interface RevisionableStorageInterface in Drupal 10

A storage that supports revisionable entity types.

Hierarchy

• interface \Drupal\Core\Entity\EntityStorageInterface
  • interface \Drupal\Core\Entity\RevisionableStorageInterface

1 file declares its use of RevisionableStorageInterface

EntityResource.php in core/modules/jsonapi/src/Controller/EntityResource.php

File

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

Namespace

Drupal\Core\Entity

interface RevisionableStorageInterface extends EntityStorageInterface {

  /**
   * Creates a new revision starting off from the specified entity object.
   *
   * @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.
   *
   * @return \Drupal\Core\Entity\RevisionableInterface
   *   A new entity revision object.
   */
  public function createRevision(RevisionableInterface $entity, $default = TRUE);

  /**
   * Loads a specific entity revision.
   *
   * @param int $revision_id
   *   The revision ID.
   *
   * @return \Drupal\Core\Entity\RevisionableInterface|null
   *   The specified entity revision or NULL if not found.
   */
  public function loadRevision($revision_id);

  /**
   * Loads multiple entity revisions.
   *
   * @param array $revision_ids
   *   An array of revision IDs to load.
   *
   * @return \Drupal\Core\Entity\RevisionableInterface[]
   *   An array of entity revisions keyed by their revision ID, or an empty
   *   array if none found.
   */
  public function loadMultipleRevisions(array $revision_ids);

  /**
   * Deletes a specific entity revision.
   *
   * A revision can only be deleted if it's not the currently active one.
   *
   * @param int $revision_id
   *   The revision ID.
   */
  public function deleteRevision($revision_id);

  /**
   * Returns the latest revision identifier for an entity.
   *
   * @param int|string $entity_id
   *   The entity identifier.
   *
   * @return int|string|null
   *   The latest revision identifier or NULL if no revision could be found.
   */
  public function getLatestRevisionId($entity_id);

}

Members

Name	Modifiers	Type	Description	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.	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::createRevision	public	function	Creates a new revision starting off from the specified entity object.	1
RevisionableStorageInterface::deleteRevision	public	function	Deletes a specific entity revision. Overrides EntityStorageInterface::deleteRevision
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. Overrides EntityStorageInterface::loadRevision