RevisionLogInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Entity/RevisionLogInterface.php
  2. 10 core/lib/Drupal/Core/Entity/RevisionLogInterface.php
  3. 11.x core/lib/Drupal/Core/Entity/RevisionLogInterface.php

Namespace

Drupal\Core\Entity

File

core/lib/Drupal/Core/Entity/RevisionLogInterface.php

View source
<?php

namespace Drupal\Core\Entity;

use Drupal\user\UserInterface;

/**
 * Defines methods for an entity that supports revision logging and ownership.
 */
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
     *   The user entity for the revision author.
     */
    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
     *   The user ID.
     */
    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
     *   The revision log message.
     */
    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);

}

Interfaces

Title Deprecated Summary
RevisionLogInterface Defines methods for an entity that supports revision logging and ownership.

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