interface TranslatableRevisionableStorageInterface

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

A storage that supports translatable and revisionable entity types.

Hierarchy

Expanded class hierarchy of TranslatableRevisionableStorageInterface

All classes that implement TranslatableRevisionableStorageInterface

File

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

Namespace

Drupal\Core\Entity
View source 
interface TranslatableRevisionableStorageInterface extends RevisionableStorageInterface, TranslatableStorageInterface {
    
    /**
     * Creates a new revision starting off from the specified entity object.
     *
     * When dealing with a translatable entity, this will merge the default
     * revision with the active translation of the passed entity.
     *
     * @param \Drupal\Core\Entity\RevisionableInterface $entity
     *   The revisionable entity object being modified.
     * @param bool $default
     *   (optional) Whether the new revision should be marked as default. Defaults
     *   to TRUE.
     * @param bool|null $keep_untranslatable_fields
     *   (optional) Whether untranslatable field values should be kept or copied
     *   from the default revision when generating a merged revision. Defaults to
     *   TRUE if the provided entity is the default translation and untranslatable
     *   fields should only affect the default translation, FALSE otherwise.
     *
     * @return \Drupal\Core\Entity\TranslatableRevisionableInterface
     *   A new translatable entity revision object.
     */
    public function createRevision(RevisionableInterface $entity, $default = TRUE, $keep_untranslatable_fields = NULL);
    
    /**
     * Returns the latest revision affecting the specified translation.
     *
     * @param int|string $entity_id
     *   The entity identifier.
     * @param string $langcode
     *   The language code of the translation.
     *
     * @return int|string|null
     *   A revision ID or NULL if no revision affecting the specified translation
     *   could be found.
     */
    public function getLatestTranslationAffectedRevisionId($entity_id, $langcode);

}

Members

Title Modifiers Object type Summary Overriden Title 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::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::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
RevisionableStorageInterface::deleteRevision public function Deletes a specific entity revision. 2
RevisionableStorageInterface::getLatestRevisionId public function Returns the latest revision identifier for an entity. 2
RevisionableStorageInterface::loadMultipleRevisions public function Loads multiple entity revisions. 2
RevisionableStorageInterface::loadRevision public function Loads a specific entity revision. 2
TranslatableRevisionableStorageInterface::createRevision public function Creates a new revision starting off from the specified entity object. Overrides RevisionableStorageInterface::createRevision 2
TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId public function Returns the latest revision affecting the specified translation. 2
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.