Version 1

[yaffs-website] / web / core / modules / migrate / src / Plugin / migrate / source / EmbeddedDataSource.php

diff --git a/web/core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php b/web/core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php
new file mode 100644 (file)
index 0000000..0bb35f3
--- /dev/null
+++ b/web/core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php
@@ -0,0 +1,115 @@
+<?php
+
+namespace Drupal\migrate\Plugin\migrate\source;
+
+use Drupal\migrate\Plugin\MigrationInterface;
+
+/**
+ * Allows source data to be defined in the configuration of the source plugin.
+ *
+ * The embedded_data source plugin is used to inject source data from the plugin
+ * configuration. One use case is when some small amount of fixed data is
+ * imported, so that it can be referenced by other migrations. Another use case
+ * is testing.
+ *
+ * Available configuration keys
+ * - data_rows: The source data array.
+ * - ids: The unique ID field of the data.
+ *
+ * Examples:
+ *
+ * @code
+ * source:
+ *   plugin: embedded_data
+ *   data_rows:
+ *     -
+ *       channel_machine_name: music
+ *       channel_description: Music
+ *     -
+ *       channel_machine_name: movies
+ *       channel_description: Movies
+ *     ids:
+ *       channel_machine_name:
+ *       type: string
+ * @endcode
+ *
+ * This example migrates a channel vocabulary.
+ *
+ * @see \Drupal\migrate\Plugin\MigrateSourceInterface
+ *
+ * @MigrateSource(
+ *   id = "embedded_data"
+ * )
+ */
+class EmbeddedDataSource extends SourcePluginBase {
+
+  /**
+   * Data obtained from the source plugin configuration.
+   *
+   * @var array[]
+   *   Array of data rows, each one an array of values keyed by field names.
+   */
+  protected $dataRows = [];
+
+  /**
+   * Description of the unique ID fields for this source.
+   *
+   * @var array[]
+   *   Each array member is keyed by a field name, with a value that is an
+   *   array with a single member with key 'type' and value a column type such
+   *   as 'integer'.
+   */
+  protected $ids = [];
+
+  /**
+   * {@inheritdoc}
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
+    $this->dataRows = $configuration['data_rows'];
+    $this->ids = $configuration['ids'];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function fields() {
+    if ($this->count() > 0) {
+      $first_row = reset($this->dataRows);
+      $field_names = array_keys($first_row);
+      return array_combine($field_names, $field_names);
+    }
+    else {
+      return [];
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function initializeIterator() {
+    return new \ArrayIterator($this->dataRows);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function __toString() {
+    return 'Embedded data';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getIds() {
+    return $this->ids;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function count() {
+    return count($this->dataRows);
+  }
+
+}