class BlockContentViewBuilder
Same name in other branches
- 9 core/modules/block_content/src/BlockContentViewBuilder.php \Drupal\block_content\BlockContentViewBuilder
- 8.9.x core/modules/block_content/src/BlockContentViewBuilder.php \Drupal\block_content\BlockContentViewBuilder
- 11.x core/modules/block_content/src/BlockContentViewBuilder.php \Drupal\block_content\BlockContentViewBuilder
View builder handler for content blocks.
Note: Content blocks (block_content entities) are not designed to be displayed outside of blocks! This BlockContentViewBuilder class is designed to be used by \Drupal\block_content\Plugin\Block\BlockContentBlock::build() and by nothing else.
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\block_content\BlockContentViewBuilder extends \Drupal\Core\Entity\EntityViewBuilder
- 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 BlockContentViewBuilder
See also
\Drupal\block_content\Plugin\Block\BlockContentBlock
File
-
core/
modules/ block_content/ src/ BlockContentViewBuilder.php, line 18
Namespace
Drupal\block_contentView source
class BlockContentViewBuilder extends EntityViewBuilder {
/**
* {@inheritdoc}
*/
public function view(EntityInterface $entity, $view_mode = 'full', $langcode = NULL) {
return $this->viewMultiple([
$entity,
], $view_mode, $langcode)[0];
}
/**
* {@inheritdoc}
*/
public function viewMultiple(array $entities = [], $view_mode = 'full', $langcode = NULL) {
$build_list = parent::viewMultiple($entities, $view_mode, $langcode);
// Apply the buildMultiple() #pre_render callback immediately, to make
// bubbling of attributes and contextual links to the actual block work.
// @see \Drupal\block\BlockViewBuilder::buildBlock()
unset($build_list['#pre_render'][0]);
return $this->buildMultiple($build_list);
}
/**
* {@inheritdoc}
*/
protected function getBuildDefaults(EntityInterface $entity, $view_mode) {
$build = parent::getBuildDefaults($entity, $view_mode);
// The content block will be rendered in the wrapped block template already
// and thus has no entity template itself.
unset($build['#theme']);
return $build;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
BlockContentViewBuilder::getBuildDefaults | protected | function | Provides entity-specific defaults to the build process. | Overrides EntityViewBuilder::getBuildDefaults | ||
BlockContentViewBuilder::view | public | function | Builds the render array for the provided entity. | Overrides EntityViewBuilder::view | ||
BlockContentViewBuilder::viewMultiple | public | function | Builds the render array for the provided entities. | Overrides EntityViewBuilder::viewMultiple | ||
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::buildComponents | public | function | Builds the component fields and properties of a set of entities. | Overrides EntityViewBuilderInterface::buildComponents | 5 | |
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::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides TrustedCallbackInterface::trustedCallbacks | 2 | |
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::__construct | public | function | Constructs a new EntityViewBuilder. | 1 | ||
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.