interface WorkspaceAssociationStorageInterface in Workspace 8.2

Defines an interface for workspace association entity storage classes.

Hierarchy

• interface \Drupal\Core\Entity\EntityStorageInterface; interface \Drupal\Core\Entity\TranslatableRevisionableStorageInterface
  • interface \Drupal\Core\Entity\ContentEntityStorageInterface
    • interface \Drupal\workspace\WorkspaceAssociationStorageInterface

1 file declares its use of WorkspaceAssociationStorageInterface

DeletedWorkspaceConstraintValidator.php in src/Plugin/Validation/Constraint/DeletedWorkspaceConstraintValidator.php

File

src/WorkspaceAssociationStorageInterface.php, line 11

Namespace

Drupal\workspace

interface WorkspaceAssociationStorageInterface extends ContentEntityStorageInterface {

  /**
   * Triggers clean-up operations after pushing.
   *
   * @param \Drupal\workspace\WorkspaceInterface $workspace
   *   A workspace entity.
   */
  public function postPush(WorkspaceInterface $workspace);

  /**
   * Retrieves the content revisions tracked by a given workspace.
   *
   * @param string $workspace_id
   *   The ID of the workspace.
   * @param bool $all_revisions
   *   (optional) Whether to return all the tracked revisions for each entity or
   *   just the latest tracked revision. Defaults to FALSE.
   *
   * @return array
   *   Returns a multidimensional array where the first level keys are entity
   *   type IDs and the values are an array of entity IDs keyed by revision IDs.
   */
  public function getTrackedEntities($workspace_id, $all_revisions = FALSE);

  /**
   * Gets a list of workspace IDs in which an entity is tracked.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   An entity object.
   *
   * @return string[]
   *   An array of workspace IDs where the given entity is tracked, or an empty
   *   array if it is not tracked anywhere.
   */
  public function getEntityTrackingWorkspaceIds(EntityInterface $entity);

}

Members

Name	Modifiers	Type	Description	Overrides
ContentEntityStorageInterface::createWithSampleValues	public	function	Creates an entity with sample field values.	2
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::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::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, static entity cache.	1
EntityStorageInterface::restore	public	function	Restores a previously saved entity.	1
EntityStorageInterface::save	public	function	Saves the entity permanently.	1
RevisionableStorageInterface::getLatestRevisionId	public	function	Returns the latest revision identifier for an entity.	2
RevisionableStorageInterface::loadMultipleRevisions	public	function	Loads multiple entity revisions.	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
WorkspaceAssociationStorageInterface::getEntityTrackingWorkspaceIds	public	function	Gets a list of workspace IDs in which an entity is tracked.	1
WorkspaceAssociationStorageInterface::getTrackedEntities	public	function	Retrieves the content revisions tracked by a given workspace.	1
WorkspaceAssociationStorageInterface::postPush	public	function	Triggers clean-up operations after pushing.	1