class EntityViewMode in Drupal 10

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"
  },
  config_export = {
    "id",
    "label",
    "targetEntityType",
    "cache",
  }
)

Hierarchy

• class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
  • class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
    • class \Drupal\Core\Entity\EntityDisplayModeBase implements EntityDisplayModeInterface
      • class \Drupal\Core\Entity\Entity\EntityViewMode implements EntityViewModeInterface

See also

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

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

hook_entity_view_mode_info_alter()

20 files declare their use of EntityViewMode

CKEditor5AllowedTagsTest.php in core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php

comment.module in core/modules/comment/comment.module

Enables users to comment on published content.

CommentIntegrationTest.php in core/modules/comment/tests/src/Kernel/CommentIntegrationTest.php

CommentInterfaceTest.php in core/modules/comment/tests/src/Functional/CommentInterfaceTest.php

DisplayApiTest.php in core/modules/field/tests/src/Kernel/DisplayApiTest.php

... See full list

File

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

Namespace

Drupal\Core\Entity\Entity

class EntityViewMode extends EntityDisplayModeBase implements EntityViewModeInterface {

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	8
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	6
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	3
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	2
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function		1
EntityBase::bundle	public	function		1
EntityBase::create	public static	function		1
EntityBase::delete	public	function		2
EntityBase::enforceIsNew	public	function
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function
EntityBase::getCacheMaxAge	public	function
EntityBase::getCacheTags	public	function
EntityBase::getConfigDependencyKey	public	function
EntityBase::getEntityType	public	function
EntityBase::getEntityTypeId	public	function
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function
EntityBase::getTypedDataClass	private	function	Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate	public	function
EntityBase::id	public	function		10
EntityBase::label	public	function		5
EntityBase::language	public	function		1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.
EntityBase::load	public static	function
EntityBase::loadMultiple	public static	function
EntityBase::postCreate	public	function		4
EntityBase::postDelete	public static	function		12
EntityBase::postLoad	public static	function		3
EntityBase::postSave	public	function		13
EntityBase::preCreate	public static	function		5
EntityBase::referencedEntities	public	function		1
EntityBase::toLink	public	function
EntityBase::uriRelationships	public	function
EntityBase::uuid	public	function		1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
EntityDisplayModeBase::$cache	protected	property	Whether or not the rendered output of this view mode is cached by default.
EntityDisplayModeBase::$id	protected	property	The ID of the form or view mode.
EntityDisplayModeBase::$label	protected	property	The human-readable name of the form or view mode.
EntityDisplayModeBase::$status	protected	property	Whether or not this form or view mode has custom settings by default. Overrides ConfigEntityBase::$status
EntityDisplayModeBase::$targetEntityType	protected	property	The entity type this form or view mode is used for.
EntityDisplayModeBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
EntityDisplayModeBase::getTargetType	public	function	Gets the entity type this display mode is used for. Overrides EntityDisplayModeInterface::getTargetType
EntityDisplayModeBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides ConfigEntityBase::preDelete
EntityDisplayModeBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
EntityDisplayModeBase::setTargetType	public	function	Set the entity type this display mode is used for. Overrides EntityDisplayModeInterface::setTargetType
EntityDisplayModeBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label. Overrides ConfigEntityBase::sort
EntityDisplayModeBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function