FileInterface

Checks data value access.

The cache contexts associated with this object.

These identify a specific variation/representation of the object.

Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.

The cache tags associated with this object.

When this object is modified, these cache tags will be invalidated.

The maximum age for which this object may be cached.

Adds cache contexts.

Adds cache tags.

Merges the maximum age (in seconds) with the existing maximum age.

The max age will be set to the given value if it is lower than the existing value.

Adds a dependency on an object: merges its cacheability metadata.

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.

Gets the identifier.

Gets the language of the entity.

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:

Generates the HTML for a link to this entity.

Indicates if a link template exists for a given key.

Gets a list of URI relationships supported by this entity.

Loads an entity.

Loads one or more entities.

Constructs a new entity object, without permanently saving it.

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.

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.

Adjust existing implementations and the documentation according to https://www.drupal.org/node/2577609 to have a consistent API.

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.

Creates a duplicate of the entity.

Gets the entity type definition.

Gets a list of entities referenced by this entity.

Gets the original ID.

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

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

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.

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.

WARNING: This method will be changed in https://www.drupal.org/node/2346347.

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

Gets the definition of a contained field.

Gets an array of field definitions of all contained fields.

Gets a field item list.

Sets a field value.

Gets an array of all field item lists.

Gets an array of field item lists for translatable fields.

Reacts to changes to a field.

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

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.

Checks whether the translation is the default one.

Checks whether the translation is new.

Returns the languages the data is translated to.

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.

Checks there is a translation for the given language code.

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 support status.

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

Determines whether a new revision should be created on save.

Enforces an entity to be saved as a new revision.

Gets the revision identifier of the entity.

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.

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.

Acts on a revision before it gets saved.

Checks whether this is the latest revision affecting this translation.

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 whether the current translation is affected by the current revision.

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 if untranslatable fields should affect only the default translation.

Sets the status of the synchronization flag.

Returns whether this entity is being changed as part of a synchronization.

If you are writing code that responds to a change in this entity (insert, update, delete, presave, etc.), and your code would result in a change to this entity itself, a configuration change (whether related to this entity, another entity, or non-entity configuration), you need to check and see if this entity change is part of a synchronization process, and skip executing your code if that is the case.

For example, \Drupal\node\Entity\NodeType::postSave() adds the default body field to newly created node type configuration entities, which is a configuration change. You would not want this code to run during an import, because imported entities were already given the body field when they were originally created, and the imported configuration includes all of their currently-configured fields. On the other hand, \Drupal\field\Entity\FieldStorageConfig::preSave() and the methods it calls make sure that the storage tables are created or updated for the field storage configuration entity, which is not a configuration change, and it must be done whether due to an import or not. So, the first method should check $entity->isSyncing() and skip executing if it returns TRUE, and the second should not perform this check.

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

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

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

This method will return the highest timestamp across all translations. To check that no translation is older than in another version of the entity (e.g. to avoid overwriting newer translations with old data), compare each translation to the other version individually.

Returns the entity owner's user entity.

Sets the entity owner's user entity.

Returns the entity owner's user ID.

Sets the entity owner's user ID.

Returns the name of the file.

This may differ from the basename of the URI if the file is renamed to avoid overwriting an existing file.

Sets the name of the file.

Returns the URI of the file.

Sets the URI of the file.

Creates a file URL for the URI of this file.

Returns the MIME type of the file.

Sets the MIME type of the file.

Returns the size of the file.

Sets the size of the file.

Returns TRUE if the file is permanent.

Returns TRUE if the file is temporary.

Sets the file status to permanent.

Sets the file status to temporary.

Returns the file entity creation timestamp.