class NodeViewBuilder
Same name in other branches
- 9 core/modules/node/src/NodeViewBuilder.php \Drupal\node\NodeViewBuilder
- 8.9.x core/modules/node/src/NodeViewBuilder.php \Drupal\node\NodeViewBuilder
- 11.x core/modules/node/src/NodeViewBuilder.php \Drupal\node\NodeViewBuilder
View builder handler for nodes.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\EntityViewBuilder extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityHandlerInterface, \Drupal\Core\Entity\EntityViewBuilderInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\node\NodeViewBuilder extends \Drupal\Core\Entity\EntityViewBuilder implements \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Entity\EntityViewBuilder extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityHandlerInterface, \Drupal\Core\Entity\EntityViewBuilderInterface, \Drupal\Core\Security\TrustedCallbackInterface
Expanded class hierarchy of NodeViewBuilder
File
-
core/
modules/ node/ src/ NodeViewBuilder.php, line 13
Namespace
Drupal\nodeView source
class NodeViewBuilder extends EntityViewBuilder implements TrustedCallbackInterface {
/**
* {@inheritdoc}
*/
public function buildComponents(array &$build, array $entities, array $displays, $view_mode) {
/** @var \Drupal\node\NodeInterface[] $entities */
if (empty($entities)) {
return;
}
parent::buildComponents($build, $entities, $displays, $view_mode);
foreach ($entities as $id => $entity) {
$bundle = $entity->bundle();
$display = $displays[$bundle];
if ($display->getComponent('links')) {
$build[$id]['links'] = [
'#lazy_builder' => [
static::class . '::renderLinks',
[
$entity->id(),
$view_mode,
$entity->language()
->getId(),
!empty($entity->in_preview),
$entity->isDefaultRevision() ? NULL : $entity->getLoadedRevisionId(),
],
],
];
}
// Add Language field text element to node render array.
if ($display->getComponent('langcode')) {
$build[$id]['langcode'] = [
'#type' => 'item',
'#title' => t('Language'),
'#markup' => $entity->language()
->getName(),
'#prefix' => '<div id="field-language-display">',
'#suffix' => '</div>',
];
}
}
}
/**
* {@inheritdoc}
*/
protected function getBuildDefaults(EntityInterface $entity, $view_mode) {
$defaults = parent::getBuildDefaults($entity, $view_mode);
// Don't cache nodes that are in 'preview' mode.
if (isset($defaults['#cache']) && isset($entity->in_preview)) {
unset($defaults['#cache']);
}
return $defaults;
}
/**
* #lazy_builder callback; builds a node's links.
*
* @param string $node_entity_id
* The node entity ID.
* @param string $view_mode
* The view mode in which the node entity is being viewed.
* @param string $langcode
* The language in which the node entity is being viewed.
* @param bool $is_in_preview
* Whether the node is currently being previewed.
* @param $revision_id
* (optional) The identifier of the node revision to be loaded. If none
* is provided, the default revision will be loaded.
*
* @return array
* A renderable array representing the node links.
*/
public static function renderLinks($node_entity_id, $view_mode, $langcode, $is_in_preview, $revision_id = NULL) {
$links = [
'#theme' => 'links__node',
'#pre_render' => [
[
Link::class,
'preRenderLinks',
],
],
'#attributes' => [
'class' => [
'links',
'inline',
],
],
];
if (!$is_in_preview) {
$storage = \Drupal::entityTypeManager()->getStorage('node');
/** @var \Drupal\node\NodeInterface $revision */
$revision = !isset($revision_id) ? $storage->load($node_entity_id) : $storage->loadRevision($revision_id);
$entity = $revision->getTranslation($langcode);
$links['node'] = static::buildLinks($entity, $view_mode);
// Allow other modules to alter the node links.
$hook_context = [
'view_mode' => $view_mode,
'langcode' => $langcode,
];
\Drupal::moduleHandler()->alter('node_links', $links, $entity, $hook_context);
}
return $links;
}
/**
* Build the default links (Read more) for a node.
*
* @param \Drupal\node\NodeInterface $entity
* The node object.
* @param string $view_mode
* A view mode identifier.
*
* @return array
* An array that can be processed by Link::preRenderLinks().
*
* @see \Drupal\Core\Render\Element\Link::preRenderLinks()
*/
protected static function buildLinks(NodeInterface $entity, $view_mode) {
$links = [];
// Always display a read more link on teasers because we have no way
// to know when a teaser view is different than a full view.
if ($view_mode == 'teaser') {
$node_title_stripped = strip_tags($entity->label());
$links['node-readmore'] = [
'title' => t('Read more<span class="visually-hidden"> about @title</span>', [
'@title' => $node_title_stripped,
]),
'url' => $entity->toUrl(),
'language' => $entity->language(),
'attributes' => [
'rel' => 'tag',
'title' => $node_title_stripped,
],
];
}
return [
'#theme' => 'links__node__node',
'#links' => $links,
'#attributes' => [
'class' => [
'links',
'inline',
],
],
];
}
/**
* {@inheritdoc}
*/
public static function trustedCallbacks() {
$callbacks = parent::trustedCallbacks();
$callbacks[] = 'renderLinks';
return $callbacks;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | ||||
DependencySerializationTrait::$_serviceIds | protected | property | ||||
DependencySerializationTrait::__sleep | public | function | 1 | |||
DependencySerializationTrait::__wakeup | public | function | 2 | |||
EntityHandlerBase::$moduleHandler | protected | property | The module handler to invoke hooks on. | 5 | ||
EntityHandlerBase::moduleHandler | protected | function | Gets the module handler. | 5 | ||
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::$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's view; augments entity defaults. | |||
EntityViewBuilder::buildMultiple | public | function | Builds multiple entities' views; augments entity defaults. | |||
EntityViewBuilder::createInstance | public static | function | Instantiates a new instance of this entity handler. | Overrides EntityHandlerInterface::createInstance | 2 | |
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::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 | |
EntityViewBuilder::__construct | public | function | Constructs a new EntityViewBuilder. | 1 | ||
NodeViewBuilder::buildComponents | public | function | Builds the component fields and properties of a set of entities. | Overrides EntityViewBuilder::buildComponents | ||
NodeViewBuilder::buildLinks | protected static | function | Build the default links (Read more) for a node. | |||
NodeViewBuilder::getBuildDefaults | protected | function | Provides entity-specific defaults to the build process. | Overrides EntityViewBuilder::getBuildDefaults | ||
NodeViewBuilder::renderLinks | public static | function | #lazy_builder callback; builds a node's links. | |||
NodeViewBuilder::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides EntityViewBuilder::trustedCallbacks | ||
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. | |||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||||
TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | 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.