You are here

interface HeartbeatStorageInterface in Heartbeat 8

Defines the storage handler class for Heartbeat entities.

This extends the base storage class, adding required special handling for Heartbeat entities.

Hierarchy

Expanded class hierarchy of HeartbeatStorageInterface

All classes that implement HeartbeatStorageInterface

File

src/HeartbeatStorageInterface.php, line 18

Namespace

Drupal\heartbeat
View source
interface HeartbeatStorageInterface extends ContentEntityStorageInterface {

  /**
   * Gets a list of Heartbeat revision IDs for a specific Heartbeat.
   *
   * @param \Drupal\heartbeat\Entity\HeartbeatInterface $entity
   *   The Heartbeat entity.
   *
   * @return int[]
   *   Heartbeat revision IDs (in ascending order).
   */
  public function revisionIds(HeartbeatInterface $entity);

  /**
   * Gets a list of revision IDs having a given user as Heartbeat author.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user entity.
   *
   * @return int[]
   *   Heartbeat revision IDs (in ascending order).
   */
  public function userRevisionIds(AccountInterface $account);

  /**
   * Counts the number of revisions in the default language.
   *
   * @param \Drupal\heartbeat\Entity\HeartbeatInterface $entity
   *   The Heartbeat entity.
   *
   * @return int
   *   The number of revisions in the default language.
   */
  public function countDefaultLanguageRevisions(HeartbeatInterface $entity);

  /**
   * Unsets the language for all Heartbeat with the given language.
   *
   * @param \Drupal\Core\Language\LanguageInterface $language
   *   The language object.
   */
  public function clearRevisionsLanguage(LanguageInterface $language);

}

Members

Namesort descending 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
HeartbeatStorageInterface::clearRevisionsLanguage public function Unsets the language for all Heartbeat with the given language. 1
HeartbeatStorageInterface::countDefaultLanguageRevisions public function Counts the number of revisions in the default language. 1
HeartbeatStorageInterface::revisionIds public function Gets a list of Heartbeat revision IDs for a specific Heartbeat. 1
HeartbeatStorageInterface::userRevisionIds public function Gets a list of revision IDs having a given user as Heartbeat author. 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