class EntityViewMode

Defines the 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

@EntityType(
  id = "view_mode",
  label = @Translation("View mode"),
  module = "entity",
  controllers = {
    "storage" = "Drupal\entity\EntityViewModeStorageController"
  },
  config_prefix = "entity.view_mode",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  }
)

Hierarchy

Expanded class hierarchy of EntityViewMode

See also

entity_get_view_modes()

hook_entity_view_mode_info_alter()

File

drupal/core/modules/entity/lib/Drupal/entity/Plugin/Core/Entity/EntityViewMode.php, line 48

Contains \Drupal\entity\Plugin\Core\Entity\EntityViewMode.

Namespace

class EntityViewMode extends ConfigEntityBase implements EntityViewModeInterface {

  /**
   * The ID of the view mode.
   *
   * @var string
   */
  public $id;

  /**
   * The UUID of the view mode.
   *
   * @var string
   */
  public $uuid;

  /**
   * The human-readable name of the view mode.
   *
   * @var string
   */
  public $label;

  /**
   * The entity type this view mode is used for.
   *
   * This is not to be confused with EntityViewMode::entityType which is
   * inherited from Entity::entityType and equals 'view_mode' for any view mode
   * entity.
   *
   * @var string
   */
  public $targetEntityType;

  /**
   * Whether or not this view mode has custom settings by default.
   *
   * If FALSE, entities displayed in this view mode will reuse the 'default'
   * display settings by default (e.g. right after the module exposing the view
   * mode is enabled), but administrators can later use the Field UI to apply
   * custom display settings specific to the view mode.
   *
   * @var bool
   */
  public $status = FALSE;

}

Members

Name contains

Name does not contain

Type

Name	Modifiers	Type	Description	Overrides
ConfigEntityBase::$originalID	protected	property	The original ID of the configuration entity.
ConfigEntityBase::createDuplicate	public	function	Overrides Entity::createDuplicate(). Overrides Entity::createDuplicate	2
ConfigEntityBase::disable	public	function	Implements \Drupal\Core\Config\Entity\ConfigEntityInterface::disable(). Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Implements \Drupal\Core\Config\Entity\ConfigEntityInterface::enable(). Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Overrides Entity::get(). Overrides Entity::get	2
ConfigEntityBase::getExportProperties	public	function	Overrides \Drupal\Core\Entity\Entity::getExportProperties(). Overrides Entity::getExportProperties	9
ConfigEntityBase::getOriginalID	public	function	Implements ConfigEntityInterface::getOriginalID(). Overrides ConfigEntityInterface::getOriginalID
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::set	public	function	Overrides Entity::set(). Overrides Entity::set
ConfigEntityBase::setOriginalID	public	function	Implements ConfigEntityInterface::setOriginalID(). Overrides ConfigEntityInterface::setOriginalID
ConfigEntityBase::setStatus	public	function	Implements \Drupal\Core\Config\Entity\ConfigEntityInterface::setStatus(). Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	2
ConfigEntityBase::status	public	function	Implements \Drupal\Core\Config\Entity\ConfigEntityInterface::status(). Overrides ConfigEntityInterface::status	1
ConfigEntityBase::__construct	public	function	Overrides Entity::__construct(). Overrides Entity::__construct	9
Entity::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
Entity::$entityType	protected	property	The entity type.
Entity::$isDefaultRevision	protected	property	Indicates whether this is the default revision.	1
Entity::$langcode	public	property	The language code of the entity's default language.	7
Entity::$newRevision	protected	property	Boolean indicating whether a new revision should be created on save.
Entity::access	public	function	Implements \Drupal\Core\TypedData\AccessibleInterface::access(). Overrides AccessibleInterface::access
Entity::bundle	public	function	Implements \Drupal\Core\Entity\EntityInterface::bundle(). Overrides EntityInterface::bundle	4
Entity::delete	public	function	Implements \Drupal\Core\Entity\EntityInterface::delete(). Overrides EntityInterface::delete	3
Entity::enforceIsNew	public	function	Implements \Drupal\Core\Entity\EntityInterface::enforceIsNew(). Overrides EntityInterface::enforceIsNew
Entity::entityInfo	public	function	Implements \Drupal\Core\Entity\EntityInterface::entityInfo(). Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Implements \Drupal\Core\Entity\EntityInterface::entityType(). Overrides EntityInterface::entityType
Entity::getBCEntity	public	function	Implements \Drupal\Core\Entity\EntityInterface::getBCEntity(). Overrides EntityInterface::getBCEntity	1
Entity::getConstraints	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getConstraints(). Overrides TypedDataInterface::getConstraints
Entity::getDefinition	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getDefinition(). Overrides TypedDataInterface::getDefinition
Entity::getIterator	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::getIterator().	1
Entity::getName	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getName(). Overrides TypedDataInterface::getName
Entity::getNGEntity	public	function	Implements \Drupal\Core\Entity\EntityInterface::getNGEntity(). Overrides EntityInterface::getNGEntity
Entity::getParent	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getParent(). Overrides TypedDataInterface::getParent
Entity::getProperties	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::getProperties(). Overrides ComplexDataInterface::getProperties	1
Entity::getPropertyDefinition	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::getPropertyDefinition(). Overrides ComplexDataInterface::getPropertyDefinition	1
Entity::getPropertyDefinitions	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::getPropertyDefinitions(). Overrides ComplexDataInterface::getPropertyDefinitions	1
Entity::getPropertyPath	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getPropertyPath(). Overrides TypedDataInterface::getPropertyPath
Entity::getPropertyValues	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::getPropertyValues(). Overrides ComplexDataInterface::getPropertyValues	1
Entity::getRevisionId	public	function	Implements \Drupal\Core\Entity\EntityInterface::getRevisionId(). Overrides EntityInterface::getRevisionId	4
Entity::getRoot	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getRoot(). Overrides TypedDataInterface::getRoot
Entity::getString	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getString(). Overrides TypedDataInterface::getString
Entity::getTranslation	public	function	Implements \Drupal\Core\TypedData\TranslatableInterface::getTranslation(). Overrides TranslatableInterface::getTranslation	1
Entity::getTranslationLanguages	public	function	Implements \Drupal\Core\TypedData\TranslatableInterface::getTranslationLanguages(). Overrides TranslatableInterface::getTranslationLanguages	1
Entity::getType	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getType(). Overrides TypedDataInterface::getType	2
Entity::getValue	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::getValue(). Overrides TypedDataInterface::getValue
Entity::id	public	function	Implements \Drupal\Core\Entity\EntityInterface::id(). Overrides EntityInterface::id	11
Entity::isDefaultRevision	public	function	Implements \Drupal\Core\Entity\EntityInterface::isDefaultRevision(). Overrides EntityInterface::isDefaultRevision	1
Entity::isEmpty	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::isEmpty(). Overrides ComplexDataInterface::isEmpty	1
Entity::isNewRevision	public	function	Implements \Drupal\Core\Entity\EntityInterface::isNewRevision(). Overrides EntityInterface::isNewRevision
Entity::isTranslatable	public	function	Implements \Drupal\Core\Entity\EntityInterface::isTranslatable(). Overrides EntityInterface::isTranslatable
Entity::label	public	function	Implements \Drupal\Core\Entity\EntityInterface::label(). Overrides EntityInterface::label	4
Entity::language	public	function	Implements \Drupal\Core\TypedData\TranslatableInterface::language(). Overrides TranslatableInterface::language	1
Entity::onChange	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::onChange(). Overrides ComplexDataInterface::onChange
Entity::save	public	function	Implements \Drupal\Core\Entity\EntityInterface::save(). Overrides EntityInterface::save	6
Entity::setContext	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::setContext(). Overrides TypedDataInterface::setContext
Entity::setNewRevision	public	function	Implements \Drupal\Core\Entity\EntityInterface::setNewRevision(). Overrides EntityInterface::setNewRevision
Entity::setPropertyValues	public	function	Implements \Drupal\Core\TypedData\ComplexDataInterface::setPropertyValues(). Overrides ComplexDataInterface::setPropertyValues	1
Entity::setValue	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::setValue(). Overrides TypedDataInterface::setValue
Entity::translations	public	function	Returns the languages the entity is translated to.	1
Entity::uri	public	function	Implements \Drupal\Core\Entity\EntityInterface::uri(). Overrides EntityInterface::uri	8
Entity::uriRelationships	public	function	Returns a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::uuid	public	function	Implements \Drupal\Core\Entity\EntityInterface::uuid(). Overrides EntityInterface::uuid	1
Entity::validate	public	function	Implements \Drupal\Core\TypedData\TypedDataInterface::validate(). Overrides TypedDataInterface::validate	1
EntityViewMode::$id	public	property	The ID of the view mode.
EntityViewMode::$label	public	property	The human-readable name of the view mode.
EntityViewMode::$status	public	property	Whether or not this view mode has custom settings by default. Overrides ConfigEntityBase::$status
EntityViewMode::$targetEntityType	public	property	The entity type this view mode is used for.
EntityViewMode::$uuid	public	property	The UUID of the view mode.