class EmbeddedDataSource

Same name in other branches
  1. 8.9.x core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php \Drupal\migrate\Plugin\migrate\source\EmbeddedDataSource
  2. 10 core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php \Drupal\migrate\Plugin\migrate\source\EmbeddedDataSource
  3. 11.x core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php \Drupal\migrate\Plugin\migrate\source\EmbeddedDataSource

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. Each source row should be an associative array of values keyed by field names.
  • ids: An associative array of fields uniquely identifying a source row. See \Drupal\migrate\Plugin\MigrateSourceInterface::getIds() for more information.

Example:


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

This example migrates a channel vocabulary specified in the source section.

For additional configuration keys, refer to the parent class:

Plugin annotation


@MigrateSource(
  id = "embedded_data",
  source_module = "migrate"
)

Hierarchy

Expanded class hierarchy of EmbeddedDataSource

See also

\Drupal\migrate\Plugin\migrate\source\SourcePluginBase

1 file declares its use of EmbeddedDataSource
CacheableEmbeddedDataSource.php in core/modules/migrate/tests/modules/migrate_cache_counts_test/src/Plugin/migrate/source/CacheableEmbeddedDataSource.php

File

core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php, line 49

Namespace

Drupal\migrate\Plugin\migrate\source
View source
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($refresh = FALSE) {
        // We do not want this source plugin to have a cacheable count.
        // @see \Drupal\migrate_cache_counts_test\Plugin\migrate\source\CacheableEmbeddedDataSource
        return count($this->dataRows);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
EmbeddedDataSource::$dataRows protected property Data obtained from the source plugin configuration.
EmbeddedDataSource::$ids protected property Description of the unique ID fields for this source.
EmbeddedDataSource::count public function Gets the source count. Overrides SourcePluginBase::count 1
EmbeddedDataSource::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
EmbeddedDataSource::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
EmbeddedDataSource::initializeIterator public function Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator
EmbeddedDataSource::__construct public function Overrides SourcePluginBase::__construct
EmbeddedDataSource::__toString public function Allows class to decide how it will react when it is treated like a string. Overrides MigrateSourceInterface::__toString
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
SourcePluginBase::$cache protected property The backend cache.
SourcePluginBase::$cacheCounts protected property Whether this instance should cache the source count. 1
SourcePluginBase::$cacheKey protected property Key to use for caching counts.
SourcePluginBase::$currentRow protected property The current row from the query.
SourcePluginBase::$currentSourceIds protected property The primary key of the current row.
SourcePluginBase::$highWaterProperty protected property Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage protected property The key-value storage for the high-water value.
SourcePluginBase::$idMap protected property The migration ID map.
SourcePluginBase::$iterator protected property The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded protected property Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration protected property The entity migration object.
SourcePluginBase::$moduleHandler protected property The module handler service. 2
SourcePluginBase::$originalHighWater protected property The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount protected property Whether this instance should not attempt to count the source. 1
SourcePluginBase::$trackChanges protected property Flags whether to track changes to incoming data. 1
SourcePluginBase::aboveHighWater protected function Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::current public function
SourcePluginBase::doCount protected function Gets the source count. 4
SourcePluginBase::fetchNextRow protected function Position the iterator to the following row. 1
SourcePluginBase::getCache protected function Gets the cache object.
SourcePluginBase::getCurrentIds public function Gets the currentSourceIds data member.
SourcePluginBase::getHighWater protected function The current value of the high water mark.
SourcePluginBase::getHighWaterField protected function Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty protected function Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage protected function Get the high water storage object.
SourcePluginBase::getIterator protected function Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler protected function Gets the module handler.
SourcePluginBase::getSourceModule public function Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key public function Gets the iterator key.
SourcePluginBase::next public function
SourcePluginBase::postRollback public function Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::prepareRow public function Adds additional data to the row. Overrides MigrateSourceInterface::prepareRow 50
SourcePluginBase::preRollback public function Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind public function Rewinds the iterator. 1
SourcePluginBase::rowChanged protected function Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater protected function Save the new high water mark.
SourcePluginBase::valid public function Checks whether the iterator is currently valid.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.