aleph1.co.uk Git - yaffs-website/blob - web/core/modules/migrate/src/Event/MigrateEvents.php

   1 <?php
   2
   3 namespace Drupal\migrate\Event;
   4
   5 /**
   6  * Defines events for the migration system.
   7  *
   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
  16  */
  17 final class MigrateEvents {
  18
  19   /**
  20    * Name of the event fired when saving to a migration's map.
  21    *
  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.
  25    *
  26    * @Event
  27    *
  28    * @see \Drupal\migrate\Event\MigrateMapSaveEvent
  29    *
  30    * @var string
  31    */
  32   const MAP_SAVE = 'migrate.map_save';
  33
  34   /**
  35    * Name of the event fired when removing an entry from a migration's map.
  36    *
  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.
  40    *
  41    * @Event
  42    *
  43    * @see \Drupal\migrate\Event\MigrateMapDeleteEvent
  44    *
  45    * @var string
  46    */
  47   const MAP_DELETE = 'migrate.map_delete';
  48
  49   /**
  50    * Name of the event fired when beginning a migration import operation.
  51    *
  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.
  55    *
  56    * @Event
  57    *
  58    * @see \Drupal\migrate\Event\MigrateImportEvent
  59    *
  60    * @var string
  61    */
  62   const PRE_IMPORT = 'migrate.pre_import';
  63
  64   /**
  65    * Name of the event fired when finishing a migration import operation.
  66    *
  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.
  70    *
  71    * @Event
  72    *
  73    * @see \Drupal\migrate\Event\MigrateImportEvent
  74    *
  75    * @var string
  76    */
  77   const POST_IMPORT = 'migrate.post_import';
  78
  79   /**
  80    * Name of the event fired when about to import a single item.
  81    *
  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.
  85    *
  86    * @Event
  87    *
  88    * @see \Drupal\migrate\Event\MigratePreRowSaveEvent
  89    *
  90    * @var string
  91    */
  92   const PRE_ROW_SAVE = 'migrate.pre_row_save';
  93
  94   /**
  95    * Name of the event fired just after a single item has been imported.
  96    *
  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.
 100    *
 101    * @Event
 102    *
 103    * @see \Drupal\migrate\Event\MigratePostRowSaveEvent
 104    *
 105    * @var string
 106    */
 107   const POST_ROW_SAVE = 'migrate.post_row_save';
 108
 109   /**
 110    * Name of the event fired when beginning a migration rollback operation.
 111    *
 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.
 115    *
 116    * @Event
 117    *
 118    * @see \Drupal\migrate\Event\MigrateRollbackEvent
 119    *
 120    * @var string
 121    */
 122   const PRE_ROLLBACK = 'migrate.pre_rollback';
 123
 124   /**
 125    * Name of the event fired when finishing a migration rollback operation.
 126    *
 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.
 130    *
 131    * @Event
 132    *
 133    * @see \Drupal\migrate\Event\MigrateRollbackEvent
 134    *
 135    * @var string
 136    */
 137   const POST_ROLLBACK = 'migrate.post_rollback';
 138
 139   /**
 140    * Name of the event fired when about to delete a single item.
 141    *
 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.
 145    *
 146    * @Event
 147    *
 148    * @see \Drupal\migrate\Event\MigrateRowDeleteEvent
 149    *
 150    * @var string
 151    */
 152   const PRE_ROW_DELETE = 'migrate.pre_row_delete';
 153
 154   /**
 155    * Name of the event fired just after a single item has been deleted.
 156    *
 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.
 160    *
 161    * @Event
 162    *
 163    * @see \Drupal\migrate\Event\MigrateRowDeleteEvent
 164    *
 165    * @var string
 166    */
 167   const POST_ROW_DELETE = 'migrate.post_row_delete';
 168
 169   /**
 170    * Name of the event fired when saving a message to the idmap.
 171    *
 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.
 175    *
 176    * @Event
 177    *
 178    * @see \Drupal\migrate\Event\MigrateIdMapMessageEvent
 179    *
 180    * @var string
 181    */
 182   const IDMAP_MESSAGE = 'migrate.idmap_message';
 183
 184 }