Defines a common interface for all content entity objects.
Content entities use fields for all their entity properties and are translatable and revisionable, while translations and revisions can be enabled per entity type. It's best practice to always implement ContentEntityInterface for content-like entities that should be stored in some database, and enable/disable revisions and translations as desired.
When implementing this interface which extends Traversable, make sure to list IteratorAggregate or Iterator before this interface in the implements clause.
Hierarchy
- interface \Drupal\Core\Entity\FieldableEntityInterface; interface \Drupal\Core\Entity\RevisionableInterface; interface \Drupal\Core\TypedData\TranslatableInterface
- interface \Drupal\Core\Entity\ContentEntityInterface extends \Traversable
See also
\Drupal\Core\Entity\ContentEntityBase
Related topics
- Entity API
- Describes how to define and manipulate content and configuration entities.
File
- core/lib/Drupal/Core/Entity/ContentEntityInterface.php, line 23
Namespace
Drupal\Core\Entity
Members
Name | Modifiers | Type | Description |
---|---|---|---|
AccessibleInterface::access | public | function | Checks data value access. |
CacheableDependencyInterface::getCacheContexts | public | function | The cache contexts associated with this object. |
CacheableDependencyInterface::getCacheMaxAge | public | function | The maximum age for which this object may be cached. |
CacheableDependencyInterface::getCacheTags | public | function | The cache tags associated with this object. |
ContentEntityInterface::hasTranslationChanges | public | function | Determines if the current translation of the entity has unsaved changes. |
ContentEntityInterface::isRevisionTranslationAffected | public | function | Checks whether the current translation is affected by the current revision. |
ContentEntityInterface::setRevisionTranslationAffected | public | function | Marks the current revision translation as affected. |
EntityInterface::bundle | public | function | Gets the bundle of the entity. |
EntityInterface::create | public static | function | Constructs a new entity object, without permanently saving it. |
EntityInterface::createDuplicate | public | function | Creates a duplicate of the entity. |
EntityInterface::delete | public | function | Deletes an entity permanently. |
EntityInterface::enforceIsNew | public | function | Enforces an entity to be new. |
EntityInterface::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. |
EntityInterface::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. |
EntityInterface::getConfigDependencyName | public | function | Gets the configuration dependency name. |
EntityInterface::getConfigTarget | public | function | Gets the configuration target identifier for the entity. |
EntityInterface::getEntityType | public | function | Gets the entity type definition. |
EntityInterface::getEntityTypeId | public | function | Gets the ID of the type of the entity. |
EntityInterface::getOriginalId | public | function | Gets the original ID. |
EntityInterface::getTypedData | public | function | Gets a typed data object for this entity object. |
EntityInterface::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. |
EntityInterface::id | public | function | Gets the identifier. |
EntityInterface::isNew | public | function | Determines whether the entity is new. |
EntityInterface::label | public | function | Gets the label of the entity. |
EntityInterface::language | public | function | Gets the language of the entity. |
EntityInterface::link Deprecated | public | function | Deprecated way of generating a link to the entity. See toLink(). |
EntityInterface::load | public static | function | Loads an entity. |
EntityInterface::loadMultiple | public static | function | Loads one or more entities. |
EntityInterface::postCreate | public | function | Acts on a created entity before hooks are invoked. |
EntityInterface::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. |
EntityInterface::postLoad | public static | function | Acts on loaded entities. Overrides EntityInterface::postLoad |
EntityInterface::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. |
EntityInterface::preCreate | public static | function | Changes the values of an entity before it is created. |
EntityInterface::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. |
EntityInterface::preSave | public | function | Acts on an entity before the presave hook is invoked. |
EntityInterface::referencedEntities | public | function | Gets a list of entities referenced by this entity. |
EntityInterface::save | public | function | Saves an entity permanently. |
EntityInterface::setOriginalId | public | function | Sets the original ID. |
EntityInterface::toLink | public | function | Generates the HTML for a link to this entity. |
EntityInterface::toUrl | public | function | Gets the URL object for the entity. |
EntityInterface::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. |
EntityInterface::url Deprecated | public | function | Gets the public URL for this entity. |
EntityInterface::urlInfo Deprecated | public | function | Gets the URL object for the entity. |
EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). |
FieldableEntityInterface::baseFieldDefinitions | public static | function | Provides base field definitions for an entity type. |
FieldableEntityInterface::bundleFieldDefinitions | public static | function | Provides field definitions for a specific bundle. |
FieldableEntityInterface::get | public | function | Gets a field item list. |
FieldableEntityInterface::getFieldDefinition | public | function | Gets the definition of a contained field. |
FieldableEntityInterface::getFieldDefinitions | public | function | Gets an array of field definitions of all contained fields. |
FieldableEntityInterface::getFields | public | function | Gets an array of all field item lists. |
FieldableEntityInterface::getTranslatableFields | public | function | Gets an array of field item lists for translatable fields. |
FieldableEntityInterface::hasField | public | function | Determines whether the entity has a field with the given name. |
FieldableEntityInterface::isValidationRequired | public | function | Checks whether entity validation is required before saving the entity. |
FieldableEntityInterface::onChange | public | function | Reacts to changes to a field. |
FieldableEntityInterface::set | public | function | Sets a field value. |
FieldableEntityInterface::setValidationRequired | public | function | Sets whether entity validation is required before saving the entity. |
FieldableEntityInterface::toArray | public | function | Gets an array of all field values. Overrides EntityInterface::toArray |
FieldableEntityInterface::validate | public | function | Validates the currently set values. |
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. |
RevisionableInterface::getRevisionId | public | function | Gets the revision identifier of the entity. |
RevisionableInterface::isDefaultRevision | public | function | Checks if this entity is the default revision. |
RevisionableInterface::isNewRevision | public | function | Determines whether a new revision should be created on save. |
RevisionableInterface::preSaveRevision | public | function | Acts on a revision before it gets saved. |
RevisionableInterface::setNewRevision | public | function | Enforces an entity to be saved as a new revision. |
TranslatableInterface::addTranslation | public | function | Adds a new translation to the translatable object. |
TranslatableInterface::getTranslation | public | function | Gets a translation of the data. |
TranslatableInterface::getTranslationLanguages | public | function | Returns the languages the data is translated to. |
TranslatableInterface::getUntranslated | public | function | Returns the translatable object referring to the original language. |
TranslatableInterface::hasTranslation | public | function | Returns TRUE there is a translation for the given language code. |
TranslatableInterface::isDefaultTranslation | public | function | Checks whether the translation is the default one. |
TranslatableInterface::isNewTranslation | public | function | Checks whether the translation is new. |
TranslatableInterface::isTranslatable | public | function | Returns the translation support status. |
TranslatableInterface::removeTranslation | public | function | Removes the translation identified by the given language code. |
Please login to continue.