interface EntityDescriptionInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Entity/EntityDescriptionInterface.php \Drupal\Core\Entity\EntityDescriptionInterface
  2. 8.9.x core/lib/Drupal/Core/Entity/EntityDescriptionInterface.php \Drupal\Core\Entity\EntityDescriptionInterface
  3. 11.x core/lib/Drupal/Core/Entity/EntityDescriptionInterface.php \Drupal\Core\Entity\EntityDescriptionInterface

Defines the interface for entities that have a description.

Hierarchy

Expanded class hierarchy of EntityDescriptionInterface

All classes that implement EntityDescriptionInterface

4 files declare their use of EntityDescriptionInterface
EntityController.php in core/lib/Drupal/Core/Entity/Controller/EntityController.php
EntityTestBundle.php in core/modules/system/tests/modules/entity_test/src/Entity/EntityTestBundle.php
EntityTestMulBundle.php in core/modules/system/tests/modules/entity_test/src/Entity/EntityTestMulBundle.php
MediaTypeInterface.php in core/modules/media/src/MediaTypeInterface.php

File

core/lib/Drupal/Core/Entity/EntityDescriptionInterface.php, line 8

Namespace

Drupal\Core\Entity
View source 
interface EntityDescriptionInterface extends EntityInterface {
    
    /**
     * Gets the entity description.
     *
     * @return string
     *   The entity description.
     */
    public function getDescription();
    
    /**
     * Sets the entity description.
     *
     * @param string $description
     *   The entity description.
     *
     * @return $this
     */
    public function setDescription($description);

}

Members

Title Modifiers Object type Summary Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
EntityDescriptionInterface::getDescription public function Gets the entity description. 3
EntityDescriptionInterface::setDescription public function Sets the entity description. 3
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.