RevisionLogEntityTrait.php

<?php

namespace Drupal\Core\Entity;

use Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\user\UserInterface;

/**
 * Provides a trait for accessing revision logging and ownership information.
 *
 * @ingroup entity_api
 */
trait RevisionLogEntityTrait {
    
    /**
     * Provides revision-related base field definitions for an entity type.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     *
     * @return \Drupal\Core\Field\FieldDefinitionInterface[]
     *   An array of base field definitions for the entity type, keyed by field
     *   name.
     *
     * @see \Drupal\Core\Entity\FieldableEntityInterface::baseFieldDefinitions()
     */
    public static function revisionLogBaseFieldDefinitions(EntityTypeInterface $entity_type) {
        if (!$entity_type instanceof ContentEntityTypeInterface) {
            throw new UnsupportedEntityTypeDefinitionException('The entity type ' . $entity_type->id() . ' is not a content entity type.');
        }
        foreach ([
            'revision_created',
            'revision_user',
            'revision_log_message',
        ] as $revision_metadata_key) {
            if (!$entity_type->hasRevisionMetadataKey($revision_metadata_key)) {
                throw new UnsupportedEntityTypeDefinitionException('The entity type ' . $entity_type->id() . ' does not have an "' . $revision_metadata_key . '" entity revision metadata key.');
            }
        }
        $fields[$entity_type->getRevisionMetadataKey('revision_created')] = BaseFieldDefinition::create('created')->setLabel(t('Revision create time'))
            ->setDescription(t('The time that the current revision was created.'))
            ->setRevisionable(TRUE);
        $fields[$entity_type->getRevisionMetadataKey('revision_user')] = BaseFieldDefinition::create('entity_reference')->setLabel(t('Revision user'))
            ->setDescription(t('The user ID of the author of the current revision.'))
            ->setSetting('target_type', 'user')
            ->setRevisionable(TRUE);
        $fields[$entity_type->getRevisionMetadataKey('revision_log_message')] = BaseFieldDefinition::create('string_long')->setLabel(t('Revision log message'))
            ->setDescription(t('Briefly describe the changes you have made.'))
            ->setRevisionable(TRUE)
            ->setDefaultValue('')
            ->setDisplayOptions('form', [
            'type' => 'string_textarea',
            'weight' => 25,
            'settings' => [
                'rows' => 4,
            ],
        ]);
        return $fields;
    }
    
    /**
     * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().
     */
    public function getRevisionCreationTime() {
        return $this->{$this->getEntityType()
            ->getRevisionMetadataKey('revision_created')}->value;
    }
    
    /**
     * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().
     */
    public function setRevisionCreationTime($timestamp) {
        $this->{$this->getEntityType()
            ->getRevisionMetadataKey('revision_created')}->value = $timestamp;
        return $this;
    }
    
    /**
     * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().
     */
    public function getRevisionUser() {
        return $this->{$this->getEntityType()
            ->getRevisionMetadataKey('revision_user')}->entity;
    }
    
    /**
     * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().
     */
    public function setRevisionUser(UserInterface $account) {
        $this->{$this->getEntityType()
            ->getRevisionMetadataKey('revision_user')}->entity = $account;
        return $this;
    }
    
    /**
     * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().
     */
    public function getRevisionUserId() {
        return $this->{$this->getEntityType()
            ->getRevisionMetadataKey('revision_user')}->target_id;
    }
    
    /**
     * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().
     */
    public function setRevisionUserId($user_id) {
        $this->{$this->getEntityType()
            ->getRevisionMetadataKey('revision_user')}->target_id = $user_id;
        return $this;
    }
    
    /**
     * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().
     */
    public function getRevisionLogMessage() {
        return $this->{$this->getEntityType()
            ->getRevisionMetadataKey('revision_log_message')}->value;
    }
    
    /**
     * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().
     */
    public function setRevisionLogMessage($revision_log_message) {
        $this->{$this->getEntityType()
            ->getRevisionMetadataKey('revision_log_message')}->value = $revision_log_message;
        return $this;
    }
    
    /**
     * Gets the name of a revision metadata field.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   A content entity type definition.
     * @param string $key
     *   The revision metadata key to get, must be one of 'revision_created',
     *   'revision_user' or 'revision_log_message'.
     *
     * @return string
     *   The name of the field for the specified $key.
     */
    protected static function getRevisionMetadataKey(EntityTypeInterface $entity_type, $key) {
        @trigger_error(static::class . 'getRevisionMetadataKey() is deprecated in drupal:9.0.0 and is removed from drupal:10.0.0. Use $entity_type->getRevisionMetadataKey() instead. See: https://www.drupal.org/node/2831499', E_USER_DEPRECATED);
        
        /** @var \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type */
        return $entity_type->getRevisionMetadataKey($key);
    }
    
    /**
     * Gets the entity type definition.
     *
     * @return \Drupal\Core\Entity\ContentEntityTypeInterface
     *   The content entity type definition.
     */
    public abstract function getEntityType();

}