Version 1

[yaffs-website] / web / core / modules / content_moderation / src / Plugin / Field / ModerationStateFieldItemList.php

diff --git a/web/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php b/web/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php
new file mode 100644 (file)
index 0000000..2d93f5a
--- /dev/null
+++ b/web/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php
@@ -0,0 +1,120 @@
+<?php
+
+namespace Drupal\content_moderation\Plugin\Field;
+
+use Drupal\Core\Entity\ContentEntityInterface;
+use Drupal\Core\Field\FieldItemList;
+
+/**
+ * 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.
+ */
+class ModerationStateFieldItemList extends FieldItemList {
+
+  /**
+   * 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($workflow, $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\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 = \Drupal::service('entity.query')->get('content_moderation_state')
+      ->condition('content_entity_type_id', $entity->getEntityTypeId())
+      ->condition('content_entity_id', $entity->id())
+      // Ensure the correct revision is loaded in scenarios where a revision is
+      // being reverted.
+      ->condition('content_entity_revision_id', $entity->isNewRevision() ? $entity->getLoadedRevisionId() : $entity->getRevisionId())
+      ->condition('workflow', $moderation_info->getWorkflowForEntity($entity)->id())
+      ->allRevisions()
+      ->sort('revision_id', 'DESC')
+      ->execute();
+    if (empty($revisions)) {
+      return NULL;
+    }
+
+    /** @var \Drupal\content_moderation\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);
+      }
+      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.');
+    }
+    $this->computeModerationFieldItemList();
+    return isset($this->list[$index]) ? $this->list[$index] : NULL;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getIterator() {
+    $this->computeModerationFieldItemList();
+    return parent::getIterator();
+  }
+
+  /**
+   * Recalculate the moderation field item list.
+   */
+  protected function computeModerationFieldItemList() {
+    // Compute the value of the moderation state.
+    $index = 0;
+    if (!isset($this->list[$index]) || $this->list[$index]->isEmpty()) {
+
+      $moderation_state = $this->getModerationStateId();
+      // Do not store NULL values in the static cache.
+      if ($moderation_state) {
+        $this->list[$index] = $this->createItem($index, $moderation_state);
+      }
+    }
+  }
+
+}