3 namespace Drupal\Core\Entity;
5 use Drupal\Core\Field\BaseFieldDefinition;
6 use Drupal\user\UserInterface;
9 * Provides a trait for accessing revision logging and ownership information.
13 trait RevisionLogEntityTrait {
16 * Provides revision-related base field definitions for an entity type.
18 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
19 * The entity type definition.
21 * @return \Drupal\Core\Field\FieldDefinitionInterface[]
22 * An array of base field definitions for the entity type, keyed by field
25 * @see \Drupal\Core\Entity\FieldableEntityInterface::baseFieldDefinitions()
27 public static function revisionLogBaseFieldDefinitions(EntityTypeInterface $entity_type) {
28 $fields['revision_created'] = BaseFieldDefinition::create('created')
29 ->setLabel(t('Revision create time'))
30 ->setDescription(t('The time that the current revision was created.'))
31 ->setRevisionable(TRUE);
33 $fields['revision_user'] = BaseFieldDefinition::create('entity_reference')
34 ->setLabel(t('Revision user'))
35 ->setDescription(t('The user ID of the author of the current revision.'))
36 ->setSetting('target_type', 'user')
37 ->setRevisionable(TRUE);
39 $fields['revision_log_message'] = BaseFieldDefinition::create('string_long')
40 ->setLabel(t('Revision log message'))
41 ->setDescription(t('Briefly describe the changes you have made.'))
42 ->setRevisionable(TRUE)
44 ->setDisplayOptions('form', [
45 'type' => 'string_textarea',
56 * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().
58 public function getRevisionCreationTime() {
59 return $this->revision_created->value;
63 * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().
65 public function setRevisionCreationTime($timestamp) {
66 $this->revision_created->value = $timestamp;
71 * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().
73 public function getRevisionUser() {
74 return $this->revision_user->entity;
78 * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().
80 public function setRevisionUser(UserInterface $account) {
81 $this->revision_user->entity = $account;
86 * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().
88 public function getRevisionUserId() {
89 return $this->revision_user->target_id;
93 * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().
95 public function setRevisionUserId($user_id) {
96 $this->revision_user->target_id = $user_id;
101 * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().
103 public function getRevisionLogMessage() {
104 return $this->revision_log_message->value;
108 * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().
110 public function setRevisionLogMessage($revision_log_message) {
111 $this->revision_log_message->value = $revision_log_message;