interface MigrateProcessInterface in Drupal 8

An interface for migrate process plugins.

Migrate process plugins transform the input value.For example, transform a human provided name into a machine name, look up an identifier in a previous migration and so on.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\migrate\Plugin\MigrateProcessInterface

See also

\Drupal\migrate\Plugin\MigratePluginManager

\Drupal\migrate\ProcessPluginBase

\Drupal\migrate\Annotation\MigrateProcessPlugin

Plugin API

Related topics

Migrate API

Overview of the Migrate API, which migrates data into Drupal.

16 files declare their use of MigrateProcessInterface

BlockPluginId.php in core/modules/block/src/Plugin/migrate/process/BlockPluginId.php

BlockVisibility.php in core/modules/block/src/Plugin/migrate/process/BlockVisibility.php

CckFileTest.php in core/modules/file/tests/src/Unit/Plugin/migrate/process/d6/CckFileTest.php

FieldFile.php in core/modules/file/src/Plugin/migrate/process/d6/FieldFile.php

FieldFileTest.php in core/modules/file/tests/src/Unit/Plugin/migrate/process/d6/FieldFileTest.php

... See full list

File

core/modules/migrate/src/Plugin/MigrateProcessInterface.php, line 23

Namespace

Drupal\migrate\Plugin

interface MigrateProcessInterface extends PluginInspectionInterface {

  /**
   * Performs the associated process.
   *
   * @param mixed $value
   *   The value to be transformed.
   * @param \Drupal\migrate\MigrateExecutableInterface $migrate_executable
   *   The migration in which this process is being executed.
   * @param \Drupal\migrate\Row $row
   *   The row from the source to process. Normally, just transforming the value
   *   is adequate but very rarely you might need to change two columns at the
   *   same time or something like that.
   * @param string $destination_property
   *   The destination property currently worked on. This is only used together
   *   with the $row above.
   *
   * @return string|array
   *   The newly transformed value.
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property);

  /**
   * Indicates whether the returned value requires multiple handling.
   *
   * @return bool
   *   TRUE when the returned value contains a list of values to be processed.
   *   For example, when the 'source' property is a string and the value found
   *   is an array.
   */
  public function multiple();

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateProcessInterface::multiple	public	function	Indicates whether the returned value requires multiple handling.	1
MigrateProcessInterface::transform	public	function	Performs the associated process.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2