@@ -14,981 +14,981 @@ discard block |
||
14 | 14 | final class EE_Capabilities extends EE_Base |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * the name of the wp option used to store caps previously initialized |
|
19 | - */ |
|
20 | - const option_name = 'ee_caps_initialized'; |
|
21 | - |
|
22 | - /** |
|
23 | - * instance of EE_Capabilities object |
|
24 | - * |
|
25 | - * @var EE_Capabilities |
|
26 | - */ |
|
27 | - private static $_instance; |
|
28 | - |
|
29 | - |
|
30 | - /** |
|
31 | - * This is a map of caps that correspond to a default WP_Role. |
|
32 | - * Array is indexed by Role and values are ee capabilities. |
|
33 | - * |
|
34 | - * @since 4.5.0 |
|
35 | - * |
|
36 | - * @var array |
|
37 | - */ |
|
38 | - private $capabilities_map = array(); |
|
39 | - |
|
40 | - /** |
|
41 | - * This used to hold an array of EE_Meta_Capability_Map objects |
|
42 | - * that define the granular capabilities mapped to for a user depending on context. |
|
43 | - * |
|
44 | - * @var EE_Meta_Capability_Map[] |
|
45 | - */ |
|
46 | - private $_meta_caps = array(); |
|
47 | - |
|
48 | - /** |
|
49 | - * The internal $capabilities_map needs to be initialized before it can be used. |
|
50 | - * This flag tracks whether that has happened or not. |
|
51 | - * But for this to work, we need three states to indicate: |
|
52 | - * initialization has not occurred at all |
|
53 | - * initialization has started but is not complete |
|
54 | - * initialization is complete |
|
55 | - * The reason this is needed is because the addCaps() method |
|
56 | - * normally requires the $capabilities_map to be initialized, |
|
57 | - * but is also used during the initialization process. |
|
58 | - * So: |
|
59 | - * If initialized === null, init_caps() will be called before any other methods will run. |
|
60 | - * If initialized === false, then init_caps() is in the process of running it's logic. |
|
61 | - * If initialized === true, then init_caps() has completed the initialization process. |
|
62 | - * |
|
63 | - * @var boolean|null $initialized |
|
64 | - */ |
|
65 | - private $initialized; |
|
66 | - |
|
67 | - /** |
|
68 | - * @var boolean $reset |
|
69 | - */ |
|
70 | - private $reset = false; |
|
71 | - |
|
72 | - |
|
73 | - /** |
|
74 | - * singleton method used to instantiate class object |
|
75 | - * |
|
76 | - * @since 4.5.0 |
|
77 | - * |
|
78 | - * @return EE_Capabilities |
|
79 | - */ |
|
80 | - public static function instance() |
|
81 | - { |
|
82 | - // check if instantiated, and if not do so. |
|
83 | - if (! self::$_instance instanceof EE_Capabilities) { |
|
84 | - self::$_instance = new self(); |
|
85 | - } |
|
86 | - return self::$_instance; |
|
87 | - } |
|
88 | - |
|
89 | - |
|
90 | - /** |
|
91 | - * private constructor |
|
92 | - * |
|
93 | - * @since 4.5.0 |
|
94 | - */ |
|
95 | - private function __construct() |
|
96 | - { |
|
97 | - } |
|
98 | - |
|
99 | - |
|
100 | - /** |
|
101 | - * This delays the initialization of the capabilities class until EE_System core is loaded and ready. |
|
102 | - * |
|
103 | - * @param bool $reset allows for resetting the default capabilities saved on roles. Note that this doesn't |
|
104 | - * actually REMOVE any capabilities from existing roles, it just resaves defaults roles and |
|
105 | - * ensures that they are up to date. |
|
106 | - * |
|
107 | - * @since 4.5.0 |
|
108 | - * @return bool |
|
109 | - * @throws EE_Error |
|
110 | - */ |
|
111 | - public function init_caps($reset = false) |
|
112 | - { |
|
113 | - if (! EE_Maintenance_Mode::instance()->models_can_query()) { |
|
114 | - return false; |
|
115 | - } |
|
116 | - $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN); |
|
117 | - // if reset, then completely delete the cache option and clear the $capabilities_map property. |
|
118 | - if ($this->reset) { |
|
119 | - $this->initialized = null; |
|
120 | - $this->capabilities_map = array(); |
|
121 | - delete_option(self::option_name); |
|
122 | - } |
|
123 | - if ($this->initialized === null) { |
|
124 | - $this->initialized = false; |
|
125 | - do_action( |
|
126 | - 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
127 | - $this->reset |
|
128 | - ); |
|
129 | - $this->addCaps($this->_init_caps_map()); |
|
130 | - $this->_set_meta_caps(); |
|
131 | - do_action( |
|
132 | - 'AHEE__EE_Capabilities__init_caps__after_initialization', |
|
133 | - $this->capabilities_map |
|
134 | - ); |
|
135 | - $this->initialized = true; |
|
136 | - } |
|
137 | - // reset $this->reset so that it's not stuck on true if init_caps() gets called again |
|
138 | - $this->reset = false; |
|
139 | - return true; |
|
140 | - } |
|
141 | - |
|
142 | - |
|
143 | - /** |
|
144 | - * This sets the meta caps property. |
|
145 | - * |
|
146 | - * @since 4.5.0 |
|
147 | - * @return void |
|
148 | - * @throws EE_Error |
|
149 | - */ |
|
150 | - private function _set_meta_caps() |
|
151 | - { |
|
152 | - // get default meta caps and filter the returned array |
|
153 | - $this->_meta_caps = apply_filters( |
|
154 | - 'FHEE__EE_Capabilities___set_meta_caps__meta_caps', |
|
155 | - $this->_get_default_meta_caps_array() |
|
156 | - ); |
|
157 | - // add filter for map_meta_caps but only if models can query. |
|
158 | - if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) { |
|
159 | - add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4); |
|
160 | - } |
|
161 | - } |
|
162 | - |
|
163 | - |
|
164 | - /** |
|
165 | - * This builds and returns the default meta_caps array only once. |
|
166 | - * |
|
167 | - * @since 4.8.28.rc.012 |
|
168 | - * @return array |
|
169 | - * @throws EE_Error |
|
170 | - */ |
|
171 | - private function _get_default_meta_caps_array() |
|
172 | - { |
|
173 | - static $default_meta_caps = array(); |
|
174 | - // make sure we're only ever initializing the default _meta_caps array once if it's empty. |
|
175 | - if (empty($default_meta_caps)) { |
|
176 | - $default_meta_caps = array( |
|
177 | - // edits |
|
178 | - new EE_Meta_Capability_Map_Edit( |
|
179 | - 'ee_edit_event', |
|
180 | - array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events') |
|
181 | - ), |
|
182 | - new EE_Meta_Capability_Map_Edit( |
|
183 | - 'ee_edit_venue', |
|
184 | - array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues') |
|
185 | - ), |
|
186 | - new EE_Meta_Capability_Map_Edit( |
|
187 | - 'ee_edit_registration', |
|
188 | - array('Registration', '', 'ee_edit_others_registrations', '') |
|
189 | - ), |
|
190 | - new EE_Meta_Capability_Map_Edit( |
|
191 | - 'ee_edit_checkin', |
|
192 | - array('Registration', '', 'ee_edit_others_checkins', '') |
|
193 | - ), |
|
194 | - new EE_Meta_Capability_Map_Messages_Cap( |
|
195 | - 'ee_edit_message', |
|
196 | - array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages') |
|
197 | - ), |
|
198 | - new EE_Meta_Capability_Map_Edit( |
|
199 | - 'ee_edit_default_ticket', |
|
200 | - array('Ticket', '', 'ee_edit_others_default_tickets', '') |
|
201 | - ), |
|
202 | - new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
203 | - 'ee_edit_question', |
|
204 | - array('Question', '', '', 'ee_edit_system_questions') |
|
205 | - ), |
|
206 | - new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
207 | - 'ee_edit_question_group', |
|
208 | - array('Question_Group', '', '', 'ee_edit_system_question_groups') |
|
209 | - ), |
|
210 | - new EE_Meta_Capability_Map_Edit( |
|
211 | - 'ee_edit_payment_method', |
|
212 | - array('Payment_Method', '', 'ee_edit_others_payment_methods', '') |
|
213 | - ), |
|
214 | - // reads |
|
215 | - new EE_Meta_Capability_Map_Read( |
|
216 | - 'ee_read_event', |
|
217 | - array('Event', '', 'ee_read_others_events', 'ee_read_private_events') |
|
218 | - ), |
|
219 | - new EE_Meta_Capability_Map_Read( |
|
220 | - 'ee_read_venue', |
|
221 | - array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues') |
|
222 | - ), |
|
223 | - new EE_Meta_Capability_Map_Read( |
|
224 | - 'ee_read_registration', |
|
225 | - array('Registration', '', 'ee_read_others_registrations', '') |
|
226 | - ), |
|
227 | - new EE_Meta_Capability_Map_Read( |
|
228 | - 'ee_read_checkin', |
|
229 | - array('Registration', '', 'ee_read_others_checkins', '') |
|
230 | - ), |
|
231 | - new EE_Meta_Capability_Map_Messages_Cap( |
|
232 | - 'ee_read_message', |
|
233 | - array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages') |
|
234 | - ), |
|
235 | - new EE_Meta_Capability_Map_Read( |
|
236 | - 'ee_read_default_ticket', |
|
237 | - array('Ticket', '', 'ee_read_others_default_tickets', '') |
|
238 | - ), |
|
239 | - new EE_Meta_Capability_Map_Read( |
|
240 | - 'ee_read_payment_method', |
|
241 | - array('Payment_Method', '', 'ee_read_others_payment_methods', '') |
|
242 | - ), |
|
243 | - // deletes |
|
244 | - new EE_Meta_Capability_Map_Delete( |
|
245 | - 'ee_delete_event', |
|
246 | - array( |
|
247 | - 'Event', |
|
248 | - 'ee_delete_published_events', |
|
249 | - 'ee_delete_others_events', |
|
250 | - 'ee_delete_private_events', |
|
251 | - ) |
|
252 | - ), |
|
253 | - new EE_Meta_Capability_Map_Delete( |
|
254 | - 'ee_delete_venue', |
|
255 | - array( |
|
256 | - 'Venue', |
|
257 | - 'ee_delete_published_venues', |
|
258 | - 'ee_delete_others_venues', |
|
259 | - 'ee_delete_private_venues', |
|
260 | - ) |
|
261 | - ), |
|
262 | - new EE_Meta_Capability_Map_Delete( |
|
263 | - 'ee_delete_registration', |
|
264 | - array('Registration', '', 'ee_delete_others_registrations', '') |
|
265 | - ), |
|
266 | - new EE_Meta_Capability_Map_Delete( |
|
267 | - 'ee_delete_checkin', |
|
268 | - array('Registration', '', 'ee_delete_others_checkins', '') |
|
269 | - ), |
|
270 | - new EE_Meta_Capability_Map_Messages_Cap( |
|
271 | - 'ee_delete_message', |
|
272 | - array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages') |
|
273 | - ), |
|
274 | - new EE_Meta_Capability_Map_Delete( |
|
275 | - 'ee_delete_default_ticket', |
|
276 | - array('Ticket', '', 'ee_delete_others_default_tickets', '') |
|
277 | - ), |
|
278 | - new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
279 | - 'ee_delete_question', |
|
280 | - array('Question', '', '', 'delete_system_questions') |
|
281 | - ), |
|
282 | - new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
283 | - 'ee_delete_question_group', |
|
284 | - array('Question_Group', '', '', 'delete_system_question_groups') |
|
285 | - ), |
|
286 | - new EE_Meta_Capability_Map_Delete( |
|
287 | - 'ee_delete_payment_method', |
|
288 | - array('Payment_Method', '', 'ee_delete_others_payment_methods', '') |
|
289 | - ), |
|
290 | - ); |
|
291 | - } |
|
292 | - return $default_meta_caps; |
|
293 | - } |
|
294 | - |
|
295 | - |
|
296 | - /** |
|
297 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
298 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
299 | - * |
|
300 | - * The actual logic is carried out by implementer classes in their definition of _map_meta_caps. |
|
301 | - * |
|
302 | - * @since 4.5.0 |
|
303 | - * @see wp-includes/capabilities.php |
|
304 | - * |
|
305 | - * @param array $caps actual users capabilities |
|
306 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
307 | - * @param int $user_id The user id |
|
308 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
309 | - * @return array actual users capabilities |
|
310 | - * @throws EE_Error |
|
311 | - */ |
|
312 | - public function map_meta_caps($caps, $cap, $user_id, $args) |
|
313 | - { |
|
314 | - if (did_action('AHEE__EE_System__load_espresso_addons__complete')) { |
|
315 | - // loop through our _meta_caps array |
|
316 | - foreach ($this->_meta_caps as $meta_map) { |
|
317 | - if (! $meta_map instanceof EE_Meta_Capability_Map) { |
|
318 | - continue; |
|
319 | - } |
|
320 | - // don't load models if there is no object ID in the args |
|
321 | - if (! empty($args[0])) { |
|
322 | - $meta_map->ensure_is_model(); |
|
323 | - } |
|
324 | - $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args); |
|
325 | - } |
|
326 | - } |
|
327 | - return $caps; |
|
328 | - } |
|
329 | - |
|
330 | - |
|
331 | - /** |
|
332 | - * This sets up and returns the initial capabilities map for Event Espresso |
|
333 | - * Note this array is filtered. |
|
334 | - * It is assumed that all available EE capabilities are assigned to the administrator role. |
|
335 | - * |
|
336 | - * @since 4.5.0 |
|
337 | - * |
|
338 | - * @return array |
|
339 | - */ |
|
340 | - private function _init_caps_map() |
|
341 | - { |
|
342 | - return apply_filters( |
|
343 | - 'FHEE__EE_Capabilities__init_caps_map__caps', |
|
344 | - array( |
|
345 | - 'administrator' => array( |
|
346 | - // basic access |
|
347 | - 'ee_read_ee', |
|
348 | - // gateways |
|
349 | - /** |
|
350 | - * note that with payment method capabilities, although we've implemented |
|
351 | - * capability mapping which will be used for accessing payment methods owned by |
|
352 | - * other users. This is not fully implemented yet in the payment method ui. |
|
353 | - * Currently only the "plural" caps are in active use. |
|
354 | - * (Specific payment method caps are in use as well). |
|
355 | - **/ |
|
356 | - 'ee_manage_gateways', |
|
357 | - 'ee_read_payment_methods', |
|
358 | - 'ee_read_others_payment_methods', |
|
359 | - 'ee_edit_payment_methods', |
|
360 | - 'ee_edit_others_payment_methods', |
|
361 | - 'ee_delete_payment_methods', |
|
362 | - // events |
|
363 | - 'ee_publish_events', |
|
364 | - 'ee_read_private_events', |
|
365 | - 'ee_read_others_events', |
|
366 | - 'ee_read_events', |
|
367 | - 'ee_edit_events', |
|
368 | - 'ee_edit_published_events', |
|
369 | - 'ee_edit_others_events', |
|
370 | - 'ee_edit_private_events', |
|
371 | - 'ee_delete_published_events', |
|
372 | - 'ee_delete_private_events', |
|
373 | - 'ee_delete_events', |
|
374 | - 'ee_delete_others_events', |
|
375 | - // event categories |
|
376 | - 'ee_manage_event_categories', |
|
377 | - 'ee_edit_event_category', |
|
378 | - 'ee_delete_event_category', |
|
379 | - 'ee_assign_event_category', |
|
380 | - // venues |
|
381 | - 'ee_publish_venues', |
|
382 | - 'ee_read_venues', |
|
383 | - 'ee_read_others_venues', |
|
384 | - 'ee_read_private_venues', |
|
385 | - 'ee_edit_venues', |
|
386 | - 'ee_edit_others_venues', |
|
387 | - 'ee_edit_published_venues', |
|
388 | - 'ee_edit_private_venues', |
|
389 | - 'ee_delete_venues', |
|
390 | - 'ee_delete_others_venues', |
|
391 | - 'ee_delete_private_venues', |
|
392 | - 'ee_delete_published_venues', |
|
393 | - // venue categories |
|
394 | - 'ee_manage_venue_categories', |
|
395 | - 'ee_edit_venue_category', |
|
396 | - 'ee_delete_venue_category', |
|
397 | - 'ee_assign_venue_category', |
|
398 | - // contacts |
|
399 | - 'ee_read_contacts', |
|
400 | - 'ee_edit_contacts', |
|
401 | - 'ee_delete_contacts', |
|
402 | - // registrations |
|
403 | - 'ee_read_registrations', |
|
404 | - 'ee_read_others_registrations', |
|
405 | - 'ee_edit_registrations', |
|
406 | - 'ee_edit_others_registrations', |
|
407 | - 'ee_delete_registrations', |
|
408 | - 'ee_delete_others_registrations', |
|
409 | - // checkins |
|
410 | - 'ee_read_others_checkins', |
|
411 | - 'ee_read_checkins', |
|
412 | - 'ee_edit_checkins', |
|
413 | - 'ee_edit_others_checkins', |
|
414 | - 'ee_delete_checkins', |
|
415 | - 'ee_delete_others_checkins', |
|
416 | - // transactions && payments |
|
417 | - 'ee_read_transaction', |
|
418 | - 'ee_read_transactions', |
|
419 | - 'ee_edit_payments', |
|
420 | - 'ee_delete_payments', |
|
421 | - // messages |
|
422 | - 'ee_read_messages', |
|
423 | - 'ee_read_others_messages', |
|
424 | - 'ee_read_global_messages', |
|
425 | - 'ee_edit_global_messages', |
|
426 | - 'ee_edit_messages', |
|
427 | - 'ee_edit_others_messages', |
|
428 | - 'ee_delete_messages', |
|
429 | - 'ee_delete_others_messages', |
|
430 | - 'ee_delete_global_messages', |
|
431 | - 'ee_send_message', |
|
432 | - // tickets |
|
433 | - 'ee_read_default_tickets', |
|
434 | - 'ee_read_others_default_tickets', |
|
435 | - 'ee_edit_default_tickets', |
|
436 | - 'ee_edit_others_default_tickets', |
|
437 | - 'ee_delete_default_tickets', |
|
438 | - 'ee_delete_others_default_tickets', |
|
439 | - // prices |
|
440 | - 'ee_edit_default_price', |
|
441 | - 'ee_edit_default_prices', |
|
442 | - 'ee_delete_default_price', |
|
443 | - 'ee_delete_default_prices', |
|
444 | - 'ee_edit_default_price_type', |
|
445 | - 'ee_edit_default_price_types', |
|
446 | - 'ee_delete_default_price_type', |
|
447 | - 'ee_delete_default_price_types', |
|
448 | - 'ee_read_default_prices', |
|
449 | - 'ee_read_default_price_types', |
|
450 | - // registration form |
|
451 | - 'ee_edit_questions', |
|
452 | - 'ee_edit_system_questions', |
|
453 | - 'ee_read_questions', |
|
454 | - 'ee_delete_questions', |
|
455 | - 'ee_edit_question_groups', |
|
456 | - 'ee_read_question_groups', |
|
457 | - 'ee_edit_system_question_groups', |
|
458 | - 'ee_delete_question_groups', |
|
459 | - // event_type taxonomy |
|
460 | - 'ee_assign_event_type', |
|
461 | - 'ee_manage_event_types', |
|
462 | - 'ee_edit_event_type', |
|
463 | - 'ee_delete_event_type', |
|
464 | - ), |
|
465 | - 'ee_events_administrator' => array( |
|
466 | - // core wp caps |
|
467 | - 'read', |
|
468 | - 'read_private_pages', |
|
469 | - 'read_private_posts', |
|
470 | - 'edit_users', |
|
471 | - 'edit_posts', |
|
472 | - 'edit_pages', |
|
473 | - 'edit_published_posts', |
|
474 | - 'edit_published_pages', |
|
475 | - 'edit_private_pages', |
|
476 | - 'edit_private_posts', |
|
477 | - 'edit_others_posts', |
|
478 | - 'edit_others_pages', |
|
479 | - 'publish_posts', |
|
480 | - 'publish_pages', |
|
481 | - 'delete_posts', |
|
482 | - 'delete_pages', |
|
483 | - 'delete_private_pages', |
|
484 | - 'delete_private_posts', |
|
485 | - 'delete_published_pages', |
|
486 | - 'delete_published_posts', |
|
487 | - 'delete_others_posts', |
|
488 | - 'delete_others_pages', |
|
489 | - 'manage_categories', |
|
490 | - 'manage_links', |
|
491 | - 'moderate_comments', |
|
492 | - 'unfiltered_html', |
|
493 | - 'upload_files', |
|
494 | - 'export', |
|
495 | - 'import', |
|
496 | - 'list_users', |
|
497 | - 'level_1', // required if user with this role shows up in author dropdowns |
|
498 | - // basic ee access |
|
499 | - 'ee_read_ee', |
|
500 | - // events |
|
501 | - 'ee_publish_events', |
|
502 | - 'ee_read_private_events', |
|
503 | - 'ee_read_others_events', |
|
504 | - 'ee_read_event', |
|
505 | - 'ee_read_events', |
|
506 | - 'ee_edit_event', |
|
507 | - 'ee_edit_events', |
|
508 | - 'ee_edit_published_events', |
|
509 | - 'ee_edit_others_events', |
|
510 | - 'ee_edit_private_events', |
|
511 | - 'ee_delete_published_events', |
|
512 | - 'ee_delete_private_events', |
|
513 | - 'ee_delete_event', |
|
514 | - 'ee_delete_events', |
|
515 | - 'ee_delete_others_events', |
|
516 | - // event categories |
|
517 | - 'ee_manage_event_categories', |
|
518 | - 'ee_edit_event_category', |
|
519 | - 'ee_delete_event_category', |
|
520 | - 'ee_assign_event_category', |
|
521 | - // venues |
|
522 | - 'ee_publish_venues', |
|
523 | - 'ee_read_venue', |
|
524 | - 'ee_read_venues', |
|
525 | - 'ee_read_others_venues', |
|
526 | - 'ee_read_private_venues', |
|
527 | - 'ee_edit_venue', |
|
528 | - 'ee_edit_venues', |
|
529 | - 'ee_edit_others_venues', |
|
530 | - 'ee_edit_published_venues', |
|
531 | - 'ee_edit_private_venues', |
|
532 | - 'ee_delete_venue', |
|
533 | - 'ee_delete_venues', |
|
534 | - 'ee_delete_others_venues', |
|
535 | - 'ee_delete_private_venues', |
|
536 | - 'ee_delete_published_venues', |
|
537 | - // venue categories |
|
538 | - 'ee_manage_venue_categories', |
|
539 | - 'ee_edit_venue_category', |
|
540 | - 'ee_delete_venue_category', |
|
541 | - 'ee_assign_venue_category', |
|
542 | - // contacts |
|
543 | - 'ee_read_contacts', |
|
544 | - 'ee_edit_contacts', |
|
545 | - 'ee_delete_contacts', |
|
546 | - // registrations |
|
547 | - 'ee_read_registrations', |
|
548 | - 'ee_read_others_registrations', |
|
549 | - 'ee_edit_registration', |
|
550 | - 'ee_edit_registrations', |
|
551 | - 'ee_edit_others_registrations', |
|
552 | - 'ee_delete_registration', |
|
553 | - 'ee_delete_registrations', |
|
554 | - 'ee_delete_others_registrations', |
|
555 | - // checkins |
|
556 | - 'ee_read_others_checkins', |
|
557 | - 'ee_read_checkins', |
|
558 | - 'ee_edit_checkins', |
|
559 | - 'ee_edit_others_checkins', |
|
560 | - 'ee_delete_checkins', |
|
561 | - 'ee_delete_others_checkins', |
|
562 | - // transactions && payments |
|
563 | - 'ee_read_transaction', |
|
564 | - 'ee_read_transactions', |
|
565 | - 'ee_edit_payments', |
|
566 | - 'ee_delete_payments', |
|
567 | - // messages |
|
568 | - 'ee_read_messages', |
|
569 | - 'ee_read_others_messages', |
|
570 | - 'ee_read_global_messages', |
|
571 | - 'ee_edit_global_messages', |
|
572 | - 'ee_edit_messages', |
|
573 | - 'ee_edit_others_messages', |
|
574 | - 'ee_delete_messages', |
|
575 | - 'ee_delete_others_messages', |
|
576 | - 'ee_delete_global_messages', |
|
577 | - 'ee_send_message', |
|
578 | - // tickets |
|
579 | - 'ee_read_default_tickets', |
|
580 | - 'ee_read_others_default_tickets', |
|
581 | - 'ee_edit_default_tickets', |
|
582 | - 'ee_edit_others_default_tickets', |
|
583 | - 'ee_delete_default_tickets', |
|
584 | - 'ee_delete_others_default_tickets', |
|
585 | - // prices |
|
586 | - 'ee_edit_default_price', |
|
587 | - 'ee_edit_default_prices', |
|
588 | - 'ee_delete_default_price', |
|
589 | - 'ee_delete_default_prices', |
|
590 | - 'ee_edit_default_price_type', |
|
591 | - 'ee_edit_default_price_types', |
|
592 | - 'ee_delete_default_price_type', |
|
593 | - 'ee_delete_default_price_types', |
|
594 | - 'ee_read_default_prices', |
|
595 | - 'ee_read_default_price_types', |
|
596 | - // registration form |
|
597 | - 'ee_edit_questions', |
|
598 | - 'ee_edit_system_questions', |
|
599 | - 'ee_read_questions', |
|
600 | - 'ee_delete_questions', |
|
601 | - 'ee_edit_question_groups', |
|
602 | - 'ee_read_question_groups', |
|
603 | - 'ee_edit_system_question_groups', |
|
604 | - 'ee_delete_question_groups', |
|
605 | - // event_type taxonomy |
|
606 | - 'ee_assign_event_type', |
|
607 | - 'ee_manage_event_types', |
|
608 | - 'ee_edit_event_type', |
|
609 | - 'ee_delete_event_type', |
|
610 | - ), |
|
611 | - ) |
|
612 | - ); |
|
613 | - } |
|
614 | - |
|
615 | - |
|
616 | - /** |
|
617 | - * @return bool |
|
618 | - * @throws EE_Error |
|
619 | - */ |
|
620 | - private function setupCapabilitiesMap() |
|
621 | - { |
|
622 | - // if the initialization process hasn't even started, then we need to call init_caps() |
|
623 | - if ($this->initialized === null) { |
|
624 | - return $this->init_caps(); |
|
625 | - } |
|
626 | - // unless resetting, get caps from db if we haven't already |
|
627 | - $this->capabilities_map = $this->reset || ! empty($this->capabilities_map) |
|
628 | - ? $this->capabilities_map |
|
629 | - : get_option(self::option_name, array()); |
|
630 | - return true; |
|
631 | - } |
|
632 | - |
|
633 | - |
|
634 | - /** |
|
635 | - * @param bool $update |
|
636 | - * @return bool |
|
637 | - */ |
|
638 | - private function updateCapabilitiesMap($update = true) |
|
639 | - { |
|
640 | - return $update ? update_option(self::option_name, $this->capabilities_map) : false; |
|
641 | - } |
|
642 | - |
|
643 | - |
|
644 | - /** |
|
645 | - * Adds capabilities to roles. |
|
646 | - * |
|
647 | - * @since 4.9.42 |
|
648 | - * @param array $capabilities_to_add array of capabilities to add, indexed by roles. |
|
649 | - * Note that this should ONLY be called on activation hook |
|
650 | - * otherwise the caps will be added on every request. |
|
651 | - * @return bool |
|
652 | - * @throws \EE_Error |
|
653 | - */ |
|
654 | - public function addCaps(array $capabilities_to_add) |
|
655 | - { |
|
656 | - // don't do anything if the capabilities map can not be initialized |
|
657 | - if (! $this->setupCapabilitiesMap()) { |
|
658 | - return false; |
|
659 | - } |
|
660 | - // and filter the array so others can get in on the fun during resets |
|
661 | - $capabilities_to_add = apply_filters( |
|
662 | - 'FHEE__EE_Capabilities__addCaps__capabilities_to_add', |
|
663 | - $capabilities_to_add, |
|
664 | - $this->reset, |
|
665 | - $this->capabilities_map |
|
666 | - ); |
|
667 | - $update_capabilities_map = false; |
|
668 | - // if not reset, see what caps are new for each role. if they're new, add them. |
|
669 | - foreach ($capabilities_to_add as $role => $caps_for_role) { |
|
670 | - if (is_array($caps_for_role)) { |
|
671 | - foreach ($caps_for_role as $cap) { |
|
672 | - if (! $this->capHasBeenAddedToRole($role, $cap) |
|
673 | - && $this->add_cap_to_role($role, $cap, true, false) |
|
674 | - ) { |
|
675 | - $update_capabilities_map = true; |
|
676 | - } |
|
677 | - } |
|
678 | - } |
|
679 | - } |
|
680 | - // now let's just save the cap that has been set but only if there's been a change. |
|
681 | - $updated = $this->updateCapabilitiesMap($update_capabilities_map); |
|
682 | - $this->flushWpUser($updated); |
|
683 | - do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated); |
|
684 | - return $updated; |
|
685 | - } |
|
686 | - |
|
687 | - |
|
688 | - /** |
|
689 | - * Loops through the capabilities map and removes the role caps specified by the incoming array |
|
690 | - * |
|
691 | - * @param array $caps_map map of capabilities to be removed (indexed by roles) |
|
692 | - * @return bool |
|
693 | - * @throws \EE_Error |
|
694 | - */ |
|
695 | - public function removeCaps($caps_map) |
|
696 | - { |
|
697 | - // don't do anything if the capabilities map can not be initialized |
|
698 | - if (! $this->setupCapabilitiesMap()) { |
|
699 | - return false; |
|
700 | - } |
|
701 | - $update_capabilities_map = false; |
|
702 | - foreach ($caps_map as $role => $caps_for_role) { |
|
703 | - if (is_array($caps_for_role)) { |
|
704 | - foreach ($caps_for_role as $cap) { |
|
705 | - if ($this->capHasBeenAddedToRole($role, $cap) |
|
706 | - && $this->remove_cap_from_role($role, $cap, false) |
|
707 | - ) { |
|
708 | - $update_capabilities_map = true; |
|
709 | - } |
|
710 | - } |
|
711 | - } |
|
712 | - } |
|
713 | - // maybe resave the caps |
|
714 | - $updated = $this->updateCapabilitiesMap($update_capabilities_map); |
|
715 | - $this->flushWpUser($updated); |
|
716 | - return $updated; |
|
717 | - } |
|
718 | - |
|
719 | - |
|
720 | - /** |
|
721 | - * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from |
|
722 | - * the roles on that user. |
|
723 | - * |
|
724 | - * @param bool $flush Default is to flush the WP_User object. If false, then this method effectively does nothing. |
|
725 | - */ |
|
726 | - private function flushWpUser($flush = true) |
|
727 | - { |
|
728 | - if ($flush) { |
|
729 | - $user = wp_get_current_user(); |
|
730 | - if ($user instanceof WP_User) { |
|
731 | - $user->get_role_caps(); |
|
732 | - } |
|
733 | - } |
|
734 | - } |
|
735 | - |
|
736 | - |
|
737 | - /** |
|
738 | - * This method sets a capability on a role. Note this should only be done on activation, or if you have something |
|
739 | - * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note. |
|
740 | - * this is a wrapper for $wp_role->add_cap() |
|
741 | - * |
|
742 | - * @see wp-includes/capabilities.php |
|
743 | - * @since 4.5.0 |
|
744 | - * @param string|WP_Role $role A WordPress role the capability is being added to |
|
745 | - * @param string $cap The capability being added to the role |
|
746 | - * @param bool $grant Whether to grant access to this cap on this role. |
|
747 | - * @param bool $update_capabilities_map |
|
748 | - * @return bool |
|
749 | - * @throws \EE_Error |
|
750 | - */ |
|
751 | - public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true) |
|
752 | - { |
|
753 | - // capture incoming value for $role because we may need it to create a new WP_Role |
|
754 | - $orig_role = $role; |
|
755 | - $role = $role instanceof WP_Role ? $role : get_role($role); |
|
756 | - // if the role isn't available then we create it. |
|
757 | - if (! $role instanceof WP_Role) { |
|
758 | - // if a plugin wants to create a specific role name then they should create the role before |
|
759 | - // EE_Capabilities does. Otherwise this function will create the role name from the slug: |
|
760 | - // - removes any `ee_` namespacing from the start of the slug. |
|
761 | - // - replaces `_` with ` ` (empty space). |
|
762 | - // - sentence case on the resulting string. |
|
763 | - $role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role)); |
|
764 | - $role = add_role($orig_role, $role_label); |
|
765 | - } |
|
766 | - if ($role instanceof WP_Role) { |
|
767 | - // don't do anything if the capabilities map can not be initialized |
|
768 | - if (! $this->setupCapabilitiesMap()) { |
|
769 | - return false; |
|
770 | - } |
|
771 | - if (! $this->capHasBeenAddedToRole($role->name, $cap)) { |
|
772 | - $role->add_cap($cap, $grant); |
|
773 | - $this->capabilities_map[ $role->name ][] = $cap; |
|
774 | - $this->updateCapabilitiesMap($update_capabilities_map); |
|
775 | - return true; |
|
776 | - } |
|
777 | - } |
|
778 | - return false; |
|
779 | - } |
|
780 | - |
|
781 | - |
|
782 | - /** |
|
783 | - * Functions similarly to add_cap_to_role except removes cap from given role. |
|
784 | - * Wrapper for $wp_role->remove_cap() |
|
785 | - * |
|
786 | - * @see wp-includes/capabilities.php |
|
787 | - * @since 4.5.0 |
|
788 | - * @param string|WP_Role $role A WordPress role the capability is being removed from. |
|
789 | - * @param string $cap The capability being removed |
|
790 | - * @param bool $update_capabilities_map |
|
791 | - * @return bool |
|
792 | - * @throws \EE_Error |
|
793 | - */ |
|
794 | - public function remove_cap_from_role($role, $cap, $update_capabilities_map = true) |
|
795 | - { |
|
796 | - // don't do anything if the capabilities map can not be initialized |
|
797 | - if (! $this->setupCapabilitiesMap()) { |
|
798 | - return false; |
|
799 | - } |
|
800 | - |
|
801 | - $role = $role instanceof WP_Role ? $role : get_role($role); |
|
802 | - if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) { |
|
803 | - $role->remove_cap($cap); |
|
804 | - unset($this->capabilities_map[ $role->name ][ $index ]); |
|
805 | - $this->updateCapabilitiesMap($update_capabilities_map); |
|
806 | - return true; |
|
807 | - } |
|
808 | - return false; |
|
809 | - } |
|
810 | - |
|
811 | - |
|
812 | - /** |
|
813 | - * @param string $role_name |
|
814 | - * @param string $cap |
|
815 | - * @param bool $get_index |
|
816 | - * @return bool|mixed |
|
817 | - */ |
|
818 | - private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false) |
|
819 | - { |
|
820 | - if (isset($this->capabilities_map[ $role_name ]) |
|
821 | - && ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false |
|
822 | - ) { |
|
823 | - return $get_index ? $index : true; |
|
824 | - } |
|
825 | - return false; |
|
826 | - } |
|
827 | - |
|
828 | - |
|
829 | - /** |
|
830 | - * Wrapper for the native WP current_user_can() method. |
|
831 | - * This is provided as a handy method for a couple things: |
|
832 | - * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to |
|
833 | - * write those filters wherever current_user_can is called). |
|
834 | - * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters ) |
|
835 | - * |
|
836 | - * @since 4.5.0 |
|
837 | - * |
|
838 | - * @param string $cap The cap being checked. |
|
839 | - * @param string $context The context where the current_user_can is being called from. |
|
840 | - * @param int $id Optional. Id for item where current_user_can is being called from (used in map_meta_cap() |
|
841 | - * filters. |
|
842 | - * |
|
843 | - * @return bool Whether user can or not. |
|
844 | - */ |
|
845 | - public function current_user_can($cap, $context, $id = 0) |
|
846 | - { |
|
847 | - // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
848 | - $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id); |
|
849 | - $filtered_cap = apply_filters( |
|
850 | - 'FHEE__EE_Capabilities__current_user_can__cap', |
|
851 | - $filtered_cap, |
|
852 | - $context, |
|
853 | - $cap, |
|
854 | - $id |
|
855 | - ); |
|
856 | - return ! empty($id) |
|
857 | - ? current_user_can($filtered_cap, $id) |
|
858 | - : current_user_can($filtered_cap); |
|
859 | - } |
|
860 | - |
|
861 | - |
|
862 | - /** |
|
863 | - * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class. |
|
864 | - * |
|
865 | - * @param int|WP_User $user Either the user_id or a WP_User object |
|
866 | - * @param string $cap The capability string being checked |
|
867 | - * @param string $context The context where the user_can is being called from (used in filters). |
|
868 | - * @param int $id Optional. Id for item where user_can is being called from ( used in map_meta_cap() |
|
869 | - * filters) |
|
870 | - * |
|
871 | - * @return bool Whether user can or not. |
|
872 | - */ |
|
873 | - public function user_can($user, $cap, $context, $id = 0) |
|
874 | - { |
|
875 | - // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
876 | - $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id); |
|
877 | - $filtered_cap = apply_filters( |
|
878 | - 'FHEE__EE_Capabilities__user_can__cap', |
|
879 | - $filtered_cap, |
|
880 | - $context, |
|
881 | - $cap, |
|
882 | - $user, |
|
883 | - $id |
|
884 | - ); |
|
885 | - return ! empty($id) |
|
886 | - ? user_can($user, $filtered_cap, $id) |
|
887 | - : user_can($user, $filtered_cap); |
|
888 | - } |
|
889 | - |
|
890 | - |
|
891 | - /** |
|
892 | - * Wrapper for the native WP current_user_can_for_blog() method. |
|
893 | - * This is provided as a handy method for a couple things: |
|
894 | - * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to |
|
895 | - * write those filters wherever current_user_can is called). |
|
896 | - * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters ) |
|
897 | - * |
|
898 | - * @since 4.5.0 |
|
899 | - * |
|
900 | - * @param int $blog_id The blog id that is being checked for. |
|
901 | - * @param string $cap The cap being checked. |
|
902 | - * @param string $context The context where the current_user_can is being called from. |
|
903 | - * @param int $id Optional. Id for item where current_user_can is being called from (used in map_meta_cap() |
|
904 | - * filters. |
|
905 | - * |
|
906 | - * @return bool Whether user can or not. |
|
907 | - */ |
|
908 | - public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0) |
|
909 | - { |
|
910 | - $user_can = ! empty($id) |
|
911 | - ? current_user_can_for_blog($blog_id, $cap, $id) |
|
912 | - : current_user_can($blog_id, $cap); |
|
913 | - // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
914 | - $user_can = apply_filters( |
|
915 | - 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context, |
|
916 | - $user_can, |
|
917 | - $blog_id, |
|
918 | - $cap, |
|
919 | - $id |
|
920 | - ); |
|
921 | - $user_can = apply_filters( |
|
922 | - 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can', |
|
923 | - $user_can, |
|
924 | - $context, |
|
925 | - $blog_id, |
|
926 | - $cap, |
|
927 | - $id |
|
928 | - ); |
|
929 | - return $user_can; |
|
930 | - } |
|
931 | - |
|
932 | - |
|
933 | - /** |
|
934 | - * This helper method just returns an array of registered EE capabilities. |
|
935 | - * |
|
936 | - * @since 4.5.0 |
|
937 | - * @param string $role If empty then the entire role/capability map is returned. |
|
938 | - * Otherwise just the capabilities for the given role are returned. |
|
939 | - * @return array |
|
940 | - * @throws EE_Error |
|
941 | - */ |
|
942 | - public function get_ee_capabilities($role = 'administrator') |
|
943 | - { |
|
944 | - if (! $this->initialized) { |
|
945 | - $this->init_caps(); |
|
946 | - } |
|
947 | - if (empty($role)) { |
|
948 | - return $this->capabilities_map; |
|
949 | - } |
|
950 | - return isset($this->capabilities_map[ $role ]) |
|
951 | - ? $this->capabilities_map[ $role ] |
|
952 | - : array(); |
|
953 | - } |
|
954 | - |
|
955 | - |
|
956 | - /** |
|
957 | - * @deprecated 4.9.42 |
|
958 | - * @param bool $reset If you need to reset Event Espresso's capabilities, |
|
959 | - * then please use the init_caps() method with the "$reset" parameter set to "true" |
|
960 | - * @param array $caps_map Optional. |
|
961 | - * Can be used to send a custom map of roles and capabilities for setting them up. |
|
962 | - * Note that this should ONLY be called on activation hook or some other one-time |
|
963 | - * task otherwise the caps will be added on every request. |
|
964 | - * @return void |
|
965 | - * @throws EE_Error |
|
966 | - */ |
|
967 | - public function init_role_caps($reset = false, $caps_map = array()) |
|
968 | - { |
|
969 | - // If this method is called directly and reset is set as 'true', |
|
970 | - // then display a doing it wrong notice, because we want resets to go through init_caps() |
|
971 | - // to guarantee that everything is set up correctly. |
|
972 | - // This prevents the capabilities map getting reset incorrectly by direct calls to this method. |
|
973 | - if ($reset) { |
|
974 | - EE_Error::doing_it_wrong( |
|
975 | - __METHOD__, |
|
976 | - sprintf( |
|
977 | - esc_html__( |
|
978 | - 'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".', |
|
979 | - 'event_espresso' |
|
980 | - ), |
|
981 | - '$reset', |
|
982 | - __METHOD__ . '()', |
|
983 | - 'EE_Capabilities::init_caps()', |
|
984 | - 'true' |
|
985 | - ), |
|
986 | - '4.9.42', |
|
987 | - '5.0.0' |
|
988 | - ); |
|
989 | - } |
|
990 | - $this->addCaps($caps_map); |
|
991 | - } |
|
17 | + /** |
|
18 | + * the name of the wp option used to store caps previously initialized |
|
19 | + */ |
|
20 | + const option_name = 'ee_caps_initialized'; |
|
21 | + |
|
22 | + /** |
|
23 | + * instance of EE_Capabilities object |
|
24 | + * |
|
25 | + * @var EE_Capabilities |
|
26 | + */ |
|
27 | + private static $_instance; |
|
28 | + |
|
29 | + |
|
30 | + /** |
|
31 | + * This is a map of caps that correspond to a default WP_Role. |
|
32 | + * Array is indexed by Role and values are ee capabilities. |
|
33 | + * |
|
34 | + * @since 4.5.0 |
|
35 | + * |
|
36 | + * @var array |
|
37 | + */ |
|
38 | + private $capabilities_map = array(); |
|
39 | + |
|
40 | + /** |
|
41 | + * This used to hold an array of EE_Meta_Capability_Map objects |
|
42 | + * that define the granular capabilities mapped to for a user depending on context. |
|
43 | + * |
|
44 | + * @var EE_Meta_Capability_Map[] |
|
45 | + */ |
|
46 | + private $_meta_caps = array(); |
|
47 | + |
|
48 | + /** |
|
49 | + * The internal $capabilities_map needs to be initialized before it can be used. |
|
50 | + * This flag tracks whether that has happened or not. |
|
51 | + * But for this to work, we need three states to indicate: |
|
52 | + * initialization has not occurred at all |
|
53 | + * initialization has started but is not complete |
|
54 | + * initialization is complete |
|
55 | + * The reason this is needed is because the addCaps() method |
|
56 | + * normally requires the $capabilities_map to be initialized, |
|
57 | + * but is also used during the initialization process. |
|
58 | + * So: |
|
59 | + * If initialized === null, init_caps() will be called before any other methods will run. |
|
60 | + * If initialized === false, then init_caps() is in the process of running it's logic. |
|
61 | + * If initialized === true, then init_caps() has completed the initialization process. |
|
62 | + * |
|
63 | + * @var boolean|null $initialized |
|
64 | + */ |
|
65 | + private $initialized; |
|
66 | + |
|
67 | + /** |
|
68 | + * @var boolean $reset |
|
69 | + */ |
|
70 | + private $reset = false; |
|
71 | + |
|
72 | + |
|
73 | + /** |
|
74 | + * singleton method used to instantiate class object |
|
75 | + * |
|
76 | + * @since 4.5.0 |
|
77 | + * |
|
78 | + * @return EE_Capabilities |
|
79 | + */ |
|
80 | + public static function instance() |
|
81 | + { |
|
82 | + // check if instantiated, and if not do so. |
|
83 | + if (! self::$_instance instanceof EE_Capabilities) { |
|
84 | + self::$_instance = new self(); |
|
85 | + } |
|
86 | + return self::$_instance; |
|
87 | + } |
|
88 | + |
|
89 | + |
|
90 | + /** |
|
91 | + * private constructor |
|
92 | + * |
|
93 | + * @since 4.5.0 |
|
94 | + */ |
|
95 | + private function __construct() |
|
96 | + { |
|
97 | + } |
|
98 | + |
|
99 | + |
|
100 | + /** |
|
101 | + * This delays the initialization of the capabilities class until EE_System core is loaded and ready. |
|
102 | + * |
|
103 | + * @param bool $reset allows for resetting the default capabilities saved on roles. Note that this doesn't |
|
104 | + * actually REMOVE any capabilities from existing roles, it just resaves defaults roles and |
|
105 | + * ensures that they are up to date. |
|
106 | + * |
|
107 | + * @since 4.5.0 |
|
108 | + * @return bool |
|
109 | + * @throws EE_Error |
|
110 | + */ |
|
111 | + public function init_caps($reset = false) |
|
112 | + { |
|
113 | + if (! EE_Maintenance_Mode::instance()->models_can_query()) { |
|
114 | + return false; |
|
115 | + } |
|
116 | + $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN); |
|
117 | + // if reset, then completely delete the cache option and clear the $capabilities_map property. |
|
118 | + if ($this->reset) { |
|
119 | + $this->initialized = null; |
|
120 | + $this->capabilities_map = array(); |
|
121 | + delete_option(self::option_name); |
|
122 | + } |
|
123 | + if ($this->initialized === null) { |
|
124 | + $this->initialized = false; |
|
125 | + do_action( |
|
126 | + 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
127 | + $this->reset |
|
128 | + ); |
|
129 | + $this->addCaps($this->_init_caps_map()); |
|
130 | + $this->_set_meta_caps(); |
|
131 | + do_action( |
|
132 | + 'AHEE__EE_Capabilities__init_caps__after_initialization', |
|
133 | + $this->capabilities_map |
|
134 | + ); |
|
135 | + $this->initialized = true; |
|
136 | + } |
|
137 | + // reset $this->reset so that it's not stuck on true if init_caps() gets called again |
|
138 | + $this->reset = false; |
|
139 | + return true; |
|
140 | + } |
|
141 | + |
|
142 | + |
|
143 | + /** |
|
144 | + * This sets the meta caps property. |
|
145 | + * |
|
146 | + * @since 4.5.0 |
|
147 | + * @return void |
|
148 | + * @throws EE_Error |
|
149 | + */ |
|
150 | + private function _set_meta_caps() |
|
151 | + { |
|
152 | + // get default meta caps and filter the returned array |
|
153 | + $this->_meta_caps = apply_filters( |
|
154 | + 'FHEE__EE_Capabilities___set_meta_caps__meta_caps', |
|
155 | + $this->_get_default_meta_caps_array() |
|
156 | + ); |
|
157 | + // add filter for map_meta_caps but only if models can query. |
|
158 | + if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) { |
|
159 | + add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4); |
|
160 | + } |
|
161 | + } |
|
162 | + |
|
163 | + |
|
164 | + /** |
|
165 | + * This builds and returns the default meta_caps array only once. |
|
166 | + * |
|
167 | + * @since 4.8.28.rc.012 |
|
168 | + * @return array |
|
169 | + * @throws EE_Error |
|
170 | + */ |
|
171 | + private function _get_default_meta_caps_array() |
|
172 | + { |
|
173 | + static $default_meta_caps = array(); |
|
174 | + // make sure we're only ever initializing the default _meta_caps array once if it's empty. |
|
175 | + if (empty($default_meta_caps)) { |
|
176 | + $default_meta_caps = array( |
|
177 | + // edits |
|
178 | + new EE_Meta_Capability_Map_Edit( |
|
179 | + 'ee_edit_event', |
|
180 | + array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events') |
|
181 | + ), |
|
182 | + new EE_Meta_Capability_Map_Edit( |
|
183 | + 'ee_edit_venue', |
|
184 | + array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues') |
|
185 | + ), |
|
186 | + new EE_Meta_Capability_Map_Edit( |
|
187 | + 'ee_edit_registration', |
|
188 | + array('Registration', '', 'ee_edit_others_registrations', '') |
|
189 | + ), |
|
190 | + new EE_Meta_Capability_Map_Edit( |
|
191 | + 'ee_edit_checkin', |
|
192 | + array('Registration', '', 'ee_edit_others_checkins', '') |
|
193 | + ), |
|
194 | + new EE_Meta_Capability_Map_Messages_Cap( |
|
195 | + 'ee_edit_message', |
|
196 | + array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages') |
|
197 | + ), |
|
198 | + new EE_Meta_Capability_Map_Edit( |
|
199 | + 'ee_edit_default_ticket', |
|
200 | + array('Ticket', '', 'ee_edit_others_default_tickets', '') |
|
201 | + ), |
|
202 | + new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
203 | + 'ee_edit_question', |
|
204 | + array('Question', '', '', 'ee_edit_system_questions') |
|
205 | + ), |
|
206 | + new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
207 | + 'ee_edit_question_group', |
|
208 | + array('Question_Group', '', '', 'ee_edit_system_question_groups') |
|
209 | + ), |
|
210 | + new EE_Meta_Capability_Map_Edit( |
|
211 | + 'ee_edit_payment_method', |
|
212 | + array('Payment_Method', '', 'ee_edit_others_payment_methods', '') |
|
213 | + ), |
|
214 | + // reads |
|
215 | + new EE_Meta_Capability_Map_Read( |
|
216 | + 'ee_read_event', |
|
217 | + array('Event', '', 'ee_read_others_events', 'ee_read_private_events') |
|
218 | + ), |
|
219 | + new EE_Meta_Capability_Map_Read( |
|
220 | + 'ee_read_venue', |
|
221 | + array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues') |
|
222 | + ), |
|
223 | + new EE_Meta_Capability_Map_Read( |
|
224 | + 'ee_read_registration', |
|
225 | + array('Registration', '', 'ee_read_others_registrations', '') |
|
226 | + ), |
|
227 | + new EE_Meta_Capability_Map_Read( |
|
228 | + 'ee_read_checkin', |
|
229 | + array('Registration', '', 'ee_read_others_checkins', '') |
|
230 | + ), |
|
231 | + new EE_Meta_Capability_Map_Messages_Cap( |
|
232 | + 'ee_read_message', |
|
233 | + array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages') |
|
234 | + ), |
|
235 | + new EE_Meta_Capability_Map_Read( |
|
236 | + 'ee_read_default_ticket', |
|
237 | + array('Ticket', '', 'ee_read_others_default_tickets', '') |
|
238 | + ), |
|
239 | + new EE_Meta_Capability_Map_Read( |
|
240 | + 'ee_read_payment_method', |
|
241 | + array('Payment_Method', '', 'ee_read_others_payment_methods', '') |
|
242 | + ), |
|
243 | + // deletes |
|
244 | + new EE_Meta_Capability_Map_Delete( |
|
245 | + 'ee_delete_event', |
|
246 | + array( |
|
247 | + 'Event', |
|
248 | + 'ee_delete_published_events', |
|
249 | + 'ee_delete_others_events', |
|
250 | + 'ee_delete_private_events', |
|
251 | + ) |
|
252 | + ), |
|
253 | + new EE_Meta_Capability_Map_Delete( |
|
254 | + 'ee_delete_venue', |
|
255 | + array( |
|
256 | + 'Venue', |
|
257 | + 'ee_delete_published_venues', |
|
258 | + 'ee_delete_others_venues', |
|
259 | + 'ee_delete_private_venues', |
|
260 | + ) |
|
261 | + ), |
|
262 | + new EE_Meta_Capability_Map_Delete( |
|
263 | + 'ee_delete_registration', |
|
264 | + array('Registration', '', 'ee_delete_others_registrations', '') |
|
265 | + ), |
|
266 | + new EE_Meta_Capability_Map_Delete( |
|
267 | + 'ee_delete_checkin', |
|
268 | + array('Registration', '', 'ee_delete_others_checkins', '') |
|
269 | + ), |
|
270 | + new EE_Meta_Capability_Map_Messages_Cap( |
|
271 | + 'ee_delete_message', |
|
272 | + array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages') |
|
273 | + ), |
|
274 | + new EE_Meta_Capability_Map_Delete( |
|
275 | + 'ee_delete_default_ticket', |
|
276 | + array('Ticket', '', 'ee_delete_others_default_tickets', '') |
|
277 | + ), |
|
278 | + new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
279 | + 'ee_delete_question', |
|
280 | + array('Question', '', '', 'delete_system_questions') |
|
281 | + ), |
|
282 | + new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
283 | + 'ee_delete_question_group', |
|
284 | + array('Question_Group', '', '', 'delete_system_question_groups') |
|
285 | + ), |
|
286 | + new EE_Meta_Capability_Map_Delete( |
|
287 | + 'ee_delete_payment_method', |
|
288 | + array('Payment_Method', '', 'ee_delete_others_payment_methods', '') |
|
289 | + ), |
|
290 | + ); |
|
291 | + } |
|
292 | + return $default_meta_caps; |
|
293 | + } |
|
294 | + |
|
295 | + |
|
296 | + /** |
|
297 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
298 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
299 | + * |
|
300 | + * The actual logic is carried out by implementer classes in their definition of _map_meta_caps. |
|
301 | + * |
|
302 | + * @since 4.5.0 |
|
303 | + * @see wp-includes/capabilities.php |
|
304 | + * |
|
305 | + * @param array $caps actual users capabilities |
|
306 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
307 | + * @param int $user_id The user id |
|
308 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
309 | + * @return array actual users capabilities |
|
310 | + * @throws EE_Error |
|
311 | + */ |
|
312 | + public function map_meta_caps($caps, $cap, $user_id, $args) |
|
313 | + { |
|
314 | + if (did_action('AHEE__EE_System__load_espresso_addons__complete')) { |
|
315 | + // loop through our _meta_caps array |
|
316 | + foreach ($this->_meta_caps as $meta_map) { |
|
317 | + if (! $meta_map instanceof EE_Meta_Capability_Map) { |
|
318 | + continue; |
|
319 | + } |
|
320 | + // don't load models if there is no object ID in the args |
|
321 | + if (! empty($args[0])) { |
|
322 | + $meta_map->ensure_is_model(); |
|
323 | + } |
|
324 | + $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args); |
|
325 | + } |
|
326 | + } |
|
327 | + return $caps; |
|
328 | + } |
|
329 | + |
|
330 | + |
|
331 | + /** |
|
332 | + * This sets up and returns the initial capabilities map for Event Espresso |
|
333 | + * Note this array is filtered. |
|
334 | + * It is assumed that all available EE capabilities are assigned to the administrator role. |
|
335 | + * |
|
336 | + * @since 4.5.0 |
|
337 | + * |
|
338 | + * @return array |
|
339 | + */ |
|
340 | + private function _init_caps_map() |
|
341 | + { |
|
342 | + return apply_filters( |
|
343 | + 'FHEE__EE_Capabilities__init_caps_map__caps', |
|
344 | + array( |
|
345 | + 'administrator' => array( |
|
346 | + // basic access |
|
347 | + 'ee_read_ee', |
|
348 | + // gateways |
|
349 | + /** |
|
350 | + * note that with payment method capabilities, although we've implemented |
|
351 | + * capability mapping which will be used for accessing payment methods owned by |
|
352 | + * other users. This is not fully implemented yet in the payment method ui. |
|
353 | + * Currently only the "plural" caps are in active use. |
|
354 | + * (Specific payment method caps are in use as well). |
|
355 | + **/ |
|
356 | + 'ee_manage_gateways', |
|
357 | + 'ee_read_payment_methods', |
|
358 | + 'ee_read_others_payment_methods', |
|
359 | + 'ee_edit_payment_methods', |
|
360 | + 'ee_edit_others_payment_methods', |
|
361 | + 'ee_delete_payment_methods', |
|
362 | + // events |
|
363 | + 'ee_publish_events', |
|
364 | + 'ee_read_private_events', |
|
365 | + 'ee_read_others_events', |
|
366 | + 'ee_read_events', |
|
367 | + 'ee_edit_events', |
|
368 | + 'ee_edit_published_events', |
|
369 | + 'ee_edit_others_events', |
|
370 | + 'ee_edit_private_events', |
|
371 | + 'ee_delete_published_events', |
|
372 | + 'ee_delete_private_events', |
|
373 | + 'ee_delete_events', |
|
374 | + 'ee_delete_others_events', |
|
375 | + // event categories |
|
376 | + 'ee_manage_event_categories', |
|
377 | + 'ee_edit_event_category', |
|
378 | + 'ee_delete_event_category', |
|
379 | + 'ee_assign_event_category', |
|
380 | + // venues |
|
381 | + 'ee_publish_venues', |
|
382 | + 'ee_read_venues', |
|
383 | + 'ee_read_others_venues', |
|
384 | + 'ee_read_private_venues', |
|
385 | + 'ee_edit_venues', |
|
386 | + 'ee_edit_others_venues', |
|
387 | + 'ee_edit_published_venues', |
|
388 | + 'ee_edit_private_venues', |
|
389 | + 'ee_delete_venues', |
|
390 | + 'ee_delete_others_venues', |
|
391 | + 'ee_delete_private_venues', |
|
392 | + 'ee_delete_published_venues', |
|
393 | + // venue categories |
|
394 | + 'ee_manage_venue_categories', |
|
395 | + 'ee_edit_venue_category', |
|
396 | + 'ee_delete_venue_category', |
|
397 | + 'ee_assign_venue_category', |
|
398 | + // contacts |
|
399 | + 'ee_read_contacts', |
|
400 | + 'ee_edit_contacts', |
|
401 | + 'ee_delete_contacts', |
|
402 | + // registrations |
|
403 | + 'ee_read_registrations', |
|
404 | + 'ee_read_others_registrations', |
|
405 | + 'ee_edit_registrations', |
|
406 | + 'ee_edit_others_registrations', |
|
407 | + 'ee_delete_registrations', |
|
408 | + 'ee_delete_others_registrations', |
|
409 | + // checkins |
|
410 | + 'ee_read_others_checkins', |
|
411 | + 'ee_read_checkins', |
|
412 | + 'ee_edit_checkins', |
|
413 | + 'ee_edit_others_checkins', |
|
414 | + 'ee_delete_checkins', |
|
415 | + 'ee_delete_others_checkins', |
|
416 | + // transactions && payments |
|
417 | + 'ee_read_transaction', |
|
418 | + 'ee_read_transactions', |
|
419 | + 'ee_edit_payments', |
|
420 | + 'ee_delete_payments', |
|
421 | + // messages |
|
422 | + 'ee_read_messages', |
|
423 | + 'ee_read_others_messages', |
|
424 | + 'ee_read_global_messages', |
|
425 | + 'ee_edit_global_messages', |
|
426 | + 'ee_edit_messages', |
|
427 | + 'ee_edit_others_messages', |
|
428 | + 'ee_delete_messages', |
|
429 | + 'ee_delete_others_messages', |
|
430 | + 'ee_delete_global_messages', |
|
431 | + 'ee_send_message', |
|
432 | + // tickets |
|
433 | + 'ee_read_default_tickets', |
|
434 | + 'ee_read_others_default_tickets', |
|
435 | + 'ee_edit_default_tickets', |
|
436 | + 'ee_edit_others_default_tickets', |
|
437 | + 'ee_delete_default_tickets', |
|
438 | + 'ee_delete_others_default_tickets', |
|
439 | + // prices |
|
440 | + 'ee_edit_default_price', |
|
441 | + 'ee_edit_default_prices', |
|
442 | + 'ee_delete_default_price', |
|
443 | + 'ee_delete_default_prices', |
|
444 | + 'ee_edit_default_price_type', |
|
445 | + 'ee_edit_default_price_types', |
|
446 | + 'ee_delete_default_price_type', |
|
447 | + 'ee_delete_default_price_types', |
|
448 | + 'ee_read_default_prices', |
|
449 | + 'ee_read_default_price_types', |
|
450 | + // registration form |
|
451 | + 'ee_edit_questions', |
|
452 | + 'ee_edit_system_questions', |
|
453 | + 'ee_read_questions', |
|
454 | + 'ee_delete_questions', |
|
455 | + 'ee_edit_question_groups', |
|
456 | + 'ee_read_question_groups', |
|
457 | + 'ee_edit_system_question_groups', |
|
458 | + 'ee_delete_question_groups', |
|
459 | + // event_type taxonomy |
|
460 | + 'ee_assign_event_type', |
|
461 | + 'ee_manage_event_types', |
|
462 | + 'ee_edit_event_type', |
|
463 | + 'ee_delete_event_type', |
|
464 | + ), |
|
465 | + 'ee_events_administrator' => array( |
|
466 | + // core wp caps |
|
467 | + 'read', |
|
468 | + 'read_private_pages', |
|
469 | + 'read_private_posts', |
|
470 | + 'edit_users', |
|
471 | + 'edit_posts', |
|
472 | + 'edit_pages', |
|
473 | + 'edit_published_posts', |
|
474 | + 'edit_published_pages', |
|
475 | + 'edit_private_pages', |
|
476 | + 'edit_private_posts', |
|
477 | + 'edit_others_posts', |
|
478 | + 'edit_others_pages', |
|
479 | + 'publish_posts', |
|
480 | + 'publish_pages', |
|
481 | + 'delete_posts', |
|
482 | + 'delete_pages', |
|
483 | + 'delete_private_pages', |
|
484 | + 'delete_private_posts', |
|
485 | + 'delete_published_pages', |
|
486 | + 'delete_published_posts', |
|
487 | + 'delete_others_posts', |
|
488 | + 'delete_others_pages', |
|
489 | + 'manage_categories', |
|
490 | + 'manage_links', |
|
491 | + 'moderate_comments', |
|
492 | + 'unfiltered_html', |
|
493 | + 'upload_files', |
|
494 | + 'export', |
|
495 | + 'import', |
|
496 | + 'list_users', |
|
497 | + 'level_1', // required if user with this role shows up in author dropdowns |
|
498 | + // basic ee access |
|
499 | + 'ee_read_ee', |
|
500 | + // events |
|
501 | + 'ee_publish_events', |
|
502 | + 'ee_read_private_events', |
|
503 | + 'ee_read_others_events', |
|
504 | + 'ee_read_event', |
|
505 | + 'ee_read_events', |
|
506 | + 'ee_edit_event', |
|
507 | + 'ee_edit_events', |
|
508 | + 'ee_edit_published_events', |
|
509 | + 'ee_edit_others_events', |
|
510 | + 'ee_edit_private_events', |
|
511 | + 'ee_delete_published_events', |
|
512 | + 'ee_delete_private_events', |
|
513 | + 'ee_delete_event', |
|
514 | + 'ee_delete_events', |
|
515 | + 'ee_delete_others_events', |
|
516 | + // event categories |
|
517 | + 'ee_manage_event_categories', |
|
518 | + 'ee_edit_event_category', |
|
519 | + 'ee_delete_event_category', |
|
520 | + 'ee_assign_event_category', |
|
521 | + // venues |
|
522 | + 'ee_publish_venues', |
|
523 | + 'ee_read_venue', |
|
524 | + 'ee_read_venues', |
|
525 | + 'ee_read_others_venues', |
|
526 | + 'ee_read_private_venues', |
|
527 | + 'ee_edit_venue', |
|
528 | + 'ee_edit_venues', |
|
529 | + 'ee_edit_others_venues', |
|
530 | + 'ee_edit_published_venues', |
|
531 | + 'ee_edit_private_venues', |
|
532 | + 'ee_delete_venue', |
|
533 | + 'ee_delete_venues', |
|
534 | + 'ee_delete_others_venues', |
|
535 | + 'ee_delete_private_venues', |
|
536 | + 'ee_delete_published_venues', |
|
537 | + // venue categories |
|
538 | + 'ee_manage_venue_categories', |
|
539 | + 'ee_edit_venue_category', |
|
540 | + 'ee_delete_venue_category', |
|
541 | + 'ee_assign_venue_category', |
|
542 | + // contacts |
|
543 | + 'ee_read_contacts', |
|
544 | + 'ee_edit_contacts', |
|
545 | + 'ee_delete_contacts', |
|
546 | + // registrations |
|
547 | + 'ee_read_registrations', |
|
548 | + 'ee_read_others_registrations', |
|
549 | + 'ee_edit_registration', |
|
550 | + 'ee_edit_registrations', |
|
551 | + 'ee_edit_others_registrations', |
|
552 | + 'ee_delete_registration', |
|
553 | + 'ee_delete_registrations', |
|
554 | + 'ee_delete_others_registrations', |
|
555 | + // checkins |
|
556 | + 'ee_read_others_checkins', |
|
557 | + 'ee_read_checkins', |
|
558 | + 'ee_edit_checkins', |
|
559 | + 'ee_edit_others_checkins', |
|
560 | + 'ee_delete_checkins', |
|
561 | + 'ee_delete_others_checkins', |
|
562 | + // transactions && payments |
|
563 | + 'ee_read_transaction', |
|
564 | + 'ee_read_transactions', |
|
565 | + 'ee_edit_payments', |
|
566 | + 'ee_delete_payments', |
|
567 | + // messages |
|
568 | + 'ee_read_messages', |
|
569 | + 'ee_read_others_messages', |
|
570 | + 'ee_read_global_messages', |
|
571 | + 'ee_edit_global_messages', |
|
572 | + 'ee_edit_messages', |
|
573 | + 'ee_edit_others_messages', |
|
574 | + 'ee_delete_messages', |
|
575 | + 'ee_delete_others_messages', |
|
576 | + 'ee_delete_global_messages', |
|
577 | + 'ee_send_message', |
|
578 | + // tickets |
|
579 | + 'ee_read_default_tickets', |
|
580 | + 'ee_read_others_default_tickets', |
|
581 | + 'ee_edit_default_tickets', |
|
582 | + 'ee_edit_others_default_tickets', |
|
583 | + 'ee_delete_default_tickets', |
|
584 | + 'ee_delete_others_default_tickets', |
|
585 | + // prices |
|
586 | + 'ee_edit_default_price', |
|
587 | + 'ee_edit_default_prices', |
|
588 | + 'ee_delete_default_price', |
|
589 | + 'ee_delete_default_prices', |
|
590 | + 'ee_edit_default_price_type', |
|
591 | + 'ee_edit_default_price_types', |
|
592 | + 'ee_delete_default_price_type', |
|
593 | + 'ee_delete_default_price_types', |
|
594 | + 'ee_read_default_prices', |
|
595 | + 'ee_read_default_price_types', |
|
596 | + // registration form |
|
597 | + 'ee_edit_questions', |
|
598 | + 'ee_edit_system_questions', |
|
599 | + 'ee_read_questions', |
|
600 | + 'ee_delete_questions', |
|
601 | + 'ee_edit_question_groups', |
|
602 | + 'ee_read_question_groups', |
|
603 | + 'ee_edit_system_question_groups', |
|
604 | + 'ee_delete_question_groups', |
|
605 | + // event_type taxonomy |
|
606 | + 'ee_assign_event_type', |
|
607 | + 'ee_manage_event_types', |
|
608 | + 'ee_edit_event_type', |
|
609 | + 'ee_delete_event_type', |
|
610 | + ), |
|
611 | + ) |
|
612 | + ); |
|
613 | + } |
|
614 | + |
|
615 | + |
|
616 | + /** |
|
617 | + * @return bool |
|
618 | + * @throws EE_Error |
|
619 | + */ |
|
620 | + private function setupCapabilitiesMap() |
|
621 | + { |
|
622 | + // if the initialization process hasn't even started, then we need to call init_caps() |
|
623 | + if ($this->initialized === null) { |
|
624 | + return $this->init_caps(); |
|
625 | + } |
|
626 | + // unless resetting, get caps from db if we haven't already |
|
627 | + $this->capabilities_map = $this->reset || ! empty($this->capabilities_map) |
|
628 | + ? $this->capabilities_map |
|
629 | + : get_option(self::option_name, array()); |
|
630 | + return true; |
|
631 | + } |
|
632 | + |
|
633 | + |
|
634 | + /** |
|
635 | + * @param bool $update |
|
636 | + * @return bool |
|
637 | + */ |
|
638 | + private function updateCapabilitiesMap($update = true) |
|
639 | + { |
|
640 | + return $update ? update_option(self::option_name, $this->capabilities_map) : false; |
|
641 | + } |
|
642 | + |
|
643 | + |
|
644 | + /** |
|
645 | + * Adds capabilities to roles. |
|
646 | + * |
|
647 | + * @since 4.9.42 |
|
648 | + * @param array $capabilities_to_add array of capabilities to add, indexed by roles. |
|
649 | + * Note that this should ONLY be called on activation hook |
|
650 | + * otherwise the caps will be added on every request. |
|
651 | + * @return bool |
|
652 | + * @throws \EE_Error |
|
653 | + */ |
|
654 | + public function addCaps(array $capabilities_to_add) |
|
655 | + { |
|
656 | + // don't do anything if the capabilities map can not be initialized |
|
657 | + if (! $this->setupCapabilitiesMap()) { |
|
658 | + return false; |
|
659 | + } |
|
660 | + // and filter the array so others can get in on the fun during resets |
|
661 | + $capabilities_to_add = apply_filters( |
|
662 | + 'FHEE__EE_Capabilities__addCaps__capabilities_to_add', |
|
663 | + $capabilities_to_add, |
|
664 | + $this->reset, |
|
665 | + $this->capabilities_map |
|
666 | + ); |
|
667 | + $update_capabilities_map = false; |
|
668 | + // if not reset, see what caps are new for each role. if they're new, add them. |
|
669 | + foreach ($capabilities_to_add as $role => $caps_for_role) { |
|
670 | + if (is_array($caps_for_role)) { |
|
671 | + foreach ($caps_for_role as $cap) { |
|
672 | + if (! $this->capHasBeenAddedToRole($role, $cap) |
|
673 | + && $this->add_cap_to_role($role, $cap, true, false) |
|
674 | + ) { |
|
675 | + $update_capabilities_map = true; |
|
676 | + } |
|
677 | + } |
|
678 | + } |
|
679 | + } |
|
680 | + // now let's just save the cap that has been set but only if there's been a change. |
|
681 | + $updated = $this->updateCapabilitiesMap($update_capabilities_map); |
|
682 | + $this->flushWpUser($updated); |
|
683 | + do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated); |
|
684 | + return $updated; |
|
685 | + } |
|
686 | + |
|
687 | + |
|
688 | + /** |
|
689 | + * Loops through the capabilities map and removes the role caps specified by the incoming array |
|
690 | + * |
|
691 | + * @param array $caps_map map of capabilities to be removed (indexed by roles) |
|
692 | + * @return bool |
|
693 | + * @throws \EE_Error |
|
694 | + */ |
|
695 | + public function removeCaps($caps_map) |
|
696 | + { |
|
697 | + // don't do anything if the capabilities map can not be initialized |
|
698 | + if (! $this->setupCapabilitiesMap()) { |
|
699 | + return false; |
|
700 | + } |
|
701 | + $update_capabilities_map = false; |
|
702 | + foreach ($caps_map as $role => $caps_for_role) { |
|
703 | + if (is_array($caps_for_role)) { |
|
704 | + foreach ($caps_for_role as $cap) { |
|
705 | + if ($this->capHasBeenAddedToRole($role, $cap) |
|
706 | + && $this->remove_cap_from_role($role, $cap, false) |
|
707 | + ) { |
|
708 | + $update_capabilities_map = true; |
|
709 | + } |
|
710 | + } |
|
711 | + } |
|
712 | + } |
|
713 | + // maybe resave the caps |
|
714 | + $updated = $this->updateCapabilitiesMap($update_capabilities_map); |
|
715 | + $this->flushWpUser($updated); |
|
716 | + return $updated; |
|
717 | + } |
|
718 | + |
|
719 | + |
|
720 | + /** |
|
721 | + * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from |
|
722 | + * the roles on that user. |
|
723 | + * |
|
724 | + * @param bool $flush Default is to flush the WP_User object. If false, then this method effectively does nothing. |
|
725 | + */ |
|
726 | + private function flushWpUser($flush = true) |
|
727 | + { |
|
728 | + if ($flush) { |
|
729 | + $user = wp_get_current_user(); |
|
730 | + if ($user instanceof WP_User) { |
|
731 | + $user->get_role_caps(); |
|
732 | + } |
|
733 | + } |
|
734 | + } |
|
735 | + |
|
736 | + |
|
737 | + /** |
|
738 | + * This method sets a capability on a role. Note this should only be done on activation, or if you have something |
|
739 | + * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note. |
|
740 | + * this is a wrapper for $wp_role->add_cap() |
|
741 | + * |
|
742 | + * @see wp-includes/capabilities.php |
|
743 | + * @since 4.5.0 |
|
744 | + * @param string|WP_Role $role A WordPress role the capability is being added to |
|
745 | + * @param string $cap The capability being added to the role |
|
746 | + * @param bool $grant Whether to grant access to this cap on this role. |
|
747 | + * @param bool $update_capabilities_map |
|
748 | + * @return bool |
|
749 | + * @throws \EE_Error |
|
750 | + */ |
|
751 | + public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true) |
|
752 | + { |
|
753 | + // capture incoming value for $role because we may need it to create a new WP_Role |
|
754 | + $orig_role = $role; |
|
755 | + $role = $role instanceof WP_Role ? $role : get_role($role); |
|
756 | + // if the role isn't available then we create it. |
|
757 | + if (! $role instanceof WP_Role) { |
|
758 | + // if a plugin wants to create a specific role name then they should create the role before |
|
759 | + // EE_Capabilities does. Otherwise this function will create the role name from the slug: |
|
760 | + // - removes any `ee_` namespacing from the start of the slug. |
|
761 | + // - replaces `_` with ` ` (empty space). |
|
762 | + // - sentence case on the resulting string. |
|
763 | + $role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role)); |
|
764 | + $role = add_role($orig_role, $role_label); |
|
765 | + } |
|
766 | + if ($role instanceof WP_Role) { |
|
767 | + // don't do anything if the capabilities map can not be initialized |
|
768 | + if (! $this->setupCapabilitiesMap()) { |
|
769 | + return false; |
|
770 | + } |
|
771 | + if (! $this->capHasBeenAddedToRole($role->name, $cap)) { |
|
772 | + $role->add_cap($cap, $grant); |
|
773 | + $this->capabilities_map[ $role->name ][] = $cap; |
|
774 | + $this->updateCapabilitiesMap($update_capabilities_map); |
|
775 | + return true; |
|
776 | + } |
|
777 | + } |
|
778 | + return false; |
|
779 | + } |
|
780 | + |
|
781 | + |
|
782 | + /** |
|
783 | + * Functions similarly to add_cap_to_role except removes cap from given role. |
|
784 | + * Wrapper for $wp_role->remove_cap() |
|
785 | + * |
|
786 | + * @see wp-includes/capabilities.php |
|
787 | + * @since 4.5.0 |
|
788 | + * @param string|WP_Role $role A WordPress role the capability is being removed from. |
|
789 | + * @param string $cap The capability being removed |
|
790 | + * @param bool $update_capabilities_map |
|
791 | + * @return bool |
|
792 | + * @throws \EE_Error |
|
793 | + */ |
|
794 | + public function remove_cap_from_role($role, $cap, $update_capabilities_map = true) |
|
795 | + { |
|
796 | + // don't do anything if the capabilities map can not be initialized |
|
797 | + if (! $this->setupCapabilitiesMap()) { |
|
798 | + return false; |
|
799 | + } |
|
800 | + |
|
801 | + $role = $role instanceof WP_Role ? $role : get_role($role); |
|
802 | + if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) { |
|
803 | + $role->remove_cap($cap); |
|
804 | + unset($this->capabilities_map[ $role->name ][ $index ]); |
|
805 | + $this->updateCapabilitiesMap($update_capabilities_map); |
|
806 | + return true; |
|
807 | + } |
|
808 | + return false; |
|
809 | + } |
|
810 | + |
|
811 | + |
|
812 | + /** |
|
813 | + * @param string $role_name |
|
814 | + * @param string $cap |
|
815 | + * @param bool $get_index |
|
816 | + * @return bool|mixed |
|
817 | + */ |
|
818 | + private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false) |
|
819 | + { |
|
820 | + if (isset($this->capabilities_map[ $role_name ]) |
|
821 | + && ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false |
|
822 | + ) { |
|
823 | + return $get_index ? $index : true; |
|
824 | + } |
|
825 | + return false; |
|
826 | + } |
|
827 | + |
|
828 | + |
|
829 | + /** |
|
830 | + * Wrapper for the native WP current_user_can() method. |
|
831 | + * This is provided as a handy method for a couple things: |
|
832 | + * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to |
|
833 | + * write those filters wherever current_user_can is called). |
|
834 | + * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters ) |
|
835 | + * |
|
836 | + * @since 4.5.0 |
|
837 | + * |
|
838 | + * @param string $cap The cap being checked. |
|
839 | + * @param string $context The context where the current_user_can is being called from. |
|
840 | + * @param int $id Optional. Id for item where current_user_can is being called from (used in map_meta_cap() |
|
841 | + * filters. |
|
842 | + * |
|
843 | + * @return bool Whether user can or not. |
|
844 | + */ |
|
845 | + public function current_user_can($cap, $context, $id = 0) |
|
846 | + { |
|
847 | + // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
848 | + $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id); |
|
849 | + $filtered_cap = apply_filters( |
|
850 | + 'FHEE__EE_Capabilities__current_user_can__cap', |
|
851 | + $filtered_cap, |
|
852 | + $context, |
|
853 | + $cap, |
|
854 | + $id |
|
855 | + ); |
|
856 | + return ! empty($id) |
|
857 | + ? current_user_can($filtered_cap, $id) |
|
858 | + : current_user_can($filtered_cap); |
|
859 | + } |
|
860 | + |
|
861 | + |
|
862 | + /** |
|
863 | + * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class. |
|
864 | + * |
|
865 | + * @param int|WP_User $user Either the user_id or a WP_User object |
|
866 | + * @param string $cap The capability string being checked |
|
867 | + * @param string $context The context where the user_can is being called from (used in filters). |
|
868 | + * @param int $id Optional. Id for item where user_can is being called from ( used in map_meta_cap() |
|
869 | + * filters) |
|
870 | + * |
|
871 | + * @return bool Whether user can or not. |
|
872 | + */ |
|
873 | + public function user_can($user, $cap, $context, $id = 0) |
|
874 | + { |
|
875 | + // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
876 | + $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id); |
|
877 | + $filtered_cap = apply_filters( |
|
878 | + 'FHEE__EE_Capabilities__user_can__cap', |
|
879 | + $filtered_cap, |
|
880 | + $context, |
|
881 | + $cap, |
|
882 | + $user, |
|
883 | + $id |
|
884 | + ); |
|
885 | + return ! empty($id) |
|
886 | + ? user_can($user, $filtered_cap, $id) |
|
887 | + : user_can($user, $filtered_cap); |
|
888 | + } |
|
889 | + |
|
890 | + |
|
891 | + /** |
|
892 | + * Wrapper for the native WP current_user_can_for_blog() method. |
|
893 | + * This is provided as a handy method for a couple things: |
|
894 | + * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to |
|
895 | + * write those filters wherever current_user_can is called). |
|
896 | + * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters ) |
|
897 | + * |
|
898 | + * @since 4.5.0 |
|
899 | + * |
|
900 | + * @param int $blog_id The blog id that is being checked for. |
|
901 | + * @param string $cap The cap being checked. |
|
902 | + * @param string $context The context where the current_user_can is being called from. |
|
903 | + * @param int $id Optional. Id for item where current_user_can is being called from (used in map_meta_cap() |
|
904 | + * filters. |
|
905 | + * |
|
906 | + * @return bool Whether user can or not. |
|
907 | + */ |
|
908 | + public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0) |
|
909 | + { |
|
910 | + $user_can = ! empty($id) |
|
911 | + ? current_user_can_for_blog($blog_id, $cap, $id) |
|
912 | + : current_user_can($blog_id, $cap); |
|
913 | + // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
914 | + $user_can = apply_filters( |
|
915 | + 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context, |
|
916 | + $user_can, |
|
917 | + $blog_id, |
|
918 | + $cap, |
|
919 | + $id |
|
920 | + ); |
|
921 | + $user_can = apply_filters( |
|
922 | + 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can', |
|
923 | + $user_can, |
|
924 | + $context, |
|
925 | + $blog_id, |
|
926 | + $cap, |
|
927 | + $id |
|
928 | + ); |
|
929 | + return $user_can; |
|
930 | + } |
|
931 | + |
|
932 | + |
|
933 | + /** |
|
934 | + * This helper method just returns an array of registered EE capabilities. |
|
935 | + * |
|
936 | + * @since 4.5.0 |
|
937 | + * @param string $role If empty then the entire role/capability map is returned. |
|
938 | + * Otherwise just the capabilities for the given role are returned. |
|
939 | + * @return array |
|
940 | + * @throws EE_Error |
|
941 | + */ |
|
942 | + public function get_ee_capabilities($role = 'administrator') |
|
943 | + { |
|
944 | + if (! $this->initialized) { |
|
945 | + $this->init_caps(); |
|
946 | + } |
|
947 | + if (empty($role)) { |
|
948 | + return $this->capabilities_map; |
|
949 | + } |
|
950 | + return isset($this->capabilities_map[ $role ]) |
|
951 | + ? $this->capabilities_map[ $role ] |
|
952 | + : array(); |
|
953 | + } |
|
954 | + |
|
955 | + |
|
956 | + /** |
|
957 | + * @deprecated 4.9.42 |
|
958 | + * @param bool $reset If you need to reset Event Espresso's capabilities, |
|
959 | + * then please use the init_caps() method with the "$reset" parameter set to "true" |
|
960 | + * @param array $caps_map Optional. |
|
961 | + * Can be used to send a custom map of roles and capabilities for setting them up. |
|
962 | + * Note that this should ONLY be called on activation hook or some other one-time |
|
963 | + * task otherwise the caps will be added on every request. |
|
964 | + * @return void |
|
965 | + * @throws EE_Error |
|
966 | + */ |
|
967 | + public function init_role_caps($reset = false, $caps_map = array()) |
|
968 | + { |
|
969 | + // If this method is called directly and reset is set as 'true', |
|
970 | + // then display a doing it wrong notice, because we want resets to go through init_caps() |
|
971 | + // to guarantee that everything is set up correctly. |
|
972 | + // This prevents the capabilities map getting reset incorrectly by direct calls to this method. |
|
973 | + if ($reset) { |
|
974 | + EE_Error::doing_it_wrong( |
|
975 | + __METHOD__, |
|
976 | + sprintf( |
|
977 | + esc_html__( |
|
978 | + 'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".', |
|
979 | + 'event_espresso' |
|
980 | + ), |
|
981 | + '$reset', |
|
982 | + __METHOD__ . '()', |
|
983 | + 'EE_Capabilities::init_caps()', |
|
984 | + 'true' |
|
985 | + ), |
|
986 | + '4.9.42', |
|
987 | + '5.0.0' |
|
988 | + ); |
|
989 | + } |
|
990 | + $this->addCaps($caps_map); |
|
991 | + } |
|
992 | 992 | } |
993 | 993 | |
994 | 994 | |
@@ -1005,142 +1005,142 @@ discard block |
||
1005 | 1005 | abstract class EE_Meta_Capability_Map |
1006 | 1006 | { |
1007 | 1007 | |
1008 | - public $meta_cap; |
|
1009 | - |
|
1010 | - /** |
|
1011 | - * @var EEM_Base |
|
1012 | - */ |
|
1013 | - protected $_model; |
|
1014 | - |
|
1015 | - protected $_model_name; |
|
1016 | - |
|
1017 | - public $published_cap = ''; |
|
1018 | - |
|
1019 | - public $others_cap = ''; |
|
1020 | - |
|
1021 | - public $private_cap = ''; |
|
1022 | - |
|
1023 | - |
|
1024 | - /** |
|
1025 | - * constructor. |
|
1026 | - * Receives the setup arguments for the map. |
|
1027 | - * |
|
1028 | - * @since 4.5.0 |
|
1029 | - * |
|
1030 | - * @param string $meta_cap What meta capability is this mapping. |
|
1031 | - * @param array $map_values array { |
|
1032 | - * //array of values that MUST match a count of 4. It's okay to send an empty string for |
|
1033 | - * capabilities that don't get mapped to. |
|
1034 | - * |
|
1035 | - * @type $map_values [0] string A string representing the model name. Required. String's |
|
1036 | - * should always be used when Menu Maps are registered via the |
|
1037 | - * plugin API as models are not allowed to be instantiated when |
|
1038 | - * in maintenance mode 2 (migrations). |
|
1039 | - * @type $map_values [1] string represents the capability used for published. Optional. |
|
1040 | - * @type $map_values [2] string represents the capability used for "others". Optional. |
|
1041 | - * @type $map_values [3] string represents the capability used for private. Optional. |
|
1042 | - * } |
|
1043 | - * @throws EE_Error |
|
1044 | - */ |
|
1045 | - public function __construct($meta_cap, $map_values) |
|
1046 | - { |
|
1047 | - $this->meta_cap = $meta_cap; |
|
1048 | - // verify there are four args in the $map_values array; |
|
1049 | - if (count($map_values) !== 4) { |
|
1050 | - throw new EE_Error( |
|
1051 | - sprintf( |
|
1052 | - __( |
|
1053 | - 'Incoming $map_values array should have a count of four values in it. This is what was given: %s', |
|
1054 | - 'event_espresso' |
|
1055 | - ), |
|
1056 | - '<br>' . print_r($map_values, true) |
|
1057 | - ) |
|
1058 | - ); |
|
1059 | - } |
|
1060 | - // set properties |
|
1061 | - $this->_model = null; |
|
1062 | - $this->_model_name = $map_values[0]; |
|
1063 | - $this->published_cap = (string) $map_values[1]; |
|
1064 | - $this->others_cap = (string) $map_values[2]; |
|
1065 | - $this->private_cap = (string) $map_values[3]; |
|
1066 | - } |
|
1067 | - |
|
1068 | - /** |
|
1069 | - * Makes it so this object stops filtering caps |
|
1070 | - */ |
|
1071 | - public function remove_filters() |
|
1072 | - { |
|
1073 | - remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10); |
|
1074 | - } |
|
1075 | - |
|
1076 | - |
|
1077 | - /** |
|
1078 | - * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class |
|
1079 | - * |
|
1080 | - * @since 4.5.0 |
|
1081 | - * @throws EE_Error |
|
1082 | - * |
|
1083 | - * @return void |
|
1084 | - */ |
|
1085 | - public function ensure_is_model() |
|
1086 | - { |
|
1087 | - // is it already instantiated? |
|
1088 | - if ($this->_model instanceof EEM_Base) { |
|
1089 | - return; |
|
1090 | - } |
|
1091 | - // ensure model name is string |
|
1092 | - $this->_model_name = (string) $this->_model_name; |
|
1093 | - // error proof if the name has EEM in it |
|
1094 | - $this->_model_name = str_replace('EEM', '', $this->_model_name); |
|
1095 | - $this->_model = EE_Registry::instance()->load_model($this->_model_name); |
|
1096 | - if (! $this->_model instanceof EEM_Base) { |
|
1097 | - throw new EE_Error( |
|
1098 | - sprintf( |
|
1099 | - __( |
|
1100 | - 'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class. Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s', |
|
1101 | - 'event_espresso' |
|
1102 | - ), |
|
1103 | - get_class($this), |
|
1104 | - $this->_model |
|
1105 | - ) |
|
1106 | - ); |
|
1107 | - } |
|
1108 | - } |
|
1109 | - |
|
1110 | - |
|
1111 | - /** |
|
1112 | - * |
|
1113 | - * @see EE_Meta_Capability_Map::_map_meta_caps() for docs on params. |
|
1114 | - * @since 4.6.x |
|
1115 | - * |
|
1116 | - * @param $caps |
|
1117 | - * @param $cap |
|
1118 | - * @param $user_id |
|
1119 | - * @param $args |
|
1120 | - * |
|
1121 | - * @return array |
|
1122 | - */ |
|
1123 | - public function map_meta_caps($caps, $cap, $user_id, $args) |
|
1124 | - { |
|
1125 | - return $this->_map_meta_caps($caps, $cap, $user_id, $args); |
|
1126 | - } |
|
1127 | - |
|
1128 | - |
|
1129 | - /** |
|
1130 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1131 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1132 | - * |
|
1133 | - * @since 4.5.0 |
|
1134 | - * @see wp-includes/capabilities.php |
|
1135 | - * |
|
1136 | - * @param array $caps actual users capabilities |
|
1137 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
1138 | - * @param int $user_id The user id |
|
1139 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
1140 | - * |
|
1141 | - * @return array actual users capabilities |
|
1142 | - */ |
|
1143 | - abstract protected function _map_meta_caps($caps, $cap, $user_id, $args); |
|
1008 | + public $meta_cap; |
|
1009 | + |
|
1010 | + /** |
|
1011 | + * @var EEM_Base |
|
1012 | + */ |
|
1013 | + protected $_model; |
|
1014 | + |
|
1015 | + protected $_model_name; |
|
1016 | + |
|
1017 | + public $published_cap = ''; |
|
1018 | + |
|
1019 | + public $others_cap = ''; |
|
1020 | + |
|
1021 | + public $private_cap = ''; |
|
1022 | + |
|
1023 | + |
|
1024 | + /** |
|
1025 | + * constructor. |
|
1026 | + * Receives the setup arguments for the map. |
|
1027 | + * |
|
1028 | + * @since 4.5.0 |
|
1029 | + * |
|
1030 | + * @param string $meta_cap What meta capability is this mapping. |
|
1031 | + * @param array $map_values array { |
|
1032 | + * //array of values that MUST match a count of 4. It's okay to send an empty string for |
|
1033 | + * capabilities that don't get mapped to. |
|
1034 | + * |
|
1035 | + * @type $map_values [0] string A string representing the model name. Required. String's |
|
1036 | + * should always be used when Menu Maps are registered via the |
|
1037 | + * plugin API as models are not allowed to be instantiated when |
|
1038 | + * in maintenance mode 2 (migrations). |
|
1039 | + * @type $map_values [1] string represents the capability used for published. Optional. |
|
1040 | + * @type $map_values [2] string represents the capability used for "others". Optional. |
|
1041 | + * @type $map_values [3] string represents the capability used for private. Optional. |
|
1042 | + * } |
|
1043 | + * @throws EE_Error |
|
1044 | + */ |
|
1045 | + public function __construct($meta_cap, $map_values) |
|
1046 | + { |
|
1047 | + $this->meta_cap = $meta_cap; |
|
1048 | + // verify there are four args in the $map_values array; |
|
1049 | + if (count($map_values) !== 4) { |
|
1050 | + throw new EE_Error( |
|
1051 | + sprintf( |
|
1052 | + __( |
|
1053 | + 'Incoming $map_values array should have a count of four values in it. This is what was given: %s', |
|
1054 | + 'event_espresso' |
|
1055 | + ), |
|
1056 | + '<br>' . print_r($map_values, true) |
|
1057 | + ) |
|
1058 | + ); |
|
1059 | + } |
|
1060 | + // set properties |
|
1061 | + $this->_model = null; |
|
1062 | + $this->_model_name = $map_values[0]; |
|
1063 | + $this->published_cap = (string) $map_values[1]; |
|
1064 | + $this->others_cap = (string) $map_values[2]; |
|
1065 | + $this->private_cap = (string) $map_values[3]; |
|
1066 | + } |
|
1067 | + |
|
1068 | + /** |
|
1069 | + * Makes it so this object stops filtering caps |
|
1070 | + */ |
|
1071 | + public function remove_filters() |
|
1072 | + { |
|
1073 | + remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10); |
|
1074 | + } |
|
1075 | + |
|
1076 | + |
|
1077 | + /** |
|
1078 | + * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class |
|
1079 | + * |
|
1080 | + * @since 4.5.0 |
|
1081 | + * @throws EE_Error |
|
1082 | + * |
|
1083 | + * @return void |
|
1084 | + */ |
|
1085 | + public function ensure_is_model() |
|
1086 | + { |
|
1087 | + // is it already instantiated? |
|
1088 | + if ($this->_model instanceof EEM_Base) { |
|
1089 | + return; |
|
1090 | + } |
|
1091 | + // ensure model name is string |
|
1092 | + $this->_model_name = (string) $this->_model_name; |
|
1093 | + // error proof if the name has EEM in it |
|
1094 | + $this->_model_name = str_replace('EEM', '', $this->_model_name); |
|
1095 | + $this->_model = EE_Registry::instance()->load_model($this->_model_name); |
|
1096 | + if (! $this->_model instanceof EEM_Base) { |
|
1097 | + throw new EE_Error( |
|
1098 | + sprintf( |
|
1099 | + __( |
|
1100 | + 'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class. Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s', |
|
1101 | + 'event_espresso' |
|
1102 | + ), |
|
1103 | + get_class($this), |
|
1104 | + $this->_model |
|
1105 | + ) |
|
1106 | + ); |
|
1107 | + } |
|
1108 | + } |
|
1109 | + |
|
1110 | + |
|
1111 | + /** |
|
1112 | + * |
|
1113 | + * @see EE_Meta_Capability_Map::_map_meta_caps() for docs on params. |
|
1114 | + * @since 4.6.x |
|
1115 | + * |
|
1116 | + * @param $caps |
|
1117 | + * @param $cap |
|
1118 | + * @param $user_id |
|
1119 | + * @param $args |
|
1120 | + * |
|
1121 | + * @return array |
|
1122 | + */ |
|
1123 | + public function map_meta_caps($caps, $cap, $user_id, $args) |
|
1124 | + { |
|
1125 | + return $this->_map_meta_caps($caps, $cap, $user_id, $args); |
|
1126 | + } |
|
1127 | + |
|
1128 | + |
|
1129 | + /** |
|
1130 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1131 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1132 | + * |
|
1133 | + * @since 4.5.0 |
|
1134 | + * @see wp-includes/capabilities.php |
|
1135 | + * |
|
1136 | + * @param array $caps actual users capabilities |
|
1137 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
1138 | + * @param int $user_id The user id |
|
1139 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
1140 | + * |
|
1141 | + * @return array actual users capabilities |
|
1142 | + */ |
|
1143 | + abstract protected function _map_meta_caps($caps, $cap, $user_id, $args); |
|
1144 | 1144 | } |
1145 | 1145 | |
1146 | 1146 | |
@@ -1156,81 +1156,81 @@ discard block |
||
1156 | 1156 | class EE_Meta_Capability_Map_Edit extends EE_Meta_Capability_Map |
1157 | 1157 | { |
1158 | 1158 | |
1159 | - /** |
|
1160 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1161 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1162 | - * |
|
1163 | - * @since 4.5.0 |
|
1164 | - * @see wp-includes/capabilities.php |
|
1165 | - * |
|
1166 | - * @param array $caps actual users capabilities |
|
1167 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
1168 | - * @param int $user_id The user id |
|
1169 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
1170 | - * |
|
1171 | - * @return array actual users capabilities |
|
1172 | - */ |
|
1173 | - protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
1174 | - { |
|
1175 | - // only process if we're checking our mapped_cap |
|
1176 | - if ($cap !== $this->meta_cap) { |
|
1177 | - return $caps; |
|
1178 | - } |
|
1179 | - |
|
1180 | - // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
1181 | - if (($key = array_search($cap, $caps)) !== false) { |
|
1182 | - unset($caps[ $key ]); |
|
1183 | - } |
|
1184 | - |
|
1185 | - // cast $user_id to int for later explicit comparisons |
|
1186 | - $user_id = (int) $user_id; |
|
1187 | - |
|
1188 | - /** @var EE_Base_Class $obj */ |
|
1189 | - $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
1190 | - // if no obj then let's just do cap |
|
1191 | - if (! $obj instanceof EE_Base_Class) { |
|
1192 | - $caps[] = 'do_not_allow'; |
|
1193 | - return $caps; |
|
1194 | - } |
|
1195 | - $caps[] = $cap . 's'; |
|
1196 | - if ($obj instanceof EE_CPT_Base) { |
|
1197 | - // if the item author is set and the user is the author... |
|
1198 | - if ($obj->wp_user() && $user_id === $obj->wp_user()) { |
|
1199 | - // if obj is published... |
|
1200 | - if ($obj->status() === 'publish') { |
|
1201 | - $caps[] = $this->published_cap; |
|
1202 | - } |
|
1203 | - } else { |
|
1204 | - // the user is trying to edit someone else's obj |
|
1205 | - if (! empty($this->others_cap)) { |
|
1206 | - $caps[] = $this->others_cap; |
|
1207 | - } |
|
1208 | - if (! empty($this->published_cap) && $obj->status() === 'publish') { |
|
1209 | - $caps[] = $this->published_cap; |
|
1210 | - } elseif (! empty($this->private_cap) && $obj->status() === 'private') { |
|
1211 | - $caps[] = $this->private_cap; |
|
1212 | - } |
|
1213 | - } |
|
1214 | - } else { |
|
1215 | - // not a cpt object so handled differently |
|
1216 | - $has_cap = false; |
|
1217 | - try { |
|
1218 | - $has_cap = method_exists($obj, 'wp_user') |
|
1219 | - && $obj->wp_user() |
|
1220 | - && $obj->wp_user() === $user_id; |
|
1221 | - } catch (Exception $e) { |
|
1222 | - if (WP_DEBUG) { |
|
1223 | - EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
1224 | - } |
|
1225 | - } |
|
1226 | - if (! $has_cap) { |
|
1227 | - if (! empty($this->others_cap)) { |
|
1228 | - $caps[] = $this->others_cap; |
|
1229 | - } |
|
1230 | - } |
|
1231 | - } |
|
1232 | - return $caps; |
|
1233 | - } |
|
1159 | + /** |
|
1160 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1161 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1162 | + * |
|
1163 | + * @since 4.5.0 |
|
1164 | + * @see wp-includes/capabilities.php |
|
1165 | + * |
|
1166 | + * @param array $caps actual users capabilities |
|
1167 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
1168 | + * @param int $user_id The user id |
|
1169 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
1170 | + * |
|
1171 | + * @return array actual users capabilities |
|
1172 | + */ |
|
1173 | + protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
1174 | + { |
|
1175 | + // only process if we're checking our mapped_cap |
|
1176 | + if ($cap !== $this->meta_cap) { |
|
1177 | + return $caps; |
|
1178 | + } |
|
1179 | + |
|
1180 | + // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
1181 | + if (($key = array_search($cap, $caps)) !== false) { |
|
1182 | + unset($caps[ $key ]); |
|
1183 | + } |
|
1184 | + |
|
1185 | + // cast $user_id to int for later explicit comparisons |
|
1186 | + $user_id = (int) $user_id; |
|
1187 | + |
|
1188 | + /** @var EE_Base_Class $obj */ |
|
1189 | + $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
1190 | + // if no obj then let's just do cap |
|
1191 | + if (! $obj instanceof EE_Base_Class) { |
|
1192 | + $caps[] = 'do_not_allow'; |
|
1193 | + return $caps; |
|
1194 | + } |
|
1195 | + $caps[] = $cap . 's'; |
|
1196 | + if ($obj instanceof EE_CPT_Base) { |
|
1197 | + // if the item author is set and the user is the author... |
|
1198 | + if ($obj->wp_user() && $user_id === $obj->wp_user()) { |
|
1199 | + // if obj is published... |
|
1200 | + if ($obj->status() === 'publish') { |
|
1201 | + $caps[] = $this->published_cap; |
|
1202 | + } |
|
1203 | + } else { |
|
1204 | + // the user is trying to edit someone else's obj |
|
1205 | + if (! empty($this->others_cap)) { |
|
1206 | + $caps[] = $this->others_cap; |
|
1207 | + } |
|
1208 | + if (! empty($this->published_cap) && $obj->status() === 'publish') { |
|
1209 | + $caps[] = $this->published_cap; |
|
1210 | + } elseif (! empty($this->private_cap) && $obj->status() === 'private') { |
|
1211 | + $caps[] = $this->private_cap; |
|
1212 | + } |
|
1213 | + } |
|
1214 | + } else { |
|
1215 | + // not a cpt object so handled differently |
|
1216 | + $has_cap = false; |
|
1217 | + try { |
|
1218 | + $has_cap = method_exists($obj, 'wp_user') |
|
1219 | + && $obj->wp_user() |
|
1220 | + && $obj->wp_user() === $user_id; |
|
1221 | + } catch (Exception $e) { |
|
1222 | + if (WP_DEBUG) { |
|
1223 | + EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
1224 | + } |
|
1225 | + } |
|
1226 | + if (! $has_cap) { |
|
1227 | + if (! empty($this->others_cap)) { |
|
1228 | + $caps[] = $this->others_cap; |
|
1229 | + } |
|
1230 | + } |
|
1231 | + } |
|
1232 | + return $caps; |
|
1233 | + } |
|
1234 | 1234 | } |
1235 | 1235 | |
1236 | 1236 | |
@@ -1247,24 +1247,24 @@ discard block |
||
1247 | 1247 | class EE_Meta_Capability_Map_Delete extends EE_Meta_Capability_Map_Edit |
1248 | 1248 | { |
1249 | 1249 | |
1250 | - /** |
|
1251 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1252 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1253 | - * |
|
1254 | - * @since 4.5.0 |
|
1255 | - * @see wp-includes/capabilities.php |
|
1256 | - * |
|
1257 | - * @param array $caps actual users capabilities |
|
1258 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
1259 | - * @param int $user_id The user id |
|
1260 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
1261 | - * |
|
1262 | - * @return array actual users capabilities |
|
1263 | - */ |
|
1264 | - protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
1265 | - { |
|
1266 | - return parent::_map_meta_caps($caps, $cap, $user_id, $args); |
|
1267 | - } |
|
1250 | + /** |
|
1251 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1252 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1253 | + * |
|
1254 | + * @since 4.5.0 |
|
1255 | + * @see wp-includes/capabilities.php |
|
1256 | + * |
|
1257 | + * @param array $caps actual users capabilities |
|
1258 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
1259 | + * @param int $user_id The user id |
|
1260 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
1261 | + * |
|
1262 | + * @return array actual users capabilities |
|
1263 | + */ |
|
1264 | + protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
1265 | + { |
|
1266 | + return parent::_map_meta_caps($caps, $cap, $user_id, $args); |
|
1267 | + } |
|
1268 | 1268 | } |
1269 | 1269 | |
1270 | 1270 | |
@@ -1280,85 +1280,85 @@ discard block |
||
1280 | 1280 | class EE_Meta_Capability_Map_Read extends EE_Meta_Capability_Map |
1281 | 1281 | { |
1282 | 1282 | |
1283 | - /** |
|
1284 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1285 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1286 | - * |
|
1287 | - * @since 4.5.0 |
|
1288 | - * @see wp-includes/capabilities.php |
|
1289 | - * |
|
1290 | - * @param array $caps actual users capabilities |
|
1291 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
1292 | - * @param int $user_id The user id |
|
1293 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
1294 | - * |
|
1295 | - * @return array actual users capabilities |
|
1296 | - */ |
|
1297 | - protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
1298 | - { |
|
1299 | - // only process if we're checking our mapped cap; |
|
1300 | - if ($cap !== $this->meta_cap) { |
|
1301 | - return $caps; |
|
1302 | - } |
|
1303 | - |
|
1304 | - // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
1305 | - if (($key = array_search($cap, $caps)) !== false) { |
|
1306 | - unset($caps[ $key ]); |
|
1307 | - } |
|
1308 | - |
|
1309 | - // cast $user_id to int for later explicit comparisons |
|
1310 | - $user_id = (int) $user_id; |
|
1311 | - |
|
1312 | - $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
1313 | - // if no obj then let's just do cap |
|
1314 | - if (! $obj instanceof EE_Base_Class) { |
|
1315 | - $caps[] = 'do_not_allow'; |
|
1316 | - return $caps; |
|
1317 | - } |
|
1318 | - |
|
1319 | - $caps[] = $cap . 's'; |
|
1320 | - if ($obj instanceof EE_CPT_Base) { |
|
1321 | - $status_obj = get_post_status_object($obj->status()); |
|
1322 | - if ($status_obj->public) { |
|
1323 | - return $caps; |
|
1324 | - } |
|
1325 | - // if the item author is set and the user is not the author... |
|
1326 | - if ($obj->wp_user() && $obj->wp_user() !== $user_id) { |
|
1327 | - if (! empty($this->others_cap)) { |
|
1328 | - $caps[] = $this->others_cap; |
|
1329 | - } |
|
1330 | - } |
|
1331 | - // yes this means that if users created the private post, they are able to see it regardless of private cap. |
|
1332 | - if ($status_obj->private |
|
1333 | - && ! empty($this->private_cap) |
|
1334 | - && $obj->wp_user() !== $user_id |
|
1335 | - ) { |
|
1336 | - // the user is trying to view a private object for an object they don't own. |
|
1337 | - $caps[] = $this->private_cap; |
|
1338 | - } |
|
1339 | - } else { |
|
1340 | - // not a cpt object so handled differently |
|
1341 | - $has_cap = false; |
|
1342 | - try { |
|
1343 | - $has_cap = method_exists($obj, 'wp_user') |
|
1344 | - && $obj->wp_user() |
|
1345 | - && $obj->wp_user() === $user_id; |
|
1346 | - } catch (Exception $e) { |
|
1347 | - if (WP_DEBUG) { |
|
1348 | - EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
1349 | - } |
|
1350 | - } |
|
1351 | - if (! $has_cap) { |
|
1352 | - if (! empty($this->private_cap)) { |
|
1353 | - $caps[] = $this->private_cap; |
|
1354 | - } |
|
1355 | - if (! empty($this->others_cap)) { |
|
1356 | - $caps[] = $this->others_cap; |
|
1357 | - } |
|
1358 | - } |
|
1359 | - } |
|
1360 | - return $caps; |
|
1361 | - } |
|
1283 | + /** |
|
1284 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1285 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1286 | + * |
|
1287 | + * @since 4.5.0 |
|
1288 | + * @see wp-includes/capabilities.php |
|
1289 | + * |
|
1290 | + * @param array $caps actual users capabilities |
|
1291 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
1292 | + * @param int $user_id The user id |
|
1293 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
1294 | + * |
|
1295 | + * @return array actual users capabilities |
|
1296 | + */ |
|
1297 | + protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
1298 | + { |
|
1299 | + // only process if we're checking our mapped cap; |
|
1300 | + if ($cap !== $this->meta_cap) { |
|
1301 | + return $caps; |
|
1302 | + } |
|
1303 | + |
|
1304 | + // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
1305 | + if (($key = array_search($cap, $caps)) !== false) { |
|
1306 | + unset($caps[ $key ]); |
|
1307 | + } |
|
1308 | + |
|
1309 | + // cast $user_id to int for later explicit comparisons |
|
1310 | + $user_id = (int) $user_id; |
|
1311 | + |
|
1312 | + $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
1313 | + // if no obj then let's just do cap |
|
1314 | + if (! $obj instanceof EE_Base_Class) { |
|
1315 | + $caps[] = 'do_not_allow'; |
|
1316 | + return $caps; |
|
1317 | + } |
|
1318 | + |
|
1319 | + $caps[] = $cap . 's'; |
|
1320 | + if ($obj instanceof EE_CPT_Base) { |
|
1321 | + $status_obj = get_post_status_object($obj->status()); |
|
1322 | + if ($status_obj->public) { |
|
1323 | + return $caps; |
|
1324 | + } |
|
1325 | + // if the item author is set and the user is not the author... |
|
1326 | + if ($obj->wp_user() && $obj->wp_user() !== $user_id) { |
|
1327 | + if (! empty($this->others_cap)) { |
|
1328 | + $caps[] = $this->others_cap; |
|
1329 | + } |
|
1330 | + } |
|
1331 | + // yes this means that if users created the private post, they are able to see it regardless of private cap. |
|
1332 | + if ($status_obj->private |
|
1333 | + && ! empty($this->private_cap) |
|
1334 | + && $obj->wp_user() !== $user_id |
|
1335 | + ) { |
|
1336 | + // the user is trying to view a private object for an object they don't own. |
|
1337 | + $caps[] = $this->private_cap; |
|
1338 | + } |
|
1339 | + } else { |
|
1340 | + // not a cpt object so handled differently |
|
1341 | + $has_cap = false; |
|
1342 | + try { |
|
1343 | + $has_cap = method_exists($obj, 'wp_user') |
|
1344 | + && $obj->wp_user() |
|
1345 | + && $obj->wp_user() === $user_id; |
|
1346 | + } catch (Exception $e) { |
|
1347 | + if (WP_DEBUG) { |
|
1348 | + EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
1349 | + } |
|
1350 | + } |
|
1351 | + if (! $has_cap) { |
|
1352 | + if (! empty($this->private_cap)) { |
|
1353 | + $caps[] = $this->private_cap; |
|
1354 | + } |
|
1355 | + if (! empty($this->others_cap)) { |
|
1356 | + $caps[] = $this->others_cap; |
|
1357 | + } |
|
1358 | + } |
|
1359 | + } |
|
1360 | + return $caps; |
|
1361 | + } |
|
1362 | 1362 | } |
1363 | 1363 | |
1364 | 1364 | |
@@ -1375,56 +1375,56 @@ discard block |
||
1375 | 1375 | class EE_Meta_Capability_Map_Messages_Cap extends EE_Meta_Capability_Map |
1376 | 1376 | { |
1377 | 1377 | |
1378 | - /** |
|
1379 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1380 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1381 | - * |
|
1382 | - * @since 4.5.0 |
|
1383 | - * @see wp-includes/capabilities.php |
|
1384 | - * |
|
1385 | - * @param array $caps actual users capabilities |
|
1386 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
1387 | - * @param int $user_id The user id |
|
1388 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
1389 | - * |
|
1390 | - * @return array actual users capabilities |
|
1391 | - */ |
|
1392 | - protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
1393 | - { |
|
1394 | - // only process if we're checking our mapped_cap |
|
1395 | - if ($cap !== $this->meta_cap) { |
|
1396 | - return $caps; |
|
1397 | - } |
|
1398 | - |
|
1399 | - // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
1400 | - if (($key = array_search($cap, $caps)) !== false) { |
|
1401 | - unset($caps[ $key ]); |
|
1402 | - } |
|
1403 | - |
|
1404 | - // cast $user_id to int for later explicit comparisons |
|
1405 | - $user_id = (int) $user_id; |
|
1406 | - |
|
1407 | - $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
1408 | - // if no obj then let's just do cap |
|
1409 | - if (! $obj instanceof EE_Message_Template_Group) { |
|
1410 | - $caps[] = 'do_not_allow'; |
|
1411 | - return $caps; |
|
1412 | - } |
|
1413 | - $caps[] = $cap . 's'; |
|
1414 | - $is_global = $obj->is_global(); |
|
1415 | - if ($obj->wp_user() && $obj->wp_user() === $user_id) { |
|
1416 | - if ($is_global) { |
|
1417 | - $caps[] = $this->private_cap; |
|
1418 | - } |
|
1419 | - } else { |
|
1420 | - if ($is_global) { |
|
1421 | - $caps[] = $this->private_cap; |
|
1422 | - } else { |
|
1423 | - $caps[] = $this->others_cap; |
|
1424 | - } |
|
1425 | - } |
|
1426 | - return $caps; |
|
1427 | - } |
|
1378 | + /** |
|
1379 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1380 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1381 | + * |
|
1382 | + * @since 4.5.0 |
|
1383 | + * @see wp-includes/capabilities.php |
|
1384 | + * |
|
1385 | + * @param array $caps actual users capabilities |
|
1386 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
1387 | + * @param int $user_id The user id |
|
1388 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
1389 | + * |
|
1390 | + * @return array actual users capabilities |
|
1391 | + */ |
|
1392 | + protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
1393 | + { |
|
1394 | + // only process if we're checking our mapped_cap |
|
1395 | + if ($cap !== $this->meta_cap) { |
|
1396 | + return $caps; |
|
1397 | + } |
|
1398 | + |
|
1399 | + // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
1400 | + if (($key = array_search($cap, $caps)) !== false) { |
|
1401 | + unset($caps[ $key ]); |
|
1402 | + } |
|
1403 | + |
|
1404 | + // cast $user_id to int for later explicit comparisons |
|
1405 | + $user_id = (int) $user_id; |
|
1406 | + |
|
1407 | + $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
1408 | + // if no obj then let's just do cap |
|
1409 | + if (! $obj instanceof EE_Message_Template_Group) { |
|
1410 | + $caps[] = 'do_not_allow'; |
|
1411 | + return $caps; |
|
1412 | + } |
|
1413 | + $caps[] = $cap . 's'; |
|
1414 | + $is_global = $obj->is_global(); |
|
1415 | + if ($obj->wp_user() && $obj->wp_user() === $user_id) { |
|
1416 | + if ($is_global) { |
|
1417 | + $caps[] = $this->private_cap; |
|
1418 | + } |
|
1419 | + } else { |
|
1420 | + if ($is_global) { |
|
1421 | + $caps[] = $this->private_cap; |
|
1422 | + } else { |
|
1423 | + $caps[] = $this->others_cap; |
|
1424 | + } |
|
1425 | + } |
|
1426 | + return $caps; |
|
1427 | + } |
|
1428 | 1428 | } |
1429 | 1429 | |
1430 | 1430 | |
@@ -1441,40 +1441,40 @@ discard block |
||
1441 | 1441 | class EE_Meta_Capability_Map_Registration_Form_Cap extends EE_Meta_Capability_Map |
1442 | 1442 | { |
1443 | 1443 | |
1444 | - /** |
|
1445 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1446 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1447 | - * |
|
1448 | - * @since 4.5.0 |
|
1449 | - * @see wp-includes/capabilities.php |
|
1450 | - * @param array $caps actual users capabilities |
|
1451 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
1452 | - * @param int $user_id The user id |
|
1453 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
1454 | - * @return array actual users capabilities |
|
1455 | - */ |
|
1456 | - protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
1457 | - { |
|
1458 | - // only process if we're checking our mapped_cap |
|
1459 | - if ($cap !== $this->meta_cap) { |
|
1460 | - return $caps; |
|
1461 | - } |
|
1462 | - // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
1463 | - if (($key = array_search($cap, $caps)) !== false) { |
|
1464 | - unset($caps[ $key ]); |
|
1465 | - } |
|
1466 | - $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
1467 | - // if no obj then let's just do cap |
|
1468 | - if (! $obj instanceof EE_Base_Class) { |
|
1469 | - $caps[] = 'do_not_allow'; |
|
1470 | - return $caps; |
|
1471 | - } |
|
1472 | - $caps[] = $cap . 's'; |
|
1473 | - $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false; |
|
1474 | - $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system; |
|
1475 | - if ($is_system) { |
|
1476 | - $caps[] = $this->private_cap; |
|
1477 | - } |
|
1478 | - return $caps; |
|
1479 | - } |
|
1444 | + /** |
|
1445 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
1446 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
1447 | + * |
|
1448 | + * @since 4.5.0 |
|
1449 | + * @see wp-includes/capabilities.php |
|
1450 | + * @param array $caps actual users capabilities |
|
1451 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
1452 | + * @param int $user_id The user id |
|
1453 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
1454 | + * @return array actual users capabilities |
|
1455 | + */ |
|
1456 | + protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
1457 | + { |
|
1458 | + // only process if we're checking our mapped_cap |
|
1459 | + if ($cap !== $this->meta_cap) { |
|
1460 | + return $caps; |
|
1461 | + } |
|
1462 | + // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
1463 | + if (($key = array_search($cap, $caps)) !== false) { |
|
1464 | + unset($caps[ $key ]); |
|
1465 | + } |
|
1466 | + $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
1467 | + // if no obj then let's just do cap |
|
1468 | + if (! $obj instanceof EE_Base_Class) { |
|
1469 | + $caps[] = 'do_not_allow'; |
|
1470 | + return $caps; |
|
1471 | + } |
|
1472 | + $caps[] = $cap . 's'; |
|
1473 | + $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false; |
|
1474 | + $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system; |
|
1475 | + if ($is_system) { |
|
1476 | + $caps[] = $this->private_cap; |
|
1477 | + } |
|
1478 | + return $caps; |
|
1479 | + } |
|
1480 | 1480 | } |
@@ -19,2396 +19,2396 @@ discard block |
||
19 | 19 | class Registrations_Admin_Page extends EE_Admin_Page_CPT |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * @var EE_Registration |
|
24 | - */ |
|
25 | - private $_registration; |
|
26 | - |
|
27 | - /** |
|
28 | - * @var EE_Event |
|
29 | - */ |
|
30 | - private $_reg_event; |
|
31 | - |
|
32 | - /** |
|
33 | - * @var EE_Session |
|
34 | - */ |
|
35 | - private $_session; |
|
36 | - |
|
37 | - private static $_reg_status; |
|
38 | - |
|
39 | - /** |
|
40 | - * Form for displaying the custom questions for this registration. |
|
41 | - * This gets used a few times throughout the request so its best to cache it |
|
42 | - * |
|
43 | - * @var EE_Registration_Custom_Questions_Form |
|
44 | - */ |
|
45 | - protected $_reg_custom_questions_form = null; |
|
46 | - |
|
47 | - |
|
48 | - /** |
|
49 | - * constructor |
|
50 | - * |
|
51 | - * @Constructor |
|
52 | - * @access public |
|
53 | - * @param bool $routing |
|
54 | - * @return Registrations_Admin_Page |
|
55 | - */ |
|
56 | - public function __construct($routing = true) |
|
57 | - { |
|
58 | - parent::__construct($routing); |
|
59 | - add_action('wp_loaded', array($this, 'wp_loaded')); |
|
60 | - } |
|
61 | - |
|
62 | - |
|
63 | - public function wp_loaded() |
|
64 | - { |
|
65 | - // when adding a new registration... |
|
66 | - if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') { |
|
67 | - EE_System::do_not_cache(); |
|
68 | - if (! isset($this->_req_data['processing_registration']) |
|
69 | - || absint($this->_req_data['processing_registration']) !== 1 |
|
70 | - ) { |
|
71 | - // and it's NOT the attendee information reg step |
|
72 | - // force cookie expiration by setting time to last week |
|
73 | - setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/'); |
|
74 | - // and update the global |
|
75 | - $_COOKIE['ee_registration_added'] = 0; |
|
76 | - } |
|
77 | - } |
|
78 | - } |
|
79 | - |
|
80 | - |
|
81 | - protected function _init_page_props() |
|
82 | - { |
|
83 | - $this->page_slug = REG_PG_SLUG; |
|
84 | - $this->_admin_base_url = REG_ADMIN_URL; |
|
85 | - $this->_admin_base_path = REG_ADMIN; |
|
86 | - $this->page_label = esc_html__('Registrations', 'event_espresso'); |
|
87 | - $this->_cpt_routes = array( |
|
88 | - 'add_new_attendee' => 'espresso_attendees', |
|
89 | - 'edit_attendee' => 'espresso_attendees', |
|
90 | - 'insert_attendee' => 'espresso_attendees', |
|
91 | - 'update_attendee' => 'espresso_attendees', |
|
92 | - ); |
|
93 | - $this->_cpt_model_names = array( |
|
94 | - 'add_new_attendee' => 'EEM_Attendee', |
|
95 | - 'edit_attendee' => 'EEM_Attendee', |
|
96 | - ); |
|
97 | - $this->_cpt_edit_routes = array( |
|
98 | - 'espresso_attendees' => 'edit_attendee', |
|
99 | - ); |
|
100 | - $this->_pagenow_map = array( |
|
101 | - 'add_new_attendee' => 'post-new.php', |
|
102 | - 'edit_attendee' => 'post.php', |
|
103 | - 'trash' => 'post.php', |
|
104 | - ); |
|
105 | - add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10); |
|
106 | - // add filters so that the comment urls don't take users to a confusing 404 page |
|
107 | - add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3); |
|
108 | - } |
|
109 | - |
|
110 | - |
|
111 | - public function clear_comment_link($link, $comment, $args) |
|
112 | - { |
|
113 | - // gotta make sure this only happens on this route |
|
114 | - $post_type = get_post_type($comment->comment_post_ID); |
|
115 | - if ($post_type === 'espresso_attendees') { |
|
116 | - return '#commentsdiv'; |
|
117 | - } |
|
118 | - return $link; |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - protected function _ajax_hooks() |
|
123 | - { |
|
124 | - // todo: all hooks for registrations ajax goes in here |
|
125 | - add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status')); |
|
126 | - } |
|
127 | - |
|
128 | - |
|
129 | - protected function _define_page_props() |
|
130 | - { |
|
131 | - $this->_admin_page_title = $this->page_label; |
|
132 | - $this->_labels = array( |
|
133 | - 'buttons' => array( |
|
134 | - 'add-registrant' => esc_html__('Add New Registration', 'event_espresso'), |
|
135 | - 'add-attendee' => esc_html__('Add Contact', 'event_espresso'), |
|
136 | - 'edit' => esc_html__('Edit Contact', 'event_espresso'), |
|
137 | - 'report' => esc_html__("Event Registrations CSV Report", "event_espresso"), |
|
138 | - 'report_all' => esc_html__('All Registrations CSV Report', 'event_espresso'), |
|
139 | - 'report_filtered' => esc_html__('Filtered CSV Report', 'event_espresso'), |
|
140 | - 'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'), |
|
141 | - 'contact_list_export' => esc_html__("Export Data", "event_espresso"), |
|
142 | - ), |
|
143 | - 'publishbox' => array( |
|
144 | - 'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'), |
|
145 | - 'edit_attendee' => esc_html__("Update Contact Record", 'event_espresso'), |
|
146 | - ), |
|
147 | - 'hide_add_button_on_cpt_route' => array( |
|
148 | - 'edit_attendee' => true, |
|
149 | - ), |
|
150 | - ); |
|
151 | - } |
|
152 | - |
|
153 | - |
|
154 | - /** |
|
155 | - * grab url requests and route them |
|
156 | - * |
|
157 | - * @access private |
|
158 | - * @return void |
|
159 | - */ |
|
160 | - public function _set_page_routes() |
|
161 | - { |
|
162 | - $this->_get_registration_status_array(); |
|
163 | - $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID']) |
|
164 | - ? $this->_req_data['_REG_ID'] : 0; |
|
165 | - $reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID']) |
|
166 | - ? $this->_req_data['reg_status_change_form']['REG_ID'] |
|
167 | - : $reg_id; |
|
168 | - $att_id = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID']) |
|
169 | - ? $this->_req_data['ATT_ID'] : 0; |
|
170 | - $att_id = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post']) |
|
171 | - ? $this->_req_data['post'] |
|
172 | - : $att_id; |
|
173 | - $this->_page_routes = array( |
|
174 | - 'default' => array( |
|
175 | - 'func' => '_registrations_overview_list_table', |
|
176 | - 'capability' => 'ee_read_registrations', |
|
177 | - ), |
|
178 | - 'view_registration' => array( |
|
179 | - 'func' => '_registration_details', |
|
180 | - 'capability' => 'ee_read_registration', |
|
181 | - 'obj_id' => $reg_id, |
|
182 | - ), |
|
183 | - 'edit_registration' => array( |
|
184 | - 'func' => '_update_attendee_registration_form', |
|
185 | - 'noheader' => true, |
|
186 | - 'headers_sent_route' => 'view_registration', |
|
187 | - 'capability' => 'ee_edit_registration', |
|
188 | - 'obj_id' => $reg_id, |
|
189 | - '_REG_ID' => $reg_id, |
|
190 | - ), |
|
191 | - 'trash_registrations' => array( |
|
192 | - 'func' => '_trash_or_restore_registrations', |
|
193 | - 'args' => array('trash' => true), |
|
194 | - 'noheader' => true, |
|
195 | - 'capability' => 'ee_delete_registrations', |
|
196 | - ), |
|
197 | - 'restore_registrations' => array( |
|
198 | - 'func' => '_trash_or_restore_registrations', |
|
199 | - 'args' => array('trash' => false), |
|
200 | - 'noheader' => true, |
|
201 | - 'capability' => 'ee_delete_registrations', |
|
202 | - ), |
|
203 | - 'delete_registrations' => array( |
|
204 | - 'func' => '_delete_registrations', |
|
205 | - 'noheader' => true, |
|
206 | - 'capability' => 'ee_delete_registrations', |
|
207 | - ), |
|
208 | - 'new_registration' => array( |
|
209 | - 'func' => 'new_registration', |
|
210 | - 'capability' => 'ee_edit_registrations', |
|
211 | - ), |
|
212 | - 'process_reg_step' => array( |
|
213 | - 'func' => 'process_reg_step', |
|
214 | - 'noheader' => true, |
|
215 | - 'capability' => 'ee_edit_registrations', |
|
216 | - ), |
|
217 | - 'redirect_to_txn' => array( |
|
218 | - 'func' => 'redirect_to_txn', |
|
219 | - 'noheader' => true, |
|
220 | - 'capability' => 'ee_edit_registrations', |
|
221 | - ), |
|
222 | - 'change_reg_status' => array( |
|
223 | - 'func' => '_change_reg_status', |
|
224 | - 'noheader' => true, |
|
225 | - 'capability' => 'ee_edit_registration', |
|
226 | - 'obj_id' => $reg_id, |
|
227 | - ), |
|
228 | - 'approve_registration' => array( |
|
229 | - 'func' => 'approve_registration', |
|
230 | - 'noheader' => true, |
|
231 | - 'capability' => 'ee_edit_registration', |
|
232 | - 'obj_id' => $reg_id, |
|
233 | - ), |
|
234 | - 'approve_and_notify_registration' => array( |
|
235 | - 'func' => 'approve_registration', |
|
236 | - 'noheader' => true, |
|
237 | - 'args' => array(true), |
|
238 | - 'capability' => 'ee_edit_registration', |
|
239 | - 'obj_id' => $reg_id, |
|
240 | - ), |
|
241 | - 'approve_registrations' => array( |
|
242 | - 'func' => 'bulk_action_on_registrations', |
|
243 | - 'noheader' => true, |
|
244 | - 'capability' => 'ee_edit_registrations', |
|
245 | - 'args' => array('approve'), |
|
246 | - ), |
|
247 | - 'approve_and_notify_registrations' => array( |
|
248 | - 'func' => 'bulk_action_on_registrations', |
|
249 | - 'noheader' => true, |
|
250 | - 'capability' => 'ee_edit_registrations', |
|
251 | - 'args' => array('approve', true), |
|
252 | - ), |
|
253 | - 'decline_registration' => array( |
|
254 | - 'func' => 'decline_registration', |
|
255 | - 'noheader' => true, |
|
256 | - 'capability' => 'ee_edit_registration', |
|
257 | - 'obj_id' => $reg_id, |
|
258 | - ), |
|
259 | - 'decline_and_notify_registration' => array( |
|
260 | - 'func' => 'decline_registration', |
|
261 | - 'noheader' => true, |
|
262 | - 'args' => array(true), |
|
263 | - 'capability' => 'ee_edit_registration', |
|
264 | - 'obj_id' => $reg_id, |
|
265 | - ), |
|
266 | - 'decline_registrations' => array( |
|
267 | - 'func' => 'bulk_action_on_registrations', |
|
268 | - 'noheader' => true, |
|
269 | - 'capability' => 'ee_edit_registrations', |
|
270 | - 'args' => array('decline'), |
|
271 | - ), |
|
272 | - 'decline_and_notify_registrations' => array( |
|
273 | - 'func' => 'bulk_action_on_registrations', |
|
274 | - 'noheader' => true, |
|
275 | - 'capability' => 'ee_edit_registrations', |
|
276 | - 'args' => array('decline', true), |
|
277 | - ), |
|
278 | - 'pending_registration' => array( |
|
279 | - 'func' => 'pending_registration', |
|
280 | - 'noheader' => true, |
|
281 | - 'capability' => 'ee_edit_registration', |
|
282 | - 'obj_id' => $reg_id, |
|
283 | - ), |
|
284 | - 'pending_and_notify_registration' => array( |
|
285 | - 'func' => 'pending_registration', |
|
286 | - 'noheader' => true, |
|
287 | - 'args' => array(true), |
|
288 | - 'capability' => 'ee_edit_registration', |
|
289 | - 'obj_id' => $reg_id, |
|
290 | - ), |
|
291 | - 'pending_registrations' => array( |
|
292 | - 'func' => 'bulk_action_on_registrations', |
|
293 | - 'noheader' => true, |
|
294 | - 'capability' => 'ee_edit_registrations', |
|
295 | - 'args' => array('pending'), |
|
296 | - ), |
|
297 | - 'pending_and_notify_registrations' => array( |
|
298 | - 'func' => 'bulk_action_on_registrations', |
|
299 | - 'noheader' => true, |
|
300 | - 'capability' => 'ee_edit_registrations', |
|
301 | - 'args' => array('pending', true), |
|
302 | - ), |
|
303 | - 'no_approve_registration' => array( |
|
304 | - 'func' => 'not_approve_registration', |
|
305 | - 'noheader' => true, |
|
306 | - 'capability' => 'ee_edit_registration', |
|
307 | - 'obj_id' => $reg_id, |
|
308 | - ), |
|
309 | - 'no_approve_and_notify_registration' => array( |
|
310 | - 'func' => 'not_approve_registration', |
|
311 | - 'noheader' => true, |
|
312 | - 'args' => array(true), |
|
313 | - 'capability' => 'ee_edit_registration', |
|
314 | - 'obj_id' => $reg_id, |
|
315 | - ), |
|
316 | - 'no_approve_registrations' => array( |
|
317 | - 'func' => 'bulk_action_on_registrations', |
|
318 | - 'noheader' => true, |
|
319 | - 'capability' => 'ee_edit_registrations', |
|
320 | - 'args' => array('not_approve'), |
|
321 | - ), |
|
322 | - 'no_approve_and_notify_registrations' => array( |
|
323 | - 'func' => 'bulk_action_on_registrations', |
|
324 | - 'noheader' => true, |
|
325 | - 'capability' => 'ee_edit_registrations', |
|
326 | - 'args' => array('not_approve', true), |
|
327 | - ), |
|
328 | - 'cancel_registration' => array( |
|
329 | - 'func' => 'cancel_registration', |
|
330 | - 'noheader' => true, |
|
331 | - 'capability' => 'ee_edit_registration', |
|
332 | - 'obj_id' => $reg_id, |
|
333 | - ), |
|
334 | - 'cancel_and_notify_registration' => array( |
|
335 | - 'func' => 'cancel_registration', |
|
336 | - 'noheader' => true, |
|
337 | - 'args' => array(true), |
|
338 | - 'capability' => 'ee_edit_registration', |
|
339 | - 'obj_id' => $reg_id, |
|
340 | - ), |
|
341 | - 'cancel_registrations' => array( |
|
342 | - 'func' => 'bulk_action_on_registrations', |
|
343 | - 'noheader' => true, |
|
344 | - 'capability' => 'ee_edit_registrations', |
|
345 | - 'args' => array('cancel'), |
|
346 | - ), |
|
347 | - 'cancel_and_notify_registrations' => array( |
|
348 | - 'func' => 'bulk_action_on_registrations', |
|
349 | - 'noheader' => true, |
|
350 | - 'capability' => 'ee_edit_registrations', |
|
351 | - 'args' => array('cancel', true), |
|
352 | - ), |
|
353 | - 'wait_list_registration' => array( |
|
354 | - 'func' => 'wait_list_registration', |
|
355 | - 'noheader' => true, |
|
356 | - 'capability' => 'ee_edit_registration', |
|
357 | - 'obj_id' => $reg_id, |
|
358 | - ), |
|
359 | - 'wait_list_and_notify_registration' => array( |
|
360 | - 'func' => 'wait_list_registration', |
|
361 | - 'noheader' => true, |
|
362 | - 'args' => array(true), |
|
363 | - 'capability' => 'ee_edit_registration', |
|
364 | - 'obj_id' => $reg_id, |
|
365 | - ), |
|
366 | - 'contact_list' => array( |
|
367 | - 'func' => '_attendee_contact_list_table', |
|
368 | - 'capability' => 'ee_read_contacts', |
|
369 | - ), |
|
370 | - 'add_new_attendee' => array( |
|
371 | - 'func' => '_create_new_cpt_item', |
|
372 | - 'args' => array( |
|
373 | - 'new_attendee' => true, |
|
374 | - 'capability' => 'ee_edit_contacts', |
|
375 | - ), |
|
376 | - ), |
|
377 | - 'edit_attendee' => array( |
|
378 | - 'func' => '_edit_cpt_item', |
|
379 | - 'capability' => 'ee_edit_contacts', |
|
380 | - 'obj_id' => $att_id, |
|
381 | - ), |
|
382 | - 'duplicate_attendee' => array( |
|
383 | - 'func' => '_duplicate_attendee', |
|
384 | - 'noheader' => true, |
|
385 | - 'capability' => 'ee_edit_contacts', |
|
386 | - 'obj_id' => $att_id, |
|
387 | - ), |
|
388 | - 'insert_attendee' => array( |
|
389 | - 'func' => '_insert_or_update_attendee', |
|
390 | - 'args' => array( |
|
391 | - 'new_attendee' => true, |
|
392 | - ), |
|
393 | - 'noheader' => true, |
|
394 | - 'capability' => 'ee_edit_contacts', |
|
395 | - ), |
|
396 | - 'update_attendee' => array( |
|
397 | - 'func' => '_insert_or_update_attendee', |
|
398 | - 'args' => array( |
|
399 | - 'new_attendee' => false, |
|
400 | - ), |
|
401 | - 'noheader' => true, |
|
402 | - 'capability' => 'ee_edit_contacts', |
|
403 | - 'obj_id' => $att_id, |
|
404 | - ), |
|
405 | - 'trash_attendees' => array( |
|
406 | - 'func' => '_trash_or_restore_attendees', |
|
407 | - 'args' => array( |
|
408 | - 'trash' => 'true', |
|
409 | - ), |
|
410 | - 'noheader' => true, |
|
411 | - 'capability' => 'ee_delete_contacts', |
|
412 | - ), |
|
413 | - 'trash_attendee' => array( |
|
414 | - 'func' => '_trash_or_restore_attendees', |
|
415 | - 'args' => array( |
|
416 | - 'trash' => true, |
|
417 | - ), |
|
418 | - 'noheader' => true, |
|
419 | - 'capability' => 'ee_delete_contacts', |
|
420 | - 'obj_id' => $att_id, |
|
421 | - ), |
|
422 | - 'restore_attendees' => array( |
|
423 | - 'func' => '_trash_or_restore_attendees', |
|
424 | - 'args' => array( |
|
425 | - 'trash' => false, |
|
426 | - ), |
|
427 | - 'noheader' => true, |
|
428 | - 'capability' => 'ee_delete_contacts', |
|
429 | - 'obj_id' => $att_id, |
|
430 | - ), |
|
431 | - 'resend_registration' => array( |
|
432 | - 'func' => '_resend_registration', |
|
433 | - 'noheader' => true, |
|
434 | - 'capability' => 'ee_send_message', |
|
435 | - ), |
|
436 | - 'registrations_report' => array( |
|
437 | - 'func' => '_registrations_report', |
|
438 | - 'noheader' => true, |
|
439 | - 'capability' => 'ee_read_registrations', |
|
440 | - ), |
|
441 | - 'contact_list_export' => array( |
|
442 | - 'func' => '_contact_list_export', |
|
443 | - 'noheader' => true, |
|
444 | - 'capability' => 'export', |
|
445 | - ), |
|
446 | - 'contact_list_report' => array( |
|
447 | - 'func' => '_contact_list_report', |
|
448 | - 'noheader' => true, |
|
449 | - 'capability' => 'ee_read_contacts', |
|
450 | - ), |
|
451 | - ); |
|
452 | - } |
|
453 | - |
|
454 | - |
|
455 | - protected function _set_page_config() |
|
456 | - { |
|
457 | - $this->_page_config = array( |
|
458 | - 'default' => array( |
|
459 | - 'nav' => array( |
|
460 | - 'label' => esc_html__('Overview', 'event_espresso'), |
|
461 | - 'order' => 5, |
|
462 | - ), |
|
463 | - 'help_tabs' => array( |
|
464 | - 'registrations_overview_help_tab' => array( |
|
465 | - 'title' => esc_html__('Registrations Overview', 'event_espresso'), |
|
466 | - 'filename' => 'registrations_overview', |
|
467 | - ), |
|
468 | - 'registrations_overview_table_column_headings_help_tab' => array( |
|
469 | - 'title' => esc_html__('Registrations Table Column Headings', 'event_espresso'), |
|
470 | - 'filename' => 'registrations_overview_table_column_headings', |
|
471 | - ), |
|
472 | - 'registrations_overview_filters_help_tab' => array( |
|
473 | - 'title' => esc_html__('Registration Filters', 'event_espresso'), |
|
474 | - 'filename' => 'registrations_overview_filters', |
|
475 | - ), |
|
476 | - 'registrations_overview_views_help_tab' => array( |
|
477 | - 'title' => esc_html__('Registration Views', 'event_espresso'), |
|
478 | - 'filename' => 'registrations_overview_views', |
|
479 | - ), |
|
480 | - 'registrations_regoverview_other_help_tab' => array( |
|
481 | - 'title' => esc_html__('Registrations Other', 'event_espresso'), |
|
482 | - 'filename' => 'registrations_overview_other', |
|
483 | - ), |
|
484 | - ), |
|
485 | - 'help_tour' => array('Registration_Overview_Help_Tour'), |
|
486 | - 'qtips' => array('Registration_List_Table_Tips'), |
|
487 | - 'list_table' => 'EE_Registrations_List_Table', |
|
488 | - 'require_nonce' => false, |
|
489 | - ), |
|
490 | - 'view_registration' => array( |
|
491 | - 'nav' => array( |
|
492 | - 'label' => esc_html__('REG Details', 'event_espresso'), |
|
493 | - 'order' => 15, |
|
494 | - 'url' => isset($this->_req_data['_REG_ID']) |
|
495 | - ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url) |
|
496 | - : $this->_admin_base_url, |
|
497 | - 'persistent' => false, |
|
498 | - ), |
|
499 | - 'help_tabs' => array( |
|
500 | - 'registrations_details_help_tab' => array( |
|
501 | - 'title' => esc_html__('Registration Details', 'event_espresso'), |
|
502 | - 'filename' => 'registrations_details', |
|
503 | - ), |
|
504 | - 'registrations_details_table_help_tab' => array( |
|
505 | - 'title' => esc_html__('Registration Details Table', 'event_espresso'), |
|
506 | - 'filename' => 'registrations_details_table', |
|
507 | - ), |
|
508 | - 'registrations_details_form_answers_help_tab' => array( |
|
509 | - 'title' => esc_html__('Registration Form Answers', 'event_espresso'), |
|
510 | - 'filename' => 'registrations_details_form_answers', |
|
511 | - ), |
|
512 | - 'registrations_details_registrant_details_help_tab' => array( |
|
513 | - 'title' => esc_html__('Contact Details', 'event_espresso'), |
|
514 | - 'filename' => 'registrations_details_registrant_details', |
|
515 | - ), |
|
516 | - ), |
|
517 | - 'help_tour' => array('Registration_Details_Help_Tour'), |
|
518 | - 'metaboxes' => array_merge( |
|
519 | - $this->_default_espresso_metaboxes, |
|
520 | - array('_registration_details_metaboxes') |
|
521 | - ), |
|
522 | - 'require_nonce' => false, |
|
523 | - ), |
|
524 | - 'new_registration' => array( |
|
525 | - 'nav' => array( |
|
526 | - 'label' => esc_html__('Add New Registration', 'event_espresso'), |
|
527 | - 'url' => '#', |
|
528 | - 'order' => 15, |
|
529 | - 'persistent' => false, |
|
530 | - ), |
|
531 | - 'metaboxes' => $this->_default_espresso_metaboxes, |
|
532 | - 'labels' => array( |
|
533 | - 'publishbox' => esc_html__('Save Registration', 'event_espresso'), |
|
534 | - ), |
|
535 | - 'require_nonce' => false, |
|
536 | - ), |
|
537 | - 'add_new_attendee' => array( |
|
538 | - 'nav' => array( |
|
539 | - 'label' => esc_html__('Add Contact', 'event_espresso'), |
|
540 | - 'order' => 15, |
|
541 | - 'persistent' => false, |
|
542 | - ), |
|
543 | - 'metaboxes' => array_merge( |
|
544 | - $this->_default_espresso_metaboxes, |
|
545 | - array('_publish_post_box', 'attendee_editor_metaboxes') |
|
546 | - ), |
|
547 | - 'require_nonce' => false, |
|
548 | - ), |
|
549 | - 'edit_attendee' => array( |
|
550 | - 'nav' => array( |
|
551 | - 'label' => esc_html__('Edit Contact', 'event_espresso'), |
|
552 | - 'order' => 15, |
|
553 | - 'persistent' => false, |
|
554 | - 'url' => isset($this->_req_data['ATT_ID']) |
|
555 | - ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url) |
|
556 | - : $this->_admin_base_url, |
|
557 | - ), |
|
558 | - 'metaboxes' => array('attendee_editor_metaboxes'), |
|
559 | - 'require_nonce' => false, |
|
560 | - ), |
|
561 | - 'contact_list' => array( |
|
562 | - 'nav' => array( |
|
563 | - 'label' => esc_html__('Contact List', 'event_espresso'), |
|
564 | - 'order' => 20, |
|
565 | - ), |
|
566 | - 'list_table' => 'EE_Attendee_Contact_List_Table', |
|
567 | - 'help_tabs' => array( |
|
568 | - 'registrations_contact_list_help_tab' => array( |
|
569 | - 'title' => esc_html__('Registrations Contact List', 'event_espresso'), |
|
570 | - 'filename' => 'registrations_contact_list', |
|
571 | - ), |
|
572 | - 'registrations_contact-list_table_column_headings_help_tab' => array( |
|
573 | - 'title' => esc_html__('Contact List Table Column Headings', 'event_espresso'), |
|
574 | - 'filename' => 'registrations_contact_list_table_column_headings', |
|
575 | - ), |
|
576 | - 'registrations_contact_list_views_help_tab' => array( |
|
577 | - 'title' => esc_html__('Contact List Views', 'event_espresso'), |
|
578 | - 'filename' => 'registrations_contact_list_views', |
|
579 | - ), |
|
580 | - 'registrations_contact_list_other_help_tab' => array( |
|
581 | - 'title' => esc_html__('Contact List Other', 'event_espresso'), |
|
582 | - 'filename' => 'registrations_contact_list_other', |
|
583 | - ), |
|
584 | - ), |
|
585 | - 'help_tour' => array('Contact_List_Help_Tour'), |
|
586 | - 'metaboxes' => array(), |
|
587 | - 'require_nonce' => false, |
|
588 | - ), |
|
589 | - // override default cpt routes |
|
590 | - 'create_new' => '', |
|
591 | - 'edit' => '', |
|
592 | - ); |
|
593 | - } |
|
594 | - |
|
595 | - |
|
596 | - /** |
|
597 | - * The below methods aren't used by this class currently |
|
598 | - */ |
|
599 | - protected function _add_screen_options() |
|
600 | - { |
|
601 | - } |
|
602 | - |
|
603 | - |
|
604 | - protected function _add_feature_pointers() |
|
605 | - { |
|
606 | - } |
|
607 | - |
|
608 | - |
|
609 | - public function admin_init() |
|
610 | - { |
|
611 | - EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__( |
|
612 | - 'click "Update Registration Questions" to save your changes', |
|
613 | - 'event_espresso' |
|
614 | - ); |
|
615 | - } |
|
616 | - |
|
617 | - |
|
618 | - public function admin_notices() |
|
619 | - { |
|
620 | - } |
|
621 | - |
|
622 | - |
|
623 | - public function admin_footer_scripts() |
|
624 | - { |
|
625 | - } |
|
626 | - |
|
627 | - |
|
628 | - /** |
|
629 | - * get list of registration statuses |
|
630 | - * |
|
631 | - * @access private |
|
632 | - * @return void |
|
633 | - * @throws EE_Error |
|
634 | - */ |
|
635 | - private function _get_registration_status_array() |
|
636 | - { |
|
637 | - self::$_reg_status = EEM_Registration::reg_status_array(array(), true); |
|
638 | - } |
|
639 | - |
|
640 | - |
|
641 | - protected function _add_screen_options_default() |
|
642 | - { |
|
643 | - $this->_per_page_screen_option(); |
|
644 | - } |
|
645 | - |
|
646 | - |
|
647 | - protected function _add_screen_options_contact_list() |
|
648 | - { |
|
649 | - $page_title = $this->_admin_page_title; |
|
650 | - $this->_admin_page_title = esc_html__("Contacts", 'event_espresso'); |
|
651 | - $this->_per_page_screen_option(); |
|
652 | - $this->_admin_page_title = $page_title; |
|
653 | - } |
|
654 | - |
|
655 | - |
|
656 | - public function load_scripts_styles() |
|
657 | - { |
|
658 | - // style |
|
659 | - wp_register_style( |
|
660 | - 'espresso_reg', |
|
661 | - REG_ASSETS_URL . 'espresso_registrations_admin.css', |
|
662 | - array('ee-admin-css'), |
|
663 | - EVENT_ESPRESSO_VERSION |
|
664 | - ); |
|
665 | - wp_enqueue_style('espresso_reg'); |
|
666 | - // script |
|
667 | - wp_register_script( |
|
668 | - 'espresso_reg', |
|
669 | - REG_ASSETS_URL . 'espresso_registrations_admin.js', |
|
670 | - array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'), |
|
671 | - EVENT_ESPRESSO_VERSION, |
|
672 | - true |
|
673 | - ); |
|
674 | - wp_enqueue_script('espresso_reg'); |
|
675 | - } |
|
676 | - |
|
677 | - |
|
678 | - public function load_scripts_styles_edit_attendee() |
|
679 | - { |
|
680 | - // stuff to only show up on our attendee edit details page. |
|
681 | - $attendee_details_translations = array( |
|
682 | - 'att_publish_text' => sprintf( |
|
683 | - esc_html__('Created on: <b>%1$s</b>', 'event_espresso'), |
|
684 | - $this->_cpt_model_obj->get_datetime('ATT_created') |
|
685 | - ), |
|
686 | - ); |
|
687 | - wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations); |
|
688 | - wp_enqueue_script('jquery-validate'); |
|
689 | - } |
|
690 | - |
|
691 | - |
|
692 | - public function load_scripts_styles_view_registration() |
|
693 | - { |
|
694 | - // styles |
|
695 | - wp_enqueue_style('espresso-ui-theme'); |
|
696 | - // scripts |
|
697 | - $this->_get_reg_custom_questions_form($this->_registration->ID()); |
|
698 | - $this->_reg_custom_questions_form->wp_enqueue_scripts(true); |
|
699 | - } |
|
700 | - |
|
701 | - |
|
702 | - public function load_scripts_styles_contact_list() |
|
703 | - { |
|
704 | - wp_dequeue_style('espresso_reg'); |
|
705 | - wp_register_style( |
|
706 | - 'espresso_att', |
|
707 | - REG_ASSETS_URL . 'espresso_attendees_admin.css', |
|
708 | - array('ee-admin-css'), |
|
709 | - EVENT_ESPRESSO_VERSION |
|
710 | - ); |
|
711 | - wp_enqueue_style('espresso_att'); |
|
712 | - } |
|
713 | - |
|
714 | - |
|
715 | - public function load_scripts_styles_new_registration() |
|
716 | - { |
|
717 | - wp_register_script( |
|
718 | - 'ee-spco-for-admin', |
|
719 | - REG_ASSETS_URL . 'spco_for_admin.js', |
|
720 | - array('underscore', 'jquery'), |
|
721 | - EVENT_ESPRESSO_VERSION, |
|
722 | - true |
|
723 | - ); |
|
724 | - wp_enqueue_script('ee-spco-for-admin'); |
|
725 | - add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true'); |
|
726 | - EE_Form_Section_Proper::wp_enqueue_scripts(); |
|
727 | - EED_Ticket_Selector::load_tckt_slctr_assets(); |
|
728 | - EE_Datepicker_Input::enqueue_styles_and_scripts(); |
|
729 | - } |
|
730 | - |
|
731 | - |
|
732 | - public function AHEE__EE_Admin_Page__route_admin_request_resend_registration() |
|
733 | - { |
|
734 | - add_filter('FHEE_load_EE_messages', '__return_true'); |
|
735 | - } |
|
736 | - |
|
737 | - |
|
738 | - public function AHEE__EE_Admin_Page__route_admin_request_approve_registration() |
|
739 | - { |
|
740 | - add_filter('FHEE_load_EE_messages', '__return_true'); |
|
741 | - } |
|
742 | - |
|
743 | - |
|
744 | - protected function _set_list_table_views_default() |
|
745 | - { |
|
746 | - // for notification related bulk actions we need to make sure only active messengers have an option. |
|
747 | - EED_Messages::set_autoloaders(); |
|
748 | - /** @type EE_Message_Resource_Manager $message_resource_manager */ |
|
749 | - $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
750 | - $active_mts = $message_resource_manager->list_of_active_message_types(); |
|
751 | - // key= bulk_action_slug, value= message type. |
|
752 | - $match_array = array( |
|
753 | - 'approve_registrations' => 'registration', |
|
754 | - 'decline_registrations' => 'declined_registration', |
|
755 | - 'pending_registrations' => 'pending_approval', |
|
756 | - 'no_approve_registrations' => 'not_approved_registration', |
|
757 | - 'cancel_registrations' => 'cancelled_registration', |
|
758 | - ); |
|
759 | - $can_send = EE_Registry::instance()->CAP->current_user_can( |
|
760 | - 'ee_send_message', |
|
761 | - 'batch_send_messages' |
|
762 | - ); |
|
763 | - /** setup reg status bulk actions **/ |
|
764 | - $def_reg_status_actions['approve_registrations'] = esc_html__('Approve Registrations', 'event_espresso'); |
|
765 | - if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) { |
|
766 | - $def_reg_status_actions['approve_and_notify_registrations'] = esc_html__( |
|
767 | - 'Approve and Notify Registrations', |
|
768 | - 'event_espresso' |
|
769 | - ); |
|
770 | - } |
|
771 | - $def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso'); |
|
772 | - if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) { |
|
773 | - $def_reg_status_actions['decline_and_notify_registrations'] = esc_html__( |
|
774 | - 'Decline and Notify Registrations', |
|
775 | - 'event_espresso' |
|
776 | - ); |
|
777 | - } |
|
778 | - $def_reg_status_actions['pending_registrations'] = esc_html__( |
|
779 | - 'Set Registrations to Pending Payment', |
|
780 | - 'event_espresso' |
|
781 | - ); |
|
782 | - if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) { |
|
783 | - $def_reg_status_actions['pending_and_notify_registrations'] = esc_html__( |
|
784 | - 'Set Registrations to Pending Payment and Notify', |
|
785 | - 'event_espresso' |
|
786 | - ); |
|
787 | - } |
|
788 | - $def_reg_status_actions['no_approve_registrations'] = esc_html__( |
|
789 | - 'Set Registrations to Not Approved', |
|
790 | - 'event_espresso' |
|
791 | - ); |
|
792 | - if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) { |
|
793 | - $def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__( |
|
794 | - 'Set Registrations to Not Approved and Notify', |
|
795 | - 'event_espresso' |
|
796 | - ); |
|
797 | - } |
|
798 | - $def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso'); |
|
799 | - if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) { |
|
800 | - $def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__( |
|
801 | - 'Cancel Registrations and Notify', |
|
802 | - 'event_espresso' |
|
803 | - ); |
|
804 | - } |
|
805 | - $def_reg_status_actions = apply_filters( |
|
806 | - 'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array', |
|
807 | - $def_reg_status_actions, |
|
808 | - $active_mts, |
|
809 | - $can_send |
|
810 | - ); |
|
811 | - |
|
812 | - $this->_views = array( |
|
813 | - 'all' => array( |
|
814 | - 'slug' => 'all', |
|
815 | - 'label' => esc_html__('View All Registrations', 'event_espresso'), |
|
816 | - 'count' => 0, |
|
817 | - 'bulk_action' => array_merge( |
|
818 | - $def_reg_status_actions, |
|
819 | - array( |
|
820 | - 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
821 | - ) |
|
822 | - ), |
|
823 | - ), |
|
824 | - 'month' => array( |
|
825 | - 'slug' => 'month', |
|
826 | - 'label' => esc_html__('This Month', 'event_espresso'), |
|
827 | - 'count' => 0, |
|
828 | - 'bulk_action' => array_merge( |
|
829 | - $def_reg_status_actions, |
|
830 | - array( |
|
831 | - 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
832 | - ) |
|
833 | - ), |
|
834 | - ), |
|
835 | - 'today' => array( |
|
836 | - 'slug' => 'today', |
|
837 | - 'label' => sprintf( |
|
838 | - esc_html__('Today - %s', 'event_espresso'), |
|
839 | - date('M d, Y', current_time('timestamp')) |
|
840 | - ), |
|
841 | - 'count' => 0, |
|
842 | - 'bulk_action' => array_merge( |
|
843 | - $def_reg_status_actions, |
|
844 | - array( |
|
845 | - 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
846 | - ) |
|
847 | - ), |
|
848 | - ), |
|
849 | - ); |
|
850 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
851 | - 'ee_delete_registrations', |
|
852 | - 'espresso_registrations_delete_registration' |
|
853 | - )) { |
|
854 | - $this->_views['incomplete'] = array( |
|
855 | - 'slug' => 'incomplete', |
|
856 | - 'label' => esc_html__('Incomplete', 'event_espresso'), |
|
857 | - 'count' => 0, |
|
858 | - 'bulk_action' => array( |
|
859 | - 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
860 | - ), |
|
861 | - ); |
|
862 | - $this->_views['trash'] = array( |
|
863 | - 'slug' => 'trash', |
|
864 | - 'label' => esc_html__('Trash', 'event_espresso'), |
|
865 | - 'count' => 0, |
|
866 | - 'bulk_action' => array( |
|
867 | - 'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'), |
|
868 | - 'delete_registrations' => esc_html__('Delete Registrations Permanently', 'event_espresso'), |
|
869 | - ), |
|
870 | - ); |
|
871 | - } |
|
872 | - } |
|
873 | - |
|
874 | - |
|
875 | - protected function _set_list_table_views_contact_list() |
|
876 | - { |
|
877 | - $this->_views = array( |
|
878 | - 'in_use' => array( |
|
879 | - 'slug' => 'in_use', |
|
880 | - 'label' => esc_html__('In Use', 'event_espresso'), |
|
881 | - 'count' => 0, |
|
882 | - 'bulk_action' => array( |
|
883 | - 'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'), |
|
884 | - ), |
|
885 | - ), |
|
886 | - ); |
|
887 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
888 | - 'ee_delete_contacts', |
|
889 | - 'espresso_registrations_trash_attendees' |
|
890 | - ) |
|
891 | - ) { |
|
892 | - $this->_views['trash'] = array( |
|
893 | - 'slug' => 'trash', |
|
894 | - 'label' => esc_html__('Trash', 'event_espresso'), |
|
895 | - 'count' => 0, |
|
896 | - 'bulk_action' => array( |
|
897 | - 'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'), |
|
898 | - ), |
|
899 | - ); |
|
900 | - } |
|
901 | - } |
|
902 | - |
|
903 | - |
|
904 | - protected function _registration_legend_items() |
|
905 | - { |
|
906 | - $fc_items = array( |
|
907 | - 'star-icon' => array( |
|
908 | - 'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8', |
|
909 | - 'desc' => esc_html__('This is the Primary Registrant', 'event_espresso'), |
|
910 | - ), |
|
911 | - 'view_details' => array( |
|
912 | - 'class' => 'dashicons dashicons-clipboard', |
|
913 | - 'desc' => esc_html__('View Registration Details', 'event_espresso'), |
|
914 | - ), |
|
915 | - 'edit_attendee' => array( |
|
916 | - 'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16', |
|
917 | - 'desc' => esc_html__('Edit Contact Details', 'event_espresso'), |
|
918 | - ), |
|
919 | - 'view_transaction' => array( |
|
920 | - 'class' => 'dashicons dashicons-cart', |
|
921 | - 'desc' => esc_html__('View Transaction Details', 'event_espresso'), |
|
922 | - ), |
|
923 | - 'view_invoice' => array( |
|
924 | - 'class' => 'dashicons dashicons-media-spreadsheet', |
|
925 | - 'desc' => esc_html__('View Transaction Invoice', 'event_espresso'), |
|
926 | - ), |
|
927 | - ); |
|
928 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
929 | - 'ee_send_message', |
|
930 | - 'espresso_registrations_resend_registration' |
|
931 | - )) { |
|
932 | - $fc_items['resend_registration'] = array( |
|
933 | - 'class' => 'dashicons dashicons-email-alt', |
|
934 | - 'desc' => esc_html__('Resend Registration Details', 'event_espresso'), |
|
935 | - ); |
|
936 | - } else { |
|
937 | - $fc_items['blank'] = array('class' => 'blank', 'desc' => ''); |
|
938 | - } |
|
939 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
940 | - 'ee_read_global_messages', |
|
941 | - 'view_filtered_messages' |
|
942 | - )) { |
|
943 | - $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for'); |
|
944 | - if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) { |
|
945 | - $fc_items['view_related_messages'] = array( |
|
946 | - 'class' => $related_for_icon['css_class'], |
|
947 | - 'desc' => $related_for_icon['label'], |
|
948 | - ); |
|
949 | - } |
|
950 | - } |
|
951 | - $sc_items = array( |
|
952 | - 'approved_status' => array( |
|
953 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved, |
|
954 | - 'desc' => EEH_Template::pretty_status( |
|
955 | - EEM_Registration::status_id_approved, |
|
956 | - false, |
|
957 | - 'sentence' |
|
958 | - ), |
|
959 | - ), |
|
960 | - 'pending_status' => array( |
|
961 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment, |
|
962 | - 'desc' => EEH_Template::pretty_status( |
|
963 | - EEM_Registration::status_id_pending_payment, |
|
964 | - false, |
|
965 | - 'sentence' |
|
966 | - ), |
|
967 | - ), |
|
968 | - 'wait_list' => array( |
|
969 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list, |
|
970 | - 'desc' => EEH_Template::pretty_status( |
|
971 | - EEM_Registration::status_id_wait_list, |
|
972 | - false, |
|
973 | - 'sentence' |
|
974 | - ), |
|
975 | - ), |
|
976 | - 'incomplete_status' => array( |
|
977 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete, |
|
978 | - 'desc' => EEH_Template::pretty_status( |
|
979 | - EEM_Registration::status_id_incomplete, |
|
980 | - false, |
|
981 | - 'sentence' |
|
982 | - ), |
|
983 | - ), |
|
984 | - 'not_approved' => array( |
|
985 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved, |
|
986 | - 'desc' => EEH_Template::pretty_status( |
|
987 | - EEM_Registration::status_id_not_approved, |
|
988 | - false, |
|
989 | - 'sentence' |
|
990 | - ), |
|
991 | - ), |
|
992 | - 'declined_status' => array( |
|
993 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined, |
|
994 | - 'desc' => EEH_Template::pretty_status( |
|
995 | - EEM_Registration::status_id_declined, |
|
996 | - false, |
|
997 | - 'sentence' |
|
998 | - ), |
|
999 | - ), |
|
1000 | - 'cancelled_status' => array( |
|
1001 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled, |
|
1002 | - 'desc' => EEH_Template::pretty_status( |
|
1003 | - EEM_Registration::status_id_cancelled, |
|
1004 | - false, |
|
1005 | - 'sentence' |
|
1006 | - ), |
|
1007 | - ), |
|
1008 | - ); |
|
1009 | - return array_merge($fc_items, $sc_items); |
|
1010 | - } |
|
1011 | - |
|
1012 | - |
|
1013 | - |
|
1014 | - /*************************************** REGISTRATION OVERVIEW **************************************/ |
|
1015 | - /** |
|
1016 | - * @throws \EE_Error |
|
1017 | - */ |
|
1018 | - protected function _registrations_overview_list_table() |
|
1019 | - { |
|
1020 | - $this->_template_args['admin_page_header'] = ''; |
|
1021 | - $EVT_ID = ! empty($this->_req_data['event_id']) |
|
1022 | - ? absint($this->_req_data['event_id']) |
|
1023 | - : 0; |
|
1024 | - $ATT_ID = ! empty($this->_req_data['ATT_ID']) |
|
1025 | - ? absint($this->_req_data['ATT_ID']) |
|
1026 | - : 0; |
|
1027 | - if ($ATT_ID) { |
|
1028 | - $attendee = EEM_Attendee::instance()->get_one_by_ID($ATT_ID); |
|
1029 | - if ($attendee instanceof EE_Attendee) { |
|
1030 | - $this->_template_args['admin_page_header'] = sprintf( |
|
1031 | - esc_html__( |
|
1032 | - '%1$s Viewing registrations for %2$s%3$s', |
|
1033 | - 'event_espresso' |
|
1034 | - ), |
|
1035 | - '<h3 style="line-height:1.5em;">', |
|
1036 | - '<a href="' . EE_Admin_Page::add_query_args_and_nonce( |
|
1037 | - array( |
|
1038 | - 'action' => 'edit_attendee', |
|
1039 | - 'post' => $ATT_ID, |
|
1040 | - ), |
|
1041 | - REG_ADMIN_URL |
|
1042 | - ) . '">' . $attendee->full_name() . '</a>', |
|
1043 | - '</h3>' |
|
1044 | - ); |
|
1045 | - } |
|
1046 | - } |
|
1047 | - if ($EVT_ID) { |
|
1048 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
1049 | - 'ee_edit_registrations', |
|
1050 | - 'espresso_registrations_new_registration', |
|
1051 | - $EVT_ID |
|
1052 | - )) { |
|
1053 | - $this->_admin_page_title .= ' ' . $this->get_action_link_or_button( |
|
1054 | - 'new_registration', |
|
1055 | - 'add-registrant', |
|
1056 | - array('event_id' => $EVT_ID), |
|
1057 | - 'add-new-h2' |
|
1058 | - ); |
|
1059 | - } |
|
1060 | - $event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
1061 | - if ($event instanceof EE_Event) { |
|
1062 | - $this->_template_args['admin_page_header'] = sprintf( |
|
1063 | - esc_html__( |
|
1064 | - '%s Viewing registrations for the event: %s%s', |
|
1065 | - 'event_espresso' |
|
1066 | - ), |
|
1067 | - '<h3 style="line-height:1.5em;">', |
|
1068 | - '<br /><a href="' |
|
1069 | - . EE_Admin_Page::add_query_args_and_nonce( |
|
1070 | - array( |
|
1071 | - 'action' => 'edit', |
|
1072 | - 'post' => $event->ID(), |
|
1073 | - ), |
|
1074 | - EVENTS_ADMIN_URL |
|
1075 | - ) |
|
1076 | - . '"> ' |
|
1077 | - . $event->get('EVT_name') |
|
1078 | - . ' </a> ', |
|
1079 | - '</h3>' |
|
1080 | - ); |
|
1081 | - } |
|
1082 | - $DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0; |
|
1083 | - $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID); |
|
1084 | - if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') { |
|
1085 | - $this->_template_args['admin_page_header'] = substr( |
|
1086 | - $this->_template_args['admin_page_header'], |
|
1087 | - 0, |
|
1088 | - -5 |
|
1089 | - ); |
|
1090 | - $this->_template_args['admin_page_header'] .= ' <span class="drk-grey-text">'; |
|
1091 | - $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>'; |
|
1092 | - $this->_template_args['admin_page_header'] .= $datetime->name(); |
|
1093 | - $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )'; |
|
1094 | - $this->_template_args['admin_page_header'] .= '</span></h3>'; |
|
1095 | - } |
|
1096 | - } |
|
1097 | - $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items()); |
|
1098 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
1099 | - } |
|
1100 | - |
|
1101 | - |
|
1102 | - /** |
|
1103 | - * This sets the _registration property for the registration details screen |
|
1104 | - * |
|
1105 | - * @access private |
|
1106 | - * @return bool |
|
1107 | - * @throws EE_Error |
|
1108 | - * @throws InvalidArgumentException |
|
1109 | - * @throws InvalidDataTypeException |
|
1110 | - * @throws InvalidInterfaceException |
|
1111 | - */ |
|
1112 | - private function _set_registration_object() |
|
1113 | - { |
|
1114 | - // get out if we've already set the object |
|
1115 | - if ($this->_registration instanceof EE_Registration) { |
|
1116 | - return true; |
|
1117 | - } |
|
1118 | - $REG = EEM_Registration::instance(); |
|
1119 | - $REG_ID = (! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false; |
|
1120 | - if ($this->_registration = $REG->get_one_by_ID($REG_ID)) { |
|
1121 | - return true; |
|
1122 | - } else { |
|
1123 | - $error_msg = sprintf( |
|
1124 | - esc_html__( |
|
1125 | - 'An error occurred and the details for Registration ID #%s could not be retrieved.', |
|
1126 | - 'event_espresso' |
|
1127 | - ), |
|
1128 | - $REG_ID |
|
1129 | - ); |
|
1130 | - EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
1131 | - $this->_registration = null; |
|
1132 | - return false; |
|
1133 | - } |
|
1134 | - } |
|
1135 | - |
|
1136 | - |
|
1137 | - /** |
|
1138 | - * Used to retrieve registrations for the list table. |
|
1139 | - * |
|
1140 | - * @param int $per_page |
|
1141 | - * @param bool $count |
|
1142 | - * @param bool $this_month |
|
1143 | - * @param bool $today |
|
1144 | - * @return EE_Registration[]|int |
|
1145 | - * @throws EE_Error |
|
1146 | - * @throws InvalidArgumentException |
|
1147 | - * @throws InvalidDataTypeException |
|
1148 | - * @throws InvalidInterfaceException |
|
1149 | - */ |
|
1150 | - public function get_registrations( |
|
1151 | - $per_page = 10, |
|
1152 | - $count = false, |
|
1153 | - $this_month = false, |
|
1154 | - $today = false |
|
1155 | - ) { |
|
1156 | - if ($this_month) { |
|
1157 | - $this->_req_data['status'] = 'month'; |
|
1158 | - } |
|
1159 | - if ($today) { |
|
1160 | - $this->_req_data['status'] = 'today'; |
|
1161 | - } |
|
1162 | - $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count); |
|
1163 | - /** |
|
1164 | - * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected |
|
1165 | - * |
|
1166 | - * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093 |
|
1167 | - * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
1168 | - * or if you have the development copy of EE you can view this at the path: |
|
1169 | - * /docs/G--Model-System/model-query-params.md |
|
1170 | - */ |
|
1171 | - $query_params['group_by'] = ''; |
|
1172 | - |
|
1173 | - return $count |
|
1174 | - ? EEM_Registration::instance()->count($query_params) |
|
1175 | - /** @type EE_Registration[] */ |
|
1176 | - : EEM_Registration::instance()->get_all($query_params); |
|
1177 | - } |
|
1178 | - |
|
1179 | - |
|
1180 | - /** |
|
1181 | - * Retrieves the query parameters to be used by the Registration model for getting registrations. |
|
1182 | - * Note: this listens to values on the request for some of the query parameters. |
|
1183 | - * |
|
1184 | - * @param array $request |
|
1185 | - * @param int $per_page |
|
1186 | - * @param bool $count |
|
1187 | - * @return array |
|
1188 | - * @throws EE_Error |
|
1189 | - */ |
|
1190 | - protected function _get_registration_query_parameters( |
|
1191 | - $request = array(), |
|
1192 | - $per_page = 10, |
|
1193 | - $count = false |
|
1194 | - ) { |
|
1195 | - |
|
1196 | - $query_params = array( |
|
1197 | - 0 => $this->_get_where_conditions_for_registrations_query( |
|
1198 | - $request |
|
1199 | - ), |
|
1200 | - 'caps' => EEM_Registration::caps_read_admin, |
|
1201 | - 'default_where_conditions' => 'this_model_only', |
|
1202 | - ); |
|
1203 | - if (! $count) { |
|
1204 | - $query_params = array_merge( |
|
1205 | - $query_params, |
|
1206 | - $this->_get_orderby_for_registrations_query(), |
|
1207 | - $this->_get_limit($per_page) |
|
1208 | - ); |
|
1209 | - } |
|
1210 | - |
|
1211 | - return $query_params; |
|
1212 | - } |
|
1213 | - |
|
1214 | - |
|
1215 | - /** |
|
1216 | - * This will add ATT_ID to the provided $where array for EE model query parameters. |
|
1217 | - * |
|
1218 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
1219 | - * @return array |
|
1220 | - */ |
|
1221 | - protected function addAttendeeIdToWhereConditions(array $request) |
|
1222 | - { |
|
1223 | - $where = array(); |
|
1224 | - if (! empty($request['ATT_ID'])) { |
|
1225 | - $where['ATT_ID'] = absint($request['ATT_ID']); |
|
1226 | - } |
|
1227 | - return $where; |
|
1228 | - } |
|
1229 | - |
|
1230 | - |
|
1231 | - /** |
|
1232 | - * This will add EVT_ID to the provided $where array for EE model query parameters. |
|
1233 | - * |
|
1234 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
1235 | - * @return array |
|
1236 | - */ |
|
1237 | - protected function _add_event_id_to_where_conditions(array $request) |
|
1238 | - { |
|
1239 | - $where = array(); |
|
1240 | - if (! empty($request['event_id'])) { |
|
1241 | - $where['EVT_ID'] = absint($request['event_id']); |
|
1242 | - } |
|
1243 | - return $where; |
|
1244 | - } |
|
1245 | - |
|
1246 | - |
|
1247 | - /** |
|
1248 | - * Adds category ID if it exists in the request to the where conditions for the registrations query. |
|
1249 | - * |
|
1250 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
1251 | - * @return array |
|
1252 | - */ |
|
1253 | - protected function _add_category_id_to_where_conditions(array $request) |
|
1254 | - { |
|
1255 | - $where = array(); |
|
1256 | - if (! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) { |
|
1257 | - $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']); |
|
1258 | - } |
|
1259 | - return $where; |
|
1260 | - } |
|
1261 | - |
|
1262 | - |
|
1263 | - /** |
|
1264 | - * Adds the datetime ID if it exists in the request to the where conditions for the registrations query. |
|
1265 | - * |
|
1266 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
1267 | - * @return array |
|
1268 | - */ |
|
1269 | - protected function _add_datetime_id_to_where_conditions(array $request) |
|
1270 | - { |
|
1271 | - $where = array(); |
|
1272 | - if (! empty($request['datetime_id'])) { |
|
1273 | - $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']); |
|
1274 | - } |
|
1275 | - if (! empty($request['DTT_ID'])) { |
|
1276 | - $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']); |
|
1277 | - } |
|
1278 | - return $where; |
|
1279 | - } |
|
1280 | - |
|
1281 | - |
|
1282 | - /** |
|
1283 | - * Adds the correct registration status to the where conditions for the registrations query. |
|
1284 | - * |
|
1285 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
1286 | - * @return array |
|
1287 | - */ |
|
1288 | - protected function _add_registration_status_to_where_conditions(array $request) |
|
1289 | - { |
|
1290 | - $where = array(); |
|
1291 | - $view = EEH_Array::is_set($request, 'status', ''); |
|
1292 | - $registration_status = ! empty($request['_reg_status']) |
|
1293 | - ? sanitize_text_field($request['_reg_status']) |
|
1294 | - : ''; |
|
1295 | - |
|
1296 | - /* |
|
22 | + /** |
|
23 | + * @var EE_Registration |
|
24 | + */ |
|
25 | + private $_registration; |
|
26 | + |
|
27 | + /** |
|
28 | + * @var EE_Event |
|
29 | + */ |
|
30 | + private $_reg_event; |
|
31 | + |
|
32 | + /** |
|
33 | + * @var EE_Session |
|
34 | + */ |
|
35 | + private $_session; |
|
36 | + |
|
37 | + private static $_reg_status; |
|
38 | + |
|
39 | + /** |
|
40 | + * Form for displaying the custom questions for this registration. |
|
41 | + * This gets used a few times throughout the request so its best to cache it |
|
42 | + * |
|
43 | + * @var EE_Registration_Custom_Questions_Form |
|
44 | + */ |
|
45 | + protected $_reg_custom_questions_form = null; |
|
46 | + |
|
47 | + |
|
48 | + /** |
|
49 | + * constructor |
|
50 | + * |
|
51 | + * @Constructor |
|
52 | + * @access public |
|
53 | + * @param bool $routing |
|
54 | + * @return Registrations_Admin_Page |
|
55 | + */ |
|
56 | + public function __construct($routing = true) |
|
57 | + { |
|
58 | + parent::__construct($routing); |
|
59 | + add_action('wp_loaded', array($this, 'wp_loaded')); |
|
60 | + } |
|
61 | + |
|
62 | + |
|
63 | + public function wp_loaded() |
|
64 | + { |
|
65 | + // when adding a new registration... |
|
66 | + if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') { |
|
67 | + EE_System::do_not_cache(); |
|
68 | + if (! isset($this->_req_data['processing_registration']) |
|
69 | + || absint($this->_req_data['processing_registration']) !== 1 |
|
70 | + ) { |
|
71 | + // and it's NOT the attendee information reg step |
|
72 | + // force cookie expiration by setting time to last week |
|
73 | + setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/'); |
|
74 | + // and update the global |
|
75 | + $_COOKIE['ee_registration_added'] = 0; |
|
76 | + } |
|
77 | + } |
|
78 | + } |
|
79 | + |
|
80 | + |
|
81 | + protected function _init_page_props() |
|
82 | + { |
|
83 | + $this->page_slug = REG_PG_SLUG; |
|
84 | + $this->_admin_base_url = REG_ADMIN_URL; |
|
85 | + $this->_admin_base_path = REG_ADMIN; |
|
86 | + $this->page_label = esc_html__('Registrations', 'event_espresso'); |
|
87 | + $this->_cpt_routes = array( |
|
88 | + 'add_new_attendee' => 'espresso_attendees', |
|
89 | + 'edit_attendee' => 'espresso_attendees', |
|
90 | + 'insert_attendee' => 'espresso_attendees', |
|
91 | + 'update_attendee' => 'espresso_attendees', |
|
92 | + ); |
|
93 | + $this->_cpt_model_names = array( |
|
94 | + 'add_new_attendee' => 'EEM_Attendee', |
|
95 | + 'edit_attendee' => 'EEM_Attendee', |
|
96 | + ); |
|
97 | + $this->_cpt_edit_routes = array( |
|
98 | + 'espresso_attendees' => 'edit_attendee', |
|
99 | + ); |
|
100 | + $this->_pagenow_map = array( |
|
101 | + 'add_new_attendee' => 'post-new.php', |
|
102 | + 'edit_attendee' => 'post.php', |
|
103 | + 'trash' => 'post.php', |
|
104 | + ); |
|
105 | + add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10); |
|
106 | + // add filters so that the comment urls don't take users to a confusing 404 page |
|
107 | + add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3); |
|
108 | + } |
|
109 | + |
|
110 | + |
|
111 | + public function clear_comment_link($link, $comment, $args) |
|
112 | + { |
|
113 | + // gotta make sure this only happens on this route |
|
114 | + $post_type = get_post_type($comment->comment_post_ID); |
|
115 | + if ($post_type === 'espresso_attendees') { |
|
116 | + return '#commentsdiv'; |
|
117 | + } |
|
118 | + return $link; |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + protected function _ajax_hooks() |
|
123 | + { |
|
124 | + // todo: all hooks for registrations ajax goes in here |
|
125 | + add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status')); |
|
126 | + } |
|
127 | + |
|
128 | + |
|
129 | + protected function _define_page_props() |
|
130 | + { |
|
131 | + $this->_admin_page_title = $this->page_label; |
|
132 | + $this->_labels = array( |
|
133 | + 'buttons' => array( |
|
134 | + 'add-registrant' => esc_html__('Add New Registration', 'event_espresso'), |
|
135 | + 'add-attendee' => esc_html__('Add Contact', 'event_espresso'), |
|
136 | + 'edit' => esc_html__('Edit Contact', 'event_espresso'), |
|
137 | + 'report' => esc_html__("Event Registrations CSV Report", "event_espresso"), |
|
138 | + 'report_all' => esc_html__('All Registrations CSV Report', 'event_espresso'), |
|
139 | + 'report_filtered' => esc_html__('Filtered CSV Report', 'event_espresso'), |
|
140 | + 'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'), |
|
141 | + 'contact_list_export' => esc_html__("Export Data", "event_espresso"), |
|
142 | + ), |
|
143 | + 'publishbox' => array( |
|
144 | + 'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'), |
|
145 | + 'edit_attendee' => esc_html__("Update Contact Record", 'event_espresso'), |
|
146 | + ), |
|
147 | + 'hide_add_button_on_cpt_route' => array( |
|
148 | + 'edit_attendee' => true, |
|
149 | + ), |
|
150 | + ); |
|
151 | + } |
|
152 | + |
|
153 | + |
|
154 | + /** |
|
155 | + * grab url requests and route them |
|
156 | + * |
|
157 | + * @access private |
|
158 | + * @return void |
|
159 | + */ |
|
160 | + public function _set_page_routes() |
|
161 | + { |
|
162 | + $this->_get_registration_status_array(); |
|
163 | + $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID']) |
|
164 | + ? $this->_req_data['_REG_ID'] : 0; |
|
165 | + $reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID']) |
|
166 | + ? $this->_req_data['reg_status_change_form']['REG_ID'] |
|
167 | + : $reg_id; |
|
168 | + $att_id = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID']) |
|
169 | + ? $this->_req_data['ATT_ID'] : 0; |
|
170 | + $att_id = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post']) |
|
171 | + ? $this->_req_data['post'] |
|
172 | + : $att_id; |
|
173 | + $this->_page_routes = array( |
|
174 | + 'default' => array( |
|
175 | + 'func' => '_registrations_overview_list_table', |
|
176 | + 'capability' => 'ee_read_registrations', |
|
177 | + ), |
|
178 | + 'view_registration' => array( |
|
179 | + 'func' => '_registration_details', |
|
180 | + 'capability' => 'ee_read_registration', |
|
181 | + 'obj_id' => $reg_id, |
|
182 | + ), |
|
183 | + 'edit_registration' => array( |
|
184 | + 'func' => '_update_attendee_registration_form', |
|
185 | + 'noheader' => true, |
|
186 | + 'headers_sent_route' => 'view_registration', |
|
187 | + 'capability' => 'ee_edit_registration', |
|
188 | + 'obj_id' => $reg_id, |
|
189 | + '_REG_ID' => $reg_id, |
|
190 | + ), |
|
191 | + 'trash_registrations' => array( |
|
192 | + 'func' => '_trash_or_restore_registrations', |
|
193 | + 'args' => array('trash' => true), |
|
194 | + 'noheader' => true, |
|
195 | + 'capability' => 'ee_delete_registrations', |
|
196 | + ), |
|
197 | + 'restore_registrations' => array( |
|
198 | + 'func' => '_trash_or_restore_registrations', |
|
199 | + 'args' => array('trash' => false), |
|
200 | + 'noheader' => true, |
|
201 | + 'capability' => 'ee_delete_registrations', |
|
202 | + ), |
|
203 | + 'delete_registrations' => array( |
|
204 | + 'func' => '_delete_registrations', |
|
205 | + 'noheader' => true, |
|
206 | + 'capability' => 'ee_delete_registrations', |
|
207 | + ), |
|
208 | + 'new_registration' => array( |
|
209 | + 'func' => 'new_registration', |
|
210 | + 'capability' => 'ee_edit_registrations', |
|
211 | + ), |
|
212 | + 'process_reg_step' => array( |
|
213 | + 'func' => 'process_reg_step', |
|
214 | + 'noheader' => true, |
|
215 | + 'capability' => 'ee_edit_registrations', |
|
216 | + ), |
|
217 | + 'redirect_to_txn' => array( |
|
218 | + 'func' => 'redirect_to_txn', |
|
219 | + 'noheader' => true, |
|
220 | + 'capability' => 'ee_edit_registrations', |
|
221 | + ), |
|
222 | + 'change_reg_status' => array( |
|
223 | + 'func' => '_change_reg_status', |
|
224 | + 'noheader' => true, |
|
225 | + 'capability' => 'ee_edit_registration', |
|
226 | + 'obj_id' => $reg_id, |
|
227 | + ), |
|
228 | + 'approve_registration' => array( |
|
229 | + 'func' => 'approve_registration', |
|
230 | + 'noheader' => true, |
|
231 | + 'capability' => 'ee_edit_registration', |
|
232 | + 'obj_id' => $reg_id, |
|
233 | + ), |
|
234 | + 'approve_and_notify_registration' => array( |
|
235 | + 'func' => 'approve_registration', |
|
236 | + 'noheader' => true, |
|
237 | + 'args' => array(true), |
|
238 | + 'capability' => 'ee_edit_registration', |
|
239 | + 'obj_id' => $reg_id, |
|
240 | + ), |
|
241 | + 'approve_registrations' => array( |
|
242 | + 'func' => 'bulk_action_on_registrations', |
|
243 | + 'noheader' => true, |
|
244 | + 'capability' => 'ee_edit_registrations', |
|
245 | + 'args' => array('approve'), |
|
246 | + ), |
|
247 | + 'approve_and_notify_registrations' => array( |
|
248 | + 'func' => 'bulk_action_on_registrations', |
|
249 | + 'noheader' => true, |
|
250 | + 'capability' => 'ee_edit_registrations', |
|
251 | + 'args' => array('approve', true), |
|
252 | + ), |
|
253 | + 'decline_registration' => array( |
|
254 | + 'func' => 'decline_registration', |
|
255 | + 'noheader' => true, |
|
256 | + 'capability' => 'ee_edit_registration', |
|
257 | + 'obj_id' => $reg_id, |
|
258 | + ), |
|
259 | + 'decline_and_notify_registration' => array( |
|
260 | + 'func' => 'decline_registration', |
|
261 | + 'noheader' => true, |
|
262 | + 'args' => array(true), |
|
263 | + 'capability' => 'ee_edit_registration', |
|
264 | + 'obj_id' => $reg_id, |
|
265 | + ), |
|
266 | + 'decline_registrations' => array( |
|
267 | + 'func' => 'bulk_action_on_registrations', |
|
268 | + 'noheader' => true, |
|
269 | + 'capability' => 'ee_edit_registrations', |
|
270 | + 'args' => array('decline'), |
|
271 | + ), |
|
272 | + 'decline_and_notify_registrations' => array( |
|
273 | + 'func' => 'bulk_action_on_registrations', |
|
274 | + 'noheader' => true, |
|
275 | + 'capability' => 'ee_edit_registrations', |
|
276 | + 'args' => array('decline', true), |
|
277 | + ), |
|
278 | + 'pending_registration' => array( |
|
279 | + 'func' => 'pending_registration', |
|
280 | + 'noheader' => true, |
|
281 | + 'capability' => 'ee_edit_registration', |
|
282 | + 'obj_id' => $reg_id, |
|
283 | + ), |
|
284 | + 'pending_and_notify_registration' => array( |
|
285 | + 'func' => 'pending_registration', |
|
286 | + 'noheader' => true, |
|
287 | + 'args' => array(true), |
|
288 | + 'capability' => 'ee_edit_registration', |
|
289 | + 'obj_id' => $reg_id, |
|
290 | + ), |
|
291 | + 'pending_registrations' => array( |
|
292 | + 'func' => 'bulk_action_on_registrations', |
|
293 | + 'noheader' => true, |
|
294 | + 'capability' => 'ee_edit_registrations', |
|
295 | + 'args' => array('pending'), |
|
296 | + ), |
|
297 | + 'pending_and_notify_registrations' => array( |
|
298 | + 'func' => 'bulk_action_on_registrations', |
|
299 | + 'noheader' => true, |
|
300 | + 'capability' => 'ee_edit_registrations', |
|
301 | + 'args' => array('pending', true), |
|
302 | + ), |
|
303 | + 'no_approve_registration' => array( |
|
304 | + 'func' => 'not_approve_registration', |
|
305 | + 'noheader' => true, |
|
306 | + 'capability' => 'ee_edit_registration', |
|
307 | + 'obj_id' => $reg_id, |
|
308 | + ), |
|
309 | + 'no_approve_and_notify_registration' => array( |
|
310 | + 'func' => 'not_approve_registration', |
|
311 | + 'noheader' => true, |
|
312 | + 'args' => array(true), |
|
313 | + 'capability' => 'ee_edit_registration', |
|
314 | + 'obj_id' => $reg_id, |
|
315 | + ), |
|
316 | + 'no_approve_registrations' => array( |
|
317 | + 'func' => 'bulk_action_on_registrations', |
|
318 | + 'noheader' => true, |
|
319 | + 'capability' => 'ee_edit_registrations', |
|
320 | + 'args' => array('not_approve'), |
|
321 | + ), |
|
322 | + 'no_approve_and_notify_registrations' => array( |
|
323 | + 'func' => 'bulk_action_on_registrations', |
|
324 | + 'noheader' => true, |
|
325 | + 'capability' => 'ee_edit_registrations', |
|
326 | + 'args' => array('not_approve', true), |
|
327 | + ), |
|
328 | + 'cancel_registration' => array( |
|
329 | + 'func' => 'cancel_registration', |
|
330 | + 'noheader' => true, |
|
331 | + 'capability' => 'ee_edit_registration', |
|
332 | + 'obj_id' => $reg_id, |
|
333 | + ), |
|
334 | + 'cancel_and_notify_registration' => array( |
|
335 | + 'func' => 'cancel_registration', |
|
336 | + 'noheader' => true, |
|
337 | + 'args' => array(true), |
|
338 | + 'capability' => 'ee_edit_registration', |
|
339 | + 'obj_id' => $reg_id, |
|
340 | + ), |
|
341 | + 'cancel_registrations' => array( |
|
342 | + 'func' => 'bulk_action_on_registrations', |
|
343 | + 'noheader' => true, |
|
344 | + 'capability' => 'ee_edit_registrations', |
|
345 | + 'args' => array('cancel'), |
|
346 | + ), |
|
347 | + 'cancel_and_notify_registrations' => array( |
|
348 | + 'func' => 'bulk_action_on_registrations', |
|
349 | + 'noheader' => true, |
|
350 | + 'capability' => 'ee_edit_registrations', |
|
351 | + 'args' => array('cancel', true), |
|
352 | + ), |
|
353 | + 'wait_list_registration' => array( |
|
354 | + 'func' => 'wait_list_registration', |
|
355 | + 'noheader' => true, |
|
356 | + 'capability' => 'ee_edit_registration', |
|
357 | + 'obj_id' => $reg_id, |
|
358 | + ), |
|
359 | + 'wait_list_and_notify_registration' => array( |
|
360 | + 'func' => 'wait_list_registration', |
|
361 | + 'noheader' => true, |
|
362 | + 'args' => array(true), |
|
363 | + 'capability' => 'ee_edit_registration', |
|
364 | + 'obj_id' => $reg_id, |
|
365 | + ), |
|
366 | + 'contact_list' => array( |
|
367 | + 'func' => '_attendee_contact_list_table', |
|
368 | + 'capability' => 'ee_read_contacts', |
|
369 | + ), |
|
370 | + 'add_new_attendee' => array( |
|
371 | + 'func' => '_create_new_cpt_item', |
|
372 | + 'args' => array( |
|
373 | + 'new_attendee' => true, |
|
374 | + 'capability' => 'ee_edit_contacts', |
|
375 | + ), |
|
376 | + ), |
|
377 | + 'edit_attendee' => array( |
|
378 | + 'func' => '_edit_cpt_item', |
|
379 | + 'capability' => 'ee_edit_contacts', |
|
380 | + 'obj_id' => $att_id, |
|
381 | + ), |
|
382 | + 'duplicate_attendee' => array( |
|
383 | + 'func' => '_duplicate_attendee', |
|
384 | + 'noheader' => true, |
|
385 | + 'capability' => 'ee_edit_contacts', |
|
386 | + 'obj_id' => $att_id, |
|
387 | + ), |
|
388 | + 'insert_attendee' => array( |
|
389 | + 'func' => '_insert_or_update_attendee', |
|
390 | + 'args' => array( |
|
391 | + 'new_attendee' => true, |
|
392 | + ), |
|
393 | + 'noheader' => true, |
|
394 | + 'capability' => 'ee_edit_contacts', |
|
395 | + ), |
|
396 | + 'update_attendee' => array( |
|
397 | + 'func' => '_insert_or_update_attendee', |
|
398 | + 'args' => array( |
|
399 | + 'new_attendee' => false, |
|
400 | + ), |
|
401 | + 'noheader' => true, |
|
402 | + 'capability' => 'ee_edit_contacts', |
|
403 | + 'obj_id' => $att_id, |
|
404 | + ), |
|
405 | + 'trash_attendees' => array( |
|
406 | + 'func' => '_trash_or_restore_attendees', |
|
407 | + 'args' => array( |
|
408 | + 'trash' => 'true', |
|
409 | + ), |
|
410 | + 'noheader' => true, |
|
411 | + 'capability' => 'ee_delete_contacts', |
|
412 | + ), |
|
413 | + 'trash_attendee' => array( |
|
414 | + 'func' => '_trash_or_restore_attendees', |
|
415 | + 'args' => array( |
|
416 | + 'trash' => true, |
|
417 | + ), |
|
418 | + 'noheader' => true, |
|
419 | + 'capability' => 'ee_delete_contacts', |
|
420 | + 'obj_id' => $att_id, |
|
421 | + ), |
|
422 | + 'restore_attendees' => array( |
|
423 | + 'func' => '_trash_or_restore_attendees', |
|
424 | + 'args' => array( |
|
425 | + 'trash' => false, |
|
426 | + ), |
|
427 | + 'noheader' => true, |
|
428 | + 'capability' => 'ee_delete_contacts', |
|
429 | + 'obj_id' => $att_id, |
|
430 | + ), |
|
431 | + 'resend_registration' => array( |
|
432 | + 'func' => '_resend_registration', |
|
433 | + 'noheader' => true, |
|
434 | + 'capability' => 'ee_send_message', |
|
435 | + ), |
|
436 | + 'registrations_report' => array( |
|
437 | + 'func' => '_registrations_report', |
|
438 | + 'noheader' => true, |
|
439 | + 'capability' => 'ee_read_registrations', |
|
440 | + ), |
|
441 | + 'contact_list_export' => array( |
|
442 | + 'func' => '_contact_list_export', |
|
443 | + 'noheader' => true, |
|
444 | + 'capability' => 'export', |
|
445 | + ), |
|
446 | + 'contact_list_report' => array( |
|
447 | + 'func' => '_contact_list_report', |
|
448 | + 'noheader' => true, |
|
449 | + 'capability' => 'ee_read_contacts', |
|
450 | + ), |
|
451 | + ); |
|
452 | + } |
|
453 | + |
|
454 | + |
|
455 | + protected function _set_page_config() |
|
456 | + { |
|
457 | + $this->_page_config = array( |
|
458 | + 'default' => array( |
|
459 | + 'nav' => array( |
|
460 | + 'label' => esc_html__('Overview', 'event_espresso'), |
|
461 | + 'order' => 5, |
|
462 | + ), |
|
463 | + 'help_tabs' => array( |
|
464 | + 'registrations_overview_help_tab' => array( |
|
465 | + 'title' => esc_html__('Registrations Overview', 'event_espresso'), |
|
466 | + 'filename' => 'registrations_overview', |
|
467 | + ), |
|
468 | + 'registrations_overview_table_column_headings_help_tab' => array( |
|
469 | + 'title' => esc_html__('Registrations Table Column Headings', 'event_espresso'), |
|
470 | + 'filename' => 'registrations_overview_table_column_headings', |
|
471 | + ), |
|
472 | + 'registrations_overview_filters_help_tab' => array( |
|
473 | + 'title' => esc_html__('Registration Filters', 'event_espresso'), |
|
474 | + 'filename' => 'registrations_overview_filters', |
|
475 | + ), |
|
476 | + 'registrations_overview_views_help_tab' => array( |
|
477 | + 'title' => esc_html__('Registration Views', 'event_espresso'), |
|
478 | + 'filename' => 'registrations_overview_views', |
|
479 | + ), |
|
480 | + 'registrations_regoverview_other_help_tab' => array( |
|
481 | + 'title' => esc_html__('Registrations Other', 'event_espresso'), |
|
482 | + 'filename' => 'registrations_overview_other', |
|
483 | + ), |
|
484 | + ), |
|
485 | + 'help_tour' => array('Registration_Overview_Help_Tour'), |
|
486 | + 'qtips' => array('Registration_List_Table_Tips'), |
|
487 | + 'list_table' => 'EE_Registrations_List_Table', |
|
488 | + 'require_nonce' => false, |
|
489 | + ), |
|
490 | + 'view_registration' => array( |
|
491 | + 'nav' => array( |
|
492 | + 'label' => esc_html__('REG Details', 'event_espresso'), |
|
493 | + 'order' => 15, |
|
494 | + 'url' => isset($this->_req_data['_REG_ID']) |
|
495 | + ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url) |
|
496 | + : $this->_admin_base_url, |
|
497 | + 'persistent' => false, |
|
498 | + ), |
|
499 | + 'help_tabs' => array( |
|
500 | + 'registrations_details_help_tab' => array( |
|
501 | + 'title' => esc_html__('Registration Details', 'event_espresso'), |
|
502 | + 'filename' => 'registrations_details', |
|
503 | + ), |
|
504 | + 'registrations_details_table_help_tab' => array( |
|
505 | + 'title' => esc_html__('Registration Details Table', 'event_espresso'), |
|
506 | + 'filename' => 'registrations_details_table', |
|
507 | + ), |
|
508 | + 'registrations_details_form_answers_help_tab' => array( |
|
509 | + 'title' => esc_html__('Registration Form Answers', 'event_espresso'), |
|
510 | + 'filename' => 'registrations_details_form_answers', |
|
511 | + ), |
|
512 | + 'registrations_details_registrant_details_help_tab' => array( |
|
513 | + 'title' => esc_html__('Contact Details', 'event_espresso'), |
|
514 | + 'filename' => 'registrations_details_registrant_details', |
|
515 | + ), |
|
516 | + ), |
|
517 | + 'help_tour' => array('Registration_Details_Help_Tour'), |
|
518 | + 'metaboxes' => array_merge( |
|
519 | + $this->_default_espresso_metaboxes, |
|
520 | + array('_registration_details_metaboxes') |
|
521 | + ), |
|
522 | + 'require_nonce' => false, |
|
523 | + ), |
|
524 | + 'new_registration' => array( |
|
525 | + 'nav' => array( |
|
526 | + 'label' => esc_html__('Add New Registration', 'event_espresso'), |
|
527 | + 'url' => '#', |
|
528 | + 'order' => 15, |
|
529 | + 'persistent' => false, |
|
530 | + ), |
|
531 | + 'metaboxes' => $this->_default_espresso_metaboxes, |
|
532 | + 'labels' => array( |
|
533 | + 'publishbox' => esc_html__('Save Registration', 'event_espresso'), |
|
534 | + ), |
|
535 | + 'require_nonce' => false, |
|
536 | + ), |
|
537 | + 'add_new_attendee' => array( |
|
538 | + 'nav' => array( |
|
539 | + 'label' => esc_html__('Add Contact', 'event_espresso'), |
|
540 | + 'order' => 15, |
|
541 | + 'persistent' => false, |
|
542 | + ), |
|
543 | + 'metaboxes' => array_merge( |
|
544 | + $this->_default_espresso_metaboxes, |
|
545 | + array('_publish_post_box', 'attendee_editor_metaboxes') |
|
546 | + ), |
|
547 | + 'require_nonce' => false, |
|
548 | + ), |
|
549 | + 'edit_attendee' => array( |
|
550 | + 'nav' => array( |
|
551 | + 'label' => esc_html__('Edit Contact', 'event_espresso'), |
|
552 | + 'order' => 15, |
|
553 | + 'persistent' => false, |
|
554 | + 'url' => isset($this->_req_data['ATT_ID']) |
|
555 | + ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url) |
|
556 | + : $this->_admin_base_url, |
|
557 | + ), |
|
558 | + 'metaboxes' => array('attendee_editor_metaboxes'), |
|
559 | + 'require_nonce' => false, |
|
560 | + ), |
|
561 | + 'contact_list' => array( |
|
562 | + 'nav' => array( |
|
563 | + 'label' => esc_html__('Contact List', 'event_espresso'), |
|
564 | + 'order' => 20, |
|
565 | + ), |
|
566 | + 'list_table' => 'EE_Attendee_Contact_List_Table', |
|
567 | + 'help_tabs' => array( |
|
568 | + 'registrations_contact_list_help_tab' => array( |
|
569 | + 'title' => esc_html__('Registrations Contact List', 'event_espresso'), |
|
570 | + 'filename' => 'registrations_contact_list', |
|
571 | + ), |
|
572 | + 'registrations_contact-list_table_column_headings_help_tab' => array( |
|
573 | + 'title' => esc_html__('Contact List Table Column Headings', 'event_espresso'), |
|
574 | + 'filename' => 'registrations_contact_list_table_column_headings', |
|
575 | + ), |
|
576 | + 'registrations_contact_list_views_help_tab' => array( |
|
577 | + 'title' => esc_html__('Contact List Views', 'event_espresso'), |
|
578 | + 'filename' => 'registrations_contact_list_views', |
|
579 | + ), |
|
580 | + 'registrations_contact_list_other_help_tab' => array( |
|
581 | + 'title' => esc_html__('Contact List Other', 'event_espresso'), |
|
582 | + 'filename' => 'registrations_contact_list_other', |
|
583 | + ), |
|
584 | + ), |
|
585 | + 'help_tour' => array('Contact_List_Help_Tour'), |
|
586 | + 'metaboxes' => array(), |
|
587 | + 'require_nonce' => false, |
|
588 | + ), |
|
589 | + // override default cpt routes |
|
590 | + 'create_new' => '', |
|
591 | + 'edit' => '', |
|
592 | + ); |
|
593 | + } |
|
594 | + |
|
595 | + |
|
596 | + /** |
|
597 | + * The below methods aren't used by this class currently |
|
598 | + */ |
|
599 | + protected function _add_screen_options() |
|
600 | + { |
|
601 | + } |
|
602 | + |
|
603 | + |
|
604 | + protected function _add_feature_pointers() |
|
605 | + { |
|
606 | + } |
|
607 | + |
|
608 | + |
|
609 | + public function admin_init() |
|
610 | + { |
|
611 | + EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__( |
|
612 | + 'click "Update Registration Questions" to save your changes', |
|
613 | + 'event_espresso' |
|
614 | + ); |
|
615 | + } |
|
616 | + |
|
617 | + |
|
618 | + public function admin_notices() |
|
619 | + { |
|
620 | + } |
|
621 | + |
|
622 | + |
|
623 | + public function admin_footer_scripts() |
|
624 | + { |
|
625 | + } |
|
626 | + |
|
627 | + |
|
628 | + /** |
|
629 | + * get list of registration statuses |
|
630 | + * |
|
631 | + * @access private |
|
632 | + * @return void |
|
633 | + * @throws EE_Error |
|
634 | + */ |
|
635 | + private function _get_registration_status_array() |
|
636 | + { |
|
637 | + self::$_reg_status = EEM_Registration::reg_status_array(array(), true); |
|
638 | + } |
|
639 | + |
|
640 | + |
|
641 | + protected function _add_screen_options_default() |
|
642 | + { |
|
643 | + $this->_per_page_screen_option(); |
|
644 | + } |
|
645 | + |
|
646 | + |
|
647 | + protected function _add_screen_options_contact_list() |
|
648 | + { |
|
649 | + $page_title = $this->_admin_page_title; |
|
650 | + $this->_admin_page_title = esc_html__("Contacts", 'event_espresso'); |
|
651 | + $this->_per_page_screen_option(); |
|
652 | + $this->_admin_page_title = $page_title; |
|
653 | + } |
|
654 | + |
|
655 | + |
|
656 | + public function load_scripts_styles() |
|
657 | + { |
|
658 | + // style |
|
659 | + wp_register_style( |
|
660 | + 'espresso_reg', |
|
661 | + REG_ASSETS_URL . 'espresso_registrations_admin.css', |
|
662 | + array('ee-admin-css'), |
|
663 | + EVENT_ESPRESSO_VERSION |
|
664 | + ); |
|
665 | + wp_enqueue_style('espresso_reg'); |
|
666 | + // script |
|
667 | + wp_register_script( |
|
668 | + 'espresso_reg', |
|
669 | + REG_ASSETS_URL . 'espresso_registrations_admin.js', |
|
670 | + array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'), |
|
671 | + EVENT_ESPRESSO_VERSION, |
|
672 | + true |
|
673 | + ); |
|
674 | + wp_enqueue_script('espresso_reg'); |
|
675 | + } |
|
676 | + |
|
677 | + |
|
678 | + public function load_scripts_styles_edit_attendee() |
|
679 | + { |
|
680 | + // stuff to only show up on our attendee edit details page. |
|
681 | + $attendee_details_translations = array( |
|
682 | + 'att_publish_text' => sprintf( |
|
683 | + esc_html__('Created on: <b>%1$s</b>', 'event_espresso'), |
|
684 | + $this->_cpt_model_obj->get_datetime('ATT_created') |
|
685 | + ), |
|
686 | + ); |
|
687 | + wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations); |
|
688 | + wp_enqueue_script('jquery-validate'); |
|
689 | + } |
|
690 | + |
|
691 | + |
|
692 | + public function load_scripts_styles_view_registration() |
|
693 | + { |
|
694 | + // styles |
|
695 | + wp_enqueue_style('espresso-ui-theme'); |
|
696 | + // scripts |
|
697 | + $this->_get_reg_custom_questions_form($this->_registration->ID()); |
|
698 | + $this->_reg_custom_questions_form->wp_enqueue_scripts(true); |
|
699 | + } |
|
700 | + |
|
701 | + |
|
702 | + public function load_scripts_styles_contact_list() |
|
703 | + { |
|
704 | + wp_dequeue_style('espresso_reg'); |
|
705 | + wp_register_style( |
|
706 | + 'espresso_att', |
|
707 | + REG_ASSETS_URL . 'espresso_attendees_admin.css', |
|
708 | + array('ee-admin-css'), |
|
709 | + EVENT_ESPRESSO_VERSION |
|
710 | + ); |
|
711 | + wp_enqueue_style('espresso_att'); |
|
712 | + } |
|
713 | + |
|
714 | + |
|
715 | + public function load_scripts_styles_new_registration() |
|
716 | + { |
|
717 | + wp_register_script( |
|
718 | + 'ee-spco-for-admin', |
|
719 | + REG_ASSETS_URL . 'spco_for_admin.js', |
|
720 | + array('underscore', 'jquery'), |
|
721 | + EVENT_ESPRESSO_VERSION, |
|
722 | + true |
|
723 | + ); |
|
724 | + wp_enqueue_script('ee-spco-for-admin'); |
|
725 | + add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true'); |
|
726 | + EE_Form_Section_Proper::wp_enqueue_scripts(); |
|
727 | + EED_Ticket_Selector::load_tckt_slctr_assets(); |
|
728 | + EE_Datepicker_Input::enqueue_styles_and_scripts(); |
|
729 | + } |
|
730 | + |
|
731 | + |
|
732 | + public function AHEE__EE_Admin_Page__route_admin_request_resend_registration() |
|
733 | + { |
|
734 | + add_filter('FHEE_load_EE_messages', '__return_true'); |
|
735 | + } |
|
736 | + |
|
737 | + |
|
738 | + public function AHEE__EE_Admin_Page__route_admin_request_approve_registration() |
|
739 | + { |
|
740 | + add_filter('FHEE_load_EE_messages', '__return_true'); |
|
741 | + } |
|
742 | + |
|
743 | + |
|
744 | + protected function _set_list_table_views_default() |
|
745 | + { |
|
746 | + // for notification related bulk actions we need to make sure only active messengers have an option. |
|
747 | + EED_Messages::set_autoloaders(); |
|
748 | + /** @type EE_Message_Resource_Manager $message_resource_manager */ |
|
749 | + $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
750 | + $active_mts = $message_resource_manager->list_of_active_message_types(); |
|
751 | + // key= bulk_action_slug, value= message type. |
|
752 | + $match_array = array( |
|
753 | + 'approve_registrations' => 'registration', |
|
754 | + 'decline_registrations' => 'declined_registration', |
|
755 | + 'pending_registrations' => 'pending_approval', |
|
756 | + 'no_approve_registrations' => 'not_approved_registration', |
|
757 | + 'cancel_registrations' => 'cancelled_registration', |
|
758 | + ); |
|
759 | + $can_send = EE_Registry::instance()->CAP->current_user_can( |
|
760 | + 'ee_send_message', |
|
761 | + 'batch_send_messages' |
|
762 | + ); |
|
763 | + /** setup reg status bulk actions **/ |
|
764 | + $def_reg_status_actions['approve_registrations'] = esc_html__('Approve Registrations', 'event_espresso'); |
|
765 | + if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) { |
|
766 | + $def_reg_status_actions['approve_and_notify_registrations'] = esc_html__( |
|
767 | + 'Approve and Notify Registrations', |
|
768 | + 'event_espresso' |
|
769 | + ); |
|
770 | + } |
|
771 | + $def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso'); |
|
772 | + if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) { |
|
773 | + $def_reg_status_actions['decline_and_notify_registrations'] = esc_html__( |
|
774 | + 'Decline and Notify Registrations', |
|
775 | + 'event_espresso' |
|
776 | + ); |
|
777 | + } |
|
778 | + $def_reg_status_actions['pending_registrations'] = esc_html__( |
|
779 | + 'Set Registrations to Pending Payment', |
|
780 | + 'event_espresso' |
|
781 | + ); |
|
782 | + if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) { |
|
783 | + $def_reg_status_actions['pending_and_notify_registrations'] = esc_html__( |
|
784 | + 'Set Registrations to Pending Payment and Notify', |
|
785 | + 'event_espresso' |
|
786 | + ); |
|
787 | + } |
|
788 | + $def_reg_status_actions['no_approve_registrations'] = esc_html__( |
|
789 | + 'Set Registrations to Not Approved', |
|
790 | + 'event_espresso' |
|
791 | + ); |
|
792 | + if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) { |
|
793 | + $def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__( |
|
794 | + 'Set Registrations to Not Approved and Notify', |
|
795 | + 'event_espresso' |
|
796 | + ); |
|
797 | + } |
|
798 | + $def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso'); |
|
799 | + if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) { |
|
800 | + $def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__( |
|
801 | + 'Cancel Registrations and Notify', |
|
802 | + 'event_espresso' |
|
803 | + ); |
|
804 | + } |
|
805 | + $def_reg_status_actions = apply_filters( |
|
806 | + 'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array', |
|
807 | + $def_reg_status_actions, |
|
808 | + $active_mts, |
|
809 | + $can_send |
|
810 | + ); |
|
811 | + |
|
812 | + $this->_views = array( |
|
813 | + 'all' => array( |
|
814 | + 'slug' => 'all', |
|
815 | + 'label' => esc_html__('View All Registrations', 'event_espresso'), |
|
816 | + 'count' => 0, |
|
817 | + 'bulk_action' => array_merge( |
|
818 | + $def_reg_status_actions, |
|
819 | + array( |
|
820 | + 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
821 | + ) |
|
822 | + ), |
|
823 | + ), |
|
824 | + 'month' => array( |
|
825 | + 'slug' => 'month', |
|
826 | + 'label' => esc_html__('This Month', 'event_espresso'), |
|
827 | + 'count' => 0, |
|
828 | + 'bulk_action' => array_merge( |
|
829 | + $def_reg_status_actions, |
|
830 | + array( |
|
831 | + 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
832 | + ) |
|
833 | + ), |
|
834 | + ), |
|
835 | + 'today' => array( |
|
836 | + 'slug' => 'today', |
|
837 | + 'label' => sprintf( |
|
838 | + esc_html__('Today - %s', 'event_espresso'), |
|
839 | + date('M d, Y', current_time('timestamp')) |
|
840 | + ), |
|
841 | + 'count' => 0, |
|
842 | + 'bulk_action' => array_merge( |
|
843 | + $def_reg_status_actions, |
|
844 | + array( |
|
845 | + 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
846 | + ) |
|
847 | + ), |
|
848 | + ), |
|
849 | + ); |
|
850 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
851 | + 'ee_delete_registrations', |
|
852 | + 'espresso_registrations_delete_registration' |
|
853 | + )) { |
|
854 | + $this->_views['incomplete'] = array( |
|
855 | + 'slug' => 'incomplete', |
|
856 | + 'label' => esc_html__('Incomplete', 'event_espresso'), |
|
857 | + 'count' => 0, |
|
858 | + 'bulk_action' => array( |
|
859 | + 'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'), |
|
860 | + ), |
|
861 | + ); |
|
862 | + $this->_views['trash'] = array( |
|
863 | + 'slug' => 'trash', |
|
864 | + 'label' => esc_html__('Trash', 'event_espresso'), |
|
865 | + 'count' => 0, |
|
866 | + 'bulk_action' => array( |
|
867 | + 'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'), |
|
868 | + 'delete_registrations' => esc_html__('Delete Registrations Permanently', 'event_espresso'), |
|
869 | + ), |
|
870 | + ); |
|
871 | + } |
|
872 | + } |
|
873 | + |
|
874 | + |
|
875 | + protected function _set_list_table_views_contact_list() |
|
876 | + { |
|
877 | + $this->_views = array( |
|
878 | + 'in_use' => array( |
|
879 | + 'slug' => 'in_use', |
|
880 | + 'label' => esc_html__('In Use', 'event_espresso'), |
|
881 | + 'count' => 0, |
|
882 | + 'bulk_action' => array( |
|
883 | + 'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'), |
|
884 | + ), |
|
885 | + ), |
|
886 | + ); |
|
887 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
888 | + 'ee_delete_contacts', |
|
889 | + 'espresso_registrations_trash_attendees' |
|
890 | + ) |
|
891 | + ) { |
|
892 | + $this->_views['trash'] = array( |
|
893 | + 'slug' => 'trash', |
|
894 | + 'label' => esc_html__('Trash', 'event_espresso'), |
|
895 | + 'count' => 0, |
|
896 | + 'bulk_action' => array( |
|
897 | + 'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'), |
|
898 | + ), |
|
899 | + ); |
|
900 | + } |
|
901 | + } |
|
902 | + |
|
903 | + |
|
904 | + protected function _registration_legend_items() |
|
905 | + { |
|
906 | + $fc_items = array( |
|
907 | + 'star-icon' => array( |
|
908 | + 'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8', |
|
909 | + 'desc' => esc_html__('This is the Primary Registrant', 'event_espresso'), |
|
910 | + ), |
|
911 | + 'view_details' => array( |
|
912 | + 'class' => 'dashicons dashicons-clipboard', |
|
913 | + 'desc' => esc_html__('View Registration Details', 'event_espresso'), |
|
914 | + ), |
|
915 | + 'edit_attendee' => array( |
|
916 | + 'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16', |
|
917 | + 'desc' => esc_html__('Edit Contact Details', 'event_espresso'), |
|
918 | + ), |
|
919 | + 'view_transaction' => array( |
|
920 | + 'class' => 'dashicons dashicons-cart', |
|
921 | + 'desc' => esc_html__('View Transaction Details', 'event_espresso'), |
|
922 | + ), |
|
923 | + 'view_invoice' => array( |
|
924 | + 'class' => 'dashicons dashicons-media-spreadsheet', |
|
925 | + 'desc' => esc_html__('View Transaction Invoice', 'event_espresso'), |
|
926 | + ), |
|
927 | + ); |
|
928 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
929 | + 'ee_send_message', |
|
930 | + 'espresso_registrations_resend_registration' |
|
931 | + )) { |
|
932 | + $fc_items['resend_registration'] = array( |
|
933 | + 'class' => 'dashicons dashicons-email-alt', |
|
934 | + 'desc' => esc_html__('Resend Registration Details', 'event_espresso'), |
|
935 | + ); |
|
936 | + } else { |
|
937 | + $fc_items['blank'] = array('class' => 'blank', 'desc' => ''); |
|
938 | + } |
|
939 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
940 | + 'ee_read_global_messages', |
|
941 | + 'view_filtered_messages' |
|
942 | + )) { |
|
943 | + $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for'); |
|
944 | + if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) { |
|
945 | + $fc_items['view_related_messages'] = array( |
|
946 | + 'class' => $related_for_icon['css_class'], |
|
947 | + 'desc' => $related_for_icon['label'], |
|
948 | + ); |
|
949 | + } |
|
950 | + } |
|
951 | + $sc_items = array( |
|
952 | + 'approved_status' => array( |
|
953 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved, |
|
954 | + 'desc' => EEH_Template::pretty_status( |
|
955 | + EEM_Registration::status_id_approved, |
|
956 | + false, |
|
957 | + 'sentence' |
|
958 | + ), |
|
959 | + ), |
|
960 | + 'pending_status' => array( |
|
961 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment, |
|
962 | + 'desc' => EEH_Template::pretty_status( |
|
963 | + EEM_Registration::status_id_pending_payment, |
|
964 | + false, |
|
965 | + 'sentence' |
|
966 | + ), |
|
967 | + ), |
|
968 | + 'wait_list' => array( |
|
969 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list, |
|
970 | + 'desc' => EEH_Template::pretty_status( |
|
971 | + EEM_Registration::status_id_wait_list, |
|
972 | + false, |
|
973 | + 'sentence' |
|
974 | + ), |
|
975 | + ), |
|
976 | + 'incomplete_status' => array( |
|
977 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete, |
|
978 | + 'desc' => EEH_Template::pretty_status( |
|
979 | + EEM_Registration::status_id_incomplete, |
|
980 | + false, |
|
981 | + 'sentence' |
|
982 | + ), |
|
983 | + ), |
|
984 | + 'not_approved' => array( |
|
985 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved, |
|
986 | + 'desc' => EEH_Template::pretty_status( |
|
987 | + EEM_Registration::status_id_not_approved, |
|
988 | + false, |
|
989 | + 'sentence' |
|
990 | + ), |
|
991 | + ), |
|
992 | + 'declined_status' => array( |
|
993 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined, |
|
994 | + 'desc' => EEH_Template::pretty_status( |
|
995 | + EEM_Registration::status_id_declined, |
|
996 | + false, |
|
997 | + 'sentence' |
|
998 | + ), |
|
999 | + ), |
|
1000 | + 'cancelled_status' => array( |
|
1001 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled, |
|
1002 | + 'desc' => EEH_Template::pretty_status( |
|
1003 | + EEM_Registration::status_id_cancelled, |
|
1004 | + false, |
|
1005 | + 'sentence' |
|
1006 | + ), |
|
1007 | + ), |
|
1008 | + ); |
|
1009 | + return array_merge($fc_items, $sc_items); |
|
1010 | + } |
|
1011 | + |
|
1012 | + |
|
1013 | + |
|
1014 | + /*************************************** REGISTRATION OVERVIEW **************************************/ |
|
1015 | + /** |
|
1016 | + * @throws \EE_Error |
|
1017 | + */ |
|
1018 | + protected function _registrations_overview_list_table() |
|
1019 | + { |
|
1020 | + $this->_template_args['admin_page_header'] = ''; |
|
1021 | + $EVT_ID = ! empty($this->_req_data['event_id']) |
|
1022 | + ? absint($this->_req_data['event_id']) |
|
1023 | + : 0; |
|
1024 | + $ATT_ID = ! empty($this->_req_data['ATT_ID']) |
|
1025 | + ? absint($this->_req_data['ATT_ID']) |
|
1026 | + : 0; |
|
1027 | + if ($ATT_ID) { |
|
1028 | + $attendee = EEM_Attendee::instance()->get_one_by_ID($ATT_ID); |
|
1029 | + if ($attendee instanceof EE_Attendee) { |
|
1030 | + $this->_template_args['admin_page_header'] = sprintf( |
|
1031 | + esc_html__( |
|
1032 | + '%1$s Viewing registrations for %2$s%3$s', |
|
1033 | + 'event_espresso' |
|
1034 | + ), |
|
1035 | + '<h3 style="line-height:1.5em;">', |
|
1036 | + '<a href="' . EE_Admin_Page::add_query_args_and_nonce( |
|
1037 | + array( |
|
1038 | + 'action' => 'edit_attendee', |
|
1039 | + 'post' => $ATT_ID, |
|
1040 | + ), |
|
1041 | + REG_ADMIN_URL |
|
1042 | + ) . '">' . $attendee->full_name() . '</a>', |
|
1043 | + '</h3>' |
|
1044 | + ); |
|
1045 | + } |
|
1046 | + } |
|
1047 | + if ($EVT_ID) { |
|
1048 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
1049 | + 'ee_edit_registrations', |
|
1050 | + 'espresso_registrations_new_registration', |
|
1051 | + $EVT_ID |
|
1052 | + )) { |
|
1053 | + $this->_admin_page_title .= ' ' . $this->get_action_link_or_button( |
|
1054 | + 'new_registration', |
|
1055 | + 'add-registrant', |
|
1056 | + array('event_id' => $EVT_ID), |
|
1057 | + 'add-new-h2' |
|
1058 | + ); |
|
1059 | + } |
|
1060 | + $event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
1061 | + if ($event instanceof EE_Event) { |
|
1062 | + $this->_template_args['admin_page_header'] = sprintf( |
|
1063 | + esc_html__( |
|
1064 | + '%s Viewing registrations for the event: %s%s', |
|
1065 | + 'event_espresso' |
|
1066 | + ), |
|
1067 | + '<h3 style="line-height:1.5em;">', |
|
1068 | + '<br /><a href="' |
|
1069 | + . EE_Admin_Page::add_query_args_and_nonce( |
|
1070 | + array( |
|
1071 | + 'action' => 'edit', |
|
1072 | + 'post' => $event->ID(), |
|
1073 | + ), |
|
1074 | + EVENTS_ADMIN_URL |
|
1075 | + ) |
|
1076 | + . '"> ' |
|
1077 | + . $event->get('EVT_name') |
|
1078 | + . ' </a> ', |
|
1079 | + '</h3>' |
|
1080 | + ); |
|
1081 | + } |
|
1082 | + $DTT_ID = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0; |
|
1083 | + $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID); |
|
1084 | + if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') { |
|
1085 | + $this->_template_args['admin_page_header'] = substr( |
|
1086 | + $this->_template_args['admin_page_header'], |
|
1087 | + 0, |
|
1088 | + -5 |
|
1089 | + ); |
|
1090 | + $this->_template_args['admin_page_header'] .= ' <span class="drk-grey-text">'; |
|
1091 | + $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>'; |
|
1092 | + $this->_template_args['admin_page_header'] .= $datetime->name(); |
|
1093 | + $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )'; |
|
1094 | + $this->_template_args['admin_page_header'] .= '</span></h3>'; |
|
1095 | + } |
|
1096 | + } |
|
1097 | + $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items()); |
|
1098 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
1099 | + } |
|
1100 | + |
|
1101 | + |
|
1102 | + /** |
|
1103 | + * This sets the _registration property for the registration details screen |
|
1104 | + * |
|
1105 | + * @access private |
|
1106 | + * @return bool |
|
1107 | + * @throws EE_Error |
|
1108 | + * @throws InvalidArgumentException |
|
1109 | + * @throws InvalidDataTypeException |
|
1110 | + * @throws InvalidInterfaceException |
|
1111 | + */ |
|
1112 | + private function _set_registration_object() |
|
1113 | + { |
|
1114 | + // get out if we've already set the object |
|
1115 | + if ($this->_registration instanceof EE_Registration) { |
|
1116 | + return true; |
|
1117 | + } |
|
1118 | + $REG = EEM_Registration::instance(); |
|
1119 | + $REG_ID = (! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false; |
|
1120 | + if ($this->_registration = $REG->get_one_by_ID($REG_ID)) { |
|
1121 | + return true; |
|
1122 | + } else { |
|
1123 | + $error_msg = sprintf( |
|
1124 | + esc_html__( |
|
1125 | + 'An error occurred and the details for Registration ID #%s could not be retrieved.', |
|
1126 | + 'event_espresso' |
|
1127 | + ), |
|
1128 | + $REG_ID |
|
1129 | + ); |
|
1130 | + EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__); |
|
1131 | + $this->_registration = null; |
|
1132 | + return false; |
|
1133 | + } |
|
1134 | + } |
|
1135 | + |
|
1136 | + |
|
1137 | + /** |
|
1138 | + * Used to retrieve registrations for the list table. |
|
1139 | + * |
|
1140 | + * @param int $per_page |
|
1141 | + * @param bool $count |
|
1142 | + * @param bool $this_month |
|
1143 | + * @param bool $today |
|
1144 | + * @return EE_Registration[]|int |
|
1145 | + * @throws EE_Error |
|
1146 | + * @throws InvalidArgumentException |
|
1147 | + * @throws InvalidDataTypeException |
|
1148 | + * @throws InvalidInterfaceException |
|
1149 | + */ |
|
1150 | + public function get_registrations( |
|
1151 | + $per_page = 10, |
|
1152 | + $count = false, |
|
1153 | + $this_month = false, |
|
1154 | + $today = false |
|
1155 | + ) { |
|
1156 | + if ($this_month) { |
|
1157 | + $this->_req_data['status'] = 'month'; |
|
1158 | + } |
|
1159 | + if ($today) { |
|
1160 | + $this->_req_data['status'] = 'today'; |
|
1161 | + } |
|
1162 | + $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count); |
|
1163 | + /** |
|
1164 | + * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected |
|
1165 | + * |
|
1166 | + * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093 |
|
1167 | + * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md |
|
1168 | + * or if you have the development copy of EE you can view this at the path: |
|
1169 | + * /docs/G--Model-System/model-query-params.md |
|
1170 | + */ |
|
1171 | + $query_params['group_by'] = ''; |
|
1172 | + |
|
1173 | + return $count |
|
1174 | + ? EEM_Registration::instance()->count($query_params) |
|
1175 | + /** @type EE_Registration[] */ |
|
1176 | + : EEM_Registration::instance()->get_all($query_params); |
|
1177 | + } |
|
1178 | + |
|
1179 | + |
|
1180 | + /** |
|
1181 | + * Retrieves the query parameters to be used by the Registration model for getting registrations. |
|
1182 | + * Note: this listens to values on the request for some of the query parameters. |
|
1183 | + * |
|
1184 | + * @param array $request |
|
1185 | + * @param int $per_page |
|
1186 | + * @param bool $count |
|
1187 | + * @return array |
|
1188 | + * @throws EE_Error |
|
1189 | + */ |
|
1190 | + protected function _get_registration_query_parameters( |
|
1191 | + $request = array(), |
|
1192 | + $per_page = 10, |
|
1193 | + $count = false |
|
1194 | + ) { |
|
1195 | + |
|
1196 | + $query_params = array( |
|
1197 | + 0 => $this->_get_where_conditions_for_registrations_query( |
|
1198 | + $request |
|
1199 | + ), |
|
1200 | + 'caps' => EEM_Registration::caps_read_admin, |
|
1201 | + 'default_where_conditions' => 'this_model_only', |
|
1202 | + ); |
|
1203 | + if (! $count) { |
|
1204 | + $query_params = array_merge( |
|
1205 | + $query_params, |
|
1206 | + $this->_get_orderby_for_registrations_query(), |
|
1207 | + $this->_get_limit($per_page) |
|
1208 | + ); |
|
1209 | + } |
|
1210 | + |
|
1211 | + return $query_params; |
|
1212 | + } |
|
1213 | + |
|
1214 | + |
|
1215 | + /** |
|
1216 | + * This will add ATT_ID to the provided $where array for EE model query parameters. |
|
1217 | + * |
|
1218 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
1219 | + * @return array |
|
1220 | + */ |
|
1221 | + protected function addAttendeeIdToWhereConditions(array $request) |
|
1222 | + { |
|
1223 | + $where = array(); |
|
1224 | + if (! empty($request['ATT_ID'])) { |
|
1225 | + $where['ATT_ID'] = absint($request['ATT_ID']); |
|
1226 | + } |
|
1227 | + return $where; |
|
1228 | + } |
|
1229 | + |
|
1230 | + |
|
1231 | + /** |
|
1232 | + * This will add EVT_ID to the provided $where array for EE model query parameters. |
|
1233 | + * |
|
1234 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
1235 | + * @return array |
|
1236 | + */ |
|
1237 | + protected function _add_event_id_to_where_conditions(array $request) |
|
1238 | + { |
|
1239 | + $where = array(); |
|
1240 | + if (! empty($request['event_id'])) { |
|
1241 | + $where['EVT_ID'] = absint($request['event_id']); |
|
1242 | + } |
|
1243 | + return $where; |
|
1244 | + } |
|
1245 | + |
|
1246 | + |
|
1247 | + /** |
|
1248 | + * Adds category ID if it exists in the request to the where conditions for the registrations query. |
|
1249 | + * |
|
1250 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
1251 | + * @return array |
|
1252 | + */ |
|
1253 | + protected function _add_category_id_to_where_conditions(array $request) |
|
1254 | + { |
|
1255 | + $where = array(); |
|
1256 | + if (! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) { |
|
1257 | + $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']); |
|
1258 | + } |
|
1259 | + return $where; |
|
1260 | + } |
|
1261 | + |
|
1262 | + |
|
1263 | + /** |
|
1264 | + * Adds the datetime ID if it exists in the request to the where conditions for the registrations query. |
|
1265 | + * |
|
1266 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
1267 | + * @return array |
|
1268 | + */ |
|
1269 | + protected function _add_datetime_id_to_where_conditions(array $request) |
|
1270 | + { |
|
1271 | + $where = array(); |
|
1272 | + if (! empty($request['datetime_id'])) { |
|
1273 | + $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']); |
|
1274 | + } |
|
1275 | + if (! empty($request['DTT_ID'])) { |
|
1276 | + $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']); |
|
1277 | + } |
|
1278 | + return $where; |
|
1279 | + } |
|
1280 | + |
|
1281 | + |
|
1282 | + /** |
|
1283 | + * Adds the correct registration status to the where conditions for the registrations query. |
|
1284 | + * |
|
1285 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
1286 | + * @return array |
|
1287 | + */ |
|
1288 | + protected function _add_registration_status_to_where_conditions(array $request) |
|
1289 | + { |
|
1290 | + $where = array(); |
|
1291 | + $view = EEH_Array::is_set($request, 'status', ''); |
|
1292 | + $registration_status = ! empty($request['_reg_status']) |
|
1293 | + ? sanitize_text_field($request['_reg_status']) |
|
1294 | + : ''; |
|
1295 | + |
|
1296 | + /* |
|
1297 | 1297 | * If filtering by registration status, then we show registrations matching that status. |
1298 | 1298 | * If not filtering by specified status, then we show all registrations excluding incomplete registrations |
1299 | 1299 | * UNLESS viewing trashed registrations. |
1300 | 1300 | */ |
1301 | - if (! empty($registration_status)) { |
|
1302 | - $where['STS_ID'] = $registration_status; |
|
1303 | - } else { |
|
1304 | - // make sure we exclude incomplete registrations, but only if not trashed. |
|
1305 | - if ($view === 'trash') { |
|
1306 | - $where['REG_deleted'] = true; |
|
1307 | - } elseif ($view === 'incomplete') { |
|
1308 | - $where['STS_ID'] = EEM_Registration::status_id_incomplete; |
|
1309 | - } else { |
|
1310 | - $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete); |
|
1311 | - } |
|
1312 | - } |
|
1313 | - return $where; |
|
1314 | - } |
|
1315 | - |
|
1316 | - |
|
1317 | - /** |
|
1318 | - * Adds any provided date restraints to the where conditions for the registrations query. |
|
1319 | - * |
|
1320 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
1321 | - * @return array |
|
1322 | - * @throws EE_Error |
|
1323 | - * @throws InvalidArgumentException |
|
1324 | - * @throws InvalidDataTypeException |
|
1325 | - * @throws InvalidInterfaceException |
|
1326 | - */ |
|
1327 | - protected function _add_date_to_where_conditions(array $request) |
|
1328 | - { |
|
1329 | - $where = array(); |
|
1330 | - $view = EEH_Array::is_set($request, 'status', ''); |
|
1331 | - $month_range = ! empty($request['month_range']) |
|
1332 | - ? sanitize_text_field($request['month_range']) |
|
1333 | - : ''; |
|
1334 | - $retrieve_for_today = $view === 'today'; |
|
1335 | - $retrieve_for_this_month = $view === 'month'; |
|
1336 | - |
|
1337 | - if ($retrieve_for_today) { |
|
1338 | - $now = date('Y-m-d', current_time('timestamp')); |
|
1339 | - $where['REG_date'] = array( |
|
1340 | - 'BETWEEN', |
|
1341 | - array( |
|
1342 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
1343 | - 'REG_date', |
|
1344 | - $now . ' 00:00:00', |
|
1345 | - 'Y-m-d H:i:s' |
|
1346 | - ), |
|
1347 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
1348 | - 'REG_date', |
|
1349 | - $now . ' 23:59:59', |
|
1350 | - 'Y-m-d H:i:s' |
|
1351 | - ), |
|
1352 | - ), |
|
1353 | - ); |
|
1354 | - } elseif ($retrieve_for_this_month) { |
|
1355 | - $current_year_and_month = date('Y-m', current_time('timestamp')); |
|
1356 | - $days_this_month = date('t', current_time('timestamp')); |
|
1357 | - $where['REG_date'] = array( |
|
1358 | - 'BETWEEN', |
|
1359 | - array( |
|
1360 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
1361 | - 'REG_date', |
|
1362 | - $current_year_and_month . '-01 00:00:00', |
|
1363 | - 'Y-m-d H:i:s' |
|
1364 | - ), |
|
1365 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
1366 | - 'REG_date', |
|
1367 | - $current_year_and_month . '-' . $days_this_month . ' 23:59:59', |
|
1368 | - 'Y-m-d H:i:s' |
|
1369 | - ), |
|
1370 | - ), |
|
1371 | - ); |
|
1372 | - } elseif ($month_range) { |
|
1373 | - $pieces = explode(' ', $month_range, 3); |
|
1374 | - $month_requested = ! empty($pieces[0]) |
|
1375 | - ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) |
|
1376 | - : ''; |
|
1377 | - $year_requested = ! empty($pieces[1]) |
|
1378 | - ? $pieces[1] |
|
1379 | - : ''; |
|
1380 | - // if there is not a month or year then we can't go further |
|
1381 | - if ($month_requested && $year_requested) { |
|
1382 | - $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01')); |
|
1383 | - $where['REG_date'] = array( |
|
1384 | - 'BETWEEN', |
|
1385 | - array( |
|
1386 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
1387 | - 'REG_date', |
|
1388 | - $year_requested . '-' . $month_requested . '-01 00:00:00', |
|
1389 | - 'Y-m-d H:i:s' |
|
1390 | - ), |
|
1391 | - EEM_Registration::instance()->convert_datetime_for_query( |
|
1392 | - 'REG_date', |
|
1393 | - $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59', |
|
1394 | - 'Y-m-d H:i:s' |
|
1395 | - ), |
|
1396 | - ), |
|
1397 | - ); |
|
1398 | - } |
|
1399 | - } |
|
1400 | - return $where; |
|
1401 | - } |
|
1402 | - |
|
1403 | - |
|
1404 | - /** |
|
1405 | - * Adds any provided search restraints to the where conditions for the registrations query |
|
1406 | - * |
|
1407 | - * @param array $request usually the same as $this->_req_data but not necessarily |
|
1408 | - * @return array |
|
1409 | - */ |
|
1410 | - protected function _add_search_to_where_conditions(array $request) |
|
1411 | - { |
|
1412 | - $where = array(); |
|
1413 | - if (! empty($request['s'])) { |
|
1414 | - $search_string = '%' . sanitize_text_field($request['s']) . '%'; |
|
1415 | - $where['OR*search_conditions'] = array( |
|
1416 | - 'Event.EVT_name' => array('LIKE', $search_string), |
|
1417 | - 'Event.EVT_desc' => array('LIKE', $search_string), |
|
1418 | - 'Event.EVT_short_desc' => array('LIKE', $search_string), |
|
1419 | - 'Attendee.ATT_full_name' => array('LIKE', $search_string), |
|
1420 | - 'Attendee.ATT_fname' => array('LIKE', $search_string), |
|
1421 | - 'Attendee.ATT_lname' => array('LIKE', $search_string), |
|
1422 | - 'Attendee.ATT_short_bio' => array('LIKE', $search_string), |
|
1423 | - 'Attendee.ATT_email' => array('LIKE', $search_string), |
|
1424 | - 'Attendee.ATT_address' => array('LIKE', $search_string), |
|
1425 | - 'Attendee.ATT_address2' => array('LIKE', $search_string), |
|
1426 | - 'Attendee.ATT_city' => array('LIKE', $search_string), |
|
1427 | - 'REG_final_price' => array('LIKE', $search_string), |
|
1428 | - 'REG_code' => array('LIKE', $search_string), |
|
1429 | - 'REG_count' => array('LIKE', $search_string), |
|
1430 | - 'REG_group_size' => array('LIKE', $search_string), |
|
1431 | - 'Ticket.TKT_name' => array('LIKE', $search_string), |
|
1432 | - 'Ticket.TKT_description' => array('LIKE', $search_string), |
|
1433 | - 'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string), |
|
1434 | - ); |
|
1435 | - } |
|
1436 | - return $where; |
|
1437 | - } |
|
1438 | - |
|
1439 | - |
|
1440 | - /** |
|
1441 | - * Sets up the where conditions for the registrations query. |
|
1442 | - * |
|
1443 | - * @param array $request |
|
1444 | - * @return array |
|
1445 | - * @throws EE_Error |
|
1446 | - */ |
|
1447 | - protected function _get_where_conditions_for_registrations_query($request) |
|
1448 | - { |
|
1449 | - return apply_filters( |
|
1450 | - 'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query', |
|
1451 | - array_merge( |
|
1452 | - $this->addAttendeeIdToWhereConditions($request), |
|
1453 | - $this->_add_event_id_to_where_conditions($request), |
|
1454 | - $this->_add_category_id_to_where_conditions($request), |
|
1455 | - $this->_add_datetime_id_to_where_conditions($request), |
|
1456 | - $this->_add_registration_status_to_where_conditions($request), |
|
1457 | - $this->_add_date_to_where_conditions($request), |
|
1458 | - $this->_add_search_to_where_conditions($request) |
|
1459 | - ), |
|
1460 | - $request |
|
1461 | - ); |
|
1462 | - } |
|
1463 | - |
|
1464 | - |
|
1465 | - /** |
|
1466 | - * Sets up the orderby for the registrations query. |
|
1467 | - * |
|
1468 | - * @return array |
|
1469 | - */ |
|
1470 | - protected function _get_orderby_for_registrations_query() |
|
1471 | - { |
|
1472 | - $orderby_field = ! empty($this->_req_data['orderby']) |
|
1473 | - ? sanitize_text_field($this->_req_data['orderby']) |
|
1474 | - : '_REG_date'; |
|
1475 | - switch ($orderby_field) { |
|
1476 | - case '_REG_ID': |
|
1477 | - $orderby = array('REG_ID'); |
|
1478 | - break; |
|
1479 | - case '_Reg_status': |
|
1480 | - $orderby = array('STS_ID'); |
|
1481 | - break; |
|
1482 | - case 'ATT_fname': |
|
1483 | - $orderby = array('Attendee.ATT_fname', 'Attendee.ATT_lname'); |
|
1484 | - break; |
|
1485 | - case 'ATT_lname': |
|
1486 | - $orderby = array('Attendee.ATT_lname', 'Attendee.ATT_fname'); |
|
1487 | - break; |
|
1488 | - case 'event_name': |
|
1489 | - $orderby = array('Event.EVT_name'); |
|
1490 | - break; |
|
1491 | - case 'DTT_EVT_start': |
|
1492 | - $orderby = array('Event.Datetime.DTT_EVT_start'); |
|
1493 | - break; |
|
1494 | - case '_REG_date': |
|
1495 | - $orderby = array('REG_date'); |
|
1496 | - break; |
|
1497 | - default: |
|
1498 | - $orderby = array($orderby_field); |
|
1499 | - break; |
|
1500 | - } |
|
1501 | - |
|
1502 | - // order |
|
1503 | - $order = ! empty($this->_req_data['order']) |
|
1504 | - ? sanitize_text_field($this->_req_data['order']) |
|
1505 | - : 'DESC'; |
|
1506 | - $orderby = array_combine( |
|
1507 | - $orderby, |
|
1508 | - array_fill(0, count($orderby), $order) |
|
1509 | - ); |
|
1510 | - // because there are many registrations with the same date, define |
|
1511 | - // a secondary way to order them, otherwise MySQL seems to be a bit random |
|
1512 | - if (empty($orderby['REG_ID'])) { |
|
1513 | - $orderby['REG_ID'] = $order; |
|
1514 | - } |
|
1515 | - |
|
1516 | - $orderby = apply_filters( |
|
1517 | - 'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query', |
|
1518 | - $orderby, |
|
1519 | - $this->_req_data |
|
1520 | - ); |
|
1521 | - |
|
1522 | - return array('order_by' => $orderby); |
|
1523 | - } |
|
1524 | - |
|
1525 | - |
|
1526 | - /** |
|
1527 | - * Sets up the limit for the registrations query. |
|
1528 | - * |
|
1529 | - * @param $per_page |
|
1530 | - * @return array |
|
1531 | - */ |
|
1532 | - protected function _get_limit($per_page) |
|
1533 | - { |
|
1534 | - $current_page = ! empty($this->_req_data['paged']) |
|
1535 | - ? absint($this->_req_data['paged']) |
|
1536 | - : 1; |
|
1537 | - $per_page = ! empty($this->_req_data['perpage']) |
|
1538 | - ? $this->_req_data['perpage'] |
|
1539 | - : $per_page; |
|
1540 | - |
|
1541 | - // -1 means return all results so get out if that's set. |
|
1542 | - if ((int) $per_page === -1) { |
|
1543 | - return array(); |
|
1544 | - } |
|
1545 | - $per_page = absint($per_page); |
|
1546 | - $offset = ($current_page - 1) * $per_page; |
|
1547 | - return array('limit' => array($offset, $per_page)); |
|
1548 | - } |
|
1549 | - |
|
1550 | - |
|
1551 | - public function get_registration_status_array() |
|
1552 | - { |
|
1553 | - return self::$_reg_status; |
|
1554 | - } |
|
1555 | - |
|
1556 | - |
|
1557 | - |
|
1558 | - |
|
1559 | - /*************************************** REGISTRATION DETAILS ***************************************/ |
|
1560 | - /** |
|
1561 | - * generates HTML for the View Registration Details Admin page |
|
1562 | - * |
|
1563 | - * @access protected |
|
1564 | - * @return void |
|
1565 | - * @throws DomainException |
|
1566 | - * @throws EE_Error |
|
1567 | - * @throws InvalidArgumentException |
|
1568 | - * @throws InvalidDataTypeException |
|
1569 | - * @throws InvalidInterfaceException |
|
1570 | - * @throws EntityNotFoundException |
|
1571 | - */ |
|
1572 | - protected function _registration_details() |
|
1573 | - { |
|
1574 | - $this->_template_args = array(); |
|
1575 | - $this->_set_registration_object(); |
|
1576 | - if (is_object($this->_registration)) { |
|
1577 | - $transaction = $this->_registration->transaction() |
|
1578 | - ? $this->_registration->transaction() |
|
1579 | - : EE_Transaction::new_instance(); |
|
1580 | - $this->_session = $transaction->session_data(); |
|
1581 | - $event_id = $this->_registration->event_ID(); |
|
1582 | - $this->_template_args['reg_nmbr']['value'] = $this->_registration->ID(); |
|
1583 | - $this->_template_args['reg_nmbr']['label'] = esc_html__('Registration Number', 'event_espresso'); |
|
1584 | - $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date'); |
|
1585 | - $this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso'); |
|
1586 | - $this->_template_args['grand_total'] = $transaction->total(); |
|
1587 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
1588 | - // link back to overview |
|
1589 | - $this->_template_args['reg_overview_url'] = REG_ADMIN_URL; |
|
1590 | - $this->_template_args['registration'] = $this->_registration; |
|
1591 | - $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
1592 | - array( |
|
1593 | - 'action' => 'default', |
|
1594 | - 'event_id' => $event_id, |
|
1595 | - ), |
|
1596 | - REG_ADMIN_URL |
|
1597 | - ); |
|
1598 | - $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
1599 | - array( |
|
1600 | - 'action' => 'default', |
|
1601 | - 'EVT_ID' => $event_id, |
|
1602 | - 'page' => 'espresso_transactions', |
|
1603 | - ), |
|
1604 | - admin_url('admin.php') |
|
1605 | - ); |
|
1606 | - $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
1607 | - array( |
|
1608 | - 'page' => 'espresso_events', |
|
1609 | - 'action' => 'edit', |
|
1610 | - 'post' => $event_id, |
|
1611 | - ), |
|
1612 | - admin_url('admin.php') |
|
1613 | - ); |
|
1614 | - // next and previous links |
|
1615 | - $next_reg = $this->_registration->next( |
|
1616 | - null, |
|
1617 | - array(), |
|
1618 | - 'REG_ID' |
|
1619 | - ); |
|
1620 | - $this->_template_args['next_registration'] = $next_reg |
|
1621 | - ? $this->_next_link( |
|
1622 | - EE_Admin_Page::add_query_args_and_nonce( |
|
1623 | - array( |
|
1624 | - 'action' => 'view_registration', |
|
1625 | - '_REG_ID' => $next_reg['REG_ID'], |
|
1626 | - ), |
|
1627 | - REG_ADMIN_URL |
|
1628 | - ), |
|
1629 | - 'dashicons dashicons-arrow-right ee-icon-size-22' |
|
1630 | - ) |
|
1631 | - : ''; |
|
1632 | - $previous_reg = $this->_registration->previous( |
|
1633 | - null, |
|
1634 | - array(), |
|
1635 | - 'REG_ID' |
|
1636 | - ); |
|
1637 | - $this->_template_args['previous_registration'] = $previous_reg |
|
1638 | - ? $this->_previous_link( |
|
1639 | - EE_Admin_Page::add_query_args_and_nonce( |
|
1640 | - array( |
|
1641 | - 'action' => 'view_registration', |
|
1642 | - '_REG_ID' => $previous_reg['REG_ID'], |
|
1643 | - ), |
|
1644 | - REG_ADMIN_URL |
|
1645 | - ), |
|
1646 | - 'dashicons dashicons-arrow-left ee-icon-size-22' |
|
1647 | - ) |
|
1648 | - : ''; |
|
1649 | - // grab header |
|
1650 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php'; |
|
1651 | - $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
1652 | - $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
|
1653 | - $template_path, |
|
1654 | - $this->_template_args, |
|
1655 | - true |
|
1656 | - ); |
|
1657 | - } else { |
|
1658 | - $this->_template_args['admin_page_header'] = $this->display_espresso_notices(); |
|
1659 | - } |
|
1660 | - // the details template wrapper |
|
1661 | - $this->display_admin_page_with_sidebar(); |
|
1662 | - } |
|
1663 | - |
|
1664 | - |
|
1665 | - protected function _registration_details_metaboxes() |
|
1666 | - { |
|
1667 | - do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this); |
|
1668 | - $this->_set_registration_object(); |
|
1669 | - $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null; |
|
1670 | - add_meta_box( |
|
1671 | - 'edit-reg-status-mbox', |
|
1672 | - esc_html__('Registration Status', 'event_espresso'), |
|
1673 | - array($this, 'set_reg_status_buttons_metabox'), |
|
1674 | - $this->wp_page_slug, |
|
1675 | - 'normal', |
|
1676 | - 'high' |
|
1677 | - ); |
|
1678 | - add_meta_box( |
|
1679 | - 'edit-reg-details-mbox', |
|
1680 | - esc_html__('Registration Details', 'event_espresso'), |
|
1681 | - array($this, '_reg_details_meta_box'), |
|
1682 | - $this->wp_page_slug, |
|
1683 | - 'normal', |
|
1684 | - 'high' |
|
1685 | - ); |
|
1686 | - if ($attendee instanceof EE_Attendee |
|
1687 | - && EE_Registry::instance()->CAP->current_user_can( |
|
1688 | - 'ee_read_registration', |
|
1689 | - 'edit-reg-questions-mbox', |
|
1690 | - $this->_registration->ID() |
|
1691 | - ) |
|
1692 | - ) { |
|
1693 | - add_meta_box( |
|
1694 | - 'edit-reg-questions-mbox', |
|
1695 | - esc_html__('Registration Form Answers', 'event_espresso'), |
|
1696 | - array($this, '_reg_questions_meta_box'), |
|
1697 | - $this->wp_page_slug, |
|
1698 | - 'normal', |
|
1699 | - 'high' |
|
1700 | - ); |
|
1701 | - } |
|
1702 | - add_meta_box( |
|
1703 | - 'edit-reg-registrant-mbox', |
|
1704 | - esc_html__('Contact Details', 'event_espresso'), |
|
1705 | - array($this, '_reg_registrant_side_meta_box'), |
|
1706 | - $this->wp_page_slug, |
|
1707 | - 'side', |
|
1708 | - 'high' |
|
1709 | - ); |
|
1710 | - if ($this->_registration->group_size() > 1) { |
|
1711 | - add_meta_box( |
|
1712 | - 'edit-reg-attendees-mbox', |
|
1713 | - esc_html__('Other Registrations in this Transaction', 'event_espresso'), |
|
1714 | - array($this, '_reg_attendees_meta_box'), |
|
1715 | - $this->wp_page_slug, |
|
1716 | - 'normal', |
|
1717 | - 'high' |
|
1718 | - ); |
|
1719 | - } |
|
1720 | - } |
|
1721 | - |
|
1722 | - |
|
1723 | - /** |
|
1724 | - * set_reg_status_buttons_metabox |
|
1725 | - * |
|
1726 | - * @access protected |
|
1727 | - * @return string |
|
1728 | - * @throws \EE_Error |
|
1729 | - */ |
|
1730 | - public function set_reg_status_buttons_metabox() |
|
1731 | - { |
|
1732 | - $this->_set_registration_object(); |
|
1733 | - $change_reg_status_form = $this->_generate_reg_status_change_form(); |
|
1734 | - echo $change_reg_status_form->form_open( |
|
1735 | - self::add_query_args_and_nonce( |
|
1736 | - array( |
|
1737 | - 'action' => 'change_reg_status', |
|
1738 | - ), |
|
1739 | - REG_ADMIN_URL |
|
1740 | - ) |
|
1741 | - ); |
|
1742 | - echo $change_reg_status_form->get_html(); |
|
1743 | - echo $change_reg_status_form->form_close(); |
|
1744 | - } |
|
1745 | - |
|
1746 | - |
|
1747 | - /** |
|
1748 | - * @return EE_Form_Section_Proper |
|
1749 | - * @throws EE_Error |
|
1750 | - * @throws InvalidArgumentException |
|
1751 | - * @throws InvalidDataTypeException |
|
1752 | - * @throws InvalidInterfaceException |
|
1753 | - * @throws \EventEspresso\core\exceptions\EntityNotFoundException |
|
1754 | - */ |
|
1755 | - protected function _generate_reg_status_change_form() |
|
1756 | - { |
|
1757 | - $reg_status_change_form_array = array( |
|
1758 | - 'name' => 'reg_status_change_form', |
|
1759 | - 'html_id' => 'reg-status-change-form', |
|
1760 | - 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
1761 | - 'subsections' => array( |
|
1762 | - 'return' => new EE_Hidden_Input( |
|
1763 | - array( |
|
1764 | - 'name' => 'return', |
|
1765 | - 'default' => 'view_registration', |
|
1766 | - ) |
|
1767 | - ), |
|
1768 | - 'REG_ID' => new EE_Hidden_Input( |
|
1769 | - array( |
|
1770 | - 'name' => 'REG_ID', |
|
1771 | - 'default' => $this->_registration->ID(), |
|
1772 | - ) |
|
1773 | - ), |
|
1774 | - 'current_status' => new EE_Form_Section_HTML( |
|
1775 | - EEH_HTML::tr( |
|
1776 | - EEH_HTML::th( |
|
1777 | - EEH_HTML::label( |
|
1778 | - EEH_HTML::strong( |
|
1779 | - esc_html__('Current Registration Status', 'event_espresso') |
|
1780 | - ) |
|
1781 | - ) |
|
1782 | - ) |
|
1783 | - . EEH_HTML::td( |
|
1784 | - EEH_HTML::strong( |
|
1785 | - $this->_registration->pretty_status(), |
|
1786 | - '', |
|
1787 | - 'status-' . $this->_registration->status_ID(), |
|
1788 | - 'line-height: 1em; font-size: 1.5em; font-weight: bold;' |
|
1789 | - ) |
|
1790 | - ) |
|
1791 | - ) |
|
1792 | - ) |
|
1793 | - ) |
|
1794 | - ); |
|
1795 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
1796 | - 'ee_edit_registration', |
|
1797 | - 'toggle_registration_status', |
|
1798 | - $this->_registration->ID() |
|
1799 | - )) { |
|
1800 | - $reg_status_change_form_array['subsections']['reg_status'] = new EE_Select_Input( |
|
1801 | - $this->_get_reg_statuses(), |
|
1802 | - array( |
|
1803 | - 'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'), |
|
1804 | - 'default' => $this->_registration->status_ID(), |
|
1805 | - ) |
|
1806 | - ); |
|
1807 | - $reg_status_change_form_array['subsections']['send_notifications'] = new EE_Yes_No_Input( |
|
1808 | - array( |
|
1809 | - 'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'), |
|
1810 | - 'default' => false, |
|
1811 | - 'html_help_text' => esc_html__( |
|
1812 | - 'If set to "Yes", then the related messages will be sent to the registrant.', |
|
1813 | - 'event_espresso' |
|
1814 | - ) |
|
1815 | - ) |
|
1816 | - ); |
|
1817 | - $reg_status_change_form_array['subsections']['submit'] = new EE_Submit_Input( |
|
1818 | - array( |
|
1819 | - 'html_class' => 'button-primary', |
|
1820 | - 'html_label_text' => ' ', |
|
1821 | - 'default' => esc_html__('Update Registration Status', 'event_espresso'), |
|
1822 | - ) |
|
1823 | - ); |
|
1824 | - } |
|
1825 | - return new EE_Form_Section_Proper($reg_status_change_form_array); |
|
1826 | - } |
|
1827 | - |
|
1828 | - |
|
1829 | - /** |
|
1830 | - * Returns an array of all the buttons for the various statuses and switch status actions |
|
1831 | - * |
|
1832 | - * @return array |
|
1833 | - * @throws EE_Error |
|
1834 | - * @throws InvalidArgumentException |
|
1835 | - * @throws InvalidDataTypeException |
|
1836 | - * @throws InvalidInterfaceException |
|
1837 | - * @throws EntityNotFoundException |
|
1838 | - */ |
|
1839 | - protected function _get_reg_statuses() |
|
1840 | - { |
|
1841 | - $reg_status_array = EEM_Registration::instance()->reg_status_array(); |
|
1842 | - unset($reg_status_array[ EEM_Registration::status_id_incomplete ]); |
|
1843 | - // get current reg status |
|
1844 | - $current_status = $this->_registration->status_ID(); |
|
1845 | - // is registration for free event? This will determine whether to display the pending payment option |
|
1846 | - if ($current_status !== EEM_Registration::status_id_pending_payment |
|
1847 | - && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00) |
|
1848 | - ) { |
|
1849 | - unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]); |
|
1850 | - } |
|
1851 | - return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence'); |
|
1852 | - } |
|
1853 | - |
|
1854 | - |
|
1855 | - /** |
|
1856 | - * This method is used when using _REG_ID from request which may or may not be an array of reg_ids. |
|
1857 | - * |
|
1858 | - * @param bool $status REG status given for changing registrations to. |
|
1859 | - * @param bool $notify Whether to send messages notifications or not. |
|
1860 | - * @return array (array with reg_id(s) updated and whether update was successful. |
|
1861 | - * @throws EE_Error |
|
1862 | - * @throws InvalidArgumentException |
|
1863 | - * @throws InvalidDataTypeException |
|
1864 | - * @throws InvalidInterfaceException |
|
1865 | - * @throws ReflectionException |
|
1866 | - * @throws RuntimeException |
|
1867 | - * @throws EntityNotFoundException |
|
1868 | - */ |
|
1869 | - protected function _set_registration_status_from_request($status = false, $notify = false) |
|
1870 | - { |
|
1871 | - if (isset($this->_req_data['reg_status_change_form'])) { |
|
1872 | - $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID']) |
|
1873 | - ? (array) $this->_req_data['reg_status_change_form']['REG_ID'] |
|
1874 | - : array(); |
|
1875 | - } else { |
|
1876 | - $REG_IDs = isset($this->_req_data['_REG_ID']) |
|
1877 | - ? (array) $this->_req_data['_REG_ID'] |
|
1878 | - : array(); |
|
1879 | - } |
|
1880 | - // sanitize $REG_IDs |
|
1881 | - $REG_IDs = array_map('absint', $REG_IDs); |
|
1882 | - // and remove empty entries |
|
1883 | - $REG_IDs = array_filter($REG_IDs); |
|
1884 | - |
|
1885 | - $result = $this->_set_registration_status($REG_IDs, $status, $notify); |
|
1886 | - |
|
1887 | - /** |
|
1888 | - * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications. |
|
1889 | - * Currently this value is used downstream by the _process_resend_registration method. |
|
1890 | - * |
|
1891 | - * @param int|array $registration_ids The registration ids that have had their status changed successfully. |
|
1892 | - * @param bool $status The status registrations were changed to. |
|
1893 | - * @param bool $success If the status was changed successfully for all registrations. |
|
1894 | - * @param Registrations_Admin_Page $admin_page_object |
|
1895 | - */ |
|
1896 | - $this->_req_data['_REG_ID'] = apply_filters( |
|
1897 | - 'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs', |
|
1898 | - $result['REG_ID'], |
|
1899 | - $status, |
|
1900 | - $result['success'], |
|
1901 | - $this |
|
1902 | - ); |
|
1903 | - |
|
1904 | - // notify? |
|
1905 | - if ($notify |
|
1906 | - && $result['success'] |
|
1907 | - && ! empty($this->_req_data['_REG_ID']) |
|
1908 | - && EE_Registry::instance()->CAP->current_user_can( |
|
1909 | - 'ee_send_message', |
|
1910 | - 'espresso_registrations_resend_registration' |
|
1911 | - ) |
|
1912 | - ) { |
|
1913 | - $this->_process_resend_registration(); |
|
1914 | - } |
|
1915 | - return $result; |
|
1916 | - } |
|
1917 | - |
|
1918 | - |
|
1919 | - /** |
|
1920 | - * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an |
|
1921 | - * array). Note, this method does NOT take care of possible notifications. That is required by calling code. |
|
1922 | - * |
|
1923 | - * @param array $REG_IDs |
|
1924 | - * @param string $status |
|
1925 | - * @param bool $notify Used to indicate whether notification was requested or not. This determines the context |
|
1926 | - * slug sent with setting the registration status. |
|
1927 | - * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as |
|
1928 | - * @throws EE_Error |
|
1929 | - * @throws InvalidArgumentException |
|
1930 | - * @throws InvalidDataTypeException |
|
1931 | - * @throws InvalidInterfaceException |
|
1932 | - * @throws ReflectionException |
|
1933 | - * @throws RuntimeException |
|
1934 | - * @throws EntityNotFoundException |
|
1935 | - */ |
|
1936 | - protected function _set_registration_status($REG_IDs = array(), $status = '', $notify = false) |
|
1937 | - { |
|
1938 | - $success = false; |
|
1939 | - // typecast $REG_IDs |
|
1940 | - $REG_IDs = (array) $REG_IDs; |
|
1941 | - if (! empty($REG_IDs)) { |
|
1942 | - $success = true; |
|
1943 | - // set default status if none is passed |
|
1944 | - $status = $status ? $status : EEM_Registration::status_id_pending_payment; |
|
1945 | - $status_context = $notify |
|
1946 | - ? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY |
|
1947 | - : Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN; |
|
1948 | - // loop through REG_ID's and change status |
|
1949 | - foreach ($REG_IDs as $REG_ID) { |
|
1950 | - $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
1951 | - if ($registration instanceof EE_Registration) { |
|
1952 | - $registration->set_status( |
|
1953 | - $status, |
|
1954 | - false, |
|
1955 | - new Context( |
|
1956 | - $status_context, |
|
1957 | - esc_html__( |
|
1958 | - 'Manually triggered status change on a Registration Admin Page route.', |
|
1959 | - 'event_espresso' |
|
1960 | - ) |
|
1961 | - ) |
|
1962 | - ); |
|
1963 | - $result = $registration->save(); |
|
1964 | - // verifying explicit fails because update *may* just return 0 for 0 rows affected |
|
1965 | - $success = $result !== false ? $success : false; |
|
1966 | - } |
|
1967 | - } |
|
1968 | - } |
|
1969 | - |
|
1970 | - // return $success and processed registrations |
|
1971 | - return array('REG_ID' => $REG_IDs, 'success' => $success); |
|
1972 | - } |
|
1973 | - |
|
1974 | - |
|
1975 | - /** |
|
1976 | - * Common logic for setting up success message and redirecting to appropriate route |
|
1977 | - * |
|
1978 | - * @param string $STS_ID status id for the registration changed to |
|
1979 | - * @param bool $notify indicates whether the _set_registration_status_from_request does notifications or not. |
|
1980 | - * @return void |
|
1981 | - * @throws EE_Error |
|
1982 | - */ |
|
1983 | - protected function _reg_status_change_return($STS_ID, $notify = false) |
|
1984 | - { |
|
1985 | - $result = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify) |
|
1986 | - : array('success' => false); |
|
1987 | - $success = isset($result['success']) && $result['success']; |
|
1988 | - // setup success message |
|
1989 | - if ($success) { |
|
1990 | - if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) { |
|
1991 | - $msg = sprintf( |
|
1992 | - esc_html__('Registration status has been set to %s', 'event_espresso'), |
|
1993 | - EEH_Template::pretty_status($STS_ID, false, 'lower') |
|
1994 | - ); |
|
1995 | - } else { |
|
1996 | - $msg = sprintf( |
|
1997 | - esc_html__('Registrations have been set to %s.', 'event_espresso'), |
|
1998 | - EEH_Template::pretty_status($STS_ID, false, 'lower') |
|
1999 | - ); |
|
2000 | - } |
|
2001 | - EE_Error::add_success($msg); |
|
2002 | - } else { |
|
2003 | - EE_Error::add_error( |
|
2004 | - esc_html__( |
|
2005 | - 'Something went wrong, and the status was not changed', |
|
2006 | - 'event_espresso' |
|
2007 | - ), |
|
2008 | - __FILE__, |
|
2009 | - __LINE__, |
|
2010 | - __FUNCTION__ |
|
2011 | - ); |
|
2012 | - } |
|
2013 | - if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') { |
|
2014 | - $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID'])); |
|
2015 | - } else { |
|
2016 | - $route = array('action' => 'default'); |
|
2017 | - } |
|
2018 | - $route = $this->mergeExistingRequestParamsWithRedirectArgs($route); |
|
2019 | - $this->_redirect_after_action($success, '', '', $route, true); |
|
2020 | - } |
|
2021 | - |
|
2022 | - |
|
2023 | - /** |
|
2024 | - * incoming reg status change from reg details page. |
|
2025 | - * |
|
2026 | - * @return void |
|
2027 | - */ |
|
2028 | - protected function _change_reg_status() |
|
2029 | - { |
|
2030 | - $this->_req_data['return'] = 'view_registration'; |
|
2031 | - // set notify based on whether the send notifications toggle is set or not |
|
2032 | - $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']); |
|
2033 | - // $notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] ); |
|
2034 | - $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status']) |
|
2035 | - ? $this->_req_data['reg_status_change_form']['reg_status'] : ''; |
|
2036 | - switch ($this->_req_data['reg_status_change_form']['reg_status']) { |
|
2037 | - case EEM_Registration::status_id_approved: |
|
2038 | - case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'): |
|
2039 | - $this->approve_registration($notify); |
|
2040 | - break; |
|
2041 | - case EEM_Registration::status_id_pending_payment: |
|
2042 | - case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'): |
|
2043 | - $this->pending_registration($notify); |
|
2044 | - break; |
|
2045 | - case EEM_Registration::status_id_not_approved: |
|
2046 | - case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'): |
|
2047 | - $this->not_approve_registration($notify); |
|
2048 | - break; |
|
2049 | - case EEM_Registration::status_id_declined: |
|
2050 | - case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'): |
|
2051 | - $this->decline_registration($notify); |
|
2052 | - break; |
|
2053 | - case EEM_Registration::status_id_cancelled: |
|
2054 | - case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'): |
|
2055 | - $this->cancel_registration($notify); |
|
2056 | - break; |
|
2057 | - case EEM_Registration::status_id_wait_list: |
|
2058 | - case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'): |
|
2059 | - $this->wait_list_registration($notify); |
|
2060 | - break; |
|
2061 | - case EEM_Registration::status_id_incomplete: |
|
2062 | - default: |
|
2063 | - $result['success'] = false; |
|
2064 | - unset($this->_req_data['return']); |
|
2065 | - $this->_reg_status_change_return('', false); |
|
2066 | - break; |
|
2067 | - } |
|
2068 | - } |
|
2069 | - |
|
2070 | - |
|
2071 | - /** |
|
2072 | - * Callback for bulk action routes. |
|
2073 | - * Note: although we could just register the singular route callbacks for each bulk action route as well, this |
|
2074 | - * method was chosen so there is one central place all the registration status bulk actions are going through. |
|
2075 | - * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to |
|
2076 | - * when an action is happening on just a single registration). |
|
2077 | - * |
|
2078 | - * @param $action |
|
2079 | - * @param bool $notify |
|
2080 | - */ |
|
2081 | - protected function bulk_action_on_registrations($action, $notify = false) |
|
2082 | - { |
|
2083 | - do_action( |
|
2084 | - 'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution', |
|
2085 | - $this, |
|
2086 | - $action, |
|
2087 | - $notify |
|
2088 | - ); |
|
2089 | - $method = $action . '_registration'; |
|
2090 | - if (method_exists($this, $method)) { |
|
2091 | - $this->$method($notify); |
|
2092 | - } |
|
2093 | - } |
|
2094 | - |
|
2095 | - |
|
2096 | - /** |
|
2097 | - * approve_registration |
|
2098 | - * |
|
2099 | - * @access protected |
|
2100 | - * @param bool $notify whether or not to notify the registrant about their approval. |
|
2101 | - * @return void |
|
2102 | - */ |
|
2103 | - protected function approve_registration($notify = false) |
|
2104 | - { |
|
2105 | - $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify); |
|
2106 | - } |
|
2107 | - |
|
2108 | - |
|
2109 | - /** |
|
2110 | - * decline_registration |
|
2111 | - * |
|
2112 | - * @access protected |
|
2113 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
2114 | - * @return void |
|
2115 | - */ |
|
2116 | - protected function decline_registration($notify = false) |
|
2117 | - { |
|
2118 | - $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify); |
|
2119 | - } |
|
2120 | - |
|
2121 | - |
|
2122 | - /** |
|
2123 | - * cancel_registration |
|
2124 | - * |
|
2125 | - * @access protected |
|
2126 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
2127 | - * @return void |
|
2128 | - */ |
|
2129 | - protected function cancel_registration($notify = false) |
|
2130 | - { |
|
2131 | - $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify); |
|
2132 | - } |
|
2133 | - |
|
2134 | - |
|
2135 | - /** |
|
2136 | - * not_approve_registration |
|
2137 | - * |
|
2138 | - * @access protected |
|
2139 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
2140 | - * @return void |
|
2141 | - */ |
|
2142 | - protected function not_approve_registration($notify = false) |
|
2143 | - { |
|
2144 | - $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify); |
|
2145 | - } |
|
2146 | - |
|
2147 | - |
|
2148 | - /** |
|
2149 | - * decline_registration |
|
2150 | - * |
|
2151 | - * @access protected |
|
2152 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
2153 | - * @return void |
|
2154 | - */ |
|
2155 | - protected function pending_registration($notify = false) |
|
2156 | - { |
|
2157 | - $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify); |
|
2158 | - } |
|
2159 | - |
|
2160 | - |
|
2161 | - /** |
|
2162 | - * waitlist_registration |
|
2163 | - * |
|
2164 | - * @access protected |
|
2165 | - * @param bool $notify whether or not to notify the registrant about their status change. |
|
2166 | - * @return void |
|
2167 | - */ |
|
2168 | - protected function wait_list_registration($notify = false) |
|
2169 | - { |
|
2170 | - $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify); |
|
2171 | - } |
|
2172 | - |
|
2173 | - |
|
2174 | - /** |
|
2175 | - * generates HTML for the Registration main meta box |
|
2176 | - * |
|
2177 | - * @access public |
|
2178 | - * @return void |
|
2179 | - * @throws DomainException |
|
2180 | - * @throws EE_Error |
|
2181 | - * @throws InvalidArgumentException |
|
2182 | - * @throws InvalidDataTypeException |
|
2183 | - * @throws InvalidInterfaceException |
|
2184 | - * @throws ReflectionException |
|
2185 | - * @throws EntityNotFoundException |
|
2186 | - */ |
|
2187 | - public function _reg_details_meta_box() |
|
2188 | - { |
|
2189 | - EEH_Autoloader::register_line_item_display_autoloaders(); |
|
2190 | - EEH_Autoloader::register_line_item_filter_autoloaders(); |
|
2191 | - EE_Registry::instance()->load_helper('Line_Item'); |
|
2192 | - $transaction = $this->_registration->transaction() ? $this->_registration->transaction() |
|
2193 | - : EE_Transaction::new_instance(); |
|
2194 | - $this->_session = $transaction->session_data(); |
|
2195 | - $filters = new EE_Line_Item_Filter_Collection(); |
|
2196 | - // $filters->add( new EE_Non_Zero_Line_Item_Filter() ); |
|
2197 | - $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration)); |
|
2198 | - $line_item_filter_processor = new EE_Line_Item_Filter_Processor( |
|
2199 | - $filters, |
|
2200 | - $transaction->total_line_item() |
|
2201 | - ); |
|
2202 | - $filtered_line_item_tree = $line_item_filter_processor->process(); |
|
2203 | - $line_item_display = new EE_Line_Item_Display( |
|
2204 | - 'reg_admin_table', |
|
2205 | - 'EE_Admin_Table_Registration_Line_Item_Display_Strategy' |
|
2206 | - ); |
|
2207 | - $this->_template_args['line_item_table'] = $line_item_display->display_line_item( |
|
2208 | - $filtered_line_item_tree, |
|
2209 | - array('EE_Registration' => $this->_registration) |
|
2210 | - ); |
|
2211 | - $attendee = $this->_registration->attendee(); |
|
2212 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
2213 | - 'ee_read_transaction', |
|
2214 | - 'espresso_transactions_view_transaction' |
|
2215 | - )) { |
|
2216 | - $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link( |
|
2217 | - EE_Admin_Page::add_query_args_and_nonce( |
|
2218 | - array( |
|
2219 | - 'action' => 'view_transaction', |
|
2220 | - 'TXN_ID' => $transaction->ID(), |
|
2221 | - ), |
|
2222 | - TXN_ADMIN_URL |
|
2223 | - ), |
|
2224 | - esc_html__(' View Transaction', 'event_espresso'), |
|
2225 | - 'button secondary-button right', |
|
2226 | - 'dashicons dashicons-cart' |
|
2227 | - ); |
|
2228 | - } else { |
|
2229 | - $this->_template_args['view_transaction_button'] = ''; |
|
2230 | - } |
|
2231 | - if ($attendee instanceof EE_Attendee |
|
2232 | - && EE_Registry::instance()->CAP->current_user_can( |
|
2233 | - 'ee_send_message', |
|
2234 | - 'espresso_registrations_resend_registration' |
|
2235 | - ) |
|
2236 | - ) { |
|
2237 | - $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link( |
|
2238 | - EE_Admin_Page::add_query_args_and_nonce( |
|
2239 | - array( |
|
2240 | - 'action' => 'resend_registration', |
|
2241 | - '_REG_ID' => $this->_registration->ID(), |
|
2242 | - 'redirect_to' => 'view_registration', |
|
2243 | - ), |
|
2244 | - REG_ADMIN_URL |
|
2245 | - ), |
|
2246 | - esc_html__(' Resend Registration', 'event_espresso'), |
|
2247 | - 'button secondary-button right', |
|
2248 | - 'dashicons dashicons-email-alt' |
|
2249 | - ); |
|
2250 | - } else { |
|
2251 | - $this->_template_args['resend_registration_button'] = ''; |
|
2252 | - } |
|
2253 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
2254 | - $payment = $transaction->get_first_related('Payment'); |
|
2255 | - $payment = ! $payment instanceof EE_Payment |
|
2256 | - ? EE_Payment::new_instance() |
|
2257 | - : $payment; |
|
2258 | - $payment_method = $payment->get_first_related('Payment_Method'); |
|
2259 | - $payment_method = ! $payment_method instanceof EE_Payment_Method |
|
2260 | - ? EE_Payment_Method::new_instance() |
|
2261 | - : $payment_method; |
|
2262 | - $reg_details = array( |
|
2263 | - 'payment_method' => $payment_method->name(), |
|
2264 | - 'response_msg' => $payment->gateway_response(), |
|
2265 | - 'registration_id' => $this->_registration->get('REG_code'), |
|
2266 | - 'registration_session' => $this->_registration->session_ID(), |
|
2267 | - 'ip_address' => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '', |
|
2268 | - 'user_agent' => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '', |
|
2269 | - ); |
|
2270 | - if (isset($reg_details['registration_id'])) { |
|
2271 | - $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id']; |
|
2272 | - $this->_template_args['reg_details']['registration_id']['label'] = esc_html__( |
|
2273 | - 'Registration ID', |
|
2274 | - 'event_espresso' |
|
2275 | - ); |
|
2276 | - $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text'; |
|
2277 | - } |
|
2278 | - if (isset($reg_details['payment_method'])) { |
|
2279 | - $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method']; |
|
2280 | - $this->_template_args['reg_details']['payment_method']['label'] = esc_html__( |
|
2281 | - 'Most Recent Payment Method', |
|
2282 | - 'event_espresso' |
|
2283 | - ); |
|
2284 | - $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text'; |
|
2285 | - $this->_template_args['reg_details']['response_msg']['value'] = $reg_details['response_msg']; |
|
2286 | - $this->_template_args['reg_details']['response_msg']['label'] = esc_html__( |
|
2287 | - 'Payment method response', |
|
2288 | - 'event_espresso' |
|
2289 | - ); |
|
2290 | - $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text'; |
|
2291 | - } |
|
2292 | - $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session']; |
|
2293 | - $this->_template_args['reg_details']['registration_session']['label'] = esc_html__( |
|
2294 | - 'Registration Session', |
|
2295 | - 'event_espresso' |
|
2296 | - ); |
|
2297 | - $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text'; |
|
2298 | - $this->_template_args['reg_details']['ip_address']['value'] = $reg_details['ip_address']; |
|
2299 | - $this->_template_args['reg_details']['ip_address']['label'] = esc_html__( |
|
2300 | - 'Registration placed from IP', |
|
2301 | - 'event_espresso' |
|
2302 | - ); |
|
2303 | - $this->_template_args['reg_details']['ip_address']['class'] = 'regular-text'; |
|
2304 | - $this->_template_args['reg_details']['user_agent']['value'] = $reg_details['user_agent']; |
|
2305 | - $this->_template_args['reg_details']['user_agent']['label'] = esc_html__( |
|
2306 | - 'Registrant User Agent', |
|
2307 | - 'event_espresso' |
|
2308 | - ); |
|
2309 | - $this->_template_args['reg_details']['user_agent']['class'] = 'large-text'; |
|
2310 | - $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
2311 | - array( |
|
2312 | - 'action' => 'default', |
|
2313 | - 'event_id' => $this->_registration->event_ID(), |
|
2314 | - ), |
|
2315 | - REG_ADMIN_URL |
|
2316 | - ); |
|
2317 | - $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
2318 | - $this->_template_args['event_id'] = $this->_registration->event_ID(); |
|
2319 | - $template_path = |
|
2320 | - REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php'; |
|
2321 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
2322 | - } |
|
2323 | - |
|
2324 | - |
|
2325 | - /** |
|
2326 | - * generates HTML for the Registration Questions meta box. |
|
2327 | - * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters), |
|
2328 | - * otherwise uses new forms system |
|
2329 | - * |
|
2330 | - * @access public |
|
2331 | - * @return void |
|
2332 | - * @throws DomainException |
|
2333 | - * @throws EE_Error |
|
2334 | - */ |
|
2335 | - public function _reg_questions_meta_box() |
|
2336 | - { |
|
2337 | - // allow someone to override this method entirely |
|
2338 | - if (apply_filters( |
|
2339 | - 'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', |
|
2340 | - true, |
|
2341 | - $this, |
|
2342 | - $this->_registration |
|
2343 | - )) { |
|
2344 | - $form = $this->_get_reg_custom_questions_form( |
|
2345 | - $this->_registration->ID() |
|
2346 | - ); |
|
2347 | - $this->_template_args['att_questions'] = count($form->subforms()) > 0 |
|
2348 | - ? $form->get_html_and_js() |
|
2349 | - : ''; |
|
2350 | - $this->_template_args['reg_questions_form_action'] = 'edit_registration'; |
|
2351 | - $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
2352 | - $template_path = |
|
2353 | - REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
2354 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
2355 | - } |
|
2356 | - } |
|
2357 | - |
|
2358 | - |
|
2359 | - /** |
|
2360 | - * form_before_question_group |
|
2361 | - * |
|
2362 | - * @deprecated as of 4.8.32.rc.000 |
|
2363 | - * @access public |
|
2364 | - * @param string $output |
|
2365 | - * @return string |
|
2366 | - */ |
|
2367 | - public function form_before_question_group($output) |
|
2368 | - { |
|
2369 | - EE_Error::doing_it_wrong( |
|
2370 | - __CLASS__ . '::' . __FUNCTION__, |
|
2371 | - esc_html__( |
|
2372 | - 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
2373 | - 'event_espresso' |
|
2374 | - ), |
|
2375 | - '4.8.32.rc.000' |
|
2376 | - ); |
|
2377 | - return ' |
|
1301 | + if (! empty($registration_status)) { |
|
1302 | + $where['STS_ID'] = $registration_status; |
|
1303 | + } else { |
|
1304 | + // make sure we exclude incomplete registrations, but only if not trashed. |
|
1305 | + if ($view === 'trash') { |
|
1306 | + $where['REG_deleted'] = true; |
|
1307 | + } elseif ($view === 'incomplete') { |
|
1308 | + $where['STS_ID'] = EEM_Registration::status_id_incomplete; |
|
1309 | + } else { |
|
1310 | + $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete); |
|
1311 | + } |
|
1312 | + } |
|
1313 | + return $where; |
|
1314 | + } |
|
1315 | + |
|
1316 | + |
|
1317 | + /** |
|
1318 | + * Adds any provided date restraints to the where conditions for the registrations query. |
|
1319 | + * |
|
1320 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
1321 | + * @return array |
|
1322 | + * @throws EE_Error |
|
1323 | + * @throws InvalidArgumentException |
|
1324 | + * @throws InvalidDataTypeException |
|
1325 | + * @throws InvalidInterfaceException |
|
1326 | + */ |
|
1327 | + protected function _add_date_to_where_conditions(array $request) |
|
1328 | + { |
|
1329 | + $where = array(); |
|
1330 | + $view = EEH_Array::is_set($request, 'status', ''); |
|
1331 | + $month_range = ! empty($request['month_range']) |
|
1332 | + ? sanitize_text_field($request['month_range']) |
|
1333 | + : ''; |
|
1334 | + $retrieve_for_today = $view === 'today'; |
|
1335 | + $retrieve_for_this_month = $view === 'month'; |
|
1336 | + |
|
1337 | + if ($retrieve_for_today) { |
|
1338 | + $now = date('Y-m-d', current_time('timestamp')); |
|
1339 | + $where['REG_date'] = array( |
|
1340 | + 'BETWEEN', |
|
1341 | + array( |
|
1342 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
1343 | + 'REG_date', |
|
1344 | + $now . ' 00:00:00', |
|
1345 | + 'Y-m-d H:i:s' |
|
1346 | + ), |
|
1347 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
1348 | + 'REG_date', |
|
1349 | + $now . ' 23:59:59', |
|
1350 | + 'Y-m-d H:i:s' |
|
1351 | + ), |
|
1352 | + ), |
|
1353 | + ); |
|
1354 | + } elseif ($retrieve_for_this_month) { |
|
1355 | + $current_year_and_month = date('Y-m', current_time('timestamp')); |
|
1356 | + $days_this_month = date('t', current_time('timestamp')); |
|
1357 | + $where['REG_date'] = array( |
|
1358 | + 'BETWEEN', |
|
1359 | + array( |
|
1360 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
1361 | + 'REG_date', |
|
1362 | + $current_year_and_month . '-01 00:00:00', |
|
1363 | + 'Y-m-d H:i:s' |
|
1364 | + ), |
|
1365 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
1366 | + 'REG_date', |
|
1367 | + $current_year_and_month . '-' . $days_this_month . ' 23:59:59', |
|
1368 | + 'Y-m-d H:i:s' |
|
1369 | + ), |
|
1370 | + ), |
|
1371 | + ); |
|
1372 | + } elseif ($month_range) { |
|
1373 | + $pieces = explode(' ', $month_range, 3); |
|
1374 | + $month_requested = ! empty($pieces[0]) |
|
1375 | + ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) |
|
1376 | + : ''; |
|
1377 | + $year_requested = ! empty($pieces[1]) |
|
1378 | + ? $pieces[1] |
|
1379 | + : ''; |
|
1380 | + // if there is not a month or year then we can't go further |
|
1381 | + if ($month_requested && $year_requested) { |
|
1382 | + $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01')); |
|
1383 | + $where['REG_date'] = array( |
|
1384 | + 'BETWEEN', |
|
1385 | + array( |
|
1386 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
1387 | + 'REG_date', |
|
1388 | + $year_requested . '-' . $month_requested . '-01 00:00:00', |
|
1389 | + 'Y-m-d H:i:s' |
|
1390 | + ), |
|
1391 | + EEM_Registration::instance()->convert_datetime_for_query( |
|
1392 | + 'REG_date', |
|
1393 | + $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59', |
|
1394 | + 'Y-m-d H:i:s' |
|
1395 | + ), |
|
1396 | + ), |
|
1397 | + ); |
|
1398 | + } |
|
1399 | + } |
|
1400 | + return $where; |
|
1401 | + } |
|
1402 | + |
|
1403 | + |
|
1404 | + /** |
|
1405 | + * Adds any provided search restraints to the where conditions for the registrations query |
|
1406 | + * |
|
1407 | + * @param array $request usually the same as $this->_req_data but not necessarily |
|
1408 | + * @return array |
|
1409 | + */ |
|
1410 | + protected function _add_search_to_where_conditions(array $request) |
|
1411 | + { |
|
1412 | + $where = array(); |
|
1413 | + if (! empty($request['s'])) { |
|
1414 | + $search_string = '%' . sanitize_text_field($request['s']) . '%'; |
|
1415 | + $where['OR*search_conditions'] = array( |
|
1416 | + 'Event.EVT_name' => array('LIKE', $search_string), |
|
1417 | + 'Event.EVT_desc' => array('LIKE', $search_string), |
|
1418 | + 'Event.EVT_short_desc' => array('LIKE', $search_string), |
|
1419 | + 'Attendee.ATT_full_name' => array('LIKE', $search_string), |
|
1420 | + 'Attendee.ATT_fname' => array('LIKE', $search_string), |
|
1421 | + 'Attendee.ATT_lname' => array('LIKE', $search_string), |
|
1422 | + 'Attendee.ATT_short_bio' => array('LIKE', $search_string), |
|
1423 | + 'Attendee.ATT_email' => array('LIKE', $search_string), |
|
1424 | + 'Attendee.ATT_address' => array('LIKE', $search_string), |
|
1425 | + 'Attendee.ATT_address2' => array('LIKE', $search_string), |
|
1426 | + 'Attendee.ATT_city' => array('LIKE', $search_string), |
|
1427 | + 'REG_final_price' => array('LIKE', $search_string), |
|
1428 | + 'REG_code' => array('LIKE', $search_string), |
|
1429 | + 'REG_count' => array('LIKE', $search_string), |
|
1430 | + 'REG_group_size' => array('LIKE', $search_string), |
|
1431 | + 'Ticket.TKT_name' => array('LIKE', $search_string), |
|
1432 | + 'Ticket.TKT_description' => array('LIKE', $search_string), |
|
1433 | + 'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string), |
|
1434 | + ); |
|
1435 | + } |
|
1436 | + return $where; |
|
1437 | + } |
|
1438 | + |
|
1439 | + |
|
1440 | + /** |
|
1441 | + * Sets up the where conditions for the registrations query. |
|
1442 | + * |
|
1443 | + * @param array $request |
|
1444 | + * @return array |
|
1445 | + * @throws EE_Error |
|
1446 | + */ |
|
1447 | + protected function _get_where_conditions_for_registrations_query($request) |
|
1448 | + { |
|
1449 | + return apply_filters( |
|
1450 | + 'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query', |
|
1451 | + array_merge( |
|
1452 | + $this->addAttendeeIdToWhereConditions($request), |
|
1453 | + $this->_add_event_id_to_where_conditions($request), |
|
1454 | + $this->_add_category_id_to_where_conditions($request), |
|
1455 | + $this->_add_datetime_id_to_where_conditions($request), |
|
1456 | + $this->_add_registration_status_to_where_conditions($request), |
|
1457 | + $this->_add_date_to_where_conditions($request), |
|
1458 | + $this->_add_search_to_where_conditions($request) |
|
1459 | + ), |
|
1460 | + $request |
|
1461 | + ); |
|
1462 | + } |
|
1463 | + |
|
1464 | + |
|
1465 | + /** |
|
1466 | + * Sets up the orderby for the registrations query. |
|
1467 | + * |
|
1468 | + * @return array |
|
1469 | + */ |
|
1470 | + protected function _get_orderby_for_registrations_query() |
|
1471 | + { |
|
1472 | + $orderby_field = ! empty($this->_req_data['orderby']) |
|
1473 | + ? sanitize_text_field($this->_req_data['orderby']) |
|
1474 | + : '_REG_date'; |
|
1475 | + switch ($orderby_field) { |
|
1476 | + case '_REG_ID': |
|
1477 | + $orderby = array('REG_ID'); |
|
1478 | + break; |
|
1479 | + case '_Reg_status': |
|
1480 | + $orderby = array('STS_ID'); |
|
1481 | + break; |
|
1482 | + case 'ATT_fname': |
|
1483 | + $orderby = array('Attendee.ATT_fname', 'Attendee.ATT_lname'); |
|
1484 | + break; |
|
1485 | + case 'ATT_lname': |
|
1486 | + $orderby = array('Attendee.ATT_lname', 'Attendee.ATT_fname'); |
|
1487 | + break; |
|
1488 | + case 'event_name': |
|
1489 | + $orderby = array('Event.EVT_name'); |
|
1490 | + break; |
|
1491 | + case 'DTT_EVT_start': |
|
1492 | + $orderby = array('Event.Datetime.DTT_EVT_start'); |
|
1493 | + break; |
|
1494 | + case '_REG_date': |
|
1495 | + $orderby = array('REG_date'); |
|
1496 | + break; |
|
1497 | + default: |
|
1498 | + $orderby = array($orderby_field); |
|
1499 | + break; |
|
1500 | + } |
|
1501 | + |
|
1502 | + // order |
|
1503 | + $order = ! empty($this->_req_data['order']) |
|
1504 | + ? sanitize_text_field($this->_req_data['order']) |
|
1505 | + : 'DESC'; |
|
1506 | + $orderby = array_combine( |
|
1507 | + $orderby, |
|
1508 | + array_fill(0, count($orderby), $order) |
|
1509 | + ); |
|
1510 | + // because there are many registrations with the same date, define |
|
1511 | + // a secondary way to order them, otherwise MySQL seems to be a bit random |
|
1512 | + if (empty($orderby['REG_ID'])) { |
|
1513 | + $orderby['REG_ID'] = $order; |
|
1514 | + } |
|
1515 | + |
|
1516 | + $orderby = apply_filters( |
|
1517 | + 'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query', |
|
1518 | + $orderby, |
|
1519 | + $this->_req_data |
|
1520 | + ); |
|
1521 | + |
|
1522 | + return array('order_by' => $orderby); |
|
1523 | + } |
|
1524 | + |
|
1525 | + |
|
1526 | + /** |
|
1527 | + * Sets up the limit for the registrations query. |
|
1528 | + * |
|
1529 | + * @param $per_page |
|
1530 | + * @return array |
|
1531 | + */ |
|
1532 | + protected function _get_limit($per_page) |
|
1533 | + { |
|
1534 | + $current_page = ! empty($this->_req_data['paged']) |
|
1535 | + ? absint($this->_req_data['paged']) |
|
1536 | + : 1; |
|
1537 | + $per_page = ! empty($this->_req_data['perpage']) |
|
1538 | + ? $this->_req_data['perpage'] |
|
1539 | + : $per_page; |
|
1540 | + |
|
1541 | + // -1 means return all results so get out if that's set. |
|
1542 | + if ((int) $per_page === -1) { |
|
1543 | + return array(); |
|
1544 | + } |
|
1545 | + $per_page = absint($per_page); |
|
1546 | + $offset = ($current_page - 1) * $per_page; |
|
1547 | + return array('limit' => array($offset, $per_page)); |
|
1548 | + } |
|
1549 | + |
|
1550 | + |
|
1551 | + public function get_registration_status_array() |
|
1552 | + { |
|
1553 | + return self::$_reg_status; |
|
1554 | + } |
|
1555 | + |
|
1556 | + |
|
1557 | + |
|
1558 | + |
|
1559 | + /*************************************** REGISTRATION DETAILS ***************************************/ |
|
1560 | + /** |
|
1561 | + * generates HTML for the View Registration Details Admin page |
|
1562 | + * |
|
1563 | + * @access protected |
|
1564 | + * @return void |
|
1565 | + * @throws DomainException |
|
1566 | + * @throws EE_Error |
|
1567 | + * @throws InvalidArgumentException |
|
1568 | + * @throws InvalidDataTypeException |
|
1569 | + * @throws InvalidInterfaceException |
|
1570 | + * @throws EntityNotFoundException |
|
1571 | + */ |
|
1572 | + protected function _registration_details() |
|
1573 | + { |
|
1574 | + $this->_template_args = array(); |
|
1575 | + $this->_set_registration_object(); |
|
1576 | + if (is_object($this->_registration)) { |
|
1577 | + $transaction = $this->_registration->transaction() |
|
1578 | + ? $this->_registration->transaction() |
|
1579 | + : EE_Transaction::new_instance(); |
|
1580 | + $this->_session = $transaction->session_data(); |
|
1581 | + $event_id = $this->_registration->event_ID(); |
|
1582 | + $this->_template_args['reg_nmbr']['value'] = $this->_registration->ID(); |
|
1583 | + $this->_template_args['reg_nmbr']['label'] = esc_html__('Registration Number', 'event_espresso'); |
|
1584 | + $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date'); |
|
1585 | + $this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso'); |
|
1586 | + $this->_template_args['grand_total'] = $transaction->total(); |
|
1587 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
1588 | + // link back to overview |
|
1589 | + $this->_template_args['reg_overview_url'] = REG_ADMIN_URL; |
|
1590 | + $this->_template_args['registration'] = $this->_registration; |
|
1591 | + $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
1592 | + array( |
|
1593 | + 'action' => 'default', |
|
1594 | + 'event_id' => $event_id, |
|
1595 | + ), |
|
1596 | + REG_ADMIN_URL |
|
1597 | + ); |
|
1598 | + $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
1599 | + array( |
|
1600 | + 'action' => 'default', |
|
1601 | + 'EVT_ID' => $event_id, |
|
1602 | + 'page' => 'espresso_transactions', |
|
1603 | + ), |
|
1604 | + admin_url('admin.php') |
|
1605 | + ); |
|
1606 | + $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
1607 | + array( |
|
1608 | + 'page' => 'espresso_events', |
|
1609 | + 'action' => 'edit', |
|
1610 | + 'post' => $event_id, |
|
1611 | + ), |
|
1612 | + admin_url('admin.php') |
|
1613 | + ); |
|
1614 | + // next and previous links |
|
1615 | + $next_reg = $this->_registration->next( |
|
1616 | + null, |
|
1617 | + array(), |
|
1618 | + 'REG_ID' |
|
1619 | + ); |
|
1620 | + $this->_template_args['next_registration'] = $next_reg |
|
1621 | + ? $this->_next_link( |
|
1622 | + EE_Admin_Page::add_query_args_and_nonce( |
|
1623 | + array( |
|
1624 | + 'action' => 'view_registration', |
|
1625 | + '_REG_ID' => $next_reg['REG_ID'], |
|
1626 | + ), |
|
1627 | + REG_ADMIN_URL |
|
1628 | + ), |
|
1629 | + 'dashicons dashicons-arrow-right ee-icon-size-22' |
|
1630 | + ) |
|
1631 | + : ''; |
|
1632 | + $previous_reg = $this->_registration->previous( |
|
1633 | + null, |
|
1634 | + array(), |
|
1635 | + 'REG_ID' |
|
1636 | + ); |
|
1637 | + $this->_template_args['previous_registration'] = $previous_reg |
|
1638 | + ? $this->_previous_link( |
|
1639 | + EE_Admin_Page::add_query_args_and_nonce( |
|
1640 | + array( |
|
1641 | + 'action' => 'view_registration', |
|
1642 | + '_REG_ID' => $previous_reg['REG_ID'], |
|
1643 | + ), |
|
1644 | + REG_ADMIN_URL |
|
1645 | + ), |
|
1646 | + 'dashicons dashicons-arrow-left ee-icon-size-22' |
|
1647 | + ) |
|
1648 | + : ''; |
|
1649 | + // grab header |
|
1650 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php'; |
|
1651 | + $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
1652 | + $this->_template_args['admin_page_header'] = EEH_Template::display_template( |
|
1653 | + $template_path, |
|
1654 | + $this->_template_args, |
|
1655 | + true |
|
1656 | + ); |
|
1657 | + } else { |
|
1658 | + $this->_template_args['admin_page_header'] = $this->display_espresso_notices(); |
|
1659 | + } |
|
1660 | + // the details template wrapper |
|
1661 | + $this->display_admin_page_with_sidebar(); |
|
1662 | + } |
|
1663 | + |
|
1664 | + |
|
1665 | + protected function _registration_details_metaboxes() |
|
1666 | + { |
|
1667 | + do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this); |
|
1668 | + $this->_set_registration_object(); |
|
1669 | + $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null; |
|
1670 | + add_meta_box( |
|
1671 | + 'edit-reg-status-mbox', |
|
1672 | + esc_html__('Registration Status', 'event_espresso'), |
|
1673 | + array($this, 'set_reg_status_buttons_metabox'), |
|
1674 | + $this->wp_page_slug, |
|
1675 | + 'normal', |
|
1676 | + 'high' |
|
1677 | + ); |
|
1678 | + add_meta_box( |
|
1679 | + 'edit-reg-details-mbox', |
|
1680 | + esc_html__('Registration Details', 'event_espresso'), |
|
1681 | + array($this, '_reg_details_meta_box'), |
|
1682 | + $this->wp_page_slug, |
|
1683 | + 'normal', |
|
1684 | + 'high' |
|
1685 | + ); |
|
1686 | + if ($attendee instanceof EE_Attendee |
|
1687 | + && EE_Registry::instance()->CAP->current_user_can( |
|
1688 | + 'ee_read_registration', |
|
1689 | + 'edit-reg-questions-mbox', |
|
1690 | + $this->_registration->ID() |
|
1691 | + ) |
|
1692 | + ) { |
|
1693 | + add_meta_box( |
|
1694 | + 'edit-reg-questions-mbox', |
|
1695 | + esc_html__('Registration Form Answers', 'event_espresso'), |
|
1696 | + array($this, '_reg_questions_meta_box'), |
|
1697 | + $this->wp_page_slug, |
|
1698 | + 'normal', |
|
1699 | + 'high' |
|
1700 | + ); |
|
1701 | + } |
|
1702 | + add_meta_box( |
|
1703 | + 'edit-reg-registrant-mbox', |
|
1704 | + esc_html__('Contact Details', 'event_espresso'), |
|
1705 | + array($this, '_reg_registrant_side_meta_box'), |
|
1706 | + $this->wp_page_slug, |
|
1707 | + 'side', |
|
1708 | + 'high' |
|
1709 | + ); |
|
1710 | + if ($this->_registration->group_size() > 1) { |
|
1711 | + add_meta_box( |
|
1712 | + 'edit-reg-attendees-mbox', |
|
1713 | + esc_html__('Other Registrations in this Transaction', 'event_espresso'), |
|
1714 | + array($this, '_reg_attendees_meta_box'), |
|
1715 | + $this->wp_page_slug, |
|
1716 | + 'normal', |
|
1717 | + 'high' |
|
1718 | + ); |
|
1719 | + } |
|
1720 | + } |
|
1721 | + |
|
1722 | + |
|
1723 | + /** |
|
1724 | + * set_reg_status_buttons_metabox |
|
1725 | + * |
|
1726 | + * @access protected |
|
1727 | + * @return string |
|
1728 | + * @throws \EE_Error |
|
1729 | + */ |
|
1730 | + public function set_reg_status_buttons_metabox() |
|
1731 | + { |
|
1732 | + $this->_set_registration_object(); |
|
1733 | + $change_reg_status_form = $this->_generate_reg_status_change_form(); |
|
1734 | + echo $change_reg_status_form->form_open( |
|
1735 | + self::add_query_args_and_nonce( |
|
1736 | + array( |
|
1737 | + 'action' => 'change_reg_status', |
|
1738 | + ), |
|
1739 | + REG_ADMIN_URL |
|
1740 | + ) |
|
1741 | + ); |
|
1742 | + echo $change_reg_status_form->get_html(); |
|
1743 | + echo $change_reg_status_form->form_close(); |
|
1744 | + } |
|
1745 | + |
|
1746 | + |
|
1747 | + /** |
|
1748 | + * @return EE_Form_Section_Proper |
|
1749 | + * @throws EE_Error |
|
1750 | + * @throws InvalidArgumentException |
|
1751 | + * @throws InvalidDataTypeException |
|
1752 | + * @throws InvalidInterfaceException |
|
1753 | + * @throws \EventEspresso\core\exceptions\EntityNotFoundException |
|
1754 | + */ |
|
1755 | + protected function _generate_reg_status_change_form() |
|
1756 | + { |
|
1757 | + $reg_status_change_form_array = array( |
|
1758 | + 'name' => 'reg_status_change_form', |
|
1759 | + 'html_id' => 'reg-status-change-form', |
|
1760 | + 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
1761 | + 'subsections' => array( |
|
1762 | + 'return' => new EE_Hidden_Input( |
|
1763 | + array( |
|
1764 | + 'name' => 'return', |
|
1765 | + 'default' => 'view_registration', |
|
1766 | + ) |
|
1767 | + ), |
|
1768 | + 'REG_ID' => new EE_Hidden_Input( |
|
1769 | + array( |
|
1770 | + 'name' => 'REG_ID', |
|
1771 | + 'default' => $this->_registration->ID(), |
|
1772 | + ) |
|
1773 | + ), |
|
1774 | + 'current_status' => new EE_Form_Section_HTML( |
|
1775 | + EEH_HTML::tr( |
|
1776 | + EEH_HTML::th( |
|
1777 | + EEH_HTML::label( |
|
1778 | + EEH_HTML::strong( |
|
1779 | + esc_html__('Current Registration Status', 'event_espresso') |
|
1780 | + ) |
|
1781 | + ) |
|
1782 | + ) |
|
1783 | + . EEH_HTML::td( |
|
1784 | + EEH_HTML::strong( |
|
1785 | + $this->_registration->pretty_status(), |
|
1786 | + '', |
|
1787 | + 'status-' . $this->_registration->status_ID(), |
|
1788 | + 'line-height: 1em; font-size: 1.5em; font-weight: bold;' |
|
1789 | + ) |
|
1790 | + ) |
|
1791 | + ) |
|
1792 | + ) |
|
1793 | + ) |
|
1794 | + ); |
|
1795 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
1796 | + 'ee_edit_registration', |
|
1797 | + 'toggle_registration_status', |
|
1798 | + $this->_registration->ID() |
|
1799 | + )) { |
|
1800 | + $reg_status_change_form_array['subsections']['reg_status'] = new EE_Select_Input( |
|
1801 | + $this->_get_reg_statuses(), |
|
1802 | + array( |
|
1803 | + 'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'), |
|
1804 | + 'default' => $this->_registration->status_ID(), |
|
1805 | + ) |
|
1806 | + ); |
|
1807 | + $reg_status_change_form_array['subsections']['send_notifications'] = new EE_Yes_No_Input( |
|
1808 | + array( |
|
1809 | + 'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'), |
|
1810 | + 'default' => false, |
|
1811 | + 'html_help_text' => esc_html__( |
|
1812 | + 'If set to "Yes", then the related messages will be sent to the registrant.', |
|
1813 | + 'event_espresso' |
|
1814 | + ) |
|
1815 | + ) |
|
1816 | + ); |
|
1817 | + $reg_status_change_form_array['subsections']['submit'] = new EE_Submit_Input( |
|
1818 | + array( |
|
1819 | + 'html_class' => 'button-primary', |
|
1820 | + 'html_label_text' => ' ', |
|
1821 | + 'default' => esc_html__('Update Registration Status', 'event_espresso'), |
|
1822 | + ) |
|
1823 | + ); |
|
1824 | + } |
|
1825 | + return new EE_Form_Section_Proper($reg_status_change_form_array); |
|
1826 | + } |
|
1827 | + |
|
1828 | + |
|
1829 | + /** |
|
1830 | + * Returns an array of all the buttons for the various statuses and switch status actions |
|
1831 | + * |
|
1832 | + * @return array |
|
1833 | + * @throws EE_Error |
|
1834 | + * @throws InvalidArgumentException |
|
1835 | + * @throws InvalidDataTypeException |
|
1836 | + * @throws InvalidInterfaceException |
|
1837 | + * @throws EntityNotFoundException |
|
1838 | + */ |
|
1839 | + protected function _get_reg_statuses() |
|
1840 | + { |
|
1841 | + $reg_status_array = EEM_Registration::instance()->reg_status_array(); |
|
1842 | + unset($reg_status_array[ EEM_Registration::status_id_incomplete ]); |
|
1843 | + // get current reg status |
|
1844 | + $current_status = $this->_registration->status_ID(); |
|
1845 | + // is registration for free event? This will determine whether to display the pending payment option |
|
1846 | + if ($current_status !== EEM_Registration::status_id_pending_payment |
|
1847 | + && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00) |
|
1848 | + ) { |
|
1849 | + unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]); |
|
1850 | + } |
|
1851 | + return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence'); |
|
1852 | + } |
|
1853 | + |
|
1854 | + |
|
1855 | + /** |
|
1856 | + * This method is used when using _REG_ID from request which may or may not be an array of reg_ids. |
|
1857 | + * |
|
1858 | + * @param bool $status REG status given for changing registrations to. |
|
1859 | + * @param bool $notify Whether to send messages notifications or not. |
|
1860 | + * @return array (array with reg_id(s) updated and whether update was successful. |
|
1861 | + * @throws EE_Error |
|
1862 | + * @throws InvalidArgumentException |
|
1863 | + * @throws InvalidDataTypeException |
|
1864 | + * @throws InvalidInterfaceException |
|
1865 | + * @throws ReflectionException |
|
1866 | + * @throws RuntimeException |
|
1867 | + * @throws EntityNotFoundException |
|
1868 | + */ |
|
1869 | + protected function _set_registration_status_from_request($status = false, $notify = false) |
|
1870 | + { |
|
1871 | + if (isset($this->_req_data['reg_status_change_form'])) { |
|
1872 | + $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID']) |
|
1873 | + ? (array) $this->_req_data['reg_status_change_form']['REG_ID'] |
|
1874 | + : array(); |
|
1875 | + } else { |
|
1876 | + $REG_IDs = isset($this->_req_data['_REG_ID']) |
|
1877 | + ? (array) $this->_req_data['_REG_ID'] |
|
1878 | + : array(); |
|
1879 | + } |
|
1880 | + // sanitize $REG_IDs |
|
1881 | + $REG_IDs = array_map('absint', $REG_IDs); |
|
1882 | + // and remove empty entries |
|
1883 | + $REG_IDs = array_filter($REG_IDs); |
|
1884 | + |
|
1885 | + $result = $this->_set_registration_status($REG_IDs, $status, $notify); |
|
1886 | + |
|
1887 | + /** |
|
1888 | + * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications. |
|
1889 | + * Currently this value is used downstream by the _process_resend_registration method. |
|
1890 | + * |
|
1891 | + * @param int|array $registration_ids The registration ids that have had their status changed successfully. |
|
1892 | + * @param bool $status The status registrations were changed to. |
|
1893 | + * @param bool $success If the status was changed successfully for all registrations. |
|
1894 | + * @param Registrations_Admin_Page $admin_page_object |
|
1895 | + */ |
|
1896 | + $this->_req_data['_REG_ID'] = apply_filters( |
|
1897 | + 'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs', |
|
1898 | + $result['REG_ID'], |
|
1899 | + $status, |
|
1900 | + $result['success'], |
|
1901 | + $this |
|
1902 | + ); |
|
1903 | + |
|
1904 | + // notify? |
|
1905 | + if ($notify |
|
1906 | + && $result['success'] |
|
1907 | + && ! empty($this->_req_data['_REG_ID']) |
|
1908 | + && EE_Registry::instance()->CAP->current_user_can( |
|
1909 | + 'ee_send_message', |
|
1910 | + 'espresso_registrations_resend_registration' |
|
1911 | + ) |
|
1912 | + ) { |
|
1913 | + $this->_process_resend_registration(); |
|
1914 | + } |
|
1915 | + return $result; |
|
1916 | + } |
|
1917 | + |
|
1918 | + |
|
1919 | + /** |
|
1920 | + * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an |
|
1921 | + * array). Note, this method does NOT take care of possible notifications. That is required by calling code. |
|
1922 | + * |
|
1923 | + * @param array $REG_IDs |
|
1924 | + * @param string $status |
|
1925 | + * @param bool $notify Used to indicate whether notification was requested or not. This determines the context |
|
1926 | + * slug sent with setting the registration status. |
|
1927 | + * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as |
|
1928 | + * @throws EE_Error |
|
1929 | + * @throws InvalidArgumentException |
|
1930 | + * @throws InvalidDataTypeException |
|
1931 | + * @throws InvalidInterfaceException |
|
1932 | + * @throws ReflectionException |
|
1933 | + * @throws RuntimeException |
|
1934 | + * @throws EntityNotFoundException |
|
1935 | + */ |
|
1936 | + protected function _set_registration_status($REG_IDs = array(), $status = '', $notify = false) |
|
1937 | + { |
|
1938 | + $success = false; |
|
1939 | + // typecast $REG_IDs |
|
1940 | + $REG_IDs = (array) $REG_IDs; |
|
1941 | + if (! empty($REG_IDs)) { |
|
1942 | + $success = true; |
|
1943 | + // set default status if none is passed |
|
1944 | + $status = $status ? $status : EEM_Registration::status_id_pending_payment; |
|
1945 | + $status_context = $notify |
|
1946 | + ? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY |
|
1947 | + : Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN; |
|
1948 | + // loop through REG_ID's and change status |
|
1949 | + foreach ($REG_IDs as $REG_ID) { |
|
1950 | + $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
1951 | + if ($registration instanceof EE_Registration) { |
|
1952 | + $registration->set_status( |
|
1953 | + $status, |
|
1954 | + false, |
|
1955 | + new Context( |
|
1956 | + $status_context, |
|
1957 | + esc_html__( |
|
1958 | + 'Manually triggered status change on a Registration Admin Page route.', |
|
1959 | + 'event_espresso' |
|
1960 | + ) |
|
1961 | + ) |
|
1962 | + ); |
|
1963 | + $result = $registration->save(); |
|
1964 | + // verifying explicit fails because update *may* just return 0 for 0 rows affected |
|
1965 | + $success = $result !== false ? $success : false; |
|
1966 | + } |
|
1967 | + } |
|
1968 | + } |
|
1969 | + |
|
1970 | + // return $success and processed registrations |
|
1971 | + return array('REG_ID' => $REG_IDs, 'success' => $success); |
|
1972 | + } |
|
1973 | + |
|
1974 | + |
|
1975 | + /** |
|
1976 | + * Common logic for setting up success message and redirecting to appropriate route |
|
1977 | + * |
|
1978 | + * @param string $STS_ID status id for the registration changed to |
|
1979 | + * @param bool $notify indicates whether the _set_registration_status_from_request does notifications or not. |
|
1980 | + * @return void |
|
1981 | + * @throws EE_Error |
|
1982 | + */ |
|
1983 | + protected function _reg_status_change_return($STS_ID, $notify = false) |
|
1984 | + { |
|
1985 | + $result = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify) |
|
1986 | + : array('success' => false); |
|
1987 | + $success = isset($result['success']) && $result['success']; |
|
1988 | + // setup success message |
|
1989 | + if ($success) { |
|
1990 | + if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) { |
|
1991 | + $msg = sprintf( |
|
1992 | + esc_html__('Registration status has been set to %s', 'event_espresso'), |
|
1993 | + EEH_Template::pretty_status($STS_ID, false, 'lower') |
|
1994 | + ); |
|
1995 | + } else { |
|
1996 | + $msg = sprintf( |
|
1997 | + esc_html__('Registrations have been set to %s.', 'event_espresso'), |
|
1998 | + EEH_Template::pretty_status($STS_ID, false, 'lower') |
|
1999 | + ); |
|
2000 | + } |
|
2001 | + EE_Error::add_success($msg); |
|
2002 | + } else { |
|
2003 | + EE_Error::add_error( |
|
2004 | + esc_html__( |
|
2005 | + 'Something went wrong, and the status was not changed', |
|
2006 | + 'event_espresso' |
|
2007 | + ), |
|
2008 | + __FILE__, |
|
2009 | + __LINE__, |
|
2010 | + __FUNCTION__ |
|
2011 | + ); |
|
2012 | + } |
|
2013 | + if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') { |
|
2014 | + $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID'])); |
|
2015 | + } else { |
|
2016 | + $route = array('action' => 'default'); |
|
2017 | + } |
|
2018 | + $route = $this->mergeExistingRequestParamsWithRedirectArgs($route); |
|
2019 | + $this->_redirect_after_action($success, '', '', $route, true); |
|
2020 | + } |
|
2021 | + |
|
2022 | + |
|
2023 | + /** |
|
2024 | + * incoming reg status change from reg details page. |
|
2025 | + * |
|
2026 | + * @return void |
|
2027 | + */ |
|
2028 | + protected function _change_reg_status() |
|
2029 | + { |
|
2030 | + $this->_req_data['return'] = 'view_registration'; |
|
2031 | + // set notify based on whether the send notifications toggle is set or not |
|
2032 | + $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']); |
|
2033 | + // $notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] ); |
|
2034 | + $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status']) |
|
2035 | + ? $this->_req_data['reg_status_change_form']['reg_status'] : ''; |
|
2036 | + switch ($this->_req_data['reg_status_change_form']['reg_status']) { |
|
2037 | + case EEM_Registration::status_id_approved: |
|
2038 | + case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'): |
|
2039 | + $this->approve_registration($notify); |
|
2040 | + break; |
|
2041 | + case EEM_Registration::status_id_pending_payment: |
|
2042 | + case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'): |
|
2043 | + $this->pending_registration($notify); |
|
2044 | + break; |
|
2045 | + case EEM_Registration::status_id_not_approved: |
|
2046 | + case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'): |
|
2047 | + $this->not_approve_registration($notify); |
|
2048 | + break; |
|
2049 | + case EEM_Registration::status_id_declined: |
|
2050 | + case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'): |
|
2051 | + $this->decline_registration($notify); |
|
2052 | + break; |
|
2053 | + case EEM_Registration::status_id_cancelled: |
|
2054 | + case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'): |
|
2055 | + $this->cancel_registration($notify); |
|
2056 | + break; |
|
2057 | + case EEM_Registration::status_id_wait_list: |
|
2058 | + case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'): |
|
2059 | + $this->wait_list_registration($notify); |
|
2060 | + break; |
|
2061 | + case EEM_Registration::status_id_incomplete: |
|
2062 | + default: |
|
2063 | + $result['success'] = false; |
|
2064 | + unset($this->_req_data['return']); |
|
2065 | + $this->_reg_status_change_return('', false); |
|
2066 | + break; |
|
2067 | + } |
|
2068 | + } |
|
2069 | + |
|
2070 | + |
|
2071 | + /** |
|
2072 | + * Callback for bulk action routes. |
|
2073 | + * Note: although we could just register the singular route callbacks for each bulk action route as well, this |
|
2074 | + * method was chosen so there is one central place all the registration status bulk actions are going through. |
|
2075 | + * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to |
|
2076 | + * when an action is happening on just a single registration). |
|
2077 | + * |
|
2078 | + * @param $action |
|
2079 | + * @param bool $notify |
|
2080 | + */ |
|
2081 | + protected function bulk_action_on_registrations($action, $notify = false) |
|
2082 | + { |
|
2083 | + do_action( |
|
2084 | + 'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution', |
|
2085 | + $this, |
|
2086 | + $action, |
|
2087 | + $notify |
|
2088 | + ); |
|
2089 | + $method = $action . '_registration'; |
|
2090 | + if (method_exists($this, $method)) { |
|
2091 | + $this->$method($notify); |
|
2092 | + } |
|
2093 | + } |
|
2094 | + |
|
2095 | + |
|
2096 | + /** |
|
2097 | + * approve_registration |
|
2098 | + * |
|
2099 | + * @access protected |
|
2100 | + * @param bool $notify whether or not to notify the registrant about their approval. |
|
2101 | + * @return void |
|
2102 | + */ |
|
2103 | + protected function approve_registration($notify = false) |
|
2104 | + { |
|
2105 | + $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify); |
|
2106 | + } |
|
2107 | + |
|
2108 | + |
|
2109 | + /** |
|
2110 | + * decline_registration |
|
2111 | + * |
|
2112 | + * @access protected |
|
2113 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
2114 | + * @return void |
|
2115 | + */ |
|
2116 | + protected function decline_registration($notify = false) |
|
2117 | + { |
|
2118 | + $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify); |
|
2119 | + } |
|
2120 | + |
|
2121 | + |
|
2122 | + /** |
|
2123 | + * cancel_registration |
|
2124 | + * |
|
2125 | + * @access protected |
|
2126 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
2127 | + * @return void |
|
2128 | + */ |
|
2129 | + protected function cancel_registration($notify = false) |
|
2130 | + { |
|
2131 | + $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify); |
|
2132 | + } |
|
2133 | + |
|
2134 | + |
|
2135 | + /** |
|
2136 | + * not_approve_registration |
|
2137 | + * |
|
2138 | + * @access protected |
|
2139 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
2140 | + * @return void |
|
2141 | + */ |
|
2142 | + protected function not_approve_registration($notify = false) |
|
2143 | + { |
|
2144 | + $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify); |
|
2145 | + } |
|
2146 | + |
|
2147 | + |
|
2148 | + /** |
|
2149 | + * decline_registration |
|
2150 | + * |
|
2151 | + * @access protected |
|
2152 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
2153 | + * @return void |
|
2154 | + */ |
|
2155 | + protected function pending_registration($notify = false) |
|
2156 | + { |
|
2157 | + $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify); |
|
2158 | + } |
|
2159 | + |
|
2160 | + |
|
2161 | + /** |
|
2162 | + * waitlist_registration |
|
2163 | + * |
|
2164 | + * @access protected |
|
2165 | + * @param bool $notify whether or not to notify the registrant about their status change. |
|
2166 | + * @return void |
|
2167 | + */ |
|
2168 | + protected function wait_list_registration($notify = false) |
|
2169 | + { |
|
2170 | + $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify); |
|
2171 | + } |
|
2172 | + |
|
2173 | + |
|
2174 | + /** |
|
2175 | + * generates HTML for the Registration main meta box |
|
2176 | + * |
|
2177 | + * @access public |
|
2178 | + * @return void |
|
2179 | + * @throws DomainException |
|
2180 | + * @throws EE_Error |
|
2181 | + * @throws InvalidArgumentException |
|
2182 | + * @throws InvalidDataTypeException |
|
2183 | + * @throws InvalidInterfaceException |
|
2184 | + * @throws ReflectionException |
|
2185 | + * @throws EntityNotFoundException |
|
2186 | + */ |
|
2187 | + public function _reg_details_meta_box() |
|
2188 | + { |
|
2189 | + EEH_Autoloader::register_line_item_display_autoloaders(); |
|
2190 | + EEH_Autoloader::register_line_item_filter_autoloaders(); |
|
2191 | + EE_Registry::instance()->load_helper('Line_Item'); |
|
2192 | + $transaction = $this->_registration->transaction() ? $this->_registration->transaction() |
|
2193 | + : EE_Transaction::new_instance(); |
|
2194 | + $this->_session = $transaction->session_data(); |
|
2195 | + $filters = new EE_Line_Item_Filter_Collection(); |
|
2196 | + // $filters->add( new EE_Non_Zero_Line_Item_Filter() ); |
|
2197 | + $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration)); |
|
2198 | + $line_item_filter_processor = new EE_Line_Item_Filter_Processor( |
|
2199 | + $filters, |
|
2200 | + $transaction->total_line_item() |
|
2201 | + ); |
|
2202 | + $filtered_line_item_tree = $line_item_filter_processor->process(); |
|
2203 | + $line_item_display = new EE_Line_Item_Display( |
|
2204 | + 'reg_admin_table', |
|
2205 | + 'EE_Admin_Table_Registration_Line_Item_Display_Strategy' |
|
2206 | + ); |
|
2207 | + $this->_template_args['line_item_table'] = $line_item_display->display_line_item( |
|
2208 | + $filtered_line_item_tree, |
|
2209 | + array('EE_Registration' => $this->_registration) |
|
2210 | + ); |
|
2211 | + $attendee = $this->_registration->attendee(); |
|
2212 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
2213 | + 'ee_read_transaction', |
|
2214 | + 'espresso_transactions_view_transaction' |
|
2215 | + )) { |
|
2216 | + $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link( |
|
2217 | + EE_Admin_Page::add_query_args_and_nonce( |
|
2218 | + array( |
|
2219 | + 'action' => 'view_transaction', |
|
2220 | + 'TXN_ID' => $transaction->ID(), |
|
2221 | + ), |
|
2222 | + TXN_ADMIN_URL |
|
2223 | + ), |
|
2224 | + esc_html__(' View Transaction', 'event_espresso'), |
|
2225 | + 'button secondary-button right', |
|
2226 | + 'dashicons dashicons-cart' |
|
2227 | + ); |
|
2228 | + } else { |
|
2229 | + $this->_template_args['view_transaction_button'] = ''; |
|
2230 | + } |
|
2231 | + if ($attendee instanceof EE_Attendee |
|
2232 | + && EE_Registry::instance()->CAP->current_user_can( |
|
2233 | + 'ee_send_message', |
|
2234 | + 'espresso_registrations_resend_registration' |
|
2235 | + ) |
|
2236 | + ) { |
|
2237 | + $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link( |
|
2238 | + EE_Admin_Page::add_query_args_and_nonce( |
|
2239 | + array( |
|
2240 | + 'action' => 'resend_registration', |
|
2241 | + '_REG_ID' => $this->_registration->ID(), |
|
2242 | + 'redirect_to' => 'view_registration', |
|
2243 | + ), |
|
2244 | + REG_ADMIN_URL |
|
2245 | + ), |
|
2246 | + esc_html__(' Resend Registration', 'event_espresso'), |
|
2247 | + 'button secondary-button right', |
|
2248 | + 'dashicons dashicons-email-alt' |
|
2249 | + ); |
|
2250 | + } else { |
|
2251 | + $this->_template_args['resend_registration_button'] = ''; |
|
2252 | + } |
|
2253 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
2254 | + $payment = $transaction->get_first_related('Payment'); |
|
2255 | + $payment = ! $payment instanceof EE_Payment |
|
2256 | + ? EE_Payment::new_instance() |
|
2257 | + : $payment; |
|
2258 | + $payment_method = $payment->get_first_related('Payment_Method'); |
|
2259 | + $payment_method = ! $payment_method instanceof EE_Payment_Method |
|
2260 | + ? EE_Payment_Method::new_instance() |
|
2261 | + : $payment_method; |
|
2262 | + $reg_details = array( |
|
2263 | + 'payment_method' => $payment_method->name(), |
|
2264 | + 'response_msg' => $payment->gateway_response(), |
|
2265 | + 'registration_id' => $this->_registration->get('REG_code'), |
|
2266 | + 'registration_session' => $this->_registration->session_ID(), |
|
2267 | + 'ip_address' => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '', |
|
2268 | + 'user_agent' => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '', |
|
2269 | + ); |
|
2270 | + if (isset($reg_details['registration_id'])) { |
|
2271 | + $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id']; |
|
2272 | + $this->_template_args['reg_details']['registration_id']['label'] = esc_html__( |
|
2273 | + 'Registration ID', |
|
2274 | + 'event_espresso' |
|
2275 | + ); |
|
2276 | + $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text'; |
|
2277 | + } |
|
2278 | + if (isset($reg_details['payment_method'])) { |
|
2279 | + $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method']; |
|
2280 | + $this->_template_args['reg_details']['payment_method']['label'] = esc_html__( |
|
2281 | + 'Most Recent Payment Method', |
|
2282 | + 'event_espresso' |
|
2283 | + ); |
|
2284 | + $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text'; |
|
2285 | + $this->_template_args['reg_details']['response_msg']['value'] = $reg_details['response_msg']; |
|
2286 | + $this->_template_args['reg_details']['response_msg']['label'] = esc_html__( |
|
2287 | + 'Payment method response', |
|
2288 | + 'event_espresso' |
|
2289 | + ); |
|
2290 | + $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text'; |
|
2291 | + } |
|
2292 | + $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session']; |
|
2293 | + $this->_template_args['reg_details']['registration_session']['label'] = esc_html__( |
|
2294 | + 'Registration Session', |
|
2295 | + 'event_espresso' |
|
2296 | + ); |
|
2297 | + $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text'; |
|
2298 | + $this->_template_args['reg_details']['ip_address']['value'] = $reg_details['ip_address']; |
|
2299 | + $this->_template_args['reg_details']['ip_address']['label'] = esc_html__( |
|
2300 | + 'Registration placed from IP', |
|
2301 | + 'event_espresso' |
|
2302 | + ); |
|
2303 | + $this->_template_args['reg_details']['ip_address']['class'] = 'regular-text'; |
|
2304 | + $this->_template_args['reg_details']['user_agent']['value'] = $reg_details['user_agent']; |
|
2305 | + $this->_template_args['reg_details']['user_agent']['label'] = esc_html__( |
|
2306 | + 'Registrant User Agent', |
|
2307 | + 'event_espresso' |
|
2308 | + ); |
|
2309 | + $this->_template_args['reg_details']['user_agent']['class'] = 'large-text'; |
|
2310 | + $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
2311 | + array( |
|
2312 | + 'action' => 'default', |
|
2313 | + 'event_id' => $this->_registration->event_ID(), |
|
2314 | + ), |
|
2315 | + REG_ADMIN_URL |
|
2316 | + ); |
|
2317 | + $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
2318 | + $this->_template_args['event_id'] = $this->_registration->event_ID(); |
|
2319 | + $template_path = |
|
2320 | + REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php'; |
|
2321 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
2322 | + } |
|
2323 | + |
|
2324 | + |
|
2325 | + /** |
|
2326 | + * generates HTML for the Registration Questions meta box. |
|
2327 | + * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters), |
|
2328 | + * otherwise uses new forms system |
|
2329 | + * |
|
2330 | + * @access public |
|
2331 | + * @return void |
|
2332 | + * @throws DomainException |
|
2333 | + * @throws EE_Error |
|
2334 | + */ |
|
2335 | + public function _reg_questions_meta_box() |
|
2336 | + { |
|
2337 | + // allow someone to override this method entirely |
|
2338 | + if (apply_filters( |
|
2339 | + 'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', |
|
2340 | + true, |
|
2341 | + $this, |
|
2342 | + $this->_registration |
|
2343 | + )) { |
|
2344 | + $form = $this->_get_reg_custom_questions_form( |
|
2345 | + $this->_registration->ID() |
|
2346 | + ); |
|
2347 | + $this->_template_args['att_questions'] = count($form->subforms()) > 0 |
|
2348 | + ? $form->get_html_and_js() |
|
2349 | + : ''; |
|
2350 | + $this->_template_args['reg_questions_form_action'] = 'edit_registration'; |
|
2351 | + $this->_template_args['REG_ID'] = $this->_registration->ID(); |
|
2352 | + $template_path = |
|
2353 | + REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php'; |
|
2354 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
2355 | + } |
|
2356 | + } |
|
2357 | + |
|
2358 | + |
|
2359 | + /** |
|
2360 | + * form_before_question_group |
|
2361 | + * |
|
2362 | + * @deprecated as of 4.8.32.rc.000 |
|
2363 | + * @access public |
|
2364 | + * @param string $output |
|
2365 | + * @return string |
|
2366 | + */ |
|
2367 | + public function form_before_question_group($output) |
|
2368 | + { |
|
2369 | + EE_Error::doing_it_wrong( |
|
2370 | + __CLASS__ . '::' . __FUNCTION__, |
|
2371 | + esc_html__( |
|
2372 | + 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
2373 | + 'event_espresso' |
|
2374 | + ), |
|
2375 | + '4.8.32.rc.000' |
|
2376 | + ); |
|
2377 | + return ' |
|
2378 | 2378 | <table class="form-table ee-width-100"> |
2379 | 2379 | <tbody> |
2380 | 2380 | '; |
2381 | - } |
|
2382 | - |
|
2383 | - |
|
2384 | - /** |
|
2385 | - * form_after_question_group |
|
2386 | - * |
|
2387 | - * @deprecated as of 4.8.32.rc.000 |
|
2388 | - * @access public |
|
2389 | - * @param string $output |
|
2390 | - * @return string |
|
2391 | - */ |
|
2392 | - public function form_after_question_group($output) |
|
2393 | - { |
|
2394 | - EE_Error::doing_it_wrong( |
|
2395 | - __CLASS__ . '::' . __FUNCTION__, |
|
2396 | - esc_html__( |
|
2397 | - 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
2398 | - 'event_espresso' |
|
2399 | - ), |
|
2400 | - '4.8.32.rc.000' |
|
2401 | - ); |
|
2402 | - return ' |
|
2381 | + } |
|
2382 | + |
|
2383 | + |
|
2384 | + /** |
|
2385 | + * form_after_question_group |
|
2386 | + * |
|
2387 | + * @deprecated as of 4.8.32.rc.000 |
|
2388 | + * @access public |
|
2389 | + * @param string $output |
|
2390 | + * @return string |
|
2391 | + */ |
|
2392 | + public function form_after_question_group($output) |
|
2393 | + { |
|
2394 | + EE_Error::doing_it_wrong( |
|
2395 | + __CLASS__ . '::' . __FUNCTION__, |
|
2396 | + esc_html__( |
|
2397 | + 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
2398 | + 'event_espresso' |
|
2399 | + ), |
|
2400 | + '4.8.32.rc.000' |
|
2401 | + ); |
|
2402 | + return ' |
|
2403 | 2403 | <tr class="hide-if-no-js"> |
2404 | 2404 | <th> </th> |
2405 | 2405 | <td class="reg-admin-edit-attendee-question-td"> |
2406 | 2406 | <a class="reg-admin-edit-attendee-question-lnk" href="#" title="' |
2407 | - . esc_attr__('click to edit question', 'event_espresso') |
|
2408 | - . '"> |
|
2407 | + . esc_attr__('click to edit question', 'event_espresso') |
|
2408 | + . '"> |
|
2409 | 2409 | <span class="reg-admin-edit-question-group-spn lt-grey-txt">' |
2410 | - . esc_html__('edit the above question group', 'event_espresso') |
|
2411 | - . '</span> |
|
2410 | + . esc_html__('edit the above question group', 'event_espresso') |
|
2411 | + . '</span> |
|
2412 | 2412 | <div class="dashicons dashicons-edit"></div> |
2413 | 2413 | </a> |
2414 | 2414 | </td> |
@@ -2416,609 +2416,609 @@ discard block |
||
2416 | 2416 | </tbody> |
2417 | 2417 | </table> |
2418 | 2418 | '; |
2419 | - } |
|
2420 | - |
|
2421 | - |
|
2422 | - /** |
|
2423 | - * form_form_field_label_wrap |
|
2424 | - * |
|
2425 | - * @deprecated as of 4.8.32.rc.000 |
|
2426 | - * @access public |
|
2427 | - * @param string $label |
|
2428 | - * @return string |
|
2429 | - */ |
|
2430 | - public function form_form_field_label_wrap($label) |
|
2431 | - { |
|
2432 | - EE_Error::doing_it_wrong( |
|
2433 | - __CLASS__ . '::' . __FUNCTION__, |
|
2434 | - esc_html__( |
|
2435 | - 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
2436 | - 'event_espresso' |
|
2437 | - ), |
|
2438 | - '4.8.32.rc.000' |
|
2439 | - ); |
|
2440 | - return ' |
|
2419 | + } |
|
2420 | + |
|
2421 | + |
|
2422 | + /** |
|
2423 | + * form_form_field_label_wrap |
|
2424 | + * |
|
2425 | + * @deprecated as of 4.8.32.rc.000 |
|
2426 | + * @access public |
|
2427 | + * @param string $label |
|
2428 | + * @return string |
|
2429 | + */ |
|
2430 | + public function form_form_field_label_wrap($label) |
|
2431 | + { |
|
2432 | + EE_Error::doing_it_wrong( |
|
2433 | + __CLASS__ . '::' . __FUNCTION__, |
|
2434 | + esc_html__( |
|
2435 | + 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
2436 | + 'event_espresso' |
|
2437 | + ), |
|
2438 | + '4.8.32.rc.000' |
|
2439 | + ); |
|
2440 | + return ' |
|
2441 | 2441 | <tr> |
2442 | 2442 | <th> |
2443 | 2443 | ' . $label . ' |
2444 | 2444 | </th>'; |
2445 | - } |
|
2446 | - |
|
2447 | - |
|
2448 | - /** |
|
2449 | - * form_form_field_input__wrap |
|
2450 | - * |
|
2451 | - * @deprecated as of 4.8.32.rc.000 |
|
2452 | - * @access public |
|
2453 | - * @param string $input |
|
2454 | - * @return string |
|
2455 | - */ |
|
2456 | - public function form_form_field_input__wrap($input) |
|
2457 | - { |
|
2458 | - EE_Error::doing_it_wrong( |
|
2459 | - __CLASS__ . '::' . __FUNCTION__, |
|
2460 | - esc_html__( |
|
2461 | - 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
2462 | - 'event_espresso' |
|
2463 | - ), |
|
2464 | - '4.8.32.rc.000' |
|
2465 | - ); |
|
2466 | - return ' |
|
2445 | + } |
|
2446 | + |
|
2447 | + |
|
2448 | + /** |
|
2449 | + * form_form_field_input__wrap |
|
2450 | + * |
|
2451 | + * @deprecated as of 4.8.32.rc.000 |
|
2452 | + * @access public |
|
2453 | + * @param string $input |
|
2454 | + * @return string |
|
2455 | + */ |
|
2456 | + public function form_form_field_input__wrap($input) |
|
2457 | + { |
|
2458 | + EE_Error::doing_it_wrong( |
|
2459 | + __CLASS__ . '::' . __FUNCTION__, |
|
2460 | + esc_html__( |
|
2461 | + 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.', |
|
2462 | + 'event_espresso' |
|
2463 | + ), |
|
2464 | + '4.8.32.rc.000' |
|
2465 | + ); |
|
2466 | + return ' |
|
2467 | 2467 | <td class="reg-admin-attendee-questions-input-td disabled-input"> |
2468 | 2468 | ' . $input . ' |
2469 | 2469 | </td> |
2470 | 2470 | </tr>'; |
2471 | - } |
|
2472 | - |
|
2473 | - |
|
2474 | - /** |
|
2475 | - * Updates the registration's custom questions according to the form info, if the form is submitted. |
|
2476 | - * If it's not a post, the "view_registrations" route will be called next on the SAME request |
|
2477 | - * to display the page |
|
2478 | - * |
|
2479 | - * @access protected |
|
2480 | - * @return void |
|
2481 | - * @throws EE_Error |
|
2482 | - */ |
|
2483 | - protected function _update_attendee_registration_form() |
|
2484 | - { |
|
2485 | - do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this); |
|
2486 | - if ($_SERVER['REQUEST_METHOD'] == 'POST') { |
|
2487 | - $REG_ID = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false; |
|
2488 | - $success = $this->_save_reg_custom_questions_form($REG_ID); |
|
2489 | - if ($success) { |
|
2490 | - $what = esc_html__('Registration Form', 'event_espresso'); |
|
2491 | - $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) |
|
2492 | - : array('action' => 'default'); |
|
2493 | - $this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route); |
|
2494 | - } |
|
2495 | - } |
|
2496 | - } |
|
2497 | - |
|
2498 | - |
|
2499 | - /** |
|
2500 | - * Gets the form for saving registrations custom questions (if done |
|
2501 | - * previously retrieves the cached form object, which may have validation errors in it) |
|
2502 | - * |
|
2503 | - * @param int $REG_ID |
|
2504 | - * @return EE_Registration_Custom_Questions_Form |
|
2505 | - * @throws EE_Error |
|
2506 | - * @throws InvalidArgumentException |
|
2507 | - * @throws InvalidDataTypeException |
|
2508 | - * @throws InvalidInterfaceException |
|
2509 | - */ |
|
2510 | - protected function _get_reg_custom_questions_form($REG_ID) |
|
2511 | - { |
|
2512 | - if (! $this->_reg_custom_questions_form) { |
|
2513 | - require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php'); |
|
2514 | - $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form( |
|
2515 | - EEM_Registration::instance()->get_one_by_ID($REG_ID) |
|
2516 | - ); |
|
2517 | - $this->_reg_custom_questions_form->_construct_finalize(null, null); |
|
2518 | - } |
|
2519 | - return $this->_reg_custom_questions_form; |
|
2520 | - } |
|
2521 | - |
|
2522 | - |
|
2523 | - /** |
|
2524 | - * Saves |
|
2525 | - * |
|
2526 | - * @access private |
|
2527 | - * @param bool $REG_ID |
|
2528 | - * @return bool |
|
2529 | - * @throws EE_Error |
|
2530 | - * @throws InvalidArgumentException |
|
2531 | - * @throws InvalidDataTypeException |
|
2532 | - * @throws InvalidInterfaceException |
|
2533 | - */ |
|
2534 | - private function _save_reg_custom_questions_form($REG_ID = false) |
|
2535 | - { |
|
2536 | - if (! $REG_ID) { |
|
2537 | - EE_Error::add_error( |
|
2538 | - esc_html__( |
|
2539 | - 'An error occurred. No registration ID was received.', |
|
2540 | - 'event_espresso' |
|
2541 | - ), |
|
2542 | - __FILE__, |
|
2543 | - __FUNCTION__, |
|
2544 | - __LINE__ |
|
2545 | - ); |
|
2546 | - } |
|
2547 | - $form = $this->_get_reg_custom_questions_form($REG_ID); |
|
2548 | - $form->receive_form_submission($this->_req_data); |
|
2549 | - $success = false; |
|
2550 | - if ($form->is_valid()) { |
|
2551 | - foreach ($form->subforms() as $question_group_id => $question_group_form) { |
|
2552 | - foreach ($question_group_form->inputs() as $question_id => $input) { |
|
2553 | - $where_conditions = array( |
|
2554 | - 'QST_ID' => $question_id, |
|
2555 | - 'REG_ID' => $REG_ID, |
|
2556 | - ); |
|
2557 | - $possibly_new_values = array( |
|
2558 | - 'ANS_value' => $input->normalized_value(), |
|
2559 | - ); |
|
2560 | - $answer = EEM_Answer::instance()->get_one(array($where_conditions)); |
|
2561 | - if ($answer instanceof EE_Answer) { |
|
2562 | - $success = $answer->save($possibly_new_values); |
|
2563 | - } else { |
|
2564 | - // insert it then |
|
2565 | - $cols_n_vals = array_merge($where_conditions, $possibly_new_values); |
|
2566 | - $answer = EE_Answer::new_instance($cols_n_vals); |
|
2567 | - $success = $answer->save(); |
|
2568 | - } |
|
2569 | - } |
|
2570 | - } |
|
2571 | - } else { |
|
2572 | - EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__); |
|
2573 | - } |
|
2574 | - return $success; |
|
2575 | - } |
|
2576 | - |
|
2577 | - |
|
2578 | - /** |
|
2579 | - * generates HTML for the Registration main meta box |
|
2580 | - * |
|
2581 | - * @access public |
|
2582 | - * @return void |
|
2583 | - * @throws DomainException |
|
2584 | - * @throws EE_Error |
|
2585 | - * @throws InvalidArgumentException |
|
2586 | - * @throws InvalidDataTypeException |
|
2587 | - * @throws InvalidInterfaceException |
|
2588 | - */ |
|
2589 | - public function _reg_attendees_meta_box() |
|
2590 | - { |
|
2591 | - $REG = EEM_Registration::instance(); |
|
2592 | - // get all other registrations on this transaction, and cache |
|
2593 | - // the attendees for them so we don't have to run another query using force_join |
|
2594 | - $registrations = $REG->get_all( |
|
2595 | - array( |
|
2596 | - array( |
|
2597 | - 'TXN_ID' => $this->_registration->transaction_ID(), |
|
2598 | - 'REG_ID' => array('!=', $this->_registration->ID()), |
|
2599 | - ), |
|
2600 | - 'force_join' => array('Attendee'), |
|
2601 | - 'default_where_conditions' => 'other_models_only', |
|
2602 | - ) |
|
2603 | - ); |
|
2604 | - $this->_template_args['attendees'] = array(); |
|
2605 | - $this->_template_args['attendee_notice'] = ''; |
|
2606 | - if (empty($registrations) |
|
2607 | - || (is_array($registrations) |
|
2608 | - && ! EEH_Array::get_one_item_from_array($registrations)) |
|
2609 | - ) { |
|
2610 | - EE_Error::add_error( |
|
2611 | - esc_html__( |
|
2612 | - 'There are no records attached to this registration. Something may have gone wrong with the registration', |
|
2613 | - 'event_espresso' |
|
2614 | - ), |
|
2615 | - __FILE__, |
|
2616 | - __FUNCTION__, |
|
2617 | - __LINE__ |
|
2618 | - ); |
|
2619 | - $this->_template_args['attendee_notice'] = EE_Error::get_notices(); |
|
2620 | - } else { |
|
2621 | - $att_nmbr = 1; |
|
2622 | - foreach ($registrations as $registration) { |
|
2623 | - /* @var $registration EE_Registration */ |
|
2624 | - $attendee = $registration->attendee() |
|
2625 | - ? $registration->attendee() |
|
2626 | - : EEM_Attendee::instance() |
|
2627 | - ->create_default_object(); |
|
2628 | - $this->_template_args['attendees'][ $att_nmbr ]['STS_ID'] = $registration->status_ID(); |
|
2629 | - $this->_template_args['attendees'][ $att_nmbr ]['fname'] = $attendee->fname(); |
|
2630 | - $this->_template_args['attendees'][ $att_nmbr ]['lname'] = $attendee->lname(); |
|
2631 | - $this->_template_args['attendees'][ $att_nmbr ]['email'] = $attendee->email(); |
|
2632 | - $this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price(); |
|
2633 | - $this->_template_args['attendees'][ $att_nmbr ]['address'] = implode( |
|
2634 | - ', ', |
|
2635 | - $attendee->full_address_as_array() |
|
2636 | - ); |
|
2637 | - $this->_template_args['attendees'][ $att_nmbr ]['att_link'] = self::add_query_args_and_nonce( |
|
2638 | - array( |
|
2639 | - 'action' => 'edit_attendee', |
|
2640 | - 'post' => $attendee->ID(), |
|
2641 | - ), |
|
2642 | - REG_ADMIN_URL |
|
2643 | - ); |
|
2644 | - $this->_template_args['attendees'][ $att_nmbr ]['event_name'] = $registration->event_obj() instanceof EE_Event |
|
2645 | - ? $registration->event_obj()->name() |
|
2646 | - : ''; |
|
2647 | - $att_nmbr++; |
|
2648 | - } |
|
2649 | - $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
2650 | - } |
|
2651 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php'; |
|
2652 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
2653 | - } |
|
2654 | - |
|
2655 | - |
|
2656 | - /** |
|
2657 | - * generates HTML for the Edit Registration side meta box |
|
2658 | - * |
|
2659 | - * @access public |
|
2660 | - * @return void |
|
2661 | - * @throws DomainException |
|
2662 | - * @throws EE_Error |
|
2663 | - * @throws InvalidArgumentException |
|
2664 | - * @throws InvalidDataTypeException |
|
2665 | - * @throws InvalidInterfaceException |
|
2666 | - */ |
|
2667 | - public function _reg_registrant_side_meta_box() |
|
2668 | - { |
|
2669 | - /*@var $attendee EE_Attendee */ |
|
2670 | - $att_check = $this->_registration->attendee(); |
|
2671 | - $attendee = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object(); |
|
2672 | - // now let's determine if this is not the primary registration. If it isn't then we set the |
|
2673 | - // primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the |
|
2674 | - // primary registration object (that way we know if we need to show create button or not) |
|
2675 | - if (! $this->_registration->is_primary_registrant()) { |
|
2676 | - $primary_registration = $this->_registration->get_primary_registration(); |
|
2677 | - $primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() |
|
2678 | - : null; |
|
2679 | - if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) { |
|
2680 | - // in here? This means the displayed registration is not the primary registrant but ALREADY HAS its own |
|
2681 | - // custom attendee object so let's not worry about the primary reg. |
|
2682 | - $primary_registration = null; |
|
2683 | - } |
|
2684 | - } else { |
|
2685 | - $primary_registration = null; |
|
2686 | - } |
|
2687 | - $this->_template_args['ATT_ID'] = $attendee->ID(); |
|
2688 | - $this->_template_args['fname'] = $attendee->fname(); |
|
2689 | - $this->_template_args['lname'] = $attendee->lname(); |
|
2690 | - $this->_template_args['email'] = $attendee->email(); |
|
2691 | - $this->_template_args['phone'] = $attendee->phone(); |
|
2692 | - $this->_template_args['formatted_address'] = EEH_Address::format($attendee); |
|
2693 | - // edit link |
|
2694 | - $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
2695 | - array( |
|
2696 | - 'action' => 'edit_attendee', |
|
2697 | - 'post' => $attendee->ID(), |
|
2698 | - ), |
|
2699 | - REG_ADMIN_URL |
|
2700 | - ); |
|
2701 | - $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso'); |
|
2702 | - // create link |
|
2703 | - $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration |
|
2704 | - ? EE_Admin_Page::add_query_args_and_nonce( |
|
2705 | - array( |
|
2706 | - 'action' => 'duplicate_attendee', |
|
2707 | - '_REG_ID' => $this->_registration->ID(), |
|
2708 | - ), |
|
2709 | - REG_ADMIN_URL |
|
2710 | - ) : ''; |
|
2711 | - $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso'); |
|
2712 | - $this->_template_args['att_check'] = $att_check; |
|
2713 | - $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php'; |
|
2714 | - echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
2715 | - } |
|
2716 | - |
|
2717 | - |
|
2718 | - /** |
|
2719 | - * trash or restore registrations |
|
2720 | - * |
|
2721 | - * @param boolean $trash whether to archive or restore |
|
2722 | - * @return void |
|
2723 | - * @throws EE_Error |
|
2724 | - * @throws InvalidArgumentException |
|
2725 | - * @throws InvalidDataTypeException |
|
2726 | - * @throws InvalidInterfaceException |
|
2727 | - * @throws RuntimeException |
|
2728 | - * @access protected |
|
2729 | - */ |
|
2730 | - protected function _trash_or_restore_registrations($trash = true) |
|
2731 | - { |
|
2732 | - // if empty _REG_ID then get out because there's nothing to do |
|
2733 | - if (empty($this->_req_data['_REG_ID'])) { |
|
2734 | - EE_Error::add_error( |
|
2735 | - sprintf( |
|
2736 | - esc_html__( |
|
2737 | - 'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.', |
|
2738 | - 'event_espresso' |
|
2739 | - ), |
|
2740 | - $trash ? 'trash' : 'restore' |
|
2741 | - ), |
|
2742 | - __FILE__, |
|
2743 | - __LINE__, |
|
2744 | - __FUNCTION__ |
|
2745 | - ); |
|
2746 | - $this->_redirect_after_action(false, '', '', array(), true); |
|
2747 | - } |
|
2748 | - $success = 0; |
|
2749 | - $overwrite_msgs = false; |
|
2750 | - // Checkboxes |
|
2751 | - if (! is_array($this->_req_data['_REG_ID'])) { |
|
2752 | - $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']); |
|
2753 | - } |
|
2754 | - $reg_count = count($this->_req_data['_REG_ID']); |
|
2755 | - // cycle thru checkboxes |
|
2756 | - foreach ($this->_req_data['_REG_ID'] as $REG_ID) { |
|
2757 | - /** @var EE_Registration $REG */ |
|
2758 | - $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
2759 | - $payments = $REG->registration_payments(); |
|
2760 | - if (! empty($payments)) { |
|
2761 | - $name = $REG->attendee() instanceof EE_Attendee |
|
2762 | - ? $REG->attendee()->full_name() |
|
2763 | - : esc_html__('Unknown Attendee', 'event_espresso'); |
|
2764 | - $overwrite_msgs = true; |
|
2765 | - EE_Error::add_error( |
|
2766 | - sprintf( |
|
2767 | - esc_html__( |
|
2768 | - 'The registration for %s could not be trashed because it has payments attached to the related transaction. If you wish to trash this registration you must first delete the payments on the related transaction.', |
|
2769 | - 'event_espresso' |
|
2770 | - ), |
|
2771 | - $name |
|
2772 | - ), |
|
2773 | - __FILE__, |
|
2774 | - __FUNCTION__, |
|
2775 | - __LINE__ |
|
2776 | - ); |
|
2777 | - // can't trash this registration because it has payments. |
|
2778 | - continue; |
|
2779 | - } |
|
2780 | - $updated = $trash ? $REG->delete() : $REG->restore(); |
|
2781 | - if ($updated) { |
|
2782 | - $success++; |
|
2783 | - } |
|
2784 | - } |
|
2785 | - $this->_redirect_after_action( |
|
2786 | - $success === $reg_count, // were ALL registrations affected? |
|
2787 | - $success > 1 |
|
2788 | - ? esc_html__('Registrations', 'event_espresso') |
|
2789 | - : esc_html__('Registration', 'event_espresso'), |
|
2790 | - $trash |
|
2791 | - ? esc_html__('moved to the trash', 'event_espresso') |
|
2792 | - : esc_html__('restored', 'event_espresso'), |
|
2793 | - $this->mergeExistingRequestParamsWithRedirectArgs(array('action' => 'default')), |
|
2794 | - $overwrite_msgs |
|
2795 | - ); |
|
2796 | - } |
|
2797 | - |
|
2798 | - |
|
2799 | - /** |
|
2800 | - * This is used to permanently delete registrations. Note, this will handle not only deleting permanently the |
|
2801 | - * registration but also. |
|
2802 | - * 1. Removing relations to EE_Attendee |
|
2803 | - * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are |
|
2804 | - * ALSO trashed. |
|
2805 | - * 3. Deleting permanently any related Line items but only if the above conditions are met. |
|
2806 | - * 4. Removing relationships between all tickets and the related registrations |
|
2807 | - * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.) |
|
2808 | - * 6. Deleting permanently any related Checkins. |
|
2809 | - * |
|
2810 | - * @return void |
|
2811 | - * @throws EE_Error |
|
2812 | - * @throws InvalidArgumentException |
|
2813 | - * @throws InvalidDataTypeException |
|
2814 | - * @throws InvalidInterfaceException |
|
2815 | - */ |
|
2816 | - protected function _delete_registrations() |
|
2817 | - { |
|
2818 | - $REG_MDL = EEM_Registration::instance(); |
|
2819 | - $success = 1; |
|
2820 | - // Checkboxes |
|
2821 | - if (! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) { |
|
2822 | - // if array has more than one element than success message should be plural |
|
2823 | - $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1; |
|
2824 | - // cycle thru checkboxes |
|
2825 | - while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) { |
|
2826 | - $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
2827 | - if (! $REG instanceof EE_Registration) { |
|
2828 | - continue; |
|
2829 | - } |
|
2830 | - $deleted = $this->_delete_registration($REG); |
|
2831 | - if (! $deleted) { |
|
2832 | - $success = 0; |
|
2833 | - } |
|
2834 | - } |
|
2835 | - } else { |
|
2836 | - // grab single id and delete |
|
2837 | - $REG_ID = $this->_req_data['_REG_ID']; |
|
2838 | - $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
2839 | - $deleted = $this->_delete_registration($REG); |
|
2840 | - if (! $deleted) { |
|
2841 | - $success = 0; |
|
2842 | - } |
|
2843 | - } |
|
2844 | - $what = $success > 1 |
|
2845 | - ? esc_html__('Registrations', 'event_espresso') |
|
2846 | - : esc_html__('Registration', 'event_espresso'); |
|
2847 | - $action_desc = esc_html__('permanently deleted.', 'event_espresso'); |
|
2848 | - $this->_redirect_after_action( |
|
2849 | - $success, |
|
2850 | - $what, |
|
2851 | - $action_desc, |
|
2852 | - $this->mergeExistingRequestParamsWithRedirectArgs(['action' => 'default']), |
|
2853 | - true |
|
2854 | - ); |
|
2855 | - } |
|
2856 | - |
|
2857 | - |
|
2858 | - /** |
|
2859 | - * handles the permanent deletion of a registration. See comments with _delete_registrations() for details on what |
|
2860 | - * models get affected. |
|
2861 | - * |
|
2862 | - * @param EE_Registration $REG registration to be deleted permenantly |
|
2863 | - * @return bool true = successful deletion, false = fail. |
|
2864 | - * @throws EE_Error |
|
2865 | - */ |
|
2866 | - protected function _delete_registration(EE_Registration $REG) |
|
2867 | - { |
|
2868 | - // first we start with the transaction... ultimately, we WILL not delete permanently if there are any related |
|
2869 | - // registrations on the transaction that are NOT trashed. |
|
2870 | - $TXN = $REG->get_first_related('Transaction'); |
|
2871 | - $REGS = $TXN->get_many_related('Registration'); |
|
2872 | - $all_trashed = true; |
|
2873 | - foreach ($REGS as $registration) { |
|
2874 | - if (! $registration->get('REG_deleted')) { |
|
2875 | - $all_trashed = false; |
|
2876 | - } |
|
2877 | - } |
|
2878 | - if (! $all_trashed) { |
|
2879 | - EE_Error::add_error( |
|
2880 | - esc_html__( |
|
2881 | - 'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well. These registrations will be permanently deleted in the same action.', |
|
2882 | - 'event_espresso' |
|
2883 | - ), |
|
2884 | - __FILE__, |
|
2885 | - __FUNCTION__, |
|
2886 | - __LINE__ |
|
2887 | - ); |
|
2888 | - return false; |
|
2889 | - } |
|
2890 | - // k made it here so that means we can delete all the related transactions and their answers (but let's do them |
|
2891 | - // separately from THIS one). |
|
2892 | - foreach ($REGS as $registration) { |
|
2893 | - // delete related answers |
|
2894 | - $registration->delete_related_permanently('Answer'); |
|
2895 | - // remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact) |
|
2896 | - $attendee = $registration->get_first_related('Attendee'); |
|
2897 | - if ($attendee instanceof EE_Attendee) { |
|
2898 | - $registration->_remove_relation_to($attendee, 'Attendee'); |
|
2899 | - } |
|
2900 | - // now remove relationships to tickets on this registration. |
|
2901 | - $registration->_remove_relations('Ticket'); |
|
2902 | - // now delete permanently the checkins related to this registration. |
|
2903 | - $registration->delete_related_permanently('Checkin'); |
|
2904 | - if ($registration->ID() === $REG->ID()) { |
|
2905 | - continue; |
|
2906 | - } //we don't want to delete permanently the existing registration just yet. |
|
2907 | - // remove relation to transaction for these registrations if NOT the existing registrations |
|
2908 | - $registration->_remove_relations('Transaction'); |
|
2909 | - // delete permanently any related messages. |
|
2910 | - $registration->delete_related_permanently('Message'); |
|
2911 | - // now delete this registration permanently |
|
2912 | - $registration->delete_permanently(); |
|
2913 | - } |
|
2914 | - // now all related registrations on the transaction are handled. So let's just handle this registration itself |
|
2915 | - // (the transaction and line items should be all that's left). |
|
2916 | - // delete the line items related to the transaction for this registration. |
|
2917 | - $TXN->delete_related_permanently('Line_Item'); |
|
2918 | - // we need to remove all the relationships on the transaction |
|
2919 | - $TXN->delete_related_permanently('Payment'); |
|
2920 | - $TXN->delete_related_permanently('Extra_Meta'); |
|
2921 | - $TXN->delete_related_permanently('Message'); |
|
2922 | - // now we can delete this REG permanently (and the transaction of course) |
|
2923 | - $REG->delete_related_permanently('Transaction'); |
|
2924 | - return $REG->delete_permanently(); |
|
2925 | - } |
|
2926 | - |
|
2927 | - |
|
2928 | - /** |
|
2929 | - * generates HTML for the Register New Attendee Admin page |
|
2930 | - * |
|
2931 | - * @access private |
|
2932 | - * @throws DomainException |
|
2933 | - * @throws EE_Error |
|
2934 | - */ |
|
2935 | - public function new_registration() |
|
2936 | - { |
|
2937 | - if (! $this->_set_reg_event()) { |
|
2938 | - throw new EE_Error( |
|
2939 | - esc_html__( |
|
2940 | - 'Unable to continue with registering because there is no Event ID in the request', |
|
2941 | - 'event_espresso' |
|
2942 | - ) |
|
2943 | - ); |
|
2944 | - } |
|
2945 | - EE_Registry::instance()->REQ->set_espresso_page(true); |
|
2946 | - // gotta start with a clean slate if we're not coming here via ajax |
|
2947 | - if (! defined('DOING_AJAX') |
|
2948 | - && (! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error'])) |
|
2949 | - ) { |
|
2950 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
2951 | - } |
|
2952 | - $this->_template_args['event_name'] = ''; |
|
2953 | - // event name |
|
2954 | - if ($this->_reg_event) { |
|
2955 | - $this->_template_args['event_name'] = $this->_reg_event->name(); |
|
2956 | - $edit_event_url = self::add_query_args_and_nonce( |
|
2957 | - array( |
|
2958 | - 'action' => 'edit', |
|
2959 | - 'post' => $this->_reg_event->ID(), |
|
2960 | - ), |
|
2961 | - EVENTS_ADMIN_URL |
|
2962 | - ); |
|
2963 | - $edit_event_lnk = '<a href="' |
|
2964 | - . $edit_event_url |
|
2965 | - . '" title="' |
|
2966 | - . esc_attr__('Edit ', 'event_espresso') |
|
2967 | - . $this->_reg_event->name() |
|
2968 | - . '">' |
|
2969 | - . esc_html__('Edit Event', 'event_espresso') |
|
2970 | - . '</a>'; |
|
2971 | - $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">' |
|
2972 | - . $edit_event_lnk |
|
2973 | - . '</span>'; |
|
2974 | - } |
|
2975 | - $this->_template_args['step_content'] = $this->_get_registration_step_content(); |
|
2976 | - if (defined('DOING_AJAX')) { |
|
2977 | - $this->_return_json(); |
|
2978 | - } |
|
2979 | - // grab header |
|
2980 | - $template_path = |
|
2981 | - REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php'; |
|
2982 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
2983 | - $template_path, |
|
2984 | - $this->_template_args, |
|
2985 | - true |
|
2986 | - ); |
|
2987 | - // $this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE ); |
|
2988 | - // the details template wrapper |
|
2989 | - $this->display_admin_page_with_sidebar(); |
|
2990 | - } |
|
2991 | - |
|
2992 | - |
|
2993 | - /** |
|
2994 | - * This returns the content for a registration step |
|
2995 | - * |
|
2996 | - * @access protected |
|
2997 | - * @return string html |
|
2998 | - * @throws DomainException |
|
2999 | - * @throws EE_Error |
|
3000 | - * @throws InvalidArgumentException |
|
3001 | - * @throws InvalidDataTypeException |
|
3002 | - * @throws InvalidInterfaceException |
|
3003 | - */ |
|
3004 | - protected function _get_registration_step_content() |
|
3005 | - { |
|
3006 | - if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) { |
|
3007 | - $warning_msg = sprintf( |
|
3008 | - esc_html__( |
|
3009 | - '%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s', |
|
3010 | - 'event_espresso' |
|
3011 | - ), |
|
3012 | - '<br />', |
|
3013 | - '<h3 class="important-notice">', |
|
3014 | - '</h3>', |
|
3015 | - '<div class="float-right">', |
|
3016 | - '<span id="redirect_timer" class="important-notice">30</span>', |
|
3017 | - '</div>', |
|
3018 | - '<b>', |
|
3019 | - '</b>' |
|
3020 | - ); |
|
3021 | - return ' |
|
2471 | + } |
|
2472 | + |
|
2473 | + |
|
2474 | + /** |
|
2475 | + * Updates the registration's custom questions according to the form info, if the form is submitted. |
|
2476 | + * If it's not a post, the "view_registrations" route will be called next on the SAME request |
|
2477 | + * to display the page |
|
2478 | + * |
|
2479 | + * @access protected |
|
2480 | + * @return void |
|
2481 | + * @throws EE_Error |
|
2482 | + */ |
|
2483 | + protected function _update_attendee_registration_form() |
|
2484 | + { |
|
2485 | + do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this); |
|
2486 | + if ($_SERVER['REQUEST_METHOD'] == 'POST') { |
|
2487 | + $REG_ID = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false; |
|
2488 | + $success = $this->_save_reg_custom_questions_form($REG_ID); |
|
2489 | + if ($success) { |
|
2490 | + $what = esc_html__('Registration Form', 'event_espresso'); |
|
2491 | + $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) |
|
2492 | + : array('action' => 'default'); |
|
2493 | + $this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route); |
|
2494 | + } |
|
2495 | + } |
|
2496 | + } |
|
2497 | + |
|
2498 | + |
|
2499 | + /** |
|
2500 | + * Gets the form for saving registrations custom questions (if done |
|
2501 | + * previously retrieves the cached form object, which may have validation errors in it) |
|
2502 | + * |
|
2503 | + * @param int $REG_ID |
|
2504 | + * @return EE_Registration_Custom_Questions_Form |
|
2505 | + * @throws EE_Error |
|
2506 | + * @throws InvalidArgumentException |
|
2507 | + * @throws InvalidDataTypeException |
|
2508 | + * @throws InvalidInterfaceException |
|
2509 | + */ |
|
2510 | + protected function _get_reg_custom_questions_form($REG_ID) |
|
2511 | + { |
|
2512 | + if (! $this->_reg_custom_questions_form) { |
|
2513 | + require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php'); |
|
2514 | + $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form( |
|
2515 | + EEM_Registration::instance()->get_one_by_ID($REG_ID) |
|
2516 | + ); |
|
2517 | + $this->_reg_custom_questions_form->_construct_finalize(null, null); |
|
2518 | + } |
|
2519 | + return $this->_reg_custom_questions_form; |
|
2520 | + } |
|
2521 | + |
|
2522 | + |
|
2523 | + /** |
|
2524 | + * Saves |
|
2525 | + * |
|
2526 | + * @access private |
|
2527 | + * @param bool $REG_ID |
|
2528 | + * @return bool |
|
2529 | + * @throws EE_Error |
|
2530 | + * @throws InvalidArgumentException |
|
2531 | + * @throws InvalidDataTypeException |
|
2532 | + * @throws InvalidInterfaceException |
|
2533 | + */ |
|
2534 | + private function _save_reg_custom_questions_form($REG_ID = false) |
|
2535 | + { |
|
2536 | + if (! $REG_ID) { |
|
2537 | + EE_Error::add_error( |
|
2538 | + esc_html__( |
|
2539 | + 'An error occurred. No registration ID was received.', |
|
2540 | + 'event_espresso' |
|
2541 | + ), |
|
2542 | + __FILE__, |
|
2543 | + __FUNCTION__, |
|
2544 | + __LINE__ |
|
2545 | + ); |
|
2546 | + } |
|
2547 | + $form = $this->_get_reg_custom_questions_form($REG_ID); |
|
2548 | + $form->receive_form_submission($this->_req_data); |
|
2549 | + $success = false; |
|
2550 | + if ($form->is_valid()) { |
|
2551 | + foreach ($form->subforms() as $question_group_id => $question_group_form) { |
|
2552 | + foreach ($question_group_form->inputs() as $question_id => $input) { |
|
2553 | + $where_conditions = array( |
|
2554 | + 'QST_ID' => $question_id, |
|
2555 | + 'REG_ID' => $REG_ID, |
|
2556 | + ); |
|
2557 | + $possibly_new_values = array( |
|
2558 | + 'ANS_value' => $input->normalized_value(), |
|
2559 | + ); |
|
2560 | + $answer = EEM_Answer::instance()->get_one(array($where_conditions)); |
|
2561 | + if ($answer instanceof EE_Answer) { |
|
2562 | + $success = $answer->save($possibly_new_values); |
|
2563 | + } else { |
|
2564 | + // insert it then |
|
2565 | + $cols_n_vals = array_merge($where_conditions, $possibly_new_values); |
|
2566 | + $answer = EE_Answer::new_instance($cols_n_vals); |
|
2567 | + $success = $answer->save(); |
|
2568 | + } |
|
2569 | + } |
|
2570 | + } |
|
2571 | + } else { |
|
2572 | + EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__); |
|
2573 | + } |
|
2574 | + return $success; |
|
2575 | + } |
|
2576 | + |
|
2577 | + |
|
2578 | + /** |
|
2579 | + * generates HTML for the Registration main meta box |
|
2580 | + * |
|
2581 | + * @access public |
|
2582 | + * @return void |
|
2583 | + * @throws DomainException |
|
2584 | + * @throws EE_Error |
|
2585 | + * @throws InvalidArgumentException |
|
2586 | + * @throws InvalidDataTypeException |
|
2587 | + * @throws InvalidInterfaceException |
|
2588 | + */ |
|
2589 | + public function _reg_attendees_meta_box() |
|
2590 | + { |
|
2591 | + $REG = EEM_Registration::instance(); |
|
2592 | + // get all other registrations on this transaction, and cache |
|
2593 | + // the attendees for them so we don't have to run another query using force_join |
|
2594 | + $registrations = $REG->get_all( |
|
2595 | + array( |
|
2596 | + array( |
|
2597 | + 'TXN_ID' => $this->_registration->transaction_ID(), |
|
2598 | + 'REG_ID' => array('!=', $this->_registration->ID()), |
|
2599 | + ), |
|
2600 | + 'force_join' => array('Attendee'), |
|
2601 | + 'default_where_conditions' => 'other_models_only', |
|
2602 | + ) |
|
2603 | + ); |
|
2604 | + $this->_template_args['attendees'] = array(); |
|
2605 | + $this->_template_args['attendee_notice'] = ''; |
|
2606 | + if (empty($registrations) |
|
2607 | + || (is_array($registrations) |
|
2608 | + && ! EEH_Array::get_one_item_from_array($registrations)) |
|
2609 | + ) { |
|
2610 | + EE_Error::add_error( |
|
2611 | + esc_html__( |
|
2612 | + 'There are no records attached to this registration. Something may have gone wrong with the registration', |
|
2613 | + 'event_espresso' |
|
2614 | + ), |
|
2615 | + __FILE__, |
|
2616 | + __FUNCTION__, |
|
2617 | + __LINE__ |
|
2618 | + ); |
|
2619 | + $this->_template_args['attendee_notice'] = EE_Error::get_notices(); |
|
2620 | + } else { |
|
2621 | + $att_nmbr = 1; |
|
2622 | + foreach ($registrations as $registration) { |
|
2623 | + /* @var $registration EE_Registration */ |
|
2624 | + $attendee = $registration->attendee() |
|
2625 | + ? $registration->attendee() |
|
2626 | + : EEM_Attendee::instance() |
|
2627 | + ->create_default_object(); |
|
2628 | + $this->_template_args['attendees'][ $att_nmbr ]['STS_ID'] = $registration->status_ID(); |
|
2629 | + $this->_template_args['attendees'][ $att_nmbr ]['fname'] = $attendee->fname(); |
|
2630 | + $this->_template_args['attendees'][ $att_nmbr ]['lname'] = $attendee->lname(); |
|
2631 | + $this->_template_args['attendees'][ $att_nmbr ]['email'] = $attendee->email(); |
|
2632 | + $this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price(); |
|
2633 | + $this->_template_args['attendees'][ $att_nmbr ]['address'] = implode( |
|
2634 | + ', ', |
|
2635 | + $attendee->full_address_as_array() |
|
2636 | + ); |
|
2637 | + $this->_template_args['attendees'][ $att_nmbr ]['att_link'] = self::add_query_args_and_nonce( |
|
2638 | + array( |
|
2639 | + 'action' => 'edit_attendee', |
|
2640 | + 'post' => $attendee->ID(), |
|
2641 | + ), |
|
2642 | + REG_ADMIN_URL |
|
2643 | + ); |
|
2644 | + $this->_template_args['attendees'][ $att_nmbr ]['event_name'] = $registration->event_obj() instanceof EE_Event |
|
2645 | + ? $registration->event_obj()->name() |
|
2646 | + : ''; |
|
2647 | + $att_nmbr++; |
|
2648 | + } |
|
2649 | + $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign; |
|
2650 | + } |
|
2651 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php'; |
|
2652 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
2653 | + } |
|
2654 | + |
|
2655 | + |
|
2656 | + /** |
|
2657 | + * generates HTML for the Edit Registration side meta box |
|
2658 | + * |
|
2659 | + * @access public |
|
2660 | + * @return void |
|
2661 | + * @throws DomainException |
|
2662 | + * @throws EE_Error |
|
2663 | + * @throws InvalidArgumentException |
|
2664 | + * @throws InvalidDataTypeException |
|
2665 | + * @throws InvalidInterfaceException |
|
2666 | + */ |
|
2667 | + public function _reg_registrant_side_meta_box() |
|
2668 | + { |
|
2669 | + /*@var $attendee EE_Attendee */ |
|
2670 | + $att_check = $this->_registration->attendee(); |
|
2671 | + $attendee = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object(); |
|
2672 | + // now let's determine if this is not the primary registration. If it isn't then we set the |
|
2673 | + // primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the |
|
2674 | + // primary registration object (that way we know if we need to show create button or not) |
|
2675 | + if (! $this->_registration->is_primary_registrant()) { |
|
2676 | + $primary_registration = $this->_registration->get_primary_registration(); |
|
2677 | + $primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() |
|
2678 | + : null; |
|
2679 | + if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) { |
|
2680 | + // in here? This means the displayed registration is not the primary registrant but ALREADY HAS its own |
|
2681 | + // custom attendee object so let's not worry about the primary reg. |
|
2682 | + $primary_registration = null; |
|
2683 | + } |
|
2684 | + } else { |
|
2685 | + $primary_registration = null; |
|
2686 | + } |
|
2687 | + $this->_template_args['ATT_ID'] = $attendee->ID(); |
|
2688 | + $this->_template_args['fname'] = $attendee->fname(); |
|
2689 | + $this->_template_args['lname'] = $attendee->lname(); |
|
2690 | + $this->_template_args['email'] = $attendee->email(); |
|
2691 | + $this->_template_args['phone'] = $attendee->phone(); |
|
2692 | + $this->_template_args['formatted_address'] = EEH_Address::format($attendee); |
|
2693 | + // edit link |
|
2694 | + $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce( |
|
2695 | + array( |
|
2696 | + 'action' => 'edit_attendee', |
|
2697 | + 'post' => $attendee->ID(), |
|
2698 | + ), |
|
2699 | + REG_ADMIN_URL |
|
2700 | + ); |
|
2701 | + $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso'); |
|
2702 | + // create link |
|
2703 | + $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration |
|
2704 | + ? EE_Admin_Page::add_query_args_and_nonce( |
|
2705 | + array( |
|
2706 | + 'action' => 'duplicate_attendee', |
|
2707 | + '_REG_ID' => $this->_registration->ID(), |
|
2708 | + ), |
|
2709 | + REG_ADMIN_URL |
|
2710 | + ) : ''; |
|
2711 | + $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso'); |
|
2712 | + $this->_template_args['att_check'] = $att_check; |
|
2713 | + $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php'; |
|
2714 | + echo EEH_Template::display_template($template_path, $this->_template_args, true); |
|
2715 | + } |
|
2716 | + |
|
2717 | + |
|
2718 | + /** |
|
2719 | + * trash or restore registrations |
|
2720 | + * |
|
2721 | + * @param boolean $trash whether to archive or restore |
|
2722 | + * @return void |
|
2723 | + * @throws EE_Error |
|
2724 | + * @throws InvalidArgumentException |
|
2725 | + * @throws InvalidDataTypeException |
|
2726 | + * @throws InvalidInterfaceException |
|
2727 | + * @throws RuntimeException |
|
2728 | + * @access protected |
|
2729 | + */ |
|
2730 | + protected function _trash_or_restore_registrations($trash = true) |
|
2731 | + { |
|
2732 | + // if empty _REG_ID then get out because there's nothing to do |
|
2733 | + if (empty($this->_req_data['_REG_ID'])) { |
|
2734 | + EE_Error::add_error( |
|
2735 | + sprintf( |
|
2736 | + esc_html__( |
|
2737 | + 'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.', |
|
2738 | + 'event_espresso' |
|
2739 | + ), |
|
2740 | + $trash ? 'trash' : 'restore' |
|
2741 | + ), |
|
2742 | + __FILE__, |
|
2743 | + __LINE__, |
|
2744 | + __FUNCTION__ |
|
2745 | + ); |
|
2746 | + $this->_redirect_after_action(false, '', '', array(), true); |
|
2747 | + } |
|
2748 | + $success = 0; |
|
2749 | + $overwrite_msgs = false; |
|
2750 | + // Checkboxes |
|
2751 | + if (! is_array($this->_req_data['_REG_ID'])) { |
|
2752 | + $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']); |
|
2753 | + } |
|
2754 | + $reg_count = count($this->_req_data['_REG_ID']); |
|
2755 | + // cycle thru checkboxes |
|
2756 | + foreach ($this->_req_data['_REG_ID'] as $REG_ID) { |
|
2757 | + /** @var EE_Registration $REG */ |
|
2758 | + $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID); |
|
2759 | + $payments = $REG->registration_payments(); |
|
2760 | + if (! empty($payments)) { |
|
2761 | + $name = $REG->attendee() instanceof EE_Attendee |
|
2762 | + ? $REG->attendee()->full_name() |
|
2763 | + : esc_html__('Unknown Attendee', 'event_espresso'); |
|
2764 | + $overwrite_msgs = true; |
|
2765 | + EE_Error::add_error( |
|
2766 | + sprintf( |
|
2767 | + esc_html__( |
|
2768 | + 'The registration for %s could not be trashed because it has payments attached to the related transaction. If you wish to trash this registration you must first delete the payments on the related transaction.', |
|
2769 | + 'event_espresso' |
|
2770 | + ), |
|
2771 | + $name |
|
2772 | + ), |
|
2773 | + __FILE__, |
|
2774 | + __FUNCTION__, |
|
2775 | + __LINE__ |
|
2776 | + ); |
|
2777 | + // can't trash this registration because it has payments. |
|
2778 | + continue; |
|
2779 | + } |
|
2780 | + $updated = $trash ? $REG->delete() : $REG->restore(); |
|
2781 | + if ($updated) { |
|
2782 | + $success++; |
|
2783 | + } |
|
2784 | + } |
|
2785 | + $this->_redirect_after_action( |
|
2786 | + $success === $reg_count, // were ALL registrations affected? |
|
2787 | + $success > 1 |
|
2788 | + ? esc_html__('Registrations', 'event_espresso') |
|
2789 | + : esc_html__('Registration', 'event_espresso'), |
|
2790 | + $trash |
|
2791 | + ? esc_html__('moved to the trash', 'event_espresso') |
|
2792 | + : esc_html__('restored', 'event_espresso'), |
|
2793 | + $this->mergeExistingRequestParamsWithRedirectArgs(array('action' => 'default')), |
|
2794 | + $overwrite_msgs |
|
2795 | + ); |
|
2796 | + } |
|
2797 | + |
|
2798 | + |
|
2799 | + /** |
|
2800 | + * This is used to permanently delete registrations. Note, this will handle not only deleting permanently the |
|
2801 | + * registration but also. |
|
2802 | + * 1. Removing relations to EE_Attendee |
|
2803 | + * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are |
|
2804 | + * ALSO trashed. |
|
2805 | + * 3. Deleting permanently any related Line items but only if the above conditions are met. |
|
2806 | + * 4. Removing relationships between all tickets and the related registrations |
|
2807 | + * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.) |
|
2808 | + * 6. Deleting permanently any related Checkins. |
|
2809 | + * |
|
2810 | + * @return void |
|
2811 | + * @throws EE_Error |
|
2812 | + * @throws InvalidArgumentException |
|
2813 | + * @throws InvalidDataTypeException |
|
2814 | + * @throws InvalidInterfaceException |
|
2815 | + */ |
|
2816 | + protected function _delete_registrations() |
|
2817 | + { |
|
2818 | + $REG_MDL = EEM_Registration::instance(); |
|
2819 | + $success = 1; |
|
2820 | + // Checkboxes |
|
2821 | + if (! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) { |
|
2822 | + // if array has more than one element than success message should be plural |
|
2823 | + $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1; |
|
2824 | + // cycle thru checkboxes |
|
2825 | + while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) { |
|
2826 | + $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
2827 | + if (! $REG instanceof EE_Registration) { |
|
2828 | + continue; |
|
2829 | + } |
|
2830 | + $deleted = $this->_delete_registration($REG); |
|
2831 | + if (! $deleted) { |
|
2832 | + $success = 0; |
|
2833 | + } |
|
2834 | + } |
|
2835 | + } else { |
|
2836 | + // grab single id and delete |
|
2837 | + $REG_ID = $this->_req_data['_REG_ID']; |
|
2838 | + $REG = $REG_MDL->get_one_by_ID($REG_ID); |
|
2839 | + $deleted = $this->_delete_registration($REG); |
|
2840 | + if (! $deleted) { |
|
2841 | + $success = 0; |
|
2842 | + } |
|
2843 | + } |
|
2844 | + $what = $success > 1 |
|
2845 | + ? esc_html__('Registrations', 'event_espresso') |
|
2846 | + : esc_html__('Registration', 'event_espresso'); |
|
2847 | + $action_desc = esc_html__('permanently deleted.', 'event_espresso'); |
|
2848 | + $this->_redirect_after_action( |
|
2849 | + $success, |
|
2850 | + $what, |
|
2851 | + $action_desc, |
|
2852 | + $this->mergeExistingRequestParamsWithRedirectArgs(['action' => 'default']), |
|
2853 | + true |
|
2854 | + ); |
|
2855 | + } |
|
2856 | + |
|
2857 | + |
|
2858 | + /** |
|
2859 | + * handles the permanent deletion of a registration. See comments with _delete_registrations() for details on what |
|
2860 | + * models get affected. |
|
2861 | + * |
|
2862 | + * @param EE_Registration $REG registration to be deleted permenantly |
|
2863 | + * @return bool true = successful deletion, false = fail. |
|
2864 | + * @throws EE_Error |
|
2865 | + */ |
|
2866 | + protected function _delete_registration(EE_Registration $REG) |
|
2867 | + { |
|
2868 | + // first we start with the transaction... ultimately, we WILL not delete permanently if there are any related |
|
2869 | + // registrations on the transaction that are NOT trashed. |
|
2870 | + $TXN = $REG->get_first_related('Transaction'); |
|
2871 | + $REGS = $TXN->get_many_related('Registration'); |
|
2872 | + $all_trashed = true; |
|
2873 | + foreach ($REGS as $registration) { |
|
2874 | + if (! $registration->get('REG_deleted')) { |
|
2875 | + $all_trashed = false; |
|
2876 | + } |
|
2877 | + } |
|
2878 | + if (! $all_trashed) { |
|
2879 | + EE_Error::add_error( |
|
2880 | + esc_html__( |
|
2881 | + 'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well. These registrations will be permanently deleted in the same action.', |
|
2882 | + 'event_espresso' |
|
2883 | + ), |
|
2884 | + __FILE__, |
|
2885 | + __FUNCTION__, |
|
2886 | + __LINE__ |
|
2887 | + ); |
|
2888 | + return false; |
|
2889 | + } |
|
2890 | + // k made it here so that means we can delete all the related transactions and their answers (but let's do them |
|
2891 | + // separately from THIS one). |
|
2892 | + foreach ($REGS as $registration) { |
|
2893 | + // delete related answers |
|
2894 | + $registration->delete_related_permanently('Answer'); |
|
2895 | + // remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact) |
|
2896 | + $attendee = $registration->get_first_related('Attendee'); |
|
2897 | + if ($attendee instanceof EE_Attendee) { |
|
2898 | + $registration->_remove_relation_to($attendee, 'Attendee'); |
|
2899 | + } |
|
2900 | + // now remove relationships to tickets on this registration. |
|
2901 | + $registration->_remove_relations('Ticket'); |
|
2902 | + // now delete permanently the checkins related to this registration. |
|
2903 | + $registration->delete_related_permanently('Checkin'); |
|
2904 | + if ($registration->ID() === $REG->ID()) { |
|
2905 | + continue; |
|
2906 | + } //we don't want to delete permanently the existing registration just yet. |
|
2907 | + // remove relation to transaction for these registrations if NOT the existing registrations |
|
2908 | + $registration->_remove_relations('Transaction'); |
|
2909 | + // delete permanently any related messages. |
|
2910 | + $registration->delete_related_permanently('Message'); |
|
2911 | + // now delete this registration permanently |
|
2912 | + $registration->delete_permanently(); |
|
2913 | + } |
|
2914 | + // now all related registrations on the transaction are handled. So let's just handle this registration itself |
|
2915 | + // (the transaction and line items should be all that's left). |
|
2916 | + // delete the line items related to the transaction for this registration. |
|
2917 | + $TXN->delete_related_permanently('Line_Item'); |
|
2918 | + // we need to remove all the relationships on the transaction |
|
2919 | + $TXN->delete_related_permanently('Payment'); |
|
2920 | + $TXN->delete_related_permanently('Extra_Meta'); |
|
2921 | + $TXN->delete_related_permanently('Message'); |
|
2922 | + // now we can delete this REG permanently (and the transaction of course) |
|
2923 | + $REG->delete_related_permanently('Transaction'); |
|
2924 | + return $REG->delete_permanently(); |
|
2925 | + } |
|
2926 | + |
|
2927 | + |
|
2928 | + /** |
|
2929 | + * generates HTML for the Register New Attendee Admin page |
|
2930 | + * |
|
2931 | + * @access private |
|
2932 | + * @throws DomainException |
|
2933 | + * @throws EE_Error |
|
2934 | + */ |
|
2935 | + public function new_registration() |
|
2936 | + { |
|
2937 | + if (! $this->_set_reg_event()) { |
|
2938 | + throw new EE_Error( |
|
2939 | + esc_html__( |
|
2940 | + 'Unable to continue with registering because there is no Event ID in the request', |
|
2941 | + 'event_espresso' |
|
2942 | + ) |
|
2943 | + ); |
|
2944 | + } |
|
2945 | + EE_Registry::instance()->REQ->set_espresso_page(true); |
|
2946 | + // gotta start with a clean slate if we're not coming here via ajax |
|
2947 | + if (! defined('DOING_AJAX') |
|
2948 | + && (! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error'])) |
|
2949 | + ) { |
|
2950 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
2951 | + } |
|
2952 | + $this->_template_args['event_name'] = ''; |
|
2953 | + // event name |
|
2954 | + if ($this->_reg_event) { |
|
2955 | + $this->_template_args['event_name'] = $this->_reg_event->name(); |
|
2956 | + $edit_event_url = self::add_query_args_and_nonce( |
|
2957 | + array( |
|
2958 | + 'action' => 'edit', |
|
2959 | + 'post' => $this->_reg_event->ID(), |
|
2960 | + ), |
|
2961 | + EVENTS_ADMIN_URL |
|
2962 | + ); |
|
2963 | + $edit_event_lnk = '<a href="' |
|
2964 | + . $edit_event_url |
|
2965 | + . '" title="' |
|
2966 | + . esc_attr__('Edit ', 'event_espresso') |
|
2967 | + . $this->_reg_event->name() |
|
2968 | + . '">' |
|
2969 | + . esc_html__('Edit Event', 'event_espresso') |
|
2970 | + . '</a>'; |
|
2971 | + $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">' |
|
2972 | + . $edit_event_lnk |
|
2973 | + . '</span>'; |
|
2974 | + } |
|
2975 | + $this->_template_args['step_content'] = $this->_get_registration_step_content(); |
|
2976 | + if (defined('DOING_AJAX')) { |
|
2977 | + $this->_return_json(); |
|
2978 | + } |
|
2979 | + // grab header |
|
2980 | + $template_path = |
|
2981 | + REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php'; |
|
2982 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
2983 | + $template_path, |
|
2984 | + $this->_template_args, |
|
2985 | + true |
|
2986 | + ); |
|
2987 | + // $this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE ); |
|
2988 | + // the details template wrapper |
|
2989 | + $this->display_admin_page_with_sidebar(); |
|
2990 | + } |
|
2991 | + |
|
2992 | + |
|
2993 | + /** |
|
2994 | + * This returns the content for a registration step |
|
2995 | + * |
|
2996 | + * @access protected |
|
2997 | + * @return string html |
|
2998 | + * @throws DomainException |
|
2999 | + * @throws EE_Error |
|
3000 | + * @throws InvalidArgumentException |
|
3001 | + * @throws InvalidDataTypeException |
|
3002 | + * @throws InvalidInterfaceException |
|
3003 | + */ |
|
3004 | + protected function _get_registration_step_content() |
|
3005 | + { |
|
3006 | + if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) { |
|
3007 | + $warning_msg = sprintf( |
|
3008 | + esc_html__( |
|
3009 | + '%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s', |
|
3010 | + 'event_espresso' |
|
3011 | + ), |
|
3012 | + '<br />', |
|
3013 | + '<h3 class="important-notice">', |
|
3014 | + '</h3>', |
|
3015 | + '<div class="float-right">', |
|
3016 | + '<span id="redirect_timer" class="important-notice">30</span>', |
|
3017 | + '</div>', |
|
3018 | + '<b>', |
|
3019 | + '</b>' |
|
3020 | + ); |
|
3021 | + return ' |
|
3022 | 3022 | <div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div> |
3023 | 3023 | <script > |
3024 | 3024 | // WHOAH !!! it appears that someone is using the back button from the Transaction admin page |
@@ -3031,855 +3031,855 @@ discard block |
||
3031 | 3031 | } |
3032 | 3032 | }, 800 ); |
3033 | 3033 | </script >'; |
3034 | - } |
|
3035 | - $template_args = array( |
|
3036 | - 'title' => '', |
|
3037 | - 'content' => '', |
|
3038 | - 'step_button_text' => '', |
|
3039 | - 'show_notification_toggle' => false, |
|
3040 | - ); |
|
3041 | - // to indicate we're processing a new registration |
|
3042 | - $hidden_fields = array( |
|
3043 | - 'processing_registration' => array( |
|
3044 | - 'type' => 'hidden', |
|
3045 | - 'value' => 0, |
|
3046 | - ), |
|
3047 | - 'event_id' => array( |
|
3048 | - 'type' => 'hidden', |
|
3049 | - 'value' => $this->_reg_event->ID(), |
|
3050 | - ), |
|
3051 | - ); |
|
3052 | - // if the cart is empty then we know we're at step one so we'll display ticket selector |
|
3053 | - $cart = EE_Registry::instance()->SSN->cart(); |
|
3054 | - $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
3055 | - switch ($step) { |
|
3056 | - case 'ticket': |
|
3057 | - $hidden_fields['processing_registration']['value'] = 1; |
|
3058 | - $template_args['title'] = esc_html__( |
|
3059 | - 'Step One: Select the Ticket for this registration', |
|
3060 | - 'event_espresso' |
|
3061 | - ); |
|
3062 | - $template_args['content'] = |
|
3063 | - EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event); |
|
3064 | - $template_args['step_button_text'] = esc_html__( |
|
3065 | - 'Add Tickets and Continue to Registrant Details', |
|
3066 | - 'event_espresso' |
|
3067 | - ); |
|
3068 | - $template_args['show_notification_toggle'] = false; |
|
3069 | - break; |
|
3070 | - case 'questions': |
|
3071 | - $hidden_fields['processing_registration']['value'] = 2; |
|
3072 | - $template_args['title'] = esc_html__( |
|
3073 | - 'Step Two: Add Registrant Details for this Registration', |
|
3074 | - 'event_espresso' |
|
3075 | - ); |
|
3076 | - // in theory we should be able to run EED_SPCO at this point because the cart should have been setup |
|
3077 | - // properly by the first process_reg_step run. |
|
3078 | - $template_args['content'] = |
|
3079 | - EED_Single_Page_Checkout::registration_checkout_for_admin(); |
|
3080 | - $template_args['step_button_text'] = esc_html__( |
|
3081 | - 'Save Registration and Continue to Details', |
|
3082 | - 'event_espresso' |
|
3083 | - ); |
|
3084 | - $template_args['show_notification_toggle'] = true; |
|
3085 | - break; |
|
3086 | - } |
|
3087 | - // we come back to the process_registration_step route. |
|
3088 | - $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields); |
|
3089 | - return EEH_Template::display_template( |
|
3090 | - REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php', |
|
3091 | - $template_args, |
|
3092 | - true |
|
3093 | - ); |
|
3094 | - } |
|
3095 | - |
|
3096 | - |
|
3097 | - /** |
|
3098 | - * set_reg_event |
|
3099 | - * |
|
3100 | - * @access private |
|
3101 | - * @return bool |
|
3102 | - * @throws EE_Error |
|
3103 | - * @throws InvalidArgumentException |
|
3104 | - * @throws InvalidDataTypeException |
|
3105 | - * @throws InvalidInterfaceException |
|
3106 | - */ |
|
3107 | - private function _set_reg_event() |
|
3108 | - { |
|
3109 | - if (is_object($this->_reg_event)) { |
|
3110 | - return true; |
|
3111 | - } |
|
3112 | - $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false; |
|
3113 | - if (! $EVT_ID) { |
|
3114 | - return false; |
|
3115 | - } |
|
3116 | - $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
3117 | - return true; |
|
3118 | - } |
|
3119 | - |
|
3120 | - |
|
3121 | - /** |
|
3122 | - * process_reg_step |
|
3123 | - * |
|
3124 | - * @access public |
|
3125 | - * @return string |
|
3126 | - * @throws DomainException |
|
3127 | - * @throws EE_Error |
|
3128 | - * @throws InvalidArgumentException |
|
3129 | - * @throws InvalidDataTypeException |
|
3130 | - * @throws InvalidInterfaceException |
|
3131 | - * @throws ReflectionException |
|
3132 | - * @throws RuntimeException |
|
3133 | - */ |
|
3134 | - public function process_reg_step() |
|
3135 | - { |
|
3136 | - EE_System::do_not_cache(); |
|
3137 | - $this->_set_reg_event(); |
|
3138 | - EE_Registry::instance()->REQ->set_espresso_page(true); |
|
3139 | - EE_Registry::instance()->REQ->set('uts', time()); |
|
3140 | - // what step are we on? |
|
3141 | - $cart = EE_Registry::instance()->SSN->cart(); |
|
3142 | - $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
3143 | - // if doing ajax then we need to verify the nonce |
|
3144 | - if (defined('DOING_AJAX')) { |
|
3145 | - $nonce = isset($this->_req_data[ $this->_req_nonce ]) |
|
3146 | - ? sanitize_text_field($this->_req_data[ $this->_req_nonce ]) : ''; |
|
3147 | - $this->_verify_nonce($nonce, $this->_req_nonce); |
|
3148 | - } |
|
3149 | - switch ($step) { |
|
3150 | - case 'ticket': |
|
3151 | - // process ticket selection |
|
3152 | - $success = EED_Ticket_Selector::instance()->process_ticket_selections(); |
|
3153 | - if ($success) { |
|
3154 | - EE_Error::add_success( |
|
3155 | - esc_html__( |
|
3156 | - 'Tickets Selected. Now complete the registration.', |
|
3157 | - 'event_espresso' |
|
3158 | - ) |
|
3159 | - ); |
|
3160 | - } else { |
|
3161 | - $query_args['step_error'] = $this->_req_data['step_error'] = true; |
|
3162 | - } |
|
3163 | - if (defined('DOING_AJAX')) { |
|
3164 | - $this->new_registration(); // display next step |
|
3165 | - } else { |
|
3166 | - $query_args = array( |
|
3167 | - 'action' => 'new_registration', |
|
3168 | - 'processing_registration' => 1, |
|
3169 | - 'event_id' => $this->_reg_event->ID(), |
|
3170 | - 'uts' => time(), |
|
3171 | - ); |
|
3172 | - $this->_redirect_after_action( |
|
3173 | - false, |
|
3174 | - '', |
|
3175 | - '', |
|
3176 | - $query_args, |
|
3177 | - true |
|
3178 | - ); |
|
3179 | - } |
|
3180 | - break; |
|
3181 | - case 'questions': |
|
3182 | - if (! isset( |
|
3183 | - $this->_req_data['txn_reg_status_change'], |
|
3184 | - $this->_req_data['txn_reg_status_change']['send_notifications'] |
|
3185 | - ) |
|
3186 | - ) { |
|
3187 | - add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15); |
|
3188 | - } |
|
3189 | - // process registration |
|
3190 | - $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin(); |
|
3191 | - if ($cart instanceof EE_Cart) { |
|
3192 | - $grand_total = $cart->get_cart_grand_total(); |
|
3193 | - if ($grand_total instanceof EE_Line_Item) { |
|
3194 | - $grand_total->save_this_and_descendants_to_txn(); |
|
3195 | - } |
|
3196 | - } |
|
3197 | - if (! $transaction instanceof EE_Transaction) { |
|
3198 | - $query_args = array( |
|
3199 | - 'action' => 'new_registration', |
|
3200 | - 'processing_registration' => 2, |
|
3201 | - 'event_id' => $this->_reg_event->ID(), |
|
3202 | - 'uts' => time(), |
|
3203 | - ); |
|
3204 | - if (defined('DOING_AJAX')) { |
|
3205 | - // display registration form again because there are errors (maybe validation?) |
|
3206 | - $this->new_registration(); |
|
3207 | - return; |
|
3208 | - } else { |
|
3209 | - $this->_redirect_after_action( |
|
3210 | - false, |
|
3211 | - '', |
|
3212 | - '', |
|
3213 | - $query_args, |
|
3214 | - true |
|
3215 | - ); |
|
3216 | - return; |
|
3217 | - } |
|
3218 | - } |
|
3219 | - // maybe update status, and make sure to save transaction if not done already |
|
3220 | - if (! $transaction->update_status_based_on_total_paid()) { |
|
3221 | - $transaction->save(); |
|
3222 | - } |
|
3223 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
3224 | - $this->_req_data = array(); |
|
3225 | - $query_args = array( |
|
3226 | - 'action' => 'redirect_to_txn', |
|
3227 | - 'TXN_ID' => $transaction->ID(), |
|
3228 | - 'EVT_ID' => $this->_reg_event->ID(), |
|
3229 | - 'event_name' => urlencode($this->_reg_event->name()), |
|
3230 | - 'redirect_from' => 'new_registration', |
|
3231 | - ); |
|
3232 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
3233 | - break; |
|
3234 | - } |
|
3235 | - // what are you looking here for? Should be nothing to do at this point. |
|
3236 | - } |
|
3237 | - |
|
3238 | - |
|
3239 | - /** |
|
3240 | - * redirect_to_txn |
|
3241 | - * |
|
3242 | - * @access public |
|
3243 | - * @return void |
|
3244 | - * @throws EE_Error |
|
3245 | - * @throws InvalidArgumentException |
|
3246 | - * @throws InvalidDataTypeException |
|
3247 | - * @throws InvalidInterfaceException |
|
3248 | - */ |
|
3249 | - public function redirect_to_txn() |
|
3250 | - { |
|
3251 | - EE_System::do_not_cache(); |
|
3252 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
3253 | - $query_args = array( |
|
3254 | - 'action' => 'view_transaction', |
|
3255 | - 'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0, |
|
3256 | - 'page' => 'espresso_transactions', |
|
3257 | - ); |
|
3258 | - if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) { |
|
3259 | - $query_args['EVT_ID'] = $this->_req_data['EVT_ID']; |
|
3260 | - $query_args['event_name'] = urlencode($this->_req_data['event_name']); |
|
3261 | - $query_args['redirect_from'] = $this->_req_data['redirect_from']; |
|
3262 | - } |
|
3263 | - EE_Error::add_success( |
|
3264 | - esc_html__( |
|
3265 | - 'Registration Created. Please review the transaction and add any payments as necessary', |
|
3266 | - 'event_espresso' |
|
3267 | - ) |
|
3268 | - ); |
|
3269 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
3270 | - } |
|
3271 | - |
|
3272 | - |
|
3273 | - /** |
|
3274 | - * generates HTML for the Attendee Contact List |
|
3275 | - * |
|
3276 | - * @access protected |
|
3277 | - * @return void |
|
3278 | - */ |
|
3279 | - protected function _attendee_contact_list_table() |
|
3280 | - { |
|
3281 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
3282 | - $this->_search_btn_label = esc_html__('Contacts', 'event_espresso'); |
|
3283 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
3284 | - } |
|
3285 | - |
|
3286 | - |
|
3287 | - /** |
|
3288 | - * get_attendees |
|
3289 | - * |
|
3290 | - * @param $per_page |
|
3291 | - * @param bool $count whether to return count or data. |
|
3292 | - * @param bool $trash |
|
3293 | - * @return array |
|
3294 | - * @throws EE_Error |
|
3295 | - * @throws InvalidArgumentException |
|
3296 | - * @throws InvalidDataTypeException |
|
3297 | - * @throws InvalidInterfaceException |
|
3298 | - * @access public |
|
3299 | - */ |
|
3300 | - public function get_attendees($per_page, $count = false, $trash = false) |
|
3301 | - { |
|
3302 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
3303 | - require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php'); |
|
3304 | - $ATT_MDL = EEM_Attendee::instance(); |
|
3305 | - $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
|
3306 | - switch ($this->_req_data['orderby']) { |
|
3307 | - case 'ATT_ID': |
|
3308 | - $orderby = 'ATT_ID'; |
|
3309 | - break; |
|
3310 | - case 'ATT_fname': |
|
3311 | - $orderby = 'ATT_fname'; |
|
3312 | - break; |
|
3313 | - case 'ATT_email': |
|
3314 | - $orderby = 'ATT_email'; |
|
3315 | - break; |
|
3316 | - case 'ATT_city': |
|
3317 | - $orderby = 'ATT_city'; |
|
3318 | - break; |
|
3319 | - case 'STA_ID': |
|
3320 | - $orderby = 'STA_ID'; |
|
3321 | - break; |
|
3322 | - case 'CNT_ID': |
|
3323 | - $orderby = 'CNT_ID'; |
|
3324 | - break; |
|
3325 | - case 'Registration_Count': |
|
3326 | - $orderby = 'Registration_Count'; |
|
3327 | - break; |
|
3328 | - default: |
|
3329 | - $orderby = 'ATT_lname'; |
|
3330 | - } |
|
3331 | - $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) |
|
3332 | - ? $this->_req_data['order'] |
|
3333 | - : 'ASC'; |
|
3334 | - $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) |
|
3335 | - ? $this->_req_data['paged'] |
|
3336 | - : 1; |
|
3337 | - $per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10; |
|
3338 | - $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) |
|
3339 | - ? $this->_req_data['perpage'] |
|
3340 | - : $per_page; |
|
3341 | - $_where = array(); |
|
3342 | - if (! empty($this->_req_data['s'])) { |
|
3343 | - $sstr = '%' . $this->_req_data['s'] . '%'; |
|
3344 | - $_where['OR'] = array( |
|
3345 | - 'Registration.Event.EVT_name' => array('LIKE', $sstr), |
|
3346 | - 'Registration.Event.EVT_desc' => array('LIKE', $sstr), |
|
3347 | - 'Registration.Event.EVT_short_desc' => array('LIKE', $sstr), |
|
3348 | - 'ATT_fname' => array('LIKE', $sstr), |
|
3349 | - 'ATT_lname' => array('LIKE', $sstr), |
|
3350 | - 'ATT_short_bio' => array('LIKE', $sstr), |
|
3351 | - 'ATT_email' => array('LIKE', $sstr), |
|
3352 | - 'ATT_address' => array('LIKE', $sstr), |
|
3353 | - 'ATT_address2' => array('LIKE', $sstr), |
|
3354 | - 'ATT_city' => array('LIKE', $sstr), |
|
3355 | - 'Country.CNT_name' => array('LIKE', $sstr), |
|
3356 | - 'State.STA_name' => array('LIKE', $sstr), |
|
3357 | - 'ATT_phone' => array('LIKE', $sstr), |
|
3358 | - 'Registration.REG_final_price' => array('LIKE', $sstr), |
|
3359 | - 'Registration.REG_code' => array('LIKE', $sstr), |
|
3360 | - 'Registration.REG_group_size' => array('LIKE', $sstr), |
|
3361 | - ); |
|
3362 | - } |
|
3363 | - $offset = ($current_page - 1) * $per_page; |
|
3364 | - $limit = $count ? null : array($offset, $per_page); |
|
3365 | - $query_args = array( |
|
3366 | - $_where, |
|
3367 | - 'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')), |
|
3368 | - 'limit' => $limit, |
|
3369 | - ); |
|
3370 | - if (! $count) { |
|
3371 | - $query_args['order_by'] = array($orderby => $sort); |
|
3372 | - } |
|
3373 | - if ($trash) { |
|
3374 | - $query_args[0]['status'] = array('!=', 'publish'); |
|
3375 | - $all_attendees = $count |
|
3376 | - ? $ATT_MDL->count($query_args, 'ATT_ID', true) |
|
3377 | - : $ATT_MDL->get_all($query_args); |
|
3378 | - } else { |
|
3379 | - $query_args[0]['status'] = array('IN', array('publish')); |
|
3380 | - $all_attendees = $count |
|
3381 | - ? $ATT_MDL->count($query_args, 'ATT_ID', true) |
|
3382 | - : $ATT_MDL->get_all($query_args); |
|
3383 | - } |
|
3384 | - return $all_attendees; |
|
3385 | - } |
|
3386 | - |
|
3387 | - |
|
3388 | - /** |
|
3389 | - * This is just taking care of resending the registration confirmation |
|
3390 | - * |
|
3391 | - * @access protected |
|
3392 | - * @return void |
|
3393 | - */ |
|
3394 | - protected function _resend_registration() |
|
3395 | - { |
|
3396 | - $this->_process_resend_registration(); |
|
3397 | - $query_args = isset($this->_req_data['redirect_to']) |
|
3398 | - ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID']) |
|
3399 | - : array('action' => 'default'); |
|
3400 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
3401 | - } |
|
3402 | - |
|
3403 | - /** |
|
3404 | - * Creates a registration report, but accepts the name of a method to use for preparing the query parameters |
|
3405 | - * to use when selecting registrations |
|
3406 | - * |
|
3407 | - * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing |
|
3408 | - * the query parameters from the request |
|
3409 | - * @return void ends the request with a redirect or download |
|
3410 | - */ |
|
3411 | - public function _registrations_report_base($method_name_for_getting_query_params) |
|
3412 | - { |
|
3413 | - if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
3414 | - wp_redirect( |
|
3415 | - EE_Admin_Page::add_query_args_and_nonce( |
|
3416 | - array( |
|
3417 | - 'page' => 'espresso_batch', |
|
3418 | - 'batch' => 'file', |
|
3419 | - 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
3420 | - 'filters' => urlencode( |
|
3421 | - serialize( |
|
3422 | - call_user_func( |
|
3423 | - array($this, $method_name_for_getting_query_params), |
|
3424 | - EEH_Array::is_set( |
|
3425 | - $this->_req_data, |
|
3426 | - 'filters', |
|
3427 | - array() |
|
3428 | - ) |
|
3429 | - ) |
|
3430 | - ) |
|
3431 | - ), |
|
3432 | - 'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false), |
|
3433 | - 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'), |
|
3434 | - 'return_url' => urlencode($this->_req_data['return_url']), |
|
3435 | - ) |
|
3436 | - ) |
|
3437 | - ); |
|
3438 | - } else { |
|
3439 | - $new_request_args = array( |
|
3440 | - 'export' => 'report', |
|
3441 | - 'action' => 'registrations_report_for_event', |
|
3442 | - 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
3443 | - ); |
|
3444 | - $this->_req_data = array_merge($this->_req_data, $new_request_args); |
|
3445 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
3446 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
3447 | - $EE_Export = EE_Export::instance($this->_req_data); |
|
3448 | - $EE_Export->export(); |
|
3449 | - } |
|
3450 | - } |
|
3451 | - } |
|
3452 | - |
|
3453 | - |
|
3454 | - /** |
|
3455 | - * Creates a registration report using only query parameters in the request |
|
3456 | - * |
|
3457 | - * @return void |
|
3458 | - */ |
|
3459 | - public function _registrations_report() |
|
3460 | - { |
|
3461 | - $this->_registrations_report_base('_get_registration_query_parameters'); |
|
3462 | - } |
|
3463 | - |
|
3464 | - |
|
3465 | - public function _contact_list_export() |
|
3466 | - { |
|
3467 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
3468 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
3469 | - $EE_Export = EE_Export::instance($this->_req_data); |
|
3470 | - $EE_Export->export_attendees(); |
|
3471 | - } |
|
3472 | - } |
|
3473 | - |
|
3474 | - |
|
3475 | - public function _contact_list_report() |
|
3476 | - { |
|
3477 | - if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
3478 | - wp_redirect( |
|
3479 | - EE_Admin_Page::add_query_args_and_nonce( |
|
3480 | - array( |
|
3481 | - 'page' => 'espresso_batch', |
|
3482 | - 'batch' => 'file', |
|
3483 | - 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'), |
|
3484 | - 'return_url' => urlencode($this->_req_data['return_url']), |
|
3485 | - ) |
|
3486 | - ) |
|
3487 | - ); |
|
3488 | - } else { |
|
3489 | - if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
3490 | - require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
3491 | - $EE_Export = EE_Export::instance($this->_req_data); |
|
3492 | - $EE_Export->report_attendees(); |
|
3493 | - } |
|
3494 | - } |
|
3495 | - } |
|
3496 | - |
|
3497 | - |
|
3498 | - |
|
3499 | - |
|
3500 | - |
|
3501 | - /*************************************** ATTENDEE DETAILS ***************************************/ |
|
3502 | - /** |
|
3503 | - * This duplicates the attendee object for the given incoming registration id and attendee_id. |
|
3504 | - * |
|
3505 | - * @return void |
|
3506 | - * @throws EE_Error |
|
3507 | - * @throws InvalidArgumentException |
|
3508 | - * @throws InvalidDataTypeException |
|
3509 | - * @throws InvalidInterfaceException |
|
3510 | - */ |
|
3511 | - protected function _duplicate_attendee() |
|
3512 | - { |
|
3513 | - $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default'; |
|
3514 | - // verify we have necessary info |
|
3515 | - if (empty($this->_req_data['_REG_ID'])) { |
|
3516 | - EE_Error::add_error( |
|
3517 | - esc_html__( |
|
3518 | - 'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )', |
|
3519 | - 'event_espresso' |
|
3520 | - ), |
|
3521 | - __FILE__, |
|
3522 | - __LINE__, |
|
3523 | - __FUNCTION__ |
|
3524 | - ); |
|
3525 | - $query_args = array('action' => $action); |
|
3526 | - $this->_redirect_after_action('', '', '', $query_args, true); |
|
3527 | - } |
|
3528 | - // okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration. |
|
3529 | - $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']); |
|
3530 | - $attendee = $registration->attendee(); |
|
3531 | - // remove relation of existing attendee on registration |
|
3532 | - $registration->_remove_relation_to($attendee, 'Attendee'); |
|
3533 | - // new attendee |
|
3534 | - $new_attendee = clone $attendee; |
|
3535 | - $new_attendee->set('ATT_ID', 0); |
|
3536 | - $new_attendee->save(); |
|
3537 | - // add new attendee to reg |
|
3538 | - $registration->_add_relation_to($new_attendee, 'Attendee'); |
|
3539 | - EE_Error::add_success( |
|
3540 | - esc_html__( |
|
3541 | - 'New Contact record created. Now make any edits you wish to make for this contact.', |
|
3542 | - 'event_espresso' |
|
3543 | - ) |
|
3544 | - ); |
|
3545 | - // redirect to edit page for attendee |
|
3546 | - $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee'); |
|
3547 | - $this->_redirect_after_action('', '', '', $query_args, true); |
|
3548 | - } |
|
3549 | - |
|
3550 | - |
|
3551 | - /** |
|
3552 | - * Callback invoked by parent EE_Admin_CPT class hooked in on `save_post` wp hook. |
|
3553 | - * |
|
3554 | - * @param int $post_id |
|
3555 | - * @param WP_POST $post |
|
3556 | - * @throws DomainException |
|
3557 | - * @throws EE_Error |
|
3558 | - * @throws InvalidArgumentException |
|
3559 | - * @throws InvalidDataTypeException |
|
3560 | - * @throws InvalidInterfaceException |
|
3561 | - * @throws LogicException |
|
3562 | - * @throws InvalidFormSubmissionException |
|
3563 | - */ |
|
3564 | - protected function _insert_update_cpt_item($post_id, $post) |
|
3565 | - { |
|
3566 | - $success = true; |
|
3567 | - $attendee = $post instanceof WP_Post && $post->post_type === 'espresso_attendees' |
|
3568 | - ? EEM_Attendee::instance()->get_one_by_ID($post_id) |
|
3569 | - : null; |
|
3570 | - // for attendee updates |
|
3571 | - if ($attendee instanceof EE_Attendee) { |
|
3572 | - // note we should only be UPDATING attendees at this point. |
|
3573 | - $updated_fields = array( |
|
3574 | - 'ATT_fname' => $this->_req_data['ATT_fname'], |
|
3575 | - 'ATT_lname' => $this->_req_data['ATT_lname'], |
|
3576 | - 'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'], |
|
3577 | - 'ATT_address' => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '', |
|
3578 | - 'ATT_address2' => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '', |
|
3579 | - 'ATT_city' => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '', |
|
3580 | - 'STA_ID' => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '', |
|
3581 | - 'CNT_ISO' => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '', |
|
3582 | - 'ATT_zip' => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '', |
|
3583 | - ); |
|
3584 | - foreach ($updated_fields as $field => $value) { |
|
3585 | - $attendee->set($field, $value); |
|
3586 | - } |
|
3587 | - |
|
3588 | - // process contact details metabox form handler (which will also save the attendee) |
|
3589 | - $contact_details_form = $this->getAttendeeContactDetailsMetaboxFormHandler($attendee); |
|
3590 | - $success = $contact_details_form->process($this->_req_data); |
|
3591 | - |
|
3592 | - $attendee_update_callbacks = apply_filters( |
|
3593 | - 'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update', |
|
3594 | - array() |
|
3595 | - ); |
|
3596 | - foreach ($attendee_update_callbacks as $a_callback) { |
|
3597 | - if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) { |
|
3598 | - throw new EE_Error( |
|
3599 | - sprintf( |
|
3600 | - esc_html__( |
|
3601 | - 'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback. Please check the spelling.', |
|
3602 | - 'event_espresso' |
|
3603 | - ), |
|
3604 | - $a_callback |
|
3605 | - ) |
|
3606 | - ); |
|
3607 | - } |
|
3608 | - } |
|
3609 | - } |
|
3610 | - |
|
3611 | - if ($success === false) { |
|
3612 | - EE_Error::add_error( |
|
3613 | - esc_html__( |
|
3614 | - 'Something went wrong with updating the meta table data for the registration.', |
|
3615 | - 'event_espresso' |
|
3616 | - ), |
|
3617 | - __FILE__, |
|
3618 | - __FUNCTION__, |
|
3619 | - __LINE__ |
|
3620 | - ); |
|
3621 | - } |
|
3622 | - } |
|
3623 | - |
|
3624 | - |
|
3625 | - public function trash_cpt_item($post_id) |
|
3626 | - { |
|
3627 | - } |
|
3628 | - |
|
3629 | - |
|
3630 | - public function delete_cpt_item($post_id) |
|
3631 | - { |
|
3632 | - } |
|
3633 | - |
|
3634 | - |
|
3635 | - public function restore_cpt_item($post_id) |
|
3636 | - { |
|
3637 | - } |
|
3638 | - |
|
3639 | - |
|
3640 | - protected function _restore_cpt_item($post_id, $revision_id) |
|
3641 | - { |
|
3642 | - } |
|
3643 | - |
|
3644 | - |
|
3645 | - public function attendee_editor_metaboxes() |
|
3646 | - { |
|
3647 | - $this->verify_cpt_object(); |
|
3648 | - remove_meta_box( |
|
3649 | - 'postexcerpt', |
|
3650 | - esc_html__('Excerpt', 'event_espresso'), |
|
3651 | - 'post_excerpt_meta_box', |
|
3652 | - $this->_cpt_routes[ $this->_req_action ], |
|
3653 | - 'normal', |
|
3654 | - 'core' |
|
3655 | - ); |
|
3656 | - remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal', 'core'); |
|
3657 | - if (post_type_supports('espresso_attendees', 'excerpt')) { |
|
3658 | - add_meta_box( |
|
3659 | - 'postexcerpt', |
|
3660 | - esc_html__('Short Biography', 'event_espresso'), |
|
3661 | - 'post_excerpt_meta_box', |
|
3662 | - $this->_cpt_routes[ $this->_req_action ], |
|
3663 | - 'normal' |
|
3664 | - ); |
|
3665 | - } |
|
3666 | - if (post_type_supports('espresso_attendees', 'comments')) { |
|
3667 | - add_meta_box( |
|
3668 | - 'commentsdiv', |
|
3669 | - esc_html__('Notes on the Contact', 'event_espresso'), |
|
3670 | - 'post_comment_meta_box', |
|
3671 | - $this->_cpt_routes[ $this->_req_action ], |
|
3672 | - 'normal', |
|
3673 | - 'core' |
|
3674 | - ); |
|
3675 | - } |
|
3676 | - add_meta_box( |
|
3677 | - 'attendee_contact_info', |
|
3678 | - esc_html__('Contact Info', 'event_espresso'), |
|
3679 | - array($this, 'attendee_contact_info'), |
|
3680 | - $this->_cpt_routes[ $this->_req_action ], |
|
3681 | - 'side', |
|
3682 | - 'core' |
|
3683 | - ); |
|
3684 | - add_meta_box( |
|
3685 | - 'attendee_details_address', |
|
3686 | - esc_html__('Address Details', 'event_espresso'), |
|
3687 | - array($this, 'attendee_address_details'), |
|
3688 | - $this->_cpt_routes[ $this->_req_action ], |
|
3689 | - 'normal', |
|
3690 | - 'core' |
|
3691 | - ); |
|
3692 | - add_meta_box( |
|
3693 | - 'attendee_registrations', |
|
3694 | - esc_html__('Registrations for this Contact', 'event_espresso'), |
|
3695 | - array($this, 'attendee_registrations_meta_box'), |
|
3696 | - $this->_cpt_routes[ $this->_req_action ], |
|
3697 | - 'normal', |
|
3698 | - 'high' |
|
3699 | - ); |
|
3700 | - } |
|
3701 | - |
|
3702 | - |
|
3703 | - /** |
|
3704 | - * Metabox for attendee contact info |
|
3705 | - * |
|
3706 | - * @param WP_Post $post wp post object |
|
3707 | - * @return string attendee contact info ( and form ) |
|
3708 | - * @throws EE_Error |
|
3709 | - * @throws InvalidArgumentException |
|
3710 | - * @throws InvalidDataTypeException |
|
3711 | - * @throws InvalidInterfaceException |
|
3712 | - * @throws LogicException |
|
3713 | - * @throws DomainException |
|
3714 | - */ |
|
3715 | - public function attendee_contact_info($post) |
|
3716 | - { |
|
3717 | - // get attendee object ( should already have it ) |
|
3718 | - $form = $this->getAttendeeContactDetailsMetaboxFormHandler($this->_cpt_model_obj); |
|
3719 | - $form->enqueueStylesAndScripts(); |
|
3720 | - echo $form->display(); |
|
3721 | - } |
|
3722 | - |
|
3723 | - |
|
3724 | - /** |
|
3725 | - * Return form handler for the contact details metabox |
|
3726 | - * |
|
3727 | - * @param EE_Attendee $attendee |
|
3728 | - * @return AttendeeContactDetailsMetaboxFormHandler |
|
3729 | - * @throws DomainException |
|
3730 | - * @throws InvalidArgumentException |
|
3731 | - * @throws InvalidDataTypeException |
|
3732 | - * @throws InvalidInterfaceException |
|
3733 | - */ |
|
3734 | - protected function getAttendeeContactDetailsMetaboxFormHandler(EE_Attendee $attendee) |
|
3735 | - { |
|
3736 | - return new AttendeeContactDetailsMetaboxFormHandler($attendee, EE_Registry::instance()); |
|
3737 | - } |
|
3738 | - |
|
3739 | - |
|
3740 | - /** |
|
3741 | - * Metabox for attendee details |
|
3742 | - * |
|
3743 | - * @param WP_Post $post wp post object |
|
3744 | - * @throws DomainException |
|
3745 | - */ |
|
3746 | - public function attendee_address_details($post) |
|
3747 | - { |
|
3748 | - // get attendee object (should already have it) |
|
3749 | - $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
3750 | - $this->_template_args['state_html'] = EEH_Form_Fields::generate_form_input( |
|
3751 | - new EE_Question_Form_Input( |
|
3752 | - EE_Question::new_instance( |
|
3753 | - array( |
|
3754 | - 'QST_ID' => 0, |
|
3755 | - 'QST_display_text' => esc_html__('State/Province', 'event_espresso'), |
|
3756 | - 'QST_system' => 'admin-state', |
|
3757 | - ) |
|
3758 | - ), |
|
3759 | - EE_Answer::new_instance( |
|
3760 | - array( |
|
3761 | - 'ANS_ID' => 0, |
|
3762 | - 'ANS_value' => $this->_cpt_model_obj->state_ID(), |
|
3763 | - ) |
|
3764 | - ), |
|
3765 | - array( |
|
3766 | - 'input_id' => 'STA_ID', |
|
3767 | - 'input_name' => 'STA_ID', |
|
3768 | - 'input_prefix' => '', |
|
3769 | - 'append_qstn_id' => false, |
|
3770 | - ) |
|
3771 | - ) |
|
3772 | - ); |
|
3773 | - $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input( |
|
3774 | - new EE_Question_Form_Input( |
|
3775 | - EE_Question::new_instance( |
|
3776 | - array( |
|
3777 | - 'QST_ID' => 0, |
|
3778 | - 'QST_display_text' => esc_html__('Country', 'event_espresso'), |
|
3779 | - 'QST_system' => 'admin-country', |
|
3780 | - ) |
|
3781 | - ), |
|
3782 | - EE_Answer::new_instance( |
|
3783 | - array( |
|
3784 | - 'ANS_ID' => 0, |
|
3785 | - 'ANS_value' => $this->_cpt_model_obj->country_ID(), |
|
3786 | - ) |
|
3787 | - ), |
|
3788 | - array( |
|
3789 | - 'input_id' => 'CNT_ISO', |
|
3790 | - 'input_name' => 'CNT_ISO', |
|
3791 | - 'input_prefix' => '', |
|
3792 | - 'append_qstn_id' => false, |
|
3793 | - ) |
|
3794 | - ) |
|
3795 | - ); |
|
3796 | - $template = |
|
3797 | - REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php'; |
|
3798 | - EEH_Template::display_template($template, $this->_template_args); |
|
3799 | - } |
|
3800 | - |
|
3801 | - |
|
3802 | - /** |
|
3803 | - * _attendee_details |
|
3804 | - * |
|
3805 | - * @access protected |
|
3806 | - * @param $post |
|
3807 | - * @return void |
|
3808 | - * @throws DomainException |
|
3809 | - * @throws EE_Error |
|
3810 | - */ |
|
3811 | - public function attendee_registrations_meta_box($post) |
|
3812 | - { |
|
3813 | - $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
3814 | - $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration'); |
|
3815 | - $template = |
|
3816 | - REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php'; |
|
3817 | - EEH_Template::display_template($template, $this->_template_args); |
|
3818 | - } |
|
3819 | - |
|
3820 | - |
|
3821 | - /** |
|
3822 | - * add in the form fields for the attendee edit |
|
3823 | - * |
|
3824 | - * @param WP_Post $post wp post object |
|
3825 | - * @return string html for new form. |
|
3826 | - * @throws DomainException |
|
3827 | - */ |
|
3828 | - public function after_title_form_fields($post) |
|
3829 | - { |
|
3830 | - if ($post->post_type == 'espresso_attendees') { |
|
3831 | - $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php'; |
|
3832 | - $template_args['attendee'] = $this->_cpt_model_obj; |
|
3833 | - EEH_Template::display_template($template, $template_args); |
|
3834 | - } |
|
3835 | - } |
|
3836 | - |
|
3837 | - |
|
3838 | - /** |
|
3839 | - * _trash_or_restore_attendee |
|
3840 | - * |
|
3841 | - * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE) |
|
3842 | - * @return void |
|
3843 | - * @throws EE_Error |
|
3844 | - * @throws InvalidArgumentException |
|
3845 | - * @throws InvalidDataTypeException |
|
3846 | - * @throws InvalidInterfaceException |
|
3847 | - * @access protected |
|
3848 | - */ |
|
3849 | - protected function _trash_or_restore_attendees($trash = true) |
|
3850 | - { |
|
3851 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
3852 | - $ATT_MDL = EEM_Attendee::instance(); |
|
3853 | - $success = 1; |
|
3854 | - // Checkboxes |
|
3855 | - if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
3856 | - // if array has more than one element than success message should be plural |
|
3857 | - $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
|
3858 | - // cycle thru checkboxes |
|
3859 | - while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) { |
|
3860 | - $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID) |
|
3861 | - : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID); |
|
3862 | - if (! $updated) { |
|
3863 | - $success = 0; |
|
3864 | - } |
|
3865 | - } |
|
3866 | - } else { |
|
3867 | - // grab single id and delete |
|
3868 | - $ATT_ID = absint($this->_req_data['ATT_ID']); |
|
3869 | - // get attendee |
|
3870 | - $att = $ATT_MDL->get_one_by_ID($ATT_ID); |
|
3871 | - $updated = $trash ? $att->set_status('trash') : $att->set_status('publish'); |
|
3872 | - $updated = $att->save(); |
|
3873 | - if (! $updated) { |
|
3874 | - $success = 0; |
|
3875 | - } |
|
3876 | - } |
|
3877 | - $what = $success > 1 |
|
3878 | - ? esc_html__('Contacts', 'event_espresso') |
|
3879 | - : esc_html__('Contact', 'event_espresso'); |
|
3880 | - $action_desc = $trash |
|
3881 | - ? esc_html__('moved to the trash', 'event_espresso') |
|
3882 | - : esc_html__('restored', 'event_espresso'); |
|
3883 | - $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list')); |
|
3884 | - } |
|
3034 | + } |
|
3035 | + $template_args = array( |
|
3036 | + 'title' => '', |
|
3037 | + 'content' => '', |
|
3038 | + 'step_button_text' => '', |
|
3039 | + 'show_notification_toggle' => false, |
|
3040 | + ); |
|
3041 | + // to indicate we're processing a new registration |
|
3042 | + $hidden_fields = array( |
|
3043 | + 'processing_registration' => array( |
|
3044 | + 'type' => 'hidden', |
|
3045 | + 'value' => 0, |
|
3046 | + ), |
|
3047 | + 'event_id' => array( |
|
3048 | + 'type' => 'hidden', |
|
3049 | + 'value' => $this->_reg_event->ID(), |
|
3050 | + ), |
|
3051 | + ); |
|
3052 | + // if the cart is empty then we know we're at step one so we'll display ticket selector |
|
3053 | + $cart = EE_Registry::instance()->SSN->cart(); |
|
3054 | + $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
3055 | + switch ($step) { |
|
3056 | + case 'ticket': |
|
3057 | + $hidden_fields['processing_registration']['value'] = 1; |
|
3058 | + $template_args['title'] = esc_html__( |
|
3059 | + 'Step One: Select the Ticket for this registration', |
|
3060 | + 'event_espresso' |
|
3061 | + ); |
|
3062 | + $template_args['content'] = |
|
3063 | + EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event); |
|
3064 | + $template_args['step_button_text'] = esc_html__( |
|
3065 | + 'Add Tickets and Continue to Registrant Details', |
|
3066 | + 'event_espresso' |
|
3067 | + ); |
|
3068 | + $template_args['show_notification_toggle'] = false; |
|
3069 | + break; |
|
3070 | + case 'questions': |
|
3071 | + $hidden_fields['processing_registration']['value'] = 2; |
|
3072 | + $template_args['title'] = esc_html__( |
|
3073 | + 'Step Two: Add Registrant Details for this Registration', |
|
3074 | + 'event_espresso' |
|
3075 | + ); |
|
3076 | + // in theory we should be able to run EED_SPCO at this point because the cart should have been setup |
|
3077 | + // properly by the first process_reg_step run. |
|
3078 | + $template_args['content'] = |
|
3079 | + EED_Single_Page_Checkout::registration_checkout_for_admin(); |
|
3080 | + $template_args['step_button_text'] = esc_html__( |
|
3081 | + 'Save Registration and Continue to Details', |
|
3082 | + 'event_espresso' |
|
3083 | + ); |
|
3084 | + $template_args['show_notification_toggle'] = true; |
|
3085 | + break; |
|
3086 | + } |
|
3087 | + // we come back to the process_registration_step route. |
|
3088 | + $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields); |
|
3089 | + return EEH_Template::display_template( |
|
3090 | + REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php', |
|
3091 | + $template_args, |
|
3092 | + true |
|
3093 | + ); |
|
3094 | + } |
|
3095 | + |
|
3096 | + |
|
3097 | + /** |
|
3098 | + * set_reg_event |
|
3099 | + * |
|
3100 | + * @access private |
|
3101 | + * @return bool |
|
3102 | + * @throws EE_Error |
|
3103 | + * @throws InvalidArgumentException |
|
3104 | + * @throws InvalidDataTypeException |
|
3105 | + * @throws InvalidInterfaceException |
|
3106 | + */ |
|
3107 | + private function _set_reg_event() |
|
3108 | + { |
|
3109 | + if (is_object($this->_reg_event)) { |
|
3110 | + return true; |
|
3111 | + } |
|
3112 | + $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false; |
|
3113 | + if (! $EVT_ID) { |
|
3114 | + return false; |
|
3115 | + } |
|
3116 | + $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID); |
|
3117 | + return true; |
|
3118 | + } |
|
3119 | + |
|
3120 | + |
|
3121 | + /** |
|
3122 | + * process_reg_step |
|
3123 | + * |
|
3124 | + * @access public |
|
3125 | + * @return string |
|
3126 | + * @throws DomainException |
|
3127 | + * @throws EE_Error |
|
3128 | + * @throws InvalidArgumentException |
|
3129 | + * @throws InvalidDataTypeException |
|
3130 | + * @throws InvalidInterfaceException |
|
3131 | + * @throws ReflectionException |
|
3132 | + * @throws RuntimeException |
|
3133 | + */ |
|
3134 | + public function process_reg_step() |
|
3135 | + { |
|
3136 | + EE_System::do_not_cache(); |
|
3137 | + $this->_set_reg_event(); |
|
3138 | + EE_Registry::instance()->REQ->set_espresso_page(true); |
|
3139 | + EE_Registry::instance()->REQ->set('uts', time()); |
|
3140 | + // what step are we on? |
|
3141 | + $cart = EE_Registry::instance()->SSN->cart(); |
|
3142 | + $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions'; |
|
3143 | + // if doing ajax then we need to verify the nonce |
|
3144 | + if (defined('DOING_AJAX')) { |
|
3145 | + $nonce = isset($this->_req_data[ $this->_req_nonce ]) |
|
3146 | + ? sanitize_text_field($this->_req_data[ $this->_req_nonce ]) : ''; |
|
3147 | + $this->_verify_nonce($nonce, $this->_req_nonce); |
|
3148 | + } |
|
3149 | + switch ($step) { |
|
3150 | + case 'ticket': |
|
3151 | + // process ticket selection |
|
3152 | + $success = EED_Ticket_Selector::instance()->process_ticket_selections(); |
|
3153 | + if ($success) { |
|
3154 | + EE_Error::add_success( |
|
3155 | + esc_html__( |
|
3156 | + 'Tickets Selected. Now complete the registration.', |
|
3157 | + 'event_espresso' |
|
3158 | + ) |
|
3159 | + ); |
|
3160 | + } else { |
|
3161 | + $query_args['step_error'] = $this->_req_data['step_error'] = true; |
|
3162 | + } |
|
3163 | + if (defined('DOING_AJAX')) { |
|
3164 | + $this->new_registration(); // display next step |
|
3165 | + } else { |
|
3166 | + $query_args = array( |
|
3167 | + 'action' => 'new_registration', |
|
3168 | + 'processing_registration' => 1, |
|
3169 | + 'event_id' => $this->_reg_event->ID(), |
|
3170 | + 'uts' => time(), |
|
3171 | + ); |
|
3172 | + $this->_redirect_after_action( |
|
3173 | + false, |
|
3174 | + '', |
|
3175 | + '', |
|
3176 | + $query_args, |
|
3177 | + true |
|
3178 | + ); |
|
3179 | + } |
|
3180 | + break; |
|
3181 | + case 'questions': |
|
3182 | + if (! isset( |
|
3183 | + $this->_req_data['txn_reg_status_change'], |
|
3184 | + $this->_req_data['txn_reg_status_change']['send_notifications'] |
|
3185 | + ) |
|
3186 | + ) { |
|
3187 | + add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15); |
|
3188 | + } |
|
3189 | + // process registration |
|
3190 | + $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin(); |
|
3191 | + if ($cart instanceof EE_Cart) { |
|
3192 | + $grand_total = $cart->get_cart_grand_total(); |
|
3193 | + if ($grand_total instanceof EE_Line_Item) { |
|
3194 | + $grand_total->save_this_and_descendants_to_txn(); |
|
3195 | + } |
|
3196 | + } |
|
3197 | + if (! $transaction instanceof EE_Transaction) { |
|
3198 | + $query_args = array( |
|
3199 | + 'action' => 'new_registration', |
|
3200 | + 'processing_registration' => 2, |
|
3201 | + 'event_id' => $this->_reg_event->ID(), |
|
3202 | + 'uts' => time(), |
|
3203 | + ); |
|
3204 | + if (defined('DOING_AJAX')) { |
|
3205 | + // display registration form again because there are errors (maybe validation?) |
|
3206 | + $this->new_registration(); |
|
3207 | + return; |
|
3208 | + } else { |
|
3209 | + $this->_redirect_after_action( |
|
3210 | + false, |
|
3211 | + '', |
|
3212 | + '', |
|
3213 | + $query_args, |
|
3214 | + true |
|
3215 | + ); |
|
3216 | + return; |
|
3217 | + } |
|
3218 | + } |
|
3219 | + // maybe update status, and make sure to save transaction if not done already |
|
3220 | + if (! $transaction->update_status_based_on_total_paid()) { |
|
3221 | + $transaction->save(); |
|
3222 | + } |
|
3223 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
3224 | + $this->_req_data = array(); |
|
3225 | + $query_args = array( |
|
3226 | + 'action' => 'redirect_to_txn', |
|
3227 | + 'TXN_ID' => $transaction->ID(), |
|
3228 | + 'EVT_ID' => $this->_reg_event->ID(), |
|
3229 | + 'event_name' => urlencode($this->_reg_event->name()), |
|
3230 | + 'redirect_from' => 'new_registration', |
|
3231 | + ); |
|
3232 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
3233 | + break; |
|
3234 | + } |
|
3235 | + // what are you looking here for? Should be nothing to do at this point. |
|
3236 | + } |
|
3237 | + |
|
3238 | + |
|
3239 | + /** |
|
3240 | + * redirect_to_txn |
|
3241 | + * |
|
3242 | + * @access public |
|
3243 | + * @return void |
|
3244 | + * @throws EE_Error |
|
3245 | + * @throws InvalidArgumentException |
|
3246 | + * @throws InvalidDataTypeException |
|
3247 | + * @throws InvalidInterfaceException |
|
3248 | + */ |
|
3249 | + public function redirect_to_txn() |
|
3250 | + { |
|
3251 | + EE_System::do_not_cache(); |
|
3252 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
3253 | + $query_args = array( |
|
3254 | + 'action' => 'view_transaction', |
|
3255 | + 'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0, |
|
3256 | + 'page' => 'espresso_transactions', |
|
3257 | + ); |
|
3258 | + if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) { |
|
3259 | + $query_args['EVT_ID'] = $this->_req_data['EVT_ID']; |
|
3260 | + $query_args['event_name'] = urlencode($this->_req_data['event_name']); |
|
3261 | + $query_args['redirect_from'] = $this->_req_data['redirect_from']; |
|
3262 | + } |
|
3263 | + EE_Error::add_success( |
|
3264 | + esc_html__( |
|
3265 | + 'Registration Created. Please review the transaction and add any payments as necessary', |
|
3266 | + 'event_espresso' |
|
3267 | + ) |
|
3268 | + ); |
|
3269 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
3270 | + } |
|
3271 | + |
|
3272 | + |
|
3273 | + /** |
|
3274 | + * generates HTML for the Attendee Contact List |
|
3275 | + * |
|
3276 | + * @access protected |
|
3277 | + * @return void |
|
3278 | + */ |
|
3279 | + protected function _attendee_contact_list_table() |
|
3280 | + { |
|
3281 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
3282 | + $this->_search_btn_label = esc_html__('Contacts', 'event_espresso'); |
|
3283 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
3284 | + } |
|
3285 | + |
|
3286 | + |
|
3287 | + /** |
|
3288 | + * get_attendees |
|
3289 | + * |
|
3290 | + * @param $per_page |
|
3291 | + * @param bool $count whether to return count or data. |
|
3292 | + * @param bool $trash |
|
3293 | + * @return array |
|
3294 | + * @throws EE_Error |
|
3295 | + * @throws InvalidArgumentException |
|
3296 | + * @throws InvalidDataTypeException |
|
3297 | + * @throws InvalidInterfaceException |
|
3298 | + * @access public |
|
3299 | + */ |
|
3300 | + public function get_attendees($per_page, $count = false, $trash = false) |
|
3301 | + { |
|
3302 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
3303 | + require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php'); |
|
3304 | + $ATT_MDL = EEM_Attendee::instance(); |
|
3305 | + $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : ''; |
|
3306 | + switch ($this->_req_data['orderby']) { |
|
3307 | + case 'ATT_ID': |
|
3308 | + $orderby = 'ATT_ID'; |
|
3309 | + break; |
|
3310 | + case 'ATT_fname': |
|
3311 | + $orderby = 'ATT_fname'; |
|
3312 | + break; |
|
3313 | + case 'ATT_email': |
|
3314 | + $orderby = 'ATT_email'; |
|
3315 | + break; |
|
3316 | + case 'ATT_city': |
|
3317 | + $orderby = 'ATT_city'; |
|
3318 | + break; |
|
3319 | + case 'STA_ID': |
|
3320 | + $orderby = 'STA_ID'; |
|
3321 | + break; |
|
3322 | + case 'CNT_ID': |
|
3323 | + $orderby = 'CNT_ID'; |
|
3324 | + break; |
|
3325 | + case 'Registration_Count': |
|
3326 | + $orderby = 'Registration_Count'; |
|
3327 | + break; |
|
3328 | + default: |
|
3329 | + $orderby = 'ATT_lname'; |
|
3330 | + } |
|
3331 | + $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) |
|
3332 | + ? $this->_req_data['order'] |
|
3333 | + : 'ASC'; |
|
3334 | + $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) |
|
3335 | + ? $this->_req_data['paged'] |
|
3336 | + : 1; |
|
3337 | + $per_page = isset($per_page) && ! empty($per_page) ? $per_page : 10; |
|
3338 | + $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) |
|
3339 | + ? $this->_req_data['perpage'] |
|
3340 | + : $per_page; |
|
3341 | + $_where = array(); |
|
3342 | + if (! empty($this->_req_data['s'])) { |
|
3343 | + $sstr = '%' . $this->_req_data['s'] . '%'; |
|
3344 | + $_where['OR'] = array( |
|
3345 | + 'Registration.Event.EVT_name' => array('LIKE', $sstr), |
|
3346 | + 'Registration.Event.EVT_desc' => array('LIKE', $sstr), |
|
3347 | + 'Registration.Event.EVT_short_desc' => array('LIKE', $sstr), |
|
3348 | + 'ATT_fname' => array('LIKE', $sstr), |
|
3349 | + 'ATT_lname' => array('LIKE', $sstr), |
|
3350 | + 'ATT_short_bio' => array('LIKE', $sstr), |
|
3351 | + 'ATT_email' => array('LIKE', $sstr), |
|
3352 | + 'ATT_address' => array('LIKE', $sstr), |
|
3353 | + 'ATT_address2' => array('LIKE', $sstr), |
|
3354 | + 'ATT_city' => array('LIKE', $sstr), |
|
3355 | + 'Country.CNT_name' => array('LIKE', $sstr), |
|
3356 | + 'State.STA_name' => array('LIKE', $sstr), |
|
3357 | + 'ATT_phone' => array('LIKE', $sstr), |
|
3358 | + 'Registration.REG_final_price' => array('LIKE', $sstr), |
|
3359 | + 'Registration.REG_code' => array('LIKE', $sstr), |
|
3360 | + 'Registration.REG_group_size' => array('LIKE', $sstr), |
|
3361 | + ); |
|
3362 | + } |
|
3363 | + $offset = ($current_page - 1) * $per_page; |
|
3364 | + $limit = $count ? null : array($offset, $per_page); |
|
3365 | + $query_args = array( |
|
3366 | + $_where, |
|
3367 | + 'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')), |
|
3368 | + 'limit' => $limit, |
|
3369 | + ); |
|
3370 | + if (! $count) { |
|
3371 | + $query_args['order_by'] = array($orderby => $sort); |
|
3372 | + } |
|
3373 | + if ($trash) { |
|
3374 | + $query_args[0]['status'] = array('!=', 'publish'); |
|
3375 | + $all_attendees = $count |
|
3376 | + ? $ATT_MDL->count($query_args, 'ATT_ID', true) |
|
3377 | + : $ATT_MDL->get_all($query_args); |
|
3378 | + } else { |
|
3379 | + $query_args[0]['status'] = array('IN', array('publish')); |
|
3380 | + $all_attendees = $count |
|
3381 | + ? $ATT_MDL->count($query_args, 'ATT_ID', true) |
|
3382 | + : $ATT_MDL->get_all($query_args); |
|
3383 | + } |
|
3384 | + return $all_attendees; |
|
3385 | + } |
|
3386 | + |
|
3387 | + |
|
3388 | + /** |
|
3389 | + * This is just taking care of resending the registration confirmation |
|
3390 | + * |
|
3391 | + * @access protected |
|
3392 | + * @return void |
|
3393 | + */ |
|
3394 | + protected function _resend_registration() |
|
3395 | + { |
|
3396 | + $this->_process_resend_registration(); |
|
3397 | + $query_args = isset($this->_req_data['redirect_to']) |
|
3398 | + ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID']) |
|
3399 | + : array('action' => 'default'); |
|
3400 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
3401 | + } |
|
3402 | + |
|
3403 | + /** |
|
3404 | + * Creates a registration report, but accepts the name of a method to use for preparing the query parameters |
|
3405 | + * to use when selecting registrations |
|
3406 | + * |
|
3407 | + * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing |
|
3408 | + * the query parameters from the request |
|
3409 | + * @return void ends the request with a redirect or download |
|
3410 | + */ |
|
3411 | + public function _registrations_report_base($method_name_for_getting_query_params) |
|
3412 | + { |
|
3413 | + if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
3414 | + wp_redirect( |
|
3415 | + EE_Admin_Page::add_query_args_and_nonce( |
|
3416 | + array( |
|
3417 | + 'page' => 'espresso_batch', |
|
3418 | + 'batch' => 'file', |
|
3419 | + 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
3420 | + 'filters' => urlencode( |
|
3421 | + serialize( |
|
3422 | + call_user_func( |
|
3423 | + array($this, $method_name_for_getting_query_params), |
|
3424 | + EEH_Array::is_set( |
|
3425 | + $this->_req_data, |
|
3426 | + 'filters', |
|
3427 | + array() |
|
3428 | + ) |
|
3429 | + ) |
|
3430 | + ) |
|
3431 | + ), |
|
3432 | + 'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false), |
|
3433 | + 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'), |
|
3434 | + 'return_url' => urlencode($this->_req_data['return_url']), |
|
3435 | + ) |
|
3436 | + ) |
|
3437 | + ); |
|
3438 | + } else { |
|
3439 | + $new_request_args = array( |
|
3440 | + 'export' => 'report', |
|
3441 | + 'action' => 'registrations_report_for_event', |
|
3442 | + 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null, |
|
3443 | + ); |
|
3444 | + $this->_req_data = array_merge($this->_req_data, $new_request_args); |
|
3445 | + if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
3446 | + require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
3447 | + $EE_Export = EE_Export::instance($this->_req_data); |
|
3448 | + $EE_Export->export(); |
|
3449 | + } |
|
3450 | + } |
|
3451 | + } |
|
3452 | + |
|
3453 | + |
|
3454 | + /** |
|
3455 | + * Creates a registration report using only query parameters in the request |
|
3456 | + * |
|
3457 | + * @return void |
|
3458 | + */ |
|
3459 | + public function _registrations_report() |
|
3460 | + { |
|
3461 | + $this->_registrations_report_base('_get_registration_query_parameters'); |
|
3462 | + } |
|
3463 | + |
|
3464 | + |
|
3465 | + public function _contact_list_export() |
|
3466 | + { |
|
3467 | + if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
3468 | + require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
3469 | + $EE_Export = EE_Export::instance($this->_req_data); |
|
3470 | + $EE_Export->export_attendees(); |
|
3471 | + } |
|
3472 | + } |
|
3473 | + |
|
3474 | + |
|
3475 | + public function _contact_list_report() |
|
3476 | + { |
|
3477 | + if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) { |
|
3478 | + wp_redirect( |
|
3479 | + EE_Admin_Page::add_query_args_and_nonce( |
|
3480 | + array( |
|
3481 | + 'page' => 'espresso_batch', |
|
3482 | + 'batch' => 'file', |
|
3483 | + 'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'), |
|
3484 | + 'return_url' => urlencode($this->_req_data['return_url']), |
|
3485 | + ) |
|
3486 | + ) |
|
3487 | + ); |
|
3488 | + } else { |
|
3489 | + if (is_readable(EE_CLASSES . 'EE_Export.class.php')) { |
|
3490 | + require_once(EE_CLASSES . 'EE_Export.class.php'); |
|
3491 | + $EE_Export = EE_Export::instance($this->_req_data); |
|
3492 | + $EE_Export->report_attendees(); |
|
3493 | + } |
|
3494 | + } |
|
3495 | + } |
|
3496 | + |
|
3497 | + |
|
3498 | + |
|
3499 | + |
|
3500 | + |
|
3501 | + /*************************************** ATTENDEE DETAILS ***************************************/ |
|
3502 | + /** |
|
3503 | + * This duplicates the attendee object for the given incoming registration id and attendee_id. |
|
3504 | + * |
|
3505 | + * @return void |
|
3506 | + * @throws EE_Error |
|
3507 | + * @throws InvalidArgumentException |
|
3508 | + * @throws InvalidDataTypeException |
|
3509 | + * @throws InvalidInterfaceException |
|
3510 | + */ |
|
3511 | + protected function _duplicate_attendee() |
|
3512 | + { |
|
3513 | + $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default'; |
|
3514 | + // verify we have necessary info |
|
3515 | + if (empty($this->_req_data['_REG_ID'])) { |
|
3516 | + EE_Error::add_error( |
|
3517 | + esc_html__( |
|
3518 | + 'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )', |
|
3519 | + 'event_espresso' |
|
3520 | + ), |
|
3521 | + __FILE__, |
|
3522 | + __LINE__, |
|
3523 | + __FUNCTION__ |
|
3524 | + ); |
|
3525 | + $query_args = array('action' => $action); |
|
3526 | + $this->_redirect_after_action('', '', '', $query_args, true); |
|
3527 | + } |
|
3528 | + // okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration. |
|
3529 | + $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']); |
|
3530 | + $attendee = $registration->attendee(); |
|
3531 | + // remove relation of existing attendee on registration |
|
3532 | + $registration->_remove_relation_to($attendee, 'Attendee'); |
|
3533 | + // new attendee |
|
3534 | + $new_attendee = clone $attendee; |
|
3535 | + $new_attendee->set('ATT_ID', 0); |
|
3536 | + $new_attendee->save(); |
|
3537 | + // add new attendee to reg |
|
3538 | + $registration->_add_relation_to($new_attendee, 'Attendee'); |
|
3539 | + EE_Error::add_success( |
|
3540 | + esc_html__( |
|
3541 | + 'New Contact record created. Now make any edits you wish to make for this contact.', |
|
3542 | + 'event_espresso' |
|
3543 | + ) |
|
3544 | + ); |
|
3545 | + // redirect to edit page for attendee |
|
3546 | + $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee'); |
|
3547 | + $this->_redirect_after_action('', '', '', $query_args, true); |
|
3548 | + } |
|
3549 | + |
|
3550 | + |
|
3551 | + /** |
|
3552 | + * Callback invoked by parent EE_Admin_CPT class hooked in on `save_post` wp hook. |
|
3553 | + * |
|
3554 | + * @param int $post_id |
|
3555 | + * @param WP_POST $post |
|
3556 | + * @throws DomainException |
|
3557 | + * @throws EE_Error |
|
3558 | + * @throws InvalidArgumentException |
|
3559 | + * @throws InvalidDataTypeException |
|
3560 | + * @throws InvalidInterfaceException |
|
3561 | + * @throws LogicException |
|
3562 | + * @throws InvalidFormSubmissionException |
|
3563 | + */ |
|
3564 | + protected function _insert_update_cpt_item($post_id, $post) |
|
3565 | + { |
|
3566 | + $success = true; |
|
3567 | + $attendee = $post instanceof WP_Post && $post->post_type === 'espresso_attendees' |
|
3568 | + ? EEM_Attendee::instance()->get_one_by_ID($post_id) |
|
3569 | + : null; |
|
3570 | + // for attendee updates |
|
3571 | + if ($attendee instanceof EE_Attendee) { |
|
3572 | + // note we should only be UPDATING attendees at this point. |
|
3573 | + $updated_fields = array( |
|
3574 | + 'ATT_fname' => $this->_req_data['ATT_fname'], |
|
3575 | + 'ATT_lname' => $this->_req_data['ATT_lname'], |
|
3576 | + 'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'], |
|
3577 | + 'ATT_address' => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '', |
|
3578 | + 'ATT_address2' => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '', |
|
3579 | + 'ATT_city' => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '', |
|
3580 | + 'STA_ID' => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '', |
|
3581 | + 'CNT_ISO' => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '', |
|
3582 | + 'ATT_zip' => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '', |
|
3583 | + ); |
|
3584 | + foreach ($updated_fields as $field => $value) { |
|
3585 | + $attendee->set($field, $value); |
|
3586 | + } |
|
3587 | + |
|
3588 | + // process contact details metabox form handler (which will also save the attendee) |
|
3589 | + $contact_details_form = $this->getAttendeeContactDetailsMetaboxFormHandler($attendee); |
|
3590 | + $success = $contact_details_form->process($this->_req_data); |
|
3591 | + |
|
3592 | + $attendee_update_callbacks = apply_filters( |
|
3593 | + 'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update', |
|
3594 | + array() |
|
3595 | + ); |
|
3596 | + foreach ($attendee_update_callbacks as $a_callback) { |
|
3597 | + if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) { |
|
3598 | + throw new EE_Error( |
|
3599 | + sprintf( |
|
3600 | + esc_html__( |
|
3601 | + 'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback. Please check the spelling.', |
|
3602 | + 'event_espresso' |
|
3603 | + ), |
|
3604 | + $a_callback |
|
3605 | + ) |
|
3606 | + ); |
|
3607 | + } |
|
3608 | + } |
|
3609 | + } |
|
3610 | + |
|
3611 | + if ($success === false) { |
|
3612 | + EE_Error::add_error( |
|
3613 | + esc_html__( |
|
3614 | + 'Something went wrong with updating the meta table data for the registration.', |
|
3615 | + 'event_espresso' |
|
3616 | + ), |
|
3617 | + __FILE__, |
|
3618 | + __FUNCTION__, |
|
3619 | + __LINE__ |
|
3620 | + ); |
|
3621 | + } |
|
3622 | + } |
|
3623 | + |
|
3624 | + |
|
3625 | + public function trash_cpt_item($post_id) |
|
3626 | + { |
|
3627 | + } |
|
3628 | + |
|
3629 | + |
|
3630 | + public function delete_cpt_item($post_id) |
|
3631 | + { |
|
3632 | + } |
|
3633 | + |
|
3634 | + |
|
3635 | + public function restore_cpt_item($post_id) |
|
3636 | + { |
|
3637 | + } |
|
3638 | + |
|
3639 | + |
|
3640 | + protected function _restore_cpt_item($post_id, $revision_id) |
|
3641 | + { |
|
3642 | + } |
|
3643 | + |
|
3644 | + |
|
3645 | + public function attendee_editor_metaboxes() |
|
3646 | + { |
|
3647 | + $this->verify_cpt_object(); |
|
3648 | + remove_meta_box( |
|
3649 | + 'postexcerpt', |
|
3650 | + esc_html__('Excerpt', 'event_espresso'), |
|
3651 | + 'post_excerpt_meta_box', |
|
3652 | + $this->_cpt_routes[ $this->_req_action ], |
|
3653 | + 'normal', |
|
3654 | + 'core' |
|
3655 | + ); |
|
3656 | + remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal', 'core'); |
|
3657 | + if (post_type_supports('espresso_attendees', 'excerpt')) { |
|
3658 | + add_meta_box( |
|
3659 | + 'postexcerpt', |
|
3660 | + esc_html__('Short Biography', 'event_espresso'), |
|
3661 | + 'post_excerpt_meta_box', |
|
3662 | + $this->_cpt_routes[ $this->_req_action ], |
|
3663 | + 'normal' |
|
3664 | + ); |
|
3665 | + } |
|
3666 | + if (post_type_supports('espresso_attendees', 'comments')) { |
|
3667 | + add_meta_box( |
|
3668 | + 'commentsdiv', |
|
3669 | + esc_html__('Notes on the Contact', 'event_espresso'), |
|
3670 | + 'post_comment_meta_box', |
|
3671 | + $this->_cpt_routes[ $this->_req_action ], |
|
3672 | + 'normal', |
|
3673 | + 'core' |
|
3674 | + ); |
|
3675 | + } |
|
3676 | + add_meta_box( |
|
3677 | + 'attendee_contact_info', |
|
3678 | + esc_html__('Contact Info', 'event_espresso'), |
|
3679 | + array($this, 'attendee_contact_info'), |
|
3680 | + $this->_cpt_routes[ $this->_req_action ], |
|
3681 | + 'side', |
|
3682 | + 'core' |
|
3683 | + ); |
|
3684 | + add_meta_box( |
|
3685 | + 'attendee_details_address', |
|
3686 | + esc_html__('Address Details', 'event_espresso'), |
|
3687 | + array($this, 'attendee_address_details'), |
|
3688 | + $this->_cpt_routes[ $this->_req_action ], |
|
3689 | + 'normal', |
|
3690 | + 'core' |
|
3691 | + ); |
|
3692 | + add_meta_box( |
|
3693 | + 'attendee_registrations', |
|
3694 | + esc_html__('Registrations for this Contact', 'event_espresso'), |
|
3695 | + array($this, 'attendee_registrations_meta_box'), |
|
3696 | + $this->_cpt_routes[ $this->_req_action ], |
|
3697 | + 'normal', |
|
3698 | + 'high' |
|
3699 | + ); |
|
3700 | + } |
|
3701 | + |
|
3702 | + |
|
3703 | + /** |
|
3704 | + * Metabox for attendee contact info |
|
3705 | + * |
|
3706 | + * @param WP_Post $post wp post object |
|
3707 | + * @return string attendee contact info ( and form ) |
|
3708 | + * @throws EE_Error |
|
3709 | + * @throws InvalidArgumentException |
|
3710 | + * @throws InvalidDataTypeException |
|
3711 | + * @throws InvalidInterfaceException |
|
3712 | + * @throws LogicException |
|
3713 | + * @throws DomainException |
|
3714 | + */ |
|
3715 | + public function attendee_contact_info($post) |
|
3716 | + { |
|
3717 | + // get attendee object ( should already have it ) |
|
3718 | + $form = $this->getAttendeeContactDetailsMetaboxFormHandler($this->_cpt_model_obj); |
|
3719 | + $form->enqueueStylesAndScripts(); |
|
3720 | + echo $form->display(); |
|
3721 | + } |
|
3722 | + |
|
3723 | + |
|
3724 | + /** |
|
3725 | + * Return form handler for the contact details metabox |
|
3726 | + * |
|
3727 | + * @param EE_Attendee $attendee |
|
3728 | + * @return AttendeeContactDetailsMetaboxFormHandler |
|
3729 | + * @throws DomainException |
|
3730 | + * @throws InvalidArgumentException |
|
3731 | + * @throws InvalidDataTypeException |
|
3732 | + * @throws InvalidInterfaceException |
|
3733 | + */ |
|
3734 | + protected function getAttendeeContactDetailsMetaboxFormHandler(EE_Attendee $attendee) |
|
3735 | + { |
|
3736 | + return new AttendeeContactDetailsMetaboxFormHandler($attendee, EE_Registry::instance()); |
|
3737 | + } |
|
3738 | + |
|
3739 | + |
|
3740 | + /** |
|
3741 | + * Metabox for attendee details |
|
3742 | + * |
|
3743 | + * @param WP_Post $post wp post object |
|
3744 | + * @throws DomainException |
|
3745 | + */ |
|
3746 | + public function attendee_address_details($post) |
|
3747 | + { |
|
3748 | + // get attendee object (should already have it) |
|
3749 | + $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
3750 | + $this->_template_args['state_html'] = EEH_Form_Fields::generate_form_input( |
|
3751 | + new EE_Question_Form_Input( |
|
3752 | + EE_Question::new_instance( |
|
3753 | + array( |
|
3754 | + 'QST_ID' => 0, |
|
3755 | + 'QST_display_text' => esc_html__('State/Province', 'event_espresso'), |
|
3756 | + 'QST_system' => 'admin-state', |
|
3757 | + ) |
|
3758 | + ), |
|
3759 | + EE_Answer::new_instance( |
|
3760 | + array( |
|
3761 | + 'ANS_ID' => 0, |
|
3762 | + 'ANS_value' => $this->_cpt_model_obj->state_ID(), |
|
3763 | + ) |
|
3764 | + ), |
|
3765 | + array( |
|
3766 | + 'input_id' => 'STA_ID', |
|
3767 | + 'input_name' => 'STA_ID', |
|
3768 | + 'input_prefix' => '', |
|
3769 | + 'append_qstn_id' => false, |
|
3770 | + ) |
|
3771 | + ) |
|
3772 | + ); |
|
3773 | + $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input( |
|
3774 | + new EE_Question_Form_Input( |
|
3775 | + EE_Question::new_instance( |
|
3776 | + array( |
|
3777 | + 'QST_ID' => 0, |
|
3778 | + 'QST_display_text' => esc_html__('Country', 'event_espresso'), |
|
3779 | + 'QST_system' => 'admin-country', |
|
3780 | + ) |
|
3781 | + ), |
|
3782 | + EE_Answer::new_instance( |
|
3783 | + array( |
|
3784 | + 'ANS_ID' => 0, |
|
3785 | + 'ANS_value' => $this->_cpt_model_obj->country_ID(), |
|
3786 | + ) |
|
3787 | + ), |
|
3788 | + array( |
|
3789 | + 'input_id' => 'CNT_ISO', |
|
3790 | + 'input_name' => 'CNT_ISO', |
|
3791 | + 'input_prefix' => '', |
|
3792 | + 'append_qstn_id' => false, |
|
3793 | + ) |
|
3794 | + ) |
|
3795 | + ); |
|
3796 | + $template = |
|
3797 | + REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php'; |
|
3798 | + EEH_Template::display_template($template, $this->_template_args); |
|
3799 | + } |
|
3800 | + |
|
3801 | + |
|
3802 | + /** |
|
3803 | + * _attendee_details |
|
3804 | + * |
|
3805 | + * @access protected |
|
3806 | + * @param $post |
|
3807 | + * @return void |
|
3808 | + * @throws DomainException |
|
3809 | + * @throws EE_Error |
|
3810 | + */ |
|
3811 | + public function attendee_registrations_meta_box($post) |
|
3812 | + { |
|
3813 | + $this->_template_args['attendee'] = $this->_cpt_model_obj; |
|
3814 | + $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration'); |
|
3815 | + $template = |
|
3816 | + REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php'; |
|
3817 | + EEH_Template::display_template($template, $this->_template_args); |
|
3818 | + } |
|
3819 | + |
|
3820 | + |
|
3821 | + /** |
|
3822 | + * add in the form fields for the attendee edit |
|
3823 | + * |
|
3824 | + * @param WP_Post $post wp post object |
|
3825 | + * @return string html for new form. |
|
3826 | + * @throws DomainException |
|
3827 | + */ |
|
3828 | + public function after_title_form_fields($post) |
|
3829 | + { |
|
3830 | + if ($post->post_type == 'espresso_attendees') { |
|
3831 | + $template = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php'; |
|
3832 | + $template_args['attendee'] = $this->_cpt_model_obj; |
|
3833 | + EEH_Template::display_template($template, $template_args); |
|
3834 | + } |
|
3835 | + } |
|
3836 | + |
|
3837 | + |
|
3838 | + /** |
|
3839 | + * _trash_or_restore_attendee |
|
3840 | + * |
|
3841 | + * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE) |
|
3842 | + * @return void |
|
3843 | + * @throws EE_Error |
|
3844 | + * @throws InvalidArgumentException |
|
3845 | + * @throws InvalidDataTypeException |
|
3846 | + * @throws InvalidInterfaceException |
|
3847 | + * @access protected |
|
3848 | + */ |
|
3849 | + protected function _trash_or_restore_attendees($trash = true) |
|
3850 | + { |
|
3851 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
3852 | + $ATT_MDL = EEM_Attendee::instance(); |
|
3853 | + $success = 1; |
|
3854 | + // Checkboxes |
|
3855 | + if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
3856 | + // if array has more than one element than success message should be plural |
|
3857 | + $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
|
3858 | + // cycle thru checkboxes |
|
3859 | + while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) { |
|
3860 | + $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID) |
|
3861 | + : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID); |
|
3862 | + if (! $updated) { |
|
3863 | + $success = 0; |
|
3864 | + } |
|
3865 | + } |
|
3866 | + } else { |
|
3867 | + // grab single id and delete |
|
3868 | + $ATT_ID = absint($this->_req_data['ATT_ID']); |
|
3869 | + // get attendee |
|
3870 | + $att = $ATT_MDL->get_one_by_ID($ATT_ID); |
|
3871 | + $updated = $trash ? $att->set_status('trash') : $att->set_status('publish'); |
|
3872 | + $updated = $att->save(); |
|
3873 | + if (! $updated) { |
|
3874 | + $success = 0; |
|
3875 | + } |
|
3876 | + } |
|
3877 | + $what = $success > 1 |
|
3878 | + ? esc_html__('Contacts', 'event_espresso') |
|
3879 | + : esc_html__('Contact', 'event_espresso'); |
|
3880 | + $action_desc = $trash |
|
3881 | + ? esc_html__('moved to the trash', 'event_espresso') |
|
3882 | + : esc_html__('restored', 'event_espresso'); |
|
3883 | + $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list')); |
|
3884 | + } |
|
3885 | 3885 | } |
@@ -38,103 +38,103 @@ |
||
38 | 38 | * @since 4.0 |
39 | 39 | */ |
40 | 40 | if (function_exists('espresso_version')) { |
41 | - if (! function_exists('espresso_duplicate_plugin_error')) { |
|
42 | - /** |
|
43 | - * espresso_duplicate_plugin_error |
|
44 | - * displays if more than one version of EE is activated at the same time |
|
45 | - */ |
|
46 | - function espresso_duplicate_plugin_error() |
|
47 | - { |
|
48 | - ?> |
|
41 | + if (! function_exists('espresso_duplicate_plugin_error')) { |
|
42 | + /** |
|
43 | + * espresso_duplicate_plugin_error |
|
44 | + * displays if more than one version of EE is activated at the same time |
|
45 | + */ |
|
46 | + function espresso_duplicate_plugin_error() |
|
47 | + { |
|
48 | + ?> |
|
49 | 49 | <div class="error"> |
50 | 50 | <p> |
51 | 51 | <?php |
52 | - echo esc_html__( |
|
53 | - 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
54 | - 'event_espresso' |
|
55 | - ); ?> |
|
52 | + echo esc_html__( |
|
53 | + 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
54 | + 'event_espresso' |
|
55 | + ); ?> |
|
56 | 56 | </p> |
57 | 57 | </div> |
58 | 58 | <?php |
59 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
60 | - } |
|
61 | - } |
|
62 | - add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
59 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
60 | + } |
|
61 | + } |
|
62 | + add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
63 | 63 | } else { |
64 | - define('EE_MIN_PHP_VER_REQUIRED', '5.4.0'); |
|
65 | - if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
66 | - /** |
|
67 | - * espresso_minimum_php_version_error |
|
68 | - * |
|
69 | - * @return void |
|
70 | - */ |
|
71 | - function espresso_minimum_php_version_error() |
|
72 | - { |
|
73 | - ?> |
|
64 | + define('EE_MIN_PHP_VER_REQUIRED', '5.4.0'); |
|
65 | + if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
66 | + /** |
|
67 | + * espresso_minimum_php_version_error |
|
68 | + * |
|
69 | + * @return void |
|
70 | + */ |
|
71 | + function espresso_minimum_php_version_error() |
|
72 | + { |
|
73 | + ?> |
|
74 | 74 | <div class="error"> |
75 | 75 | <p> |
76 | 76 | <?php |
77 | - printf( |
|
78 | - esc_html__( |
|
79 | - 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
80 | - 'event_espresso' |
|
81 | - ), |
|
82 | - EE_MIN_PHP_VER_REQUIRED, |
|
83 | - PHP_VERSION, |
|
84 | - '<br/>', |
|
85 | - '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
86 | - ); |
|
87 | - ?> |
|
77 | + printf( |
|
78 | + esc_html__( |
|
79 | + 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
80 | + 'event_espresso' |
|
81 | + ), |
|
82 | + EE_MIN_PHP_VER_REQUIRED, |
|
83 | + PHP_VERSION, |
|
84 | + '<br/>', |
|
85 | + '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
86 | + ); |
|
87 | + ?> |
|
88 | 88 | </p> |
89 | 89 | </div> |
90 | 90 | <?php |
91 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
92 | - } |
|
91 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
92 | + } |
|
93 | 93 | |
94 | - add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
95 | - } else { |
|
96 | - define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
97 | - /** |
|
98 | - * espresso_version |
|
99 | - * Returns the plugin version |
|
100 | - * |
|
101 | - * @return string |
|
102 | - */ |
|
103 | - function espresso_version() |
|
104 | - { |
|
105 | - return apply_filters('FHEE__espresso__espresso_version', '4.9.80.rc.119'); |
|
106 | - } |
|
94 | + add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
95 | + } else { |
|
96 | + define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
97 | + /** |
|
98 | + * espresso_version |
|
99 | + * Returns the plugin version |
|
100 | + * |
|
101 | + * @return string |
|
102 | + */ |
|
103 | + function espresso_version() |
|
104 | + { |
|
105 | + return apply_filters('FHEE__espresso__espresso_version', '4.9.80.rc.119'); |
|
106 | + } |
|
107 | 107 | |
108 | - /** |
|
109 | - * espresso_plugin_activation |
|
110 | - * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
111 | - */ |
|
112 | - function espresso_plugin_activation() |
|
113 | - { |
|
114 | - update_option('ee_espresso_activation', true); |
|
115 | - } |
|
108 | + /** |
|
109 | + * espresso_plugin_activation |
|
110 | + * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
111 | + */ |
|
112 | + function espresso_plugin_activation() |
|
113 | + { |
|
114 | + update_option('ee_espresso_activation', true); |
|
115 | + } |
|
116 | 116 | |
117 | - register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
117 | + register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
118 | 118 | |
119 | - require_once __DIR__ . '/core/bootstrap_espresso.php'; |
|
120 | - bootstrap_espresso(); |
|
121 | - } |
|
119 | + require_once __DIR__ . '/core/bootstrap_espresso.php'; |
|
120 | + bootstrap_espresso(); |
|
121 | + } |
|
122 | 122 | } |
123 | 123 | if (! function_exists('espresso_deactivate_plugin')) { |
124 | - /** |
|
125 | - * deactivate_plugin |
|
126 | - * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
127 | - * |
|
128 | - * @access public |
|
129 | - * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
130 | - * @return void |
|
131 | - */ |
|
132 | - function espresso_deactivate_plugin($plugin_basename = '') |
|
133 | - { |
|
134 | - if (! function_exists('deactivate_plugins')) { |
|
135 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
136 | - } |
|
137 | - unset($_GET['activate'], $_REQUEST['activate']); |
|
138 | - deactivate_plugins($plugin_basename); |
|
139 | - } |
|
124 | + /** |
|
125 | + * deactivate_plugin |
|
126 | + * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
127 | + * |
|
128 | + * @access public |
|
129 | + * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
130 | + * @return void |
|
131 | + */ |
|
132 | + function espresso_deactivate_plugin($plugin_basename = '') |
|
133 | + { |
|
134 | + if (! function_exists('deactivate_plugins')) { |
|
135 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
136 | + } |
|
137 | + unset($_GET['activate'], $_REQUEST['activate']); |
|
138 | + deactivate_plugins($plugin_basename); |
|
139 | + } |
|
140 | 140 | } |