interface EntityViewDisplayInterface in Drupal 10

Provides a common interface for entity view displays.

Hierarchy

• interface \Drupal\Core\Config\Entity\ConfigEntityInterface; interface \Drupal\Core\Entity\EntityWithPluginCollectionInterface
  • interface \Drupal\Core\Entity\Display\EntityDisplayInterface
    • interface \Drupal\Core\Entity\Display\EntityViewDisplayInterface

36 files declare their use of EntityViewDisplayInterface

AudioFile.php in core/modules/media/src/Plugin/media/Source/AudioFile.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

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

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	4
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	24
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	24
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	17
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::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::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.	1
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	1
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	1
EntityInterface::delete	public	function	Deletes an entity permanently.	1
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	1
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	1
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	1
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	1
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	1
EntityInterface::getEntityType	public	function	Gets the entity type definition.	1
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	1
EntityInterface::getOriginalId	public	function	Gets the original ID.	1
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	1
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	1
EntityInterface::id	public	function	Gets the identifier.	1
EntityInterface::isNew	public	function	Determines whether the entity is new.	1
EntityInterface::label	public	function	Gets the label of the entity.	1
EntityInterface::language	public	function	Gets the language of the entity.	1
EntityInterface::load	public static	function	Loads an entity.	1
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	1
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	1
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	1
EntityInterface::postLoad	public static	function	Acts on loaded entities.	1
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	1
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	1
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	1
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	1
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	1
EntityInterface::save	public	function	Saves an entity permanently.	1
EntityInterface::setOriginalId	public	function	Sets the original ID.	1
EntityInterface::toArray	public	function	Gets an array of all property values.	1
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	1
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	1
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	1
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	1
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 object.	11
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	4
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	4
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	4
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	4
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	4