aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Entity/RevisionLogInterface.php

   1 <?php
   2
   3 namespace Drupal\Core\Entity;
   4
   5 use Drupal\user\UserInterface;
   6
   7 /**
   8  * Defines methods for an entity that supports revision logging and ownership.
   9  */
  10 interface RevisionLogInterface extends RevisionableInterface {
  11
  12   /**
  13    * Gets the entity revision creation timestamp.
  14    *
  15    * @return int
  16    *   The UNIX timestamp of when this revision was created.
  17    */
  18   public function getRevisionCreationTime();
  19
  20   /**
  21    * Sets the entity revision creation timestamp.
  22    *
  23    * @param int $timestamp
  24    *   The UNIX timestamp of when this revision was created.
  25    *
  26    * @return $this
  27    */
  28   public function setRevisionCreationTime($timestamp);
  29
  30   /**
  31    * Gets the entity revision author.
  32    *
  33    * @return \Drupal\user\UserInterface
  34    *   The user entity for the revision author.
  35    */
  36   public function getRevisionUser();
  37
  38   /**
  39    * Sets the entity revision author.
  40    *
  41    * @param \Drupal\user\UserInterface $account
  42    *   The user account of the revision author.
  43    *
  44    * @return $this
  45    */
  46   public function setRevisionUser(UserInterface $account);
  47
  48   /**
  49    * Gets the entity revision author ID.
  50    *
  51    * @return int
  52    *   The user ID.
  53    */
  54   public function getRevisionUserId();
  55
  56   /**
  57    * Sets the entity revision author by ID.
  58    *
  59    * @param int $user_id
  60    *   The user ID of the revision author.
  61    *
  62    * @return $this
  63    */
  64   public function setRevisionUserId($user_id);
  65
  66   /**
  67    * Returns the entity revision log message.
  68    *
  69    * @return string
  70    *   The revision log message.
  71    */
  72   public function getRevisionLogMessage();
  73
  74   /**
  75    * Sets the entity revision log message.
  76    *
  77    * @param string $revision_log_message
  78    *   The revision log message.
  79    *
  80    * @return $this
  81    */
  82   public function setRevisionLogMessage($revision_log_message);
  83
  84 }