Security update for Core, with self-updated composer

[yaffs-website] / web / core / modules / migrate / src / Plugin / migrate / process / SubProcess.php

diff --git a/web/core/modules/migrate/src/Plugin/migrate/process/SubProcess.php b/web/core/modules/migrate/src/Plugin/migrate/process/SubProcess.php
new file mode 100644 (file)
index 0000000..3e3d8dc
--- /dev/null
+++ b/web/core/modules/migrate/src/Plugin/migrate/process/SubProcess.php
@@ -0,0 +1,166 @@
+<?php
+
+namespace Drupal\migrate\Plugin\migrate\process;
+
+use Drupal\migrate\ProcessPluginBase;
+use Drupal\migrate\MigrateExecutableInterface;
+use Drupal\migrate\Row;
+
+/**
+ * Runs an array of arrays through its own process pipeline.
+ *
+ * The sub_process plugin accepts an array of associative arrays and runs each
+ * one through its own process pipeline, producing a newly keyed associative
+ * array of transformed values.
+ *
+ * Available configuration keys:
+ *   - process: the plugin(s) that will process each element of the source.
+ *   - key: runs the process pipeline for the key to determine a new dynamic
+ *     name.
+ *
+ * Examples:
+ *
+ * @code
+ * source: Array
+ * (
+ *   [upload] => Array
+ *     (
+ *       [0] => Array
+ *         (
+ *           [fid] => 1
+ *           [list] => 0
+ *           [description] => "File number 1"
+ *         )
+ *       [1] => Array
+ *         (
+ *           [fid] => 2
+ *           [list] => 1
+ *           [description] => "File number 2"
+ *         )
+ *     )
+ * )
+ * ...
+ * @endcode
+ *
+ * The sub_process process plugin will take these arrays one at a time and run
+ * its own process over each one:
+ *
+ * @code
+ * process:
+ *   upload:
+ *     plugin: sub_process
+ *     source: upload
+ *     process:
+ *       target_id:
+ *         plugin: migration_lookup
+ *         migration: d6_file
+ *         source: fid
+ *       display: list
+ *       description: description
+ * @endcode
+ *
+ * In this case, each item in the upload array will be processed by the
+ * sub_process process plugin. The target_id will be found by looking up the
+ * destination value from a previous migration. The display and description
+ * fields will simply be mapped.
+ *
+ * In the next example, normally the array returned from sub_process will have
+ * its original keys. If you need to change the key, it is possible for the
+ * returned array to be keyed by one of the transformed values in the sub-array.
+ *
+ * @code
+ * source: Array
+ * (
+ *   [format] => 1
+ *   [name] => Filtered HTML
+ * ...
+ *   [filters] => Array
+ *     (
+ *       [0] => Array
+ *         (
+ *           [module] => filter
+ *           [delta] => 2
+ *           [weight] => 0
+ *         )
+ *       [1] => Array
+ *         (
+ *           [module] => filter
+ *           [delta] => 0
+ *           [weight] => 1
+ *         )
+ *    )
+ * )
+ * ...
+ *
+ * process:
+ *   filters:
+ *     plugin: sub_process
+ *     source: filters
+ *     key: "@id"
+ *     process:
+ *       id:
+ *         plugin: concat
+ *         source:
+ *           - module
+ *           - delta
+ *         delimiter: _
+ * @endcode
+ *
+ * In the above example, the keys of the returned array would be filter_2 and
+ * filter_0
+ *
+ * @see \Drupal\migrate\Plugin\MigrateProcessInterface
+ *
+ * @MigrateProcessPlugin(
+ *   id = "sub_process",
+ *   handle_multiples = TRUE
+ * )
+ */
+class SubProcess extends ProcessPluginBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
+    $return = [];
+    if (is_array($value) || $value instanceof \Traversable) {
+      foreach ($value as $key => $new_value) {
+        $new_row = new Row($new_value, []);
+        $migrate_executable->processRow($new_row, $this->configuration['process']);
+        $destination = $new_row->getDestination();
+        if (array_key_exists('key', $this->configuration)) {
+          $key = $this->transformKey($key, $migrate_executable, $new_row);
+        }
+        $return[$key] = $destination;
+      }
+    }
+    return $return;
+  }
+
+  /**
+   * Runs the process pipeline for the key to determine its dynamic name.
+   *
+   * @param string|int $key
+   *   The current key.
+   * @param \Drupal\migrate\MigrateExecutableInterface $migrate_executable
+   *   The migrate executable helper class.
+   * @param \Drupal\migrate\Row $row
+   *   The current row after processing.
+   *
+   * @return mixed
+   *   The transformed key.
+   */
+  protected function transformKey($key, MigrateExecutableInterface $migrate_executable, Row $row) {
+    $process = ['key' => $this->configuration['key']];
+    $migrate_executable->processRow($row, $process, $key);
+    return $row->getDestinationProperty('key');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function multiple() {
+    return TRUE;
+  }
+
+}