Drupal 8  8.0.2
ProcessPluginBase Class Reference
Inheritance diagram for ProcessPluginBase:

Public Member Functions

 transform ($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property)
 multiple ()
- Public Member Functions inherited from PluginInspectionInterface
 getPluginId ()
 getPluginDefinition ()

Detailed Description

The base class for all migrate process plugins.

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

See Also
Plugin API

Member Function Documentation

multiple ( )

{Indicates whether the returned value requires multiple handling.

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.

Implements MigrateProcessInterface.

transform (   $value,
MigrateExecutableInterface  $migrate_executable,
Row  $row,

{Performs the associated process.

mixed$valueThe value to be transformed.
\Drupal\migrate\MigrateExecutableInterface$migrate_executableThe migration in which this process is being executed.
\Drupal\migrate\Row$rowThe 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.
string$destination_propertyThe destination property currently worked on. This is only used together with the $row above.
string|array The newly transformed value.

Implements MigrateProcessInterface.

The documentation for this class was generated from the following file: