Completed
Branch FET-8385-datetime-ticket-selec... (1e9ded)
by
unknown
83:08 queued 72:04
created
core/admin/EE_Admin_Page.core.php 1 patch
Indentation   +3305 added lines, -3305 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,2120 +28,2120 @@  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
-        //enqueue global styles
1541
-        wp_enqueue_style('ee-admin-css');
1542
-        /** SCRIPTS **/
1543
-        //register all scripts
1544
-        wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
1545
-        wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
1546
-        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);
1547
-        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);
1548
-        // register jQuery Validate - see /includes/functions/wp_hooks.php
1549
-        add_filter('FHEE_load_jquery_validate', '__return_true');
1550
-        add_filter('FHEE_load_joyride', '__return_true');
1551
-        //script for sorting tables
1552
-        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);
1553
-        //script for parsing uri's
1554
-        wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
1555
-        //and parsing associative serialized form elements
1556
-        wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
1557
-        //helpers scripts
1558
-        wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
1559
-        wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
1560
-        wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
1561
-        wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
1562
-        //google charts
1563
-        wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
1564
-        //enqueue global scripts
1565
-        //taking care of metaboxes
1566
-        if ((isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes'])) && empty($this->_cpt_route)) {
1567
-            wp_enqueue_script('dashboard');
1568
-        }
1569
-        //enqueue thickbox for ee help popups.  default is to enqueue unless its explicitly set to false since we're assuming all EE pages will have popups
1570
-        if ( ! isset($this->_route_config['has_help_popups']) || (isset($this->_route_config['has_help_popups']) && $this->_route_config['has_help_popups'])) {
1571
-            wp_enqueue_script('ee_admin_js');
1572
-            wp_enqueue_style('ee-admin-css');
1573
-        }
1574
-        //localize script for ajax lazy loading
1575
-        $lazy_loader_container_ids = apply_filters('FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content'));
1576
-        wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
1577
-        /**
1578
-         * help tour stuff
1579
-         */
1580
-        if ( ! empty($this->_help_tour)) {
1581
-            //register the js for kicking things off
1582
-            wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
1583
-            //setup tours for the js tour object
1584
-            foreach ($this->_help_tour['tours'] as $tour) {
1585
-                $tours[] = array(
1586
-                        'id'      => $tour->get_slug(),
1587
-                        'options' => $tour->get_options(),
1588
-                );
1589
-            }
1590
-            wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
1591
-            //admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
1592
-        }
1593
-    }
1594
-
1595
-
1596
-
1597
-    /**
1598
-     *        admin_footer_scripts_eei18n_js_strings
1599
-     *
1600
-     * @access        public
1601
-     * @return        void
1602
-     */
1603
-    public function admin_footer_scripts_eei18n_js_strings()
1604
-    {
1605
-        EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
1606
-        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');
1607
-        EE_Registry::$i18n_js_strings['January'] = __('January', 'event_espresso');
1608
-        EE_Registry::$i18n_js_strings['February'] = __('February', 'event_espresso');
1609
-        EE_Registry::$i18n_js_strings['March'] = __('March', 'event_espresso');
1610
-        EE_Registry::$i18n_js_strings['April'] = __('April', 'event_espresso');
1611
-        EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
1612
-        EE_Registry::$i18n_js_strings['June'] = __('June', 'event_espresso');
1613
-        EE_Registry::$i18n_js_strings['July'] = __('July', 'event_espresso');
1614
-        EE_Registry::$i18n_js_strings['August'] = __('August', 'event_espresso');
1615
-        EE_Registry::$i18n_js_strings['September'] = __('September', 'event_espresso');
1616
-        EE_Registry::$i18n_js_strings['October'] = __('October', 'event_espresso');
1617
-        EE_Registry::$i18n_js_strings['November'] = __('November', 'event_espresso');
1618
-        EE_Registry::$i18n_js_strings['December'] = __('December', 'event_espresso');
1619
-        EE_Registry::$i18n_js_strings['Jan'] = __('Jan', 'event_espresso');
1620
-        EE_Registry::$i18n_js_strings['Feb'] = __('Feb', 'event_espresso');
1621
-        EE_Registry::$i18n_js_strings['Mar'] = __('Mar', 'event_espresso');
1622
-        EE_Registry::$i18n_js_strings['Apr'] = __('Apr', 'event_espresso');
1623
-        EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
1624
-        EE_Registry::$i18n_js_strings['Jun'] = __('Jun', 'event_espresso');
1625
-        EE_Registry::$i18n_js_strings['Jul'] = __('Jul', 'event_espresso');
1626
-        EE_Registry::$i18n_js_strings['Aug'] = __('Aug', 'event_espresso');
1627
-        EE_Registry::$i18n_js_strings['Sep'] = __('Sep', 'event_espresso');
1628
-        EE_Registry::$i18n_js_strings['Oct'] = __('Oct', 'event_espresso');
1629
-        EE_Registry::$i18n_js_strings['Nov'] = __('Nov', 'event_espresso');
1630
-        EE_Registry::$i18n_js_strings['Dec'] = __('Dec', 'event_espresso');
1631
-        EE_Registry::$i18n_js_strings['Sunday'] = __('Sunday', 'event_espresso');
1632
-        EE_Registry::$i18n_js_strings['Monday'] = __('Monday', 'event_espresso');
1633
-        EE_Registry::$i18n_js_strings['Tuesday'] = __('Tuesday', 'event_espresso');
1634
-        EE_Registry::$i18n_js_strings['Wednesday'] = __('Wednesday', 'event_espresso');
1635
-        EE_Registry::$i18n_js_strings['Thursday'] = __('Thursday', 'event_espresso');
1636
-        EE_Registry::$i18n_js_strings['Friday'] = __('Friday', 'event_espresso');
1637
-        EE_Registry::$i18n_js_strings['Saturday'] = __('Saturday', 'event_espresso');
1638
-        EE_Registry::$i18n_js_strings['Sun'] = __('Sun', 'event_espresso');
1639
-        EE_Registry::$i18n_js_strings['Mon'] = __('Mon', 'event_espresso');
1640
-        EE_Registry::$i18n_js_strings['Tue'] = __('Tue', 'event_espresso');
1641
-        EE_Registry::$i18n_js_strings['Wed'] = __('Wed', 'event_espresso');
1642
-        EE_Registry::$i18n_js_strings['Thu'] = __('Thu', 'event_espresso');
1643
-        EE_Registry::$i18n_js_strings['Fri'] = __('Fri', 'event_espresso');
1644
-        EE_Registry::$i18n_js_strings['Sat'] = __('Sat', 'event_espresso');
1645
-        //setting on espresso_core instead of ee_admin_js because espresso_core is enqueued by the maintenance
1646
-        //admin page when in maintenance mode and ee_admin_js is not loaded then.  This works everywhere else because
1647
-        //espresso_core is listed as a dependency of ee_admin_js.
1648
-        wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
1649
-    }
1650
-
1651
-
1652
-
1653
-    /**
1654
-     *        load enhanced xdebug styles for ppl with failing eyesight
1655
-     *
1656
-     * @access        public
1657
-     * @return        void
1658
-     */
1659
-    public function add_xdebug_style()
1660
-    {
1661
-        echo '<style>.xdebug-error { font-size:1.5em; }</style>';
1662
-    }
1663
-
1664
-
1665
-    /************************/
1666
-    /** LIST TABLE METHODS **/
1667
-    /************************/
1668
-    /**
1669
-     * this sets up the list table if the current view requires it.
1670
-     *
1671
-     * @access protected
1672
-     * @return void
1673
-     */
1674
-    protected function _set_list_table()
1675
-    {
1676
-        //first is this a list_table view?
1677
-        if ( ! isset($this->_route_config['list_table'])) {
1678
-            return;
1679
-        } //not a list_table view so get out.
1680
-        //list table functions are per view specific (because some admin pages might have more than one listtable!)
1681
-        if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
1682
-            //user error msg
1683
-            $error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
1684
-            //developer error msg
1685
-            $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'),
1686
-                            $this->_req_action, '_set_list_table_views_' . $this->_req_action);
1687
-            throw new EE_Error($error_msg);
1688
-        }
1689
-        //let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
1690
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
1691
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
1692
-        $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
1693
-        $this->_set_list_table_view();
1694
-        $this->_set_list_table_object();
1695
-    }
1696
-
1697
-
1698
-
1699
-    /**
1700
-     *        set current view for List Table
1701
-     *
1702
-     * @access public
1703
-     * @return array
1704
-     */
1705
-    protected function _set_list_table_view()
1706
-    {
1707
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1708
-        // looking at active items or dumpster diving ?
1709
-        if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
1710
-            $this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
1711
-        } else {
1712
-            $this->_view = sanitize_key($this->_req_data['status']);
1713
-        }
1714
-    }
1715
-
1716
-
1717
-
1718
-    /**
1719
-     * _set_list_table_object
1720
-     * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
1721
-     *
1722
-     * @throws \EE_Error
1723
-     */
1724
-    protected function _set_list_table_object()
1725
-    {
1726
-        if (isset($this->_route_config['list_table'])) {
1727
-            if ( ! class_exists($this->_route_config['list_table'])) {
1728
-                throw new EE_Error(
1729
-                        sprintf(
1730
-                                __(
1731
-                                        '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.',
1732
-                                        'event_espresso'
1733
-                                ),
1734
-                                $this->_route_config['list_table'],
1735
-                                get_class($this)
1736
-                        )
1737
-                );
1738
-            }
1739
-            $list_table = $this->_route_config['list_table'];
1740
-            $this->_list_table_object = new $list_table($this);
1741
-        }
1742
-    }
1743
-
1744
-
1745
-
1746
-    /**
1747
-     * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
1748
-     *
1749
-     * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
1750
-     *                                                    urls.  The array should be indexed by the view it is being
1751
-     *                                                    added to.
1752
-     * @return array
1753
-     */
1754
-    public function get_list_table_view_RLs($extra_query_args = array())
1755
-    {
1756
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1757
-        if (empty($this->_views)) {
1758
-            $this->_views = array();
1759
-        }
1760
-        // cycle thru views
1761
-        foreach ($this->_views as $key => $view) {
1762
-            $query_args = array();
1763
-            // check for current view
1764
-            $this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
1765
-            $query_args['action'] = $this->_req_action;
1766
-            $query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
1767
-            $query_args['status'] = $view['slug'];
1768
-            //merge any other arguments sent in.
1769
-            if (isset($extra_query_args[$view['slug']])) {
1770
-                $query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
1771
-            }
1772
-            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
1773
-        }
1774
-        return $this->_views;
1775
-    }
1776
-
1777
-
1778
-
1779
-    /**
1780
-     * _entries_per_page_dropdown
1781
-     * generates a drop down box for selecting the number of visiable rows in an admin page list table
1782
-     *
1783
-     * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
1784
-     * @access protected
1785
-     * @param int $max_entries total number of rows in the table
1786
-     * @return string
1787
-     */
1788
-    protected function _entries_per_page_dropdown($max_entries = false)
1789
-    {
1790
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1791
-        $values = array(10, 25, 50, 100);
1792
-        $per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
1793
-        if ($max_entries) {
1794
-            $values[] = $max_entries;
1795
-            sort($values);
1796
-        }
1797
-        $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
+		//enqueue global styles
1541
+		wp_enqueue_style('ee-admin-css');
1542
+		/** SCRIPTS **/
1543
+		//register all scripts
1544
+		wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
1545
+		wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, true);
1546
+		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);
1547
+		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);
1548
+		// register jQuery Validate - see /includes/functions/wp_hooks.php
1549
+		add_filter('FHEE_load_jquery_validate', '__return_true');
1550
+		add_filter('FHEE_load_joyride', '__return_true');
1551
+		//script for sorting tables
1552
+		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);
1553
+		//script for parsing uri's
1554
+		wp_register_script('ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, true);
1555
+		//and parsing associative serialized form elements
1556
+		wp_register_script('ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
1557
+		//helpers scripts
1558
+		wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
1559
+		wp_register_script('ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, true);
1560
+		wp_register_script('ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, true);
1561
+		wp_register_script('ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon', 'ee-moment'), EVENT_ESPRESSO_VERSION, true);
1562
+		//google charts
1563
+		wp_register_script('google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false);
1564
+		//enqueue global scripts
1565
+		//taking care of metaboxes
1566
+		if ((isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes'])) && empty($this->_cpt_route)) {
1567
+			wp_enqueue_script('dashboard');
1568
+		}
1569
+		//enqueue thickbox for ee help popups.  default is to enqueue unless its explicitly set to false since we're assuming all EE pages will have popups
1570
+		if ( ! isset($this->_route_config['has_help_popups']) || (isset($this->_route_config['has_help_popups']) && $this->_route_config['has_help_popups'])) {
1571
+			wp_enqueue_script('ee_admin_js');
1572
+			wp_enqueue_style('ee-admin-css');
1573
+		}
1574
+		//localize script for ajax lazy loading
1575
+		$lazy_loader_container_ids = apply_filters('FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content'));
1576
+		wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
1577
+		/**
1578
+		 * help tour stuff
1579
+		 */
1580
+		if ( ! empty($this->_help_tour)) {
1581
+			//register the js for kicking things off
1582
+			wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, true);
1583
+			//setup tours for the js tour object
1584
+			foreach ($this->_help_tour['tours'] as $tour) {
1585
+				$tours[] = array(
1586
+						'id'      => $tour->get_slug(),
1587
+						'options' => $tour->get_options(),
1588
+				);
1589
+			}
1590
+			wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
1591
+			//admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
1592
+		}
1593
+	}
1594
+
1595
+
1596
+
1597
+	/**
1598
+	 *        admin_footer_scripts_eei18n_js_strings
1599
+	 *
1600
+	 * @access        public
1601
+	 * @return        void
1602
+	 */
1603
+	public function admin_footer_scripts_eei18n_js_strings()
1604
+	{
1605
+		EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
1606
+		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');
1607
+		EE_Registry::$i18n_js_strings['January'] = __('January', 'event_espresso');
1608
+		EE_Registry::$i18n_js_strings['February'] = __('February', 'event_espresso');
1609
+		EE_Registry::$i18n_js_strings['March'] = __('March', 'event_espresso');
1610
+		EE_Registry::$i18n_js_strings['April'] = __('April', 'event_espresso');
1611
+		EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
1612
+		EE_Registry::$i18n_js_strings['June'] = __('June', 'event_espresso');
1613
+		EE_Registry::$i18n_js_strings['July'] = __('July', 'event_espresso');
1614
+		EE_Registry::$i18n_js_strings['August'] = __('August', 'event_espresso');
1615
+		EE_Registry::$i18n_js_strings['September'] = __('September', 'event_espresso');
1616
+		EE_Registry::$i18n_js_strings['October'] = __('October', 'event_espresso');
1617
+		EE_Registry::$i18n_js_strings['November'] = __('November', 'event_espresso');
1618
+		EE_Registry::$i18n_js_strings['December'] = __('December', 'event_espresso');
1619
+		EE_Registry::$i18n_js_strings['Jan'] = __('Jan', 'event_espresso');
1620
+		EE_Registry::$i18n_js_strings['Feb'] = __('Feb', 'event_espresso');
1621
+		EE_Registry::$i18n_js_strings['Mar'] = __('Mar', 'event_espresso');
1622
+		EE_Registry::$i18n_js_strings['Apr'] = __('Apr', 'event_espresso');
1623
+		EE_Registry::$i18n_js_strings['May'] = __('May', 'event_espresso');
1624
+		EE_Registry::$i18n_js_strings['Jun'] = __('Jun', 'event_espresso');
1625
+		EE_Registry::$i18n_js_strings['Jul'] = __('Jul', 'event_espresso');
1626
+		EE_Registry::$i18n_js_strings['Aug'] = __('Aug', 'event_espresso');
1627
+		EE_Registry::$i18n_js_strings['Sep'] = __('Sep', 'event_espresso');
1628
+		EE_Registry::$i18n_js_strings['Oct'] = __('Oct', 'event_espresso');
1629
+		EE_Registry::$i18n_js_strings['Nov'] = __('Nov', 'event_espresso');
1630
+		EE_Registry::$i18n_js_strings['Dec'] = __('Dec', 'event_espresso');
1631
+		EE_Registry::$i18n_js_strings['Sunday'] = __('Sunday', 'event_espresso');
1632
+		EE_Registry::$i18n_js_strings['Monday'] = __('Monday', 'event_espresso');
1633
+		EE_Registry::$i18n_js_strings['Tuesday'] = __('Tuesday', 'event_espresso');
1634
+		EE_Registry::$i18n_js_strings['Wednesday'] = __('Wednesday', 'event_espresso');
1635
+		EE_Registry::$i18n_js_strings['Thursday'] = __('Thursday', 'event_espresso');
1636
+		EE_Registry::$i18n_js_strings['Friday'] = __('Friday', 'event_espresso');
1637
+		EE_Registry::$i18n_js_strings['Saturday'] = __('Saturday', 'event_espresso');
1638
+		EE_Registry::$i18n_js_strings['Sun'] = __('Sun', 'event_espresso');
1639
+		EE_Registry::$i18n_js_strings['Mon'] = __('Mon', 'event_espresso');
1640
+		EE_Registry::$i18n_js_strings['Tue'] = __('Tue', 'event_espresso');
1641
+		EE_Registry::$i18n_js_strings['Wed'] = __('Wed', 'event_espresso');
1642
+		EE_Registry::$i18n_js_strings['Thu'] = __('Thu', 'event_espresso');
1643
+		EE_Registry::$i18n_js_strings['Fri'] = __('Fri', 'event_espresso');
1644
+		EE_Registry::$i18n_js_strings['Sat'] = __('Sat', 'event_espresso');
1645
+		//setting on espresso_core instead of ee_admin_js because espresso_core is enqueued by the maintenance
1646
+		//admin page when in maintenance mode and ee_admin_js is not loaded then.  This works everywhere else because
1647
+		//espresso_core is listed as a dependency of ee_admin_js.
1648
+		wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
1649
+	}
1650
+
1651
+
1652
+
1653
+	/**
1654
+	 *        load enhanced xdebug styles for ppl with failing eyesight
1655
+	 *
1656
+	 * @access        public
1657
+	 * @return        void
1658
+	 */
1659
+	public function add_xdebug_style()
1660
+	{
1661
+		echo '<style>.xdebug-error { font-size:1.5em; }</style>';
1662
+	}
1663
+
1664
+
1665
+	/************************/
1666
+	/** LIST TABLE METHODS **/
1667
+	/************************/
1668
+	/**
1669
+	 * this sets up the list table if the current view requires it.
1670
+	 *
1671
+	 * @access protected
1672
+	 * @return void
1673
+	 */
1674
+	protected function _set_list_table()
1675
+	{
1676
+		//first is this a list_table view?
1677
+		if ( ! isset($this->_route_config['list_table'])) {
1678
+			return;
1679
+		} //not a list_table view so get out.
1680
+		//list table functions are per view specific (because some admin pages might have more than one listtable!)
1681
+		if (call_user_func(array($this, '_set_list_table_views_' . $this->_req_action)) === false) {
1682
+			//user error msg
1683
+			$error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso');
1684
+			//developer error msg
1685
+			$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'),
1686
+							$this->_req_action, '_set_list_table_views_' . $this->_req_action);
1687
+			throw new EE_Error($error_msg);
1688
+		}
1689
+		//let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
1690
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views);
1691
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
1692
+		$this->_views = apply_filters('FHEE_list_table_views', $this->_views);
1693
+		$this->_set_list_table_view();
1694
+		$this->_set_list_table_object();
1695
+	}
1696
+
1697
+
1698
+
1699
+	/**
1700
+	 *        set current view for List Table
1701
+	 *
1702
+	 * @access public
1703
+	 * @return array
1704
+	 */
1705
+	protected function _set_list_table_view()
1706
+	{
1707
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1708
+		// looking at active items or dumpster diving ?
1709
+		if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
1710
+			$this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
1711
+		} else {
1712
+			$this->_view = sanitize_key($this->_req_data['status']);
1713
+		}
1714
+	}
1715
+
1716
+
1717
+
1718
+	/**
1719
+	 * _set_list_table_object
1720
+	 * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
1721
+	 *
1722
+	 * @throws \EE_Error
1723
+	 */
1724
+	protected function _set_list_table_object()
1725
+	{
1726
+		if (isset($this->_route_config['list_table'])) {
1727
+			if ( ! class_exists($this->_route_config['list_table'])) {
1728
+				throw new EE_Error(
1729
+						sprintf(
1730
+								__(
1731
+										'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.',
1732
+										'event_espresso'
1733
+								),
1734
+								$this->_route_config['list_table'],
1735
+								get_class($this)
1736
+						)
1737
+				);
1738
+			}
1739
+			$list_table = $this->_route_config['list_table'];
1740
+			$this->_list_table_object = new $list_table($this);
1741
+		}
1742
+	}
1743
+
1744
+
1745
+
1746
+	/**
1747
+	 * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
1748
+	 *
1749
+	 * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
1750
+	 *                                                    urls.  The array should be indexed by the view it is being
1751
+	 *                                                    added to.
1752
+	 * @return array
1753
+	 */
1754
+	public function get_list_table_view_RLs($extra_query_args = array())
1755
+	{
1756
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1757
+		if (empty($this->_views)) {
1758
+			$this->_views = array();
1759
+		}
1760
+		// cycle thru views
1761
+		foreach ($this->_views as $key => $view) {
1762
+			$query_args = array();
1763
+			// check for current view
1764
+			$this->_views[$key]['class'] = $this->_view == $view['slug'] ? 'current' : '';
1765
+			$query_args['action'] = $this->_req_action;
1766
+			$query_args[$this->_req_action . '_nonce'] = wp_create_nonce($query_args['action'] . '_nonce');
1767
+			$query_args['status'] = $view['slug'];
1768
+			//merge any other arguments sent in.
1769
+			if (isset($extra_query_args[$view['slug']])) {
1770
+				$query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
1771
+			}
1772
+			$this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
1773
+		}
1774
+		return $this->_views;
1775
+	}
1776
+
1777
+
1778
+
1779
+	/**
1780
+	 * _entries_per_page_dropdown
1781
+	 * generates a drop down box for selecting the number of visiable rows in an admin page list table
1782
+	 *
1783
+	 * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
1784
+	 * @access protected
1785
+	 * @param int $max_entries total number of rows in the table
1786
+	 * @return string
1787
+	 */
1788
+	protected function _entries_per_page_dropdown($max_entries = false)
1789
+	{
1790
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1791
+		$values = array(10, 25, 50, 100);
1792
+		$per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
1793
+		if ($max_entries) {
1794
+			$values[] = $max_entries;
1795
+			sort($values);
1796
+		}
1797
+		$entries_per_page_dropdown = '
1798 1798
 			<div id="entries-per-page-dv" class="alignleft actions">
1799 1799
 				<label class="hide-if-no-js">
1800 1800
 					Show
1801 1801
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
1802
-        foreach ($values as $value) {
1803
-            if ($value < $max_entries) {
1804
-                $selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
1805
-                $entries_per_page_dropdown .= '
1802
+		foreach ($values as $value) {
1803
+			if ($value < $max_entries) {
1804
+				$selected = $value == $per_page ? ' selected="' . $per_page . '"' : '';
1805
+				$entries_per_page_dropdown .= '
1806 1806
 						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
1807
-            }
1808
-        }
1809
-        $selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
1810
-        $entries_per_page_dropdown .= '
1807
+			}
1808
+		}
1809
+		$selected = $max_entries == $per_page ? ' selected="' . $per_page . '"' : '';
1810
+		$entries_per_page_dropdown .= '
1811 1811
 						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
1812
-        $entries_per_page_dropdown .= '
1812
+		$entries_per_page_dropdown .= '
1813 1813
 					</select>
1814 1814
 					entries
1815 1815
 				</label>
1816 1816
 				<input id="entries-per-page-btn" class="button-secondary" type="submit" value="Go" >
1817 1817
 			</div>
1818 1818
 		';
1819
-        return $entries_per_page_dropdown;
1820
-    }
1821
-
1822
-
1823
-
1824
-    /**
1825
-     *        _set_search_attributes
1826
-     *
1827
-     * @access        protected
1828
-     * @return        void
1829
-     */
1830
-    public function _set_search_attributes()
1831
-    {
1832
-        $this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
1833
-        $this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
1834
-    }
1835
-
1836
-    /*** END LIST TABLE METHODS **/
1837
-    /*****************************/
1838
-    /**
1839
-     *        _add_registered_metaboxes
1840
-     *        this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
1841
-     *
1842
-     * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
1843
-     * @access private
1844
-     * @return void
1845
-     */
1846
-    private function _add_registered_meta_boxes()
1847
-    {
1848
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1849
-        //we only add meta boxes if the page_route calls for it
1850
-        if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
1851
-            && is_array(
1852
-                    $this->_route_config['metaboxes']
1853
-            )
1854
-        ) {
1855
-            // this simply loops through the callbacks provided
1856
-            // and checks if there is a corresponding callback registered by the child
1857
-            // if there is then we go ahead and process the metabox loader.
1858
-            foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
1859
-                // first check for Closures
1860
-                if ($metabox_callback instanceof Closure) {
1861
-                    $result = $metabox_callback();
1862
-                } else if (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
1863
-                    $result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
1864
-                } else {
1865
-                    $result = call_user_func(array($this, &$metabox_callback));
1866
-                }
1867
-                if ($result === false) {
1868
-                    // user error msg
1869
-                    $error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
1870
-                    // developer error msg
1871
-                    $error_msg .= '||' . sprintf(
1872
-                                    __(
1873
-                                            '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.',
1874
-                                            'event_espresso'
1875
-                                    ),
1876
-                                    $metabox_callback
1877
-                            );
1878
-                    throw new EE_Error($error_msg);
1879
-                }
1880
-            }
1881
-        }
1882
-    }
1883
-
1884
-
1885
-
1886
-    /**
1887
-     * _add_screen_columns
1888
-     * 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.
1889
-     *
1890
-     * @access private
1891
-     * @return void
1892
-     */
1893
-    private function _add_screen_columns()
1894
-    {
1895
-        if (
1896
-                is_array($this->_route_config)
1897
-                && isset($this->_route_config['columns'])
1898
-                && is_array($this->_route_config['columns'])
1899
-                && count($this->_route_config['columns']) === 2
1900
-        ) {
1901
-            add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
1902
-            $this->_template_args['num_columns'] = $this->_route_config['columns'][0];
1903
-            $screen_id = $this->_current_screen->id;
1904
-            $screen_columns = (int)get_user_option("screen_layout_$screen_id");
1905
-            $total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
1906
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
1907
-            $this->_template_args['current_page'] = $this->_wp_page_slug;
1908
-            $this->_template_args['screen'] = $this->_current_screen;
1909
-            $this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
1910
-            //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.
1911
-            $this->_route_config['has_metaboxes'] = true;
1912
-        }
1913
-    }
1914
-
1915
-
1916
-
1917
-    /**********************************/
1918
-    /** GLOBALLY AVAILABLE METABOXES **/
1919
-    /**
1920
-     * 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
1921
-     * loaded on.
1922
-     */
1923
-    private function _espresso_news_post_box()
1924
-    {
1925
-        $news_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('New @ Event Espresso', 'event_espresso'));
1926
-        add_meta_box('espresso_news_post_box', $news_box_title, array(
1927
-                $this,
1928
-                'espresso_news_post_box',
1929
-        ), $this->_wp_page_slug, 'side');
1930
-    }
1931
-
1932
-
1933
-
1934
-    /**
1935
-     * Code for setting up espresso ratings request metabox.
1936
-     */
1937
-    protected function _espresso_ratings_request()
1938
-    {
1939
-        if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
1940
-            return '';
1941
-        }
1942
-        $ratings_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso'));
1943
-        add_meta_box('espresso_ratings_request', $ratings_box_title, array(
1944
-                $this,
1945
-                'espresso_ratings_request',
1946
-        ), $this->_wp_page_slug, 'side');
1947
-    }
1948
-
1949
-
1950
-
1951
-    /**
1952
-     * Code for setting up espresso ratings request metabox content.
1953
-     */
1954
-    public function espresso_ratings_request()
1955
-    {
1956
-        $template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
1957
-        EEH_Template::display_template($template_path, array());
1958
-    }
1959
-
1960
-
1961
-
1962
-    public static function cached_rss_display($rss_id, $url)
1963
-    {
1964
-        $loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
1965
-        $doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
1966
-        $pre = '<div class="espresso-rss-display">' . "\n\t";
1967
-        $pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
1968
-        $post = '</div>' . "\n";
1969
-        $cache_key = 'ee_rss_' . md5($rss_id);
1970
-        if (false != ($output = get_transient($cache_key))) {
1971
-            echo $pre . $output . $post;
1972
-            return true;
1973
-        }
1974
-        if ( ! $doing_ajax) {
1975
-            echo $pre . $loading . $post;
1976
-            return false;
1977
-        }
1978
-        ob_start();
1979
-        wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
1980
-        set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
1981
-        return true;
1982
-    }
1983
-
1984
-
1985
-
1986
-    public function espresso_news_post_box()
1987
-    {
1988
-        ?>
1819
+		return $entries_per_page_dropdown;
1820
+	}
1821
+
1822
+
1823
+
1824
+	/**
1825
+	 *        _set_search_attributes
1826
+	 *
1827
+	 * @access        protected
1828
+	 * @return        void
1829
+	 */
1830
+	public function _set_search_attributes()
1831
+	{
1832
+		$this->_template_args['search']['btn_label'] = sprintf(__('Search %s', 'event_espresso'), empty($this->_search_btn_label) ? $this->page_label : $this->_search_btn_label);
1833
+		$this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
1834
+	}
1835
+
1836
+	/*** END LIST TABLE METHODS **/
1837
+	/*****************************/
1838
+	/**
1839
+	 *        _add_registered_metaboxes
1840
+	 *        this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
1841
+	 *
1842
+	 * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
1843
+	 * @access private
1844
+	 * @return void
1845
+	 */
1846
+	private function _add_registered_meta_boxes()
1847
+	{
1848
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1849
+		//we only add meta boxes if the page_route calls for it
1850
+		if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
1851
+			&& is_array(
1852
+					$this->_route_config['metaboxes']
1853
+			)
1854
+		) {
1855
+			// this simply loops through the callbacks provided
1856
+			// and checks if there is a corresponding callback registered by the child
1857
+			// if there is then we go ahead and process the metabox loader.
1858
+			foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
1859
+				// first check for Closures
1860
+				if ($metabox_callback instanceof Closure) {
1861
+					$result = $metabox_callback();
1862
+				} else if (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
1863
+					$result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
1864
+				} else {
1865
+					$result = call_user_func(array($this, &$metabox_callback));
1866
+				}
1867
+				if ($result === false) {
1868
+					// user error msg
1869
+					$error_msg = __('An error occurred. The  requested metabox could not be found.', 'event_espresso');
1870
+					// developer error msg
1871
+					$error_msg .= '||' . sprintf(
1872
+									__(
1873
+											'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.',
1874
+											'event_espresso'
1875
+									),
1876
+									$metabox_callback
1877
+							);
1878
+					throw new EE_Error($error_msg);
1879
+				}
1880
+			}
1881
+		}
1882
+	}
1883
+
1884
+
1885
+
1886
+	/**
1887
+	 * _add_screen_columns
1888
+	 * 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.
1889
+	 *
1890
+	 * @access private
1891
+	 * @return void
1892
+	 */
1893
+	private function _add_screen_columns()
1894
+	{
1895
+		if (
1896
+				is_array($this->_route_config)
1897
+				&& isset($this->_route_config['columns'])
1898
+				&& is_array($this->_route_config['columns'])
1899
+				&& count($this->_route_config['columns']) === 2
1900
+		) {
1901
+			add_screen_option('layout_columns', array('max' => (int)$this->_route_config['columns'][0], 'default' => (int)$this->_route_config['columns'][1]));
1902
+			$this->_template_args['num_columns'] = $this->_route_config['columns'][0];
1903
+			$screen_id = $this->_current_screen->id;
1904
+			$screen_columns = (int)get_user_option("screen_layout_$screen_id");
1905
+			$total_columns = ! empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
1906
+			$this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
1907
+			$this->_template_args['current_page'] = $this->_wp_page_slug;
1908
+			$this->_template_args['screen'] = $this->_current_screen;
1909
+			$this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
1910
+			//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.
1911
+			$this->_route_config['has_metaboxes'] = true;
1912
+		}
1913
+	}
1914
+
1915
+
1916
+
1917
+	/**********************************/
1918
+	/** GLOBALLY AVAILABLE METABOXES **/
1919
+	/**
1920
+	 * 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
1921
+	 * loaded on.
1922
+	 */
1923
+	private function _espresso_news_post_box()
1924
+	{
1925
+		$news_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('New @ Event Espresso', 'event_espresso'));
1926
+		add_meta_box('espresso_news_post_box', $news_box_title, array(
1927
+				$this,
1928
+				'espresso_news_post_box',
1929
+		), $this->_wp_page_slug, 'side');
1930
+	}
1931
+
1932
+
1933
+
1934
+	/**
1935
+	 * Code for setting up espresso ratings request metabox.
1936
+	 */
1937
+	protected function _espresso_ratings_request()
1938
+	{
1939
+		if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
1940
+			return '';
1941
+		}
1942
+		$ratings_box_title = apply_filters('FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso'));
1943
+		add_meta_box('espresso_ratings_request', $ratings_box_title, array(
1944
+				$this,
1945
+				'espresso_ratings_request',
1946
+		), $this->_wp_page_slug, 'side');
1947
+	}
1948
+
1949
+
1950
+
1951
+	/**
1952
+	 * Code for setting up espresso ratings request metabox content.
1953
+	 */
1954
+	public function espresso_ratings_request()
1955
+	{
1956
+		$template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
1957
+		EEH_Template::display_template($template_path, array());
1958
+	}
1959
+
1960
+
1961
+
1962
+	public static function cached_rss_display($rss_id, $url)
1963
+	{
1964
+		$loading = '<p class="widget-loading hide-if-no-js">' . __('Loading&#8230;') . '</p><p class="hide-if-js">' . __('This widget requires JavaScript.') . '</p>';
1965
+		$doing_ajax = (defined('DOING_AJAX') && DOING_AJAX);
1966
+		$pre = '<div class="espresso-rss-display">' . "\n\t";
1967
+		$pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
1968
+		$post = '</div>' . "\n";
1969
+		$cache_key = 'ee_rss_' . md5($rss_id);
1970
+		if (false != ($output = get_transient($cache_key))) {
1971
+			echo $pre . $output . $post;
1972
+			return true;
1973
+		}
1974
+		if ( ! $doing_ajax) {
1975
+			echo $pre . $loading . $post;
1976
+			return false;
1977
+		}
1978
+		ob_start();
1979
+		wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
1980
+		set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
1981
+		return true;
1982
+	}
1983
+
1984
+
1985
+
1986
+	public function espresso_news_post_box()
1987
+	{
1988
+		?>
1989 1989
         <div class="padding">
1990 1990
             <div id="espresso_news_post_box_content" class="infolinks">
1991 1991
                 <?php
1992
-                // Get RSS Feed(s)
1993
-                $feed_url = apply_filters('FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/');
1994
-                $url = urlencode($feed_url);
1995
-                self::cached_rss_display('espresso_news_post_box_content', $url);
1996
-                ?>
1992
+				// Get RSS Feed(s)
1993
+				$feed_url = apply_filters('FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/');
1994
+				$url = urlencode($feed_url);
1995
+				self::cached_rss_display('espresso_news_post_box_content', $url);
1996
+				?>
1997 1997
             </div>
1998 1998
             <?php do_action('AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
1999 1999
         </div>
2000 2000
         <?php
2001
-    }
2002
-
2003
-
2004
-
2005
-    private function _espresso_links_post_box()
2006
-    {
2007
-        //Hiding until we actually have content to put in here...
2008
-        //add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
2009
-    }
2010
-
2011
-
2012
-
2013
-    public function espresso_links_post_box()
2014
-    {
2015
-        //Hiding until we actually have content to put in here...
2016
-        //$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
2017
-        //EEH_Template::display_template( $templatepath );
2018
-    }
2019
-
2020
-
2021
-
2022
-    protected function _espresso_sponsors_post_box()
2023
-    {
2024
-        $show_sponsors = apply_filters('FHEE_show_sponsors_meta_box', true);
2025
-        if ($show_sponsors) {
2026
-            add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array($this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
2027
-        }
2028
-    }
2029
-
2030
-
2031
-
2032
-    public function espresso_sponsors_post_box()
2033
-    {
2034
-        $templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
2035
-        EEH_Template::display_template($templatepath);
2036
-    }
2037
-
2038
-
2039
-
2040
-    private function _publish_post_box()
2041
-    {
2042
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
2043
-        //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)
2044
-        if ( ! empty($this->_labels['publishbox'])) {
2045
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
2046
-        } else {
2047
-            $box_label = __('Publish', 'event_espresso');
2048
-        }
2049
-        $box_label = apply_filters('FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this);
2050
-        add_meta_box($meta_box_ref, $box_label, array($this, 'editor_overview'), $this->_current_screen->id, 'side', 'high');
2051
-    }
2052
-
2053
-
2054
-
2055
-    public function editor_overview()
2056
-    {
2057
-        //if we have extra content set let's add it in if not make sure its empty
2058
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
2059
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
2060
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
2061
-    }
2062
-
2063
-
2064
-    /** end of globally available metaboxes section **/
2065
-    /*************************************************/
2066
-    /**
2067
-     * Public wrapper for the protected method.  Allows plugins/addons to externally call the
2068
-     * protected method.
2069
-     *
2070
-     * @see   $this->_set_publish_post_box_vars for param details
2071
-     * @since 4.6.0
2072
-     */
2073
-    public function set_publish_post_box_vars($name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true)
2074
-    {
2075
-        $this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
2076
-    }
2077
-
2078
-
2079
-
2080
-    /**
2081
-     * Sets the _template_args arguments used by the _publish_post_box shortcut
2082
-     * Note: currently there is no validation for this.  However if you want the delete button, the
2083
-     * save, and save and close buttons to work properly, then you will want to include a
2084
-     * values for the name and id arguments.
2085
-     *
2086
-     * @todo  Add in validation for name/id arguments.
2087
-     * @param    string  $name                    key used for the action ID (i.e. event_id)
2088
-     * @param    int     $id                      id attached to the item published
2089
-     * @param    string  $delete                  page route callback for the delete action
2090
-     * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
2091
-     * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
2092
-     * @throws \EE_Error
2093
-     */
2094
-    protected function _set_publish_post_box_vars(
2095
-            $name = '',
2096
-            $id = 0,
2097
-            $delete = '',
2098
-            $save_close_redirect_URL = '',
2099
-            $both_btns = true
2100
-    ) {
2101
-        // if Save & Close, use a custom redirect URL or default to the main page?
2102
-        $save_close_redirect_URL = ! empty($save_close_redirect_URL) ? $save_close_redirect_URL : $this->_admin_base_url;
2103
-        // create the Save & Close and Save buttons
2104
-        $this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
2105
-        //if we have extra content set let's add it in if not make sure its empty
2106
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
2107
-        if ($delete && ! empty($id)) {
2108
-            //make sure we have a default if just true is sent.
2109
-            $delete = ! empty($delete) ? $delete : 'delete';
2110
-            $delete_link_args = array($name => $id);
2111
-            $delete = $this->get_action_link_or_button(
2112
-                    $delete,
2113
-                    $delete,
2114
-                    $delete_link_args,
2115
-                    'submitdelete deletion',
2116
-                    '',
2117
-                    false
2118
-            );
2119
-        }
2120
-        $this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
2121
-        if ( ! empty($name) && ! empty($id)) {
2122
-            $hidden_field_arr[$name] = array(
2123
-                    'type'  => 'hidden',
2124
-                    'value' => $id,
2125
-            );
2126
-            $hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
2127
-        } else {
2128
-            $hf = '';
2129
-        }
2130
-        // add hidden field
2131
-        $this->_template_args['publish_hidden_fields'] = ! empty($hf) ? $hf[$name]['field'] : $hf;
2132
-    }
2133
-
2134
-
2135
-
2136
-    /**
2137
-     *        displays an error message to ppl who have javascript disabled
2138
-     *
2139
-     * @access        private
2140
-     * @return        string
2141
-     */
2142
-    private function _display_no_javascript_warning()
2143
-    {
2144
-        ?>
2001
+	}
2002
+
2003
+
2004
+
2005
+	private function _espresso_links_post_box()
2006
+	{
2007
+		//Hiding until we actually have content to put in here...
2008
+		//add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
2009
+	}
2010
+
2011
+
2012
+
2013
+	public function espresso_links_post_box()
2014
+	{
2015
+		//Hiding until we actually have content to put in here...
2016
+		//$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
2017
+		//EEH_Template::display_template( $templatepath );
2018
+	}
2019
+
2020
+
2021
+
2022
+	protected function _espresso_sponsors_post_box()
2023
+	{
2024
+		$show_sponsors = apply_filters('FHEE_show_sponsors_meta_box', true);
2025
+		if ($show_sponsors) {
2026
+			add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array($this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
2027
+		}
2028
+	}
2029
+
2030
+
2031
+
2032
+	public function espresso_sponsors_post_box()
2033
+	{
2034
+		$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
2035
+		EEH_Template::display_template($templatepath);
2036
+	}
2037
+
2038
+
2039
+
2040
+	private function _publish_post_box()
2041
+	{
2042
+		$meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
2043
+		//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)
2044
+		if ( ! empty($this->_labels['publishbox'])) {
2045
+			$box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
2046
+		} else {
2047
+			$box_label = __('Publish', 'event_espresso');
2048
+		}
2049
+		$box_label = apply_filters('FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this);
2050
+		add_meta_box($meta_box_ref, $box_label, array($this, 'editor_overview'), $this->_current_screen->id, 'side', 'high');
2051
+	}
2052
+
2053
+
2054
+
2055
+	public function editor_overview()
2056
+	{
2057
+		//if we have extra content set let's add it in if not make sure its empty
2058
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
2059
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
2060
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
2061
+	}
2062
+
2063
+
2064
+	/** end of globally available metaboxes section **/
2065
+	/*************************************************/
2066
+	/**
2067
+	 * Public wrapper for the protected method.  Allows plugins/addons to externally call the
2068
+	 * protected method.
2069
+	 *
2070
+	 * @see   $this->_set_publish_post_box_vars for param details
2071
+	 * @since 4.6.0
2072
+	 */
2073
+	public function set_publish_post_box_vars($name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true)
2074
+	{
2075
+		$this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
2076
+	}
2077
+
2078
+
2079
+
2080
+	/**
2081
+	 * Sets the _template_args arguments used by the _publish_post_box shortcut
2082
+	 * Note: currently there is no validation for this.  However if you want the delete button, the
2083
+	 * save, and save and close buttons to work properly, then you will want to include a
2084
+	 * values for the name and id arguments.
2085
+	 *
2086
+	 * @todo  Add in validation for name/id arguments.
2087
+	 * @param    string  $name                    key used for the action ID (i.e. event_id)
2088
+	 * @param    int     $id                      id attached to the item published
2089
+	 * @param    string  $delete                  page route callback for the delete action
2090
+	 * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
2091
+	 * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
2092
+	 * @throws \EE_Error
2093
+	 */
2094
+	protected function _set_publish_post_box_vars(
2095
+			$name = '',
2096
+			$id = 0,
2097
+			$delete = '',
2098
+			$save_close_redirect_URL = '',
2099
+			$both_btns = true
2100
+	) {
2101
+		// if Save & Close, use a custom redirect URL or default to the main page?
2102
+		$save_close_redirect_URL = ! empty($save_close_redirect_URL) ? $save_close_redirect_URL : $this->_admin_base_url;
2103
+		// create the Save & Close and Save buttons
2104
+		$this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
2105
+		//if we have extra content set let's add it in if not make sure its empty
2106
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content']) ? $this->_template_args['publish_box_extra_content'] : '';
2107
+		if ($delete && ! empty($id)) {
2108
+			//make sure we have a default if just true is sent.
2109
+			$delete = ! empty($delete) ? $delete : 'delete';
2110
+			$delete_link_args = array($name => $id);
2111
+			$delete = $this->get_action_link_or_button(
2112
+					$delete,
2113
+					$delete,
2114
+					$delete_link_args,
2115
+					'submitdelete deletion',
2116
+					'',
2117
+					false
2118
+			);
2119
+		}
2120
+		$this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
2121
+		if ( ! empty($name) && ! empty($id)) {
2122
+			$hidden_field_arr[$name] = array(
2123
+					'type'  => 'hidden',
2124
+					'value' => $id,
2125
+			);
2126
+			$hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
2127
+		} else {
2128
+			$hf = '';
2129
+		}
2130
+		// add hidden field
2131
+		$this->_template_args['publish_hidden_fields'] = ! empty($hf) ? $hf[$name]['field'] : $hf;
2132
+	}
2133
+
2134
+
2135
+
2136
+	/**
2137
+	 *        displays an error message to ppl who have javascript disabled
2138
+	 *
2139
+	 * @access        private
2140
+	 * @return        string
2141
+	 */
2142
+	private function _display_no_javascript_warning()
2143
+	{
2144
+		?>
2145 2145
         <noscript>
2146 2146
             <div id="no-js-message" class="error">
2147 2147
                 <p style="font-size:1.3em;">
@@ -2151,1267 +2151,1267 @@  discard block
 block discarded – undo
2151 2151
             </div>
2152 2152
         </noscript>
2153 2153
         <?php
2154
-    }
2154
+	}
2155 2155
 
2156 2156
 
2157 2157
 
2158
-    /**
2159
-     *        displays espresso success and/or error notices
2160
-     *
2161
-     * @access        private
2162
-     * @return        string
2163
-     */
2164
-    private function _display_espresso_notices()
2165
-    {
2166
-        $notices = $this->_get_transient(true);
2167
-        echo stripslashes($notices);
2168
-    }
2158
+	/**
2159
+	 *        displays espresso success and/or error notices
2160
+	 *
2161
+	 * @access        private
2162
+	 * @return        string
2163
+	 */
2164
+	private function _display_espresso_notices()
2165
+	{
2166
+		$notices = $this->_get_transient(true);
2167
+		echo stripslashes($notices);
2168
+	}
2169 2169
 
2170 2170
 
2171 2171
 
2172
-    /**
2173
-     *        spinny things pacify the masses
2174
-     *
2175
-     * @access private
2176
-     * @return string
2177
-     */
2178
-    protected function _add_admin_page_ajax_loading_img()
2179
-    {
2180
-        ?>
2172
+	/**
2173
+	 *        spinny things pacify the masses
2174
+	 *
2175
+	 * @access private
2176
+	 * @return string
2177
+	 */
2178
+	protected function _add_admin_page_ajax_loading_img()
2179
+	{
2180
+		?>
2181 2181
         <div id="espresso-ajax-loading" class="ajax-loading-grey">
2182 2182
             <span class="ee-spinner ee-spin"></span><span class="hidden"><?php esc_html_e('loading...', 'event_espresso'); ?></span>
2183 2183
         </div>
2184 2184
         <?php
2185
-    }
2185
+	}
2186 2186
 
2187 2187
 
2188 2188
 
2189
-    /**
2190
-     *        add admin page overlay for modal boxes
2191
-     *
2192
-     * @access private
2193
-     * @return string
2194
-     */
2195
-    protected function _add_admin_page_overlay()
2196
-    {
2197
-        ?>
2189
+	/**
2190
+	 *        add admin page overlay for modal boxes
2191
+	 *
2192
+	 * @access private
2193
+	 * @return string
2194
+	 */
2195
+	protected function _add_admin_page_overlay()
2196
+	{
2197
+		?>
2198 2198
         <div id="espresso-admin-page-overlay-dv" class=""></div>
2199 2199
         <?php
2200
-    }
2201
-
2202
-
2203
-
2204
-    /**
2205
-     * facade for add_meta_box
2206
-     *
2207
-     * @param string  $action        where the metabox get's displayed
2208
-     * @param string  $title         Title of Metabox (output in metabox header)
2209
-     * @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.
2210
-     * @param array   $callback_args an array of args supplied for the metabox
2211
-     * @param string  $column        what metabox column
2212
-     * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
2213
-     * @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.
2214
-     */
2215
-    public function _add_admin_page_meta_box($action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true)
2216
-    {
2217
-        do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
2218
-        //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.
2219
-        if (empty($callback_args) && $create_func) {
2220
-            $callback_args = array(
2221
-                    'template_path' => $this->_template_path,
2222
-                    'template_args' => $this->_template_args,
2223
-            );
2224
-        }
2225
-        //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)
2226
-        $call_back_func = $create_func ? create_function('$post, $metabox',
2227
-                'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
2228
-        add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
2229
-    }
2230
-
2231
-
2232
-
2233
-    /**
2234
-     * generates HTML wrapper for and admin details page that contains metaboxes in columns
2235
-     *
2236
-     * @return [type] [description]
2237
-     */
2238
-    public function display_admin_page_with_metabox_columns()
2239
-    {
2240
-        $this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
2241
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_column_template_path, $this->_template_args, true);
2242
-        //the final wrapper
2243
-        $this->admin_page_wrapper();
2244
-    }
2245
-
2246
-
2247
-
2248
-    /**
2249
-     *        generates  HTML wrapper for an admin details page
2250
-     *
2251
-     * @access public
2252
-     * @return void
2253
-     */
2254
-    public function display_admin_page_with_sidebar()
2255
-    {
2256
-        $this->_display_admin_page(true);
2257
-    }
2258
-
2259
-
2260
-
2261
-    /**
2262
-     *        generates  HTML wrapper for an admin details page (except no sidebar)
2263
-     *
2264
-     * @access public
2265
-     * @return void
2266
-     */
2267
-    public function display_admin_page_with_no_sidebar()
2268
-    {
2269
-        $this->_display_admin_page();
2270
-    }
2271
-
2272
-
2273
-
2274
-    /**
2275
-     * generates HTML wrapper for an EE about admin page (no sidebar)
2276
-     *
2277
-     * @access public
2278
-     * @return void
2279
-     */
2280
-    public function display_about_admin_page()
2281
-    {
2282
-        $this->_display_admin_page(false, true);
2283
-    }
2284
-
2285
-
2286
-
2287
-    /**
2288
-     * display_admin_page
2289
-     * contains the code for actually displaying an admin page
2290
-     *
2291
-     * @access private
2292
-     * @param  boolean $sidebar true with sidebar, false without
2293
-     * @param  boolean $about   use the about admin wrapper instead of the default.
2294
-     * @return void
2295
-     */
2296
-    private function _display_admin_page($sidebar = false, $about = false)
2297
-    {
2298
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2299
-        //custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
2300
-        do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
2301
-        // set current wp page slug - looks like: event-espresso_page_event_categories
2302
-        // keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
2303
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
2304
-        $this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
2305
-                ? 'poststuff'
2306
-                : 'espresso-default-admin';
2307
-        $template_path = $sidebar
2308
-                ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
2309
-                : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
2310
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2311
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
2312
-        }
2313
-        $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
2314
-        $this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
2315
-        $this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
2316
-        $this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
2317
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
2318
-        // the final template wrapper
2319
-        $this->admin_page_wrapper($about);
2320
-    }
2321
-
2322
-
2323
-
2324
-    /**
2325
-     * This is used to display caf preview pages.
2326
-     *
2327
-     * @since 4.3.2
2328
-     * @param string $utm_campaign_source what is the key used for google analytics link
2329
-     * @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.
2330
-     * @return void
2331
-     * @throws \EE_Error
2332
-     */
2333
-    public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
2334
-    {
2335
-        //let's generate a default preview action button if there isn't one already present.
2336
-        $this->_labels['buttons']['buy_now'] = __('Upgrade Now', 'event_espresso');
2337
-        $buy_now_url = add_query_arg(
2338
-                array(
2339
-                        'ee_ver'       => 'ee4',
2340
-                        'utm_source'   => 'ee4_plugin_admin',
2341
-                        'utm_medium'   => 'link',
2342
-                        'utm_campaign' => $utm_campaign_source,
2343
-                        'utm_content'  => 'buy_now_button',
2344
-                ),
2345
-                'http://eventespresso.com/pricing/'
2346
-        );
2347
-        $this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
2348
-                ? $this->get_action_link_or_button(
2349
-                        '',
2350
-                        'buy_now',
2351
-                        array(),
2352
-                        'button-primary button-large',
2353
-                        $buy_now_url,
2354
-                        true
2355
-                )
2356
-                : $this->_template_args['preview_action_button'];
2357
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
2358
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
2359
-                $template_path,
2360
-                $this->_template_args,
2361
-                true
2362
-        );
2363
-        $this->_display_admin_page($display_sidebar);
2364
-    }
2365
-
2366
-
2367
-
2368
-    /**
2369
-     * display_admin_list_table_page_with_sidebar
2370
-     * generates HTML wrapper for an admin_page with list_table
2371
-     *
2372
-     * @access public
2373
-     * @return void
2374
-     */
2375
-    public function display_admin_list_table_page_with_sidebar()
2376
-    {
2377
-        $this->_display_admin_list_table_page(true);
2378
-    }
2379
-
2380
-
2381
-
2382
-    /**
2383
-     * display_admin_list_table_page_with_no_sidebar
2384
-     * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
2385
-     *
2386
-     * @access public
2387
-     * @return void
2388
-     */
2389
-    public function display_admin_list_table_page_with_no_sidebar()
2390
-    {
2391
-        $this->_display_admin_list_table_page();
2392
-    }
2393
-
2394
-
2395
-
2396
-    /**
2397
-     * generates html wrapper for an admin_list_table page
2398
-     *
2399
-     * @access private
2400
-     * @param boolean $sidebar whether to display with sidebar or not.
2401
-     * @return void
2402
-     */
2403
-    private function _display_admin_list_table_page($sidebar = false)
2404
-    {
2405
-        //setup search attributes
2406
-        $this->_set_search_attributes();
2407
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
2408
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
2409
-        $this->_template_args['table_url'] = defined('DOING_AJAX')
2410
-                ? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
2411
-                : add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
2412
-        $this->_template_args['list_table'] = $this->_list_table_object;
2413
-        $this->_template_args['current_route'] = $this->_req_action;
2414
-        $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
2415
-        $ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
2416
-        if ( ! empty($ajax_sorting_callback)) {
2417
-            $sortable_list_table_form_fields = wp_nonce_field(
2418
-                    $ajax_sorting_callback . '_nonce',
2419
-                    $ajax_sorting_callback . '_nonce',
2420
-                    false,
2421
-                    false
2422
-            );
2423
-            //			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
2424
-            //			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
2425
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
2426
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
2427
-        } else {
2428
-            $sortable_list_table_form_fields = '';
2429
-        }
2430
-        $this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
2431
-        $hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
2432
-        $nonce_ref = $this->_req_action . '_nonce';
2433
-        $hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
2434
-        $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
2435
-        //display message about search results?
2436
-        $this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
2437
-                ? '<p class="ee-search-results">' . sprintf(
2438
-                        esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
2439
-                        trim($this->_req_data['s'], '%')
2440
-                ) . '</p>'
2441
-                : '';
2442
-        // filter before_list_table template arg
2443
-        $this->_template_args['before_list_table'] = apply_filters(
2444
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
2445
-            $this->_template_args['before_list_table'],
2446
-            $this->page_slug,
2447
-            $this->_req_data,
2448
-            $this->_req_action
2449
-        );
2450
-        // convert to array and filter again
2451
-        // arrays are easier to inject new items in a specific location,
2452
-        // but would not be backwards compatible, so we have to add a new filter
2453
-        $this->_template_args['before_list_table'] = implode(
2454
-            " \n",
2455
-            (array) apply_filters(
2456
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
2457
-                (array) $this->_template_args['before_list_table'],
2458
-                $this->page_slug,
2459
-                $this->_req_data,
2460
-                $this->_req_action
2461
-            )
2462
-        );
2463
-        // filter after_list_table template arg
2464
-        $this->_template_args['after_list_table'] = apply_filters(
2465
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
2466
-            $this->_template_args['after_list_table'],
2467
-            $this->page_slug,
2468
-            $this->_req_data,
2469
-            $this->_req_action
2470
-        );
2471
-        // convert to array and filter again
2472
-        // arrays are easier to inject new items in a specific location,
2473
-        // but would not be backwards compatible, so we have to add a new filter
2474
-        $this->_template_args['after_list_table'] = implode(
2475
-            " \n",
2476
-            (array) apply_filters(
2477
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
2478
-                (array) $this->_template_args['after_list_table'],
2479
-                $this->page_slug,
2480
-                $this->_req_data,
2481
-                $this->_req_action
2482
-            )
2483
-        );
2484
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
2485
-                $template_path,
2486
-                $this->_template_args,
2487
-                true
2488
-        );
2489
-        // the final template wrapper
2490
-        if ($sidebar) {
2491
-            $this->display_admin_page_with_sidebar();
2492
-        } else {
2493
-            $this->display_admin_page_with_no_sidebar();
2494
-        }
2495
-    }
2496
-
2497
-
2498
-
2499
-    /**
2500
-     * 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.
2501
-     * $items are expected in an array in the following format:
2502
-     * $legend_items = array(
2503
-     *        'item_id' => array(
2504
-     *            'icon' => 'http://url_to_icon_being_described.png',
2505
-     *            'desc' => __('localized description of item');
2506
-     *        )
2507
-     * );
2508
-     *
2509
-     * @param  array $items see above for format of array
2510
-     * @return string        html string of legend
2511
-     */
2512
-    protected function _display_legend($items)
2513
-    {
2514
-        $this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
2515
-        $legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
2516
-        return EEH_Template::display_template($legend_template, $this->_template_args, true);
2517
-    }
2518
-
2519
-
2520
-
2521
-    /**
2522
-     * this is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
2523
-     *
2524
-     * @param bool $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
2525
-     *                             The returned json object is created from an array in the following format:
2526
-     *                             array(
2527
-     *                             'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
2528
-     *                             'success' => FALSE, //(default FALSE) - contains any special success message.
2529
-     *                             'notices' => '', // - contains any EE_Error formatted notices
2530
-     *                             'content' => 'string can be html', //this is a string of formatted content (can be html)
2531
-     *                             '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
2532
-     *                             specific template args that might be included in here)
2533
-     *                             )
2534
-     *                             The json object is populated by whatever is set in the $_template_args property.
2535
-     * @return void
2536
-     */
2537
-    protected function _return_json($sticky_notices = false)
2538
-    {
2539
-        //make sure any EE_Error notices have been handled.
2540
-        $this->_process_notices(array(), true, $sticky_notices);
2541
-        $data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
2542
-        unset($this->_template_args['data']);
2543
-        $json = array(
2544
-                'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
2545
-                'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
2546
-                'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
2547
-                'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
2548
-                'notices'   => EE_Error::get_notices(),
2549
-                'content'   => isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '',
2550
-                'data'      => array_merge($data, array('template_args' => $this->_template_args)),
2551
-                'isEEajax'  => true //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
2552
-        );
2553
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
2554
-        if (null === error_get_last() || ! headers_sent()) {
2555
-            header('Content-Type: application/json; charset=UTF-8');
2556
-        }
2557
-        echo wp_json_encode($json);
2558
-
2559
-        exit();
2560
-    }
2561
-
2562
-
2563
-
2564
-    /**
2565
-     * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
2566
-     *
2567
-     * @return void
2568
-     * @throws EE_Error
2569
-     */
2570
-    public function return_json()
2571
-    {
2572
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2573
-            $this->_return_json();
2574
-        } else {
2575
-            throw new EE_Error(sprintf(__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__));
2576
-        }
2577
-    }
2578
-
2579
-
2580
-
2581
-    /**
2582
-     * 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.
2583
-     *
2584
-     * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
2585
-     * @access   public
2586
-     */
2587
-    public function set_hook_object(EE_Admin_Hooks $hook_obj)
2588
-    {
2589
-        $this->_hook_obj = $hook_obj;
2590
-    }
2591
-
2592
-
2593
-
2594
-    /**
2595
-     *        generates  HTML wrapper with Tabbed nav for an admin page
2596
-     *
2597
-     * @access public
2598
-     * @param  boolean $about whether to use the special about page wrapper or default.
2599
-     * @return void
2600
-     */
2601
-    public function admin_page_wrapper($about = false)
2602
-    {
2603
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2604
-        $this->_nav_tabs = $this->_get_main_nav_tabs();
2605
-        $this->_template_args['nav_tabs'] = $this->_nav_tabs;
2606
-        $this->_template_args['admin_page_title'] = $this->_admin_page_title;
2607
-        $this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
2608
-                isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
2609
-        $this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
2610
-                isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
2611
-        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
2612
-        // load settings page wrapper template
2613
-        $template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
2614
-        //about page?
2615
-        $template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
2616
-        if (defined('DOING_AJAX')) {
2617
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
2618
-            $this->_return_json();
2619
-        } else {
2620
-            EEH_Template::display_template($template_path, $this->_template_args);
2621
-        }
2622
-    }
2623
-
2624
-
2625
-
2626
-    /**
2627
-     * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
2628
-     *
2629
-     * @return string html
2630
-     */
2631
-    protected function _get_main_nav_tabs()
2632
-    {
2633
-        //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)
2634
-        return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
2635
-    }
2636
-
2637
-
2638
-
2639
-    /**
2640
-     *        sort nav tabs
2641
-     *
2642
-     * @access public
2643
-     * @param $a
2644
-     * @param $b
2645
-     * @return int
2646
-     */
2647
-    private function _sort_nav_tabs($a, $b)
2648
-    {
2649
-        if ($a['order'] == $b['order']) {
2650
-            return 0;
2651
-        }
2652
-        return ($a['order'] < $b['order']) ? -1 : 1;
2653
-    }
2654
-
2655
-
2656
-
2657
-    /**
2658
-     *    generates HTML for the forms used on admin pages
2659
-     *
2660
-     * @access protected
2661
-     * @param    array $input_vars - array of input field details
2662
-     * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to use)
2663
-     * @return string
2664
-     * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
2665
-     * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
2666
-     */
2667
-    protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
2668
-    {
2669
-        $content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
2670
-        return $content;
2671
-    }
2672
-
2673
-
2674
-
2675
-    /**
2676
-     * generates the "Save" and "Save & Close" buttons for edit forms
2677
-     *
2678
-     * @access protected
2679
-     * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save & Close" button.
2680
-     * @param array            $text     if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
2681
-     * @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.
2682
-     * @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).
2683
-     */
2684
-    protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
2685
-    {
2686
-        //make sure $text and $actions are in an array
2687
-        $text = (array)$text;
2688
-        $actions = (array)$actions;
2689
-        $referrer_url = empty($referrer) ? '' : $referrer;
2690
-        $referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
2691
-                : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
2692
-        $button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
2693
-        $default_names = array('save', 'save_and_close');
2694
-        //add in a hidden index for the current page (so save and close redirects properly)
2695
-        $this->_template_args['save_buttons'] = $referrer_url;
2696
-        foreach ($button_text as $key => $button) {
2697
-            $ref = $default_names[$key];
2698
-            $id = $this->_current_view . '_' . $ref;
2699
-            $name = ! empty($actions) ? $actions[$key] : $ref;
2700
-            $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
2701
-            if ( ! $both) {
2702
-                break;
2703
-            }
2704
-        }
2705
-    }
2706
-
2707
-
2708
-
2709
-    /**
2710
-     * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
2711
-     *
2712
-     * @see   $this->_set_add_edit_form_tags() for details on params
2713
-     * @since 4.6.0
2714
-     * @param string $route
2715
-     * @param array  $additional_hidden_fields
2716
-     */
2717
-    public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
2718
-    {
2719
-        $this->_set_add_edit_form_tags($route, $additional_hidden_fields);
2720
-    }
2721
-
2722
-
2723
-
2724
-    /**
2725
-     * set form open and close tags on add/edit pages.
2726
-     *
2727
-     * @access protected
2728
-     * @param string $route                    the route you want the form to direct to
2729
-     * @param array  $additional_hidden_fields any additional hidden fields required in the form header
2730
-     * @return void
2731
-     */
2732
-    protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
2733
-    {
2734
-        if (empty($route)) {
2735
-            $user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
2736
-            $dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
2737
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
2738
-        }
2739
-        // open form
2740
-        $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
2741
-        // add nonce
2742
-        $nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
2743
-        //		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
2744
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
2745
-        // add REQUIRED form action
2746
-        $hidden_fields = array(
2747
-                'action' => array('type' => 'hidden', 'value' => $route),
2748
-        );
2749
-        // merge arrays
2750
-        $hidden_fields = is_array($additional_hidden_fields) ? array_merge($hidden_fields, $additional_hidden_fields) : $hidden_fields;
2751
-        // generate form fields
2752
-        $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
2753
-        // add fields to form
2754
-        foreach ((array)$form_fields as $field_name => $form_field) {
2755
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
2756
-        }
2757
-        // close form
2758
-        $this->_template_args['after_admin_page_content'] = '</form>';
2759
-    }
2760
-
2761
-
2762
-
2763
-    /**
2764
-     * Public Wrapper for _redirect_after_action() method since its
2765
-     * discovered it would be useful for external code to have access.
2766
-     *
2767
-     * @see   EE_Admin_Page::_redirect_after_action() for params.
2768
-     * @since 4.5.0
2769
-     */
2770
-    public function redirect_after_action($success = false, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
2771
-    {
2772
-        $this->_redirect_after_action($success, $what, $action_desc, $query_args, $override_overwrite);
2773
-    }
2774
-
2775
-
2776
-
2777
-    /**
2778
-     *    _redirect_after_action
2779
-     *
2780
-     * @param int    $success            - whether success was for two or more records, or just one, or none
2781
-     * @param string $what               - what the action was performed on
2782
-     * @param string $action_desc        - what was done ie: updated, deleted, etc
2783
-     * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin action is completed
2784
-     * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
2785
-     * @access protected
2786
-     * @return void
2787
-     */
2788
-    protected function _redirect_after_action($success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
2789
-    {
2790
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2791
-        //class name for actions/filters.
2792
-        $classname = get_class($this);
2793
-        //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
2794
-        $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
2795
-        $notices = EE_Error::get_notices(false);
2796
-        // overwrite default success messages //BUT ONLY if overwrite not overridden
2797
-        if ( ! $override_overwrite || ! empty($notices['errors'])) {
2798
-            EE_Error::overwrite_success();
2799
-        }
2800
-        if ( ! empty($what) && ! empty($action_desc)) {
2801
-            // how many records affected ? more than one record ? or just one ?
2802
-            if ($success > 1 && empty($notices['errors'])) {
2803
-                // set plural msg
2804
-                EE_Error::add_success(
2805
-                        sprintf(
2806
-                                __('The "%s" have been successfully %s.', 'event_espresso'),
2807
-                                $what,
2808
-                                $action_desc
2809
-                        ),
2810
-                        __FILE__, __FUNCTION__, __LINE__
2811
-                );
2812
-            } else if ($success == 1 && empty($notices['errors'])) {
2813
-                // set singular msg
2814
-                EE_Error::add_success(
2815
-                        sprintf(
2816
-                                __('The "%s" has been successfully %s.', 'event_espresso'),
2817
-                                $what,
2818
-                                $action_desc
2819
-                        ),
2820
-                        __FILE__, __FUNCTION__, __LINE__
2821
-                );
2822
-            }
2823
-        }
2824
-        // check that $query_args isn't something crazy
2825
-        if ( ! is_array($query_args)) {
2826
-            $query_args = array();
2827
-        }
2828
-        /**
2829
-         * Allow injecting actions before the query_args are modified for possible different
2830
-         * redirections on save and close actions
2831
-         *
2832
-         * @since 4.2.0
2833
-         * @param array $query_args       The original query_args array coming into the
2834
-         *                                method.
2835
-         */
2836
-        do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
2837
-        //calculate where we're going (if we have a "save and close" button pushed)
2838
-        if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
2839
-            // even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
2840
-            $parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
2841
-            // regenerate query args array from referrer URL
2842
-            parse_str($parsed_url['query'], $query_args);
2843
-            // correct page and action will be in the query args now
2844
-            $redirect_url = admin_url('admin.php');
2845
-        }
2846
-        //merge any default query_args set in _default_route_query_args property
2847
-        if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
2848
-            $args_to_merge = array();
2849
-            foreach ($this->_default_route_query_args as $query_param => $query_value) {
2850
-                //is there a wp_referer array in our _default_route_query_args property?
2851
-                if ($query_param == 'wp_referer') {
2852
-                    $query_value = (array)$query_value;
2853
-                    foreach ($query_value as $reference => $value) {
2854
-                        if (strpos($reference, 'nonce') !== false) {
2855
-                            continue;
2856
-                        }
2857
-                        //finally we will override any arguments in the referer with
2858
-                        //what might be set on the _default_route_query_args array.
2859
-                        if (isset($this->_default_route_query_args[$reference])) {
2860
-                            $args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
2861
-                        } else {
2862
-                            $args_to_merge[$reference] = urlencode($value);
2863
-                        }
2864
-                    }
2865
-                    continue;
2866
-                }
2867
-                $args_to_merge[$query_param] = $query_value;
2868
-            }
2869
-            //now let's merge these arguments but override with what was specifically sent in to the
2870
-            //redirect.
2871
-            $query_args = array_merge($args_to_merge, $query_args);
2872
-        }
2873
-        $this->_process_notices($query_args);
2874
-        // generate redirect url
2875
-        // if redirecting to anything other than the main page, add a nonce
2876
-        if (isset($query_args['action'])) {
2877
-            // manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
2878
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
2879
-        }
2880
-        //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).
2881
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
2882
-        $redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
2883
-        // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
2884
-        if (defined('DOING_AJAX')) {
2885
-            $default_data = array(
2886
-                    'close'        => true,
2887
-                    'redirect_url' => $redirect_url,
2888
-                    'where'        => 'main',
2889
-                    'what'         => 'append',
2890
-            );
2891
-            $this->_template_args['success'] = $success;
2892
-            $this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data']) : $default_data;
2893
-            $this->_return_json();
2894
-        }
2895
-        wp_safe_redirect($redirect_url);
2896
-        exit();
2897
-    }
2898
-
2899
-
2900
-
2901
-    /**
2902
-     * process any notices before redirecting (or returning ajax request)
2903
-     * This method sets the $this->_template_args['notices'] attribute;
2904
-     *
2905
-     * @param  array $query_args        any query args that need to be used for notice transient ('action')
2906
-     * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
2907
-     * @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.
2908
-     * @return void
2909
-     */
2910
-    protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
2911
-    {
2912
-        //first let's set individual error properties if doing_ajax and the properties aren't already set.
2913
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2914
-            $notices = EE_Error::get_notices(false);
2915
-            if (empty($this->_template_args['success'])) {
2916
-                $this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
2917
-            }
2918
-            if (empty($this->_template_args['errors'])) {
2919
-                $this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
2920
-            }
2921
-            if (empty($this->_template_args['attention'])) {
2922
-                $this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
2923
-            }
2924
-        }
2925
-        $this->_template_args['notices'] = EE_Error::get_notices();
2926
-        //IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
2927
-        if ( ! defined('DOING_AJAX') || $sticky_notices) {
2928
-            $route = isset($query_args['action']) ? $query_args['action'] : 'default';
2929
-            $this->_add_transient($route, $this->_template_args['notices'], true, $skip_route_verify);
2930
-        }
2931
-    }
2932
-
2933
-
2934
-
2935
-    /**
2936
-     * get_action_link_or_button
2937
-     * returns the button html for adding, editing, or deleting an item (depending on given type)
2938
-     *
2939
-     * @param string $action        use this to indicate which action the url is generated with.
2940
-     * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key) property.
2941
-     * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
2942
-     * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
2943
-     * @param string $base_url      If this is not provided
2944
-     *                              the _admin_base_url will be used as the default for the button base_url.
2945
-     *                              Otherwise this value will be used.
2946
-     * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
2947
-     * @return string
2948
-     * @throws \EE_Error
2949
-     */
2950
-    public function get_action_link_or_button(
2951
-            $action,
2952
-            $type = 'add',
2953
-            $extra_request = array(),
2954
-            $class = 'button-primary',
2955
-            $base_url = '',
2956
-            $exclude_nonce = false
2957
-    ) {
2958
-        //first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
2959
-        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
2960
-            throw new EE_Error(
2961
-                    sprintf(
2962
-                            __(
2963
-                                    'There is no page route for given action for the button.  This action was given: %s',
2964
-                                    'event_espresso'
2965
-                            ),
2966
-                            $action
2967
-                    )
2968
-            );
2969
-        }
2970
-        if ( ! isset($this->_labels['buttons'][$type])) {
2971
-            throw new EE_Error(
2972
-                    sprintf(
2973
-                            __(
2974
-                                    'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
2975
-                                    'event_espresso'
2976
-                            ),
2977
-                            $type
2978
-                    )
2979
-            );
2980
-        }
2981
-        //finally check user access for this button.
2982
-        $has_access = $this->check_user_access($action, true);
2983
-        if ( ! $has_access) {
2984
-            return '';
2985
-        }
2986
-        $_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
2987
-        $query_args = array(
2988
-                'action' => $action,
2989
-        );
2990
-        //merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
2991
-        if ( ! empty($extra_request)) {
2992
-            $query_args = array_merge($extra_request, $query_args);
2993
-        }
2994
-        $url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
2995
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
2996
-    }
2997
-
2998
-
2999
-
3000
-    /**
3001
-     * _per_page_screen_option
3002
-     * Utility function for adding in a per_page_option in the screen_options_dropdown.
3003
-     *
3004
-     * @return void
3005
-     */
3006
-    protected function _per_page_screen_option()
3007
-    {
3008
-        $option = 'per_page';
3009
-        $args = array(
3010
-                'label'   => $this->_admin_page_title,
3011
-                'default' => 10,
3012
-                'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
3013
-        );
3014
-        //ONLY add the screen option if the user has access to it.
3015
-        if ($this->check_user_access($this->_current_view, true)) {
3016
-            add_screen_option($option, $args);
3017
-        }
3018
-    }
3019
-
3020
-
3021
-
3022
-    /**
3023
-     * set_per_page_screen_option
3024
-     * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
3025
-     * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
3026
-     *
3027
-     * @access private
3028
-     * @return void
3029
-     */
3030
-    private function _set_per_page_screen_options()
3031
-    {
3032
-        if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
3033
-            check_admin_referer('screen-options-nonce', 'screenoptionnonce');
3034
-            if ( ! $user = wp_get_current_user()) {
3035
-                return;
3036
-            }
3037
-            $option = $_POST['wp_screen_options']['option'];
3038
-            $value = $_POST['wp_screen_options']['value'];
3039
-            if ($option != sanitize_key($option)) {
3040
-                return;
3041
-            }
3042
-            $map_option = $option;
3043
-            $option = str_replace('-', '_', $option);
3044
-            switch ($map_option) {
3045
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
3046
-                    $value = (int)$value;
3047
-                    if ($value < 1 || $value > 999) {
3048
-                        return;
3049
-                    }
3050
-                    break;
3051
-                default:
3052
-                    $value = apply_filters('FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value);
3053
-                    if (false === $value) {
3054
-                        return;
3055
-                    }
3056
-                    break;
3057
-            }
3058
-            update_user_meta($user->ID, $option, $value);
3059
-            wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
3060
-            exit;
3061
-        }
3062
-    }
3063
-
3064
-
3065
-
3066
-    /**
3067
-     * This just allows for setting the $_template_args property if it needs to be set outside the object
3068
-     *
3069
-     * @param array $data array that will be assigned to template args.
3070
-     */
3071
-    public function set_template_args($data)
3072
-    {
3073
-        $this->_template_args = array_merge($this->_template_args, (array)$data);
3074
-    }
3075
-
3076
-
3077
-
3078
-    /**
3079
-     * This makes available the WP transient system for temporarily moving data between routes
3080
-     *
3081
-     * @access protected
3082
-     * @param string $route             the route that should receive the transient
3083
-     * @param array  $data              the data that gets sent
3084
-     * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
3085
-     * @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.
3086
-     * @return void
3087
-     */
3088
-    protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
3089
-    {
3090
-        $user_id = get_current_user_id();
3091
-        if ( ! $skip_route_verify) {
3092
-            $this->_verify_route($route);
3093
-        }
3094
-        //now let's set the string for what kind of transient we're setting
3095
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
3096
-        $data = $notices ? array('notices' => $data) : $data;
3097
-        //is there already a transient for this route?  If there is then let's ADD to that transient
3098
-        $existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
3099
-        if ($existing) {
3100
-            $data = array_merge((array)$data, (array)$existing);
3101
-        }
3102
-        if (is_multisite() && is_network_admin()) {
3103
-            set_site_transient($transient, $data, 8);
3104
-        } else {
3105
-            set_transient($transient, $data, 8);
3106
-        }
3107
-    }
3108
-
3109
-
3110
-
3111
-    /**
3112
-     * this retrieves the temporary transient that has been set for moving data between routes.
3113
-     *
3114
-     * @param bool $notices true we get notices transient. False we just return normal route transient
3115
-     * @return mixed data
3116
-     */
3117
-    protected function _get_transient($notices = false, $route = false)
3118
-    {
3119
-        $user_id = get_current_user_id();
3120
-        $route = ! $route ? $this->_req_action : $route;
3121
-        $transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
3122
-        $data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
3123
-        //delete transient after retrieval (just in case it hasn't expired);
3124
-        if (is_multisite() && is_network_admin()) {
3125
-            delete_site_transient($transient);
3126
-        } else {
3127
-            delete_transient($transient);
3128
-        }
3129
-        return $notices && isset($data['notices']) ? $data['notices'] : $data;
3130
-    }
3131
-
3132
-
3133
-
3134
-    /**
3135
-     * 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.
3136
-     * 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.)
3137
-     *
3138
-     * @return void
3139
-     */
3140
-    protected function _transient_garbage_collection()
3141
-    {
3142
-        global $wpdb;
3143
-        //retrieve all existing transients
3144
-        $query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
3145
-        if ($results = $wpdb->get_results($query)) {
3146
-            foreach ($results as $result) {
3147
-                $transient = str_replace('_transient_', '', $result->option_name);
3148
-                get_transient($transient);
3149
-                if (is_multisite() && is_network_admin()) {
3150
-                    get_site_transient($transient);
3151
-                }
3152
-            }
3153
-        }
3154
-    }
3155
-
3156
-
3157
-
3158
-    /**
3159
-     * get_view
3160
-     *
3161
-     * @access public
3162
-     * @return string content of _view property
3163
-     */
3164
-    public function get_view()
3165
-    {
3166
-        return $this->_view;
3167
-    }
3168
-
3169
-
3170
-
3171
-    /**
3172
-     * getter for the protected $_views property
3173
-     *
3174
-     * @return array
3175
-     */
3176
-    public function get_views()
3177
-    {
3178
-        return $this->_views;
3179
-    }
3180
-
3181
-
3182
-
3183
-    /**
3184
-     * get_current_page
3185
-     *
3186
-     * @access public
3187
-     * @return string _current_page property value
3188
-     */
3189
-    public function get_current_page()
3190
-    {
3191
-        return $this->_current_page;
3192
-    }
3193
-
3194
-
3195
-
3196
-    /**
3197
-     * get_current_view
3198
-     *
3199
-     * @access public
3200
-     * @return string _current_view property value
3201
-     */
3202
-    public function get_current_view()
3203
-    {
3204
-        return $this->_current_view;
3205
-    }
3206
-
3207
-
3208
-
3209
-    /**
3210
-     * get_current_screen
3211
-     *
3212
-     * @access public
3213
-     * @return object The current WP_Screen object
3214
-     */
3215
-    public function get_current_screen()
3216
-    {
3217
-        return $this->_current_screen;
3218
-    }
3219
-
3220
-
3221
-
3222
-    /**
3223
-     * get_current_page_view_url
3224
-     *
3225
-     * @access public
3226
-     * @return string This returns the url for the current_page_view.
3227
-     */
3228
-    public function get_current_page_view_url()
3229
-    {
3230
-        return $this->_current_page_view_url;
3231
-    }
3232
-
3233
-
3234
-
3235
-    /**
3236
-     * just returns the _req_data property
3237
-     *
3238
-     * @return array
3239
-     */
3240
-    public function get_request_data()
3241
-    {
3242
-        return $this->_req_data;
3243
-    }
3244
-
3245
-
3246
-
3247
-    /**
3248
-     * returns the _req_data protected property
3249
-     *
3250
-     * @return string
3251
-     */
3252
-    public function get_req_action()
3253
-    {
3254
-        return $this->_req_action;
3255
-    }
3256
-
3257
-
3258
-
3259
-    /**
3260
-     * @return bool  value of $_is_caf property
3261
-     */
3262
-    public function is_caf()
3263
-    {
3264
-        return $this->_is_caf;
3265
-    }
3266
-
3267
-
3268
-
3269
-    /**
3270
-     * @return mixed
3271
-     */
3272
-    public function default_espresso_metaboxes()
3273
-    {
3274
-        return $this->_default_espresso_metaboxes;
3275
-    }
3276
-
3277
-
3278
-
3279
-    /**
3280
-     * @return mixed
3281
-     */
3282
-    public function admin_base_url()
3283
-    {
3284
-        return $this->_admin_base_url;
3285
-    }
3286
-
3287
-
3288
-
3289
-    /**
3290
-     * @return mixed
3291
-     */
3292
-    public function wp_page_slug()
3293
-    {
3294
-        return $this->_wp_page_slug;
3295
-    }
3296
-
3297
-
3298
-
3299
-    /**
3300
-     * updates  espresso configuration settings
3301
-     *
3302
-     * @access    protected
3303
-     * @param string                   $tab
3304
-     * @param EE_Config_Base|EE_Config $config
3305
-     * @param string                   $file file where error occurred
3306
-     * @param string                   $func function  where error occurred
3307
-     * @param string                   $line line no where error occurred
3308
-     * @return boolean
3309
-     */
3310
-    protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
3311
-    {
3312
-        //remove any options that are NOT going to be saved with the config settings.
3313
-        if (isset($config->core->ee_ueip_optin)) {
3314
-            $config->core->ee_ueip_has_notified = true;
3315
-            // TODO: remove the following two lines and make sure values are migrated from 3.1
3316
-            update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
3317
-            update_option('ee_ueip_has_notified', true);
3318
-        }
3319
-        // and save it (note we're also doing the network save here)
3320
-        $net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
3321
-        $config_saved = EE_Config::instance()->update_espresso_config(false, false);
3322
-        if ($config_saved && $net_saved) {
3323
-            EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
3324
-            return true;
3325
-        } else {
3326
-            EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
3327
-            return false;
3328
-        }
3329
-    }
3330
-
3331
-
3332
-
3333
-    /**
3334
-     * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
3335
-     *
3336
-     * @return array
3337
-     */
3338
-    public function get_yes_no_values()
3339
-    {
3340
-        return $this->_yes_no_values;
3341
-    }
3342
-
3343
-
3344
-
3345
-    protected function _get_dir()
3346
-    {
3347
-        $reflector = new ReflectionClass(get_class($this));
3348
-        return dirname($reflector->getFileName());
3349
-    }
3350
-
3351
-
3352
-
3353
-    /**
3354
-     * A helper for getting a "next link".
3355
-     *
3356
-     * @param string $url   The url to link to
3357
-     * @param string $class The class to use.
3358
-     * @return string
3359
-     */
3360
-    protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
3361
-    {
3362
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
3363
-    }
3364
-
3365
-
3366
-
3367
-    /**
3368
-     * A helper for getting a "previous link".
3369
-     *
3370
-     * @param string $url   The url to link to
3371
-     * @param string $class The class to use.
3372
-     * @return string
3373
-     */
3374
-    protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
3375
-    {
3376
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
3377
-    }
3378
-
3379
-
3380
-
3381
-
3382
-
3383
-
3384
-
3385
-    //below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
3386
-    /**
3387
-     * 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
3388
-     * array.
3389
-     *
3390
-     * @return bool success/fail
3391
-     */
3392
-    protected function _process_resend_registration()
3393
-    {
3394
-        $this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
3395
-        do_action('AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data);
3396
-        return $this->_template_args['success'];
3397
-    }
3398
-
3399
-
3400
-
3401
-    /**
3402
-     * This automatically processes any payment message notifications when manual payment has been applied.
3403
-     *
3404
-     * @access protected
3405
-     * @param \EE_Payment $payment
3406
-     * @return bool success/fail
3407
-     */
3408
-    protected function _process_payment_notification(EE_Payment $payment)
3409
-    {
3410
-        add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
3411
-        do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
3412
-        $this->_template_args['success'] = apply_filters('FHEE__EE_Admin_Page___process_admin_payment_notification__success', false, $payment);
3413
-        return $this->_template_args['success'];
3414
-    }
2200
+	}
2201
+
2202
+
2203
+
2204
+	/**
2205
+	 * facade for add_meta_box
2206
+	 *
2207
+	 * @param string  $action        where the metabox get's displayed
2208
+	 * @param string  $title         Title of Metabox (output in metabox header)
2209
+	 * @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.
2210
+	 * @param array   $callback_args an array of args supplied for the metabox
2211
+	 * @param string  $column        what metabox column
2212
+	 * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
2213
+	 * @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.
2214
+	 */
2215
+	public function _add_admin_page_meta_box($action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true)
2216
+	{
2217
+		do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
2218
+		//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.
2219
+		if (empty($callback_args) && $create_func) {
2220
+			$callback_args = array(
2221
+					'template_path' => $this->_template_path,
2222
+					'template_args' => $this->_template_args,
2223
+			);
2224
+		}
2225
+		//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)
2226
+		$call_back_func = $create_func ? create_function('$post, $metabox',
2227
+				'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
2228
+		add_meta_box(str_replace('_', '-', $action) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args);
2229
+	}
2230
+
2231
+
2232
+
2233
+	/**
2234
+	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
2235
+	 *
2236
+	 * @return [type] [description]
2237
+	 */
2238
+	public function display_admin_page_with_metabox_columns()
2239
+	{
2240
+		$this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
2241
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_column_template_path, $this->_template_args, true);
2242
+		//the final wrapper
2243
+		$this->admin_page_wrapper();
2244
+	}
2245
+
2246
+
2247
+
2248
+	/**
2249
+	 *        generates  HTML wrapper for an admin details page
2250
+	 *
2251
+	 * @access public
2252
+	 * @return void
2253
+	 */
2254
+	public function display_admin_page_with_sidebar()
2255
+	{
2256
+		$this->_display_admin_page(true);
2257
+	}
2258
+
2259
+
2260
+
2261
+	/**
2262
+	 *        generates  HTML wrapper for an admin details page (except no sidebar)
2263
+	 *
2264
+	 * @access public
2265
+	 * @return void
2266
+	 */
2267
+	public function display_admin_page_with_no_sidebar()
2268
+	{
2269
+		$this->_display_admin_page();
2270
+	}
2271
+
2272
+
2273
+
2274
+	/**
2275
+	 * generates HTML wrapper for an EE about admin page (no sidebar)
2276
+	 *
2277
+	 * @access public
2278
+	 * @return void
2279
+	 */
2280
+	public function display_about_admin_page()
2281
+	{
2282
+		$this->_display_admin_page(false, true);
2283
+	}
2284
+
2285
+
2286
+
2287
+	/**
2288
+	 * display_admin_page
2289
+	 * contains the code for actually displaying an admin page
2290
+	 *
2291
+	 * @access private
2292
+	 * @param  boolean $sidebar true with sidebar, false without
2293
+	 * @param  boolean $about   use the about admin wrapper instead of the default.
2294
+	 * @return void
2295
+	 */
2296
+	private function _display_admin_page($sidebar = false, $about = false)
2297
+	{
2298
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2299
+		//custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
2300
+		do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
2301
+		// set current wp page slug - looks like: event-espresso_page_event_categories
2302
+		// keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
2303
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
2304
+		$this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
2305
+				? 'poststuff'
2306
+				: 'espresso-default-admin';
2307
+		$template_path = $sidebar
2308
+				? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
2309
+				: EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
2310
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2311
+			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
2312
+		}
2313
+		$template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
2314
+		$this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '';
2315
+		$this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
2316
+		$this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
2317
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
2318
+		// the final template wrapper
2319
+		$this->admin_page_wrapper($about);
2320
+	}
2321
+
2322
+
2323
+
2324
+	/**
2325
+	 * This is used to display caf preview pages.
2326
+	 *
2327
+	 * @since 4.3.2
2328
+	 * @param string $utm_campaign_source what is the key used for google analytics link
2329
+	 * @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.
2330
+	 * @return void
2331
+	 * @throws \EE_Error
2332
+	 */
2333
+	public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
2334
+	{
2335
+		//let's generate a default preview action button if there isn't one already present.
2336
+		$this->_labels['buttons']['buy_now'] = __('Upgrade Now', 'event_espresso');
2337
+		$buy_now_url = add_query_arg(
2338
+				array(
2339
+						'ee_ver'       => 'ee4',
2340
+						'utm_source'   => 'ee4_plugin_admin',
2341
+						'utm_medium'   => 'link',
2342
+						'utm_campaign' => $utm_campaign_source,
2343
+						'utm_content'  => 'buy_now_button',
2344
+				),
2345
+				'http://eventespresso.com/pricing/'
2346
+		);
2347
+		$this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
2348
+				? $this->get_action_link_or_button(
2349
+						'',
2350
+						'buy_now',
2351
+						array(),
2352
+						'button-primary button-large',
2353
+						$buy_now_url,
2354
+						true
2355
+				)
2356
+				: $this->_template_args['preview_action_button'];
2357
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
2358
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
2359
+				$template_path,
2360
+				$this->_template_args,
2361
+				true
2362
+		);
2363
+		$this->_display_admin_page($display_sidebar);
2364
+	}
2365
+
2366
+
2367
+
2368
+	/**
2369
+	 * display_admin_list_table_page_with_sidebar
2370
+	 * generates HTML wrapper for an admin_page with list_table
2371
+	 *
2372
+	 * @access public
2373
+	 * @return void
2374
+	 */
2375
+	public function display_admin_list_table_page_with_sidebar()
2376
+	{
2377
+		$this->_display_admin_list_table_page(true);
2378
+	}
2379
+
2380
+
2381
+
2382
+	/**
2383
+	 * display_admin_list_table_page_with_no_sidebar
2384
+	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
2385
+	 *
2386
+	 * @access public
2387
+	 * @return void
2388
+	 */
2389
+	public function display_admin_list_table_page_with_no_sidebar()
2390
+	{
2391
+		$this->_display_admin_list_table_page();
2392
+	}
2393
+
2394
+
2395
+
2396
+	/**
2397
+	 * generates html wrapper for an admin_list_table page
2398
+	 *
2399
+	 * @access private
2400
+	 * @param boolean $sidebar whether to display with sidebar or not.
2401
+	 * @return void
2402
+	 */
2403
+	private function _display_admin_list_table_page($sidebar = false)
2404
+	{
2405
+		//setup search attributes
2406
+		$this->_set_search_attributes();
2407
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
2408
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
2409
+		$this->_template_args['table_url'] = defined('DOING_AJAX')
2410
+				? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
2411
+				: add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
2412
+		$this->_template_args['list_table'] = $this->_list_table_object;
2413
+		$this->_template_args['current_route'] = $this->_req_action;
2414
+		$this->_template_args['list_table_class'] = get_class($this->_list_table_object);
2415
+		$ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
2416
+		if ( ! empty($ajax_sorting_callback)) {
2417
+			$sortable_list_table_form_fields = wp_nonce_field(
2418
+					$ajax_sorting_callback . '_nonce',
2419
+					$ajax_sorting_callback . '_nonce',
2420
+					false,
2421
+					false
2422
+			);
2423
+			//			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
2424
+			//			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
2425
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug . '" />';
2426
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
2427
+		} else {
2428
+			$sortable_list_table_form_fields = '';
2429
+		}
2430
+		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
2431
+		$hidden_form_fields = isset($this->_template_args['list_table_hidden_fields']) ? $this->_template_args['list_table_hidden_fields'] : '';
2432
+		$nonce_ref = $this->_req_action . '_nonce';
2433
+		$hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
2434
+		$this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
2435
+		//display message about search results?
2436
+		$this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
2437
+				? '<p class="ee-search-results">' . sprintf(
2438
+						esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
2439
+						trim($this->_req_data['s'], '%')
2440
+				) . '</p>'
2441
+				: '';
2442
+		// filter before_list_table template arg
2443
+		$this->_template_args['before_list_table'] = apply_filters(
2444
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
2445
+			$this->_template_args['before_list_table'],
2446
+			$this->page_slug,
2447
+			$this->_req_data,
2448
+			$this->_req_action
2449
+		);
2450
+		// convert to array and filter again
2451
+		// arrays are easier to inject new items in a specific location,
2452
+		// but would not be backwards compatible, so we have to add a new filter
2453
+		$this->_template_args['before_list_table'] = implode(
2454
+			" \n",
2455
+			(array) apply_filters(
2456
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
2457
+				(array) $this->_template_args['before_list_table'],
2458
+				$this->page_slug,
2459
+				$this->_req_data,
2460
+				$this->_req_action
2461
+			)
2462
+		);
2463
+		// filter after_list_table template arg
2464
+		$this->_template_args['after_list_table'] = apply_filters(
2465
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
2466
+			$this->_template_args['after_list_table'],
2467
+			$this->page_slug,
2468
+			$this->_req_data,
2469
+			$this->_req_action
2470
+		);
2471
+		// convert to array and filter again
2472
+		// arrays are easier to inject new items in a specific location,
2473
+		// but would not be backwards compatible, so we have to add a new filter
2474
+		$this->_template_args['after_list_table'] = implode(
2475
+			" \n",
2476
+			(array) apply_filters(
2477
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
2478
+				(array) $this->_template_args['after_list_table'],
2479
+				$this->page_slug,
2480
+				$this->_req_data,
2481
+				$this->_req_action
2482
+			)
2483
+		);
2484
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
2485
+				$template_path,
2486
+				$this->_template_args,
2487
+				true
2488
+		);
2489
+		// the final template wrapper
2490
+		if ($sidebar) {
2491
+			$this->display_admin_page_with_sidebar();
2492
+		} else {
2493
+			$this->display_admin_page_with_no_sidebar();
2494
+		}
2495
+	}
2496
+
2497
+
2498
+
2499
+	/**
2500
+	 * 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.
2501
+	 * $items are expected in an array in the following format:
2502
+	 * $legend_items = array(
2503
+	 *        'item_id' => array(
2504
+	 *            'icon' => 'http://url_to_icon_being_described.png',
2505
+	 *            'desc' => __('localized description of item');
2506
+	 *        )
2507
+	 * );
2508
+	 *
2509
+	 * @param  array $items see above for format of array
2510
+	 * @return string        html string of legend
2511
+	 */
2512
+	protected function _display_legend($items)
2513
+	{
2514
+		$this->_template_args['items'] = apply_filters('FHEE__EE_Admin_Page___display_legend__items', (array)$items, $this);
2515
+		$legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
2516
+		return EEH_Template::display_template($legend_template, $this->_template_args, true);
2517
+	}
2518
+
2519
+
2520
+
2521
+	/**
2522
+	 * this is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
2523
+	 *
2524
+	 * @param bool $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
2525
+	 *                             The returned json object is created from an array in the following format:
2526
+	 *                             array(
2527
+	 *                             'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
2528
+	 *                             'success' => FALSE, //(default FALSE) - contains any special success message.
2529
+	 *                             'notices' => '', // - contains any EE_Error formatted notices
2530
+	 *                             'content' => 'string can be html', //this is a string of formatted content (can be html)
2531
+	 *                             '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
2532
+	 *                             specific template args that might be included in here)
2533
+	 *                             )
2534
+	 *                             The json object is populated by whatever is set in the $_template_args property.
2535
+	 * @return void
2536
+	 */
2537
+	protected function _return_json($sticky_notices = false)
2538
+	{
2539
+		//make sure any EE_Error notices have been handled.
2540
+		$this->_process_notices(array(), true, $sticky_notices);
2541
+		$data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
2542
+		unset($this->_template_args['data']);
2543
+		$json = array(
2544
+				'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
2545
+				'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
2546
+				'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
2547
+				'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
2548
+				'notices'   => EE_Error::get_notices(),
2549
+				'content'   => isset($this->_template_args['admin_page_content']) ? $this->_template_args['admin_page_content'] : '',
2550
+				'data'      => array_merge($data, array('template_args' => $this->_template_args)),
2551
+				'isEEajax'  => true //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
2552
+		);
2553
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
2554
+		if (null === error_get_last() || ! headers_sent()) {
2555
+			header('Content-Type: application/json; charset=UTF-8');
2556
+		}
2557
+		echo wp_json_encode($json);
2558
+
2559
+		exit();
2560
+	}
2561
+
2562
+
2563
+
2564
+	/**
2565
+	 * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
2566
+	 *
2567
+	 * @return void
2568
+	 * @throws EE_Error
2569
+	 */
2570
+	public function return_json()
2571
+	{
2572
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2573
+			$this->_return_json();
2574
+		} else {
2575
+			throw new EE_Error(sprintf(__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__));
2576
+		}
2577
+	}
2578
+
2579
+
2580
+
2581
+	/**
2582
+	 * 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.
2583
+	 *
2584
+	 * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
2585
+	 * @access   public
2586
+	 */
2587
+	public function set_hook_object(EE_Admin_Hooks $hook_obj)
2588
+	{
2589
+		$this->_hook_obj = $hook_obj;
2590
+	}
2591
+
2592
+
2593
+
2594
+	/**
2595
+	 *        generates  HTML wrapper with Tabbed nav for an admin page
2596
+	 *
2597
+	 * @access public
2598
+	 * @param  boolean $about whether to use the special about page wrapper or default.
2599
+	 * @return void
2600
+	 */
2601
+	public function admin_page_wrapper($about = false)
2602
+	{
2603
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2604
+		$this->_nav_tabs = $this->_get_main_nav_tabs();
2605
+		$this->_template_args['nav_tabs'] = $this->_nav_tabs;
2606
+		$this->_template_args['admin_page_title'] = $this->_admin_page_title;
2607
+		$this->_template_args['before_admin_page_content'] = apply_filters('FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view,
2608
+				isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '');
2609
+		$this->_template_args['after_admin_page_content'] = apply_filters('FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view,
2610
+				isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '');
2611
+		$this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
2612
+		// load settings page wrapper template
2613
+		$template_path = ! defined('DOING_AJAX') ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
2614
+		//about page?
2615
+		$template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
2616
+		if (defined('DOING_AJAX')) {
2617
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path, $this->_template_args, true);
2618
+			$this->_return_json();
2619
+		} else {
2620
+			EEH_Template::display_template($template_path, $this->_template_args);
2621
+		}
2622
+	}
2623
+
2624
+
2625
+
2626
+	/**
2627
+	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
2628
+	 *
2629
+	 * @return string html
2630
+	 */
2631
+	protected function _get_main_nav_tabs()
2632
+	{
2633
+		//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)
2634
+		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
2635
+	}
2636
+
2637
+
2638
+
2639
+	/**
2640
+	 *        sort nav tabs
2641
+	 *
2642
+	 * @access public
2643
+	 * @param $a
2644
+	 * @param $b
2645
+	 * @return int
2646
+	 */
2647
+	private function _sort_nav_tabs($a, $b)
2648
+	{
2649
+		if ($a['order'] == $b['order']) {
2650
+			return 0;
2651
+		}
2652
+		return ($a['order'] < $b['order']) ? -1 : 1;
2653
+	}
2654
+
2655
+
2656
+
2657
+	/**
2658
+	 *    generates HTML for the forms used on admin pages
2659
+	 *
2660
+	 * @access protected
2661
+	 * @param    array $input_vars - array of input field details
2662
+	 * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to use)
2663
+	 * @return string
2664
+	 * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
2665
+	 * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
2666
+	 */
2667
+	protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
2668
+	{
2669
+		$content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
2670
+		return $content;
2671
+	}
2672
+
2673
+
2674
+
2675
+	/**
2676
+	 * generates the "Save" and "Save & Close" buttons for edit forms
2677
+	 *
2678
+	 * @access protected
2679
+	 * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save & Close" button.
2680
+	 * @param array            $text     if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
2681
+	 * @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.
2682
+	 * @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).
2683
+	 */
2684
+	protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
2685
+	{
2686
+		//make sure $text and $actions are in an array
2687
+		$text = (array)$text;
2688
+		$actions = (array)$actions;
2689
+		$referrer_url = empty($referrer) ? '' : $referrer;
2690
+		$referrer_url = ! $referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] . '" />'
2691
+				: '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer . '" />';
2692
+		$button_text = ! empty($text) ? $text : array(__('Save', 'event_espresso'), __('Save and Close', 'event_espresso'));
2693
+		$default_names = array('save', 'save_and_close');
2694
+		//add in a hidden index for the current page (so save and close redirects properly)
2695
+		$this->_template_args['save_buttons'] = $referrer_url;
2696
+		foreach ($button_text as $key => $button) {
2697
+			$ref = $default_names[$key];
2698
+			$id = $this->_current_view . '_' . $ref;
2699
+			$name = ! empty($actions) ? $actions[$key] : $ref;
2700
+			$this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
2701
+			if ( ! $both) {
2702
+				break;
2703
+			}
2704
+		}
2705
+	}
2706
+
2707
+
2708
+
2709
+	/**
2710
+	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
2711
+	 *
2712
+	 * @see   $this->_set_add_edit_form_tags() for details on params
2713
+	 * @since 4.6.0
2714
+	 * @param string $route
2715
+	 * @param array  $additional_hidden_fields
2716
+	 */
2717
+	public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
2718
+	{
2719
+		$this->_set_add_edit_form_tags($route, $additional_hidden_fields);
2720
+	}
2721
+
2722
+
2723
+
2724
+	/**
2725
+	 * set form open and close tags on add/edit pages.
2726
+	 *
2727
+	 * @access protected
2728
+	 * @param string $route                    the route you want the form to direct to
2729
+	 * @param array  $additional_hidden_fields any additional hidden fields required in the form header
2730
+	 * @return void
2731
+	 */
2732
+	protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
2733
+	{
2734
+		if (empty($route)) {
2735
+			$user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
2736
+			$dev_msg = $user_msg . "\n" . sprintf(__('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__);
2737
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
2738
+		}
2739
+		// open form
2740
+		$this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
2741
+		// add nonce
2742
+		$nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
2743
+		//		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
2744
+		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
2745
+		// add REQUIRED form action
2746
+		$hidden_fields = array(
2747
+				'action' => array('type' => 'hidden', 'value' => $route),
2748
+		);
2749
+		// merge arrays
2750
+		$hidden_fields = is_array($additional_hidden_fields) ? array_merge($hidden_fields, $additional_hidden_fields) : $hidden_fields;
2751
+		// generate form fields
2752
+		$form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
2753
+		// add fields to form
2754
+		foreach ((array)$form_fields as $field_name => $form_field) {
2755
+			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
2756
+		}
2757
+		// close form
2758
+		$this->_template_args['after_admin_page_content'] = '</form>';
2759
+	}
2760
+
2761
+
2762
+
2763
+	/**
2764
+	 * Public Wrapper for _redirect_after_action() method since its
2765
+	 * discovered it would be useful for external code to have access.
2766
+	 *
2767
+	 * @see   EE_Admin_Page::_redirect_after_action() for params.
2768
+	 * @since 4.5.0
2769
+	 */
2770
+	public function redirect_after_action($success = false, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
2771
+	{
2772
+		$this->_redirect_after_action($success, $what, $action_desc, $query_args, $override_overwrite);
2773
+	}
2774
+
2775
+
2776
+
2777
+	/**
2778
+	 *    _redirect_after_action
2779
+	 *
2780
+	 * @param int    $success            - whether success was for two or more records, or just one, or none
2781
+	 * @param string $what               - what the action was performed on
2782
+	 * @param string $action_desc        - what was done ie: updated, deleted, etc
2783
+	 * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin action is completed
2784
+	 * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
2785
+	 * @access protected
2786
+	 * @return void
2787
+	 */
2788
+	protected function _redirect_after_action($success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = false)
2789
+	{
2790
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2791
+		//class name for actions/filters.
2792
+		$classname = get_class($this);
2793
+		//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
2794
+		$redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
2795
+		$notices = EE_Error::get_notices(false);
2796
+		// overwrite default success messages //BUT ONLY if overwrite not overridden
2797
+		if ( ! $override_overwrite || ! empty($notices['errors'])) {
2798
+			EE_Error::overwrite_success();
2799
+		}
2800
+		if ( ! empty($what) && ! empty($action_desc)) {
2801
+			// how many records affected ? more than one record ? or just one ?
2802
+			if ($success > 1 && empty($notices['errors'])) {
2803
+				// set plural msg
2804
+				EE_Error::add_success(
2805
+						sprintf(
2806
+								__('The "%s" have been successfully %s.', 'event_espresso'),
2807
+								$what,
2808
+								$action_desc
2809
+						),
2810
+						__FILE__, __FUNCTION__, __LINE__
2811
+				);
2812
+			} else if ($success == 1 && empty($notices['errors'])) {
2813
+				// set singular msg
2814
+				EE_Error::add_success(
2815
+						sprintf(
2816
+								__('The "%s" has been successfully %s.', 'event_espresso'),
2817
+								$what,
2818
+								$action_desc
2819
+						),
2820
+						__FILE__, __FUNCTION__, __LINE__
2821
+				);
2822
+			}
2823
+		}
2824
+		// check that $query_args isn't something crazy
2825
+		if ( ! is_array($query_args)) {
2826
+			$query_args = array();
2827
+		}
2828
+		/**
2829
+		 * Allow injecting actions before the query_args are modified for possible different
2830
+		 * redirections on save and close actions
2831
+		 *
2832
+		 * @since 4.2.0
2833
+		 * @param array $query_args       The original query_args array coming into the
2834
+		 *                                method.
2835
+		 */
2836
+		do_action('AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args);
2837
+		//calculate where we're going (if we have a "save and close" button pushed)
2838
+		if (isset($this->_req_data['save_and_close']) && isset($this->_req_data['save_and_close_referrer'])) {
2839
+			// even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
2840
+			$parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
2841
+			// regenerate query args array from referrer URL
2842
+			parse_str($parsed_url['query'], $query_args);
2843
+			// correct page and action will be in the query args now
2844
+			$redirect_url = admin_url('admin.php');
2845
+		}
2846
+		//merge any default query_args set in _default_route_query_args property
2847
+		if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
2848
+			$args_to_merge = array();
2849
+			foreach ($this->_default_route_query_args as $query_param => $query_value) {
2850
+				//is there a wp_referer array in our _default_route_query_args property?
2851
+				if ($query_param == 'wp_referer') {
2852
+					$query_value = (array)$query_value;
2853
+					foreach ($query_value as $reference => $value) {
2854
+						if (strpos($reference, 'nonce') !== false) {
2855
+							continue;
2856
+						}
2857
+						//finally we will override any arguments in the referer with
2858
+						//what might be set on the _default_route_query_args array.
2859
+						if (isset($this->_default_route_query_args[$reference])) {
2860
+							$args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
2861
+						} else {
2862
+							$args_to_merge[$reference] = urlencode($value);
2863
+						}
2864
+					}
2865
+					continue;
2866
+				}
2867
+				$args_to_merge[$query_param] = $query_value;
2868
+			}
2869
+			//now let's merge these arguments but override with what was specifically sent in to the
2870
+			//redirect.
2871
+			$query_args = array_merge($args_to_merge, $query_args);
2872
+		}
2873
+		$this->_process_notices($query_args);
2874
+		// generate redirect url
2875
+		// if redirecting to anything other than the main page, add a nonce
2876
+		if (isset($query_args['action'])) {
2877
+			// manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
2878
+			$query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
2879
+		}
2880
+		//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).
2881
+		do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
2882
+		$redirect_url = apply_filters('FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce($query_args, $redirect_url), $query_args);
2883
+		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
2884
+		if (defined('DOING_AJAX')) {
2885
+			$default_data = array(
2886
+					'close'        => true,
2887
+					'redirect_url' => $redirect_url,
2888
+					'where'        => 'main',
2889
+					'what'         => 'append',
2890
+			);
2891
+			$this->_template_args['success'] = $success;
2892
+			$this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data']) : $default_data;
2893
+			$this->_return_json();
2894
+		}
2895
+		wp_safe_redirect($redirect_url);
2896
+		exit();
2897
+	}
2898
+
2899
+
2900
+
2901
+	/**
2902
+	 * process any notices before redirecting (or returning ajax request)
2903
+	 * This method sets the $this->_template_args['notices'] attribute;
2904
+	 *
2905
+	 * @param  array $query_args        any query args that need to be used for notice transient ('action')
2906
+	 * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
2907
+	 * @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.
2908
+	 * @return void
2909
+	 */
2910
+	protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
2911
+	{
2912
+		//first let's set individual error properties if doing_ajax and the properties aren't already set.
2913
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2914
+			$notices = EE_Error::get_notices(false);
2915
+			if (empty($this->_template_args['success'])) {
2916
+				$this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
2917
+			}
2918
+			if (empty($this->_template_args['errors'])) {
2919
+				$this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
2920
+			}
2921
+			if (empty($this->_template_args['attention'])) {
2922
+				$this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
2923
+			}
2924
+		}
2925
+		$this->_template_args['notices'] = EE_Error::get_notices();
2926
+		//IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
2927
+		if ( ! defined('DOING_AJAX') || $sticky_notices) {
2928
+			$route = isset($query_args['action']) ? $query_args['action'] : 'default';
2929
+			$this->_add_transient($route, $this->_template_args['notices'], true, $skip_route_verify);
2930
+		}
2931
+	}
2932
+
2933
+
2934
+
2935
+	/**
2936
+	 * get_action_link_or_button
2937
+	 * returns the button html for adding, editing, or deleting an item (depending on given type)
2938
+	 *
2939
+	 * @param string $action        use this to indicate which action the url is generated with.
2940
+	 * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key) property.
2941
+	 * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
2942
+	 * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
2943
+	 * @param string $base_url      If this is not provided
2944
+	 *                              the _admin_base_url will be used as the default for the button base_url.
2945
+	 *                              Otherwise this value will be used.
2946
+	 * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
2947
+	 * @return string
2948
+	 * @throws \EE_Error
2949
+	 */
2950
+	public function get_action_link_or_button(
2951
+			$action,
2952
+			$type = 'add',
2953
+			$extra_request = array(),
2954
+			$class = 'button-primary',
2955
+			$base_url = '',
2956
+			$exclude_nonce = false
2957
+	) {
2958
+		//first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
2959
+		if (empty($base_url) && ! isset($this->_page_routes[$action])) {
2960
+			throw new EE_Error(
2961
+					sprintf(
2962
+							__(
2963
+									'There is no page route for given action for the button.  This action was given: %s',
2964
+									'event_espresso'
2965
+							),
2966
+							$action
2967
+					)
2968
+			);
2969
+		}
2970
+		if ( ! isset($this->_labels['buttons'][$type])) {
2971
+			throw new EE_Error(
2972
+					sprintf(
2973
+							__(
2974
+									'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
2975
+									'event_espresso'
2976
+							),
2977
+							$type
2978
+					)
2979
+			);
2980
+		}
2981
+		//finally check user access for this button.
2982
+		$has_access = $this->check_user_access($action, true);
2983
+		if ( ! $has_access) {
2984
+			return '';
2985
+		}
2986
+		$_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
2987
+		$query_args = array(
2988
+				'action' => $action,
2989
+		);
2990
+		//merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
2991
+		if ( ! empty($extra_request)) {
2992
+			$query_args = array_merge($extra_request, $query_args);
2993
+		}
2994
+		$url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
2995
+		return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
2996
+	}
2997
+
2998
+
2999
+
3000
+	/**
3001
+	 * _per_page_screen_option
3002
+	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
3003
+	 *
3004
+	 * @return void
3005
+	 */
3006
+	protected function _per_page_screen_option()
3007
+	{
3008
+		$option = 'per_page';
3009
+		$args = array(
3010
+				'label'   => $this->_admin_page_title,
3011
+				'default' => 10,
3012
+				'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
3013
+		);
3014
+		//ONLY add the screen option if the user has access to it.
3015
+		if ($this->check_user_access($this->_current_view, true)) {
3016
+			add_screen_option($option, $args);
3017
+		}
3018
+	}
3019
+
3020
+
3021
+
3022
+	/**
3023
+	 * set_per_page_screen_option
3024
+	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
3025
+	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
3026
+	 *
3027
+	 * @access private
3028
+	 * @return void
3029
+	 */
3030
+	private function _set_per_page_screen_options()
3031
+	{
3032
+		if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
3033
+			check_admin_referer('screen-options-nonce', 'screenoptionnonce');
3034
+			if ( ! $user = wp_get_current_user()) {
3035
+				return;
3036
+			}
3037
+			$option = $_POST['wp_screen_options']['option'];
3038
+			$value = $_POST['wp_screen_options']['value'];
3039
+			if ($option != sanitize_key($option)) {
3040
+				return;
3041
+			}
3042
+			$map_option = $option;
3043
+			$option = str_replace('-', '_', $option);
3044
+			switch ($map_option) {
3045
+				case $this->_current_page . '_' . $this->_current_view . '_per_page':
3046
+					$value = (int)$value;
3047
+					if ($value < 1 || $value > 999) {
3048
+						return;
3049
+					}
3050
+					break;
3051
+				default:
3052
+					$value = apply_filters('FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value);
3053
+					if (false === $value) {
3054
+						return;
3055
+					}
3056
+					break;
3057
+			}
3058
+			update_user_meta($user->ID, $option, $value);
3059
+			wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
3060
+			exit;
3061
+		}
3062
+	}
3063
+
3064
+
3065
+
3066
+	/**
3067
+	 * This just allows for setting the $_template_args property if it needs to be set outside the object
3068
+	 *
3069
+	 * @param array $data array that will be assigned to template args.
3070
+	 */
3071
+	public function set_template_args($data)
3072
+	{
3073
+		$this->_template_args = array_merge($this->_template_args, (array)$data);
3074
+	}
3075
+
3076
+
3077
+
3078
+	/**
3079
+	 * This makes available the WP transient system for temporarily moving data between routes
3080
+	 *
3081
+	 * @access protected
3082
+	 * @param string $route             the route that should receive the transient
3083
+	 * @param array  $data              the data that gets sent
3084
+	 * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
3085
+	 * @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.
3086
+	 * @return void
3087
+	 */
3088
+	protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
3089
+	{
3090
+		$user_id = get_current_user_id();
3091
+		if ( ! $skip_route_verify) {
3092
+			$this->_verify_route($route);
3093
+		}
3094
+		//now let's set the string for what kind of transient we're setting
3095
+		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
3096
+		$data = $notices ? array('notices' => $data) : $data;
3097
+		//is there already a transient for this route?  If there is then let's ADD to that transient
3098
+		$existing = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
3099
+		if ($existing) {
3100
+			$data = array_merge((array)$data, (array)$existing);
3101
+		}
3102
+		if (is_multisite() && is_network_admin()) {
3103
+			set_site_transient($transient, $data, 8);
3104
+		} else {
3105
+			set_transient($transient, $data, 8);
3106
+		}
3107
+	}
3108
+
3109
+
3110
+
3111
+	/**
3112
+	 * this retrieves the temporary transient that has been set for moving data between routes.
3113
+	 *
3114
+	 * @param bool $notices true we get notices transient. False we just return normal route transient
3115
+	 * @return mixed data
3116
+	 */
3117
+	protected function _get_transient($notices = false, $route = false)
3118
+	{
3119
+		$user_id = get_current_user_id();
3120
+		$route = ! $route ? $this->_req_action : $route;
3121
+		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
3122
+		$data = is_multisite() && is_network_admin() ? get_site_transient($transient) : get_transient($transient);
3123
+		//delete transient after retrieval (just in case it hasn't expired);
3124
+		if (is_multisite() && is_network_admin()) {
3125
+			delete_site_transient($transient);
3126
+		} else {
3127
+			delete_transient($transient);
3128
+		}
3129
+		return $notices && isset($data['notices']) ? $data['notices'] : $data;
3130
+	}
3131
+
3132
+
3133
+
3134
+	/**
3135
+	 * 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.
3136
+	 * 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.)
3137
+	 *
3138
+	 * @return void
3139
+	 */
3140
+	protected function _transient_garbage_collection()
3141
+	{
3142
+		global $wpdb;
3143
+		//retrieve all existing transients
3144
+		$query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
3145
+		if ($results = $wpdb->get_results($query)) {
3146
+			foreach ($results as $result) {
3147
+				$transient = str_replace('_transient_', '', $result->option_name);
3148
+				get_transient($transient);
3149
+				if (is_multisite() && is_network_admin()) {
3150
+					get_site_transient($transient);
3151
+				}
3152
+			}
3153
+		}
3154
+	}
3155
+
3156
+
3157
+
3158
+	/**
3159
+	 * get_view
3160
+	 *
3161
+	 * @access public
3162
+	 * @return string content of _view property
3163
+	 */
3164
+	public function get_view()
3165
+	{
3166
+		return $this->_view;
3167
+	}
3168
+
3169
+
3170
+
3171
+	/**
3172
+	 * getter for the protected $_views property
3173
+	 *
3174
+	 * @return array
3175
+	 */
3176
+	public function get_views()
3177
+	{
3178
+		return $this->_views;
3179
+	}
3180
+
3181
+
3182
+
3183
+	/**
3184
+	 * get_current_page
3185
+	 *
3186
+	 * @access public
3187
+	 * @return string _current_page property value
3188
+	 */
3189
+	public function get_current_page()
3190
+	{
3191
+		return $this->_current_page;
3192
+	}
3193
+
3194
+
3195
+
3196
+	/**
3197
+	 * get_current_view
3198
+	 *
3199
+	 * @access public
3200
+	 * @return string _current_view property value
3201
+	 */
3202
+	public function get_current_view()
3203
+	{
3204
+		return $this->_current_view;
3205
+	}
3206
+
3207
+
3208
+
3209
+	/**
3210
+	 * get_current_screen
3211
+	 *
3212
+	 * @access public
3213
+	 * @return object The current WP_Screen object
3214
+	 */
3215
+	public function get_current_screen()
3216
+	{
3217
+		return $this->_current_screen;
3218
+	}
3219
+
3220
+
3221
+
3222
+	/**
3223
+	 * get_current_page_view_url
3224
+	 *
3225
+	 * @access public
3226
+	 * @return string This returns the url for the current_page_view.
3227
+	 */
3228
+	public function get_current_page_view_url()
3229
+	{
3230
+		return $this->_current_page_view_url;
3231
+	}
3232
+
3233
+
3234
+
3235
+	/**
3236
+	 * just returns the _req_data property
3237
+	 *
3238
+	 * @return array
3239
+	 */
3240
+	public function get_request_data()
3241
+	{
3242
+		return $this->_req_data;
3243
+	}
3244
+
3245
+
3246
+
3247
+	/**
3248
+	 * returns the _req_data protected property
3249
+	 *
3250
+	 * @return string
3251
+	 */
3252
+	public function get_req_action()
3253
+	{
3254
+		return $this->_req_action;
3255
+	}
3256
+
3257
+
3258
+
3259
+	/**
3260
+	 * @return bool  value of $_is_caf property
3261
+	 */
3262
+	public function is_caf()
3263
+	{
3264
+		return $this->_is_caf;
3265
+	}
3266
+
3267
+
3268
+
3269
+	/**
3270
+	 * @return mixed
3271
+	 */
3272
+	public function default_espresso_metaboxes()
3273
+	{
3274
+		return $this->_default_espresso_metaboxes;
3275
+	}
3276
+
3277
+
3278
+
3279
+	/**
3280
+	 * @return mixed
3281
+	 */
3282
+	public function admin_base_url()
3283
+	{
3284
+		return $this->_admin_base_url;
3285
+	}
3286
+
3287
+
3288
+
3289
+	/**
3290
+	 * @return mixed
3291
+	 */
3292
+	public function wp_page_slug()
3293
+	{
3294
+		return $this->_wp_page_slug;
3295
+	}
3296
+
3297
+
3298
+
3299
+	/**
3300
+	 * updates  espresso configuration settings
3301
+	 *
3302
+	 * @access    protected
3303
+	 * @param string                   $tab
3304
+	 * @param EE_Config_Base|EE_Config $config
3305
+	 * @param string                   $file file where error occurred
3306
+	 * @param string                   $func function  where error occurred
3307
+	 * @param string                   $line line no where error occurred
3308
+	 * @return boolean
3309
+	 */
3310
+	protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
3311
+	{
3312
+		//remove any options that are NOT going to be saved with the config settings.
3313
+		if (isset($config->core->ee_ueip_optin)) {
3314
+			$config->core->ee_ueip_has_notified = true;
3315
+			// TODO: remove the following two lines and make sure values are migrated from 3.1
3316
+			update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
3317
+			update_option('ee_ueip_has_notified', true);
3318
+		}
3319
+		// and save it (note we're also doing the network save here)
3320
+		$net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
3321
+		$config_saved = EE_Config::instance()->update_espresso_config(false, false);
3322
+		if ($config_saved && $net_saved) {
3323
+			EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
3324
+			return true;
3325
+		} else {
3326
+			EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
3327
+			return false;
3328
+		}
3329
+	}
3330
+
3331
+
3332
+
3333
+	/**
3334
+	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
3335
+	 *
3336
+	 * @return array
3337
+	 */
3338
+	public function get_yes_no_values()
3339
+	{
3340
+		return $this->_yes_no_values;
3341
+	}
3342
+
3343
+
3344
+
3345
+	protected function _get_dir()
3346
+	{
3347
+		$reflector = new ReflectionClass(get_class($this));
3348
+		return dirname($reflector->getFileName());
3349
+	}
3350
+
3351
+
3352
+
3353
+	/**
3354
+	 * A helper for getting a "next link".
3355
+	 *
3356
+	 * @param string $url   The url to link to
3357
+	 * @param string $class The class to use.
3358
+	 * @return string
3359
+	 */
3360
+	protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
3361
+	{
3362
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
3363
+	}
3364
+
3365
+
3366
+
3367
+	/**
3368
+	 * A helper for getting a "previous link".
3369
+	 *
3370
+	 * @param string $url   The url to link to
3371
+	 * @param string $class The class to use.
3372
+	 * @return string
3373
+	 */
3374
+	protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
3375
+	{
3376
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
3377
+	}
3378
+
3379
+
3380
+
3381
+
3382
+
3383
+
3384
+
3385
+	//below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
3386
+	/**
3387
+	 * 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
3388
+	 * array.
3389
+	 *
3390
+	 * @return bool success/fail
3391
+	 */
3392
+	protected function _process_resend_registration()
3393
+	{
3394
+		$this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
3395
+		do_action('AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data);
3396
+		return $this->_template_args['success'];
3397
+	}
3398
+
3399
+
3400
+
3401
+	/**
3402
+	 * This automatically processes any payment message notifications when manual payment has been applied.
3403
+	 *
3404
+	 * @access protected
3405
+	 * @param \EE_Payment $payment
3406
+	 * @return bool success/fail
3407
+	 */
3408
+	protected function _process_payment_notification(EE_Payment $payment)
3409
+	{
3410
+		add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
3411
+		do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
3412
+		$this->_template_args['success'] = apply_filters('FHEE__EE_Admin_Page___process_admin_payment_notification__success', false, $payment);
3413
+		return $this->_template_args['success'];
3414
+	}
3415 3415
 
3416 3416
 
3417 3417
 }
Please login to merge, or discard this patch.
modules/ticket_selector/DisplayTicketSelector.php 2 patches
Indentation   +663 added lines, -663 removed lines patch added patch discarded remove patch
@@ -2,7 +2,7 @@  discard block
 block discarded – undo
2 2
 namespace EventEspresso\modules\ticket_selector;
3 3
 
4 4
 if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
5
-    exit( 'No direct script access allowed' );
5
+	exit( 'No direct script access allowed' );
6 6
 }
7 7
 
8 8
 
@@ -19,671 +19,671 @@  discard block
 block discarded – undo
19 19
 class DisplayTicketSelector
20 20
 {
21 21
 
22
-    /**
23
-     * event that ticket selector is being generated for
24
-     *
25
-     * @access protected
26
-     * @var \EE_Event $event
27
-     */
28
-    protected $event;
29
-
30
-    /**
31
-     * Used to flag when the ticket selector is being called from an external iframe.
32
-     *
33
-     * @var bool $iframe
34
-     */
35
-    protected $iframe = false;
36
-
37
-    /**
38
-     * max attendees that can register for event at one time
39
-     *
40
-     * @var int $max_attendees
41
-     */
42
-    private $max_attendees = EE_INF;
43
-
44
-    /**
45
-     *@var string $date_format
46
-     */
47
-    private $date_format = '';
48
-
49
-    /**
50
-     *@var string $time_format
51
-     */
52
-    private $time_format = '';
53
-
54
-
55
-
56
-    /**
57
-     * DisplayTicketSelector constructor.
58
-     */
59
-    public function __construct()
60
-    {
61
-        $this->date_format = apply_filters(
62
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
63
-            get_option('date_format')
64
-        );
65
-        $this->time_format = apply_filters(
66
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
67
-            get_option('time_format')
68
-        );
69
-    }
70
-
71
-
72
-
73
-    /**
74
-     * @param boolean $iframe
75
-     */
76
-    public function setIframe( $iframe = true )
77
-    {
78
-        $this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
79
-    }
80
-
81
-
82
-
83
-    /**
84
-     * finds and sets the \EE_Event object for use throughout class
85
-     *
86
-     * @param    mixed $event
87
-     * @return    bool
88
-     */
89
-    protected function setEvent( $event = null )
90
-    {
91
-        if ( $event === null ) {
92
-            global $post;
93
-            $event = $post;
94
-        }
95
-        if ( $event instanceof \EE_Event ) {
96
-            $this->event = $event;
97
-        } else if ( $event instanceof \WP_Post ) {
98
-            if ( isset( $event->EE_Event ) && $event->EE_Event instanceof \EE_Event ) {
99
-                $this->event = $event->EE_Event;
100
-            } else if ( $event->post_type === 'espresso_events' ) {
101
-                $event->EE_Event = \EEM_Event::instance()->instantiate_class_from_post_object( $event );
102
-                $this->event = $event->EE_Event;
103
-            }
104
-        } else {
105
-            $user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
106
-            $dev_msg = $user_msg . __(
107
-                    'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
108
-                    'event_espresso'
109
-                );
110
-            \EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
111
-            return false;
112
-        }
113
-        return true;
114
-    }
115
-
116
-
117
-
118
-    /**
119
-     * @return int
120
-     */
121
-    public function getMaxAttendees()
122
-    {
123
-        return $this->max_attendees;
124
-    }
125
-
126
-
127
-
128
-    /**
129
-     * @param int $max_attendees
130
-     */
131
-    public function setMaxAttendees($max_attendees)
132
-    {
133
-        $this->max_attendees = absint(
134
-            apply_filters(
135
-                'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
136
-                $max_attendees
137
-            )
138
-        );
139
-    }
140
-
141
-
142
-
143
-    /**
144
-     * creates buttons for selecting number of attendees for an event
145
-     *
146
-     * @param \WP_Post|int $event
147
-     * @param bool         $view_details
148
-     * @return string
149
-     * @throws \EE_Error
150
-     */
151
-    public function display( $event = null, $view_details = false )
152
-    {
153
-        // reset filter for displaying submit button
154
-        remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
155
-        // poke and prod incoming event till it tells us what it is
156
-        if ( ! $this->setEvent( $event ) ) {
157
-            return false;
158
-        }
159
-        // begin gathering template arguments by getting event status
160
-        $template_args = array( 'event_status' => $this->event->get_active_status() );
161
-        if ( $this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details) ) {
162
-            return ! is_single() ? $this->displayViewDetailsButton() : '';
163
-        }
164
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
165
-        $this->setMaxAttendees($this->event->additional_limit());
166
-        if ($this->getMaxAttendees() < 1) {
167
-            return $this->ticketSalesClosedMessage();
168
-        }
169
-        // is the event expired ?
170
-        $template_args['event_is_expired'] = $this->event->is_expired();
171
-        if ( $template_args[ 'event_is_expired' ] ) {
172
-            return $this->expiredEventMessage();
173
-        }
174
-        // get all tickets for this event ordered by the datetime
175
-        $tickets = $this->getTickets();
176
-        if (count($tickets) < 1) {
177
-            return $this->noTicketAvailableMessage();
178
-        }
179
-        // redirecting to another site for registration ??
180
-        $external_url = (string) $this->event->external_url();
181
-        // if redirecting to another site for registration, then we don't load the TS
182
-        $ticket_selector = $external_url
183
-            ? $this->externalEventRegistration()
184
-            : $this->loadTicketSelector($tickets,$template_args);
185
-        // now set up the form (but not for the admin)
186
-        $ticket_selector = ! is_admin()
187
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
188
-            : $ticket_selector;
189
-        // submit button and form close tag
190
-        $ticket_selector .= ! is_admin() ? $this->displaySubmitButton($external_url) : '';
191
-        return $ticket_selector;
192
-    }
193
-
194
-
195
-
196
-    /**
197
-     * displayTicketSelector
198
-     * examines the event properties and determines whether a Ticket Selector should be displayed
199
-     *
200
-     * @param \WP_Post|int $event
201
-     * @param string       $_event_active_status
202
-     * @param bool         $view_details
203
-     * @return bool
204
-     * @throws \EE_Error
205
-     */
206
-    protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
207
-    {
208
-        $event_post = $this->event instanceof \EE_Event ? $this->event->ID() : $event;
209
-        return ! is_admin()
210
-               && (
211
-                   ! $this->event->display_ticket_selector()
212
-                   || $view_details
213
-                   || post_password_required($event_post)
214
-                   || (
215
-                       $_event_active_status !== \EE_Datetime::active
216
-                       && $_event_active_status !== \EE_Datetime::upcoming
217
-                       && $_event_active_status !== \EE_Datetime::sold_out
218
-                       && ! (
219
-                           $_event_active_status === \EE_Datetime::inactive
220
-                           && is_user_logged_in()
221
-                       )
222
-                   )
223
-               );
224
-    }
225
-
226
-
227
-
228
-    /**
229
-     * noTicketAvailableMessage
230
-     * notice displayed if event is expired
231
-     *
232
-     * @return string
233
-     * @throws \EE_Error
234
-     */
235
-    protected function expiredEventMessage()
236
-    {
237
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
238
-            'We\'re sorry, but all tickets sales have ended because the event is expired.',
239
-            'event_espresso'
240
-        ) . '</span></div>';
241
-    }
242
-
243
-
244
-
245
-    /**
246
-     * noTicketAvailableMessage
247
-     * notice displayed if event has no more tickets available
248
-     *
249
-     * @return string
250
-     * @throws \EE_Error
251
-     */
252
-    protected function noTicketAvailableMessage()
253
-    {
254
-        $no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
255
-        if (current_user_can('edit_post', $this->event->ID())) {
256
-            $no_ticket_available_msg .= sprintf(
257
-                esc_html__(
258
-                    '%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
259
-                    'event_espresso'
260
-                ),
261
-                '<div class="ee-attention" style="text-align: left;"><b>',
262
-                '</b><br />',
263
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
264
-                '</a></span></div>'
265
-            );
266
-        }
267
-        return '
22
+	/**
23
+	 * event that ticket selector is being generated for
24
+	 *
25
+	 * @access protected
26
+	 * @var \EE_Event $event
27
+	 */
28
+	protected $event;
29
+
30
+	/**
31
+	 * Used to flag when the ticket selector is being called from an external iframe.
32
+	 *
33
+	 * @var bool $iframe
34
+	 */
35
+	protected $iframe = false;
36
+
37
+	/**
38
+	 * max attendees that can register for event at one time
39
+	 *
40
+	 * @var int $max_attendees
41
+	 */
42
+	private $max_attendees = EE_INF;
43
+
44
+	/**
45
+	 *@var string $date_format
46
+	 */
47
+	private $date_format = '';
48
+
49
+	/**
50
+	 *@var string $time_format
51
+	 */
52
+	private $time_format = '';
53
+
54
+
55
+
56
+	/**
57
+	 * DisplayTicketSelector constructor.
58
+	 */
59
+	public function __construct()
60
+	{
61
+		$this->date_format = apply_filters(
62
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
63
+			get_option('date_format')
64
+		);
65
+		$this->time_format = apply_filters(
66
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
67
+			get_option('time_format')
68
+		);
69
+	}
70
+
71
+
72
+
73
+	/**
74
+	 * @param boolean $iframe
75
+	 */
76
+	public function setIframe( $iframe = true )
77
+	{
78
+		$this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
79
+	}
80
+
81
+
82
+
83
+	/**
84
+	 * finds and sets the \EE_Event object for use throughout class
85
+	 *
86
+	 * @param    mixed $event
87
+	 * @return    bool
88
+	 */
89
+	protected function setEvent( $event = null )
90
+	{
91
+		if ( $event === null ) {
92
+			global $post;
93
+			$event = $post;
94
+		}
95
+		if ( $event instanceof \EE_Event ) {
96
+			$this->event = $event;
97
+		} else if ( $event instanceof \WP_Post ) {
98
+			if ( isset( $event->EE_Event ) && $event->EE_Event instanceof \EE_Event ) {
99
+				$this->event = $event->EE_Event;
100
+			} else if ( $event->post_type === 'espresso_events' ) {
101
+				$event->EE_Event = \EEM_Event::instance()->instantiate_class_from_post_object( $event );
102
+				$this->event = $event->EE_Event;
103
+			}
104
+		} else {
105
+			$user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
106
+			$dev_msg = $user_msg . __(
107
+					'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
108
+					'event_espresso'
109
+				);
110
+			\EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
111
+			return false;
112
+		}
113
+		return true;
114
+	}
115
+
116
+
117
+
118
+	/**
119
+	 * @return int
120
+	 */
121
+	public function getMaxAttendees()
122
+	{
123
+		return $this->max_attendees;
124
+	}
125
+
126
+
127
+
128
+	/**
129
+	 * @param int $max_attendees
130
+	 */
131
+	public function setMaxAttendees($max_attendees)
132
+	{
133
+		$this->max_attendees = absint(
134
+			apply_filters(
135
+				'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
136
+				$max_attendees
137
+			)
138
+		);
139
+	}
140
+
141
+
142
+
143
+	/**
144
+	 * creates buttons for selecting number of attendees for an event
145
+	 *
146
+	 * @param \WP_Post|int $event
147
+	 * @param bool         $view_details
148
+	 * @return string
149
+	 * @throws \EE_Error
150
+	 */
151
+	public function display( $event = null, $view_details = false )
152
+	{
153
+		// reset filter for displaying submit button
154
+		remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
155
+		// poke and prod incoming event till it tells us what it is
156
+		if ( ! $this->setEvent( $event ) ) {
157
+			return false;
158
+		}
159
+		// begin gathering template arguments by getting event status
160
+		$template_args = array( 'event_status' => $this->event->get_active_status() );
161
+		if ( $this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details) ) {
162
+			return ! is_single() ? $this->displayViewDetailsButton() : '';
163
+		}
164
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
165
+		$this->setMaxAttendees($this->event->additional_limit());
166
+		if ($this->getMaxAttendees() < 1) {
167
+			return $this->ticketSalesClosedMessage();
168
+		}
169
+		// is the event expired ?
170
+		$template_args['event_is_expired'] = $this->event->is_expired();
171
+		if ( $template_args[ 'event_is_expired' ] ) {
172
+			return $this->expiredEventMessage();
173
+		}
174
+		// get all tickets for this event ordered by the datetime
175
+		$tickets = $this->getTickets();
176
+		if (count($tickets) < 1) {
177
+			return $this->noTicketAvailableMessage();
178
+		}
179
+		// redirecting to another site for registration ??
180
+		$external_url = (string) $this->event->external_url();
181
+		// if redirecting to another site for registration, then we don't load the TS
182
+		$ticket_selector = $external_url
183
+			? $this->externalEventRegistration()
184
+			: $this->loadTicketSelector($tickets,$template_args);
185
+		// now set up the form (but not for the admin)
186
+		$ticket_selector = ! is_admin()
187
+			? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
188
+			: $ticket_selector;
189
+		// submit button and form close tag
190
+		$ticket_selector .= ! is_admin() ? $this->displaySubmitButton($external_url) : '';
191
+		return $ticket_selector;
192
+	}
193
+
194
+
195
+
196
+	/**
197
+	 * displayTicketSelector
198
+	 * examines the event properties and determines whether a Ticket Selector should be displayed
199
+	 *
200
+	 * @param \WP_Post|int $event
201
+	 * @param string       $_event_active_status
202
+	 * @param bool         $view_details
203
+	 * @return bool
204
+	 * @throws \EE_Error
205
+	 */
206
+	protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
207
+	{
208
+		$event_post = $this->event instanceof \EE_Event ? $this->event->ID() : $event;
209
+		return ! is_admin()
210
+			   && (
211
+				   ! $this->event->display_ticket_selector()
212
+				   || $view_details
213
+				   || post_password_required($event_post)
214
+				   || (
215
+					   $_event_active_status !== \EE_Datetime::active
216
+					   && $_event_active_status !== \EE_Datetime::upcoming
217
+					   && $_event_active_status !== \EE_Datetime::sold_out
218
+					   && ! (
219
+						   $_event_active_status === \EE_Datetime::inactive
220
+						   && is_user_logged_in()
221
+					   )
222
+				   )
223
+			   );
224
+	}
225
+
226
+
227
+
228
+	/**
229
+	 * noTicketAvailableMessage
230
+	 * notice displayed if event is expired
231
+	 *
232
+	 * @return string
233
+	 * @throws \EE_Error
234
+	 */
235
+	protected function expiredEventMessage()
236
+	{
237
+		return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
238
+			'We\'re sorry, but all tickets sales have ended because the event is expired.',
239
+			'event_espresso'
240
+		) . '</span></div>';
241
+	}
242
+
243
+
244
+
245
+	/**
246
+	 * noTicketAvailableMessage
247
+	 * notice displayed if event has no more tickets available
248
+	 *
249
+	 * @return string
250
+	 * @throws \EE_Error
251
+	 */
252
+	protected function noTicketAvailableMessage()
253
+	{
254
+		$no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
255
+		if (current_user_can('edit_post', $this->event->ID())) {
256
+			$no_ticket_available_msg .= sprintf(
257
+				esc_html__(
258
+					'%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
259
+					'event_espresso'
260
+				),
261
+				'<div class="ee-attention" style="text-align: left;"><b>',
262
+				'</b><br />',
263
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
264
+				'</a></span></div>'
265
+			);
266
+		}
267
+		return '
268 268
             <div class="ee-event-expired-notice">
269 269
                 <span class="important-notice">' . $no_ticket_available_msg . '</span>
270 270
             </div>';
271
-    }
272
-
273
-
274
-
275
-    /**
276
-     * ticketSalesClosed
277
-     * notice displayed if event ticket sales are turned off
278
-     *
279
-     * @return string
280
-     * @throws \EE_Error
281
-     */
282
-    protected function ticketSalesClosedMessage()
283
-    {
284
-        $sales_closed_msg = esc_html__(
285
-            'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
286
-            'event_espresso'
287
-        );
288
-        if (current_user_can('edit_post', $this->event->ID())) {
289
-            $sales_closed_msg .= sprintf(
290
-                esc_html__(
291
-                    '%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
292
-                    'event_espresso'
293
-                ),
294
-                '<div class="ee-attention" style="text-align: left;"><b>',
295
-                '</b><br />',
296
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
297
-                '</a></span></div>'
298
-            );
299
-        }
300
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
301
-    }
302
-
303
-
304
-
305
-    /**
306
-     * getTickets
307
-     *
308
-     * @return \EE_Base_Class[]|\EE_Ticket[]
309
-     * @throws \EE_Error
310
-     */
311
-    protected function getTickets()
312
-    {
313
-        $ticket_query_args = array(
314
-            array('Datetime.EVT_ID' => $this->event->ID()),
315
-            'order_by' => array(
316
-                'TKT_order'              => 'ASC',
317
-                'TKT_required'           => 'DESC',
318
-                'TKT_start_date'         => 'ASC',
319
-                'TKT_end_date'           => 'ASC',
320
-                'Datetime.DTT_EVT_start' => 'DESC',
321
-            ),
322
-        );
323
-        if ( ! \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets) {
324
-            //use the correct applicable time query depending on what version of core is being run.
325
-            $current_time = method_exists('EEM_Datetime', 'current_time_for_query')
326
-                ? time()
327
-                : current_time('timestamp');
328
-            $ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
329
-        }
330
-        return \EEM_Ticket::instance()->get_all($ticket_query_args);
331
-    }
332
-
333
-
334
-
335
-    /**
336
-     * loadTicketSelector
337
-     * begins to assemble template arguments
338
-     * and decides whether to load a "simple" ticket selector, or the standard
339
-     *
340
-     * @param \EE_Ticket[] $tickets
341
-     * @param array $template_args
342
-     * @return string
343
-     * @throws \EE_Error
344
-     */
345
-    protected function loadTicketSelector(array $tickets, array $template_args)
346
-    {
347
-        $template_args['event'] = $this->event;
348
-        $template_args['EVT_ID'] = $this->event->ID();
349
-        $template_args['event_is_expired'] = $this->event->is_expired();
350
-        $template_args['max_atndz'] = $this->getMaxAttendees();
351
-        $template_args['date_format'] = $this->date_format;
352
-        $template_args['time_format'] = $this->time_format;
353
-        /**
354
-         * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
355
-         *
356
-         * @since 4.9.13
357
-         * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
358
-         * @param int $EVT_ID The Event ID
359
-         */
360
-        $template_args['anchor_id'] = apply_filters(
361
-            'FHEE__EE_Ticket_Selector__redirect_anchor_id',
362
-            '#tkt-slctr-tbl-' . $this->event->ID(),
363
-            $this->event->ID()
364
-        );
365
-        $template_args['tickets'] = $tickets;
366
-        $template_args['ticket_count'] = count($tickets);
367
-        $ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
368
-        return $ticket_selector instanceof TicketSelectorSimple
369
-            ? $ticket_selector
370
-            : new TicketSelectorStandard(
371
-                $this->event,
372
-                $tickets,
373
-                $this->getMaxAttendees(),
374
-                $template_args,
375
-                $this->date_format,
376
-                $this->time_format
377
-            );
378
-    }
379
-
380
-
381
-
382
-    /**
383
-     * simpleTicketSelector
384
-     * there's one ticket, and max attendees is set to one,
385
-     * so if the event is free, then this is a "simple" ticket selector
386
-     * a.k.a. "Dude Where's my Ticket Selector?"
387
-     *
388
-     * @param \EE_Ticket[] $tickets
389
-     * @param array  $template_args
390
-     * @return string
391
-     * @throws \EE_Error
392
-     */
393
-    protected function simpleTicketSelector($tickets, array $template_args)
394
-    {
395
-        // if there is only ONE ticket with a max qty of ONE
396
-        if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
397
-            return '';
398
-        }
399
-        /** @var \EE_Ticket $ticket */
400
-        $ticket = reset($tickets);
401
-        // if the ticket is free... then not much need for the ticket selector
402
-        if (
403
-            apply_filters(
404
-                'FHEE__ticket_selector_chart_template__hide_ticket_selector',
405
-                $ticket->is_free(),
406
-                $this->event->ID()
407
-            )
408
-        ) {
409
-            return new TicketSelectorSimple(
410
-                $this->event,
411
-                $ticket,
412
-                $this->getMaxAttendees(),
413
-                $template_args
414
-            );
415
-        }
416
-        return '';
417
-    }
418
-
419
-
420
-
421
-    /**
422
-     * externalEventRegistration
423
-     *
424
-     * @return string
425
-     */
426
-    public function externalEventRegistration()
427
-    {
428
-        // if not we still need to trigger the display of the submit button
429
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
430
-        //display notice to admin that registration is external
431
-        return is_admin()
432
-            ? esc_html__(
433
-                'Registration is at an external URL for this event.',
434
-                'event_espresso'
435
-            )
436
-            : '';
437
-    }
438
-
439
-
440
-
441
-    /**
442
-     * formOpen
443
-     *
444
-     * @param        int    $ID
445
-     * @param        string $external_url
446
-     * @return        string
447
-     */
448
-    public function formOpen( $ID = 0, $external_url = '' )
449
-    {
450
-        // if redirecting, we don't need any anything else
451
-        if ( $external_url ) {
452
-            $html = '<form method="GET" action="' . \EEH_URL::refactor_url($external_url) . '"';
453
-            // open link in new window ?
454
-            $html .= apply_filters(
455
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
456
-                false
457
-            )
458
-                ? ' target="_blank"'
459
-                : '';
460
-            $html .= '>';
461
-            $query_args = \EEH_URL::get_query_string( $external_url );
462
-            foreach ( (array)$query_args as $query_arg => $value ) {
463
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
464
-            }
465
-            return $html;
466
-        }
467
-        // if there is no submit button, then don't start building a form
468
-        // because the "View Details" button will build its own form
469
-        if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
470
-            return '';
471
-        }
472
-        $checkout_url = \EEH_Event_View::event_link_url( $ID );
473
-        if ( ! $checkout_url ) {
474
-            \EE_Error::add_error(
475
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
476
-                __FILE__,
477
-                __FUNCTION__,
478
-                __LINE__
479
-            );
480
-        }
481
-        // set no cache headers and constants
482
-        \EE_System::do_not_cache();
483
-        $extra_params = $this->iframe ? ' target="_blank"' : '';
484
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
485
-        $html .= wp_nonce_field( 'process_ticket_selections', 'process_ticket_selections_nonce_' . $ID, true, false );
486
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
487
-        $html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
488
-        return $html;
489
-    }
490
-
491
-
492
-
493
-    /**
494
-     * displaySubmitButton
495
-     *
496
-     * @param  string $external_url
497
-     * @return string
498
-     * @throws \EE_Error
499
-     */
500
-    public function displaySubmitButton($external_url = '')
501
-    {
502
-        $html = '';
503
-        if ( ! is_admin()) {
504
-            // standard TS displayed with submit button, ie: "Register Now"
505
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
506
-                $html .= $this->displayRegisterNowButton();
507
-                $html .= empty($external_url)
508
-                    ? $this->ticketSelectorEndDiv()
509
-                    : $this->clearTicketSelector();
510
-                $html .= '<br/>' . $this->formClose();
511
-            } else if ($this->getMaxAttendees() === 1) {
512
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
513
-                if ($this->event->is_sold_out()) {
514
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
515
-                    $html .= apply_filters(
516
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
517
-                        sprintf(
518
-                            __(
519
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
520
-                                'event_espresso'
521
-                            ),
522
-                            '<p class="no-ticket-selector-msg clear-float">',
523
-                            $this->event->name(),
524
-                            '</p>',
525
-                            '<br />'
526
-                        ),
527
-                        $this->event
528
-                    );
529
-                    if (
530
-                    apply_filters(
531
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
532
-                        false,
533
-                        $this->event
534
-                    )
535
-                    ) {
536
-                        $html .= $this->displayRegisterNowButton();
537
-                    }
538
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
539
-                    $html .= $this->ticketSelectorEndDiv();
540
-                } else if (
541
-                    apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
542
-                    && ! is_single()
543
-                ) {
544
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
545
-                    // but no tickets are available, so display event's "View Details" button.
546
-                    // it is being viewed via somewhere other than a single post
547
-                    $html .= $this->displayViewDetailsButton(true);
548
-                }
549
-            } else if (is_archive()) {
550
-                // event list, no tickets available so display event's "View Details" button
551
-                $html .= $this->ticketSelectorEndDiv();
552
-                $html .= $this->displayViewDetailsButton();
553
-            } else {
554
-                if (
555
-                apply_filters(
556
-                    'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
557
-                    false,
558
-                    $this->event
559
-                )
560
-                ) {
561
-                    $html .= $this->displayRegisterNowButton();
562
-                }
563
-                // no submit or view details button, and no additional content
564
-                $html .= $this->ticketSelectorEndDiv();
565
-            }
566
-            if ( ! is_archive()) {
567
-                $html .= \EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
568
-            }
569
-        }
570
-        return $html;
571
-    }
572
-
573
-
574
-
575
-    /**
576
-     * @return string
577
-     * @throws \EE_Error
578
-     */
579
-    public function displayRegisterNowButton()
580
-    {
581
-        $btn_text = apply_filters(
582
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
583
-            __('Register Now', 'event_espresso'),
584
-            $this->event
585
-        );
586
-        $external_url = $this->event->external_url();
587
-        $html = \EEH_HTML::div(
588
-            '', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
589
-        );
590
-        $html .= \EEH_HTML::span(
591
-            esc_html__('please select a datetime', 'event_espresso'),
592
-            '', 'ticket-selector-disabled-submit-btn-msg important-notice'
593
-        );
594
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
595
-        $html .= ' class="ticket-selector-submit-btn ';
596
-        $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
597
-        $html .= ' type="submit" value="' . $btn_text . '" />';
598
-        $html .= \EEH_HTML::divx();
599
-        $html .= apply_filters(
600
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
601
-            '',
602
-            $this->event
603
-        );
604
-        return $html;
605
-    }
606
-
607
-
608
-    /**
609
-     * displayViewDetailsButton
610
-     *
611
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
612
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
613
-     *                    either because they are sold out, expired, or not yet on sale.
614
-     *                    In this case, we need to close the form BEFORE adding any closing divs
615
-     * @return string
616
-     * @throws \EE_Error
617
-     */
618
-    public function displayViewDetailsButton( $DWMTS = false )
619
-    {
620
-        if ( ! $this->event->get_permalink() ) {
621
-            \EE_Error::add_error(
622
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
623
-                __FILE__, __FUNCTION__, __LINE__
624
-            );
625
-        }
626
-        $view_details_btn = '<form method="POST" action="';
627
-        $view_details_btn .= apply_filters(
628
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
629
-            $this->event->get_permalink(),
630
-            $this->event
631
-        );
632
-        $view_details_btn .= '">';
633
-        $btn_text = apply_filters(
634
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
635
-            esc_html__('View Details', 'event_espresso'),
636
-            $this->event
637
-        );
638
-        $view_details_btn .= '<input id="ticket-selector-submit-'
639
-                             . $this->event->ID()
640
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
641
-                             . $btn_text
642
-                             . '" />';
643
-        $view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
644
-        if ($DWMTS) {
645
-            $view_details_btn .= $this->formClose();
646
-            $view_details_btn .= $this->ticketSelectorEndDiv();
647
-            $view_details_btn .= '<br/>';
648
-        } else {
649
-            $view_details_btn .= $this->clearTicketSelector();
650
-            $view_details_btn .= '<br/>';
651
-            $view_details_btn .= $this->formClose();
652
-        }
653
-        return $view_details_btn;
654
-    }
655
-
656
-
657
-
658
-    /**
659
-     * @return string
660
-     */
661
-    public function ticketSelectorEndDiv()
662
-    {
663
-        return '<div class="clear"></div></div>';
664
-    }
665
-
666
-
667
-
668
-    /**
669
-     * @return string
670
-     */
671
-    public function clearTicketSelector()
672
-    {
673
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
674
-        return '<div class="clear"></div>';
675
-    }
676
-
677
-
678
-
679
-    /**
680
-     * @access        public
681
-     * @return        string
682
-     */
683
-    public function formClose()
684
-    {
685
-        return '</form>';
686
-    }
271
+	}
272
+
273
+
274
+
275
+	/**
276
+	 * ticketSalesClosed
277
+	 * notice displayed if event ticket sales are turned off
278
+	 *
279
+	 * @return string
280
+	 * @throws \EE_Error
281
+	 */
282
+	protected function ticketSalesClosedMessage()
283
+	{
284
+		$sales_closed_msg = esc_html__(
285
+			'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
286
+			'event_espresso'
287
+		);
288
+		if (current_user_can('edit_post', $this->event->ID())) {
289
+			$sales_closed_msg .= sprintf(
290
+				esc_html__(
291
+					'%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
292
+					'event_espresso'
293
+				),
294
+				'<div class="ee-attention" style="text-align: left;"><b>',
295
+				'</b><br />',
296
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
297
+				'</a></span></div>'
298
+			);
299
+		}
300
+		return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
301
+	}
302
+
303
+
304
+
305
+	/**
306
+	 * getTickets
307
+	 *
308
+	 * @return \EE_Base_Class[]|\EE_Ticket[]
309
+	 * @throws \EE_Error
310
+	 */
311
+	protected function getTickets()
312
+	{
313
+		$ticket_query_args = array(
314
+			array('Datetime.EVT_ID' => $this->event->ID()),
315
+			'order_by' => array(
316
+				'TKT_order'              => 'ASC',
317
+				'TKT_required'           => 'DESC',
318
+				'TKT_start_date'         => 'ASC',
319
+				'TKT_end_date'           => 'ASC',
320
+				'Datetime.DTT_EVT_start' => 'DESC',
321
+			),
322
+		);
323
+		if ( ! \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets) {
324
+			//use the correct applicable time query depending on what version of core is being run.
325
+			$current_time = method_exists('EEM_Datetime', 'current_time_for_query')
326
+				? time()
327
+				: current_time('timestamp');
328
+			$ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
329
+		}
330
+		return \EEM_Ticket::instance()->get_all($ticket_query_args);
331
+	}
332
+
333
+
334
+
335
+	/**
336
+	 * loadTicketSelector
337
+	 * begins to assemble template arguments
338
+	 * and decides whether to load a "simple" ticket selector, or the standard
339
+	 *
340
+	 * @param \EE_Ticket[] $tickets
341
+	 * @param array $template_args
342
+	 * @return string
343
+	 * @throws \EE_Error
344
+	 */
345
+	protected function loadTicketSelector(array $tickets, array $template_args)
346
+	{
347
+		$template_args['event'] = $this->event;
348
+		$template_args['EVT_ID'] = $this->event->ID();
349
+		$template_args['event_is_expired'] = $this->event->is_expired();
350
+		$template_args['max_atndz'] = $this->getMaxAttendees();
351
+		$template_args['date_format'] = $this->date_format;
352
+		$template_args['time_format'] = $this->time_format;
353
+		/**
354
+		 * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
355
+		 *
356
+		 * @since 4.9.13
357
+		 * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
358
+		 * @param int $EVT_ID The Event ID
359
+		 */
360
+		$template_args['anchor_id'] = apply_filters(
361
+			'FHEE__EE_Ticket_Selector__redirect_anchor_id',
362
+			'#tkt-slctr-tbl-' . $this->event->ID(),
363
+			$this->event->ID()
364
+		);
365
+		$template_args['tickets'] = $tickets;
366
+		$template_args['ticket_count'] = count($tickets);
367
+		$ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
368
+		return $ticket_selector instanceof TicketSelectorSimple
369
+			? $ticket_selector
370
+			: new TicketSelectorStandard(
371
+				$this->event,
372
+				$tickets,
373
+				$this->getMaxAttendees(),
374
+				$template_args,
375
+				$this->date_format,
376
+				$this->time_format
377
+			);
378
+	}
379
+
380
+
381
+
382
+	/**
383
+	 * simpleTicketSelector
384
+	 * there's one ticket, and max attendees is set to one,
385
+	 * so if the event is free, then this is a "simple" ticket selector
386
+	 * a.k.a. "Dude Where's my Ticket Selector?"
387
+	 *
388
+	 * @param \EE_Ticket[] $tickets
389
+	 * @param array  $template_args
390
+	 * @return string
391
+	 * @throws \EE_Error
392
+	 */
393
+	protected function simpleTicketSelector($tickets, array $template_args)
394
+	{
395
+		// if there is only ONE ticket with a max qty of ONE
396
+		if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
397
+			return '';
398
+		}
399
+		/** @var \EE_Ticket $ticket */
400
+		$ticket = reset($tickets);
401
+		// if the ticket is free... then not much need for the ticket selector
402
+		if (
403
+			apply_filters(
404
+				'FHEE__ticket_selector_chart_template__hide_ticket_selector',
405
+				$ticket->is_free(),
406
+				$this->event->ID()
407
+			)
408
+		) {
409
+			return new TicketSelectorSimple(
410
+				$this->event,
411
+				$ticket,
412
+				$this->getMaxAttendees(),
413
+				$template_args
414
+			);
415
+		}
416
+		return '';
417
+	}
418
+
419
+
420
+
421
+	/**
422
+	 * externalEventRegistration
423
+	 *
424
+	 * @return string
425
+	 */
426
+	public function externalEventRegistration()
427
+	{
428
+		// if not we still need to trigger the display of the submit button
429
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
430
+		//display notice to admin that registration is external
431
+		return is_admin()
432
+			? esc_html__(
433
+				'Registration is at an external URL for this event.',
434
+				'event_espresso'
435
+			)
436
+			: '';
437
+	}
438
+
439
+
440
+
441
+	/**
442
+	 * formOpen
443
+	 *
444
+	 * @param        int    $ID
445
+	 * @param        string $external_url
446
+	 * @return        string
447
+	 */
448
+	public function formOpen( $ID = 0, $external_url = '' )
449
+	{
450
+		// if redirecting, we don't need any anything else
451
+		if ( $external_url ) {
452
+			$html = '<form method="GET" action="' . \EEH_URL::refactor_url($external_url) . '"';
453
+			// open link in new window ?
454
+			$html .= apply_filters(
455
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
456
+				false
457
+			)
458
+				? ' target="_blank"'
459
+				: '';
460
+			$html .= '>';
461
+			$query_args = \EEH_URL::get_query_string( $external_url );
462
+			foreach ( (array)$query_args as $query_arg => $value ) {
463
+				$html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
464
+			}
465
+			return $html;
466
+		}
467
+		// if there is no submit button, then don't start building a form
468
+		// because the "View Details" button will build its own form
469
+		if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
470
+			return '';
471
+		}
472
+		$checkout_url = \EEH_Event_View::event_link_url( $ID );
473
+		if ( ! $checkout_url ) {
474
+			\EE_Error::add_error(
475
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
476
+				__FILE__,
477
+				__FUNCTION__,
478
+				__LINE__
479
+			);
480
+		}
481
+		// set no cache headers and constants
482
+		\EE_System::do_not_cache();
483
+		$extra_params = $this->iframe ? ' target="_blank"' : '';
484
+		$html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
485
+		$html .= wp_nonce_field( 'process_ticket_selections', 'process_ticket_selections_nonce_' . $ID, true, false );
486
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
487
+		$html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
488
+		return $html;
489
+	}
490
+
491
+
492
+
493
+	/**
494
+	 * displaySubmitButton
495
+	 *
496
+	 * @param  string $external_url
497
+	 * @return string
498
+	 * @throws \EE_Error
499
+	 */
500
+	public function displaySubmitButton($external_url = '')
501
+	{
502
+		$html = '';
503
+		if ( ! is_admin()) {
504
+			// standard TS displayed with submit button, ie: "Register Now"
505
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
506
+				$html .= $this->displayRegisterNowButton();
507
+				$html .= empty($external_url)
508
+					? $this->ticketSelectorEndDiv()
509
+					: $this->clearTicketSelector();
510
+				$html .= '<br/>' . $this->formClose();
511
+			} else if ($this->getMaxAttendees() === 1) {
512
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
513
+				if ($this->event->is_sold_out()) {
514
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
515
+					$html .= apply_filters(
516
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
517
+						sprintf(
518
+							__(
519
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
520
+								'event_espresso'
521
+							),
522
+							'<p class="no-ticket-selector-msg clear-float">',
523
+							$this->event->name(),
524
+							'</p>',
525
+							'<br />'
526
+						),
527
+						$this->event
528
+					);
529
+					if (
530
+					apply_filters(
531
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
532
+						false,
533
+						$this->event
534
+					)
535
+					) {
536
+						$html .= $this->displayRegisterNowButton();
537
+					}
538
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
539
+					$html .= $this->ticketSelectorEndDiv();
540
+				} else if (
541
+					apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
542
+					&& ! is_single()
543
+				) {
544
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
545
+					// but no tickets are available, so display event's "View Details" button.
546
+					// it is being viewed via somewhere other than a single post
547
+					$html .= $this->displayViewDetailsButton(true);
548
+				}
549
+			} else if (is_archive()) {
550
+				// event list, no tickets available so display event's "View Details" button
551
+				$html .= $this->ticketSelectorEndDiv();
552
+				$html .= $this->displayViewDetailsButton();
553
+			} else {
554
+				if (
555
+				apply_filters(
556
+					'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
557
+					false,
558
+					$this->event
559
+				)
560
+				) {
561
+					$html .= $this->displayRegisterNowButton();
562
+				}
563
+				// no submit or view details button, and no additional content
564
+				$html .= $this->ticketSelectorEndDiv();
565
+			}
566
+			if ( ! is_archive()) {
567
+				$html .= \EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
568
+			}
569
+		}
570
+		return $html;
571
+	}
572
+
573
+
574
+
575
+	/**
576
+	 * @return string
577
+	 * @throws \EE_Error
578
+	 */
579
+	public function displayRegisterNowButton()
580
+	{
581
+		$btn_text = apply_filters(
582
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
583
+			__('Register Now', 'event_espresso'),
584
+			$this->event
585
+		);
586
+		$external_url = $this->event->external_url();
587
+		$html = \EEH_HTML::div(
588
+			'', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
589
+		);
590
+		$html .= \EEH_HTML::span(
591
+			esc_html__('please select a datetime', 'event_espresso'),
592
+			'', 'ticket-selector-disabled-submit-btn-msg important-notice'
593
+		);
594
+		$html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
595
+		$html .= ' class="ticket-selector-submit-btn ';
596
+		$html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
597
+		$html .= ' type="submit" value="' . $btn_text . '" />';
598
+		$html .= \EEH_HTML::divx();
599
+		$html .= apply_filters(
600
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
601
+			'',
602
+			$this->event
603
+		);
604
+		return $html;
605
+	}
606
+
607
+
608
+	/**
609
+	 * displayViewDetailsButton
610
+	 *
611
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
612
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
613
+	 *                    either because they are sold out, expired, or not yet on sale.
614
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
615
+	 * @return string
616
+	 * @throws \EE_Error
617
+	 */
618
+	public function displayViewDetailsButton( $DWMTS = false )
619
+	{
620
+		if ( ! $this->event->get_permalink() ) {
621
+			\EE_Error::add_error(
622
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
623
+				__FILE__, __FUNCTION__, __LINE__
624
+			);
625
+		}
626
+		$view_details_btn = '<form method="POST" action="';
627
+		$view_details_btn .= apply_filters(
628
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
629
+			$this->event->get_permalink(),
630
+			$this->event
631
+		);
632
+		$view_details_btn .= '">';
633
+		$btn_text = apply_filters(
634
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
635
+			esc_html__('View Details', 'event_espresso'),
636
+			$this->event
637
+		);
638
+		$view_details_btn .= '<input id="ticket-selector-submit-'
639
+							 . $this->event->ID()
640
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
641
+							 . $btn_text
642
+							 . '" />';
643
+		$view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
644
+		if ($DWMTS) {
645
+			$view_details_btn .= $this->formClose();
646
+			$view_details_btn .= $this->ticketSelectorEndDiv();
647
+			$view_details_btn .= '<br/>';
648
+		} else {
649
+			$view_details_btn .= $this->clearTicketSelector();
650
+			$view_details_btn .= '<br/>';
651
+			$view_details_btn .= $this->formClose();
652
+		}
653
+		return $view_details_btn;
654
+	}
655
+
656
+
657
+
658
+	/**
659
+	 * @return string
660
+	 */
661
+	public function ticketSelectorEndDiv()
662
+	{
663
+		return '<div class="clear"></div></div>';
664
+	}
665
+
666
+
667
+
668
+	/**
669
+	 * @return string
670
+	 */
671
+	public function clearTicketSelector()
672
+	{
673
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
674
+		return '<div class="clear"></div>';
675
+	}
676
+
677
+
678
+
679
+	/**
680
+	 * @access        public
681
+	 * @return        string
682
+	 */
683
+	public function formClose()
684
+	{
685
+		return '</form>';
686
+	}
687 687
 
688 688
 
689 689
 
Please login to merge, or discard this patch.
Spacing   +50 added lines, -50 removed lines patch added patch discarded remove patch
@@ -1,8 +1,8 @@  discard block
 block discarded – undo
1 1
 <?php
2 2
 namespace EventEspresso\modules\ticket_selector;
3 3
 
4
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
5
-    exit( 'No direct script access allowed' );
4
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
5
+    exit('No direct script access allowed');
6 6
 }
7 7
 
8 8
 
@@ -73,9 +73,9 @@  discard block
 block discarded – undo
73 73
     /**
74 74
      * @param boolean $iframe
75 75
      */
76
-    public function setIframe( $iframe = true )
76
+    public function setIframe($iframe = true)
77 77
     {
78
-        $this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
78
+        $this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
79 79
     }
80 80
 
81 81
 
@@ -86,28 +86,28 @@  discard block
 block discarded – undo
86 86
      * @param    mixed $event
87 87
      * @return    bool
88 88
      */
89
-    protected function setEvent( $event = null )
89
+    protected function setEvent($event = null)
90 90
     {
91
-        if ( $event === null ) {
91
+        if ($event === null) {
92 92
             global $post;
93 93
             $event = $post;
94 94
         }
95
-        if ( $event instanceof \EE_Event ) {
95
+        if ($event instanceof \EE_Event) {
96 96
             $this->event = $event;
97
-        } else if ( $event instanceof \WP_Post ) {
98
-            if ( isset( $event->EE_Event ) && $event->EE_Event instanceof \EE_Event ) {
97
+        } else if ($event instanceof \WP_Post) {
98
+            if (isset($event->EE_Event) && $event->EE_Event instanceof \EE_Event) {
99 99
                 $this->event = $event->EE_Event;
100
-            } else if ( $event->post_type === 'espresso_events' ) {
101
-                $event->EE_Event = \EEM_Event::instance()->instantiate_class_from_post_object( $event );
100
+            } else if ($event->post_type === 'espresso_events') {
101
+                $event->EE_Event = \EEM_Event::instance()->instantiate_class_from_post_object($event);
102 102
                 $this->event = $event->EE_Event;
103 103
             }
104 104
         } else {
105
-            $user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
106
-            $dev_msg = $user_msg . __(
105
+            $user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
106
+            $dev_msg = $user_msg.__(
107 107
                     'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
108 108
                     'event_espresso'
109 109
                 );
110
-            \EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
110
+            \EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
111 111
             return false;
112 112
         }
113 113
         return true;
@@ -148,17 +148,17 @@  discard block
 block discarded – undo
148 148
      * @return string
149 149
      * @throws \EE_Error
150 150
      */
151
-    public function display( $event = null, $view_details = false )
151
+    public function display($event = null, $view_details = false)
152 152
     {
153 153
         // reset filter for displaying submit button
154
-        remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
154
+        remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
155 155
         // poke and prod incoming event till it tells us what it is
156
-        if ( ! $this->setEvent( $event ) ) {
156
+        if ( ! $this->setEvent($event)) {
157 157
             return false;
158 158
         }
159 159
         // begin gathering template arguments by getting event status
160
-        $template_args = array( 'event_status' => $this->event->get_active_status() );
161
-        if ( $this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details) ) {
160
+        $template_args = array('event_status' => $this->event->get_active_status());
161
+        if ($this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details)) {
162 162
             return ! is_single() ? $this->displayViewDetailsButton() : '';
163 163
         }
164 164
         // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
@@ -168,7 +168,7 @@  discard block
 block discarded – undo
168 168
         }
169 169
         // is the event expired ?
170 170
         $template_args['event_is_expired'] = $this->event->is_expired();
171
-        if ( $template_args[ 'event_is_expired' ] ) {
171
+        if ($template_args['event_is_expired']) {
172 172
             return $this->expiredEventMessage();
173 173
         }
174 174
         // get all tickets for this event ordered by the datetime
@@ -181,10 +181,10 @@  discard block
 block discarded – undo
181 181
         // if redirecting to another site for registration, then we don't load the TS
182 182
         $ticket_selector = $external_url
183 183
             ? $this->externalEventRegistration()
184
-            : $this->loadTicketSelector($tickets,$template_args);
184
+            : $this->loadTicketSelector($tickets, $template_args);
185 185
         // now set up the form (but not for the admin)
186 186
         $ticket_selector = ! is_admin()
187
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
187
+            ? $this->formOpen($this->event->ID(), $external_url).$ticket_selector
188 188
             : $ticket_selector;
189 189
         // submit button and form close tag
190 190
         $ticket_selector .= ! is_admin() ? $this->displaySubmitButton($external_url) : '';
@@ -234,10 +234,10 @@  discard block
 block discarded – undo
234 234
      */
235 235
     protected function expiredEventMessage()
236 236
     {
237
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
237
+        return '<div class="ee-event-expired-notice"><span class="important-notice">'.esc_html__(
238 238
             'We\'re sorry, but all tickets sales have ended because the event is expired.',
239 239
             'event_espresso'
240
-        ) . '</span></div>';
240
+        ).'</span></div>';
241 241
     }
242 242
 
243 243
 
@@ -251,7 +251,7 @@  discard block
 block discarded – undo
251 251
      */
252 252
     protected function noTicketAvailableMessage()
253 253
     {
254
-        $no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
254
+        $no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
255 255
         if (current_user_can('edit_post', $this->event->ID())) {
256 256
             $no_ticket_available_msg .= sprintf(
257 257
                 esc_html__(
@@ -266,7 +266,7 @@  discard block
 block discarded – undo
266 266
         }
267 267
         return '
268 268
             <div class="ee-event-expired-notice">
269
-                <span class="important-notice">' . $no_ticket_available_msg . '</span>
269
+                <span class="important-notice">' . $no_ticket_available_msg.'</span>
270 270
             </div>';
271 271
     }
272 272
 
@@ -297,7 +297,7 @@  discard block
 block discarded – undo
297 297
                 '</a></span></div>'
298 298
             );
299 299
         }
300
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
300
+        return '<p><span class="important-notice">'.$sales_closed_msg.'</span></p>';
301 301
     }
302 302
 
303 303
 
@@ -359,12 +359,12 @@  discard block
 block discarded – undo
359 359
          */
360 360
         $template_args['anchor_id'] = apply_filters(
361 361
             'FHEE__EE_Ticket_Selector__redirect_anchor_id',
362
-            '#tkt-slctr-tbl-' . $this->event->ID(),
362
+            '#tkt-slctr-tbl-'.$this->event->ID(),
363 363
             $this->event->ID()
364 364
         );
365 365
         $template_args['tickets'] = $tickets;
366 366
         $template_args['ticket_count'] = count($tickets);
367
-        $ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
367
+        $ticket_selector = $this->simpleTicketSelector($tickets, $template_args);
368 368
         return $ticket_selector instanceof TicketSelectorSimple
369 369
             ? $ticket_selector
370 370
             : new TicketSelectorStandard(
@@ -445,11 +445,11 @@  discard block
 block discarded – undo
445 445
      * @param        string $external_url
446 446
      * @return        string
447 447
      */
448
-    public function formOpen( $ID = 0, $external_url = '' )
448
+    public function formOpen($ID = 0, $external_url = '')
449 449
     {
450 450
         // if redirecting, we don't need any anything else
451
-        if ( $external_url ) {
452
-            $html = '<form method="GET" action="' . \EEH_URL::refactor_url($external_url) . '"';
451
+        if ($external_url) {
452
+            $html = '<form method="GET" action="'.\EEH_URL::refactor_url($external_url).'"';
453 453
             // open link in new window ?
454 454
             $html .= apply_filters(
455 455
                 'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
@@ -458,21 +458,21 @@  discard block
 block discarded – undo
458 458
                 ? ' target="_blank"'
459 459
                 : '';
460 460
             $html .= '>';
461
-            $query_args = \EEH_URL::get_query_string( $external_url );
462
-            foreach ( (array)$query_args as $query_arg => $value ) {
463
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
461
+            $query_args = \EEH_URL::get_query_string($external_url);
462
+            foreach ((array) $query_args as $query_arg => $value) {
463
+                $html .= '<input type="hidden" name="'.$query_arg.'" value="'.$value.'">';
464 464
             }
465 465
             return $html;
466 466
         }
467 467
         // if there is no submit button, then don't start building a form
468 468
         // because the "View Details" button will build its own form
469
-        if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
469
+        if ( ! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
470 470
             return '';
471 471
         }
472
-        $checkout_url = \EEH_Event_View::event_link_url( $ID );
473
-        if ( ! $checkout_url ) {
472
+        $checkout_url = \EEH_Event_View::event_link_url($ID);
473
+        if ( ! $checkout_url) {
474 474
             \EE_Error::add_error(
475
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
475
+                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
476 476
                 __FILE__,
477 477
                 __FUNCTION__,
478 478
                 __LINE__
@@ -481,10 +481,10 @@  discard block
 block discarded – undo
481 481
         // set no cache headers and constants
482 482
         \EE_System::do_not_cache();
483 483
         $extra_params = $this->iframe ? ' target="_blank"' : '';
484
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
485
-        $html .= wp_nonce_field( 'process_ticket_selections', 'process_ticket_selections_nonce_' . $ID, true, false );
484
+        $html = '<form method="POST" action="'.$checkout_url.'"'.$extra_params.'>';
485
+        $html .= wp_nonce_field('process_ticket_selections', 'process_ticket_selections_nonce_'.$ID, true, false);
486 486
         $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
487
-        $html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
487
+        $html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
488 488
         return $html;
489 489
     }
490 490
 
@@ -507,7 +507,7 @@  discard block
 block discarded – undo
507 507
                 $html .= empty($external_url)
508 508
                     ? $this->ticketSelectorEndDiv()
509 509
                     : $this->clearTicketSelector();
510
-                $html .= '<br/>' . $this->formClose();
510
+                $html .= '<br/>'.$this->formClose();
511 511
             } else if ($this->getMaxAttendees() === 1) {
512 512
                 // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
513 513
                 if ($this->event->is_sold_out()) {
@@ -585,16 +585,16 @@  discard block
 block discarded – undo
585 585
         );
586 586
         $external_url = $this->event->external_url();
587 587
         $html = \EEH_HTML::div(
588
-            '', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
588
+            '', 'ticket-selector-submit-'.$this->event->ID().'-btn-wrap', 'ticket-selector-submit-btn-wrap'
589 589
         );
590 590
         $html .= \EEH_HTML::span(
591 591
             esc_html__('please select a datetime', 'event_espresso'),
592 592
             '', 'ticket-selector-disabled-submit-btn-msg important-notice'
593 593
         );
594
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
594
+        $html .= '<input id="ticket-selector-submit-'.$this->event->ID().'-btn"';
595 595
         $html .= ' class="ticket-selector-submit-btn ';
596 596
         $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
597
-        $html .= ' type="submit" value="' . $btn_text . '" />';
597
+        $html .= ' type="submit" value="'.$btn_text.'" />';
598 598
         $html .= \EEH_HTML::divx();
599 599
         $html .= apply_filters(
600 600
             'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
@@ -615,11 +615,11 @@  discard block
 block discarded – undo
615 615
      * @return string
616 616
      * @throws \EE_Error
617 617
      */
618
-    public function displayViewDetailsButton( $DWMTS = false )
618
+    public function displayViewDetailsButton($DWMTS = false)
619 619
     {
620
-        if ( ! $this->event->get_permalink() ) {
620
+        if ( ! $this->event->get_permalink()) {
621 621
             \EE_Error::add_error(
622
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
622
+                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
623 623
                 __FILE__, __FUNCTION__, __LINE__
624 624
             );
625 625
         }
@@ -640,7 +640,7 @@  discard block
 block discarded – undo
640 640
                              . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
641 641
                              . $btn_text
642 642
                              . '" />';
643
-        $view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
643
+        $view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
644 644
         if ($DWMTS) {
645 645
             $view_details_btn .= $this->formClose();
646 646
             $view_details_btn .= $this->ticketSelectorEndDiv();
Please login to merge, or discard this patch.
espresso.php 1 patch
Indentation   +219 added lines, -219 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('ABSPATH')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 /*
5 5
   Plugin Name:		Event Espresso
@@ -40,243 +40,243 @@  discard block
 block discarded – undo
40 40
  * @since            4.0
41 41
  */
42 42
 if (function_exists('espresso_version')) {
43
-    /**
44
-     *    espresso_duplicate_plugin_error
45
-     *    displays if more than one version of EE is activated at the same time
46
-     */
47
-    function espresso_duplicate_plugin_error()
48
-    {
49
-        ?>
43
+	/**
44
+	 *    espresso_duplicate_plugin_error
45
+	 *    displays if more than one version of EE is activated at the same time
46
+	 */
47
+	function espresso_duplicate_plugin_error()
48
+	{
49
+		?>
50 50
         <div class="error">
51 51
             <p>
52 52
                 <?php echo esc_html__(
53
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
-                        'event_espresso'
55
-                ); ?>
53
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
+						'event_espresso'
55
+				); ?>
56 56
             </p>
57 57
         </div>
58 58
         <?php
59
-        espresso_deactivate_plugin(plugin_basename(__FILE__));
60
-    }
59
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
60
+	}
61 61
 
62
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
62
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
63 63
 } else {
64
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
65
-    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
-        /**
67
-         * espresso_minimum_php_version_error
68
-         *
69
-         * @return void
70
-         */
71
-        function espresso_minimum_php_version_error()
72
-        {
73
-            ?>
64
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
65
+	if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
+		/**
67
+		 * espresso_minimum_php_version_error
68
+		 *
69
+		 * @return void
70
+		 */
71
+		function espresso_minimum_php_version_error()
72
+		{
73
+			?>
74 74
             <div class="error">
75 75
                 <p>
76 76
                     <?php
77
-                    printf(
78
-                            esc_html__(
79
-                                    'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
-                                    'event_espresso'
81
-                            ),
82
-                            EE_MIN_PHP_VER_REQUIRED,
83
-                            PHP_VERSION,
84
-                            '<br/>',
85
-                            '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
-                    );
87
-                    ?>
77
+					printf(
78
+							esc_html__(
79
+									'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
+									'event_espresso'
81
+							),
82
+							EE_MIN_PHP_VER_REQUIRED,
83
+							PHP_VERSION,
84
+							'<br/>',
85
+							'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
+					);
87
+					?>
88 88
                 </p>
89 89
             </div>
90 90
             <?php
91
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
92
-        }
91
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
92
+		}
93 93
 
94
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
-    } else {
96
-        /**
97
-         * espresso_version
98
-         * Returns the plugin version
99
-         *
100
-         * @return string
101
-         */
102
-        function espresso_version()
103
-        {
104
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.26.rc.002');
105
-        }
94
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
+	} else {
96
+		/**
97
+		 * espresso_version
98
+		 * Returns the plugin version
99
+		 *
100
+		 * @return string
101
+		 */
102
+		function espresso_version()
103
+		{
104
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.26.rc.002');
105
+		}
106 106
 
107
-        // define versions
108
-        define('EVENT_ESPRESSO_VERSION', espresso_version());
109
-        define('EE_MIN_WP_VER_REQUIRED', '4.1');
110
-        define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
111
-        define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
112
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
113
-        //used to be DIRECTORY_SEPARATOR, but that caused issues on windows
114
-        if ( ! defined('DS')) {
115
-            define('DS', '/');
116
-        }
117
-        if ( ! defined('PS')) {
118
-            define('PS', PATH_SEPARATOR);
119
-        }
120
-        if ( ! defined('SP')) {
121
-            define('SP', ' ');
122
-        }
123
-        if ( ! defined('EENL')) {
124
-            define('EENL', "\n");
125
-        }
126
-        define('EE_SUPPORT_EMAIL', '[email protected]');
127
-        // define the plugin directory and URL
128
-        define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
129
-        define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
130
-        define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
131
-        // main root folder paths
132
-        define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
133
-        define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
134
-        define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
135
-        define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
136
-        define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
137
-        define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
138
-        define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
139
-        define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
140
-        // core system paths
141
-        define('EE_ADMIN', EE_CORE . 'admin' . DS);
142
-        define('EE_CPTS', EE_CORE . 'CPTs' . DS);
143
-        define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
144
-        define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
145
-        define('EE_BUSINESS', EE_CORE . 'business' . DS);
146
-        define('EE_MODELS', EE_CORE . 'db_models' . DS);
147
-        define('EE_HELPERS', EE_CORE . 'helpers' . DS);
148
-        define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
149
-        define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
150
-        define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
151
-        define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
152
-        define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
153
-        // gateways
154
-        define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
155
-        define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
156
-        // asset URL paths
157
-        define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
158
-        define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
159
-        define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
160
-        define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
161
-        define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
162
-        define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
163
-        // define upload paths
164
-        $uploads = wp_upload_dir();
165
-        // define the uploads directory and URL
166
-        define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
167
-        define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
168
-        // define the templates directory and URL
169
-        define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
170
-        define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
171
-        // define the gateway directory and URL
172
-        define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
173
-        define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
174
-        // languages folder/path
175
-        define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
176
-        define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
177
-        //check for dompdf fonts in uploads
178
-        if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
179
-            define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
180
-        }
181
-        //ajax constants
182
-        define(
183
-                'EE_FRONT_AJAX',
184
-                isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
185
-        );
186
-        define(
187
-                'EE_ADMIN_AJAX',
188
-                isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
189
-        );
190
-        //just a handy constant occasionally needed for finding values representing infinity in the DB
191
-        //you're better to use this than its straight value (currently -1) in case you ever
192
-        //want to change its default value! or find when -1 means infinity
193
-        define('EE_INF_IN_DB', -1);
194
-        define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
195
-        define('EE_DEBUG', false);
196
-        // for older WP versions
197
-        if ( ! defined('MONTH_IN_SECONDS')) {
198
-            define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
199
-        }
200
-        /**
201
-         *    espresso_plugin_activation
202
-         *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
203
-         */
204
-        function espresso_plugin_activation()
205
-        {
206
-            update_option('ee_espresso_activation', true);
207
-        }
107
+		// define versions
108
+		define('EVENT_ESPRESSO_VERSION', espresso_version());
109
+		define('EE_MIN_WP_VER_REQUIRED', '4.1');
110
+		define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
111
+		define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
112
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
113
+		//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
114
+		if ( ! defined('DS')) {
115
+			define('DS', '/');
116
+		}
117
+		if ( ! defined('PS')) {
118
+			define('PS', PATH_SEPARATOR);
119
+		}
120
+		if ( ! defined('SP')) {
121
+			define('SP', ' ');
122
+		}
123
+		if ( ! defined('EENL')) {
124
+			define('EENL', "\n");
125
+		}
126
+		define('EE_SUPPORT_EMAIL', '[email protected]');
127
+		// define the plugin directory and URL
128
+		define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
129
+		define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
130
+		define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
131
+		// main root folder paths
132
+		define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
133
+		define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
134
+		define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
135
+		define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
136
+		define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
137
+		define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
138
+		define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
139
+		define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
140
+		// core system paths
141
+		define('EE_ADMIN', EE_CORE . 'admin' . DS);
142
+		define('EE_CPTS', EE_CORE . 'CPTs' . DS);
143
+		define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
144
+		define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
145
+		define('EE_BUSINESS', EE_CORE . 'business' . DS);
146
+		define('EE_MODELS', EE_CORE . 'db_models' . DS);
147
+		define('EE_HELPERS', EE_CORE . 'helpers' . DS);
148
+		define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
149
+		define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
150
+		define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
151
+		define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
152
+		define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
153
+		// gateways
154
+		define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
155
+		define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
156
+		// asset URL paths
157
+		define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
158
+		define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
159
+		define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
160
+		define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
161
+		define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
162
+		define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
163
+		// define upload paths
164
+		$uploads = wp_upload_dir();
165
+		// define the uploads directory and URL
166
+		define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
167
+		define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
168
+		// define the templates directory and URL
169
+		define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
170
+		define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
171
+		// define the gateway directory and URL
172
+		define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
173
+		define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
174
+		// languages folder/path
175
+		define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
176
+		define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
177
+		//check for dompdf fonts in uploads
178
+		if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
179
+			define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
180
+		}
181
+		//ajax constants
182
+		define(
183
+				'EE_FRONT_AJAX',
184
+				isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
185
+		);
186
+		define(
187
+				'EE_ADMIN_AJAX',
188
+				isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
189
+		);
190
+		//just a handy constant occasionally needed for finding values representing infinity in the DB
191
+		//you're better to use this than its straight value (currently -1) in case you ever
192
+		//want to change its default value! or find when -1 means infinity
193
+		define('EE_INF_IN_DB', -1);
194
+		define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
195
+		define('EE_DEBUG', false);
196
+		// for older WP versions
197
+		if ( ! defined('MONTH_IN_SECONDS')) {
198
+			define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
199
+		}
200
+		/**
201
+		 *    espresso_plugin_activation
202
+		 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
203
+		 */
204
+		function espresso_plugin_activation()
205
+		{
206
+			update_option('ee_espresso_activation', true);
207
+		}
208 208
 
209
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
210
-        /**
211
-         *    espresso_load_error_handling
212
-         *    this function loads EE's class for handling exceptions and errors
213
-         */
214
-        function espresso_load_error_handling()
215
-        {
216
-            // load debugging tools
217
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
218
-                require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
219
-                EEH_Debug_Tools::instance();
220
-            }
221
-            // load error handling
222
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
223
-                require_once(EE_CORE . 'EE_Error.core.php');
224
-            } else {
225
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
226
-            }
227
-        }
209
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
210
+		/**
211
+		 *    espresso_load_error_handling
212
+		 *    this function loads EE's class for handling exceptions and errors
213
+		 */
214
+		function espresso_load_error_handling()
215
+		{
216
+			// load debugging tools
217
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
218
+				require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
219
+				EEH_Debug_Tools::instance();
220
+			}
221
+			// load error handling
222
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
223
+				require_once(EE_CORE . 'EE_Error.core.php');
224
+			} else {
225
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
226
+			}
227
+		}
228 228
 
229
-        /**
230
-         *    espresso_load_required
231
-         *    given a class name and path, this function will load that file or throw an exception
232
-         *
233
-         * @param    string $classname
234
-         * @param    string $full_path_to_file
235
-         * @throws    EE_Error
236
-         */
237
-        function espresso_load_required($classname, $full_path_to_file)
238
-        {
239
-            static $error_handling_loaded = false;
240
-            if ( ! $error_handling_loaded) {
241
-                espresso_load_error_handling();
242
-                $error_handling_loaded = true;
243
-            }
244
-            if (is_readable($full_path_to_file)) {
245
-                require_once($full_path_to_file);
246
-            } else {
247
-                throw new EE_Error (
248
-                        sprintf(
249
-                                esc_html__(
250
-                                        'The %s class file could not be located or is not readable due to file permissions.',
251
-                                        'event_espresso'
252
-                                ),
253
-                                $classname
254
-                        )
255
-                );
256
-            }
257
-        }
229
+		/**
230
+		 *    espresso_load_required
231
+		 *    given a class name and path, this function will load that file or throw an exception
232
+		 *
233
+		 * @param    string $classname
234
+		 * @param    string $full_path_to_file
235
+		 * @throws    EE_Error
236
+		 */
237
+		function espresso_load_required($classname, $full_path_to_file)
238
+		{
239
+			static $error_handling_loaded = false;
240
+			if ( ! $error_handling_loaded) {
241
+				espresso_load_error_handling();
242
+				$error_handling_loaded = true;
243
+			}
244
+			if (is_readable($full_path_to_file)) {
245
+				require_once($full_path_to_file);
246
+			} else {
247
+				throw new EE_Error (
248
+						sprintf(
249
+								esc_html__(
250
+										'The %s class file could not be located or is not readable due to file permissions.',
251
+										'event_espresso'
252
+								),
253
+								$classname
254
+						)
255
+				);
256
+			}
257
+		}
258 258
 
259
-        espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
260
-        espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
261
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
262
-        new EE_Bootstrap();
263
-    }
259
+		espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
260
+		espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
261
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
262
+		new EE_Bootstrap();
263
+	}
264 264
 }
265 265
 if ( ! function_exists('espresso_deactivate_plugin')) {
266
-    /**
267
-     *    deactivate_plugin
268
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
269
-     *
270
-     * @access public
271
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
272
-     * @return    void
273
-     */
274
-    function espresso_deactivate_plugin($plugin_basename = '')
275
-    {
276
-        if ( ! function_exists('deactivate_plugins')) {
277
-            require_once(ABSPATH . 'wp-admin/includes/plugin.php');
278
-        }
279
-        unset($_GET['activate'], $_REQUEST['activate']);
280
-        deactivate_plugins($plugin_basename);
281
-    }
266
+	/**
267
+	 *    deactivate_plugin
268
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
269
+	 *
270
+	 * @access public
271
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
272
+	 * @return    void
273
+	 */
274
+	function espresso_deactivate_plugin($plugin_basename = '')
275
+	{
276
+		if ( ! function_exists('deactivate_plugins')) {
277
+			require_once(ABSPATH . 'wp-admin/includes/plugin.php');
278
+		}
279
+		unset($_GET['activate'], $_REQUEST['activate']);
280
+		deactivate_plugins($plugin_basename);
281
+	}
282 282
 }
Please login to merge, or discard this patch.