class AggregatorFeedBlock

Same name and namespace in other branches
  1. 8.9.x core/modules/aggregator/src/Plugin/Block/AggregatorFeedBlock.php \Drupal\aggregator\Plugin\Block\AggregatorFeedBlock

Provides an 'Aggregator feed' block with the latest items from the feed.

Plugin annotation


@Block(
  id = "aggregator_feed_block",
  admin_label = @Translation("Aggregator feed"),
  category = @Translation("Lists (Views)")
)

Hierarchy

Expanded class hierarchy of AggregatorFeedBlock

File

core/modules/aggregator/src/Plugin/Block/AggregatorFeedBlock.php, line 24

Namespace

Drupal\aggregator\Plugin\Block
View source
class AggregatorFeedBlock extends BlockBase implements ContainerFactoryPluginInterface {
    
    /**
     * The entity storage for feeds.
     *
     * @var \Drupal\aggregator\FeedStorageInterface
     */
    protected $feedStorage;
    
    /**
     * The entity storage for items.
     *
     * @var \Drupal\aggregator\ItemStorageInterface
     */
    protected $itemStorage;
    
    /**
     * Constructs an AggregatorFeedBlock 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\aggregator\FeedStorageInterface $feed_storage
     *   The entity storage for feeds.
     * @param \Drupal\aggregator\ItemStorageInterface $item_storage
     *   The entity storage for feed items.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, FeedStorageInterface $feed_storage, ItemStorageInterface $item_storage) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->feedStorage = $feed_storage;
        $this->itemStorage = $item_storage;
    }
    
    /**
     * {@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')
            ->getStorage('aggregator_feed'), $container->get('entity_type.manager')
            ->getStorage('aggregator_item'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        // By default, the block will contain 10 feed items.
        return [
            'block_count' => 10,
            'feed' => NULL,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function blockAccess(AccountInterface $account) {
        // Only grant access to users with the 'access news feeds' permission.
        return AccessResult::allowedIfHasPermission($account, 'access news feeds');
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockForm($form, FormStateInterface $form_state) {
        $feeds = $this->feedStorage
            ->loadMultiple();
        $options = [];
        foreach ($feeds as $feed) {
            $options[$feed->id()] = $feed->label();
        }
        $form['feed'] = [
            '#type' => 'select',
            '#title' => $this->t('Select the feed that should be displayed'),
            '#default_value' => $this->configuration['feed'],
            '#options' => $options,
        ];
        $range = range(2, 20);
        $form['block_count'] = [
            '#type' => 'select',
            '#title' => $this->t('Number of news items in block'),
            '#default_value' => $this->configuration['block_count'],
            '#options' => array_combine($range, $range),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockSubmit($form, FormStateInterface $form_state) {
        $this->configuration['block_count'] = $form_state->getValue('block_count');
        $this->configuration['feed'] = $form_state->getValue('feed');
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        // Load the selected feed.
        if (!($feed = $this->feedStorage
            ->load($this->configuration['feed']))) {
            return [];
        }
        $result = $this->itemStorage
            ->getQuery()
            ->accessCheck(TRUE)
            ->condition('fid', $feed->id())
            ->range(0, $this->configuration['block_count'])
            ->sort('timestamp', 'DESC')
            ->sort('iid', 'DESC')
            ->execute();
        if ($result) {
            // Only display the block if there are items to show.
            $items = $this->itemStorage
                ->loadMultiple($result);
            $build['list'] = [
                '#theme' => 'item_list',
                '#items' => [],
            ];
            foreach ($items as $item) {
                $build['list']['#items'][$item->id()] = [
                    '#type' => 'link',
                    '#url' => $item->toUrl(),
                    '#title' => $item->label(),
                ];
            }
            $build['more_link'] = [
                '#type' => 'more_link',
                '#url' => $feed->toUrl(),
                '#attributes' => [
                    'title' => $this->t("View this feed's recent news."),
                ],
            ];
            return $build;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheTags() {
        $cache_tags = parent::getCacheTags();
        if ($feed = $this->feedStorage
            ->load($this->configuration['feed'])) {
            $cache_tags = Cache::mergeTags($cache_tags, $feed->getCacheTags());
        }
        return $cache_tags;
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
AggregatorFeedBlock::$feedStorage protected property The entity storage for feeds.
AggregatorFeedBlock::$itemStorage protected property The entity storage for items.
AggregatorFeedBlock::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
AggregatorFeedBlock::blockForm public function Overrides BlockPluginTrait::blockForm
AggregatorFeedBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
AggregatorFeedBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
AggregatorFeedBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
AggregatorFeedBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
AggregatorFeedBlock::getCacheTags public function Overrides ContextAwarePluginTrait::getCacheTags
AggregatorFeedBlock::__construct public function Constructs an AggregatorFeedBlock object. Overrides BlockPluginTrait::__construct
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::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().
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.