Updated Drupal to 8.6. This goes with the following updates because it's possible...

[yaffs-website] / web / core / lib / Drupal / Core / Config / Entity / ConfigEntityUpdater.php

diff --git a/web/core/lib/Drupal/Core/Config/Entity/ConfigEntityUpdater.php b/web/core/lib/Drupal/Core/Config/Entity/ConfigEntityUpdater.php
new file mode 100644 (file)
index 0000000..37e5fb1
--- /dev/null
+++ b/web/core/lib/Drupal/Core/Config/Entity/ConfigEntityUpdater.php
@@ -0,0 +1,119 @@
+<?php
+
+namespace Drupal\Core\Config\Entity;
+
+use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * A utility class to make updating configuration entities simple.
+ *
+ * Use this in a post update function like so:
+ * @code
+ * // Update the dependencies of all Vocabulary configuration entities.
+ * \Drupal::classResolver(ConfigEntityUpdater::class)->update($sandbox, 'taxonomy_vocabulary');
+ * @endcode
+ *
+ * The number of entities processed in each batch is determined by the
+ * 'entity_update_batch_size' setting.
+ *
+ * @see default.settings.php
+ */
+class ConfigEntityUpdater implements ContainerInjectionInterface {
+
+  /**
+   * The entity type manager.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * The number of entities to process in each batch.
+   * @var int
+   */
+  protected $batchSize;
+
+  /**
+   * ConfigEntityUpdater constructor.
+   *
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
+   *   The entity type manager.
+   * @param int $batch_size
+   *   The number of entities to process in each batch.
+   */
+  public function __construct(EntityTypeManagerInterface $entity_type_manager, $batch_size) {
+    $this->entityTypeManager = $entity_type_manager;
+    $this->batchSize = $batch_size;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('entity_type.manager'),
+      $container->get('settings')->get('entity_update_batch_size', 50)
+    );
+  }
+
+  /**
+   * Updates configuration entities as part of a Drupal update.
+   *
+   * @param array $sandbox
+   *   Stores information for batch updates.
+   * @param string $entity_type_id
+   *   The configuration entity type ID. For example, 'view' or 'vocabulary'.
+   * @param callable $callback
+   *   (optional) A callback to determine if a configuration entity should be
+   *   saved. The callback will be passed each entity of the provided type that
+   *   exists. The callback should not save an entity itself. Return TRUE to
+   *   save an entity. The callback can make changes to an entity. Note that all
+   *   changes should comply with schema as an entity's data will not be
+   *   validated against schema on save to avoid unexpected errors. If a
+   *   callback is not provided, the default behaviour is to update the
+   *   dependencies if required.
+   *
+   * @see hook_post_update_NAME()
+   *
+   * @api
+   *
+   * @throws \InvalidArgumentException
+   *   Thrown when the provided entity type ID is not a configuration entity
+   *   type.
+   */
+  public function update(array &$sandbox, $entity_type_id, callable $callback = NULL) {
+    $storage = $this->entityTypeManager->getStorage($entity_type_id);
+    $sandbox_key = 'config_entity_updater:' . $entity_type_id;
+    if (!isset($sandbox[$sandbox_key])) {
+      $entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
+      if (!($entity_type instanceof ConfigEntityTypeInterface)) {
+        throw new \InvalidArgumentException("The provided entity type ID '$entity_type_id' is not a configuration entity type");
+      }
+      $sandbox[$sandbox_key]['entities'] = $storage->getQuery()->accessCheck(FALSE)->execute();
+      $sandbox[$sandbox_key]['count'] = count($sandbox[$sandbox_key]['entities']);
+    }
+
+    // The default behaviour is to fix dependencies.
+    if ($callback === NULL) {
+      $callback = function ($entity) {
+        /** @var \Drupal\Core\Config\Entity\ConfigEntityInterface $entity */
+        $original_dependencies = $entity->getDependencies();
+        return $original_dependencies !== $entity->calculateDependencies()->getDependencies();
+      };
+    }
+
+    /** @var \Drupal\Core\Config\Entity\ConfigEntityInterface $entity */
+    $entities = $storage->loadMultiple(array_splice($sandbox[$sandbox_key]['entities'], 0, $this->batchSize));
+    foreach ($entities as $entity) {
+      if (call_user_func($callback, $entity)) {
+        $entity->trustData();
+        $entity->save();
+      }
+    }
+
+    $sandbox['#finished'] = empty($sandbox[$sandbox_key]['entities']) ? 1 : ($sandbox[$sandbox_key]['count'] - count($sandbox[$sandbox_key]['entities'])) / $sandbox[$sandbox_key]['count'];
+  }
+
+}