interface TranslatableStorageInterface

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

A storage that supports translatable entity types.

Hierarchy

Expanded class hierarchy of TranslatableStorageInterface

All classes that implement TranslatableStorageInterface

File

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

Namespace

Drupal\Core\Entity
View source 
interface TranslatableStorageInterface extends EntityStorageInterface {
    
    /**
     * Constructs a new entity translation object, without permanently saving it.
     *
     * @param \Drupal\Core\Entity\ContentEntityInterface $entity
     *   The entity object being translated.
     * @param string $langcode
     *   The translation language code.
     * @param array $values
     *   (optional) An associative array of initial field values keyed by field
     *   name. If none is provided default values will be applied.
     *
     * @return \Drupal\Core\Entity\ContentEntityInterface
     *   Another instance of the specified entity object class with the specified
     *   active language and initial values.
     *
     * @todo Consider accepting \Drupal\Core\Entity\TranslatableInterface as first
     *   parameter. See https://www.drupal.org/project/drupal/issues/2932049.
     */
    public function createTranslation(ContentEntityInterface $entity, $langcode, array $values = []);

}

Members

Title Modifiers Object type Summary Overrides
EntityStorageInterface::create public function Constructs a new entity object, without permanently saving it. 1
EntityStorageInterface::delete public function Deletes permanently saved entities. 1
EntityStorageInterface::deleteRevision public function Delete a specific entity revision. 4
EntityStorageInterface::FIELD_LOAD_CURRENT constant Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION constant Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery public function Gets an aggregated query instance. 1
EntityStorageInterface::getEntityClass public function Retrieves the class name used to create the entity. 1
EntityStorageInterface::getEntityType public function Gets the entity type definition. 1
EntityStorageInterface::getEntityTypeId public function Gets the entity type ID. 1
EntityStorageInterface::getQuery public function Gets an entity query instance. 1
EntityStorageInterface::hasData public function Determines if the storage contains any data. 1
EntityStorageInterface::load public function Loads one entity. 1
EntityStorageInterface::loadByProperties public function Load entities by their property values without any access checks. 1
EntityStorageInterface::loadMultiple public function Loads one or more entities. 1
EntityStorageInterface::loadRevision public function Load a specific entity revision. 4
EntityStorageInterface::loadUnchanged public function Loads an unchanged entity from the database. 1
EntityStorageInterface::resetCache public function Resets the internal entity cache. 1
EntityStorageInterface::restore public function Restores a previously saved entity. 1
EntityStorageInterface::save public function Saves the entity permanently. 1
TranslatableStorageInterface::createTranslation public function Constructs a new entity translation object, without permanently saving it. 2

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