Completed
Branch BUG-10791-route-translations (bc080c)
by
unknown
48:24 queued 36:57
created
core/admin/EE_Admin_Page.core.php 1 patch
Indentation   +3299 added lines, -3299 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 /**
5 5
  * Event Espresso
@@ -28,2114 +28,2114 @@  discard block
 block discarded – undo
28 28
 {
29 29
 
30 30
 
31
-    //set in _init_page_props()
32
-    public $page_slug;
31
+	//set in _init_page_props()
32
+	public $page_slug;
33 33
 
34
-    public $page_label;
34
+	public $page_label;
35 35
 
36
-    public $page_folder;
36
+	public $page_folder;
37 37
 
38
-    //set in define_page_props()
39
-    protected $_admin_base_url;
38
+	//set in define_page_props()
39
+	protected $_admin_base_url;
40 40
 
41
-    protected $_admin_base_path;
41
+	protected $_admin_base_path;
42 42
 
43
-    protected $_admin_page_title;
43
+	protected $_admin_page_title;
44 44
 
45
-    protected $_labels;
45
+	protected $_labels;
46 46
 
47 47
 
48
-    //set early within EE_Admin_Init
49
-    protected $_wp_page_slug;
48
+	//set early within EE_Admin_Init
49
+	protected $_wp_page_slug;
50 50
 
51
-    //navtabs
52
-    protected $_nav_tabs;
51
+	//navtabs
52
+	protected $_nav_tabs;
53 53
 
54
-    protected $_default_nav_tab_name;
54
+	protected $_default_nav_tab_name;
55 55
 
56
-    //helptourstops
57
-    protected $_help_tour = array();
56
+	//helptourstops
57
+	protected $_help_tour = array();
58 58
 
59 59
 
60
-    //template variables (used by templates)
61
-    protected $_template_path;
60
+	//template variables (used by templates)
61
+	protected $_template_path;
62 62
 
63
-    protected $_column_template_path;
63
+	protected $_column_template_path;
64 64
 
65
-    /**
66
-     * @var array $_template_args
67
-     */
68
-    protected $_template_args = array();
65
+	/**
66
+	 * @var array $_template_args
67
+	 */
68
+	protected $_template_args = array();
69 69
 
70
-    /**
71
-     * this will hold the list table object for a given view.
72
-     *
73
-     * @var EE_Admin_List_Table $_list_table_object
74
-     */
75
-    protected $_list_table_object;
70
+	/**
71
+	 * this will hold the list table object for a given view.
72
+	 *
73
+	 * @var EE_Admin_List_Table $_list_table_object
74
+	 */
75
+	protected $_list_table_object;
76 76
 
77
-    //bools
78
-    protected $_is_UI_request = null; //this starts at null so we can have no header routes progress through two states.
77
+	//bools
78
+	protected $_is_UI_request = null; //this starts at null so we can have no header routes progress through two states.
79 79
 
80
-    protected $_routing;
80
+	protected $_routing;
81 81
 
82
-    //list table args
83
-    protected $_view;
82
+	//list table args
83
+	protected $_view;
84 84
 
85
-    protected $_views;
85
+	protected $_views;
86 86
 
87 87
 
88
-    //action => method pairs used for routing incoming requests
89
-    protected $_page_routes;
88
+	//action => method pairs used for routing incoming requests
89
+	protected $_page_routes;
90 90
 
91
-    protected $_page_config;
91
+	protected $_page_config;
92 92
 
93
-    //the current page route and route config
94
-    protected $_route;
93
+	//the current page route and route config
94
+	protected $_route;
95 95
 
96
-    protected $_route_config;
96
+	protected $_route_config;
97 97
 
98
-    /**
99
-     * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
100
-     * actions.
101
-     *
102
-     * @since 4.6.x
103
-     * @var array.
104
-     */
105
-    protected $_default_route_query_args;
98
+	/**
99
+	 * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
100
+	 * actions.
101
+	 *
102
+	 * @since 4.6.x
103
+	 * @var array.
104
+	 */
105
+	protected $_default_route_query_args;
106 106
 
107
-    //set via request page and action args.
108
-    protected $_current_page;
107
+	//set via request page and action args.
108
+	protected $_current_page;
109 109
 
110
-    protected $_current_view;
110
+	protected $_current_view;
111 111
 
112
-    protected $_current_page_view_url;
112
+	protected $_current_page_view_url;
113 113
 
114
-    //sanitized request action (and nonce)
115
-    /**
116
-     * @var string $_req_action
117
-     */
118
-    protected $_req_action;
114
+	//sanitized request action (and nonce)
115
+	/**
116
+	 * @var string $_req_action
117
+	 */
118
+	protected $_req_action;
119 119
 
120
-    /**
121
-     * @var string $_req_nonce
122
-     */
123
-    protected $_req_nonce;
120
+	/**
121
+	 * @var string $_req_nonce
122
+	 */
123
+	protected $_req_nonce;
124 124
 
125
-    //search related
126
-    protected $_search_btn_label;
125
+	//search related
126
+	protected $_search_btn_label;
127 127
 
128
-    protected $_search_box_callback;
128
+	protected $_search_box_callback;
129 129
 
130
-    /**
131
-     * WP Current Screen object
132
-     *
133
-     * @var WP_Screen
134
-     */
135
-    protected $_current_screen;
130
+	/**
131
+	 * WP Current Screen object
132
+	 *
133
+	 * @var WP_Screen
134
+	 */
135
+	protected $_current_screen;
136 136
 
137
-    //for holding EE_Admin_Hooks object when needed (set via set_hook_object())
138
-    protected $_hook_obj;
137
+	//for holding EE_Admin_Hooks object when needed (set via set_hook_object())
138
+	protected $_hook_obj;
139 139
 
140
-    //for holding incoming request data
141
-    protected $_req_data;
140
+	//for holding incoming request data
141
+	protected $_req_data;
142 142
 
143
-    // yes / no array for admin form fields
144
-    protected $_yes_no_values = array();
145
-
146
-    //some default things shared by all child classes
147
-    protected $_default_espresso_metaboxes;
148
-
149
-    /**
150
-     *    EE_Registry Object
151
-     *
152
-     * @var    EE_Registry
153
-     * @access    protected
154
-     */
155
-    protected $EE = null;
156
-
157
-
158
-
159
-    /**
160
-     * This is just a property that flags whether the given route is a caffeinated route or not.
161
-     *
162
-     * @var boolean
163
-     */
164
-    protected $_is_caf = false;
165
-
166
-
167
-
168
-    /**
169
-     * @Constructor
170
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
171
-     * @access public
172
-     */
173
-    public function __construct($routing = true)
174
-    {
175
-        if (strpos($this->_get_dir(), 'caffeinated') !== false) {
176
-            $this->_is_caf = true;
177
-        }
178
-        $this->_yes_no_values = array(
179
-                array('id' => true, 'text' => __('Yes', 'event_espresso')),
180
-                array('id' => false, 'text' => __('No', 'event_espresso')),
181
-        );
182
-        //set the _req_data property.
183
-        $this->_req_data = array_merge($_GET, $_POST);
184
-        //routing enabled?
185
-        $this->_routing = $routing;
186
-        //set initial page props (child method)
187
-        $this->_init_page_props();
188
-        //set global defaults
189
-        $this->_set_defaults();
190
-        //set early because incoming requests could be ajax related and we need to register those hooks.
191
-        $this->_global_ajax_hooks();
192
-        $this->_ajax_hooks();
193
-        //other_page_hooks have to be early too.
194
-        $this->_do_other_page_hooks();
195
-        //This just allows us to have extending classes do something specific
196
-        // before the parent constructor runs _page_setup().
197
-        if (method_exists($this, '_before_page_setup')) {
198
-            $this->_before_page_setup();
199
-        }
200
-        //set up page dependencies
201
-        $this->_page_setup();
202
-    }
203
-
204
-
205
-
206
-    /**
207
-     * _init_page_props
208
-     * Child classes use to set at least the following properties:
209
-     * $page_slug.
210
-     * $page_label.
211
-     *
212
-     * @abstract
213
-     * @access protected
214
-     * @return void
215
-     */
216
-    abstract protected function _init_page_props();
217
-
218
-
219
-
220
-    /**
221
-     * _ajax_hooks
222
-     * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
223
-     * Note: within the ajax callback methods.
224
-     *
225
-     * @abstract
226
-     * @access protected
227
-     * @return void
228
-     */
229
-    abstract protected function _ajax_hooks();
230
-
231
-
232
-
233
-    /**
234
-     * _define_page_props
235
-     * child classes define page properties in here.  Must include at least:
236
-     * $_admin_base_url = base_url for all admin pages
237
-     * $_admin_page_title = default admin_page_title for admin pages
238
-     * $_labels = array of default labels for various automatically generated elements:
239
-     *    array(
240
-     *        'buttons' => array(
241
-     *            'add' => __('label for add new button'),
242
-     *            'edit' => __('label for edit button'),
243
-     *            'delete' => __('label for delete button')
244
-     *            )
245
-     *        )
246
-     *
247
-     * @abstract
248
-     * @access protected
249
-     * @return void
250
-     */
251
-    abstract protected function _define_page_props();
252
-
253
-
254
-
255
-    /**
256
-     * _set_page_routes
257
-     * child classes use this to define the page routes for all subpages handled by the class.  Page routes are assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also have a 'default'
258
-     * route. Here's the format
259
-     * $this->_page_routes = array(
260
-     *        'default' => array(
261
-     *            'func' => '_default_method_handling_route',
262
-     *            'args' => array('array','of','args'),
263
-     *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e. ajax request, backend processing)
264
-     *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a headers route after.  The string you enter here should match the defined route reference for a headers sent route.
265
-     *            'capability' => 'route_capability', //indicate a string for minimum capability required to access this route.
266
-     *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability checks).
267
-     *        ),
268
-     *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a handling method.
269
-     *        )
270
-     * )
271
-     *
272
-     * @abstract
273
-     * @access protected
274
-     * @return void
275
-     */
276
-    abstract protected function _set_page_routes();
277
-
278
-
279
-
280
-    /**
281
-     * _set_page_config
282
-     * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the array corresponds to the page_route for the loaded page.
283
-     * Format:
284
-     * $this->_page_config = array(
285
-     *        'default' => array(
286
-     *            'labels' => array(
287
-     *                'buttons' => array(
288
-     *                    'add' => __('label for adding item'),
289
-     *                    'edit' => __('label for editing item'),
290
-     *                    'delete' => __('label for deleting item')
291
-     *                ),
292
-     *                'publishbox' => __('Localized Title for Publish metabox', 'event_espresso')
293
-     *            ), //optional an array of custom labels for various automatically generated elements to use on the page. If this isn't present then the defaults will be used as set for the $this->_labels in _define_page_props() method
294
-     *            'nav' => array(
295
-     *                'label' => __('Label for Tab', 'event_espresso').
296
-     *                'url' => 'http://someurl', //automatically generated UNLESS you define
297
-     *                'css_class' => 'css-class', //automatically generated UNLESS you define
298
-     *                'order' => 10, //required to indicate tab position.
299
-     *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is displayed then add this parameter.
300
-     *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
301
-     *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load metaboxes set for eventespresso admin pages.
302
-     *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added later.  We just use
303
-     *            this flag to make sure the necessary js gets enqueued on page load.
304
-     *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
305
-     *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The array indicates the max number of columns (4) and the default number of columns on page load (2).  There is an option
306
-     *            in the "screen_options" dropdown that is setup so users can pick what columns they want to display.
307
-     *            'help_tabs' => array( //this is used for adding help tabs to a page
308
-     *                'tab_id' => array(
309
-     *                    'title' => 'tab_title',
310
-     *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting help tab content.  The fallback if it isn't present is to try a the callback.  Filename should match a file in the admin
311
-     *                    folder's "help_tabs" dir (ie.. events/help_tabs/name_of_file_containing_content.help_tab.php)
312
-     *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will attempt to use the callback which should match the name of a method in the class
313
-     *                    ),
314
-     *                'tab2_id' => array(
315
-     *                    'title' => 'tab2 title',
316
-     *                    'filename' => 'file_name_2'
317
-     *                    'callback' => 'callback_method_for_content',
318
-     *                 ),
319
-     *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the help tab area on an admin page. @link http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
320
-     *            'help_tour' => array(
321
-     *                'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located in a folder for this admin page named "help_tours", a file name matching the key given here
322
-     *                (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
323
-     *            ),
324
-     *            'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is true if it isn't present).  To remove the requirement for a nonce check when this route is visited just set
325
-     *            'require_nonce' to FALSE
326
-     *            )
327
-     * )
328
-     *
329
-     * @abstract
330
-     * @access protected
331
-     * @return void
332
-     */
333
-    abstract protected function _set_page_config();
334
-
335
-
336
-
337
-
338
-
339
-    /** end sample help_tour methods **/
340
-    /**
341
-     * _add_screen_options
342
-     * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
343
-     * Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options to a particular view.
344
-     *
345
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
346
-     *         see also WP_Screen object documents...
347
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
348
-     * @abstract
349
-     * @access protected
350
-     * @return void
351
-     */
352
-    abstract protected function _add_screen_options();
353
-
354
-
355
-
356
-    /**
357
-     * _add_feature_pointers
358
-     * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
359
-     * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a particular view.
360
-     * Note: this is just a placeholder for now.  Implementation will come down the road
361
-     * See: WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
362
-     *
363
-     * @link   http://eamann.com/tech/wordpress-portland/
364
-     * @abstract
365
-     * @access protected
366
-     * @return void
367
-     */
368
-    abstract protected function _add_feature_pointers();
369
-
370
-
371
-
372
-    /**
373
-     * load_scripts_styles
374
-     * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific scripts/styles
375
-     * per view by putting them in a dynamic function in this format (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
376
-     *
377
-     * @abstract
378
-     * @access public
379
-     * @return void
380
-     */
381
-    abstract public function load_scripts_styles();
382
-
383
-
384
-
385
-    /**
386
-     * admin_init
387
-     * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to all pages/views loaded by child class.
388
-     *
389
-     * @abstract
390
-     * @access public
391
-     * @return void
392
-     */
393
-    abstract public function admin_init();
394
-
395
-
396
-
397
-    /**
398
-     * admin_notices
399
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to all pages/views loaded by child class.
400
-     *
401
-     * @abstract
402
-     * @access public
403
-     * @return void
404
-     */
405
-    abstract public function admin_notices();
406
-
407
-
408
-
409
-    /**
410
-     * admin_footer_scripts
411
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply to all pages/views loaded by child class.
412
-     *
413
-     * @access public
414
-     * @return void
415
-     */
416
-    abstract public function admin_footer_scripts();
417
-
418
-
419
-
420
-    /**
421
-     * admin_footer
422
-     * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will apply to all pages/views loaded by child class.
423
-     *
424
-     * @access  public
425
-     * @return void
426
-     */
427
-    public function admin_footer()
428
-    {
429
-    }
430
-
431
-
432
-
433
-    /**
434
-     * _global_ajax_hooks
435
-     * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
436
-     * Note: within the ajax callback methods.
437
-     *
438
-     * @abstract
439
-     * @access protected
440
-     * @return void
441
-     */
442
-    protected function _global_ajax_hooks()
443
-    {
444
-        //for lazy loading of metabox content
445
-        add_action('wp_ajax_espresso-ajax-content', array($this, 'ajax_metabox_content'), 10);
446
-    }
447
-
448
-
449
-
450
-    public function ajax_metabox_content()
451
-    {
452
-        $contentid = isset($this->_req_data['contentid']) ? $this->_req_data['contentid'] : '';
453
-        $url = isset($this->_req_data['contenturl']) ? $this->_req_data['contenturl'] : '';
454
-        self::cached_rss_display($contentid, $url);
455
-        wp_die();
456
-    }
457
-
458
-
459
-
460
-    /**
461
-     * _page_setup
462
-     * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested doesn't match the object.
463
-     *
464
-     * @final
465
-     * @access protected
466
-     * @return void
467
-     */
468
-    final protected function _page_setup()
469
-    {
470
-        //requires?
471
-        //admin_init stuff - global - we're setting this REALLY early so if EE_Admin pages have to hook into other WP pages they can.  But keep in mind, not everything is available from the EE_Admin Page object at this point.
472
-        add_action('admin_init', array($this, 'admin_init_global'), 5);
473
-        //next verify if we need to load anything...
474
-        $this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
475
-        $this->page_folder = strtolower(str_replace('_Admin_Page', '', str_replace('Extend_', '', get_class($this))));
476
-        global $ee_menu_slugs;
477
-        $ee_menu_slugs = (array)$ee_menu_slugs;
478
-        if (( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page])) && ! defined('DOING_AJAX')) {
479
-            return;
480
-        }
481
-        // becuz WP List tables have two duplicate select inputs for choosing bulk actions, we need to copy the action from the second to the first
482
-        if (isset($this->_req_data['action2']) && $this->_req_data['action'] == -1) {
483
-            $this->_req_data['action'] = ! empty($this->_req_data['action2']) && $this->_req_data['action2'] != -1 ? $this->_req_data['action2'] : $this->_req_data['action'];
484
-        }
485
-        // then set blank or -1 action values to 'default'
486
-        $this->_req_action = isset($this->_req_data['action']) && ! empty($this->_req_data['action']) && $this->_req_data['action'] != -1 ? sanitize_key($this->_req_data['action']) : 'default';
487
-        //if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.  This covers cases where we're coming in from a list table that isn't on the default route.
488
-        $this->_req_action = $this->_req_action === 'default' && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
489
-        //however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
490
-        $this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
491
-        $this->_current_view = $this->_req_action;
492
-        $this->_req_nonce = $this->_req_action . '_nonce';
493
-        $this->_define_page_props();
494
-        $this->_current_page_view_url = add_query_arg(array('page' => $this->_current_page, 'action' => $this->_current_view), $this->_admin_base_url);
495
-        //default things
496
-        $this->_default_espresso_metaboxes = array('_espresso_news_post_box', '_espresso_links_post_box', '_espresso_ratings_request', '_espresso_sponsors_post_box');
497
-        //set page configs
498
-        $this->_set_page_routes();
499
-        $this->_set_page_config();
500
-        //let's include any referrer data in our default_query_args for this route for "stickiness".
501
-        if (isset($this->_req_data['wp_referer'])) {
502
-            $this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
503
-        }
504
-        //for caffeinated and other extended functionality.  If there is a _extend_page_config method then let's run that to modify the all the various page configuration arrays
505
-        if (method_exists($this, '_extend_page_config')) {
506
-            $this->_extend_page_config();
507
-        }
508
-        //for CPT and other extended functionality. If there is an _extend_page_config_for_cpt then let's run that to modify all the various page configuration arrays.
509
-        if (method_exists($this, '_extend_page_config_for_cpt')) {
510
-            $this->_extend_page_config_for_cpt();
511
-        }
512
-        //filter routes and page_config so addons can add their stuff. Filtering done per class
513
-        $this->_page_routes = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this);
514
-        $this->_page_config = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this);
515
-        //if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
516
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
517
-            add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view), 10, 2);
518
-        }
519
-        //next route only if routing enabled
520
-        if ($this->_routing && ! defined('DOING_AJAX')) {
521
-            $this->_verify_routes();
522
-            //next let's just check user_access and kill if no access
523
-            $this->check_user_access();
524
-            if ($this->_is_UI_request) {
525
-                //admin_init stuff - global, all views for this page class, specific view
526
-                add_action('admin_init', array($this, 'admin_init'), 10);
527
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
528
-                    add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
529
-                }
530
-            } else {
531
-                //hijack regular WP loading and route admin request immediately
532
-                @ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
533
-                $this->route_admin_request();
534
-            }
535
-        }
536
-    }
537
-
538
-
539
-
540
-    /**
541
-     * Provides a way for related child admin pages to load stuff on the loaded admin page.
542
-     *
543
-     * @access private
544
-     * @return void
545
-     */
546
-    private function _do_other_page_hooks()
547
-    {
548
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
549
-        foreach ($registered_pages as $page) {
550
-            //now let's setup the file name and class that should be present
551
-            $classname = str_replace('.class.php', '', $page);
552
-            //autoloaders should take care of loading file
553
-            if ( ! class_exists($classname)) {
554
-                $error_msg[] = sprintf( esc_html__('Something went wrong with loading the %s admin hooks page.', 'event_espresso'), $page);
555
-                $error_msg[] = $error_msg[0]
556
-                               . "\r\n"
557
-                               . sprintf( esc_html__('There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
558
-                                'event_espresso'), $page, '<br />', '<strong>' . $classname . '</strong>');
559
-                throw new EE_Error(implode('||', $error_msg));
560
-            }
561
-            $a = new ReflectionClass($classname);
562
-            //notice we are passing the instance of this class to the hook object.
563
-            $hookobj[] = $a->newInstance($this);
564
-        }
565
-    }
566
-
567
-
568
-
569
-    public function load_page_dependencies()
570
-    {
571
-        try {
572
-            $this->_load_page_dependencies();
573
-        } catch (EE_Error $e) {
574
-            $e->get_error();
575
-        }
576
-    }
577
-
578
-
579
-
580
-    /**
581
-     * load_page_dependencies
582
-     * loads things specific to this page class when its loaded.  Really helps with efficiency.
583
-     *
584
-     * @access public
585
-     * @return void
586
-     */
587
-    protected function _load_page_dependencies()
588
-    {
589
-        //let's set the current_screen and screen options to override what WP set
590
-        $this->_current_screen = get_current_screen();
591
-        //load admin_notices - global, page class, and view specific
592
-        add_action('admin_notices', array($this, 'admin_notices_global'), 5);
593
-        add_action('admin_notices', array($this, 'admin_notices'), 10);
594
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
595
-            add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
596
-        }
597
-        //load network admin_notices - global, page class, and view specific
598
-        add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
599
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
600
-            add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
601
-        }
602
-        //this will save any per_page screen options if they are present
603
-        $this->_set_per_page_screen_options();
604
-        //setup list table properties
605
-        $this->_set_list_table();
606
-        // child classes can "register" a metabox to be automatically handled via the _page_config array property.  However in some cases the metaboxes will need to be added within a route handling callback.
607
-        $this->_add_registered_meta_boxes();
608
-        $this->_add_screen_columns();
609
-        //add screen options - global, page child class, and view specific
610
-        $this->_add_global_screen_options();
611
-        $this->_add_screen_options();
612
-        if (method_exists($this, '_add_screen_options_' . $this->_current_view)) {
613
-            call_user_func(array($this, '_add_screen_options_' . $this->_current_view));
614
-        }
615
-        //add help tab(s) and tours- set via page_config and qtips.
616
-        $this->_add_help_tour();
617
-        $this->_add_help_tabs();
618
-        $this->_add_qtips();
619
-        //add feature_pointers - global, page child class, and view specific
620
-        $this->_add_feature_pointers();
621
-        $this->_add_global_feature_pointers();
622
-        if (method_exists($this, '_add_feature_pointer_' . $this->_current_view)) {
623
-            call_user_func(array($this, '_add_feature_pointer_' . $this->_current_view));
624
-        }
625
-        //enqueue scripts/styles - global, page class, and view specific
626
-        add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
627
-        add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
628
-        if (method_exists($this, 'load_scripts_styles_' . $this->_current_view)) {
629
-            add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view), 15);
630
-        }
631
-        add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
632
-        //admin_print_footer_scripts - global, page child class, and view specific.  NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.  In most cases that's doing_it_wrong().  But adding hidden container elements etc. is a good use case. Notice the late priority we're giving these
633
-        add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
634
-        add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
635
-        if (method_exists($this, 'admin_footer_scripts_' . $this->_current_view)) {
636
-            add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_' . $this->_current_view), 101);
637
-        }
638
-        //admin footer scripts
639
-        add_action('admin_footer', array($this, 'admin_footer_global'), 99);
640
-        add_action('admin_footer', array($this, 'admin_footer'), 100);
641
-        if (method_exists($this, 'admin_footer_' . $this->_current_view)) {
642
-            add_action('admin_footer', array($this, 'admin_footer_' . $this->_current_view), 101);
643
-        }
644
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
645
-        //targeted hook
646
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action);
647
-    }
648
-
649
-
650
-
651
-    /**
652
-     * _set_defaults
653
-     * This sets some global defaults for class properties.
654
-     */
655
-    private function _set_defaults()
656
-    {
657
-        $this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = $this->_event = $this->_template_path = $this->_column_template_path = null;
658
-        $this->_nav_tabs = $this_views = $this->_page_routes = $this->_page_config = $this->_default_route_query_args = array();
659
-        $this->default_nav_tab_name = 'overview';
660
-        //init template args
661
-        $this->_template_args = array(
662
-                'admin_page_header'  => '',
663
-                'admin_page_content' => '',
664
-                'post_body_content'  => '',
665
-                'before_list_table'  => '',
666
-                'after_list_table'   => '',
667
-        );
668
-    }
669
-
670
-
671
-
672
-    /**
673
-     * route_admin_request
674
-     *
675
-     * @see    _route_admin_request()
676
-     * @access public
677
-     * @return void|exception error
678
-     */
679
-    public function route_admin_request()
680
-    {
681
-        try {
682
-            $this->_route_admin_request();
683
-        } catch (EE_Error $e) {
684
-            $e->get_error();
685
-        }
686
-    }
687
-
688
-
689
-
690
-    public function set_wp_page_slug($wp_page_slug)
691
-    {
692
-        $this->_wp_page_slug = $wp_page_slug;
693
-        //if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
694
-        if (is_network_admin()) {
695
-            $this->_wp_page_slug .= '-network';
696
-        }
697
-    }
698
-
699
-
700
-
701
-    /**
702
-     * _verify_routes
703
-     * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so we know if we need to drop out.
704
-     *
705
-     * @access protected
706
-     * @return void
707
-     */
708
-    protected function _verify_routes()
709
-    {
710
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
711
-        if ( ! $this->_current_page && ! defined('DOING_AJAX')) {
712
-            return false;
713
-        }
714
-        $this->_route = false;
715
-        $func = false;
716
-        $args = array();
717
-        // check that the page_routes array is not empty
718
-        if (empty($this->_page_routes)) {
719
-            // user error msg
720
-            $error_msg = sprintf(__('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
721
-            // developer error msg
722
-            $error_msg .= '||' . $error_msg . __(' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso');
723
-            throw new EE_Error($error_msg);
724
-        }
725
-        // and that the requested page route exists
726
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
727
-            $this->_route = $this->_page_routes[$this->_req_action];
728
-            $this->_route_config = isset($this->_page_config[$this->_req_action]) ? $this->_page_config[$this->_req_action] : array();
729
-        } else {
730
-            // user error msg
731
-            $error_msg = sprintf(__('The requested page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
732
-            // developer error msg
733
-            $error_msg .= '||' . $error_msg . sprintf(__(' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso'), $this->_req_action);
734
-            throw new EE_Error($error_msg);
735
-        }
736
-        // and that a default route exists
737
-        if ( ! array_key_exists('default', $this->_page_routes)) {
738
-            // user error msg
739
-            $error_msg = sprintf(__('A default page route has not been set for the % admin page.', 'event_espresso'), $this->_admin_page_title);
740
-            // developer error msg
741
-            $error_msg .= '||' . $error_msg . __(' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso');
742
-            throw new EE_Error($error_msg);
743
-        }
744
-        //first lets' catch if the UI request has EVER been set.
745
-        if ($this->_is_UI_request === null) {
746
-            //lets set if this is a UI request or not.
747
-            $this->_is_UI_request = ( ! isset($this->_req_data['noheader']) || $this->_req_data['noheader'] !== true) ? true : false;
748
-            //wait a minute... we might have a noheader in the route array
749
-            $this->_is_UI_request = is_array($this->_route) && isset($this->_route['noheader']) && $this->_route['noheader'] ? false : $this->_is_UI_request;
750
-        }
751
-        $this->_set_current_labels();
752
-    }
753
-
754
-
755
-
756
-    /**
757
-     * this method simply verifies a given route and makes sure its an actual route available for the loaded page
758
-     *
759
-     * @param  string $route the route name we're verifying
760
-     * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
761
-     */
762
-    protected function _verify_route($route)
763
-    {
764
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
765
-            return true;
766
-        } else {
767
-            // user error msg
768
-            $error_msg = sprintf(__('The given page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
769
-            // developer error msg
770
-            $error_msg .= '||' . $error_msg . sprintf(__(' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso'), $route);
771
-            throw new EE_Error($error_msg);
772
-        }
773
-    }
774
-
775
-
776
-
777
-    /**
778
-     * perform nonce verification
779
-     * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces using this method (and save retyping!)
780
-     *
781
-     * @param  string $nonce     The nonce sent
782
-     * @param  string $nonce_ref The nonce reference string (name0)
783
-     * @return mixed (bool|die)
784
-     */
785
-    protected function _verify_nonce($nonce, $nonce_ref)
786
-    {
787
-        // verify nonce against expected value
788
-        if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
789
-            // these are not the droids you are looking for !!!
790
-            $msg = sprintf(__('%sNonce Fail.%s', 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>');
791
-            if (WP_DEBUG) {
792
-                $msg .= "\n  " . sprintf(__('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso'), __CLASS__);
793
-            }
794
-            if ( ! defined('DOING_AJAX')) {
795
-                wp_die($msg);
796
-            } else {
797
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
798
-                $this->_return_json();
799
-            }
800
-        }
801
-    }
802
-
803
-
804
-
805
-    /**
806
-     * _route_admin_request()
807
-     * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
808
-     * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
809
-     * in the page routes and then will try to load the corresponding method.
810
-     *
811
-     * @access protected
812
-     * @return void
813
-     * @throws \EE_Error
814
-     */
815
-    protected function _route_admin_request()
816
-    {
817
-        if ( ! $this->_is_UI_request) {
818
-            $this->_verify_routes();
819
-        }
820
-        $nonce_check = isset($this->_route_config['require_nonce'])
821
-            ? $this->_route_config['require_nonce']
822
-            : true;
823
-        if ($this->_req_action !== 'default' && $nonce_check) {
824
-            // set nonce from post data
825
-            $nonce = isset($this->_req_data[$this->_req_nonce])
826
-                ? sanitize_text_field($this->_req_data[$this->_req_nonce])
827
-                : '';
828
-            $this->_verify_nonce($nonce, $this->_req_nonce);
829
-        }
830
-        //set the nav_tabs array but ONLY if this is  UI_request
831
-        if ($this->_is_UI_request) {
832
-            $this->_set_nav_tabs();
833
-        }
834
-        // grab callback function
835
-        $func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
836
-        // check if callback has args
837
-        $args = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : array();
838
-        $error_msg = '';
839
-        // action right before calling route
840
-        // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
841
-        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
842
-            do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
843
-        }
844
-        // right before calling the route, let's remove _wp_http_referer from the
845
-        // $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
846
-        $_SERVER['REQUEST_URI'] = remove_query_arg('_wp_http_referer', wp_unslash($_SERVER['REQUEST_URI']));
847
-        if ( ! empty($func)) {
848
-            if (is_array($func)) {
849
-                list($class, $method) = $func;
850
-            } else if (strpos($func, '::') !== false) {
851
-                list($class, $method) = explode('::', $func);
852
-            } else {
853
-                $class = $this;
854
-                $method = $func;
855
-            }
856
-            if ( ! (is_object($class) && $class === $this)) {
857
-                // send along this admin page object for access by addons.
858
-                $args['admin_page_object'] = $this;
859
-            }
860
-
861
-            if (
862
-                //is it a method on a class that doesn't work?
863
-                (
864
-                    (
865
-                        method_exists($class, $method)
866
-                        && call_user_func_array(array($class, $method), $args) === false
867
-                    )
868
-                    && (
869
-                        //is it a standalone function that doesn't work?
870
-                        function_exists($method)
871
-                        && call_user_func_array($func, array_merge(array('admin_page_object' => $this), $args)) === false
872
-                    )
873
-                )
874
-                || (
875
-                    //is it neither a class method NOR a standalone function?
876
-                    ! method_exists($class, $method)
877
-                    && ! function_exists($method)
878
-                )
879
-            ) {
880
-                // user error msg
881
-                $error_msg = __('An error occurred. The  requested page route could not be found.', 'event_espresso');
882
-                // developer error msg
883
-                $error_msg .= '||';
884
-                $error_msg .= sprintf(
885
-                    __(
886
-                        'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
887
-                        'event_espresso'
888
-                    ),
889
-                    $method
890
-                );
891
-            }
892
-            if ( ! empty($error_msg)) {
893
-                throw new EE_Error($error_msg);
894
-            }
895
-        }
896
-        //if we've routed and this route has a no headers route AND a sent_headers_route, then we need to reset the routing properties to the new route.
897
-        //now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
898
-        if ($this->_is_UI_request === false
899
-            && is_array($this->_route)
900
-            && ! empty($this->_route['headers_sent_route'])
901
-        ) {
902
-            $this->_reset_routing_properties($this->_route['headers_sent_route']);
903
-        }
904
-    }
905
-
906
-
907
-
908
-    /**
909
-     * This method just allows the resetting of page properties in the case where a no headers
910
-     * route redirects to a headers route in its route config.
911
-     *
912
-     * @since   4.3.0
913
-     * @param  string $new_route New (non header) route to redirect to.
914
-     * @return   void
915
-     */
916
-    protected function _reset_routing_properties($new_route)
917
-    {
918
-        $this->_is_UI_request = true;
919
-        //now we set the current route to whatever the headers_sent_route is set at
920
-        $this->_req_data['action'] = $new_route;
921
-        //rerun page setup
922
-        $this->_page_setup();
923
-    }
924
-
925
-
926
-
927
-    /**
928
-     * _add_query_arg
929
-     * adds nonce to array of arguments then calls WP add_query_arg function
930
-     *(internally just uses EEH_URL's function with the same name)
931
-     *
932
-     * @access public
933
-     * @param array  $args
934
-     * @param string $url
935
-     * @param bool   $sticky                  if true, then the existing Request params will be appended to the generated
936
-     *                                        url in an associative array indexed by the key 'wp_referer';
937
-     *                                        Example usage:
938
-     *                                        If the current page is:
939
-     *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
940
-     *                                        &action=default&event_id=20&month_range=March%202015
941
-     *                                        &_wpnonce=5467821
942
-     *                                        and you call:
943
-     *                                        EE_Admin_Page::add_query_args_and_nonce(
944
-     *                                        array(
945
-     *                                        'action' => 'resend_something',
946
-     *                                        'page=>espresso_registrations'
947
-     *                                        ),
948
-     *                                        $some_url,
949
-     *                                        true
950
-     *                                        );
951
-     *                                        It will produce a url in this structure:
952
-     *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
953
-     *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
954
-     *                                        month_range]=March%202015
955
-     * @param   bool $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
956
-     * @return string
957
-     */
958
-    public static function add_query_args_and_nonce($args = array(), $url = false, $sticky = false, $exclude_nonce = false)
959
-    {
960
-        //if there is a _wp_http_referer include the values from the request but only if sticky = true
961
-        if ($sticky) {
962
-            $request = $_REQUEST;
963
-            unset($request['_wp_http_referer']);
964
-            unset($request['wp_referer']);
965
-            foreach ($request as $key => $value) {
966
-                //do not add nonces
967
-                if (strpos($key, 'nonce') !== false) {
968
-                    continue;
969
-                }
970
-                $args['wp_referer[' . $key . ']'] = $value;
971
-            }
972
-        }
973
-        return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
974
-    }
975
-
976
-
977
-
978
-    /**
979
-     * This returns a generated link that will load the related help tab.
980
-     *
981
-     * @param  string $help_tab_id the id for the connected help tab
982
-     * @param  string $icon_style  (optional) include css class for the style you want to use for the help icon.
983
-     * @param  string $help_text   (optional) send help text you want to use for the link if default not to be used
984
-     * @uses EEH_Template::get_help_tab_link()
985
-     * @return string              generated link
986
-     */
987
-    protected function _get_help_tab_link($help_tab_id, $icon_style = false, $help_text = false)
988
-    {
989
-        return EEH_Template::get_help_tab_link($help_tab_id, $this->page_slug, $this->_req_action, $icon_style, $help_text);
990
-    }
991
-
992
-
993
-
994
-    /**
995
-     * _add_help_tabs
996
-     * Note child classes define their help tabs within the page_config array.
997
-     *
998
-     * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
999
-     * @access protected
1000
-     * @return void
1001
-     */
1002
-    protected function _add_help_tabs()
1003
-    {
1004
-        $tour_buttons = '';
1005
-        if (isset($this->_page_config[$this->_req_action])) {
1006
-            $config = $this->_page_config[$this->_req_action];
1007
-            //is there a help tour for the current route?  if there is let's setup the tour buttons
1008
-            if (isset($this->_help_tour[$this->_req_action])) {
1009
-                $tb = array();
1010
-                $tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
1011
-                foreach ($this->_help_tour['tours'] as $tour) {
1012
-                    //if this is the end tour then we don't need to setup a button
1013
-                    if ($tour instanceof EE_Help_Tour_final_stop) {
1014
-                        continue;
1015
-                    }
1016
-                    $tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
1017
-                }
1018
-                $tour_buttons .= implode('<br />', $tb);
1019
-                $tour_buttons .= '</div></div>';
1020
-            }
1021
-            // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
1022
-            if (is_array($config) && isset($config['help_sidebar'])) {
1023
-                //check that the callback given is valid
1024
-                if ( ! method_exists($this, $config['help_sidebar'])) {
1025
-                    throw new EE_Error(sprintf(__('The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
1026
-                            'event_espresso'), $config['help_sidebar'], get_class($this)));
1027
-                }
1028
-                $content = apply_filters('FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func(array($this, $config['help_sidebar'])));
1029
-                $content .= $tour_buttons; //add help tour buttons.
1030
-                //do we have any help tours setup?  Cause if we do we want to add the buttons
1031
-                $this->_current_screen->set_help_sidebar($content);
1032
-            }
1033
-            //if we DON'T have config help sidebar and there ARE toure buttons then we'll just add the tour buttons to the sidebar.
1034
-            if ( ! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
1035
-                $this->_current_screen->set_help_sidebar($tour_buttons);
1036
-            }
1037
-            //handle if no help_tabs are set so the sidebar will still show for the help tour buttons
1038
-            if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
1039
-                $_ht['id'] = $this->page_slug;
1040
-                $_ht['title'] = __('Help Tours', 'event_espresso');
1041
-                $_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
1042
-                $this->_current_screen->add_help_tab($_ht);
1043
-            }/**/
1044
-            if ( ! isset($config['help_tabs'])) {
1045
-                return;
1046
-            } //no help tabs for this route
1047
-            foreach ((array)$config['help_tabs'] as $tab_id => $cfg) {
1048
-                //we're here so there ARE help tabs!
1049
-                //make sure we've got what we need
1050
-                if ( ! isset($cfg['title'])) {
1051
-                    throw new EE_Error(__('The _page_config array is not set up properly for help tabs.  It is missing a title', 'event_espresso'));
1052
-                }
1053
-                if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
1054
-                    throw new EE_Error(__('The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
1055
-                            'event_espresso'));
1056
-                }
1057
-                //first priority goes to content.
1058
-                if ( ! empty($cfg['content'])) {
1059
-                    $content = ! empty($cfg['content']) ? $cfg['content'] : null;
1060
-                    //second priority goes to filename
1061
-                } else if ( ! empty($cfg['filename'])) {
1062
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
1063
-                    //it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
1064
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;
1065
-                    //if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1066
-                    if ( ! is_readable($file_path) && ! isset($cfg['callback'])) {
1067
-                        EE_Error::add_error(sprintf(__('The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
1068
-                                'event_espresso'), $tab_id, key($config), $file_path), __FILE__, __FUNCTION__, __LINE__);
1069
-                        return;
1070
-                    }
1071
-                    $template_args['admin_page_obj'] = $this;
1072
-                    $content = EEH_Template::display_template($file_path, $template_args, true);
1073
-                } else {
1074
-                    $content = '';
1075
-                }
1076
-                //check if callback is valid
1077
-                if (empty($content) && ( ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback']))) {
1078
-                    EE_Error::add_error(sprintf(__('The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
1079
-                            'event_espresso'), $cfg['title']), __FILE__, __FUNCTION__, __LINE__);
1080
-                    return;
1081
-                }
1082
-                //setup config array for help tab method
1083
-                $id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
1084
-                $_ht = array(
1085
-                        'id'       => $id,
1086
-                        'title'    => $cfg['title'],
1087
-                        'callback' => isset($cfg['callback']) && empty($content) ? array($this, $cfg['callback']) : null,
1088
-                        'content'  => $content,
1089
-                );
1090
-                $this->_current_screen->add_help_tab($_ht);
1091
-            }
1092
-        }
1093
-    }
1094
-
1095
-
1096
-
1097
-    /**
1098
-     * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is an array with properties for setting up usage of the joyride plugin
1099
-     *
1100
-     * @link   http://zurb.com/playground/jquery-joyride-feature-tour-plugin
1101
-     * @see    instructions regarding the format and construction of the "help_tour" array element is found in the _set_page_config() comments
1102
-     * @access protected
1103
-     * @return void
1104
-     */
1105
-    protected function _add_help_tour()
1106
-    {
1107
-        $tours = array();
1108
-        $this->_help_tour = array();
1109
-        //exit early if help tours are turned off globally
1110
-        if ( ! EE_Registry::instance()->CFG->admin->help_tour_activation || (defined('EE_DISABLE_HELP_TOURS') && EE_DISABLE_HELP_TOURS)) {
1111
-            return;
1112
-        }
1113
-        //loop through _page_config to find any help_tour defined
1114
-        foreach ($this->_page_config as $route => $config) {
1115
-            //we're only going to set things up for this route
1116
-            if ($route !== $this->_req_action) {
1117
-                continue;
1118
-            }
1119
-            if (isset($config['help_tour'])) {
1120
-                foreach ($config['help_tour'] as $tour) {
1121
-                    $file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
1122
-                    //let's see if we can get that file... if not its possible this is a decaf route not set in caffienated so lets try and get the caffeinated equivalent
1123
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;
1124
-                    //if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1125
-                    if ( ! is_readable($file_path)) {
1126
-                        EE_Error::add_error(sprintf(__('The file path given for the help tour (%s) is not a valid path.  Please check that the string you set for the help tour on this route (%s) is the correct spelling', 'event_espresso'),
1127
-                                $file_path, $tour), __FILE__, __FUNCTION__, __LINE__);
1128
-                        return;
1129
-                    }
1130
-                    require_once $file_path;
1131
-                    if ( ! class_exists($tour)) {
1132
-                        $error_msg[] = sprintf(__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'), $tour);
1133
-                        $error_msg[] = $error_msg[0] . "\r\n" . sprintf(__('There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.',
1134
-                                        'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this));
1135
-                        throw new EE_Error(implode('||', $error_msg));
1136
-                    }
1137
-                    $a = new ReflectionClass($tour);
1138
-                    $tour_obj = $a->newInstance($this->_is_caf);
1139
-                    $tours[] = $tour_obj;
1140
-                    $this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($tour_obj);
1141
-                }
1142
-                //let's inject the end tour stop element common to all pages... this will only get seen once per machine.
1143
-                $end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
1144
-                $tours[] = $end_stop_tour;
1145
-                $this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
1146
-            }
1147
-        }
1148
-        if ( ! empty($tours)) {
1149
-            $this->_help_tour['tours'] = $tours;
1150
-        }
1151
-        //thats it!  Now that the $_help_tours property is set (or not) the scripts and html should be taken care of automatically.
1152
-    }
1153
-
1154
-
1155
-
1156
-    /**
1157
-     * This simply sets up any qtips that have been defined in the page config
1158
-     *
1159
-     * @access protected
1160
-     * @return void
1161
-     */
1162
-    protected function _add_qtips()
1163
-    {
1164
-        if (isset($this->_route_config['qtips'])) {
1165
-            $qtips = (array)$this->_route_config['qtips'];
1166
-            //load qtip loader
1167
-            $path = array(
1168
-                    $this->_get_dir() . '/qtips/',
1169
-                    EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
1170
-            );
1171
-            EEH_Qtip_Loader::instance()->register($qtips, $path);
1172
-        }
1173
-    }
1174
-
1175
-
1176
-
1177
-    /**
1178
-     * _set_nav_tabs
1179
-     * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you wish to add additional tabs or modify accordingly.
1180
-     *
1181
-     * @access protected
1182
-     * @return void
1183
-     */
1184
-    protected function _set_nav_tabs()
1185
-    {
1186
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1187
-        $i = 0;
1188
-        foreach ($this->_page_config as $slug => $config) {
1189
-            if ( ! is_array($config) || (is_array($config) && (isset($config['nav']) && ! $config['nav']) || ! isset($config['nav']))) {
1190
-                continue;
1191
-            } //no nav tab for this config
1192
-            //check for persistent flag
1193
-            if (isset($config['nav']['persistent']) && ! $config['nav']['persistent'] && $slug !== $this->_req_action) {
1194
-                continue;
1195
-            } //nav tab is only to appear when route requested.
1196
-            if ( ! $this->check_user_access($slug, true)) {
1197
-                continue;
1198
-            } //no nav tab becasue current user does not have access.
1199
-            $css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
1200
-            $this->_nav_tabs[$slug] = array(
1201
-                    'url'       => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce(array('action' => $slug), $this->_admin_base_url),
1202
-                    'link_text' => isset($config['nav']['label']) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug)),
1203
-                    'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
1204
-                    'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
1205
-            );
1206
-            $i++;
1207
-        }
1208
-        //if $this->_nav_tabs is empty then lets set the default
1209
-        if (empty($this->_nav_tabs)) {
1210
-            $this->_nav_tabs[$this->default_nav_tab_name] = array(
1211
-                    'url'       => $this->admin_base_url,
1212
-                    'link_text' => ucwords(str_replace('_', ' ', $this->default_nav_tab_name)),
1213
-                    'css_class' => 'nav-tab-active',
1214
-                    'order'     => 10,
1215
-            );
1216
-        }
1217
-        //now let's sort the tabs according to order
1218
-        usort($this->_nav_tabs, array($this, '_sort_nav_tabs'));
1219
-    }
1220
-
1221
-
1222
-
1223
-    /**
1224
-     * _set_current_labels
1225
-     * This method modifies the _labels property with any optional specific labels indicated in the _page_routes property array
1226
-     *
1227
-     * @access private
1228
-     * @return void
1229
-     */
1230
-    private function _set_current_labels()
1231
-    {
1232
-        if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
1233
-            foreach ($this->_route_config['labels'] as $label => $text) {
1234
-                if (is_array($text)) {
1235
-                    foreach ($text as $sublabel => $subtext) {
1236
-                        $this->_labels[$label][$sublabel] = $subtext;
1237
-                    }
1238
-                } else {
1239
-                    $this->_labels[$label] = $text;
1240
-                }
1241
-            }
1242
-        }
1243
-    }
1244
-
1245
-
1246
-
1247
-    /**
1248
-     *        verifies user access for this admin page
1249
-     *
1250
-     * @param string $route_to_check if present then the capability for the route matching this string is checked.
1251
-     * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just return false if verify fail.
1252
-     * @return        BOOL|wp_die()
1253
-     */
1254
-    public function check_user_access($route_to_check = '', $verify_only = false)
1255
-    {
1256
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1257
-        $route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
1258
-        $capability = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check]) && is_array($this->_page_routes[$route_to_check]) && ! empty($this->_page_routes[$route_to_check]['capability'])
1259
-                ? $this->_page_routes[$route_to_check]['capability'] : null;
1260
-        if (empty($capability) && empty($route_to_check)) {
1261
-            $capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options' : $this->_route['capability'];
1262
-        } else {
1263
-            $capability = empty($capability) ? 'manage_options' : $capability;
1264
-        }
1265
-        $id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
1266
-        if (( ! function_exists('is_admin') || ! EE_Registry::instance()->CAP->current_user_can($capability, $this->page_slug . '_' . $route_to_check, $id)) && ! defined('DOING_AJAX')) {
1267
-            if ($verify_only) {
1268
-                return false;
1269
-            } else {
1270
-                if ( is_user_logged_in() ) {
1271
-                    wp_die(__('You do not have access to this route.', 'event_espresso'));
1272
-                } else {
1273
-                    return false;
1274
-                }
1275
-            }
1276
-        }
1277
-        return true;
1278
-    }
1279
-
1280
-
1281
-
1282
-    /**
1283
-     * admin_init_global
1284
-     * This runs all the code that we want executed within the WP admin_init hook.
1285
-     * This method executes for ALL EE Admin pages.
1286
-     *
1287
-     * @access public
1288
-     * @return void
1289
-     */
1290
-    public function admin_init_global()
1291
-    {
1292
-    }
1293
-
1294
-
1295
-
1296
-    /**
1297
-     * wp_loaded_global
1298
-     * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an EE_Admin page and will execute on every EE Admin Page load
1299
-     *
1300
-     * @access public
1301
-     * @return void
1302
-     */
1303
-    public function wp_loaded()
1304
-    {
1305
-    }
1306
-
1307
-
1308
-
1309
-    /**
1310
-     * admin_notices
1311
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on ALL EE_Admin pages.
1312
-     *
1313
-     * @access public
1314
-     * @return void
1315
-     */
1316
-    public function admin_notices_global()
1317
-    {
1318
-        $this->_display_no_javascript_warning();
1319
-        $this->_display_espresso_notices();
1320
-    }
1321
-
1322
-
1323
-
1324
-    public function network_admin_notices_global()
1325
-    {
1326
-        $this->_display_no_javascript_warning();
1327
-        $this->_display_espresso_notices();
1328
-    }
1329
-
1330
-
1331
-
1332
-    /**
1333
-     * admin_footer_scripts_global
1334
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply on ALL EE_Admin pages.
1335
-     *
1336
-     * @access public
1337
-     * @return void
1338
-     */
1339
-    public function admin_footer_scripts_global()
1340
-    {
1341
-        $this->_add_admin_page_ajax_loading_img();
1342
-        $this->_add_admin_page_overlay();
1343
-        //if metaboxes are present we need to add the nonce field
1344
-        if ((isset($this->_route_config['metaboxes']) || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes']) || isset($this->_route_config['list_table']))) {
1345
-            wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
1346
-            wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
1347
-        }
1348
-    }
1349
-
1350
-
1351
-
1352
-    /**
1353
-     * admin_footer_global
1354
-     * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particluar method will apply on ALL EE_Admin Pages.
1355
-     *
1356
-     * @access  public
1357
-     * @return  void
1358
-     */
1359
-    public function admin_footer_global()
1360
-    {
1361
-        //dialog container for dialog helper
1362
-        $d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
1363
-        $d_cont .= '<div class="ee-notices"></div>';
1364
-        $d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
1365
-        $d_cont .= '</div>';
1366
-        echo $d_cont;
1367
-        //help tour stuff?
1368
-        if (isset($this->_help_tour[$this->_req_action])) {
1369
-            echo implode('<br />', $this->_help_tour[$this->_req_action]);
1370
-        }
1371
-        //current set timezone for timezone js
1372
-        echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
1373
-    }
1374
-
1375
-
1376
-
1377
-    /**
1378
-     * This function sees if there is a method for help popup content existing for the given route.  If there is then we'll use the retrieved array to output the content using the template.
1379
-     * For child classes:
1380
-     * If you want to have help popups then in your templates or your content you set "triggers" for the content using the "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method for
1381
-     * the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content for the
1382
-     * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined "help_popup_content_..." method.  You must prepare and return an array in the following format array(
1383
-     *    'help_trigger_id' => array(
1384
-     *        'title' => __('localized title for popup', 'event_espresso'),
1385
-     *        'content' => __('localized content for popup', 'event_espresso')
1386
-     *    )
1387
-     * );
1388
-     * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
1389
-     *
1390
-     * @access protected
1391
-     * @return string content
1392
-     */
1393
-    protected function _set_help_popup_content($help_array = array(), $display = false)
1394
-    {
1395
-        $content = '';
1396
-        $help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
1397
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';
1398
-        //loop through the array and setup content
1399
-        foreach ($help_array as $trigger => $help) {
1400
-            //make sure the array is setup properly
1401
-            if ( ! isset($help['title']) || ! isset($help['content'])) {
1402
-                throw new EE_Error(__('Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
1403
-                        'event_espresso'));
1404
-            }
1405
-            //we're good so let'd setup the template vars and then assign parsed template content to our content.
1406
-            $template_args = array(
1407
-                    'help_popup_id'      => $trigger,
1408
-                    'help_popup_title'   => $help['title'],
1409
-                    'help_popup_content' => $help['content'],
1410
-            );
1411
-            $content .= EEH_Template::display_template($template_path, $template_args, true);
1412
-        }
1413
-        if ($display) {
1414
-            echo $content;
1415
-        } else {
1416
-            return $content;
1417
-        }
1418
-    }
1419
-
1420
-
1421
-
1422
-    /**
1423
-     * All this does is retrive the help content array if set by the EE_Admin_Page child
1424
-     *
1425
-     * @access private
1426
-     * @return array properly formatted array for help popup content
1427
-     */
1428
-    private function _get_help_content()
1429
-    {
1430
-        //what is the method we're looking for?
1431
-        $method_name = '_help_popup_content_' . $this->_req_action;
1432
-        //if method doesn't exist let's get out.
1433
-        if ( ! method_exists($this, $method_name)) {
1434
-            return array();
1435
-        }
1436
-        //k we're good to go let's retrieve the help array
1437
-        $help_array = call_user_func(array($this, $method_name));
1438
-        //make sure we've got an array!
1439
-        if ( ! is_array($help_array)) {
1440
-            throw new EE_Error(__('Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.', 'event_espresso'));
1441
-        }
1442
-        return $help_array;
1443
-    }
1444
-
1445
-
1446
-
1447
-    /**
1448
-     * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
1449
-     * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
1450
-     * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
1451
-     *
1452
-     * @access protected
1453
-     * @param string  $trigger_id reference for retrieving the trigger content for the popup
1454
-     * @param boolean $display    if false then we return the trigger string
1455
-     * @param array   $dimensions an array of dimensions for the box (array(h,w))
1456
-     * @return string
1457
-     */
1458
-    protected function _set_help_trigger($trigger_id, $display = true, $dimensions = array('400', '640'))
1459
-    {
1460
-        if (defined('DOING_AJAX')) {
1461
-            return;
1462
-        }
1463
-        //let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
1464
-        $help_array = $this->_get_help_content();
1465
-        $help_content = '';
1466
-        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
1467
-            $help_array[$trigger_id] = array(
1468
-                    'title'   => __('Missing Content', 'event_espresso'),
1469
-                    'content' => __('A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
1470
-                            'event_espresso'),
1471
-            );
1472
-            $help_content = $this->_set_help_popup_content($help_array, false);
1473
-        }
1474
-        //let's setup the trigger
1475
-        $content = '<a class="ee-dialog" href="?height=' . $dimensions[0] . '&width=' . $dimensions[1] . '&inlineId=' . $trigger_id . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
1476
-        $content = $content . $help_content;
1477
-        if ($display) {
1478
-            echo $content;
1479
-        } else {
1480
-            return $content;
1481
-        }
1482
-    }
1483
-
1484
-
1485
-
1486
-    /**
1487
-     * _add_global_screen_options
1488
-     * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
1489
-     * This particular method will add_screen_options on ALL EE_Admin Pages
1490
-     *
1491
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
1492
-     *         see also WP_Screen object documents...
1493
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
1494
-     * @abstract
1495
-     * @access private
1496
-     * @return void
1497
-     */
1498
-    private function _add_global_screen_options()
1499
-    {
1500
-    }
1501
-
1502
-
1503
-
1504
-    /**
1505
-     * _add_global_feature_pointers
1506
-     * This method is used for implementing any "feature pointers" (using built-in WP styling js).
1507
-     * This particular method will implement feature pointers for ALL EE_Admin pages.
1508
-     * Note: this is just a placeholder for now.  Implementation will come down the road
1509
-     *
1510
-     * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
1511
-     * @link   http://eamann.com/tech/wordpress-portland/
1512
-     * @abstract
1513
-     * @access protected
1514
-     * @return void
1515
-     */
1516
-    private function _add_global_feature_pointers()
1517
-    {
1518
-    }
1519
-
1520
-
1521
-
1522
-    /**
1523
-     * load_global_scripts_styles
1524
-     * The scripts and styles enqueued in here will be loaded on every EE Admin page
1525
-     *
1526
-     * @return void
1527
-     */
1528
-    public function load_global_scripts_styles()
1529
-    {
1530
-        /** STYLES **/
1531
-        // add debugging styles
1532
-        if (WP_DEBUG) {
1533
-            add_action('admin_head', array($this, 'add_xdebug_style'));
1534
-        }
1535
-        // register all styles
1536
-        wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
1537
-        wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
1538
-        //helpers styles
1539
-        wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION);
1540
-        /** SCRIPTS **/
1541
-        //register all scripts
1542
-        wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
1543
-        wp_register_script('ee_admin_js', EE_ADMIN_URL . 'assets/ee-admin-page.js', array('espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true);
1544
-        wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true);
1545
-        add_filter('FHEE_load_joyride', '__return_true');
1546
-        //script for sorting tables
1547
-        wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL . "assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
1548
-        //script for parsing uri's
1549
-        wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
1550
-        //and parsing associative serialized form elements
1551
-        wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
1552
-        //helpers scripts
1553
-        wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
1554
-        wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
1555
-        wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
1556
-        wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
1557
-        //google charts
1558
-        wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
1559
-        // ENQUEUE ALL BASICS BY DEFAULT
1560
-        wp_enqueue_style('ee-admin-css');
1561
-        wp_enqueue_script('ee_admin_js');
1562
-        wp_enqueue_script('ee-accounting');
1563
-        wp_enqueue_script('jquery-validate');
1564
-        //taking care of metaboxes
1565
-        if (
1566
-            empty($this->_cpt_route)
1567
-            && (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
1568
-        ) {
1569
-            wp_enqueue_script('dashboard');
1570
-        }
1571
-        // LOCALIZED DATA
1572
-        //localize script for ajax lazy loading
1573
-        $lazy_loader_container_ids = apply_filters('FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content'));
1574
-        wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
1575
-        /**
1576
-         * help tour stuff
1577
-         */
1578
-        if ( ! empty($this->_help_tour)) {
1579
-            //register the js for kicking things off
1580
-            wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
1581
-            //setup tours for the js tour object
1582
-            foreach ($this->_help_tour['tours'] as $tour) {
1583
-                $tours[] = array(
1584
-                        'id'      => $tour->get_slug(),
1585
-                        'options' => $tour->get_options(),
1586
-                );
1587
-            }
1588
-            wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
1589
-            //admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
1590
-        }
1591
-    }
1592
-
1593
-
1594
-
1595
-    /**
1596
-     *        admin_footer_scripts_eei18n_js_strings
1597
-     *
1598
-     * @access        public
1599
-     * @return        void
1600
-     */
1601
-    public function admin_footer_scripts_eei18n_js_strings()
1602
-    {
1603
-        EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
1604
-        EE_Registry::$i18n_js_strings['confirm_delete'] = __('Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!', 'event_espresso');
1605
-        EE_Registry::$i18n_js_strings['January'] = __('January', 'event_espresso');
1606
-        EE_Registry::$i18n_js_strings['February'] = __('February', 'event_espresso');
1607
-        EE_Registry::$i18n_js_strings['March'] = __('March', 'event_espresso');
1608
-        EE_Registry::$i18n_js_strings['April'] = __('April', 'event_espresso');
1609
-        EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
1610
-        EE_Registry::$i18n_js_strings['June'] = __('June', 'event_espresso');
1611
-        EE_Registry::$i18n_js_strings['July'] = __('July', 'event_espresso');
1612
-        EE_Registry::$i18n_js_strings['August'] = __('August', 'event_espresso');
1613
-        EE_Registry::$i18n_js_strings['September'] = __('September', 'event_espresso');
1614
-        EE_Registry::$i18n_js_strings['October'] = __('October', 'event_espresso');
1615
-        EE_Registry::$i18n_js_strings['November'] = __('November', 'event_espresso');
1616
-        EE_Registry::$i18n_js_strings['December'] = __('December', 'event_espresso');
1617
-        EE_Registry::$i18n_js_strings['Jan'] = __('Jan', 'event_espresso');
1618
-        EE_Registry::$i18n_js_strings['Feb'] = __('Feb', 'event_espresso');
1619
-        EE_Registry::$i18n_js_strings['Mar'] = __('Mar', 'event_espresso');
1620
-        EE_Registry::$i18n_js_strings['Apr'] = __('Apr', 'event_espresso');
1621
-        EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
1622
-        EE_Registry::$i18n_js_strings['Jun'] = __('Jun', 'event_espresso');
1623
-        EE_Registry::$i18n_js_strings['Jul'] = __('Jul', 'event_espresso');
1624
-        EE_Registry::$i18n_js_strings['Aug'] = __('Aug', 'event_espresso');
1625
-        EE_Registry::$i18n_js_strings['Sep'] = __('Sep', 'event_espresso');
1626
-        EE_Registry::$i18n_js_strings['Oct'] = __('Oct', 'event_espresso');
1627
-        EE_Registry::$i18n_js_strings['Nov'] = __('Nov', 'event_espresso');
1628
-        EE_Registry::$i18n_js_strings['Dec'] = __('Dec', 'event_espresso');
1629
-        EE_Registry::$i18n_js_strings['Sunday'] = __('Sunday', 'event_espresso');
1630
-        EE_Registry::$i18n_js_strings['Monday'] = __('Monday', 'event_espresso');
1631
-        EE_Registry::$i18n_js_strings['Tuesday'] = __('Tuesday', 'event_espresso');
1632
-        EE_Registry::$i18n_js_strings['Wednesday'] = __('Wednesday', 'event_espresso');
1633
-        EE_Registry::$i18n_js_strings['Thursday'] = __('Thursday', 'event_espresso');
1634
-        EE_Registry::$i18n_js_strings['Friday'] = __('Friday', 'event_espresso');
1635
-        EE_Registry::$i18n_js_strings['Saturday'] = __('Saturday', 'event_espresso');
1636
-        EE_Registry::$i18n_js_strings['Sun'] = __('Sun', 'event_espresso');
1637
-        EE_Registry::$i18n_js_strings['Mon'] = __('Mon', 'event_espresso');
1638
-        EE_Registry::$i18n_js_strings['Tue'] = __('Tue', 'event_espresso');
1639
-        EE_Registry::$i18n_js_strings['Wed'] = __('Wed', 'event_espresso');
1640
-        EE_Registry::$i18n_js_strings['Thu'] = __('Thu', 'event_espresso');
1641
-        EE_Registry::$i18n_js_strings['Fri'] = __('Fri', 'event_espresso');
1642
-        EE_Registry::$i18n_js_strings['Sat'] = __('Sat', 'event_espresso');
1643
-    }
1644
-
1645
-
1646
-
1647
-    /**
1648
-     *        load enhanced xdebug styles for ppl with failing eyesight
1649
-     *
1650
-     * @access        public
1651
-     * @return        void
1652
-     */
1653
-    public function add_xdebug_style()
1654
-    {
1655
-        echo '<style>.xdebug-error { font-size:1.5em; }</style>';
1656
-    }
1657
-
1658
-
1659
-    /************************/
1660
-    /** LIST TABLE METHODS **/
1661
-    /************************/
1662
-    /**
1663
-     * this sets up the list table if the current view requires it.
1664
-     *
1665
-     * @access protected
1666
-     * @return void
1667
-     */
1668
-    protected function _set_list_table()
1669
-    {
1670
-        //first is this a list_table view?
1671
-        if ( ! isset($this->_route_config['list_table'])) {
1672
-            return;
1673
-        } //not a list_table view so get out.
1674
-        //list table functions are per view specific (because some admin pages might have more than one listtable!)
1675
-        if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
1676
-            //user error msg
1677
-            $error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
1678
-            //developer error msg
1679
-            $error_msg .= '||' . sprintf(__('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso'),
1680
-                            $this->_req_action, '_set_list_table_views_' . $this->_req_action);
1681
-            throw new EE_Error($error_msg);
1682
-        }
1683
-        //let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
1684
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
1685
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
1686
-        $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
1687
-        $this->_set_list_table_view();
1688
-        $this->_set_list_table_object();
1689
-    }
1690
-
1691
-
1692
-
1693
-    /**
1694
-     *        set current view for List Table
1695
-     *
1696
-     * @access public
1697
-     * @return array
1698
-     */
1699
-    protected function _set_list_table_view()
1700
-    {
1701
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1702
-        // looking at active items or dumpster diving ?
1703
-        if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
1704
-            $this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
1705
-        } else {
1706
-            $this->_view = sanitize_key($this->_req_data['status']);
1707
-        }
1708
-    }
1709
-
1710
-
1711
-
1712
-    /**
1713
-     * _set_list_table_object
1714
-     * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
1715
-     *
1716
-     * @throws \EE_Error
1717
-     */
1718
-    protected function _set_list_table_object()
1719
-    {
1720
-        if (isset($this->_route_config['list_table'])) {
1721
-            if ( ! class_exists($this->_route_config['list_table'])) {
1722
-                throw new EE_Error(
1723
-                        sprintf(
1724
-                                __(
1725
-                                        'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
1726
-                                        'event_espresso'
1727
-                                ),
1728
-                                $this->_route_config['list_table'],
1729
-                                get_class($this)
1730
-                        )
1731
-                );
1732
-            }
1733
-            $list_table = $this->_route_config['list_table'];
1734
-            $this->_list_table_object = new $list_table($this);
1735
-        }
1736
-    }
1737
-
1738
-
1739
-
1740
-    /**
1741
-     * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
1742
-     *
1743
-     * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
1744
-     *                                                    urls.  The array should be indexed by the view it is being
1745
-     *                                                    added to.
1746
-     * @return array
1747
-     */
1748
-    public function get_list_table_view_RLs($extra_query_args = array())
1749
-    {
1750
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1751
-        if (empty($this->_views)) {
1752
-            $this->_views = array();
1753
-        }
1754
-        // cycle thru views
1755
-        foreach ($this->_views as $key => $view) {
1756
-            $query_args = array();
1757
-            // check for current view
1758
-            $this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
1759
-            $query_args['action'] = $this->_req_action;
1760
-            $query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
1761
-            $query_args['status'] = $view['slug'];
1762
-            //merge any other arguments sent in.
1763
-            if (isset($extra_query_args[$view['slug']])) {
1764
-                $query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
1765
-            }
1766
-            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
1767
-        }
1768
-        return $this->_views;
1769
-    }
1770
-
1771
-
1772
-
1773
-    /**
1774
-     * _entries_per_page_dropdown
1775
-     * generates a drop down box for selecting the number of visiable rows in an admin page list table
1776
-     *
1777
-     * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
1778
-     * @access protected
1779
-     * @param int $max_entries total number of rows in the table
1780
-     * @return string
1781
-     */
1782
-    protected function _entries_per_page_dropdown($max_entries = false)
1783
-    {
1784
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1785
-        $values = array(10, 25, 50, 100);
1786
-        $per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
1787
-        if ($max_entries) {
1788
-            $values[] = $max_entries;
1789
-            sort($values);
1790
-        }
1791
-        $entries_per_page_dropdown = '
143
+	// yes / no array for admin form fields
144
+	protected $_yes_no_values = array();
145
+
146
+	//some default things shared by all child classes
147
+	protected $_default_espresso_metaboxes;
148
+
149
+	/**
150
+	 *    EE_Registry Object
151
+	 *
152
+	 * @var    EE_Registry
153
+	 * @access    protected
154
+	 */
155
+	protected $EE = null;
156
+
157
+
158
+
159
+	/**
160
+	 * This is just a property that flags whether the given route is a caffeinated route or not.
161
+	 *
162
+	 * @var boolean
163
+	 */
164
+	protected $_is_caf = false;
165
+
166
+
167
+
168
+	/**
169
+	 * @Constructor
170
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
171
+	 * @access public
172
+	 */
173
+	public function __construct($routing = true)
174
+	{
175
+		if (strpos($this->_get_dir(), 'caffeinated') !== false) {
176
+			$this->_is_caf = true;
177
+		}
178
+		$this->_yes_no_values = array(
179
+				array('id' => true, 'text' => __('Yes', 'event_espresso')),
180
+				array('id' => false, 'text' => __('No', 'event_espresso')),
181
+		);
182
+		//set the _req_data property.
183
+		$this->_req_data = array_merge($_GET, $_POST);
184
+		//routing enabled?
185
+		$this->_routing = $routing;
186
+		//set initial page props (child method)
187
+		$this->_init_page_props();
188
+		//set global defaults
189
+		$this->_set_defaults();
190
+		//set early because incoming requests could be ajax related and we need to register those hooks.
191
+		$this->_global_ajax_hooks();
192
+		$this->_ajax_hooks();
193
+		//other_page_hooks have to be early too.
194
+		$this->_do_other_page_hooks();
195
+		//This just allows us to have extending classes do something specific
196
+		// before the parent constructor runs _page_setup().
197
+		if (method_exists($this, '_before_page_setup')) {
198
+			$this->_before_page_setup();
199
+		}
200
+		//set up page dependencies
201
+		$this->_page_setup();
202
+	}
203
+
204
+
205
+
206
+	/**
207
+	 * _init_page_props
208
+	 * Child classes use to set at least the following properties:
209
+	 * $page_slug.
210
+	 * $page_label.
211
+	 *
212
+	 * @abstract
213
+	 * @access protected
214
+	 * @return void
215
+	 */
216
+	abstract protected function _init_page_props();
217
+
218
+
219
+
220
+	/**
221
+	 * _ajax_hooks
222
+	 * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
223
+	 * Note: within the ajax callback methods.
224
+	 *
225
+	 * @abstract
226
+	 * @access protected
227
+	 * @return void
228
+	 */
229
+	abstract protected function _ajax_hooks();
230
+
231
+
232
+
233
+	/**
234
+	 * _define_page_props
235
+	 * child classes define page properties in here.  Must include at least:
236
+	 * $_admin_base_url = base_url for all admin pages
237
+	 * $_admin_page_title = default admin_page_title for admin pages
238
+	 * $_labels = array of default labels for various automatically generated elements:
239
+	 *    array(
240
+	 *        'buttons' => array(
241
+	 *            'add' => __('label for add new button'),
242
+	 *            'edit' => __('label for edit button'),
243
+	 *            'delete' => __('label for delete button')
244
+	 *            )
245
+	 *        )
246
+	 *
247
+	 * @abstract
248
+	 * @access protected
249
+	 * @return void
250
+	 */
251
+	abstract protected function _define_page_props();
252
+
253
+
254
+
255
+	/**
256
+	 * _set_page_routes
257
+	 * child classes use this to define the page routes for all subpages handled by the class.  Page routes are assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also have a 'default'
258
+	 * route. Here's the format
259
+	 * $this->_page_routes = array(
260
+	 *        'default' => array(
261
+	 *            'func' => '_default_method_handling_route',
262
+	 *            'args' => array('array','of','args'),
263
+	 *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e. ajax request, backend processing)
264
+	 *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a headers route after.  The string you enter here should match the defined route reference for a headers sent route.
265
+	 *            'capability' => 'route_capability', //indicate a string for minimum capability required to access this route.
266
+	 *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability checks).
267
+	 *        ),
268
+	 *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a handling method.
269
+	 *        )
270
+	 * )
271
+	 *
272
+	 * @abstract
273
+	 * @access protected
274
+	 * @return void
275
+	 */
276
+	abstract protected function _set_page_routes();
277
+
278
+
279
+
280
+	/**
281
+	 * _set_page_config
282
+	 * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the array corresponds to the page_route for the loaded page.
283
+	 * Format:
284
+	 * $this->_page_config = array(
285
+	 *        'default' => array(
286
+	 *            'labels' => array(
287
+	 *                'buttons' => array(
288
+	 *                    'add' => __('label for adding item'),
289
+	 *                    'edit' => __('label for editing item'),
290
+	 *                    'delete' => __('label for deleting item')
291
+	 *                ),
292
+	 *                'publishbox' => __('Localized Title for Publish metabox', 'event_espresso')
293
+	 *            ), //optional an array of custom labels for various automatically generated elements to use on the page. If this isn't present then the defaults will be used as set for the $this->_labels in _define_page_props() method
294
+	 *            'nav' => array(
295
+	 *                'label' => __('Label for Tab', 'event_espresso').
296
+	 *                'url' => 'http://someurl', //automatically generated UNLESS you define
297
+	 *                'css_class' => 'css-class', //automatically generated UNLESS you define
298
+	 *                'order' => 10, //required to indicate tab position.
299
+	 *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is displayed then add this parameter.
300
+	 *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
301
+	 *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load metaboxes set for eventespresso admin pages.
302
+	 *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added later.  We just use
303
+	 *            this flag to make sure the necessary js gets enqueued on page load.
304
+	 *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
305
+	 *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The array indicates the max number of columns (4) and the default number of columns on page load (2).  There is an option
306
+	 *            in the "screen_options" dropdown that is setup so users can pick what columns they want to display.
307
+	 *            'help_tabs' => array( //this is used for adding help tabs to a page
308
+	 *                'tab_id' => array(
309
+	 *                    'title' => 'tab_title',
310
+	 *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting help tab content.  The fallback if it isn't present is to try a the callback.  Filename should match a file in the admin
311
+	 *                    folder's "help_tabs" dir (ie.. events/help_tabs/name_of_file_containing_content.help_tab.php)
312
+	 *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will attempt to use the callback which should match the name of a method in the class
313
+	 *                    ),
314
+	 *                'tab2_id' => array(
315
+	 *                    'title' => 'tab2 title',
316
+	 *                    'filename' => 'file_name_2'
317
+	 *                    'callback' => 'callback_method_for_content',
318
+	 *                 ),
319
+	 *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the help tab area on an admin page. @link http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
320
+	 *            'help_tour' => array(
321
+	 *                'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located in a folder for this admin page named "help_tours", a file name matching the key given here
322
+	 *                (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
323
+	 *            ),
324
+	 *            'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is true if it isn't present).  To remove the requirement for a nonce check when this route is visited just set
325
+	 *            'require_nonce' to FALSE
326
+	 *            )
327
+	 * )
328
+	 *
329
+	 * @abstract
330
+	 * @access protected
331
+	 * @return void
332
+	 */
333
+	abstract protected function _set_page_config();
334
+
335
+
336
+
337
+
338
+
339
+	/** end sample help_tour methods **/
340
+	/**
341
+	 * _add_screen_options
342
+	 * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
343
+	 * Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options to a particular view.
344
+	 *
345
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
346
+	 *         see also WP_Screen object documents...
347
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
348
+	 * @abstract
349
+	 * @access protected
350
+	 * @return void
351
+	 */
352
+	abstract protected function _add_screen_options();
353
+
354
+
355
+
356
+	/**
357
+	 * _add_feature_pointers
358
+	 * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
359
+	 * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a particular view.
360
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
361
+	 * See: WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
362
+	 *
363
+	 * @link   http://eamann.com/tech/wordpress-portland/
364
+	 * @abstract
365
+	 * @access protected
366
+	 * @return void
367
+	 */
368
+	abstract protected function _add_feature_pointers();
369
+
370
+
371
+
372
+	/**
373
+	 * load_scripts_styles
374
+	 * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific scripts/styles
375
+	 * per view by putting them in a dynamic function in this format (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
376
+	 *
377
+	 * @abstract
378
+	 * @access public
379
+	 * @return void
380
+	 */
381
+	abstract public function load_scripts_styles();
382
+
383
+
384
+
385
+	/**
386
+	 * admin_init
387
+	 * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to all pages/views loaded by child class.
388
+	 *
389
+	 * @abstract
390
+	 * @access public
391
+	 * @return void
392
+	 */
393
+	abstract public function admin_init();
394
+
395
+
396
+
397
+	/**
398
+	 * admin_notices
399
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to all pages/views loaded by child class.
400
+	 *
401
+	 * @abstract
402
+	 * @access public
403
+	 * @return void
404
+	 */
405
+	abstract public function admin_notices();
406
+
407
+
408
+
409
+	/**
410
+	 * admin_footer_scripts
411
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply to all pages/views loaded by child class.
412
+	 *
413
+	 * @access public
414
+	 * @return void
415
+	 */
416
+	abstract public function admin_footer_scripts();
417
+
418
+
419
+
420
+	/**
421
+	 * admin_footer
422
+	 * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will apply to all pages/views loaded by child class.
423
+	 *
424
+	 * @access  public
425
+	 * @return void
426
+	 */
427
+	public function admin_footer()
428
+	{
429
+	}
430
+
431
+
432
+
433
+	/**
434
+	 * _global_ajax_hooks
435
+	 * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
436
+	 * Note: within the ajax callback methods.
437
+	 *
438
+	 * @abstract
439
+	 * @access protected
440
+	 * @return void
441
+	 */
442
+	protected function _global_ajax_hooks()
443
+	{
444
+		//for lazy loading of metabox content
445
+		add_action('wp_ajax_espresso-ajax-content', array($this, 'ajax_metabox_content'), 10);
446
+	}
447
+
448
+
449
+
450
+	public function ajax_metabox_content()
451
+	{
452
+		$contentid = isset($this->_req_data['contentid']) ? $this->_req_data['contentid'] : '';
453
+		$url = isset($this->_req_data['contenturl']) ? $this->_req_data['contenturl'] : '';
454
+		self::cached_rss_display($contentid, $url);
455
+		wp_die();
456
+	}
457
+
458
+
459
+
460
+	/**
461
+	 * _page_setup
462
+	 * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested doesn't match the object.
463
+	 *
464
+	 * @final
465
+	 * @access protected
466
+	 * @return void
467
+	 */
468
+	final protected function _page_setup()
469
+	{
470
+		//requires?
471
+		//admin_init stuff - global - we're setting this REALLY early so if EE_Admin pages have to hook into other WP pages they can.  But keep in mind, not everything is available from the EE_Admin Page object at this point.
472
+		add_action('admin_init', array($this, 'admin_init_global'), 5);
473
+		//next verify if we need to load anything...
474
+		$this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
475
+		$this->page_folder = strtolower(str_replace('_Admin_Page', '', str_replace('Extend_', '', get_class($this))));
476
+		global $ee_menu_slugs;
477
+		$ee_menu_slugs = (array)$ee_menu_slugs;
478
+		if (( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page])) && ! defined('DOING_AJAX')) {
479
+			return;
480
+		}
481
+		// becuz WP List tables have two duplicate select inputs for choosing bulk actions, we need to copy the action from the second to the first
482
+		if (isset($this->_req_data['action2']) && $this->_req_data['action'] == -1) {
483
+			$this->_req_data['action'] = ! empty($this->_req_data['action2']) && $this->_req_data['action2'] != -1 ? $this->_req_data['action2'] : $this->_req_data['action'];
484
+		}
485
+		// then set blank or -1 action values to 'default'
486
+		$this->_req_action = isset($this->_req_data['action']) && ! empty($this->_req_data['action']) && $this->_req_data['action'] != -1 ? sanitize_key($this->_req_data['action']) : 'default';
487
+		//if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.  This covers cases where we're coming in from a list table that isn't on the default route.
488
+		$this->_req_action = $this->_req_action === 'default' && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
489
+		//however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
490
+		$this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
491
+		$this->_current_view = $this->_req_action;
492
+		$this->_req_nonce = $this->_req_action . '_nonce';
493
+		$this->_define_page_props();
494
+		$this->_current_page_view_url = add_query_arg(array('page' => $this->_current_page, 'action' => $this->_current_view), $this->_admin_base_url);
495
+		//default things
496
+		$this->_default_espresso_metaboxes = array('_espresso_news_post_box', '_espresso_links_post_box', '_espresso_ratings_request', '_espresso_sponsors_post_box');
497
+		//set page configs
498
+		$this->_set_page_routes();
499
+		$this->_set_page_config();
500
+		//let's include any referrer data in our default_query_args for this route for "stickiness".
501
+		if (isset($this->_req_data['wp_referer'])) {
502
+			$this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
503
+		}
504
+		//for caffeinated and other extended functionality.  If there is a _extend_page_config method then let's run that to modify the all the various page configuration arrays
505
+		if (method_exists($this, '_extend_page_config')) {
506
+			$this->_extend_page_config();
507
+		}
508
+		//for CPT and other extended functionality. If there is an _extend_page_config_for_cpt then let's run that to modify all the various page configuration arrays.
509
+		if (method_exists($this, '_extend_page_config_for_cpt')) {
510
+			$this->_extend_page_config_for_cpt();
511
+		}
512
+		//filter routes and page_config so addons can add their stuff. Filtering done per class
513
+		$this->_page_routes = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this);
514
+		$this->_page_config = apply_filters('FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this);
515
+		//if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
516
+		if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
517
+			add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view), 10, 2);
518
+		}
519
+		//next route only if routing enabled
520
+		if ($this->_routing && ! defined('DOING_AJAX')) {
521
+			$this->_verify_routes();
522
+			//next let's just check user_access and kill if no access
523
+			$this->check_user_access();
524
+			if ($this->_is_UI_request) {
525
+				//admin_init stuff - global, all views for this page class, specific view
526
+				add_action('admin_init', array($this, 'admin_init'), 10);
527
+				if (method_exists($this, 'admin_init_' . $this->_current_view)) {
528
+					add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
529
+				}
530
+			} else {
531
+				//hijack regular WP loading and route admin request immediately
532
+				@ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
533
+				$this->route_admin_request();
534
+			}
535
+		}
536
+	}
537
+
538
+
539
+
540
+	/**
541
+	 * Provides a way for related child admin pages to load stuff on the loaded admin page.
542
+	 *
543
+	 * @access private
544
+	 * @return void
545
+	 */
546
+	private function _do_other_page_hooks()
547
+	{
548
+		$registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
549
+		foreach ($registered_pages as $page) {
550
+			//now let's setup the file name and class that should be present
551
+			$classname = str_replace('.class.php', '', $page);
552
+			//autoloaders should take care of loading file
553
+			if ( ! class_exists($classname)) {
554
+				$error_msg[] = sprintf( esc_html__('Something went wrong with loading the %s admin hooks page.', 'event_espresso'), $page);
555
+				$error_msg[] = $error_msg[0]
556
+							   . "\r\n"
557
+							   . sprintf( esc_html__('There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
558
+								'event_espresso'), $page, '<br />', '<strong>' . $classname . '</strong>');
559
+				throw new EE_Error(implode('||', $error_msg));
560
+			}
561
+			$a = new ReflectionClass($classname);
562
+			//notice we are passing the instance of this class to the hook object.
563
+			$hookobj[] = $a->newInstance($this);
564
+		}
565
+	}
566
+
567
+
568
+
569
+	public function load_page_dependencies()
570
+	{
571
+		try {
572
+			$this->_load_page_dependencies();
573
+		} catch (EE_Error $e) {
574
+			$e->get_error();
575
+		}
576
+	}
577
+
578
+
579
+
580
+	/**
581
+	 * load_page_dependencies
582
+	 * loads things specific to this page class when its loaded.  Really helps with efficiency.
583
+	 *
584
+	 * @access public
585
+	 * @return void
586
+	 */
587
+	protected function _load_page_dependencies()
588
+	{
589
+		//let's set the current_screen and screen options to override what WP set
590
+		$this->_current_screen = get_current_screen();
591
+		//load admin_notices - global, page class, and view specific
592
+		add_action('admin_notices', array($this, 'admin_notices_global'), 5);
593
+		add_action('admin_notices', array($this, 'admin_notices'), 10);
594
+		if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
595
+			add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
596
+		}
597
+		//load network admin_notices - global, page class, and view specific
598
+		add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
599
+		if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
600
+			add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
601
+		}
602
+		//this will save any per_page screen options if they are present
603
+		$this->_set_per_page_screen_options();
604
+		//setup list table properties
605
+		$this->_set_list_table();
606
+		// child classes can "register" a metabox to be automatically handled via the _page_config array property.  However in some cases the metaboxes will need to be added within a route handling callback.
607
+		$this->_add_registered_meta_boxes();
608
+		$this->_add_screen_columns();
609
+		//add screen options - global, page child class, and view specific
610
+		$this->_add_global_screen_options();
611
+		$this->_add_screen_options();
612
+		if (method_exists($this, '_add_screen_options_' . $this->_current_view)) {
613
+			call_user_func(array($this, '_add_screen_options_' . $this->_current_view));
614
+		}
615
+		//add help tab(s) and tours- set via page_config and qtips.
616
+		$this->_add_help_tour();
617
+		$this->_add_help_tabs();
618
+		$this->_add_qtips();
619
+		//add feature_pointers - global, page child class, and view specific
620
+		$this->_add_feature_pointers();
621
+		$this->_add_global_feature_pointers();
622
+		if (method_exists($this, '_add_feature_pointer_' . $this->_current_view)) {
623
+			call_user_func(array($this, '_add_feature_pointer_' . $this->_current_view));
624
+		}
625
+		//enqueue scripts/styles - global, page class, and view specific
626
+		add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
627
+		add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
628
+		if (method_exists($this, 'load_scripts_styles_' . $this->_current_view)) {
629
+			add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view), 15);
630
+		}
631
+		add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
632
+		//admin_print_footer_scripts - global, page child class, and view specific.  NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.  In most cases that's doing_it_wrong().  But adding hidden container elements etc. is a good use case. Notice the late priority we're giving these
633
+		add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
634
+		add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
635
+		if (method_exists($this, 'admin_footer_scripts_' . $this->_current_view)) {
636
+			add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_' . $this->_current_view), 101);
637
+		}
638
+		//admin footer scripts
639
+		add_action('admin_footer', array($this, 'admin_footer_global'), 99);
640
+		add_action('admin_footer', array($this, 'admin_footer'), 100);
641
+		if (method_exists($this, 'admin_footer_' . $this->_current_view)) {
642
+			add_action('admin_footer', array($this, 'admin_footer_' . $this->_current_view), 101);
643
+		}
644
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
645
+		//targeted hook
646
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action);
647
+	}
648
+
649
+
650
+
651
+	/**
652
+	 * _set_defaults
653
+	 * This sets some global defaults for class properties.
654
+	 */
655
+	private function _set_defaults()
656
+	{
657
+		$this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = $this->_event = $this->_template_path = $this->_column_template_path = null;
658
+		$this->_nav_tabs = $this_views = $this->_page_routes = $this->_page_config = $this->_default_route_query_args = array();
659
+		$this->default_nav_tab_name = 'overview';
660
+		//init template args
661
+		$this->_template_args = array(
662
+				'admin_page_header'  => '',
663
+				'admin_page_content' => '',
664
+				'post_body_content'  => '',
665
+				'before_list_table'  => '',
666
+				'after_list_table'   => '',
667
+		);
668
+	}
669
+
670
+
671
+
672
+	/**
673
+	 * route_admin_request
674
+	 *
675
+	 * @see    _route_admin_request()
676
+	 * @access public
677
+	 * @return void|exception error
678
+	 */
679
+	public function route_admin_request()
680
+	{
681
+		try {
682
+			$this->_route_admin_request();
683
+		} catch (EE_Error $e) {
684
+			$e->get_error();
685
+		}
686
+	}
687
+
688
+
689
+
690
+	public function set_wp_page_slug($wp_page_slug)
691
+	{
692
+		$this->_wp_page_slug = $wp_page_slug;
693
+		//if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
694
+		if (is_network_admin()) {
695
+			$this->_wp_page_slug .= '-network';
696
+		}
697
+	}
698
+
699
+
700
+
701
+	/**
702
+	 * _verify_routes
703
+	 * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so we know if we need to drop out.
704
+	 *
705
+	 * @access protected
706
+	 * @return void
707
+	 */
708
+	protected function _verify_routes()
709
+	{
710
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
711
+		if ( ! $this->_current_page && ! defined('DOING_AJAX')) {
712
+			return false;
713
+		}
714
+		$this->_route = false;
715
+		$func = false;
716
+		$args = array();
717
+		// check that the page_routes array is not empty
718
+		if (empty($this->_page_routes)) {
719
+			// user error msg
720
+			$error_msg = sprintf(__('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
721
+			// developer error msg
722
+			$error_msg .= '||' . $error_msg . __(' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso');
723
+			throw new EE_Error($error_msg);
724
+		}
725
+		// and that the requested page route exists
726
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
727
+			$this->_route = $this->_page_routes[$this->_req_action];
728
+			$this->_route_config = isset($this->_page_config[$this->_req_action]) ? $this->_page_config[$this->_req_action] : array();
729
+		} else {
730
+			// user error msg
731
+			$error_msg = sprintf(__('The requested page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
732
+			// developer error msg
733
+			$error_msg .= '||' . $error_msg . sprintf(__(' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso'), $this->_req_action);
734
+			throw new EE_Error($error_msg);
735
+		}
736
+		// and that a default route exists
737
+		if ( ! array_key_exists('default', $this->_page_routes)) {
738
+			// user error msg
739
+			$error_msg = sprintf(__('A default page route has not been set for the % admin page.', 'event_espresso'), $this->_admin_page_title);
740
+			// developer error msg
741
+			$error_msg .= '||' . $error_msg . __(' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso');
742
+			throw new EE_Error($error_msg);
743
+		}
744
+		//first lets' catch if the UI request has EVER been set.
745
+		if ($this->_is_UI_request === null) {
746
+			//lets set if this is a UI request or not.
747
+			$this->_is_UI_request = ( ! isset($this->_req_data['noheader']) || $this->_req_data['noheader'] !== true) ? true : false;
748
+			//wait a minute... we might have a noheader in the route array
749
+			$this->_is_UI_request = is_array($this->_route) && isset($this->_route['noheader']) && $this->_route['noheader'] ? false : $this->_is_UI_request;
750
+		}
751
+		$this->_set_current_labels();
752
+	}
753
+
754
+
755
+
756
+	/**
757
+	 * this method simply verifies a given route and makes sure its an actual route available for the loaded page
758
+	 *
759
+	 * @param  string $route the route name we're verifying
760
+	 * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
761
+	 */
762
+	protected function _verify_route($route)
763
+	{
764
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
765
+			return true;
766
+		} else {
767
+			// user error msg
768
+			$error_msg = sprintf(__('The given page route does not exist for the %s admin page.', 'event_espresso'), $this->_admin_page_title);
769
+			// developer error msg
770
+			$error_msg .= '||' . $error_msg . sprintf(__(' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso'), $route);
771
+			throw new EE_Error($error_msg);
772
+		}
773
+	}
774
+
775
+
776
+
777
+	/**
778
+	 * perform nonce verification
779
+	 * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces using this method (and save retyping!)
780
+	 *
781
+	 * @param  string $nonce     The nonce sent
782
+	 * @param  string $nonce_ref The nonce reference string (name0)
783
+	 * @return mixed (bool|die)
784
+	 */
785
+	protected function _verify_nonce($nonce, $nonce_ref)
786
+	{
787
+		// verify nonce against expected value
788
+		if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
789
+			// these are not the droids you are looking for !!!
790
+			$msg = sprintf(__('%sNonce Fail.%s', 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>');
791
+			if (WP_DEBUG) {
792
+				$msg .= "\n  " . sprintf(__('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso'), __CLASS__);
793
+			}
794
+			if ( ! defined('DOING_AJAX')) {
795
+				wp_die($msg);
796
+			} else {
797
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
798
+				$this->_return_json();
799
+			}
800
+		}
801
+	}
802
+
803
+
804
+
805
+	/**
806
+	 * _route_admin_request()
807
+	 * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
808
+	 * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
809
+	 * in the page routes and then will try to load the corresponding method.
810
+	 *
811
+	 * @access protected
812
+	 * @return void
813
+	 * @throws \EE_Error
814
+	 */
815
+	protected function _route_admin_request()
816
+	{
817
+		if ( ! $this->_is_UI_request) {
818
+			$this->_verify_routes();
819
+		}
820
+		$nonce_check = isset($this->_route_config['require_nonce'])
821
+			? $this->_route_config['require_nonce']
822
+			: true;
823
+		if ($this->_req_action !== 'default' && $nonce_check) {
824
+			// set nonce from post data
825
+			$nonce = isset($this->_req_data[$this->_req_nonce])
826
+				? sanitize_text_field($this->_req_data[$this->_req_nonce])
827
+				: '';
828
+			$this->_verify_nonce($nonce, $this->_req_nonce);
829
+		}
830
+		//set the nav_tabs array but ONLY if this is  UI_request
831
+		if ($this->_is_UI_request) {
832
+			$this->_set_nav_tabs();
833
+		}
834
+		// grab callback function
835
+		$func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
836
+		// check if callback has args
837
+		$args = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : array();
838
+		$error_msg = '';
839
+		// action right before calling route
840
+		// (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
841
+		if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
842
+			do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
843
+		}
844
+		// right before calling the route, let's remove _wp_http_referer from the
845
+		// $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
846
+		$_SERVER['REQUEST_URI'] = remove_query_arg('_wp_http_referer', wp_unslash($_SERVER['REQUEST_URI']));
847
+		if ( ! empty($func)) {
848
+			if (is_array($func)) {
849
+				list($class, $method) = $func;
850
+			} else if (strpos($func, '::') !== false) {
851
+				list($class, $method) = explode('::', $func);
852
+			} else {
853
+				$class = $this;
854
+				$method = $func;
855
+			}
856
+			if ( ! (is_object($class) && $class === $this)) {
857
+				// send along this admin page object for access by addons.
858
+				$args['admin_page_object'] = $this;
859
+			}
860
+
861
+			if (
862
+				//is it a method on a class that doesn't work?
863
+				(
864
+					(
865
+						method_exists($class, $method)
866
+						&& call_user_func_array(array($class, $method), $args) === false
867
+					)
868
+					&& (
869
+						//is it a standalone function that doesn't work?
870
+						function_exists($method)
871
+						&& call_user_func_array($func, array_merge(array('admin_page_object' => $this), $args)) === false
872
+					)
873
+				)
874
+				|| (
875
+					//is it neither a class method NOR a standalone function?
876
+					! method_exists($class, $method)
877
+					&& ! function_exists($method)
878
+				)
879
+			) {
880
+				// user error msg
881
+				$error_msg = __('An error occurred. The  requested page route could not be found.', 'event_espresso');
882
+				// developer error msg
883
+				$error_msg .= '||';
884
+				$error_msg .= sprintf(
885
+					__(
886
+						'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
887
+						'event_espresso'
888
+					),
889
+					$method
890
+				);
891
+			}
892
+			if ( ! empty($error_msg)) {
893
+				throw new EE_Error($error_msg);
894
+			}
895
+		}
896
+		//if we've routed and this route has a no headers route AND a sent_headers_route, then we need to reset the routing properties to the new route.
897
+		//now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
898
+		if ($this->_is_UI_request === false
899
+			&& is_array($this->_route)
900
+			&& ! empty($this->_route['headers_sent_route'])
901
+		) {
902
+			$this->_reset_routing_properties($this->_route['headers_sent_route']);
903
+		}
904
+	}
905
+
906
+
907
+
908
+	/**
909
+	 * This method just allows the resetting of page properties in the case where a no headers
910
+	 * route redirects to a headers route in its route config.
911
+	 *
912
+	 * @since   4.3.0
913
+	 * @param  string $new_route New (non header) route to redirect to.
914
+	 * @return   void
915
+	 */
916
+	protected function _reset_routing_properties($new_route)
917
+	{
918
+		$this->_is_UI_request = true;
919
+		//now we set the current route to whatever the headers_sent_route is set at
920
+		$this->_req_data['action'] = $new_route;
921
+		//rerun page setup
922
+		$this->_page_setup();
923
+	}
924
+
925
+
926
+
927
+	/**
928
+	 * _add_query_arg
929
+	 * adds nonce to array of arguments then calls WP add_query_arg function
930
+	 *(internally just uses EEH_URL's function with the same name)
931
+	 *
932
+	 * @access public
933
+	 * @param array  $args
934
+	 * @param string $url
935
+	 * @param bool   $sticky                  if true, then the existing Request params will be appended to the generated
936
+	 *                                        url in an associative array indexed by the key 'wp_referer';
937
+	 *                                        Example usage:
938
+	 *                                        If the current page is:
939
+	 *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
940
+	 *                                        &action=default&event_id=20&month_range=March%202015
941
+	 *                                        &_wpnonce=5467821
942
+	 *                                        and you call:
943
+	 *                                        EE_Admin_Page::add_query_args_and_nonce(
944
+	 *                                        array(
945
+	 *                                        'action' => 'resend_something',
946
+	 *                                        'page=>espresso_registrations'
947
+	 *                                        ),
948
+	 *                                        $some_url,
949
+	 *                                        true
950
+	 *                                        );
951
+	 *                                        It will produce a url in this structure:
952
+	 *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
953
+	 *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
954
+	 *                                        month_range]=March%202015
955
+	 * @param   bool $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
956
+	 * @return string
957
+	 */
958
+	public static function add_query_args_and_nonce($args = array(), $url = false, $sticky = false, $exclude_nonce = false)
959
+	{
960
+		//if there is a _wp_http_referer include the values from the request but only if sticky = true
961
+		if ($sticky) {
962
+			$request = $_REQUEST;
963
+			unset($request['_wp_http_referer']);
964
+			unset($request['wp_referer']);
965
+			foreach ($request as $key => $value) {
966
+				//do not add nonces
967
+				if (strpos($key, 'nonce') !== false) {
968
+					continue;
969
+				}
970
+				$args['wp_referer[' . $key . ']'] = $value;
971
+			}
972
+		}
973
+		return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
974
+	}
975
+
976
+
977
+
978
+	/**
979
+	 * This returns a generated link that will load the related help tab.
980
+	 *
981
+	 * @param  string $help_tab_id the id for the connected help tab
982
+	 * @param  string $icon_style  (optional) include css class for the style you want to use for the help icon.
983
+	 * @param  string $help_text   (optional) send help text you want to use for the link if default not to be used
984
+	 * @uses EEH_Template::get_help_tab_link()
985
+	 * @return string              generated link
986
+	 */
987
+	protected function _get_help_tab_link($help_tab_id, $icon_style = false, $help_text = false)
988
+	{
989
+		return EEH_Template::get_help_tab_link($help_tab_id, $this->page_slug, $this->_req_action, $icon_style, $help_text);
990
+	}
991
+
992
+
993
+
994
+	/**
995
+	 * _add_help_tabs
996
+	 * Note child classes define their help tabs within the page_config array.
997
+	 *
998
+	 * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
999
+	 * @access protected
1000
+	 * @return void
1001
+	 */
1002
+	protected function _add_help_tabs()
1003
+	{
1004
+		$tour_buttons = '';
1005
+		if (isset($this->_page_config[$this->_req_action])) {
1006
+			$config = $this->_page_config[$this->_req_action];
1007
+			//is there a help tour for the current route?  if there is let's setup the tour buttons
1008
+			if (isset($this->_help_tour[$this->_req_action])) {
1009
+				$tb = array();
1010
+				$tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
1011
+				foreach ($this->_help_tour['tours'] as $tour) {
1012
+					//if this is the end tour then we don't need to setup a button
1013
+					if ($tour instanceof EE_Help_Tour_final_stop) {
1014
+						continue;
1015
+					}
1016
+					$tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
1017
+				}
1018
+				$tour_buttons .= implode('<br />', $tb);
1019
+				$tour_buttons .= '</div></div>';
1020
+			}
1021
+			// let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
1022
+			if (is_array($config) && isset($config['help_sidebar'])) {
1023
+				//check that the callback given is valid
1024
+				if ( ! method_exists($this, $config['help_sidebar'])) {
1025
+					throw new EE_Error(sprintf(__('The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
1026
+							'event_espresso'), $config['help_sidebar'], get_class($this)));
1027
+				}
1028
+				$content = apply_filters('FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func(array($this, $config['help_sidebar'])));
1029
+				$content .= $tour_buttons; //add help tour buttons.
1030
+				//do we have any help tours setup?  Cause if we do we want to add the buttons
1031
+				$this->_current_screen->set_help_sidebar($content);
1032
+			}
1033
+			//if we DON'T have config help sidebar and there ARE toure buttons then we'll just add the tour buttons to the sidebar.
1034
+			if ( ! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
1035
+				$this->_current_screen->set_help_sidebar($tour_buttons);
1036
+			}
1037
+			//handle if no help_tabs are set so the sidebar will still show for the help tour buttons
1038
+			if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
1039
+				$_ht['id'] = $this->page_slug;
1040
+				$_ht['title'] = __('Help Tours', 'event_espresso');
1041
+				$_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
1042
+				$this->_current_screen->add_help_tab($_ht);
1043
+			}/**/
1044
+			if ( ! isset($config['help_tabs'])) {
1045
+				return;
1046
+			} //no help tabs for this route
1047
+			foreach ((array)$config['help_tabs'] as $tab_id => $cfg) {
1048
+				//we're here so there ARE help tabs!
1049
+				//make sure we've got what we need
1050
+				if ( ! isset($cfg['title'])) {
1051
+					throw new EE_Error(__('The _page_config array is not set up properly for help tabs.  It is missing a title', 'event_espresso'));
1052
+				}
1053
+				if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
1054
+					throw new EE_Error(__('The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
1055
+							'event_espresso'));
1056
+				}
1057
+				//first priority goes to content.
1058
+				if ( ! empty($cfg['content'])) {
1059
+					$content = ! empty($cfg['content']) ? $cfg['content'] : null;
1060
+					//second priority goes to filename
1061
+				} else if ( ! empty($cfg['filename'])) {
1062
+					$file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
1063
+					//it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
1064
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;
1065
+					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1066
+					if ( ! is_readable($file_path) && ! isset($cfg['callback'])) {
1067
+						EE_Error::add_error(sprintf(__('The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
1068
+								'event_espresso'), $tab_id, key($config), $file_path), __FILE__, __FUNCTION__, __LINE__);
1069
+						return;
1070
+					}
1071
+					$template_args['admin_page_obj'] = $this;
1072
+					$content = EEH_Template::display_template($file_path, $template_args, true);
1073
+				} else {
1074
+					$content = '';
1075
+				}
1076
+				//check if callback is valid
1077
+				if (empty($content) && ( ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback']))) {
1078
+					EE_Error::add_error(sprintf(__('The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
1079
+							'event_espresso'), $cfg['title']), __FILE__, __FUNCTION__, __LINE__);
1080
+					return;
1081
+				}
1082
+				//setup config array for help tab method
1083
+				$id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
1084
+				$_ht = array(
1085
+						'id'       => $id,
1086
+						'title'    => $cfg['title'],
1087
+						'callback' => isset($cfg['callback']) && empty($content) ? array($this, $cfg['callback']) : null,
1088
+						'content'  => $content,
1089
+				);
1090
+				$this->_current_screen->add_help_tab($_ht);
1091
+			}
1092
+		}
1093
+	}
1094
+
1095
+
1096
+
1097
+	/**
1098
+	 * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is an array with properties for setting up usage of the joyride plugin
1099
+	 *
1100
+	 * @link   http://zurb.com/playground/jquery-joyride-feature-tour-plugin
1101
+	 * @see    instructions regarding the format and construction of the "help_tour" array element is found in the _set_page_config() comments
1102
+	 * @access protected
1103
+	 * @return void
1104
+	 */
1105
+	protected function _add_help_tour()
1106
+	{
1107
+		$tours = array();
1108
+		$this->_help_tour = array();
1109
+		//exit early if help tours are turned off globally
1110
+		if ( ! EE_Registry::instance()->CFG->admin->help_tour_activation || (defined('EE_DISABLE_HELP_TOURS') && EE_DISABLE_HELP_TOURS)) {
1111
+			return;
1112
+		}
1113
+		//loop through _page_config to find any help_tour defined
1114
+		foreach ($this->_page_config as $route => $config) {
1115
+			//we're only going to set things up for this route
1116
+			if ($route !== $this->_req_action) {
1117
+				continue;
1118
+			}
1119
+			if (isset($config['help_tour'])) {
1120
+				foreach ($config['help_tour'] as $tour) {
1121
+					$file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
1122
+					//let's see if we can get that file... if not its possible this is a decaf route not set in caffienated so lets try and get the caffeinated equivalent
1123
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;
1124
+					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1125
+					if ( ! is_readable($file_path)) {
1126
+						EE_Error::add_error(sprintf(__('The file path given for the help tour (%s) is not a valid path.  Please check that the string you set for the help tour on this route (%s) is the correct spelling', 'event_espresso'),
1127
+								$file_path, $tour), __FILE__, __FUNCTION__, __LINE__);
1128
+						return;
1129
+					}
1130
+					require_once $file_path;
1131
+					if ( ! class_exists($tour)) {
1132
+						$error_msg[] = sprintf(__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'), $tour);
1133
+						$error_msg[] = $error_msg[0] . "\r\n" . sprintf(__('There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.',
1134
+										'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this));
1135
+						throw new EE_Error(implode('||', $error_msg));
1136
+					}
1137
+					$a = new ReflectionClass($tour);
1138
+					$tour_obj = $a->newInstance($this->_is_caf);
1139
+					$tours[] = $tour_obj;
1140
+					$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($tour_obj);
1141
+				}
1142
+				//let's inject the end tour stop element common to all pages... this will only get seen once per machine.
1143
+				$end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
1144
+				$tours[] = $end_stop_tour;
1145
+				$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
1146
+			}
1147
+		}
1148
+		if ( ! empty($tours)) {
1149
+			$this->_help_tour['tours'] = $tours;
1150
+		}
1151
+		//thats it!  Now that the $_help_tours property is set (or not) the scripts and html should be taken care of automatically.
1152
+	}
1153
+
1154
+
1155
+
1156
+	/**
1157
+	 * This simply sets up any qtips that have been defined in the page config
1158
+	 *
1159
+	 * @access protected
1160
+	 * @return void
1161
+	 */
1162
+	protected function _add_qtips()
1163
+	{
1164
+		if (isset($this->_route_config['qtips'])) {
1165
+			$qtips = (array)$this->_route_config['qtips'];
1166
+			//load qtip loader
1167
+			$path = array(
1168
+					$this->_get_dir() . '/qtips/',
1169
+					EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
1170
+			);
1171
+			EEH_Qtip_Loader::instance()->register($qtips, $path);
1172
+		}
1173
+	}
1174
+
1175
+
1176
+
1177
+	/**
1178
+	 * _set_nav_tabs
1179
+	 * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you wish to add additional tabs or modify accordingly.
1180
+	 *
1181
+	 * @access protected
1182
+	 * @return void
1183
+	 */
1184
+	protected function _set_nav_tabs()
1185
+	{
1186
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1187
+		$i = 0;
1188
+		foreach ($this->_page_config as $slug => $config) {
1189
+			if ( ! is_array($config) || (is_array($config) && (isset($config['nav']) && ! $config['nav']) || ! isset($config['nav']))) {
1190
+				continue;
1191
+			} //no nav tab for this config
1192
+			//check for persistent flag
1193
+			if (isset($config['nav']['persistent']) && ! $config['nav']['persistent'] && $slug !== $this->_req_action) {
1194
+				continue;
1195
+			} //nav tab is only to appear when route requested.
1196
+			if ( ! $this->check_user_access($slug, true)) {
1197
+				continue;
1198
+			} //no nav tab becasue current user does not have access.
1199
+			$css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
1200
+			$this->_nav_tabs[$slug] = array(
1201
+					'url'       => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce(array('action' => $slug), $this->_admin_base_url),
1202
+					'link_text' => isset($config['nav']['label']) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug)),
1203
+					'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
1204
+					'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
1205
+			);
1206
+			$i++;
1207
+		}
1208
+		//if $this->_nav_tabs is empty then lets set the default
1209
+		if (empty($this->_nav_tabs)) {
1210
+			$this->_nav_tabs[$this->default_nav_tab_name] = array(
1211
+					'url'       => $this->admin_base_url,
1212
+					'link_text' => ucwords(str_replace('_', ' ', $this->default_nav_tab_name)),
1213
+					'css_class' => 'nav-tab-active',
1214
+					'order'     => 10,
1215
+			);
1216
+		}
1217
+		//now let's sort the tabs according to order
1218
+		usort($this->_nav_tabs, array($this, '_sort_nav_tabs'));
1219
+	}
1220
+
1221
+
1222
+
1223
+	/**
1224
+	 * _set_current_labels
1225
+	 * This method modifies the _labels property with any optional specific labels indicated in the _page_routes property array
1226
+	 *
1227
+	 * @access private
1228
+	 * @return void
1229
+	 */
1230
+	private function _set_current_labels()
1231
+	{
1232
+		if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
1233
+			foreach ($this->_route_config['labels'] as $label => $text) {
1234
+				if (is_array($text)) {
1235
+					foreach ($text as $sublabel => $subtext) {
1236
+						$this->_labels[$label][$sublabel] = $subtext;
1237
+					}
1238
+				} else {
1239
+					$this->_labels[$label] = $text;
1240
+				}
1241
+			}
1242
+		}
1243
+	}
1244
+
1245
+
1246
+
1247
+	/**
1248
+	 *        verifies user access for this admin page
1249
+	 *
1250
+	 * @param string $route_to_check if present then the capability for the route matching this string is checked.
1251
+	 * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just return false if verify fail.
1252
+	 * @return        BOOL|wp_die()
1253
+	 */
1254
+	public function check_user_access($route_to_check = '', $verify_only = false)
1255
+	{
1256
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1257
+		$route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
1258
+		$capability = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check]) && is_array($this->_page_routes[$route_to_check]) && ! empty($this->_page_routes[$route_to_check]['capability'])
1259
+				? $this->_page_routes[$route_to_check]['capability'] : null;
1260
+		if (empty($capability) && empty($route_to_check)) {
1261
+			$capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options' : $this->_route['capability'];
1262
+		} else {
1263
+			$capability = empty($capability) ? 'manage_options' : $capability;
1264
+		}
1265
+		$id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
1266
+		if (( ! function_exists('is_admin') || ! EE_Registry::instance()->CAP->current_user_can($capability, $this->page_slug . '_' . $route_to_check, $id)) && ! defined('DOING_AJAX')) {
1267
+			if ($verify_only) {
1268
+				return false;
1269
+			} else {
1270
+				if ( is_user_logged_in() ) {
1271
+					wp_die(__('You do not have access to this route.', 'event_espresso'));
1272
+				} else {
1273
+					return false;
1274
+				}
1275
+			}
1276
+		}
1277
+		return true;
1278
+	}
1279
+
1280
+
1281
+
1282
+	/**
1283
+	 * admin_init_global
1284
+	 * This runs all the code that we want executed within the WP admin_init hook.
1285
+	 * This method executes for ALL EE Admin pages.
1286
+	 *
1287
+	 * @access public
1288
+	 * @return void
1289
+	 */
1290
+	public function admin_init_global()
1291
+	{
1292
+	}
1293
+
1294
+
1295
+
1296
+	/**
1297
+	 * wp_loaded_global
1298
+	 * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an EE_Admin page and will execute on every EE Admin Page load
1299
+	 *
1300
+	 * @access public
1301
+	 * @return void
1302
+	 */
1303
+	public function wp_loaded()
1304
+	{
1305
+	}
1306
+
1307
+
1308
+
1309
+	/**
1310
+	 * admin_notices
1311
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on ALL EE_Admin pages.
1312
+	 *
1313
+	 * @access public
1314
+	 * @return void
1315
+	 */
1316
+	public function admin_notices_global()
1317
+	{
1318
+		$this->_display_no_javascript_warning();
1319
+		$this->_display_espresso_notices();
1320
+	}
1321
+
1322
+
1323
+
1324
+	public function network_admin_notices_global()
1325
+	{
1326
+		$this->_display_no_javascript_warning();
1327
+		$this->_display_espresso_notices();
1328
+	}
1329
+
1330
+
1331
+
1332
+	/**
1333
+	 * admin_footer_scripts_global
1334
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply on ALL EE_Admin pages.
1335
+	 *
1336
+	 * @access public
1337
+	 * @return void
1338
+	 */
1339
+	public function admin_footer_scripts_global()
1340
+	{
1341
+		$this->_add_admin_page_ajax_loading_img();
1342
+		$this->_add_admin_page_overlay();
1343
+		//if metaboxes are present we need to add the nonce field
1344
+		if ((isset($this->_route_config['metaboxes']) || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes']) || isset($this->_route_config['list_table']))) {
1345
+			wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
1346
+			wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
1347
+		}
1348
+	}
1349
+
1350
+
1351
+
1352
+	/**
1353
+	 * admin_footer_global
1354
+	 * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particluar method will apply on ALL EE_Admin Pages.
1355
+	 *
1356
+	 * @access  public
1357
+	 * @return  void
1358
+	 */
1359
+	public function admin_footer_global()
1360
+	{
1361
+		//dialog container for dialog helper
1362
+		$d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
1363
+		$d_cont .= '<div class="ee-notices"></div>';
1364
+		$d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
1365
+		$d_cont .= '</div>';
1366
+		echo $d_cont;
1367
+		//help tour stuff?
1368
+		if (isset($this->_help_tour[$this->_req_action])) {
1369
+			echo implode('<br />', $this->_help_tour[$this->_req_action]);
1370
+		}
1371
+		//current set timezone for timezone js
1372
+		echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
1373
+	}
1374
+
1375
+
1376
+
1377
+	/**
1378
+	 * This function sees if there is a method for help popup content existing for the given route.  If there is then we'll use the retrieved array to output the content using the template.
1379
+	 * For child classes:
1380
+	 * If you want to have help popups then in your templates or your content you set "triggers" for the content using the "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method for
1381
+	 * the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content for the
1382
+	 * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined "help_popup_content_..." method.  You must prepare and return an array in the following format array(
1383
+	 *    'help_trigger_id' => array(
1384
+	 *        'title' => __('localized title for popup', 'event_espresso'),
1385
+	 *        'content' => __('localized content for popup', 'event_espresso')
1386
+	 *    )
1387
+	 * );
1388
+	 * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
1389
+	 *
1390
+	 * @access protected
1391
+	 * @return string content
1392
+	 */
1393
+	protected function _set_help_popup_content($help_array = array(), $display = false)
1394
+	{
1395
+		$content = '';
1396
+		$help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
1397
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';
1398
+		//loop through the array and setup content
1399
+		foreach ($help_array as $trigger => $help) {
1400
+			//make sure the array is setup properly
1401
+			if ( ! isset($help['title']) || ! isset($help['content'])) {
1402
+				throw new EE_Error(__('Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
1403
+						'event_espresso'));
1404
+			}
1405
+			//we're good so let'd setup the template vars and then assign parsed template content to our content.
1406
+			$template_args = array(
1407
+					'help_popup_id'      => $trigger,
1408
+					'help_popup_title'   => $help['title'],
1409
+					'help_popup_content' => $help['content'],
1410
+			);
1411
+			$content .= EEH_Template::display_template($template_path, $template_args, true);
1412
+		}
1413
+		if ($display) {
1414
+			echo $content;
1415
+		} else {
1416
+			return $content;
1417
+		}
1418
+	}
1419
+
1420
+
1421
+
1422
+	/**
1423
+	 * All this does is retrive the help content array if set by the EE_Admin_Page child
1424
+	 *
1425
+	 * @access private
1426
+	 * @return array properly formatted array for help popup content
1427
+	 */
1428
+	private function _get_help_content()
1429
+	{
1430
+		//what is the method we're looking for?
1431
+		$method_name = '_help_popup_content_' . $this->_req_action;
1432
+		//if method doesn't exist let's get out.
1433
+		if ( ! method_exists($this, $method_name)) {
1434
+			return array();
1435
+		}
1436
+		//k we're good to go let's retrieve the help array
1437
+		$help_array = call_user_func(array($this, $method_name));
1438
+		//make sure we've got an array!
1439
+		if ( ! is_array($help_array)) {
1440
+			throw new EE_Error(__('Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.', 'event_espresso'));
1441
+		}
1442
+		return $help_array;
1443
+	}
1444
+
1445
+
1446
+
1447
+	/**
1448
+	 * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
1449
+	 * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
1450
+	 * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
1451
+	 *
1452
+	 * @access protected
1453
+	 * @param string  $trigger_id reference for retrieving the trigger content for the popup
1454
+	 * @param boolean $display    if false then we return the trigger string
1455
+	 * @param array   $dimensions an array of dimensions for the box (array(h,w))
1456
+	 * @return string
1457
+	 */
1458
+	protected function _set_help_trigger($trigger_id, $display = true, $dimensions = array('400', '640'))
1459
+	{
1460
+		if (defined('DOING_AJAX')) {
1461
+			return;
1462
+		}
1463
+		//let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
1464
+		$help_array = $this->_get_help_content();
1465
+		$help_content = '';
1466
+		if (empty($help_array) || ! isset($help_array[$trigger_id])) {
1467
+			$help_array[$trigger_id] = array(
1468
+					'title'   => __('Missing Content', 'event_espresso'),
1469
+					'content' => __('A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
1470
+							'event_espresso'),
1471
+			);
1472
+			$help_content = $this->_set_help_popup_content($help_array, false);
1473
+		}
1474
+		//let's setup the trigger
1475
+		$content = '<a class="ee-dialog" href="?height=' . $dimensions[0] . '&width=' . $dimensions[1] . '&inlineId=' . $trigger_id . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
1476
+		$content = $content . $help_content;
1477
+		if ($display) {
1478
+			echo $content;
1479
+		} else {
1480
+			return $content;
1481
+		}
1482
+	}
1483
+
1484
+
1485
+
1486
+	/**
1487
+	 * _add_global_screen_options
1488
+	 * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
1489
+	 * This particular method will add_screen_options on ALL EE_Admin Pages
1490
+	 *
1491
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
1492
+	 *         see also WP_Screen object documents...
1493
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
1494
+	 * @abstract
1495
+	 * @access private
1496
+	 * @return void
1497
+	 */
1498
+	private function _add_global_screen_options()
1499
+	{
1500
+	}
1501
+
1502
+
1503
+
1504
+	/**
1505
+	 * _add_global_feature_pointers
1506
+	 * This method is used for implementing any "feature pointers" (using built-in WP styling js).
1507
+	 * This particular method will implement feature pointers for ALL EE_Admin pages.
1508
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
1509
+	 *
1510
+	 * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
1511
+	 * @link   http://eamann.com/tech/wordpress-portland/
1512
+	 * @abstract
1513
+	 * @access protected
1514
+	 * @return void
1515
+	 */
1516
+	private function _add_global_feature_pointers()
1517
+	{
1518
+	}
1519
+
1520
+
1521
+
1522
+	/**
1523
+	 * load_global_scripts_styles
1524
+	 * The scripts and styles enqueued in here will be loaded on every EE Admin page
1525
+	 *
1526
+	 * @return void
1527
+	 */
1528
+	public function load_global_scripts_styles()
1529
+	{
1530
+		/** STYLES **/
1531
+		// add debugging styles
1532
+		if (WP_DEBUG) {
1533
+			add_action('admin_head', array($this, 'add_xdebug_style'));
1534
+		}
1535
+		// register all styles
1536
+		wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
1537
+		wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
1538
+		//helpers styles
1539
+		wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION);
1540
+		/** SCRIPTS **/
1541
+		//register all scripts
1542
+		wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
1543
+		wp_register_script('ee_admin_js', EE_ADMIN_URL . 'assets/ee-admin-page.js', array('espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true);
1544
+		wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true);
1545
+		add_filter('FHEE_load_joyride', '__return_true');
1546
+		//script for sorting tables
1547
+		wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL . "assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, true);
1548
+		//script for parsing uri's
1549
+		wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
1550
+		//and parsing associative serialized form elements
1551
+		wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
1552
+		//helpers scripts
1553
+		wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
1554
+		wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
1555
+		wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
1556
+		wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
1557
+		//google charts
1558
+		wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
1559
+		// ENQUEUE ALL BASICS BY DEFAULT
1560
+		wp_enqueue_style('ee-admin-css');
1561
+		wp_enqueue_script('ee_admin_js');
1562
+		wp_enqueue_script('ee-accounting');
1563
+		wp_enqueue_script('jquery-validate');
1564
+		//taking care of metaboxes
1565
+		if (
1566
+			empty($this->_cpt_route)
1567
+			&& (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
1568
+		) {
1569
+			wp_enqueue_script('dashboard');
1570
+		}
1571
+		// LOCALIZED DATA
1572
+		//localize script for ajax lazy loading
1573
+		$lazy_loader_container_ids = apply_filters('FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content'));
1574
+		wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
1575
+		/**
1576
+		 * help tour stuff
1577
+		 */
1578
+		if ( ! empty($this->_help_tour)) {
1579
+			//register the js for kicking things off
1580
+			wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
1581
+			//setup tours for the js tour object
1582
+			foreach ($this->_help_tour['tours'] as $tour) {
1583
+				$tours[] = array(
1584
+						'id'      => $tour->get_slug(),
1585
+						'options' => $tour->get_options(),
1586
+				);
1587
+			}
1588
+			wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
1589
+			//admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
1590
+		}
1591
+	}
1592
+
1593
+
1594
+
1595
+	/**
1596
+	 *        admin_footer_scripts_eei18n_js_strings
1597
+	 *
1598
+	 * @access        public
1599
+	 * @return        void
1600
+	 */
1601
+	public function admin_footer_scripts_eei18n_js_strings()
1602
+	{
1603
+		EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
1604
+		EE_Registry::$i18n_js_strings['confirm_delete'] = __('Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!', 'event_espresso');
1605
+		EE_Registry::$i18n_js_strings['January'] = __('January', 'event_espresso');
1606
+		EE_Registry::$i18n_js_strings['February'] = __('February', 'event_espresso');
1607
+		EE_Registry::$i18n_js_strings['March'] = __('March', 'event_espresso');
1608
+		EE_Registry::$i18n_js_strings['April'] = __('April', 'event_espresso');
1609
+		EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
1610
+		EE_Registry::$i18n_js_strings['June'] = __('June', 'event_espresso');
1611
+		EE_Registry::$i18n_js_strings['July'] = __('July', 'event_espresso');
1612
+		EE_Registry::$i18n_js_strings['August'] = __('August', 'event_espresso');
1613
+		EE_Registry::$i18n_js_strings['September'] = __('September', 'event_espresso');
1614
+		EE_Registry::$i18n_js_strings['October'] = __('October', 'event_espresso');
1615
+		EE_Registry::$i18n_js_strings['November'] = __('November', 'event_espresso');
1616
+		EE_Registry::$i18n_js_strings['December'] = __('December', 'event_espresso');
1617
+		EE_Registry::$i18n_js_strings['Jan'] = __('Jan', 'event_espresso');
1618
+		EE_Registry::$i18n_js_strings['Feb'] = __('Feb', 'event_espresso');
1619
+		EE_Registry::$i18n_js_strings['Mar'] = __('Mar', 'event_espresso');
1620
+		EE_Registry::$i18n_js_strings['Apr'] = __('Apr', 'event_espresso');
1621
+		EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
1622
+		EE_Registry::$i18n_js_strings['Jun'] = __('Jun', 'event_espresso');
1623
+		EE_Registry::$i18n_js_strings['Jul'] = __('Jul', 'event_espresso');
1624
+		EE_Registry::$i18n_js_strings['Aug'] = __('Aug', 'event_espresso');
1625
+		EE_Registry::$i18n_js_strings['Sep'] = __('Sep', 'event_espresso');
1626
+		EE_Registry::$i18n_js_strings['Oct'] = __('Oct', 'event_espresso');
1627
+		EE_Registry::$i18n_js_strings['Nov'] = __('Nov', 'event_espresso');
1628
+		EE_Registry::$i18n_js_strings['Dec'] = __('Dec', 'event_espresso');
1629
+		EE_Registry::$i18n_js_strings['Sunday'] = __('Sunday', 'event_espresso');
1630
+		EE_Registry::$i18n_js_strings['Monday'] = __('Monday', 'event_espresso');
1631
+		EE_Registry::$i18n_js_strings['Tuesday'] = __('Tuesday', 'event_espresso');
1632
+		EE_Registry::$i18n_js_strings['Wednesday'] = __('Wednesday', 'event_espresso');
1633
+		EE_Registry::$i18n_js_strings['Thursday'] = __('Thursday', 'event_espresso');
1634
+		EE_Registry::$i18n_js_strings['Friday'] = __('Friday', 'event_espresso');
1635
+		EE_Registry::$i18n_js_strings['Saturday'] = __('Saturday', 'event_espresso');
1636
+		EE_Registry::$i18n_js_strings['Sun'] = __('Sun', 'event_espresso');
1637
+		EE_Registry::$i18n_js_strings['Mon'] = __('Mon', 'event_espresso');
1638
+		EE_Registry::$i18n_js_strings['Tue'] = __('Tue', 'event_espresso');
1639
+		EE_Registry::$i18n_js_strings['Wed'] = __('Wed', 'event_espresso');
1640
+		EE_Registry::$i18n_js_strings['Thu'] = __('Thu', 'event_espresso');
1641
+		EE_Registry::$i18n_js_strings['Fri'] = __('Fri', 'event_espresso');
1642
+		EE_Registry::$i18n_js_strings['Sat'] = __('Sat', 'event_espresso');
1643
+	}
1644
+
1645
+
1646
+
1647
+	/**
1648
+	 *        load enhanced xdebug styles for ppl with failing eyesight
1649
+	 *
1650
+	 * @access        public
1651
+	 * @return        void
1652
+	 */
1653
+	public function add_xdebug_style()
1654
+	{
1655
+		echo '<style>.xdebug-error { font-size:1.5em; }</style>';
1656
+	}
1657
+
1658
+
1659
+	/************************/
1660
+	/** LIST TABLE METHODS **/
1661
+	/************************/
1662
+	/**
1663
+	 * this sets up the list table if the current view requires it.
1664
+	 *
1665
+	 * @access protected
1666
+	 * @return void
1667
+	 */
1668
+	protected function _set_list_table()
1669
+	{
1670
+		//first is this a list_table view?
1671
+		if ( ! isset($this->_route_config['list_table'])) {
1672
+			return;
1673
+		} //not a list_table view so get out.
1674
+		//list table functions are per view specific (because some admin pages might have more than one listtable!)
1675
+		if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
1676
+			//user error msg
1677
+			$error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
1678
+			//developer error msg
1679
+			$error_msg .= '||' . sprintf(__('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso'),
1680
+							$this->_req_action, '_set_list_table_views_' . $this->_req_action);
1681
+			throw new EE_Error($error_msg);
1682
+		}
1683
+		//let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
1684
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
1685
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
1686
+		$this->_views = apply_filters('FHEE_list_table_views', $this->_views);
1687
+		$this->_set_list_table_view();
1688
+		$this->_set_list_table_object();
1689
+	}
1690
+
1691
+
1692
+
1693
+	/**
1694
+	 *        set current view for List Table
1695
+	 *
1696
+	 * @access public
1697
+	 * @return array
1698
+	 */
1699
+	protected function _set_list_table_view()
1700
+	{
1701
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1702
+		// looking at active items or dumpster diving ?
1703
+		if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
1704
+			$this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
1705
+		} else {
1706
+			$this->_view = sanitize_key($this->_req_data['status']);
1707
+		}
1708
+	}
1709
+
1710
+
1711
+
1712
+	/**
1713
+	 * _set_list_table_object
1714
+	 * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
1715
+	 *
1716
+	 * @throws \EE_Error
1717
+	 */
1718
+	protected function _set_list_table_object()
1719
+	{
1720
+		if (isset($this->_route_config['list_table'])) {
1721
+			if ( ! class_exists($this->_route_config['list_table'])) {
1722
+				throw new EE_Error(
1723
+						sprintf(
1724
+								__(
1725
+										'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
1726
+										'event_espresso'
1727
+								),
1728
+								$this->_route_config['list_table'],
1729
+								get_class($this)
1730
+						)
1731
+				);
1732
+			}
1733
+			$list_table = $this->_route_config['list_table'];
1734
+			$this->_list_table_object = new $list_table($this);
1735
+		}
1736
+	}
1737
+
1738
+
1739
+
1740
+	/**
1741
+	 * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
1742
+	 *
1743
+	 * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
1744
+	 *                                                    urls.  The array should be indexed by the view it is being
1745
+	 *                                                    added to.
1746
+	 * @return array
1747
+	 */
1748
+	public function get_list_table_view_RLs($extra_query_args = array())
1749
+	{
1750
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1751
+		if (empty($this->_views)) {
1752
+			$this->_views = array();
1753
+		}
1754
+		// cycle thru views
1755
+		foreach ($this->_views as $key => $view) {
1756
+			$query_args = array();
1757
+			// check for current view
1758
+			$this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
1759
+			$query_args['action'] = $this->_req_action;
1760
+			$query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
1761
+			$query_args['status'] = $view['slug'];
1762
+			//merge any other arguments sent in.
1763
+			if (isset($extra_query_args[$view['slug']])) {
1764
+				$query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
1765
+			}
1766
+			$this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
1767
+		}
1768
+		return $this->_views;
1769
+	}
1770
+
1771
+
1772
+
1773
+	/**
1774
+	 * _entries_per_page_dropdown
1775
+	 * generates a drop down box for selecting the number of visiable rows in an admin page list table
1776
+	 *
1777
+	 * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
1778
+	 * @access protected
1779
+	 * @param int $max_entries total number of rows in the table
1780
+	 * @return string
1781
+	 */
1782
+	protected function _entries_per_page_dropdown($max_entries = false)
1783
+	{
1784
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1785
+		$values = array(10, 25, 50, 100);
1786
+		$per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
1787
+		if ($max_entries) {
1788
+			$values[] = $max_entries;
1789
+			sort($values);
1790
+		}
1791
+		$entries_per_page_dropdown = '
1792 1792
 			<div id="entries-per-page-dv" class="alignleft actions">
1793 1793
 				<label class="hide-if-no-js">
1794 1794
 					Show
1795 1795
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
1796
-        foreach ($values as $value) {
1797
-            if ($value < $max_entries) {
1798
-                $selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
1799
-                $entries_per_page_dropdown .= '
1796
+		foreach ($values as $value) {
1797
+			if ($value < $max_entries) {
1798
+				$selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
1799
+				$entries_per_page_dropdown .= '
1800 1800
 						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
1801
-            }
1802
-        }
1803
-        $selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
1804
-        $entries_per_page_dropdown .= '
1801
+			}
1802
+		}
1803
+		$selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
1804
+		$entries_per_page_dropdown .= '
1805 1805
 						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
1806
-        $entries_per_page_dropdown .= '
1806
+		$entries_per_page_dropdown .= '
1807 1807
 					</select>
1808 1808
 					entries
1809 1809
 				</label>
1810 1810
 				<input id="entries-per-page-btn" class="button-secondary" type="submit" value="Go" >
1811 1811
 			</div>
1812 1812
 		';
1813
-        return $entries_per_page_dropdown;
1814
-    }
1815
-
1816
-
1817
-
1818
-    /**
1819
-     *        _set_search_attributes
1820
-     *
1821
-     * @access        protected
1822
-     * @return        void
1823
-     */
1824
-    public function _set_search_attributes()
1825
-    {
1826
-        $this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
1827
-        $this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
1828
-    }
1829
-
1830
-    /*** END LIST TABLE METHODS **/
1831
-    /*****************************/
1832
-    /**
1833
-     *        _add_registered_metaboxes
1834
-     *        this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
1835
-     *
1836
-     * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
1837
-     * @access private
1838
-     * @return void
1839
-     */
1840
-    private function _add_registered_meta_boxes()
1841
-    {
1842
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1843
-        //we only add meta boxes if the page_route calls for it
1844
-        if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
1845
-            && is_array(
1846
-                    $this->_route_config['metaboxes']
1847
-            )
1848
-        ) {
1849
-            // this simply loops through the callbacks provided
1850
-            // and checks if there is a corresponding callback registered by the child
1851
-            // if there is then we go ahead and process the metabox loader.
1852
-            foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
1853
-                // first check for Closures
1854
-                if ($metabox_callback instanceof Closure) {
1855
-                    $result = $metabox_callback();
1856
-                } else if (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
1857
-                    $result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
1858
-                } else {
1859
-                    $result = call_user_func(array($this, &$metabox_callback));
1860
-                }
1861
-                if ($result === false) {
1862
-                    // user error msg
1863
-                    $error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
1864
-                    // developer error msg
1865
-                    $error_msg .= '||' . sprintf(
1866
-                                    __(
1867
-                                            'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
1868
-                                            'event_espresso'
1869
-                                    ),
1870
-                                    $metabox_callback
1871
-                            );
1872
-                    throw new EE_Error($error_msg);
1873
-                }
1874
-            }
1875
-        }
1876
-    }
1877
-
1878
-
1879
-
1880
-    /**
1881
-     * _add_screen_columns
1882
-     * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as the dynamic column template and we'll setup the column options for the page.
1883
-     *
1884
-     * @access private
1885
-     * @return void
1886
-     */
1887
-    private function _add_screen_columns()
1888
-    {
1889
-        if (
1890
-                is_array($this->_route_config)
1891
-                && isset($this->_route_config['columns'])
1892
-                && is_array($this->_route_config['columns'])
1893
-                && count($this->_route_config['columns']) === 2
1894
-        ) {
1895
-            add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
1896
-            $this->_template_args['num_columns'] = $this->_route_config['columns'][0];
1897
-            $screen_id = $this->_current_screen->id;
1898
-            $screen_columns = (int)get_user_option("screen_layout_$screen_id");
1899
-            $total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
1900
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
1901
-            $this->_template_args['current_page'] = $this->_wp_page_slug;
1902
-            $this->_template_args['screen'] = $this->_current_screen;
1903
-            $this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
1904
-            //finally if we don't have has_metaboxes set in the route config let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
1905
-            $this->_route_config['has_metaboxes'] = true;
1906
-        }
1907
-    }
1908
-
1909
-
1910
-
1911
-    /**********************************/
1912
-    /** GLOBALLY AVAILABLE METABOXES **/
1913
-    /**
1914
-     * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply referencing the callback in the _page_config array property.  This way you can be very specific about what pages these get
1915
-     * loaded on.
1916
-     */
1917
-    private function _espresso_news_post_box()
1918
-    {
1919
-        $news_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('New @ Event Espresso', 'event_espresso'));
1920
-        add_meta_box('espresso_news_post_box', $news_box_title, array(
1921
-                $this,
1922
-                'espresso_news_post_box',
1923
-        ), $this->_wp_page_slug, 'side');
1924
-    }
1925
-
1926
-
1927
-
1928
-    /**
1929
-     * Code for setting up espresso ratings request metabox.
1930
-     */
1931
-    protected function _espresso_ratings_request()
1932
-    {
1933
-        if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
1934
-            return '';
1935
-        }
1936
-        $ratings_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso'));
1937
-        add_meta_box('espresso_ratings_request', $ratings_box_title, array(
1938
-                $this,
1939
-                'espresso_ratings_request',
1940
-        ), $this->_wp_page_slug, 'side');
1941
-    }
1942
-
1943
-
1944
-
1945
-    /**
1946
-     * Code for setting up espresso ratings request metabox content.
1947
-     */
1948
-    public function espresso_ratings_request()
1949
-    {
1950
-        $template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
1951
-        EEH_Template::display_template($template_path, array());
1952
-    }
1953
-
1954
-
1955
-
1956
-    public static function cached_rss_display($rss_id, $url)
1957
-    {
1958
-        $loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
1959
-        $doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
1960
-        $pre = '<div class="espresso-rss-display">' . "\n\t";
1961
-        $pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
1962
-        $post = '</div>' . "\n";
1963
-        $cache_key = 'ee_rss_' . md5($rss_id);
1964
-        if (false != ($output = get_transient($cache_key))) {
1965
-            echo $pre . $output . $post;
1966
-            return true;
1967
-        }
1968
-        if ( ! $doing_ajax) {
1969
-            echo $pre . $loading . $post;
1970
-            return false;
1971
-        }
1972
-        ob_start();
1973
-        wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
1974
-        set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
1975
-        return true;
1976
-    }
1977
-
1978
-
1979
-
1980
-    public function espresso_news_post_box()
1981
-    {
1982
-        ?>
1813
+		return $entries_per_page_dropdown;
1814
+	}
1815
+
1816
+
1817
+
1818
+	/**
1819
+	 *        _set_search_attributes
1820
+	 *
1821
+	 * @access        protected
1822
+	 * @return        void
1823
+	 */
1824
+	public function _set_search_attributes()
1825
+	{
1826
+		$this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
1827
+		$this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
1828
+	}
1829
+
1830
+	/*** END LIST TABLE METHODS **/
1831
+	/*****************************/
1832
+	/**
1833
+	 *        _add_registered_metaboxes
1834
+	 *        this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
1835
+	 *
1836
+	 * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
1837
+	 * @access private
1838
+	 * @return void
1839
+	 */
1840
+	private function _add_registered_meta_boxes()
1841
+	{
1842
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1843
+		//we only add meta boxes if the page_route calls for it
1844
+		if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
1845
+			&& is_array(
1846
+					$this->_route_config['metaboxes']
1847
+			)
1848
+		) {
1849
+			// this simply loops through the callbacks provided
1850
+			// and checks if there is a corresponding callback registered by the child
1851
+			// if there is then we go ahead and process the metabox loader.
1852
+			foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
1853
+				// first check for Closures
1854
+				if ($metabox_callback instanceof Closure) {
1855
+					$result = $metabox_callback();
1856
+				} else if (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
1857
+					$result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
1858
+				} else {
1859
+					$result = call_user_func(array($this, &$metabox_callback));
1860
+				}
1861
+				if ($result === false) {
1862
+					// user error msg
1863
+					$error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
1864
+					// developer error msg
1865
+					$error_msg .= '||' . sprintf(
1866
+									__(
1867
+											'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
1868
+											'event_espresso'
1869
+									),
1870
+									$metabox_callback
1871
+							);
1872
+					throw new EE_Error($error_msg);
1873
+				}
1874
+			}
1875
+		}
1876
+	}
1877
+
1878
+
1879
+
1880
+	/**
1881
+	 * _add_screen_columns
1882
+	 * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as the dynamic column template and we'll setup the column options for the page.
1883
+	 *
1884
+	 * @access private
1885
+	 * @return void
1886
+	 */
1887
+	private function _add_screen_columns()
1888
+	{
1889
+		if (
1890
+				is_array($this->_route_config)
1891
+				&& isset($this->_route_config['columns'])
1892
+				&& is_array($this->_route_config['columns'])
1893
+				&& count($this->_route_config['columns']) === 2
1894
+		) {
1895
+			add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
1896
+			$this->_template_args['num_columns'] = $this->_route_config['columns'][0];
1897
+			$screen_id = $this->_current_screen->id;
1898
+			$screen_columns = (int)get_user_option("screen_layout_$screen_id");
1899
+			$total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
1900
+			$this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
1901
+			$this->_template_args['current_page'] = $this->_wp_page_slug;
1902
+			$this->_template_args['screen'] = $this->_current_screen;
1903
+			$this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
1904
+			//finally if we don't have has_metaboxes set in the route config let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
1905
+			$this->_route_config['has_metaboxes'] = true;
1906
+		}
1907
+	}
1908
+
1909
+
1910
+
1911
+	/**********************************/
1912
+	/** GLOBALLY AVAILABLE METABOXES **/
1913
+	/**
1914
+	 * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply referencing the callback in the _page_config array property.  This way you can be very specific about what pages these get
1915
+	 * loaded on.
1916
+	 */
1917
+	private function _espresso_news_post_box()
1918
+	{
1919
+		$news_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('New @ Event Espresso', 'event_espresso'));
1920
+		add_meta_box('espresso_news_post_box', $news_box_title, array(
1921
+				$this,
1922
+				'espresso_news_post_box',
1923
+		), $this->_wp_page_slug, 'side');
1924
+	}
1925
+
1926
+
1927
+
1928
+	/**
1929
+	 * Code for setting up espresso ratings request metabox.
1930
+	 */
1931
+	protected function _espresso_ratings_request()
1932
+	{
1933
+		if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
1934
+			return '';
1935
+		}
1936
+		$ratings_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso'));
1937
+		add_meta_box('espresso_ratings_request', $ratings_box_title, array(
1938
+				$this,
1939
+				'espresso_ratings_request',
1940
+		), $this->_wp_page_slug, 'side');
1941
+	}
1942
+
1943
+
1944
+
1945
+	/**
1946
+	 * Code for setting up espresso ratings request metabox content.
1947
+	 */
1948
+	public function espresso_ratings_request()
1949
+	{
1950
+		$template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
1951
+		EEH_Template::display_template($template_path, array());
1952
+	}
1953
+
1954
+
1955
+
1956
+	public static function cached_rss_display($rss_id, $url)
1957
+	{
1958
+		$loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
1959
+		$doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
1960
+		$pre = '<div class="espresso-rss-display">' . "\n\t";
1961
+		$pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
1962
+		$post = '</div>' . "\n";
1963
+		$cache_key = 'ee_rss_' . md5($rss_id);
1964
+		if (false != ($output = get_transient($cache_key))) {
1965
+			echo $pre . $output . $post;
1966
+			return true;
1967
+		}
1968
+		if ( ! $doing_ajax) {
1969
+			echo $pre . $loading . $post;
1970
+			return false;
1971
+		}
1972
+		ob_start();
1973
+		wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
1974
+		set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
1975
+		return true;
1976
+	}
1977
+
1978
+
1979
+
1980
+	public function espresso_news_post_box()
1981
+	{
1982
+		?>
1983 1983
         <div class="padding">
1984 1984
             <div id="espresso_news_post_box_content" class="infolinks">
1985 1985
                 <?php
1986
-                // Get RSS Feed(s)
1987
-                $feed_url = apply_filters('FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/');
1988
-                $url = urlencode($feed_url);
1989
-                self::cached_rss_display('espresso_news_post_box_content', $url);
1990
-                ?>
1986
+				// Get RSS Feed(s)
1987
+				$feed_url = apply_filters('FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/');
1988
+				$url = urlencode($feed_url);
1989
+				self::cached_rss_display('espresso_news_post_box_content', $url);
1990
+				?>
1991 1991
             </div>
1992 1992
             <?php do_action('AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
1993 1993
         </div>
1994 1994
         <?php
1995
-    }
1996
-
1997
-
1998
-
1999
-    private function _espresso_links_post_box()
2000
-    {
2001
-        //Hiding until we actually have content to put in here...
2002
-        //add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
2003
-    }
2004
-
2005
-
2006
-
2007
-    public function espresso_links_post_box()
2008
-    {
2009
-        //Hiding until we actually have content to put in here...
2010
-        //$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
2011
-        //EEH_Template::display_template( $templatepath );
2012
-    }
2013
-
2014
-
2015
-
2016
-    protected function _espresso_sponsors_post_box()
2017
-    {
2018
-        $show_sponsors = apply_filters('FHEE_show_sponsors_meta_box', true);
2019
-        if ($show_sponsors) {
2020
-            add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array($this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
2021
-        }
2022
-    }
2023
-
2024
-
2025
-
2026
-    public function espresso_sponsors_post_box()
2027
-    {
2028
-        $templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
2029
-        EEH_Template::display_template($templatepath);
2030
-    }
2031
-
2032
-
2033
-
2034
-    private function _publish_post_box()
2035
-    {
2036
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
2037
-        //if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array then we'll use that for the metabox label.  Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
2038
-        if ( ! empty($this->_labels['publishbox'])) {
2039
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
2040
-        } else {
2041
-            $box_label = __('Publish', 'event_espresso');
2042
-        }
2043
-        $box_label = apply_filters('FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this);
2044
-        add_meta_box($meta_box_ref, $box_label, array($this, 'editor_overview'), $this->_current_screen->id, 'side', 'high');
2045
-    }
2046
-
2047
-
2048
-
2049
-    public function editor_overview()
2050
-    {
2051
-        //if we have extra content set let's add it in if not make sure its empty
2052
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
2053
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
2054
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
2055
-    }
2056
-
2057
-
2058
-    /** end of globally available metaboxes section **/
2059
-    /*************************************************/
2060
-    /**
2061
-     * Public wrapper for the protected method.  Allows plugins/addons to externally call the
2062
-     * protected method.
2063
-     *
2064
-     * @see   $this->_set_publish_post_box_vars for param details
2065
-     * @since 4.6.0
2066
-     */
2067
-    public function set_publish_post_box_vars($name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true)
2068
-    {
2069
-        $this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
2070
-    }
2071
-
2072
-
2073
-
2074
-    /**
2075
-     * Sets the _template_args arguments used by the _publish_post_box shortcut
2076
-     * Note: currently there is no validation for this.  However if you want the delete button, the
2077
-     * save, and save and close buttons to work properly, then you will want to include a
2078
-     * values for the name and id arguments.
2079
-     *
2080
-     * @todo  Add in validation for name/id arguments.
2081
-     * @param    string  $name                    key used for the action ID (i.e. event_id)
2082
-     * @param    int     $id                      id attached to the item published
2083
-     * @param    string  $delete                  page route callback for the delete action
2084
-     * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
2085
-     * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
2086
-     * @throws \EE_Error
2087
-     */
2088
-    protected function _set_publish_post_box_vars(
2089
-            $name = '',
2090
-            $id = 0,
2091
-            $delete = '',
2092
-            $save_close_redirect_URL = '',
2093
-            $both_btns = true
2094
-    ) {
2095
-        // if Save & Close, use a custom redirect URL or default to the main page?
2096
-        $save_close_redirect_URL = ! empty($save_close_redirect_URL) ? $save_close_redirect_URL : $this->_admin_base_url;
2097
-        // create the Save & Close and Save buttons
2098
-        $this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
2099
-        //if we have extra content set let's add it in if not make sure its empty
2100
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
2101
-        if ($delete && ! empty($id)) {
2102
-            //make sure we have a default if just true is sent.
2103
-            $delete = ! empty($delete) ? $delete : 'delete';
2104
-            $delete_link_args = array($name => $id);
2105
-            $delete = $this->get_action_link_or_button(
2106
-                    $delete,
2107
-                    $delete,
2108
-                    $delete_link_args,
2109
-                    'submitdelete deletion',
2110
-                    '',
2111
-                    false
2112
-            );
2113
-        }
2114
-        $this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
2115
-        if ( ! empty($name) && ! empty($id)) {
2116
-            $hidden_field_arr[$name] = array(
2117
-                    'type'  => 'hidden',
2118
-                    'value' => $id,
2119
-            );
2120
-            $hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
2121
-        } else {
2122
-            $hf = '';
2123
-        }
2124
-        // add hidden field
2125
-        $this->_template_args['publish_hidden_fields'] = ! empty($hf) ? $hf[$name]['field'] : $hf;
2126
-    }
2127
-
2128
-
2129
-
2130
-    /**
2131
-     *        displays an error message to ppl who have javascript disabled
2132
-     *
2133
-     * @access        private
2134
-     * @return        string
2135
-     */
2136
-    private function _display_no_javascript_warning()
2137
-    {
2138
-        ?>
1995
+	}
1996
+
1997
+
1998
+
1999
+	private function _espresso_links_post_box()
2000
+	{
2001
+		//Hiding until we actually have content to put in here...
2002
+		//add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
2003
+	}
2004
+
2005
+
2006
+
2007
+	public function espresso_links_post_box()
2008
+	{
2009
+		//Hiding until we actually have content to put in here...
2010
+		//$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
2011
+		//EEH_Template::display_template( $templatepath );
2012
+	}
2013
+
2014
+
2015
+
2016
+	protected function _espresso_sponsors_post_box()
2017
+	{
2018
+		$show_sponsors = apply_filters('FHEE_show_sponsors_meta_box', true);
2019
+		if ($show_sponsors) {
2020
+			add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array($this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
2021
+		}
2022
+	}
2023
+
2024
+
2025
+
2026
+	public function espresso_sponsors_post_box()
2027
+	{
2028
+		$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
2029
+		EEH_Template::display_template($templatepath);
2030
+	}
2031
+
2032
+
2033
+
2034
+	private function _publish_post_box()
2035
+	{
2036
+		$meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
2037
+		//if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array then we'll use that for the metabox label.  Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
2038
+		if ( ! empty($this->_labels['publishbox'])) {
2039
+			$box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
2040
+		} else {
2041
+			$box_label = __('Publish', 'event_espresso');
2042
+		}
2043
+		$box_label = apply_filters('FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this);
2044
+		add_meta_box($meta_box_ref, $box_label, array($this, 'editor_overview'), $this->_current_screen->id, 'side', 'high');
2045
+	}
2046
+
2047
+
2048
+
2049
+	public function editor_overview()
2050
+	{
2051
+		//if we have extra content set let's add it in if not make sure its empty
2052
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
2053
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
2054
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
2055
+	}
2056
+
2057
+
2058
+	/** end of globally available metaboxes section **/
2059
+	/*************************************************/
2060
+	/**
2061
+	 * Public wrapper for the protected method.  Allows plugins/addons to externally call the
2062
+	 * protected method.
2063
+	 *
2064
+	 * @see   $this->_set_publish_post_box_vars for param details
2065
+	 * @since 4.6.0
2066
+	 */
2067
+	public function set_publish_post_box_vars($name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true)
2068
+	{
2069
+		$this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
2070
+	}
2071
+
2072
+
2073
+
2074
+	/**
2075
+	 * Sets the _template_args arguments used by the _publish_post_box shortcut
2076
+	 * Note: currently there is no validation for this.  However if you want the delete button, the
2077
+	 * save, and save and close buttons to work properly, then you will want to include a
2078
+	 * values for the name and id arguments.
2079
+	 *
2080
+	 * @todo  Add in validation for name/id arguments.
2081
+	 * @param    string  $name                    key used for the action ID (i.e. event_id)
2082
+	 * @param    int     $id                      id attached to the item published
2083
+	 * @param    string  $delete                  page route callback for the delete action
2084
+	 * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
2085
+	 * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
2086
+	 * @throws \EE_Error
2087
+	 */
2088
+	protected function _set_publish_post_box_vars(
2089
+			$name = '',
2090
+			$id = 0,
2091
+			$delete = '',
2092
+			$save_close_redirect_URL = '',
2093
+			$both_btns = true
2094
+	) {
2095
+		// if Save & Close, use a custom redirect URL or default to the main page?
2096
+		$save_close_redirect_URL = ! empty($save_close_redirect_URL) ? $save_close_redirect_URL : $this->_admin_base_url;
2097
+		// create the Save & Close and Save buttons
2098
+		$this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
2099
+		//if we have extra content set let's add it in if not make sure its empty
2100
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
2101
+		if ($delete && ! empty($id)) {
2102
+			//make sure we have a default if just true is sent.
2103
+			$delete = ! empty($delete) ? $delete : 'delete';
2104
+			$delete_link_args = array($name => $id);
2105
+			$delete = $this->get_action_link_or_button(
2106
+					$delete,
2107
+					$delete,
2108
+					$delete_link_args,
2109
+					'submitdelete deletion',
2110
+					'',
2111
+					false
2112
+			);
2113
+		}
2114
+		$this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
2115
+		if ( ! empty($name) && ! empty($id)) {
2116
+			$hidden_field_arr[$name] = array(
2117
+					'type'  => 'hidden',
2118
+					'value' => $id,
2119
+			);
2120
+			$hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
2121
+		} else {
2122
+			$hf = '';
2123
+		}
2124
+		// add hidden field
2125
+		$this->_template_args['publish_hidden_fields'] = ! empty($hf) ? $hf[$name]['field'] : $hf;
2126
+	}
2127
+
2128
+
2129
+
2130
+	/**
2131
+	 *        displays an error message to ppl who have javascript disabled
2132
+	 *
2133
+	 * @access        private
2134
+	 * @return        string
2135
+	 */
2136
+	private function _display_no_javascript_warning()
2137
+	{
2138
+		?>
2139 2139
         <noscript>
2140 2140
             <div id="no-js-message" class="error">
2141 2141
                 <p style="font-size:1.3em;">
@@ -2145,1267 +2145,1267 @@  discard block
 block discarded – undo
2145 2145
             </div>
2146 2146
         </noscript>
2147 2147
         <?php
2148
-    }
2148
+	}
2149 2149
 
2150 2150
 
2151 2151
 
2152
-    /**
2153
-     *        displays espresso success and/or error notices
2154
-     *
2155
-     * @access        private
2156
-     * @return        string
2157
-     */
2158
-    private function _display_espresso_notices()
2159
-    {
2160
-        $notices = $this->_get_transient(true);
2161
-        echo stripslashes($notices);
2162
-    }
2152
+	/**
2153
+	 *        displays espresso success and/or error notices
2154
+	 *
2155
+	 * @access        private
2156
+	 * @return        string
2157
+	 */
2158
+	private function _display_espresso_notices()
2159
+	{
2160
+		$notices = $this->_get_transient(true);
2161
+		echo stripslashes($notices);
2162
+	}
2163 2163
 
2164 2164
 
2165 2165
 
2166
-    /**
2167
-     *        spinny things pacify the masses
2168
-     *
2169
-     * @access private
2170
-     * @return string
2171
-     */
2172
-    protected function _add_admin_page_ajax_loading_img()
2173
-    {
2174
-        ?>
2166
+	/**
2167
+	 *        spinny things pacify the masses
2168
+	 *
2169
+	 * @access private
2170
+	 * @return string
2171
+	 */
2172
+	protected function _add_admin_page_ajax_loading_img()
2173
+	{
2174
+		?>
2175 2175
         <div id="espresso-ajax-loading" class="ajax-loading-grey">
2176 2176
             <span class="ee-spinner ee-spin"></span><span class="hidden"><?php esc_html_e('loading...', 'event_espresso'); ?></span>
2177 2177
         </div>
2178 2178
         <?php
2179
-    }
2179
+	}
2180 2180
 
2181 2181
 
2182 2182
 
2183
-    /**
2184
-     *        add admin page overlay for modal boxes
2185
-     *
2186
-     * @access private
2187
-     * @return string
2188
-     */
2189
-    protected function _add_admin_page_overlay()
2190
-    {
2191
-        ?>
2183
+	/**
2184
+	 *        add admin page overlay for modal boxes
2185
+	 *
2186
+	 * @access private
2187
+	 * @return string
2188
+	 */
2189
+	protected function _add_admin_page_overlay()
2190
+	{
2191
+		?>
2192 2192
         <div id="espresso-admin-page-overlay-dv" class=""></div>
2193 2193
         <?php
2194
-    }
2195
-
2196
-
2197
-
2198
-    /**
2199
-     * facade for add_meta_box
2200
-     *
2201
-     * @param string  $action        where the metabox get's displayed
2202
-     * @param string  $title         Title of Metabox (output in metabox header)
2203
-     * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback instead of the one created in here.
2204
-     * @param array   $callback_args an array of args supplied for the metabox
2205
-     * @param string  $column        what metabox column
2206
-     * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
2207
-     * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function created but just set our own callback for wp's add_meta_box.
2208
-     */
2209
-    public function _add_admin_page_meta_box($action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true)
2210
-    {
2211
-        do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
2212
-        //if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
2213
-        if (empty($callback_args) && $create_func) {
2214
-            $callback_args = array(
2215
-                    'template_path' => $this->_template_path,
2216
-                    'template_args' => $this->_template_args,
2217
-            );
2218
-        }
2219
-        //if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
2220
-        $call_back_func = $create_func ? create_function('$post, $metabox',
2221
-                'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
2222
-        add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
2223
-    }
2224
-
2225
-
2226
-
2227
-    /**
2228
-     * generates HTML wrapper for and admin details page that contains metaboxes in columns
2229
-     *
2230
-     * @return [type] [description]
2231
-     */
2232
-    public function display_admin_page_with_metabox_columns()
2233
-    {
2234
-        $this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
2235
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_column_template_path, $this->_template_args, true);
2236
-        //the final wrapper
2237
-        $this->admin_page_wrapper();
2238
-    }
2239
-
2240
-
2241
-
2242
-    /**
2243
-     *        generates  HTML wrapper for an admin details page
2244
-     *
2245
-     * @access public
2246
-     * @return void
2247
-     */
2248
-    public function display_admin_page_with_sidebar()
2249
-    {
2250
-        $this->_display_admin_page(true);
2251
-    }
2252
-
2253
-
2254
-
2255
-    /**
2256
-     *        generates  HTML wrapper for an admin details page (except no sidebar)
2257
-     *
2258
-     * @access public
2259
-     * @return void
2260
-     */
2261
-    public function display_admin_page_with_no_sidebar()
2262
-    {
2263
-        $this->_display_admin_page();
2264
-    }
2265
-
2266
-
2267
-
2268
-    /**
2269
-     * generates HTML wrapper for an EE about admin page (no sidebar)
2270
-     *
2271
-     * @access public
2272
-     * @return void
2273
-     */
2274
-    public function display_about_admin_page()
2275
-    {
2276
-        $this->_display_admin_page(false, true);
2277
-    }
2278
-
2279
-
2280
-
2281
-    /**
2282
-     * display_admin_page
2283
-     * contains the code for actually displaying an admin page
2284
-     *
2285
-     * @access private
2286
-     * @param  boolean $sidebar true with sidebar, false without
2287
-     * @param  boolean $about   use the about admin wrapper instead of the default.
2288
-     * @return void
2289
-     */
2290
-    private function _display_admin_page($sidebar = false, $about = false)
2291
-    {
2292
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2293
-        //custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
2294
-        do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
2295
-        // set current wp page slug - looks like: event-espresso_page_event_categories
2296
-        // keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
2297
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
2298
-        $this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
2299
-                ? 'poststuff'
2300
-                : 'espresso-default-admin';
2301
-        $template_path = $sidebar
2302
-                ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
2303
-                : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
2304
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2305
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
2306
-        }
2307
-        $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
2308
-        $this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
2309
-        $this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
2310
-        $this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
2311
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
2312
-        // the final template wrapper
2313
-        $this->admin_page_wrapper($about);
2314
-    }
2315
-
2316
-
2317
-
2318
-    /**
2319
-     * This is used to display caf preview pages.
2320
-     *
2321
-     * @since 4.3.2
2322
-     * @param string $utm_campaign_source what is the key used for google analytics link
2323
-     * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
2324
-     * @return void
2325
-     * @throws \EE_Error
2326
-     */
2327
-    public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
2328
-    {
2329
-        //let's generate a default preview action button if there isn't one already present.
2330
-        $this->_labels['buttons']['buy_now'] = __('Upgrade to Event Espresso 4 Right Now', 'event_espresso');
2331
-        $buy_now_url = add_query_arg(
2332
-                array(
2333
-                        'ee_ver'       => 'ee4',
2334
-                        'utm_source'   => 'ee4_plugin_admin',
2335
-                        'utm_medium'   => 'link',
2336
-                        'utm_campaign' => $utm_campaign_source,
2337
-                        'utm_content'  => 'buy_now_button',
2338
-                ),
2339
-                'http://eventespresso.com/pricing/'
2340
-        );
2341
-        $this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
2342
-                ? $this->get_action_link_or_button(
2343
-                        '',
2344
-                        'buy_now',
2345
-                        array(),
2346
-                        'button-primary button-large',
2347
-                        $buy_now_url,
2348
-                        true
2349
-                )
2350
-                : $this->_template_args['preview_action_button'];
2351
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
2352
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
2353
-                $template_path,
2354
-                $this->_template_args,
2355
-                true
2356
-        );
2357
-        $this->_display_admin_page($display_sidebar);
2358
-    }
2359
-
2360
-
2361
-
2362
-    /**
2363
-     * display_admin_list_table_page_with_sidebar
2364
-     * generates HTML wrapper for an admin_page with list_table
2365
-     *
2366
-     * @access public
2367
-     * @return void
2368
-     */
2369
-    public function display_admin_list_table_page_with_sidebar()
2370
-    {
2371
-        $this->_display_admin_list_table_page(true);
2372
-    }
2373
-
2374
-
2375
-
2376
-    /**
2377
-     * display_admin_list_table_page_with_no_sidebar
2378
-     * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
2379
-     *
2380
-     * @access public
2381
-     * @return void
2382
-     */
2383
-    public function display_admin_list_table_page_with_no_sidebar()
2384
-    {
2385
-        $this->_display_admin_list_table_page();
2386
-    }
2387
-
2388
-
2389
-
2390
-    /**
2391
-     * generates html wrapper for an admin_list_table page
2392
-     *
2393
-     * @access private
2394
-     * @param boolean $sidebar whether to display with sidebar or not.
2395
-     * @return void
2396
-     */
2397
-    private function _display_admin_list_table_page($sidebar = false)
2398
-    {
2399
-        //setup search attributes
2400
-        $this->_set_search_attributes();
2401
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
2402
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
2403
-        $this->_template_args['table_url'] = defined('DOING_AJAX')
2404
-                ? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
2405
-                : add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
2406
-        $this->_template_args['list_table'] = $this->_list_table_object;
2407
-        $this->_template_args['current_route'] = $this->_req_action;
2408
-        $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
2409
-        $ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
2410
-        if ( ! empty($ajax_sorting_callback)) {
2411
-            $sortable_list_table_form_fields = wp_nonce_field(
2412
-                    $ajax_sorting_callback . '_nonce',
2413
-                    $ajax_sorting_callback . '_nonce',
2414
-                    false,
2415
-                    false
2416
-            );
2417
-            //			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
2418
-            //			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
2419
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
2420
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
2421
-        } else {
2422
-            $sortable_list_table_form_fields = '';
2423
-        }
2424
-        $this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
2425
-        $hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
2426
-        $nonce_ref = $this->_req_action . '_nonce';
2427
-        $hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
2428
-        $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
2429
-        //display message about search results?
2430
-        $this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
2431
-                ? '<p class="ee-search-results">' . sprintf(
2432
-                        esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
2433
-                        trim($this->_req_data['s'], '%')
2434
-                ) . '</p>'
2435
-                : '';
2436
-        // filter before_list_table template arg
2437
-        $this->_template_args['before_list_table'] = apply_filters(
2438
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
2439
-            $this->_template_args['before_list_table'],
2440
-            $this->page_slug,
2441
-            $this->_req_data,
2442
-            $this->_req_action
2443
-        );
2444
-        // convert to array and filter again
2445
-        // arrays are easier to inject new items in a specific location,
2446
-        // but would not be backwards compatible, so we have to add a new filter
2447
-        $this->_template_args['before_list_table'] = implode(
2448
-            " \n",
2449
-            (array) apply_filters(
2450
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
2451
-                (array) $this->_template_args['before_list_table'],
2452
-                $this->page_slug,
2453
-                $this->_req_data,
2454
-                $this->_req_action
2455
-            )
2456
-        );
2457
-        // filter after_list_table template arg
2458
-        $this->_template_args['after_list_table'] = apply_filters(
2459
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
2460
-            $this->_template_args['after_list_table'],
2461
-            $this->page_slug,
2462
-            $this->_req_data,
2463
-            $this->_req_action
2464
-        );
2465
-        // convert to array and filter again
2466
-        // arrays are easier to inject new items in a specific location,
2467
-        // but would not be backwards compatible, so we have to add a new filter
2468
-        $this->_template_args['after_list_table'] = implode(
2469
-            " \n",
2470
-            (array) apply_filters(
2471
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
2472
-                (array) $this->_template_args['after_list_table'],
2473
-                $this->page_slug,
2474
-                $this->_req_data,
2475
-                $this->_req_action
2476
-            )
2477
-        );
2478
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
2479
-                $template_path,
2480
-                $this->_template_args,
2481
-                true
2482
-        );
2483
-        // the final template wrapper
2484
-        if ($sidebar) {
2485
-            $this->display_admin_page_with_sidebar();
2486
-        } else {
2487
-            $this->display_admin_page_with_no_sidebar();
2488
-        }
2489
-    }
2490
-
2491
-
2492
-
2493
-    /**
2494
-     * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the html string for the legend.
2495
-     * $items are expected in an array in the following format:
2496
-     * $legend_items = array(
2497
-     *        'item_id' => array(
2498
-     *            'icon' => 'http://url_to_icon_being_described.png',
2499
-     *            'desc' => __('localized description of item');
2500
-     *        )
2501
-     * );
2502
-     *
2503
-     * @param  array $items see above for format of array
2504
-     * @return string        html string of legend
2505
-     */
2506
-    protected function _display_legend($items)
2507
-    {
2508
-        $this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
2509
-        $legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
2510
-        return EEH_Template::display_template($legend_template, $this->_template_args, true);
2511
-    }
2512
-
2513
-
2514
-    /**
2515
-     * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
2516
-     * The returned json object is created from an array in the following format:
2517
-     * array(
2518
-     *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
2519
-     *  'success' => FALSE, //(default FALSE) - contains any special success message.
2520
-     *  'notices' => '', // - contains any EE_Error formatted notices
2521
-     *  'content' => 'string can be html', //this is a string of formatted content (can be html)
2522
-     *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. We're also going to include the template args with every package (so js can pick out any
2523
-     *  specific template args that might be included in here)
2524
-     * )
2525
-     * The json object is populated by whatever is set in the $_template_args property.
2526
-     *
2527
-     * @param bool  $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
2528
-     * @param array $notices_arguments  Use this to pass any additional args on to the _process_notices.
2529
-     * @return void
2530
-     */
2531
-    protected function _return_json($sticky_notices = false, $notices_arguments = array())
2532
-    {
2533
-        //make sure any EE_Error notices have been handled.
2534
-        $this->_process_notices($notices_arguments, true, $sticky_notices);
2535
-        $data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
2536
-        unset($this->_template_args['data']);
2537
-        $json = array(
2538
-                'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
2539
-                'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
2540
-                'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
2541
-                'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
2542
-                'notices'   => EE_Error::get_notices(),
2543
-                'content'   => isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '',
2544
-                'data'      => array_merge($data, array('template_args' => $this->_template_args)),
2545
-                'isEEajax'  => true //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
2546
-        );
2547
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
2548
-        if (null === error_get_last() || ! headers_sent()) {
2549
-            header('Content-Type: application/json; charset=UTF-8');
2550
-        }
2551
-        echo wp_json_encode($json);
2552
-
2553
-        exit();
2554
-    }
2555
-
2556
-
2557
-
2558
-    /**
2559
-     * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
2560
-     *
2561
-     * @return void
2562
-     * @throws EE_Error
2563
-     */
2564
-    public function return_json()
2565
-    {
2566
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2567
-            $this->_return_json();
2568
-        } else {
2569
-            throw new EE_Error(sprintf(__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__));
2570
-        }
2571
-    }
2572
-
2573
-
2574
-
2575
-    /**
2576
-     * This provides a way for child hook classes to send along themselves by reference so methods/properties within them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
2577
-     *
2578
-     * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
2579
-     * @access   public
2580
-     */
2581
-    public function set_hook_object(EE_Admin_Hooks $hook_obj)
2582
-    {
2583
-        $this->_hook_obj = $hook_obj;
2584
-    }
2585
-
2586
-
2587
-
2588
-    /**
2589
-     *        generates  HTML wrapper with Tabbed nav for an admin page
2590
-     *
2591
-     * @access public
2592
-     * @param  boolean $about whether to use the special about page wrapper or default.
2593
-     * @return void
2594
-     */
2595
-    public function admin_page_wrapper($about = false)
2596
-    {
2597
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2598
-        $this->_nav_tabs = $this->_get_main_nav_tabs();
2599
-        $this->_template_args['nav_tabs'] = $this->_nav_tabs;
2600
-        $this->_template_args['admin_page_title'] = $this->_admin_page_title;
2601
-        $this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
2602
-                isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
2603
-        $this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
2604
-                isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
2605
-        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
2606
-        // load settings page wrapper template
2607
-        $template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
2608
-        //about page?
2609
-        $template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
2610
-        if (defined('DOING_AJAX')) {
2611
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
2612
-            $this->_return_json();
2613
-        } else {
2614
-            EEH_Template::display_template($template_path, $this->_template_args);
2615
-        }
2616
-    }
2617
-
2618
-
2619
-
2620
-    /**
2621
-     * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
2622
-     *
2623
-     * @return string html
2624
-     */
2625
-    protected function _get_main_nav_tabs()
2626
-    {
2627
-        //let's generate the html using the EEH_Tabbed_Content helper.  We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute (rather than setting in the page_routes array)
2628
-        return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
2629
-    }
2630
-
2631
-
2632
-
2633
-    /**
2634
-     *        sort nav tabs
2635
-     *
2636
-     * @access public
2637
-     * @param $a
2638
-     * @param $b
2639
-     * @return int
2640
-     */
2641
-    private function _sort_nav_tabs($a, $b)
2642
-    {
2643
-        if ($a['order'] == $b['order']) {
2644
-            return 0;
2645
-        }
2646
-        return ($a['order'] < $b['order']) ? -1 : 1;
2647
-    }
2648
-
2649
-
2650
-
2651
-    /**
2652
-     *    generates HTML for the forms used on admin pages
2653
-     *
2654
-     * @access protected
2655
-     * @param    array $input_vars - array of input field details
2656
-     * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to use)
2657
-     * @return string
2658
-     * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
2659
-     * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
2660
-     */
2661
-    protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
2662
-    {
2663
-        $content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
2664
-        return $content;
2665
-    }
2666
-
2667
-
2668
-
2669
-    /**
2670
-     * generates the "Save" and "Save & Close" buttons for edit forms
2671
-     *
2672
-     * @access protected
2673
-     * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save & Close" button.
2674
-     * @param array            $text     if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
2675
-     * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e. via the "name" value in the button).  We can also use this to just dump default actions by submitting some other value.
2676
-     * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it will use the $referrer string. IF null, then we don't do ANYTHING on save and close (normal form handling).
2677
-     */
2678
-    protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
2679
-    {
2680
-        //make sure $text and $actions are in an array
2681
-        $text = (array)$text;
2682
-        $actions = (array)$actions;
2683
-        $referrer_url = empty($referrer) ? '' : $referrer;
2684
-        $referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
2685
-                : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
2686
-        $button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
2687
-        $default_names = array('save', 'save_and_close');
2688
-        //add in a hidden index for the current page (so save and close redirects properly)
2689
-        $this->_template_args['save_buttons'] = $referrer_url;
2690
-        foreach ($button_text as $key => $button) {
2691
-            $ref = $default_names[$key];
2692
-            $id = $this->_current_view . '_' . $ref;
2693
-            $name = ! empty($actions) ? $actions[$key] : $ref;
2694
-            $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
2695
-            if ( ! $both) {
2696
-                break;
2697
-            }
2698
-        }
2699
-    }
2700
-
2701
-
2702
-
2703
-    /**
2704
-     * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
2705
-     *
2706
-     * @see   $this->_set_add_edit_form_tags() for details on params
2707
-     * @since 4.6.0
2708
-     * @param string $route
2709
-     * @param array  $additional_hidden_fields
2710
-     */
2711
-    public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
2712
-    {
2713
-        $this->_set_add_edit_form_tags($route, $additional_hidden_fields);
2714
-    }
2715
-
2716
-
2717
-
2718
-    /**
2719
-     * set form open and close tags on add/edit pages.
2720
-     *
2721
-     * @access protected
2722
-     * @param string $route                    the route you want the form to direct to
2723
-     * @param array  $additional_hidden_fields any additional hidden fields required in the form header
2724
-     * @return void
2725
-     */
2726
-    protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
2727
-    {
2728
-        if (empty($route)) {
2729
-            $user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
2730
-            $dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
2731
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
2732
-        }
2733
-        // open form
2734
-        $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
2735
-        // add nonce
2736
-        $nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
2737
-        //		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
2738
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
2739
-        // add REQUIRED form action
2740
-        $hidden_fields = array(
2741
-                'action' => array('type' => 'hidden', 'value' => $route),
2742
-        );
2743
-        // merge arrays
2744
-        $hidden_fields = is_array($additional_hidden_fields) ? array_merge($hidden_fields, $additional_hidden_fields) : $hidden_fields;
2745
-        // generate form fields
2746
-        $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
2747
-        // add fields to form
2748
-        foreach ((array)$form_fields as $field_name => $form_field) {
2749
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
2750
-        }
2751
-        // close form
2752
-        $this->_template_args['after_admin_page_content'] = '</form>';
2753
-    }
2754
-
2755
-
2756
-
2757
-    /**
2758
-     * Public Wrapper for _redirect_after_action() method since its
2759
-     * discovered it would be useful for external code to have access.
2760
-     *
2761
-     * @see   EE_Admin_Page::_redirect_after_action() for params.
2762
-     * @since 4.5.0
2763
-     */
2764
-    public function redirect_after_action($success = false, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
2765
-    {
2766
-        $this->_redirect_after_action($success, $what, $action_desc, $query_args, $override_overwrite);
2767
-    }
2768
-
2769
-
2770
-
2771
-    /**
2772
-     *    _redirect_after_action
2773
-     *
2774
-     * @param int    $success            - whether success was for two or more records, or just one, or none
2775
-     * @param string $what               - what the action was performed on
2776
-     * @param string $action_desc        - what was done ie: updated, deleted, etc
2777
-     * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin action is completed
2778
-     * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
2779
-     * @access protected
2780
-     * @return void
2781
-     */
2782
-    protected function _redirect_after_action($success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
2783
-    {
2784
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2785
-        //class name for actions/filters.
2786
-        $classname = get_class($this);
2787
-        //set redirect url. Note if there is a "page" index in the $query_args then we go with vanilla admin.php route, otherwise we go with whatever is set as the _admin_base_url
2788
-        $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
2789
-        $notices = EE_Error::get_notices(false);
2790
-        // overwrite default success messages //BUT ONLY if overwrite not overridden
2791
-        if ( ! $override_overwrite || ! empty($notices['errors'])) {
2792
-            EE_Error::overwrite_success();
2793
-        }
2794
-        if ( ! empty($what) && ! empty($action_desc)) {
2795
-            // how many records affected ? more than one record ? or just one ?
2796
-            if ($success > 1 && empty($notices['errors'])) {
2797
-                // set plural msg
2798
-                EE_Error::add_success(
2799
-                        sprintf(
2800
-                                __('The "%s" have been successfully %s.', 'event_espresso'),
2801
-                                $what,
2802
-                                $action_desc
2803
-                        ),
2804
-                        __FILE__, __FUNCTION__, __LINE__
2805
-                );
2806
-            } else if ($success == 1 && empty($notices['errors'])) {
2807
-                // set singular msg
2808
-                EE_Error::add_success(
2809
-                        sprintf(
2810
-                                __('The "%s" has been successfully %s.', 'event_espresso'),
2811
-                                $what,
2812
-                                $action_desc
2813
-                        ),
2814
-                        __FILE__, __FUNCTION__, __LINE__
2815
-                );
2816
-            }
2817
-        }
2818
-        // check that $query_args isn't something crazy
2819
-        if ( ! is_array($query_args)) {
2820
-            $query_args = array();
2821
-        }
2822
-        /**
2823
-         * Allow injecting actions before the query_args are modified for possible different
2824
-         * redirections on save and close actions
2825
-         *
2826
-         * @since 4.2.0
2827
-         * @param array $query_args       The original query_args array coming into the
2828
-         *                                method.
2829
-         */
2830
-        do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
2831
-        //calculate where we're going (if we have a "save and close" button pushed)
2832
-        if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
2833
-            // even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
2834
-            $parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
2835
-            // regenerate query args array from referrer URL
2836
-            parse_str($parsed_url['query'], $query_args);
2837
-            // correct page and action will be in the query args now
2838
-            $redirect_url = admin_url('admin.php');
2839
-        }
2840
-        //merge any default query_args set in _default_route_query_args property
2841
-        if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
2842
-            $args_to_merge = array();
2843
-            foreach ($this->_default_route_query_args as $query_param => $query_value) {
2844
-                //is there a wp_referer array in our _default_route_query_args property?
2845
-                if ($query_param == 'wp_referer') {
2846
-                    $query_value = (array)$query_value;
2847
-                    foreach ($query_value as $reference => $value) {
2848
-                        if (strpos($reference, 'nonce') !== false) {
2849
-                            continue;
2850
-                        }
2851
-                        //finally we will override any arguments in the referer with
2852
-                        //what might be set on the _default_route_query_args array.
2853
-                        if (isset($this->_default_route_query_args[$reference])) {
2854
-                            $args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
2855
-                        } else {
2856
-                            $args_to_merge[$reference] = urlencode($value);
2857
-                        }
2858
-                    }
2859
-                    continue;
2860
-                }
2861
-                $args_to_merge[$query_param] = $query_value;
2862
-            }
2863
-            //now let's merge these arguments but override with what was specifically sent in to the
2864
-            //redirect.
2865
-            $query_args = array_merge($args_to_merge, $query_args);
2866
-        }
2867
-        $this->_process_notices($query_args);
2868
-        // generate redirect url
2869
-        // if redirecting to anything other than the main page, add a nonce
2870
-        if (isset($query_args['action'])) {
2871
-            // manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
2872
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
2873
-        }
2874
-        //we're adding some hooks and filters in here for processing any things just before redirects (example: an admin page has done an insert or update and we want to run something after that).
2875
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
2876
-        $redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
2877
-        // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
2878
-        if (defined('DOING_AJAX')) {
2879
-            $default_data = array(
2880
-                    'close'        => true,
2881
-                    'redirect_url' => $redirect_url,
2882
-                    'where'        => 'main',
2883
-                    'what'         => 'append',
2884
-            );
2885
-            $this->_template_args['success'] = $success;
2886
-            $this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data']) : $default_data;
2887
-            $this->_return_json();
2888
-        }
2889
-        wp_safe_redirect($redirect_url);
2890
-        exit();
2891
-    }
2892
-
2893
-
2894
-
2895
-    /**
2896
-     * process any notices before redirecting (or returning ajax request)
2897
-     * This method sets the $this->_template_args['notices'] attribute;
2898
-     *
2899
-     * @param  array $query_args        any query args that need to be used for notice transient ('action')
2900
-     * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
2901
-     * @param bool   $sticky_notices    This is used to flag that regardless of whether this is doing_ajax or not, we still save a transient for the notice.
2902
-     * @return void
2903
-     */
2904
-    protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
2905
-    {
2906
-        //first let's set individual error properties if doing_ajax and the properties aren't already set.
2907
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2908
-            $notices = EE_Error::get_notices(false);
2909
-            if (empty($this->_template_args['success'])) {
2910
-                $this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
2911
-            }
2912
-            if (empty($this->_template_args['errors'])) {
2913
-                $this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
2914
-            }
2915
-            if (empty($this->_template_args['attention'])) {
2916
-                $this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
2917
-            }
2918
-        }
2919
-        $this->_template_args['notices'] = EE_Error::get_notices();
2920
-        //IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
2921
-        if ( ! defined('DOING_AJAX') || $sticky_notices) {
2922
-            $route = isset($query_args['action']) ? $query_args['action'] : 'default';
2923
-            $this->_add_transient($route, $this->_template_args['notices'], true, $skip_route_verify);
2924
-        }
2925
-    }
2926
-
2927
-
2928
-
2929
-    /**
2930
-     * get_action_link_or_button
2931
-     * returns the button html for adding, editing, or deleting an item (depending on given type)
2932
-     *
2933
-     * @param string $action        use this to indicate which action the url is generated with.
2934
-     * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key) property.
2935
-     * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
2936
-     * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
2937
-     * @param string $base_url      If this is not provided
2938
-     *                              the _admin_base_url will be used as the default for the button base_url.
2939
-     *                              Otherwise this value will be used.
2940
-     * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
2941
-     * @return string
2942
-     * @throws \EE_Error
2943
-     */
2944
-    public function get_action_link_or_button(
2945
-            $action,
2946
-            $type = 'add',
2947
-            $extra_request = array(),
2948
-            $class = 'button-primary',
2949
-            $base_url = '',
2950
-            $exclude_nonce = false
2951
-    ) {
2952
-        //first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
2953
-        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
2954
-            throw new EE_Error(
2955
-                    sprintf(
2956
-                            __(
2957
-                                    'There is no page route for given action for the button.  This action was given: %s',
2958
-                                    'event_espresso'
2959
-                            ),
2960
-                            $action
2961
-                    )
2962
-            );
2963
-        }
2964
-        if ( ! isset($this->_labels['buttons'][$type])) {
2965
-            throw new EE_Error(
2966
-                    sprintf(
2967
-                            __(
2968
-                                    'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
2969
-                                    'event_espresso'
2970
-                            ),
2971
-                            $type
2972
-                    )
2973
-            );
2974
-        }
2975
-        //finally check user access for this button.
2976
-        $has_access = $this->check_user_access($action, true);
2977
-        if ( ! $has_access) {
2978
-            return '';
2979
-        }
2980
-        $_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
2981
-        $query_args = array(
2982
-                'action' => $action,
2983
-        );
2984
-        //merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
2985
-        if ( ! empty($extra_request)) {
2986
-            $query_args = array_merge($extra_request, $query_args);
2987
-        }
2988
-        $url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
2989
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
2990
-    }
2991
-
2992
-
2993
-
2994
-    /**
2995
-     * _per_page_screen_option
2996
-     * Utility function for adding in a per_page_option in the screen_options_dropdown.
2997
-     *
2998
-     * @return void
2999
-     */
3000
-    protected function _per_page_screen_option()
3001
-    {
3002
-        $option = 'per_page';
3003
-        $args = array(
3004
-                'label'   => $this->_admin_page_title,
3005
-                'default' => 10,
3006
-                'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
3007
-        );
3008
-        //ONLY add the screen option if the user has access to it.
3009
-        if ($this->check_user_access($this->_current_view, true)) {
3010
-            add_screen_option($option, $args);
3011
-        }
3012
-    }
3013
-
3014
-
3015
-
3016
-    /**
3017
-     * set_per_page_screen_option
3018
-     * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
3019
-     * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
3020
-     *
3021
-     * @access private
3022
-     * @return void
3023
-     */
3024
-    private function _set_per_page_screen_options()
3025
-    {
3026
-        if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
3027
-            check_admin_referer('screen-options-nonce', 'screenoptionnonce');
3028
-            if ( ! $user = wp_get_current_user()) {
3029
-                return;
3030
-            }
3031
-            $option = $_POST['wp_screen_options']['option'];
3032
-            $value = $_POST['wp_screen_options']['value'];
3033
-            if ($option != sanitize_key($option)) {
3034
-                return;
3035
-            }
3036
-            $map_option = $option;
3037
-            $option = str_replace('-', '_', $option);
3038
-            switch ($map_option) {
3039
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
3040
-                    $value = (int)$value;
3041
-                    if ($value < 1 || $value > 999) {
3042
-                        return;
3043
-                    }
3044
-                    break;
3045
-                default:
3046
-                    $value = apply_filters('FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value);
3047
-                    if (false === $value) {
3048
-                        return;
3049
-                    }
3050
-                    break;
3051
-            }
3052
-            update_user_meta($user->ID, $option, $value);
3053
-            wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
3054
-            exit;
3055
-        }
3056
-    }
3057
-
3058
-
3059
-
3060
-    /**
3061
-     * This just allows for setting the $_template_args property if it needs to be set outside the object
3062
-     *
3063
-     * @param array $data array that will be assigned to template args.
3064
-     */
3065
-    public function set_template_args($data)
3066
-    {
3067
-        $this->_template_args = array_merge($this->_template_args, (array)$data);
3068
-    }
3069
-
3070
-
3071
-
3072
-    /**
3073
-     * This makes available the WP transient system for temporarily moving data between routes
3074
-     *
3075
-     * @access protected
3076
-     * @param string $route             the route that should receive the transient
3077
-     * @param array  $data              the data that gets sent
3078
-     * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
3079
-     * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used when we are adding a transient before page_routes have been defined.
3080
-     * @return void
3081
-     */
3082
-    protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
3083
-    {
3084
-        $user_id = get_current_user_id();
3085
-        if ( ! $skip_route_verify) {
3086
-            $this->_verify_route($route);
3087
-        }
3088
-        //now let's set the string for what kind of transient we're setting
3089
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
3090
-        $data = $notices ? array('notices' => $data) : $data;
3091
-        //is there already a transient for this route?  If there is then let's ADD to that transient
3092
-        $existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
3093
-        if ($existing) {
3094
-            $data = array_merge((array)$data, (array)$existing);
3095
-        }
3096
-        if (is_multisite() && is_network_admin()) {
3097
-            set_site_transient($transient, $data, 8);
3098
-        } else {
3099
-            set_transient($transient, $data, 8);
3100
-        }
3101
-    }
3102
-
3103
-
3104
-
3105
-    /**
3106
-     * this retrieves the temporary transient that has been set for moving data between routes.
3107
-     *
3108
-     * @param bool $notices true we get notices transient. False we just return normal route transient
3109
-     * @return mixed data
3110
-     */
3111
-    protected function _get_transient($notices = false, $route = false)
3112
-    {
3113
-        $user_id = get_current_user_id();
3114
-        $route = ! $route ? $this->_req_action : $route;
3115
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
3116
-        $data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
3117
-        //delete transient after retrieval (just in case it hasn't expired);
3118
-        if (is_multisite() && is_network_admin()) {
3119
-            delete_site_transient($transient);
3120
-        } else {
3121
-            delete_transient($transient);
3122
-        }
3123
-        return $notices && isset($data['notices']) ? $data['notices'] : $data;
3124
-    }
3125
-
3126
-
3127
-
3128
-    /**
3129
-     * The purpose of this method is just to run garbage collection on any EE transients that might have expired but would not be called later.
3130
-     * This will be assigned to run on a specific EE Admin page. (place the method in the default route callback on the EE_Admin page you want it run.)
3131
-     *
3132
-     * @return void
3133
-     */
3134
-    protected function _transient_garbage_collection()
3135
-    {
3136
-        global $wpdb;
3137
-        //retrieve all existing transients
3138
-        $query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
3139
-        if ($results = $wpdb->get_results($query)) {
3140
-            foreach ($results as $result) {
3141
-                $transient = str_replace('_transient_', '', $result->option_name);
3142
-                get_transient($transient);
3143
-                if (is_multisite() && is_network_admin()) {
3144
-                    get_site_transient($transient);
3145
-                }
3146
-            }
3147
-        }
3148
-    }
3149
-
3150
-
3151
-
3152
-    /**
3153
-     * get_view
3154
-     *
3155
-     * @access public
3156
-     * @return string content of _view property
3157
-     */
3158
-    public function get_view()
3159
-    {
3160
-        return $this->_view;
3161
-    }
3162
-
3163
-
3164
-
3165
-    /**
3166
-     * getter for the protected $_views property
3167
-     *
3168
-     * @return array
3169
-     */
3170
-    public function get_views()
3171
-    {
3172
-        return $this->_views;
3173
-    }
3174
-
3175
-
3176
-
3177
-    /**
3178
-     * get_current_page
3179
-     *
3180
-     * @access public
3181
-     * @return string _current_page property value
3182
-     */
3183
-    public function get_current_page()
3184
-    {
3185
-        return $this->_current_page;
3186
-    }
3187
-
3188
-
3189
-
3190
-    /**
3191
-     * get_current_view
3192
-     *
3193
-     * @access public
3194
-     * @return string _current_view property value
3195
-     */
3196
-    public function get_current_view()
3197
-    {
3198
-        return $this->_current_view;
3199
-    }
3200
-
3201
-
3202
-
3203
-    /**
3204
-     * get_current_screen
3205
-     *
3206
-     * @access public
3207
-     * @return object The current WP_Screen object
3208
-     */
3209
-    public function get_current_screen()
3210
-    {
3211
-        return $this->_current_screen;
3212
-    }
3213
-
3214
-
3215
-
3216
-    /**
3217
-     * get_current_page_view_url
3218
-     *
3219
-     * @access public
3220
-     * @return string This returns the url for the current_page_view.
3221
-     */
3222
-    public function get_current_page_view_url()
3223
-    {
3224
-        return $this->_current_page_view_url;
3225
-    }
3226
-
3227
-
3228
-
3229
-    /**
3230
-     * just returns the _req_data property
3231
-     *
3232
-     * @return array
3233
-     */
3234
-    public function get_request_data()
3235
-    {
3236
-        return $this->_req_data;
3237
-    }
3238
-
3239
-
3240
-
3241
-    /**
3242
-     * returns the _req_data protected property
3243
-     *
3244
-     * @return string
3245
-     */
3246
-    public function get_req_action()
3247
-    {
3248
-        return $this->_req_action;
3249
-    }
3250
-
3251
-
3252
-
3253
-    /**
3254
-     * @return bool  value of $_is_caf property
3255
-     */
3256
-    public function is_caf()
3257
-    {
3258
-        return $this->_is_caf;
3259
-    }
3260
-
3261
-
3262
-
3263
-    /**
3264
-     * @return mixed
3265
-     */
3266
-    public function default_espresso_metaboxes()
3267
-    {
3268
-        return $this->_default_espresso_metaboxes;
3269
-    }
3270
-
3271
-
3272
-
3273
-    /**
3274
-     * @return mixed
3275
-     */
3276
-    public function admin_base_url()
3277
-    {
3278
-        return $this->_admin_base_url;
3279
-    }
3280
-
3281
-
3282
-
3283
-    /**
3284
-     * @return mixed
3285
-     */
3286
-    public function wp_page_slug()
3287
-    {
3288
-        return $this->_wp_page_slug;
3289
-    }
3290
-
3291
-
3292
-
3293
-    /**
3294
-     * updates  espresso configuration settings
3295
-     *
3296
-     * @access    protected
3297
-     * @param string                   $tab
3298
-     * @param EE_Config_Base|EE_Config $config
3299
-     * @param string                   $file file where error occurred
3300
-     * @param string                   $func function  where error occurred
3301
-     * @param string                   $line line no where error occurred
3302
-     * @return boolean
3303
-     */
3304
-    protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
3305
-    {
3306
-        //remove any options that are NOT going to be saved with the config settings.
3307
-        if (isset($config->core->ee_ueip_optin)) {
3308
-            $config->core->ee_ueip_has_notified = true;
3309
-            // TODO: remove the following two lines and make sure values are migrated from 3.1
3310
-            update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
3311
-            update_option('ee_ueip_has_notified', true);
3312
-        }
3313
-        // and save it (note we're also doing the network save here)
3314
-        $net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
3315
-        $config_saved = EE_Config::instance()->update_espresso_config(false, false);
3316
-        if ($config_saved && $net_saved) {
3317
-            EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
3318
-            return true;
3319
-        } else {
3320
-            EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
3321
-            return false;
3322
-        }
3323
-    }
3324
-
3325
-
3326
-
3327
-    /**
3328
-     * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
3329
-     *
3330
-     * @return array
3331
-     */
3332
-    public function get_yes_no_values()
3333
-    {
3334
-        return $this->_yes_no_values;
3335
-    }
3336
-
3337
-
3338
-
3339
-    protected function _get_dir()
3340
-    {
3341
-        $reflector = new ReflectionClass(get_class($this));
3342
-        return dirname($reflector->getFileName());
3343
-    }
3344
-
3345
-
3346
-
3347
-    /**
3348
-     * A helper for getting a "next link".
3349
-     *
3350
-     * @param string $url   The url to link to
3351
-     * @param string $class The class to use.
3352
-     * @return string
3353
-     */
3354
-    protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
3355
-    {
3356
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
3357
-    }
3358
-
3359
-
3360
-
3361
-    /**
3362
-     * A helper for getting a "previous link".
3363
-     *
3364
-     * @param string $url   The url to link to
3365
-     * @param string $class The class to use.
3366
-     * @return string
3367
-     */
3368
-    protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
3369
-    {
3370
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
3371
-    }
3372
-
3373
-
3374
-
3375
-
3376
-
3377
-
3378
-
3379
-    //below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
3380
-    /**
3381
-     * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the _req_data
3382
-     * array.
3383
-     *
3384
-     * @return bool success/fail
3385
-     */
3386
-    protected function _process_resend_registration()
3387
-    {
3388
-        $this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
3389
-        do_action('AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data);
3390
-        return $this->_template_args['success'];
3391
-    }
3392
-
3393
-
3394
-
3395
-    /**
3396
-     * This automatically processes any payment message notifications when manual payment has been applied.
3397
-     *
3398
-     * @access protected
3399
-     * @param \EE_Payment $payment
3400
-     * @return bool success/fail
3401
-     */
3402
-    protected function _process_payment_notification(EE_Payment $payment)
3403
-    {
3404
-        add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
3405
-        do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
3406
-        $this->_template_args['success'] = apply_filters('FHEE__EE_Admin_Page___process_admin_payment_notification__success', false, $payment);
3407
-        return $this->_template_args['success'];
3408
-    }
2194
+	}
2195
+
2196
+
2197
+
2198
+	/**
2199
+	 * facade for add_meta_box
2200
+	 *
2201
+	 * @param string  $action        where the metabox get's displayed
2202
+	 * @param string  $title         Title of Metabox (output in metabox header)
2203
+	 * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback instead of the one created in here.
2204
+	 * @param array   $callback_args an array of args supplied for the metabox
2205
+	 * @param string  $column        what metabox column
2206
+	 * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
2207
+	 * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function created but just set our own callback for wp's add_meta_box.
2208
+	 */
2209
+	public function _add_admin_page_meta_box($action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true)
2210
+	{
2211
+		do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
2212
+		//if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
2213
+		if (empty($callback_args) && $create_func) {
2214
+			$callback_args = array(
2215
+					'template_path' => $this->_template_path,
2216
+					'template_args' => $this->_template_args,
2217
+			);
2218
+		}
2219
+		//if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
2220
+		$call_back_func = $create_func ? create_function('$post, $metabox',
2221
+				'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
2222
+		add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
2223
+	}
2224
+
2225
+
2226
+
2227
+	/**
2228
+	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
2229
+	 *
2230
+	 * @return [type] [description]
2231
+	 */
2232
+	public function display_admin_page_with_metabox_columns()
2233
+	{
2234
+		$this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
2235
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_column_template_path, $this->_template_args, true);
2236
+		//the final wrapper
2237
+		$this->admin_page_wrapper();
2238
+	}
2239
+
2240
+
2241
+
2242
+	/**
2243
+	 *        generates  HTML wrapper for an admin details page
2244
+	 *
2245
+	 * @access public
2246
+	 * @return void
2247
+	 */
2248
+	public function display_admin_page_with_sidebar()
2249
+	{
2250
+		$this->_display_admin_page(true);
2251
+	}
2252
+
2253
+
2254
+
2255
+	/**
2256
+	 *        generates  HTML wrapper for an admin details page (except no sidebar)
2257
+	 *
2258
+	 * @access public
2259
+	 * @return void
2260
+	 */
2261
+	public function display_admin_page_with_no_sidebar()
2262
+	{
2263
+		$this->_display_admin_page();
2264
+	}
2265
+
2266
+
2267
+
2268
+	/**
2269
+	 * generates HTML wrapper for an EE about admin page (no sidebar)
2270
+	 *
2271
+	 * @access public
2272
+	 * @return void
2273
+	 */
2274
+	public function display_about_admin_page()
2275
+	{
2276
+		$this->_display_admin_page(false, true);
2277
+	}
2278
+
2279
+
2280
+
2281
+	/**
2282
+	 * display_admin_page
2283
+	 * contains the code for actually displaying an admin page
2284
+	 *
2285
+	 * @access private
2286
+	 * @param  boolean $sidebar true with sidebar, false without
2287
+	 * @param  boolean $about   use the about admin wrapper instead of the default.
2288
+	 * @return void
2289
+	 */
2290
+	private function _display_admin_page($sidebar = false, $about = false)
2291
+	{
2292
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2293
+		//custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
2294
+		do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
2295
+		// set current wp page slug - looks like: event-espresso_page_event_categories
2296
+		// keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
2297
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
2298
+		$this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
2299
+				? 'poststuff'
2300
+				: 'espresso-default-admin';
2301
+		$template_path = $sidebar
2302
+				? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
2303
+				: EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
2304
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2305
+			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
2306
+		}
2307
+		$template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
2308
+		$this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
2309
+		$this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
2310
+		$this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
2311
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
2312
+		// the final template wrapper
2313
+		$this->admin_page_wrapper($about);
2314
+	}
2315
+
2316
+
2317
+
2318
+	/**
2319
+	 * This is used to display caf preview pages.
2320
+	 *
2321
+	 * @since 4.3.2
2322
+	 * @param string $utm_campaign_source what is the key used for google analytics link
2323
+	 * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
2324
+	 * @return void
2325
+	 * @throws \EE_Error
2326
+	 */
2327
+	public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
2328
+	{
2329
+		//let's generate a default preview action button if there isn't one already present.
2330
+		$this->_labels['buttons']['buy_now'] = __('Upgrade to Event Espresso 4 Right Now', 'event_espresso');
2331
+		$buy_now_url = add_query_arg(
2332
+				array(
2333
+						'ee_ver'       => 'ee4',
2334
+						'utm_source'   => 'ee4_plugin_admin',
2335
+						'utm_medium'   => 'link',
2336
+						'utm_campaign' => $utm_campaign_source,
2337
+						'utm_content'  => 'buy_now_button',
2338
+				),
2339
+				'http://eventespresso.com/pricing/'
2340
+		);
2341
+		$this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
2342
+				? $this->get_action_link_or_button(
2343
+						'',
2344
+						'buy_now',
2345
+						array(),
2346
+						'button-primary button-large',
2347
+						$buy_now_url,
2348
+						true
2349
+				)
2350
+				: $this->_template_args['preview_action_button'];
2351
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
2352
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
2353
+				$template_path,
2354
+				$this->_template_args,
2355
+				true
2356
+		);
2357
+		$this->_display_admin_page($display_sidebar);
2358
+	}
2359
+
2360
+
2361
+
2362
+	/**
2363
+	 * display_admin_list_table_page_with_sidebar
2364
+	 * generates HTML wrapper for an admin_page with list_table
2365
+	 *
2366
+	 * @access public
2367
+	 * @return void
2368
+	 */
2369
+	public function display_admin_list_table_page_with_sidebar()
2370
+	{
2371
+		$this->_display_admin_list_table_page(true);
2372
+	}
2373
+
2374
+
2375
+
2376
+	/**
2377
+	 * display_admin_list_table_page_with_no_sidebar
2378
+	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
2379
+	 *
2380
+	 * @access public
2381
+	 * @return void
2382
+	 */
2383
+	public function display_admin_list_table_page_with_no_sidebar()
2384
+	{
2385
+		$this->_display_admin_list_table_page();
2386
+	}
2387
+
2388
+
2389
+
2390
+	/**
2391
+	 * generates html wrapper for an admin_list_table page
2392
+	 *
2393
+	 * @access private
2394
+	 * @param boolean $sidebar whether to display with sidebar or not.
2395
+	 * @return void
2396
+	 */
2397
+	private function _display_admin_list_table_page($sidebar = false)
2398
+	{
2399
+		//setup search attributes
2400
+		$this->_set_search_attributes();
2401
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
2402
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
2403
+		$this->_template_args['table_url'] = defined('DOING_AJAX')
2404
+				? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
2405
+				: add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
2406
+		$this->_template_args['list_table'] = $this->_list_table_object;
2407
+		$this->_template_args['current_route'] = $this->_req_action;
2408
+		$this->_template_args['list_table_class'] = get_class($this->_list_table_object);
2409
+		$ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
2410
+		if ( ! empty($ajax_sorting_callback)) {
2411
+			$sortable_list_table_form_fields = wp_nonce_field(
2412
+					$ajax_sorting_callback . '_nonce',
2413
+					$ajax_sorting_callback . '_nonce',
2414
+					false,
2415
+					false
2416
+			);
2417
+			//			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
2418
+			//			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
2419
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
2420
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
2421
+		} else {
2422
+			$sortable_list_table_form_fields = '';
2423
+		}
2424
+		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
2425
+		$hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
2426
+		$nonce_ref = $this->_req_action . '_nonce';
2427
+		$hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
2428
+		$this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
2429
+		//display message about search results?
2430
+		$this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
2431
+				? '<p class="ee-search-results">' . sprintf(
2432
+						esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
2433
+						trim($this->_req_data['s'], '%')
2434
+				) . '</p>'
2435
+				: '';
2436
+		// filter before_list_table template arg
2437
+		$this->_template_args['before_list_table'] = apply_filters(
2438
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
2439
+			$this->_template_args['before_list_table'],
2440
+			$this->page_slug,
2441
+			$this->_req_data,
2442
+			$this->_req_action
2443
+		);
2444
+		// convert to array and filter again
2445
+		// arrays are easier to inject new items in a specific location,
2446
+		// but would not be backwards compatible, so we have to add a new filter
2447
+		$this->_template_args['before_list_table'] = implode(
2448
+			" \n",
2449
+			(array) apply_filters(
2450
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
2451
+				(array) $this->_template_args['before_list_table'],
2452
+				$this->page_slug,
2453
+				$this->_req_data,
2454
+				$this->_req_action
2455
+			)
2456
+		);
2457
+		// filter after_list_table template arg
2458
+		$this->_template_args['after_list_table'] = apply_filters(
2459
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
2460
+			$this->_template_args['after_list_table'],
2461
+			$this->page_slug,
2462
+			$this->_req_data,
2463
+			$this->_req_action
2464
+		);
2465
+		// convert to array and filter again
2466
+		// arrays are easier to inject new items in a specific location,
2467
+		// but would not be backwards compatible, so we have to add a new filter
2468
+		$this->_template_args['after_list_table'] = implode(
2469
+			" \n",
2470
+			(array) apply_filters(
2471
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
2472
+				(array) $this->_template_args['after_list_table'],
2473
+				$this->page_slug,
2474
+				$this->_req_data,
2475
+				$this->_req_action
2476
+			)
2477
+		);
2478
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
2479
+				$template_path,
2480
+				$this->_template_args,
2481
+				true
2482
+		);
2483
+		// the final template wrapper
2484
+		if ($sidebar) {
2485
+			$this->display_admin_page_with_sidebar();
2486
+		} else {
2487
+			$this->display_admin_page_with_no_sidebar();
2488
+		}
2489
+	}
2490
+
2491
+
2492
+
2493
+	/**
2494
+	 * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the html string for the legend.
2495
+	 * $items are expected in an array in the following format:
2496
+	 * $legend_items = array(
2497
+	 *        'item_id' => array(
2498
+	 *            'icon' => 'http://url_to_icon_being_described.png',
2499
+	 *            'desc' => __('localized description of item');
2500
+	 *        )
2501
+	 * );
2502
+	 *
2503
+	 * @param  array $items see above for format of array
2504
+	 * @return string        html string of legend
2505
+	 */
2506
+	protected function _display_legend($items)
2507
+	{
2508
+		$this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
2509
+		$legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
2510
+		return EEH_Template::display_template($legend_template, $this->_template_args, true);
2511
+	}
2512
+
2513
+
2514
+	/**
2515
+	 * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
2516
+	 * The returned json object is created from an array in the following format:
2517
+	 * array(
2518
+	 *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
2519
+	 *  'success' => FALSE, //(default FALSE) - contains any special success message.
2520
+	 *  'notices' => '', // - contains any EE_Error formatted notices
2521
+	 *  'content' => 'string can be html', //this is a string of formatted content (can be html)
2522
+	 *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. We're also going to include the template args with every package (so js can pick out any
2523
+	 *  specific template args that might be included in here)
2524
+	 * )
2525
+	 * The json object is populated by whatever is set in the $_template_args property.
2526
+	 *
2527
+	 * @param bool  $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
2528
+	 * @param array $notices_arguments  Use this to pass any additional args on to the _process_notices.
2529
+	 * @return void
2530
+	 */
2531
+	protected function _return_json($sticky_notices = false, $notices_arguments = array())
2532
+	{
2533
+		//make sure any EE_Error notices have been handled.
2534
+		$this->_process_notices($notices_arguments, true, $sticky_notices);
2535
+		$data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
2536
+		unset($this->_template_args['data']);
2537
+		$json = array(
2538
+				'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
2539
+				'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
2540
+				'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
2541
+				'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
2542
+				'notices'   => EE_Error::get_notices(),
2543
+				'content'   => isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '',
2544
+				'data'      => array_merge($data, array('template_args' => $this->_template_args)),
2545
+				'isEEajax'  => true //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
2546
+		);
2547
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
2548
+		if (null === error_get_last() || ! headers_sent()) {
2549
+			header('Content-Type: application/json; charset=UTF-8');
2550
+		}
2551
+		echo wp_json_encode($json);
2552
+
2553
+		exit();
2554
+	}
2555
+
2556
+
2557
+
2558
+	/**
2559
+	 * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
2560
+	 *
2561
+	 * @return void
2562
+	 * @throws EE_Error
2563
+	 */
2564
+	public function return_json()
2565
+	{
2566
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2567
+			$this->_return_json();
2568
+		} else {
2569
+			throw new EE_Error(sprintf(__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__));
2570
+		}
2571
+	}
2572
+
2573
+
2574
+
2575
+	/**
2576
+	 * This provides a way for child hook classes to send along themselves by reference so methods/properties within them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
2577
+	 *
2578
+	 * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
2579
+	 * @access   public
2580
+	 */
2581
+	public function set_hook_object(EE_Admin_Hooks $hook_obj)
2582
+	{
2583
+		$this->_hook_obj = $hook_obj;
2584
+	}
2585
+
2586
+
2587
+
2588
+	/**
2589
+	 *        generates  HTML wrapper with Tabbed nav for an admin page
2590
+	 *
2591
+	 * @access public
2592
+	 * @param  boolean $about whether to use the special about page wrapper or default.
2593
+	 * @return void
2594
+	 */
2595
+	public function admin_page_wrapper($about = false)
2596
+	{
2597
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2598
+		$this->_nav_tabs = $this->_get_main_nav_tabs();
2599
+		$this->_template_args['nav_tabs'] = $this->_nav_tabs;
2600
+		$this->_template_args['admin_page_title'] = $this->_admin_page_title;
2601
+		$this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
2602
+				isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
2603
+		$this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
2604
+				isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
2605
+		$this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
2606
+		// load settings page wrapper template
2607
+		$template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
2608
+		//about page?
2609
+		$template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
2610
+		if (defined('DOING_AJAX')) {
2611
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
2612
+			$this->_return_json();
2613
+		} else {
2614
+			EEH_Template::display_template($template_path, $this->_template_args);
2615
+		}
2616
+	}
2617
+
2618
+
2619
+
2620
+	/**
2621
+	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
2622
+	 *
2623
+	 * @return string html
2624
+	 */
2625
+	protected function _get_main_nav_tabs()
2626
+	{
2627
+		//let's generate the html using the EEH_Tabbed_Content helper.  We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute (rather than setting in the page_routes array)
2628
+		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
2629
+	}
2630
+
2631
+
2632
+
2633
+	/**
2634
+	 *        sort nav tabs
2635
+	 *
2636
+	 * @access public
2637
+	 * @param $a
2638
+	 * @param $b
2639
+	 * @return int
2640
+	 */
2641
+	private function _sort_nav_tabs($a, $b)
2642
+	{
2643
+		if ($a['order'] == $b['order']) {
2644
+			return 0;
2645
+		}
2646
+		return ($a['order'] < $b['order']) ? -1 : 1;
2647
+	}
2648
+
2649
+
2650
+
2651
+	/**
2652
+	 *    generates HTML for the forms used on admin pages
2653
+	 *
2654
+	 * @access protected
2655
+	 * @param    array $input_vars - array of input field details
2656
+	 * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to use)
2657
+	 * @return string
2658
+	 * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
2659
+	 * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
2660
+	 */
2661
+	protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
2662
+	{
2663
+		$content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
2664
+		return $content;
2665
+	}
2666
+
2667
+
2668
+
2669
+	/**
2670
+	 * generates the "Save" and "Save & Close" buttons for edit forms
2671
+	 *
2672
+	 * @access protected
2673
+	 * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save & Close" button.
2674
+	 * @param array            $text     if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
2675
+	 * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e. via the "name" value in the button).  We can also use this to just dump default actions by submitting some other value.
2676
+	 * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it will use the $referrer string. IF null, then we don't do ANYTHING on save and close (normal form handling).
2677
+	 */
2678
+	protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
2679
+	{
2680
+		//make sure $text and $actions are in an array
2681
+		$text = (array)$text;
2682
+		$actions = (array)$actions;
2683
+		$referrer_url = empty($referrer) ? '' : $referrer;
2684
+		$referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
2685
+				: '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
2686
+		$button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
2687
+		$default_names = array('save', 'save_and_close');
2688
+		//add in a hidden index for the current page (so save and close redirects properly)
2689
+		$this->_template_args['save_buttons'] = $referrer_url;
2690
+		foreach ($button_text as $key => $button) {
2691
+			$ref = $default_names[$key];
2692
+			$id = $this->_current_view . '_' . $ref;
2693
+			$name = ! empty($actions) ? $actions[$key] : $ref;
2694
+			$this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
2695
+			if ( ! $both) {
2696
+				break;
2697
+			}
2698
+		}
2699
+	}
2700
+
2701
+
2702
+
2703
+	/**
2704
+	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
2705
+	 *
2706
+	 * @see   $this->_set_add_edit_form_tags() for details on params
2707
+	 * @since 4.6.0
2708
+	 * @param string $route
2709
+	 * @param array  $additional_hidden_fields
2710
+	 */
2711
+	public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
2712
+	{
2713
+		$this->_set_add_edit_form_tags($route, $additional_hidden_fields);
2714
+	}
2715
+
2716
+
2717
+
2718
+	/**
2719
+	 * set form open and close tags on add/edit pages.
2720
+	 *
2721
+	 * @access protected
2722
+	 * @param string $route                    the route you want the form to direct to
2723
+	 * @param array  $additional_hidden_fields any additional hidden fields required in the form header
2724
+	 * @return void
2725
+	 */
2726
+	protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
2727
+	{
2728
+		if (empty($route)) {
2729
+			$user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
2730
+			$dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
2731
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
2732
+		}
2733
+		// open form
2734
+		$this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
2735
+		// add nonce
2736
+		$nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
2737
+		//		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
2738
+		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
2739
+		// add REQUIRED form action
2740
+		$hidden_fields = array(
2741
+				'action' => array('type' => 'hidden', 'value' => $route),
2742
+		);
2743
+		// merge arrays
2744
+		$hidden_fields = is_array($additional_hidden_fields) ? array_merge($hidden_fields, $additional_hidden_fields) : $hidden_fields;
2745
+		// generate form fields
2746
+		$form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
2747
+		// add fields to form
2748
+		foreach ((array)$form_fields as $field_name => $form_field) {
2749
+			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
2750
+		}
2751
+		// close form
2752
+		$this->_template_args['after_admin_page_content'] = '</form>';
2753
+	}
2754
+
2755
+
2756
+
2757
+	/**
2758
+	 * Public Wrapper for _redirect_after_action() method since its
2759
+	 * discovered it would be useful for external code to have access.
2760
+	 *
2761
+	 * @see   EE_Admin_Page::_redirect_after_action() for params.
2762
+	 * @since 4.5.0
2763
+	 */
2764
+	public function redirect_after_action($success = false, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
2765
+	{
2766
+		$this->_redirect_after_action($success, $what, $action_desc, $query_args, $override_overwrite);
2767
+	}
2768
+
2769
+
2770
+
2771
+	/**
2772
+	 *    _redirect_after_action
2773
+	 *
2774
+	 * @param int    $success            - whether success was for two or more records, or just one, or none
2775
+	 * @param string $what               - what the action was performed on
2776
+	 * @param string $action_desc        - what was done ie: updated, deleted, etc
2777
+	 * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin action is completed
2778
+	 * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
2779
+	 * @access protected
2780
+	 * @return void
2781
+	 */
2782
+	protected function _redirect_after_action($success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
2783
+	{
2784
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2785
+		//class name for actions/filters.
2786
+		$classname = get_class($this);
2787
+		//set redirect url. Note if there is a "page" index in the $query_args then we go with vanilla admin.php route, otherwise we go with whatever is set as the _admin_base_url
2788
+		$redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
2789
+		$notices = EE_Error::get_notices(false);
2790
+		// overwrite default success messages //BUT ONLY if overwrite not overridden
2791
+		if ( ! $override_overwrite || ! empty($notices['errors'])) {
2792
+			EE_Error::overwrite_success();
2793
+		}
2794
+		if ( ! empty($what) && ! empty($action_desc)) {
2795
+			// how many records affected ? more than one record ? or just one ?
2796
+			if ($success > 1 && empty($notices['errors'])) {
2797
+				// set plural msg
2798
+				EE_Error::add_success(
2799
+						sprintf(
2800
+								__('The "%s" have been successfully %s.', 'event_espresso'),
2801
+								$what,
2802
+								$action_desc
2803
+						),
2804
+						__FILE__, __FUNCTION__, __LINE__
2805
+				);
2806
+			} else if ($success == 1 && empty($notices['errors'])) {
2807
+				// set singular msg
2808
+				EE_Error::add_success(
2809
+						sprintf(
2810
+								__('The "%s" has been successfully %s.', 'event_espresso'),
2811
+								$what,
2812
+								$action_desc
2813
+						),
2814
+						__FILE__, __FUNCTION__, __LINE__
2815
+				);
2816
+			}
2817
+		}
2818
+		// check that $query_args isn't something crazy
2819
+		if ( ! is_array($query_args)) {
2820
+			$query_args = array();
2821
+		}
2822
+		/**
2823
+		 * Allow injecting actions before the query_args are modified for possible different
2824
+		 * redirections on save and close actions
2825
+		 *
2826
+		 * @since 4.2.0
2827
+		 * @param array $query_args       The original query_args array coming into the
2828
+		 *                                method.
2829
+		 */
2830
+		do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
2831
+		//calculate where we're going (if we have a "save and close" button pushed)
2832
+		if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
2833
+			// even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
2834
+			$parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
2835
+			// regenerate query args array from referrer URL
2836
+			parse_str($parsed_url['query'], $query_args);
2837
+			// correct page and action will be in the query args now
2838
+			$redirect_url = admin_url('admin.php');
2839
+		}
2840
+		//merge any default query_args set in _default_route_query_args property
2841
+		if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
2842
+			$args_to_merge = array();
2843
+			foreach ($this->_default_route_query_args as $query_param => $query_value) {
2844
+				//is there a wp_referer array in our _default_route_query_args property?
2845
+				if ($query_param == 'wp_referer') {
2846
+					$query_value = (array)$query_value;
2847
+					foreach ($query_value as $reference => $value) {
2848
+						if (strpos($reference, 'nonce') !== false) {
2849
+							continue;
2850
+						}
2851
+						//finally we will override any arguments in the referer with
2852
+						//what might be set on the _default_route_query_args array.
2853
+						if (isset($this->_default_route_query_args[$reference])) {
2854
+							$args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
2855
+						} else {
2856
+							$args_to_merge[$reference] = urlencode($value);
2857
+						}
2858
+					}
2859
+					continue;
2860
+				}
2861
+				$args_to_merge[$query_param] = $query_value;
2862
+			}
2863
+			//now let's merge these arguments but override with what was specifically sent in to the
2864
+			//redirect.
2865
+			$query_args = array_merge($args_to_merge, $query_args);
2866
+		}
2867
+		$this->_process_notices($query_args);
2868
+		// generate redirect url
2869
+		// if redirecting to anything other than the main page, add a nonce
2870
+		if (isset($query_args['action'])) {
2871
+			// manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
2872
+			$query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
2873
+		}
2874
+		//we're adding some hooks and filters in here for processing any things just before redirects (example: an admin page has done an insert or update and we want to run something after that).
2875
+		do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
2876
+		$redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
2877
+		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
2878
+		if (defined('DOING_AJAX')) {
2879
+			$default_data = array(
2880
+					'close'        => true,
2881
+					'redirect_url' => $redirect_url,
2882
+					'where'        => 'main',
2883
+					'what'         => 'append',
2884
+			);
2885
+			$this->_template_args['success'] = $success;
2886
+			$this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data']) : $default_data;
2887
+			$this->_return_json();
2888
+		}
2889
+		wp_safe_redirect($redirect_url);
2890
+		exit();
2891
+	}
2892
+
2893
+
2894
+
2895
+	/**
2896
+	 * process any notices before redirecting (or returning ajax request)
2897
+	 * This method sets the $this->_template_args['notices'] attribute;
2898
+	 *
2899
+	 * @param  array $query_args        any query args that need to be used for notice transient ('action')
2900
+	 * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
2901
+	 * @param bool   $sticky_notices    This is used to flag that regardless of whether this is doing_ajax or not, we still save a transient for the notice.
2902
+	 * @return void
2903
+	 */
2904
+	protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
2905
+	{
2906
+		//first let's set individual error properties if doing_ajax and the properties aren't already set.
2907
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2908
+			$notices = EE_Error::get_notices(false);
2909
+			if (empty($this->_template_args['success'])) {
2910
+				$this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
2911
+			}
2912
+			if (empty($this->_template_args['errors'])) {
2913
+				$this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
2914
+			}
2915
+			if (empty($this->_template_args['attention'])) {
2916
+				$this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
2917
+			}
2918
+		}
2919
+		$this->_template_args['notices'] = EE_Error::get_notices();
2920
+		//IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
2921
+		if ( ! defined('DOING_AJAX') || $sticky_notices) {
2922
+			$route = isset($query_args['action']) ? $query_args['action'] : 'default';
2923
+			$this->_add_transient($route, $this->_template_args['notices'], true, $skip_route_verify);
2924
+		}
2925
+	}
2926
+
2927
+
2928
+
2929
+	/**
2930
+	 * get_action_link_or_button
2931
+	 * returns the button html for adding, editing, or deleting an item (depending on given type)
2932
+	 *
2933
+	 * @param string $action        use this to indicate which action the url is generated with.
2934
+	 * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key) property.
2935
+	 * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
2936
+	 * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
2937
+	 * @param string $base_url      If this is not provided
2938
+	 *                              the _admin_base_url will be used as the default for the button base_url.
2939
+	 *                              Otherwise this value will be used.
2940
+	 * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
2941
+	 * @return string
2942
+	 * @throws \EE_Error
2943
+	 */
2944
+	public function get_action_link_or_button(
2945
+			$action,
2946
+			$type = 'add',
2947
+			$extra_request = array(),
2948
+			$class = 'button-primary',
2949
+			$base_url = '',
2950
+			$exclude_nonce = false
2951
+	) {
2952
+		//first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
2953
+		if (empty($base_url) && ! isset($this->_page_routes[$action])) {
2954
+			throw new EE_Error(
2955
+					sprintf(
2956
+							__(
2957
+									'There is no page route for given action for the button.  This action was given: %s',
2958
+									'event_espresso'
2959
+							),
2960
+							$action
2961
+					)
2962
+			);
2963
+		}
2964
+		if ( ! isset($this->_labels['buttons'][$type])) {
2965
+			throw new EE_Error(
2966
+					sprintf(
2967
+							__(
2968
+									'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
2969
+									'event_espresso'
2970
+							),
2971
+							$type
2972
+					)
2973
+			);
2974
+		}
2975
+		//finally check user access for this button.
2976
+		$has_access = $this->check_user_access($action, true);
2977
+		if ( ! $has_access) {
2978
+			return '';
2979
+		}
2980
+		$_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
2981
+		$query_args = array(
2982
+				'action' => $action,
2983
+		);
2984
+		//merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
2985
+		if ( ! empty($extra_request)) {
2986
+			$query_args = array_merge($extra_request, $query_args);
2987
+		}
2988
+		$url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
2989
+		return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
2990
+	}
2991
+
2992
+
2993
+
2994
+	/**
2995
+	 * _per_page_screen_option
2996
+	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
2997
+	 *
2998
+	 * @return void
2999
+	 */
3000
+	protected function _per_page_screen_option()
3001
+	{
3002
+		$option = 'per_page';
3003
+		$args = array(
3004
+				'label'   => $this->_admin_page_title,
3005
+				'default' => 10,
3006
+				'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
3007
+		);
3008
+		//ONLY add the screen option if the user has access to it.
3009
+		if ($this->check_user_access($this->_current_view, true)) {
3010
+			add_screen_option($option, $args);
3011
+		}
3012
+	}
3013
+
3014
+
3015
+
3016
+	/**
3017
+	 * set_per_page_screen_option
3018
+	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
3019
+	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
3020
+	 *
3021
+	 * @access private
3022
+	 * @return void
3023
+	 */
3024
+	private function _set_per_page_screen_options()
3025
+	{
3026
+		if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
3027
+			check_admin_referer('screen-options-nonce', 'screenoptionnonce');
3028
+			if ( ! $user = wp_get_current_user()) {
3029
+				return;
3030
+			}
3031
+			$option = $_POST['wp_screen_options']['option'];
3032
+			$value = $_POST['wp_screen_options']['value'];
3033
+			if ($option != sanitize_key($option)) {
3034
+				return;
3035
+			}
3036
+			$map_option = $option;
3037
+			$option = str_replace('-', '_', $option);
3038
+			switch ($map_option) {
3039
+				case $this->_current_page . '_' . $this->_current_view . '_per_page':
3040
+					$value = (int)$value;
3041
+					if ($value < 1 || $value > 999) {
3042
+						return;
3043
+					}
3044
+					break;
3045
+				default:
3046
+					$value = apply_filters('FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value);
3047
+					if (false === $value) {
3048
+						return;
3049
+					}
3050
+					break;
3051
+			}
3052
+			update_user_meta($user->ID, $option, $value);
3053
+			wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
3054
+			exit;
3055
+		}
3056
+	}
3057
+
3058
+
3059
+
3060
+	/**
3061
+	 * This just allows for setting the $_template_args property if it needs to be set outside the object
3062
+	 *
3063
+	 * @param array $data array that will be assigned to template args.
3064
+	 */
3065
+	public function set_template_args($data)
3066
+	{
3067
+		$this->_template_args = array_merge($this->_template_args, (array)$data);
3068
+	}
3069
+
3070
+
3071
+
3072
+	/**
3073
+	 * This makes available the WP transient system for temporarily moving data between routes
3074
+	 *
3075
+	 * @access protected
3076
+	 * @param string $route             the route that should receive the transient
3077
+	 * @param array  $data              the data that gets sent
3078
+	 * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
3079
+	 * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used when we are adding a transient before page_routes have been defined.
3080
+	 * @return void
3081
+	 */
3082
+	protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
3083
+	{
3084
+		$user_id = get_current_user_id();
3085
+		if ( ! $skip_route_verify) {
3086
+			$this->_verify_route($route);
3087
+		}
3088
+		//now let's set the string for what kind of transient we're setting
3089
+		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
3090
+		$data = $notices ? array('notices' => $data) : $data;
3091
+		//is there already a transient for this route?  If there is then let's ADD to that transient
3092
+		$existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
3093
+		if ($existing) {
3094
+			$data = array_merge((array)$data, (array)$existing);
3095
+		}
3096
+		if (is_multisite() && is_network_admin()) {
3097
+			set_site_transient($transient, $data, 8);
3098
+		} else {
3099
+			set_transient($transient, $data, 8);
3100
+		}
3101
+	}
3102
+
3103
+
3104
+
3105
+	/**
3106
+	 * this retrieves the temporary transient that has been set for moving data between routes.
3107
+	 *
3108
+	 * @param bool $notices true we get notices transient. False we just return normal route transient
3109
+	 * @return mixed data
3110
+	 */
3111
+	protected function _get_transient($notices = false, $route = false)
3112
+	{
3113
+		$user_id = get_current_user_id();
3114
+		$route = ! $route ? $this->_req_action : $route;
3115
+		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
3116
+		$data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
3117
+		//delete transient after retrieval (just in case it hasn't expired);
3118
+		if (is_multisite() && is_network_admin()) {
3119
+			delete_site_transient($transient);
3120
+		} else {
3121
+			delete_transient($transient);
3122
+		}
3123
+		return $notices && isset($data['notices']) ? $data['notices'] : $data;
3124
+	}
3125
+
3126
+
3127
+
3128
+	/**
3129
+	 * The purpose of this method is just to run garbage collection on any EE transients that might have expired but would not be called later.
3130
+	 * This will be assigned to run on a specific EE Admin page. (place the method in the default route callback on the EE_Admin page you want it run.)
3131
+	 *
3132
+	 * @return void
3133
+	 */
3134
+	protected function _transient_garbage_collection()
3135
+	{
3136
+		global $wpdb;
3137
+		//retrieve all existing transients
3138
+		$query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
3139
+		if ($results = $wpdb->get_results($query)) {
3140
+			foreach ($results as $result) {
3141
+				$transient = str_replace('_transient_', '', $result->option_name);
3142
+				get_transient($transient);
3143
+				if (is_multisite() && is_network_admin()) {
3144
+					get_site_transient($transient);
3145
+				}
3146
+			}
3147
+		}
3148
+	}
3149
+
3150
+
3151
+
3152
+	/**
3153
+	 * get_view
3154
+	 *
3155
+	 * @access public
3156
+	 * @return string content of _view property
3157
+	 */
3158
+	public function get_view()
3159
+	{
3160
+		return $this->_view;
3161
+	}
3162
+
3163
+
3164
+
3165
+	/**
3166
+	 * getter for the protected $_views property
3167
+	 *
3168
+	 * @return array
3169
+	 */
3170
+	public function get_views()
3171
+	{
3172
+		return $this->_views;
3173
+	}
3174
+
3175
+
3176
+
3177
+	/**
3178
+	 * get_current_page
3179
+	 *
3180
+	 * @access public
3181
+	 * @return string _current_page property value
3182
+	 */
3183
+	public function get_current_page()
3184
+	{
3185
+		return $this->_current_page;
3186
+	}
3187
+
3188
+
3189
+
3190
+	/**
3191
+	 * get_current_view
3192
+	 *
3193
+	 * @access public
3194
+	 * @return string _current_view property value
3195
+	 */
3196
+	public function get_current_view()
3197
+	{
3198
+		return $this->_current_view;
3199
+	}
3200
+
3201
+
3202
+
3203
+	/**
3204
+	 * get_current_screen
3205
+	 *
3206
+	 * @access public
3207
+	 * @return object The current WP_Screen object
3208
+	 */
3209
+	public function get_current_screen()
3210
+	{
3211
+		return $this->_current_screen;
3212
+	}
3213
+
3214
+
3215
+
3216
+	/**
3217
+	 * get_current_page_view_url
3218
+	 *
3219
+	 * @access public
3220
+	 * @return string This returns the url for the current_page_view.
3221
+	 */
3222
+	public function get_current_page_view_url()
3223
+	{
3224
+		return $this->_current_page_view_url;
3225
+	}
3226
+
3227
+
3228
+
3229
+	/**
3230
+	 * just returns the _req_data property
3231
+	 *
3232
+	 * @return array
3233
+	 */
3234
+	public function get_request_data()
3235
+	{
3236
+		return $this->_req_data;
3237
+	}
3238
+
3239
+
3240
+
3241
+	/**
3242
+	 * returns the _req_data protected property
3243
+	 *
3244
+	 * @return string
3245
+	 */
3246
+	public function get_req_action()
3247
+	{
3248
+		return $this->_req_action;
3249
+	}
3250
+
3251
+
3252
+
3253
+	/**
3254
+	 * @return bool  value of $_is_caf property
3255
+	 */
3256
+	public function is_caf()
3257
+	{
3258
+		return $this->_is_caf;
3259
+	}
3260
+
3261
+
3262
+
3263
+	/**
3264
+	 * @return mixed
3265
+	 */
3266
+	public function default_espresso_metaboxes()
3267
+	{
3268
+		return $this->_default_espresso_metaboxes;
3269
+	}
3270
+
3271
+
3272
+
3273
+	/**
3274
+	 * @return mixed
3275
+	 */
3276
+	public function admin_base_url()
3277
+	{
3278
+		return $this->_admin_base_url;
3279
+	}
3280
+
3281
+
3282
+
3283
+	/**
3284
+	 * @return mixed
3285
+	 */
3286
+	public function wp_page_slug()
3287
+	{
3288
+		return $this->_wp_page_slug;
3289
+	}
3290
+
3291
+
3292
+
3293
+	/**
3294
+	 * updates  espresso configuration settings
3295
+	 *
3296
+	 * @access    protected
3297
+	 * @param string                   $tab
3298
+	 * @param EE_Config_Base|EE_Config $config
3299
+	 * @param string                   $file file where error occurred
3300
+	 * @param string                   $func function  where error occurred
3301
+	 * @param string                   $line line no where error occurred
3302
+	 * @return boolean
3303
+	 */
3304
+	protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
3305
+	{
3306
+		//remove any options that are NOT going to be saved with the config settings.
3307
+		if (isset($config->core->ee_ueip_optin)) {
3308
+			$config->core->ee_ueip_has_notified = true;
3309
+			// TODO: remove the following two lines and make sure values are migrated from 3.1
3310
+			update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
3311
+			update_option('ee_ueip_has_notified', true);
3312
+		}
3313
+		// and save it (note we're also doing the network save here)
3314
+		$net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
3315
+		$config_saved = EE_Config::instance()->update_espresso_config(false, false);
3316
+		if ($config_saved && $net_saved) {
3317
+			EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
3318
+			return true;
3319
+		} else {
3320
+			EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
3321
+			return false;
3322
+		}
3323
+	}
3324
+
3325
+
3326
+
3327
+	/**
3328
+	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
3329
+	 *
3330
+	 * @return array
3331
+	 */
3332
+	public function get_yes_no_values()
3333
+	{
3334
+		return $this->_yes_no_values;
3335
+	}
3336
+
3337
+
3338
+
3339
+	protected function _get_dir()
3340
+	{
3341
+		$reflector = new ReflectionClass(get_class($this));
3342
+		return dirname($reflector->getFileName());
3343
+	}
3344
+
3345
+
3346
+
3347
+	/**
3348
+	 * A helper for getting a "next link".
3349
+	 *
3350
+	 * @param string $url   The url to link to
3351
+	 * @param string $class The class to use.
3352
+	 * @return string
3353
+	 */
3354
+	protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
3355
+	{
3356
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
3357
+	}
3358
+
3359
+
3360
+
3361
+	/**
3362
+	 * A helper for getting a "previous link".
3363
+	 *
3364
+	 * @param string $url   The url to link to
3365
+	 * @param string $class The class to use.
3366
+	 * @return string
3367
+	 */
3368
+	protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
3369
+	{
3370
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
3371
+	}
3372
+
3373
+
3374
+
3375
+
3376
+
3377
+
3378
+
3379
+	//below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
3380
+	/**
3381
+	 * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the _req_data
3382
+	 * array.
3383
+	 *
3384
+	 * @return bool success/fail
3385
+	 */
3386
+	protected function _process_resend_registration()
3387
+	{
3388
+		$this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
3389
+		do_action('AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data);
3390
+		return $this->_template_args['success'];
3391
+	}
3392
+
3393
+
3394
+
3395
+	/**
3396
+	 * This automatically processes any payment message notifications when manual payment has been applied.
3397
+	 *
3398
+	 * @access protected
3399
+	 * @param \EE_Payment $payment
3400
+	 * @return bool success/fail
3401
+	 */
3402
+	protected function _process_payment_notification(EE_Payment $payment)
3403
+	{
3404
+		add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
3405
+		do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
3406
+		$this->_template_args['success'] = apply_filters('FHEE__EE_Admin_Page___process_admin_payment_notification__success', false, $payment);
3407
+		return $this->_template_args['success'];
3408
+	}
3409 3409
 
3410 3410
 
3411 3411
 }
Please login to merge, or discard this patch.
shortcodes/espresso_events/EES_Espresso_Events.shortcode.php 1 patch
Indentation   +18 added lines, -18 removed lines patch added patch discarded remove patch
@@ -10,15 +10,15 @@  discard block
 block discarded – undo
10 10
 class EES_Espresso_Events  extends EES_Shortcode {
11 11
 
12 12
 	/**
13
-     * @deprecated 4.9.27
14
-     *  @return 	void
13
+	 * @deprecated 4.9.27
14
+	 *  @return 	void
15 15
 	 */
16 16
 	public static function set_hooks() {
17 17
 	}
18 18
 
19 19
 	/**
20
-     * @deprecated 4.9.27
21
-     *  @return 	void
20
+	 * @deprecated 4.9.27
21
+	 *  @return 	void
22 22
 	 */
23 23
 	public static function set_hooks_admin() {
24 24
 	}
@@ -26,8 +26,8 @@  discard block
 block discarded – undo
26 26
 
27 27
 
28 28
 	/**
29
-     * @deprecated 4.9.27
30
-     * @param WP $WP
29
+	 * @deprecated 4.9.27
30
+	 * @param WP $WP
31 31
 	 * @return    void
32 32
 	 */
33 33
 	public function run( WP $WP ) {
@@ -36,21 +36,21 @@  discard block
 block discarded – undo
36 36
 
37 37
 
38 38
 	/**
39
-     * @deprecated 4.9.27
40
-     *  @param 	array 	$attributes
39
+	 * @deprecated 4.9.27
40
+	 *  @param 	array 	$attributes
41 41
 	 *  @return 	string
42 42
 	 */
43 43
 	public function process_shortcode( $attributes = array() ) {
44
-        \EE_Error::doing_it_wrong(
45
-            __METHOD__,
46
-            __(
47
-                'Usage is deprecated. Please use \EventEspresso\core\domain\entities\shortcodes\EspressoEvents instead.',
48
-                'event_espresso'
49
-            ),
50
-            '4.9.27'
51
-        );
52
-        return '';
53
-    }
44
+		\EE_Error::doing_it_wrong(
45
+			__METHOD__,
46
+			__(
47
+				'Usage is deprecated. Please use \EventEspresso\core\domain\entities\shortcodes\EspressoEvents instead.',
48
+				'event_espresso'
49
+			),
50
+			'4.9.27'
51
+		);
52
+		return '';
53
+	}
54 54
 
55 55
 
56 56
 
Please login to merge, or discard this patch.
admin_pages/about/templates/credits.template.php 1 patch
Spacing   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -3,7 +3,7 @@  discard block
 block discarded – undo
3 3
 <ul class="wp-people-group" id="ee-people-group-owners">
4 4
 	<li class="wp-person" id="ee-person-sshoultes">
5 5
 		<a href="<?php esp_gravatar_profile('[email protected]'); ?>">
6
-			<?php echo esp_gravatar_image( '[email protected]', 'Seth Shoultes' ); ?>
6
+			<?php echo esp_gravatar_image('[email protected]', 'Seth Shoultes'); ?>
7 7
 		</a>
8 8
 		<a class="web" href="<?php esp_gravatar_profile('[email protected]'); ?>">
9 9
 			Seth Shoultes
@@ -12,7 +12,7 @@  discard block
 block discarded – undo
12 12
 	</li>
13 13
 	<li class="wp-person" id="ee-person-gkoyle">
14 14
 		<a href="<?php esp_gravatar_profile('[email protected]'); ?>">
15
-			<?php echo esp_gravatar_image( '[email protected]', 'Garth Koyle' ); ?>
15
+			<?php echo esp_gravatar_image('[email protected]', 'Garth Koyle'); ?>
16 16
 		</a>
17 17
 		<a class="web" href="<?php esp_gravatar_profile('[email protected]'); ?>">
18 18
 			Garth Koyle
@@ -24,7 +24,7 @@  discard block
 block discarded – undo
24 24
 <ul class="wp-people-group" id="ee-people-group-core-developers">
25 25
 	<li class="wp-person" id="ee-person-bchristensen">
26 26
 		<a href="<?php esp_gravatar_profile('[email protected]'); ?>">
27
-			<?php echo esp_gravatar_image( '[email protected]', 'Brent Christensen' ); ?>
27
+			<?php echo esp_gravatar_image('[email protected]', 'Brent Christensen'); ?>
28 28
 		</a>
29 29
 		<a class="web" href="<?php esp_gravatar_profile('[email protected]'); ?>">
30 30
 			Brent Christensen
@@ -33,7 +33,7 @@  discard block
 block discarded – undo
33 33
 	</li>
34 34
 	<li class="wp-person" id="ee-person-dethier">
35 35
 		<a href="<?php esp_gravatar_profile('[email protected]'); ?>">
36
-			<?php echo esp_gravatar_image( '[email protected]', 'Darren Ethier' ); ?>
36
+			<?php echo esp_gravatar_image('[email protected]', 'Darren Ethier'); ?>
37 37
 		</a>
38 38
 		<a class="web" href="<?php esp_gravatar_profile('[email protected]'); ?>">
39 39
 			Darren Ethier
@@ -42,7 +42,7 @@  discard block
 block discarded – undo
42 42
 	</li>
43 43
 	<li class="wp-person" id="ee-person-mnelson">
44 44
 		<a href="<?php esp_gravatar_profile('[email protected]'); ?>">
45
-			<?php echo esp_gravatar_image( '[email protected]', 'Michael Nelson' ); ?>
45
+			<?php echo esp_gravatar_image('[email protected]', 'Michael Nelson'); ?>
46 46
 		</a>
47 47
 		<a class="web" href="<?php esp_gravatar_profile('[email protected]'); ?>">
48 48
 			Michael Nelson
@@ -51,7 +51,7 @@  discard block
 block discarded – undo
51 51
 	</li>
52 52
 	<li class="wp-person" id="ee-person-nkolivoshka">
53 53
 		<a href="<?php esp_gravatar_profile('[email protected]'); ?>">
54
-			<?php echo esp_gravatar_image( '[email protected]', 'Nazar Kolivoshka' ); ?>
54
+			<?php echo esp_gravatar_image('[email protected]', 'Nazar Kolivoshka'); ?>
55 55
 		</a>
56 56
 		<a class="web" href="<?php esp_gravatar_profile('[email protected]'); ?>">
57 57
 			Nazar Kolivoshka
@@ -63,7 +63,7 @@  discard block
 block discarded – undo
63 63
 <ul class="wp-people-group" id="ee-people-group-support-staff">
64 64
 	<li class="wp-person" id="ee-person-jfeck">
65 65
 		<a href="<?php esp_gravatar_profile('[email protected]'); ?>">
66
-			<?php echo esp_gravatar_image( '[email protected]', 'Josh Feck' ); ?>
66
+			<?php echo esp_gravatar_image('[email protected]', 'Josh Feck'); ?>
67 67
 		</a>
68 68
 		<a class="web" href="<?php esp_gravatar_profile('[email protected]'); ?>">
69 69
 			Josh Feck
@@ -71,7 +71,7 @@  discard block
 block discarded – undo
71 71
 	</li>
72 72
 	<li class="wp-person" id="ee-person-twarwick">
73 73
 		<a href="<?php esp_gravatar_profile('[email protected]'); ?>">
74
-			<?php echo esp_gravatar_image( '[email protected]', 'Tony Warwick' ); ?>
74
+			<?php echo esp_gravatar_image('[email protected]', 'Tony Warwick'); ?>
75 75
 		</a>
76 76
 		<a class="web" href="<?php esp_gravatar_profile('[email protected]'); ?>">
77 77
 			Tony Warwick
@@ -79,7 +79,7 @@  discard block
 block discarded – undo
79 79
 	</li>
80 80
 	<li class="wp-person" id="ee-person-lcaum">
81 81
 		<a href="<?php esp_gravatar_profile('[email protected]'); ?>">
82
-			<?php echo esp_gravatar_image( '[email protected]', 'Lorenzo Caum' ); ?>
82
+			<?php echo esp_gravatar_image('[email protected]', 'Lorenzo Caum'); ?>
83 83
 		</a>
84 84
 		<a class="web" href="<?php esp_gravatar_profile('[email protected]'); ?>">
85 85
 			Lorenzo Caum
@@ -87,7 +87,7 @@  discard block
 block discarded – undo
87 87
 	</li>
88 88
 	<li class="wp-person" id="ee-logan-lenz">
89 89
 		<a href="<?php esp_gravatar_profile('[email protected]'); ?>">
90
-			<?php echo esp_gravatar_image( '[email protected]', 'Logan Lenz' ); ?>
90
+			<?php echo esp_gravatar_image('[email protected]', 'Logan Lenz'); ?>
91 91
 		</a>
92 92
 		<a class="web" href="<?php esp_gravatar_profile('[email protected]'); ?>">
93 93
 			Logan Lenz
@@ -97,7 +97,7 @@  discard block
 block discarded – undo
97 97
 </ul>
98 98
 <h3 class="wp-people-group"><?php _e('Contributor Recognition', 'event_espresso'); ?></h3>
99 99
 <p class="description">
100
-	<?php printf( __('For every major release we want to recognize the people who contributed to the release via a GitHub pull request. Want to see your name listed here? %sWhen you submit a pull request that gets included in a major release%s, we\'ll add your name here linked to your GitHub profile.', 'event_espresso'), '<a href="https://github.com/eventespresso/event-espresso-core" title="Contribute to Event Espresso by making a pull request via GitHub">', '</a>' ); ?>
100
+	<?php printf(__('For every major release we want to recognize the people who contributed to the release via a GitHub pull request. Want to see your name listed here? %sWhen you submit a pull request that gets included in a major release%s, we\'ll add your name here linked to your GitHub profile.', 'event_espresso'), '<a href="https://github.com/eventespresso/event-espresso-core" title="Contribute to Event Espresso by making a pull request via GitHub">', '</a>'); ?>
101 101
 </p>
102 102
 <p class="wp-credits-list">
103 103
 	<ul>
@@ -111,7 +111,7 @@  discard block
 block discarded – undo
111 111
 </p>
112 112
 <h3 class="wp-people-group"><?php _e('External Libraries', 'event_espresso'); ?></h3>
113 113
 <p class="description">
114
-	<?php printf( __('Along with the libraries %sincluded with WordPress%s, Event Espresso utilizes the following third party libraries:', 'event_espresso'), '<a href="credits.php">', '</a>' ); ?>
114
+	<?php printf(__('Along with the libraries %sincluded with WordPress%s, Event Espresso utilizes the following third party libraries:', 'event_espresso'), '<a href="credits.php">', '</a>'); ?>
115 115
 </p>
116 116
 <p class="wp-credits-list">
117 117
 	<a href="http://josscrowcroft.github.io/accounting.js/"><?php _e('accounting.js', 'event_espresso'); ?></a>,
@@ -127,10 +127,10 @@  discard block
 block discarded – undo
127 127
 
128 128
 <?php
129 129
 	function esp_gravatar_profile($email) {
130
-		echo 'http://www.gravatar.com/' . md5($email);
130
+		echo 'http://www.gravatar.com/'.md5($email);
131 131
 	}
132 132
 
133 133
 	function esp_gravatar_image($email, $name) {
134
-		echo '<img src="http://0.gravatar.com/avatar/' . md5($email) . '?s=60" class="gravatar" alt="' . $name . '"/>';
134
+		echo '<img src="http://0.gravatar.com/avatar/'.md5($email).'?s=60" class="gravatar" alt="'.$name.'"/>';
135 135
 	}
136 136
 ?>
Please login to merge, or discard this patch.
acceptance_tests/tests/b-TestRegistrationSummaryCept.php 1 patch
Indentation   +41 added lines, -41 removed lines patch added patch discarded remove patch
@@ -14,8 +14,8 @@  discard block
 block discarded – undo
14 14
 
15 15
 //need the MER plugin active for this test (we'll deactivate it after).
16 16
 $I->ensurePluginActive(
17
-    'event-espresso-mer-multi-event-registration',
18
-    'activated'
17
+	'event-espresso-mer-multi-event-registration',
18
+	'activated'
19 19
 );
20 20
 
21 21
 //k now we need to make sure the registration multi-status message type is active because it isn't by default
@@ -76,38 +76,38 @@  discard block
 block discarded – undo
76 76
 $I->loginAsAdmin();
77 77
 $I->amOnMessagesActivityListTablePage();
78 78
 $I->see(
79
-    '[email protected]',
80
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
81
-        'to',
82
-        'Registration Multi-status Summary',
83
-        MessagesAdmin::MESSAGE_STATUS_SENT,
84
-        '',
85
-        'Primary Registrant'
86
-    )
79
+	'[email protected]',
80
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
81
+		'to',
82
+		'Registration Multi-status Summary',
83
+		MessagesAdmin::MESSAGE_STATUS_SENT,
84
+		'',
85
+		'Primary Registrant'
86
+	)
87 87
 );
88 88
 $I->see(
89
-    '[email protected]',
90
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
91
-        'to',
92
-        'Registration Multi-status Summary',
93
-        MessagesAdmin::MESSAGE_STATUS_SENT
94
-    )
89
+	'[email protected]',
90
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
91
+		'to',
92
+		'Registration Multi-status Summary',
93
+		MessagesAdmin::MESSAGE_STATUS_SENT
94
+	)
95 95
 );
96 96
 //verify count
97 97
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
98
-    1,
99
-    '[email protected]',
100
-    'to',
101
-    'Registration Multi-status Summary',
102
-    MessagesAdmin::MESSAGE_STATUS_SENT,
103
-    'Email',
104
-    'Primary Registrant'
98
+	1,
99
+	'[email protected]',
100
+	'to',
101
+	'Registration Multi-status Summary',
102
+	MessagesAdmin::MESSAGE_STATUS_SENT,
103
+	'Email',
104
+	'Primary Registrant'
105 105
 );
106 106
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
107
-    1,
108
-    '[email protected]',
109
-    'to',
110
-    'Registration Multi-status Summary'
107
+	1,
108
+	'[email protected]',
109
+	'to',
110
+	'Registration Multi-status Summary'
111 111
 );
112 112
 
113 113
 //okay now let's do some registrations for just the first event and verify that registration multi-status summary is NOT
@@ -137,25 +137,25 @@  discard block
 block discarded – undo
137 137
 $I->loginAsAdmin();
138 138
 $I->amOnMessagesActivityListTablePage();
139 139
 $I->dontSee(
140
-    '[email protected]',
141
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
142
-        'to',
143
-        'Registration Multi-status Summary',
144
-        MessagesAdmin::MESSAGE_STATUS_SENT,
145
-        '',
146
-        'Primary Registrant'
147
-    )
140
+	'[email protected]',
141
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
142
+		'to',
143
+		'Registration Multi-status Summary',
144
+		MessagesAdmin::MESSAGE_STATUS_SENT,
145
+		'',
146
+		'Primary Registrant'
147
+	)
148 148
 );
149 149
 //there should still only be one admin multi-status summary thing.
150 150
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
151
-    1,
152
-    '[email protected]',
153
-    'to',
154
-    'Registration Multi-status Summary'
151
+	1,
152
+	'[email protected]',
153
+	'to',
154
+	'Registration Multi-status Summary'
155 155
 );
156 156
 
157 157
 //deactivate MER plugin so its not active for future tests
158 158
 $I->ensurePluginDeactivated(
159
-    'event-espresso-mer-multi-event-registration',
160
-    'Plugin deactivated'
159
+	'event-espresso-mer-multi-event-registration',
160
+	'Plugin deactivated'
161 161
 );
162 162
\ No newline at end of file
Please login to merge, or discard this patch.
modules/messages/EED_Messages.module.php 1 patch
Indentation   +1071 added lines, -1071 removed lines patch added patch discarded remove patch
@@ -13,1086 +13,1086 @@
 block discarded – undo
13 13
 class EED_Messages extends EED_Module
14 14
 {
15 15
 
16
-    /**
17
-     * This holds the EE_messages controller
18
-     *
19
-     * @deprecated 4.9.0
20
-     * @var EE_messages $_EEMSG
21
-     */
22
-    protected static $_EEMSG;
23
-
24
-    /**
25
-     * @type EE_Message_Resource_Manager $_message_resource_manager
26
-     */
27
-    protected static $_message_resource_manager;
28
-
29
-    /**
30
-     * This holds the EE_Messages_Processor business class.
31
-     *
32
-     * @type EE_Messages_Processor
33
-     */
34
-    protected static $_MSG_PROCESSOR;
35
-
36
-    /**
37
-     * holds all the paths for various messages components.
38
-     * Utilized by autoloader registry
39
-     *
40
-     * @var array
41
-     */
42
-    protected static $_MSG_PATHS;
43
-
44
-
45
-    /**
46
-     * This will hold an array of messages template packs that are registered in the messages system.
47
-     * Format is:
48
-     * array(
49
-     *    'template_pack_dbref' => EE_Messages_Template_Pack (instance)
50
-     * )
51
-     *
52
-     * @var EE_Messages_Template_Pack[]
53
-     */
54
-    protected static $_TMP_PACKS = array();
55
-
56
-
57
-    /**
58
-     * @return EED_Messages
59
-     */
60
-    public static function instance()
61
-    {
62
-        return parent::get_instance(__CLASS__);
63
-    }
64
-
65
-
66
-    /**
67
-     *  set_hooks - for hooking into EE Core, other modules, etc
68
-     *
69
-     * @since 4.5.0
70
-     * @return    void
71
-     */
72
-    public static function set_hooks()
73
-    {
74
-        //actions
75
-        add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
76
-        add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
77
-            array('EED_Messages', 'maybe_registration'), 10, 2);
78
-        //filters
79
-        add_filter('FHEE__EE_Registration__receipt_url__receipt_url',
80
-            array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
81
-        add_filter('FHEE__EE_Registration__invoice_url__invoice_url',
82
-            array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
83
-        //register routes
84
-        self::_register_routes();
85
-    }
86
-
87
-    /**
88
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
89
-     *
90
-     * @access    public
91
-     * @return    void
92
-     */
93
-    public static function set_hooks_admin()
94
-    {
95
-        //actions
96
-        add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
97
-        add_action('AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
98
-            array('EED_Messages', 'payment_reminder'), 10);
99
-        add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
100
-            array('EED_Messages', 'maybe_registration'), 10, 3);
101
-        add_action('AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
102
-            array('EED_Messages', 'send_newsletter_message'), 10, 2);
103
-        add_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction',
104
-            array('EED_Messages', 'cancelled_registration'), 10);
105
-        add_action('AHEE__EE_Admin_Page___process_admin_payment_notification',
106
-            array('EED_Messages', 'process_admin_payment'), 10, 1);
107
-        //filters
108
-        add_filter('FHEE__EE_Admin_Page___process_resend_registration__success',
109
-            array('EED_Messages', 'process_resend'), 10, 2);
110
-        add_filter('FHEE__EE_Registration__receipt_url__receipt_url',
111
-            array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
112
-        add_filter('FHEE__EE_Registration__invoice_url__invoice_url',
113
-            array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
114
-    }
115
-
116
-
117
-    /**
118
-     * All the message triggers done by route go in here.
119
-     *
120
-     * @since 4.5.0
121
-     * @return void
122
-     */
123
-    protected static function _register_routes()
124
-    {
125
-        EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
126
-        EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
127
-        EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
128
-        EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
129
-        do_action('AHEE__EED_Messages___register_routes');
130
-    }
131
-
132
-
133
-    /**
134
-     * This is called when a browser display trigger is executed.
135
-     * The browser display trigger is typically used when a already generated message is displayed directly in the
136
-     * browser.
137
-     *
138
-     * @since 4.9.0
139
-     * @param WP $WP
140
-     */
141
-    public function browser_trigger($WP)
142
-    {
143
-        //ensure controller is loaded
144
-        self::_load_controller();
145
-        $token = EE_Registry::instance()->REQ->get('token');
146
-        try {
147
-            $mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
148
-            self::$_MSG_PROCESSOR->generate_and_send_now($mtg);
149
-        } catch (EE_Error $e) {
150
-            $error_msg = __('Please note that a system message failed to send due to a technical issue.',
151
-                'event_espresso');
152
-            // add specific message for developers if WP_DEBUG in on
153
-            $error_msg .= '||' . $e->getMessage();
154
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
155
-        }
156
-    }
157
-
158
-
159
-    /**
160
-     * This is called when a browser error trigger is executed.
161
-     * When triggered this will grab the EE_Message matching the token in the request and use that to get the error
162
-     * message and display it.
163
-     *
164
-     * @since 4.9.0
165
-     * @param $WP
166
-     */
167
-    public function browser_error_trigger($WP)
168
-    {
169
-        $token = EE_Registry::instance()->REQ->get('token');
170
-        if ($token) {
171
-            $message = EEM_Message::instance()->get_one_by_token($token);
172
-            if ($message instanceof EE_Message) {
173
-                header('HTTP/1.1 200 OK');
174
-                $error_msg = nl2br($message->error_message());
175
-                ?>
16
+	/**
17
+	 * This holds the EE_messages controller
18
+	 *
19
+	 * @deprecated 4.9.0
20
+	 * @var EE_messages $_EEMSG
21
+	 */
22
+	protected static $_EEMSG;
23
+
24
+	/**
25
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
26
+	 */
27
+	protected static $_message_resource_manager;
28
+
29
+	/**
30
+	 * This holds the EE_Messages_Processor business class.
31
+	 *
32
+	 * @type EE_Messages_Processor
33
+	 */
34
+	protected static $_MSG_PROCESSOR;
35
+
36
+	/**
37
+	 * holds all the paths for various messages components.
38
+	 * Utilized by autoloader registry
39
+	 *
40
+	 * @var array
41
+	 */
42
+	protected static $_MSG_PATHS;
43
+
44
+
45
+	/**
46
+	 * This will hold an array of messages template packs that are registered in the messages system.
47
+	 * Format is:
48
+	 * array(
49
+	 *    'template_pack_dbref' => EE_Messages_Template_Pack (instance)
50
+	 * )
51
+	 *
52
+	 * @var EE_Messages_Template_Pack[]
53
+	 */
54
+	protected static $_TMP_PACKS = array();
55
+
56
+
57
+	/**
58
+	 * @return EED_Messages
59
+	 */
60
+	public static function instance()
61
+	{
62
+		return parent::get_instance(__CLASS__);
63
+	}
64
+
65
+
66
+	/**
67
+	 *  set_hooks - for hooking into EE Core, other modules, etc
68
+	 *
69
+	 * @since 4.5.0
70
+	 * @return    void
71
+	 */
72
+	public static function set_hooks()
73
+	{
74
+		//actions
75
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
76
+		add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
77
+			array('EED_Messages', 'maybe_registration'), 10, 2);
78
+		//filters
79
+		add_filter('FHEE__EE_Registration__receipt_url__receipt_url',
80
+			array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
81
+		add_filter('FHEE__EE_Registration__invoice_url__invoice_url',
82
+			array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
83
+		//register routes
84
+		self::_register_routes();
85
+	}
86
+
87
+	/**
88
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
89
+	 *
90
+	 * @access    public
91
+	 * @return    void
92
+	 */
93
+	public static function set_hooks_admin()
94
+	{
95
+		//actions
96
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
97
+		add_action('AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
98
+			array('EED_Messages', 'payment_reminder'), 10);
99
+		add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
100
+			array('EED_Messages', 'maybe_registration'), 10, 3);
101
+		add_action('AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
102
+			array('EED_Messages', 'send_newsletter_message'), 10, 2);
103
+		add_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction',
104
+			array('EED_Messages', 'cancelled_registration'), 10);
105
+		add_action('AHEE__EE_Admin_Page___process_admin_payment_notification',
106
+			array('EED_Messages', 'process_admin_payment'), 10, 1);
107
+		//filters
108
+		add_filter('FHEE__EE_Admin_Page___process_resend_registration__success',
109
+			array('EED_Messages', 'process_resend'), 10, 2);
110
+		add_filter('FHEE__EE_Registration__receipt_url__receipt_url',
111
+			array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
112
+		add_filter('FHEE__EE_Registration__invoice_url__invoice_url',
113
+			array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
114
+	}
115
+
116
+
117
+	/**
118
+	 * All the message triggers done by route go in here.
119
+	 *
120
+	 * @since 4.5.0
121
+	 * @return void
122
+	 */
123
+	protected static function _register_routes()
124
+	{
125
+		EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
126
+		EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
127
+		EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
128
+		EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
129
+		do_action('AHEE__EED_Messages___register_routes');
130
+	}
131
+
132
+
133
+	/**
134
+	 * This is called when a browser display trigger is executed.
135
+	 * The browser display trigger is typically used when a already generated message is displayed directly in the
136
+	 * browser.
137
+	 *
138
+	 * @since 4.9.0
139
+	 * @param WP $WP
140
+	 */
141
+	public function browser_trigger($WP)
142
+	{
143
+		//ensure controller is loaded
144
+		self::_load_controller();
145
+		$token = EE_Registry::instance()->REQ->get('token');
146
+		try {
147
+			$mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
148
+			self::$_MSG_PROCESSOR->generate_and_send_now($mtg);
149
+		} catch (EE_Error $e) {
150
+			$error_msg = __('Please note that a system message failed to send due to a technical issue.',
151
+				'event_espresso');
152
+			// add specific message for developers if WP_DEBUG in on
153
+			$error_msg .= '||' . $e->getMessage();
154
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
155
+		}
156
+	}
157
+
158
+
159
+	/**
160
+	 * This is called when a browser error trigger is executed.
161
+	 * When triggered this will grab the EE_Message matching the token in the request and use that to get the error
162
+	 * message and display it.
163
+	 *
164
+	 * @since 4.9.0
165
+	 * @param $WP
166
+	 */
167
+	public function browser_error_trigger($WP)
168
+	{
169
+		$token = EE_Registry::instance()->REQ->get('token');
170
+		if ($token) {
171
+			$message = EEM_Message::instance()->get_one_by_token($token);
172
+			if ($message instanceof EE_Message) {
173
+				header('HTTP/1.1 200 OK');
174
+				$error_msg = nl2br($message->error_message());
175
+				?>
176 176
                 <!DOCTYPE html>
177 177
                 <html>
178 178
                 <head></head>
179 179
                 <body>
180 180
                 <?php echo empty($error_msg)
181
-                    ? esc_html__('Unfortunately, we were unable to capture the error message for this message.',
182
-                        'event_espresso')
183
-                    : wp_kses(
184
-                        $error_msg,
185
-                        array(
186
-                            'a'      => array(
187
-                                'href'  => array(),
188
-                                'title' => array(),
189
-                            ),
190
-                            'span'   => array(),
191
-                            'div'    => array(),
192
-                            'p'      => array(),
193
-                            'strong' => array(),
194
-                            'em'     => array(),
195
-                            'br'     => array(),
196
-                        )
197
-                    ); ?>
181
+					? esc_html__('Unfortunately, we were unable to capture the error message for this message.',
182
+						'event_espresso')
183
+					: wp_kses(
184
+						$error_msg,
185
+						array(
186
+							'a'      => array(
187
+								'href'  => array(),
188
+								'title' => array(),
189
+							),
190
+							'span'   => array(),
191
+							'div'    => array(),
192
+							'p'      => array(),
193
+							'strong' => array(),
194
+							'em'     => array(),
195
+							'br'     => array(),
196
+						)
197
+					); ?>
198 198
                 </body>
199 199
                 </html>
200 200
                 <?php
201
-                exit;
202
-            }
203
-        }
204
-        return;
205
-    }
206
-
207
-
208
-    /**
209
-     *  This runs when the msg_url_trigger route has initiated.
210
-     *
211
-     * @since 4.5.0
212
-     * @param WP $WP
213
-     * @throws EE_Error
214
-     * @return    void
215
-     */
216
-    public function run($WP)
217
-    {
218
-        //ensure controller is loaded
219
-        self::_load_controller();
220
-        // attempt to process message
221
-        try {
222
-            /** @type EE_Message_To_Generate_From_Request $message_to_generate */
223
-            $message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
224
-            self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
225
-        } catch (EE_Error $e) {
226
-            $error_msg = __('Please note that a system message failed to send due to a technical issue.',
227
-                'event_espresso');
228
-            // add specific message for developers if WP_DEBUG in on
229
-            $error_msg .= '||' . $e->getMessage();
230
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
231
-        }
232
-    }
233
-
234
-
235
-    /**
236
-     * This is triggered by the 'msg_cron_trigger' route.
237
-     *
238
-     * @param WP $WP
239
-     */
240
-    public function execute_batch_request($WP)
241
-    {
242
-        $this->run_cron();
243
-        header('HTTP/1.1 200 OK');
244
-        exit();
245
-    }
246
-
247
-
248
-    /**
249
-     * This gets executed on wp_cron jobs or when a batch request is initiated on its own separate non regular wp
250
-     * request.
251
-     */
252
-    public function run_cron()
253
-    {
254
-        self::_load_controller();
255
-        //get required vars
256
-        $cron_type     = EE_Registry::instance()->REQ->get('type');
257
-        $transient_key = EE_Registry::instance()->REQ->get('key');
258
-
259
-        //now let's verify transient, if not valid exit immediately
260
-        if (! get_transient($transient_key)) {
261
-            /**
262
-             * trigger error so this gets in the error logs.  This is important because it happens on a non-user request.
263
-             */
264
-            trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
265
-        }
266
-
267
-        //if made it here, lets' delete the transient to keep the db clean
268
-        delete_transient($transient_key);
269
-
270
-        if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
271
-
272
-            $method = 'batch_' . $cron_type . '_from_queue';
273
-            if (method_exists(self::$_MSG_PROCESSOR, $method)) {
274
-                self::$_MSG_PROCESSOR->$method();
275
-            } else {
276
-                //no matching task
277
-                /**
278
-                 * trigger error so this gets in the error logs.  This is important because it happens on a non user request.
279
-                 */
280
-                trigger_error(esc_attr(sprintf(__('There is no task corresponding to this route %s', 'event_espresso'),
281
-                    $cron_type)));
282
-            }
283
-        }
284
-
285
-        do_action('FHEE__EED_Messages__run_cron__end');
286
-    }
287
-
288
-
289
-    /**
290
-     * This is used to retrieve the template pack for the given name.
291
-     * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then
292
-     * the default template pack is returned.
293
-     *
294
-     * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
295
-     * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used
296
-     *                                   in generating the Pack class name).
297
-     * @return EE_Messages_Template_Pack
298
-     */
299
-    public static function get_template_pack($template_pack_name)
300
-    {
301
-        EE_Registry::instance()->load_helper('MSG_Template');
302
-        return EEH_MSG_Template::get_template_pack($template_pack_name);
303
-    }
304
-
305
-
306
-    /**
307
-     * Retrieves an array of all template packs.
308
-     * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
309
-     *
310
-     * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
311
-     * @return EE_Messages_Template_Pack[]
312
-     */
313
-    public static function get_template_packs()
314
-    {
315
-        EE_Registry::instance()->load_helper('MSG_Template');
316
-
317
-        //for backward compat, let's make sure this returns in the same format as originally.
318
-        $template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
319
-        $template_pack_collection->rewind();
320
-        $template_packs = array();
321
-        while ($template_pack_collection->valid()) {
322
-            $template_packs[$template_pack_collection->current()->dbref] = $template_pack_collection->current();
323
-            $template_pack_collection->next();
324
-        }
325
-        return $template_packs;
326
-    }
327
-
328
-
329
-    /**
330
-     * This simply makes sure the autoloaders are registered for the EE_messages system.
331
-     *
332
-     * @since 4.5.0
333
-     * @return void
334
-     */
335
-    public static function set_autoloaders()
336
-    {
337
-        if (empty(self::$_MSG_PATHS)) {
338
-            self::_set_messages_paths();
339
-            foreach (self::$_MSG_PATHS as $path) {
340
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
341
-            }
342
-            // add aliases
343
-            EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
344
-            EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
345
-        }
346
-    }
347
-
348
-
349
-    /**
350
-     * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
351
-     * for use by the Messages Autoloaders
352
-     *
353
-     * @since 4.5.0
354
-     * @return void.
355
-     */
356
-    protected static function _set_messages_paths()
357
-    {
358
-        $dir_ref = array(
359
-            'messages/message_type',
360
-            'messages/messenger',
361
-            'messages/defaults',
362
-            'messages/defaults/email',
363
-            'messages/data_class',
364
-            'messages/validators',
365
-            'messages/validators/email',
366
-            'messages/validators/html',
367
-            'shortcodes',
368
-        );
369
-        $paths   = array();
370
-        foreach ($dir_ref as $index => $dir) {
371
-            $paths[$index] = EE_LIBRARIES . $dir;
372
-        }
373
-        self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
374
-    }
375
-
376
-
377
-    /**
378
-     * Takes care of loading dependencies
379
-     *
380
-     * @since 4.5.0
381
-     * @return void
382
-     */
383
-    protected static function _load_controller()
384
-    {
385
-        if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
386
-            EE_Registry::instance()->load_core('Request_Handler');
387
-            self::set_autoloaders();
388
-            self::$_EEMSG                    = EE_Registry::instance()->load_lib('messages');
389
-            self::$_MSG_PROCESSOR            = EE_Registry::instance()->load_lib('Messages_Processor');
390
-            self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
391
-        }
392
-    }
393
-
394
-
395
-    /**
396
-     * @param EE_Transaction $transaction
397
-     */
398
-    public static function payment_reminder(EE_Transaction $transaction)
399
-    {
400
-        self::_load_controller();
401
-        $data = array($transaction, null);
402
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
403
-    }
404
-
405
-
406
-    /**
407
-     * Any messages triggers for after successful gateway payments should go in here.
408
-     *
409
-     * @param  EE_Transaction object
410
-     * @param  EE_Payment     object
411
-     * @return void
412
-     */
413
-    public static function payment(EE_Transaction $transaction, EE_Payment $payment)
414
-    {
415
-        self::_load_controller();
416
-        $data = array($transaction, $payment);
417
-        EE_Registry::instance()->load_helper('MSG_Template');
418
-        $message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
419
-        //if payment amount is less than 0 then switch to payment_refund message type.
420
-        $message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
421
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
422
-    }
423
-
424
-
425
-    /**
426
-     * @param EE_Transaction $transaction
427
-     */
428
-    public static function cancelled_registration(EE_Transaction $transaction)
429
-    {
430
-        self::_load_controller();
431
-        $data = array($transaction, null);
432
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
433
-    }
434
-
435
-
436
-    /**
437
-     * Trigger for Registration messages
438
-     * Note that what registration message type is sent depends on what the reg status is for the registrations on the
439
-     * incoming transaction.
440
-     *
441
-     * @param EE_Registration $registration
442
-     * @param array           $extra_details
443
-     * @return void
444
-     */
445
-    public static function maybe_registration(EE_Registration $registration, $extra_details = array())
446
-    {
447
-
448
-        if (! self::_verify_registration_notification_send($registration, $extra_details)) {
449
-            //no messages please
450
-            return;
451
-        }
452
-
453
-
454
-        //get all registrations so we make sure we send messages for the right status.
455
-        $all_registrations = $registration->transaction()->registrations();
456
-
457
-        //cached array of statuses so we only trigger messages once per status.
458
-        $statuses_sent = array();
459
-        self::_load_controller();
460
-        $mtgs = array();
461
-
462
-        //loop through registrations and trigger messages once per status.
463
-        foreach ($all_registrations as $reg) {
464
-
465
-            //already triggered?
466
-            if (in_array($reg->status_ID(), $statuses_sent)) {
467
-                continue;
468
-            }
469
-
470
-            $message_type    = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
471
-            $mtgs            = array_merge(
472
-                    $mtgs,
473
-                    self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
474
-                            $message_type,
475
-                            array($registration->transaction(), null, $reg->status_ID())
476
-                    )
477
-            );
478
-            $statuses_sent[] = $reg->status_ID();
479
-        }
480
-
481
-        if (count($statuses_sent) > 1) {
482
-            $mtgs = array_merge(
483
-                $mtgs,
484
-                self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
485
-                    'registration_summary',
486
-                    array($registration->transaction(), null)
487
-                )
488
-            );
489
-        }
490
-
491
-        //batch queue and initiate request
492
-        self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
493
-        self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
494
-    }
495
-
496
-
497
-    /**
498
-     * This is a helper method used to very whether a registration notification should be sent or
499
-     * not.  Prevents duplicate notifications going out for registration context notifications.
500
-     *
501
-     * @param EE_Registration $registration  [description]
502
-     * @param array           $extra_details [description]
503
-     * @return bool          true = send away, false = nope halt the presses.
504
-     */
505
-    protected static function _verify_registration_notification_send(
506
-        EE_Registration $registration,
507
-        $extra_details = array()
508
-    ) {
509
-        //self::log(
510
-        //	__CLASS__, __FUNCTION__, __LINE__,
511
-        //	$registration->transaction(),
512
-        //	array( '$extra_details' => $extra_details )
513
-        //);
514
-        // currently only using this to send messages for the primary registrant
515
-        if (! $registration->is_primary_registrant()) {
516
-            return false;
517
-        }
518
-        // first we check if we're in admin and not doing front ajax
519
-        if (is_admin() && ! EE_FRONT_AJAX) {
520
-            //make sure appropriate admin params are set for sending messages
521
-            if (empty($_REQUEST['txn_reg_status_change']['send_notifications']) || ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])) {
522
-                //no messages sent please.
523
-                return false;
524
-            }
525
-        } else {
526
-            // frontend request (either regular or via AJAX)
527
-            // TXN is NOT finalized ?
528
-            if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
529
-                return false;
530
-            }
531
-            // return visit but nothing changed ???
532
-            if (
533
-                isset($extra_details['revisit'], $extra_details['status_updates']) &&
534
-                $extra_details['revisit'] && ! $extra_details['status_updates']
535
-            ) {
536
-                return false;
537
-            }
538
-            // NOT sending messages && reg status is something other than "Not-Approved"
539
-            if (
540
-                ! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
541
-                $registration->status_ID() !== EEM_Registration::status_id_not_approved
542
-            ) {
543
-                return false;
544
-            }
545
-        }
546
-        // release the kraken
547
-        return true;
548
-    }
549
-
550
-
551
-    /**
552
-     * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that
553
-     * status id.
554
-     *
555
-     * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
556
-     *                    or EEH_MSG_Template::convert_reg_status_to_message_type
557
-     * @param string $reg_status
558
-     * @return array
559
-     */
560
-    protected static function _get_reg_status_array($reg_status = '')
561
-    {
562
-        EE_Registry::instance()->load_helper('MSG_Template');
563
-        return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
564
-            ? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
565
-            : EEH_MSG_Template::reg_status_to_message_type_array();
566
-    }
567
-
568
-
569
-    /**
570
-     * Simply returns the payment message type for the given payment status.
571
-     *
572
-     * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
573
-     *                   or EEH_MSG_Template::convert_payment_status_to_message_type
574
-     * @param string $payment_status The payment status being matched.
575
-     * @return string|bool The payment message type slug matching the status or false if no match.
576
-     */
577
-    protected static function _get_payment_message_type($payment_status)
578
-    {
579
-        EE_Registry::instance()->load_helper('MSG_Template');
580
-        return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
581
-            ? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
582
-            : false;
583
-    }
584
-
585
-
586
-    /**
587
-     * Message triggers for a resending already sent message(s) (via EE_Message list table)
588
-     *
589
-     * @access public
590
-     * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
591
-     * @return bool          success/fail
592
-     */
593
-    public static function process_resend($req_data)
594
-    {
595
-        self::_load_controller();
596
-
597
-        //if $msgID in this request then skip to the new resend_message
598
-        if (EE_Registry::instance()->REQ->get('MSG_ID')) {
599
-            return self::resend_message();
600
-        }
601
-
602
-        //make sure any incoming request data is set on the REQ so that it gets picked up later.
603
-        $req_data = (array)$req_data;
604
-        foreach ($req_data as $request_key => $request_value) {
605
-            EE_Registry::instance()->REQ->set($request_key, $request_value);
606
-        }
607
-
608
-        if (! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request()) {
609
-            return false;
610
-        }
611
-
612
-        try {
613
-            self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
614
-            self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
615
-        } catch (EE_Error $e) {
616
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
617
-            return false;
618
-        }
619
-        EE_Error::add_success(
620
-            __('Messages have been successfully queued for generation and sending.', 'event_espresso')
621
-        );
622
-        return true; //everything got queued.
623
-    }
624
-
625
-
626
-    /**
627
-     * Message triggers for a resending already sent message(s) (via EE_Message list table)
628
-     *
629
-     * @return bool
630
-     */
631
-    public static function resend_message()
632
-    {
633
-        self::_load_controller();
634
-
635
-        $msgID = EE_Registry::instance()->REQ->get('MSG_ID');
636
-        if (! $msgID) {
637
-            EE_Error::add_error(__('Something went wrong because there is no "MSG_ID" value in the request',
638
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
639
-            return false;
640
-        }
641
-
642
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array)$msgID);
643
-
644
-        //setup success message.
645
-        $count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
646
-        EE_Error::add_success(sprintf(
647
-            _n(
648
-                'There was %d message queued for resending.',
649
-                'There were %d messages queued for resending.',
650
-                $count_ready_for_resend,
651
-                'event_espresso'
652
-            ),
653
-            $count_ready_for_resend
654
-        ));
655
-        return true;
656
-    }
657
-
658
-
659
-    /**
660
-     * Message triggers for manual payment applied by admin
661
-     *
662
-     * @param  EE_Payment $payment EE_payment object
663
-     * @return bool              success/fail
664
-     */
665
-    public static function process_admin_payment(EE_Payment $payment)
666
-    {
667
-        EE_Registry::instance()->load_helper('MSG_Template');
668
-        //we need to get the transaction object
669
-        $transaction = $payment->transaction();
670
-        if ($transaction instanceof EE_Transaction) {
671
-            $data         = array($transaction, $payment);
672
-            $message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
673
-
674
-            //if payment amount is less than 0 then switch to payment_refund message type.
675
-            $message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
676
-
677
-            //if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
678
-            $message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved ? false : $message_type;
679
-
680
-            self::_load_controller();
681
-
682
-            self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
683
-
684
-            //get count of queued for generation
685
-            $count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(array(
686
-                EEM_Message::status_incomplete,
687
-                EEM_Message::status_idle,
688
-            ));
689
-
690
-            if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
691
-                add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
692
-                return true;
693
-            } else {
694
-                $count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::instance()->stati_indicating_failed_sending());
695
-                /**
696
-                 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
697
-                 * IMMEDIATE generation.
698
-                 */
699
-                if ($count_failed > 0) {
700
-                    EE_Error::add_error(sprintf(
701
-                        _n(
702
-                            'The payment notification generation failed.',
703
-                            '%d payment notifications failed being sent.',
704
-                            $count_failed,
705
-                            'event_espresso'
706
-                        ),
707
-                        $count_failed
708
-                    ), __FILE__, __FUNCTION__, __LINE__);
709
-
710
-                    return false;
711
-                } else {
712
-                    add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
713
-                    return true;
714
-                }
715
-            }
716
-        } else {
717
-            EE_Error::add_error(
718
-                'Unable to generate the payment notification because the given value for the transaction is invalid.',
719
-                'event_espresso'
720
-            );
721
-            return false;
722
-        }
723
-    }
724
-
725
-
726
-    /**
727
-     * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
728
-     *
729
-     * @since   4.3.0
730
-     * @param  EE_Registration[] $registrations an array of EE_Registration objects
731
-     * @param  int               $grp_id        a specific message template group id.
732
-     * @return void
733
-     */
734
-    public static function send_newsletter_message($registrations, $grp_id)
735
-    {
736
-        //make sure mtp is id and set it in the EE_Request Handler later messages setup.
737
-        EE_Registry::instance()->REQ->set('GRP_ID', (int)$grp_id);
738
-        self::_load_controller();
739
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
740
-    }
741
-
742
-
743
-    /**
744
-     * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
745
-     *
746
-     * @since   4.3.0
747
-     * @param    string          $registration_message_trigger_url
748
-     * @param    EE_Registration $registration
749
-     * @param string             $messenger
750
-     * @param string             $message_type
751
-     * @return    string
752
-     */
753
-    public static function registration_message_trigger_url(
754
-        $registration_message_trigger_url,
755
-        EE_Registration $registration,
756
-        $messenger = 'html',
757
-        $message_type = 'invoice'
758
-    ) {
759
-        // whitelist $messenger
760
-        switch ($messenger) {
761
-            case 'pdf' :
762
-                $sending_messenger    = 'pdf';
763
-                $generating_messenger = 'html';
764
-                break;
765
-            case 'html' :
766
-            default :
767
-                $sending_messenger    = 'html';
768
-                $generating_messenger = 'html';
769
-                break;
770
-        }
771
-        // whitelist $message_type
772
-        switch ($message_type) {
773
-            case 'receipt' :
774
-                $message_type = 'receipt';
775
-                break;
776
-            case 'invoice' :
777
-            default :
778
-                $message_type = 'invoice';
779
-                break;
780
-        }
781
-        // verify that both the messenger AND the message type are active
782
-        if (EEH_MSG_Template::is_messenger_active($sending_messenger) && EEH_MSG_Template::is_mt_active($message_type)) {
783
-            //need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
784
-            $template_query_params = array(
785
-                'MTP_is_active'    => true,
786
-                'MTP_messenger'    => $generating_messenger,
787
-                'MTP_message_type' => $message_type,
788
-                'Event.EVT_ID'     => $registration->event_ID(),
789
-            );
790
-            //get the message template group.
791
-            $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
792
-            //if we don't have an EE_Message_Template_Group then return
793
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
794
-                // remove EVT_ID from query params so that global templates get picked up
795
-                unset($template_query_params['Event.EVT_ID']);
796
-                //get global template as the fallback
797
-                $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
798
-            }
799
-            //if we don't have an EE_Message_Template_Group then return
800
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
801
-                return '';
802
-            }
803
-            // generate the URL
804
-            $registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
805
-                $sending_messenger,
806
-                $generating_messenger,
807
-                'purchaser',
808
-                $message_type,
809
-                $registration,
810
-                $msg_template_group->ID(),
811
-                $registration->transaction_ID()
812
-            );
813
-
814
-        }
815
-        return $registration_message_trigger_url;
816
-    }
817
-
818
-
819
-    /**
820
-     * Use to generate and return a message preview!
821
-     *
822
-     * @param  string $type      This should correspond with a valid message type
823
-     * @param  string $context   This should correspond with a valid context for the message type
824
-     * @param  string $messenger This should correspond with a valid messenger.
825
-     * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
826
-     *                           preview
827
-     * @return string|bool          The body of the message or if send is requested, sends.
828
-     */
829
-    public static function preview_message($type, $context, $messenger, $send = false)
830
-    {
831
-        self::_load_controller();
832
-        $mtg                     = new EE_Message_To_Generate(
833
-            $messenger,
834
-            $type,
835
-            array(),
836
-            $context,
837
-            true
838
-        );
839
-        $generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
840
-        if ($generated_preview_queue instanceof EE_Messages_Queue) {
841
-            return $generated_preview_queue->get_message_repository()->current()->content();
842
-        } else {
843
-            return $generated_preview_queue;
844
-        }
845
-    }
846
-
847
-
848
-    /**
849
-     * This is a method that allows for sending a message using a messenger matching the string given and the provided
850
-     * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the
851
-     * content found in the EE_Message objects in the queue.
852
-     *
853
-     * @since 4.9.0
854
-     * @param string            $messenger            a string matching a valid active messenger in the system
855
-     * @param string            $message_type         Although it seems contrary to the name of the method, a message
856
-     *                                                type name is still required to send along the message type to the
857
-     *                                                messenger because this is used for determining what specific
858
-     *                                                variations might be loaded for the generated message.
859
-     * @param EE_Messages_Queue $queue
860
-     * @param string            $custom_subject       Can be used to set what the custom subject string will be on the
861
-     *                                                aggregate EE_Message object.
862
-     * @return bool          success or fail.
863
-     */
864
-    public static function send_message_with_messenger_only(
865
-        $messenger,
866
-        $message_type,
867
-        EE_Messages_Queue $queue,
868
-        $custom_subject = ''
869
-    ) {
870
-        self::_load_controller();
871
-        /** @type EE_Message_To_Generate_From_Queue $message_to_generate */
872
-        $message_to_generate = EE_Registry::instance()->load_lib(
873
-            'Message_To_Generate_From_Queue',
874
-            array(
875
-                $messenger,
876
-                $message_type,
877
-                $queue,
878
-                $custom_subject,
879
-            )
880
-        );
881
-        return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
882
-    }
883
-
884
-
885
-    /**
886
-     * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
887
-     *
888
-     * @since 4.9.0
889
-     * @param array $message_ids An array of message ids
890
-     * @return bool | EE_Messages_Queue     false if nothing was generated, EE_Messages_Queue containing generated
891
-     *              messages.
892
-     */
893
-    public static function generate_now($message_ids)
894
-    {
895
-        self::_load_controller();
896
-        $messages        = EEM_Message::instance()->get_all(
897
-            array(
898
-                0 => array(
899
-                    'MSG_ID' => array('IN', $message_ids),
900
-                    'STS_ID' => EEM_Message::status_incomplete,
901
-                ),
902
-            )
903
-        );
904
-        $generated_queue = false;
905
-        if ($messages) {
906
-            $generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
907
-        }
908
-
909
-        if (! $generated_queue instanceof EE_Messages_Queue) {
910
-            EE_Error::add_error(
911
-                __('The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
912
-                    'event_espresso'),
913
-                __FILE__, __FUNCTION__, __LINE__
914
-            );
915
-        }
916
-        return $generated_queue;
917
-    }
918
-
919
-
920
-    /**
921
-     * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
922
-     * EEM_Message::status_idle
923
-     *
924
-     * @since 4.9.0
925
-     * @param $message_ids
926
-     * @return bool | EE_Messages_Queue  false if no messages sent.
927
-     */
928
-    public static function send_now($message_ids)
929
-    {
930
-        self::_load_controller();
931
-        $messages   = EEM_Message::instance()->get_all(
932
-            array(
933
-                0 => array(
934
-                    'MSG_ID' => array('IN', $message_ids),
935
-                    'STS_ID' => array(
936
-                        'IN',
937
-                        array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry),
938
-                    ),
939
-                ),
940
-            )
941
-        );
942
-        $sent_queue = false;
943
-        if ($messages) {
944
-            $sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
945
-        }
946
-
947
-        if (! $sent_queue instanceof EE_Messages_Queue) {
948
-            EE_Error::add_error(
949
-                __('The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
950
-                    'event_espresso'),
951
-                __FILE__, __FUNCTION__, __LINE__
952
-            );
953
-        } else {
954
-            //can count how many sent by using the messages in the queue
955
-            $sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
956
-            if ($sent_count > 0) {
957
-                EE_Error::add_success(
958
-                    sprintf(
959
-                        _n(
960
-                            'There was %d message successfully sent.',
961
-                            'There were %d messages successfully sent.',
962
-                            $sent_count,
963
-                            'event_espresso'
964
-                        ),
965
-                        $sent_count
966
-                    )
967
-                );
968
-            } else {
969
-                EE_Error::overwrite_errors();
970
-                EE_Error::add_error(
971
-                    __('No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
201
+				exit;
202
+			}
203
+		}
204
+		return;
205
+	}
206
+
207
+
208
+	/**
209
+	 *  This runs when the msg_url_trigger route has initiated.
210
+	 *
211
+	 * @since 4.5.0
212
+	 * @param WP $WP
213
+	 * @throws EE_Error
214
+	 * @return    void
215
+	 */
216
+	public function run($WP)
217
+	{
218
+		//ensure controller is loaded
219
+		self::_load_controller();
220
+		// attempt to process message
221
+		try {
222
+			/** @type EE_Message_To_Generate_From_Request $message_to_generate */
223
+			$message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
224
+			self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
225
+		} catch (EE_Error $e) {
226
+			$error_msg = __('Please note that a system message failed to send due to a technical issue.',
227
+				'event_espresso');
228
+			// add specific message for developers if WP_DEBUG in on
229
+			$error_msg .= '||' . $e->getMessage();
230
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
231
+		}
232
+	}
233
+
234
+
235
+	/**
236
+	 * This is triggered by the 'msg_cron_trigger' route.
237
+	 *
238
+	 * @param WP $WP
239
+	 */
240
+	public function execute_batch_request($WP)
241
+	{
242
+		$this->run_cron();
243
+		header('HTTP/1.1 200 OK');
244
+		exit();
245
+	}
246
+
247
+
248
+	/**
249
+	 * This gets executed on wp_cron jobs or when a batch request is initiated on its own separate non regular wp
250
+	 * request.
251
+	 */
252
+	public function run_cron()
253
+	{
254
+		self::_load_controller();
255
+		//get required vars
256
+		$cron_type     = EE_Registry::instance()->REQ->get('type');
257
+		$transient_key = EE_Registry::instance()->REQ->get('key');
258
+
259
+		//now let's verify transient, if not valid exit immediately
260
+		if (! get_transient($transient_key)) {
261
+			/**
262
+			 * trigger error so this gets in the error logs.  This is important because it happens on a non-user request.
263
+			 */
264
+			trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
265
+		}
266
+
267
+		//if made it here, lets' delete the transient to keep the db clean
268
+		delete_transient($transient_key);
269
+
270
+		if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
271
+
272
+			$method = 'batch_' . $cron_type . '_from_queue';
273
+			if (method_exists(self::$_MSG_PROCESSOR, $method)) {
274
+				self::$_MSG_PROCESSOR->$method();
275
+			} else {
276
+				//no matching task
277
+				/**
278
+				 * trigger error so this gets in the error logs.  This is important because it happens on a non user request.
279
+				 */
280
+				trigger_error(esc_attr(sprintf(__('There is no task corresponding to this route %s', 'event_espresso'),
281
+					$cron_type)));
282
+			}
283
+		}
284
+
285
+		do_action('FHEE__EED_Messages__run_cron__end');
286
+	}
287
+
288
+
289
+	/**
290
+	 * This is used to retrieve the template pack for the given name.
291
+	 * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then
292
+	 * the default template pack is returned.
293
+	 *
294
+	 * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
295
+	 * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used
296
+	 *                                   in generating the Pack class name).
297
+	 * @return EE_Messages_Template_Pack
298
+	 */
299
+	public static function get_template_pack($template_pack_name)
300
+	{
301
+		EE_Registry::instance()->load_helper('MSG_Template');
302
+		return EEH_MSG_Template::get_template_pack($template_pack_name);
303
+	}
304
+
305
+
306
+	/**
307
+	 * Retrieves an array of all template packs.
308
+	 * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
309
+	 *
310
+	 * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
311
+	 * @return EE_Messages_Template_Pack[]
312
+	 */
313
+	public static function get_template_packs()
314
+	{
315
+		EE_Registry::instance()->load_helper('MSG_Template');
316
+
317
+		//for backward compat, let's make sure this returns in the same format as originally.
318
+		$template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
319
+		$template_pack_collection->rewind();
320
+		$template_packs = array();
321
+		while ($template_pack_collection->valid()) {
322
+			$template_packs[$template_pack_collection->current()->dbref] = $template_pack_collection->current();
323
+			$template_pack_collection->next();
324
+		}
325
+		return $template_packs;
326
+	}
327
+
328
+
329
+	/**
330
+	 * This simply makes sure the autoloaders are registered for the EE_messages system.
331
+	 *
332
+	 * @since 4.5.0
333
+	 * @return void
334
+	 */
335
+	public static function set_autoloaders()
336
+	{
337
+		if (empty(self::$_MSG_PATHS)) {
338
+			self::_set_messages_paths();
339
+			foreach (self::$_MSG_PATHS as $path) {
340
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
341
+			}
342
+			// add aliases
343
+			EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
344
+			EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
345
+		}
346
+	}
347
+
348
+
349
+	/**
350
+	 * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
351
+	 * for use by the Messages Autoloaders
352
+	 *
353
+	 * @since 4.5.0
354
+	 * @return void.
355
+	 */
356
+	protected static function _set_messages_paths()
357
+	{
358
+		$dir_ref = array(
359
+			'messages/message_type',
360
+			'messages/messenger',
361
+			'messages/defaults',
362
+			'messages/defaults/email',
363
+			'messages/data_class',
364
+			'messages/validators',
365
+			'messages/validators/email',
366
+			'messages/validators/html',
367
+			'shortcodes',
368
+		);
369
+		$paths   = array();
370
+		foreach ($dir_ref as $index => $dir) {
371
+			$paths[$index] = EE_LIBRARIES . $dir;
372
+		}
373
+		self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
374
+	}
375
+
376
+
377
+	/**
378
+	 * Takes care of loading dependencies
379
+	 *
380
+	 * @since 4.5.0
381
+	 * @return void
382
+	 */
383
+	protected static function _load_controller()
384
+	{
385
+		if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
386
+			EE_Registry::instance()->load_core('Request_Handler');
387
+			self::set_autoloaders();
388
+			self::$_EEMSG                    = EE_Registry::instance()->load_lib('messages');
389
+			self::$_MSG_PROCESSOR            = EE_Registry::instance()->load_lib('Messages_Processor');
390
+			self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
391
+		}
392
+	}
393
+
394
+
395
+	/**
396
+	 * @param EE_Transaction $transaction
397
+	 */
398
+	public static function payment_reminder(EE_Transaction $transaction)
399
+	{
400
+		self::_load_controller();
401
+		$data = array($transaction, null);
402
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
403
+	}
404
+
405
+
406
+	/**
407
+	 * Any messages triggers for after successful gateway payments should go in here.
408
+	 *
409
+	 * @param  EE_Transaction object
410
+	 * @param  EE_Payment     object
411
+	 * @return void
412
+	 */
413
+	public static function payment(EE_Transaction $transaction, EE_Payment $payment)
414
+	{
415
+		self::_load_controller();
416
+		$data = array($transaction, $payment);
417
+		EE_Registry::instance()->load_helper('MSG_Template');
418
+		$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
419
+		//if payment amount is less than 0 then switch to payment_refund message type.
420
+		$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
421
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
422
+	}
423
+
424
+
425
+	/**
426
+	 * @param EE_Transaction $transaction
427
+	 */
428
+	public static function cancelled_registration(EE_Transaction $transaction)
429
+	{
430
+		self::_load_controller();
431
+		$data = array($transaction, null);
432
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
433
+	}
434
+
435
+
436
+	/**
437
+	 * Trigger for Registration messages
438
+	 * Note that what registration message type is sent depends on what the reg status is for the registrations on the
439
+	 * incoming transaction.
440
+	 *
441
+	 * @param EE_Registration $registration
442
+	 * @param array           $extra_details
443
+	 * @return void
444
+	 */
445
+	public static function maybe_registration(EE_Registration $registration, $extra_details = array())
446
+	{
447
+
448
+		if (! self::_verify_registration_notification_send($registration, $extra_details)) {
449
+			//no messages please
450
+			return;
451
+		}
452
+
453
+
454
+		//get all registrations so we make sure we send messages for the right status.
455
+		$all_registrations = $registration->transaction()->registrations();
456
+
457
+		//cached array of statuses so we only trigger messages once per status.
458
+		$statuses_sent = array();
459
+		self::_load_controller();
460
+		$mtgs = array();
461
+
462
+		//loop through registrations and trigger messages once per status.
463
+		foreach ($all_registrations as $reg) {
464
+
465
+			//already triggered?
466
+			if (in_array($reg->status_ID(), $statuses_sent)) {
467
+				continue;
468
+			}
469
+
470
+			$message_type    = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
471
+			$mtgs            = array_merge(
472
+					$mtgs,
473
+					self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
474
+							$message_type,
475
+							array($registration->transaction(), null, $reg->status_ID())
476
+					)
477
+			);
478
+			$statuses_sent[] = $reg->status_ID();
479
+		}
480
+
481
+		if (count($statuses_sent) > 1) {
482
+			$mtgs = array_merge(
483
+				$mtgs,
484
+				self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
485
+					'registration_summary',
486
+					array($registration->transaction(), null)
487
+				)
488
+			);
489
+		}
490
+
491
+		//batch queue and initiate request
492
+		self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
493
+		self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
494
+	}
495
+
496
+
497
+	/**
498
+	 * This is a helper method used to very whether a registration notification should be sent or
499
+	 * not.  Prevents duplicate notifications going out for registration context notifications.
500
+	 *
501
+	 * @param EE_Registration $registration  [description]
502
+	 * @param array           $extra_details [description]
503
+	 * @return bool          true = send away, false = nope halt the presses.
504
+	 */
505
+	protected static function _verify_registration_notification_send(
506
+		EE_Registration $registration,
507
+		$extra_details = array()
508
+	) {
509
+		//self::log(
510
+		//	__CLASS__, __FUNCTION__, __LINE__,
511
+		//	$registration->transaction(),
512
+		//	array( '$extra_details' => $extra_details )
513
+		//);
514
+		// currently only using this to send messages for the primary registrant
515
+		if (! $registration->is_primary_registrant()) {
516
+			return false;
517
+		}
518
+		// first we check if we're in admin and not doing front ajax
519
+		if (is_admin() && ! EE_FRONT_AJAX) {
520
+			//make sure appropriate admin params are set for sending messages
521
+			if (empty($_REQUEST['txn_reg_status_change']['send_notifications']) || ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])) {
522
+				//no messages sent please.
523
+				return false;
524
+			}
525
+		} else {
526
+			// frontend request (either regular or via AJAX)
527
+			// TXN is NOT finalized ?
528
+			if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
529
+				return false;
530
+			}
531
+			// return visit but nothing changed ???
532
+			if (
533
+				isset($extra_details['revisit'], $extra_details['status_updates']) &&
534
+				$extra_details['revisit'] && ! $extra_details['status_updates']
535
+			) {
536
+				return false;
537
+			}
538
+			// NOT sending messages && reg status is something other than "Not-Approved"
539
+			if (
540
+				! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
541
+				$registration->status_ID() !== EEM_Registration::status_id_not_approved
542
+			) {
543
+				return false;
544
+			}
545
+		}
546
+		// release the kraken
547
+		return true;
548
+	}
549
+
550
+
551
+	/**
552
+	 * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that
553
+	 * status id.
554
+	 *
555
+	 * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
556
+	 *                    or EEH_MSG_Template::convert_reg_status_to_message_type
557
+	 * @param string $reg_status
558
+	 * @return array
559
+	 */
560
+	protected static function _get_reg_status_array($reg_status = '')
561
+	{
562
+		EE_Registry::instance()->load_helper('MSG_Template');
563
+		return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
564
+			? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
565
+			: EEH_MSG_Template::reg_status_to_message_type_array();
566
+	}
567
+
568
+
569
+	/**
570
+	 * Simply returns the payment message type for the given payment status.
571
+	 *
572
+	 * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
573
+	 *                   or EEH_MSG_Template::convert_payment_status_to_message_type
574
+	 * @param string $payment_status The payment status being matched.
575
+	 * @return string|bool The payment message type slug matching the status or false if no match.
576
+	 */
577
+	protected static function _get_payment_message_type($payment_status)
578
+	{
579
+		EE_Registry::instance()->load_helper('MSG_Template');
580
+		return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
581
+			? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
582
+			: false;
583
+	}
584
+
585
+
586
+	/**
587
+	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
588
+	 *
589
+	 * @access public
590
+	 * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
591
+	 * @return bool          success/fail
592
+	 */
593
+	public static function process_resend($req_data)
594
+	{
595
+		self::_load_controller();
596
+
597
+		//if $msgID in this request then skip to the new resend_message
598
+		if (EE_Registry::instance()->REQ->get('MSG_ID')) {
599
+			return self::resend_message();
600
+		}
601
+
602
+		//make sure any incoming request data is set on the REQ so that it gets picked up later.
603
+		$req_data = (array)$req_data;
604
+		foreach ($req_data as $request_key => $request_value) {
605
+			EE_Registry::instance()->REQ->set($request_key, $request_value);
606
+		}
607
+
608
+		if (! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request()) {
609
+			return false;
610
+		}
611
+
612
+		try {
613
+			self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
614
+			self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
615
+		} catch (EE_Error $e) {
616
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
617
+			return false;
618
+		}
619
+		EE_Error::add_success(
620
+			__('Messages have been successfully queued for generation and sending.', 'event_espresso')
621
+		);
622
+		return true; //everything got queued.
623
+	}
624
+
625
+
626
+	/**
627
+	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
628
+	 *
629
+	 * @return bool
630
+	 */
631
+	public static function resend_message()
632
+	{
633
+		self::_load_controller();
634
+
635
+		$msgID = EE_Registry::instance()->REQ->get('MSG_ID');
636
+		if (! $msgID) {
637
+			EE_Error::add_error(__('Something went wrong because there is no "MSG_ID" value in the request',
638
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
639
+			return false;
640
+		}
641
+
642
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array)$msgID);
643
+
644
+		//setup success message.
645
+		$count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
646
+		EE_Error::add_success(sprintf(
647
+			_n(
648
+				'There was %d message queued for resending.',
649
+				'There were %d messages queued for resending.',
650
+				$count_ready_for_resend,
651
+				'event_espresso'
652
+			),
653
+			$count_ready_for_resend
654
+		));
655
+		return true;
656
+	}
657
+
658
+
659
+	/**
660
+	 * Message triggers for manual payment applied by admin
661
+	 *
662
+	 * @param  EE_Payment $payment EE_payment object
663
+	 * @return bool              success/fail
664
+	 */
665
+	public static function process_admin_payment(EE_Payment $payment)
666
+	{
667
+		EE_Registry::instance()->load_helper('MSG_Template');
668
+		//we need to get the transaction object
669
+		$transaction = $payment->transaction();
670
+		if ($transaction instanceof EE_Transaction) {
671
+			$data         = array($transaction, $payment);
672
+			$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
673
+
674
+			//if payment amount is less than 0 then switch to payment_refund message type.
675
+			$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
676
+
677
+			//if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
678
+			$message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved ? false : $message_type;
679
+
680
+			self::_load_controller();
681
+
682
+			self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
683
+
684
+			//get count of queued for generation
685
+			$count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(array(
686
+				EEM_Message::status_incomplete,
687
+				EEM_Message::status_idle,
688
+			));
689
+
690
+			if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
691
+				add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
692
+				return true;
693
+			} else {
694
+				$count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::instance()->stati_indicating_failed_sending());
695
+				/**
696
+				 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
697
+				 * IMMEDIATE generation.
698
+				 */
699
+				if ($count_failed > 0) {
700
+					EE_Error::add_error(sprintf(
701
+						_n(
702
+							'The payment notification generation failed.',
703
+							'%d payment notifications failed being sent.',
704
+							$count_failed,
705
+							'event_espresso'
706
+						),
707
+						$count_failed
708
+					), __FILE__, __FUNCTION__, __LINE__);
709
+
710
+					return false;
711
+				} else {
712
+					add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
713
+					return true;
714
+				}
715
+			}
716
+		} else {
717
+			EE_Error::add_error(
718
+				'Unable to generate the payment notification because the given value for the transaction is invalid.',
719
+				'event_espresso'
720
+			);
721
+			return false;
722
+		}
723
+	}
724
+
725
+
726
+	/**
727
+	 * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
728
+	 *
729
+	 * @since   4.3.0
730
+	 * @param  EE_Registration[] $registrations an array of EE_Registration objects
731
+	 * @param  int               $grp_id        a specific message template group id.
732
+	 * @return void
733
+	 */
734
+	public static function send_newsletter_message($registrations, $grp_id)
735
+	{
736
+		//make sure mtp is id and set it in the EE_Request Handler later messages setup.
737
+		EE_Registry::instance()->REQ->set('GRP_ID', (int)$grp_id);
738
+		self::_load_controller();
739
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
740
+	}
741
+
742
+
743
+	/**
744
+	 * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
745
+	 *
746
+	 * @since   4.3.0
747
+	 * @param    string          $registration_message_trigger_url
748
+	 * @param    EE_Registration $registration
749
+	 * @param string             $messenger
750
+	 * @param string             $message_type
751
+	 * @return    string
752
+	 */
753
+	public static function registration_message_trigger_url(
754
+		$registration_message_trigger_url,
755
+		EE_Registration $registration,
756
+		$messenger = 'html',
757
+		$message_type = 'invoice'
758
+	) {
759
+		// whitelist $messenger
760
+		switch ($messenger) {
761
+			case 'pdf' :
762
+				$sending_messenger    = 'pdf';
763
+				$generating_messenger = 'html';
764
+				break;
765
+			case 'html' :
766
+			default :
767
+				$sending_messenger    = 'html';
768
+				$generating_messenger = 'html';
769
+				break;
770
+		}
771
+		// whitelist $message_type
772
+		switch ($message_type) {
773
+			case 'receipt' :
774
+				$message_type = 'receipt';
775
+				break;
776
+			case 'invoice' :
777
+			default :
778
+				$message_type = 'invoice';
779
+				break;
780
+		}
781
+		// verify that both the messenger AND the message type are active
782
+		if (EEH_MSG_Template::is_messenger_active($sending_messenger) && EEH_MSG_Template::is_mt_active($message_type)) {
783
+			//need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
784
+			$template_query_params = array(
785
+				'MTP_is_active'    => true,
786
+				'MTP_messenger'    => $generating_messenger,
787
+				'MTP_message_type' => $message_type,
788
+				'Event.EVT_ID'     => $registration->event_ID(),
789
+			);
790
+			//get the message template group.
791
+			$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
792
+			//if we don't have an EE_Message_Template_Group then return
793
+			if (! $msg_template_group instanceof EE_Message_Template_Group) {
794
+				// remove EVT_ID from query params so that global templates get picked up
795
+				unset($template_query_params['Event.EVT_ID']);
796
+				//get global template as the fallback
797
+				$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
798
+			}
799
+			//if we don't have an EE_Message_Template_Group then return
800
+			if (! $msg_template_group instanceof EE_Message_Template_Group) {
801
+				return '';
802
+			}
803
+			// generate the URL
804
+			$registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
805
+				$sending_messenger,
806
+				$generating_messenger,
807
+				'purchaser',
808
+				$message_type,
809
+				$registration,
810
+				$msg_template_group->ID(),
811
+				$registration->transaction_ID()
812
+			);
813
+
814
+		}
815
+		return $registration_message_trigger_url;
816
+	}
817
+
818
+
819
+	/**
820
+	 * Use to generate and return a message preview!
821
+	 *
822
+	 * @param  string $type      This should correspond with a valid message type
823
+	 * @param  string $context   This should correspond with a valid context for the message type
824
+	 * @param  string $messenger This should correspond with a valid messenger.
825
+	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
826
+	 *                           preview
827
+	 * @return string|bool          The body of the message or if send is requested, sends.
828
+	 */
829
+	public static function preview_message($type, $context, $messenger, $send = false)
830
+	{
831
+		self::_load_controller();
832
+		$mtg                     = new EE_Message_To_Generate(
833
+			$messenger,
834
+			$type,
835
+			array(),
836
+			$context,
837
+			true
838
+		);
839
+		$generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
840
+		if ($generated_preview_queue instanceof EE_Messages_Queue) {
841
+			return $generated_preview_queue->get_message_repository()->current()->content();
842
+		} else {
843
+			return $generated_preview_queue;
844
+		}
845
+	}
846
+
847
+
848
+	/**
849
+	 * This is a method that allows for sending a message using a messenger matching the string given and the provided
850
+	 * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the
851
+	 * content found in the EE_Message objects in the queue.
852
+	 *
853
+	 * @since 4.9.0
854
+	 * @param string            $messenger            a string matching a valid active messenger in the system
855
+	 * @param string            $message_type         Although it seems contrary to the name of the method, a message
856
+	 *                                                type name is still required to send along the message type to the
857
+	 *                                                messenger because this is used for determining what specific
858
+	 *                                                variations might be loaded for the generated message.
859
+	 * @param EE_Messages_Queue $queue
860
+	 * @param string            $custom_subject       Can be used to set what the custom subject string will be on the
861
+	 *                                                aggregate EE_Message object.
862
+	 * @return bool          success or fail.
863
+	 */
864
+	public static function send_message_with_messenger_only(
865
+		$messenger,
866
+		$message_type,
867
+		EE_Messages_Queue $queue,
868
+		$custom_subject = ''
869
+	) {
870
+		self::_load_controller();
871
+		/** @type EE_Message_To_Generate_From_Queue $message_to_generate */
872
+		$message_to_generate = EE_Registry::instance()->load_lib(
873
+			'Message_To_Generate_From_Queue',
874
+			array(
875
+				$messenger,
876
+				$message_type,
877
+				$queue,
878
+				$custom_subject,
879
+			)
880
+		);
881
+		return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
882
+	}
883
+
884
+
885
+	/**
886
+	 * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
887
+	 *
888
+	 * @since 4.9.0
889
+	 * @param array $message_ids An array of message ids
890
+	 * @return bool | EE_Messages_Queue     false if nothing was generated, EE_Messages_Queue containing generated
891
+	 *              messages.
892
+	 */
893
+	public static function generate_now($message_ids)
894
+	{
895
+		self::_load_controller();
896
+		$messages        = EEM_Message::instance()->get_all(
897
+			array(
898
+				0 => array(
899
+					'MSG_ID' => array('IN', $message_ids),
900
+					'STS_ID' => EEM_Message::status_incomplete,
901
+				),
902
+			)
903
+		);
904
+		$generated_queue = false;
905
+		if ($messages) {
906
+			$generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
907
+		}
908
+
909
+		if (! $generated_queue instanceof EE_Messages_Queue) {
910
+			EE_Error::add_error(
911
+				__('The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
912
+					'event_espresso'),
913
+				__FILE__, __FUNCTION__, __LINE__
914
+			);
915
+		}
916
+		return $generated_queue;
917
+	}
918
+
919
+
920
+	/**
921
+	 * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
922
+	 * EEM_Message::status_idle
923
+	 *
924
+	 * @since 4.9.0
925
+	 * @param $message_ids
926
+	 * @return bool | EE_Messages_Queue  false if no messages sent.
927
+	 */
928
+	public static function send_now($message_ids)
929
+	{
930
+		self::_load_controller();
931
+		$messages   = EEM_Message::instance()->get_all(
932
+			array(
933
+				0 => array(
934
+					'MSG_ID' => array('IN', $message_ids),
935
+					'STS_ID' => array(
936
+						'IN',
937
+						array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry),
938
+					),
939
+				),
940
+			)
941
+		);
942
+		$sent_queue = false;
943
+		if ($messages) {
944
+			$sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
945
+		}
946
+
947
+		if (! $sent_queue instanceof EE_Messages_Queue) {
948
+			EE_Error::add_error(
949
+				__('The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
950
+					'event_espresso'),
951
+				__FILE__, __FUNCTION__, __LINE__
952
+			);
953
+		} else {
954
+			//can count how many sent by using the messages in the queue
955
+			$sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
956
+			if ($sent_count > 0) {
957
+				EE_Error::add_success(
958
+					sprintf(
959
+						_n(
960
+							'There was %d message successfully sent.',
961
+							'There were %d messages successfully sent.',
962
+							$sent_count,
963
+							'event_espresso'
964
+						),
965
+						$sent_count
966
+					)
967
+				);
968
+			} else {
969
+				EE_Error::overwrite_errors();
970
+				EE_Error::add_error(
971
+					__('No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
972 972
 					If there was an error, you can look at the messages in the message activity list table for any error messages.',
973
-                        'event_espresso'),
974
-                    __FILE__, __FUNCTION__, __LINE__
975
-                );
976
-            }
977
-        }
978
-        return $sent_queue;
979
-    }
980
-
981
-
982
-    /**
983
-     * This will queue the incoming message ids for resending.
984
-     * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
985
-     *
986
-     * @since 4.9.0
987
-     * @param array $message_ids An array of EE_Message IDs
988
-     * @return bool  true means messages were successfully queued for resending, false means none were queued for
989
-     *               resending.
990
-     */
991
-    public static function queue_for_resending($message_ids)
992
-    {
993
-        self::_load_controller();
994
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
995
-
996
-        //get queue and count
997
-        $queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
998
-
999
-        if (
1000
-            $queue_count > 0
1001
-        ) {
1002
-            EE_Error::add_success(
1003
-                sprintf(
1004
-                    _n(
1005
-                        '%d message successfully queued for resending.',
1006
-                        '%d messages successfully queued for resending.',
1007
-                        $queue_count,
1008
-                        'event_espresso'
1009
-                    ),
1010
-                    $queue_count
1011
-                )
1012
-            );
1013
-            /**
1014
-             * @see filter usage in EE_Messages_Queue::initiate_request_by_priority
1015
-             */
1016
-        } elseif (
1017
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', true)
1018
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
1019
-        ) {
1020
-            $queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_sent);
1021
-            if ($queue_count > 0) {
1022
-                EE_Error::add_success(
1023
-                    sprintf(
1024
-                        _n(
1025
-                            '%d message successfully sent.',
1026
-                            '%d messages successfully sent.',
1027
-                            $queue_count,
1028
-                            'event_espresso'
1029
-                        ),
1030
-                        $queue_count
1031
-                    )
1032
-                );
1033
-            } else {
1034
-                EE_Error::add_error(
1035
-                    __('No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
1036
-                        'event_espresso'),
1037
-                    __FILE__, __FUNCTION__, __LINE__
1038
-                );
1039
-            }
1040
-        } else {
1041
-            EE_Error::add_error(
1042
-                __('No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
1043
-                    'event_espresso'),
1044
-                __FILE__, __FUNCTION__, __LINE__
1045
-            );
1046
-        }
1047
-        return (bool)$queue_count;
1048
-    }
1049
-
1050
-
1051
-    /**
1052
-     * debug
1053
-     *
1054
-     * @param string          $class
1055
-     * @param string          $func
1056
-     * @param string          $line
1057
-     * @param \EE_Transaction $transaction
1058
-     * @param array           $info
1059
-     * @param bool            $display_request
1060
-     */
1061
-    protected static function log(
1062
-        $class = '',
1063
-        $func = '',
1064
-        $line = '',
1065
-        EE_Transaction $transaction,
1066
-        $info = array(),
1067
-        $display_request = false
1068
-    ) {
1069
-        if (WP_DEBUG && false) {
1070
-            if ($transaction instanceof EE_Transaction) {
1071
-                // don't serialize objects
1072
-                $info                  = EEH_Debug_Tools::strip_objects($info);
1073
-                $info['TXN_status']    = $transaction->status_ID();
1074
-                $info['TXN_reg_steps'] = $transaction->reg_steps();
1075
-                if ($transaction->ID()) {
1076
-                    $index = 'EE_Transaction: ' . $transaction->ID();
1077
-                    EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
1078
-                }
1079
-            }
1080
-        }
1081
-
1082
-    }
1083
-
1084
-
1085
-    /**
1086
-     *  Resets all the static properties in this class when called.
1087
-     */
1088
-    public static function reset()
1089
-    {
1090
-        self::$_EEMSG                    = null;
1091
-        self::$_message_resource_manager = null;
1092
-        self::$_MSG_PROCESSOR            = null;
1093
-        self::$_MSG_PATHS                = null;
1094
-        self::$_TMP_PACKS                = array();
1095
-    }
973
+						'event_espresso'),
974
+					__FILE__, __FUNCTION__, __LINE__
975
+				);
976
+			}
977
+		}
978
+		return $sent_queue;
979
+	}
980
+
981
+
982
+	/**
983
+	 * This will queue the incoming message ids for resending.
984
+	 * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
985
+	 *
986
+	 * @since 4.9.0
987
+	 * @param array $message_ids An array of EE_Message IDs
988
+	 * @return bool  true means messages were successfully queued for resending, false means none were queued for
989
+	 *               resending.
990
+	 */
991
+	public static function queue_for_resending($message_ids)
992
+	{
993
+		self::_load_controller();
994
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
995
+
996
+		//get queue and count
997
+		$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
998
+
999
+		if (
1000
+			$queue_count > 0
1001
+		) {
1002
+			EE_Error::add_success(
1003
+				sprintf(
1004
+					_n(
1005
+						'%d message successfully queued for resending.',
1006
+						'%d messages successfully queued for resending.',
1007
+						$queue_count,
1008
+						'event_espresso'
1009
+					),
1010
+					$queue_count
1011
+				)
1012
+			);
1013
+			/**
1014
+			 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority
1015
+			 */
1016
+		} elseif (
1017
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', true)
1018
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
1019
+		) {
1020
+			$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_sent);
1021
+			if ($queue_count > 0) {
1022
+				EE_Error::add_success(
1023
+					sprintf(
1024
+						_n(
1025
+							'%d message successfully sent.',
1026
+							'%d messages successfully sent.',
1027
+							$queue_count,
1028
+							'event_espresso'
1029
+						),
1030
+						$queue_count
1031
+					)
1032
+				);
1033
+			} else {
1034
+				EE_Error::add_error(
1035
+					__('No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
1036
+						'event_espresso'),
1037
+					__FILE__, __FUNCTION__, __LINE__
1038
+				);
1039
+			}
1040
+		} else {
1041
+			EE_Error::add_error(
1042
+				__('No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
1043
+					'event_espresso'),
1044
+				__FILE__, __FUNCTION__, __LINE__
1045
+			);
1046
+		}
1047
+		return (bool)$queue_count;
1048
+	}
1049
+
1050
+
1051
+	/**
1052
+	 * debug
1053
+	 *
1054
+	 * @param string          $class
1055
+	 * @param string          $func
1056
+	 * @param string          $line
1057
+	 * @param \EE_Transaction $transaction
1058
+	 * @param array           $info
1059
+	 * @param bool            $display_request
1060
+	 */
1061
+	protected static function log(
1062
+		$class = '',
1063
+		$func = '',
1064
+		$line = '',
1065
+		EE_Transaction $transaction,
1066
+		$info = array(),
1067
+		$display_request = false
1068
+	) {
1069
+		if (WP_DEBUG && false) {
1070
+			if ($transaction instanceof EE_Transaction) {
1071
+				// don't serialize objects
1072
+				$info                  = EEH_Debug_Tools::strip_objects($info);
1073
+				$info['TXN_status']    = $transaction->status_ID();
1074
+				$info['TXN_reg_steps'] = $transaction->reg_steps();
1075
+				if ($transaction->ID()) {
1076
+					$index = 'EE_Transaction: ' . $transaction->ID();
1077
+					EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
1078
+				}
1079
+			}
1080
+		}
1081
+
1082
+	}
1083
+
1084
+
1085
+	/**
1086
+	 *  Resets all the static properties in this class when called.
1087
+	 */
1088
+	public static function reset()
1089
+	{
1090
+		self::$_EEMSG                    = null;
1091
+		self::$_message_resource_manager = null;
1092
+		self::$_MSG_PROCESSOR            = null;
1093
+		self::$_MSG_PATHS                = null;
1094
+		self::$_TMP_PACKS                = array();
1095
+	}
1096 1096
 
1097 1097
 }
1098 1098
 // End of file EED_Messages.module.php
Please login to merge, or discard this patch.
core/services/database/TableManager.php 2 patches
Indentation   +245 added lines, -247 removed lines patch added patch discarded remove patch
@@ -17,254 +17,252 @@
 block discarded – undo
17 17
 class TableManager extends \EE_Base
18 18
 {
19 19
 
20
-    /**
21
-     * @var TableAnalysis $table_analysis
22
-     */
23
-    private $table_analysis;
24
-
25
-
26
-
27
-    /**
28
-     * TableManager constructor.
29
-     *
30
-     * @param TableAnalysis $TableAnalysis
31
-     */
32
-    public function __construct(TableAnalysis $TableAnalysis)
33
-    {
34
-        $this->table_analysis = $TableAnalysis;
35
-    }
36
-
37
-
38
-
39
-    /**
40
-     * Gets the injected table analyzer, or throws an exception
41
-     *
42
-     * @return TableAnalysis
43
-     * @throws \EE_Error
44
-     */
45
-    protected function getTableAnalysis()
46
-    {
47
-        if ($this->table_analysis instanceof TableAnalysis) {
48
-            return $this->table_analysis;
49
-        } else {
50
-            throw new \EE_Error(
51
-                sprintf(
52
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
53
-                    get_class($this)
54
-                )
55
-            );
56
-        }
57
-    }
58
-
59
-
60
-
61
-    /**
62
-     * @param string $table_name which can optionally start with $wpdb->prefix or not
63
-     * @param string $column_name
64
-     * @param string $column_info
65
-     * @return bool|false|int
66
-     */
67
-    public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
68
-    {
69
-        if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
70
-            return false;
71
-        }
72
-        global $wpdb;
73
-        $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
74
-        $columns = $this->getTableColumns($table_name);
75
-        if ( ! in_array($column_name, $columns)) {
76
-            $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
77
-            return $wpdb->query($alter_query);
78
-        }
79
-        return true;
80
-    }
81
-
82
-
83
-
84
-    /**
85
-     * Gets the name of all columns on the  table. $table_name can
86
-     * optionally start with $wpdb->prefix or not
87
-     *
88
-     * @global \wpdb $wpdb
89
-     * @param string $table_name
90
-     * @return array
91
-     */
92
-    public function getTableColumns($table_name)
93
-    {
94
-        global $wpdb;
95
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
96
-        $field_array = array();
97
-        if ( ! empty($table_name)) {
98
-            $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
99
-            if ($columns !== false) {
100
-                foreach ($columns as $column) {
101
-                    $field_array[] = $column->Field;
102
-                }
103
-            }
104
-        }
105
-        return $field_array;
106
-    }
107
-
108
-
109
-
110
-    /**
111
-     * Drops the specified table from the database. $table_name can
112
-     * optionally start with $wpdb->prefix or not
113
-     *
114
-     * @global \wpdb $wpdb
115
-     * @param string $table_name
116
-     * @return int
117
-     */
118
-    public function dropTable($table_name)
119
-    {
120
-        global $wpdb;
121
-        if ($this->getTableAnalysis()->tableExists($table_name)) {
122
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
123
-            return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
124
-        }
125
-        return 0;
126
-    }
127
-
128
-
129
-
130
-    /**
131
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
132
-     * each table name provided has a wpdb prefix attached, and that it exists.
133
-     * Returns the list actually deleted
134
-     *
135
-     * @global WPDB $wpdb
136
-     * @param array $table_names
137
-     * @return array of table names which we deleted
138
-     */
139
-    public function dropTables($table_names)
140
-    {
141
-        $tables_to_delete = array();
142
-        foreach ($table_names as $table_name) {
143
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
144
-            if ($this->getTableAnalysis()->tableExists($table_name)) {
145
-                $tables_to_delete[$table_name] = $table_name;
146
-            }
147
-        }
148
-        if( ! empty( $tables_to_delete ) ) {
149
-            global $wpdb;
150
-            //make sure we only have a unique strings in the array.
151
-            $tables_to_delete = array_unique($tables_to_delete);
152
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
153
-        }
154
-        return $tables_to_delete;
155
-    }
156
-
157
-
158
-
159
-    /**
160
-     * Drops the specified index from the specified table. $table_name can
161
-     * optionally start with $wpdb->prefix or not
162
-
163
-     *
20
+	/**
21
+	 * @var TableAnalysis $table_analysis
22
+	 */
23
+	private $table_analysis;
24
+
25
+
26
+
27
+	/**
28
+	 * TableManager constructor.
29
+	 *
30
+	 * @param TableAnalysis $TableAnalysis
31
+	 */
32
+	public function __construct(TableAnalysis $TableAnalysis)
33
+	{
34
+		$this->table_analysis = $TableAnalysis;
35
+	}
36
+
37
+
38
+
39
+	/**
40
+	 * Gets the injected table analyzer, or throws an exception
41
+	 *
42
+	 * @return TableAnalysis
43
+	 * @throws \EE_Error
44
+	 */
45
+	protected function getTableAnalysis()
46
+	{
47
+		if ($this->table_analysis instanceof TableAnalysis) {
48
+			return $this->table_analysis;
49
+		} else {
50
+			throw new \EE_Error(
51
+				sprintf(
52
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
53
+					get_class($this)
54
+				)
55
+			);
56
+		}
57
+	}
58
+
59
+
60
+
61
+	/**
62
+	 * @param string $table_name which can optionally start with $wpdb->prefix or not
63
+	 * @param string $column_name
64
+	 * @param string $column_info
65
+	 * @return bool|false|int
66
+	 */
67
+	public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
68
+	{
69
+		if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
70
+			return false;
71
+		}
72
+		global $wpdb;
73
+		$full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
74
+		$columns = $this->getTableColumns($table_name);
75
+		if ( ! in_array($column_name, $columns)) {
76
+			$alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
77
+			return $wpdb->query($alter_query);
78
+		}
79
+		return true;
80
+	}
81
+
82
+
83
+
84
+	/**
85
+	 * Gets the name of all columns on the  table. $table_name can
86
+	 * optionally start with $wpdb->prefix or not
87
+	 *
88
+	 * @global \wpdb $wpdb
89
+	 * @param string $table_name
90
+	 * @return array
91
+	 */
92
+	public function getTableColumns($table_name)
93
+	{
94
+		global $wpdb;
95
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
96
+		$field_array = array();
97
+		if ( ! empty($table_name)) {
98
+			$columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
99
+			if ($columns !== false) {
100
+				foreach ($columns as $column) {
101
+					$field_array[] = $column->Field;
102
+				}
103
+			}
104
+		}
105
+		return $field_array;
106
+	}
107
+
108
+
109
+
110
+	/**
111
+	 * Drops the specified table from the database. $table_name can
112
+	 * optionally start with $wpdb->prefix or not
113
+	 *
114
+	 * @global \wpdb $wpdb
115
+	 * @param string $table_name
116
+	 * @return int
117
+	 */
118
+	public function dropTable($table_name)
119
+	{
120
+		global $wpdb;
121
+		if ($this->getTableAnalysis()->tableExists($table_name)) {
122
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
123
+			return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
124
+		}
125
+		return 0;
126
+	}
127
+
128
+
129
+
130
+	/**
131
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
132
+	 * each table name provided has a wpdb prefix attached, and that it exists.
133
+	 * Returns the list actually deleted
134
+	 *
135
+	 * @global WPDB $wpdb
136
+	 * @param array $table_names
137
+	 * @return array of table names which we deleted
138
+	 */
139
+	public function dropTables($table_names)
140
+	{
141
+		$tables_to_delete = array();
142
+		foreach ($table_names as $table_name) {
143
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
144
+			if ($this->getTableAnalysis()->tableExists($table_name)) {
145
+				$tables_to_delete[$table_name] = $table_name;
146
+			}
147
+		}
148
+		if( ! empty( $tables_to_delete ) ) {
149
+			global $wpdb;
150
+			//make sure we only have a unique strings in the array.
151
+			$tables_to_delete = array_unique($tables_to_delete);
152
+			$wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
153
+		}
154
+		return $tables_to_delete;
155
+	}
156
+
157
+
158
+
159
+	/**
160
+	 * Drops the specified index from the specified table. $table_name can
161
+	 * optionally start with $wpdb->prefix or not
162
+	 *
164 163
 *@global \wpdb       $wpdb
165
-     * @param string $table_name
166
-     * @param string $index_name
167
-     * @return int the number of indexes dropped. False if there was a datbase error
168
-     */
169
-    public function dropIndex($table_name, $index_name)
170
-    {
171
-        if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
172
-            return 0;
173
-        }
174
-        global $wpdb;
175
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
176
-        $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'";
177
-        if (
178
-            $this->getTableAnalysis()->tableExists($table_name)
179
-            && $wpdb->get_var($index_exists_query)
180
-               === $table_name //using get_var with the $index_exists_query returns the table's name
181
-        ) {
182
-            return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
183
-        }
184
-        return 0;
185
-    }
186
-
187
-
188
-
189
-    /**
190
-     * Just creates the requested table. $table_name can
191
-     * optionally start with $wpdb->prefix or not
192
-
193
-     *
164
+	 * @param string $table_name
165
+	 * @param string $index_name
166
+	 * @return int the number of indexes dropped. False if there was a datbase error
167
+	 */
168
+	public function dropIndex($table_name, $index_name)
169
+	{
170
+		if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
171
+			return 0;
172
+		}
173
+		global $wpdb;
174
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
175
+		$index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'";
176
+		if (
177
+			$this->getTableAnalysis()->tableExists($table_name)
178
+			&& $wpdb->get_var($index_exists_query)
179
+			   === $table_name //using get_var with the $index_exists_query returns the table's name
180
+		) {
181
+			return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
182
+		}
183
+		return 0;
184
+	}
185
+
186
+
187
+
188
+	/**
189
+	 * Just creates the requested table. $table_name can
190
+	 * optionally start with $wpdb->prefix or not
191
+	 *
194 192
 *@param string       $table_name
195
-     * @param string $create_sql defining the table's columns and indexes
196
-     * @param string $engine     (no need to specify "ENGINE=", that's implied)
197
-     * @return void
198
-     * @throws \EE_Error
199
-     */
200
-    public function createTable($table_name, $create_sql, $engine = 'MyISAM')
201
-    {
202
-        // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
203
-        if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
204
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
205
-            /** @var \wpdb $wpdb */
206
-            global $wpdb;
207
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
208
-
209
-            //get $wpdb to echo errors, but buffer them. This way at least WE know an error
210
-            //happened. And then we can choose to tell the end user
211
-            $old_show_errors_policy = $wpdb->show_errors(true);
212
-            $old_error_suppression_policy = $wpdb->suppress_errors(false);
213
-            ob_start();
214
-            dbDelta($SQL);
215
-            $output = ob_get_contents();
216
-            ob_end_clean();
217
-            $wpdb->show_errors($old_show_errors_policy);
218
-            $wpdb->suppress_errors($old_error_suppression_policy);
219
-            if ( ! empty($output)) {
220
-                throw new \EE_Error($output);
221
-            }
222
-        } else {
223
-            throw new \EE_Error(
224
-                sprintf(
225
-                    __('The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
226
-                        'event_espresso'),
227
-                    '<br />',
228
-                    $create_sql
229
-                )
230
-            );
231
-        }
232
-    }
233
-
234
-
235
-
236
-    /**
237
-     * Drops the specified index if it's size differs from $desired_index_size.
238
-     * WordPress' dbdelta method doesn't automatically change index sizes, so this
239
-     * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
240
-     * If the table doesn't exist, or it exists but the index does not, or returns false
241
-     *
242
-     * @param string $table_name
243
-     * @param string $index_name
244
-     * @param string $column_name if none is provided, we assume the column name matches the index (often true in EE)
245
-     * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
246
-     * @return bool whether an index was dropped or not
247
-     * @throws /EE_Error if table analysis object isn't defined
248
-     */
249
-    public function dropIndexIfSizeNot($table_name, $index_name, $column_name = null, $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE)
250
-    {
251
-        if($column_name === null){
252
-            $column_name = $index_name;
253
-        }
254
-        if(!$this->getTableAnalysis()->tableExists($table_name)){
255
-            return false;
256
-        }
257
-        $index_entries = $this->getTableAnalysis()->showIndexes($table_name,$index_name);
258
-        if(empty($index_entries)){
259
-            return false;
260
-        }
261
-        foreach($index_entries as $index_entry){
262
-            if( $column_name === $index_entry->Column_name
263
-                && (string)$desired_index_size !== $index_entry->Sub_part){
264
-                return $this->dropIndex($table_name,$index_name);
265
-            }
266
-        }
267
-        return false;
268
-    }
193
+	 * @param string $create_sql defining the table's columns and indexes
194
+	 * @param string $engine     (no need to specify "ENGINE=", that's implied)
195
+	 * @return void
196
+	 * @throws \EE_Error
197
+	 */
198
+	public function createTable($table_name, $create_sql, $engine = 'MyISAM')
199
+	{
200
+		// does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
201
+		if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
202
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
203
+			/** @var \wpdb $wpdb */
204
+			global $wpdb;
205
+			$SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
206
+
207
+			//get $wpdb to echo errors, but buffer them. This way at least WE know an error
208
+			//happened. And then we can choose to tell the end user
209
+			$old_show_errors_policy = $wpdb->show_errors(true);
210
+			$old_error_suppression_policy = $wpdb->suppress_errors(false);
211
+			ob_start();
212
+			dbDelta($SQL);
213
+			$output = ob_get_contents();
214
+			ob_end_clean();
215
+			$wpdb->show_errors($old_show_errors_policy);
216
+			$wpdb->suppress_errors($old_error_suppression_policy);
217
+			if ( ! empty($output)) {
218
+				throw new \EE_Error($output);
219
+			}
220
+		} else {
221
+			throw new \EE_Error(
222
+				sprintf(
223
+					__('The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
224
+						'event_espresso'),
225
+					'<br />',
226
+					$create_sql
227
+				)
228
+			);
229
+		}
230
+	}
231
+
232
+
233
+
234
+	/**
235
+	 * Drops the specified index if it's size differs from $desired_index_size.
236
+	 * WordPress' dbdelta method doesn't automatically change index sizes, so this
237
+	 * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
238
+	 * If the table doesn't exist, or it exists but the index does not, or returns false
239
+	 *
240
+	 * @param string $table_name
241
+	 * @param string $index_name
242
+	 * @param string $column_name if none is provided, we assume the column name matches the index (often true in EE)
243
+	 * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
244
+	 * @return bool whether an index was dropped or not
245
+	 * @throws /EE_Error if table analysis object isn't defined
246
+	 */
247
+	public function dropIndexIfSizeNot($table_name, $index_name, $column_name = null, $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE)
248
+	{
249
+		if($column_name === null){
250
+			$column_name = $index_name;
251
+		}
252
+		if(!$this->getTableAnalysis()->tableExists($table_name)){
253
+			return false;
254
+		}
255
+		$index_entries = $this->getTableAnalysis()->showIndexes($table_name,$index_name);
256
+		if(empty($index_entries)){
257
+			return false;
258
+		}
259
+		foreach($index_entries as $index_entry){
260
+			if( $column_name === $index_entry->Column_name
261
+				&& (string)$desired_index_size !== $index_entry->Sub_part){
262
+				return $this->dropIndex($table_name,$index_name);
263
+			}
264
+		}
265
+		return false;
266
+	}
269 267
 
270 268
 }
Please login to merge, or discard this patch.
Spacing   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -145,11 +145,11 @@  discard block
 block discarded – undo
145 145
                 $tables_to_delete[$table_name] = $table_name;
146 146
             }
147 147
         }
148
-        if( ! empty( $tables_to_delete ) ) {
148
+        if ( ! empty($tables_to_delete)) {
149 149
             global $wpdb;
150 150
             //make sure we only have a unique strings in the array.
151 151
             $tables_to_delete = array_unique($tables_to_delete);
152
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
152
+            $wpdb->query('DROP TABLE '.implode(', ', $tables_to_delete));
153 153
         }
154 154
         return $tables_to_delete;
155 155
     }
@@ -204,7 +204,7 @@  discard block
 block discarded – undo
204 204
             $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
205 205
             /** @var \wpdb $wpdb */
206 206
             global $wpdb;
207
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
207
+            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} ".$wpdb->get_charset_collate();
208 208
 
209 209
             //get $wpdb to echo errors, but buffer them. This way at least WE know an error
210 210
             //happened. And then we can choose to tell the end user
@@ -248,20 +248,20 @@  discard block
 block discarded – undo
248 248
      */
249 249
     public function dropIndexIfSizeNot($table_name, $index_name, $column_name = null, $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE)
250 250
     {
251
-        if($column_name === null){
251
+        if ($column_name === null) {
252 252
             $column_name = $index_name;
253 253
         }
254
-        if(!$this->getTableAnalysis()->tableExists($table_name)){
254
+        if ( ! $this->getTableAnalysis()->tableExists($table_name)) {
255 255
             return false;
256 256
         }
257
-        $index_entries = $this->getTableAnalysis()->showIndexes($table_name,$index_name);
258
-        if(empty($index_entries)){
257
+        $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
258
+        if (empty($index_entries)) {
259 259
             return false;
260 260
         }
261
-        foreach($index_entries as $index_entry){
262
-            if( $column_name === $index_entry->Column_name
263
-                && (string)$desired_index_size !== $index_entry->Sub_part){
264
-                return $this->dropIndex($table_name,$index_name);
261
+        foreach ($index_entries as $index_entry) {
262
+            if ($column_name === $index_entry->Column_name
263
+                && (string) $desired_index_size !== $index_entry->Sub_part) {
264
+                return $this->dropIndex($table_name, $index_name);
265 265
             }
266 266
         }
267 267
         return false;
Please login to merge, or discard this patch.
core/helpers/EEH_Activation.helper.php 1 patch
Indentation   +1653 added lines, -1653 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 
5 5
 
@@ -14,244 +14,244 @@  discard block
 block discarded – undo
14 14
 class EEH_Activation
15 15
 {
16 16
 
17
-    /**
18
-     * constant used to indicate a cron task is no longer in use
19
-     */
20
-    const cron_task_no_longer_in_use = 'no_longer_in_use';
21
-
22
-    /**
23
-     * option name that will indicate whether or not we still
24
-     * need to create EE's folders in the uploads directory
25
-     * (because if EE was installed without file system access,
26
-     * we need to request credentials before we can create them)
27
-     */
28
-    const upload_directories_incomplete_option_name = 'ee_upload_directories_incomplete';
29
-
30
-    /**
31
-     * WP_User->ID
32
-     *
33
-     * @var int
34
-     */
35
-    private static $_default_creator_id;
36
-
37
-    /**
38
-     * indicates whether or not we've already verified core's default data during this request,
39
-     * because after migrations are done, any addons activated while in maintenance mode
40
-     * will want to setup their own default data, and they might hook into core's default data
41
-     * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
42
-     * This prevents doing that for EVERY single addon.
43
-     *
44
-     * @var boolean
45
-     */
46
-    protected static $_initialized_db_content_already_in_this_request = false;
47
-
48
-    /**
49
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
50
-     */
51
-    private static $table_analysis;
52
-
53
-    /**
54
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
55
-     */
56
-    private static $table_manager;
57
-
58
-
59
-    /**
60
-     * @return \EventEspresso\core\services\database\TableAnalysis
61
-     */
62
-    public static function getTableAnalysis()
63
-    {
64
-        if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
65
-            self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
66
-        }
67
-        return self::$table_analysis;
68
-    }
69
-
70
-
71
-    /**
72
-     * @return \EventEspresso\core\services\database\TableManager
73
-     */
74
-    public static function getTableManager()
75
-    {
76
-        if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
77
-            self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
78
-        }
79
-        return self::$table_manager;
80
-    }
81
-
82
-
83
-    /**
84
-     *    _ensure_table_name_has_prefix
85
-     *
86
-     * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
87
-     * @access     public
88
-     * @static
89
-     * @param $table_name
90
-     * @return string
91
-     */
92
-    public static function ensure_table_name_has_prefix($table_name)
93
-    {
94
-        return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
95
-    }
96
-
97
-
98
-    /**
99
-     *    system_initialization
100
-     *    ensures the EE configuration settings are loaded with at least default options set
101
-     *    and that all critical EE pages have been generated with the appropriate shortcodes in place
102
-     *
103
-     * @access public
104
-     * @static
105
-     * @return void
106
-     */
107
-    public static function system_initialization()
108
-    {
109
-        EEH_Activation::reset_and_update_config();
110
-        //which is fired BEFORE activation of plugin anyways
111
-        EEH_Activation::verify_default_pages_exist();
112
-    }
113
-
114
-
115
-    /**
116
-     * Sets the database schema and creates folders. This should
117
-     * be called on plugin activation and reactivation
118
-     *
119
-     * @return boolean success, whether the database and folders are setup properly
120
-     * @throws \EE_Error
121
-     */
122
-    public static function initialize_db_and_folders()
123
-    {
124
-        $good_filesystem = EEH_Activation::create_upload_directories();
125
-        $good_db         = EEH_Activation::create_database_tables();
126
-        return $good_filesystem && $good_db;
127
-    }
128
-
129
-
130
-    /**
131
-     * assuming we have an up-to-date database schema, this will populate it
132
-     * with default and initial data. This should be called
133
-     * upon activation of a new plugin, reactivation, and at the end
134
-     * of running migration scripts
135
-     *
136
-     * @throws \EE_Error
137
-     */
138
-    public static function initialize_db_content()
139
-    {
140
-        //let's avoid doing all this logic repeatedly, especially when addons are requesting it
141
-        if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
142
-            return;
143
-        }
144
-        EEH_Activation::$_initialized_db_content_already_in_this_request = true;
145
-
146
-        EEH_Activation::initialize_system_questions();
147
-        EEH_Activation::insert_default_status_codes();
148
-        EEH_Activation::generate_default_message_templates();
149
-        EEH_Activation::create_no_ticket_prices_array();
150
-        EE_Registry::instance()->CAP->init_caps();
151
-
152
-        EEH_Activation::validate_messages_system();
153
-        EEH_Activation::insert_default_payment_methods();
154
-        //in case we've
155
-        EEH_Activation::remove_cron_tasks();
156
-        EEH_Activation::create_cron_tasks();
157
-        // remove all TXN locks since that is being done via extra meta now
158
-        delete_option('ee_locked_transactions');
159
-        //also, check for CAF default db content
160
-        do_action('AHEE__EEH_Activation__initialize_db_content');
161
-        //also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
162
-        //which users really won't care about on initial activation
163
-        EE_Error::overwrite_success();
164
-    }
165
-
166
-
167
-    /**
168
-     * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
169
-     * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
170
-     * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
171
-     * (null)
172
-     *
173
-     * @param string $which_to_include can be 'current' (ones that are currently in use),
174
-     *                                 'old' (only returns ones that should no longer be used),or 'all',
175
-     * @return array
176
-     * @throws \EE_Error
177
-     */
178
-    public static function get_cron_tasks($which_to_include)
179
-    {
180
-        $cron_tasks = apply_filters(
181
-            'FHEE__EEH_Activation__get_cron_tasks',
182
-            array(
183
-                'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
17
+	/**
18
+	 * constant used to indicate a cron task is no longer in use
19
+	 */
20
+	const cron_task_no_longer_in_use = 'no_longer_in_use';
21
+
22
+	/**
23
+	 * option name that will indicate whether or not we still
24
+	 * need to create EE's folders in the uploads directory
25
+	 * (because if EE was installed without file system access,
26
+	 * we need to request credentials before we can create them)
27
+	 */
28
+	const upload_directories_incomplete_option_name = 'ee_upload_directories_incomplete';
29
+
30
+	/**
31
+	 * WP_User->ID
32
+	 *
33
+	 * @var int
34
+	 */
35
+	private static $_default_creator_id;
36
+
37
+	/**
38
+	 * indicates whether or not we've already verified core's default data during this request,
39
+	 * because after migrations are done, any addons activated while in maintenance mode
40
+	 * will want to setup their own default data, and they might hook into core's default data
41
+	 * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
42
+	 * This prevents doing that for EVERY single addon.
43
+	 *
44
+	 * @var boolean
45
+	 */
46
+	protected static $_initialized_db_content_already_in_this_request = false;
47
+
48
+	/**
49
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
50
+	 */
51
+	private static $table_analysis;
52
+
53
+	/**
54
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
55
+	 */
56
+	private static $table_manager;
57
+
58
+
59
+	/**
60
+	 * @return \EventEspresso\core\services\database\TableAnalysis
61
+	 */
62
+	public static function getTableAnalysis()
63
+	{
64
+		if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
65
+			self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
66
+		}
67
+		return self::$table_analysis;
68
+	}
69
+
70
+
71
+	/**
72
+	 * @return \EventEspresso\core\services\database\TableManager
73
+	 */
74
+	public static function getTableManager()
75
+	{
76
+		if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
77
+			self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
78
+		}
79
+		return self::$table_manager;
80
+	}
81
+
82
+
83
+	/**
84
+	 *    _ensure_table_name_has_prefix
85
+	 *
86
+	 * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
87
+	 * @access     public
88
+	 * @static
89
+	 * @param $table_name
90
+	 * @return string
91
+	 */
92
+	public static function ensure_table_name_has_prefix($table_name)
93
+	{
94
+		return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
95
+	}
96
+
97
+
98
+	/**
99
+	 *    system_initialization
100
+	 *    ensures the EE configuration settings are loaded with at least default options set
101
+	 *    and that all critical EE pages have been generated with the appropriate shortcodes in place
102
+	 *
103
+	 * @access public
104
+	 * @static
105
+	 * @return void
106
+	 */
107
+	public static function system_initialization()
108
+	{
109
+		EEH_Activation::reset_and_update_config();
110
+		//which is fired BEFORE activation of plugin anyways
111
+		EEH_Activation::verify_default_pages_exist();
112
+	}
113
+
114
+
115
+	/**
116
+	 * Sets the database schema and creates folders. This should
117
+	 * be called on plugin activation and reactivation
118
+	 *
119
+	 * @return boolean success, whether the database and folders are setup properly
120
+	 * @throws \EE_Error
121
+	 */
122
+	public static function initialize_db_and_folders()
123
+	{
124
+		$good_filesystem = EEH_Activation::create_upload_directories();
125
+		$good_db         = EEH_Activation::create_database_tables();
126
+		return $good_filesystem && $good_db;
127
+	}
128
+
129
+
130
+	/**
131
+	 * assuming we have an up-to-date database schema, this will populate it
132
+	 * with default and initial data. This should be called
133
+	 * upon activation of a new plugin, reactivation, and at the end
134
+	 * of running migration scripts
135
+	 *
136
+	 * @throws \EE_Error
137
+	 */
138
+	public static function initialize_db_content()
139
+	{
140
+		//let's avoid doing all this logic repeatedly, especially when addons are requesting it
141
+		if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
142
+			return;
143
+		}
144
+		EEH_Activation::$_initialized_db_content_already_in_this_request = true;
145
+
146
+		EEH_Activation::initialize_system_questions();
147
+		EEH_Activation::insert_default_status_codes();
148
+		EEH_Activation::generate_default_message_templates();
149
+		EEH_Activation::create_no_ticket_prices_array();
150
+		EE_Registry::instance()->CAP->init_caps();
151
+
152
+		EEH_Activation::validate_messages_system();
153
+		EEH_Activation::insert_default_payment_methods();
154
+		//in case we've
155
+		EEH_Activation::remove_cron_tasks();
156
+		EEH_Activation::create_cron_tasks();
157
+		// remove all TXN locks since that is being done via extra meta now
158
+		delete_option('ee_locked_transactions');
159
+		//also, check for CAF default db content
160
+		do_action('AHEE__EEH_Activation__initialize_db_content');
161
+		//also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
162
+		//which users really won't care about on initial activation
163
+		EE_Error::overwrite_success();
164
+	}
165
+
166
+
167
+	/**
168
+	 * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
169
+	 * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
170
+	 * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
171
+	 * (null)
172
+	 *
173
+	 * @param string $which_to_include can be 'current' (ones that are currently in use),
174
+	 *                                 'old' (only returns ones that should no longer be used),or 'all',
175
+	 * @return array
176
+	 * @throws \EE_Error
177
+	 */
178
+	public static function get_cron_tasks($which_to_include)
179
+	{
180
+		$cron_tasks = apply_filters(
181
+			'FHEE__EEH_Activation__get_cron_tasks',
182
+			array(
183
+				'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
184 184
 //				'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions' => EEH_Activation::cron_task_no_longer_in_use, actually this is still in use
185
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
186
-                //there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
187
-                'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
188
-            )
189
-        );
190
-        if ($which_to_include === 'old') {
191
-            $cron_tasks = array_filter(
192
-                $cron_tasks,
193
-                function ($value) {
194
-                    return $value === EEH_Activation::cron_task_no_longer_in_use;
195
-                }
196
-            );
197
-        } elseif ($which_to_include === 'current') {
198
-            $cron_tasks = array_filter($cron_tasks);
199
-        } elseif (WP_DEBUG && $which_to_include !== 'all') {
200
-            throw new EE_Error(
201
-                sprintf(
202
-                    __(
203
-                        'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
204
-                        'event_espresso'
205
-                    ),
206
-                    $which_to_include
207
-                )
208
-            );
209
-        }
210
-        return $cron_tasks;
211
-    }
212
-
213
-
214
-    /**
215
-     * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
216
-     *
217
-     * @throws \EE_Error
218
-     */
219
-    public static function create_cron_tasks()
220
-    {
221
-
222
-        foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
223
-            if (! wp_next_scheduled($hook_name)) {
224
-                /**
225
-                 * This allows client code to define the initial start timestamp for this schedule.
226
-                 */
227
-                if (is_array($frequency)
228
-                    && count($frequency) === 2
229
-                    && isset($frequency[0], $frequency[1])
230
-                ) {
231
-                    $start_timestamp = $frequency[0];
232
-                    $frequency = $frequency[1];
233
-                } else {
234
-                    $start_timestamp = time();
235
-                }
236
-                wp_schedule_event($start_timestamp, $frequency, $hook_name);
237
-            }
238
-        }
239
-
240
-    }
241
-
242
-
243
-    /**
244
-     * Remove the currently-existing and now-removed cron tasks.
245
-     *
246
-     * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
247
-     * @throws \EE_Error
248
-     */
249
-    public static function remove_cron_tasks($remove_all = true)
250
-    {
251
-        $cron_tasks_to_remove = $remove_all ? 'all' : 'old';
252
-        $crons                = _get_cron_array();
253
-        $crons                = is_array($crons) ? $crons : array();
254
-        /* reminder of what $crons look like:
185
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
186
+				//there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
187
+				'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
188
+			)
189
+		);
190
+		if ($which_to_include === 'old') {
191
+			$cron_tasks = array_filter(
192
+				$cron_tasks,
193
+				function ($value) {
194
+					return $value === EEH_Activation::cron_task_no_longer_in_use;
195
+				}
196
+			);
197
+		} elseif ($which_to_include === 'current') {
198
+			$cron_tasks = array_filter($cron_tasks);
199
+		} elseif (WP_DEBUG && $which_to_include !== 'all') {
200
+			throw new EE_Error(
201
+				sprintf(
202
+					__(
203
+						'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
204
+						'event_espresso'
205
+					),
206
+					$which_to_include
207
+				)
208
+			);
209
+		}
210
+		return $cron_tasks;
211
+	}
212
+
213
+
214
+	/**
215
+	 * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
216
+	 *
217
+	 * @throws \EE_Error
218
+	 */
219
+	public static function create_cron_tasks()
220
+	{
221
+
222
+		foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
223
+			if (! wp_next_scheduled($hook_name)) {
224
+				/**
225
+				 * This allows client code to define the initial start timestamp for this schedule.
226
+				 */
227
+				if (is_array($frequency)
228
+					&& count($frequency) === 2
229
+					&& isset($frequency[0], $frequency[1])
230
+				) {
231
+					$start_timestamp = $frequency[0];
232
+					$frequency = $frequency[1];
233
+				} else {
234
+					$start_timestamp = time();
235
+				}
236
+				wp_schedule_event($start_timestamp, $frequency, $hook_name);
237
+			}
238
+		}
239
+
240
+	}
241
+
242
+
243
+	/**
244
+	 * Remove the currently-existing and now-removed cron tasks.
245
+	 *
246
+	 * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
247
+	 * @throws \EE_Error
248
+	 */
249
+	public static function remove_cron_tasks($remove_all = true)
250
+	{
251
+		$cron_tasks_to_remove = $remove_all ? 'all' : 'old';
252
+		$crons                = _get_cron_array();
253
+		$crons                = is_array($crons) ? $crons : array();
254
+		/* reminder of what $crons look like:
255 255
          * Top-level keys are timestamps, and their values are arrays.
256 256
          * The 2nd level arrays have keys with each of the cron task hook names to run at that time
257 257
          * and their values are arrays.
@@ -268,912 +268,912 @@  discard block
 block discarded – undo
268 268
          *					...
269 269
          *      ...
270 270
          */
271
-        $ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
272
-        foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
273
-            if (is_array($hooks_to_fire_at_time)) {
274
-                foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
275
-                    if (isset($ee_cron_tasks_to_remove[$hook_name])
276
-                        && is_array($ee_cron_tasks_to_remove[$hook_name])
277
-                    ) {
278
-                        unset($crons[$timestamp][$hook_name]);
279
-                    }
280
-                }
281
-                //also take care of any empty cron timestamps.
282
-                if (empty($hooks_to_fire_at_time)) {
283
-                    unset($crons[$timestamp]);
284
-                }
285
-            }
286
-        }
287
-        _set_cron_array($crons);
288
-    }
289
-
290
-
291
-    /**
292
-     *    CPT_initialization
293
-     *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
294
-     *
295
-     * @access public
296
-     * @static
297
-     * @return void
298
-     */
299
-    public static function CPT_initialization()
300
-    {
301
-        // register Custom Post Types
302
-        EE_Registry::instance()->load_core('Register_CPTs');
303
-        flush_rewrite_rules();
304
-    }
305
-
306
-
307
-
308
-    /**
309
-     *    reset_and_update_config
310
-     * The following code was moved over from EE_Config so that it will no longer run on every request.
311
-     * If there is old calendar config data saved, then it will get converted on activation.
312
-     * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
313
-     *
314
-     * @access public
315
-     * @static
316
-     * @return void
317
-     */
318
-    public static function reset_and_update_config()
319
-    {
320
-        do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
321
-        add_filter(
322
-            'FHEE__EE_Config___load_core_config__config_settings',
323
-            array('EEH_Activation', 'migrate_old_config_data'),
324
-            10,
325
-            3
326
-        );
327
-        //EE_Config::reset();
328
-        if (! EE_Config::logging_enabled()) {
329
-            delete_option(EE_Config::LOG_NAME);
330
-        }
331
-    }
332
-
333
-
334
-    /**
335
-     *    load_calendar_config
336
-     *
337
-     * @access    public
338
-     * @return    void
339
-     */
340
-    public static function load_calendar_config()
341
-    {
342
-        // grab array of all plugin folders and loop thru it
343
-        $plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
344
-        if (empty($plugins)) {
345
-            return;
346
-        }
347
-        foreach ($plugins as $plugin_path) {
348
-            // grab plugin folder name from path
349
-            $plugin = basename($plugin_path);
350
-            // drill down to Espresso plugins
351
-            // then to calendar related plugins
352
-            if (
353
-                strpos($plugin, 'espresso') !== false
354
-                || strpos($plugin, 'Espresso') !== false
355
-                || strpos($plugin, 'ee4') !== false
356
-                || strpos($plugin, 'EE4') !== false
357
-                || strpos($plugin, 'calendar') !== false
358
-            ) {
359
-                // this is what we are looking for
360
-                $calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
361
-                // does it exist in this folder ?
362
-                if (is_readable($calendar_config)) {
363
-                    // YEAH! let's load it
364
-                    require_once($calendar_config);
365
-                }
366
-            }
367
-        }
368
-    }
369
-
370
-
371
-
372
-    /**
373
-     *    _migrate_old_config_data
374
-     *
375
-     * @access    public
376
-     * @param array|stdClass $settings
377
-     * @param string         $config
378
-     * @param \EE_Config     $EE_Config
379
-     * @return \stdClass
380
-     */
381
-    public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
382
-    {
383
-        $convert_from_array = array('addons');
384
-        // in case old settings were saved as an array
385
-        if (is_array($settings) && in_array($config, $convert_from_array)) {
386
-            // convert existing settings to an object
387
-            $config_array = $settings;
388
-            $settings = new stdClass();
389
-            foreach ($config_array as $key => $value) {
390
-                if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
391
-                    $EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
392
-                } else {
393
-                    $settings->{$key} = $value;
394
-                }
395
-            }
396
-            add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
397
-        }
398
-        return $settings;
399
-    }
400
-
401
-
402
-    /**
403
-     * deactivate_event_espresso
404
-     *
405
-     * @access public
406
-     * @static
407
-     * @return void
408
-     */
409
-    public static function deactivate_event_espresso()
410
-    {
411
-        // check permissions
412
-        if (current_user_can('activate_plugins')) {
413
-            deactivate_plugins(EE_PLUGIN_BASENAME, true);
414
-        }
415
-    }
416
-
417
-
418
-
419
-
420
-
421
-    /**
422
-     * verify_default_pages_exist
423
-     *
424
-     * @access public
425
-     * @static
426
-     * @return void
427
-     */
428
-    public static function verify_default_pages_exist()
429
-    {
430
-        $critical_page_problem = false;
431
-        $critical_pages = array(
432
-            array(
433
-                'id'   => 'reg_page_id',
434
-                'name' => __('Registration Checkout', 'event_espresso'),
435
-                'post' => null,
436
-                'code' => 'ESPRESSO_CHECKOUT',
437
-            ),
438
-            array(
439
-                'id'   => 'txn_page_id',
440
-                'name' => __('Transactions', 'event_espresso'),
441
-                'post' => null,
442
-                'code' => 'ESPRESSO_TXN_PAGE',
443
-            ),
444
-            array(
445
-                'id'   => 'thank_you_page_id',
446
-                'name' => __('Thank You', 'event_espresso'),
447
-                'post' => null,
448
-                'code' => 'ESPRESSO_THANK_YOU',
449
-            ),
450
-            array(
451
-                'id'   => 'cancel_page_id',
452
-                'name' => __('Registration Cancelled', 'event_espresso'),
453
-                'post' => null,
454
-                'code' => 'ESPRESSO_CANCELLED',
455
-            ),
456
-        );
457
-        $EE_Core_Config = EE_Registry::instance()->CFG->core;
458
-        foreach ($critical_pages as $critical_page) {
459
-            // is critical page ID set in config ?
460
-            if ($EE_Core_Config->{$critical_page['id']} !== false) {
461
-                // attempt to find post by ID
462
-                $critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
463
-            }
464
-            // no dice?
465
-            if ($critical_page['post'] === null) {
466
-                // attempt to find post by title
467
-                $critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
468
-                // still nothing?
469
-                if ($critical_page['post'] === null) {
470
-                    $critical_page = EEH_Activation::create_critical_page($critical_page);
471
-                    // REALLY? Still nothing ??!?!?
472
-                    if ($critical_page['post'] === null) {
473
-                        $msg = __(
474
-                            'The Event Espresso critical page configuration settings could not be updated.',
475
-                            'event_espresso'
476
-                        );
477
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
478
-                        break;
479
-                    }
480
-                }
481
-            }
482
-            // check that Post ID matches critical page ID in config
483
-            if (
484
-                isset($critical_page['post']->ID)
485
-                && $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
486
-            ) {
487
-                //update Config with post ID
488
-                $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
489
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
490
-                    $msg = __(
491
-                        'The Event Espresso critical page configuration settings could not be updated.',
492
-                        'event_espresso'
493
-                    );
494
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
495
-                }
496
-            }
497
-            $critical_page_problem =
498
-                ! isset($critical_page['post']->post_status)
499
-                || $critical_page['post']->post_status !== 'publish'
500
-                || strpos($critical_page['post']->post_content, $critical_page['code']) === false
501
-                    ? true
502
-                    : $critical_page_problem;
503
-        }
504
-        if ($critical_page_problem) {
505
-            $msg = sprintf(
506
-                __(
507
-                    'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
508
-                    'event_espresso'
509
-                ),
510
-                '<a href="'
511
-                . admin_url('admin.php?page=espresso_general_settings&action=critical_pages')
512
-                . '">'
513
-                . __('Event Espresso Critical Pages Settings', 'event_espresso')
514
-                . '</a>'
515
-            );
516
-            EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
517
-        }
518
-        if (EE_Error::has_notices()) {
519
-            EE_Error::get_notices(false, true, true);
520
-        }
521
-    }
522
-
523
-
524
-
525
-    /**
526
-     * Returns the first post which uses the specified shortcode
527
-     *
528
-     * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
529
-     *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
530
-     *                             "[ESPRESSO_THANK_YOU"
531
-     *                             (we don't search for the closing shortcode bracket because they might have added
532
-     *                             parameter to the shortcode
533
-     * @return WP_Post or NULl
534
-     */
535
-    public static function get_page_by_ee_shortcode($ee_shortcode)
536
-    {
537
-        global $wpdb;
538
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
539
-        $post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
540
-        if ($post_id) {
541
-            return get_post($post_id);
542
-        } else {
543
-            return null;
544
-        }
545
-    }
546
-
547
-
548
-    /**
549
-     *    This function generates a post for critical espresso pages
550
-     *
551
-     * @access public
552
-     * @static
553
-     * @param array $critical_page
554
-     * @return array
555
-     */
556
-    public static function create_critical_page($critical_page)
557
-    {
558
-
559
-        $post_args = array(
560
-            'post_title'     => $critical_page['name'],
561
-            'post_status'    => 'publish',
562
-            'post_type'      => 'page',
563
-            'comment_status' => 'closed',
564
-            'post_content'   => '[' . $critical_page['code'] . ']',
565
-        );
566
-
567
-        $post_id = wp_insert_post($post_args);
568
-        if (! $post_id) {
569
-            $msg = sprintf(
570
-                __('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
571
-                $critical_page['name']
572
-            );
573
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
574
-            return $critical_page;
575
-        }
576
-        // get newly created post's details
577
-        if (! $critical_page['post'] = get_post($post_id)) {
578
-            $msg = sprintf(
579
-                __('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
580
-                $critical_page['name']
581
-            );
582
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
583
-        }
584
-
585
-        return $critical_page;
586
-
587
-    }
588
-
589
-
590
-
591
-
592
-    /**
593
-     * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
594
-     * The role being used to check is filterable.
595
-     *
596
-     * @since  4.6.0
597
-     * @global WPDB $wpdb
598
-     * @return mixed null|int WP_user ID or NULL
599
-     */
600
-    public static function get_default_creator_id()
601
-    {
602
-        global $wpdb;
603
-        if ( ! empty(self::$_default_creator_id)) {
604
-            return self::$_default_creator_id;
605
-        }/**/
606
-        $role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
607
-        //let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
608
-        $pre_filtered_id = apply_filters(
609
-            'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
610
-            false,
611
-            $role_to_check
612
-        );
613
-        if ($pre_filtered_id !== false) {
614
-            return (int)$pre_filtered_id;
615
-        }
616
-        $capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
617
-        $query = $wpdb->prepare(
618
-            "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
619
-            '%' . $role_to_check . '%'
620
-        );
621
-        $user_id = $wpdb->get_var($query);
622
-        $user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
623
-        if ($user_id && (int)$user_id) {
624
-            self::$_default_creator_id = (int)$user_id;
625
-            return self::$_default_creator_id;
626
-        } else {
627
-            return null;
628
-        }
629
-    }
630
-
631
-
632
-
633
-    /**
634
-     * used by EE and EE addons during plugin activation to create tables.
635
-     * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
636
-     * but includes extra logic regarding activations.
637
-     *
638
-     * @access public
639
-     * @static
640
-     * @param string  $table_name              without the $wpdb->prefix
641
-     * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
642
-     *                                         table query)
643
-     * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
644
-     * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
645
-     *                                         and new once this function is done (ie, you really do want to CREATE a
646
-     *                                         table, and expect it to be empty once you're done) leave as FALSE when
647
-     *                                         you just want to verify the table exists and matches this definition
648
-     *                                         (and if it HAS data in it you want to leave it be)
649
-     * @return void
650
-     * @throws EE_Error if there are database errors
651
-     */
652
-    public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
653
-    {
654
-        if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
655
-            return;
656
-        }
657
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
658
-        if ( ! function_exists('dbDelta')) {
659
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
660
-        }
661
-        $tableAnalysis = \EEH_Activation::getTableAnalysis();
662
-        $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
663
-        // do we need to first delete an existing version of this table ?
664
-        if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
665
-            // ok, delete the table... but ONLY if it's empty
666
-            $deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
667
-            // table is NOT empty, are you SURE you want to delete this table ???
668
-            if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
669
-                \EEH_Activation::getTableManager()->dropTable($wp_table_name);
670
-            } else if ( ! $deleted_safely) {
671
-                // so we should be more cautious rather than just dropping tables so easily
672
-                error_log(
673
-                    sprintf(
674
-                        __(
675
-                            'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
676
-                            'event_espresso'
677
-                        ),
678
-                        $wp_table_name,
679
-                        '<br/>',
680
-                        'espresso_db_update'
681
-                    )
682
-                );
683
-            }
684
-        }
685
-        $engine = str_replace('ENGINE=', '', $engine);
686
-        \EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
687
-    }
688
-
689
-
690
-
691
-    /**
692
-     *    add_column_if_it_doesn't_exist
693
-     *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
694
-     *
695
-     * @access     public
696
-     * @static
697
-     * @deprecated instead use TableManager::addColumn()
698
-     * @param string $table_name  (without "wp_", eg "esp_attendee"
699
-     * @param string $column_name
700
-     * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
701
-     *                            'VARCHAR(10)'
702
-     * @return bool|int
703
-     */
704
-    public static function add_column_if_it_doesnt_exist(
705
-        $table_name,
706
-        $column_name,
707
-        $column_info = 'INT UNSIGNED NOT NULL'
708
-    ) {
709
-        return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
710
-    }
711
-
712
-
713
-    /**
714
-     * get_fields_on_table
715
-     * Gets all the fields on the database table.
716
-     *
717
-     * @access     public
718
-     * @deprecated instead use TableManager::getTableColumns()
719
-     * @static
720
-     * @param string $table_name , without prefixed $wpdb->prefix
721
-     * @return array of database column names
722
-     */
723
-    public static function get_fields_on_table($table_name = null)
724
-    {
725
-        return \EEH_Activation::getTableManager()->getTableColumns($table_name);
726
-    }
727
-
728
-
729
-    /**
730
-     * db_table_is_empty
731
-     *
732
-     * @access     public\
733
-     * @deprecated instead use TableAnalysis::tableIsEmpty()
734
-     * @static
735
-     * @param string $table_name
736
-     * @return bool
737
-     */
738
-    public static function db_table_is_empty($table_name)
739
-    {
740
-        return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
741
-    }
742
-
743
-
744
-    /**
745
-     * delete_db_table_if_empty
746
-     *
747
-     * @access public
748
-     * @static
749
-     * @param string $table_name
750
-     * @return bool | int
751
-     */
752
-    public static function delete_db_table_if_empty($table_name)
753
-    {
754
-        if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
755
-            return \EEH_Activation::getTableManager()->dropTable($table_name);
756
-        }
757
-        return false;
758
-    }
759
-
760
-
761
-    /**
762
-     * delete_unused_db_table
763
-     *
764
-     * @access     public
765
-     * @static
766
-     * @deprecated instead use TableManager::dropTable()
767
-     * @param string $table_name
768
-     * @return bool | int
769
-     */
770
-    public static function delete_unused_db_table($table_name)
771
-    {
772
-        return \EEH_Activation::getTableManager()->dropTable($table_name);
773
-    }
774
-
775
-
776
-    /**
777
-     * drop_index
778
-     *
779
-     * @access     public
780
-     * @static
781
-     * @deprecated instead use TableManager::dropIndex()
782
-     * @param string $table_name
783
-     * @param string $index_name
784
-     * @return bool | int
785
-     */
786
-    public static function drop_index($table_name, $index_name)
787
-    {
788
-        return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
789
-    }
790
-
791
-
792
-
793
-    /**
794
-     * create_database_tables
795
-     *
796
-     * @access public
797
-     * @static
798
-     * @throws EE_Error
799
-     * @return boolean success (whether database is setup properly or not)
800
-     */
801
-    public static function create_database_tables()
802
-    {
803
-        EE_Registry::instance()->load_core('Data_Migration_Manager');
804
-        //find the migration script that sets the database to be compatible with the code
805
-        $dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
806
-        if ($dms_name) {
807
-            $current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
808
-            $current_data_migration_script->set_migrating(false);
809
-            $current_data_migration_script->schema_changes_before_migration();
810
-            $current_data_migration_script->schema_changes_after_migration();
811
-            if ($current_data_migration_script->get_errors()) {
812
-                if (WP_DEBUG) {
813
-                    foreach ($current_data_migration_script->get_errors() as $error) {
814
-                        EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
815
-                    }
816
-                } else {
817
-                    EE_Error::add_error(
818
-                        __(
819
-                            'There were errors creating the Event Espresso database tables and Event Espresso has been 
271
+		$ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
272
+		foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
273
+			if (is_array($hooks_to_fire_at_time)) {
274
+				foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
275
+					if (isset($ee_cron_tasks_to_remove[$hook_name])
276
+						&& is_array($ee_cron_tasks_to_remove[$hook_name])
277
+					) {
278
+						unset($crons[$timestamp][$hook_name]);
279
+					}
280
+				}
281
+				//also take care of any empty cron timestamps.
282
+				if (empty($hooks_to_fire_at_time)) {
283
+					unset($crons[$timestamp]);
284
+				}
285
+			}
286
+		}
287
+		_set_cron_array($crons);
288
+	}
289
+
290
+
291
+	/**
292
+	 *    CPT_initialization
293
+	 *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
294
+	 *
295
+	 * @access public
296
+	 * @static
297
+	 * @return void
298
+	 */
299
+	public static function CPT_initialization()
300
+	{
301
+		// register Custom Post Types
302
+		EE_Registry::instance()->load_core('Register_CPTs');
303
+		flush_rewrite_rules();
304
+	}
305
+
306
+
307
+
308
+	/**
309
+	 *    reset_and_update_config
310
+	 * The following code was moved over from EE_Config so that it will no longer run on every request.
311
+	 * If there is old calendar config data saved, then it will get converted on activation.
312
+	 * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
313
+	 *
314
+	 * @access public
315
+	 * @static
316
+	 * @return void
317
+	 */
318
+	public static function reset_and_update_config()
319
+	{
320
+		do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
321
+		add_filter(
322
+			'FHEE__EE_Config___load_core_config__config_settings',
323
+			array('EEH_Activation', 'migrate_old_config_data'),
324
+			10,
325
+			3
326
+		);
327
+		//EE_Config::reset();
328
+		if (! EE_Config::logging_enabled()) {
329
+			delete_option(EE_Config::LOG_NAME);
330
+		}
331
+	}
332
+
333
+
334
+	/**
335
+	 *    load_calendar_config
336
+	 *
337
+	 * @access    public
338
+	 * @return    void
339
+	 */
340
+	public static function load_calendar_config()
341
+	{
342
+		// grab array of all plugin folders and loop thru it
343
+		$plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
344
+		if (empty($plugins)) {
345
+			return;
346
+		}
347
+		foreach ($plugins as $plugin_path) {
348
+			// grab plugin folder name from path
349
+			$plugin = basename($plugin_path);
350
+			// drill down to Espresso plugins
351
+			// then to calendar related plugins
352
+			if (
353
+				strpos($plugin, 'espresso') !== false
354
+				|| strpos($plugin, 'Espresso') !== false
355
+				|| strpos($plugin, 'ee4') !== false
356
+				|| strpos($plugin, 'EE4') !== false
357
+				|| strpos($plugin, 'calendar') !== false
358
+			) {
359
+				// this is what we are looking for
360
+				$calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
361
+				// does it exist in this folder ?
362
+				if (is_readable($calendar_config)) {
363
+					// YEAH! let's load it
364
+					require_once($calendar_config);
365
+				}
366
+			}
367
+		}
368
+	}
369
+
370
+
371
+
372
+	/**
373
+	 *    _migrate_old_config_data
374
+	 *
375
+	 * @access    public
376
+	 * @param array|stdClass $settings
377
+	 * @param string         $config
378
+	 * @param \EE_Config     $EE_Config
379
+	 * @return \stdClass
380
+	 */
381
+	public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
382
+	{
383
+		$convert_from_array = array('addons');
384
+		// in case old settings were saved as an array
385
+		if (is_array($settings) && in_array($config, $convert_from_array)) {
386
+			// convert existing settings to an object
387
+			$config_array = $settings;
388
+			$settings = new stdClass();
389
+			foreach ($config_array as $key => $value) {
390
+				if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
391
+					$EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
392
+				} else {
393
+					$settings->{$key} = $value;
394
+				}
395
+			}
396
+			add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
397
+		}
398
+		return $settings;
399
+	}
400
+
401
+
402
+	/**
403
+	 * deactivate_event_espresso
404
+	 *
405
+	 * @access public
406
+	 * @static
407
+	 * @return void
408
+	 */
409
+	public static function deactivate_event_espresso()
410
+	{
411
+		// check permissions
412
+		if (current_user_can('activate_plugins')) {
413
+			deactivate_plugins(EE_PLUGIN_BASENAME, true);
414
+		}
415
+	}
416
+
417
+
418
+
419
+
420
+
421
+	/**
422
+	 * verify_default_pages_exist
423
+	 *
424
+	 * @access public
425
+	 * @static
426
+	 * @return void
427
+	 */
428
+	public static function verify_default_pages_exist()
429
+	{
430
+		$critical_page_problem = false;
431
+		$critical_pages = array(
432
+			array(
433
+				'id'   => 'reg_page_id',
434
+				'name' => __('Registration Checkout', 'event_espresso'),
435
+				'post' => null,
436
+				'code' => 'ESPRESSO_CHECKOUT',
437
+			),
438
+			array(
439
+				'id'   => 'txn_page_id',
440
+				'name' => __('Transactions', 'event_espresso'),
441
+				'post' => null,
442
+				'code' => 'ESPRESSO_TXN_PAGE',
443
+			),
444
+			array(
445
+				'id'   => 'thank_you_page_id',
446
+				'name' => __('Thank You', 'event_espresso'),
447
+				'post' => null,
448
+				'code' => 'ESPRESSO_THANK_YOU',
449
+			),
450
+			array(
451
+				'id'   => 'cancel_page_id',
452
+				'name' => __('Registration Cancelled', 'event_espresso'),
453
+				'post' => null,
454
+				'code' => 'ESPRESSO_CANCELLED',
455
+			),
456
+		);
457
+		$EE_Core_Config = EE_Registry::instance()->CFG->core;
458
+		foreach ($critical_pages as $critical_page) {
459
+			// is critical page ID set in config ?
460
+			if ($EE_Core_Config->{$critical_page['id']} !== false) {
461
+				// attempt to find post by ID
462
+				$critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
463
+			}
464
+			// no dice?
465
+			if ($critical_page['post'] === null) {
466
+				// attempt to find post by title
467
+				$critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
468
+				// still nothing?
469
+				if ($critical_page['post'] === null) {
470
+					$critical_page = EEH_Activation::create_critical_page($critical_page);
471
+					// REALLY? Still nothing ??!?!?
472
+					if ($critical_page['post'] === null) {
473
+						$msg = __(
474
+							'The Event Espresso critical page configuration settings could not be updated.',
475
+							'event_espresso'
476
+						);
477
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
478
+						break;
479
+					}
480
+				}
481
+			}
482
+			// check that Post ID matches critical page ID in config
483
+			if (
484
+				isset($critical_page['post']->ID)
485
+				&& $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
486
+			) {
487
+				//update Config with post ID
488
+				$EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
489
+				if (! EE_Config::instance()->update_espresso_config(false, false)) {
490
+					$msg = __(
491
+						'The Event Espresso critical page configuration settings could not be updated.',
492
+						'event_espresso'
493
+					);
494
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
495
+				}
496
+			}
497
+			$critical_page_problem =
498
+				! isset($critical_page['post']->post_status)
499
+				|| $critical_page['post']->post_status !== 'publish'
500
+				|| strpos($critical_page['post']->post_content, $critical_page['code']) === false
501
+					? true
502
+					: $critical_page_problem;
503
+		}
504
+		if ($critical_page_problem) {
505
+			$msg = sprintf(
506
+				__(
507
+					'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
508
+					'event_espresso'
509
+				),
510
+				'<a href="'
511
+				. admin_url('admin.php?page=espresso_general_settings&action=critical_pages')
512
+				. '">'
513
+				. __('Event Espresso Critical Pages Settings', 'event_espresso')
514
+				. '</a>'
515
+			);
516
+			EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
517
+		}
518
+		if (EE_Error::has_notices()) {
519
+			EE_Error::get_notices(false, true, true);
520
+		}
521
+	}
522
+
523
+
524
+
525
+	/**
526
+	 * Returns the first post which uses the specified shortcode
527
+	 *
528
+	 * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
529
+	 *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
530
+	 *                             "[ESPRESSO_THANK_YOU"
531
+	 *                             (we don't search for the closing shortcode bracket because they might have added
532
+	 *                             parameter to the shortcode
533
+	 * @return WP_Post or NULl
534
+	 */
535
+	public static function get_page_by_ee_shortcode($ee_shortcode)
536
+	{
537
+		global $wpdb;
538
+		$shortcode_and_opening_bracket = '[' . $ee_shortcode;
539
+		$post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
540
+		if ($post_id) {
541
+			return get_post($post_id);
542
+		} else {
543
+			return null;
544
+		}
545
+	}
546
+
547
+
548
+	/**
549
+	 *    This function generates a post for critical espresso pages
550
+	 *
551
+	 * @access public
552
+	 * @static
553
+	 * @param array $critical_page
554
+	 * @return array
555
+	 */
556
+	public static function create_critical_page($critical_page)
557
+	{
558
+
559
+		$post_args = array(
560
+			'post_title'     => $critical_page['name'],
561
+			'post_status'    => 'publish',
562
+			'post_type'      => 'page',
563
+			'comment_status' => 'closed',
564
+			'post_content'   => '[' . $critical_page['code'] . ']',
565
+		);
566
+
567
+		$post_id = wp_insert_post($post_args);
568
+		if (! $post_id) {
569
+			$msg = sprintf(
570
+				__('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
571
+				$critical_page['name']
572
+			);
573
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
574
+			return $critical_page;
575
+		}
576
+		// get newly created post's details
577
+		if (! $critical_page['post'] = get_post($post_id)) {
578
+			$msg = sprintf(
579
+				__('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
580
+				$critical_page['name']
581
+			);
582
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
583
+		}
584
+
585
+		return $critical_page;
586
+
587
+	}
588
+
589
+
590
+
591
+
592
+	/**
593
+	 * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
594
+	 * The role being used to check is filterable.
595
+	 *
596
+	 * @since  4.6.0
597
+	 * @global WPDB $wpdb
598
+	 * @return mixed null|int WP_user ID or NULL
599
+	 */
600
+	public static function get_default_creator_id()
601
+	{
602
+		global $wpdb;
603
+		if ( ! empty(self::$_default_creator_id)) {
604
+			return self::$_default_creator_id;
605
+		}/**/
606
+		$role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
607
+		//let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
608
+		$pre_filtered_id = apply_filters(
609
+			'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
610
+			false,
611
+			$role_to_check
612
+		);
613
+		if ($pre_filtered_id !== false) {
614
+			return (int)$pre_filtered_id;
615
+		}
616
+		$capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
617
+		$query = $wpdb->prepare(
618
+			"SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
619
+			'%' . $role_to_check . '%'
620
+		);
621
+		$user_id = $wpdb->get_var($query);
622
+		$user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
623
+		if ($user_id && (int)$user_id) {
624
+			self::$_default_creator_id = (int)$user_id;
625
+			return self::$_default_creator_id;
626
+		} else {
627
+			return null;
628
+		}
629
+	}
630
+
631
+
632
+
633
+	/**
634
+	 * used by EE and EE addons during plugin activation to create tables.
635
+	 * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
636
+	 * but includes extra logic regarding activations.
637
+	 *
638
+	 * @access public
639
+	 * @static
640
+	 * @param string  $table_name              without the $wpdb->prefix
641
+	 * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
642
+	 *                                         table query)
643
+	 * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
644
+	 * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
645
+	 *                                         and new once this function is done (ie, you really do want to CREATE a
646
+	 *                                         table, and expect it to be empty once you're done) leave as FALSE when
647
+	 *                                         you just want to verify the table exists and matches this definition
648
+	 *                                         (and if it HAS data in it you want to leave it be)
649
+	 * @return void
650
+	 * @throws EE_Error if there are database errors
651
+	 */
652
+	public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
653
+	{
654
+		if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
655
+			return;
656
+		}
657
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
658
+		if ( ! function_exists('dbDelta')) {
659
+			require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
660
+		}
661
+		$tableAnalysis = \EEH_Activation::getTableAnalysis();
662
+		$wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
663
+		// do we need to first delete an existing version of this table ?
664
+		if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
665
+			// ok, delete the table... but ONLY if it's empty
666
+			$deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
667
+			// table is NOT empty, are you SURE you want to delete this table ???
668
+			if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
669
+				\EEH_Activation::getTableManager()->dropTable($wp_table_name);
670
+			} else if ( ! $deleted_safely) {
671
+				// so we should be more cautious rather than just dropping tables so easily
672
+				error_log(
673
+					sprintf(
674
+						__(
675
+							'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
676
+							'event_espresso'
677
+						),
678
+						$wp_table_name,
679
+						'<br/>',
680
+						'espresso_db_update'
681
+					)
682
+				);
683
+			}
684
+		}
685
+		$engine = str_replace('ENGINE=', '', $engine);
686
+		\EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
687
+	}
688
+
689
+
690
+
691
+	/**
692
+	 *    add_column_if_it_doesn't_exist
693
+	 *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
694
+	 *
695
+	 * @access     public
696
+	 * @static
697
+	 * @deprecated instead use TableManager::addColumn()
698
+	 * @param string $table_name  (without "wp_", eg "esp_attendee"
699
+	 * @param string $column_name
700
+	 * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
701
+	 *                            'VARCHAR(10)'
702
+	 * @return bool|int
703
+	 */
704
+	public static function add_column_if_it_doesnt_exist(
705
+		$table_name,
706
+		$column_name,
707
+		$column_info = 'INT UNSIGNED NOT NULL'
708
+	) {
709
+		return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
710
+	}
711
+
712
+
713
+	/**
714
+	 * get_fields_on_table
715
+	 * Gets all the fields on the database table.
716
+	 *
717
+	 * @access     public
718
+	 * @deprecated instead use TableManager::getTableColumns()
719
+	 * @static
720
+	 * @param string $table_name , without prefixed $wpdb->prefix
721
+	 * @return array of database column names
722
+	 */
723
+	public static function get_fields_on_table($table_name = null)
724
+	{
725
+		return \EEH_Activation::getTableManager()->getTableColumns($table_name);
726
+	}
727
+
728
+
729
+	/**
730
+	 * db_table_is_empty
731
+	 *
732
+	 * @access     public\
733
+	 * @deprecated instead use TableAnalysis::tableIsEmpty()
734
+	 * @static
735
+	 * @param string $table_name
736
+	 * @return bool
737
+	 */
738
+	public static function db_table_is_empty($table_name)
739
+	{
740
+		return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
741
+	}
742
+
743
+
744
+	/**
745
+	 * delete_db_table_if_empty
746
+	 *
747
+	 * @access public
748
+	 * @static
749
+	 * @param string $table_name
750
+	 * @return bool | int
751
+	 */
752
+	public static function delete_db_table_if_empty($table_name)
753
+	{
754
+		if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
755
+			return \EEH_Activation::getTableManager()->dropTable($table_name);
756
+		}
757
+		return false;
758
+	}
759
+
760
+
761
+	/**
762
+	 * delete_unused_db_table
763
+	 *
764
+	 * @access     public
765
+	 * @static
766
+	 * @deprecated instead use TableManager::dropTable()
767
+	 * @param string $table_name
768
+	 * @return bool | int
769
+	 */
770
+	public static function delete_unused_db_table($table_name)
771
+	{
772
+		return \EEH_Activation::getTableManager()->dropTable($table_name);
773
+	}
774
+
775
+
776
+	/**
777
+	 * drop_index
778
+	 *
779
+	 * @access     public
780
+	 * @static
781
+	 * @deprecated instead use TableManager::dropIndex()
782
+	 * @param string $table_name
783
+	 * @param string $index_name
784
+	 * @return bool | int
785
+	 */
786
+	public static function drop_index($table_name, $index_name)
787
+	{
788
+		return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
789
+	}
790
+
791
+
792
+
793
+	/**
794
+	 * create_database_tables
795
+	 *
796
+	 * @access public
797
+	 * @static
798
+	 * @throws EE_Error
799
+	 * @return boolean success (whether database is setup properly or not)
800
+	 */
801
+	public static function create_database_tables()
802
+	{
803
+		EE_Registry::instance()->load_core('Data_Migration_Manager');
804
+		//find the migration script that sets the database to be compatible with the code
805
+		$dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
806
+		if ($dms_name) {
807
+			$current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
808
+			$current_data_migration_script->set_migrating(false);
809
+			$current_data_migration_script->schema_changes_before_migration();
810
+			$current_data_migration_script->schema_changes_after_migration();
811
+			if ($current_data_migration_script->get_errors()) {
812
+				if (WP_DEBUG) {
813
+					foreach ($current_data_migration_script->get_errors() as $error) {
814
+						EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
815
+					}
816
+				} else {
817
+					EE_Error::add_error(
818
+						__(
819
+							'There were errors creating the Event Espresso database tables and Event Espresso has been 
820 820
                             deactivated. To view the errors, please enable WP_DEBUG in your wp-config.php file.',
821
-                            'event_espresso'
822
-                        )
823
-                    );
824
-                }
825
-                return false;
826
-            }
827
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to();
828
-        } else {
829
-            EE_Error::add_error(
830
-                __(
831
-                    'Could not determine most up-to-date data migration script from which to pull database schema
821
+							'event_espresso'
822
+						)
823
+					);
824
+				}
825
+				return false;
826
+			}
827
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to();
828
+		} else {
829
+			EE_Error::add_error(
830
+				__(
831
+					'Could not determine most up-to-date data migration script from which to pull database schema
832 832
                      structure. So database is probably not setup properly',
833
-                    'event_espresso'
834
-                ),
835
-                __FILE__,
836
-                __FUNCTION__,
837
-                __LINE__
838
-            );
839
-            return false;
840
-        }
841
-        return true;
842
-    }
843
-
844
-
845
-
846
-    /**
847
-     * initialize_system_questions
848
-     *
849
-     * @access public
850
-     * @static
851
-     * @return void
852
-     */
853
-    public static function initialize_system_questions()
854
-    {
855
-        // QUESTION GROUPS
856
-        global $wpdb;
857
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
858
-        $SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
859
-        // what we have
860
-        $question_groups = $wpdb->get_col($SQL);
861
-        // check the response
862
-        $question_groups = is_array($question_groups) ? $question_groups : array();
863
-        // what we should have
864
-        $QSG_systems = array(1, 2);
865
-        // loop thru what we should have and compare to what we have
866
-        foreach ($QSG_systems as $QSG_system) {
867
-            // reset values array
868
-            $QSG_values = array();
869
-            // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
870
-            if (! in_array("$QSG_system", $question_groups)) {
871
-                // add it
872
-                switch ($QSG_system) {
873
-                    case 1:
874
-                        $QSG_values = array(
875
-                            'QSG_name'            => __('Personal Information', 'event_espresso'),
876
-                            'QSG_identifier'      => 'personal-information-' . time(),
877
-                            'QSG_desc'            => '',
878
-                            'QSG_order'           => 1,
879
-                            'QSG_show_group_name' => 1,
880
-                            'QSG_show_group_desc' => 1,
881
-                            'QSG_system'          => EEM_Question_Group::system_personal,
882
-                            'QSG_deleted'         => 0,
883
-                        );
884
-                        break;
885
-                    case 2:
886
-                        $QSG_values = array(
887
-                            'QSG_name'            => __('Address Information', 'event_espresso'),
888
-                            'QSG_identifier'      => 'address-information-' . time(),
889
-                            'QSG_desc'            => '',
890
-                            'QSG_order'           => 2,
891
-                            'QSG_show_group_name' => 1,
892
-                            'QSG_show_group_desc' => 1,
893
-                            'QSG_system'          => EEM_Question_Group::system_address,
894
-                            'QSG_deleted'         => 0,
895
-                        );
896
-                        break;
897
-                }
898
-                // make sure we have some values before inserting them
899
-                if (! empty($QSG_values)) {
900
-                    // insert system question
901
-                    $wpdb->insert(
902
-                        $table_name,
903
-                        $QSG_values,
904
-                        array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
905
-                    );
906
-                    $QSG_IDs[$QSG_system] = $wpdb->insert_id;
907
-                }
908
-            }
909
-        }
910
-        // QUESTIONS
911
-        global $wpdb;
912
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
913
-        $SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
914
-        // what we have
915
-        $questions = $wpdb->get_col($SQL);
916
-        // what we should have
917
-        $QST_systems = array(
918
-            'fname',
919
-            'lname',
920
-            'email',
921
-            'address',
922
-            'address2',
923
-            'city',
924
-            'country',
925
-            'state',
926
-            'zip',
927
-            'phone',
928
-        );
929
-        $order_for_group_1 = 1;
930
-        $order_for_group_2 = 1;
931
-        // loop thru what we should have and compare to what we have
932
-        foreach ($QST_systems as $QST_system) {
933
-            // reset values array
934
-            $QST_values = array();
935
-            // if we don't have what we should have
936
-            if (! in_array($QST_system, $questions)) {
937
-                // add it
938
-                switch ($QST_system) {
939
-                    case 'fname':
940
-                        $QST_values = array(
941
-                            'QST_display_text'  => __('First Name', 'event_espresso'),
942
-                            'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
943
-                            'QST_system'        => 'fname',
944
-                            'QST_type'          => 'TEXT',
945
-                            'QST_required'      => 1,
946
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
947
-                            'QST_order'         => 1,
948
-                            'QST_admin_only'    => 0,
949
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
950
-                            'QST_wp_user'       => self::get_default_creator_id(),
951
-                            'QST_deleted'       => 0,
952
-                        );
953
-                        break;
954
-                    case 'lname':
955
-                        $QST_values = array(
956
-                            'QST_display_text'  => __('Last Name', 'event_espresso'),
957
-                            'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
958
-                            'QST_system'        => 'lname',
959
-                            'QST_type'          => 'TEXT',
960
-                            'QST_required'      => 1,
961
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
962
-                            'QST_order'         => 2,
963
-                            'QST_admin_only'    => 0,
964
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
965
-                            'QST_wp_user'       => self::get_default_creator_id(),
966
-                            'QST_deleted'       => 0,
967
-                        );
968
-                        break;
969
-                    case 'email':
970
-                        $QST_values = array(
971
-                            'QST_display_text'  => __('Email Address', 'event_espresso'),
972
-                            'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
973
-                            'QST_system'        => 'email',
974
-                            'QST_type'          => 'EMAIL',
975
-                            'QST_required'      => 1,
976
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
977
-                            'QST_order'         => 3,
978
-                            'QST_admin_only'    => 0,
979
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
980
-                            'QST_wp_user'       => self::get_default_creator_id(),
981
-                            'QST_deleted'       => 0,
982
-                        );
983
-                        break;
984
-                    case 'address':
985
-                        $QST_values = array(
986
-                            'QST_display_text'  => __('Address', 'event_espresso'),
987
-                            'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
988
-                            'QST_system'        => 'address',
989
-                            'QST_type'          => 'TEXT',
990
-                            'QST_required'      => 0,
991
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
992
-                            'QST_order'         => 4,
993
-                            'QST_admin_only'    => 0,
994
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
995
-                            'QST_wp_user'       => self::get_default_creator_id(),
996
-                            'QST_deleted'       => 0,
997
-                        );
998
-                        break;
999
-                    case 'address2':
1000
-                        $QST_values = array(
1001
-                            'QST_display_text'  => __('Address2', 'event_espresso'),
1002
-                            'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
1003
-                            'QST_system'        => 'address2',
1004
-                            'QST_type'          => 'TEXT',
1005
-                            'QST_required'      => 0,
1006
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
1007
-                            'QST_order'         => 5,
1008
-                            'QST_admin_only'    => 0,
1009
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
1010
-                            'QST_wp_user'       => self::get_default_creator_id(),
1011
-                            'QST_deleted'       => 0,
1012
-                        );
1013
-                        break;
1014
-                    case 'city':
1015
-                        $QST_values = array(
1016
-                            'QST_display_text'  => __('City', 'event_espresso'),
1017
-                            'QST_admin_label'   => __('City - System Question', 'event_espresso'),
1018
-                            'QST_system'        => 'city',
1019
-                            'QST_type'          => 'TEXT',
1020
-                            'QST_required'      => 0,
1021
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
1022
-                            'QST_order'         => 6,
1023
-                            'QST_admin_only'    => 0,
1024
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
1025
-                            'QST_wp_user'       => self::get_default_creator_id(),
1026
-                            'QST_deleted'       => 0,
1027
-                        );
1028
-                        break;
1029
-                    case 'country':
1030
-                        $QST_values = array(
1031
-                            'QST_display_text'  => __('Country', 'event_espresso'),
1032
-                            'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
1033
-                            'QST_system'        => 'country',
1034
-                            'QST_type'          => 'COUNTRY',
1035
-                            'QST_required'      => 0,
1036
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
1037
-                            'QST_order'         => 7,
1038
-                            'QST_admin_only'    => 0,
1039
-                            'QST_wp_user'       => self::get_default_creator_id(),
1040
-                            'QST_deleted'       => 0,
1041
-                        );
1042
-                        break;
1043
-                    case 'state':
1044
-                        $QST_values = array(
1045
-                            'QST_display_text'  => __('State/Province', 'event_espresso'),
1046
-                            'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
1047
-                            'QST_system'        => 'state',
1048
-                            'QST_type'          => 'STATE',
1049
-                            'QST_required'      => 0,
1050
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
1051
-                            'QST_order'         => 8,
1052
-                            'QST_admin_only'    => 0,
1053
-                            'QST_wp_user'       => self::get_default_creator_id(),
1054
-                            'QST_deleted'       => 0,
1055
-                        );
1056
-                        break;
1057
-                    case 'zip':
1058
-                        $QST_values = array(
1059
-                            'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
1060
-                            'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
1061
-                            'QST_system'        => 'zip',
1062
-                            'QST_type'          => 'TEXT',
1063
-                            'QST_required'      => 0,
1064
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
1065
-                            'QST_order'         => 9,
1066
-                            'QST_admin_only'    => 0,
1067
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
1068
-                            'QST_wp_user'       => self::get_default_creator_id(),
1069
-                            'QST_deleted'       => 0,
1070
-                        );
1071
-                        break;
1072
-                    case 'phone':
1073
-                        $QST_values = array(
1074
-                            'QST_display_text'  => __('Phone Number', 'event_espresso'),
1075
-                            'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
1076
-                            'QST_system'        => 'phone',
1077
-                            'QST_type'          => 'TEXT',
1078
-                            'QST_required'      => 0,
1079
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
1080
-                            'QST_order'         => 10,
1081
-                            'QST_admin_only'    => 0,
1082
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
1083
-                            'QST_wp_user'       => self::get_default_creator_id(),
1084
-                            'QST_deleted'       => 0,
1085
-                        );
1086
-                        break;
1087
-                }
1088
-                if (! empty($QST_values)) {
1089
-                    // insert system question
1090
-                    $wpdb->insert(
1091
-                        $table_name,
1092
-                        $QST_values,
1093
-                        array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
1094
-                    );
1095
-                    $QST_ID = $wpdb->insert_id;
1096
-                    // QUESTION GROUP QUESTIONS
1097
-                    if (in_array($QST_system, array('fname', 'lname', 'email'))) {
1098
-                        $system_question_we_want = EEM_Question_Group::system_personal;
1099
-                    } else {
1100
-                        $system_question_we_want = EEM_Question_Group::system_address;
1101
-                    }
1102
-                    if (isset($QSG_IDs[$system_question_we_want])) {
1103
-                        $QSG_ID = $QSG_IDs[$system_question_we_want];
1104
-                    } else {
1105
-                        $id_col = EEM_Question_Group::instance()
1106
-                                                    ->get_col(array(array('QSG_system' => $system_question_we_want)));
1107
-                        if (is_array($id_col)) {
1108
-                            $QSG_ID = reset($id_col);
1109
-                        } else {
1110
-                            //ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
1111
-                            EE_Log::instance()->log(
1112
-                                __FILE__,
1113
-                                __FUNCTION__,
1114
-                                sprintf(
1115
-                                    __(
1116
-                                        'Could not associate question %1$s to a question group because no system question
833
+					'event_espresso'
834
+				),
835
+				__FILE__,
836
+				__FUNCTION__,
837
+				__LINE__
838
+			);
839
+			return false;
840
+		}
841
+		return true;
842
+	}
843
+
844
+
845
+
846
+	/**
847
+	 * initialize_system_questions
848
+	 *
849
+	 * @access public
850
+	 * @static
851
+	 * @return void
852
+	 */
853
+	public static function initialize_system_questions()
854
+	{
855
+		// QUESTION GROUPS
856
+		global $wpdb;
857
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
858
+		$SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
859
+		// what we have
860
+		$question_groups = $wpdb->get_col($SQL);
861
+		// check the response
862
+		$question_groups = is_array($question_groups) ? $question_groups : array();
863
+		// what we should have
864
+		$QSG_systems = array(1, 2);
865
+		// loop thru what we should have and compare to what we have
866
+		foreach ($QSG_systems as $QSG_system) {
867
+			// reset values array
868
+			$QSG_values = array();
869
+			// if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
870
+			if (! in_array("$QSG_system", $question_groups)) {
871
+				// add it
872
+				switch ($QSG_system) {
873
+					case 1:
874
+						$QSG_values = array(
875
+							'QSG_name'            => __('Personal Information', 'event_espresso'),
876
+							'QSG_identifier'      => 'personal-information-' . time(),
877
+							'QSG_desc'            => '',
878
+							'QSG_order'           => 1,
879
+							'QSG_show_group_name' => 1,
880
+							'QSG_show_group_desc' => 1,
881
+							'QSG_system'          => EEM_Question_Group::system_personal,
882
+							'QSG_deleted'         => 0,
883
+						);
884
+						break;
885
+					case 2:
886
+						$QSG_values = array(
887
+							'QSG_name'            => __('Address Information', 'event_espresso'),
888
+							'QSG_identifier'      => 'address-information-' . time(),
889
+							'QSG_desc'            => '',
890
+							'QSG_order'           => 2,
891
+							'QSG_show_group_name' => 1,
892
+							'QSG_show_group_desc' => 1,
893
+							'QSG_system'          => EEM_Question_Group::system_address,
894
+							'QSG_deleted'         => 0,
895
+						);
896
+						break;
897
+				}
898
+				// make sure we have some values before inserting them
899
+				if (! empty($QSG_values)) {
900
+					// insert system question
901
+					$wpdb->insert(
902
+						$table_name,
903
+						$QSG_values,
904
+						array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
905
+					);
906
+					$QSG_IDs[$QSG_system] = $wpdb->insert_id;
907
+				}
908
+			}
909
+		}
910
+		// QUESTIONS
911
+		global $wpdb;
912
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
913
+		$SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
914
+		// what we have
915
+		$questions = $wpdb->get_col($SQL);
916
+		// what we should have
917
+		$QST_systems = array(
918
+			'fname',
919
+			'lname',
920
+			'email',
921
+			'address',
922
+			'address2',
923
+			'city',
924
+			'country',
925
+			'state',
926
+			'zip',
927
+			'phone',
928
+		);
929
+		$order_for_group_1 = 1;
930
+		$order_for_group_2 = 1;
931
+		// loop thru what we should have and compare to what we have
932
+		foreach ($QST_systems as $QST_system) {
933
+			// reset values array
934
+			$QST_values = array();
935
+			// if we don't have what we should have
936
+			if (! in_array($QST_system, $questions)) {
937
+				// add it
938
+				switch ($QST_system) {
939
+					case 'fname':
940
+						$QST_values = array(
941
+							'QST_display_text'  => __('First Name', 'event_espresso'),
942
+							'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
943
+							'QST_system'        => 'fname',
944
+							'QST_type'          => 'TEXT',
945
+							'QST_required'      => 1,
946
+							'QST_required_text' => __('This field is required', 'event_espresso'),
947
+							'QST_order'         => 1,
948
+							'QST_admin_only'    => 0,
949
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
950
+							'QST_wp_user'       => self::get_default_creator_id(),
951
+							'QST_deleted'       => 0,
952
+						);
953
+						break;
954
+					case 'lname':
955
+						$QST_values = array(
956
+							'QST_display_text'  => __('Last Name', 'event_espresso'),
957
+							'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
958
+							'QST_system'        => 'lname',
959
+							'QST_type'          => 'TEXT',
960
+							'QST_required'      => 1,
961
+							'QST_required_text' => __('This field is required', 'event_espresso'),
962
+							'QST_order'         => 2,
963
+							'QST_admin_only'    => 0,
964
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
965
+							'QST_wp_user'       => self::get_default_creator_id(),
966
+							'QST_deleted'       => 0,
967
+						);
968
+						break;
969
+					case 'email':
970
+						$QST_values = array(
971
+							'QST_display_text'  => __('Email Address', 'event_espresso'),
972
+							'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
973
+							'QST_system'        => 'email',
974
+							'QST_type'          => 'EMAIL',
975
+							'QST_required'      => 1,
976
+							'QST_required_text' => __('This field is required', 'event_espresso'),
977
+							'QST_order'         => 3,
978
+							'QST_admin_only'    => 0,
979
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
980
+							'QST_wp_user'       => self::get_default_creator_id(),
981
+							'QST_deleted'       => 0,
982
+						);
983
+						break;
984
+					case 'address':
985
+						$QST_values = array(
986
+							'QST_display_text'  => __('Address', 'event_espresso'),
987
+							'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
988
+							'QST_system'        => 'address',
989
+							'QST_type'          => 'TEXT',
990
+							'QST_required'      => 0,
991
+							'QST_required_text' => __('This field is required', 'event_espresso'),
992
+							'QST_order'         => 4,
993
+							'QST_admin_only'    => 0,
994
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
995
+							'QST_wp_user'       => self::get_default_creator_id(),
996
+							'QST_deleted'       => 0,
997
+						);
998
+						break;
999
+					case 'address2':
1000
+						$QST_values = array(
1001
+							'QST_display_text'  => __('Address2', 'event_espresso'),
1002
+							'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
1003
+							'QST_system'        => 'address2',
1004
+							'QST_type'          => 'TEXT',
1005
+							'QST_required'      => 0,
1006
+							'QST_required_text' => __('This field is required', 'event_espresso'),
1007
+							'QST_order'         => 5,
1008
+							'QST_admin_only'    => 0,
1009
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
1010
+							'QST_wp_user'       => self::get_default_creator_id(),
1011
+							'QST_deleted'       => 0,
1012
+						);
1013
+						break;
1014
+					case 'city':
1015
+						$QST_values = array(
1016
+							'QST_display_text'  => __('City', 'event_espresso'),
1017
+							'QST_admin_label'   => __('City - System Question', 'event_espresso'),
1018
+							'QST_system'        => 'city',
1019
+							'QST_type'          => 'TEXT',
1020
+							'QST_required'      => 0,
1021
+							'QST_required_text' => __('This field is required', 'event_espresso'),
1022
+							'QST_order'         => 6,
1023
+							'QST_admin_only'    => 0,
1024
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
1025
+							'QST_wp_user'       => self::get_default_creator_id(),
1026
+							'QST_deleted'       => 0,
1027
+						);
1028
+						break;
1029
+					case 'country':
1030
+						$QST_values = array(
1031
+							'QST_display_text'  => __('Country', 'event_espresso'),
1032
+							'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
1033
+							'QST_system'        => 'country',
1034
+							'QST_type'          => 'COUNTRY',
1035
+							'QST_required'      => 0,
1036
+							'QST_required_text' => __('This field is required', 'event_espresso'),
1037
+							'QST_order'         => 7,
1038
+							'QST_admin_only'    => 0,
1039
+							'QST_wp_user'       => self::get_default_creator_id(),
1040
+							'QST_deleted'       => 0,
1041
+						);
1042
+						break;
1043
+					case 'state':
1044
+						$QST_values = array(
1045
+							'QST_display_text'  => __('State/Province', 'event_espresso'),
1046
+							'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
1047
+							'QST_system'        => 'state',
1048
+							'QST_type'          => 'STATE',
1049
+							'QST_required'      => 0,
1050
+							'QST_required_text' => __('This field is required', 'event_espresso'),
1051
+							'QST_order'         => 8,
1052
+							'QST_admin_only'    => 0,
1053
+							'QST_wp_user'       => self::get_default_creator_id(),
1054
+							'QST_deleted'       => 0,
1055
+						);
1056
+						break;
1057
+					case 'zip':
1058
+						$QST_values = array(
1059
+							'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
1060
+							'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
1061
+							'QST_system'        => 'zip',
1062
+							'QST_type'          => 'TEXT',
1063
+							'QST_required'      => 0,
1064
+							'QST_required_text' => __('This field is required', 'event_espresso'),
1065
+							'QST_order'         => 9,
1066
+							'QST_admin_only'    => 0,
1067
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
1068
+							'QST_wp_user'       => self::get_default_creator_id(),
1069
+							'QST_deleted'       => 0,
1070
+						);
1071
+						break;
1072
+					case 'phone':
1073
+						$QST_values = array(
1074
+							'QST_display_text'  => __('Phone Number', 'event_espresso'),
1075
+							'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
1076
+							'QST_system'        => 'phone',
1077
+							'QST_type'          => 'TEXT',
1078
+							'QST_required'      => 0,
1079
+							'QST_required_text' => __('This field is required', 'event_espresso'),
1080
+							'QST_order'         => 10,
1081
+							'QST_admin_only'    => 0,
1082
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
1083
+							'QST_wp_user'       => self::get_default_creator_id(),
1084
+							'QST_deleted'       => 0,
1085
+						);
1086
+						break;
1087
+				}
1088
+				if (! empty($QST_values)) {
1089
+					// insert system question
1090
+					$wpdb->insert(
1091
+						$table_name,
1092
+						$QST_values,
1093
+						array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
1094
+					);
1095
+					$QST_ID = $wpdb->insert_id;
1096
+					// QUESTION GROUP QUESTIONS
1097
+					if (in_array($QST_system, array('fname', 'lname', 'email'))) {
1098
+						$system_question_we_want = EEM_Question_Group::system_personal;
1099
+					} else {
1100
+						$system_question_we_want = EEM_Question_Group::system_address;
1101
+					}
1102
+					if (isset($QSG_IDs[$system_question_we_want])) {
1103
+						$QSG_ID = $QSG_IDs[$system_question_we_want];
1104
+					} else {
1105
+						$id_col = EEM_Question_Group::instance()
1106
+													->get_col(array(array('QSG_system' => $system_question_we_want)));
1107
+						if (is_array($id_col)) {
1108
+							$QSG_ID = reset($id_col);
1109
+						} else {
1110
+							//ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
1111
+							EE_Log::instance()->log(
1112
+								__FILE__,
1113
+								__FUNCTION__,
1114
+								sprintf(
1115
+									__(
1116
+										'Could not associate question %1$s to a question group because no system question
1117 1117
                                          group existed',
1118
-                                        'event_espresso'
1119
-                                    ),
1120
-                                    $QST_ID),
1121
-                                'error');
1122
-                            continue;
1123
-                        }
1124
-                    }
1125
-                    // add system questions to groups
1126
-                    $wpdb->insert(
1127
-                        \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
1128
-                        array(
1129
-                            'QSG_ID'    => $QSG_ID,
1130
-                            'QST_ID'    => $QST_ID,
1131
-                            'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
1132
-                        ),
1133
-                        array('%d', '%d', '%d')
1134
-                    );
1135
-                }
1136
-            }
1137
-        }
1138
-    }
1139
-
1140
-
1141
-    /**
1142
-     * Makes sure the default payment method (Invoice) is active.
1143
-     * This used to be done automatically as part of constructing the old gateways config
1144
-     *
1145
-     * @throws \EE_Error
1146
-     */
1147
-    public static function insert_default_payment_methods()
1148
-    {
1149
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
1150
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
1151
-            EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
1152
-        } else {
1153
-            EEM_Payment_Method::instance()->verify_button_urls();
1154
-        }
1155
-    }
1156
-
1157
-    /**
1158
-     * insert_default_status_codes
1159
-     *
1160
-     * @access public
1161
-     * @static
1162
-     * @return void
1163
-     */
1164
-    public static function insert_default_status_codes()
1165
-    {
1166
-
1167
-        global $wpdb;
1168
-
1169
-        if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
1170
-
1171
-            $table_name = EEM_Status::instance()->table();
1172
-
1173
-            $SQL = "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
1174
-            $wpdb->query($SQL);
1175
-
1176
-            $SQL = "INSERT INTO $table_name
1118
+										'event_espresso'
1119
+									),
1120
+									$QST_ID),
1121
+								'error');
1122
+							continue;
1123
+						}
1124
+					}
1125
+					// add system questions to groups
1126
+					$wpdb->insert(
1127
+						\EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
1128
+						array(
1129
+							'QSG_ID'    => $QSG_ID,
1130
+							'QST_ID'    => $QST_ID,
1131
+							'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
1132
+						),
1133
+						array('%d', '%d', '%d')
1134
+					);
1135
+				}
1136
+			}
1137
+		}
1138
+	}
1139
+
1140
+
1141
+	/**
1142
+	 * Makes sure the default payment method (Invoice) is active.
1143
+	 * This used to be done automatically as part of constructing the old gateways config
1144
+	 *
1145
+	 * @throws \EE_Error
1146
+	 */
1147
+	public static function insert_default_payment_methods()
1148
+	{
1149
+		if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
1150
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
1151
+			EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
1152
+		} else {
1153
+			EEM_Payment_Method::instance()->verify_button_urls();
1154
+		}
1155
+	}
1156
+
1157
+	/**
1158
+	 * insert_default_status_codes
1159
+	 *
1160
+	 * @access public
1161
+	 * @static
1162
+	 * @return void
1163
+	 */
1164
+	public static function insert_default_status_codes()
1165
+	{
1166
+
1167
+		global $wpdb;
1168
+
1169
+		if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
1170
+
1171
+			$table_name = EEM_Status::instance()->table();
1172
+
1173
+			$SQL = "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
1174
+			$wpdb->query($SQL);
1175
+
1176
+			$SQL = "INSERT INTO $table_name
1177 1177
 					(STS_ID, STS_code, STS_type, STS_can_edit, STS_desc, STS_open) VALUES
1178 1178
 					('ACT', 'ACTIVE', 'event', 0, NULL, 1),
1179 1179
 					('NAC', 'NOT_ACTIVE', 'event', 0, NULL, 0),
@@ -1213,521 +1213,521 @@  discard block
 block discarded – undo
1213 1213
 					('MID', 'IDLE', 'message', 0, NULL, 1),
1214 1214
 					('MRS', 'RESEND', 'message', 0, NULL, 1),
1215 1215
 					('MIC', 'INCOMPLETE', 'message', 0, NULL, 0);";
1216
-            $wpdb->query($SQL);
1217
-
1218
-        }
1219
-
1220
-    }
1221
-
1222
-
1223
-    /**
1224
-     * create_upload_directories
1225
-     * Creates folders in the uploads directory to facilitate addons and templates
1226
-     *
1227
-     * @access public
1228
-     * @static
1229
-     * @return boolean success of verifying upload directories exist
1230
-     */
1231
-    public static function create_upload_directories()
1232
-    {
1233
-        // Create the required folders
1234
-        $folders = array(
1235
-            EVENT_ESPRESSO_TEMPLATE_DIR,
1236
-            EVENT_ESPRESSO_GATEWAY_DIR,
1237
-            EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
1238
-            EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
1239
-            EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/',
1240
-        );
1241
-        foreach ($folders as $folder) {
1242
-            try {
1243
-                EEH_File::ensure_folder_exists_and_is_writable($folder);
1244
-                @ chmod($folder, 0755);
1245
-            } catch (EE_Error $e) {
1246
-                EE_Error::add_error(
1247
-                    sprintf(
1248
-                        __('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
1249
-                        $folder,
1250
-                        '<br />' . $e->getMessage()
1251
-                    ),
1252
-                    __FILE__, __FUNCTION__, __LINE__
1253
-                );
1254
-                //indicate we'll need to fix this later
1255
-                update_option(EEH_Activation::upload_directories_incomplete_option_name, true);
1256
-                return false;
1257
-            }
1258
-        }
1259
-        //just add the .htaccess file to the logs directory to begin with. Even if logging
1260
-        //is disabled, there might be activation errors recorded in there
1261
-        EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs/');
1262
-        //remember EE's folders are all good
1263
-        delete_option(EEH_Activation::upload_directories_incomplete_option_name);
1264
-        return true;
1265
-    }
1266
-
1267
-    /**
1268
-     * Whether the upload directories need to be fixed or not.
1269
-     * If EE is installed but filesystem access isn't initially available,
1270
-     * we need to get the user's filesystem credentials and THEN create them,
1271
-     * so there might be period of time when EE is installed but its
1272
-     * upload directories aren't available. This indicates such a state
1273
-     *
1274
-     * @return boolean
1275
-     */
1276
-    public static function upload_directories_incomplete()
1277
-    {
1278
-        return get_option(EEH_Activation::upload_directories_incomplete_option_name, false);
1279
-    }
1280
-
1281
-
1282
-    /**
1283
-     * generate_default_message_templates
1284
-     *
1285
-     * @static
1286
-     * @throws EE_Error
1287
-     * @return bool     true means new templates were created.
1288
-     *                  false means no templates were created.
1289
-     *                  This is NOT an error flag. To check for errors you will want
1290
-     *                  to use either EE_Error or a try catch for an EE_Error exception.
1291
-     */
1292
-    public static function generate_default_message_templates()
1293
-    {
1294
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
1295
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
1296
-        /*
1216
+			$wpdb->query($SQL);
1217
+
1218
+		}
1219
+
1220
+	}
1221
+
1222
+
1223
+	/**
1224
+	 * create_upload_directories
1225
+	 * Creates folders in the uploads directory to facilitate addons and templates
1226
+	 *
1227
+	 * @access public
1228
+	 * @static
1229
+	 * @return boolean success of verifying upload directories exist
1230
+	 */
1231
+	public static function create_upload_directories()
1232
+	{
1233
+		// Create the required folders
1234
+		$folders = array(
1235
+			EVENT_ESPRESSO_TEMPLATE_DIR,
1236
+			EVENT_ESPRESSO_GATEWAY_DIR,
1237
+			EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
1238
+			EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
1239
+			EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/',
1240
+		);
1241
+		foreach ($folders as $folder) {
1242
+			try {
1243
+				EEH_File::ensure_folder_exists_and_is_writable($folder);
1244
+				@ chmod($folder, 0755);
1245
+			} catch (EE_Error $e) {
1246
+				EE_Error::add_error(
1247
+					sprintf(
1248
+						__('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
1249
+						$folder,
1250
+						'<br />' . $e->getMessage()
1251
+					),
1252
+					__FILE__, __FUNCTION__, __LINE__
1253
+				);
1254
+				//indicate we'll need to fix this later
1255
+				update_option(EEH_Activation::upload_directories_incomplete_option_name, true);
1256
+				return false;
1257
+			}
1258
+		}
1259
+		//just add the .htaccess file to the logs directory to begin with. Even if logging
1260
+		//is disabled, there might be activation errors recorded in there
1261
+		EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs/');
1262
+		//remember EE's folders are all good
1263
+		delete_option(EEH_Activation::upload_directories_incomplete_option_name);
1264
+		return true;
1265
+	}
1266
+
1267
+	/**
1268
+	 * Whether the upload directories need to be fixed or not.
1269
+	 * If EE is installed but filesystem access isn't initially available,
1270
+	 * we need to get the user's filesystem credentials and THEN create them,
1271
+	 * so there might be period of time when EE is installed but its
1272
+	 * upload directories aren't available. This indicates such a state
1273
+	 *
1274
+	 * @return boolean
1275
+	 */
1276
+	public static function upload_directories_incomplete()
1277
+	{
1278
+		return get_option(EEH_Activation::upload_directories_incomplete_option_name, false);
1279
+	}
1280
+
1281
+
1282
+	/**
1283
+	 * generate_default_message_templates
1284
+	 *
1285
+	 * @static
1286
+	 * @throws EE_Error
1287
+	 * @return bool     true means new templates were created.
1288
+	 *                  false means no templates were created.
1289
+	 *                  This is NOT an error flag. To check for errors you will want
1290
+	 *                  to use either EE_Error or a try catch for an EE_Error exception.
1291
+	 */
1292
+	public static function generate_default_message_templates()
1293
+	{
1294
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
1295
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
1296
+		/*
1297 1297
          * This first method is taking care of ensuring any default messengers
1298 1298
          * that should be made active and have templates generated are done.
1299 1299
          */
1300
-        $new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
1301
-            $message_resource_manager
1302
-        );
1303
-        /**
1304
-         * This method is verifying there are no NEW default message types
1305
-         * for ACTIVE messengers that need activated (and corresponding templates setup).
1306
-         */
1307
-        $new_templates_created_for_message_type = self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
1308
-            $message_resource_manager
1309
-        );
1310
-        //after all is done, let's persist these changes to the db.
1311
-        $message_resource_manager->update_has_activated_messengers_option();
1312
-        $message_resource_manager->update_active_messengers_option();
1313
-        // will return true if either of these are true.  Otherwise will return false.
1314
-        return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
1315
-    }
1316
-
1317
-
1318
-
1319
-    /**
1320
-     * @param \EE_Message_Resource_Manager $message_resource_manager
1321
-     * @return array|bool
1322
-     * @throws \EE_Error
1323
-     */
1324
-    protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
1325
-        EE_Message_Resource_Manager $message_resource_manager
1326
-    ) {
1327
-        /** @type EE_messenger[] $active_messengers */
1328
-        $active_messengers = $message_resource_manager->active_messengers();
1329
-        $installed_message_types = $message_resource_manager->installed_message_types();
1330
-        $templates_created = false;
1331
-        foreach ($active_messengers as $active_messenger) {
1332
-            $default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
1333
-            $default_message_type_names_to_activate = array();
1334
-            // looping through each default message type reported by the messenger
1335
-            // and setup the actual message types to activate.
1336
-            foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
1337
-                // if already active or has already been activated before we skip
1338
-                // (otherwise we might reactivate something user's intentionally deactivated.)
1339
-                // we also skip if the message type is not installed.
1340
-                if (
1341
-                    $message_resource_manager->has_message_type_been_activated_for_messenger(
1342
-                        $default_message_type_name_for_messenger,
1343
-                        $active_messenger->name
1344
-                    )
1345
-                    || $message_resource_manager->is_message_type_active_for_messenger(
1346
-                        $active_messenger->name,
1347
-                        $default_message_type_name_for_messenger
1348
-                    )
1349
-                    || ! isset($installed_message_types[$default_message_type_name_for_messenger])
1350
-                ) {
1351
-                    continue;
1352
-                }
1353
-                $default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
1354
-            }
1355
-            //let's activate!
1356
-            $message_resource_manager->ensure_message_types_are_active(
1357
-                $default_message_type_names_to_activate,
1358
-                $active_messenger->name,
1359
-                false
1360
-            );
1361
-            //activate the templates for these message types
1362
-            if ( ! empty($default_message_type_names_to_activate)) {
1363
-                $templates_created = EEH_MSG_Template::generate_new_templates(
1364
-                    $active_messenger->name,
1365
-                    $default_message_type_names_for_messenger,
1366
-                    '',
1367
-                    true
1368
-                );
1369
-            }
1370
-        }
1371
-        return $templates_created;
1372
-    }
1373
-
1374
-
1375
-
1376
-    /**
1377
-     * This will activate and generate default messengers and default message types for those messengers.
1378
-     *
1379
-     * @param EE_message_Resource_Manager $message_resource_manager
1380
-     * @return array|bool  True means there were default messengers and message type templates generated.
1381
-     *                     False means that there were no templates generated
1382
-     *                     (which could simply mean there are no default message types for a messenger).
1383
-     * @throws EE_Error
1384
-     */
1385
-    protected static function _activate_and_generate_default_messengers_and_message_templates(
1386
-        EE_Message_Resource_Manager $message_resource_manager
1387
-    ) {
1388
-        /** @type EE_messenger[] $messengers_to_generate */
1389
-        $messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
1390
-        $installed_message_types = $message_resource_manager->installed_message_types();
1391
-        $templates_generated = false;
1392
-        foreach ($messengers_to_generate as $messenger_to_generate) {
1393
-            $default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
1394
-            //verify the default message types match an installed message type.
1395
-            foreach ($default_message_type_names_for_messenger as $key => $name) {
1396
-                if (
1397
-                    ! isset($installed_message_types[$name])
1398
-                    || $message_resource_manager->has_message_type_been_activated_for_messenger(
1399
-                        $name,
1400
-                        $messenger_to_generate->name
1401
-                    )
1402
-                ) {
1403
-                    unset($default_message_type_names_for_messenger[$key]);
1404
-                }
1405
-            }
1406
-            // in previous iterations, the active_messengers option in the db
1407
-            // needed updated before calling create templates. however with the changes this may not be necessary.
1408
-            // This comment is left here just in case we discover that we _do_ need to update before
1409
-            // passing off to create templates (after the refactor is done).
1410
-            // @todo remove this comment when determined not necessary.
1411
-            $message_resource_manager->activate_messenger(
1412
-                $messenger_to_generate->name,
1413
-                $default_message_type_names_for_messenger,
1414
-                false
1415
-            );
1416
-            //create any templates needing created (or will reactivate templates already generated as necessary).
1417
-            if ( ! empty($default_message_type_names_for_messenger)) {
1418
-                $templates_generated = EEH_MSG_Template::generate_new_templates(
1419
-                    $messenger_to_generate->name,
1420
-                    $default_message_type_names_for_messenger,
1421
-                    '',
1422
-                    true
1423
-                );
1424
-            }
1425
-        }
1426
-        return $templates_generated;
1427
-    }
1428
-
1429
-
1430
-    /**
1431
-     * This returns the default messengers to generate templates for on activation of EE.
1432
-     * It considers:
1433
-     * - whether a messenger is already active in the db.
1434
-     * - whether a messenger has been made active at any time in the past.
1435
-     *
1436
-     * @static
1437
-     * @param  EE_Message_Resource_Manager $message_resource_manager
1438
-     * @return EE_messenger[]
1439
-     */
1440
-    protected static function _get_default_messengers_to_generate_on_activation(
1441
-        EE_Message_Resource_Manager $message_resource_manager
1442
-    ) {
1443
-        $active_messengers    = $message_resource_manager->active_messengers();
1444
-        $installed_messengers = $message_resource_manager->installed_messengers();
1445
-        $has_activated        = $message_resource_manager->get_has_activated_messengers_option();
1446
-
1447
-        $messengers_to_generate = array();
1448
-        foreach ($installed_messengers as $installed_messenger) {
1449
-            //if installed messenger is a messenger that should be activated on install
1450
-            //and is not already active
1451
-            //and has never been activated
1452
-            if (
1453
-                ! $installed_messenger->activate_on_install
1454
-                || isset($active_messengers[$installed_messenger->name])
1455
-                || isset($has_activated[$installed_messenger->name])
1456
-            ) {
1457
-                continue;
1458
-            }
1459
-            $messengers_to_generate[$installed_messenger->name] = $installed_messenger;
1460
-        }
1461
-        return $messengers_to_generate;
1462
-    }
1463
-
1464
-
1465
-    /**
1466
-     * This simply validates active message types to ensure they actually match installed
1467
-     * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
1468
-     * rows are set inactive.
1469
-     * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
1470
-     * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
1471
-     * are still handled in here.
1472
-     *
1473
-     * @since 4.3.1
1474
-     * @return void
1475
-     */
1476
-    public static function validate_messages_system()
1477
-    {
1478
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
1479
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
1480
-        $message_resource_manager->validate_active_message_types_are_installed();
1481
-        do_action('AHEE__EEH_Activation__validate_messages_system');
1482
-    }
1483
-
1484
-
1485
-    /**
1486
-     * create_no_ticket_prices_array
1487
-     *
1488
-     * @access public
1489
-     * @static
1490
-     * @return void
1491
-     */
1492
-    public static function create_no_ticket_prices_array()
1493
-    {
1494
-        // this creates an array for tracking events that have no active ticket prices created
1495
-        // this allows us to warn admins of the situation so that it can be corrected
1496
-        $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
1497
-        if (! $espresso_no_ticket_prices) {
1498
-            add_option('ee_no_ticket_prices', array(), '', false);
1499
-        }
1500
-    }
1501
-
1502
-
1503
-    /**
1504
-     * plugin_deactivation
1505
-     *
1506
-     * @access public
1507
-     * @static
1508
-     * @return void
1509
-     */
1510
-    public static function plugin_deactivation()
1511
-    {
1512
-    }
1513
-
1514
-
1515
-    /**
1516
-     * Finds all our EE4 custom post types, and deletes them and their associated data
1517
-     * (like post meta or term relations)
1518
-     *
1519
-     * @global wpdb $wpdb
1520
-     * @throws \EE_Error
1521
-     */
1522
-    public static function delete_all_espresso_cpt_data()
1523
-    {
1524
-        global $wpdb;
1525
-        //get all the CPT post_types
1526
-        $ee_post_types = array();
1527
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
1528
-            if (method_exists($model_name, 'instance')) {
1529
-                $model_obj = call_user_func(array($model_name, 'instance'));
1530
-                if ($model_obj instanceof EEM_CPT_Base) {
1531
-                    $ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
1532
-                }
1533
-            }
1534
-        }
1535
-        //get all our CPTs
1536
-        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
1537
-        $cpt_ids = $wpdb->get_col($query);
1538
-        //delete each post meta and term relations too
1539
-        foreach ($cpt_ids as $post_id) {
1540
-            wp_delete_post($post_id, true);
1541
-        }
1542
-    }
1543
-
1544
-    /**
1545
-     * Deletes all EE custom tables
1546
-     *
1547
-     * @return array
1548
-     */
1549
-    public static function drop_espresso_tables()
1550
-    {
1551
-        $tables = array();
1552
-        // load registry
1553
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
1554
-            if (method_exists($model_name, 'instance')) {
1555
-                $model_obj = call_user_func(array($model_name, 'instance'));
1556
-                if ($model_obj instanceof EEM_Base) {
1557
-                    foreach ($model_obj->get_tables() as $table) {
1558
-                        if (strpos($table->get_table_name(), 'esp_')
1559
-                            &&
1560
-                            (
1561
-                                is_main_site()//main site? nuke them all
1562
-                                || ! $table->is_global()//not main site,but not global either. nuke it
1563
-                            )
1564
-                        ) {
1565
-                            $tables[$table->get_table_name()] = $table->get_table_name();
1566
-                        }
1567
-                    }
1568
-                }
1569
-            }
1570
-        }
1571
-
1572
-        //there are some tables whose models were removed.
1573
-        //they should be removed when removing all EE core's data
1574
-        $tables_without_models = array(
1575
-            'esp_promotion',
1576
-            'esp_promotion_applied',
1577
-            'esp_promotion_object',
1578
-            'esp_promotion_rule',
1579
-            'esp_rule',
1580
-        );
1581
-        foreach ($tables_without_models as $table) {
1582
-            $tables[$table] = $table;
1583
-        }
1584
-        return \EEH_Activation::getTableManager()->dropTables($tables);
1585
-    }
1586
-
1587
-
1588
-
1589
-    /**
1590
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
1591
-     * each table name provided has a wpdb prefix attached, and that it exists.
1592
-     * Returns the list actually deleted
1593
-     *
1594
-     * @deprecated in 4.9.13. Instead use TableManager::dropTables()
1595
-     * @global WPDB $wpdb
1596
-     * @param array $table_names
1597
-     * @return array of table names which we deleted
1598
-     */
1599
-    public static function drop_tables($table_names)
1600
-    {
1601
-        return \EEH_Activation::getTableManager()->dropTables($table_names);
1602
-    }
1603
-
1604
-
1605
-
1606
-    /**
1607
-     * plugin_uninstall
1608
-     *
1609
-     * @access public
1610
-     * @static
1611
-     * @param bool $remove_all
1612
-     * @return void
1613
-     */
1614
-    public static function delete_all_espresso_tables_and_data($remove_all = true)
1615
-    {
1616
-        global $wpdb;
1617
-        self::drop_espresso_tables();
1618
-        $wp_options_to_delete = array(
1619
-            'ee_no_ticket_prices'                => true,
1620
-            'ee_active_messengers'               => true,
1621
-            'ee_has_activated_messenger'         => true,
1622
-            'ee_flush_rewrite_rules'             => true,
1623
-            'ee_config'                          => false,
1624
-            'ee_data_migration_current_db_state' => true,
1625
-            'ee_data_migration_mapping_'         => false,
1626
-            'ee_data_migration_script_'          => false,
1627
-            'ee_data_migrations'                 => true,
1628
-            'ee_dms_map'                         => false,
1629
-            'ee_notices'                         => true,
1630
-            'lang_file_check_'                   => false,
1631
-            'ee_maintenance_mode'                => true,
1632
-            'ee_ueip_optin'                      => true,
1633
-            'ee_ueip_has_notified'               => true,
1634
-            'ee_plugin_activation_errors'        => true,
1635
-            'ee_id_mapping_from'                 => false,
1636
-            'espresso_persistent_admin_notices'  => true,
1637
-            'ee_encryption_key'                  => true,
1638
-            'pue_force_upgrade_'                 => false,
1639
-            'pue_json_error_'                    => false,
1640
-            'pue_install_key_'                   => false,
1641
-            'pue_verification_error_'            => false,
1642
-            'pu_dismissed_upgrade_'              => false,
1643
-            'external_updates-'                  => false,
1644
-            'ee_extra_data'                      => true,
1645
-            'ee_ssn_'                            => false,
1646
-            'ee_rss_'                            => false,
1647
-            'ee_rte_n_tx_'                       => false,
1648
-            'ee_pers_admin_notices'              => true,
1649
-            'ee_job_parameters_'                 => false,
1650
-            'ee_upload_directories_incomplete'   => true,
1651
-            'ee_verified_db_collations'          => true,
1652
-        );
1653
-        if (is_main_site()) {
1654
-            $wp_options_to_delete['ee_network_config'] = true;
1655
-        }
1656
-        $undeleted_options = array();
1657
-        foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
1658
-            if ($no_wildcard) {
1659
-                if ( ! delete_option($option_name)) {
1660
-                    $undeleted_options[] = $option_name;
1661
-                }
1662
-            } else {
1663
-                $option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
1664
-                foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
1665
-                    if ( ! delete_option($option_name_from_wildcard)) {
1666
-                        $undeleted_options[] = $option_name_from_wildcard;
1667
-                    }
1668
-                }
1669
-            }
1670
-        }
1671
-        //also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
1672
-        remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
1673
-        if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
1674
-            $db_update_sans_ee4 = array();
1675
-            foreach ($espresso_db_update as $version => $times_activated) {
1676
-                if ((string)$version[0] === '3') {//if its NON EE4
1677
-                    $db_update_sans_ee4[$version] = $times_activated;
1678
-                }
1679
-            }
1680
-            update_option('espresso_db_update', $db_update_sans_ee4);
1681
-        }
1682
-        $errors = '';
1683
-        if ( ! empty($undeleted_options)) {
1684
-            $errors .= sprintf(
1685
-                __('The following wp-options could not be deleted: %s%s', 'event_espresso'),
1686
-                '<br/>',
1687
-                implode(',<br/>', $undeleted_options)
1688
-            );
1689
-        }
1690
-        if ( ! empty($errors)) {
1691
-            EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
1692
-        }
1693
-    }
1694
-
1695
-    /**
1696
-     * Gets the mysql error code from the last used query by wpdb
1697
-     *
1698
-     * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
1699
-     */
1700
-    public static function last_wpdb_error_code()
1701
-    {
1702
-        global $wpdb;
1703
-        if ($wpdb->use_mysqli) {
1704
-            return mysqli_errno($wpdb->dbh);
1705
-        } else {
1706
-            return mysql_errno($wpdb->dbh);
1707
-        }
1708
-    }
1709
-
1710
-    /**
1711
-     * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
1712
-     *
1713
-     * @global wpdb  $wpdb
1714
-     * @deprecated instead use TableAnalysis::tableExists()
1715
-     * @param string $table_name with or without $wpdb->prefix
1716
-     * @return boolean
1717
-     */
1718
-    public static function table_exists($table_name)
1719
-    {
1720
-        return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
1721
-    }
1722
-
1723
-    /**
1724
-     * Resets the cache on EEH_Activation
1725
-     */
1726
-    public static function reset()
1727
-    {
1728
-        self::$_default_creator_id                             = null;
1729
-        self::$_initialized_db_content_already_in_this_request = false;
1730
-    }
1300
+		$new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
1301
+			$message_resource_manager
1302
+		);
1303
+		/**
1304
+		 * This method is verifying there are no NEW default message types
1305
+		 * for ACTIVE messengers that need activated (and corresponding templates setup).
1306
+		 */
1307
+		$new_templates_created_for_message_type = self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
1308
+			$message_resource_manager
1309
+		);
1310
+		//after all is done, let's persist these changes to the db.
1311
+		$message_resource_manager->update_has_activated_messengers_option();
1312
+		$message_resource_manager->update_active_messengers_option();
1313
+		// will return true if either of these are true.  Otherwise will return false.
1314
+		return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
1315
+	}
1316
+
1317
+
1318
+
1319
+	/**
1320
+	 * @param \EE_Message_Resource_Manager $message_resource_manager
1321
+	 * @return array|bool
1322
+	 * @throws \EE_Error
1323
+	 */
1324
+	protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
1325
+		EE_Message_Resource_Manager $message_resource_manager
1326
+	) {
1327
+		/** @type EE_messenger[] $active_messengers */
1328
+		$active_messengers = $message_resource_manager->active_messengers();
1329
+		$installed_message_types = $message_resource_manager->installed_message_types();
1330
+		$templates_created = false;
1331
+		foreach ($active_messengers as $active_messenger) {
1332
+			$default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
1333
+			$default_message_type_names_to_activate = array();
1334
+			// looping through each default message type reported by the messenger
1335
+			// and setup the actual message types to activate.
1336
+			foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
1337
+				// if already active or has already been activated before we skip
1338
+				// (otherwise we might reactivate something user's intentionally deactivated.)
1339
+				// we also skip if the message type is not installed.
1340
+				if (
1341
+					$message_resource_manager->has_message_type_been_activated_for_messenger(
1342
+						$default_message_type_name_for_messenger,
1343
+						$active_messenger->name
1344
+					)
1345
+					|| $message_resource_manager->is_message_type_active_for_messenger(
1346
+						$active_messenger->name,
1347
+						$default_message_type_name_for_messenger
1348
+					)
1349
+					|| ! isset($installed_message_types[$default_message_type_name_for_messenger])
1350
+				) {
1351
+					continue;
1352
+				}
1353
+				$default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
1354
+			}
1355
+			//let's activate!
1356
+			$message_resource_manager->ensure_message_types_are_active(
1357
+				$default_message_type_names_to_activate,
1358
+				$active_messenger->name,
1359
+				false
1360
+			);
1361
+			//activate the templates for these message types
1362
+			if ( ! empty($default_message_type_names_to_activate)) {
1363
+				$templates_created = EEH_MSG_Template::generate_new_templates(
1364
+					$active_messenger->name,
1365
+					$default_message_type_names_for_messenger,
1366
+					'',
1367
+					true
1368
+				);
1369
+			}
1370
+		}
1371
+		return $templates_created;
1372
+	}
1373
+
1374
+
1375
+
1376
+	/**
1377
+	 * This will activate and generate default messengers and default message types for those messengers.
1378
+	 *
1379
+	 * @param EE_message_Resource_Manager $message_resource_manager
1380
+	 * @return array|bool  True means there were default messengers and message type templates generated.
1381
+	 *                     False means that there were no templates generated
1382
+	 *                     (which could simply mean there are no default message types for a messenger).
1383
+	 * @throws EE_Error
1384
+	 */
1385
+	protected static function _activate_and_generate_default_messengers_and_message_templates(
1386
+		EE_Message_Resource_Manager $message_resource_manager
1387
+	) {
1388
+		/** @type EE_messenger[] $messengers_to_generate */
1389
+		$messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
1390
+		$installed_message_types = $message_resource_manager->installed_message_types();
1391
+		$templates_generated = false;
1392
+		foreach ($messengers_to_generate as $messenger_to_generate) {
1393
+			$default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
1394
+			//verify the default message types match an installed message type.
1395
+			foreach ($default_message_type_names_for_messenger as $key => $name) {
1396
+				if (
1397
+					! isset($installed_message_types[$name])
1398
+					|| $message_resource_manager->has_message_type_been_activated_for_messenger(
1399
+						$name,
1400
+						$messenger_to_generate->name
1401
+					)
1402
+				) {
1403
+					unset($default_message_type_names_for_messenger[$key]);
1404
+				}
1405
+			}
1406
+			// in previous iterations, the active_messengers option in the db
1407
+			// needed updated before calling create templates. however with the changes this may not be necessary.
1408
+			// This comment is left here just in case we discover that we _do_ need to update before
1409
+			// passing off to create templates (after the refactor is done).
1410
+			// @todo remove this comment when determined not necessary.
1411
+			$message_resource_manager->activate_messenger(
1412
+				$messenger_to_generate->name,
1413
+				$default_message_type_names_for_messenger,
1414
+				false
1415
+			);
1416
+			//create any templates needing created (or will reactivate templates already generated as necessary).
1417
+			if ( ! empty($default_message_type_names_for_messenger)) {
1418
+				$templates_generated = EEH_MSG_Template::generate_new_templates(
1419
+					$messenger_to_generate->name,
1420
+					$default_message_type_names_for_messenger,
1421
+					'',
1422
+					true
1423
+				);
1424
+			}
1425
+		}
1426
+		return $templates_generated;
1427
+	}
1428
+
1429
+
1430
+	/**
1431
+	 * This returns the default messengers to generate templates for on activation of EE.
1432
+	 * It considers:
1433
+	 * - whether a messenger is already active in the db.
1434
+	 * - whether a messenger has been made active at any time in the past.
1435
+	 *
1436
+	 * @static
1437
+	 * @param  EE_Message_Resource_Manager $message_resource_manager
1438
+	 * @return EE_messenger[]
1439
+	 */
1440
+	protected static function _get_default_messengers_to_generate_on_activation(
1441
+		EE_Message_Resource_Manager $message_resource_manager
1442
+	) {
1443
+		$active_messengers    = $message_resource_manager->active_messengers();
1444
+		$installed_messengers = $message_resource_manager->installed_messengers();
1445
+		$has_activated        = $message_resource_manager->get_has_activated_messengers_option();
1446
+
1447
+		$messengers_to_generate = array();
1448
+		foreach ($installed_messengers as $installed_messenger) {
1449
+			//if installed messenger is a messenger that should be activated on install
1450
+			//and is not already active
1451
+			//and has never been activated
1452
+			if (
1453
+				! $installed_messenger->activate_on_install
1454
+				|| isset($active_messengers[$installed_messenger->name])
1455
+				|| isset($has_activated[$installed_messenger->name])
1456
+			) {
1457
+				continue;
1458
+			}
1459
+			$messengers_to_generate[$installed_messenger->name] = $installed_messenger;
1460
+		}
1461
+		return $messengers_to_generate;
1462
+	}
1463
+
1464
+
1465
+	/**
1466
+	 * This simply validates active message types to ensure they actually match installed
1467
+	 * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
1468
+	 * rows are set inactive.
1469
+	 * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
1470
+	 * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
1471
+	 * are still handled in here.
1472
+	 *
1473
+	 * @since 4.3.1
1474
+	 * @return void
1475
+	 */
1476
+	public static function validate_messages_system()
1477
+	{
1478
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
1479
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
1480
+		$message_resource_manager->validate_active_message_types_are_installed();
1481
+		do_action('AHEE__EEH_Activation__validate_messages_system');
1482
+	}
1483
+
1484
+
1485
+	/**
1486
+	 * create_no_ticket_prices_array
1487
+	 *
1488
+	 * @access public
1489
+	 * @static
1490
+	 * @return void
1491
+	 */
1492
+	public static function create_no_ticket_prices_array()
1493
+	{
1494
+		// this creates an array for tracking events that have no active ticket prices created
1495
+		// this allows us to warn admins of the situation so that it can be corrected
1496
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
1497
+		if (! $espresso_no_ticket_prices) {
1498
+			add_option('ee_no_ticket_prices', array(), '', false);
1499
+		}
1500
+	}
1501
+
1502
+
1503
+	/**
1504
+	 * plugin_deactivation
1505
+	 *
1506
+	 * @access public
1507
+	 * @static
1508
+	 * @return void
1509
+	 */
1510
+	public static function plugin_deactivation()
1511
+	{
1512
+	}
1513
+
1514
+
1515
+	/**
1516
+	 * Finds all our EE4 custom post types, and deletes them and their associated data
1517
+	 * (like post meta or term relations)
1518
+	 *
1519
+	 * @global wpdb $wpdb
1520
+	 * @throws \EE_Error
1521
+	 */
1522
+	public static function delete_all_espresso_cpt_data()
1523
+	{
1524
+		global $wpdb;
1525
+		//get all the CPT post_types
1526
+		$ee_post_types = array();
1527
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
1528
+			if (method_exists($model_name, 'instance')) {
1529
+				$model_obj = call_user_func(array($model_name, 'instance'));
1530
+				if ($model_obj instanceof EEM_CPT_Base) {
1531
+					$ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
1532
+				}
1533
+			}
1534
+		}
1535
+		//get all our CPTs
1536
+		$query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
1537
+		$cpt_ids = $wpdb->get_col($query);
1538
+		//delete each post meta and term relations too
1539
+		foreach ($cpt_ids as $post_id) {
1540
+			wp_delete_post($post_id, true);
1541
+		}
1542
+	}
1543
+
1544
+	/**
1545
+	 * Deletes all EE custom tables
1546
+	 *
1547
+	 * @return array
1548
+	 */
1549
+	public static function drop_espresso_tables()
1550
+	{
1551
+		$tables = array();
1552
+		// load registry
1553
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
1554
+			if (method_exists($model_name, 'instance')) {
1555
+				$model_obj = call_user_func(array($model_name, 'instance'));
1556
+				if ($model_obj instanceof EEM_Base) {
1557
+					foreach ($model_obj->get_tables() as $table) {
1558
+						if (strpos($table->get_table_name(), 'esp_')
1559
+							&&
1560
+							(
1561
+								is_main_site()//main site? nuke them all
1562
+								|| ! $table->is_global()//not main site,but not global either. nuke it
1563
+							)
1564
+						) {
1565
+							$tables[$table->get_table_name()] = $table->get_table_name();
1566
+						}
1567
+					}
1568
+				}
1569
+			}
1570
+		}
1571
+
1572
+		//there are some tables whose models were removed.
1573
+		//they should be removed when removing all EE core's data
1574
+		$tables_without_models = array(
1575
+			'esp_promotion',
1576
+			'esp_promotion_applied',
1577
+			'esp_promotion_object',
1578
+			'esp_promotion_rule',
1579
+			'esp_rule',
1580
+		);
1581
+		foreach ($tables_without_models as $table) {
1582
+			$tables[$table] = $table;
1583
+		}
1584
+		return \EEH_Activation::getTableManager()->dropTables($tables);
1585
+	}
1586
+
1587
+
1588
+
1589
+	/**
1590
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
1591
+	 * each table name provided has a wpdb prefix attached, and that it exists.
1592
+	 * Returns the list actually deleted
1593
+	 *
1594
+	 * @deprecated in 4.9.13. Instead use TableManager::dropTables()
1595
+	 * @global WPDB $wpdb
1596
+	 * @param array $table_names
1597
+	 * @return array of table names which we deleted
1598
+	 */
1599
+	public static function drop_tables($table_names)
1600
+	{
1601
+		return \EEH_Activation::getTableManager()->dropTables($table_names);
1602
+	}
1603
+
1604
+
1605
+
1606
+	/**
1607
+	 * plugin_uninstall
1608
+	 *
1609
+	 * @access public
1610
+	 * @static
1611
+	 * @param bool $remove_all
1612
+	 * @return void
1613
+	 */
1614
+	public static function delete_all_espresso_tables_and_data($remove_all = true)
1615
+	{
1616
+		global $wpdb;
1617
+		self::drop_espresso_tables();
1618
+		$wp_options_to_delete = array(
1619
+			'ee_no_ticket_prices'                => true,
1620
+			'ee_active_messengers'               => true,
1621
+			'ee_has_activated_messenger'         => true,
1622
+			'ee_flush_rewrite_rules'             => true,
1623
+			'ee_config'                          => false,
1624
+			'ee_data_migration_current_db_state' => true,
1625
+			'ee_data_migration_mapping_'         => false,
1626
+			'ee_data_migration_script_'          => false,
1627
+			'ee_data_migrations'                 => true,
1628
+			'ee_dms_map'                         => false,
1629
+			'ee_notices'                         => true,
1630
+			'lang_file_check_'                   => false,
1631
+			'ee_maintenance_mode'                => true,
1632
+			'ee_ueip_optin'                      => true,
1633
+			'ee_ueip_has_notified'               => true,
1634
+			'ee_plugin_activation_errors'        => true,
1635
+			'ee_id_mapping_from'                 => false,
1636
+			'espresso_persistent_admin_notices'  => true,
1637
+			'ee_encryption_key'                  => true,
1638
+			'pue_force_upgrade_'                 => false,
1639
+			'pue_json_error_'                    => false,
1640
+			'pue_install_key_'                   => false,
1641
+			'pue_verification_error_'            => false,
1642
+			'pu_dismissed_upgrade_'              => false,
1643
+			'external_updates-'                  => false,
1644
+			'ee_extra_data'                      => true,
1645
+			'ee_ssn_'                            => false,
1646
+			'ee_rss_'                            => false,
1647
+			'ee_rte_n_tx_'                       => false,
1648
+			'ee_pers_admin_notices'              => true,
1649
+			'ee_job_parameters_'                 => false,
1650
+			'ee_upload_directories_incomplete'   => true,
1651
+			'ee_verified_db_collations'          => true,
1652
+		);
1653
+		if (is_main_site()) {
1654
+			$wp_options_to_delete['ee_network_config'] = true;
1655
+		}
1656
+		$undeleted_options = array();
1657
+		foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
1658
+			if ($no_wildcard) {
1659
+				if ( ! delete_option($option_name)) {
1660
+					$undeleted_options[] = $option_name;
1661
+				}
1662
+			} else {
1663
+				$option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
1664
+				foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
1665
+					if ( ! delete_option($option_name_from_wildcard)) {
1666
+						$undeleted_options[] = $option_name_from_wildcard;
1667
+					}
1668
+				}
1669
+			}
1670
+		}
1671
+		//also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
1672
+		remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
1673
+		if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
1674
+			$db_update_sans_ee4 = array();
1675
+			foreach ($espresso_db_update as $version => $times_activated) {
1676
+				if ((string)$version[0] === '3') {//if its NON EE4
1677
+					$db_update_sans_ee4[$version] = $times_activated;
1678
+				}
1679
+			}
1680
+			update_option('espresso_db_update', $db_update_sans_ee4);
1681
+		}
1682
+		$errors = '';
1683
+		if ( ! empty($undeleted_options)) {
1684
+			$errors .= sprintf(
1685
+				__('The following wp-options could not be deleted: %s%s', 'event_espresso'),
1686
+				'<br/>',
1687
+				implode(',<br/>', $undeleted_options)
1688
+			);
1689
+		}
1690
+		if ( ! empty($errors)) {
1691
+			EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
1692
+		}
1693
+	}
1694
+
1695
+	/**
1696
+	 * Gets the mysql error code from the last used query by wpdb
1697
+	 *
1698
+	 * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
1699
+	 */
1700
+	public static function last_wpdb_error_code()
1701
+	{
1702
+		global $wpdb;
1703
+		if ($wpdb->use_mysqli) {
1704
+			return mysqli_errno($wpdb->dbh);
1705
+		} else {
1706
+			return mysql_errno($wpdb->dbh);
1707
+		}
1708
+	}
1709
+
1710
+	/**
1711
+	 * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
1712
+	 *
1713
+	 * @global wpdb  $wpdb
1714
+	 * @deprecated instead use TableAnalysis::tableExists()
1715
+	 * @param string $table_name with or without $wpdb->prefix
1716
+	 * @return boolean
1717
+	 */
1718
+	public static function table_exists($table_name)
1719
+	{
1720
+		return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
1721
+	}
1722
+
1723
+	/**
1724
+	 * Resets the cache on EEH_Activation
1725
+	 */
1726
+	public static function reset()
1727
+	{
1728
+		self::$_default_creator_id                             = null;
1729
+		self::$_initialized_db_content_already_in_this_request = false;
1730
+	}
1731 1731
 }
1732 1732
 // End of file EEH_Activation.helper.php
1733 1733
 // Location: /helpers/EEH_Activation.core.php
Please login to merge, or discard this patch.
admin_pages/registrations/Registrations_Admin_Page.core.php 2 patches
Spacing   +85 added lines, -85 removed lines patch added patch discarded remove patch
@@ -69,7 +69,7 @@  discard block
 block discarded – undo
69 69
         // when adding a new registration...
70 70
         if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
71 71
             EE_System::do_not_cache();
72
-            if (! isset($this->_req_data['processing_registration'])
72
+            if ( ! isset($this->_req_data['processing_registration'])
73 73
                  || absint($this->_req_data['processing_registration']) !== 1
74 74
             ) {
75 75
                 // and it's NOT the attendee information reg step
@@ -577,7 +577,7 @@  discard block
 block discarded – undo
577 577
         //style
578 578
         wp_register_style(
579 579
             'espresso_reg',
580
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
580
+            REG_ASSETS_URL.'espresso_registrations_admin.css',
581 581
             array('ee-admin-css'),
582 582
             EVENT_ESPRESSO_VERSION
583 583
         );
@@ -585,7 +585,7 @@  discard block
 block discarded – undo
585 585
         //script
586 586
         wp_register_script(
587 587
             'espresso_reg',
588
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
588
+            REG_ASSETS_URL.'espresso_registrations_admin.js',
589 589
             array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
590 590
             EVENT_ESPRESSO_VERSION,
591 591
             true
@@ -623,7 +623,7 @@  discard block
 block discarded – undo
623 623
         wp_deregister_style('espresso_reg');
624 624
         wp_register_style(
625 625
             'espresso_att',
626
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
626
+            REG_ASSETS_URL.'espresso_attendees_admin.css',
627 627
             array('ee-admin-css'),
628 628
             EVENT_ESPRESSO_VERSION
629 629
         );
@@ -635,7 +635,7 @@  discard block
 block discarded – undo
635 635
     {
636 636
         wp_register_script(
637 637
             'ee-spco-for-admin',
638
-            REG_ASSETS_URL . 'spco_for_admin.js',
638
+            REG_ASSETS_URL.'spco_for_admin.js',
639 639
             array('underscore', 'jquery'),
640 640
             EVENT_ESPRESSO_VERSION,
641 641
             true
@@ -768,7 +768,7 @@  discard block
 block discarded – undo
768 768
                     'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
769 769
                 ),
770 770
             );
771
-            $this->_views['trash']      = array(
771
+            $this->_views['trash'] = array(
772 772
                 'slug'        => 'trash',
773 773
                 'label'       => esc_html__('Trash', 'event_espresso'),
774 774
                 'count'       => 0,
@@ -857,7 +857,7 @@  discard block
 block discarded – undo
857 857
         }
858 858
         $sc_items = array(
859 859
             'approved_status'   => array(
860
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
860
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved,
861 861
                 'desc'  => EEH_Template::pretty_status(
862 862
                     EEM_Registration::status_id_approved,
863 863
                     false,
@@ -865,7 +865,7 @@  discard block
 block discarded – undo
865 865
                 ),
866 866
             ),
867 867
             'pending_status'    => array(
868
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
868
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment,
869 869
                 'desc'  => EEH_Template::pretty_status(
870 870
                     EEM_Registration::status_id_pending_payment,
871 871
                     false,
@@ -873,7 +873,7 @@  discard block
 block discarded – undo
873 873
                 ),
874 874
             ),
875 875
             'wait_list'         => array(
876
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
876
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list,
877 877
                 'desc'  => EEH_Template::pretty_status(
878 878
                     EEM_Registration::status_id_wait_list,
879 879
                     false,
@@ -881,7 +881,7 @@  discard block
 block discarded – undo
881 881
                 ),
882 882
             ),
883 883
             'incomplete_status' => array(
884
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
884
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_incomplete,
885 885
                 'desc'  => EEH_Template::pretty_status(
886 886
                     EEM_Registration::status_id_incomplete,
887 887
                     false,
@@ -889,7 +889,7 @@  discard block
 block discarded – undo
889 889
                 ),
890 890
             ),
891 891
             'not_approved'      => array(
892
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
892
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved,
893 893
                 'desc'  => EEH_Template::pretty_status(
894 894
                     EEM_Registration::status_id_not_approved,
895 895
                     false,
@@ -897,7 +897,7 @@  discard block
 block discarded – undo
897 897
                 ),
898 898
             ),
899 899
             'declined_status'   => array(
900
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
900
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined,
901 901
                 'desc'  => EEH_Template::pretty_status(
902 902
                     EEM_Registration::status_id_declined,
903 903
                     false,
@@ -905,7 +905,7 @@  discard block
 block discarded – undo
905 905
                 ),
906 906
             ),
907 907
             'cancelled_status'  => array(
908
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
908
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled,
909 909
                 'desc'  => EEH_Template::pretty_status(
910 910
                     EEM_Registration::status_id_cancelled,
911 911
                     false,
@@ -934,7 +934,7 @@  discard block
 block discarded – undo
934 934
                 'espresso_registrations_new_registration',
935 935
                 $EVT_ID
936 936
             )) {
937
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
937
+                $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
938 938
                     'new_registration',
939 939
                     'add-registrant',
940 940
                     array('event_id' => $EVT_ID),
@@ -974,7 +974,7 @@  discard block
 block discarded – undo
974 974
                 $this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
975 975
                 $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
976 976
                 $this->_template_args['admin_page_header'] .= $datetime->name();
977
-                $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
977
+                $this->_template_args['admin_page_header'] .= ' ( '.$datetime->start_date().' )';
978 978
                 $this->_template_args['admin_page_header'] .= '</span></h3>';
979 979
             }
980 980
         }
@@ -1074,7 +1074,7 @@  discard block
 block discarded – undo
1074 1074
             'caps'                     => EEM_Registration::caps_read_admin,
1075 1075
             'default_where_conditions' => 'this_model_only',
1076 1076
         );
1077
-        if (! $count) {
1077
+        if ( ! $count) {
1078 1078
             $query_params = array_merge(
1079 1079
                 $query_params,
1080 1080
                 $this->_get_orderby_for_registrations_query(),
@@ -1095,7 +1095,7 @@  discard block
 block discarded – undo
1095 1095
     protected function _add_event_id_to_where_conditions(array $request)
1096 1096
     {
1097 1097
         $where = array();
1098
-        if (! empty($request['event_id'])) {
1098
+        if ( ! empty($request['event_id'])) {
1099 1099
             $where['EVT_ID'] = absint($request['event_id']);
1100 1100
         }
1101 1101
         return $where;
@@ -1111,7 +1111,7 @@  discard block
 block discarded – undo
1111 1111
     protected function _add_category_id_to_where_conditions(array $request)
1112 1112
     {
1113 1113
         $where = array();
1114
-        if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
1114
+        if ( ! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) {
1115 1115
             $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
1116 1116
         }
1117 1117
         return $where;
@@ -1127,10 +1127,10 @@  discard block
 block discarded – undo
1127 1127
     protected function _add_datetime_id_to_where_conditions(array $request)
1128 1128
     {
1129 1129
         $where = array();
1130
-        if (! empty($request['datetime_id'])) {
1130
+        if ( ! empty($request['datetime_id'])) {
1131 1131
             $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
1132 1132
         }
1133
-        if (! empty($request['DTT_ID'])) {
1133
+        if ( ! empty($request['DTT_ID'])) {
1134 1134
             $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
1135 1135
         }
1136 1136
         return $where;
@@ -1156,7 +1156,7 @@  discard block
 block discarded – undo
1156 1156
          * If not filtering by specified status, then we show all registrations excluding incomplete registrations
1157 1157
          * UNLESS viewing trashed registrations.
1158 1158
          */
1159
-        if (! empty($registration_status)) {
1159
+        if ( ! empty($registration_status)) {
1160 1160
             $where['STS_ID'] = $registration_status;
1161 1161
         } else {
1162 1162
             //make sure we exclude incomplete registrations, but only if not trashed.
@@ -1196,12 +1196,12 @@  discard block
 block discarded – undo
1196 1196
                 array(
1197 1197
                     EEM_Registration::instance()->convert_datetime_for_query(
1198 1198
                         'REG_date',
1199
-                        $now . ' 00:00:00',
1199
+                        $now.' 00:00:00',
1200 1200
                         'Y-m-d H:i:s'
1201 1201
                     ),
1202 1202
                     EEM_Registration::instance()->convert_datetime_for_query(
1203 1203
                         'REG_date',
1204
-                        $now . ' 23:59:59',
1204
+                        $now.' 23:59:59',
1205 1205
                         'Y-m-d H:i:s'
1206 1206
                     ),
1207 1207
                 ),
@@ -1214,12 +1214,12 @@  discard block
 block discarded – undo
1214 1214
                 array(
1215 1215
                     EEM_Registration::instance()->convert_datetime_for_query(
1216 1216
                         'REG_date',
1217
-                        $current_year_and_month . '-01 00:00:00',
1217
+                        $current_year_and_month.'-01 00:00:00',
1218 1218
                         'Y-m-d H:i:s'
1219 1219
                     ),
1220 1220
                     EEM_Registration::instance()->convert_datetime_for_query(
1221 1221
                         'REG_date',
1222
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
1222
+                        $current_year_and_month.'-'.$days_this_month.' 23:59:59',
1223 1223
                         'Y-m-d H:i:s'
1224 1224
                     ),
1225 1225
                 ),
@@ -1234,18 +1234,18 @@  discard block
 block discarded – undo
1234 1234
                 : '';
1235 1235
             //if there is not a month or year then we can't go further
1236 1236
             if ($month_requested && $year_requested) {
1237
-                $days_in_month     = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
1237
+                $days_in_month     = date('t', strtotime($year_requested.'-'.$month_requested.'-'.'01'));
1238 1238
                 $where['REG_date'] = array(
1239 1239
                     'BETWEEN',
1240 1240
                     array(
1241 1241
                         EEM_Registration::instance()->convert_datetime_for_query(
1242 1242
                             'REG_date',
1243
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
1243
+                            $year_requested.'-'.$month_requested.'-01 00:00:00',
1244 1244
                             'Y-m-d H:i:s'
1245 1245
                         ),
1246 1246
                         EEM_Registration::instance()->convert_datetime_for_query(
1247 1247
                             'REG_date',
1248
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
1248
+                            $year_requested.'-'.$month_requested.'-'.$days_in_month.' 23:59:59',
1249 1249
                             'Y-m-d H:i:s'
1250 1250
                         ),
1251 1251
                     ),
@@ -1265,8 +1265,8 @@  discard block
 block discarded – undo
1265 1265
     protected function _add_search_to_where_conditions(array $request)
1266 1266
     {
1267 1267
         $where = array();
1268
-        if (! empty($request['s'])) {
1269
-            $search_string = '%' . sanitize_text_field($request['s']) . '%';
1268
+        if ( ! empty($request['s'])) {
1269
+            $search_string = '%'.sanitize_text_field($request['s']).'%';
1270 1270
             $where['OR*search_conditions'] = array(
1271 1271
                 'Event.EVT_name'                          => array('LIKE', $search_string),
1272 1272
                 'Event.EVT_desc'                          => array('LIKE', $search_string),
@@ -1379,7 +1379,7 @@  discard block
 block discarded – undo
1379 1379
             : $per_page;
1380 1380
 
1381 1381
         //-1 means return all results so get out if that's set.
1382
-        if ((int)$per_page === -1) {
1382
+        if ((int) $per_page === -1) {
1383 1383
             return array();
1384 1384
         }
1385 1385
         $per_page = absint($per_page);
@@ -1432,7 +1432,7 @@  discard block
 block discarded – undo
1432 1432
                 ),
1433 1433
                 REG_ADMIN_URL
1434 1434
             );
1435
-            $this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
1435
+            $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce(
1436 1436
                 array(
1437 1437
                     'action' => 'default',
1438 1438
                     'EVT_ID' => $event_id,
@@ -1440,7 +1440,7 @@  discard block
 block discarded – undo
1440 1440
                 ),
1441 1441
                 admin_url('admin.php')
1442 1442
             );
1443
-            $this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
1443
+            $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(
1444 1444
                 array(
1445 1445
                     'page'   => 'espresso_events',
1446 1446
                     'action' => 'edit',
@@ -1449,12 +1449,12 @@  discard block
 block discarded – undo
1449 1449
                 admin_url('admin.php')
1450 1450
             );
1451 1451
             //next and previous links
1452
-            $next_reg                                      = $this->_registration->next(
1452
+            $next_reg = $this->_registration->next(
1453 1453
                 null,
1454 1454
                 array(),
1455 1455
                 'REG_ID'
1456 1456
             );
1457
-            $this->_template_args['next_registration']     = $next_reg
1457
+            $this->_template_args['next_registration'] = $next_reg
1458 1458
                 ? $this->_next_link(
1459 1459
                     EE_Admin_Page::add_query_args_and_nonce(
1460 1460
                         array(
@@ -1466,7 +1466,7 @@  discard block
 block discarded – undo
1466 1466
                     'dashicons dashicons-arrow-right ee-icon-size-22'
1467 1467
                 )
1468 1468
                 : '';
1469
-            $previous_reg                                  = $this->_registration->previous(
1469
+            $previous_reg = $this->_registration->previous(
1470 1470
                 null,
1471 1471
                 array(),
1472 1472
                 'REG_ID'
@@ -1484,7 +1484,7 @@  discard block
 block discarded – undo
1484 1484
                 )
1485 1485
                 : '';
1486 1486
             // grab header
1487
-            $template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
1487
+            $template_path                             = REG_TEMPLATE_PATH.'reg_admin_details_header.template.php';
1488 1488
             $this->_template_args['REG_ID']            = $this->_registration->ID();
1489 1489
             $this->_template_args['admin_page_header'] = EEH_Template::display_template(
1490 1490
                 $template_path,
@@ -1599,7 +1599,7 @@  discard block
 block discarded – undo
1599 1599
                             EEH_HTML::strong(
1600 1600
                                 $this->_registration->pretty_status(),
1601 1601
                                 '',
1602
-                                'status-' . $this->_registration->status_ID(),
1602
+                                'status-'.$this->_registration->status_ID(),
1603 1603
                                 'line-height: 1em; font-size: 1.5em; font-weight: bold;'
1604 1604
                             )
1605 1605
                         )
@@ -1669,9 +1669,9 @@  discard block
 block discarded – undo
1669 1669
     {
1670 1670
         if (isset($this->_req_data['reg_status_change_form'])) {
1671 1671
             $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
1672
-                ? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array();
1672
+                ? (array) $this->_req_data['reg_status_change_form']['REG_ID'] : array();
1673 1673
         } else {
1674
-            $REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array();
1674
+            $REG_IDs = isset($this->_req_data['_REG_ID']) ? (array) $this->_req_data['_REG_ID'] : array();
1675 1675
         }
1676 1676
         $success = $this->_set_registration_status($REG_IDs, $status);
1677 1677
         //notify?
@@ -1703,7 +1703,7 @@  discard block
 block discarded – undo
1703 1703
     {
1704 1704
         $success = false;
1705 1705
         // typecast $REG_IDs
1706
-        $REG_IDs = (array)$REG_IDs;
1706
+        $REG_IDs = (array) $REG_IDs;
1707 1707
         if ( ! empty($REG_IDs)) {
1708 1708
             $success = true;
1709 1709
             // set default status if none is passed
@@ -1933,7 +1933,7 @@  discard block
 block discarded – undo
1933 1933
             $filtered_line_item_tree,
1934 1934
             array('EE_Registration' => $this->_registration)
1935 1935
         );
1936
-        $attendee                                = $this->_registration->attendee();
1936
+        $attendee = $this->_registration->attendee();
1937 1937
         if (EE_Registry::instance()->CAP->current_user_can(
1938 1938
             'ee_read_transaction',
1939 1939
             'espresso_transactions_view_transaction'
@@ -2012,7 +2012,7 @@  discard block
 block discarded – undo
2012 2012
                 'Payment method response',
2013 2013
                 'event_espresso'
2014 2014
             );
2015
-            $this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
2015
+            $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text';
2016 2016
         }
2017 2017
         $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
2018 2018
         $this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
@@ -2040,7 +2040,7 @@  discard block
 block discarded – undo
2040 2040
         $this->_template_args['REG_ID']                                       = $this->_registration->ID();
2041 2041
         $this->_template_args['event_id']                                     = $this->_registration->event_ID();
2042 2042
         $template_path                                                        =
2043
-            REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
2043
+            REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_details.template.php';
2044 2044
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
2045 2045
     }
2046 2046
 
@@ -2069,7 +2069,7 @@  discard block
 block discarded – undo
2069 2069
             $this->_template_args['reg_questions_form_action'] = 'edit_registration';
2070 2070
             $this->_template_args['REG_ID']                    = $this->_registration->ID();
2071 2071
             $template_path                                     =
2072
-                REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
2072
+                REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php';
2073 2073
             echo EEH_Template::display_template($template_path, $this->_template_args, true);
2074 2074
         }
2075 2075
     }
@@ -2086,7 +2086,7 @@  discard block
 block discarded – undo
2086 2086
     public function form_before_question_group($output)
2087 2087
     {
2088 2088
         EE_Error::doing_it_wrong(
2089
-            __CLASS__ . '::' . __FUNCTION__,
2089
+            __CLASS__.'::'.__FUNCTION__,
2090 2090
             esc_html__(
2091 2091
                 '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.',
2092 2092
                 'event_espresso'
@@ -2111,7 +2111,7 @@  discard block
 block discarded – undo
2111 2111
     public function form_after_question_group($output)
2112 2112
     {
2113 2113
         EE_Error::doing_it_wrong(
2114
-            __CLASS__ . '::' . __FUNCTION__,
2114
+            __CLASS__.'::'.__FUNCTION__,
2115 2115
             esc_html__(
2116 2116
                 '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.',
2117 2117
                 'event_espresso'
@@ -2149,7 +2149,7 @@  discard block
 block discarded – undo
2149 2149
     public function form_form_field_label_wrap($label)
2150 2150
     {
2151 2151
         EE_Error::doing_it_wrong(
2152
-            __CLASS__ . '::' . __FUNCTION__,
2152
+            __CLASS__.'::'.__FUNCTION__,
2153 2153
             esc_html__(
2154 2154
                 '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.',
2155 2155
                 'event_espresso'
@@ -2159,7 +2159,7 @@  discard block
 block discarded – undo
2159 2159
         return '
2160 2160
 			<tr>
2161 2161
 				<th>
2162
-					' . $label . '
2162
+					' . $label.'
2163 2163
 				</th>';
2164 2164
     }
2165 2165
 
@@ -2175,7 +2175,7 @@  discard block
 block discarded – undo
2175 2175
     public function form_form_field_input__wrap($input)
2176 2176
     {
2177 2177
         EE_Error::doing_it_wrong(
2178
-            __CLASS__ . '::' . __FUNCTION__,
2178
+            __CLASS__.'::'.__FUNCTION__,
2179 2179
             esc_html__(
2180 2180
                 '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.',
2181 2181
                 'event_espresso'
@@ -2184,7 +2184,7 @@  discard block
 block discarded – undo
2184 2184
         );
2185 2185
         return '
2186 2186
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
2187
-					' . $input . '
2187
+					' . $input.'
2188 2188
 				</td>
2189 2189
 			</tr>';
2190 2190
     }
@@ -2226,7 +2226,7 @@  discard block
 block discarded – undo
2226 2226
     protected function _get_reg_custom_questions_form($REG_ID)
2227 2227
     {
2228 2228
         if ( ! $this->_reg_custom_questions_form) {
2229
-            require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
2229
+            require_once(REG_ADMIN.'form_sections'.DS.'EE_Registration_Custom_Questions_Form.form.php');
2230 2230
             $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
2231 2231
                 EEM_Registration::instance()->get_one_by_ID($REG_ID)
2232 2232
             );
@@ -2259,7 +2259,7 @@  discard block
 block discarded – undo
2259 2259
         if ($form->is_valid()) {
2260 2260
             foreach ($form->subforms() as $question_group_id => $question_group_form) {
2261 2261
                 foreach ($question_group_form->inputs() as $question_id => $input) {
2262
-                    $where_conditions    = array(
2262
+                    $where_conditions = array(
2263 2263
                         'QST_ID' => $question_id,
2264 2264
                         'REG_ID' => $REG_ID,
2265 2265
                     );
@@ -2297,7 +2297,7 @@  discard block
 block discarded – undo
2297 2297
         $REG = EEM_Registration::instance();
2298 2298
         //get all other registrations on this transaction, and cache
2299 2299
         //the attendees for them so we don't have to run another query using force_join
2300
-        $registrations                           = $REG->get_all(array(
2300
+        $registrations = $REG->get_all(array(
2301 2301
             array(
2302 2302
                 'TXN_ID' => $this->_registration->transaction_ID(),
2303 2303
                 'REG_ID' => array('!=', $this->_registration->ID()),
@@ -2321,7 +2321,7 @@  discard block
 block discarded – undo
2321 2321
             $att_nmbr = 1;
2322 2322
             foreach ($registrations as $registration) {
2323 2323
                 /* @var $registration EE_Registration */
2324
-                $attendee                                                    = $registration->attendee()
2324
+                $attendee = $registration->attendee()
2325 2325
                     ? $registration->attendee()
2326 2326
                     : EEM_Attendee::instance()
2327 2327
                                   ->create_default_object();
@@ -2334,19 +2334,19 @@  discard block
 block discarded – undo
2334 2334
                     ', ',
2335 2335
                     $attendee->full_address_as_array()
2336 2336
                 );
2337
-                $this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
2337
+                $this->_template_args['attendees'][$att_nmbr]['att_link'] = self::add_query_args_and_nonce(
2338 2338
                     array(
2339 2339
                         'action' => 'edit_attendee',
2340 2340
                         'post'   => $attendee->ID(),
2341 2341
                     ),
2342 2342
                     REG_ADMIN_URL
2343 2343
                 );
2344
-                $this->_template_args['attendees'][$att_nmbr]['event_name']  = $registration->event_obj()->name();
2344
+                $this->_template_args['attendees'][$att_nmbr]['event_name'] = $registration->event_obj()->name();
2345 2345
                 $att_nmbr++;
2346 2346
             }
2347 2347
             $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
2348 2348
         }
2349
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
2349
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_attendees.template.php';
2350 2350
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
2351 2351
     }
2352 2352
 
@@ -2386,20 +2386,20 @@  discard block
 block discarded – undo
2386 2386
         $this->_template_args['phone']             = $attendee->phone();
2387 2387
         $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
2388 2388
         //edit link
2389
-        $this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(array(
2389
+        $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
2390 2390
             'action' => 'edit_attendee',
2391 2391
             'post'   => $attendee->ID(),
2392 2392
         ), REG_ADMIN_URL);
2393 2393
         $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
2394 2394
         //create link
2395
-        $this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
2395
+        $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration
2396 2396
             ? EE_Admin_Page::add_query_args_and_nonce(array(
2397 2397
                 'action'  => 'duplicate_attendee',
2398 2398
                 '_REG_ID' => $this->_registration->ID(),
2399 2399
             ), REG_ADMIN_URL) : '';
2400 2400
         $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
2401 2401
         $this->_template_args['att_check']    = $att_check;
2402
-        $template_path                        = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
2402
+        $template_path                        = REG_TEMPLATE_PATH.'reg_admin_details_side_meta_box_registrant.template.php';
2403 2403
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
2404 2404
     }
2405 2405
 
@@ -2441,7 +2441,7 @@  discard block
 block discarded – undo
2441 2441
             /** @var EE_Registration $REG */
2442 2442
             $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
2443 2443
             $payments = $REG->registration_payments();
2444
-            if (! empty($payments)) {
2444
+            if ( ! empty($payments)) {
2445 2445
                 $name = $REG->attendee() instanceof EE_Attendee
2446 2446
                     ? $REG->attendee()->full_name()
2447 2447
                     : esc_html__('Unknown Attendee', 'event_espresso');
@@ -2634,7 +2634,7 @@  discard block
 block discarded – undo
2634 2634
                 'action' => 'edit',
2635 2635
                 'post'   => $this->_reg_event->ID(),
2636 2636
             ), EVENTS_ADMIN_URL);
2637
-            $edit_event_lnk                     = '<a href="'
2637
+            $edit_event_lnk = '<a href="'
2638 2638
                                                   . $edit_event_url
2639 2639
                                                   . '" title="'
2640 2640
                                                   . esc_attr__('Edit ', 'event_espresso')
@@ -2652,7 +2652,7 @@  discard block
 block discarded – undo
2652 2652
         }
2653 2653
         // grab header
2654 2654
         $template_path                              =
2655
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
2655
+            REG_TEMPLATE_PATH.'reg_admin_register_new_attendee.template.php';
2656 2656
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
2657 2657
             $this->_template_args, true);
2658 2658
         //$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
@@ -2687,7 +2687,7 @@  discard block
 block discarded – undo
2687 2687
                 '</b>'
2688 2688
             );
2689 2689
             return '
2690
-	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
2690
+	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg.'</p></div>
2691 2691
 	<script >
2692 2692
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
2693 2693
 		// after just adding a new registration... we gotta try to put a stop to that !!!
@@ -2755,7 +2755,7 @@  discard block
 block discarded – undo
2755 2755
         //we come back to the process_registration_step route.
2756 2756
         $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
2757 2757
         return EEH_Template::display_template(
2758
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
2758
+            REG_TEMPLATE_PATH.'reg_admin_register_new_attendee_step_content.template.php',
2759 2759
             $template_args,
2760 2760
             true
2761 2761
         );
@@ -2774,7 +2774,7 @@  discard block
 block discarded – undo
2774 2774
         if (is_object($this->_reg_event)) {
2775 2775
             return true;
2776 2776
         }
2777
-        $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
2777
+        $EVT_ID = ( ! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
2778 2778
         if ( ! $EVT_ID) {
2779 2779
             return false;
2780 2780
         }
@@ -2840,7 +2840,7 @@  discard block
 block discarded – undo
2840 2840
                 }
2841 2841
                 break;
2842 2842
             case 'questions' :
2843
-                if (! isset(
2843
+                if ( ! isset(
2844 2844
                     $this->_req_data['txn_reg_status_change'],
2845 2845
                     $this->_req_data['txn_reg_status_change']['send_notifications'])
2846 2846
                 ) {
@@ -2954,7 +2954,7 @@  discard block
 block discarded – undo
2954 2954
     public function get_attendees($per_page, $count = false, $trash = false)
2955 2955
     {
2956 2956
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2957
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
2957
+        require_once(REG_ADMIN.'EE_Attendee_Contact_List_Table.class.php');
2958 2958
         $ATT_MDL                    = EEM_Attendee::instance();
2959 2959
         $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
2960 2960
         switch ($this->_req_data['orderby']) {
@@ -2991,7 +2991,7 @@  discard block
 block discarded – undo
2991 2991
             : $per_page;
2992 2992
         $_where       = array();
2993 2993
         if ( ! empty($this->_req_data['s'])) {
2994
-            $sstr         = '%' . $this->_req_data['s'] . '%';
2994
+            $sstr         = '%'.$this->_req_data['s'].'%';
2995 2995
             $_where['OR'] = array(
2996 2996
                 'Registration.Event.EVT_name'       => array('LIKE', $sstr),
2997 2997
                 'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
@@ -3067,9 +3067,9 @@  discard block
 block discarded – undo
3067 3067
      *                                                     the query parameters from the request
3068 3068
      * @return void ends the request with a redirect or download
3069 3069
      */
3070
-    public function _registrations_report_base( $method_name_for_getting_query_params )
3070
+    public function _registrations_report_base($method_name_for_getting_query_params)
3071 3071
     {
3072
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
3072
+        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
3073 3073
             wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
3074 3074
                 array(
3075 3075
                     'page'        => 'espresso_batch',
@@ -3078,7 +3078,7 @@  discard block
 block discarded – undo
3078 3078
                     'filters'     => urlencode(
3079 3079
                         serialize(
3080 3080
                             call_user_func(
3081
-                                array( $this, $method_name_for_getting_query_params ),
3081
+                                array($this, $method_name_for_getting_query_params),
3082 3082
                                 EEH_Array::is_set(
3083 3083
                                     $this->_req_data,
3084 3084
                                     'filters',
@@ -3098,8 +3098,8 @@  discard block
 block discarded – undo
3098 3098
                 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
3099 3099
             );
3100 3100
             $this->_req_data = array_merge($this->_req_data, $new_request_args);
3101
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
3102
-                require_once(EE_CLASSES . 'EE_Export.class.php');
3101
+            if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
3102
+                require_once(EE_CLASSES.'EE_Export.class.php');
3103 3103
                 $EE_Export = EE_Export::instance($this->_req_data);
3104 3104
                 $EE_Export->export();
3105 3105
             }
@@ -3120,8 +3120,8 @@  discard block
 block discarded – undo
3120 3120
 
3121 3121
     public function _contact_list_export()
3122 3122
     {
3123
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
3124
-            require_once(EE_CLASSES . 'EE_Export.class.php');
3123
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
3124
+            require_once(EE_CLASSES.'EE_Export.class.php');
3125 3125
             $EE_Export = EE_Export::instance($this->_req_data);
3126 3126
             $EE_Export->export_attendees();
3127 3127
         }
@@ -3138,8 +3138,8 @@  discard block
 block discarded – undo
3138 3138
                 'return_url'  => urlencode($this->_req_data['return_url']),
3139 3139
             )));
3140 3140
         } else {
3141
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
3142
-                require_once(EE_CLASSES . 'EE_Export.class.php');
3141
+            if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
3142
+                require_once(EE_CLASSES.'EE_Export.class.php');
3143 3143
                 $EE_Export = EE_Export::instance($this->_req_data);
3144 3144
                 $EE_Export->report_attendees();
3145 3145
             }
@@ -3205,7 +3205,7 @@  discard block
 block discarded – undo
3205 3205
             $updated_fields = array(
3206 3206
                 'ATT_fname'     => $this->_req_data['ATT_fname'],
3207 3207
                 'ATT_lname'     => $this->_req_data['ATT_lname'],
3208
-                'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
3208
+                'ATT_full_name' => $this->_req_data['ATT_fname'].' '.$this->_req_data['ATT_lname'],
3209 3209
                 'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
3210 3210
                 'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
3211 3211
                 'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
@@ -3338,7 +3338,7 @@  discard block
 block discarded – undo
3338 3338
     {
3339 3339
         //get attendee object ( should already have it )
3340 3340
         $this->_template_args['attendee'] = $this->_cpt_model_obj;
3341
-        $template                         = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php';
3341
+        $template                         = REG_TEMPLATE_PATH.'attendee_contact_info_metabox_content.template.php';
3342 3342
         EEH_Template::display_template($template, $this->_template_args);
3343 3343
     }
3344 3344
 
@@ -3400,8 +3400,8 @@  discard block
 block discarded – undo
3400 3400
                 )
3401 3401
             )
3402 3402
         );
3403
-        $template                             =
3404
-            REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
3403
+        $template =
3404
+            REG_TEMPLATE_PATH.'attendee_address_details_metabox_content.template.php';
3405 3405
         EEH_Template::display_template($template, $this->_template_args);
3406 3406
     }
3407 3407
 
@@ -3420,7 +3420,7 @@  discard block
 block discarded – undo
3420 3420
         $this->_template_args['attendee']      = $this->_cpt_model_obj;
3421 3421
         $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
3422 3422
         $template                              =
3423
-            REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
3423
+            REG_TEMPLATE_PATH.'attendee_registrations_main_meta_box.template.php';
3424 3424
         EEH_Template::display_template($template, $this->_template_args);
3425 3425
     }
3426 3426
 
@@ -3435,7 +3435,7 @@  discard block
 block discarded – undo
3435 3435
     public function after_title_form_fields($post)
3436 3436
     {
3437 3437
         if ($post->post_type == 'espresso_attendees') {
3438
-            $template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
3438
+            $template                  = REG_TEMPLATE_PATH.'attendee_details_after_title_form_fields.template.php';
3439 3439
             $template_args['attendee'] = $this->_cpt_model_obj;
3440 3440
             EEH_Template::display_template($template, $template_args);
3441 3441
         }
Please login to merge, or discard this patch.
Indentation   +3425 added lines, -3425 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 
5 5
 
@@ -23,2111 +23,2111 @@  discard block
 block discarded – undo
23 23
 class Registrations_Admin_Page extends EE_Admin_Page_CPT
24 24
 {
25 25
 
26
-    /**
27
-     * @var EE_Registration
28
-     */
29
-    private $_registration;
30
-
31
-    /**
32
-     * @var EE_Event
33
-     */
34
-    private $_reg_event;
35
-
36
-    /**
37
-     * @var EE_Session
38
-     */
39
-    private $_session;
40
-
41
-    private static $_reg_status;
42
-
43
-    /**
44
-     * Form for displaying the custom questions for this registration.
45
-     * This gets used a few times throughout the request so its best to cache it
46
-     *
47
-     * @var EE_Registration_Custom_Questions_Form
48
-     */
49
-    protected $_reg_custom_questions_form = null;
50
-
51
-
52
-    /**
53
-     *        constructor
54
-     *
55
-     * @Constructor
56
-     * @access public
57
-     * @param bool $routing
58
-     * @return Registrations_Admin_Page
59
-     */
60
-    public function __construct($routing = true)
61
-    {
62
-        parent::__construct($routing);
63
-        add_action('wp_loaded', array($this, 'wp_loaded'));
64
-    }
65
-
66
-
67
-    public function wp_loaded()
68
-    {
69
-        // when adding a new registration...
70
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
71
-            EE_System::do_not_cache();
72
-            if (! isset($this->_req_data['processing_registration'])
73
-                 || absint($this->_req_data['processing_registration']) !== 1
74
-            ) {
75
-                // and it's NOT the attendee information reg step
76
-                // force cookie expiration by setting time to last week
77
-                setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
78
-                // and update the global
79
-                $_COOKIE['ee_registration_added'] = 0;
80
-            }
81
-        }
82
-    }
83
-
84
-
85
-    protected function _init_page_props()
86
-    {
87
-        $this->page_slug        = REG_PG_SLUG;
88
-        $this->_admin_base_url  = REG_ADMIN_URL;
89
-        $this->_admin_base_path = REG_ADMIN;
90
-        $this->page_label       = esc_html__('Registrations', 'event_espresso');
91
-        $this->_cpt_routes      = array(
92
-            'add_new_attendee' => 'espresso_attendees',
93
-            'edit_attendee'    => 'espresso_attendees',
94
-            'insert_attendee'  => 'espresso_attendees',
95
-            'update_attendee'  => 'espresso_attendees',
96
-        );
97
-        $this->_cpt_model_names = array(
98
-            'add_new_attendee' => 'EEM_Attendee',
99
-            'edit_attendee'    => 'EEM_Attendee',
100
-        );
101
-        $this->_cpt_edit_routes = array(
102
-            'espresso_attendees' => 'edit_attendee',
103
-        );
104
-        $this->_pagenow_map     = array(
105
-            'add_new_attendee' => 'post-new.php',
106
-            'edit_attendee'    => 'post.php',
107
-            'trash'            => 'post.php',
108
-        );
109
-        add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
110
-        //add filters so that the comment urls don't take users to a confusing 404 page
111
-        add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
112
-    }
113
-
114
-
115
-    public function clear_comment_link($link, $comment, $args)
116
-    {
117
-        //gotta make sure this only happens on this route
118
-        $post_type = get_post_type($comment->comment_post_ID);
119
-        if ($post_type === 'espresso_attendees') {
120
-            return '#commentsdiv';
121
-        }
122
-        return $link;
123
-    }
124
-
125
-
126
-    protected function _ajax_hooks()
127
-    {
128
-        //todo: all hooks for registrations ajax goes in here
129
-        add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
130
-    }
131
-
132
-
133
-    protected function _define_page_props()
134
-    {
135
-        $this->_admin_page_title = $this->page_label;
136
-        $this->_labels           = array(
137
-            'buttons'                      => array(
138
-                'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
139
-                'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
140
-                'edit'                => esc_html__('Edit Contact', 'event_espresso'),
141
-                'report'              => esc_html__("Event Registrations CSV Report", "event_espresso"),
142
-                'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
143
-                'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
144
-                'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
145
-                'contact_list_export' => esc_html__("Export Data", "event_espresso"),
146
-            ),
147
-            'publishbox'                   => array(
148
-                'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'),
149
-                'edit_attendee'    => esc_html__("Update Contact Record", 'event_espresso'),
150
-            ),
151
-            'hide_add_button_on_cpt_route' => array(
152
-                'edit_attendee' => true,
153
-            ),
154
-        );
155
-    }
156
-
157
-
158
-    /**
159
-     *        grab url requests and route them
160
-     *
161
-     * @access private
162
-     * @return void
163
-     */
164
-    public function _set_page_routes()
165
-    {
166
-        $this->_get_registration_status_array();
167
-        $reg_id             = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
168
-            ? $this->_req_data['_REG_ID'] : 0;
169
-        $att_id             = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
170
-            ? $this->_req_data['ATT_ID'] : 0;
171
-        $att_id             = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post'])
172
-            ? $this->_req_data['post']
173
-            : $att_id;
174
-        $this->_page_routes = array(
175
-            'default'                            => array(
176
-                'func'       => '_registrations_overview_list_table',
177
-                'capability' => 'ee_read_registrations',
178
-            ),
179
-            'view_registration'                  => array(
180
-                'func'       => '_registration_details',
181
-                'capability' => 'ee_read_registration',
182
-                'obj_id'     => $reg_id,
183
-            ),
184
-            'edit_registration'                  => array(
185
-                'func'               => '_update_attendee_registration_form',
186
-                'noheader'           => true,
187
-                'headers_sent_route' => 'view_registration',
188
-                'capability'         => 'ee_edit_registration',
189
-                'obj_id'             => $reg_id,
190
-                '_REG_ID'            => $reg_id,
191
-            ),
192
-            'trash_registrations'                => array(
193
-                'func'       => '_trash_or_restore_registrations',
194
-                'args'       => array('trash' => true),
195
-                'noheader'   => true,
196
-                'capability' => 'ee_delete_registrations',
197
-            ),
198
-            'restore_registrations'              => array(
199
-                'func'       => '_trash_or_restore_registrations',
200
-                'args'       => array('trash' => false),
201
-                'noheader'   => true,
202
-                'capability' => 'ee_delete_registrations',
203
-            ),
204
-            'delete_registrations'               => array(
205
-                'func'       => '_delete_registrations',
206
-                'noheader'   => true,
207
-                'capability' => 'ee_delete_registrations',
208
-            ),
209
-            'new_registration'                   => array(
210
-                'func'       => 'new_registration',
211
-                'capability' => 'ee_edit_registrations',
212
-            ),
213
-            'process_reg_step'                   => array(
214
-                'func'       => 'process_reg_step',
215
-                'noheader'   => true,
216
-                'capability' => 'ee_edit_registrations',
217
-            ),
218
-            'redirect_to_txn'                    => array(
219
-                'func'       => 'redirect_to_txn',
220
-                'noheader'   => true,
221
-                'capability' => 'ee_edit_registrations',
222
-            ),
223
-            'change_reg_status'                  => array(
224
-                'func'       => '_change_reg_status',
225
-                'noheader'   => true,
226
-                'capability' => 'ee_edit_registration',
227
-                'obj_id'     => $reg_id,
228
-            ),
229
-            'approve_registration'               => array(
230
-                'func'       => 'approve_registration',
231
-                'noheader'   => true,
232
-                'capability' => 'ee_edit_registration',
233
-                'obj_id'     => $reg_id,
234
-            ),
235
-            'approve_and_notify_registration'    => array(
236
-                'func'       => 'approve_registration',
237
-                'noheader'   => true,
238
-                'args'       => array(true),
239
-                'capability' => 'ee_edit_registration',
240
-                'obj_id'     => $reg_id,
241
-            ),
242
-            'decline_registration'               => array(
243
-                'func'       => 'decline_registration',
244
-                'noheader'   => true,
245
-                'capability' => 'ee_edit_registration',
246
-                'obj_id'     => $reg_id,
247
-            ),
248
-            'decline_and_notify_registration'    => array(
249
-                'func'       => 'decline_registration',
250
-                'noheader'   => true,
251
-                'args'       => array(true),
252
-                'capability' => 'ee_edit_registration',
253
-                'obj_id'     => $reg_id,
254
-            ),
255
-            'pending_registration'               => array(
256
-                'func'       => 'pending_registration',
257
-                'noheader'   => true,
258
-                'capability' => 'ee_edit_registration',
259
-                'obj_id'     => $reg_id,
260
-            ),
261
-            'pending_and_notify_registration'    => array(
262
-                'func'       => 'pending_registration',
263
-                'noheader'   => true,
264
-                'args'       => array(true),
265
-                'capability' => 'ee_edit_registration',
266
-                'obj_id'     => $reg_id,
267
-            ),
268
-            'no_approve_registration'            => array(
269
-                'func'       => 'not_approve_registration',
270
-                'noheader'   => true,
271
-                'capability' => 'ee_edit_registration',
272
-                'obj_id'     => $reg_id,
273
-            ),
274
-            'no_approve_and_notify_registration' => array(
275
-                'func'       => 'not_approve_registration',
276
-                'noheader'   => true,
277
-                'args'       => array(true),
278
-                'capability' => 'ee_edit_registration',
279
-                'obj_id'     => $reg_id,
280
-            ),
281
-            'cancel_registration'                => array(
282
-                'func'       => 'cancel_registration',
283
-                'noheader'   => true,
284
-                'capability' => 'ee_edit_registration',
285
-                'obj_id'     => $reg_id,
286
-            ),
287
-            'cancel_and_notify_registration'     => array(
288
-                'func'       => 'cancel_registration',
289
-                'noheader'   => true,
290
-                'args'       => array(true),
291
-                'capability' => 'ee_edit_registration',
292
-                'obj_id'     => $reg_id,
293
-            ),
294
-            'contact_list'                       => array(
295
-                'func'       => '_attendee_contact_list_table',
296
-                'capability' => 'ee_read_contacts',
297
-            ),
298
-            'add_new_attendee'                   => array(
299
-                'func' => '_create_new_cpt_item',
300
-                'args' => array(
301
-                    'new_attendee' => true,
302
-                    'capability'   => 'ee_edit_contacts',
303
-                ),
304
-            ),
305
-            'edit_attendee'                      => array(
306
-                'func'       => '_edit_cpt_item',
307
-                'capability' => 'ee_edit_contacts',
308
-                'obj_id'     => $att_id,
309
-            ),
310
-            'duplicate_attendee'                 => array(
311
-                'func'       => '_duplicate_attendee',
312
-                'noheader'   => true,
313
-                'capability' => 'ee_edit_contacts',
314
-                'obj_id'     => $att_id,
315
-            ),
316
-            'insert_attendee'                    => array(
317
-                'func'       => '_insert_or_update_attendee',
318
-                'args'       => array(
319
-                    'new_attendee' => true,
320
-                ),
321
-                'noheader'   => true,
322
-                'capability' => 'ee_edit_contacts',
323
-            ),
324
-            'update_attendee'                    => array(
325
-                'func'       => '_insert_or_update_attendee',
326
-                'args'       => array(
327
-                    'new_attendee' => false,
328
-                ),
329
-                'noheader'   => true,
330
-                'capability' => 'ee_edit_contacts',
331
-                'obj_id'     => $att_id,
332
-            ),
333
-            'trash_attendee'                    => array(
334
-                'func'       => '_trash_or_restore_attendees',
335
-                'args'       => array(
336
-                    'trash' => true,
337
-                ),
338
-                'noheader'   => true,
339
-                'capability' => 'ee_delete_contacts',
340
-                'obj_id'     => $att_id,
341
-            ),
342
-            'restore_attendees'                  => array(
343
-                'func'       => '_trash_or_restore_attendees',
344
-                'args'       => array(
345
-                    'trash' => false,
346
-                ),
347
-                'noheader'   => true,
348
-                'capability' => 'ee_delete_contacts',
349
-                'obj_id'     => $att_id,
350
-            ),
351
-            'resend_registration'                => array(
352
-                'func'       => '_resend_registration',
353
-                'noheader'   => true,
354
-                'capability' => 'ee_send_message',
355
-            ),
356
-            'registrations_report'               => array(
357
-                'func'       => '_registrations_report',
358
-                'noheader'   => true,
359
-                'capability' => 'ee_read_registrations',
360
-            ),
361
-            'contact_list_export'                => array(
362
-                'func'       => '_contact_list_export',
363
-                'noheader'   => true,
364
-                'capability' => 'export',
365
-            ),
366
-            'contact_list_report'                => array(
367
-                'func'       => '_contact_list_report',
368
-                'noheader'   => true,
369
-                'capability' => 'ee_read_contacts',
370
-            ),
371
-        );
372
-    }
373
-
374
-
375
-    protected function _set_page_config()
376
-    {
377
-        $this->_page_config = array(
378
-            'default'           => array(
379
-                'nav'           => array(
380
-                    'label' => esc_html__('Overview', 'event_espresso'),
381
-                    'order' => 5,
382
-                ),
383
-                'help_tabs'     => array(
384
-                    'registrations_overview_help_tab'                       => array(
385
-                        'title'    => esc_html__('Registrations Overview', 'event_espresso'),
386
-                        'filename' => 'registrations_overview',
387
-                    ),
388
-                    'registrations_overview_table_column_headings_help_tab' => array(
389
-                        'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
390
-                        'filename' => 'registrations_overview_table_column_headings',
391
-                    ),
392
-                    'registrations_overview_filters_help_tab'               => array(
393
-                        'title'    => esc_html__('Registration Filters', 'event_espresso'),
394
-                        'filename' => 'registrations_overview_filters',
395
-                    ),
396
-                    'registrations_overview_views_help_tab'                 => array(
397
-                        'title'    => esc_html__('Registration Views', 'event_espresso'),
398
-                        'filename' => 'registrations_overview_views',
399
-                    ),
400
-                    'registrations_regoverview_other_help_tab'              => array(
401
-                        'title'    => esc_html__('Registrations Other', 'event_espresso'),
402
-                        'filename' => 'registrations_overview_other',
403
-                    ),
404
-                ),
405
-                'help_tour'     => array('Registration_Overview_Help_Tour'),
406
-                'qtips'         => array('Registration_List_Table_Tips'),
407
-                'list_table'    => 'EE_Registrations_List_Table',
408
-                'require_nonce' => false,
409
-            ),
410
-            'view_registration' => array(
411
-                'nav'           => array(
412
-                    'label'      => esc_html__('REG Details', 'event_espresso'),
413
-                    'order'      => 15,
414
-                    'url'        => isset($this->_req_data['_REG_ID'])
415
-                        ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
416
-                        : $this->_admin_base_url,
417
-                    'persistent' => false,
418
-                ),
419
-                'help_tabs'     => array(
420
-                    'registrations_details_help_tab'                    => array(
421
-                        'title'    => esc_html__('Registration Details', 'event_espresso'),
422
-                        'filename' => 'registrations_details',
423
-                    ),
424
-                    'registrations_details_table_help_tab'              => array(
425
-                        'title'    => esc_html__('Registration Details Table', 'event_espresso'),
426
-                        'filename' => 'registrations_details_table',
427
-                    ),
428
-                    'registrations_details_form_answers_help_tab'       => array(
429
-                        'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
430
-                        'filename' => 'registrations_details_form_answers',
431
-                    ),
432
-                    'registrations_details_registrant_details_help_tab' => array(
433
-                        'title'    => esc_html__('Contact Details', 'event_espresso'),
434
-                        'filename' => 'registrations_details_registrant_details',
435
-                    ),
436
-                ),
437
-                'help_tour'     => array('Registration_Details_Help_Tour'),
438
-                'metaboxes'     => array_merge(
439
-                    $this->_default_espresso_metaboxes,
440
-                    array('_registration_details_metaboxes')
441
-                ),
442
-                'require_nonce' => false,
443
-            ),
444
-            'new_registration'  => array(
445
-                'nav'           => array(
446
-                    'label'      => esc_html__('Add New Registration', 'event_espresso'),
447
-                    'url'        => '#',
448
-                    'order'      => 15,
449
-                    'persistent' => false,
450
-                ),
451
-                'metaboxes'     => $this->_default_espresso_metaboxes,
452
-                'labels'        => array(
453
-                    'publishbox' => esc_html__('Save Registration', 'event_espresso'),
454
-                ),
455
-                'require_nonce' => false,
456
-            ),
457
-            'add_new_attendee'  => array(
458
-                'nav'           => array(
459
-                    'label'      => esc_html__('Add Contact', 'event_espresso'),
460
-                    'order'      => 15,
461
-                    'persistent' => false,
462
-                ),
463
-                'metaboxes'     => array_merge(
464
-                    $this->_default_espresso_metaboxes,
465
-                    array('_publish_post_box', 'attendee_editor_metaboxes')
466
-                ),
467
-                'require_nonce' => false,
468
-            ),
469
-            'edit_attendee'     => array(
470
-                'nav'           => array(
471
-                    'label'      => esc_html__('Edit Contact', 'event_espresso'),
472
-                    'order'      => 15,
473
-                    'persistent' => false,
474
-                    'url'        => isset($this->_req_data['ATT_ID'])
475
-                        ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
476
-                        : $this->_admin_base_url,
477
-                ),
478
-                'metaboxes'     => array('attendee_editor_metaboxes'),
479
-                'require_nonce' => false,
480
-            ),
481
-            'contact_list'      => array(
482
-                'nav'           => array(
483
-                    'label' => esc_html__('Contact List', 'event_espresso'),
484
-                    'order' => 20,
485
-                ),
486
-                'list_table'    => 'EE_Attendee_Contact_List_Table',
487
-                'help_tabs'     => array(
488
-                    'registrations_contact_list_help_tab'                       => array(
489
-                        'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
490
-                        'filename' => 'registrations_contact_list',
491
-                    ),
492
-                    'registrations_contact-list_table_column_headings_help_tab' => array(
493
-                        'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
494
-                        'filename' => 'registrations_contact_list_table_column_headings',
495
-                    ),
496
-                    'registrations_contact_list_views_help_tab'                 => array(
497
-                        'title'    => esc_html__('Contact List Views', 'event_espresso'),
498
-                        'filename' => 'registrations_contact_list_views',
499
-                    ),
500
-                    'registrations_contact_list_other_help_tab'                 => array(
501
-                        'title'    => esc_html__('Contact List Other', 'event_espresso'),
502
-                        'filename' => 'registrations_contact_list_other',
503
-                    ),
504
-                ),
505
-                'help_tour'     => array('Contact_List_Help_Tour'),
506
-                'metaboxes'     => array(),
507
-                'require_nonce' => false,
508
-            ),
509
-            //override default cpt routes
510
-            'create_new'        => '',
511
-            'edit'              => '',
512
-        );
513
-    }
514
-
515
-
516
-    /**
517
-     * The below methods aren't used by this class currently
518
-     */
519
-    protected function _add_screen_options()
520
-    {
521
-    }
522
-
523
-
524
-    protected function _add_feature_pointers()
525
-    {
526
-    }
527
-
528
-
529
-    public function admin_init()
530
-    {
531
-        EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
532
-            'click "Update Registration Questions" to save your changes',
533
-            'event_espresso'
534
-        );
535
-    }
536
-
537
-
538
-    public function admin_notices()
539
-    {
540
-    }
541
-
542
-
543
-    public function admin_footer_scripts()
544
-    {
545
-    }
546
-
547
-
548
-    /**
549
-     *        get list of registration statuses
550
-     *
551
-     * @access private
552
-     * @return void
553
-     */
554
-    private function _get_registration_status_array()
555
-    {
556
-        self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
557
-    }
558
-
559
-
560
-    protected function _add_screen_options_default()
561
-    {
562
-        $this->_per_page_screen_option();
563
-    }
564
-
565
-
566
-    protected function _add_screen_options_contact_list()
567
-    {
568
-        $page_title              = $this->_admin_page_title;
569
-        $this->_admin_page_title = esc_html__("Contacts", 'event_espresso');
570
-        $this->_per_page_screen_option();
571
-        $this->_admin_page_title = $page_title;
572
-    }
573
-
574
-
575
-    public function load_scripts_styles()
576
-    {
577
-        //style
578
-        wp_register_style(
579
-            'espresso_reg',
580
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
581
-            array('ee-admin-css'),
582
-            EVENT_ESPRESSO_VERSION
583
-        );
584
-        wp_enqueue_style('espresso_reg');
585
-        //script
586
-        wp_register_script(
587
-            'espresso_reg',
588
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
589
-            array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
590
-            EVENT_ESPRESSO_VERSION,
591
-            true
592
-        );
593
-        wp_enqueue_script('espresso_reg');
594
-    }
595
-
596
-
597
-    public function load_scripts_styles_edit_attendee()
598
-    {
599
-        //stuff to only show up on our attendee edit details page.
600
-        $attendee_details_translations = array(
601
-            'att_publish_text' => sprintf(
602
-                esc_html__('Created on: <b>%1$s</b>', 'event_espresso'),
603
-                $this->_cpt_model_obj->get_datetime('ATT_created')
604
-            ),
605
-        );
606
-        wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
607
-        wp_enqueue_script('jquery-validate');
608
-    }
609
-
610
-
611
-    public function load_scripts_styles_view_registration()
612
-    {
613
-        //styles
614
-        wp_enqueue_style('espresso-ui-theme');
615
-        //scripts
616
-        $this->_get_reg_custom_questions_form($this->_registration->ID());
617
-        $this->_reg_custom_questions_form->wp_enqueue_scripts(true);
618
-    }
619
-
620
-
621
-    public function load_scripts_styles_contact_list()
622
-    {
623
-        wp_deregister_style('espresso_reg');
624
-        wp_register_style(
625
-            'espresso_att',
626
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
627
-            array('ee-admin-css'),
628
-            EVENT_ESPRESSO_VERSION
629
-        );
630
-        wp_enqueue_style('espresso_att');
631
-    }
632
-
633
-
634
-    public function load_scripts_styles_new_registration()
635
-    {
636
-        wp_register_script(
637
-            'ee-spco-for-admin',
638
-            REG_ASSETS_URL . 'spco_for_admin.js',
639
-            array('underscore', 'jquery'),
640
-            EVENT_ESPRESSO_VERSION,
641
-            true
642
-        );
643
-        wp_enqueue_script('ee-spco-for-admin');
644
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
645
-        EE_Form_Section_Proper::wp_enqueue_scripts();
646
-        EED_Ticket_Selector::load_tckt_slctr_assets();
647
-        EE_Datepicker_Input::enqueue_styles_and_scripts();
648
-    }
649
-
650
-
651
-    public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
652
-    {
653
-        add_filter('FHEE_load_EE_messages', '__return_true');
654
-    }
655
-
656
-
657
-    public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
658
-    {
659
-        add_filter('FHEE_load_EE_messages', '__return_true');
660
-    }
661
-
662
-
663
-    protected function _set_list_table_views_default()
664
-    {
665
-        //for notification related bulk actions we need to make sure only active messengers have an option.
666
-        EED_Messages::set_autoloaders();
667
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
668
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
669
-        $active_mts               = $message_resource_manager->list_of_active_message_types();
670
-        //key= bulk_action_slug, value= message type.
671
-        $match_array = array(
672
-            'approve_registration'    => 'registration',
673
-            'decline_registration'    => 'declined_registration',
674
-            'pending_registration'    => 'pending_approval',
675
-            'no_approve_registration' => 'not_approved_registration',
676
-            'cancel_registration'     => 'cancelled_registration',
677
-        );
678
-        /** setup reg status bulk actions **/
679
-        $def_reg_status_actions['approve_registration'] = esc_html__('Approve Registrations', 'event_espresso');
680
-        if (in_array($match_array['approve_registration'], $active_mts)
681
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
682
-        ) {
683
-            $def_reg_status_actions['approve_and_notify_registration'] = esc_html__(
684
-                'Approve and Notify Registrations',
685
-                'event_espresso'
686
-            );
687
-        }
688
-        $def_reg_status_actions['decline_registration'] = esc_html__('Decline Registrations', 'event_espresso');
689
-        if (in_array($match_array['decline_registration'], $active_mts)
690
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
691
-        ) {
692
-            $def_reg_status_actions['decline_and_notify_registration'] = esc_html__(
693
-                'Decline and Notify Registrations',
694
-                'event_espresso'
695
-            );
696
-        }
697
-        $def_reg_status_actions['pending_registration'] = esc_html__(
698
-            'Set Registrations to Pending Payment',
699
-            'event_espresso'
700
-        );
701
-        if (in_array($match_array['pending_registration'], $active_mts)
702
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
703
-        ) {
704
-            $def_reg_status_actions['pending_and_notify_registration'] = esc_html__(
705
-                'Set Registrations to Pending Payment and Notify',
706
-                'event_espresso'
707
-            );
708
-        }
709
-        $def_reg_status_actions['no_approve_registration'] = esc_html__(
710
-            'Set Registrations to Not Approved',
711
-            'event_espresso'
712
-        );
713
-        if (in_array($match_array['no_approve_registration'], $active_mts)
714
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
715
-        ) {
716
-            $def_reg_status_actions['no_approve_and_notify_registration'] = esc_html__(
717
-                'Set Registrations to Not Approved and Notify',
718
-                'event_espresso'
719
-            );
720
-        }
721
-        $def_reg_status_actions['cancel_registration'] = esc_html__('Cancel Registrations', 'event_espresso');
722
-        if (in_array($match_array['cancel_registration'], $active_mts)
723
-            && EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
724
-        ) {
725
-            $def_reg_status_actions['cancel_and_notify_registration'] = esc_html__(
726
-                'Cancel Registrations and Notify',
727
-                'event_espresso'
728
-            );
729
-        }
730
-        $this->_views = array(
731
-            'all'   => array(
732
-                'slug'        => 'all',
733
-                'label'       => esc_html__('View All Registrations', 'event_espresso'),
734
-                'count'       => 0,
735
-                'bulk_action' => array_merge($def_reg_status_actions, array(
736
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
737
-                )),
738
-            ),
739
-            'month' => array(
740
-                'slug'        => 'month',
741
-                'label'       => esc_html__('This Month', 'event_espresso'),
742
-                'count'       => 0,
743
-                'bulk_action' => array_merge($def_reg_status_actions, array(
744
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
745
-                )),
746
-            ),
747
-            'today' => array(
748
-                'slug'        => 'today',
749
-                'label'       => sprintf(
750
-                    esc_html__('Today - %s', 'event_espresso'),
751
-                    date('M d, Y', current_time('timestamp'))
752
-                ),
753
-                'count'       => 0,
754
-                'bulk_action' => array_merge($def_reg_status_actions, array(
755
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
756
-                )),
757
-            ),
758
-        );
759
-        if (EE_Registry::instance()->CAP->current_user_can(
760
-            'ee_delete_registrations',
761
-            'espresso_registrations_delete_registration'
762
-        )) {
763
-            $this->_views['incomplete'] = array(
764
-                'slug'        => 'incomplete',
765
-                'label'       => esc_html__('Incomplete', 'event_espresso'),
766
-                'count'       => 0,
767
-                'bulk_action' => array(
768
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
769
-                ),
770
-            );
771
-            $this->_views['trash']      = array(
772
-                'slug'        => 'trash',
773
-                'label'       => esc_html__('Trash', 'event_espresso'),
774
-                'count'       => 0,
775
-                'bulk_action' => array(
776
-                    'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
777
-                    'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
778
-                ),
779
-            );
780
-        }
781
-    }
782
-
783
-
784
-    protected function _set_list_table_views_contact_list()
785
-    {
786
-        $this->_views = array(
787
-            'in_use' => array(
788
-                'slug'        => 'in_use',
789
-                'label'       => esc_html__('In Use', 'event_espresso'),
790
-                'count'       => 0,
791
-                'bulk_action' => array(
792
-                    'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
793
-                ),
794
-            ),
795
-        );
796
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts',
797
-            'espresso_registrations_trash_attendees')
798
-        ) {
799
-            $this->_views['trash'] = array(
800
-                'slug'        => 'trash',
801
-                'label'       => esc_html__('Trash', 'event_espresso'),
802
-                'count'       => 0,
803
-                'bulk_action' => array(
804
-                    'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
805
-                ),
806
-            );
807
-        }
808
-    }
809
-
810
-
811
-    protected function _registration_legend_items()
812
-    {
813
-        $fc_items = array(
814
-            'star-icon'        => array(
815
-                'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
816
-                'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
817
-            ),
818
-            'view_details'     => array(
819
-                'class' => 'dashicons dashicons-clipboard',
820
-                'desc'  => esc_html__('View Registration Details', 'event_espresso'),
821
-            ),
822
-            'edit_attendee'    => array(
823
-                'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
824
-                'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
825
-            ),
826
-            'view_transaction' => array(
827
-                'class' => 'dashicons dashicons-cart',
828
-                'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
829
-            ),
830
-            'view_invoice'     => array(
831
-                'class' => 'dashicons dashicons-media-spreadsheet',
832
-                'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
833
-            ),
834
-        );
835
-        if (EE_Registry::instance()->CAP->current_user_can(
836
-            'ee_send_message',
837
-            'espresso_registrations_resend_registration'
838
-        )) {
839
-            $fc_items['resend_registration'] = array(
840
-                'class' => 'dashicons dashicons-email-alt',
841
-                'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
842
-            );
843
-        } else {
844
-            $fc_items['blank'] = array('class' => 'blank', 'desc' => '');
845
-        }
846
-        if (EE_Registry::instance()->CAP->current_user_can(
847
-            'ee_read_global_messages',
848
-            'view_filtered_messages'
849
-        )) {
850
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
851
-            if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
852
-                $fc_items['view_related_messages'] = array(
853
-                    'class' => $related_for_icon['css_class'],
854
-                    'desc'  => $related_for_icon['label'],
855
-                );
856
-            }
857
-        }
858
-        $sc_items = array(
859
-            'approved_status'   => array(
860
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
861
-                'desc'  => EEH_Template::pretty_status(
862
-                    EEM_Registration::status_id_approved,
863
-                    false,
864
-                    'sentence'
865
-                ),
866
-            ),
867
-            'pending_status'    => array(
868
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
869
-                'desc'  => EEH_Template::pretty_status(
870
-                    EEM_Registration::status_id_pending_payment,
871
-                    false,
872
-                    'sentence'
873
-                ),
874
-            ),
875
-            'wait_list'         => array(
876
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
877
-                'desc'  => EEH_Template::pretty_status(
878
-                    EEM_Registration::status_id_wait_list,
879
-                    false,
880
-                    'sentence'
881
-                ),
882
-            ),
883
-            'incomplete_status' => array(
884
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
885
-                'desc'  => EEH_Template::pretty_status(
886
-                    EEM_Registration::status_id_incomplete,
887
-                    false,
888
-                    'sentence'
889
-                ),
890
-            ),
891
-            'not_approved'      => array(
892
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
893
-                'desc'  => EEH_Template::pretty_status(
894
-                    EEM_Registration::status_id_not_approved,
895
-                    false,
896
-                    'sentence'
897
-                ),
898
-            ),
899
-            'declined_status'   => array(
900
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
901
-                'desc'  => EEH_Template::pretty_status(
902
-                    EEM_Registration::status_id_declined,
903
-                    false,
904
-                    'sentence'
905
-                ),
906
-            ),
907
-            'cancelled_status'  => array(
908
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
909
-                'desc'  => EEH_Template::pretty_status(
910
-                    EEM_Registration::status_id_cancelled,
911
-                    false,
912
-                    'sentence'
913
-                ),
914
-            ),
915
-        );
916
-        return array_merge($fc_items, $sc_items);
917
-    }
918
-
919
-
920
-
921
-    /***************************************        REGISTRATION OVERVIEW        **************************************/
922
-    /**
923
-     * @throws \EE_Error
924
-     */
925
-    protected function _registrations_overview_list_table()
926
-    {
927
-        $this->_template_args['admin_page_header'] = '';
928
-        $EVT_ID                                    = ! empty($this->_req_data['event_id'])
929
-            ? absint($this->_req_data['event_id'])
930
-            : 0;
931
-        if ($EVT_ID) {
932
-            if (EE_Registry::instance()->CAP->current_user_can(
933
-                'ee_edit_registrations',
934
-                'espresso_registrations_new_registration',
935
-                $EVT_ID
936
-            )) {
937
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
938
-                    'new_registration',
939
-                    'add-registrant',
940
-                    array('event_id' => $EVT_ID),
941
-                    'add-new-h2'
942
-                );
943
-            }
944
-            $event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
945
-            if ($event instanceof EE_Event) {
946
-                $this->_template_args['admin_page_header'] = sprintf(
947
-                    esc_html__(
948
-                        '%s Viewing registrations for the event: %s%s',
949
-                        'event_espresso'
950
-                    ),
951
-                    '<h3 style="line-height:1.5em;">',
952
-                    '<br /><a href="'
953
-                        . EE_Admin_Page::add_query_args_and_nonce(
954
-                            array(
955
-                                'action' => 'edit',
956
-                                'post'   => $event->ID(),
957
-                            ),
958
-                            EVENTS_ADMIN_URL
959
-                        )
960
-                        . '">&nbsp;'
961
-                        . $event->get('EVT_name')
962
-                        . '&nbsp;</a>&nbsp;',
963
-                    '</h3>'
964
-                );
965
-            }
966
-            $DTT_ID   = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
967
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
968
-            if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
969
-                $this->_template_args['admin_page_header'] = substr(
970
-                    $this->_template_args['admin_page_header'],
971
-                    0,
972
-                    -5
973
-                );
974
-                $this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
975
-                $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
976
-                $this->_template_args['admin_page_header'] .= $datetime->name();
977
-                $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
978
-                $this->_template_args['admin_page_header'] .= '</span></h3>';
979
-            }
980
-        }
981
-        $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
982
-        $this->display_admin_list_table_page_with_no_sidebar();
983
-    }
984
-
985
-
986
-    /**
987
-     * This sets the _registration property for the registration details screen
988
-     *
989
-     * @access private
990
-     * @return bool
991
-     */
992
-    private function _set_registration_object()
993
-    {
994
-        //get out if we've already set the object
995
-        if (is_object($this->_registration)) {
996
-            return true;
997
-        }
998
-        $REG    = EEM_Registration::instance();
999
-        $REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
1000
-        if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
1001
-            return true;
1002
-        } else {
1003
-            $error_msg = sprintf(
1004
-                esc_html__(
1005
-                    'An error occurred and the details for Registration ID #%s could not be retrieved.',
1006
-                    'event_espresso'
1007
-                ),
1008
-                $REG_ID
1009
-            );
1010
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
1011
-            $this->_registration = null;
1012
-            return false;
1013
-        }
1014
-    }
1015
-
1016
-
1017
-    /**
1018
-     * Used to retrieve registrations for the list table.
1019
-     *
1020
-     * @param int  $per_page
1021
-     * @param bool $count
1022
-     * @param bool $this_month
1023
-     * @param bool $today
1024
-     * @return EE_Registration[]|int
1025
-     * @throws EE_Error
1026
-     */
1027
-    public function get_registrations(
1028
-        $per_page = 10,
1029
-        $count = false,
1030
-        $this_month = false,
1031
-        $today = false
1032
-    ) {
1033
-        if ($this_month) {
1034
-            $this->_req_data['status'] = 'month';
1035
-        }
1036
-        if ($today) {
1037
-            $this->_req_data['status'] = 'today';
1038
-        }
1039
-        $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count);
1040
-        /**
1041
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
1042
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
1043
-         * @see EEM_Base::get_all()
1044
-         */
1045
-        $query_params['group_by'] = '';
1046
-
1047
-        return $count
1048
-            ? EEM_Registration::instance()->count($query_params)
1049
-            /** @type EE_Registration[] */
1050
-            : EEM_Registration::instance()->get_all($query_params);
1051
-    }
1052
-
1053
-
1054
-
1055
-    /**
1056
-     * Retrieves the query parameters to be used by the Registration model for getting registrations.
1057
-     * Note: this listens to values on the request for some of the query parameters.
1058
-     *
1059
-     * @param array $request
1060
-     * @param int    $per_page
1061
-     * @param bool   $count
1062
-     * @return array
1063
-     */
1064
-    protected function _get_registration_query_parameters(
1065
-        $request = array(),
1066
-        $per_page = 10,
1067
-        $count = false
1068
-    ) {
1069
-
1070
-        $query_params = array(
1071
-            0                          => $this->_get_where_conditions_for_registrations_query(
1072
-                $request
1073
-            ),
1074
-            'caps'                     => EEM_Registration::caps_read_admin,
1075
-            'default_where_conditions' => 'this_model_only',
1076
-        );
1077
-        if (! $count) {
1078
-            $query_params = array_merge(
1079
-                $query_params,
1080
-                $this->_get_orderby_for_registrations_query(),
1081
-                $this->_get_limit($per_page)
1082
-            );
1083
-        }
1084
-
1085
-        return $query_params;
1086
-    }
1087
-
1088
-
1089
-    /**
1090
-     * This will add EVT_ID to the provided $where array for EE model query parameters.
1091
-     *
1092
-     * @param array $request usually the same as $this->_req_data but not necessarily
1093
-     * @return array
1094
-     */
1095
-    protected function _add_event_id_to_where_conditions(array $request)
1096
-    {
1097
-        $where = array();
1098
-        if (! empty($request['event_id'])) {
1099
-            $where['EVT_ID'] = absint($request['event_id']);
1100
-        }
1101
-        return $where;
1102
-    }
1103
-
1104
-
1105
-    /**
1106
-     * Adds category ID if it exists in the request to the where conditions for the registrations query.
1107
-     *
1108
-     * @param array $request usually the same as $this->_req_data but not necessarily
1109
-     * @return array
1110
-     */
1111
-    protected function _add_category_id_to_where_conditions(array $request)
1112
-    {
1113
-        $where = array();
1114
-        if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
1115
-            $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
1116
-        }
1117
-        return $where;
1118
-    }
1119
-
1120
-
1121
-    /**
1122
-     * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
1123
-     *
1124
-     * @param array $request usually the same as $this->_req_data but not necessarily
1125
-     * @return array
1126
-     */
1127
-    protected function _add_datetime_id_to_where_conditions(array $request)
1128
-    {
1129
-        $where = array();
1130
-        if (! empty($request['datetime_id'])) {
1131
-            $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
1132
-        }
1133
-        if (! empty($request['DTT_ID'])) {
1134
-            $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
1135
-        }
1136
-        return $where;
1137
-    }
1138
-
1139
-
1140
-    /**
1141
-     * Adds the correct registration status to the where conditions for the registrations query.
1142
-     *
1143
-     * @param array $request usually the same as $this->_req_data but not necessarily
1144
-     * @return array
1145
-     */
1146
-    protected function _add_registration_status_to_where_conditions(array $request)
1147
-    {
1148
-        $where = array();
1149
-        $view = EEH_Array::is_set($request, 'status', '');
1150
-        $registration_status = ! empty($request['_reg_status'])
1151
-            ? sanitize_text_field($request['_reg_status'])
1152
-            : '';
1153
-
1154
-        /*
26
+	/**
27
+	 * @var EE_Registration
28
+	 */
29
+	private $_registration;
30
+
31
+	/**
32
+	 * @var EE_Event
33
+	 */
34
+	private $_reg_event;
35
+
36
+	/**
37
+	 * @var EE_Session
38
+	 */
39
+	private $_session;
40
+
41
+	private static $_reg_status;
42
+
43
+	/**
44
+	 * Form for displaying the custom questions for this registration.
45
+	 * This gets used a few times throughout the request so its best to cache it
46
+	 *
47
+	 * @var EE_Registration_Custom_Questions_Form
48
+	 */
49
+	protected $_reg_custom_questions_form = null;
50
+
51
+
52
+	/**
53
+	 *        constructor
54
+	 *
55
+	 * @Constructor
56
+	 * @access public
57
+	 * @param bool $routing
58
+	 * @return Registrations_Admin_Page
59
+	 */
60
+	public function __construct($routing = true)
61
+	{
62
+		parent::__construct($routing);
63
+		add_action('wp_loaded', array($this, 'wp_loaded'));
64
+	}
65
+
66
+
67
+	public function wp_loaded()
68
+	{
69
+		// when adding a new registration...
70
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
71
+			EE_System::do_not_cache();
72
+			if (! isset($this->_req_data['processing_registration'])
73
+				 || absint($this->_req_data['processing_registration']) !== 1
74
+			) {
75
+				// and it's NOT the attendee information reg step
76
+				// force cookie expiration by setting time to last week
77
+				setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
78
+				// and update the global
79
+				$_COOKIE['ee_registration_added'] = 0;
80
+			}
81
+		}
82
+	}
83
+
84
+
85
+	protected function _init_page_props()
86
+	{
87
+		$this->page_slug        = REG_PG_SLUG;
88
+		$this->_admin_base_url  = REG_ADMIN_URL;
89
+		$this->_admin_base_path = REG_ADMIN;
90
+		$this->page_label       = esc_html__('Registrations', 'event_espresso');
91
+		$this->_cpt_routes      = array(
92
+			'add_new_attendee' => 'espresso_attendees',
93
+			'edit_attendee'    => 'espresso_attendees',
94
+			'insert_attendee'  => 'espresso_attendees',
95
+			'update_attendee'  => 'espresso_attendees',
96
+		);
97
+		$this->_cpt_model_names = array(
98
+			'add_new_attendee' => 'EEM_Attendee',
99
+			'edit_attendee'    => 'EEM_Attendee',
100
+		);
101
+		$this->_cpt_edit_routes = array(
102
+			'espresso_attendees' => 'edit_attendee',
103
+		);
104
+		$this->_pagenow_map     = array(
105
+			'add_new_attendee' => 'post-new.php',
106
+			'edit_attendee'    => 'post.php',
107
+			'trash'            => 'post.php',
108
+		);
109
+		add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
110
+		//add filters so that the comment urls don't take users to a confusing 404 page
111
+		add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
112
+	}
113
+
114
+
115
+	public function clear_comment_link($link, $comment, $args)
116
+	{
117
+		//gotta make sure this only happens on this route
118
+		$post_type = get_post_type($comment->comment_post_ID);
119
+		if ($post_type === 'espresso_attendees') {
120
+			return '#commentsdiv';
121
+		}
122
+		return $link;
123
+	}
124
+
125
+
126
+	protected function _ajax_hooks()
127
+	{
128
+		//todo: all hooks for registrations ajax goes in here
129
+		add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
130
+	}
131
+
132
+
133
+	protected function _define_page_props()
134
+	{
135
+		$this->_admin_page_title = $this->page_label;
136
+		$this->_labels           = array(
137
+			'buttons'                      => array(
138
+				'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
139
+				'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
140
+				'edit'                => esc_html__('Edit Contact', 'event_espresso'),
141
+				'report'              => esc_html__("Event Registrations CSV Report", "event_espresso"),
142
+				'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
143
+				'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
144
+				'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
145
+				'contact_list_export' => esc_html__("Export Data", "event_espresso"),
146
+			),
147
+			'publishbox'                   => array(
148
+				'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'),
149
+				'edit_attendee'    => esc_html__("Update Contact Record", 'event_espresso'),
150
+			),
151
+			'hide_add_button_on_cpt_route' => array(
152
+				'edit_attendee' => true,
153
+			),
154
+		);
155
+	}
156
+
157
+
158
+	/**
159
+	 *        grab url requests and route them
160
+	 *
161
+	 * @access private
162
+	 * @return void
163
+	 */
164
+	public function _set_page_routes()
165
+	{
166
+		$this->_get_registration_status_array();
167
+		$reg_id             = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
168
+			? $this->_req_data['_REG_ID'] : 0;
169
+		$att_id             = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
170
+			? $this->_req_data['ATT_ID'] : 0;
171
+		$att_id             = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post'])
172
+			? $this->_req_data['post']
173
+			: $att_id;
174
+		$this->_page_routes = array(
175
+			'default'                            => array(
176
+				'func'       => '_registrations_overview_list_table',
177
+				'capability' => 'ee_read_registrations',
178
+			),
179
+			'view_registration'                  => array(
180
+				'func'       => '_registration_details',
181
+				'capability' => 'ee_read_registration',
182
+				'obj_id'     => $reg_id,
183
+			),
184
+			'edit_registration'                  => array(
185
+				'func'               => '_update_attendee_registration_form',
186
+				'noheader'           => true,
187
+				'headers_sent_route' => 'view_registration',
188
+				'capability'         => 'ee_edit_registration',
189
+				'obj_id'             => $reg_id,
190
+				'_REG_ID'            => $reg_id,
191
+			),
192
+			'trash_registrations'                => array(
193
+				'func'       => '_trash_or_restore_registrations',
194
+				'args'       => array('trash' => true),
195
+				'noheader'   => true,
196
+				'capability' => 'ee_delete_registrations',
197
+			),
198
+			'restore_registrations'              => array(
199
+				'func'       => '_trash_or_restore_registrations',
200
+				'args'       => array('trash' => false),
201
+				'noheader'   => true,
202
+				'capability' => 'ee_delete_registrations',
203
+			),
204
+			'delete_registrations'               => array(
205
+				'func'       => '_delete_registrations',
206
+				'noheader'   => true,
207
+				'capability' => 'ee_delete_registrations',
208
+			),
209
+			'new_registration'                   => array(
210
+				'func'       => 'new_registration',
211
+				'capability' => 'ee_edit_registrations',
212
+			),
213
+			'process_reg_step'                   => array(
214
+				'func'       => 'process_reg_step',
215
+				'noheader'   => true,
216
+				'capability' => 'ee_edit_registrations',
217
+			),
218
+			'redirect_to_txn'                    => array(
219
+				'func'       => 'redirect_to_txn',
220
+				'noheader'   => true,
221
+				'capability' => 'ee_edit_registrations',
222
+			),
223
+			'change_reg_status'                  => array(
224
+				'func'       => '_change_reg_status',
225
+				'noheader'   => true,
226
+				'capability' => 'ee_edit_registration',
227
+				'obj_id'     => $reg_id,
228
+			),
229
+			'approve_registration'               => array(
230
+				'func'       => 'approve_registration',
231
+				'noheader'   => true,
232
+				'capability' => 'ee_edit_registration',
233
+				'obj_id'     => $reg_id,
234
+			),
235
+			'approve_and_notify_registration'    => array(
236
+				'func'       => 'approve_registration',
237
+				'noheader'   => true,
238
+				'args'       => array(true),
239
+				'capability' => 'ee_edit_registration',
240
+				'obj_id'     => $reg_id,
241
+			),
242
+			'decline_registration'               => array(
243
+				'func'       => 'decline_registration',
244
+				'noheader'   => true,
245
+				'capability' => 'ee_edit_registration',
246
+				'obj_id'     => $reg_id,
247
+			),
248
+			'decline_and_notify_registration'    => array(
249
+				'func'       => 'decline_registration',
250
+				'noheader'   => true,
251
+				'args'       => array(true),
252
+				'capability' => 'ee_edit_registration',
253
+				'obj_id'     => $reg_id,
254
+			),
255
+			'pending_registration'               => array(
256
+				'func'       => 'pending_registration',
257
+				'noheader'   => true,
258
+				'capability' => 'ee_edit_registration',
259
+				'obj_id'     => $reg_id,
260
+			),
261
+			'pending_and_notify_registration'    => array(
262
+				'func'       => 'pending_registration',
263
+				'noheader'   => true,
264
+				'args'       => array(true),
265
+				'capability' => 'ee_edit_registration',
266
+				'obj_id'     => $reg_id,
267
+			),
268
+			'no_approve_registration'            => array(
269
+				'func'       => 'not_approve_registration',
270
+				'noheader'   => true,
271
+				'capability' => 'ee_edit_registration',
272
+				'obj_id'     => $reg_id,
273
+			),
274
+			'no_approve_and_notify_registration' => array(
275
+				'func'       => 'not_approve_registration',
276
+				'noheader'   => true,
277
+				'args'       => array(true),
278
+				'capability' => 'ee_edit_registration',
279
+				'obj_id'     => $reg_id,
280
+			),
281
+			'cancel_registration'                => array(
282
+				'func'       => 'cancel_registration',
283
+				'noheader'   => true,
284
+				'capability' => 'ee_edit_registration',
285
+				'obj_id'     => $reg_id,
286
+			),
287
+			'cancel_and_notify_registration'     => array(
288
+				'func'       => 'cancel_registration',
289
+				'noheader'   => true,
290
+				'args'       => array(true),
291
+				'capability' => 'ee_edit_registration',
292
+				'obj_id'     => $reg_id,
293
+			),
294
+			'contact_list'                       => array(
295
+				'func'       => '_attendee_contact_list_table',
296
+				'capability' => 'ee_read_contacts',
297
+			),
298
+			'add_new_attendee'                   => array(
299
+				'func' => '_create_new_cpt_item',
300
+				'args' => array(
301
+					'new_attendee' => true,
302
+					'capability'   => 'ee_edit_contacts',
303
+				),
304
+			),
305
+			'edit_attendee'                      => array(
306
+				'func'       => '_edit_cpt_item',
307
+				'capability' => 'ee_edit_contacts',
308
+				'obj_id'     => $att_id,
309
+			),
310
+			'duplicate_attendee'                 => array(
311
+				'func'       => '_duplicate_attendee',
312
+				'noheader'   => true,
313
+				'capability' => 'ee_edit_contacts',
314
+				'obj_id'     => $att_id,
315
+			),
316
+			'insert_attendee'                    => array(
317
+				'func'       => '_insert_or_update_attendee',
318
+				'args'       => array(
319
+					'new_attendee' => true,
320
+				),
321
+				'noheader'   => true,
322
+				'capability' => 'ee_edit_contacts',
323
+			),
324
+			'update_attendee'                    => array(
325
+				'func'       => '_insert_or_update_attendee',
326
+				'args'       => array(
327
+					'new_attendee' => false,
328
+				),
329
+				'noheader'   => true,
330
+				'capability' => 'ee_edit_contacts',
331
+				'obj_id'     => $att_id,
332
+			),
333
+			'trash_attendee'                    => array(
334
+				'func'       => '_trash_or_restore_attendees',
335
+				'args'       => array(
336
+					'trash' => true,
337
+				),
338
+				'noheader'   => true,
339
+				'capability' => 'ee_delete_contacts',
340
+				'obj_id'     => $att_id,
341
+			),
342
+			'restore_attendees'                  => array(
343
+				'func'       => '_trash_or_restore_attendees',
344
+				'args'       => array(
345
+					'trash' => false,
346
+				),
347
+				'noheader'   => true,
348
+				'capability' => 'ee_delete_contacts',
349
+				'obj_id'     => $att_id,
350
+			),
351
+			'resend_registration'                => array(
352
+				'func'       => '_resend_registration',
353
+				'noheader'   => true,
354
+				'capability' => 'ee_send_message',
355
+			),
356
+			'registrations_report'               => array(
357
+				'func'       => '_registrations_report',
358
+				'noheader'   => true,
359
+				'capability' => 'ee_read_registrations',
360
+			),
361
+			'contact_list_export'                => array(
362
+				'func'       => '_contact_list_export',
363
+				'noheader'   => true,
364
+				'capability' => 'export',
365
+			),
366
+			'contact_list_report'                => array(
367
+				'func'       => '_contact_list_report',
368
+				'noheader'   => true,
369
+				'capability' => 'ee_read_contacts',
370
+			),
371
+		);
372
+	}
373
+
374
+
375
+	protected function _set_page_config()
376
+	{
377
+		$this->_page_config = array(
378
+			'default'           => array(
379
+				'nav'           => array(
380
+					'label' => esc_html__('Overview', 'event_espresso'),
381
+					'order' => 5,
382
+				),
383
+				'help_tabs'     => array(
384
+					'registrations_overview_help_tab'                       => array(
385
+						'title'    => esc_html__('Registrations Overview', 'event_espresso'),
386
+						'filename' => 'registrations_overview',
387
+					),
388
+					'registrations_overview_table_column_headings_help_tab' => array(
389
+						'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
390
+						'filename' => 'registrations_overview_table_column_headings',
391
+					),
392
+					'registrations_overview_filters_help_tab'               => array(
393
+						'title'    => esc_html__('Registration Filters', 'event_espresso'),
394
+						'filename' => 'registrations_overview_filters',
395
+					),
396
+					'registrations_overview_views_help_tab'                 => array(
397
+						'title'    => esc_html__('Registration Views', 'event_espresso'),
398
+						'filename' => 'registrations_overview_views',
399
+					),
400
+					'registrations_regoverview_other_help_tab'              => array(
401
+						'title'    => esc_html__('Registrations Other', 'event_espresso'),
402
+						'filename' => 'registrations_overview_other',
403
+					),
404
+				),
405
+				'help_tour'     => array('Registration_Overview_Help_Tour'),
406
+				'qtips'         => array('Registration_List_Table_Tips'),
407
+				'list_table'    => 'EE_Registrations_List_Table',
408
+				'require_nonce' => false,
409
+			),
410
+			'view_registration' => array(
411
+				'nav'           => array(
412
+					'label'      => esc_html__('REG Details', 'event_espresso'),
413
+					'order'      => 15,
414
+					'url'        => isset($this->_req_data['_REG_ID'])
415
+						? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
416
+						: $this->_admin_base_url,
417
+					'persistent' => false,
418
+				),
419
+				'help_tabs'     => array(
420
+					'registrations_details_help_tab'                    => array(
421
+						'title'    => esc_html__('Registration Details', 'event_espresso'),
422
+						'filename' => 'registrations_details',
423
+					),
424
+					'registrations_details_table_help_tab'              => array(
425
+						'title'    => esc_html__('Registration Details Table', 'event_espresso'),
426
+						'filename' => 'registrations_details_table',
427
+					),
428
+					'registrations_details_form_answers_help_tab'       => array(
429
+						'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
430
+						'filename' => 'registrations_details_form_answers',
431
+					),
432
+					'registrations_details_registrant_details_help_tab' => array(
433
+						'title'    => esc_html__('Contact Details', 'event_espresso'),
434
+						'filename' => 'registrations_details_registrant_details',
435
+					),
436
+				),
437
+				'help_tour'     => array('Registration_Details_Help_Tour'),
438
+				'metaboxes'     => array_merge(
439
+					$this->_default_espresso_metaboxes,
440
+					array('_registration_details_metaboxes')
441
+				),
442
+				'require_nonce' => false,
443
+			),
444
+			'new_registration'  => array(
445
+				'nav'           => array(
446
+					'label'      => esc_html__('Add New Registration', 'event_espresso'),
447
+					'url'        => '#',
448
+					'order'      => 15,
449
+					'persistent' => false,
450
+				),
451
+				'metaboxes'     => $this->_default_espresso_metaboxes,
452
+				'labels'        => array(
453
+					'publishbox' => esc_html__('Save Registration', 'event_espresso'),
454
+				),
455
+				'require_nonce' => false,
456
+			),
457
+			'add_new_attendee'  => array(
458
+				'nav'           => array(
459
+					'label'      => esc_html__('Add Contact', 'event_espresso'),
460
+					'order'      => 15,
461
+					'persistent' => false,
462
+				),
463
+				'metaboxes'     => array_merge(
464
+					$this->_default_espresso_metaboxes,
465
+					array('_publish_post_box', 'attendee_editor_metaboxes')
466
+				),
467
+				'require_nonce' => false,
468
+			),
469
+			'edit_attendee'     => array(
470
+				'nav'           => array(
471
+					'label'      => esc_html__('Edit Contact', 'event_espresso'),
472
+					'order'      => 15,
473
+					'persistent' => false,
474
+					'url'        => isset($this->_req_data['ATT_ID'])
475
+						? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
476
+						: $this->_admin_base_url,
477
+				),
478
+				'metaboxes'     => array('attendee_editor_metaboxes'),
479
+				'require_nonce' => false,
480
+			),
481
+			'contact_list'      => array(
482
+				'nav'           => array(
483
+					'label' => esc_html__('Contact List', 'event_espresso'),
484
+					'order' => 20,
485
+				),
486
+				'list_table'    => 'EE_Attendee_Contact_List_Table',
487
+				'help_tabs'     => array(
488
+					'registrations_contact_list_help_tab'                       => array(
489
+						'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
490
+						'filename' => 'registrations_contact_list',
491
+					),
492
+					'registrations_contact-list_table_column_headings_help_tab' => array(
493
+						'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
494
+						'filename' => 'registrations_contact_list_table_column_headings',
495
+					),
496
+					'registrations_contact_list_views_help_tab'                 => array(
497
+						'title'    => esc_html__('Contact List Views', 'event_espresso'),
498
+						'filename' => 'registrations_contact_list_views',
499
+					),
500
+					'registrations_contact_list_other_help_tab'                 => array(
501
+						'title'    => esc_html__('Contact List Other', 'event_espresso'),
502
+						'filename' => 'registrations_contact_list_other',
503
+					),
504
+				),
505
+				'help_tour'     => array('Contact_List_Help_Tour'),
506
+				'metaboxes'     => array(),
507
+				'require_nonce' => false,
508
+			),
509
+			//override default cpt routes
510
+			'create_new'        => '',
511
+			'edit'              => '',
512
+		);
513
+	}
514
+
515
+
516
+	/**
517
+	 * The below methods aren't used by this class currently
518
+	 */
519
+	protected function _add_screen_options()
520
+	{
521
+	}
522
+
523
+
524
+	protected function _add_feature_pointers()
525
+	{
526
+	}
527
+
528
+
529
+	public function admin_init()
530
+	{
531
+		EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
532
+			'click "Update Registration Questions" to save your changes',
533
+			'event_espresso'
534
+		);
535
+	}
536
+
537
+
538
+	public function admin_notices()
539
+	{
540
+	}
541
+
542
+
543
+	public function admin_footer_scripts()
544
+	{
545
+	}
546
+
547
+
548
+	/**
549
+	 *        get list of registration statuses
550
+	 *
551
+	 * @access private
552
+	 * @return void
553
+	 */
554
+	private function _get_registration_status_array()
555
+	{
556
+		self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
557
+	}
558
+
559
+
560
+	protected function _add_screen_options_default()
561
+	{
562
+		$this->_per_page_screen_option();
563
+	}
564
+
565
+
566
+	protected function _add_screen_options_contact_list()
567
+	{
568
+		$page_title              = $this->_admin_page_title;
569
+		$this->_admin_page_title = esc_html__("Contacts", 'event_espresso');
570
+		$this->_per_page_screen_option();
571
+		$this->_admin_page_title = $page_title;
572
+	}
573
+
574
+
575
+	public function load_scripts_styles()
576
+	{
577
+		//style
578
+		wp_register_style(
579
+			'espresso_reg',
580
+			REG_ASSETS_URL . 'espresso_registrations_admin.css',
581
+			array('ee-admin-css'),
582
+			EVENT_ESPRESSO_VERSION
583
+		);
584
+		wp_enqueue_style('espresso_reg');
585
+		//script
586
+		wp_register_script(
587
+			'espresso_reg',
588
+			REG_ASSETS_URL . 'espresso_registrations_admin.js',
589
+			array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
590
+			EVENT_ESPRESSO_VERSION,
591
+			true
592
+		);
593
+		wp_enqueue_script('espresso_reg');
594
+	}
595
+
596
+
597
+	public function load_scripts_styles_edit_attendee()
598
+	{
599
+		//stuff to only show up on our attendee edit details page.
600
+		$attendee_details_translations = array(
601
+			'att_publish_text' => sprintf(
602
+				esc_html__('Created on: <b>%1$s</b>', 'event_espresso'),
603
+				$this->_cpt_model_obj->get_datetime('ATT_created')
604
+			),
605
+		);
606
+		wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
607
+		wp_enqueue_script('jquery-validate');
608
+	}
609
+
610
+
611
+	public function load_scripts_styles_view_registration()
612
+	{
613
+		//styles
614
+		wp_enqueue_style('espresso-ui-theme');
615
+		//scripts
616
+		$this->_get_reg_custom_questions_form($this->_registration->ID());
617
+		$this->_reg_custom_questions_form->wp_enqueue_scripts(true);
618
+	}
619
+
620
+
621
+	public function load_scripts_styles_contact_list()
622
+	{
623
+		wp_deregister_style('espresso_reg');
624
+		wp_register_style(
625
+			'espresso_att',
626
+			REG_ASSETS_URL . 'espresso_attendees_admin.css',
627
+			array('ee-admin-css'),
628
+			EVENT_ESPRESSO_VERSION
629
+		);
630
+		wp_enqueue_style('espresso_att');
631
+	}
632
+
633
+
634
+	public function load_scripts_styles_new_registration()
635
+	{
636
+		wp_register_script(
637
+			'ee-spco-for-admin',
638
+			REG_ASSETS_URL . 'spco_for_admin.js',
639
+			array('underscore', 'jquery'),
640
+			EVENT_ESPRESSO_VERSION,
641
+			true
642
+		);
643
+		wp_enqueue_script('ee-spco-for-admin');
644
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
645
+		EE_Form_Section_Proper::wp_enqueue_scripts();
646
+		EED_Ticket_Selector::load_tckt_slctr_assets();
647
+		EE_Datepicker_Input::enqueue_styles_and_scripts();
648
+	}
649
+
650
+
651
+	public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
652
+	{
653
+		add_filter('FHEE_load_EE_messages', '__return_true');
654
+	}
655
+
656
+
657
+	public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
658
+	{
659
+		add_filter('FHEE_load_EE_messages', '__return_true');
660
+	}
661
+
662
+
663
+	protected function _set_list_table_views_default()
664
+	{
665
+		//for notification related bulk actions we need to make sure only active messengers have an option.
666
+		EED_Messages::set_autoloaders();
667
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
668
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
669
+		$active_mts               = $message_resource_manager->list_of_active_message_types();
670
+		//key= bulk_action_slug, value= message type.
671
+		$match_array = array(
672
+			'approve_registration'    => 'registration',
673
+			'decline_registration'    => 'declined_registration',
674
+			'pending_registration'    => 'pending_approval',
675
+			'no_approve_registration' => 'not_approved_registration',
676
+			'cancel_registration'     => 'cancelled_registration',
677
+		);
678
+		/** setup reg status bulk actions **/
679
+		$def_reg_status_actions['approve_registration'] = esc_html__('Approve Registrations', 'event_espresso');
680
+		if (in_array($match_array['approve_registration'], $active_mts)
681
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
682
+		) {
683
+			$def_reg_status_actions['approve_and_notify_registration'] = esc_html__(
684
+				'Approve and Notify Registrations',
685
+				'event_espresso'
686
+			);
687
+		}
688
+		$def_reg_status_actions['decline_registration'] = esc_html__('Decline Registrations', 'event_espresso');
689
+		if (in_array($match_array['decline_registration'], $active_mts)
690
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
691
+		) {
692
+			$def_reg_status_actions['decline_and_notify_registration'] = esc_html__(
693
+				'Decline and Notify Registrations',
694
+				'event_espresso'
695
+			);
696
+		}
697
+		$def_reg_status_actions['pending_registration'] = esc_html__(
698
+			'Set Registrations to Pending Payment',
699
+			'event_espresso'
700
+		);
701
+		if (in_array($match_array['pending_registration'], $active_mts)
702
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
703
+		) {
704
+			$def_reg_status_actions['pending_and_notify_registration'] = esc_html__(
705
+				'Set Registrations to Pending Payment and Notify',
706
+				'event_espresso'
707
+			);
708
+		}
709
+		$def_reg_status_actions['no_approve_registration'] = esc_html__(
710
+			'Set Registrations to Not Approved',
711
+			'event_espresso'
712
+		);
713
+		if (in_array($match_array['no_approve_registration'], $active_mts)
714
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
715
+		) {
716
+			$def_reg_status_actions['no_approve_and_notify_registration'] = esc_html__(
717
+				'Set Registrations to Not Approved and Notify',
718
+				'event_espresso'
719
+			);
720
+		}
721
+		$def_reg_status_actions['cancel_registration'] = esc_html__('Cancel Registrations', 'event_espresso');
722
+		if (in_array($match_array['cancel_registration'], $active_mts)
723
+			&& EE_Registry::instance()->CAP->current_user_can('ee_send_message', 'batch_send_messages')
724
+		) {
725
+			$def_reg_status_actions['cancel_and_notify_registration'] = esc_html__(
726
+				'Cancel Registrations and Notify',
727
+				'event_espresso'
728
+			);
729
+		}
730
+		$this->_views = array(
731
+			'all'   => array(
732
+				'slug'        => 'all',
733
+				'label'       => esc_html__('View All Registrations', 'event_espresso'),
734
+				'count'       => 0,
735
+				'bulk_action' => array_merge($def_reg_status_actions, array(
736
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
737
+				)),
738
+			),
739
+			'month' => array(
740
+				'slug'        => 'month',
741
+				'label'       => esc_html__('This Month', 'event_espresso'),
742
+				'count'       => 0,
743
+				'bulk_action' => array_merge($def_reg_status_actions, array(
744
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
745
+				)),
746
+			),
747
+			'today' => array(
748
+				'slug'        => 'today',
749
+				'label'       => sprintf(
750
+					esc_html__('Today - %s', 'event_espresso'),
751
+					date('M d, Y', current_time('timestamp'))
752
+				),
753
+				'count'       => 0,
754
+				'bulk_action' => array_merge($def_reg_status_actions, array(
755
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
756
+				)),
757
+			),
758
+		);
759
+		if (EE_Registry::instance()->CAP->current_user_can(
760
+			'ee_delete_registrations',
761
+			'espresso_registrations_delete_registration'
762
+		)) {
763
+			$this->_views['incomplete'] = array(
764
+				'slug'        => 'incomplete',
765
+				'label'       => esc_html__('Incomplete', 'event_espresso'),
766
+				'count'       => 0,
767
+				'bulk_action' => array(
768
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
769
+				),
770
+			);
771
+			$this->_views['trash']      = array(
772
+				'slug'        => 'trash',
773
+				'label'       => esc_html__('Trash', 'event_espresso'),
774
+				'count'       => 0,
775
+				'bulk_action' => array(
776
+					'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
777
+					'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
778
+				),
779
+			);
780
+		}
781
+	}
782
+
783
+
784
+	protected function _set_list_table_views_contact_list()
785
+	{
786
+		$this->_views = array(
787
+			'in_use' => array(
788
+				'slug'        => 'in_use',
789
+				'label'       => esc_html__('In Use', 'event_espresso'),
790
+				'count'       => 0,
791
+				'bulk_action' => array(
792
+					'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
793
+				),
794
+			),
795
+		);
796
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts',
797
+			'espresso_registrations_trash_attendees')
798
+		) {
799
+			$this->_views['trash'] = array(
800
+				'slug'        => 'trash',
801
+				'label'       => esc_html__('Trash', 'event_espresso'),
802
+				'count'       => 0,
803
+				'bulk_action' => array(
804
+					'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
805
+				),
806
+			);
807
+		}
808
+	}
809
+
810
+
811
+	protected function _registration_legend_items()
812
+	{
813
+		$fc_items = array(
814
+			'star-icon'        => array(
815
+				'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
816
+				'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
817
+			),
818
+			'view_details'     => array(
819
+				'class' => 'dashicons dashicons-clipboard',
820
+				'desc'  => esc_html__('View Registration Details', 'event_espresso'),
821
+			),
822
+			'edit_attendee'    => array(
823
+				'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
824
+				'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
825
+			),
826
+			'view_transaction' => array(
827
+				'class' => 'dashicons dashicons-cart',
828
+				'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
829
+			),
830
+			'view_invoice'     => array(
831
+				'class' => 'dashicons dashicons-media-spreadsheet',
832
+				'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
833
+			),
834
+		);
835
+		if (EE_Registry::instance()->CAP->current_user_can(
836
+			'ee_send_message',
837
+			'espresso_registrations_resend_registration'
838
+		)) {
839
+			$fc_items['resend_registration'] = array(
840
+				'class' => 'dashicons dashicons-email-alt',
841
+				'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
842
+			);
843
+		} else {
844
+			$fc_items['blank'] = array('class' => 'blank', 'desc' => '');
845
+		}
846
+		if (EE_Registry::instance()->CAP->current_user_can(
847
+			'ee_read_global_messages',
848
+			'view_filtered_messages'
849
+		)) {
850
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
851
+			if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
852
+				$fc_items['view_related_messages'] = array(
853
+					'class' => $related_for_icon['css_class'],
854
+					'desc'  => $related_for_icon['label'],
855
+				);
856
+			}
857
+		}
858
+		$sc_items = array(
859
+			'approved_status'   => array(
860
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
861
+				'desc'  => EEH_Template::pretty_status(
862
+					EEM_Registration::status_id_approved,
863
+					false,
864
+					'sentence'
865
+				),
866
+			),
867
+			'pending_status'    => array(
868
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
869
+				'desc'  => EEH_Template::pretty_status(
870
+					EEM_Registration::status_id_pending_payment,
871
+					false,
872
+					'sentence'
873
+				),
874
+			),
875
+			'wait_list'         => array(
876
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
877
+				'desc'  => EEH_Template::pretty_status(
878
+					EEM_Registration::status_id_wait_list,
879
+					false,
880
+					'sentence'
881
+				),
882
+			),
883
+			'incomplete_status' => array(
884
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
885
+				'desc'  => EEH_Template::pretty_status(
886
+					EEM_Registration::status_id_incomplete,
887
+					false,
888
+					'sentence'
889
+				),
890
+			),
891
+			'not_approved'      => array(
892
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
893
+				'desc'  => EEH_Template::pretty_status(
894
+					EEM_Registration::status_id_not_approved,
895
+					false,
896
+					'sentence'
897
+				),
898
+			),
899
+			'declined_status'   => array(
900
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
901
+				'desc'  => EEH_Template::pretty_status(
902
+					EEM_Registration::status_id_declined,
903
+					false,
904
+					'sentence'
905
+				),
906
+			),
907
+			'cancelled_status'  => array(
908
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
909
+				'desc'  => EEH_Template::pretty_status(
910
+					EEM_Registration::status_id_cancelled,
911
+					false,
912
+					'sentence'
913
+				),
914
+			),
915
+		);
916
+		return array_merge($fc_items, $sc_items);
917
+	}
918
+
919
+
920
+
921
+	/***************************************        REGISTRATION OVERVIEW        **************************************/
922
+	/**
923
+	 * @throws \EE_Error
924
+	 */
925
+	protected function _registrations_overview_list_table()
926
+	{
927
+		$this->_template_args['admin_page_header'] = '';
928
+		$EVT_ID                                    = ! empty($this->_req_data['event_id'])
929
+			? absint($this->_req_data['event_id'])
930
+			: 0;
931
+		if ($EVT_ID) {
932
+			if (EE_Registry::instance()->CAP->current_user_can(
933
+				'ee_edit_registrations',
934
+				'espresso_registrations_new_registration',
935
+				$EVT_ID
936
+			)) {
937
+				$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
938
+					'new_registration',
939
+					'add-registrant',
940
+					array('event_id' => $EVT_ID),
941
+					'add-new-h2'
942
+				);
943
+			}
944
+			$event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
945
+			if ($event instanceof EE_Event) {
946
+				$this->_template_args['admin_page_header'] = sprintf(
947
+					esc_html__(
948
+						'%s Viewing registrations for the event: %s%s',
949
+						'event_espresso'
950
+					),
951
+					'<h3 style="line-height:1.5em;">',
952
+					'<br /><a href="'
953
+						. EE_Admin_Page::add_query_args_and_nonce(
954
+							array(
955
+								'action' => 'edit',
956
+								'post'   => $event->ID(),
957
+							),
958
+							EVENTS_ADMIN_URL
959
+						)
960
+						. '">&nbsp;'
961
+						. $event->get('EVT_name')
962
+						. '&nbsp;</a>&nbsp;',
963
+					'</h3>'
964
+				);
965
+			}
966
+			$DTT_ID   = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
967
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
968
+			if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
969
+				$this->_template_args['admin_page_header'] = substr(
970
+					$this->_template_args['admin_page_header'],
971
+					0,
972
+					-5
973
+				);
974
+				$this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
975
+				$this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
976
+				$this->_template_args['admin_page_header'] .= $datetime->name();
977
+				$this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
978
+				$this->_template_args['admin_page_header'] .= '</span></h3>';
979
+			}
980
+		}
981
+		$this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
982
+		$this->display_admin_list_table_page_with_no_sidebar();
983
+	}
984
+
985
+
986
+	/**
987
+	 * This sets the _registration property for the registration details screen
988
+	 *
989
+	 * @access private
990
+	 * @return bool
991
+	 */
992
+	private function _set_registration_object()
993
+	{
994
+		//get out if we've already set the object
995
+		if (is_object($this->_registration)) {
996
+			return true;
997
+		}
998
+		$REG    = EEM_Registration::instance();
999
+		$REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
1000
+		if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
1001
+			return true;
1002
+		} else {
1003
+			$error_msg = sprintf(
1004
+				esc_html__(
1005
+					'An error occurred and the details for Registration ID #%s could not be retrieved.',
1006
+					'event_espresso'
1007
+				),
1008
+				$REG_ID
1009
+			);
1010
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
1011
+			$this->_registration = null;
1012
+			return false;
1013
+		}
1014
+	}
1015
+
1016
+
1017
+	/**
1018
+	 * Used to retrieve registrations for the list table.
1019
+	 *
1020
+	 * @param int  $per_page
1021
+	 * @param bool $count
1022
+	 * @param bool $this_month
1023
+	 * @param bool $today
1024
+	 * @return EE_Registration[]|int
1025
+	 * @throws EE_Error
1026
+	 */
1027
+	public function get_registrations(
1028
+		$per_page = 10,
1029
+		$count = false,
1030
+		$this_month = false,
1031
+		$today = false
1032
+	) {
1033
+		if ($this_month) {
1034
+			$this->_req_data['status'] = 'month';
1035
+		}
1036
+		if ($today) {
1037
+			$this->_req_data['status'] = 'today';
1038
+		}
1039
+		$query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count);
1040
+		/**
1041
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
1042
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
1043
+		 * @see EEM_Base::get_all()
1044
+		 */
1045
+		$query_params['group_by'] = '';
1046
+
1047
+		return $count
1048
+			? EEM_Registration::instance()->count($query_params)
1049
+			/** @type EE_Registration[] */
1050
+			: EEM_Registration::instance()->get_all($query_params);
1051
+	}
1052
+
1053
+
1054
+
1055
+	/**
1056
+	 * Retrieves the query parameters to be used by the Registration model for getting registrations.
1057
+	 * Note: this listens to values on the request for some of the query parameters.
1058
+	 *
1059
+	 * @param array $request
1060
+	 * @param int    $per_page
1061
+	 * @param bool   $count
1062
+	 * @return array
1063
+	 */
1064
+	protected function _get_registration_query_parameters(
1065
+		$request = array(),
1066
+		$per_page = 10,
1067
+		$count = false
1068
+	) {
1069
+
1070
+		$query_params = array(
1071
+			0                          => $this->_get_where_conditions_for_registrations_query(
1072
+				$request
1073
+			),
1074
+			'caps'                     => EEM_Registration::caps_read_admin,
1075
+			'default_where_conditions' => 'this_model_only',
1076
+		);
1077
+		if (! $count) {
1078
+			$query_params = array_merge(
1079
+				$query_params,
1080
+				$this->_get_orderby_for_registrations_query(),
1081
+				$this->_get_limit($per_page)
1082
+			);
1083
+		}
1084
+
1085
+		return $query_params;
1086
+	}
1087
+
1088
+
1089
+	/**
1090
+	 * This will add EVT_ID to the provided $where array for EE model query parameters.
1091
+	 *
1092
+	 * @param array $request usually the same as $this->_req_data but not necessarily
1093
+	 * @return array
1094
+	 */
1095
+	protected function _add_event_id_to_where_conditions(array $request)
1096
+	{
1097
+		$where = array();
1098
+		if (! empty($request['event_id'])) {
1099
+			$where['EVT_ID'] = absint($request['event_id']);
1100
+		}
1101
+		return $where;
1102
+	}
1103
+
1104
+
1105
+	/**
1106
+	 * Adds category ID if it exists in the request to the where conditions for the registrations query.
1107
+	 *
1108
+	 * @param array $request usually the same as $this->_req_data but not necessarily
1109
+	 * @return array
1110
+	 */
1111
+	protected function _add_category_id_to_where_conditions(array $request)
1112
+	{
1113
+		$where = array();
1114
+		if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
1115
+			$where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
1116
+		}
1117
+		return $where;
1118
+	}
1119
+
1120
+
1121
+	/**
1122
+	 * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
1123
+	 *
1124
+	 * @param array $request usually the same as $this->_req_data but not necessarily
1125
+	 * @return array
1126
+	 */
1127
+	protected function _add_datetime_id_to_where_conditions(array $request)
1128
+	{
1129
+		$where = array();
1130
+		if (! empty($request['datetime_id'])) {
1131
+			$where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
1132
+		}
1133
+		if (! empty($request['DTT_ID'])) {
1134
+			$where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
1135
+		}
1136
+		return $where;
1137
+	}
1138
+
1139
+
1140
+	/**
1141
+	 * Adds the correct registration status to the where conditions for the registrations query.
1142
+	 *
1143
+	 * @param array $request usually the same as $this->_req_data but not necessarily
1144
+	 * @return array
1145
+	 */
1146
+	protected function _add_registration_status_to_where_conditions(array $request)
1147
+	{
1148
+		$where = array();
1149
+		$view = EEH_Array::is_set($request, 'status', '');
1150
+		$registration_status = ! empty($request['_reg_status'])
1151
+			? sanitize_text_field($request['_reg_status'])
1152
+			: '';
1153
+
1154
+		/*
1155 1155
          * If filtering by registration status, then we show registrations matching that status.
1156 1156
          * If not filtering by specified status, then we show all registrations excluding incomplete registrations
1157 1157
          * UNLESS viewing trashed registrations.
1158 1158
          */
1159
-        if (! empty($registration_status)) {
1160
-            $where['STS_ID'] = $registration_status;
1161
-        } else {
1162
-            //make sure we exclude incomplete registrations, but only if not trashed.
1163
-            if ($view === 'trash') {
1164
-                $where['REG_deleted'] = true;
1165
-            } elseif ($view === 'incomplete') {
1166
-                $where['STS_ID'] = EEM_Registration::status_id_incomplete;
1167
-            } else {
1168
-                $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
1169
-            }
1170
-        }
1171
-        return $where;
1172
-    }
1173
-
1174
-
1175
-    /**
1176
-     * Adds any provided date restraints to the where conditions for the registrations query.
1177
-     *
1178
-     * @param array $request usually the same as $this->_req_data but not necessarily
1179
-     * @return array
1180
-     * @throws EE_Error
1181
-     */
1182
-    protected function _add_date_to_where_conditions(array $request)
1183
-    {
1184
-        $where = array();
1185
-        $view = EEH_Array::is_set($request, 'status', '');
1186
-        $month_range             = ! empty($request['month_range'])
1187
-            ? sanitize_text_field($request['month_range'])
1188
-            : '';
1189
-        $retrieve_for_today      = $view === 'today';
1190
-        $retrieve_for_this_month = $view === 'month';
1191
-
1192
-        if ($retrieve_for_today) {
1193
-            $now               = date('Y-m-d', current_time('timestamp'));
1194
-            $where['REG_date'] = array(
1195
-                'BETWEEN',
1196
-                array(
1197
-                    EEM_Registration::instance()->convert_datetime_for_query(
1198
-                        'REG_date',
1199
-                        $now . ' 00:00:00',
1200
-                        'Y-m-d H:i:s'
1201
-                    ),
1202
-                    EEM_Registration::instance()->convert_datetime_for_query(
1203
-                        'REG_date',
1204
-                        $now . ' 23:59:59',
1205
-                        'Y-m-d H:i:s'
1206
-                    ),
1207
-                ),
1208
-            );
1209
-        } elseif ($retrieve_for_this_month) {
1210
-            $current_year_and_month = date('Y-m', current_time('timestamp'));
1211
-            $days_this_month        = date('t', current_time('timestamp'));
1212
-            $where['REG_date']      = array(
1213
-                'BETWEEN',
1214
-                array(
1215
-                    EEM_Registration::instance()->convert_datetime_for_query(
1216
-                        'REG_date',
1217
-                        $current_year_and_month . '-01 00:00:00',
1218
-                        'Y-m-d H:i:s'
1219
-                    ),
1220
-                    EEM_Registration::instance()->convert_datetime_for_query(
1221
-                        'REG_date',
1222
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
1223
-                        'Y-m-d H:i:s'
1224
-                    ),
1225
-                ),
1226
-            );
1227
-        } elseif ($month_range) {
1228
-            $pieces          = explode(' ', $month_range, 3);
1229
-            $month_requested = ! empty($pieces[0])
1230
-                ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
1231
-                : '';
1232
-            $year_requested  = ! empty($pieces[1])
1233
-                ? $pieces[1]
1234
-                : '';
1235
-            //if there is not a month or year then we can't go further
1236
-            if ($month_requested && $year_requested) {
1237
-                $days_in_month     = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
1238
-                $where['REG_date'] = array(
1239
-                    'BETWEEN',
1240
-                    array(
1241
-                        EEM_Registration::instance()->convert_datetime_for_query(
1242
-                            'REG_date',
1243
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
1244
-                            'Y-m-d H:i:s'
1245
-                        ),
1246
-                        EEM_Registration::instance()->convert_datetime_for_query(
1247
-                            'REG_date',
1248
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
1249
-                            'Y-m-d H:i:s'
1250
-                        ),
1251
-                    ),
1252
-                );
1253
-            }
1254
-        }
1255
-        return $where;
1256
-    }
1257
-
1258
-
1259
-    /**
1260
-     * Adds any provided search restraints to the where conditions for the registrations query
1261
-     *
1262
-     * @param array $request usually the same as $this->_req_data but not necessarily
1263
-     * @return array
1264
-     */
1265
-    protected function _add_search_to_where_conditions(array $request)
1266
-    {
1267
-        $where = array();
1268
-        if (! empty($request['s'])) {
1269
-            $search_string = '%' . sanitize_text_field($request['s']) . '%';
1270
-            $where['OR*search_conditions'] = array(
1271
-                'Event.EVT_name'                          => array('LIKE', $search_string),
1272
-                'Event.EVT_desc'                          => array('LIKE', $search_string),
1273
-                'Event.EVT_short_desc'                    => array('LIKE', $search_string),
1274
-                'Attendee.ATT_full_name'                  => array('LIKE', $search_string),
1275
-                'Attendee.ATT_fname'                      => array('LIKE', $search_string),
1276
-                'Attendee.ATT_lname'                      => array('LIKE', $search_string),
1277
-                'Attendee.ATT_short_bio'                  => array('LIKE', $search_string),
1278
-                'Attendee.ATT_email'                      => array('LIKE', $search_string),
1279
-                'Attendee.ATT_address'                    => array('LIKE', $search_string),
1280
-                'Attendee.ATT_address2'                   => array('LIKE', $search_string),
1281
-                'Attendee.ATT_city'                       => array('LIKE', $search_string),
1282
-                'REG_final_price'                         => array('LIKE', $search_string),
1283
-                'REG_code'                                => array('LIKE', $search_string),
1284
-                'REG_count'                               => array('LIKE', $search_string),
1285
-                'REG_group_size'                          => array('LIKE', $search_string),
1286
-                'Ticket.TKT_name'                         => array('LIKE', $search_string),
1287
-                'Ticket.TKT_description'                  => array('LIKE', $search_string),
1288
-                'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string),
1289
-            );
1290
-        }
1291
-        return $where;
1292
-    }
1293
-
1294
-
1295
-    /**
1296
-     * Sets up the where conditions for the registrations query.
1297
-     *
1298
-     * @param array $request
1299
-     * @return array
1300
-     * @throws EE_Error
1301
-     */
1302
-    protected function _get_where_conditions_for_registrations_query($request)
1303
-    {
1304
-        return apply_filters(
1305
-            'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
1306
-            array_merge(
1307
-                $this->_add_event_id_to_where_conditions($request),
1308
-                $this->_add_category_id_to_where_conditions($request),
1309
-                $this->_add_datetime_id_to_where_conditions($request),
1310
-                $this->_add_registration_status_to_where_conditions($request),
1311
-                $this->_add_date_to_where_conditions($request),
1312
-                $this->_add_search_to_where_conditions($request)
1313
-            ),
1314
-            $request
1315
-        );
1316
-    }
1317
-
1318
-
1319
-    /**
1320
-     * Sets up the orderby for the registrations query.
1321
-     *
1322
-     * @return array
1323
-     */
1324
-    protected function _get_orderby_for_registrations_query()
1325
-    {
1326
-        $orderby_field = ! empty($this->_req_data['orderby'])
1327
-            ? sanitize_text_field($this->_req_data['orderby'])
1328
-            : '';
1329
-        switch ($orderby_field) {
1330
-            case '_REG_ID':
1331
-                $orderby_field = 'REG_ID';
1332
-                break;
1333
-            case '_Reg_status':
1334
-                $orderby_field = 'STS_ID';
1335
-                break;
1336
-            case 'ATT_fname':
1337
-                $orderby_field = array('Attendee.ATT_fname', 'Attendee.ATT_lname');
1338
-                break;
1339
-            case 'ATT_lname':
1340
-                $orderby_field = array('Attendee.ATT_lname', 'Attendee.ATT_fname');
1341
-                break;
1342
-            case 'event_name':
1343
-                $orderby_field = 'Event.EVT_name';
1344
-                break;
1345
-            case 'DTT_EVT_start':
1346
-                $orderby_field = 'Event.Datetime.DTT_EVT_start';
1347
-                break;
1348
-            default: //'REG_date'
1349
-                $orderby_field = 'REG_date';
1350
-        }
1351
-
1352
-        //order
1353
-        $order = ! empty($this->_req_data['order'])
1354
-            ? sanitize_text_field($this->_req_data['order'])
1355
-            : 'DESC';
1356
-
1357
-        //mutate orderby_field
1358
-        $orderby_field = array_combine(
1359
-            (array) $orderby_field,
1360
-            array_fill(0, count($orderby_field), $order)
1361
-        );
1362
-        return array('order_by' => $orderby_field);
1363
-    }
1364
-
1365
-
1366
-    /**
1367
-     * Sets up the limit for the registrations query.
1368
-     *
1369
-     * @param $per_page
1370
-     * @return array
1371
-     */
1372
-    protected function _get_limit($per_page)
1373
-    {
1374
-        $current_page = ! empty($this->_req_data['paged'])
1375
-            ? absint($this->_req_data['paged'])
1376
-            : 1;
1377
-        $per_page     = ! empty($this->_req_data['perpage'])
1378
-            ? $this->_req_data['perpage']
1379
-            : $per_page;
1380
-
1381
-        //-1 means return all results so get out if that's set.
1382
-        if ((int)$per_page === -1) {
1383
-            return array();
1384
-        }
1385
-        $per_page = absint($per_page);
1386
-        $offset   = ($current_page - 1) * $per_page;
1387
-        return array('limit' => array($offset, $per_page));
1388
-    }
1389
-
1390
-
1391
-    public function get_registration_status_array()
1392
-    {
1393
-        return self::$_reg_status;
1394
-    }
1395
-
1396
-
1397
-
1398
-
1399
-    /***************************************        REGISTRATION DETAILS        ***************************************/
1400
-    /**
1401
-     *        generates HTML for the View Registration Details Admin page
1402
-     *
1403
-     * @access protected
1404
-     * @return void
1405
-     * @throws DomainException
1406
-     * @throws EE_Error
1407
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1408
-     */
1409
-    protected function _registration_details()
1410
-    {
1411
-        $this->_template_args = array();
1412
-        $this->_set_registration_object();
1413
-        if (is_object($this->_registration)) {
1414
-            $transaction                                   = $this->_registration->transaction()
1415
-                ? $this->_registration->transaction()
1416
-                : EE_Transaction::new_instance();
1417
-            $this->_session                                = $transaction->session_data();
1418
-            $event_id                                      = $this->_registration->event_ID();
1419
-            $this->_template_args['reg_nmbr']['value']     = $this->_registration->ID();
1420
-            $this->_template_args['reg_nmbr']['label']     = esc_html__('Registration Number', 'event_espresso');
1421
-            $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
1422
-            $this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
1423
-            $this->_template_args['grand_total']           = $transaction->total();
1424
-            $this->_template_args['currency_sign']         = EE_Registry::instance()->CFG->currency->sign;
1425
-            // link back to overview
1426
-            $this->_template_args['reg_overview_url']            = REG_ADMIN_URL;
1427
-            $this->_template_args['registration']                = $this->_registration;
1428
-            $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
1429
-                array(
1430
-                    'action'   => 'default',
1431
-                    'event_id' => $event_id,
1432
-                ),
1433
-                REG_ADMIN_URL
1434
-            );
1435
-            $this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
1436
-                array(
1437
-                    'action' => 'default',
1438
-                    'EVT_ID' => $event_id,
1439
-                    'page'   => 'espresso_transactions',
1440
-                ),
1441
-                admin_url('admin.php')
1442
-            );
1443
-            $this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
1444
-                array(
1445
-                    'page'   => 'espresso_events',
1446
-                    'action' => 'edit',
1447
-                    'post'   => $event_id,
1448
-                ),
1449
-                admin_url('admin.php')
1450
-            );
1451
-            //next and previous links
1452
-            $next_reg                                      = $this->_registration->next(
1453
-                null,
1454
-                array(),
1455
-                'REG_ID'
1456
-            );
1457
-            $this->_template_args['next_registration']     = $next_reg
1458
-                ? $this->_next_link(
1459
-                    EE_Admin_Page::add_query_args_and_nonce(
1460
-                        array(
1461
-                            'action'  => 'view_registration',
1462
-                            '_REG_ID' => $next_reg['REG_ID'],
1463
-                        ),
1464
-                        REG_ADMIN_URL
1465
-                    ),
1466
-                    'dashicons dashicons-arrow-right ee-icon-size-22'
1467
-                )
1468
-                : '';
1469
-            $previous_reg                                  = $this->_registration->previous(
1470
-                null,
1471
-                array(),
1472
-                'REG_ID'
1473
-            );
1474
-            $this->_template_args['previous_registration'] = $previous_reg
1475
-                ? $this->_previous_link(
1476
-                    EE_Admin_Page::add_query_args_and_nonce(
1477
-                        array(
1478
-                            'action'  => 'view_registration',
1479
-                            '_REG_ID' => $previous_reg['REG_ID'],
1480
-                        ),
1481
-                        REG_ADMIN_URL
1482
-                    ),
1483
-                    'dashicons dashicons-arrow-left ee-icon-size-22'
1484
-                )
1485
-                : '';
1486
-            // grab header
1487
-            $template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
1488
-            $this->_template_args['REG_ID']            = $this->_registration->ID();
1489
-            $this->_template_args['admin_page_header'] = EEH_Template::display_template(
1490
-                $template_path,
1491
-                $this->_template_args,
1492
-                true
1493
-            );
1494
-        } else {
1495
-            $this->_template_args['admin_page_header'] = $this->display_espresso_notices();
1496
-        }
1497
-        // the details template wrapper
1498
-        $this->display_admin_page_with_sidebar();
1499
-    }
1500
-
1501
-
1502
-    protected function _registration_details_metaboxes()
1503
-    {
1504
-        do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
1505
-        $this->_set_registration_object();
1506
-        $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
1507
-        add_meta_box('edit-reg-status-mbox', esc_html__('Registration Status', 'event_espresso'),
1508
-            array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high');
1509
-        add_meta_box('edit-reg-details-mbox', esc_html__('Registration Details', 'event_espresso'),
1510
-            array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high');
1511
-        if ($attendee instanceof EE_Attendee
1512
-            && EE_Registry::instance()->CAP->current_user_can(
1513
-                'ee_edit_registration',
1514
-                'edit-reg-questions-mbox'
1515
-            )
1516
-        ) {
1517
-            add_meta_box(
1518
-                'edit-reg-questions-mbox',
1519
-                esc_html__('Registration Form Answers', 'event_espresso'),
1520
-                array($this, '_reg_questions_meta_box'),
1521
-                $this->wp_page_slug,
1522
-                'normal',
1523
-                'high'
1524
-            );
1525
-        }
1526
-        add_meta_box(
1527
-            'edit-reg-registrant-mbox',
1528
-            esc_html__('Contact Details', 'event_espresso'),
1529
-            array($this, '_reg_registrant_side_meta_box'),
1530
-            $this->wp_page_slug,
1531
-            'side',
1532
-            'high'
1533
-        );
1534
-        if ($this->_registration->group_size() > 1) {
1535
-            add_meta_box(
1536
-                'edit-reg-attendees-mbox',
1537
-                esc_html__('Other Registrations in this Transaction', 'event_espresso'),
1538
-                array($this, '_reg_attendees_meta_box'),
1539
-                $this->wp_page_slug,
1540
-                'normal',
1541
-                'high'
1542
-            );
1543
-        }
1544
-    }
1545
-
1546
-
1547
-    /**
1548
-     * set_reg_status_buttons_metabox
1549
-     *
1550
-     * @access protected
1551
-     * @return string
1552
-     * @throws \EE_Error
1553
-     */
1554
-    public function set_reg_status_buttons_metabox()
1555
-    {
1556
-        $this->_set_registration_object();
1557
-        $change_reg_status_form = $this->_generate_reg_status_change_form();
1558
-        echo $change_reg_status_form->form_open(
1559
-            self::add_query_args_and_nonce(
1560
-                array(
1561
-                    'action' => 'change_reg_status',
1562
-                ),
1563
-                REG_ADMIN_URL
1564
-            )
1565
-        );
1566
-        echo $change_reg_status_form->get_html();
1567
-        echo $change_reg_status_form->form_close();
1568
-    }
1569
-
1570
-
1571
-    /**
1572
-     * @return EE_Form_Section_Proper
1573
-     * @throws EE_Error
1574
-     */
1575
-    protected function _generate_reg_status_change_form()
1576
-    {
1577
-        return new EE_Form_Section_Proper(array(
1578
-            'name'            => 'reg_status_change_form',
1579
-            'html_id'         => 'reg-status-change-form',
1580
-            'layout_strategy' => new EE_Admin_Two_Column_Layout(),
1581
-            'subsections'     => array(
1582
-                'return'             => new EE_Hidden_Input(array(
1583
-                    'name'    => 'return',
1584
-                    'default' => 'view_registration',
1585
-                )),
1586
-                'REG_ID'             => new EE_Hidden_Input(array(
1587
-                    'name'    => 'REG_ID',
1588
-                    'default' => $this->_registration->ID(),
1589
-                )),
1590
-                'current_status'     => new EE_Form_Section_HTML(
1591
-                    EEH_HTML::tr(
1592
-                        EEH_HTML::th(
1593
-                            EEH_HTML::label(
1594
-                                EEH_HTML::strong(esc_html__('Current Registration Status', 'event_espresso')
1595
-                                )
1596
-                            )
1597
-                        )
1598
-                        . EEH_HTML::td(
1599
-                            EEH_HTML::strong(
1600
-                                $this->_registration->pretty_status(),
1601
-                                '',
1602
-                                'status-' . $this->_registration->status_ID(),
1603
-                                'line-height: 1em; font-size: 1.5em; font-weight: bold;'
1604
-                            )
1605
-                        )
1606
-                    )
1607
-                ),
1608
-                'reg_status'         => new EE_Select_Input(
1609
-                    $this->_get_reg_statuses(),
1610
-                    array(
1611
-                        'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
1612
-                        'default'         => $this->_registration->status_ID(),
1613
-                    )
1614
-                ),
1615
-                'send_notifications' => new EE_Yes_No_Input(
1616
-                    array(
1617
-                        'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
1618
-                        'default'         => false,
1619
-                        'html_help_text'  => esc_html__(
1620
-                            'If set to "Yes", then the related messages will be sent to the registrant.',
1621
-                            'event_espresso'
1622
-                        ),
1623
-                    )
1624
-                ),
1625
-                'submit'             => new EE_Submit_Input(
1626
-                    array(
1627
-                        'html_class'      => 'button-primary',
1628
-                        'html_label_text' => '&nbsp;',
1629
-                        'default'         => esc_html__('Update Registration Status', 'event_espresso'),
1630
-                    )
1631
-                ),
1632
-            ),
1633
-        ));
1634
-    }
1635
-
1636
-
1637
-    /**
1638
-     * Returns an array of all the buttons for the various statuses and switch status actions
1639
-     *
1640
-     * @return array
1641
-     * @throws EE_Error
1642
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1643
-     */
1644
-    protected function _get_reg_statuses()
1645
-    {
1646
-        $reg_status_array = EEM_Registration::instance()->reg_status_array();
1647
-        unset ($reg_status_array[EEM_Registration::status_id_incomplete]);
1648
-        // get current reg status
1649
-        $current_status = $this->_registration->status_ID();
1650
-        // is registration for free event? This will determine whether to display the pending payment option
1651
-        if ($current_status != EEM_Registration::status_id_pending_payment
1652
-            && $this->_registration->transaction()
1653
-                                   ->is_free()
1654
-        ) {
1655
-            unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
1656
-        }
1657
-        return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
1658
-    }
1659
-
1660
-
1661
-    /**
1662
-     * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
1663
-     *
1664
-     * @param bool $status REG status given for changing registrations to.
1665
-     * @param bool $notify Whether to send messages notifications or not.
1666
-     * @return array  (array with reg_id(s) updated and whether update was successful.
1667
-     */
1668
-    protected function _set_registration_status_from_request($status = false, $notify = false)
1669
-    {
1670
-        if (isset($this->_req_data['reg_status_change_form'])) {
1671
-            $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
1672
-                ? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array();
1673
-        } else {
1674
-            $REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array();
1675
-        }
1676
-        $success = $this->_set_registration_status($REG_IDs, $status);
1677
-        //notify?
1678
-        if ($success
1679
-            && $notify
1680
-            && EE_Registry::instance()->CAP->current_user_can(
1681
-                'ee_send_message',
1682
-                'espresso_registrations_resend_registration'
1683
-            )
1684
-        ) {
1685
-            $this->_process_resend_registration();
1686
-        }
1687
-        return $success;
1688
-    }
1689
-
1690
-
1691
-    /**
1692
-     * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
1693
-     * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
1694
-     *
1695
-     * @param array $REG_IDs
1696
-     * @param bool  $status
1697
-     * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
1698
-     *               the array of updated registrations).
1699
-     * @throws EE_Error
1700
-     * @throws RuntimeException
1701
-     */
1702
-    protected function _set_registration_status($REG_IDs = array(), $status = false)
1703
-    {
1704
-        $success = false;
1705
-        // typecast $REG_IDs
1706
-        $REG_IDs = (array)$REG_IDs;
1707
-        if ( ! empty($REG_IDs)) {
1708
-            $success = true;
1709
-            // set default status if none is passed
1710
-            $status = $status ? $status : EEM_Registration::status_id_pending_payment;
1711
-            // sanitize $REG_IDs
1712
-            $REG_IDs = array_filter($REG_IDs, 'absint');
1713
-            //loop through REG_ID's and change status
1714
-            foreach ($REG_IDs as $REG_ID) {
1715
-                $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
1716
-                if ($registration instanceof EE_Registration) {
1717
-                    $registration->set_status($status);
1718
-                    $result = $registration->save();
1719
-                    // verifying explicit fails because update *may* just return 0 for 0 rows affected
1720
-                    $success = $result !== false ? $success : false;
1721
-                }
1722
-            }
1723
-        }
1724
-        //reset _req_data['_REG_ID'] for any potential future messages notifications
1725
-        $this->_req_data['_REG_ID'] = $REG_IDs;
1726
-        //return $success and processed registrations
1727
-        return array('REG_ID' => $REG_IDs, 'success' => $success);
1728
-    }
1729
-
1730
-
1731
-    /**
1732
-     * Common logic for setting up success message and redirecting to appropriate route
1733
-     *
1734
-     * @param  string $STS_ID status id for the registration changed to
1735
-     * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
1736
-     * @return void
1737
-     */
1738
-    protected function _reg_status_change_return($STS_ID, $notify = false)
1739
-    {
1740
-        $result  = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
1741
-            : array('success' => false);
1742
-        $success = isset($result['success']) && $result['success'];
1743
-        //setup success message
1744
-        if ($success) {
1745
-            if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
1746
-                $msg = sprintf(esc_html__('Registration status has been set to %s', 'event_espresso'),
1747
-                    EEH_Template::pretty_status($STS_ID, false, 'lower'));
1748
-            } else {
1749
-                $msg = sprintf(esc_html__('Registrations have been set to %s.', 'event_espresso'),
1750
-                    EEH_Template::pretty_status($STS_ID, false, 'lower'));
1751
-            }
1752
-            EE_Error::add_success($msg);
1753
-        } else {
1754
-            EE_Error::add_error(
1755
-                esc_html__(
1756
-                    'Something went wrong, and the status was not changed',
1757
-                    'event_espresso'
1758
-                ), __FILE__, __LINE__, __FUNCTION__
1759
-            );
1760
-        }
1761
-        if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
1762
-            $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
1763
-        } else {
1764
-            $route = array('action' => 'default');
1765
-        }
1766
-        //unset nonces
1767
-        foreach ($this->_req_data as $ref => $value) {
1768
-            if (strpos($ref, 'nonce') !== false) {
1769
-                unset($this->_req_data[$ref]);
1770
-                continue;
1771
-            }
1772
-            $value                 = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
1773
-            $this->_req_data[$ref] = $value;
1774
-        }
1775
-        //merge request vars so that the reloaded list table contains any existing filter query params
1776
-        $route = array_merge($this->_req_data, $route);
1777
-        $this->_redirect_after_action($success, '', '', $route, true);
1778
-    }
1779
-
1780
-
1781
-    /**
1782
-     * incoming reg status change from reg details page.
1783
-     *
1784
-     * @return void
1785
-     */
1786
-    protected function _change_reg_status()
1787
-    {
1788
-        $this->_req_data['return'] = 'view_registration';
1789
-        //set notify based on whether the send notifications toggle is set or not
1790
-        $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
1791
-        //$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
1792
-        $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
1793
-            ? $this->_req_data['reg_status_change_form']['reg_status'] : '';
1794
-        switch ($this->_req_data['reg_status_change_form']['reg_status']) {
1795
-            case EEM_Registration::status_id_approved :
1796
-            case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') :
1797
-                $this->approve_registration($notify);
1798
-                break;
1799
-            case EEM_Registration::status_id_pending_payment :
1800
-            case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') :
1801
-                $this->pending_registration($notify);
1802
-                break;
1803
-            case EEM_Registration::status_id_not_approved :
1804
-            case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') :
1805
-                $this->not_approve_registration($notify);
1806
-                break;
1807
-            case EEM_Registration::status_id_declined :
1808
-            case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') :
1809
-                $this->decline_registration($notify);
1810
-                break;
1811
-            case EEM_Registration::status_id_cancelled :
1812
-            case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') :
1813
-                $this->cancel_registration($notify);
1814
-                break;
1815
-            case EEM_Registration::status_id_wait_list :
1816
-            case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') :
1817
-                $this->waitlist_registration($notify);
1818
-                break;
1819
-            case EEM_Registration::status_id_incomplete :
1820
-            default :
1821
-                $result['success'] = false;
1822
-                unset($this->_req_data['return']);
1823
-                $this->_reg_status_change_return('', false);
1824
-                break;
1825
-        }
1826
-    }
1827
-
1828
-
1829
-    /**
1830
-     * approve_registration
1831
-     *
1832
-     * @access protected
1833
-     * @param bool $notify whether or not to notify the registrant about their approval.
1834
-     * @return void
1835
-     */
1836
-    protected function approve_registration($notify = false)
1837
-    {
1838
-        $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
1839
-    }
1840
-
1841
-
1842
-    /**
1843
-     *        decline_registration
1844
-     *
1845
-     * @access protected
1846
-     * @param bool $notify whether or not to notify the registrant about their status change.
1847
-     * @return void
1848
-     */
1849
-    protected function decline_registration($notify = false)
1850
-    {
1851
-        $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
1852
-    }
1853
-
1854
-
1855
-    /**
1856
-     *        cancel_registration
1857
-     *
1858
-     * @access protected
1859
-     * @param bool $notify whether or not to notify the registrant about their status change.
1860
-     * @return void
1861
-     */
1862
-    protected function cancel_registration($notify = false)
1863
-    {
1864
-        $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
1865
-    }
1866
-
1867
-
1868
-    /**
1869
-     *        not_approve_registration
1870
-     *
1871
-     * @access protected
1872
-     * @param bool $notify whether or not to notify the registrant about their status change.
1873
-     * @return void
1874
-     */
1875
-    protected function not_approve_registration($notify = false)
1876
-    {
1877
-        $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
1878
-    }
1879
-
1880
-
1881
-    /**
1882
-     *        decline_registration
1883
-     *
1884
-     * @access protected
1885
-     * @param bool $notify whether or not to notify the registrant about their status change.
1886
-     * @return void
1887
-     */
1888
-    protected function pending_registration($notify = false)
1889
-    {
1890
-        $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
1891
-    }
1892
-
1893
-
1894
-    /**
1895
-     * waitlist_registration
1896
-     *
1897
-     * @access protected
1898
-     * @param bool $notify whether or not to notify the registrant about their status change.
1899
-     * @return void
1900
-     */
1901
-    protected function waitlist_registration($notify = false)
1902
-    {
1903
-        $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
1904
-    }
1905
-
1906
-
1907
-    /**
1908
-     *        generates HTML for the Registration main meta box
1909
-     *
1910
-     * @access public
1911
-     * @return void
1912
-     * @throws DomainException
1913
-     * @throws EE_Error
1914
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1915
-     */
1916
-    public function _reg_details_meta_box()
1917
-    {
1918
-        EEH_Autoloader::register_line_item_display_autoloaders();
1919
-        EEH_Autoloader::register_line_item_filter_autoloaders();
1920
-        EE_Registry::instance()->load_helper('Line_Item');
1921
-        $transaction    = $this->_registration->transaction() ? $this->_registration->transaction()
1922
-            : EE_Transaction::new_instance();
1923
-        $this->_session = $transaction->session_data();
1924
-        $filters        = new EE_Line_Item_Filter_Collection();
1925
-        //$filters->add( new EE_Non_Zero_Line_Item_Filter() );
1926
-        $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
1927
-        $line_item_filter_processor              = new EE_Line_Item_Filter_Processor($filters,
1928
-            $transaction->total_line_item());
1929
-        $filtered_line_item_tree                 = $line_item_filter_processor->process();
1930
-        $line_item_display                       = new EE_Line_Item_Display('reg_admin_table',
1931
-            'EE_Admin_Table_Registration_Line_Item_Display_Strategy');
1932
-        $this->_template_args['line_item_table'] = $line_item_display->display_line_item(
1933
-            $filtered_line_item_tree,
1934
-            array('EE_Registration' => $this->_registration)
1935
-        );
1936
-        $attendee                                = $this->_registration->attendee();
1937
-        if (EE_Registry::instance()->CAP->current_user_can(
1938
-            'ee_read_transaction',
1939
-            'espresso_transactions_view_transaction'
1940
-        )) {
1941
-            $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
1942
-                EE_Admin_Page::add_query_args_and_nonce(
1943
-                    array(
1944
-                        'action' => 'view_transaction',
1945
-                        'TXN_ID' => $transaction->ID(),
1946
-                    ),
1947
-                    TXN_ADMIN_URL
1948
-                ),
1949
-                esc_html__(' View Transaction', 'event_espresso'),
1950
-                'button secondary-button right',
1951
-                'dashicons dashicons-cart'
1952
-            );
1953
-        } else {
1954
-            $this->_template_args['view_transaction_button'] = '';
1955
-        }
1956
-        if ($attendee instanceof EE_Attendee
1957
-            && EE_Registry::instance()->CAP->current_user_can(
1958
-                'ee_send_message',
1959
-                'espresso_registrations_resend_registration'
1960
-            )
1961
-        ) {
1962
-            $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
1963
-                EE_Admin_Page::add_query_args_and_nonce(
1964
-                    array(
1965
-                        'action'      => 'resend_registration',
1966
-                        '_REG_ID'     => $this->_registration->ID(),
1967
-                        'redirect_to' => 'view_registration',
1968
-                    ),
1969
-                    REG_ADMIN_URL
1970
-                ),
1971
-                esc_html__(' Resend Registration', 'event_espresso'),
1972
-                'button secondary-button right',
1973
-                'dashicons dashicons-email-alt'
1974
-            );
1975
-        } else {
1976
-            $this->_template_args['resend_registration_button'] = '';
1977
-        }
1978
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
1979
-        $payment                               = $transaction->get_first_related('Payment');
1980
-        $payment                               = ! $payment instanceof EE_Payment
1981
-            ? EE_Payment::new_instance()
1982
-            : $payment;
1983
-        $payment_method                        = $payment->get_first_related('Payment_Method');
1984
-        $payment_method                        = ! $payment_method instanceof EE_Payment_Method
1985
-            ? EE_Payment_Method::new_instance()
1986
-            : $payment_method;
1987
-        $reg_details                           = array(
1988
-            'payment_method'       => $payment_method->name(),
1989
-            'response_msg'         => $payment->gateway_response(),
1990
-            'registration_id'      => $this->_registration->get('REG_code'),
1991
-            'registration_session' => $this->_registration->session_ID(),
1992
-            'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
1993
-            'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
1994
-        );
1995
-        if (isset($reg_details['registration_id'])) {
1996
-            $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
1997
-            $this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
1998
-                'Registration ID',
1999
-                'event_espresso'
2000
-            );
2001
-            $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
2002
-        }
2003
-        if (isset($reg_details['payment_method'])) {
2004
-            $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
2005
-            $this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
2006
-                'Most Recent Payment Method',
2007
-                'event_espresso'
2008
-            );
2009
-            $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
2010
-            $this->_template_args['reg_details']['response_msg']['value']   = $reg_details['response_msg'];
2011
-            $this->_template_args['reg_details']['response_msg']['label']   = esc_html__(
2012
-                'Payment method response',
2013
-                'event_espresso'
2014
-            );
2015
-            $this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
2016
-        }
2017
-        $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
2018
-        $this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
2019
-            'Registration Session',
2020
-            'event_espresso'
2021
-        );
2022
-        $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
2023
-        $this->_template_args['reg_details']['ip_address']['value']           = $reg_details['ip_address'];
2024
-        $this->_template_args['reg_details']['ip_address']['label']           = esc_html__(
2025
-            'Registration placed from IP',
2026
-            'event_espresso'
2027
-        );
2028
-        $this->_template_args['reg_details']['ip_address']['class']           = 'regular-text';
2029
-        $this->_template_args['reg_details']['user_agent']['value']           = $reg_details['user_agent'];
2030
-        $this->_template_args['reg_details']['user_agent']['label']           = esc_html__('Registrant User Agent',
2031
-            'event_espresso');
2032
-        $this->_template_args['reg_details']['user_agent']['class']           = 'large-text';
2033
-        $this->_template_args['event_link']                                   = EE_Admin_Page::add_query_args_and_nonce(
2034
-            array(
2035
-                'action'   => 'default',
2036
-                'event_id' => $this->_registration->event_ID(),
2037
-            ),
2038
-            REG_ADMIN_URL
2039
-        );
2040
-        $this->_template_args['REG_ID']                                       = $this->_registration->ID();
2041
-        $this->_template_args['event_id']                                     = $this->_registration->event_ID();
2042
-        $template_path                                                        =
2043
-            REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
2044
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
2045
-    }
2046
-
2047
-
2048
-    /**
2049
-     * generates HTML for the Registration Questions meta box.
2050
-     * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
2051
-     * otherwise uses new forms system
2052
-     *
2053
-     * @access public
2054
-     * @return void
2055
-     * @throws DomainException
2056
-     * @throws EE_Error
2057
-     */
2058
-    public function _reg_questions_meta_box()
2059
-    {
2060
-        //allow someone to override this method entirely
2061
-        if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this,
2062
-            $this->_registration)) {
2063
-            $form                                              = $this->_get_reg_custom_questions_form(
2064
-                $this->_registration->ID()
2065
-            );
2066
-            $this->_template_args['att_questions']             = count($form->subforms()) > 0
2067
-                ? $form->get_html_and_js()
2068
-                : '';
2069
-            $this->_template_args['reg_questions_form_action'] = 'edit_registration';
2070
-            $this->_template_args['REG_ID']                    = $this->_registration->ID();
2071
-            $template_path                                     =
2072
-                REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
2073
-            echo EEH_Template::display_template($template_path, $this->_template_args, true);
2074
-        }
2075
-    }
2076
-
2077
-
2078
-    /**
2079
-     * form_before_question_group
2080
-     *
2081
-     * @deprecated    as of 4.8.32.rc.000
2082
-     * @access        public
2083
-     * @param        string $output
2084
-     * @return        string
2085
-     */
2086
-    public function form_before_question_group($output)
2087
-    {
2088
-        EE_Error::doing_it_wrong(
2089
-            __CLASS__ . '::' . __FUNCTION__,
2090
-            esc_html__(
2091
-                '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.',
2092
-                'event_espresso'
2093
-            ),
2094
-            '4.8.32.rc.000'
2095
-        );
2096
-        return '
1159
+		if (! empty($registration_status)) {
1160
+			$where['STS_ID'] = $registration_status;
1161
+		} else {
1162
+			//make sure we exclude incomplete registrations, but only if not trashed.
1163
+			if ($view === 'trash') {
1164
+				$where['REG_deleted'] = true;
1165
+			} elseif ($view === 'incomplete') {
1166
+				$where['STS_ID'] = EEM_Registration::status_id_incomplete;
1167
+			} else {
1168
+				$where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
1169
+			}
1170
+		}
1171
+		return $where;
1172
+	}
1173
+
1174
+
1175
+	/**
1176
+	 * Adds any provided date restraints to the where conditions for the registrations query.
1177
+	 *
1178
+	 * @param array $request usually the same as $this->_req_data but not necessarily
1179
+	 * @return array
1180
+	 * @throws EE_Error
1181
+	 */
1182
+	protected function _add_date_to_where_conditions(array $request)
1183
+	{
1184
+		$where = array();
1185
+		$view = EEH_Array::is_set($request, 'status', '');
1186
+		$month_range             = ! empty($request['month_range'])
1187
+			? sanitize_text_field($request['month_range'])
1188
+			: '';
1189
+		$retrieve_for_today      = $view === 'today';
1190
+		$retrieve_for_this_month = $view === 'month';
1191
+
1192
+		if ($retrieve_for_today) {
1193
+			$now               = date('Y-m-d', current_time('timestamp'));
1194
+			$where['REG_date'] = array(
1195
+				'BETWEEN',
1196
+				array(
1197
+					EEM_Registration::instance()->convert_datetime_for_query(
1198
+						'REG_date',
1199
+						$now . ' 00:00:00',
1200
+						'Y-m-d H:i:s'
1201
+					),
1202
+					EEM_Registration::instance()->convert_datetime_for_query(
1203
+						'REG_date',
1204
+						$now . ' 23:59:59',
1205
+						'Y-m-d H:i:s'
1206
+					),
1207
+				),
1208
+			);
1209
+		} elseif ($retrieve_for_this_month) {
1210
+			$current_year_and_month = date('Y-m', current_time('timestamp'));
1211
+			$days_this_month        = date('t', current_time('timestamp'));
1212
+			$where['REG_date']      = array(
1213
+				'BETWEEN',
1214
+				array(
1215
+					EEM_Registration::instance()->convert_datetime_for_query(
1216
+						'REG_date',
1217
+						$current_year_and_month . '-01 00:00:00',
1218
+						'Y-m-d H:i:s'
1219
+					),
1220
+					EEM_Registration::instance()->convert_datetime_for_query(
1221
+						'REG_date',
1222
+						$current_year_and_month . '-' . $days_this_month . ' 23:59:59',
1223
+						'Y-m-d H:i:s'
1224
+					),
1225
+				),
1226
+			);
1227
+		} elseif ($month_range) {
1228
+			$pieces          = explode(' ', $month_range, 3);
1229
+			$month_requested = ! empty($pieces[0])
1230
+				? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
1231
+				: '';
1232
+			$year_requested  = ! empty($pieces[1])
1233
+				? $pieces[1]
1234
+				: '';
1235
+			//if there is not a month or year then we can't go further
1236
+			if ($month_requested && $year_requested) {
1237
+				$days_in_month     = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
1238
+				$where['REG_date'] = array(
1239
+					'BETWEEN',
1240
+					array(
1241
+						EEM_Registration::instance()->convert_datetime_for_query(
1242
+							'REG_date',
1243
+							$year_requested . '-' . $month_requested . '-01 00:00:00',
1244
+							'Y-m-d H:i:s'
1245
+						),
1246
+						EEM_Registration::instance()->convert_datetime_for_query(
1247
+							'REG_date',
1248
+							$year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
1249
+							'Y-m-d H:i:s'
1250
+						),
1251
+					),
1252
+				);
1253
+			}
1254
+		}
1255
+		return $where;
1256
+	}
1257
+
1258
+
1259
+	/**
1260
+	 * Adds any provided search restraints to the where conditions for the registrations query
1261
+	 *
1262
+	 * @param array $request usually the same as $this->_req_data but not necessarily
1263
+	 * @return array
1264
+	 */
1265
+	protected function _add_search_to_where_conditions(array $request)
1266
+	{
1267
+		$where = array();
1268
+		if (! empty($request['s'])) {
1269
+			$search_string = '%' . sanitize_text_field($request['s']) . '%';
1270
+			$where['OR*search_conditions'] = array(
1271
+				'Event.EVT_name'                          => array('LIKE', $search_string),
1272
+				'Event.EVT_desc'                          => array('LIKE', $search_string),
1273
+				'Event.EVT_short_desc'                    => array('LIKE', $search_string),
1274
+				'Attendee.ATT_full_name'                  => array('LIKE', $search_string),
1275
+				'Attendee.ATT_fname'                      => array('LIKE', $search_string),
1276
+				'Attendee.ATT_lname'                      => array('LIKE', $search_string),
1277
+				'Attendee.ATT_short_bio'                  => array('LIKE', $search_string),
1278
+				'Attendee.ATT_email'                      => array('LIKE', $search_string),
1279
+				'Attendee.ATT_address'                    => array('LIKE', $search_string),
1280
+				'Attendee.ATT_address2'                   => array('LIKE', $search_string),
1281
+				'Attendee.ATT_city'                       => array('LIKE', $search_string),
1282
+				'REG_final_price'                         => array('LIKE', $search_string),
1283
+				'REG_code'                                => array('LIKE', $search_string),
1284
+				'REG_count'                               => array('LIKE', $search_string),
1285
+				'REG_group_size'                          => array('LIKE', $search_string),
1286
+				'Ticket.TKT_name'                         => array('LIKE', $search_string),
1287
+				'Ticket.TKT_description'                  => array('LIKE', $search_string),
1288
+				'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string),
1289
+			);
1290
+		}
1291
+		return $where;
1292
+	}
1293
+
1294
+
1295
+	/**
1296
+	 * Sets up the where conditions for the registrations query.
1297
+	 *
1298
+	 * @param array $request
1299
+	 * @return array
1300
+	 * @throws EE_Error
1301
+	 */
1302
+	protected function _get_where_conditions_for_registrations_query($request)
1303
+	{
1304
+		return apply_filters(
1305
+			'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
1306
+			array_merge(
1307
+				$this->_add_event_id_to_where_conditions($request),
1308
+				$this->_add_category_id_to_where_conditions($request),
1309
+				$this->_add_datetime_id_to_where_conditions($request),
1310
+				$this->_add_registration_status_to_where_conditions($request),
1311
+				$this->_add_date_to_where_conditions($request),
1312
+				$this->_add_search_to_where_conditions($request)
1313
+			),
1314
+			$request
1315
+		);
1316
+	}
1317
+
1318
+
1319
+	/**
1320
+	 * Sets up the orderby for the registrations query.
1321
+	 *
1322
+	 * @return array
1323
+	 */
1324
+	protected function _get_orderby_for_registrations_query()
1325
+	{
1326
+		$orderby_field = ! empty($this->_req_data['orderby'])
1327
+			? sanitize_text_field($this->_req_data['orderby'])
1328
+			: '';
1329
+		switch ($orderby_field) {
1330
+			case '_REG_ID':
1331
+				$orderby_field = 'REG_ID';
1332
+				break;
1333
+			case '_Reg_status':
1334
+				$orderby_field = 'STS_ID';
1335
+				break;
1336
+			case 'ATT_fname':
1337
+				$orderby_field = array('Attendee.ATT_fname', 'Attendee.ATT_lname');
1338
+				break;
1339
+			case 'ATT_lname':
1340
+				$orderby_field = array('Attendee.ATT_lname', 'Attendee.ATT_fname');
1341
+				break;
1342
+			case 'event_name':
1343
+				$orderby_field = 'Event.EVT_name';
1344
+				break;
1345
+			case 'DTT_EVT_start':
1346
+				$orderby_field = 'Event.Datetime.DTT_EVT_start';
1347
+				break;
1348
+			default: //'REG_date'
1349
+				$orderby_field = 'REG_date';
1350
+		}
1351
+
1352
+		//order
1353
+		$order = ! empty($this->_req_data['order'])
1354
+			? sanitize_text_field($this->_req_data['order'])
1355
+			: 'DESC';
1356
+
1357
+		//mutate orderby_field
1358
+		$orderby_field = array_combine(
1359
+			(array) $orderby_field,
1360
+			array_fill(0, count($orderby_field), $order)
1361
+		);
1362
+		return array('order_by' => $orderby_field);
1363
+	}
1364
+
1365
+
1366
+	/**
1367
+	 * Sets up the limit for the registrations query.
1368
+	 *
1369
+	 * @param $per_page
1370
+	 * @return array
1371
+	 */
1372
+	protected function _get_limit($per_page)
1373
+	{
1374
+		$current_page = ! empty($this->_req_data['paged'])
1375
+			? absint($this->_req_data['paged'])
1376
+			: 1;
1377
+		$per_page     = ! empty($this->_req_data['perpage'])
1378
+			? $this->_req_data['perpage']
1379
+			: $per_page;
1380
+
1381
+		//-1 means return all results so get out if that's set.
1382
+		if ((int)$per_page === -1) {
1383
+			return array();
1384
+		}
1385
+		$per_page = absint($per_page);
1386
+		$offset   = ($current_page - 1) * $per_page;
1387
+		return array('limit' => array($offset, $per_page));
1388
+	}
1389
+
1390
+
1391
+	public function get_registration_status_array()
1392
+	{
1393
+		return self::$_reg_status;
1394
+	}
1395
+
1396
+
1397
+
1398
+
1399
+	/***************************************        REGISTRATION DETAILS        ***************************************/
1400
+	/**
1401
+	 *        generates HTML for the View Registration Details Admin page
1402
+	 *
1403
+	 * @access protected
1404
+	 * @return void
1405
+	 * @throws DomainException
1406
+	 * @throws EE_Error
1407
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1408
+	 */
1409
+	protected function _registration_details()
1410
+	{
1411
+		$this->_template_args = array();
1412
+		$this->_set_registration_object();
1413
+		if (is_object($this->_registration)) {
1414
+			$transaction                                   = $this->_registration->transaction()
1415
+				? $this->_registration->transaction()
1416
+				: EE_Transaction::new_instance();
1417
+			$this->_session                                = $transaction->session_data();
1418
+			$event_id                                      = $this->_registration->event_ID();
1419
+			$this->_template_args['reg_nmbr']['value']     = $this->_registration->ID();
1420
+			$this->_template_args['reg_nmbr']['label']     = esc_html__('Registration Number', 'event_espresso');
1421
+			$this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
1422
+			$this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
1423
+			$this->_template_args['grand_total']           = $transaction->total();
1424
+			$this->_template_args['currency_sign']         = EE_Registry::instance()->CFG->currency->sign;
1425
+			// link back to overview
1426
+			$this->_template_args['reg_overview_url']            = REG_ADMIN_URL;
1427
+			$this->_template_args['registration']                = $this->_registration;
1428
+			$this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
1429
+				array(
1430
+					'action'   => 'default',
1431
+					'event_id' => $event_id,
1432
+				),
1433
+				REG_ADMIN_URL
1434
+			);
1435
+			$this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
1436
+				array(
1437
+					'action' => 'default',
1438
+					'EVT_ID' => $event_id,
1439
+					'page'   => 'espresso_transactions',
1440
+				),
1441
+				admin_url('admin.php')
1442
+			);
1443
+			$this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
1444
+				array(
1445
+					'page'   => 'espresso_events',
1446
+					'action' => 'edit',
1447
+					'post'   => $event_id,
1448
+				),
1449
+				admin_url('admin.php')
1450
+			);
1451
+			//next and previous links
1452
+			$next_reg                                      = $this->_registration->next(
1453
+				null,
1454
+				array(),
1455
+				'REG_ID'
1456
+			);
1457
+			$this->_template_args['next_registration']     = $next_reg
1458
+				? $this->_next_link(
1459
+					EE_Admin_Page::add_query_args_and_nonce(
1460
+						array(
1461
+							'action'  => 'view_registration',
1462
+							'_REG_ID' => $next_reg['REG_ID'],
1463
+						),
1464
+						REG_ADMIN_URL
1465
+					),
1466
+					'dashicons dashicons-arrow-right ee-icon-size-22'
1467
+				)
1468
+				: '';
1469
+			$previous_reg                                  = $this->_registration->previous(
1470
+				null,
1471
+				array(),
1472
+				'REG_ID'
1473
+			);
1474
+			$this->_template_args['previous_registration'] = $previous_reg
1475
+				? $this->_previous_link(
1476
+					EE_Admin_Page::add_query_args_and_nonce(
1477
+						array(
1478
+							'action'  => 'view_registration',
1479
+							'_REG_ID' => $previous_reg['REG_ID'],
1480
+						),
1481
+						REG_ADMIN_URL
1482
+					),
1483
+					'dashicons dashicons-arrow-left ee-icon-size-22'
1484
+				)
1485
+				: '';
1486
+			// grab header
1487
+			$template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
1488
+			$this->_template_args['REG_ID']            = $this->_registration->ID();
1489
+			$this->_template_args['admin_page_header'] = EEH_Template::display_template(
1490
+				$template_path,
1491
+				$this->_template_args,
1492
+				true
1493
+			);
1494
+		} else {
1495
+			$this->_template_args['admin_page_header'] = $this->display_espresso_notices();
1496
+		}
1497
+		// the details template wrapper
1498
+		$this->display_admin_page_with_sidebar();
1499
+	}
1500
+
1501
+
1502
+	protected function _registration_details_metaboxes()
1503
+	{
1504
+		do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
1505
+		$this->_set_registration_object();
1506
+		$attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
1507
+		add_meta_box('edit-reg-status-mbox', esc_html__('Registration Status', 'event_espresso'),
1508
+			array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high');
1509
+		add_meta_box('edit-reg-details-mbox', esc_html__('Registration Details', 'event_espresso'),
1510
+			array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high');
1511
+		if ($attendee instanceof EE_Attendee
1512
+			&& EE_Registry::instance()->CAP->current_user_can(
1513
+				'ee_edit_registration',
1514
+				'edit-reg-questions-mbox'
1515
+			)
1516
+		) {
1517
+			add_meta_box(
1518
+				'edit-reg-questions-mbox',
1519
+				esc_html__('Registration Form Answers', 'event_espresso'),
1520
+				array($this, '_reg_questions_meta_box'),
1521
+				$this->wp_page_slug,
1522
+				'normal',
1523
+				'high'
1524
+			);
1525
+		}
1526
+		add_meta_box(
1527
+			'edit-reg-registrant-mbox',
1528
+			esc_html__('Contact Details', 'event_espresso'),
1529
+			array($this, '_reg_registrant_side_meta_box'),
1530
+			$this->wp_page_slug,
1531
+			'side',
1532
+			'high'
1533
+		);
1534
+		if ($this->_registration->group_size() > 1) {
1535
+			add_meta_box(
1536
+				'edit-reg-attendees-mbox',
1537
+				esc_html__('Other Registrations in this Transaction', 'event_espresso'),
1538
+				array($this, '_reg_attendees_meta_box'),
1539
+				$this->wp_page_slug,
1540
+				'normal',
1541
+				'high'
1542
+			);
1543
+		}
1544
+	}
1545
+
1546
+
1547
+	/**
1548
+	 * set_reg_status_buttons_metabox
1549
+	 *
1550
+	 * @access protected
1551
+	 * @return string
1552
+	 * @throws \EE_Error
1553
+	 */
1554
+	public function set_reg_status_buttons_metabox()
1555
+	{
1556
+		$this->_set_registration_object();
1557
+		$change_reg_status_form = $this->_generate_reg_status_change_form();
1558
+		echo $change_reg_status_form->form_open(
1559
+			self::add_query_args_and_nonce(
1560
+				array(
1561
+					'action' => 'change_reg_status',
1562
+				),
1563
+				REG_ADMIN_URL
1564
+			)
1565
+		);
1566
+		echo $change_reg_status_form->get_html();
1567
+		echo $change_reg_status_form->form_close();
1568
+	}
1569
+
1570
+
1571
+	/**
1572
+	 * @return EE_Form_Section_Proper
1573
+	 * @throws EE_Error
1574
+	 */
1575
+	protected function _generate_reg_status_change_form()
1576
+	{
1577
+		return new EE_Form_Section_Proper(array(
1578
+			'name'            => 'reg_status_change_form',
1579
+			'html_id'         => 'reg-status-change-form',
1580
+			'layout_strategy' => new EE_Admin_Two_Column_Layout(),
1581
+			'subsections'     => array(
1582
+				'return'             => new EE_Hidden_Input(array(
1583
+					'name'    => 'return',
1584
+					'default' => 'view_registration',
1585
+				)),
1586
+				'REG_ID'             => new EE_Hidden_Input(array(
1587
+					'name'    => 'REG_ID',
1588
+					'default' => $this->_registration->ID(),
1589
+				)),
1590
+				'current_status'     => new EE_Form_Section_HTML(
1591
+					EEH_HTML::tr(
1592
+						EEH_HTML::th(
1593
+							EEH_HTML::label(
1594
+								EEH_HTML::strong(esc_html__('Current Registration Status', 'event_espresso')
1595
+								)
1596
+							)
1597
+						)
1598
+						. EEH_HTML::td(
1599
+							EEH_HTML::strong(
1600
+								$this->_registration->pretty_status(),
1601
+								'',
1602
+								'status-' . $this->_registration->status_ID(),
1603
+								'line-height: 1em; font-size: 1.5em; font-weight: bold;'
1604
+							)
1605
+						)
1606
+					)
1607
+				),
1608
+				'reg_status'         => new EE_Select_Input(
1609
+					$this->_get_reg_statuses(),
1610
+					array(
1611
+						'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
1612
+						'default'         => $this->_registration->status_ID(),
1613
+					)
1614
+				),
1615
+				'send_notifications' => new EE_Yes_No_Input(
1616
+					array(
1617
+						'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
1618
+						'default'         => false,
1619
+						'html_help_text'  => esc_html__(
1620
+							'If set to "Yes", then the related messages will be sent to the registrant.',
1621
+							'event_espresso'
1622
+						),
1623
+					)
1624
+				),
1625
+				'submit'             => new EE_Submit_Input(
1626
+					array(
1627
+						'html_class'      => 'button-primary',
1628
+						'html_label_text' => '&nbsp;',
1629
+						'default'         => esc_html__('Update Registration Status', 'event_espresso'),
1630
+					)
1631
+				),
1632
+			),
1633
+		));
1634
+	}
1635
+
1636
+
1637
+	/**
1638
+	 * Returns an array of all the buttons for the various statuses and switch status actions
1639
+	 *
1640
+	 * @return array
1641
+	 * @throws EE_Error
1642
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1643
+	 */
1644
+	protected function _get_reg_statuses()
1645
+	{
1646
+		$reg_status_array = EEM_Registration::instance()->reg_status_array();
1647
+		unset ($reg_status_array[EEM_Registration::status_id_incomplete]);
1648
+		// get current reg status
1649
+		$current_status = $this->_registration->status_ID();
1650
+		// is registration for free event? This will determine whether to display the pending payment option
1651
+		if ($current_status != EEM_Registration::status_id_pending_payment
1652
+			&& $this->_registration->transaction()
1653
+								   ->is_free()
1654
+		) {
1655
+			unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
1656
+		}
1657
+		return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
1658
+	}
1659
+
1660
+
1661
+	/**
1662
+	 * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
1663
+	 *
1664
+	 * @param bool $status REG status given for changing registrations to.
1665
+	 * @param bool $notify Whether to send messages notifications or not.
1666
+	 * @return array  (array with reg_id(s) updated and whether update was successful.
1667
+	 */
1668
+	protected function _set_registration_status_from_request($status = false, $notify = false)
1669
+	{
1670
+		if (isset($this->_req_data['reg_status_change_form'])) {
1671
+			$REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
1672
+				? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array();
1673
+		} else {
1674
+			$REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array();
1675
+		}
1676
+		$success = $this->_set_registration_status($REG_IDs, $status);
1677
+		//notify?
1678
+		if ($success
1679
+			&& $notify
1680
+			&& EE_Registry::instance()->CAP->current_user_can(
1681
+				'ee_send_message',
1682
+				'espresso_registrations_resend_registration'
1683
+			)
1684
+		) {
1685
+			$this->_process_resend_registration();
1686
+		}
1687
+		return $success;
1688
+	}
1689
+
1690
+
1691
+	/**
1692
+	 * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
1693
+	 * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
1694
+	 *
1695
+	 * @param array $REG_IDs
1696
+	 * @param bool  $status
1697
+	 * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
1698
+	 *               the array of updated registrations).
1699
+	 * @throws EE_Error
1700
+	 * @throws RuntimeException
1701
+	 */
1702
+	protected function _set_registration_status($REG_IDs = array(), $status = false)
1703
+	{
1704
+		$success = false;
1705
+		// typecast $REG_IDs
1706
+		$REG_IDs = (array)$REG_IDs;
1707
+		if ( ! empty($REG_IDs)) {
1708
+			$success = true;
1709
+			// set default status if none is passed
1710
+			$status = $status ? $status : EEM_Registration::status_id_pending_payment;
1711
+			// sanitize $REG_IDs
1712
+			$REG_IDs = array_filter($REG_IDs, 'absint');
1713
+			//loop through REG_ID's and change status
1714
+			foreach ($REG_IDs as $REG_ID) {
1715
+				$registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
1716
+				if ($registration instanceof EE_Registration) {
1717
+					$registration->set_status($status);
1718
+					$result = $registration->save();
1719
+					// verifying explicit fails because update *may* just return 0 for 0 rows affected
1720
+					$success = $result !== false ? $success : false;
1721
+				}
1722
+			}
1723
+		}
1724
+		//reset _req_data['_REG_ID'] for any potential future messages notifications
1725
+		$this->_req_data['_REG_ID'] = $REG_IDs;
1726
+		//return $success and processed registrations
1727
+		return array('REG_ID' => $REG_IDs, 'success' => $success);
1728
+	}
1729
+
1730
+
1731
+	/**
1732
+	 * Common logic for setting up success message and redirecting to appropriate route
1733
+	 *
1734
+	 * @param  string $STS_ID status id for the registration changed to
1735
+	 * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
1736
+	 * @return void
1737
+	 */
1738
+	protected function _reg_status_change_return($STS_ID, $notify = false)
1739
+	{
1740
+		$result  = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
1741
+			: array('success' => false);
1742
+		$success = isset($result['success']) && $result['success'];
1743
+		//setup success message
1744
+		if ($success) {
1745
+			if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
1746
+				$msg = sprintf(esc_html__('Registration status has been set to %s', 'event_espresso'),
1747
+					EEH_Template::pretty_status($STS_ID, false, 'lower'));
1748
+			} else {
1749
+				$msg = sprintf(esc_html__('Registrations have been set to %s.', 'event_espresso'),
1750
+					EEH_Template::pretty_status($STS_ID, false, 'lower'));
1751
+			}
1752
+			EE_Error::add_success($msg);
1753
+		} else {
1754
+			EE_Error::add_error(
1755
+				esc_html__(
1756
+					'Something went wrong, and the status was not changed',
1757
+					'event_espresso'
1758
+				), __FILE__, __LINE__, __FUNCTION__
1759
+			);
1760
+		}
1761
+		if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
1762
+			$route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
1763
+		} else {
1764
+			$route = array('action' => 'default');
1765
+		}
1766
+		//unset nonces
1767
+		foreach ($this->_req_data as $ref => $value) {
1768
+			if (strpos($ref, 'nonce') !== false) {
1769
+				unset($this->_req_data[$ref]);
1770
+				continue;
1771
+			}
1772
+			$value                 = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
1773
+			$this->_req_data[$ref] = $value;
1774
+		}
1775
+		//merge request vars so that the reloaded list table contains any existing filter query params
1776
+		$route = array_merge($this->_req_data, $route);
1777
+		$this->_redirect_after_action($success, '', '', $route, true);
1778
+	}
1779
+
1780
+
1781
+	/**
1782
+	 * incoming reg status change from reg details page.
1783
+	 *
1784
+	 * @return void
1785
+	 */
1786
+	protected function _change_reg_status()
1787
+	{
1788
+		$this->_req_data['return'] = 'view_registration';
1789
+		//set notify based on whether the send notifications toggle is set or not
1790
+		$notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
1791
+		//$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
1792
+		$this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
1793
+			? $this->_req_data['reg_status_change_form']['reg_status'] : '';
1794
+		switch ($this->_req_data['reg_status_change_form']['reg_status']) {
1795
+			case EEM_Registration::status_id_approved :
1796
+			case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') :
1797
+				$this->approve_registration($notify);
1798
+				break;
1799
+			case EEM_Registration::status_id_pending_payment :
1800
+			case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') :
1801
+				$this->pending_registration($notify);
1802
+				break;
1803
+			case EEM_Registration::status_id_not_approved :
1804
+			case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') :
1805
+				$this->not_approve_registration($notify);
1806
+				break;
1807
+			case EEM_Registration::status_id_declined :
1808
+			case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') :
1809
+				$this->decline_registration($notify);
1810
+				break;
1811
+			case EEM_Registration::status_id_cancelled :
1812
+			case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') :
1813
+				$this->cancel_registration($notify);
1814
+				break;
1815
+			case EEM_Registration::status_id_wait_list :
1816
+			case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') :
1817
+				$this->waitlist_registration($notify);
1818
+				break;
1819
+			case EEM_Registration::status_id_incomplete :
1820
+			default :
1821
+				$result['success'] = false;
1822
+				unset($this->_req_data['return']);
1823
+				$this->_reg_status_change_return('', false);
1824
+				break;
1825
+		}
1826
+	}
1827
+
1828
+
1829
+	/**
1830
+	 * approve_registration
1831
+	 *
1832
+	 * @access protected
1833
+	 * @param bool $notify whether or not to notify the registrant about their approval.
1834
+	 * @return void
1835
+	 */
1836
+	protected function approve_registration($notify = false)
1837
+	{
1838
+		$this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
1839
+	}
1840
+
1841
+
1842
+	/**
1843
+	 *        decline_registration
1844
+	 *
1845
+	 * @access protected
1846
+	 * @param bool $notify whether or not to notify the registrant about their status change.
1847
+	 * @return void
1848
+	 */
1849
+	protected function decline_registration($notify = false)
1850
+	{
1851
+		$this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
1852
+	}
1853
+
1854
+
1855
+	/**
1856
+	 *        cancel_registration
1857
+	 *
1858
+	 * @access protected
1859
+	 * @param bool $notify whether or not to notify the registrant about their status change.
1860
+	 * @return void
1861
+	 */
1862
+	protected function cancel_registration($notify = false)
1863
+	{
1864
+		$this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
1865
+	}
1866
+
1867
+
1868
+	/**
1869
+	 *        not_approve_registration
1870
+	 *
1871
+	 * @access protected
1872
+	 * @param bool $notify whether or not to notify the registrant about their status change.
1873
+	 * @return void
1874
+	 */
1875
+	protected function not_approve_registration($notify = false)
1876
+	{
1877
+		$this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
1878
+	}
1879
+
1880
+
1881
+	/**
1882
+	 *        decline_registration
1883
+	 *
1884
+	 * @access protected
1885
+	 * @param bool $notify whether or not to notify the registrant about their status change.
1886
+	 * @return void
1887
+	 */
1888
+	protected function pending_registration($notify = false)
1889
+	{
1890
+		$this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
1891
+	}
1892
+
1893
+
1894
+	/**
1895
+	 * waitlist_registration
1896
+	 *
1897
+	 * @access protected
1898
+	 * @param bool $notify whether or not to notify the registrant about their status change.
1899
+	 * @return void
1900
+	 */
1901
+	protected function waitlist_registration($notify = false)
1902
+	{
1903
+		$this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
1904
+	}
1905
+
1906
+
1907
+	/**
1908
+	 *        generates HTML for the Registration main meta box
1909
+	 *
1910
+	 * @access public
1911
+	 * @return void
1912
+	 * @throws DomainException
1913
+	 * @throws EE_Error
1914
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1915
+	 */
1916
+	public function _reg_details_meta_box()
1917
+	{
1918
+		EEH_Autoloader::register_line_item_display_autoloaders();
1919
+		EEH_Autoloader::register_line_item_filter_autoloaders();
1920
+		EE_Registry::instance()->load_helper('Line_Item');
1921
+		$transaction    = $this->_registration->transaction() ? $this->_registration->transaction()
1922
+			: EE_Transaction::new_instance();
1923
+		$this->_session = $transaction->session_data();
1924
+		$filters        = new EE_Line_Item_Filter_Collection();
1925
+		//$filters->add( new EE_Non_Zero_Line_Item_Filter() );
1926
+		$filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
1927
+		$line_item_filter_processor              = new EE_Line_Item_Filter_Processor($filters,
1928
+			$transaction->total_line_item());
1929
+		$filtered_line_item_tree                 = $line_item_filter_processor->process();
1930
+		$line_item_display                       = new EE_Line_Item_Display('reg_admin_table',
1931
+			'EE_Admin_Table_Registration_Line_Item_Display_Strategy');
1932
+		$this->_template_args['line_item_table'] = $line_item_display->display_line_item(
1933
+			$filtered_line_item_tree,
1934
+			array('EE_Registration' => $this->_registration)
1935
+		);
1936
+		$attendee                                = $this->_registration->attendee();
1937
+		if (EE_Registry::instance()->CAP->current_user_can(
1938
+			'ee_read_transaction',
1939
+			'espresso_transactions_view_transaction'
1940
+		)) {
1941
+			$this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
1942
+				EE_Admin_Page::add_query_args_and_nonce(
1943
+					array(
1944
+						'action' => 'view_transaction',
1945
+						'TXN_ID' => $transaction->ID(),
1946
+					),
1947
+					TXN_ADMIN_URL
1948
+				),
1949
+				esc_html__(' View Transaction', 'event_espresso'),
1950
+				'button secondary-button right',
1951
+				'dashicons dashicons-cart'
1952
+			);
1953
+		} else {
1954
+			$this->_template_args['view_transaction_button'] = '';
1955
+		}
1956
+		if ($attendee instanceof EE_Attendee
1957
+			&& EE_Registry::instance()->CAP->current_user_can(
1958
+				'ee_send_message',
1959
+				'espresso_registrations_resend_registration'
1960
+			)
1961
+		) {
1962
+			$this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
1963
+				EE_Admin_Page::add_query_args_and_nonce(
1964
+					array(
1965
+						'action'      => 'resend_registration',
1966
+						'_REG_ID'     => $this->_registration->ID(),
1967
+						'redirect_to' => 'view_registration',
1968
+					),
1969
+					REG_ADMIN_URL
1970
+				),
1971
+				esc_html__(' Resend Registration', 'event_espresso'),
1972
+				'button secondary-button right',
1973
+				'dashicons dashicons-email-alt'
1974
+			);
1975
+		} else {
1976
+			$this->_template_args['resend_registration_button'] = '';
1977
+		}
1978
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
1979
+		$payment                               = $transaction->get_first_related('Payment');
1980
+		$payment                               = ! $payment instanceof EE_Payment
1981
+			? EE_Payment::new_instance()
1982
+			: $payment;
1983
+		$payment_method                        = $payment->get_first_related('Payment_Method');
1984
+		$payment_method                        = ! $payment_method instanceof EE_Payment_Method
1985
+			? EE_Payment_Method::new_instance()
1986
+			: $payment_method;
1987
+		$reg_details                           = array(
1988
+			'payment_method'       => $payment_method->name(),
1989
+			'response_msg'         => $payment->gateway_response(),
1990
+			'registration_id'      => $this->_registration->get('REG_code'),
1991
+			'registration_session' => $this->_registration->session_ID(),
1992
+			'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
1993
+			'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
1994
+		);
1995
+		if (isset($reg_details['registration_id'])) {
1996
+			$this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
1997
+			$this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
1998
+				'Registration ID',
1999
+				'event_espresso'
2000
+			);
2001
+			$this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
2002
+		}
2003
+		if (isset($reg_details['payment_method'])) {
2004
+			$this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
2005
+			$this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
2006
+				'Most Recent Payment Method',
2007
+				'event_espresso'
2008
+			);
2009
+			$this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
2010
+			$this->_template_args['reg_details']['response_msg']['value']   = $reg_details['response_msg'];
2011
+			$this->_template_args['reg_details']['response_msg']['label']   = esc_html__(
2012
+				'Payment method response',
2013
+				'event_espresso'
2014
+			);
2015
+			$this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
2016
+		}
2017
+		$this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
2018
+		$this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
2019
+			'Registration Session',
2020
+			'event_espresso'
2021
+		);
2022
+		$this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
2023
+		$this->_template_args['reg_details']['ip_address']['value']           = $reg_details['ip_address'];
2024
+		$this->_template_args['reg_details']['ip_address']['label']           = esc_html__(
2025
+			'Registration placed from IP',
2026
+			'event_espresso'
2027
+		);
2028
+		$this->_template_args['reg_details']['ip_address']['class']           = 'regular-text';
2029
+		$this->_template_args['reg_details']['user_agent']['value']           = $reg_details['user_agent'];
2030
+		$this->_template_args['reg_details']['user_agent']['label']           = esc_html__('Registrant User Agent',
2031
+			'event_espresso');
2032
+		$this->_template_args['reg_details']['user_agent']['class']           = 'large-text';
2033
+		$this->_template_args['event_link']                                   = EE_Admin_Page::add_query_args_and_nonce(
2034
+			array(
2035
+				'action'   => 'default',
2036
+				'event_id' => $this->_registration->event_ID(),
2037
+			),
2038
+			REG_ADMIN_URL
2039
+		);
2040
+		$this->_template_args['REG_ID']                                       = $this->_registration->ID();
2041
+		$this->_template_args['event_id']                                     = $this->_registration->event_ID();
2042
+		$template_path                                                        =
2043
+			REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
2044
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
2045
+	}
2046
+
2047
+
2048
+	/**
2049
+	 * generates HTML for the Registration Questions meta box.
2050
+	 * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
2051
+	 * otherwise uses new forms system
2052
+	 *
2053
+	 * @access public
2054
+	 * @return void
2055
+	 * @throws DomainException
2056
+	 * @throws EE_Error
2057
+	 */
2058
+	public function _reg_questions_meta_box()
2059
+	{
2060
+		//allow someone to override this method entirely
2061
+		if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this,
2062
+			$this->_registration)) {
2063
+			$form                                              = $this->_get_reg_custom_questions_form(
2064
+				$this->_registration->ID()
2065
+			);
2066
+			$this->_template_args['att_questions']             = count($form->subforms()) > 0
2067
+				? $form->get_html_and_js()
2068
+				: '';
2069
+			$this->_template_args['reg_questions_form_action'] = 'edit_registration';
2070
+			$this->_template_args['REG_ID']                    = $this->_registration->ID();
2071
+			$template_path                                     =
2072
+				REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
2073
+			echo EEH_Template::display_template($template_path, $this->_template_args, true);
2074
+		}
2075
+	}
2076
+
2077
+
2078
+	/**
2079
+	 * form_before_question_group
2080
+	 *
2081
+	 * @deprecated    as of 4.8.32.rc.000
2082
+	 * @access        public
2083
+	 * @param        string $output
2084
+	 * @return        string
2085
+	 */
2086
+	public function form_before_question_group($output)
2087
+	{
2088
+		EE_Error::doing_it_wrong(
2089
+			__CLASS__ . '::' . __FUNCTION__,
2090
+			esc_html__(
2091
+				'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.',
2092
+				'event_espresso'
2093
+			),
2094
+			'4.8.32.rc.000'
2095
+		);
2096
+		return '
2097 2097
 	<table class="form-table ee-width-100">
2098 2098
 		<tbody>
2099 2099
 			';
2100
-    }
2101
-
2102
-
2103
-    /**
2104
-     * form_after_question_group
2105
-     *
2106
-     * @deprecated    as of 4.8.32.rc.000
2107
-     * @access        public
2108
-     * @param        string $output
2109
-     * @return        string
2110
-     */
2111
-    public function form_after_question_group($output)
2112
-    {
2113
-        EE_Error::doing_it_wrong(
2114
-            __CLASS__ . '::' . __FUNCTION__,
2115
-            esc_html__(
2116
-                '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.',
2117
-                'event_espresso'
2118
-            ),
2119
-            '4.8.32.rc.000'
2120
-        );
2121
-        return '
2100
+	}
2101
+
2102
+
2103
+	/**
2104
+	 * form_after_question_group
2105
+	 *
2106
+	 * @deprecated    as of 4.8.32.rc.000
2107
+	 * @access        public
2108
+	 * @param        string $output
2109
+	 * @return        string
2110
+	 */
2111
+	public function form_after_question_group($output)
2112
+	{
2113
+		EE_Error::doing_it_wrong(
2114
+			__CLASS__ . '::' . __FUNCTION__,
2115
+			esc_html__(
2116
+				'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.',
2117
+				'event_espresso'
2118
+			),
2119
+			'4.8.32.rc.000'
2120
+		);
2121
+		return '
2122 2122
 			<tr class="hide-if-no-js">
2123 2123
 				<th> </th>
2124 2124
 				<td class="reg-admin-edit-attendee-question-td">
2125 2125
 					<a class="reg-admin-edit-attendee-question-lnk" href="#" title="'
2126
-               . esc_attr__('click to edit question', 'event_espresso')
2127
-               . '">
2126
+			   . esc_attr__('click to edit question', 'event_espresso')
2127
+			   . '">
2128 2128
 						<span class="reg-admin-edit-question-group-spn lt-grey-txt">'
2129
-               . esc_html__('edit the above question group', 'event_espresso')
2130
-               . '</span>
2129
+			   . esc_html__('edit the above question group', 'event_espresso')
2130
+			   . '</span>
2131 2131
 						<div class="dashicons dashicons-edit"></div>
2132 2132
 					</a>
2133 2133
 				</td>
@@ -2135,558 +2135,558 @@  discard block
 block discarded – undo
2135 2135
 		</tbody>
2136 2136
 	</table>
2137 2137
 ';
2138
-    }
2139
-
2140
-
2141
-    /**
2142
-     * form_form_field_label_wrap
2143
-     *
2144
-     * @deprecated    as of 4.8.32.rc.000
2145
-     * @access        public
2146
-     * @param        string $label
2147
-     * @return        string
2148
-     */
2149
-    public function form_form_field_label_wrap($label)
2150
-    {
2151
-        EE_Error::doing_it_wrong(
2152
-            __CLASS__ . '::' . __FUNCTION__,
2153
-            esc_html__(
2154
-                '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.',
2155
-                'event_espresso'
2156
-            ),
2157
-            '4.8.32.rc.000'
2158
-        );
2159
-        return '
2138
+	}
2139
+
2140
+
2141
+	/**
2142
+	 * form_form_field_label_wrap
2143
+	 *
2144
+	 * @deprecated    as of 4.8.32.rc.000
2145
+	 * @access        public
2146
+	 * @param        string $label
2147
+	 * @return        string
2148
+	 */
2149
+	public function form_form_field_label_wrap($label)
2150
+	{
2151
+		EE_Error::doing_it_wrong(
2152
+			__CLASS__ . '::' . __FUNCTION__,
2153
+			esc_html__(
2154
+				'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.',
2155
+				'event_espresso'
2156
+			),
2157
+			'4.8.32.rc.000'
2158
+		);
2159
+		return '
2160 2160
 			<tr>
2161 2161
 				<th>
2162 2162
 					' . $label . '
2163 2163
 				</th>';
2164
-    }
2165
-
2166
-
2167
-    /**
2168
-     * form_form_field_input__wrap
2169
-     *
2170
-     * @deprecated    as of 4.8.32.rc.000
2171
-     * @access        public
2172
-     * @param        string $input
2173
-     * @return        string
2174
-     */
2175
-    public function form_form_field_input__wrap($input)
2176
-    {
2177
-        EE_Error::doing_it_wrong(
2178
-            __CLASS__ . '::' . __FUNCTION__,
2179
-            esc_html__(
2180
-                '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.',
2181
-                'event_espresso'
2182
-            ),
2183
-            '4.8.32.rc.000'
2184
-        );
2185
-        return '
2164
+	}
2165
+
2166
+
2167
+	/**
2168
+	 * form_form_field_input__wrap
2169
+	 *
2170
+	 * @deprecated    as of 4.8.32.rc.000
2171
+	 * @access        public
2172
+	 * @param        string $input
2173
+	 * @return        string
2174
+	 */
2175
+	public function form_form_field_input__wrap($input)
2176
+	{
2177
+		EE_Error::doing_it_wrong(
2178
+			__CLASS__ . '::' . __FUNCTION__,
2179
+			esc_html__(
2180
+				'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.',
2181
+				'event_espresso'
2182
+			),
2183
+			'4.8.32.rc.000'
2184
+		);
2185
+		return '
2186 2186
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
2187 2187
 					' . $input . '
2188 2188
 				</td>
2189 2189
 			</tr>';
2190
-    }
2191
-
2192
-
2193
-    /**
2194
-     * Updates the registration's custom questions according to the form info, if the form is submitted.
2195
-     * If it's not a post, the "view_registrations" route will be called next on the SAME request
2196
-     * to display the page
2197
-     *
2198
-     * @access protected
2199
-     * @return void
2200
-     * @throws EE_Error
2201
-     */
2202
-    protected function _update_attendee_registration_form()
2203
-    {
2204
-        do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
2205
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
2206
-            $REG_ID  = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
2207
-            $success = $this->_save_reg_custom_questions_form($REG_ID);
2208
-            if ($success) {
2209
-                $what  = esc_html__('Registration Form', 'event_espresso');
2210
-                $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
2211
-                    : array('action' => 'default');
2212
-                $this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
2213
-            }
2214
-        }
2215
-    }
2216
-
2217
-
2218
-    /**
2219
-     * Gets the form for saving registrations custom questions (if done
2220
-     * previously retrieves the cached form object, which may have validation errors in it)
2221
-     *
2222
-     * @param int $REG_ID
2223
-     * @return EE_Registration_Custom_Questions_Form
2224
-     * @throws EE_Error
2225
-     */
2226
-    protected function _get_reg_custom_questions_form($REG_ID)
2227
-    {
2228
-        if ( ! $this->_reg_custom_questions_form) {
2229
-            require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
2230
-            $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
2231
-                EEM_Registration::instance()->get_one_by_ID($REG_ID)
2232
-            );
2233
-            $this->_reg_custom_questions_form->_construct_finalize(null, null);
2234
-        }
2235
-        return $this->_reg_custom_questions_form;
2236
-    }
2237
-
2238
-
2239
-    /**
2240
-     * Saves
2241
-     *
2242
-     * @access private
2243
-     * @param bool $REG_ID
2244
-     * @return bool
2245
-     * @throws EE_Error
2246
-     */
2247
-    private function _save_reg_custom_questions_form($REG_ID = false)
2248
-    {
2249
-        if ( ! $REG_ID) {
2250
-            EE_Error::add_error(
2251
-                esc_html__(
2252
-                    'An error occurred. No registration ID was received.', 'event_espresso'),
2253
-                __FILE__, __FUNCTION__, __LINE__
2254
-            );
2255
-        }
2256
-        $form = $this->_get_reg_custom_questions_form($REG_ID);
2257
-        $form->receive_form_submission($this->_req_data);
2258
-        $success = false;
2259
-        if ($form->is_valid()) {
2260
-            foreach ($form->subforms() as $question_group_id => $question_group_form) {
2261
-                foreach ($question_group_form->inputs() as $question_id => $input) {
2262
-                    $where_conditions    = array(
2263
-                        'QST_ID' => $question_id,
2264
-                        'REG_ID' => $REG_ID,
2265
-                    );
2266
-                    $possibly_new_values = array(
2267
-                        'ANS_value' => $input->normalized_value(),
2268
-                    );
2269
-                    $answer              = EEM_Answer::instance()->get_one(array($where_conditions));
2270
-                    if ($answer instanceof EE_Answer) {
2271
-                        $success = $answer->save($possibly_new_values);
2272
-                    } else {
2273
-                        //insert it then
2274
-                        $cols_n_vals = array_merge($where_conditions, $possibly_new_values);
2275
-                        $answer      = EE_Answer::new_instance($cols_n_vals);
2276
-                        $success     = $answer->save();
2277
-                    }
2278
-                }
2279
-            }
2280
-        } else {
2281
-            EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
2282
-        }
2283
-        return $success;
2284
-    }
2285
-
2286
-
2287
-    /**
2288
-     *        generates HTML for the Registration main meta box
2289
-     *
2290
-     * @access public
2291
-     * @return void
2292
-     * @throws DomainException
2293
-     * @throws EE_Error
2294
-     */
2295
-    public function _reg_attendees_meta_box()
2296
-    {
2297
-        $REG = EEM_Registration::instance();
2298
-        //get all other registrations on this transaction, and cache
2299
-        //the attendees for them so we don't have to run another query using force_join
2300
-        $registrations                           = $REG->get_all(array(
2301
-            array(
2302
-                'TXN_ID' => $this->_registration->transaction_ID(),
2303
-                'REG_ID' => array('!=', $this->_registration->ID()),
2304
-            ),
2305
-            'force_join' => array('Attendee'),
2306
-        ));
2307
-        $this->_template_args['attendees']       = array();
2308
-        $this->_template_args['attendee_notice'] = '';
2309
-        if (empty($registrations)
2310
-            || (is_array($registrations)
2311
-                && ! EEH_Array::get_one_item_from_array($registrations))
2312
-        ) {
2313
-            EE_Error::add_error(
2314
-                esc_html__(
2315
-                    'There are no records attached to this registration. Something may have gone wrong with the registration',
2316
-                    'event_espresso'
2317
-                ), __FILE__, __FUNCTION__, __LINE__
2318
-            );
2319
-            $this->_template_args['attendee_notice'] = EE_Error::get_notices();
2320
-        } else {
2321
-            $att_nmbr = 1;
2322
-            foreach ($registrations as $registration) {
2323
-                /* @var $registration EE_Registration */
2324
-                $attendee                                                    = $registration->attendee()
2325
-                    ? $registration->attendee()
2326
-                    : EEM_Attendee::instance()
2327
-                                  ->create_default_object();
2328
-                $this->_template_args['attendees'][$att_nmbr]['STS_ID']      = $registration->status_ID();
2329
-                $this->_template_args['attendees'][$att_nmbr]['fname']       = $attendee->fname();
2330
-                $this->_template_args['attendees'][$att_nmbr]['lname']       = $attendee->lname();
2331
-                $this->_template_args['attendees'][$att_nmbr]['email']       = $attendee->email();
2332
-                $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();
2333
-                $this->_template_args['attendees'][$att_nmbr]['address']     = implode(
2334
-                    ', ',
2335
-                    $attendee->full_address_as_array()
2336
-                );
2337
-                $this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
2338
-                    array(
2339
-                        'action' => 'edit_attendee',
2340
-                        'post'   => $attendee->ID(),
2341
-                    ),
2342
-                    REG_ADMIN_URL
2343
-                );
2344
-                $this->_template_args['attendees'][$att_nmbr]['event_name']  = $registration->event_obj()->name();
2345
-                $att_nmbr++;
2346
-            }
2347
-            $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
2348
-        }
2349
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
2350
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
2351
-    }
2352
-
2353
-
2354
-    /**
2355
-     *        generates HTML for the Edit Registration side meta box
2356
-     *
2357
-     * @access public
2358
-     * @return void
2359
-     * @throws DomainException
2360
-     * @throws EE_Error
2361
-     */
2362
-    public function _reg_registrant_side_meta_box()
2363
-    {
2364
-        /*@var $attendee EE_Attendee */
2365
-        $att_check = $this->_registration->attendee();
2366
-        $attendee  = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
2367
-        //now let's determine if this is not the primary registration.  If it isn't then we set the
2368
-        //primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
2369
-        //primary registration object (that way we know if we need to show create button or not)
2370
-        if ( ! $this->_registration->is_primary_registrant()) {
2371
-            $primary_registration = $this->_registration->get_primary_registration();
2372
-            $primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
2373
-                : null;
2374
-            if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
2375
-                //in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
2376
-                //custom attendee object so let's not worry about the primary reg.
2377
-                $primary_registration = null;
2378
-            }
2379
-        } else {
2380
-            $primary_registration = null;
2381
-        }
2382
-        $this->_template_args['ATT_ID']            = $attendee->ID();
2383
-        $this->_template_args['fname']             = $attendee->fname();
2384
-        $this->_template_args['lname']             = $attendee->lname();
2385
-        $this->_template_args['email']             = $attendee->email();
2386
-        $this->_template_args['phone']             = $attendee->phone();
2387
-        $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
2388
-        //edit link
2389
-        $this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(array(
2390
-            'action' => 'edit_attendee',
2391
-            'post'   => $attendee->ID(),
2392
-        ), REG_ADMIN_URL);
2393
-        $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
2394
-        //create link
2395
-        $this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
2396
-            ? EE_Admin_Page::add_query_args_and_nonce(array(
2397
-                'action'  => 'duplicate_attendee',
2398
-                '_REG_ID' => $this->_registration->ID(),
2399
-            ), REG_ADMIN_URL) : '';
2400
-        $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
2401
-        $this->_template_args['att_check']    = $att_check;
2402
-        $template_path                        = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
2403
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
2404
-    }
2405
-
2406
-
2407
-    /**
2408
-     * trash or restore registrations
2409
-     *
2410
-     * @param  boolean $trash whether to archive or restore
2411
-     * @return void
2412
-     * @throws EE_Error
2413
-     * @throws RuntimeException
2414
-     * @access protected
2415
-     */
2416
-    protected function _trash_or_restore_registrations($trash = true)
2417
-    {
2418
-        //if empty _REG_ID then get out because there's nothing to do
2419
-        if (empty($this->_req_data['_REG_ID'])) {
2420
-            EE_Error::add_error(
2421
-                sprintf(
2422
-                    esc_html__(
2423
-                        'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
2424
-                        'event_espresso'
2425
-                    ),
2426
-                    $trash ? 'trash' : 'restore'
2427
-                ),
2428
-                __FILE__, __LINE__, __FUNCTION__
2429
-            );
2430
-            $this->_redirect_after_action(false, '', '', array(), true);
2431
-        }
2432
-        $success = 0;
2433
-        $overwrite_msgs = false;
2434
-        //Checkboxes
2435
-        if ( ! is_array($this->_req_data['_REG_ID'])) {
2436
-            $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
2437
-        }
2438
-        $reg_count = count($this->_req_data['_REG_ID']);
2439
-        // cycle thru checkboxes
2440
-        foreach ($this->_req_data['_REG_ID'] as $REG_ID) {
2441
-            /** @var EE_Registration $REG */
2442
-            $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
2443
-            $payments = $REG->registration_payments();
2444
-            if (! empty($payments)) {
2445
-                $name = $REG->attendee() instanceof EE_Attendee
2446
-                    ? $REG->attendee()->full_name()
2447
-                    : esc_html__('Unknown Attendee', 'event_espresso');
2448
-                $overwrite_msgs = true;
2449
-                EE_Error::add_error(
2450
-                    sprintf(
2451
-                        esc_html__(
2452
-                            '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.',
2453
-                            'event_espresso'
2454
-                        ),
2455
-                        $name
2456
-                    ),
2457
-                    __FILE__, __FUNCTION__, __LINE__
2458
-                );
2459
-                //can't trash this registration because it has payments.
2460
-                continue;
2461
-            }
2462
-            $updated = $trash ? $REG->delete() : $REG->restore();
2463
-            if ($updated) {
2464
-                $success++;
2465
-            }
2466
-        }
2467
-        $this->_redirect_after_action(
2468
-            $success === $reg_count, // were ALL registrations affected?
2469
-            $success > 1
2470
-                ? esc_html__('Registrations', 'event_espresso')
2471
-                : esc_html__('Registration', 'event_espresso'),
2472
-            $trash
2473
-                ? esc_html__('moved to the trash', 'event_espresso')
2474
-                : esc_html__('restored', 'event_espresso'),
2475
-            array('action' => 'default'),
2476
-            $overwrite_msgs
2477
-        );
2478
-    }
2479
-
2480
-
2481
-    /**
2482
-     * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
2483
-     * registration but also.
2484
-     * 1. Removing relations to EE_Attendee
2485
-     * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
2486
-     * ALSO trashed.
2487
-     * 3. Deleting permanently any related Line items but only if the above conditions are met.
2488
-     * 4. Removing relationships between all tickets and the related registrations
2489
-     * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
2490
-     * 6. Deleting permanently any related Checkins.
2491
-     *
2492
-     * @return void
2493
-     * @throws EE_Error
2494
-     */
2495
-    protected function _delete_registrations()
2496
-    {
2497
-        $REG_MDL = EEM_Registration::instance();
2498
-        $success = 1;
2499
-        //Checkboxes
2500
-        if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
2501
-            // if array has more than one element than success message should be plural
2502
-            $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
2503
-            // cycle thru checkboxes
2504
-            while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
2505
-                $REG = $REG_MDL->get_one_by_ID($REG_ID);
2506
-                if ( ! $REG instanceof EE_Registration) {
2507
-                    continue;
2508
-                }
2509
-                $deleted = $this->_delete_registration($REG);
2510
-                if ( ! $deleted) {
2511
-                    $success = 0;
2512
-                }
2513
-            }
2514
-        } else {
2515
-            // grab single id and delete
2516
-            $REG_ID  = $this->_req_data['_REG_ID'];
2517
-            $REG     = $REG_MDL->get_one_by_ID($REG_ID);
2518
-            $deleted = $this->_delete_registration($REG);
2519
-            if ( ! $deleted) {
2520
-                $success = 0;
2521
-            }
2522
-        }
2523
-        $what        = $success > 1
2524
-            ? esc_html__('Registrations', 'event_espresso')
2525
-            : esc_html__('Registration', 'event_espresso');
2526
-        $action_desc = esc_html__('permanently deleted.', 'event_espresso');
2527
-        $this->_redirect_after_action(
2528
-            $success,
2529
-            $what,
2530
-            $action_desc,
2531
-            array('action' => 'default'),
2532
-            true
2533
-        );
2534
-    }
2535
-
2536
-
2537
-    /**
2538
-     * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
2539
-     * models get affected.
2540
-     *
2541
-     * @param  EE_Registration $REG registration to be deleted permenantly
2542
-     * @return bool true = successful deletion, false = fail.
2543
-     * @throws EE_Error
2544
-     */
2545
-    protected function _delete_registration(EE_Registration $REG)
2546
-    {
2547
-        //first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
2548
-        //registrations on the transaction that are NOT trashed.
2549
-        $TXN         = $REG->get_first_related('Transaction');
2550
-        $REGS        = $TXN->get_many_related('Registration');
2551
-        $all_trashed = true;
2552
-        foreach ($REGS as $registration) {
2553
-            if ( ! $registration->get('REG_deleted')) {
2554
-                $all_trashed = false;
2555
-            }
2556
-        }
2557
-        if ( ! $all_trashed) {
2558
-            EE_Error::add_error(
2559
-                esc_html__(
2560
-                    '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.',
2561
-                    'event_espresso'
2562
-                ),
2563
-                __FILE__, __FUNCTION__, __LINE__
2564
-            );
2565
-            return false;
2566
-        }
2567
-        //k made it here so that means we can delete all the related transactions and their answers (but let's do them
2568
-        //separately from THIS one).
2569
-        foreach ($REGS as $registration) {
2570
-            //delete related answers
2571
-            $registration->delete_related_permanently('Answer');
2572
-            //remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
2573
-            $attendee = $registration->get_first_related('Attendee');
2574
-            if ($attendee instanceof EE_Attendee) {
2575
-                $registration->_remove_relation_to($attendee, 'Attendee');
2576
-            }
2577
-            //now remove relationships to tickets on this registration.
2578
-            $registration->_remove_relations('Ticket');
2579
-            //now delete permanently the checkins related to this registration.
2580
-            $registration->delete_related_permanently('Checkin');
2581
-            if ($registration->ID() === $REG->ID()) {
2582
-                continue;
2583
-            } //we don't want to delete permanently the existing registration just yet.
2584
-            //remove relation to transaction for these registrations if NOT the existing registrations
2585
-            $registration->_remove_relations('Transaction');
2586
-            //delete permanently any related messages.
2587
-            $registration->delete_related_permanently('Message');
2588
-            //now delete this registration permanently
2589
-            $registration->delete_permanently();
2590
-        }
2591
-        //now all related registrations on the transaction are handled.  So let's just handle this registration itself
2592
-        // (the transaction and line items should be all that's left).
2593
-        // delete the line items related to the transaction for this registration.
2594
-        $TXN->delete_related_permanently('Line_Item');
2595
-        //we need to remove all the relationships on the transaction
2596
-        $TXN->delete_related_permanently('Payment');
2597
-        $TXN->delete_related_permanently('Extra_Meta');
2598
-        $TXN->delete_related_permanently('Message');
2599
-        //now we can delete this REG permanently (and the transaction of course)
2600
-        $REG->delete_related_permanently('Transaction');
2601
-        return $REG->delete_permanently();
2602
-    }
2603
-
2604
-
2605
-    /**
2606
-     *    generates HTML for the Register New Attendee Admin page
2607
-     *
2608
-     * @access private
2609
-     * @throws DomainException
2610
-     * @throws EE_Error
2611
-     */
2612
-    public function new_registration()
2613
-    {
2614
-        if ( ! $this->_set_reg_event()) {
2615
-            throw new EE_Error(
2616
-                esc_html__(
2617
-                    'Unable to continue with registering because there is no Event ID in the request',
2618
-                    'event_espresso'
2619
-                )
2620
-            );
2621
-        }
2622
-        EE_Registry::instance()->REQ->set_espresso_page(true);
2623
-        // gotta start with a clean slate if we're not coming here via ajax
2624
-        if ( ! defined('DOING_AJAX')
2625
-             && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
2626
-        ) {
2627
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2628
-        }
2629
-        $this->_template_args['event_name'] = '';
2630
-        // event name
2631
-        if ($this->_reg_event) {
2632
-            $this->_template_args['event_name'] = $this->_reg_event->name();
2633
-            $edit_event_url                     = self::add_query_args_and_nonce(array(
2634
-                'action' => 'edit',
2635
-                'post'   => $this->_reg_event->ID(),
2636
-            ), EVENTS_ADMIN_URL);
2637
-            $edit_event_lnk                     = '<a href="'
2638
-                                                  . $edit_event_url
2639
-                                                  . '" title="'
2640
-                                                  . esc_attr__('Edit ', 'event_espresso')
2641
-                                                  . $this->_reg_event->name()
2642
-                                                  . '">'
2643
-                                                  . esc_html__('Edit Event', 'event_espresso')
2644
-                                                  . '</a>';
2645
-            $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
2646
-                                                   . $edit_event_lnk
2647
-                                                   . '</span>';
2648
-        }
2649
-        $this->_template_args['step_content'] = $this->_get_registration_step_content();
2650
-        if (defined('DOING_AJAX')) {
2651
-            $this->_return_json();
2652
-        }
2653
-        // grab header
2654
-        $template_path                              =
2655
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
2656
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
2657
-            $this->_template_args, true);
2658
-        //$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
2659
-        // the details template wrapper
2660
-        $this->display_admin_page_with_sidebar();
2661
-    }
2662
-
2663
-
2664
-    /**
2665
-     * This returns the content for a registration step
2666
-     *
2667
-     * @access protected
2668
-     * @return string html
2669
-     * @throws DomainException
2670
-     * @throws EE_Error
2671
-     */
2672
-    protected function _get_registration_step_content()
2673
-    {
2674
-        if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
2675
-            $warning_msg = sprintf(
2676
-                esc_html__(
2677
-                    '%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',
2678
-                    'event_espresso'
2679
-                ),
2680
-                '<br />',
2681
-                '<h3 class="important-notice">',
2682
-                '</h3>',
2683
-                '<div class="float-right">',
2684
-                '<span id="redirect_timer" class="important-notice">30</span>',
2685
-                '</div>',
2686
-                '<b>',
2687
-                '</b>'
2688
-            );
2689
-            return '
2190
+	}
2191
+
2192
+
2193
+	/**
2194
+	 * Updates the registration's custom questions according to the form info, if the form is submitted.
2195
+	 * If it's not a post, the "view_registrations" route will be called next on the SAME request
2196
+	 * to display the page
2197
+	 *
2198
+	 * @access protected
2199
+	 * @return void
2200
+	 * @throws EE_Error
2201
+	 */
2202
+	protected function _update_attendee_registration_form()
2203
+	{
2204
+		do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
2205
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
2206
+			$REG_ID  = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
2207
+			$success = $this->_save_reg_custom_questions_form($REG_ID);
2208
+			if ($success) {
2209
+				$what  = esc_html__('Registration Form', 'event_espresso');
2210
+				$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
2211
+					: array('action' => 'default');
2212
+				$this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
2213
+			}
2214
+		}
2215
+	}
2216
+
2217
+
2218
+	/**
2219
+	 * Gets the form for saving registrations custom questions (if done
2220
+	 * previously retrieves the cached form object, which may have validation errors in it)
2221
+	 *
2222
+	 * @param int $REG_ID
2223
+	 * @return EE_Registration_Custom_Questions_Form
2224
+	 * @throws EE_Error
2225
+	 */
2226
+	protected function _get_reg_custom_questions_form($REG_ID)
2227
+	{
2228
+		if ( ! $this->_reg_custom_questions_form) {
2229
+			require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
2230
+			$this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
2231
+				EEM_Registration::instance()->get_one_by_ID($REG_ID)
2232
+			);
2233
+			$this->_reg_custom_questions_form->_construct_finalize(null, null);
2234
+		}
2235
+		return $this->_reg_custom_questions_form;
2236
+	}
2237
+
2238
+
2239
+	/**
2240
+	 * Saves
2241
+	 *
2242
+	 * @access private
2243
+	 * @param bool $REG_ID
2244
+	 * @return bool
2245
+	 * @throws EE_Error
2246
+	 */
2247
+	private function _save_reg_custom_questions_form($REG_ID = false)
2248
+	{
2249
+		if ( ! $REG_ID) {
2250
+			EE_Error::add_error(
2251
+				esc_html__(
2252
+					'An error occurred. No registration ID was received.', 'event_espresso'),
2253
+				__FILE__, __FUNCTION__, __LINE__
2254
+			);
2255
+		}
2256
+		$form = $this->_get_reg_custom_questions_form($REG_ID);
2257
+		$form->receive_form_submission($this->_req_data);
2258
+		$success = false;
2259
+		if ($form->is_valid()) {
2260
+			foreach ($form->subforms() as $question_group_id => $question_group_form) {
2261
+				foreach ($question_group_form->inputs() as $question_id => $input) {
2262
+					$where_conditions    = array(
2263
+						'QST_ID' => $question_id,
2264
+						'REG_ID' => $REG_ID,
2265
+					);
2266
+					$possibly_new_values = array(
2267
+						'ANS_value' => $input->normalized_value(),
2268
+					);
2269
+					$answer              = EEM_Answer::instance()->get_one(array($where_conditions));
2270
+					if ($answer instanceof EE_Answer) {
2271
+						$success = $answer->save($possibly_new_values);
2272
+					} else {
2273
+						//insert it then
2274
+						$cols_n_vals = array_merge($where_conditions, $possibly_new_values);
2275
+						$answer      = EE_Answer::new_instance($cols_n_vals);
2276
+						$success     = $answer->save();
2277
+					}
2278
+				}
2279
+			}
2280
+		} else {
2281
+			EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
2282
+		}
2283
+		return $success;
2284
+	}
2285
+
2286
+
2287
+	/**
2288
+	 *        generates HTML for the Registration main meta box
2289
+	 *
2290
+	 * @access public
2291
+	 * @return void
2292
+	 * @throws DomainException
2293
+	 * @throws EE_Error
2294
+	 */
2295
+	public function _reg_attendees_meta_box()
2296
+	{
2297
+		$REG = EEM_Registration::instance();
2298
+		//get all other registrations on this transaction, and cache
2299
+		//the attendees for them so we don't have to run another query using force_join
2300
+		$registrations                           = $REG->get_all(array(
2301
+			array(
2302
+				'TXN_ID' => $this->_registration->transaction_ID(),
2303
+				'REG_ID' => array('!=', $this->_registration->ID()),
2304
+			),
2305
+			'force_join' => array('Attendee'),
2306
+		));
2307
+		$this->_template_args['attendees']       = array();
2308
+		$this->_template_args['attendee_notice'] = '';
2309
+		if (empty($registrations)
2310
+			|| (is_array($registrations)
2311
+				&& ! EEH_Array::get_one_item_from_array($registrations))
2312
+		) {
2313
+			EE_Error::add_error(
2314
+				esc_html__(
2315
+					'There are no records attached to this registration. Something may have gone wrong with the registration',
2316
+					'event_espresso'
2317
+				), __FILE__, __FUNCTION__, __LINE__
2318
+			);
2319
+			$this->_template_args['attendee_notice'] = EE_Error::get_notices();
2320
+		} else {
2321
+			$att_nmbr = 1;
2322
+			foreach ($registrations as $registration) {
2323
+				/* @var $registration EE_Registration */
2324
+				$attendee                                                    = $registration->attendee()
2325
+					? $registration->attendee()
2326
+					: EEM_Attendee::instance()
2327
+								  ->create_default_object();
2328
+				$this->_template_args['attendees'][$att_nmbr]['STS_ID']      = $registration->status_ID();
2329
+				$this->_template_args['attendees'][$att_nmbr]['fname']       = $attendee->fname();
2330
+				$this->_template_args['attendees'][$att_nmbr]['lname']       = $attendee->lname();
2331
+				$this->_template_args['attendees'][$att_nmbr]['email']       = $attendee->email();
2332
+				$this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();
2333
+				$this->_template_args['attendees'][$att_nmbr]['address']     = implode(
2334
+					', ',
2335
+					$attendee->full_address_as_array()
2336
+				);
2337
+				$this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
2338
+					array(
2339
+						'action' => 'edit_attendee',
2340
+						'post'   => $attendee->ID(),
2341
+					),
2342
+					REG_ADMIN_URL
2343
+				);
2344
+				$this->_template_args['attendees'][$att_nmbr]['event_name']  = $registration->event_obj()->name();
2345
+				$att_nmbr++;
2346
+			}
2347
+			$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
2348
+		}
2349
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
2350
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
2351
+	}
2352
+
2353
+
2354
+	/**
2355
+	 *        generates HTML for the Edit Registration side meta box
2356
+	 *
2357
+	 * @access public
2358
+	 * @return void
2359
+	 * @throws DomainException
2360
+	 * @throws EE_Error
2361
+	 */
2362
+	public function _reg_registrant_side_meta_box()
2363
+	{
2364
+		/*@var $attendee EE_Attendee */
2365
+		$att_check = $this->_registration->attendee();
2366
+		$attendee  = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
2367
+		//now let's determine if this is not the primary registration.  If it isn't then we set the
2368
+		//primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
2369
+		//primary registration object (that way we know if we need to show create button or not)
2370
+		if ( ! $this->_registration->is_primary_registrant()) {
2371
+			$primary_registration = $this->_registration->get_primary_registration();
2372
+			$primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
2373
+				: null;
2374
+			if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
2375
+				//in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
2376
+				//custom attendee object so let's not worry about the primary reg.
2377
+				$primary_registration = null;
2378
+			}
2379
+		} else {
2380
+			$primary_registration = null;
2381
+		}
2382
+		$this->_template_args['ATT_ID']            = $attendee->ID();
2383
+		$this->_template_args['fname']             = $attendee->fname();
2384
+		$this->_template_args['lname']             = $attendee->lname();
2385
+		$this->_template_args['email']             = $attendee->email();
2386
+		$this->_template_args['phone']             = $attendee->phone();
2387
+		$this->_template_args['formatted_address'] = EEH_Address::format($attendee);
2388
+		//edit link
2389
+		$this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(array(
2390
+			'action' => 'edit_attendee',
2391
+			'post'   => $attendee->ID(),
2392
+		), REG_ADMIN_URL);
2393
+		$this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
2394
+		//create link
2395
+		$this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
2396
+			? EE_Admin_Page::add_query_args_and_nonce(array(
2397
+				'action'  => 'duplicate_attendee',
2398
+				'_REG_ID' => $this->_registration->ID(),
2399
+			), REG_ADMIN_URL) : '';
2400
+		$this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
2401
+		$this->_template_args['att_check']    = $att_check;
2402
+		$template_path                        = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
2403
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
2404
+	}
2405
+
2406
+
2407
+	/**
2408
+	 * trash or restore registrations
2409
+	 *
2410
+	 * @param  boolean $trash whether to archive or restore
2411
+	 * @return void
2412
+	 * @throws EE_Error
2413
+	 * @throws RuntimeException
2414
+	 * @access protected
2415
+	 */
2416
+	protected function _trash_or_restore_registrations($trash = true)
2417
+	{
2418
+		//if empty _REG_ID then get out because there's nothing to do
2419
+		if (empty($this->_req_data['_REG_ID'])) {
2420
+			EE_Error::add_error(
2421
+				sprintf(
2422
+					esc_html__(
2423
+						'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
2424
+						'event_espresso'
2425
+					),
2426
+					$trash ? 'trash' : 'restore'
2427
+				),
2428
+				__FILE__, __LINE__, __FUNCTION__
2429
+			);
2430
+			$this->_redirect_after_action(false, '', '', array(), true);
2431
+		}
2432
+		$success = 0;
2433
+		$overwrite_msgs = false;
2434
+		//Checkboxes
2435
+		if ( ! is_array($this->_req_data['_REG_ID'])) {
2436
+			$this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
2437
+		}
2438
+		$reg_count = count($this->_req_data['_REG_ID']);
2439
+		// cycle thru checkboxes
2440
+		foreach ($this->_req_data['_REG_ID'] as $REG_ID) {
2441
+			/** @var EE_Registration $REG */
2442
+			$REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
2443
+			$payments = $REG->registration_payments();
2444
+			if (! empty($payments)) {
2445
+				$name = $REG->attendee() instanceof EE_Attendee
2446
+					? $REG->attendee()->full_name()
2447
+					: esc_html__('Unknown Attendee', 'event_espresso');
2448
+				$overwrite_msgs = true;
2449
+				EE_Error::add_error(
2450
+					sprintf(
2451
+						esc_html__(
2452
+							'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.',
2453
+							'event_espresso'
2454
+						),
2455
+						$name
2456
+					),
2457
+					__FILE__, __FUNCTION__, __LINE__
2458
+				);
2459
+				//can't trash this registration because it has payments.
2460
+				continue;
2461
+			}
2462
+			$updated = $trash ? $REG->delete() : $REG->restore();
2463
+			if ($updated) {
2464
+				$success++;
2465
+			}
2466
+		}
2467
+		$this->_redirect_after_action(
2468
+			$success === $reg_count, // were ALL registrations affected?
2469
+			$success > 1
2470
+				? esc_html__('Registrations', 'event_espresso')
2471
+				: esc_html__('Registration', 'event_espresso'),
2472
+			$trash
2473
+				? esc_html__('moved to the trash', 'event_espresso')
2474
+				: esc_html__('restored', 'event_espresso'),
2475
+			array('action' => 'default'),
2476
+			$overwrite_msgs
2477
+		);
2478
+	}
2479
+
2480
+
2481
+	/**
2482
+	 * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
2483
+	 * registration but also.
2484
+	 * 1. Removing relations to EE_Attendee
2485
+	 * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
2486
+	 * ALSO trashed.
2487
+	 * 3. Deleting permanently any related Line items but only if the above conditions are met.
2488
+	 * 4. Removing relationships between all tickets and the related registrations
2489
+	 * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
2490
+	 * 6. Deleting permanently any related Checkins.
2491
+	 *
2492
+	 * @return void
2493
+	 * @throws EE_Error
2494
+	 */
2495
+	protected function _delete_registrations()
2496
+	{
2497
+		$REG_MDL = EEM_Registration::instance();
2498
+		$success = 1;
2499
+		//Checkboxes
2500
+		if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
2501
+			// if array has more than one element than success message should be plural
2502
+			$success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
2503
+			// cycle thru checkboxes
2504
+			while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
2505
+				$REG = $REG_MDL->get_one_by_ID($REG_ID);
2506
+				if ( ! $REG instanceof EE_Registration) {
2507
+					continue;
2508
+				}
2509
+				$deleted = $this->_delete_registration($REG);
2510
+				if ( ! $deleted) {
2511
+					$success = 0;
2512
+				}
2513
+			}
2514
+		} else {
2515
+			// grab single id and delete
2516
+			$REG_ID  = $this->_req_data['_REG_ID'];
2517
+			$REG     = $REG_MDL->get_one_by_ID($REG_ID);
2518
+			$deleted = $this->_delete_registration($REG);
2519
+			if ( ! $deleted) {
2520
+				$success = 0;
2521
+			}
2522
+		}
2523
+		$what        = $success > 1
2524
+			? esc_html__('Registrations', 'event_espresso')
2525
+			: esc_html__('Registration', 'event_espresso');
2526
+		$action_desc = esc_html__('permanently deleted.', 'event_espresso');
2527
+		$this->_redirect_after_action(
2528
+			$success,
2529
+			$what,
2530
+			$action_desc,
2531
+			array('action' => 'default'),
2532
+			true
2533
+		);
2534
+	}
2535
+
2536
+
2537
+	/**
2538
+	 * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
2539
+	 * models get affected.
2540
+	 *
2541
+	 * @param  EE_Registration $REG registration to be deleted permenantly
2542
+	 * @return bool true = successful deletion, false = fail.
2543
+	 * @throws EE_Error
2544
+	 */
2545
+	protected function _delete_registration(EE_Registration $REG)
2546
+	{
2547
+		//first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
2548
+		//registrations on the transaction that are NOT trashed.
2549
+		$TXN         = $REG->get_first_related('Transaction');
2550
+		$REGS        = $TXN->get_many_related('Registration');
2551
+		$all_trashed = true;
2552
+		foreach ($REGS as $registration) {
2553
+			if ( ! $registration->get('REG_deleted')) {
2554
+				$all_trashed = false;
2555
+			}
2556
+		}
2557
+		if ( ! $all_trashed) {
2558
+			EE_Error::add_error(
2559
+				esc_html__(
2560
+					'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.',
2561
+					'event_espresso'
2562
+				),
2563
+				__FILE__, __FUNCTION__, __LINE__
2564
+			);
2565
+			return false;
2566
+		}
2567
+		//k made it here so that means we can delete all the related transactions and their answers (but let's do them
2568
+		//separately from THIS one).
2569
+		foreach ($REGS as $registration) {
2570
+			//delete related answers
2571
+			$registration->delete_related_permanently('Answer');
2572
+			//remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
2573
+			$attendee = $registration->get_first_related('Attendee');
2574
+			if ($attendee instanceof EE_Attendee) {
2575
+				$registration->_remove_relation_to($attendee, 'Attendee');
2576
+			}
2577
+			//now remove relationships to tickets on this registration.
2578
+			$registration->_remove_relations('Ticket');
2579
+			//now delete permanently the checkins related to this registration.
2580
+			$registration->delete_related_permanently('Checkin');
2581
+			if ($registration->ID() === $REG->ID()) {
2582
+				continue;
2583
+			} //we don't want to delete permanently the existing registration just yet.
2584
+			//remove relation to transaction for these registrations if NOT the existing registrations
2585
+			$registration->_remove_relations('Transaction');
2586
+			//delete permanently any related messages.
2587
+			$registration->delete_related_permanently('Message');
2588
+			//now delete this registration permanently
2589
+			$registration->delete_permanently();
2590
+		}
2591
+		//now all related registrations on the transaction are handled.  So let's just handle this registration itself
2592
+		// (the transaction and line items should be all that's left).
2593
+		// delete the line items related to the transaction for this registration.
2594
+		$TXN->delete_related_permanently('Line_Item');
2595
+		//we need to remove all the relationships on the transaction
2596
+		$TXN->delete_related_permanently('Payment');
2597
+		$TXN->delete_related_permanently('Extra_Meta');
2598
+		$TXN->delete_related_permanently('Message');
2599
+		//now we can delete this REG permanently (and the transaction of course)
2600
+		$REG->delete_related_permanently('Transaction');
2601
+		return $REG->delete_permanently();
2602
+	}
2603
+
2604
+
2605
+	/**
2606
+	 *    generates HTML for the Register New Attendee Admin page
2607
+	 *
2608
+	 * @access private
2609
+	 * @throws DomainException
2610
+	 * @throws EE_Error
2611
+	 */
2612
+	public function new_registration()
2613
+	{
2614
+		if ( ! $this->_set_reg_event()) {
2615
+			throw new EE_Error(
2616
+				esc_html__(
2617
+					'Unable to continue with registering because there is no Event ID in the request',
2618
+					'event_espresso'
2619
+				)
2620
+			);
2621
+		}
2622
+		EE_Registry::instance()->REQ->set_espresso_page(true);
2623
+		// gotta start with a clean slate if we're not coming here via ajax
2624
+		if ( ! defined('DOING_AJAX')
2625
+			 && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
2626
+		) {
2627
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2628
+		}
2629
+		$this->_template_args['event_name'] = '';
2630
+		// event name
2631
+		if ($this->_reg_event) {
2632
+			$this->_template_args['event_name'] = $this->_reg_event->name();
2633
+			$edit_event_url                     = self::add_query_args_and_nonce(array(
2634
+				'action' => 'edit',
2635
+				'post'   => $this->_reg_event->ID(),
2636
+			), EVENTS_ADMIN_URL);
2637
+			$edit_event_lnk                     = '<a href="'
2638
+												  . $edit_event_url
2639
+												  . '" title="'
2640
+												  . esc_attr__('Edit ', 'event_espresso')
2641
+												  . $this->_reg_event->name()
2642
+												  . '">'
2643
+												  . esc_html__('Edit Event', 'event_espresso')
2644
+												  . '</a>';
2645
+			$this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
2646
+												   . $edit_event_lnk
2647
+												   . '</span>';
2648
+		}
2649
+		$this->_template_args['step_content'] = $this->_get_registration_step_content();
2650
+		if (defined('DOING_AJAX')) {
2651
+			$this->_return_json();
2652
+		}
2653
+		// grab header
2654
+		$template_path                              =
2655
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
2656
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
2657
+			$this->_template_args, true);
2658
+		//$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
2659
+		// the details template wrapper
2660
+		$this->display_admin_page_with_sidebar();
2661
+	}
2662
+
2663
+
2664
+	/**
2665
+	 * This returns the content for a registration step
2666
+	 *
2667
+	 * @access protected
2668
+	 * @return string html
2669
+	 * @throws DomainException
2670
+	 * @throws EE_Error
2671
+	 */
2672
+	protected function _get_registration_step_content()
2673
+	{
2674
+		if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
2675
+			$warning_msg = sprintf(
2676
+				esc_html__(
2677
+					'%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',
2678
+					'event_espresso'
2679
+				),
2680
+				'<br />',
2681
+				'<h3 class="important-notice">',
2682
+				'</h3>',
2683
+				'<div class="float-right">',
2684
+				'<span id="redirect_timer" class="important-notice">30</span>',
2685
+				'</div>',
2686
+				'<b>',
2687
+				'</b>'
2688
+			);
2689
+			return '
2690 2690
 	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
2691 2691
 	<script >
2692 2692
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
@@ -2699,792 +2699,792 @@  discard block
 block discarded – undo
2699 2699
 	        }
2700 2700
 	    }, 800 );
2701 2701
 	</script >';
2702
-        }
2703
-        $template_args = array(
2704
-            'title'                    => '',
2705
-            'content'                  => '',
2706
-            'step_button_text'         => '',
2707
-            'show_notification_toggle' => false,
2708
-        );
2709
-        //to indicate we're processing a new registration
2710
-        $hidden_fields = array(
2711
-            'processing_registration' => array(
2712
-                'type'  => 'hidden',
2713
-                'value' => 0,
2714
-            ),
2715
-            'event_id'                => array(
2716
-                'type'  => 'hidden',
2717
-                'value' => $this->_reg_event->ID(),
2718
-            ),
2719
-        );
2720
-        //if the cart is empty then we know we're at step one so we'll display ticket selector
2721
-        $cart = EE_Registry::instance()->SSN->cart();
2722
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
2723
-        switch ($step) {
2724
-            case 'ticket' :
2725
-                $hidden_fields['processing_registration']['value'] = 1;
2726
-                $template_args['title']                            = esc_html__(
2727
-                    'Step One: Select the Ticket for this registration',
2728
-                    'event_espresso'
2729
-                );
2730
-                $template_args['content']                          =
2731
-                    EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
2732
-                $template_args['step_button_text']                 = esc_html__(
2733
-                    'Add Tickets and Continue to Registrant Details',
2734
-                    'event_espresso'
2735
-                );
2736
-                $template_args['show_notification_toggle']         = false;
2737
-                break;
2738
-            case 'questions' :
2739
-                $hidden_fields['processing_registration']['value'] = 2;
2740
-                $template_args['title']                            = esc_html__(
2741
-                    'Step Two: Add Registrant Details for this Registration',
2742
-                    'event_espresso'
2743
-                );
2744
-                //in theory we should be able to run EED_SPCO at this point because the cart should have been setup
2745
-                // properly by the first process_reg_step run.
2746
-                $template_args['content']                  =
2747
-                    EED_Single_Page_Checkout::registration_checkout_for_admin();
2748
-                $template_args['step_button_text']         = esc_html__(
2749
-                    'Save Registration and Continue to Details',
2750
-                    'event_espresso'
2751
-                );
2752
-                $template_args['show_notification_toggle'] = true;
2753
-                break;
2754
-        }
2755
-        //we come back to the process_registration_step route.
2756
-        $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
2757
-        return EEH_Template::display_template(
2758
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
2759
-            $template_args,
2760
-            true
2761
-        );
2762
-    }
2763
-
2764
-
2765
-    /**
2766
-     *        set_reg_event
2767
-     *
2768
-     * @access private
2769
-     * @return bool
2770
-     * @throws EE_Error
2771
-     */
2772
-    private function _set_reg_event()
2773
-    {
2774
-        if (is_object($this->_reg_event)) {
2775
-            return true;
2776
-        }
2777
-        $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
2778
-        if ( ! $EVT_ID) {
2779
-            return false;
2780
-        }
2781
-        $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
2782
-        return true;
2783
-    }
2784
-
2785
-
2786
-    /**
2787
-     * process_reg_step
2788
-     *
2789
-     * @access        public
2790
-     * @return string
2791
-     * @throws DomainException
2792
-     * @throws EE_Error
2793
-     * @throws RuntimeException
2794
-     */
2795
-    public function process_reg_step()
2796
-    {
2797
-        EE_System::do_not_cache();
2798
-        $this->_set_reg_event();
2799
-        EE_Registry::instance()->REQ->set_espresso_page(true);
2800
-        EE_Registry::instance()->REQ->set('uts', time());
2801
-        //what step are we on?
2802
-        $cart = EE_Registry::instance()->SSN->cart();
2803
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
2804
-        //if doing ajax then we need to verify the nonce
2805
-        if (defined('DOING_AJAX')) {
2806
-            $nonce = isset($this->_req_data[$this->_req_nonce])
2807
-                ? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
2808
-            $this->_verify_nonce($nonce, $this->_req_nonce);
2809
-        }
2810
-        switch ($step) {
2811
-            case 'ticket' :
2812
-                //process ticket selection
2813
-                $success = EED_Ticket_Selector::instance()->process_ticket_selections();
2814
-                if ($success) {
2815
-                    EE_Error::add_success(
2816
-                        esc_html__(
2817
-                            'Tickets Selected. Now complete the registration.',
2818
-                            'event_espresso'
2819
-                        )
2820
-                    );
2821
-                } else {
2822
-                    $query_args['step_error'] = $this->_req_data['step_error'] = true;
2823
-                }
2824
-                if (defined('DOING_AJAX')) {
2825
-                    $this->new_registration(); //display next step
2826
-                } else {
2827
-                    $query_args = array(
2828
-                        'action'                  => 'new_registration',
2829
-                        'processing_registration' => 1,
2830
-                        'event_id'                => $this->_reg_event->ID(),
2831
-                        'uts'                     => time(),
2832
-                    );
2833
-                    $this->_redirect_after_action(
2834
-                        false,
2835
-                        '',
2836
-                        '',
2837
-                        $query_args,
2838
-                        true
2839
-                    );
2840
-                }
2841
-                break;
2842
-            case 'questions' :
2843
-                if (! isset(
2844
-                    $this->_req_data['txn_reg_status_change'],
2845
-                    $this->_req_data['txn_reg_status_change']['send_notifications'])
2846
-                ) {
2847
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
2848
-                }
2849
-                //process registration
2850
-                $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
2851
-                if ($cart instanceof EE_Cart) {
2852
-                    $grand_total = $cart->get_cart_grand_total();
2853
-                    if ($grand_total instanceof EE_Line_Item) {
2854
-                        $grand_total->save_this_and_descendants_to_txn();
2855
-                    }
2856
-                }
2857
-                if ( ! $transaction instanceof EE_Transaction) {
2858
-                    $query_args = array(
2859
-                        'action'                  => 'new_registration',
2860
-                        'processing_registration' => 2,
2861
-                        'event_id'                => $this->_reg_event->ID(),
2862
-                        'uts'                     => time(),
2863
-                    );
2864
-                    if (defined('DOING_AJAX')) {
2865
-                        //display registration form again because there are errors (maybe validation?)
2866
-                        $this->new_registration();
2867
-                        return;
2868
-                    } else {
2869
-                        $this->_redirect_after_action(
2870
-                            false,
2871
-                            '',
2872
-                            '',
2873
-                            $query_args,
2874
-                            true
2875
-                        );
2876
-                        return;
2877
-                    }
2878
-                }
2879
-                // maybe update status, and make sure to save transaction if not done already
2880
-                if ( ! $transaction->update_status_based_on_total_paid()) {
2881
-                    $transaction->save();
2882
-                }
2883
-                EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2884
-                $this->_req_data = array();
2885
-                $query_args      = array(
2886
-                    'action'        => 'redirect_to_txn',
2887
-                    'TXN_ID'        => $transaction->ID(),
2888
-                    'EVT_ID'        => $this->_reg_event->ID(),
2889
-                    'event_name'    => urlencode($this->_reg_event->name()),
2890
-                    'redirect_from' => 'new_registration',
2891
-                );
2892
-                $this->_redirect_after_action(false, '', '', $query_args, true);
2893
-                break;
2894
-        }
2895
-        //what are you looking here for?  Should be nothing to do at this point.
2896
-    }
2897
-
2898
-
2899
-    /**
2900
-     * redirect_to_txn
2901
-     *
2902
-     * @access public
2903
-     * @return void
2904
-     * @throws EE_Error
2905
-     */
2906
-    public function redirect_to_txn()
2907
-    {
2908
-        EE_System::do_not_cache();
2909
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2910
-        $query_args = array(
2911
-            'action' => 'view_transaction',
2912
-            'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
2913
-            'page'   => 'espresso_transactions',
2914
-        );
2915
-        if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
2916
-            $query_args['EVT_ID']        = $this->_req_data['EVT_ID'];
2917
-            $query_args['event_name']    = urlencode($this->_req_data['event_name']);
2918
-            $query_args['redirect_from'] = $this->_req_data['redirect_from'];
2919
-        }
2920
-        EE_Error::add_success(
2921
-            esc_html__(
2922
-                'Registration Created.  Please review the transaction and add any payments as necessary',
2923
-                'event_espresso'
2924
-            )
2925
-        );
2926
-        $this->_redirect_after_action(false, '', '', $query_args, true);
2927
-    }
2928
-
2929
-
2930
-    /**
2931
-     *        generates HTML for the Attendee Contact List
2932
-     *
2933
-     * @access protected
2934
-     * @return void
2935
-     */
2936
-    protected function _attendee_contact_list_table()
2937
-    {
2938
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2939
-        $this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
2940
-        $this->display_admin_list_table_page_with_no_sidebar();
2941
-    }
2942
-
2943
-
2944
-    /**
2945
-     *        get_attendees
2946
-     *
2947
-     * @param      $per_page
2948
-     * @param bool $count whether to return count or data.
2949
-     * @param bool $trash
2950
-     * @return array
2951
-     * @throws EE_Error
2952
-     * @access public
2953
-     */
2954
-    public function get_attendees($per_page, $count = false, $trash = false)
2955
-    {
2956
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2957
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
2958
-        $ATT_MDL                    = EEM_Attendee::instance();
2959
-        $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
2960
-        switch ($this->_req_data['orderby']) {
2961
-            case 'ATT_ID':
2962
-                $orderby = 'ATT_ID';
2963
-                break;
2964
-            case 'ATT_fname':
2965
-                $orderby = 'ATT_fname';
2966
-                break;
2967
-            case 'ATT_email':
2968
-                $orderby = 'ATT_email';
2969
-                break;
2970
-            case 'ATT_city':
2971
-                $orderby = 'ATT_city';
2972
-                break;
2973
-            case 'STA_ID':
2974
-                $orderby = 'STA_ID';
2975
-                break;
2976
-            case 'CNT_ID':
2977
-                $orderby = 'CNT_ID';
2978
-                break;
2979
-            default:
2980
-                $orderby = 'ATT_lname';
2981
-        }
2982
-        $sort         = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
2983
-            ? $this->_req_data['order']
2984
-            : 'ASC';
2985
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
2986
-            ? $this->_req_data['paged']
2987
-            : 1;
2988
-        $per_page     = isset($per_page) && ! empty($per_page) ? $per_page : 10;
2989
-        $per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
2990
-            ? $this->_req_data['perpage']
2991
-            : $per_page;
2992
-        $_where       = array();
2993
-        if ( ! empty($this->_req_data['s'])) {
2994
-            $sstr         = '%' . $this->_req_data['s'] . '%';
2995
-            $_where['OR'] = array(
2996
-                'Registration.Event.EVT_name'       => array('LIKE', $sstr),
2997
-                'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
2998
-                'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
2999
-                'ATT_fname'                         => array('LIKE', $sstr),
3000
-                'ATT_lname'                         => array('LIKE', $sstr),
3001
-                'ATT_short_bio'                     => array('LIKE', $sstr),
3002
-                'ATT_email'                         => array('LIKE', $sstr),
3003
-                'ATT_address'                       => array('LIKE', $sstr),
3004
-                'ATT_address2'                      => array('LIKE', $sstr),
3005
-                'ATT_city'                          => array('LIKE', $sstr),
3006
-                'Country.CNT_name'                  => array('LIKE', $sstr),
3007
-                'State.STA_name'                    => array('LIKE', $sstr),
3008
-                'ATT_phone'                         => array('LIKE', $sstr),
3009
-                'Registration.REG_final_price'      => array('LIKE', $sstr),
3010
-                'Registration.REG_code'             => array('LIKE', $sstr),
3011
-                'Registration.REG_count'            => array('LIKE', $sstr),
3012
-                'Registration.REG_group_size'       => array('LIKE', $sstr),
3013
-            );
3014
-        }
3015
-        $offset = ($current_page - 1) * $per_page;
3016
-        $limit  = $count ? null : array($offset, $per_page);
3017
-        if ($trash) {
3018
-            $_where['status'] = array('!=', 'publish');
3019
-            $all_attendees    = $count
3020
-                ? $ATT_MDL->count(array(
3021
-                    $_where,
3022
-                    'order_by' => array($orderby => $sort),
3023
-                    'limit'    => $limit,
3024
-                ), 'ATT_ID', true)
3025
-                : $ATT_MDL->get_all(array(
3026
-                    $_where,
3027
-                    'order_by' => array($orderby => $sort),
3028
-                    'limit'    => $limit,
3029
-                ));
3030
-        } else {
3031
-            $_where['status'] = array('IN', array('publish'));
3032
-            $all_attendees    = $count
3033
-                ? $ATT_MDL->count(array(
3034
-                    $_where,
3035
-                    'order_by' => array($orderby => $sort),
3036
-                    'limit'    => $limit,
3037
-                ), 'ATT_ID', true)
3038
-                : $ATT_MDL->get_all(array(
3039
-                    $_where,
3040
-                    'order_by' => array($orderby => $sort),
3041
-                    'limit'    => $limit,
3042
-                ));
3043
-        }
3044
-        return $all_attendees;
3045
-    }
3046
-
3047
-
3048
-    /**
3049
-     * This is just taking care of resending the registration confirmation
3050
-     *
3051
-     * @access protected
3052
-     * @return void
3053
-     */
3054
-    protected function _resend_registration()
3055
-    {
3056
-        $this->_process_resend_registration();
3057
-        $query_args = isset($this->_req_data['redirect_to'])
3058
-            ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
3059
-            : array('action' => 'default');
3060
-        $this->_redirect_after_action(false, '', '', $query_args, true);
3061
-    }
3062
-
3063
-    /**
3064
-     * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
3065
-     * to use when selecting registrations
3066
-     * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
3067
-     *                                                     the query parameters from the request
3068
-     * @return void ends the request with a redirect or download
3069
-     */
3070
-    public function _registrations_report_base( $method_name_for_getting_query_params )
3071
-    {
3072
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
3073
-            wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
3074
-                array(
3075
-                    'page'        => 'espresso_batch',
3076
-                    'batch'       => 'file',
3077
-                    'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
3078
-                    'filters'     => urlencode(
3079
-                        serialize(
3080
-                            call_user_func(
3081
-                                array( $this, $method_name_for_getting_query_params ),
3082
-                                EEH_Array::is_set(
3083
-                                    $this->_req_data,
3084
-                                    'filters',
3085
-                                    array()
3086
-                                )
3087
-                            )
3088
-                        )
3089
-                ),
3090
-                'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false),
3091
-                'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
3092
-                'return_url'  => urlencode($this->_req_data['return_url']),
3093
-            )));
3094
-        } else {
3095
-            $new_request_args = array(
3096
-                'export' => 'report',
3097
-                'action' => 'registrations_report_for_event',
3098
-                'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
3099
-            );
3100
-            $this->_req_data = array_merge($this->_req_data, $new_request_args);
3101
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
3102
-                require_once(EE_CLASSES . 'EE_Export.class.php');
3103
-                $EE_Export = EE_Export::instance($this->_req_data);
3104
-                $EE_Export->export();
3105
-            }
3106
-        }
3107
-    }
3108
-
3109
-
3110
-
3111
-    /**
3112
-     * Creates a registration report using only query parameters in the request
3113
-     * @return void
3114
-     */
3115
-    public function _registrations_report()
3116
-    {
3117
-        $this->_registrations_report_base('_get_registration_query_parameters');
3118
-    }
3119
-
3120
-
3121
-    public function _contact_list_export()
3122
-    {
3123
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
3124
-            require_once(EE_CLASSES . 'EE_Export.class.php');
3125
-            $EE_Export = EE_Export::instance($this->_req_data);
3126
-            $EE_Export->export_attendees();
3127
-        }
3128
-    }
3129
-
3130
-
3131
-    public function _contact_list_report()
3132
-    {
3133
-        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
3134
-            wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
3135
-                'page'        => 'espresso_batch',
3136
-                'batch'       => 'file',
3137
-                'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
3138
-                'return_url'  => urlencode($this->_req_data['return_url']),
3139
-            )));
3140
-        } else {
3141
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
3142
-                require_once(EE_CLASSES . 'EE_Export.class.php');
3143
-                $EE_Export = EE_Export::instance($this->_req_data);
3144
-                $EE_Export->report_attendees();
3145
-            }
3146
-        }
3147
-    }
3148
-
3149
-
3150
-
3151
-
3152
-
3153
-    /***************************************        ATTENDEE DETAILS        ***************************************/
3154
-    /**
3155
-     * This duplicates the attendee object for the given incoming registration id and attendee_id.
3156
-     *
3157
-     * @return void
3158
-     * @throws EE_Error
3159
-     */
3160
-    protected function _duplicate_attendee()
3161
-    {
3162
-        $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
3163
-        //verify we have necessary info
3164
-        if (empty($this->_req_data['_REG_ID'])) {
3165
-            EE_Error::add_error(
3166
-                esc_html__(
3167
-                    'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
3168
-                    'event_espresso'
3169
-                ), __FILE__, __LINE__, __FUNCTION__
3170
-            );
3171
-            $query_args = array('action' => $action);
3172
-            $this->_redirect_after_action('', '', '', $query_args, true);
3173
-        }
3174
-        //okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
3175
-        $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
3176
-        $attendee     = $registration->attendee();
3177
-        //remove relation of existing attendee on registration
3178
-        $registration->_remove_relation_to($attendee, 'Attendee');
3179
-        //new attendee
3180
-        $new_attendee = clone $attendee;
3181
-        $new_attendee->set('ATT_ID', 0);
3182
-        $new_attendee->save();
3183
-        //add new attendee to reg
3184
-        $registration->_add_relation_to($new_attendee, 'Attendee');
3185
-        EE_Error::add_success(
3186
-            esc_html__(
3187
-                'New Contact record created.  Now make any edits you wish to make for this contact.',
3188
-                'event_espresso'
3189
-            )
3190
-        );
3191
-        //redirect to edit page for attendee
3192
-        $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
3193
-        $this->_redirect_after_action('', '', '', $query_args, true);
3194
-    }
3195
-
3196
-
3197
-    //related to cpt routes
3198
-    protected function _insert_update_cpt_item($post_id, $post)
3199
-    {
3200
-        $success  = true;
3201
-        $attendee = EEM_Attendee::instance()->get_one_by_ID($post_id);
3202
-        //for attendee updates
3203
-        if ($post->post_type = 'espresso_attendees' && ! empty($attendee)) {
3204
-            //note we should only be UPDATING attendees at this point.
3205
-            $updated_fields = array(
3206
-                'ATT_fname'     => $this->_req_data['ATT_fname'],
3207
-                'ATT_lname'     => $this->_req_data['ATT_lname'],
3208
-                'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
3209
-                'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
3210
-                'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
3211
-                'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
3212
-                'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
3213
-                'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
3214
-                'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
3215
-                'ATT_email'     => isset($this->_req_data['ATT_email']) ? $this->_req_data['ATT_email'] : '',
3216
-                'ATT_phone'     => isset($this->_req_data['ATT_phone']) ? $this->_req_data['ATT_phone'] : '',
3217
-            );
3218
-            foreach ($updated_fields as $field => $value) {
3219
-                $attendee->set($field, $value);
3220
-            }
3221
-            $success                   = $attendee->save();
3222
-            $attendee_update_callbacks = apply_filters(
3223
-                'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
3224
-                array()
3225
-            );
3226
-            foreach ($attendee_update_callbacks as $a_callback) {
3227
-                if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
3228
-                    throw new EE_Error(
3229
-                        sprintf(
3230
-                            esc_html__(
3231
-                                '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.',
3232
-                                'event_espresso'
3233
-                            ),
3234
-                            $a_callback
3235
-                        )
3236
-                    );
3237
-                }
3238
-            }
3239
-        }
3240
-        if ($success === false) {
3241
-            EE_Error::add_error(
3242
-                esc_html__(
3243
-                    'Something went wrong with updating the meta table data for the registration.',
3244
-                    'event_espresso'
3245
-                ),
3246
-                __FILE__, __FUNCTION__, __LINE__
3247
-            );
3248
-        }
3249
-    }
3250
-
3251
-
3252
-    public function trash_cpt_item($post_id)
3253
-    {
3254
-    }
3255
-
3256
-
3257
-    public function delete_cpt_item($post_id)
3258
-    {
3259
-    }
3260
-
3261
-
3262
-    public function restore_cpt_item($post_id)
3263
-    {
3264
-    }
3265
-
3266
-
3267
-    protected function _restore_cpt_item($post_id, $revision_id)
3268
-    {
3269
-    }
3270
-
3271
-
3272
-    public function attendee_editor_metaboxes()
3273
-    {
3274
-        $this->verify_cpt_object();
3275
-        remove_meta_box(
3276
-            'postexcerpt',
3277
-            esc_html__('Excerpt', 'event_espresso'),
3278
-            'post_excerpt_meta_box',
3279
-            $this->_cpt_routes[$this->_req_action],
3280
-            'normal',
3281
-            'core'
3282
-        );
3283
-        remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
3284
-        if (post_type_supports('espresso_attendees', 'excerpt')) {
3285
-            add_meta_box(
3286
-                'postexcerpt',
3287
-                esc_html__('Short Biography', 'event_espresso'),
3288
-                'post_excerpt_meta_box',
3289
-                $this->_cpt_routes[$this->_req_action],
3290
-                'normal'
3291
-            );
3292
-        }
3293
-        if (post_type_supports('espresso_attendees', 'comments')) {
3294
-            add_meta_box(
3295
-                'commentsdiv',
3296
-                esc_html__('Notes on the Contact', 'event_espresso'),
3297
-                'post_comment_meta_box',
3298
-                $this->_cpt_routes[$this->_req_action],
3299
-                'normal',
3300
-                'core'
3301
-            );
3302
-        }
3303
-        add_meta_box(
3304
-            'attendee_contact_info',
3305
-            esc_html__('Contact Info', 'event_espresso'),
3306
-            array($this, 'attendee_contact_info'),
3307
-            $this->_cpt_routes[$this->_req_action],
3308
-            'side',
3309
-            'core'
3310
-        );
3311
-        add_meta_box(
3312
-            'attendee_details_address',
3313
-            esc_html__('Address Details', 'event_espresso'),
3314
-            array($this, 'attendee_address_details'),
3315
-            $this->_cpt_routes[$this->_req_action],
3316
-            'normal',
3317
-            'core'
3318
-        );
3319
-        add_meta_box(
3320
-            'attendee_registrations',
3321
-            esc_html__('Registrations for this Contact', 'event_espresso'),
3322
-            array($this, 'attendee_registrations_meta_box'),
3323
-            $this->_cpt_routes[$this->_req_action],
3324
-            'normal',
3325
-            'high'
3326
-        );
3327
-    }
3328
-
3329
-
3330
-    /**
3331
-     * Metabox for attendee contact info
3332
-     *
3333
-     * @param  WP_Post $post wp post object
3334
-     * @return string attendee contact info ( and form )
3335
-     * @throws DomainException
3336
-     */
3337
-    public function attendee_contact_info($post)
3338
-    {
3339
-        //get attendee object ( should already have it )
3340
-        $this->_template_args['attendee'] = $this->_cpt_model_obj;
3341
-        $template                         = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php';
3342
-        EEH_Template::display_template($template, $this->_template_args);
3343
-    }
3344
-
3345
-
3346
-    /**
3347
-     * Metabox for attendee details
3348
-     *
3349
-     * @param  WP_Post $post wp post object
3350
-     * @return string attendee address details (and form)
3351
-     * @throws DomainException
3352
-     */
3353
-    public function attendee_address_details($post)
3354
-    {
3355
-        //get attendee object (should already have it)
3356
-        $this->_template_args['attendee']     = $this->_cpt_model_obj;
3357
-        $this->_template_args['state_html']   = EEH_Form_Fields::generate_form_input(
3358
-            new EE_Question_Form_Input(
3359
-                EE_Question::new_instance(
3360
-                    array(
3361
-                        'QST_ID'           => 0,
3362
-                        'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
3363
-                        'QST_system'       => 'admin-state',
3364
-                    )
3365
-                ),
3366
-                EE_Answer::new_instance(
3367
-                    array(
3368
-                        'ANS_ID'    => 0,
3369
-                        'ANS_value' => $this->_cpt_model_obj->state_ID(),
3370
-                    )
3371
-                ),
3372
-                array(
3373
-                    'input_id'       => 'STA_ID',
3374
-                    'input_name'     => 'STA_ID',
3375
-                    'input_prefix'   => '',
3376
-                    'append_qstn_id' => false,
3377
-                )
3378
-            )
3379
-        );
3380
-        $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
3381
-            new EE_Question_Form_Input(
3382
-                EE_Question::new_instance(
3383
-                    array(
3384
-                        'QST_ID'           => 0,
3385
-                        'QST_display_text' => esc_html__('Country', 'event_espresso'),
3386
-                        'QST_system'       => 'admin-country',
3387
-                    )
3388
-                ),
3389
-                EE_Answer::new_instance(
3390
-                    array(
3391
-                        'ANS_ID'    => 0,
3392
-                        'ANS_value' => $this->_cpt_model_obj->country_ID(),
3393
-                    )
3394
-                ),
3395
-                array(
3396
-                    'input_id'       => 'CNT_ISO',
3397
-                    'input_name'     => 'CNT_ISO',
3398
-                    'input_prefix'   => '',
3399
-                    'append_qstn_id' => false,
3400
-                )
3401
-            )
3402
-        );
3403
-        $template                             =
3404
-            REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
3405
-        EEH_Template::display_template($template, $this->_template_args);
3406
-    }
3407
-
3408
-
3409
-    /**
3410
-     *        _attendee_details
3411
-     *
3412
-     * @access protected
3413
-     * @param $post
3414
-     * @return void
3415
-     * @throws DomainException
3416
-     * @throws EE_Error
3417
-     */
3418
-    public function attendee_registrations_meta_box($post)
3419
-    {
3420
-        $this->_template_args['attendee']      = $this->_cpt_model_obj;
3421
-        $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
3422
-        $template                              =
3423
-            REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
3424
-        EEH_Template::display_template($template, $this->_template_args);
3425
-    }
3426
-
3427
-
3428
-    /**
3429
-     * add in the form fields for the attendee edit
3430
-     *
3431
-     * @param  WP_Post $post wp post object
3432
-     * @return string html for new form.
3433
-     * @throws DomainException
3434
-     */
3435
-    public function after_title_form_fields($post)
3436
-    {
3437
-        if ($post->post_type == 'espresso_attendees') {
3438
-            $template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
3439
-            $template_args['attendee'] = $this->_cpt_model_obj;
3440
-            EEH_Template::display_template($template, $template_args);
3441
-        }
3442
-    }
3443
-
3444
-
3445
-    /**
3446
-     *        _trash_or_restore_attendee
3447
-     *
3448
-     * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
3449
-     * @return void
3450
-     * @throws EE_Error
3451
-     * @access protected
3452
-     */
3453
-    protected function _trash_or_restore_attendees($trash = true)
3454
-    {
3455
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3456
-        $ATT_MDL = EEM_Attendee::instance();
3457
-        $success = 1;
3458
-        //Checkboxes
3459
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3460
-            // if array has more than one element than success message should be plural
3461
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3462
-            // cycle thru checkboxes
3463
-            while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
3464
-                $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
3465
-                    : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
3466
-                if ( ! $updated) {
3467
-                    $success = 0;
3468
-                }
3469
-            }
3470
-        } else {
3471
-            // grab single id and delete
3472
-            $ATT_ID = absint($this->_req_data['ATT_ID']);
3473
-            //get attendee
3474
-            $att     = $ATT_MDL->get_one_by_ID($ATT_ID);
3475
-            $updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
3476
-            $updated = $att->save();
3477
-            if ( ! $updated) {
3478
-                $success = 0;
3479
-            }
3480
-        }
3481
-        $what        = $success > 1
3482
-            ? esc_html__('Contacts', 'event_espresso')
3483
-            : esc_html__('Contact', 'event_espresso');
3484
-        $action_desc = $trash
3485
-            ? esc_html__('moved to the trash', 'event_espresso')
3486
-            : esc_html__('restored', 'event_espresso');
3487
-        $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
3488
-    }
2702
+		}
2703
+		$template_args = array(
2704
+			'title'                    => '',
2705
+			'content'                  => '',
2706
+			'step_button_text'         => '',
2707
+			'show_notification_toggle' => false,
2708
+		);
2709
+		//to indicate we're processing a new registration
2710
+		$hidden_fields = array(
2711
+			'processing_registration' => array(
2712
+				'type'  => 'hidden',
2713
+				'value' => 0,
2714
+			),
2715
+			'event_id'                => array(
2716
+				'type'  => 'hidden',
2717
+				'value' => $this->_reg_event->ID(),
2718
+			),
2719
+		);
2720
+		//if the cart is empty then we know we're at step one so we'll display ticket selector
2721
+		$cart = EE_Registry::instance()->SSN->cart();
2722
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
2723
+		switch ($step) {
2724
+			case 'ticket' :
2725
+				$hidden_fields['processing_registration']['value'] = 1;
2726
+				$template_args['title']                            = esc_html__(
2727
+					'Step One: Select the Ticket for this registration',
2728
+					'event_espresso'
2729
+				);
2730
+				$template_args['content']                          =
2731
+					EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
2732
+				$template_args['step_button_text']                 = esc_html__(
2733
+					'Add Tickets and Continue to Registrant Details',
2734
+					'event_espresso'
2735
+				);
2736
+				$template_args['show_notification_toggle']         = false;
2737
+				break;
2738
+			case 'questions' :
2739
+				$hidden_fields['processing_registration']['value'] = 2;
2740
+				$template_args['title']                            = esc_html__(
2741
+					'Step Two: Add Registrant Details for this Registration',
2742
+					'event_espresso'
2743
+				);
2744
+				//in theory we should be able to run EED_SPCO at this point because the cart should have been setup
2745
+				// properly by the first process_reg_step run.
2746
+				$template_args['content']                  =
2747
+					EED_Single_Page_Checkout::registration_checkout_for_admin();
2748
+				$template_args['step_button_text']         = esc_html__(
2749
+					'Save Registration and Continue to Details',
2750
+					'event_espresso'
2751
+				);
2752
+				$template_args['show_notification_toggle'] = true;
2753
+				break;
2754
+		}
2755
+		//we come back to the process_registration_step route.
2756
+		$this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
2757
+		return EEH_Template::display_template(
2758
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
2759
+			$template_args,
2760
+			true
2761
+		);
2762
+	}
2763
+
2764
+
2765
+	/**
2766
+	 *        set_reg_event
2767
+	 *
2768
+	 * @access private
2769
+	 * @return bool
2770
+	 * @throws EE_Error
2771
+	 */
2772
+	private function _set_reg_event()
2773
+	{
2774
+		if (is_object($this->_reg_event)) {
2775
+			return true;
2776
+		}
2777
+		$EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
2778
+		if ( ! $EVT_ID) {
2779
+			return false;
2780
+		}
2781
+		$this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
2782
+		return true;
2783
+	}
2784
+
2785
+
2786
+	/**
2787
+	 * process_reg_step
2788
+	 *
2789
+	 * @access        public
2790
+	 * @return string
2791
+	 * @throws DomainException
2792
+	 * @throws EE_Error
2793
+	 * @throws RuntimeException
2794
+	 */
2795
+	public function process_reg_step()
2796
+	{
2797
+		EE_System::do_not_cache();
2798
+		$this->_set_reg_event();
2799
+		EE_Registry::instance()->REQ->set_espresso_page(true);
2800
+		EE_Registry::instance()->REQ->set('uts', time());
2801
+		//what step are we on?
2802
+		$cart = EE_Registry::instance()->SSN->cart();
2803
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
2804
+		//if doing ajax then we need to verify the nonce
2805
+		if (defined('DOING_AJAX')) {
2806
+			$nonce = isset($this->_req_data[$this->_req_nonce])
2807
+				? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
2808
+			$this->_verify_nonce($nonce, $this->_req_nonce);
2809
+		}
2810
+		switch ($step) {
2811
+			case 'ticket' :
2812
+				//process ticket selection
2813
+				$success = EED_Ticket_Selector::instance()->process_ticket_selections();
2814
+				if ($success) {
2815
+					EE_Error::add_success(
2816
+						esc_html__(
2817
+							'Tickets Selected. Now complete the registration.',
2818
+							'event_espresso'
2819
+						)
2820
+					);
2821
+				} else {
2822
+					$query_args['step_error'] = $this->_req_data['step_error'] = true;
2823
+				}
2824
+				if (defined('DOING_AJAX')) {
2825
+					$this->new_registration(); //display next step
2826
+				} else {
2827
+					$query_args = array(
2828
+						'action'                  => 'new_registration',
2829
+						'processing_registration' => 1,
2830
+						'event_id'                => $this->_reg_event->ID(),
2831
+						'uts'                     => time(),
2832
+					);
2833
+					$this->_redirect_after_action(
2834
+						false,
2835
+						'',
2836
+						'',
2837
+						$query_args,
2838
+						true
2839
+					);
2840
+				}
2841
+				break;
2842
+			case 'questions' :
2843
+				if (! isset(
2844
+					$this->_req_data['txn_reg_status_change'],
2845
+					$this->_req_data['txn_reg_status_change']['send_notifications'])
2846
+				) {
2847
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
2848
+				}
2849
+				//process registration
2850
+				$transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
2851
+				if ($cart instanceof EE_Cart) {
2852
+					$grand_total = $cart->get_cart_grand_total();
2853
+					if ($grand_total instanceof EE_Line_Item) {
2854
+						$grand_total->save_this_and_descendants_to_txn();
2855
+					}
2856
+				}
2857
+				if ( ! $transaction instanceof EE_Transaction) {
2858
+					$query_args = array(
2859
+						'action'                  => 'new_registration',
2860
+						'processing_registration' => 2,
2861
+						'event_id'                => $this->_reg_event->ID(),
2862
+						'uts'                     => time(),
2863
+					);
2864
+					if (defined('DOING_AJAX')) {
2865
+						//display registration form again because there are errors (maybe validation?)
2866
+						$this->new_registration();
2867
+						return;
2868
+					} else {
2869
+						$this->_redirect_after_action(
2870
+							false,
2871
+							'',
2872
+							'',
2873
+							$query_args,
2874
+							true
2875
+						);
2876
+						return;
2877
+					}
2878
+				}
2879
+				// maybe update status, and make sure to save transaction if not done already
2880
+				if ( ! $transaction->update_status_based_on_total_paid()) {
2881
+					$transaction->save();
2882
+				}
2883
+				EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2884
+				$this->_req_data = array();
2885
+				$query_args      = array(
2886
+					'action'        => 'redirect_to_txn',
2887
+					'TXN_ID'        => $transaction->ID(),
2888
+					'EVT_ID'        => $this->_reg_event->ID(),
2889
+					'event_name'    => urlencode($this->_reg_event->name()),
2890
+					'redirect_from' => 'new_registration',
2891
+				);
2892
+				$this->_redirect_after_action(false, '', '', $query_args, true);
2893
+				break;
2894
+		}
2895
+		//what are you looking here for?  Should be nothing to do at this point.
2896
+	}
2897
+
2898
+
2899
+	/**
2900
+	 * redirect_to_txn
2901
+	 *
2902
+	 * @access public
2903
+	 * @return void
2904
+	 * @throws EE_Error
2905
+	 */
2906
+	public function redirect_to_txn()
2907
+	{
2908
+		EE_System::do_not_cache();
2909
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
2910
+		$query_args = array(
2911
+			'action' => 'view_transaction',
2912
+			'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
2913
+			'page'   => 'espresso_transactions',
2914
+		);
2915
+		if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
2916
+			$query_args['EVT_ID']        = $this->_req_data['EVT_ID'];
2917
+			$query_args['event_name']    = urlencode($this->_req_data['event_name']);
2918
+			$query_args['redirect_from'] = $this->_req_data['redirect_from'];
2919
+		}
2920
+		EE_Error::add_success(
2921
+			esc_html__(
2922
+				'Registration Created.  Please review the transaction and add any payments as necessary',
2923
+				'event_espresso'
2924
+			)
2925
+		);
2926
+		$this->_redirect_after_action(false, '', '', $query_args, true);
2927
+	}
2928
+
2929
+
2930
+	/**
2931
+	 *        generates HTML for the Attendee Contact List
2932
+	 *
2933
+	 * @access protected
2934
+	 * @return void
2935
+	 */
2936
+	protected function _attendee_contact_list_table()
2937
+	{
2938
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2939
+		$this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
2940
+		$this->display_admin_list_table_page_with_no_sidebar();
2941
+	}
2942
+
2943
+
2944
+	/**
2945
+	 *        get_attendees
2946
+	 *
2947
+	 * @param      $per_page
2948
+	 * @param bool $count whether to return count or data.
2949
+	 * @param bool $trash
2950
+	 * @return array
2951
+	 * @throws EE_Error
2952
+	 * @access public
2953
+	 */
2954
+	public function get_attendees($per_page, $count = false, $trash = false)
2955
+	{
2956
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2957
+		require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
2958
+		$ATT_MDL                    = EEM_Attendee::instance();
2959
+		$this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
2960
+		switch ($this->_req_data['orderby']) {
2961
+			case 'ATT_ID':
2962
+				$orderby = 'ATT_ID';
2963
+				break;
2964
+			case 'ATT_fname':
2965
+				$orderby = 'ATT_fname';
2966
+				break;
2967
+			case 'ATT_email':
2968
+				$orderby = 'ATT_email';
2969
+				break;
2970
+			case 'ATT_city':
2971
+				$orderby = 'ATT_city';
2972
+				break;
2973
+			case 'STA_ID':
2974
+				$orderby = 'STA_ID';
2975
+				break;
2976
+			case 'CNT_ID':
2977
+				$orderby = 'CNT_ID';
2978
+				break;
2979
+			default:
2980
+				$orderby = 'ATT_lname';
2981
+		}
2982
+		$sort         = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
2983
+			? $this->_req_data['order']
2984
+			: 'ASC';
2985
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
2986
+			? $this->_req_data['paged']
2987
+			: 1;
2988
+		$per_page     = isset($per_page) && ! empty($per_page) ? $per_page : 10;
2989
+		$per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
2990
+			? $this->_req_data['perpage']
2991
+			: $per_page;
2992
+		$_where       = array();
2993
+		if ( ! empty($this->_req_data['s'])) {
2994
+			$sstr         = '%' . $this->_req_data['s'] . '%';
2995
+			$_where['OR'] = array(
2996
+				'Registration.Event.EVT_name'       => array('LIKE', $sstr),
2997
+				'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
2998
+				'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
2999
+				'ATT_fname'                         => array('LIKE', $sstr),
3000
+				'ATT_lname'                         => array('LIKE', $sstr),
3001
+				'ATT_short_bio'                     => array('LIKE', $sstr),
3002
+				'ATT_email'                         => array('LIKE', $sstr),
3003
+				'ATT_address'                       => array('LIKE', $sstr),
3004
+				'ATT_address2'                      => array('LIKE', $sstr),
3005
+				'ATT_city'                          => array('LIKE', $sstr),
3006
+				'Country.CNT_name'                  => array('LIKE', $sstr),
3007
+				'State.STA_name'                    => array('LIKE', $sstr),
3008
+				'ATT_phone'                         => array('LIKE', $sstr),
3009
+				'Registration.REG_final_price'      => array('LIKE', $sstr),
3010
+				'Registration.REG_code'             => array('LIKE', $sstr),
3011
+				'Registration.REG_count'            => array('LIKE', $sstr),
3012
+				'Registration.REG_group_size'       => array('LIKE', $sstr),
3013
+			);
3014
+		}
3015
+		$offset = ($current_page - 1) * $per_page;
3016
+		$limit  = $count ? null : array($offset, $per_page);
3017
+		if ($trash) {
3018
+			$_where['status'] = array('!=', 'publish');
3019
+			$all_attendees    = $count
3020
+				? $ATT_MDL->count(array(
3021
+					$_where,
3022
+					'order_by' => array($orderby => $sort),
3023
+					'limit'    => $limit,
3024
+				), 'ATT_ID', true)
3025
+				: $ATT_MDL->get_all(array(
3026
+					$_where,
3027
+					'order_by' => array($orderby => $sort),
3028
+					'limit'    => $limit,
3029
+				));
3030
+		} else {
3031
+			$_where['status'] = array('IN', array('publish'));
3032
+			$all_attendees    = $count
3033
+				? $ATT_MDL->count(array(
3034
+					$_where,
3035
+					'order_by' => array($orderby => $sort),
3036
+					'limit'    => $limit,
3037
+				), 'ATT_ID', true)
3038
+				: $ATT_MDL->get_all(array(
3039
+					$_where,
3040
+					'order_by' => array($orderby => $sort),
3041
+					'limit'    => $limit,
3042
+				));
3043
+		}
3044
+		return $all_attendees;
3045
+	}
3046
+
3047
+
3048
+	/**
3049
+	 * This is just taking care of resending the registration confirmation
3050
+	 *
3051
+	 * @access protected
3052
+	 * @return void
3053
+	 */
3054
+	protected function _resend_registration()
3055
+	{
3056
+		$this->_process_resend_registration();
3057
+		$query_args = isset($this->_req_data['redirect_to'])
3058
+			? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
3059
+			: array('action' => 'default');
3060
+		$this->_redirect_after_action(false, '', '', $query_args, true);
3061
+	}
3062
+
3063
+	/**
3064
+	 * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
3065
+	 * to use when selecting registrations
3066
+	 * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
3067
+	 *                                                     the query parameters from the request
3068
+	 * @return void ends the request with a redirect or download
3069
+	 */
3070
+	public function _registrations_report_base( $method_name_for_getting_query_params )
3071
+	{
3072
+		if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
3073
+			wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
3074
+				array(
3075
+					'page'        => 'espresso_batch',
3076
+					'batch'       => 'file',
3077
+					'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
3078
+					'filters'     => urlencode(
3079
+						serialize(
3080
+							call_user_func(
3081
+								array( $this, $method_name_for_getting_query_params ),
3082
+								EEH_Array::is_set(
3083
+									$this->_req_data,
3084
+									'filters',
3085
+									array()
3086
+								)
3087
+							)
3088
+						)
3089
+				),
3090
+				'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false),
3091
+				'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
3092
+				'return_url'  => urlencode($this->_req_data['return_url']),
3093
+			)));
3094
+		} else {
3095
+			$new_request_args = array(
3096
+				'export' => 'report',
3097
+				'action' => 'registrations_report_for_event',
3098
+				'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
3099
+			);
3100
+			$this->_req_data = array_merge($this->_req_data, $new_request_args);
3101
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
3102
+				require_once(EE_CLASSES . 'EE_Export.class.php');
3103
+				$EE_Export = EE_Export::instance($this->_req_data);
3104
+				$EE_Export->export();
3105
+			}
3106
+		}
3107
+	}
3108
+
3109
+
3110
+
3111
+	/**
3112
+	 * Creates a registration report using only query parameters in the request
3113
+	 * @return void
3114
+	 */
3115
+	public function _registrations_report()
3116
+	{
3117
+		$this->_registrations_report_base('_get_registration_query_parameters');
3118
+	}
3119
+
3120
+
3121
+	public function _contact_list_export()
3122
+	{
3123
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
3124
+			require_once(EE_CLASSES . 'EE_Export.class.php');
3125
+			$EE_Export = EE_Export::instance($this->_req_data);
3126
+			$EE_Export->export_attendees();
3127
+		}
3128
+	}
3129
+
3130
+
3131
+	public function _contact_list_report()
3132
+	{
3133
+		if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
3134
+			wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
3135
+				'page'        => 'espresso_batch',
3136
+				'batch'       => 'file',
3137
+				'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
3138
+				'return_url'  => urlencode($this->_req_data['return_url']),
3139
+			)));
3140
+		} else {
3141
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
3142
+				require_once(EE_CLASSES . 'EE_Export.class.php');
3143
+				$EE_Export = EE_Export::instance($this->_req_data);
3144
+				$EE_Export->report_attendees();
3145
+			}
3146
+		}
3147
+	}
3148
+
3149
+
3150
+
3151
+
3152
+
3153
+	/***************************************        ATTENDEE DETAILS        ***************************************/
3154
+	/**
3155
+	 * This duplicates the attendee object for the given incoming registration id and attendee_id.
3156
+	 *
3157
+	 * @return void
3158
+	 * @throws EE_Error
3159
+	 */
3160
+	protected function _duplicate_attendee()
3161
+	{
3162
+		$action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
3163
+		//verify we have necessary info
3164
+		if (empty($this->_req_data['_REG_ID'])) {
3165
+			EE_Error::add_error(
3166
+				esc_html__(
3167
+					'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
3168
+					'event_espresso'
3169
+				), __FILE__, __LINE__, __FUNCTION__
3170
+			);
3171
+			$query_args = array('action' => $action);
3172
+			$this->_redirect_after_action('', '', '', $query_args, true);
3173
+		}
3174
+		//okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
3175
+		$registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
3176
+		$attendee     = $registration->attendee();
3177
+		//remove relation of existing attendee on registration
3178
+		$registration->_remove_relation_to($attendee, 'Attendee');
3179
+		//new attendee
3180
+		$new_attendee = clone $attendee;
3181
+		$new_attendee->set('ATT_ID', 0);
3182
+		$new_attendee->save();
3183
+		//add new attendee to reg
3184
+		$registration->_add_relation_to($new_attendee, 'Attendee');
3185
+		EE_Error::add_success(
3186
+			esc_html__(
3187
+				'New Contact record created.  Now make any edits you wish to make for this contact.',
3188
+				'event_espresso'
3189
+			)
3190
+		);
3191
+		//redirect to edit page for attendee
3192
+		$query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
3193
+		$this->_redirect_after_action('', '', '', $query_args, true);
3194
+	}
3195
+
3196
+
3197
+	//related to cpt routes
3198
+	protected function _insert_update_cpt_item($post_id, $post)
3199
+	{
3200
+		$success  = true;
3201
+		$attendee = EEM_Attendee::instance()->get_one_by_ID($post_id);
3202
+		//for attendee updates
3203
+		if ($post->post_type = 'espresso_attendees' && ! empty($attendee)) {
3204
+			//note we should only be UPDATING attendees at this point.
3205
+			$updated_fields = array(
3206
+				'ATT_fname'     => $this->_req_data['ATT_fname'],
3207
+				'ATT_lname'     => $this->_req_data['ATT_lname'],
3208
+				'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
3209
+				'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
3210
+				'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
3211
+				'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
3212
+				'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
3213
+				'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
3214
+				'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
3215
+				'ATT_email'     => isset($this->_req_data['ATT_email']) ? $this->_req_data['ATT_email'] : '',
3216
+				'ATT_phone'     => isset($this->_req_data['ATT_phone']) ? $this->_req_data['ATT_phone'] : '',
3217
+			);
3218
+			foreach ($updated_fields as $field => $value) {
3219
+				$attendee->set($field, $value);
3220
+			}
3221
+			$success                   = $attendee->save();
3222
+			$attendee_update_callbacks = apply_filters(
3223
+				'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
3224
+				array()
3225
+			);
3226
+			foreach ($attendee_update_callbacks as $a_callback) {
3227
+				if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
3228
+					throw new EE_Error(
3229
+						sprintf(
3230
+							esc_html__(
3231
+								'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.',
3232
+								'event_espresso'
3233
+							),
3234
+							$a_callback
3235
+						)
3236
+					);
3237
+				}
3238
+			}
3239
+		}
3240
+		if ($success === false) {
3241
+			EE_Error::add_error(
3242
+				esc_html__(
3243
+					'Something went wrong with updating the meta table data for the registration.',
3244
+					'event_espresso'
3245
+				),
3246
+				__FILE__, __FUNCTION__, __LINE__
3247
+			);
3248
+		}
3249
+	}
3250
+
3251
+
3252
+	public function trash_cpt_item($post_id)
3253
+	{
3254
+	}
3255
+
3256
+
3257
+	public function delete_cpt_item($post_id)
3258
+	{
3259
+	}
3260
+
3261
+
3262
+	public function restore_cpt_item($post_id)
3263
+	{
3264
+	}
3265
+
3266
+
3267
+	protected function _restore_cpt_item($post_id, $revision_id)
3268
+	{
3269
+	}
3270
+
3271
+
3272
+	public function attendee_editor_metaboxes()
3273
+	{
3274
+		$this->verify_cpt_object();
3275
+		remove_meta_box(
3276
+			'postexcerpt',
3277
+			esc_html__('Excerpt', 'event_espresso'),
3278
+			'post_excerpt_meta_box',
3279
+			$this->_cpt_routes[$this->_req_action],
3280
+			'normal',
3281
+			'core'
3282
+		);
3283
+		remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
3284
+		if (post_type_supports('espresso_attendees', 'excerpt')) {
3285
+			add_meta_box(
3286
+				'postexcerpt',
3287
+				esc_html__('Short Biography', 'event_espresso'),
3288
+				'post_excerpt_meta_box',
3289
+				$this->_cpt_routes[$this->_req_action],
3290
+				'normal'
3291
+			);
3292
+		}
3293
+		if (post_type_supports('espresso_attendees', 'comments')) {
3294
+			add_meta_box(
3295
+				'commentsdiv',
3296
+				esc_html__('Notes on the Contact', 'event_espresso'),
3297
+				'post_comment_meta_box',
3298
+				$this->_cpt_routes[$this->_req_action],
3299
+				'normal',
3300
+				'core'
3301
+			);
3302
+		}
3303
+		add_meta_box(
3304
+			'attendee_contact_info',
3305
+			esc_html__('Contact Info', 'event_espresso'),
3306
+			array($this, 'attendee_contact_info'),
3307
+			$this->_cpt_routes[$this->_req_action],
3308
+			'side',
3309
+			'core'
3310
+		);
3311
+		add_meta_box(
3312
+			'attendee_details_address',
3313
+			esc_html__('Address Details', 'event_espresso'),
3314
+			array($this, 'attendee_address_details'),
3315
+			$this->_cpt_routes[$this->_req_action],
3316
+			'normal',
3317
+			'core'
3318
+		);
3319
+		add_meta_box(
3320
+			'attendee_registrations',
3321
+			esc_html__('Registrations for this Contact', 'event_espresso'),
3322
+			array($this, 'attendee_registrations_meta_box'),
3323
+			$this->_cpt_routes[$this->_req_action],
3324
+			'normal',
3325
+			'high'
3326
+		);
3327
+	}
3328
+
3329
+
3330
+	/**
3331
+	 * Metabox for attendee contact info
3332
+	 *
3333
+	 * @param  WP_Post $post wp post object
3334
+	 * @return string attendee contact info ( and form )
3335
+	 * @throws DomainException
3336
+	 */
3337
+	public function attendee_contact_info($post)
3338
+	{
3339
+		//get attendee object ( should already have it )
3340
+		$this->_template_args['attendee'] = $this->_cpt_model_obj;
3341
+		$template                         = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php';
3342
+		EEH_Template::display_template($template, $this->_template_args);
3343
+	}
3344
+
3345
+
3346
+	/**
3347
+	 * Metabox for attendee details
3348
+	 *
3349
+	 * @param  WP_Post $post wp post object
3350
+	 * @return string attendee address details (and form)
3351
+	 * @throws DomainException
3352
+	 */
3353
+	public function attendee_address_details($post)
3354
+	{
3355
+		//get attendee object (should already have it)
3356
+		$this->_template_args['attendee']     = $this->_cpt_model_obj;
3357
+		$this->_template_args['state_html']   = EEH_Form_Fields::generate_form_input(
3358
+			new EE_Question_Form_Input(
3359
+				EE_Question::new_instance(
3360
+					array(
3361
+						'QST_ID'           => 0,
3362
+						'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
3363
+						'QST_system'       => 'admin-state',
3364
+					)
3365
+				),
3366
+				EE_Answer::new_instance(
3367
+					array(
3368
+						'ANS_ID'    => 0,
3369
+						'ANS_value' => $this->_cpt_model_obj->state_ID(),
3370
+					)
3371
+				),
3372
+				array(
3373
+					'input_id'       => 'STA_ID',
3374
+					'input_name'     => 'STA_ID',
3375
+					'input_prefix'   => '',
3376
+					'append_qstn_id' => false,
3377
+				)
3378
+			)
3379
+		);
3380
+		$this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
3381
+			new EE_Question_Form_Input(
3382
+				EE_Question::new_instance(
3383
+					array(
3384
+						'QST_ID'           => 0,
3385
+						'QST_display_text' => esc_html__('Country', 'event_espresso'),
3386
+						'QST_system'       => 'admin-country',
3387
+					)
3388
+				),
3389
+				EE_Answer::new_instance(
3390
+					array(
3391
+						'ANS_ID'    => 0,
3392
+						'ANS_value' => $this->_cpt_model_obj->country_ID(),
3393
+					)
3394
+				),
3395
+				array(
3396
+					'input_id'       => 'CNT_ISO',
3397
+					'input_name'     => 'CNT_ISO',
3398
+					'input_prefix'   => '',
3399
+					'append_qstn_id' => false,
3400
+				)
3401
+			)
3402
+		);
3403
+		$template                             =
3404
+			REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
3405
+		EEH_Template::display_template($template, $this->_template_args);
3406
+	}
3407
+
3408
+
3409
+	/**
3410
+	 *        _attendee_details
3411
+	 *
3412
+	 * @access protected
3413
+	 * @param $post
3414
+	 * @return void
3415
+	 * @throws DomainException
3416
+	 * @throws EE_Error
3417
+	 */
3418
+	public function attendee_registrations_meta_box($post)
3419
+	{
3420
+		$this->_template_args['attendee']      = $this->_cpt_model_obj;
3421
+		$this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
3422
+		$template                              =
3423
+			REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
3424
+		EEH_Template::display_template($template, $this->_template_args);
3425
+	}
3426
+
3427
+
3428
+	/**
3429
+	 * add in the form fields for the attendee edit
3430
+	 *
3431
+	 * @param  WP_Post $post wp post object
3432
+	 * @return string html for new form.
3433
+	 * @throws DomainException
3434
+	 */
3435
+	public function after_title_form_fields($post)
3436
+	{
3437
+		if ($post->post_type == 'espresso_attendees') {
3438
+			$template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
3439
+			$template_args['attendee'] = $this->_cpt_model_obj;
3440
+			EEH_Template::display_template($template, $template_args);
3441
+		}
3442
+	}
3443
+
3444
+
3445
+	/**
3446
+	 *        _trash_or_restore_attendee
3447
+	 *
3448
+	 * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
3449
+	 * @return void
3450
+	 * @throws EE_Error
3451
+	 * @access protected
3452
+	 */
3453
+	protected function _trash_or_restore_attendees($trash = true)
3454
+	{
3455
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3456
+		$ATT_MDL = EEM_Attendee::instance();
3457
+		$success = 1;
3458
+		//Checkboxes
3459
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3460
+			// if array has more than one element than success message should be plural
3461
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3462
+			// cycle thru checkboxes
3463
+			while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
3464
+				$updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
3465
+					: $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
3466
+				if ( ! $updated) {
3467
+					$success = 0;
3468
+				}
3469
+			}
3470
+		} else {
3471
+			// grab single id and delete
3472
+			$ATT_ID = absint($this->_req_data['ATT_ID']);
3473
+			//get attendee
3474
+			$att     = $ATT_MDL->get_one_by_ID($ATT_ID);
3475
+			$updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
3476
+			$updated = $att->save();
3477
+			if ( ! $updated) {
3478
+				$success = 0;
3479
+			}
3480
+		}
3481
+		$what        = $success > 1
3482
+			? esc_html__('Contacts', 'event_espresso')
3483
+			: esc_html__('Contact', 'event_espresso');
3484
+		$action_desc = $trash
3485
+			? esc_html__('moved to the trash', 'event_espresso')
3486
+			: esc_html__('restored', 'event_espresso');
3487
+		$this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
3488
+	}
3489 3489
 
3490 3490
 }
Please login to merge, or discard this patch.
admin_pages/registrations/EE_Attendee_Contact_List_Table.class.php 1 patch
Spacing   +36 added lines, -36 removed lines patch added patch discarded remove patch
@@ -4,7 +4,7 @@  discard block
 block discarded – undo
4 4
 class EE_Attendee_Contact_List_Table extends EE_Admin_List_Table {
5 5
 
6 6
 
7
-	public function __construct( $admin_page ) {
7
+	public function __construct($admin_page) {
8 8
 		parent::__construct($admin_page);
9 9
 	}
10 10
 
@@ -12,8 +12,8 @@  discard block
 block discarded – undo
12 12
 
13 13
 
14 14
 	protected function _setup_data() {
15
-		$this->_data = $this->_view != 'trash' ? $this->_admin_page->get_attendees( $this->_per_page ) : $this->_admin_page->get_attendees( $this->_per_page, FALSE, TRUE );
16
-		$this->_all_data_count = $this->_view != 'trash' ? $this->_admin_page->get_attendees( $this->_per_page, TRUE ) : $this->_admin_page->get_attendees( $this->_per_page,TRUE, TRUE );
15
+		$this->_data = $this->_view != 'trash' ? $this->_admin_page->get_attendees($this->_per_page) : $this->_admin_page->get_attendees($this->_per_page, FALSE, TRUE);
16
+		$this->_all_data_count = $this->_view != 'trash' ? $this->_admin_page->get_attendees($this->_per_page, TRUE) : $this->_admin_page->get_attendees($this->_per_page, TRUE, TRUE);
17 17
 	}
18 18
 
19 19
 
@@ -41,13 +41,13 @@  discard block
 block discarded – undo
41 41
 			);
42 42
 
43 43
 		$this->_sortable_columns = array(
44
-			'ATT_ID' => array( 'ATT_ID' => FALSE ),
45
-			'ATT_lname' => array( 'ATT_lname' => TRUE ), //true means its already sorted
46
-			'ATT_fname' => array( 'ATT_fname' => FALSE ),
47
-			'ATT_email' => array( 'ATT_email' => FALSE ),
48
-			'ATT_city' => array( 'ATT_city' => FALSE ),
49
-			'STA_ID' => array( 'STA_ID' => FALSE ),
50
-			'CNT_ISO' => array( 'CNT_ISO' => FALSE )
44
+			'ATT_ID' => array('ATT_ID' => FALSE),
45
+			'ATT_lname' => array('ATT_lname' => TRUE), //true means its already sorted
46
+			'ATT_fname' => array('ATT_fname' => FALSE),
47
+			'ATT_email' => array('ATT_email' => FALSE),
48
+			'ATT_city' => array('ATT_city' => FALSE),
49
+			'STA_ID' => array('STA_ID' => FALSE),
50
+			'CNT_ISO' => array('CNT_ISO' => FALSE)
51 51
 		);
52 52
 
53 53
 		$this->_hidden_columns = array();
@@ -64,9 +64,9 @@  discard block
 block discarded – undo
64 64
 
65 65
 
66 66
 	protected function _add_view_counts() {
67
-		$this->_views['in_use']['count'] = $this->_admin_page->get_attendees( $this->_per_page, TRUE );
68
-		if ( EE_Registry::instance()->CAP->current_user_can( 'ee_delete_contacts', 'espresso_registrations_delete_registration' ) ) {
69
-			$this->_views['trash']['count'] = $this->_admin_page->get_attendees( $this->_per_page,TRUE, TRUE );
67
+		$this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, TRUE);
68
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts', 'espresso_registrations_delete_registration')) {
69
+			$this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, TRUE, TRUE);
70 70
 		}
71 71
 	}
72 72
 
@@ -89,7 +89,7 @@  discard block
 block discarded – undo
89 89
 
90 90
 
91 91
 	function column_cb($item) {
92
-		return sprintf( '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', /* $1%s */ $item->ID() );
92
+		return sprintf('<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', /* $1%s */ $item->ID());
93 93
 	}
94 94
 
95 95
 
@@ -97,9 +97,9 @@  discard block
 block discarded – undo
97 97
 
98 98
 
99 99
 	function column_ATT_ID($item) {
100
-		$content =  $item->ID();
100
+		$content = $item->ID();
101 101
 		$attendee_name = $item instanceof EE_Attendee ? $item->full_name() : '';
102
-		$content .= '  <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
102
+		$content .= '  <span class="show-on-mobile-view-only">'.$attendee_name.'</span>';
103 103
 		return $content;
104 104
 	}
105 105
 
@@ -110,8 +110,8 @@  discard block
 block discarded – undo
110 110
 	function column_ATT_lname($item) {
111 111
 
112 112
 		// edit attendee link
113
-		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'edit_attendee', 'post'=>$item->ID() ), REG_ADMIN_URL );
114
-		$name_link = EE_Registry::instance()->CAP->current_user_can( 'ee_edit_contacts', 'espresso_registrations_edit_attendee' ) ?  '<a href="'.$edit_lnk_url.'" title="' . esc_attr__( 'Edit Contact', 'event_espresso' ) . '">' . $item->lname() . '</a>' : $item->lname();
113
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'edit_attendee', 'post'=>$item->ID()), REG_ADMIN_URL);
114
+		$name_link = EE_Registry::instance()->CAP->current_user_can('ee_edit_contacts', 'espresso_registrations_edit_attendee') ? '<a href="'.$edit_lnk_url.'" title="'.esc_attr__('Edit Contact', 'event_espresso').'">'.$item->lname().'</a>' : $item->lname();
115 115
 		return $name_link;
116 116
 
117 117
 	}
@@ -124,30 +124,30 @@  discard block
 block discarded – undo
124 124
 		//Build row actions
125 125
 		$actions = array();
126 126
 		// edit attendee link
127
-		if ( EE_Registry::instance()->CAP->current_user_can( 'ee_edit_contacts', 'espresso_registrations_edit_attendee' ) ) {
128
-			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'edit_attendee', 'post'=>$item->ID() ), REG_ADMIN_URL );
129
-			$actions['edit'] = '<a href="'.$edit_lnk_url.'" title="' . esc_attr__( 'Edit Contact', 'event_espresso' ) . '">' . __( 'Edit', 'event_espresso' ) . '</a>';
127
+		if (EE_Registry::instance()->CAP->current_user_can('ee_edit_contacts', 'espresso_registrations_edit_attendee')) {
128
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'edit_attendee', 'post'=>$item->ID()), REG_ADMIN_URL);
129
+			$actions['edit'] = '<a href="'.$edit_lnk_url.'" title="'.esc_attr__('Edit Contact', 'event_espresso').'">'.__('Edit', 'event_espresso').'</a>';
130 130
 		}
131 131
 
132
-		if ( $this->_view == 'in_use' ) {
132
+		if ($this->_view == 'in_use') {
133 133
 			// trash attendee link
134
-			if ( EE_Registry::instance()->CAP->current_user_can( 'ee_delete_contacts', 'espresso_registrations_trash_attendees' ) ) {
135
-				$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'trash_attendee', 'ATT_ID'=>$item->ID() ), REG_ADMIN_URL );
136
-				$actions['trash'] = '<a href="'.$trash_lnk_url.'" title="' . esc_attr__( 'Move Contact to Trash', 'event_espresso' ) . '">' . __( 'Trash', 'event_espresso' ) . '</a>';
134
+			if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts', 'espresso_registrations_trash_attendees')) {
135
+				$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'trash_attendee', 'ATT_ID'=>$item->ID()), REG_ADMIN_URL);
136
+				$actions['trash'] = '<a href="'.$trash_lnk_url.'" title="'.esc_attr__('Move Contact to Trash', 'event_espresso').'">'.__('Trash', 'event_espresso').'</a>';
137 137
 			}
138 138
 		} else {
139
-			if ( EE_Registry::instance()->CAP->current_user_can( 'ee_delete_contacts', 'espresso_registrations_restore_attendees' ) ) {
139
+			if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts', 'espresso_registrations_restore_attendees')) {
140 140
 				// restore attendee link
141
-				$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'restore_attendees', 'ATT_ID'=>$item->ID() ), REG_ADMIN_URL );
142
-				$actions['restore'] = '<a href="'.$restore_lnk_url.'" title="' . esc_attr__( 'Restore Contact', 'event_espresso' ) . '">' . __( 'Restore', 'event_espresso' ) . '</a>';
141
+				$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'restore_attendees', 'ATT_ID'=>$item->ID()), REG_ADMIN_URL);
142
+				$actions['restore'] = '<a href="'.$restore_lnk_url.'" title="'.esc_attr__('Restore Contact', 'event_espresso').'">'.__('Restore', 'event_espresso').'</a>';
143 143
 			}
144 144
 		}
145 145
 
146
-		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action'=>'edit_attendee', 'post'=>$item->ID() ), REG_ADMIN_URL );
147
-		$name_link = EE_Registry::instance()->CAP->current_user_can( 'ee_edit_contacts', 'espresso_registrations_edit_attendee' ) ?  '<a href="'.$edit_lnk_url.'" title="' . esc_attr__( 'Edit Contact', 'event_espresso' ) . '">' . $item->fname() . '</a>' : $item->fname();
146
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array('action'=>'edit_attendee', 'post'=>$item->ID()), REG_ADMIN_URL);
147
+		$name_link = EE_Registry::instance()->CAP->current_user_can('ee_edit_contacts', 'espresso_registrations_edit_attendee') ? '<a href="'.$edit_lnk_url.'" title="'.esc_attr__('Edit Contact', 'event_espresso').'">'.$item->fname().'</a>' : $item->fname();
148 148
 
149 149
 		//Return the name contents
150
-		return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions) );
150
+		return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions));
151 151
 	}
152 152
 
153 153
 
@@ -155,7 +155,7 @@  discard block
 block discarded – undo
155 155
 
156 156
 
157 157
 	function column_ATT_email($item) {
158
-		return '<a href="mailto:' . $item->email() . '">' . $item->email() . '</a>';
158
+		return '<a href="mailto:'.$item->email().'">'.$item->email().'</a>';
159 159
 	}
160 160
 
161 161
 
@@ -175,8 +175,8 @@  discard block
 block discarded – undo
175 175
 
176 176
 	function column_STA_ID($item) {
177 177
 		$states = EEM_State::instance()->get_all_states();
178
-		$state = isset( $states[ $item->state_ID() ] ) ? $states[ $item->state_ID() ]->get( 'STA_name' ) : $item->state_ID();
179
-		return ! is_numeric( $state ) ? $state : '';
178
+		$state = isset($states[$item->state_ID()]) ? $states[$item->state_ID()]->get('STA_name') : $item->state_ID();
179
+		return ! is_numeric($state) ? $state : '';
180 180
 	}
181 181
 
182 182
 
@@ -184,8 +184,8 @@  discard block
 block discarded – undo
184 184
 	function column_CNT_ISO($item) {
185 185
 		$countries = EEM_Country::instance()->get_all_countries();
186 186
 		//EEH_Debug_Tools::printr( $countries, '$countries  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
187
-		$country = isset( $countries[ $item->country_ID() ] ) ? $countries[ $item->country_ID() ]->get( 'CNT_name' ) : $item->country_ID();
188
-		return ! is_numeric( $country ) ? $country : '';
187
+		$country = isset($countries[$item->country_ID()]) ? $countries[$item->country_ID()]->get('CNT_name') : $item->country_ID();
188
+		return ! is_numeric($country) ? $country : '';
189 189
 	}
190 190
 
191 191
 
Please login to merge, or discard this patch.