class StatisticsPopularBlock

Same name in other branches
  1. 8.9.x core/modules/statistics/src/Plugin/Block/StatisticsPopularBlock.php \Drupal\statistics\Plugin\Block\StatisticsPopularBlock
  2. 10 core/modules/statistics/src/Plugin/Block/StatisticsPopularBlock.php \Drupal\statistics\Plugin\Block\StatisticsPopularBlock
  3. 11.x core/modules/statistics/src/Plugin/Block/StatisticsPopularBlock.php \Drupal\statistics\Plugin\Block\StatisticsPopularBlock

Provides a 'Popular content' block.

Plugin annotation


@Block(
  id = "statistics_popular_block",
  admin_label = @Translation("Popular content")
)

Hierarchy

Expanded class hierarchy of StatisticsPopularBlock

File

core/modules/statistics/src/Plugin/Block/StatisticsPopularBlock.php, line 24

Namespace

Drupal\statistics\Plugin\Block
View source
class StatisticsPopularBlock extends BlockBase implements ContainerFactoryPluginInterface {
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The entity repository service.
     *
     * @var \Drupal\Core\Entity\EntityRepositoryInterface
     */
    protected $entityRepository;
    
    /**
     * The storage for statistics.
     *
     * @var \Drupal\statistics\StatisticsStorageInterface
     */
    protected $statisticsStorage;
    
    /**
     * @var \Drupal\Core\Render\RendererInterface
     */
    protected $renderer;
    
    /**
     * Constructs a StatisticsPopularBlock object.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin_id for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
     *   The entity repository service
     * @param \Drupal\statistics\StatisticsStorageInterface $statistics_storage
     *   The storage for statistics.
     * @param \Drupal\Core\Render\RendererInterface $renderer
     *   The renderer configuration array.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityRepositoryInterface $entity_repository, StatisticsStorageInterface $statistics_storage, RendererInterface $renderer) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->entityTypeManager = $entity_type_manager;
        $this->entityRepository = $entity_repository;
        $this->statisticsStorage = $statistics_storage;
        $this->renderer = $renderer;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager'), $container->get('entity.repository'), $container->get('statistics.storage.node'), $container->get('renderer'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'top_day_num' => 0,
            'top_all_num' => 0,
            'top_last_num' => 0,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function blockAccess(AccountInterface $account) {
        return AccessResult::allowedIfHasPermission($account, 'access content');
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockForm($form, FormStateInterface $form_state) {
        // Popular content block settings.
        $numbers = [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            15,
            20,
            25,
            30,
            40,
        ];
        $numbers = [
            '0' => $this->t('Disabled'),
        ] + array_combine($numbers, $numbers);
        $form['statistics_block_top_day_num'] = [
            '#type' => 'select',
            '#title' => $this->t("Number of day's top views to display"),
            '#default_value' => $this->configuration['top_day_num'],
            '#options' => $numbers,
            '#description' => $this->t('How many content items to display in "day" list.'),
        ];
        $form['statistics_block_top_all_num'] = [
            '#type' => 'select',
            '#title' => $this->t('Number of all time views to display'),
            '#default_value' => $this->configuration['top_all_num'],
            '#options' => $numbers,
            '#description' => $this->t('How many content items to display in "all time" list.'),
        ];
        $form['statistics_block_top_last_num'] = [
            '#type' => 'select',
            '#title' => $this->t('Number of most recent views to display'),
            '#default_value' => $this->configuration['top_last_num'],
            '#options' => $numbers,
            '#description' => $this->t('How many content items to display in "recently viewed" list.'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockSubmit($form, FormStateInterface $form_state) {
        $this->configuration['top_day_num'] = $form_state->getValue('statistics_block_top_day_num');
        $this->configuration['top_all_num'] = $form_state->getValue('statistics_block_top_all_num');
        $this->configuration['top_last_num'] = $form_state->getValue('statistics_block_top_last_num');
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        $content = [];
        if ($this->configuration['top_day_num'] > 0) {
            $nids = $this->statisticsStorage
                ->fetchAll('daycount', $this->configuration['top_day_num']);
            if ($nids) {
                $content['top_day'] = $this->nodeTitleList($nids, $this->t("Today's:"));
                $content['top_day']['#suffix'] = '<br />';
            }
        }
        if ($this->configuration['top_all_num'] > 0) {
            $nids = $this->statisticsStorage
                ->fetchAll('totalcount', $this->configuration['top_all_num']);
            if ($nids) {
                $content['top_all'] = $this->nodeTitleList($nids, $this->t('All time:'));
                $content['top_all']['#suffix'] = '<br />';
            }
        }
        if ($this->configuration['top_last_num'] > 0) {
            $nids = $this->statisticsStorage
                ->fetchAll('timestamp', $this->configuration['top_last_num']);
            $content['top_last'] = $this->nodeTitleList($nids, $this->t('Last viewed:'));
            $content['top_last']['#suffix'] = '<br />';
        }
        return $content;
    }
    
    /**
     * Generates the ordered array of node links for build().
     *
     * @param int[] $nids
     *   An ordered array of node ids.
     * @param string $title
     *   The title for the list.
     *
     * @return array
     *   A render array for the list.
     */
    protected function nodeTitleList(array $nids, $title) {
        $nodes = $this->entityTypeManager
            ->getStorage('node')
            ->loadMultiple($nids);
        $items = [];
        foreach ($nids as $nid) {
            $node = $this->entityRepository
                ->getTranslationFromContext($nodes[$nid]);
            $item = $node->toLink()
                ->toRenderable();
            $this->renderer
                ->addCacheableDependency($item, $node);
            $items[] = $item;
        }
        return [
            '#theme' => 'item_list__node',
            '#items' => $items,
            '#title' => $title,
            '#cache' => [
                'tags' => $this->entityTypeManager
                    ->getDefinition('node')
                    ->getListCacheTags(),
            ],
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$inPreview protected property Whether the plugin is being rendered in preview mode.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual
block plugins can add elements to this form by overriding
BlockBase::blockForm(). Most block plugins should not override this
method unless they need to alter the generic form elements.
Aliased as: traitBuildConfigurationForm
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setInPreview public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission
handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation
for a specific block type, override BlockBase::blockValidate().
1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StatisticsPopularBlock::$entityRepository protected property The entity repository service.
StatisticsPopularBlock::$entityTypeManager protected property The entity type manager.
StatisticsPopularBlock::$renderer protected property
StatisticsPopularBlock::$statisticsStorage protected property The storage for statistics.
StatisticsPopularBlock::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
StatisticsPopularBlock::blockForm public function Overrides BlockPluginTrait::blockForm
StatisticsPopularBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
StatisticsPopularBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
StatisticsPopularBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
StatisticsPopularBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
StatisticsPopularBlock::nodeTitleList protected function Generates the ordered array of node links for build().
StatisticsPopularBlock::__construct public function Constructs a StatisticsPopularBlock object. Overrides BlockPluginTrait::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.