interface MigrateExecutableInterface (View source)

Methods

int
import()

Performs an import operation - migrate items from source to destination.

rollback()

Performs a rollback operation - remove previously-imported items.

processRow(Row $row, array $process = NULL, mixed $value = NULL)

Processes a row.

saveMessage(string $message, int $level = MigrationInterface::MESSAGE_ERROR)

Passes messages through to the map class.

Details

int import()

Performs an import operation - migrate items from source to destination.

Return Value

int

Returns a value indicating the status of the import operation. The possible values are the 'RESULT_' constants defined in MigrationInterface.

See also

MigrationInterface

rollback()

Performs a rollback operation - remove previously-imported items.

processRow(Row $row, array $process = NULL, mixed $value = NULL)

Processes a row.

Parameters

Row $row

The $row to be processed.

array $process

(optional) A process pipeline configuration. If not set, the top level process configuration in the migration entity is used.

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.

Exceptions

MigrateException

saveMessage(string $message, int $level = MigrationInterface::MESSAGE_ERROR)

Passes messages through to the map class.

Parameters

string $message

The message to record.

int $level

(optional) Message severity (defaults to MESSAGE_ERROR).