class ModerationStateFieldItemList

Same name in other branches
  1. 9 core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php \Drupal\content_moderation\Plugin\Field\ModerationStateFieldItemList
  2. 8.9.x core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php \Drupal\content_moderation\Plugin\Field\ModerationStateFieldItemList
  3. 10 core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php \Drupal\content_moderation\Plugin\Field\ModerationStateFieldItemList

A computed field that provides a content entity's moderation state.

It links content entities to a moderation state configuration entity via a moderation state content entity.

Hierarchy

Expanded class hierarchy of ModerationStateFieldItemList

2 files declare their use of ModerationStateFieldItemList
EntityTypeInfo.php in core/modules/content_moderation/src/EntityTypeInfo.php
ModerationStateWidget.php in core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php

File

core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php, line 16

Namespace

Drupal\content_moderation\Plugin\Field
View source
class ModerationStateFieldItemList extends FieldItemList {
    use ComputedItemListTrait {
        get as traitGet;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function computeValue() {
        $moderation_state = $this->getModerationStateId();
        // Do not store NULL values, in the case where an entity does not have a
        // moderation workflow associated with it, we do not create list items for
        // the computed field.
        if ($moderation_state) {
            // An entity can only have a single moderation state.
            $this->list[0] = $this->createItem(0, $moderation_state);
        }
    }
    
    /**
     * Gets the moderation state ID linked to a content entity revision.
     *
     * @return string|null
     *   The moderation state ID linked to a content entity revision.
     */
    protected function getModerationStateId() {
        $entity = $this->getEntity();
        
        /** @var \Drupal\content_moderation\ModerationInformationInterface $moderation_info */
        $moderation_info = \Drupal::service('content_moderation.moderation_information');
        if (!$moderation_info->shouldModerateEntitiesOfBundle($entity->getEntityType(), $entity->bundle())) {
            return NULL;
        }
        // Existing entities will have a corresponding content_moderation_state
        // entity associated with them.
        if (!$entity->isNew() && ($content_moderation_state = $this->loadContentModerationStateRevision($entity))) {
            return $content_moderation_state->moderation_state->value;
        }
        // It is possible that the bundle does not exist at this point. For example,
        // the node type form creates a fake Node entity to get default values.
        // @see \Drupal\node\NodeTypeForm::form()
        $workflow = $moderation_info->getWorkFlowForEntity($entity);
        return $workflow ? $workflow->getTypePlugin()
            ->getInitialState($entity)
            ->id() : NULL;
    }
    
    /**
     * Load the content moderation state revision associated with an entity.
     *
     * @param \Drupal\Core\Entity\ContentEntityInterface $entity
     *   The entity the content moderation state entity will be loaded from.
     *
     * @return \Drupal\content_moderation\Entity\ContentModerationStateInterface|null
     *   The content_moderation_state revision or FALSE if none exists.
     */
    protected function loadContentModerationStateRevision(ContentEntityInterface $entity) {
        $moderation_info = \Drupal::service('content_moderation.moderation_information');
        $content_moderation_storage = \Drupal::entityTypeManager()->getStorage('content_moderation_state');
        $revisions = $content_moderation_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('content_entity_type_id', $entity->getEntityTypeId())
            ->condition('content_entity_id', $entity->id())
            ->condition('content_entity_revision_id', $entity->isNewRevision() ? $entity->getLoadedRevisionId() : $entity->getRevisionId())
            ->condition('workflow', $moderation_info->getWorkflowForEntity($entity)
            ->id())
            ->condition('langcode', $entity->language()
            ->getId())
            ->allRevisions()
            ->sort('revision_id', 'DESC')
            ->execute();
        if (empty($revisions)) {
            return NULL;
        }
        
        /** @var \Drupal\content_moderation\Entity\ContentModerationStateInterface $content_moderation_state */
        $content_moderation_state = $content_moderation_storage->loadRevision(key($revisions));
        if ($entity->getEntityType()
            ->hasKey('langcode')) {
            $langcode = $entity->language()
                ->getId();
            if (!$content_moderation_state->hasTranslation($langcode)) {
                $content_moderation_state->addTranslation($langcode, $content_moderation_state->toArray());
            }
            if ($content_moderation_state->language()
                ->getId() !== $langcode) {
                $content_moderation_state = $content_moderation_state->getTranslation($langcode);
            }
        }
        return $content_moderation_state;
    }
    
    /**
     * {@inheritdoc}
     */
    public function get($index) {
        if ($index !== 0) {
            throw new \InvalidArgumentException('An entity can not have multiple moderation states at the same time.');
        }
        return $this->traitGet($index);
    }
    
    /**
     * {@inheritdoc}
     */
    public function onChange($delta) {
        $this->updateModeratedEntity($this->list[$delta]->value);
        parent::onChange($delta);
    }
    
    /**
     * {@inheritdoc}
     */
    public function setValue($values, $notify = TRUE) {
        parent::setValue($values, $notify);
        $this->valueComputed = TRUE;
        // If the parent created a field item and if the parent should be notified
        // about the change (e.g. this is not initialized with the current value),
        // update the moderated entity.
        if (isset($this->list[0]) && $notify) {
            $this->updateModeratedEntity($this->list[0]->value);
        }
    }
    
    /**
     * Updates the default revision flag and the publishing status of the entity.
     *
     * @param string $moderation_state_id
     *   The ID of the new moderation state.
     */
    protected function updateModeratedEntity($moderation_state_id) {
        $entity = $this->getEntity();
        
        /** @var \Drupal\content_moderation\ModerationInformationInterface $content_moderation_info */
        $content_moderation_info = \Drupal::service('content_moderation.moderation_information');
        $workflow = $content_moderation_info->getWorkflowForEntity($entity);
        // Change the entity's default revision flag and the publishing status only
        // if the new workflow state is a valid one.
        if ($workflow && $workflow->getTypePlugin()
            ->hasState($moderation_state_id)) {
            
            /** @var \Drupal\content_moderation\ContentModerationState $current_state */
            $current_state = $workflow->getTypePlugin()
                ->getState($moderation_state_id);
            // This entity is default if it is new, the default revision state, or the
            // default revision is not published.
            if (!$entity->isSyncing()) {
                $update_default_revision = $entity->isNew() || $current_state->isDefaultRevisionState() || !$content_moderation_info->isDefaultRevisionPublished($entity);
                $entity->isDefaultRevision($update_default_revision);
            }
            // Update publishing status if it can be updated and if it needs updating.
            $published_state = $current_state->isPublishedState();
            if ($entity instanceof EntityPublishedInterface && $entity->isPublished() !== $published_state) {
                $published_state ? $entity->setPublished() : $entity->setUnpublished();
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function generateSampleItems($count = 1) {
        // No sample items generated since the starting moderation state is always
        // computed based on the default state of the associated workflow.
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
ComputedItemListTrait::$valueComputed protected property Whether the values have already been computed or not.
ComputedItemListTrait::appendItem public function
ComputedItemListTrait::applyDefaultValue public function
ComputedItemListTrait::count public function
ComputedItemListTrait::ensureComputedValue protected function Ensures that values are only computed once.
ComputedItemListTrait::get public function Aliased as: traitGet
ComputedItemListTrait::getIterator public function
ComputedItemListTrait::getString public function
ComputedItemListTrait::getValue public function
ComputedItemListTrait::isEmpty public function
ComputedItemListTrait::offsetExists public function
ComputedItemListTrait::removeItem public function
ComputedItemListTrait::set public function
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FieldItemList::$langcode protected property The langcode of the field values held in the object.
FieldItemList::$list protected property Numerically indexed array of field items. Overrides ItemList::$list 1
FieldItemList::access public function Checks data value access. Overrides AccessibleInterface::access 1
FieldItemList::createItem protected function Helper for creating a list item object. Overrides ItemList::createItem
FieldItemList::defaultAccess public function Contains the default access logic of this field. Overrides FieldItemListInterface::defaultAccess 3
FieldItemList::defaultValuesForm public function Returns a form for the default value input. Overrides FieldItemListInterface::defaultValuesForm 2
FieldItemList::defaultValuesFormSubmit public function Processes the submitted default value. Overrides FieldItemListInterface::defaultValuesFormSubmit 2
FieldItemList::defaultValuesFormValidate public function Validates the submitted default value. Overrides FieldItemListInterface::defaultValuesFormValidate 2
FieldItemList::defaultValueWidget protected function Returns the widget object used in default value form.
FieldItemList::delegateMethod protected function Calls a method on each FieldItem.
FieldItemList::delete public function Defines custom delete behavior for field values. Overrides FieldItemListInterface::delete 2
FieldItemList::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemListInterface::deleteRevision 1
FieldItemList::equals public function Determines equality to another object implementing FieldItemListInterface. Overrides FieldItemListInterface::equals 2
FieldItemList::filterEmptyItems public function Filters out empty field items and re-numbers the item deltas. Overrides FieldItemListInterface::filterEmptyItems
FieldItemList::getConstraints public function Gets a list of validation constraints. Overrides TypedData::getConstraints 1
FieldItemList::getEntity public function Gets the entity that field belongs to. Overrides FieldItemListInterface::getEntity 1
FieldItemList::getFieldDefinition public function Gets the field definition. Overrides FieldItemListInterface::getFieldDefinition
FieldItemList::getLangcode public function Gets the langcode of the field values held in the object. Overrides FieldItemListInterface::getLangcode
FieldItemList::getSetting public function Returns the value of a given field setting. Overrides FieldItemListInterface::getSetting
FieldItemList::getSettings public function Returns the array of field settings. Overrides FieldItemListInterface::getSettings
FieldItemList::hasAffectingChanges public function Determines whether the field has relevant changes. Overrides FieldItemListInterface::hasAffectingChanges 1
FieldItemList::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemListInterface::postSave 1
FieldItemList::preSave public function Defines custom presave behavior for field values. Overrides FieldItemListInterface::preSave 1
FieldItemList::processDefaultValue public static function Processes the default value before being applied. Overrides FieldItemListInterface::processDefaultValue 2
FieldItemList::setLangcode public function Sets the langcode of the field values held in the object. Overrides FieldItemListInterface::setLangcode
FieldItemList::view public function Returns a renderable array for the field items. Overrides FieldItemListInterface::view
FieldItemList::__get public function Magic method: Gets a property value of to the first field item. Overrides FieldItemListInterface::__get
FieldItemList::__isset public function Magic method: Determines whether a property of the first field item is set. Overrides FieldItemListInterface::__isset
FieldItemList::__set public function Magic method: Sets a property value of the first field item. Overrides FieldItemListInterface::__set
FieldItemList::__unset public function Magic method: Unsets a property of the first field item. Overrides FieldItemListInterface::__unset
ItemList::filter public function Filters the items in the list using a custom callback. Overrides ListInterface::filter
ItemList::first public function Returns the first item in this list. Overrides ListInterface::first
ItemList::getItemDefinition public function Gets the definition of a contained item. Overrides ListInterface::getItemDefinition
ItemList::last public function Returns the last item in this list. Overrides ListInterface::last
ItemList::offsetGet public function
ItemList::offsetSet public function
ItemList::offsetUnset public function
ItemList::rekey protected function Renumbers the items in the list.
ItemList::__clone public function Magic method: Implements a deep clone.
ModerationStateFieldItemList::computeValue protected function Computes the values for an item list. Overrides ComputedItemListTrait::computeValue
ModerationStateFieldItemList::generateSampleItems public function Populates a specified number of field items with valid sample data. Overrides FieldItemList::generateSampleItems
ModerationStateFieldItemList::get public function Returns the item at the specified position in this list. Overrides ItemList::get
ModerationStateFieldItemList::getModerationStateId protected function Gets the moderation state ID linked to a content entity revision.
ModerationStateFieldItemList::loadContentModerationStateRevision protected function Load the content moderation state revision associated with an entity.
ModerationStateFieldItemList::onChange public function React to changes to a child property or item. Overrides ItemList::onChange
ModerationStateFieldItemList::setValue public function Overrides \Drupal\Core\TypedData\TypedData::setValue(). Overrides ComputedItemListTrait::setValue
ModerationStateFieldItemList::updateModeratedEntity protected function Updates the default revision flag and the publishing status of the entity.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TypedData::$definition protected property The data definition. 1
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::createInstance public static function Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition public function Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent public function Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext public function Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate public function Validates the currently set data value. Overrides TypedDataInterface::validate
TypedData::__construct public function Constructs a TypedData object given its definition and context. 4
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2

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