1. 8.3.x core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php EntityViewDisplayInterface
  2. 8.0.x core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php EntityViewDisplayInterface
  3. 8.1.x core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php EntityViewDisplayInterface
  4. 8.2.x core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php EntityViewDisplayInterface
  5. 8.4.x core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php EntityViewDisplayInterface

Provides a common interface for entity view displays.

Hierarchy

Expanded class hierarchy of EntityViewDisplayInterface

All classes that implement EntityViewDisplayInterface

24 files declare their use of EntityViewDisplayInterface
BlockContentViewBuilder.php in core/modules/block_content/src/BlockContentViewBuilder.php
book.module in core/modules/book/book.module
Allows users to create and organize related content in an outline.
BooleanFormatterTest.php in core/modules/field/tests/src/Kernel/Boolean/BooleanFormatterTest.php
comment.module in core/modules/comment/comment.module
Enables users to comment on published content.
CommentViewBuilder.php in core/modules/comment/src/CommentViewBuilder.php

... See full list

File

core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php, line 10

Namespace

Drupal\Core\Entity\Display
View source
interface EntityViewDisplayInterface extends EntityDisplayInterface {

  /**
   * Builds a renderable array for the components of an entity.
   *
   * See the buildMultiple() method for details.
   *
   * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
   *   The entity being displayed.
   *
   * @return array
   *   A renderable array for the entity.
   *
   * @see \Drupal\Core\Entity\Display\EntityViewDisplayInterface::buildMultiple()
   */
  public function build(FieldableEntityInterface $entity);

  /**
   * Builds a renderable array for the components of a set of entities.
   *
   * This only includes the components handled by the Display object, but
   * excludes 'extra fields', that are typically rendered through specific,
   * ad-hoc code in EntityViewBuilderInterface::buildComponents() or in
   * hook_entity_view() implementations.
   *
   * hook_entity_display_build_alter() is invoked on each entity, allowing 3rd
   * party code to alter the render array.
   *
   * @param \Drupal\Core\Entity\FieldableEntityInterface[] $entities
   *   The entities being displayed.
   *
   * @return array
   *   A renderable array for the entities, indexed by the same keys as the
   *   $entities array parameter.
   *
   * @see hook_entity_display_build_alter()
   */
  public function buildMultiple(array $entities);

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. Overrides AccessibleInterface::access 6
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 32
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 32
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 26
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isSyncing public function Returns whether this entity is being changed as part of an import process. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::setSyncing public function Sets the status of the isSyncing flag. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
EntityDisplayInterface::createCopy public function Creates a duplicate of the entity display object on a different view mode. 1
EntityDisplayInterface::getComponent public function Gets the display options set for a component. 1
EntityDisplayInterface::getComponents public function Gets the display options for all components. 1
EntityDisplayInterface::getHighestWeight public function Gets the highest weight of the components in the display. 1
EntityDisplayInterface::getMode public function Gets the view or form mode to be displayed. 1
EntityDisplayInterface::getOriginalMode public function Gets the original view or form mode that was requested. 1
EntityDisplayInterface::getRenderer public function Gets the renderer plugin for a field (e.g. widget, formatter). 2
EntityDisplayInterface::getTargetBundle public function Gets the bundle to be displayed. 1
EntityDisplayInterface::getTargetEntityTypeId public function Gets the entity type for which this display is used. 1
EntityDisplayInterface::removeComponent public function Sets a component to be hidden. 1
EntityDisplayInterface::setComponent public function Sets the display options for a component. 1
EntityDisplayInterface::setTargetBundle public function Sets the bundle to be displayed. 1
EntityInterface::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 3
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create 3
EntityInterface::createDuplicate public function Creates a duplicate of the entity. Overrides EntityInterface::createDuplicate 3
EntityInterface::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 3
EntityInterface::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew 3
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate 3
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey 3
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName 3
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget 3
EntityInterface::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType 3
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId 3
EntityInterface::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId 3
EntityInterface::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData 3
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate 3
EntityInterface::id public function Gets the identifier. Overrides EntityInterface::id 3
EntityInterface::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew 3
EntityInterface::label public function Gets the label of the entity. Overrides EntityInterface::label 3
EntityInterface::language public function Gets the language of the entity. Overrides EntityInterface::language 3
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link 3
EntityInterface::load public static function Loads an entity. Overrides EntityInterface::load 3
EntityInterface::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple 3
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 3
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 3
EntityInterface::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 4
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 3
EntityInterface::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 3
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 3
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityInterface::preSave 3
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 3
EntityInterface::save public function Saves an entity permanently. Overrides EntityInterface::save 3
EntityInterface::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId 3
EntityInterface::toArray public function Gets an array of all property values. Overrides EntityInterface::toArray 4
EntityInterface::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink 3
EntityInterface::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 3
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships 3
EntityInterface::url Deprecated public function Gets the public URL for this entity. Overrides EntityInterface::url 3
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. Overrides EntityInterface::urlInfo 3
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 3
EntityViewDisplayInterface::build public function Builds a renderable array for the components of an entity. 1
EntityViewDisplayInterface::buildMultiple public function Builds a renderable array for the components of a set of entities. 1
ObjectWithPluginCollectionInterface::getPluginCollections public function Gets the plugin collections used by this entity. 9
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency 3
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts 3
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags 3
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge 3
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 3
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 3
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 3
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 3
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 3