annotate modules/contrib/migrate_plus/src/Event/MigrateEvents.php @ 0:c75dbcec494b

Initial commit from drush-created site
author Chris Cannam
date Thu, 05 Jul 2018 14:24:15 +0000
parents
children a9cd425dd02b
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\migrate_plus\Event;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Defines the row preparation event for the migration system.
Chris@0 7 *
Chris@0 8 * @see \Drupal\migrate\Event\MigratePrepareRowEvent
Chris@0 9 */
Chris@0 10 final class MigrateEvents {
Chris@0 11
Chris@0 12 /**
Chris@0 13 * Name of the event fired when preparing a source data row.
Chris@0 14 *
Chris@0 15 * This event allows modules to perform an action whenever the source plugin
Chris@0 16 * has read the inital source data into a Row object. Typically, this would be
Chris@0 17 * used to add data to the row, manipulate the data into a canonical form, or
Chris@0 18 * signal by exception that the row should be skipped. The event listener
Chris@0 19 * method receives a \Drupal\migrate_plus\Event\MigratePrepareRowEvent instance.
Chris@0 20 *
Chris@0 21 * @Event
Chris@0 22 *
Chris@0 23 * @see \Drupal\migrate_plus\Event\MigratePrepareRowEvent
Chris@0 24 *
Chris@0 25 * @var string
Chris@0 26 */
Chris@0 27 const PREPARE_ROW = 'migrate_plus.prepare_row';
Chris@0 28
Chris@0 29 }