Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/migrate/src/Event/MigrateEvents.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	100.00% covered (success)	100.00%	1 / 1	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0
MigrateEvents	100.00% covered (success)	100.00%	1 / 1	100.00% covered (success)	100.00%	0 / 0	0	100.00% covered (success)	100.00%	0 / 0

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