Drupal 8  8.0.2
MigrateProcessInterface Interface Reference
Inheritance diagram for MigrateProcessInterface:

Public Member Functions

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

Detailed Description

An interface for migrate process plugins.

A process plugin can use any number of methods instead of (but not in addition to) transform with the same arguments and then the plugin configuration needs to provide the name of the method to be called via the "method" key. See and migrate.migration.d6_field_instance_widget_settings.yml for examples.

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.

Implemented in Get, Iterator, and ProcessPluginBase.

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.

Implemented in BlockVisibility, BlockTheme, BlockPluginId, MachineName, UserUpdate7002, FieldType, BlockRegion, Route, CckLink, Flatten, Get, ProcessPluginBase, Callback, StaticMap, Concat, Extract, FieldFormatterSettingsDefaults, DedupeBase, Iterator, ConvertTokens, FieldInstanceWidgetSettings, FieldSettings, SkipRowIfNotSet, UserUpdate8002, FieldTypeDefaults, BlockSettings, FieldInstanceDefaults, FieldInstanceSettings, InternalUri, DefaultValue, FieldInstanceDefaults, FieldInstanceSettings, FieldSettings, ImageCacheActions, and ProfileFieldSettings.

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