interface MigrateExecutableInterface
Same name in other branches
- 9 core/modules/migrate/src/MigrateExecutableInterface.php \Drupal\migrate\MigrateExecutableInterface
- 10 core/modules/migrate/src/MigrateExecutableInterface.php \Drupal\migrate\MigrateExecutableInterface
- 11.x core/modules/migrate/src/MigrateExecutableInterface.php \Drupal\migrate\MigrateExecutableInterface
Hierarchy
- interface \Drupal\migrate\MigrateExecutableInterface
Expanded class hierarchy of MigrateExecutableInterface
All classes that implement MigrateExecutableInterface
91 files declare their use of MigrateExecutableInterface
- ArrayBuild.php in core/
modules/ migrate/ src/ Plugin/ migrate/ process/ ArrayBuild.php - BlockPluginId.php in core/
modules/ block/ src/ Plugin/ migrate/ process/ BlockPluginId.php - BlockRegion.php in core/
modules/ block/ src/ Plugin/ migrate/ process/ BlockRegion.php - BlockRegionTest.php in core/
modules/ block/ tests/ src/ Unit/ Plugin/ migrate/ process/ BlockRegionTest.php - BlockSettings.php in core/
modules/ block/ src/ Plugin/ migrate/ process/ BlockSettings.php
File
-
core/
modules/ migrate/ src/ MigrateExecutableInterface.php, line 7
Namespace
Drupal\migrateView source
interface MigrateExecutableInterface {
/**
* Performs an import operation - migrate items from source to destination.
*/
public function import();
/**
* Performs a rollback operation - remove previously-imported items.
*/
public function rollback();
/**
* Processes a row.
*
* @param \Drupal\migrate\Row $row
* The $row to be processed.
* @param array $process
* (optional) A process pipeline configuration. If not set, the top level
* process configuration in the migration entity is used.
* @param mixed $value
* (optional) Initial value of the pipeline for the first destination.
* Usually setting this is not necessary as $process typically starts with
* a 'get'. This is useful only when the $process contains a single
* destination and needs to access a value outside of the source. See
* \Drupal\migrate\Plugin\migrate\process\SubProcess::transformKey for an
* example.
*
* @throws \Drupal\migrate\MigrateException
*/
public function processRow(Row $row, array $process = NULL, $value = NULL);
/**
* Passes messages through to the map class.
*
* @param string $message
* The message to record.
* @param int $level
* (optional) Message severity (defaults to MESSAGE_ERROR).
*/
public function saveMessage($message, $level = MigrationInterface::MESSAGE_ERROR);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
MigrateExecutableInterface::import | public | function | Performs an import operation - migrate items from source to destination. | 1 |
MigrateExecutableInterface::processRow | public | function | Processes a row. | 1 |
MigrateExecutableInterface::rollback | public | function | Performs a rollback operation - remove previously-imported items. | 1 |
MigrateExecutableInterface::saveMessage | public | function | Passes messages through to the map class. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.