annotate core/modules/migrate/src/Event/MigrateEvents.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\migrate\Event;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Defines events for the migration system.
Chris@0 7 *
Chris@0 8 * @see \Drupal\migrate\Event\MigrateMapSaveEvent
Chris@0 9 * @see \Drupal\migrate\Event\MigrateMapDeleteEvent
Chris@0 10 * @see \Drupal\migrate\Event\MigrateImportEvent
Chris@0 11 * @see \Drupal\migrate\Event\MigratePreRowSaveEvent
Chris@0 12 * @see \Drupal\migrate\Event\MigratePostRowSaveEvent
Chris@0 13 * @see \Drupal\migrate\Event\MigrateRollbackEvent
Chris@0 14 * @see \Drupal\migrate\Event\MigrateRowDeleteEvent
Chris@0 15 * @see \Drupal\migrate\Event\MigrateIdMapMessageEvent
Chris@0 16 */
Chris@0 17 final class MigrateEvents {
Chris@0 18
Chris@0 19 /**
Chris@0 20 * Name of the event fired when saving to a migration's map.
Chris@0 21 *
Chris@0 22 * This event allows modules to perform an action whenever the disposition of
Chris@0 23 * an item being migrated is saved to the map table. The event listener method
Chris@0 24 * receives a \Drupal\migrate\Event\MigrateMapSaveEvent instance.
Chris@0 25 *
Chris@0 26 * @Event
Chris@0 27 *
Chris@0 28 * @see \Drupal\migrate\Event\MigrateMapSaveEvent
Chris@0 29 *
Chris@0 30 * @var string
Chris@0 31 */
Chris@0 32 const MAP_SAVE = 'migrate.map_save';
Chris@0 33
Chris@0 34 /**
Chris@0 35 * Name of the event fired when removing an entry from a migration's map.
Chris@0 36 *
Chris@0 37 * This event allows modules to perform an action whenever a row is deleted
Chris@0 38 * from a migration's map table (implying it has been rolled back). The event
Chris@0 39 * listener method receives a \Drupal\migrate\Event\MigrateMapDeleteEvent instance.
Chris@0 40 *
Chris@0 41 * @Event
Chris@0 42 *
Chris@0 43 * @see \Drupal\migrate\Event\MigrateMapDeleteEvent
Chris@0 44 *
Chris@0 45 * @var string
Chris@0 46 */
Chris@0 47 const MAP_DELETE = 'migrate.map_delete';
Chris@0 48
Chris@0 49 /**
Chris@0 50 * Name of the event fired when beginning a migration import operation.
Chris@0 51 *
Chris@0 52 * This event allows modules to perform an action whenever a migration import
Chris@0 53 * operation is about to begin. The event listener method receives a
Chris@0 54 * \Drupal\migrate\Event\MigrateImportEvent instance.
Chris@0 55 *
Chris@0 56 * @Event
Chris@0 57 *
Chris@0 58 * @see \Drupal\migrate\Event\MigrateImportEvent
Chris@0 59 *
Chris@0 60 * @var string
Chris@0 61 */
Chris@0 62 const PRE_IMPORT = 'migrate.pre_import';
Chris@0 63
Chris@0 64 /**
Chris@0 65 * Name of the event fired when finishing a migration import operation.
Chris@0 66 *
Chris@0 67 * This event allows modules to perform an action whenever a migration import
Chris@0 68 * operation is completing. The event listener method receives a
Chris@0 69 * \Drupal\migrate\Event\MigrateImportEvent instance.
Chris@0 70 *
Chris@0 71 * @Event
Chris@0 72 *
Chris@0 73 * @see \Drupal\migrate\Event\MigrateImportEvent
Chris@0 74 *
Chris@0 75 * @var string
Chris@0 76 */
Chris@0 77 const POST_IMPORT = 'migrate.post_import';
Chris@0 78
Chris@0 79 /**
Chris@0 80 * Name of the event fired when about to import a single item.
Chris@0 81 *
Chris@0 82 * This event allows modules to perform an action whenever a specific item
Chris@0 83 * is about to be saved by the destination plugin. The event listener method
Chris@0 84 * receives a \Drupal\migrate\Event\MigratePreRowSaveEvent instance.
Chris@0 85 *
Chris@0 86 * @Event
Chris@0 87 *
Chris@0 88 * @see \Drupal\migrate\Event\MigratePreRowSaveEvent
Chris@0 89 *
Chris@0 90 * @var string
Chris@0 91 */
Chris@0 92 const PRE_ROW_SAVE = 'migrate.pre_row_save';
Chris@0 93
Chris@0 94 /**
Chris@0 95 * Name of the event fired just after a single item has been imported.
Chris@0 96 *
Chris@0 97 * This event allows modules to perform an action whenever a specific item
Chris@0 98 * has been saved by the destination plugin. The event listener method
Chris@0 99 * receives a \Drupal\migrate\Event\MigratePostRowSaveEvent instance.
Chris@0 100 *
Chris@0 101 * @Event
Chris@0 102 *
Chris@0 103 * @see \Drupal\migrate\Event\MigratePostRowSaveEvent
Chris@0 104 *
Chris@0 105 * @var string
Chris@0 106 */
Chris@0 107 const POST_ROW_SAVE = 'migrate.post_row_save';
Chris@0 108
Chris@0 109 /**
Chris@0 110 * Name of the event fired when beginning a migration rollback operation.
Chris@0 111 *
Chris@0 112 * This event allows modules to perform an action whenever a migration
Chris@0 113 * rollback operation is about to begin. The event listener method receives a
Chris@0 114 * \Drupal\migrate\Event\MigrateRollbackEvent instance.
Chris@0 115 *
Chris@0 116 * @Event
Chris@0 117 *
Chris@0 118 * @see \Drupal\migrate\Event\MigrateRollbackEvent
Chris@0 119 *
Chris@0 120 * @var string
Chris@0 121 */
Chris@0 122 const PRE_ROLLBACK = 'migrate.pre_rollback';
Chris@0 123
Chris@0 124 /**
Chris@0 125 * Name of the event fired when finishing a migration rollback operation.
Chris@0 126 *
Chris@0 127 * This event allows modules to perform an action whenever a migration
Chris@0 128 * rollback operation is completing. The event listener method receives a
Chris@0 129 * \Drupal\migrate\Event\MigrateRollbackEvent instance.
Chris@0 130 *
Chris@0 131 * @Event
Chris@0 132 *
Chris@0 133 * @see \Drupal\migrate\Event\MigrateRollbackEvent
Chris@0 134 *
Chris@0 135 * @var string
Chris@0 136 */
Chris@0 137 const POST_ROLLBACK = 'migrate.post_rollback';
Chris@0 138
Chris@0 139 /**
Chris@0 140 * Name of the event fired when about to delete a single item.
Chris@0 141 *
Chris@0 142 * This event allows modules to perform an action whenever a specific item
Chris@0 143 * is about to be deleted by the destination plugin. The event listener method
Chris@0 144 * receives a \Drupal\migrate\Event\MigrateRowDeleteEvent instance.
Chris@0 145 *
Chris@0 146 * @Event
Chris@0 147 *
Chris@0 148 * @see \Drupal\migrate\Event\MigrateRowDeleteEvent
Chris@0 149 *
Chris@0 150 * @var string
Chris@0 151 */
Chris@0 152 const PRE_ROW_DELETE = 'migrate.pre_row_delete';
Chris@0 153
Chris@0 154 /**
Chris@0 155 * Name of the event fired just after a single item has been deleted.
Chris@0 156 *
Chris@0 157 * This event allows modules to perform an action whenever a specific item
Chris@0 158 * has been deleted by the destination plugin. The event listener method
Chris@0 159 * receives a \Drupal\migrate\Event\MigrateRowDeleteEvent instance.
Chris@0 160 *
Chris@0 161 * @Event
Chris@0 162 *
Chris@0 163 * @see \Drupal\migrate\Event\MigrateRowDeleteEvent
Chris@0 164 *
Chris@0 165 * @var string
Chris@0 166 */
Chris@0 167 const POST_ROW_DELETE = 'migrate.post_row_delete';
Chris@0 168
Chris@0 169 /**
Chris@0 170 * Name of the event fired when saving a message to the idmap.
Chris@0 171 *
Chris@0 172 * This event allows modules to perform an action whenever a message is being
Chris@0 173 * logged by the idmap. The event listener method
Chris@0 174 * receives a \Drupal\migrate\Event\MigrateIdMapMessageEvent instance.
Chris@0 175 *
Chris@0 176 * @Event
Chris@0 177 *
Chris@0 178 * @see \Drupal\migrate\Event\MigrateIdMapMessageEvent
Chris@0 179 *
Chris@0 180 * @var string
Chris@0 181 */
Chris@0 182 const IDMAP_MESSAGE = 'migrate.idmap_message';
Chris@0 183
Chris@0 184 }