interface ContentEntityInterface

Defines a common interface for all content entity objects.

Content entities use fields for all their entity properties and can be translatable and revisionable. Translations and revisions can be enabled per entity type through annotation and using entity type hooks.

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

Expanded class hierarchy of ContentEntityInterface

All classes that implement ContentEntityInterface

See also

\Drupal\Core\Entity\ContentEntityBase

\Drupal\Core\Entity\EntityTypeInterface

Related topics

File

core/lib/Drupal/Core/Entity/ContentEntityInterface.php, line 24

Namespace

interface ContentEntityInterface extends \Traversable, FieldableEntityInterface, TranslatableRevisionableInterface, SynchronizableInterface {

}

Members

Name contains

Name does not contain

Type

Name	Modifiers	Type	Description	Overrides
FieldableEntityInterface::hasField	public	function	Determines whether the entity has a field with the given name.
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::toArray	public	function	Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::get	public	function	Gets a field item list.
FieldableEntityInterface::set	public	function	Sets a field value.
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::onChange	public	function	Reacts to changes to a field.
FieldableEntityInterface::validate	public	function	Validates the currently set values.	1
FieldableEntityInterface::isValidationRequired	public	function	Checks whether entity validation is required before saving the entity.
FieldableEntityInterface::setValidationRequired	public	function	Sets whether entity validation is required before saving the entity.
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	1
EntityInterface::id	public	function	Gets the identifier.	1
EntityInterface::language	public	function	Gets the language of the entity.	1
EntityInterface::isNew	public	function	Determines whether the entity is new.	1
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	1
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	1
EntityInterface::bundle	public	function	Gets the bundle of the entity.	1
EntityInterface::label	public	function	Gets the label of the entity.	3
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	1
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	1
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	1
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	1
EntityInterface::save	public	function	Saves an entity permanently.	3
EntityInterface::delete	public	function	Deletes an entity permanently.	1
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	8
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	8
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	1
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	1
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	1
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	3
EntityInterface::setOriginalId	public	function	Sets the original ID.	1
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	1
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
AccessibleInterface::access	public	function	Checks data value access.	6
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	12
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	12
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	12
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.
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision	public	function	Checks whether this is the latest revision affecting this translation.
TranslatableRevisionableInterface::setRevisionTranslationAffected	public	function	Marks the current revision translation as affected.
TranslatableRevisionableInterface::isRevisionTranslationAffected	public	function	Checks whether the current translation is affected by the current revision.
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced	public	function	Checks if the revision translation affected flag value has been enforced.
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced	public	function	Enforces the revision translation affected flag value.
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly	public	function	Checks if untranslatable fields should affect only the default translation.
TranslatableInterface::hasTranslationChanges	public	function	Determines if the current translation of the entity has unsaved changes.
TranslatableInterface::isDefaultTranslation	public	function	Checks whether the translation is the default one.
TranslatableInterface::isNewTranslation	public	function	Checks whether the translation is new.
TranslatableInterface::getTranslationLanguages	public	function	Returns the languages the data is translated to.
TranslatableInterface::getTranslation	public	function	Gets a translation of the data.
TranslatableInterface::getUntranslated	public	function	Returns the translatable object in the language it was created.
TranslatableInterface::hasTranslation	public	function	Checks there is a translation for the given language code.
TranslatableInterface::addTranslation	public	function	Adds a new translation to the translatable object.
TranslatableInterface::removeTranslation	public	function	Removes the translation identified by the given language code.
TranslatableInterface::isTranslatable	public	function	Returns the translation support status.
RevisionableInterface::isNewRevision	public	function	Determines whether a new revision should be created on save.
RevisionableInterface::setNewRevision	public	function	Enforces an entity to be saved as a new revision.
RevisionableInterface::getRevisionId	public	function	Gets the revision identifier of the entity.
RevisionableInterface::getLoadedRevisionId	public	function	Gets the loaded Revision ID of the entity.
RevisionableInterface::updateLoadedRevisionId	public	function	Updates the loaded Revision ID with the revision ID.
RevisionableInterface::isDefaultRevision	public	function	Checks if this entity is the default revision.
RevisionableInterface::wasDefaultRevision	public	function	Checks whether the entity object was a default revision when it was saved.
RevisionableInterface::isLatestRevision	public	function	Checks if this entity is the latest revision.
RevisionableInterface::preSaveRevision	public	function	Acts on a revision before it gets saved.	3
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.
FieldableEntityInterface::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type.	7
FieldableEntityInterface::bundleFieldDefinitions	public static	function	Provides field definitions for a specific bundle.	2
EntityInterface::load	public static	function	Loads an entity.	1
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	1
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	1
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::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