comparison core/modules/migrate/src/MigrateExecutableInterface.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children c2387f117808
comparison
equal deleted inserted replaced
-1:000000000000 0:4c8ae668cc8c
1 <?php
2
3 namespace Drupal\migrate;
4
5 use Drupal\migrate\Plugin\MigrationInterface;
6
7 interface MigrateExecutableInterface {
8
9 /**
10 * Performs an import operation - migrate items from source to destination.
11 */
12 public function import();
13
14 /**
15 * Performs a rollback operation - remove previously-imported items.
16 */
17 public function rollback();
18
19 /**
20 * Processes a row.
21 *
22 * @param \Drupal\migrate\Row $row
23 * The $row to be processed.
24 * @param array $process
25 * (optional) A process pipeline configuration. If not set, the top level
26 * process configuration in the migration entity is used.
27 * @param mixed $value
28 * (optional) Initial value of the pipeline for the first destination.
29 * Usually setting this is not necessary as $process typically starts with
30 * a 'get'. This is useful only when the $process contains a single
31 * destination and needs to access a value outside of the source. See
32 * \Drupal\migrate\Plugin\migrate\process\Iterator::transformKey for an
33 * example.
34 *
35 * @throws \Drupal\migrate\MigrateException
36 */
37 public function processRow(Row $row, array $process = NULL, $value = NULL);
38
39 /**
40 * Passes messages through to the map class.
41 *
42 * @param string $message
43 * The message to record.
44 * @param int $level
45 * (optional) Message severity (defaults to MESSAGE_ERROR).
46 */
47 public function saveMessage($message, $level = MigrationInterface::MESSAGE_ERROR);
48
49 }