Added Entity and Entity Reference Revisions which got dropped somewhere along the...
[yaffs-website] / web / modules / contrib / entity_reference_revisions / src / Plugin / migrate / destination / EntityReferenceRevisions.php
diff --git a/web/modules/contrib/entity_reference_revisions/src/Plugin/migrate/destination/EntityReferenceRevisions.php b/web/modules/contrib/entity_reference_revisions/src/Plugin/migrate/destination/EntityReferenceRevisions.php
new file mode 100644 (file)
index 0000000..75644b2
--- /dev/null
@@ -0,0 +1,219 @@
+<?php
+
+namespace Drupal\entity_reference_revisions\Plugin\migrate\destination;
+
+use Drupal\Component\Plugin\ConfigurablePluginInterface;
+use Drupal\Component\Utility\NestedArray;
+use Drupal\Core\Entity\ContentEntityInterface;
+use Drupal\Core\Entity\EntityManagerInterface;
+use Drupal\Core\Entity\EntityStorageInterface;
+use Drupal\Core\Field\FieldTypePluginManagerInterface;
+use Drupal\Core\TypedData\TranslatableInterface;
+use Drupal\migrate\MigrateException;
+use Drupal\migrate\Plugin\migrate\destination\EntityRevision;
+use Drupal\migrate\Plugin\MigrateIdMapInterface;
+use Drupal\migrate\Plugin\MigrationInterface;
+use Drupal\migrate\Row;
+
+/**
+ * Provides entity_reference_revisions destination plugin.
+ *
+ * Available configuration keys:
+ * - new_revisions: (optional) Flag to indicate if a new revision should be
+ *   created instead of updating a previous default record. Only applicable when
+ *   providing an entity id without a revision_id.
+ *
+ * @MigrateDestination(
+ *   id = "entity_reference_revisions",
+ *   deriver = "Drupal\entity_reference_revisions\Plugin\Derivative\MigrateEntityReferenceRevisions"
+ * )
+ */
+class EntityReferenceRevisions extends EntityRevision implements ConfigurablePluginInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles, EntityManagerInterface $entity_manager, FieldTypePluginManagerInterface $field_type_manager) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $storage, $bundles, $entity_manager, $field_type_manager);
+    $this->setConfiguration($configuration);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setConfiguration(array $configuration) {
+    $this->configuration = NestedArray::mergeDeep(
+      $this->defaultConfiguration(),
+      $configuration
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getConfiguration() {
+    return $this->configuration;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function defaultConfiguration() {
+    return [
+      'new_revisions' => FALSE,
+    ];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static function getEntityTypeId($pluginId) {
+    // Remove "entity_reference_revisions:".
+    // Ideally, we would call getDerivativeId(), but since this is static
+    // that is not possible so we follow the same pattern as core.
+    return substr($pluginId, 27);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function save(ContentEntityInterface $entity, array $oldDestinationIdValues = []) {
+    $entity->save();
+
+    return [
+      $this->getKey('id') => $entity->id(),
+      $this->getKey('revision') => $entity->getRevisionId(),
+    ];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getIds() {
+    if ($revision_key = $this->getKey('revision')) {
+      $id_key = $this->getKey('id');
+      $ids[$id_key]['type'] = 'integer';
+
+      // TODO: Improve after https://www.drupal.org/node/2783715 is finished.
+      $ids[$revision_key]['type'] = 'integer';
+
+      if ($this->isTranslationDestination()) {
+        if ($revision_key = $this->getKey('langcode')) {
+          $ids[$revision_key]['type'] = 'string';
+        }
+        else {
+          throw new MigrateException('This entity type does not support translation.');
+        }
+      }
+
+      return $ids;
+    }
+    throw new MigrateException('This entity type does not support revisions.');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getEntity(Row $row, array $oldDestinationIdValues) {
+    $entity_id = $oldDestinationIdValues ?
+      array_shift($oldDestinationIdValues) :
+      $this->getEntityId($row);
+    $revision_id = $oldDestinationIdValues ?
+      array_pop($oldDestinationIdValues) :
+      $row->getDestinationProperty($this->getKey('revision'));
+
+    // If a specific revision_id is supplied and exists, assert the entity_id
+    // matches (if supplied), and update the revision.
+    /** @var \Drupal\Core\Entity\RevisionableInterface|\Drupal\Core\Entity\EntityInterface $entity */
+    if (!empty($revision_id) && ($entity = $this->storage->loadRevision($revision_id))) {
+      if (!empty($entity_id) && ($entity->id() != $entity_id)) {
+        throw new MigrateException("The revision_id exists for this entity type, but does not belong to the given entity id");
+      }
+      $entity = $this->updateEntity($entity, $row) ?: $entity;
+    }
+    // If there is no revision_id supplied, but there is an entity_id
+    // supplied that exists, update it.
+    elseif (!empty($entity_id) && ($entity = $this->storage->load($entity_id))) {
+      // If so configured, create a new revision while updating.
+      if ($this->getConfiguration()['new_revisions']) {
+        $entity->setNewRevision(TRUE);
+      }
+      $entity = $this->updateEntity($entity, $row) ?: $entity;
+    }
+
+    // Otherwise, create a new (possibly stub) entity.
+    else {
+      // Attempt to ensure we always have a bundle.
+      if ($bundle = $this->getBundle($row)) {
+        $row->setDestinationProperty($this->getKey('bundle'), $bundle);
+      }
+
+      // Stubs might need some required fields filled in.
+      if ($row->isStub()) {
+        $this->processStubRow($row);
+      }
+      $entity = $this->storage->create($row->getDestination())
+        ->enforceIsNew(TRUE);
+      $entity->setNewRevision(TRUE);
+    }
+    $this->rollbackAction = MigrateIdMapInterface::ROLLBACK_DELETE;
+    return $entity;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function rollback(array $destination_identifiers) {
+    if ($this->isTranslationDestination()) {
+      $this->rollbackTranslation($destination_identifiers);
+    }
+    else {
+      $this->rollbackNonTranslation($destination_identifiers);
+    }
+  }
+
+  /**
+   * Rollback translation destinations.
+   *
+   * @param array $destination_identifiers
+   *   The IDs of the destination object to delete.
+   */
+  protected function rollbackTranslation(array $destination_identifiers) {
+    $entity = $this->storage->loadRevision(array_pop($destination_identifiers));
+    if ($entity && $entity instanceof TranslatableInterface) {
+      if ($key = $this->getKey('langcode')) {
+        if (isset($destination_identifier[$key])) {
+          $langcode = $destination_identifier[$key];
+          if ($entity->hasTranslation($langcode)) {
+            // Make sure we don't remove the default translation.
+            $translation = $entity->getTranslation($langcode);
+            if (!$translation->isDefaultTranslation()) {
+              $entity->removeTranslation($langcode);
+              $entity->save();
+            }
+          }
+        }
+      }
+    }
+  }
+
+  /**
+   * Rollback non-translation destinations.
+   *
+   * @param array $destination_identifiers
+   *   The IDs of the destination object to delete.
+   */
+  protected function rollbackNonTranslation(array $destination_identifiers) {
+    $revision_id = array_pop($destination_identifiers);
+    $entity = $this->storage->loadRevision($revision_id);
+    if ($entity) {
+      if ($entity->isDefaultRevision()) {
+        $entity->delete();
+      }
+      else {
+        $this->storage->deleteRevision($revision_id);
+      }
+    }
+  }
+
+}