interface RevisionLogInterface

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

Defines methods for an entity that supports revision logging and ownership.

Hierarchy

  • interface \Drupal\Core\Entity\RevisionLogInterface extends \Drupal\Core\Entity\RevisionableInterface

Expanded class hierarchy of RevisionLogInterface

All classes that implement RevisionLogInterface

Related topics

Entity type characteristics
Describes how to enhance entity types with additional functionality.
17 files declare their use of RevisionLogInterface
BlockContentInterface.php in core/modules/block_content/src/BlockContentInterface.php
EntityFieldTest.php in core/tests/Drupal/KernelTests/Core/Entity/EntityFieldTest.php
EntityModerationForm.php in core/modules/content_moderation/src/Form/EntityModerationForm.php
EntityResource.php in core/modules/jsonapi/src/Controller/EntityResource.php
EntityRevisionViewController.php in core/lib/Drupal/Core/Entity/Controller/EntityRevisionViewController.php

... See full list

File

View on git.drupalcode.org

core/lib/Drupal/Core/Entity/RevisionLogInterface.php, line 12

Namespace

Drupal\Core\Entity
View source 
interface RevisionLogInterface extends RevisionableInterface {
  
  /**
   * Gets the entity revision creation timestamp.
   *
   * @return int
   *   The UNIX timestamp of when this revision was created.
   */
  public function getRevisionCreationTime();
  
  /**
   * Sets the entity revision creation timestamp.
   *
   * @param int $timestamp
   *   The UNIX timestamp of when this revision was created.
   *
   * @return $this
   */
  public function setRevisionCreationTime($timestamp);
  
  /**
   * Gets the entity revision author.
   *
   * @return \Drupal\user\UserInterface|null
   *   The user entity for the revision author, or NULL if not set or user was
   *   deleted.
   */
  public function getRevisionUser();
  
  /**
   * Sets the entity revision author.
   *
   * @param \Drupal\user\UserInterface $account
   *   The user account of the revision author.
   *
   * @return $this
   */
  public function setRevisionUser(UserInterface $account);
  
  /**
   * Gets the entity revision author ID.
   *
   * @return int|null
   *   The user ID, or NULL if not set or user was deleted.
   */
  public function getRevisionUserId();
  
  /**
   * Sets the entity revision author by ID.
   *
   * @param int $user_id
   *   The user ID of the revision author.
   *
   * @return $this
   */
  public function setRevisionUserId($user_id);
  
  /**
   * Returns the entity revision log message.
   *
   * @return string|null
   *   The revision log message, or NULL if not set.
   */
  public function getRevisionLogMessage();
  
  /**
   * Sets the entity revision log message.
   *
   * @param string $revision_log_message
   *   The revision log message.
   *
   * @return $this
   */
  public function setRevisionLogMessage($revision_log_message);

}

Members

Title Modifiers Object type Summary Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 36
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 36
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginal public function Returns the original unchanged entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 2
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginal public function Sets the original unchanged entity. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
RevisionableInterface::getLoadedRevisionId public function Gets the loaded Revision ID of the entity. 2
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity. 2
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision. 2
RevisionableInterface::isLatestRevision public function Checks if this entity is the latest revision. 2
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save. 2
RevisionableInterface::preSaveRevision public function Acts on a revision before it gets saved. 2
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision. 2
RevisionableInterface::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID. 2
RevisionableInterface::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved. 2
RevisionLogInterface::getRevisionCreationTime public function Gets the entity revision creation timestamp. 1
RevisionLogInterface::getRevisionLogMessage public function Returns the entity revision log message.
RevisionLogInterface::getRevisionUser public function Gets the entity revision author.
RevisionLogInterface::getRevisionUserId public function Gets the entity revision author ID.
RevisionLogInterface::setRevisionCreationTime public function Sets the entity revision creation timestamp. 1
RevisionLogInterface::setRevisionLogMessage public function Sets the entity revision log message.
RevisionLogInterface::setRevisionUser public function Sets the entity revision author.
RevisionLogInterface::setRevisionUserId public function Sets the entity revision author by ID.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.