interface LogStorageInterface in Log entity 8

Defines an interface for log entity storage classes.

Hierarchy

• interface \Drupal\Core\Entity\EntityStorageInterface; interface \Drupal\Core\Entity\TranslatableRevisionableStorageInterface
  • interface \Drupal\Core\Entity\ContentEntityStorageInterface
    • interface \Drupal\log\LogStorageInterface

File

src/LogStorageInterface.php, line 17

Contains \Drupal\log\LogStorageInterface.

Namespace

Drupal\log

interface LogStorageInterface extends ContentEntityStorageInterface {

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

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

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

  /**
   * Updates all logs of one type to be of another type.
   *
   * @param string $old_type
   *   The current log type of the logs.
   * @param string $new_type
   *   The new log type of the logs.
   *
   * @return int
   *   The number of logs whose log type field was modified.
   */
  public function updateType($old_type, $new_type);

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

}

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
LogStorageInterface::clearRevisionsLanguage	public	function	Unsets the language for all logs with the given language.	1
LogStorageInterface::countDefaultLanguageRevisions	public	function	Counts the number of revisions in the default language.	1
LogStorageInterface::revisionIds	public	function	Gets a list of log revision IDs for a specific log.	1
LogStorageInterface::updateType	public	function	Updates all logs of one type to be of another type.	1
LogStorageInterface::userRevisionIds	public	function	Gets a list of revision IDs having a given user as log 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