class FeedViewBuilder in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/aggregator/src/FeedViewBuilder.php \Drupal\aggregator\FeedViewBuilder
Render controller for aggregator feed items.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityViewBuilder implements EntityHandlerInterface, EntityViewBuilderInterface
- class \Drupal\aggregator\FeedViewBuilder
- class \Drupal\Core\Entity\EntityViewBuilder implements EntityHandlerInterface, EntityViewBuilderInterface
Expanded class hierarchy of FeedViewBuilder
File
- core/
modules/ aggregator/ src/ FeedViewBuilder.php, line 21 - Contains \Drupal\aggregator\FeedViewBuilder.
Namespace
Drupal\aggregatorView source
class FeedViewBuilder extends EntityViewBuilder {
/**
* Constructs a new FeedViewBuilder.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
* The entity manager service.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
* @param \Drupal\Core\Config\Config $config
* The 'aggregator.settings' config.
*/
public function __construct(EntityTypeInterface $entity_type, EntityManagerInterface $entity_manager, LanguageManagerInterface $language_manager, Config $config) {
parent::__construct($entity_type, $entity_manager, $language_manager);
$this->config = $config;
}
/**
* {@inheritdoc}
*/
public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
return new static($entity_type, $container
->get('entity.manager'), $container
->get('language_manager'), $container
->get('config.factory')
->get('aggregator.settings'));
}
/**
* {@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->entityManager
->getStorage('aggregator_item')
->loadByFeed($entity
->id(), $limit);
$build[$id]['items'] = $this->entityManager
->getViewBuilder('aggregator_item')
->viewMultiple($items, $view_mode, $entity
->language()
->getId());
if ($view_mode == 'full') {
// Also add the pager.
$build[$id]['pager'] = array(
'#type' => 'pager',
);
}
}
if ($display
->getComponent('description')) {
$build[$id]['description'] = array(
'#markup' => $entity
->getDescription(),
'#allowed_tags' => _aggregator_allowed_tags(),
'#prefix' => '<div class="feed-description">',
'#suffix' => '</div>',
);
}
if ($display
->getComponent('image')) {
$image_link = array();
// 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 = array(
'#theme' => 'image',
'#uri' => $image,
'#alt' => $label,
);
$image_link = array(
'#type' => 'link',
'#title' => $link_title,
'#url' => Url::fromUri($link_href),
'#options' => array(
'attributes' => array(
'class' => array(
'feed-image',
),
),
),
);
}
$build[$id]['image'] = $image_link;
}
if ($display
->getComponent('feed_icon')) {
$build[$id]['feed_icon'] = array(
'#theme' => 'feed_icon',
'#url' => $entity
->getUrl(),
'#title' => t('@title feed', array(
'@title' => $entity
->label(),
)),
);
}
if ($display
->getComponent('more_link')) {
$title_stripped = strip_tags($entity
->label());
$build[$id]['more_link'] = array(
'#type' => 'link',
'#title' => t('More<span class="visually-hidden"> posts about @title</span>', array(
'@title' => $title_stripped,
)),
'#url' => Url::fromRoute('entity.aggregator_feed.canonical', [
'aggregator_feed' => $entity
->id(),
]),
'#options' => array(
'attributes' => array(
'title' => $title_stripped,
),
),
);
}
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityHandlerBase:: |
protected | property | The module handler to invoke hooks on. | 3 |
EntityHandlerBase:: |
protected | function | Gets the module handler. | 3 |
EntityHandlerBase:: |
public | function | Sets the module handler for this handler. | |
EntityViewBuilder:: |
protected | property | The cache bin used to store the render cache. | |
EntityViewBuilder:: |
protected | property | The entity manager service. | |
EntityViewBuilder:: |
protected | property | Information about the entity type. | |
EntityViewBuilder:: |
protected | property | The type of entities for which this view builder is instantiated. | |
EntityViewBuilder:: |
protected | property | The language manager. | |
EntityViewBuilder:: |
protected | property | The EntityViewDisplay objects created for individual field rendering. | |
EntityViewBuilder:: |
protected | function | Specific per-entity building. | 4 |
EntityViewBuilder:: |
public | function | Builds an entity's view; augments entity defaults. | |
EntityViewBuilder:: |
public | function | Builds multiple entities' views; augments entity defaults. | |
EntityViewBuilder:: |
protected | function | Provides entity-specific defaults to the build process. | 5 |
EntityViewBuilder:: |
public | function |
The cache tag associated with this entity view builder. Overrides EntityViewBuilderInterface:: |
|
EntityViewBuilder:: |
protected | function | Gets an EntityViewDisplay for rendering an individual field. | |
EntityViewBuilder:: |
protected | function | Determines whether the view mode is cacheable. | |
EntityViewBuilder:: |
public | function |
Resets the entity render cache. Overrides EntityViewBuilderInterface:: |
|
EntityViewBuilder:: |
public | function |
Builds the render array for the provided entity. Overrides EntityViewBuilderInterface:: |
4 |
EntityViewBuilder:: |
public | function |
Builds a renderable array for the value of a single field in an entity. Overrides EntityViewBuilderInterface:: |
|
EntityViewBuilder:: |
public | function |
Builds a renderable array for a single field item. Overrides EntityViewBuilderInterface:: |
|
EntityViewBuilder:: |
public | function |
Builds the render array for the provided entities. Overrides EntityViewBuilderInterface:: |
4 |
FeedViewBuilder:: |
public | function |
Builds the component fields and properties of a set of entities. Overrides EntityViewBuilder:: |
|
FeedViewBuilder:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityViewBuilder:: |
|
FeedViewBuilder:: |
public | function |
Constructs a new FeedViewBuilder. Overrides EntityViewBuilder:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |