3 namespace Drupal\migrate\Event;
6 * Defines events for the migration system.
8 * @see \Drupal\migrate\Event\MigrateMapSaveEvent
9 * @see \Drupal\migrate\Event\MigrateMapDeleteEvent
10 * @see \Drupal\migrate\Event\MigrateImportEvent
11 * @see \Drupal\migrate\Event\MigratePreRowSaveEvent
12 * @see \Drupal\migrate\Event\MigratePostRowSaveEvent
13 * @see \Drupal\migrate\Event\MigrateRollbackEvent
14 * @see \Drupal\migrate\Event\MigrateRowDeleteEvent
15 * @see \Drupal\migrate\Event\MigrateIdMapMessageEvent
17 final class MigrateEvents {
20 * Name of the event fired when saving to a migration's map.
22 * This event allows modules to perform an action whenever the disposition of
23 * an item being migrated is saved to the map table. The event listener method
24 * receives a \Drupal\migrate\Event\MigrateMapSaveEvent instance.
28 * @see \Drupal\migrate\Event\MigrateMapSaveEvent
32 const MAP_SAVE = 'migrate.map_save';
35 * Name of the event fired when removing an entry from a migration's map.
37 * This event allows modules to perform an action whenever a row is deleted
38 * from a migration's map table (implying it has been rolled back). The event
39 * listener method receives a \Drupal\migrate\Event\MigrateMapDeleteEvent instance.
43 * @see \Drupal\migrate\Event\MigrateMapDeleteEvent
47 const MAP_DELETE = 'migrate.map_delete';
50 * Name of the event fired when beginning a migration import operation.
52 * This event allows modules to perform an action whenever a migration import
53 * operation is about to begin. The event listener method receives a
54 * \Drupal\migrate\Event\MigrateImportEvent instance.
58 * @see \Drupal\migrate\Event\MigrateImportEvent
62 const PRE_IMPORT = 'migrate.pre_import';
65 * Name of the event fired when finishing a migration import operation.
67 * This event allows modules to perform an action whenever a migration import
68 * operation is completing. The event listener method receives a
69 * \Drupal\migrate\Event\MigrateImportEvent instance.
73 * @see \Drupal\migrate\Event\MigrateImportEvent
77 const POST_IMPORT = 'migrate.post_import';
80 * Name of the event fired when about to import a single item.
82 * This event allows modules to perform an action whenever a specific item
83 * is about to be saved by the destination plugin. The event listener method
84 * receives a \Drupal\migrate\Event\MigratePreRowSaveEvent instance.
88 * @see \Drupal\migrate\Event\MigratePreRowSaveEvent
92 const PRE_ROW_SAVE = 'migrate.pre_row_save';
95 * Name of the event fired just after a single item has been imported.
97 * This event allows modules to perform an action whenever a specific item
98 * has been saved by the destination plugin. The event listener method
99 * receives a \Drupal\migrate\Event\MigratePostRowSaveEvent instance.
103 * @see \Drupal\migrate\Event\MigratePostRowSaveEvent
107 const POST_ROW_SAVE = 'migrate.post_row_save';
110 * Name of the event fired when beginning a migration rollback operation.
112 * This event allows modules to perform an action whenever a migration
113 * rollback operation is about to begin. The event listener method receives a
114 * \Drupal\migrate\Event\MigrateRollbackEvent instance.
118 * @see \Drupal\migrate\Event\MigrateRollbackEvent
122 const PRE_ROLLBACK = 'migrate.pre_rollback';
125 * Name of the event fired when finishing a migration rollback operation.
127 * This event allows modules to perform an action whenever a migration
128 * rollback operation is completing. The event listener method receives a
129 * \Drupal\migrate\Event\MigrateRollbackEvent instance.
133 * @see \Drupal\migrate\Event\MigrateRollbackEvent
137 const POST_ROLLBACK = 'migrate.post_rollback';
140 * Name of the event fired when about to delete a single item.
142 * This event allows modules to perform an action whenever a specific item
143 * is about to be deleted by the destination plugin. The event listener method
144 * receives a \Drupal\migrate\Event\MigrateRowDeleteEvent instance.
148 * @see \Drupal\migrate\Event\MigrateRowDeleteEvent
152 const PRE_ROW_DELETE = 'migrate.pre_row_delete';
155 * Name of the event fired just after a single item has been deleted.
157 * This event allows modules to perform an action whenever a specific item
158 * has been deleted by the destination plugin. The event listener method
159 * receives a \Drupal\migrate\Event\MigrateRowDeleteEvent instance.
163 * @see \Drupal\migrate\Event\MigrateRowDeleteEvent
167 const POST_ROW_DELETE = 'migrate.post_row_delete';
170 * Name of the event fired when saving a message to the idmap.
172 * This event allows modules to perform an action whenever a message is being
173 * logged by the idmap. The event listener method
174 * receives a \Drupal\migrate\Event\MigrateIdMapMessageEvent instance.
178 * @see \Drupal\migrate\Event\MigrateIdMapMessageEvent
182 const IDMAP_MESSAGE = 'migrate.idmap_message';