Term

Sets cacheability; useful for value object constructors.

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

Constructs an Entity object.

Gets the entity type manager.

Gets the entity type bundle info service.

Gets the language manager.

Gets the UUID generator.

Gets the identifier.

Gets the entity UUID (Universally Unique Identifier).

The UUID is guaranteed to be unique and can be used to identify an entity across multiple systems.

Determines whether the entity is new.

Usually an entity is new if no ID exists for it yet. However, entities may be enforced to be new with existing IDs too.

Enforces an entity to be new.

Allows migrations to create entities with pre-defined IDs by forcing the entity to be new before saving.

Gets the ID of the type of the entity.

Gets the bundle of the entity.

Gets the label of the entity.

Gets the URL object for the entity.

The entity must have an id already. Content entities usually get their IDs by saving them.

URI templates might be set in the links array in an annotation, for example:

Indicates if a link template exists for a given key.

Gets an array link templates.

Generates the HTML for a link to this entity.

Gets an array of placeholders for this entity.

Individual entity classes may override this method to add additional placeholders if desired. If so, they should be sure to replicate the property caching logic.

Gets a list of URI relationships supported by this entity.

Checks data value access.

Gets the language of the entity.

Saves an entity permanently.

When saving existing entities, the entity is assumed to be complete, partial updates of entities are not supported.

Deletes an entity permanently.

Creates a duplicate of the entity.

Gets the entity type definition.

Acts on an entity before the presave hook is invoked.

Used before the entity is saved and before invoking the presave hook. Note that in case of translatable content entities this callback is only fired on their current translation. It is up to the developer to iterate over all translations if needed. This is different from its counterpart in the Field API, FieldItemListInterface::preSave(), which is fired on all field translations automatically.

Acts on a saved entity before the insert or update hook is invoked.

Used after the entity is saved, but before invoking the insert or update hook. Note that in case of translatable content entities this callback is only fired on their current translation. It is up to the developer to iterate over all translations if needed.

Changes the values of an entity before it is created.

Load defaults for example.

Acts on a created entity before hooks are invoked.

Used after the entity is created, but before saving the entity and before any of the presave hooks are invoked.

See the @link entity_crud Entity CRUD topic @endlink for more information.

Acts on entities before they are deleted and before hooks are invoked.

Used before the entities are deleted and before invoking the delete hook.

Acts on deleted entities before the delete hook is invoked.

Used after the entities are deleted but before invoking the delete hook.

Acts on loaded entities.

Gets a list of entities referenced by this entity.

The list cache tags to invalidate for this entity.

Returns the cache tags that should be used to invalidate caches.

This will not return additional cache tags added through addCacheTags().

Loads an entity.

Loads one or more entities.

Constructs a new entity object, without permanently saving it.

Invalidates an entity's cache tags upon save.

Invalidates an entity's cache tags upon delete.

Gets the original ID.

Sets the original ID.

Gets an array of all property values.

Gets a typed data object for this entity object.

The returned typed data object wraps this entity and allows dealing with entities based on the generic typed data API.

Gets the key that is used to store configuration dependencies.

Gets the configuration dependency name.

Configuration entities can depend on content and configuration entities. They store an array of content and config dependency names in their "dependencies" key.

Gets the configuration target identifier for the entity.

Used to supply the correct format for storing a reference targeting this entity in configuration.

Returns an array of field names to skip when checking for changes.

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

Enforces an entity to be saved as a new revision.

Gets the loaded Revision ID of the entity.

Updates the loaded Revision ID with the revision ID.

This method should not be used, it could unintentionally cause the original revision ID property value to be lost.

Determines whether a new revision should be created on save.

Checks if this entity is the default revision.

Checks whether the entity object was a default revision when it was saved.

Checks if this entity is the latest revision.

Checks whether this is the latest revision affecting this translation.

Checks whether the current translation is affected by the current revision.

Marks the current revision translation as affected.

Setting the revision translation affected flag through the setter or through the field directly will always enforce it, which will be used by the entity storage to determine if the flag should be recomputed or the set value should be used instead.

Checks if the revision translation affected flag value has been enforced.

Enforces the revision translation affected flag value.

Note that this method call will not have any influence on the storage if the value of the revision translation affected flag is NULL which is used as an indication for the storage to recompute the flag.

Checks whether the translation is the default one.

Gets the revision identifier of the entity.

Returns the translation support status.

Acts on a revision before it gets saved.

Validates the currently set values.

Checks whether entity validation is required before saving the entity.

Sets whether entity validation is required before saving the entity.

Clear entity translation object cache to remove stale references.

Determines whether the entity has a field with the given name.

Gets a field item list.

Gets a translated field.

Sets a field value.

Gets an array of all field item lists.

Gets an array of field item lists for translatable fields.

{@inheritdoc}

Gets the definition of a contained field.

Gets an array of field definitions of all contained fields.

Populates the local cache for the default language code.

Updates language for already instantiated fields.

Reacts to changes to a field.

Note that this is invoked after any changes have been applied.

Gets a translation of the data.

The returned translation has to be of the same type than this typed data object.

Returns the translatable object referring to the original language.

Instantiates a translation object for an existing translation.

The translated entity will be a clone of the current entity with the specified $langcode. All translations share the same field data structures to ensure that all of them deal with fresh data.

Checks there is a translation for the given language code.

Checks whether the translation is new.

Adds a new translation to the translatable object.

To create a translation of an entity prefilled with the original data:

Removes the translation identified by the given language code.

Returns the translation status.

Returns the languages the data is translated to.

Updates the original values with the interim changes.

Implements the magic method for getting object properties.

Implements the magic method for setting object properties.

Uses default language always.

Implements the magic method for isset().

Implements the magic method for unset().

Magic method: Implements a deep clone.

Gets the value of the given entity key, if defined.

Provides base field definitions for an entity type.

Implementations typically use the class \Drupal\Core\Field\BaseFieldDefinition for creating the field definitions; for example a 'name' field could be defined as the following:

Provides field definitions for a specific bundle.

This function can return definitions both for bundle fields (fields that are not defined in $base_field_definitions, and therefore might not exist on some bundles) as well as bundle-specific overrides of base fields (fields that are defined in $base_field_definitions, and therefore exist for all bundles). However, bundle-specific base field overrides can also be provided by 'base_field_override' configuration entities, and that is the recommended approach except in cases where an entity type needs to provide a bundle-specific base field override that is decoupled from configuration. Note that for most entity types, the bundles themselves are derived from configuration (e.g., 'node' bundles are managed via 'node_type' configuration entities), so decoupling bundle-specific base field overrides from configuration only makes sense for entity types that also decouple their bundles from configuration. In cases where both this function returns a bundle-specific override of a base field and a 'base_field_override' configuration entity exists, the latter takes precedence.

Determines if the current translation of the entity has unsaved changes.

Checks if untranslatable fields should affect only the default translation.

Returns the timestamp of the last entity change across all translations.

Gets the timestamp of the last entity change for the current translation.

Sets the timestamp of the last entity change for the current translation.

Returns an array of base field definitions for publishing status.

{@inheritdoc}

{@inheritdoc}

{@inheritdoc}

Provides revision-related base field definitions for an entity type.

Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().

Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().

Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().

Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().

Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().

Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().

Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().

Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().

Gets the name of a revision metadata field.

Gets the term description.

Sets the term description.

Gets the text format name for the term description.

Sets the text format name for the term description.

Gets the term name.

Sets the term name.

Gets the term weight.

Sets the term weight.