You are here

Home » API reference » Zircon Profile 8 » AggregatorFeedBlock.php

class AggregatorFeedBlock in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 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 30
Contains \Drupal\aggregator\Plugin\Block\AggregatorFeedBlock.

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;

  /**
   * The entity query object for feed items.
   *
   * @var \Drupal\Core\Entity\Query\QueryInterface
   */
  protected $itemQuery;

  /**
   * 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.
   * @param \Drupal\Core\Entity\Query\QueryInterface $item_query
   *   The entity query object for feed items.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, FeedStorageInterface $feed_storage, ItemStorageInterface $item_storage, QueryInterface $item_query) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->feedStorage = $feed_storage;
    $this->itemStorage = $item_storage;
    $this->itemQuery = $item_query;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity.manager')
      ->getStorage('aggregator_feed'), $container
      ->get('entity.manager')
      ->getStorage('aggregator_item'), $container
      ->get('entity.query')
      ->get('aggregator_item'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {

    // By default, the block will contain 10 feed items.
    return array(
      '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 = array();
    foreach ($feeds as $feed) {
      $options[$feed
        ->id()] = $feed
        ->label();
    }
    $form['feed'] = array(
      '#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'] = array(
      '#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'])) {
      $result = $this->itemQuery
        ->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
              ->urlInfo(),
            '#title' => $item
              ->label(),
          ];
        }
        $build['more_link'] = [
          '#type' => 'more_link',
          '#url' => $feed
            ->urlInfo(),
          '#attributes' => [
            'title' => $this
              ->t("View this feed's recent news."),
          ],
        ];
        return $build;
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $cache_tags = parent::getCacheTags();
    $feed = $this->feedStorage
      ->load($this->configuration['feed']);
    return Cache::mergeTags($cache_tags, $feed
      ->getCacheTags());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AggregatorFeedBlock::$feedStorage protected property The entity storage for feeds.
AggregatorFeedBlock::$itemQuery protected property The entity query object for feed items.
AggregatorFeedBlock::$itemStorage protected property The entity storage for items.
AggregatorFeedBlock::blockAccess protected function Indicates whether the block should be shown. Overrides BlockBase::blockAccess
AggregatorFeedBlock::blockForm public function Returns the configuration form elements specific to this block plugin. Overrides BlockBase::blockForm
AggregatorFeedBlock::blockSubmit public function Adds block type-specific submission handling for the block form. Overrides BlockBase::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 Gets default configuration for this plugin. Overrides BlockBase::defaultConfiguration
AggregatorFeedBlock::getCacheTags public function Overrides ContextAwarePluginBase::getCacheTags
AggregatorFeedBlock::__construct public function Constructs an AggregatorFeedBlock object. Overrides BlockBase::__construct
BlockBase::$transliteration protected property The transliteration service.
BlockBase::access public function Indicates whether the block should be shown. Overrides BlockPluginInterface::access
BlockBase::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockBase::blockValidate public function Adds block type-specific validation for the block form. Overrides BlockPluginInterface::blockValidate 1
BlockBase::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. Overrides PluginFormInterface::buildConfigurationForm 1
BlockBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
BlockBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration 1
BlockBase::getMachineNameSuggestion public function Suggests a machine name to identify an instance of this block. Overrides BlockPluginInterface::getMachineNameSuggestion 1
BlockBase::label public function Returns the user-facing block label. Overrides BlockPluginInterface::label
BlockBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
BlockBase::setConfigurationValue public function Sets a particular value in the block settings. Overrides BlockPluginInterface::setConfigurationValue
BlockBase::setTransliteration public function Sets the transliteration service.
BlockBase::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). Overrides PluginFormInterface::submitConfigurationForm
BlockBase::transliteration protected function Wraps the transliteration service.
BlockBase::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). Overrides PluginFormInterface::validateConfigurationForm
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function 9
ContextAwarePluginBase::getCacheMaxAge public function 7
ContextAwarePluginBase::getContext public function Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation protected property The string translation service.
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
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 1
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 1