class FarmMigrationGroupLookup in farmOS 2.x

Looks up the value of a property based on a previous migration group.

@MigrateProcessPlugin( id = "farm_migration_group_lookup" )

This extends from the core migration_lookup process plugin, loads a list of all migrations in the specified migration_group, then passes that to the parent class, along with all other configuration keys.

Example:

process:
  uid:
    plugin: farm_migration_group_lookup
    migration_group: users
    source: author

@todo Remove if migrate_plus incorporates this plugin upstream. See: https://gitlab.com/drupalspoons/migrate_plus/-/issues/240

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
      • class \Drupal\migrate\Plugin\migrate\process\MigrationLookup implements ContainerFactoryPluginInterface
        • class \Drupal\farm_migrate\Plugin\migrate\process\FarmMigrationGroupLookup

File

modules/core/migrate/src/Plugin/migrate/process/FarmMigrationGroupLookup.php, line 33

Namespace

Drupal\farm_migrate\Plugin\migrate\process

class FarmMigrationGroupLookup extends MigrationLookup {

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {

    // Get the migration group ID from the process configuration.
    $lookup_migration_group_id = $this->configuration['migration_group'];

    // Load all migrations.
    $manager = \Drupal::service('plugin.manager.migration');
    $migrations = $manager
      ->createInstances([]);

    // Filter by group.
    $group_migrations = [];
    foreach ($migrations as $id => $migration) {
      $definition = $migration
        ->getPluginDefinition();
      if ($definition['migration_group'] == $lookup_migration_group_id) {
        $group_migrations[] = $id;
      }
    }

    // Set the migration configuration and delegate processing to the parent
    // MigrationLookup::transform() method.
    $this->configuration['migration'] = $group_migrations;
    return parent::transform($value, $migrate_executable, $row, $destination_property);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FarmMigrationGroupLookup::transform	public	function	Performs the associated process. Overrides MigrationLookup::transform
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
MigrationLookup::$migrateLookup	protected	property	The migrate lookup service.
MigrationLookup::$migrateStub	protected	property	The migrate stub service.
MigrationLookup::$migration	protected	property	The migration to be executed.
MigrationLookup::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MigrationLookup::isValid	protected	function	Determines if the value is valid for lookup.
MigrationLookup::skipInvalid	protected	function	Skips the migration process entirely if the value is invalid.
MigrationLookup::__construct	public	function	Constructs a MigrationLookup object. Overrides PluginBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple	3
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.