class FeedViewBuilder

Same name in other branches
  1. 9 core/modules/aggregator/src/FeedViewBuilder.php \Drupal\aggregator\FeedViewBuilder

View builder handler for aggregator feeds.

Hierarchy

Expanded class hierarchy of FeedViewBuilder

File

core/modules/aggregator/src/FeedViewBuilder.php, line 19

Namespace

Drupal\aggregator
View source
class FeedViewBuilder extends EntityViewBuilder {
    
    /**
     * The 'aggregator.settings' config.
     *
     * @var \Drupal\Core\Config\Config
     */
    protected $config;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs a new FeedViewBuilder.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
     *   The entity repository service.
     * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
     *   The language manager.
     * @param \Drupal\Core\Config\Config $config
     *   The 'aggregator.settings' config.
     * @param \Drupal\Core\Theme\Registry $theme_registry
     *   The theme registry.
     * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
     *   The entity display repository.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityRepositoryInterface $entity_repository, LanguageManagerInterface $language_manager, Config $config, Registry $theme_registry, EntityDisplayRepositoryInterface $entity_display_repository, EntityTypeManagerInterface $entity_type_manager) {
        parent::__construct($entity_type, $entity_repository, $language_manager, $theme_registry, $entity_display_repository);
        $this->config = $config;
        $this->entityTypeManager = $entity_type_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        return new static($entity_type, $container->get('entity.repository'), $container->get('language_manager'), $container->get('config.factory')
            ->get('aggregator.settings'), $container->get('theme.registry'), $container->get('entity_display.repository'), $container->get('entity_type.manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildComponents(array &$build, array $entities, array $displays, $view_mode) {
        parent::buildComponents($build, $entities, $displays, $view_mode);
        foreach ($entities as $id => $entity) {
            $bundle = $entity->bundle();
            $display = $displays[$bundle];
            if ($display->getComponent('items')) {
                // When in summary view mode, respect the list_max setting.
                $limit = $view_mode == 'summary' ? $this->config
                    ->get('source.list_max') : 20;
                // Retrieve the items attached to this feed.
                $items = $this->entityTypeManager
                    ->getStorage('aggregator_item')
                    ->loadByFeed($entity->id(), $limit);
                $build[$id]['items'] = $this->entityTypeManager
                    ->getViewBuilder('aggregator_item')
                    ->viewMultiple($items, $view_mode, $entity->language()
                    ->getId());
                if ($view_mode == 'full') {
                    // Also add the pager.
                    $build[$id]['pager'] = [
                        '#type' => 'pager',
                    ];
                }
            }
            // By default, the description and image fields are exposed as
            // pseudo-fields rendered in this function. However they can optionally
            // be rendered directly using a field formatter. Skip rendering here if a
            // field formatter type is set.
            $component = $display->getComponent('description');
            if ($component && !isset($component['type'])) {
                $build[$id]['description'] = [
                    '#markup' => $entity->getDescription(),
                    '#allowed_tags' => _aggregator_allowed_tags(),
                    '#prefix' => '<div class="feed-description">',
                    '#suffix' => '</div>',
                ];
            }
            $component = $display->getComponent('image');
            if ($component && !isset($component['type'])) {
                $image_link = [];
                // Render the image as link if it is available.
                $image = $entity->getImage();
                $label = $entity->label();
                $link_href = $entity->getWebsiteUrl();
                if ($image && $label && $link_href) {
                    $link_title = [
                        '#theme' => 'image',
                        '#uri' => $image,
                        '#alt' => $label,
                    ];
                    $image_link = [
                        '#type' => 'link',
                        '#title' => $link_title,
                        '#url' => Url::fromUri($link_href),
                        '#options' => [
                            'attributes' => [
                                'class' => [
                                    'feed-image',
                                ],
                            ],
                        ],
                    ];
                }
                $build[$id]['image'] = $image_link;
            }
            if ($display->getComponent('feed_icon')) {
                $build[$id]['feed_icon'] = [
                    '#theme' => 'feed_icon',
                    '#url' => $entity->getUrl(),
                    '#title' => t('@title feed', [
                        '@title' => $entity->label(),
                    ]),
                ];
            }
            if ($display->getComponent('more_link')) {
                $title_stripped = strip_tags($entity->label());
                $build[$id]['more_link'] = [
                    '#type' => 'link',
                    '#title' => t('More<span class="visually-hidden"> posts about @title</span>', [
                        '@title' => $title_stripped,
                    ]),
                    '#url' => Url::fromRoute('entity.aggregator_feed.canonical', [
                        'aggregator_feed' => $entity->id(),
                    ]),
                    '#options' => [
                        'attributes' => [
                            'title' => $title_stripped,
                        ],
                    ],
                ];
            }
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
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
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityViewBuilder::$cacheBin protected property The cache bin used to store the render cache.
EntityViewBuilder::$deprecatedProperties protected property
EntityViewBuilder::$entityDisplayRepository protected property The entity display repository.
EntityViewBuilder::$entityRepository protected property The entity repository service.
EntityViewBuilder::$entityType protected property Information about the entity type.
EntityViewBuilder::$entityTypeId protected property The type of entities for which this view builder is instantiated.
EntityViewBuilder::$languageManager protected property The language manager.
EntityViewBuilder::$singleFieldDisplays protected property The EntityViewDisplay objects created for individual field rendering.
EntityViewBuilder::$themeRegistry protected property The theme registry.
EntityViewBuilder::addContextualLinks protected function Add contextual links.
EntityViewBuilder::alterBuild protected function Specific per-entity building. 1
EntityViewBuilder::build public function Builds an entity&#039;s view; augments entity defaults.
EntityViewBuilder::buildMultiple public function Builds multiple entities&#039; views; augments entity defaults.
EntityViewBuilder::getBuildDefaults protected function Provides entity-specific defaults to the build process. 4
EntityViewBuilder::getCacheTags public function The cache tag associated with this entity view builder. Overrides EntityViewBuilderInterface::getCacheTags
EntityViewBuilder::getSingleFieldDisplay protected function Gets an EntityViewDisplay for rendering an individual field.
EntityViewBuilder::isViewModeCacheable protected function Determines whether the view mode is cacheable.
EntityViewBuilder::resetCache public function Resets the entity render cache. Overrides EntityViewBuilderInterface::resetCache
EntityViewBuilder::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 2
EntityViewBuilder::view public function Builds the render array for the provided entity. Overrides EntityViewBuilderInterface::view 4
EntityViewBuilder::viewField public function Builds a renderable array for the value of a single field in an entity. Overrides EntityViewBuilderInterface::viewField
EntityViewBuilder::viewFieldItem public function Builds a renderable array for a single field item. Overrides EntityViewBuilderInterface::viewFieldItem
EntityViewBuilder::viewMultiple public function Builds the render array for the provided entities. Overrides EntityViewBuilderInterface::viewMultiple 4
FeedViewBuilder::$config protected property The &#039;aggregator.settings&#039; config.
FeedViewBuilder::$entityTypeManager protected property The entity type manager.
FeedViewBuilder::buildComponents public function Builds the component fields and properties of a set of entities. Overrides EntityViewBuilder::buildComponents
FeedViewBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityViewBuilder::createInstance
FeedViewBuilder::__construct public function Constructs a new FeedViewBuilder. Overrides EntityViewBuilder::__construct
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
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.

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