class ContentModerationState

Same name in this branch
  1. 8.9.x core/modules/content_moderation/src/ContentModerationState.php \Drupal\content_moderation\ContentModerationState
Same name in other branches
  1. 9 core/modules/content_moderation/src/ContentModerationState.php \Drupal\content_moderation\ContentModerationState
  2. 9 core/modules/content_moderation/src/Entity/ContentModerationState.php \Drupal\content_moderation\Entity\ContentModerationState
  3. 10 core/modules/content_moderation/src/ContentModerationState.php \Drupal\content_moderation\ContentModerationState
  4. 10 core/modules/content_moderation/src/Entity/ContentModerationState.php \Drupal\content_moderation\Entity\ContentModerationState
  5. 11.x core/modules/content_moderation/src/ContentModerationState.php \Drupal\content_moderation\ContentModerationState
  6. 11.x core/modules/content_moderation/src/Entity/ContentModerationState.php \Drupal\content_moderation\Entity\ContentModerationState

Defines the Content moderation state entity.

@ContentEntityType( id = "content_moderation_state", label = @Translation("Content moderation state"), label_singular = @Translation("content moderation state"), label_plural = @Translation("content moderation states"), label_count = @PluralTranslation( singular = "@count content moderation state", plural = "@count content moderation states" ), handlers = { "storage_schema" = "Drupal\content_moderation\ContentModerationStateStorageSchema", "views_data" = "\Drupal\views\EntityViewsData", "access" = "Drupal\content_moderation\ContentModerationStateAccessControlHandler", }, base_table = "content_moderation_state", revision_table = "content_moderation_state_revision", data_table = "content_moderation_state_field_data", revision_data_table = "content_moderation_state_field_revision", translatable = TRUE, internal = TRUE, entity_keys = { "id" = "id", "revision" = "revision_id", "uuid" = "uuid", "uid" = "uid", "owner" = "uid", "langcode" = "langcode", } )

@internal This entity is marked internal because it should not be used directly to alter the moderation state of an entity. Instead, the computed moderation_state field should be set on the entity directly.

Hierarchy

Expanded class hierarchy of ContentModerationState

4 files declare their use of ContentModerationState
ContentModerationStateAccessControlHandlerTest.php in core/modules/content_moderation/tests/src/Kernel/ContentModerationStateAccessControlHandlerTest.php
ContentModerationStateStorageSchemaTest.php in core/modules/content_moderation/tests/src/Kernel/ContentModerationStateStorageSchemaTest.php
ContentModerationStateTest.php in core/modules/content_moderation/tests/src/Kernel/ContentModerationStateTest.php
EntityOperations.php in core/modules/content_moderation/src/EntityOperations.php

File

core/modules/content_moderation/src/Entity/ContentModerationState.php, line 50

Namespace

Drupal\content_moderation\Entity
View source
class ContentModerationState extends ContentEntityBase implements ContentModerationStateInterface {
    use EntityOwnerTrait;
    
    /**
     * {@inheritdoc}
     */
    public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
        $fields = parent::baseFieldDefinitions($entity_type);
        $fields += static::ownerBaseFieldDefinitions($entity_type);
        $fields['uid']->setLabel(t('User'))
            ->setDescription(t('The username of the entity creator.'))
            ->setRevisionable(TRUE);
        $fields['workflow'] = BaseFieldDefinition::create('entity_reference')->setLabel(t('Workflow'))
            ->setDescription(t('The workflow the moderation state is in.'))
            ->setSetting('target_type', 'workflow')
            ->setRequired(TRUE)
            ->setRevisionable(TRUE);
        $fields['moderation_state'] = BaseFieldDefinition::create('string')->setLabel(t('Moderation state'))
            ->setDescription(t('The moderation state of the referenced content.'))
            ->setRequired(TRUE)
            ->setTranslatable(TRUE)
            ->setRevisionable(TRUE);
        $fields['content_entity_type_id'] = BaseFieldDefinition::create('string')->setLabel(t('Content entity type ID'))
            ->setDescription(t('The ID of the content entity type this moderation state is for.'))
            ->setRequired(TRUE)
            ->setSetting('max_length', EntityTypeInterface::ID_MAX_LENGTH)
            ->setRevisionable(TRUE);
        $fields['content_entity_id'] = BaseFieldDefinition::create('integer')->setLabel(t('Content entity ID'))
            ->setDescription(t('The ID of the content entity this moderation state is for.'))
            ->setRequired(TRUE)
            ->setRevisionable(TRUE);
        $fields['content_entity_revision_id'] = BaseFieldDefinition::create('integer')->setLabel(t('Content entity revision ID'))
            ->setDescription(t('The revision ID of the content entity this moderation state is for.'))
            ->setRequired(TRUE)
            ->setRevisionable(TRUE);
        return $fields;
    }
    
    /**
     * Creates or updates an entity's moderation state whilst saving that entity.
     *
     * @param \Drupal\content_moderation\Entity\ContentModerationState $content_moderation_state
     *   The content moderation entity content entity to create or save.
     *
     * @internal
     *   This method should only be called as a result of saving the related
     *   content entity.
     */
    public static function updateOrCreateFromEntity(ContentModerationState $content_moderation_state) {
        $content_moderation_state->realSave();
    }
    
    /**
     * Loads a content moderation state entity.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   A moderated entity object.
     *
     * @return \Drupal\content_moderation\Entity\ContentModerationStateInterface|null
     *   The related content moderation state or NULL if none could be found.
     *
     * @internal
     *   This method should only be called by code directly handling the
     *   ContentModerationState entity objects.
     */
    public static function loadFromModeratedEntity(EntityInterface $entity) {
        $content_moderation_state = NULL;
        $moderation_info = \Drupal::service('content_moderation.moderation_information');
        if ($moderation_info->isModeratedEntity($entity)) {
            
            /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
            $storage = \Drupal::entityTypeManager()->getStorage('content_moderation_state');
            $ids = $storage->getQuery()
                ->condition('content_entity_type_id', $entity->getEntityTypeId())
                ->condition('content_entity_id', $entity->id())
                ->condition('workflow', $moderation_info->getWorkflowForEntity($entity)
                ->id())
                ->condition('content_entity_revision_id', $entity->getLoadedRevisionId())
                ->allRevisions()
                ->execute();
            if ($ids) {
                
                /** @var \Drupal\content_moderation\Entity\ContentModerationStateInterface $content_moderation_state */
                $content_moderation_state = $storage->loadRevision(key($ids));
            }
        }
        return $content_moderation_state;
    }
    
    /**
     * Default value callback for the 'uid' base field definition.
     *
     * @see \Drupal\content_moderation\Entity\ContentModerationState::baseFieldDefinitions()
     *
     * @deprecated The ::getCurrentUserId method is deprecated in 8.6.x and will
     *   be removed before 9.0.0.
     *
     * @return array
     *   An array of default values.
     */
    public static function getCurrentUserId() {
        @trigger_error('The ::getCurrentUserId method is deprecated in 8.6.x and will be removed before 9.0.0.', E_USER_DEPRECATED);
        return [
            \Drupal::currentUser()->id(),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function save() {
        $related_entity = \Drupal::entityTypeManager()->getStorage($this->content_entity_type_id->value)
            ->loadRevision($this->content_entity_revision_id->value);
        if ($related_entity instanceof TranslatableInterface) {
            $related_entity = $related_entity->getTranslation($this->activeLangcode);
        }
        $related_entity->moderation_state = $this->moderation_state;
        return $related_entity->save();
    }
    
    /**
     * Saves an entity permanently.
     *
     * When saving existing entities, the entity is assumed to be complete,
     * partial updates of entities are not supported.
     *
     * @return int
     *   Either SAVED_NEW or SAVED_UPDATED, depending on the operation performed.
     *
     * @throws \Drupal\Core\Entity\EntityStorageException
     *   In case of failures an exception is thrown.
     */
    protected function realSave() {
        return parent::save();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getFieldsToSkipFromTranslationChangesCheck() {
        $field_names = parent::getFieldsToSkipFromTranslationChangesCheck();
        // We need to skip the parent entity revision ID, since that will always
        // change on every save, otherwise every translation would be marked as
        // affected regardless of actual changes.
        $field_names[] = 'content_entity_revision_id';
        return $field_names;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ContentEntityBase::$activeLangcode protected property Language code identifying the entity active language.
ContentEntityBase::$defaultLangcode protected property Local cache for the default language code.
ContentEntityBase::$defaultLangcodeKey protected property The default langcode entity key.
ContentEntityBase::$enforceRevisionTranslationAffected protected property Whether the revision translation affected flag has been enforced.
ContentEntityBase::$entityKeys protected property Holds untranslatable entity keys such as the ID, bundle, and revision ID.
ContentEntityBase::$fieldDefinitions protected property Local cache for field definitions.
ContentEntityBase::$fields protected property The array of fields, each being an instance of FieldItemListInterface.
ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck protected static property Local cache for fields to skip from the checking for translation changes.
ContentEntityBase::$isDefaultRevision protected property Indicates whether this is the default revision.
ContentEntityBase::$langcodeKey protected property The language entity key.
ContentEntityBase::$languages protected property Local cache for the available language objects.
ContentEntityBase::$loadedRevisionId protected property The loaded revision ID before the new revision was set.
ContentEntityBase::$newRevision protected property Boolean indicating whether a new revision should be created on save.
ContentEntityBase::$revisionTranslationAffectedKey protected property The revision translation affected entity key.
ContentEntityBase::$translatableEntityKeys protected property Holds translatable entity keys such as the label.
ContentEntityBase::$translationInitialize protected property A flag indicating whether a translation object is being initialized.
ContentEntityBase::$translations protected property An array of entity translation metadata.
ContentEntityBase::$validated protected property Whether entity validation was performed.
ContentEntityBase::$validationRequired protected property Whether entity validation is required before saving the entity.
ContentEntityBase::$values protected property The plain data values of the contained fields.
ContentEntityBase::access public function Checks data value access. Overrides EntityBase::access 1
ContentEntityBase::addTranslation public function
ContentEntityBase::bundle public function Gets the bundle of the entity. Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions public static function 4
ContentEntityBase::clearTranslationCache protected function Clear entity translation object cache to remove stale references.
ContentEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ContentEntityBase::get public function
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined. 1
ContentEntityBase::getFieldDefinition public function
ContentEntityBase::getFieldDefinitions public function
ContentEntityBase::getFields public function
ContentEntityBase::getIterator public function
ContentEntityBase::getLanguages protected function
ContentEntityBase::getLoadedRevisionId public function
ContentEntityBase::getRevisionId public function
ContentEntityBase::getTranslatableFields public function
ContentEntityBase::getTranslatedField protected function Gets a translated field.
ContentEntityBase::getTranslation public function
ContentEntityBase::getTranslationLanguages public function
ContentEntityBase::getTranslationStatus public function Returns the translation status. Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated public function
ContentEntityBase::hasField public function
ContentEntityBase::hasTranslation public function
ContentEntityBase::hasTranslationChanges public function
ContentEntityBase::id public function Gets the identifier. Overrides EntityBase::id
ContentEntityBase::initializeTranslation protected function Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision public function
ContentEntityBase::isDefaultTranslation public function
ContentEntityBase::isDefaultTranslationAffectedOnly public function
ContentEntityBase::isLatestRevision public function
ContentEntityBase::isLatestTranslationAffectedRevision public function
ContentEntityBase::isNewRevision public function
ContentEntityBase::isNewTranslation public function
ContentEntityBase::isRevisionTranslationAffected public function
ContentEntityBase::isRevisionTranslationAffectedEnforced public function
ContentEntityBase::isTranslatable public function
ContentEntityBase::isValidationRequired public function
ContentEntityBase::label public function Gets the label of the entity. Overrides EntityBase::label 6
ContentEntityBase::language public function Gets the language of the entity. Overrides EntityBase::language
ContentEntityBase::onChange public function
ContentEntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate
ContentEntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave 9
ContentEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 8
ContentEntityBase::preSaveRevision public function 3
ContentEntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityBase::referencedEntities 1
ContentEntityBase::removeTranslation public function
ContentEntityBase::set public function
ContentEntityBase::setDefaultLangcode protected function Populates the local cache for the default language code.
ContentEntityBase::setNewRevision public function
ContentEntityBase::setRevisionTranslationAffected public function
ContentEntityBase::setRevisionTranslationAffectedEnforced public function
ContentEntityBase::setValidationRequired public function
ContentEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray
ContentEntityBase::updateFieldLangcodes protected function Updates language for already instantiated fields.
ContentEntityBase::updateLoadedRevisionId public function
ContentEntityBase::updateOriginalValues public function Updates the original values with the interim changes.
ContentEntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase::uuid
ContentEntityBase::validate public function 1
ContentEntityBase::wasDefaultRevision public function
ContentEntityBase::__clone public function Magic method: Implements a deep clone.
ContentEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct
ContentEntityBase::__get public function Implements the magic method for getting object properties.
ContentEntityBase::__isset public function Implements the magic method for isset().
ContentEntityBase::__set public function Implements the magic method for setting object properties.
ContentEntityBase::__sleep public function Overrides EntityBase::__sleep
ContentEntityBase::__unset public function Implements the magic method for unset().
ContentModerationState::baseFieldDefinitions public static function Overrides ContentEntityBase::baseFieldDefinitions
ContentModerationState::getCurrentUserId Deprecated public static function Default value callback for the 'uid' base field definition.
ContentModerationState::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip in ::hasTranslationChanges. Overrides ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck
ContentModerationState::loadFromModeratedEntity public static function Loads a content moderation state entity.
ContentModerationState::realSave protected function Saves an entity permanently.
ContentModerationState::save public function Saves an entity permanently. Overrides EntityBase::save
ContentModerationState::updateOrCreateFromEntity public static function Creates or updates an entity's moderation state whilst saving that entity.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate 4
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName 1
EntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget 1
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId 1
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::invalidateTagsOnDelete protected static function Invalidates an entity's cache tags upon delete. 1
EntityBase::invalidateTagsOnSave protected function Invalidates an entity's cache tags upon save. 1
EntityBase::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew 2
EntityBase::languageManager protected function Gets the language manager.
EntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link 1
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 6
EntityBase::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 2
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::url public function Gets the public URL for this entity. Overrides EntityInterface::url 2
EntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityInterface::urlInfo 1
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuidGenerator protected function Gets the UUID generator.
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck
EntityOwnerTrait::getDefaultEntityOwner public static function Default value callback for 'owner' base field. 1
EntityOwnerTrait::getOwner public function 1
EntityOwnerTrait::getOwnerId public function
EntityOwnerTrait::ownerBaseFieldDefinitions public static function Returns an array of base field definitions for entity owners.
EntityOwnerTrait::setOwner public function
EntityOwnerTrait::setOwnerId public function
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a
synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function
TranslationStatusInterface::TRANSLATION_CREATED constant Status code identifying a newly created translation.
TranslationStatusInterface::TRANSLATION_EXISTING constant Status code identifying an existing translation.
TranslationStatusInterface::TRANSLATION_REMOVED constant Status code identifying a removed translation.

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