class EntityViewMode

Defines the entity view mode configuration entity class.

View modes let entities be displayed differently depending on the context. For instance, a node can be displayed differently on its own page ('full' mode), on the home page or taxonomy listings ('teaser' mode), or in an RSS feed ('rss' mode). Modules taking part in the display of the entity (notably the Field API) can adjust their behavior depending on the requested view mode. An additional 'default' view mode is available for all entity types. This view mode is not intended for actual entity display, but holds default display settings. For each available view mode, administrators can configure whether it should use its own set of field display settings, or just replicate the settings of the 'default' view mode, thus reducing the amount of display configurations to keep track of.

Plugin annotation

@ConfigEntityType(
  id = "entity_view_mode",
  label = @Translation("View mode"),
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "description" = "description",
  },
  config_export = {
    "id",
    "label",
    "description",
    "targetEntityType",
    "cache",
  },
  constraints = {
    "ImmutableProperties" = {"id", "targetEntityType"},
  }
)

Hierarchy

Expanded class hierarchy of EntityViewMode

See also

\Drupal\Core\Entity\EntityDisplayRepositoryInterface::getAllViewModes()

\Drupal\Core\Entity\EntityDisplayRepositoryInterface::getViewModes()

hook_entity_view_mode_info_alter()

File

core/lib/Drupal/Core/Entity/Entity/EntityViewMode.php, line 47

Namespace

class EntityViewMode extends EntityDisplayModeBase implements EntityViewModeInterface {

}

Members

Name contains

Name does not contain

Type

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	6
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	12
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	12
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	12
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	1
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	1
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	1
ConfigEntityInterface::get	public	function	Returns the value of a property.	1
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	1
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	1
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	1
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	1
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	1
ConfigEntityInterface::set	public	function	Sets the value of a property.	1
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	1
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	1
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	1
EntityDisplayModeInterface::getDescription	public	function	Gets the display mode description.
EntityDisplayModeInterface::getTargetType	public	function	Gets the entity type this display mode is used for.
EntityDisplayModeInterface::setTargetType	public	function	Set the entity type this display mode is used for.
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.	2
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.	3
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.	3
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.	7
EntityInterface::postLoad	public static	function	Acts on loaded entities.	2
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	8
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	4
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	6
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	8
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	3
EntityInterface::setOriginalId	public	function	Sets the original ID.	1
EntityInterface::toArray	public	function	Gets an array of all property values.	2
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
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.
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