Completed
Branch BUG-9625-better-us-phone-valid... (e0ce21)
by
unknown
631:18 queued 616:37
created

EE_Admin_Page   F

Complexity

Total Complexity 440

Size/Duplication

Total Lines 3381
Duplicated Lines 1.04 %

Coupling/Cohesion

Components 1
Dependencies 15

Importance

Changes 0
Metric Value
dl 35
loc 3381
rs 0.6314
c 0
b 0
f 0
wmc 440
lcom 1
cbo 15

121 Methods

Rating   Name   Duplication   Size   Complexity  
B __construct() 0 41 3
_init_page_props() 0 1 ?
_ajax_hooks() 0 1 ?
_define_page_props() 0 1 ?
_set_page_routes() 0 1 ?
_set_page_config() 0 1 ?
_add_screen_options() 0 1 ?
_add_feature_pointers() 0 1 ?
load_scripts_styles() 0 1 ?
admin_init() 0 1 ?
admin_notices() 0 1 ?
admin_footer_scripts() 0 1 ?
A admin_footer() 0 1 1
A _global_ajax_hooks() 0 4 1
A ajax_metabox_content() 0 7 3
F _page_setup() 0 92 24
A _do_other_page_hooks() 5 21 3
A load_page_dependencies() 0 7 2
C _load_page_dependencies() 0 71 8
A _set_defaults() 0 16 1
A route_admin_request() 0 7 2
A set_wp_page_slug() 0 8 2
C _verify_routes() 7 53 13
A _verify_route() 7 11 2
A _verify_nonce() 0 16 4
F _route_admin_request() 5 60 23
A _reset_routing_properties() 0 7 1
A add_query_args_and_nonce() 0 19 4
A _get_help_tab_link() 0 3 1
F _add_help_tabs() 4 105 29
C _add_help_tour() 5 52 12
A _add_qtips() 0 12 2
D _set_nav_tabs() 0 38 17
B _set_current_labels() 0 13 6
F check_user_access() 0 22 17
A admin_init_global() 0 2 1
A wp_loaded() 0 1 1
A admin_notices_global() 0 4 1
A network_admin_notices_global() 0 4 1
B admin_footer_scripts_global() 0 10 5
A admin_footer_global() 0 17 2
B _set_help_popup_content() 0 29 6
A _get_help_content() 0 18 3
B _set_help_trigger() 0 25 5
A _add_global_screen_options() 0 1 1
A _add_global_feature_pointers() 0 1 1
C load_global_scripts_styles() 0 83 10
A admin_footer_scripts_eei18n_js_strings() 0 51 1
A add_xdebug_style() 0 3 1
B _set_list_table() 0 25 3
A _set_list_table_view() 0 11 4
A _set_list_table_object() 2 8 3
B get_list_table_view_RLs() 0 25 5
C _entries_per_page_dropdown() 0 38 7
A _set_search_attributes() 0 4 2
B _add_registered_meta_boxes() 0 19 6
B _add_screen_columns() 0 17 6
A _espresso_news_post_box() 0 7 1
A _espresso_ratings_request() 0 10 2
A espresso_ratings_request() 0 5 1
B cached_rss_display() 0 24 4
A espresso_news_post_box() 0 16 1
A _espresso_links_post_box() 0 4 1
A espresso_links_post_box() 0 5 1
A _espresso_sponsors_post_box() 0 6 2
A espresso_sponsors_post_box() 0 4 1
A _publish_post_box() 0 15 3
A editor_overview() 0 6 2
A set_publish_post_box_vars() 0 3 1
D _set_publish_post_box_vars() 0 30 10
A _display_no_javascript_warning() 0 12 1
A _display_espresso_notices() 0 4 1
A _add_admin_page_ajax_loading_img() 0 7 1
A _add_admin_page_overlay() 0 5 1
A _add_admin_page_meta_box() 0 16 4
A display_admin_page_with_metabox_columns() 0 7 1
A display_admin_page_with_sidebar() 0 4 1
A display_admin_page_with_no_sidebar() 0 3 1
A display_about_admin_page() 0 3 1
C _display_admin_page() 0 26 7
A display_admin_caf_preview_page() 0 18 2
A display_admin_list_table_page_with_sidebar() 0 3 1
A display_admin_list_table_page_with_no_sidebar() 0 3 1
B _display_admin_list_table_page() 0 39 6
A _display_legend() 0 5 1
C _return_json() 0 28 8
A return_json() 0 8 3
A set_hook_object() 0 3 1
B admin_page_wrapper() 0 32 6
A _get_main_nav_tabs() 0 5 1
A _sort_nav_tabs() 0 6 3
A _generate_admin_form_fields() 0 5 2
C _set_save_buttons() 0 22 7
A set_add_edit_form_tags() 0 3 1
B _set_add_edit_form_tags() 0 30 4
A redirect_after_action() 0 3 1
A _process_notices() 0 10 4
C get_action_link_or_button() 0 29 7
A _per_page_screen_option() 0 12 2
D _set_per_page_screen_options() 0 34 9
A set_template_args() 0 3 1
C _add_transient() 0 22 9
B _get_transient() 0 13 9
B _transient_garbage_collection() 0 15 5
A get_view() 0 3 1
A get_views() 0 3 1
A get_current_page() 0 3 1
A get_current_view() 0 3 1
A get_current_screen() 0 3 1
A get_current_page_view_url() 0 3 1
A get_request_data() 0 3 1
A get_req_action() 0 3 1
A is_caf() 0 3 1
B _update_espresso_configuration() 0 20 5
A get_yes_no_values() 0 3 1
A _get_dir() 0 4 1
A _next_link() 0 3 1
A _previous_link() 0 3 1
A _process_resend_registration() 0 5 1
A _process_payment_notification() 0 6 1
F _redirect_after_action() 0 115 21

How to fix   Duplicated Code    Complexity   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

Complex Class

 Tip:   Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like EE_Admin_Page often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use EE_Admin_Page, and based on these observations, apply Extract Interface, too.

1
<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
2
/**
3
 * Event Espresso
4
 *
5
 * Event Registration and Management Plugin for WordPress
6
 *
7
 * @ package			Event Espresso
8
 * @ author				Seth Shoultes
9
 * @ copyright		(c) 2008-2011 Event Espresso  All Rights Reserved.
10
 * @ license			{@link http://eventespresso.com/support/terms-conditions/}   * see Plugin Licensing *
11
 * @ link				{@link http://www.eventespresso.com}
12
 * @ since		 		4.0
13
 *
14
 * ------------------------------------------------------------------------
15
 */
16
17
18
19
/**
20
 * EE_Admin_Page class
21
 *
22
 * @package		Event Espresso
23
 * @subpackage		includes/core/admin/EE_Admin_Page.core.php
24
 * @abstract
25
 * @author		Brent Christensen, Darren Ethier
26
 *
27
 * ------------------------------------------------------------------------
28
 */
29
abstract class EE_Admin_Page extends EE_BASE {
30
31
32
	//set in _init_page_props()
33
	public $page_slug;
34
	public $page_label;
35
	public $page_folder;
36
37
	//set in define_page_props()
38
	protected $_admin_base_url;
39
	protected $_admin_base_path;
40
	protected $_admin_page_title;
41
	protected $_labels;
42
43
44
	//set early within EE_Admin_Init
45
	protected $_wp_page_slug;
46
47
	//navtabs
48
	protected $_nav_tabs;
49
	protected $_default_nav_tab_name;
50
51
	//helptourstops
52
	protected $_help_tour = array();
53
54
55
	//template variables (used by templates)
56
	protected $_template_path;
57
	protected $_column_template_path;
58
59
	/**
60
	 * @var array $_template_args
61
	 */
62
	protected $_template_args = array();
63
64
	//this will hold the list table object for a given view.
65
	protected $_list_table_object;
66
67
	//bools
68
	protected $_is_UI_request = NULL; //this starts at null so we can have no header routes progress through two states.
69
	protected $_routing;
70
71
	//list table args
72
	protected $_view;
73
	protected $_views;
74
75
76
	//action => method pairs used for routing incoming requests
77
	protected $_page_routes;
78
	protected $_page_config;
79
80
	//the current page route and route config
81
	protected $_route;
82
	protected $_route_config;
83
84
	/**
85
	 * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
86
	 * actions.
87
	 *
88
	 * @since 4.6.x
89
	 * @var array.
90
	 */
91
	protected $_default_route_query_args;
92
93
	//set via request page and action args.
94
	protected $_current_page;
95
	protected $_current_view;
96
	protected $_current_page_view_url;
97
98
	//sanitized request action (and nonce)
99
	protected $_req_action;
100
	protected $_req_nonce;
101
102
	//search related
103
	protected $_search_btn_label;
104
	protected $_search_box_callback;
105
106
	/**
107
	 * WP Current Screen object
108
	 *
109
	 * @var WP_Screen
110
	 */
111
	protected $_current_screen;
112
113
	//for holding EE_Admin_Hooks object when needed (set via set_hook_object())
114
	protected $_hook_obj;
115
116
	//for holding incoming request data
117
	protected $_req_data;
118
119
	// yes / no array for admin form fields
120
	protected $_yes_no_values = array();
121
122
	//some default things shared by all child classes
123
	protected $_default_espresso_metaboxes;
124
125
	/**
126
	 * 	EE_Registry Object
127
	 *	@var 	EE_Registry
128
	 * 	@access 	protected
129
	 */
130
	protected $EE = NULL;
131
132
133
134
	/**
135
	 * This is just a property that flags whether the given route is a caffeinated route or not.
136
	 * @var boolean
137
	 */
138
	protected $_is_caf = FALSE;
139
140
141
142
143
144
	/**
145
	 * 		@Constructor
146
	 *
147
	 * 		@param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
148
	 * 		@access public
149
	 */
150
	public function __construct( $routing = TRUE ) {
151
152
		if ( strpos( $this->_get_dir(), 'caffeinated' ) !== false )
153
			$this->_is_caf = TRUE;
154
155
		$this->_yes_no_values = array(
156
			array('id' => TRUE, 'text' => __('Yes', 'event_espresso')),
157
			array('id' => FALSE, 'text' => __('No', 'event_espresso'))
158
		);
159
160
161
162
		//set the _req_data property.
163
		$this->_req_data = array_merge( $_GET, $_POST );
164
165
166
		//routing enabled?
167
		$this->_routing = $routing;
168
169
		//set initial page props (child method)
170
		$this->_init_page_props();
171
172
		//set global defaults
173
		$this->_set_defaults();
174
175
		//set early because incoming requests could be ajax related and we need to register those hooks.
176
		$this->_global_ajax_hooks();
177
		$this->_ajax_hooks();
178
179
180
		//other_page_hooks have to be early too.
181
		$this->_do_other_page_hooks();
182
183
		//This just allows us to have extending clases do something specific before the parent constructor runs _page_setup.
184
		if ( method_exists( $this, '_before_page_setup' ) )
185
			$this->_before_page_setup();
0 ignored issues
show
Bug introduced by
The method _before_page_setup() does not exist on EE_Admin_Page. Did you maybe mean _page_setup()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
186
187
		//set up page dependencies
188
		$this->_page_setup();
189
190
	}
191
192
193
194
195
	/**
196
	 * _init_page_props
197
	 * Child classes use to set at least the following properties:
198
	 * $page_slug.
199
	 * $page_label.
200
	 *
201
	 * @abstract
202
	 * @access protected
203
	 * @return void
204
	 */
205
	abstract protected function _init_page_props();
206
207
208
209
	/**
210
	 * _ajax_hooks
211
	 * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
212
	 * Note: within the ajax callback methods.
213
	 *
214
	 * @abstract
215
	 * @access protected
216
	 * @return void
217
	 */
218
	abstract protected function _ajax_hooks();
219
220
221
222
223
	/**
224
	 * _define_page_props
225
	 * child classes define page properties in here.  Must include at least:
226
	 * $_admin_base_url = base_url for all admin pages
227
	 * $_admin_page_title = default admin_page_title for admin pages
228
	 * $_labels = array of default labels for various automatically generated elements:
229
	 * 	array(
230
	 * 		'buttons' => array(
231
	 * 			'add' => __('label for add new button'),
232
	 * 	 		'edit' => __('label for edit button'),
233
	 * 	  		'delete' => __('label for delete button')
234
	 * 	  	 	)
235
	 * 	  	)
236
	 *
237
	 * @abstract
238
	 * @access protected
239
	 * @return void
240
	 */
241
	abstract protected function _define_page_props();
242
243
244
245
246
247
	/**
248
	 * _set_page_routes
249
	 * 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' route. Here's the format
250
	 * $this->_page_routes = array(
251
	 * 		'default' => array(
252
	 * 			'func' => '_default_method_handling_route',
253
	 * 			'args' => array('array','of','args'),
254
	 * 			'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e. ajax request, backend processing)
255
	 *			'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.
256
	 *			'capability' => 'route_capability', //indicate a string for minimum capability required to access this route.
257
	 *			'obj_id' => 10 // if this route has an object id, then this can include it (used for capability checks).
258
	 * 		),
259
	 * 		'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a handling method.
260
	 * 		)
261
	 *
262
	 * )
263
	 *
264
	 *
265
	 * @abstract
266
	 * @access protected
267
	 * @return void
268
	 */
269
	abstract protected function _set_page_routes();
270
271
272
273
274
275
276
	/**
277
	 * _set_page_config
278
	 * 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.
279
	 * Format:
280
	 * $this->_page_config = array(
281
	 * 		'default' => array(
282
	 * 			'labels' => array(
283
	 * 				'buttons' => array(
284
	 * 					'add' => __('label for adding item'),
285
	 * 				 	'edit' => __('label for editing item'),
286
	 * 				  	'delete' => __('label for deleting item')
287
	 * 			    ),
288
	 * 			    'publishbox' => __('Localized Title for Publish metabox', 'event_espresso')
289
	 * 			), //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
290
	 * 			'nav' => array(
291
	 * 				'label' => __('Label for Tab', 'event_espresso').
292
	 *     			'url' => 'http://someurl', //automatically generated UNLESS you define
293
	 *     			'css_class' => 'css-class', //automatically generated UNLESS you define
294
	 *     			'order' => 10, //required to indicate tab position.
295
	 *     			'persistent' => false //if you want the nav tab to ONLY display when the specific route is displayed then add this parameter.
296
	 *     		'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
297
	 *     		'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load metaboxes set for eventespresso admin pages.
298
	 *     		'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 this flag to make sure the necessary js gets enqueued on page load.
299
	 *     		'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.
300
	 *     		'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 in the "screen_options" dropdown that is setup so users can pick what columns they want to display.
301
	 *     		'help_tabs' => array( //this is used for adding help tabs to a page
302
	 *     			'tab_id' => array(
303
	 *     				'title' => 'tab_title',
304
	 *     				'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 folder's "help_tabs" dir (ie.. events/help_tabs/name_of_file_containing_content.help_tab.php)
305
	 *     				'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
306
	 *     				),
307
	 *     			'tab2_id' => array(
308
	 *     			 	'title' => 'tab2 title',
309
	 *     			 	'filename' => 'file_name_2'
310
	 *     			 	'callback' => 'callback_method_for_content',
311
	 *     			 ),
312
	 *     	   	'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/
313
	 *     		'help_tour' => array(
314
	 *     			'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 (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
315
	 *     		),
316
	 *     		'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 'require_nonce' to FALSE
317
	 *     		)
318
	 *
319
	 * )
320
	 *
321
	 *
322
	 * @abstract
323
	 * @access protected
324
	 * @return void
325
	 */
326
	abstract protected function _set_page_config();
327
328
329
330
331
332
	/** end sample help_tour methods **/
333
334
335
	/**
336
	 * _add_screen_options
337
	 * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
338
	 * Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options to a particular view.
339
	 * @link http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
340
	 * see also WP_Screen object documents...
341
	 * @link http://codex.wordpress.org/Class_Reference/WP_Screen
342
	 *
343
	 * @abstract
344
	 * @access protected
345
	 * @return void
346
	 */
347
	abstract protected function _add_screen_options();
348
349
350
351
352
353
354
355
	/**
356
	 * _add_feature_pointers
357
	 * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
358
	 * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a particular view.
359
	 * Note: this is just a placeholder for now.  Implementation will come down the road
360
	 * See: WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
361
	 * @link http://eamann.com/tech/wordpress-portland/
362
	 *
363
	 * @abstract
364
	 * @access protected
365
	 * @return void
366
	 */
367
	abstract protected function _add_feature_pointers();
368
369
370
371
372
373
	/**
374
	 * load_scripts_styles
375
	 * 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 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
387
388
	/**
389
	 * admin_init
390
	 * 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.
391
	 *
392
	 * @abstract
393
	 * @access public
394
	 * @return void
395
	 */
396
	abstract public function admin_init();
397
398
399
400
401
402
403
	/**
404
	 * admin_notices
405
	 * 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.
406
	 *
407
	 * @abstract
408
	 * @access public
409
	 * @return void
410
	 */
411
	abstract public function admin_notices();
412
413
414
415
416
417
	/**
418
	 * admin_footer_scripts
419
	 * 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.
420
	 *
421
	 * @access public
422
	 * @return void
423
	 */
424
	abstract public function admin_footer_scripts();
425
426
427
428
429
430
431
	/**
432
	 * admin_footer
433
	 * 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.
434
	 *
435
	 * @access  public
436
	 * @return void
437
	 */
438
	public function admin_footer() {}
439
440
441
442
443
	/**
444
	 * _global_ajax_hooks
445
	 * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
446
	 * Note: within the ajax callback methods.
447
	 *
448
	 * @abstract
449
	 * @access protected
450
	 * @return void
451
	 */
452
	protected function _global_ajax_hooks() {
453
		//for lazy loading of metabox content
454
		add_action( 'wp_ajax_espresso-ajax-content', array( $this, 'ajax_metabox_content'), 10 );
455
	}
456
457
458
459
	public function ajax_metabox_content() {
460
		$contentid = isset( $this->_req_data['contentid'] ) ? $this->_req_data['contentid'] : '';
461
		$url = isset( $this->_req_data['contenturl'] ) ? $this->_req_data['contenturl'] : '';
462
463
		self::cached_rss_display( $contentid, $url );
464
		wp_die();
465
	}
466
467
468
469
	/**
470
	 * _page_setup
471
	 * 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.
472
	 *
473
	 * @final
474
	 * @access protected
475
	 * @return void
476
	 */
477
	final protected function _page_setup() {
478
479
		//requires?
480
		EE_Registry::instance()->load_helper('Template');
481
482
483
		//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.
484
		add_action( 'admin_init', array( $this, 'admin_init_global' ), 5 );
485
486
487
		//next verify if we need to load anything...
488
		$this->_current_page = !empty( $_GET['page'] ) ? sanitize_key( $_GET['page'] ) : FALSE;
489
		$this->page_folder = strtolower( str_replace( '_Admin_Page', '', str_replace( 'Extend_', '', get_class($this) ) ) );
490
491
		global $ee_menu_slugs;
492
		$ee_menu_slugs = (array) $ee_menu_slugs;
493
494
		if ( ( !$this->_current_page || ! isset( $ee_menu_slugs[$this->_current_page] ) ) && !defined( 'DOING_AJAX') ) return FALSE;
495
496
497
		// 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
498
		if ( isset( $this->_req_data['action2'] ) && $this->_req_data['action'] == -1 ) {
499
			$this->_req_data['action'] = ! empty( $this->_req_data['action2'] ) && $this->_req_data['action2'] != -1 ? $this->_req_data['action2'] : $this->_req_data['action'];
500
		}
501
		// then set blank or -1 action values to 'default'
502
		$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';
503
504
		//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.
505
		$this->_req_action = $this->_req_action == 'default' && isset( $this->_req_data['route'] ) ? $this->_req_data['route'] : $this->_req_action;
506
507
		//however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
508
		$this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;
509
510
		$this->_current_view = $this->_req_action;
511
		$this->_req_nonce = $this->_req_action . '_nonce';
512
		$this->_define_page_props();
513
514
		$this->_current_page_view_url = add_query_arg( array( 'page' => $this->_current_page, 'action' => $this->_current_view ),  $this->_admin_base_url );
515
516
		//default things
517
		$this->_default_espresso_metaboxes = array('_espresso_news_post_box', '_espresso_links_post_box', '_espresso_ratings_request', '_espresso_sponsors_post_box' );
518
519
		//set page configs
520
		$this->_set_page_routes();
521
		$this->_set_page_config();
522
523
		//let's include any referrer data in our default_query_args for this route for "stickiness".
524
		if ( isset( $this->_req_data['wp_referer'] ) ) {
525
			$this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
526
		}
527
528
		//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
529
		if ( method_exists( $this, '_extend_page_config' ) )
530
			$this->_extend_page_config();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class EE_Admin_Page as the method _extend_page_config() does only exist in the following sub-classes of EE_Admin_Page: Extend_About_Admin_Page, Extend_Events_Admin_Page, Extend_General_Settings_Admin_Page, Extend_Messages_Admin_Page, Extend_Registration_Form_Admin_Page, Extend_Registrations_Admin_Page, Extend_Support_Admin_Page, Extend_Transactions_Admin_Page. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
531
532
		//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.
533
		if ( method_exists( $this, '_extend_page_config_for_cpt' ) )
534
			$this->_extend_page_config_for_cpt();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class EE_Admin_Page as the method _extend_page_config_for_cpt() does only exist in the following sub-classes of EE_Admin_Page: EE_Admin_Page_CPT, Events_Admin_Page, Extend_Events_Admin_Page, Extend_Registrations_Admin_Page, Registrations_Admin_Page, Venues_Admin_Page. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
535
536
		//filter routes and page_config so addons can add their stuff. Filtering done per class
537
		$this->_page_routes = apply_filters( 'FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this );
538
		$this->_page_config = apply_filters( 'FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this );
539
540
541
		//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
542
		if ( method_exists( $this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view ) ) {
543
			add_action( 'AHEE__EE_Admin_Page__route_admin_request', array( $this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view ), 10, 2 );
544
		}
545
546
547
		//next route only if routing enabled
548
		if ( $this->_routing && !defined('DOING_AJAX') ) {
549
550
			$this->_verify_routes();
551
552
			//next let's just check user_access and kill if no access
553
			$this->check_user_access();
554
555
			if ( $this->_is_UI_request ) {
556
				//admin_init stuff - global, all views for this page class, specific view
557
				add_action( 'admin_init', array( $this, 'admin_init' ), 10 );
558
				if ( method_exists( $this, 'admin_init_' . $this->_current_view )) {
559
					add_action( 'admin_init', array( $this, 'admin_init_' . $this->_current_view ), 15 );
560
				}
561
562
			} else {
563
				//hijack regular WP loading and route admin request immediately
564
				@ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', WP_MAX_MEMORY_LIMIT ) );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
565
				$this->route_admin_request();
566
			}
567
		}
568
	}
569
570
571
572
573
574
	/**
575
	 * Provides a way for related child admin pages to load stuff on the loaded admin page.
576
	 *
577
	 * @access private
578
	 * @return void
579
	 */
580
	private function _do_other_page_hooks() {
581
		$registered_pages = apply_filters( 'FHEE_do_other_page_hooks_' . $this->page_slug, array() );
582
583
		foreach ( $registered_pages as $page ) {
584
585
			//now let's setup the file name and class that should be present
586
			$classname = str_replace('.class.php', '', $page);
587
588
			//autoloaders should take care of loading file
589 View Code Duplication
			if ( !class_exists( $classname ) ) {
590
				$error_msg[] = sprintf( __('Something went wrong with loading the %s admin hooks page.', 'event_espresso' ), $page);
0 ignored issues
show
Coding Style Comprehensibility introduced by
$error_msg was never initialized. Although not strictly required by PHP, it is generally a good practice to add $error_msg = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
591
				$error_msg[] = $error_msg[0] . "\r\n" . sprintf( __( 'There is no class in place for the %s admin hooks page.%sMake sure you have <strong>%s</strong> defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class', 'event_espresso'), $page, '<br />', $classname );
592
				throw new EE_Error( implode( '||', $error_msg ));
593
			}
594
595
			$a = new ReflectionClass($classname);
596
597
			//notice we are passing the instance of this class to the hook object.
598
			$hookobj[] = $a->newInstance($this);
0 ignored issues
show
Coding Style Comprehensibility introduced by
$hookobj was never initialized. Although not strictly required by PHP, it is generally a good practice to add $hookobj = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
599
		}
600
	}
601
602
603
604
	public function load_page_dependencies() {
605
		try {
606
			$this->_load_page_dependencies();
607
		} catch ( EE_Error $e ) {
608
			$e->get_error();
609
		}
610
	}
611
612
613
614
	/**
615
	 * load_page_dependencies
616
	 * loads things specific to this page class when its loaded.  Really helps with efficiency.
617
	 * @access public
618
	 * @return void
619
	 */
620
	protected function _load_page_dependencies() {
621
		//let's set the current_screen and screen options to override what WP set
622
		$this->_current_screen = get_current_screen();
623
624
		//load admin_notices - global, page class, and view specific
625
		add_action( 'admin_notices', array( $this, 'admin_notices_global'), 5 );
626
		add_action( 'admin_notices', array( $this, 'admin_notices' ), 10 );
627
		if ( method_exists( $this, 'admin_notices_' . $this->_current_view ) ) {
628
			add_action( 'admin_notices', array( $this, 'admin_notices_' . $this->_current_view ), 15 );
629
		}
630
631
		//load network admin_notices - global, page class, and view specific
632
		add_action( 'network_admin_notices', array( $this, 'network_admin_notices_global'), 5 );
633
		if ( method_exists( $this, 'network_admin_notices_' . $this->_current_view ) ) {
634
			add_action( 'network_admin_notices', array( $this, 'network_admin_notices_' . $this->_current_view ) );
635
		}
636
637
		//this will save any per_page screen options if they are present
638
		$this->_set_per_page_screen_options();
639
640
		//setup list table properties
641
		$this->_set_list_table();
642
643
		// 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.
644
		$this->_add_registered_meta_boxes();
645
		$this->_add_screen_columns();
646
647
		//add screen options - global, page child class, and view specific
648
		$this->_add_global_screen_options();
0 ignored issues
show
Unused Code introduced by
The call to the method EE_Admin_Page::_add_global_screen_options() seems un-needed as the method has no side-effects.

PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left.

Let’s take a look at an example:

class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

If we look at the getEmail() method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless:

$user = new User();
$user->getEmail(); // This line could safely be removed as it has no effect.

On the hand, if we look at the setEmail(), this method _has_ side-effects. In the following case, we could not remove the method call:

$user = new User();
$user->setEmail('email@domain'); // This line has a side-effect (it changes an
                                 // instance variable).
Loading history...
649
		$this->_add_screen_options();
650
		if ( method_exists( $this, '_add_screen_options_' . $this->_current_view ) )
651
			call_user_func( array( $this, '_add_screen_options_' . $this->_current_view ) );
652
653
654
		//add help tab(s) and tours- set via page_config and qtips.
655
		$this->_add_help_tour();
656
		$this->_add_help_tabs();
657
		$this->_add_qtips();
658
659
		//add feature_pointers - global, page child class, and view specific
660
		$this->_add_feature_pointers();
661
		$this->_add_global_feature_pointers();
0 ignored issues
show
Unused Code introduced by
The call to the method EE_Admin_Page::_add_global_feature_pointers() seems un-needed as the method has no side-effects.

PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left.

Let’s take a look at an example:

class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

If we look at the getEmail() method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless:

$user = new User();
$user->getEmail(); // This line could safely be removed as it has no effect.

On the hand, if we look at the setEmail(), this method _has_ side-effects. In the following case, we could not remove the method call:

$user = new User();
$user->setEmail('email@domain'); // This line has a side-effect (it changes an
                                 // instance variable).
Loading history...
662
		if ( method_exists( $this, '_add_feature_pointer_' . $this->_current_view ) )
663
			call_user_func( array( $this, '_add_feature_pointer_' . $this->_current_view ) );
664
665
		//enqueue scripts/styles - global, page class, and view specific
666
		add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5 );
667
		add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10 );
668
		if ( method_exists( $this, 'load_scripts_styles_' . $this->_current_view ) )
669
			add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view ), 15 );
670
671
		add_action('admin_enqueue_scripts', array( $this, 'admin_footer_scripts_eei18n_js_strings' ), 100 );
672
673
		//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
674
		add_action('admin_print_footer_scripts', array( $this, 'admin_footer_scripts_global' ), 99 );
675
		add_action('admin_print_footer_scripts', array( $this, 'admin_footer_scripts' ), 100 );
676
		if ( method_exists( $this, 'admin_footer_scripts_' . $this->_current_view ) )
677
			add_action('admin_print_footer_scripts', array( $this, 'admin_footer_scripts_' . $this->_current_view ), 101 );
678
679
		//admin footer scripts
680
		add_action('admin_footer', array( $this, 'admin_footer_global' ), 99 );
681
		add_action('admin_footer', array( $this, 'admin_footer'), 100 );
682
		if ( method_exists( $this, 'admin_footer_' . $this->_current_view ) )
683
			add_action('admin_footer', array( $this, 'admin_footer_' . $this->_current_view ), 101 );
684
685
686
		do_action( 'FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug );
687
		//targeted hook
688
		do_action( 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action );
689
690
	}
691
692
693
694
695
696
	/**
697
	 * _set_defaults
698
	 * This sets some global defaults for class properties.
699
	 */
700
	private function _set_defaults() {
701
		$this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = $this->_event = $this->_template_path = $this->_column_template_path = NULL;
0 ignored issues
show
Documentation introduced by
The property _event does not exist on object<EE_Admin_Page>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
702
703
		$this->_nav_tabs = $this_views = $this->_page_routes = $this->_page_config =  $this->_default_route_query_args = array();
0 ignored issues
show
Unused Code introduced by
$this_views is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
704
705
		$this->default_nav_tab_name = 'overview';
0 ignored issues
show
Bug introduced by
The property default_nav_tab_name does not seem to exist. Did you mean _default_nav_tab_name?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
706
707
		//init template args
708
		$this->_template_args = array(
709
			'admin_page_header' => '',
710
			'admin_page_content' => '',
711
			'post_body_content' => '',
712
			'before_list_table' => '',
713
			'after_list_table' => ''
714
		);
715
	}
716
717
718
719
720
	/**
721
	 * route_admin_request
722
	 *
723
	 * @see _route_admin_request()
724
	 * @access public
725
	 * @return void|exception error
726
	 */
727
	public function route_admin_request() {
728
		try {
729
			$this->_route_admin_request();
730
		} catch ( EE_Error $e ) {
731
			$e->get_error();
732
		}
733
	}
734
735
736
737
	public function set_wp_page_slug($wp_page_slug) {
738
		$this->_wp_page_slug = $wp_page_slug;
739
740
		//if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
741
		if ( is_network_admin() ) {
742
			$this->_wp_page_slug .= '-network';
743
		}
744
	}
745
746
	/**
747
	 * _verify_routes
748
	 * 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.
749
	 *
750
	 * @access protected
751
	 * @return void
752
	 */
753
	protected function _verify_routes() {
754
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
755
756
		if ( !$this->_current_page && !defined( 'DOING_AJAX')) return FALSE;
757
758
		$this->_route = FALSE;
759
		$func = FALSE;
0 ignored issues
show
Unused Code introduced by
$func is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
760
		$args = array();
0 ignored issues
show
Unused Code introduced by
$args is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
761
762
		// check that the page_routes array is not empty
763
		if ( empty( $this->_page_routes )) {
764
			// user error msg
765
			$error_msg = sprintf( __('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title );
766
			// developer error msg
767
			$error_msg .=  '||' . $error_msg . __( ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso' );
768
			throw new EE_Error( $error_msg );
769
		}
770
771
		// and that the requested page route exists
772
		if ( array_key_exists( $this->_req_action, $this->_page_routes )) {
773
			$this->_route = $this->_page_routes[ $this->_req_action ];
774
			$this->_route_config = isset($this->_page_config[$this->_req_action]) ? $this->_page_config[$this->_req_action] : array();
775 View Code Duplication
		} else {
776
			// user error msg
777
			$error_msg =  sprintf( __( 'The requested page route does not exist for the %s admin page.', 'event_espresso' ), $this->_admin_page_title );
778
			// developer error msg
779
			$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 );
780
			throw new EE_Error( $error_msg );
781
		}
782
783
		// and that a default route exists
784
		if ( ! array_key_exists( 'default', $this->_page_routes )) {
785
			// user error msg
786
			$error_msg = sprintf( __( 'A default page route has not been set for the % admin page.', 'event_espresso' ), $this->_admin_page_title );
787
			// developer error msg
788
			$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' );
789
			throw new EE_Error( $error_msg );
790
		}
791
792
793
		//first lets' catch if the UI request has EVER been set.
794
		if ( $this->_is_UI_request === NULL ) {
795
			//lets set if this is a UI request or not.
796
			$this->_is_UI_request = ( ! isset( $this->_req_data['noheader'] ) || $this->_req_data['noheader'] !== TRUE ) ? TRUE : FALSE;
797
798
799
			//wait a minute... we might have a noheader in the route array
800
			$this->_is_UI_request = is_array($this->_route) && isset($this->_route['noheader'] ) && $this->_route['noheader'] ? FALSE : $this->_is_UI_request;
801
		}
802
803
		$this->_set_current_labels();
804
805
	}
806
807
808
809
810
	/**
811
	 * this method simply verifies a given route and makes sure its an actual route available for the loaded page
812
	 * @param  string $route the route name we're verifying
813
	 * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
814
	 */
815
	protected function _verify_route( $route ) {
816
		if ( array_key_exists( $this->_req_action, $this->_page_routes )) {
817
			return true;
818 View Code Duplication
		} else {
819
			// user error msg
820
			$error_msg =  sprintf( __( 'The given page route does not exist for the %s admin page.', 'event_espresso' ), $this->_admin_page_title );
821
			// developer error msg
822
			$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 );
823
			throw new EE_Error( $error_msg );
824
		}
825
	}
826
827
828
829
830
	/**
831
	 * perform nonce verification
832
	 * 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!)
833
	 * @param  string $nonce     The nonce sent
834
	 * @param  string $nonce_ref The nonce reference string (name0)
835
	 * @return mixed (bool|die)
836
	 */
837
	protected function _verify_nonce( $nonce, $nonce_ref ) {
838
		// verify nonce against expected value
839
		if ( ! wp_verify_nonce( $nonce, $nonce_ref) ) {
840
			// these are not the droids you are looking for !!!
841
			$msg = sprintf(__('%sNonce Fail.%s' , 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>' );
842
			if ( WP_DEBUG ) {
843
				$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__  );
844
			}
845
			if ( ! defined( 'DOING_AJAX' )) {
846
				wp_die( $msg );
847
			} else {
848
				EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ );
849
				$this->_return_json();
850
			}
851
		}
852
	}
853
854
855
856
857
	/**
858
	 * _route_admin_request()
859
	 * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are some doodads to work the magic and handle the flingjangy.
860
	 * Translation:  Checks if the requested action is listed in the page routes and then will try to load the corresponding method.
861
	 *
862
	 * @access protected
863
	 * @return void
864
	 */
865
	protected function _route_admin_request() {
866
		if (  ! $this->_is_UI_request )
867
			$this->_verify_routes();
868
869
		$nonce_check = isset( $this->_route_config['require_nonce'] ) ? $this->_route_config['require_nonce'] : TRUE;
870
871 View Code Duplication
		if ( $this->_req_action != 'default' && $nonce_check ) {
872
			// set nonce from post data
873
			$nonce = isset($this->_req_data[ $this->_req_nonce  ]) ? sanitize_text_field( $this->_req_data[ $this->_req_nonce  ] ) : '';
874
			$this->_verify_nonce( $nonce, $this->_req_nonce );
875
		}
876
		//set the nav_tabs array but ONLY if this is  UI_request
877
		if ( $this->_is_UI_request )
878
			$this->_set_nav_tabs();
879
880
		// grab callback function
881
		$func = is_array( $this->_route ) ? $this->_route['func'] : $this->_route;
882
883
		// check if callback has args
884
		$args = is_array( $this->_route ) && isset( $this->_route['args'] ) ? $this->_route['args'] : array();
885
886
		$error_msg = '';
887
888
		//action right before calling route (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
889
		if ( !did_action('AHEE__EE_Admin_Page__route_admin_request')) {
890
			do_action( 'AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this );
891
		}
892
893
		//right before calling the route, let's remove _wp_http_referer from the $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
894
		$_SERVER['REQUEST_URI'] = remove_query_arg( '_wp_http_referer', wp_unslash( $_SERVER['REQUEST_URI'] ) );
895
896
		if ( ! empty( $func )) {
897
			$base_call = $addon_call = FALSE;
898
			//try to access page route via this class
899
			if ( ! is_array( $func ) && method_exists( $this, $func ) && ( $base_call = call_user_func_array( array( $this, &$func  ), $args ) ) === FALSE ) {
900
				// user error msg
901
				$error_msg =  __( 'An error occurred. The  requested page route could not be found.', 'event_espresso' );
902
				// developer error msg
903
				$error_msg .= '||' . sprintf( __( 'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.', 'event_espresso' ), $func );
904
			}
905
906
			//for pluggability by addons first let's see if just the function exists (this will also work in the case where $func is an array indicating class/method)
907
			$args['admin_page_object'] = $this; //send along this admin page object for access by addons.
908
909
			if ( $base_call === FALSE && ( $addon_call = call_user_func_array( $func, $args ) )=== FALSE ) {
910
				$error_msg = __('An error occurred. The requested page route could not be found', 'event_espresso' );
911
				$error_msg .= '||' . sprintf( __('Page route "%s" could not be called.  Check that the spelling for the function name and action in the "_page_routes" array filtered by your plugin is correct.', 'event_espresso'), $func );
912
			}
913
914
915
			if ( !empty( $error_msg ) && $base_call === FALSE && $addon_call === FALSE )
916
				throw new EE_Error( $error_msg );
917
		}
918
919
		//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.
920
		//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.
921
		if ( $this->_is_UI_request === FALSE && is_array( $this->_route) && ! empty( $this->_route['headers_sent_route'] ) ) {
922
			$this->_reset_routing_properties( $this->_route['headers_sent_route'] );
923
		}
924
	}
925
926
927
928
929
	/**
930
	 * This method just allows the resetting of page properties in the case where a no headers
931
	 * route redirects to a headers route in its route config.
932
	 *
933
	 * @since   4.3.0
934
	 *
935
	 * @param  string    $new_route   New (non header) route to redirect to.
936
	 * @return   void
937
	 */
938
	protected function _reset_routing_properties( $new_route ) {
939
		$this->_is_UI_request = TRUE;
940
		//now we set the current route to whatever the headers_sent_route is set at
941
		$this->_req_data['action'] = $new_route;
942
		//rerun page setup
943
		$this->_page_setup();
944
	}
945
946
947
948
949
	/**
950
	 * _add_query_arg
951
	 * adds nonce to array of arguments then calls WP add_query_arg function
952
	 *(internally just uses EEH_URL's function with the same name)
953
	 * 	@access public
954
	 *	@param array $args
955
	 *	@param string $url
956
	 *	@param bool $sticky if true, then the existing Request params will be appended to the generated
957
	 *	                    		url in an associative array indexed by the key 'wp_referer';
958
	 *	                    		Example usage:
959
	 *
960
	 *	                    		If the current page is:
961
	 *	                    		http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
962
	 *	                    		&action=default&event_id=20&month_range=March%202015
963
	 *	                    		&_wpnonce=5467821
964
	 *
965
	 *	                    		and you call:
966
	 *
967
	 *	                    		EE_Admin_Page::add_query_args_and_nonce(
968
	 *	                    			array(
969
	 *	                    				'action' => 'resend_something',
970
	 *	                    				'page=>espresso_registrations'
971
	 *	                    				),
972
	 *	                    			$some_url,
973
	 *	                    			true
974
	 *	                    		 );
975
	 *
976
	 *	                    		It will produce a url in this structure:
977
	 *
978
	 *	                      		http://{$some_url}/?page=espresso_registrations&action=resend_something
979
	 *	                        	&wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
980
	 *	                        	month_range]=March%202015
981
	 * @param   bool    $exclude_nonce  If true, the the nonce will be excluded from the generated nonce.
982
	 * 	@return string
983
	 */
984
	public static function add_query_args_and_nonce( $args = array(), $url = false, $sticky = false, $exclude_nonce = false ) {
985
		EE_Registry::instance()->load_helper('URL');
986
987
		//if there is a _wp_http_referer include the values from the request but only if sticky = true
988
		if ( $sticky ) {
989
			$request = $_REQUEST;
990
			unset( $request['_wp_http_referer'] );
991
			unset( $request['wp_referer'] );
992
			foreach ( $request as $key => $value ) {
993
				//do not add nonces
994
				if ( strpos( $key, 'nonce' ) !== false ) {
995
					continue;
996
				}
997
				$args['wp_referer[' . $key . ']'] = $value;
998
			}
999
		}
1000
1001
		return EEH_URL::add_query_args_and_nonce( $args, $url, $exclude_nonce );
0 ignored issues
show
Bug introduced by
It seems like $url defined by parameter $url on line 984 can also be of type false; however, EEH_URL::add_query_args_and_nonce() does only seem to accept string, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
1002
	}
1003
1004
1005
1006
1007
	/**
1008
	 * This returns a generated link that will load the related help tab.
1009
	 *
1010
	 *
1011
	 * @param  string $help_tab_id the id for the connected help tab
1012
	 * @param  string $icon_style (optional) include css class for the style you want to use for the help icon.
1013
	 * @param  string $help_text (optional) send help text you want to use for the link if default not to be used
1014
	 * @uses EEH_Template::get_help_tab_link()
1015
	 * @return string              generated link
1016
	 */
1017
	protected function _get_help_tab_link( $help_tab_id, $icon_style = FALSE, $help_text = FALSE ) {
1018
		return EEH_Template::get_help_tab_link( $help_tab_id, $this->page_slug, $this->_req_action, $icon_style, $help_text );
1019
	}
1020
1021
1022
1023
1024
	/**
1025
	 * _add_help_tabs
1026
	 *
1027
	 * Note child classes define their help tabs within the page_config array.
1028
	 * @link http://codex.wordpress.org/Function_Reference/add_help_tab
1029
	 *
1030
	 * @access protected
1031
	 * @return void
1032
	 */
1033
	protected function _add_help_tabs() {
1034
		$tour_buttons = '';
1035
		if ( isset( $this->_page_config[$this->_req_action] ) ) {
1036
			$config = $this->_page_config[$this->_req_action];
1037
1038
			//is there a help tour for the current route?  if there is let's setup the tour buttons
1039
			if ( isset( $this->_help_tour[$this->_req_action]) ) {
1040
				$tb = array();
1041
				$tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
1042
				foreach ( $this->_help_tour['tours'] as $tour ) {
1043
					//if this is the end tour then we don't need to setup a button
1044
					if ( $tour instanceof EE_Help_Tour_final_stop )
1045
						continue;
1046
					$tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
1047
				}
1048
				$tour_buttons .= implode('<br />', $tb);
1049
				$tour_buttons .= '</div></div>';
1050
			}
1051
1052
			// let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
1053
			if ( is_array( $config ) && isset( $config['help_sidebar'] ) ) {
1054
				//check that the callback given is valid
1055
				if ( !method_exists($this, $config['help_sidebar'] ) )
1056
					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', 'event_espresso'), $config['help_sidebar'], get_class($this) ) );
1057
1058
				$content = apply_filters( 'FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func( array( $this, $config['help_sidebar'] ) ) );
1059
1060
				$content .= $tour_buttons; //add help tour buttons.
1061
1062
				//do we have any help tours setup?  Cause if we do we want to add the buttons
1063
				$this->_current_screen->set_help_sidebar($content);
1064
			}
1065
1066
			//if we DON'T have config help sidebar and there ARE toure buttons then we'll just add the tour buttons to the sidebar.
1067
			if ( !isset( $config['help_sidebar'] ) && !empty( $tour_buttons ) ) {
1068
				$this->_current_screen->set_help_sidebar($tour_buttons);
1069
			}
1070
1071
			//handle if no help_tabs are set so the sidebar will still show for the help tour buttons
1072
			if ( !isset( $config['help_tabs'] ) && !empty($tour_buttons) ) {
1073
				$_ht['id'] = $this->page_slug;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$_ht was never initialized. Although not strictly required by PHP, it is generally a good practice to add $_ht = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
1074
				$_ht['title'] = __('Help Tours', 'event_espresso');
1075
				$_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
1076
				$this->_current_screen->add_help_tab($_ht);
1077
				}/**/
1078
1079
1080
			if ( !isset( $config['help_tabs'] ) ) return; //no help tabs for this route
1081
1082
			foreach ( (array) $config['help_tabs'] as $tab_id => $cfg ) {
1083
				//we're here so there ARE help tabs!
1084
1085
				//make sure we've got what we need
1086
				if ( !isset( $cfg['title'] ) )
1087
					throw new EE_Error( __('The _page_config array is not set up properly for help tabs.  It is missing a title', 'event_espresso') );
1088
1089
1090
				if ( !isset($cfg['filename']) && !isset( $cfg['callback'] ) && !isset( $cfg['content'] ) )
1091
					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', 'event_espresso') );
1092
1093
1094
1095
				//first priority goes to content.
1096
				if ( !empty($cfg['content'] ) ) {
1097
					$content = !empty($cfg['content']) ? $cfg['content'] : NULL;
1098
1099
				//second priority goes to filename
1100
				} else if ( !empty($cfg['filename'] ) ) {
1101
					$file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
1102
1103
1104
					//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)
1105
					$file_path = !is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;
1106
1107
					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1108 View Code Duplication
					if ( !is_readable($file_path) && !isset($cfg['callback']) ) {
1109
						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', 'event_espresso'), $tab_id, key($config), $file_path ), __FILE__, __FUNCTION__, __LINE__ );
1110
						return;
1111
					}
1112
					$template_args['admin_page_obj'] = $this;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$template_args was never initialized. Although not strictly required by PHP, it is generally a good practice to add $template_args = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
1113
					$content = EEH_Template::display_template($file_path, $template_args, true);
0 ignored issues
show
Bug introduced by
The variable $template_args does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1114
				} else {
1115
					$content = '';
1116
				}
1117
1118
1119
				//check if callback is valid
1120
				if ( empty($content) && ( !isset($cfg['callback']) || !method_exists( $this, $cfg['callback'] ) ) ) {
1121
					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.', 'event_espresso'), $cfg['title'] ), __FILE__, __FUNCTION__, __LINE__ );
1122
					return;
1123
				}
1124
1125
				//setup config array for help tab method
1126
				$id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
1127
				$_ht = array(
1128
					'id' => $id,
1129
					'title' => $cfg['title'],
1130
					'callback' => isset( $cfg['callback'] ) && empty($content) ? array( $this, $cfg['callback'] ) : NULL,
1131
					'content' => $content
1132
					);
1133
1134
				$this->_current_screen->add_help_tab( $_ht );
1135
			}
1136
		}
1137
	}
1138
1139
1140
1141
	/**
1142
	 * 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
1143
	 *
1144
	 * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
1145
	 * @see instructions regarding the format and construction of the "help_tour" array element is found in the _set_page_config() comments
1146
	 * @access protected
1147
	 * @return void
1148
	 */
1149
	protected function _add_help_tour() {
1150
		$tours = array();
1151
		$this->_help_tour = array();
1152
1153
		//exit early if help tours are turned off globally
1154
		if ( ! EE_Registry::instance()->CFG->admin->help_tour_activation || ( defined( 'EE_DISABLE_HELP_TOURS' ) && EE_DISABLE_HELP_TOURS ) )
1155
			return;
1156
1157
		//loop through _page_config to find any help_tour defined
1158
		foreach ( $this->_page_config as $route => $config ) {
1159
			//we're only going to set things up for this route
1160
			if ( $route !== $this->_req_action )
1161
				continue;
1162
1163
			if ( isset( $config['help_tour'] ) ) {
1164
1165
				foreach( $config['help_tour'] as $tour ) {
1166
					$file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
1167
					//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
1168
					$file_path = !is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;
1169
1170
					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1171
					if ( !is_readable($file_path) ) {
1172
						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'), $file_path, $tour ), __FILE__, __FUNCTION__, __LINE__ );
1173
						return;
1174
					}
1175
1176
					require_once $file_path;
1177 View Code Duplication
					if ( !class_exists( $tour ) ) {
1178
						$error_msg[] = sprintf( __('Something went wrong with loading the %s Help Tour Class.', 'event_espresso' ), $tour);
0 ignored issues
show
Coding Style Comprehensibility introduced by
$error_msg was never initialized. Although not strictly required by PHP, it is generally a good practice to add $error_msg = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
1179
						$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.', 'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this) );
1180
						throw new EE_Error( implode( '||', $error_msg ));
1181
					}
1182
					$a = new ReflectionClass($tour);
1183
					$tour_obj = $a->newInstance($this->_is_caf);
1184
1185
					$tours[] = $tour_obj;
1186
					$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator( $tour_obj );
1187
				}
1188
1189
				//let's inject the end tour stop element common to all pages... this will only get seen once per machine.
1190
				$end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
1191
				$tours[] = $end_stop_tour;
1192
				$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator( $end_stop_tour );
1193
			}
1194
		}
1195
1196
		if ( !empty( $tours ) )
1197
			$this->_help_tour['tours'] = $tours;
1198
1199
		//thats it!  Now that the $_help_tours property is set (or not) the scripts and html should be taken care of automatically.
1200
	}
1201
1202
1203
1204
1205
	/**
1206
	 * This simply sets up any qtips that have been defined in the page config
1207
	 *
1208
	 * @access protected
1209
	 * @return void
1210
	 */
1211
	protected function _add_qtips() {
1212
		if ( isset( $this->_route_config['qtips'] ) ) {
1213
			$qtips = (array) $this->_route_config['qtips'];
1214
			//load qtip loader
1215
			EE_Registry::instance()->load_helper('Qtip_Loader', array(), TRUE);
1216
			$path = array(
1217
				$this->_get_dir() . '/qtips/',
1218
				EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/'
1219
				);
1220
			EEH_Qtip_Loader::instance()->register($qtips, $path);
1221
		}
1222
	}
1223
1224
1225
1226
1227
	/**
1228
	 * _set_nav_tabs
1229
	 * 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.
1230
	 *
1231
	 * @access protected
1232
	 * @return void
1233
	 */
1234
	protected function _set_nav_tabs() {
1235
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
1236
		$i = 0;
1237
		foreach ( $this->_page_config as $slug => $config ) {
1238
			if ( !is_array( $config ) || ( is_array($config) && (isset($config['nav']) && !$config['nav'] ) || !isset($config['nav'] ) ) )
1239
				continue; //no nav tab for this config
1240
1241
			//check for persistent flag
1242
			if ( isset( $config['nav']['persistent']) && !$config['nav']['persistent'] && $slug !== $this->_req_action )
1243
				continue; //nav tab is only to appear when route requested.
1244
1245
			if ( ! $this->check_user_access( $slug, TRUE ) )
1246
				continue; //no nav tab becasue current user does not have access.
1247
1248
			$css_class = isset( $config['css_class'] ) ? $config['css_class'] . ' ' : '';
1249
			$this->_nav_tabs[$slug] = array(
1250
				'url' => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce( array( 'action'=>$slug ), $this->_admin_base_url ),
1251
				'link_text' => isset( $config['nav']['label'] ) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug ) ),
1252
				'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
1253
				'order' => isset( $config['nav']['order'] ) ? $config['nav']['order'] : $i
1254
				);
1255
			$i++;
1256
		}
1257
1258
		//if $this->_nav_tabs is empty then lets set the default
1259
		if ( empty( $this->_nav_tabs ) ) {
1260
			$this->_nav_tabs[$this->default_nav_tab_name] = array(
0 ignored issues
show
Bug introduced by
The property default_nav_tab_name does not seem to exist. Did you mean _default_nav_tab_name?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1261
				'url' => $this->admin_base_url,
0 ignored issues
show
Bug introduced by
The property admin_base_url does not seem to exist. Did you mean _admin_base_url?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1262
				'link_text' => ucwords( str_replace( '_', ' ', $this->default_nav_tab_name ) ),
0 ignored issues
show
Bug introduced by
The property default_nav_tab_name does not seem to exist. Did you mean _default_nav_tab_name?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1263
				'css_class' => 'nav-tab-active',
1264
				'order' => 10
1265
				);
1266
		}
1267
1268
		//now let's sort the tabs according to order
1269
		usort( $this->_nav_tabs, array($this, '_sort_nav_tabs' ));
1270
1271
	}
1272
1273
1274
1275
1276
1277
	/**
1278
	 * _set_current_labels
1279
	 * This method modifies the _labels property with any optional specific labels indicated in the _page_routes property array
1280
	 *
1281
	 * @access private
1282
	 * @return void
1283
	 */
1284
	private function _set_current_labels() {
1285
		if ( is_array($this->_route_config) && isset($this->_route_config['labels']) ) {
1286
			foreach ( $this->_route_config['labels'] as $label => $text ) {
1287
				if ( is_array($text) ) {
1288
					foreach ( $text as $sublabel => $subtext ) {
1289
						$this->_labels[$label][$sublabel] = $subtext;
1290
					}
1291
				} else {
1292
					$this->_labels[$label] = $text;
1293
				}
1294
			}
1295
		}
1296
	}
1297
1298
1299
1300
1301
1302
1303
	/**
1304
	 * 		verifies user access for this admin page
1305
	 * 		@param string $route_to_check if present then the capability for the route matching this string is checked.
1306
	 * 		@param bool   $verify_only Default is FALSE which means if user check fails then wp_die().  Otherwise just return false if verify fail.
1307
	*		@return 		BOOL|wp_die()
0 ignored issues
show
Documentation introduced by
The doc-type BOOL|wp_die() could not be parsed: Expected "|" or "end of type", but got "(" at position 11. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
1308
	*/
1309
	public function check_user_access( $route_to_check = '', $verify_only = FALSE ) {
1310
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
1311
		$route_to_check = empty( $route_to_check ) ? $this->_req_action : $route_to_check;
1312
		$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'] ) ? $this->_page_routes[$route_to_check]['capability'] : NULL;
1313
1314
		if ( empty( $capability ) && empty( $route_to_check )  ) {
1315
			$capability = is_array( $this->_route ) && empty( $this->_route['capability'] ) ? 'manage_options' : $this->_route['capability'];
1316
		} else {
1317
			$capability = empty( $capability ) ? 'manage_options' : $capability;
1318
		}
1319
1320
		$id = is_array( $this->_route ) && ! empty( $this->_route['obj_id'] ) ? $this->_route['obj_id'] : 0;
1321
1322
		if (( ! function_exists( 'is_admin' ) || ! EE_Registry::instance()->CAP->current_user_can( $capability, $this->page_slug . '_' . $route_to_check, $id ) ) && ! defined( 'DOING_AJAX')) {
1323
			if ( $verify_only ) {
1324
				return FALSE;
1325
			} else {
1326
				wp_die( __('You do not have access to this route.', 'event_espresso' ) );
1327
			}
1328
		}
1329
		return TRUE;
1330
	}
1331
1332
1333
1334
1335
1336
1337
1338
	/**
1339
	 * admin_init_global
1340
	 * This runs all the code that we want executed within the WP admin_init hook.
1341
	 * This method executes for ALL EE Admin pages.
1342
	 *
1343
	 * @access public
1344
	 * @return void
1345
	 */
1346
	public function admin_init_global() {
1347
	}
1348
1349
1350
1351
1352
1353
1354
	/**
1355
	 * wp_loaded_global
1356
	 * 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
1357
	 *
1358
	 * @access public
1359
	 * @return void
1360
	 */
1361
	public function wp_loaded() {}
1362
1363
1364
1365
1366
1367
1368
	/**
1369
	 * admin_notices
1370
	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on ALL EE_Admin pages.
1371
	 *
1372
	 * @access public
1373
	 * @return void
1374
	 */
1375
	public function admin_notices_global() {
1376
		$this->_display_no_javascript_warning();
1377
		$this->_display_espresso_notices();
1378
	}
1379
1380
1381
1382
1383
	public function network_admin_notices_global() {
1384
		$this->_display_no_javascript_warning();
1385
		$this->_display_espresso_notices();
1386
	}
1387
1388
1389
1390
1391
	/**
1392
	 * admin_footer_scripts_global
1393
	 * 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.
1394
	 *
1395
	 * @access public
1396
	 * @return void
1397
	 */
1398
	public function admin_footer_scripts_global() {
1399
		$this->_add_admin_page_ajax_loading_img();
1400
		$this->_add_admin_page_overlay();
0 ignored issues
show
Unused Code introduced by
The call to the method EE_Admin_Page::_add_admin_page_overlay() seems un-needed as the method has no side-effects.

PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left.

Let’s take a look at an example:

class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

If we look at the getEmail() method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless:

$user = new User();
$user->getEmail(); // This line could safely be removed as it has no effect.

On the hand, if we look at the setEmail(), this method _has_ side-effects. In the following case, we could not remove the method call:

$user = new User();
$user->setEmail('email@domain'); // This line has a side-effect (it changes an
                                 // instance variable).
Loading history...
1401
1402
		//if metaboxes are present we need to add the nonce field
1403
		if ( ( isset($this->_route_config['metaboxes']) || ( isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes'] ) || isset($this->_route_config['list_table']) ) ) {
1404
			wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
1405
			wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
1406
		}
1407
	}
1408
1409
1410
1411
1412
1413
	/**
1414
	 * admin_footer_global
1415
	 * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particluar method will apply on ALL EE_Admin Pages.
1416
	 *
1417
	 * @access  public
1418
	 * @return  void
1419
	 */
1420
	public function admin_footer_global() {
1421
		//dialog container for dialog helper
1422
		$d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
1423
		$d_cont .= '<div class="ee-notices"></div>';
1424
		$d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
1425
		$d_cont .= '</div>';
1426
		echo $d_cont;
1427
1428
		//help tour stuff?
1429
		if ( isset( $this->_help_tour[$this->_req_action] ) ) {
1430
			echo implode('<br />', $this->_help_tour[$this->_req_action]);
1431
		}
1432
1433
		//current set timezone for timezone js
1434
		EE_Registry::instance()->load_helper('DTT_Helper');
1435
		echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
1436
	}
1437
1438
1439
	/**
1440
	 * 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.
1441
	 *
1442
	 * For child classes:
1443
	 * 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 the help popup content on that page.
1444
	 * 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 'edit_event' route you should have a method named "_help_popup_content_edit_route".
1445
	 * In your defined "help_popup_content_..." method.  You must prepare and return an array in the following format
1446
	 * array(
1447
	 * 	'help_trigger_id' => array(
1448
	 * 		'title' => __('localized title for popup', 'event_espresso'),
1449
	 * 		'content' => __('localized content for popup', 'event_espresso')
1450
	 * 	)
1451
	 * );
1452
	 *
1453
	 * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
1454
	 *
1455
	 *
1456
	 * @access protected
1457
	 * @return string content
1458
	 */
1459
	protected function _set_help_popup_content( $help_array = array(), $display = FALSE ) {
1460
		$content = '';
1461
1462
		$help_array = empty( $help_array ) ? $this->_get_help_content() : $help_array;
1463
		$template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';
1464
1465
1466
		//loop through the array and setup content
1467
		foreach ( $help_array as $trigger => $help ) {
1468
			//make sure the array is setup properly
1469
			if ( !isset($help['title']) || !isset($help['content'] ) ) {
1470
				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', 'event_espresso') );
1471
			}
1472
1473
			//we're good so let'd setup the template vars and then assign parsed template content to our content.
1474
			$template_args = array(
1475
				'help_popup_id' => $trigger,
1476
				'help_popup_title' => $help['title'],
1477
				'help_popup_content' => $help['content']
1478
				);
1479
1480
			$content .= EEH_Template::display_template( $template_path, $template_args, TRUE );
1481
		}
1482
1483
		if ( $display )
1484
			echo $content;
1485
		else
1486
			return $content;
1487
	}
1488
1489
1490
1491
1492
	/**
1493
	 * All this does is retrive the help content array if set by the EE_Admin_Page child
1494
	 *
1495
	 * @access private
1496
	 * @return array properly formatted array for help popup content
1497
	 */
1498
	private function _get_help_content() {
1499
		//what is the method we're looking for?
1500
		$method_name = '_help_popup_content_' . $this->_req_action;
1501
1502
		//if method doesn't exist let's get out.
1503
		if ( !method_exists( $this, $method_name ) )
1504
			return array();
1505
1506
		//k we're good to go let's retrieve the help array
1507
		$help_array = call_user_func( array( $this, $method_name ) );
1508
1509
		//make sure we've got an array!
1510
		if ( !is_array($help_array) ) {
1511
			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' ) );
1512
		}
1513
1514
		return $help_array;
1515
	}
1516
1517
1518
1519
	/**
1520
	 * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
1521
	 *
1522
	 * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
1523
	 *
1524
	 * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
1525
	 *
1526
	 *
1527
	 * @access protected
1528
	 * @param string  $trigger_id reference for retrieving the trigger content for the popup
1529
	 * @param boolean $display    if false then we return the trigger string
1530
	 * @param array $dimensions an array of dimensions for the box (array(h,w))
1531
	 * @return string
1532
	 */
1533
	protected function _set_help_trigger( $trigger_id, $display = TRUE, $dimensions = array( '400', '640') ) {
1534
1535
		if ( defined('DOING_AJAX') ) return;
1536
1537
		//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
1538
		$help_array = $this->_get_help_content();
1539
		$help_content = '';
1540
1541
		if ( empty( $help_array ) || !isset( $help_array[$trigger_id] ) ) {
1542
			$help_array[$trigger_id] = array(
1543
				'title' => __('Missing Content', 'event_espresso'),
1544
				'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.)', 'event_espresso')
1545
				);
1546
			$help_content = $this->_set_help_popup_content( $help_array, FALSE );
1547
		}
1548
1549
		//let's setup the trigger
1550
		$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>';
1551
		$content = $content . $help_content;
1552
1553
		if ( $display )
1554
			echo $content;
1555
		else
1556
			return $content;
1557
	}
1558
1559
1560
	/**
1561
	 * _add_global_screen_options
1562
	 * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
1563
	 * This particular method will add_screen_options on ALL EE_Admin Pages
1564
	 * @link http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
1565
	 * see also WP_Screen object documents...
1566
	 * @link http://codex.wordpress.org/Class_Reference/WP_Screen
1567
	 *
1568
	 * @abstract
1569
	 * @access private
1570
	 * @return void
1571
	 */
1572
	private function _add_global_screen_options() {}
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
	/**
1583
	 * _add_global_feature_pointers
1584
	 * This method is used for implementing any "feature pointers" (using built-in WP styling js).
1585
	 * This particular method will implement feature pointers for ALL EE_Admin pages.
1586
	 * Note: this is just a placeholder for now.  Implementation will come down the road
1587
	 * @see WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
1588
	 * @link http://eamann.com/tech/wordpress-portland/
1589
	 *
1590
	 * @abstract
1591
	 * @access protected
1592
	 * @return void
1593
	 */
1594
	private function _add_global_feature_pointers() {}
1595
1596
1597
1598
1599
1600
1601
	/**
1602
	 * load_global_scripts_styles
1603
	 * The scripts and styles enqueued in here will be loaded on every EE Admin page
1604
	 *
1605
	 * @return void
1606
	 */
1607
	public function load_global_scripts_styles() {
1608
		/** STYLES **/
1609
		// add debugging styles
1610
		if ( WP_DEBUG ) {
1611
			add_action('admin_head', array( $this, 'add_xdebug_style' ));
1612
		}
1613
1614
		//register all styles
1615
		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 );
1616
		wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
1617
		//helpers styles
1618
		wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION );
1619
		//enqueue global styles
1620
		wp_enqueue_style('ee-admin-css');
1621
1622
1623
		/** SCRIPTS **/
1624
1625
		//register all scripts
1626
		wp_register_script( 'espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE );
1627
		wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, TRUE );
1628
		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 );
1629
1630
		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 );
1631
		// register jQuery Validate - see /includes/functions/wp_hooks.php
1632
		add_filter( 'FHEE_load_jquery_validate', '__return_true' );
1633
		add_filter('FHEE_load_joyride', '__return_true');
1634
1635
		//script for sorting tables
1636
		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);
1637
		//script for parsing uri's
1638
		wp_register_script( 'ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, TRUE );
1639
		//and parsing associative serialized form elements
1640
		wp_register_script( 'ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE );
1641
		//helpers scripts
1642
		wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE );
1643
		wp_register_script( 'ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, TRUE );
1644
		wp_register_script( 'ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, TRUE );
1645
		wp_register_script( 'ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon','ee-moment'), EVENT_ESPRESSO_VERSION, TRUE );
1646
1647
		//google charts
1648
		wp_register_script( 'google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false );
1649
1650
		//enqueue global scripts
1651
1652
		//taking care of metaboxes
1653
		if ( ( isset($this->_route_config['metaboxes'] ) || isset($this->_route_config['has_metaboxes']) ) && empty( $this->_cpt_route) ) {
0 ignored issues
show
Bug introduced by
The property _cpt_route does not seem to exist. Did you mean _route?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1654
			wp_enqueue_script('dashboard');
1655
		}
1656
1657
		//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
1658
		if ( ! isset( $this->_route_config['has_help_popups']) || ( isset( $this->_route_config['has_help_popups']) && $this->_route_config['has_help_popups'] ) ) {
1659
			wp_enqueue_script('ee_admin_js');
1660
			wp_enqueue_style('ee-admin-css');
1661
		}
1662
1663
1664
		//localize script for ajax lazy loading
1665
		$lazy_loader_container_ids = apply_filters( 'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content') );
1666
		wp_localize_script( 'ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
1667
1668
1669
		/**
1670
		 * help tour stuff
1671
		 */
1672
		if ( !empty( $this->_help_tour ) ) {
1673
1674
			//register the js for kicking things off
1675
			wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, TRUE );
1676
1677
			//setup tours for the js tour object
1678
			foreach ( $this->_help_tour['tours'] as $tour ) {
1679
				$tours[] = array(
0 ignored issues
show
Coding Style Comprehensibility introduced by
$tours was never initialized. Although not strictly required by PHP, it is generally a good practice to add $tours = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
1680
					'id' => $tour->get_slug(),
1681
					'options' => $tour->get_options()
1682
					);
1683
			}
1684
1685
			wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours ) );
0 ignored issues
show
Bug introduced by
The variable $tours does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1686
1687
			//admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
1688
		}
1689
	}
1690
1691
1692
1693
1694
	/**
1695
	*		admin_footer_scripts_eei18n_js_strings
1696
	*
1697
	*		@access 		public
1698
	*		@return 		void
1699
	*/
1700
	public function admin_footer_scripts_eei18n_js_strings() {
1701
1702
		EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
1703
		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' );
1704
1705
		EE_Registry::$i18n_js_strings['January'] = __( 'January', 'event_espresso' );
1706
		EE_Registry::$i18n_js_strings['February'] = __( 'February', 'event_espresso' );
1707
		EE_Registry::$i18n_js_strings['March'] = __( 'March', 'event_espresso' );
1708
		EE_Registry::$i18n_js_strings['April'] = __( 'April', 'event_espresso' );
1709
		EE_Registry::$i18n_js_strings['May'] = __( 'May', 'event_espresso' );
1710
		EE_Registry::$i18n_js_strings['June'] = __( 'June', 'event_espresso' );
1711
		EE_Registry::$i18n_js_strings['July'] = __( 'July', 'event_espresso' );
1712
		EE_Registry::$i18n_js_strings['August'] = __( 'August', 'event_espresso' );
1713
		EE_Registry::$i18n_js_strings['September'] = __( 'September', 'event_espresso' );
1714
		EE_Registry::$i18n_js_strings['October'] = __( 'October', 'event_espresso' );
1715
		EE_Registry::$i18n_js_strings['November'] = __( 'November', 'event_espresso' );
1716
		EE_Registry::$i18n_js_strings['December'] = __( 'December', 'event_espresso' );
1717
		EE_Registry::$i18n_js_strings['Jan'] = __( 'Jan', 'event_espresso' );
1718
		EE_Registry::$i18n_js_strings['Feb'] = __( 'Feb', 'event_espresso' );
1719
		EE_Registry::$i18n_js_strings['Mar'] = __( 'Mar', 'event_espresso' );
1720
		EE_Registry::$i18n_js_strings['Apr'] = __( 'Apr', 'event_espresso' );
1721
		EE_Registry::$i18n_js_strings['May'] = __( 'May', 'event_espresso' );
1722
		EE_Registry::$i18n_js_strings['Jun'] = __( 'Jun', 'event_espresso' );
1723
		EE_Registry::$i18n_js_strings['Jul'] = __( 'Jul', 'event_espresso' );
1724
		EE_Registry::$i18n_js_strings['Aug'] = __( 'Aug', 'event_espresso' );
1725
		EE_Registry::$i18n_js_strings['Sep'] = __( 'Sep', 'event_espresso' );
1726
		EE_Registry::$i18n_js_strings['Oct'] = __( 'Oct', 'event_espresso' );
1727
		EE_Registry::$i18n_js_strings['Nov'] = __( 'Nov', 'event_espresso' );
1728
		EE_Registry::$i18n_js_strings['Dec'] = __( 'Dec', 'event_espresso' );
1729
1730
		EE_Registry::$i18n_js_strings['Sunday'] = __( 'Sunday', 'event_espresso' );
1731
		EE_Registry::$i18n_js_strings['Monday'] = __( 'Monday', 'event_espresso' );
1732
		EE_Registry::$i18n_js_strings['Tuesday'] = __( 'Tuesday', 'event_espresso' );
1733
		EE_Registry::$i18n_js_strings['Wednesday'] = __( 'Wednesday', 'event_espresso' );
1734
		EE_Registry::$i18n_js_strings['Thursday'] = __( 'Thursday', 'event_espresso' );
1735
		EE_Registry::$i18n_js_strings['Friday'] = __( 'Friday', 'event_espresso' );
1736
		EE_Registry::$i18n_js_strings['Saturday'] = __( 'Saturday', 'event_espresso' );
1737
		EE_Registry::$i18n_js_strings['Sun'] = __( 'Sun', 'event_espresso' );
1738
		EE_Registry::$i18n_js_strings['Mon'] = __( 'Mon', 'event_espresso' );
1739
		EE_Registry::$i18n_js_strings['Tue'] = __( 'Tue', 'event_espresso' );
1740
		EE_Registry::$i18n_js_strings['Wed'] = __( 'Wed', 'event_espresso' );
1741
		EE_Registry::$i18n_js_strings['Thu'] = __( 'Thu', 'event_espresso' );
1742
		EE_Registry::$i18n_js_strings['Fri'] = __( 'Fri', 'event_espresso' );
1743
		EE_Registry::$i18n_js_strings['Sat'] = __( 'Sat', 'event_espresso' );
1744
1745
		//setting on espresso_core instead of ee_admin_js because espresso_core is enqueued by the maintenance
1746
		//admin page when in maintenance mode and ee_admin_js is not loaded then.  This works everywhere else because
1747
		//espresso_core is listed as a dependency of ee_admin_js.
1748
		wp_localize_script( 'espresso_core', 'eei18n', EE_Registry::$i18n_js_strings );
1749
1750
	}
1751
1752
1753
1754
	/**
1755
	*		load enhanced xdebug styles for ppl with failing eyesight
1756
	*
1757
	*		@access 		public
1758
	*		@return 		void
1759
	*/
1760
	public function add_xdebug_style() {
1761
		echo '<style>.xdebug-error { font-size:1.5em; }</style>';
1762
	}
1763
1764
1765
	/************************/
1766
	/** LIST TABLE METHODS **/
1767
	/************************/
1768
1769
1770
1771
1772
1773
	/**
1774
	 * this sets up the list table if the current view requires it.
1775
	 *
1776
	 * @access protected
1777
	 * @return void
1778
	 */
1779
	protected function _set_list_table() {
1780
1781
		//first is this a list_table view?
1782
		if ( !isset($this->_route_config['list_table']) )
1783
			return; //not a list_table view so get out.
1784
1785
		//list table functions are per view specific (because some admin pages might have more than one listtable!)
1786
1787
		if ( call_user_func( array( $this, '_set_list_table_views_' . $this->_req_action ) ) === FALSE ) {
1788
			//user error msg
1789
			$error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso' );
1790
			//developer error msg
1791
			$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' ), $this->_req_action, '_set_list_table_views_' . $this->_req_action );
1792
			throw new EE_Error( $error_msg );
1793
		}
1794
1795
		//let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
1796
		$this->_views = apply_filters( 'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views );
1797
		$this->_views = apply_filters( 'FHEE_list_table_views_' . $this->page_slug, $this->_views );
1798
		$this->_views = apply_filters( 'FHEE_list_table_views', $this->_views );
1799
1800
		$this->_set_list_table_view();
1801
		$this->_set_list_table_object();
1802
1803
	}
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
	/**
1815
	 * 		set current view for List Table
1816
	*		@access public
1817
	*		@return array
1818
	*/
1819
	protected function _set_list_table_view() {
1820
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
1821
1822
1823
		// looking at active items or dumpster diving ?
1824
		if ( ! isset( $this->_req_data['status'] ) || ! array_key_exists( $this->_req_data['status'], $this->_views )) {
1825
			$this->_view = isset( $this->_views['in_use'] ) ? 'in_use' : 'all';
1826
		} else {
1827
			$this->_view = sanitize_key( $this->_req_data['status'] );
1828
		}
1829
	}
1830
1831
1832
1833
	/**
1834
	 * _set_list_table_object
1835
	 * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
1836
	 */
1837
	protected function _set_list_table_object() {
1838
		if ( isset($this->_route_config['list_table'] ) ) {
1839 View Code Duplication
			if ( !class_exists( $this->_route_config['list_table'] ) )
1840
				throw new EE_Error( sprintf( __('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.', 'event_espresso'), $this->_route_config['list_table'], get_class($this) ) );
1841
			$a = new ReflectionClass($this->_route_config['list_table']);
1842
			$this->_list_table_object = $a->newInstance($this);
1843
		}
1844
	}
1845
1846
1847
1848
1849
1850
	/**
1851
	 * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
1852
	 *
1853
	 * @param array $extra_query_args Optional. An array of extra query args to add to the generated
1854
	 *                                		          	urls.  The array should be indexed by the view it is being
1855
	 *                                		          	added to.
1856
	 *
1857
	 * @return array
1858
	 */
1859
	public function get_list_table_view_RLs( $extra_query_args = array() ) {
1860
1861
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
1862
1863
		if ( empty( $this->_views )) {
1864
			$this->_views = array();
1865
		}
1866
1867
		// cycle thru views
1868
		foreach ( $this->_views as $key => $view ) {
1869
			$query_args = array();
1870
			// check for current view
1871
			$this->_views[ $key ]['class'] = $this->_view == $view['slug'] ? 'current' : '';
1872
			$query_args['action'] = $this->_req_action;
1873
			$query_args[$this->_req_action.'_nonce'] = wp_create_nonce( $query_args['action'] . '_nonce' );
1874
			$query_args['status'] = $view['slug'];
1875
			//merge any other arguments sent in.
1876
			if ( isset( $extra_query_args[$view['slug']] ) ) {
1877
				$query_args = array_merge( $query_args, $extra_query_args[$view['slug']] );
1878
			}
1879
			$this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce( $query_args, $this->_admin_base_url );
1880
		}
1881
1882
		return $this->_views;
1883
	}
1884
1885
1886
1887
1888
	/**
1889
	 * _entries_per_page_dropdown
1890
	 * generates a drop down box for selecting the number of visiable rows in an admin page list table
1891
	 * @todo: Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
1892
	 * @access protected
1893
	 * @param int $max_entries total number of rows in the table
1894
	 * @return string
1895
	*/
1896
	protected function _entries_per_page_dropdown( $max_entries = FALSE ) {
1897
1898
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
1899
		$values = array( 10, 25, 50, 100 );
1900
		$per_page = ( ! empty( $this->_req_data['per_page'] )) ? absint( $this->_req_data['per_page'] ) : 10;
1901
1902
		if ( $max_entries ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $max_entries of type false|integer is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
1903
			$values[] = $max_entries;
1904
			sort( $values );
1905
		}
1906
1907
		$entries_per_page_dropdown = '
1908
			<div id="entries-per-page-dv" class="alignleft actions">
1909
				<label class="hide-if-no-js">
1910
					Show
1911
					<select id="entries-per-page-slct" name="entries-per-page-slct">';
1912
1913
		foreach ( $values as $value ) {
1914
			if ( $value < $max_entries ) {
1915
				$selected = $value == $per_page ?  ' selected="' . $per_page . '"' : '';
1916
				$entries_per_page_dropdown .= '
1917
						<option value="'.$value.'"'.$selected.'>'.$value.'&nbsp;&nbsp;</option>';
1918
			}
1919
		}
1920
1921
		$selected = $max_entries == $per_page ?  ' selected="' . $per_page . '"' : '';
1922
		$entries_per_page_dropdown .= '
1923
						<option value="'.$max_entries.'"'.$selected.'>All&nbsp;&nbsp;</option>';
1924
1925
		$entries_per_page_dropdown .= '
1926
					</select>
1927
					entries
1928
				</label>
1929
				<input id="entries-per-page-btn" class="button-secondary" type="submit" value="Go" >
1930
			</div>
1931
		';
1932
		return $entries_per_page_dropdown;
1933
	}
1934
1935
1936
1937
1938
	/**
1939
	 * 		_set_search_attributes
1940
	*		@access 		protected
1941
	*		@return 		void
1942
	*/
1943
	public function _set_search_attributes() {
1944
		$this->_template_args['search']['btn_label'] = sprintf( __( 'Search %s', 'event_espresso' ), empty( $this->_search_btn_label ) ? $this->page_label : $this->_search_btn_label );
1945
		$this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
1946
	}
1947
1948
	/*** END LIST TABLE METHODS **/
1949
	/*****************************/
1950
1951
1952
1953
1954
1955
	/**
1956
	 * 		_add_registered_metaboxes
1957
	 * 		this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
1958
	 *
1959
	 * @link http://codex.wordpress.org/Function_Reference/add_meta_box
1960
	 * @access private
1961
	 * @return void
1962
	*/
1963
	private function _add_registered_meta_boxes() {
1964
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
1965
1966
		//we only add meta boxes if the page_route calls for it
1967
		if ( is_array($this->_route_config) && isset( $this->_route_config['metaboxes'] ) && is_array($this->_route_config['metaboxes']) ) {
1968
1969
1970
			//this simply loops through the callbacks provided and checks if there is a corresponding callback registered by the child - if there is then we go ahead and process the metabox loader.
1971
			foreach ( $this->_route_config['metaboxes'] as $metabox_callback ) {
1972
				if ( call_user_func( array($this, &$metabox_callback) ) === FALSE ) {
1973
					// user error msg
1974
				$error_msg =  __( 'An error occurred. The  requested metabox could not be found.', 'event_espresso' );
1975
				// developer error msg
1976
				$error_msg .= '||' . sprintf( __( '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.', 'event_espresso' ), $metabox_callback );
1977
				throw new EE_Error( $error_msg );
1978
				}
1979
			}
1980
		}
1981
	}
1982
1983
1984
1985
1986
	/**
1987
	 * _add_screen_columns
1988
	 * 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.
1989
	 *
1990
	 * @access private
1991
	 * @return void
1992
	 */
1993
	private function _add_screen_columns() {
1994
		if ( is_array($this->_route_config) && isset( $this->_route_config['columns'] ) && is_array($this->_route_config['columns']) && count( $this->_route_config['columns'] == 2 ) ) {
1995
1996
			add_screen_option('layout_columns', array('max' => (int) $this->_route_config['columns'][0], 'default' => (int) $this->_route_config['columns'][1] ) );
1997
			$this->_template_args['num_columns'] = $this->_route_config['columns'][0];
1998
			$screen_id = $this->_current_screen->id;
1999
			$screen_columns = (int) get_user_option("screen_layout_$screen_id");
2000
			$total_columns = !empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
2001
			$this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
2002
			$this->_template_args['current_page'] = $this->_wp_page_slug;
2003
			$this->_template_args['screen'] = $this->_current_screen;
2004
			$this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';
2005
2006
			//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.
2007
			$this->_route_config['has_metaboxes'] = TRUE;
2008
		}
2009
	}
2010
2011
2012
2013
	/**********************************/
2014
	/** GLOBALLY AVAILABLE METABOXES **/
2015
2016
	/**
2017
	 * 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 loaded on.
2018
	 */
2019
2020
	private function _espresso_news_post_box() {
2021
		$news_box_title = apply_filters( 'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __( 'New @ Event Espresso', 'event_espresso' ) );
2022
		add_meta_box( 'espresso_news_post_box', $news_box_title, array(
2023
			$this,
2024
			'espresso_news_post_box'
2025
		), $this->_wp_page_slug, 'side' );
2026
	}
2027
2028
2029
	/**
2030
	 * Code for setting up espresso ratings request metabox.
2031
	 */
2032
	protected function _espresso_ratings_request() {
2033
		if ( ! apply_filters( 'FHEE_show_ratings_request_meta_box', true ) ) {
2034
			return '';
2035
		}
2036
		$ratings_box_title = apply_filters( 'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso') );
2037
		add_meta_box( 'espresso_ratings_request', $ratings_box_title, array(
2038
			$this,
2039
			'espresso_ratings_request'
2040
		), $this->_wp_page_slug, 'side' );
2041
	}
2042
2043
2044
	/**
2045
	 * Code for setting up espresso ratings request metabox content.
2046
	 */
2047
	public function espresso_ratings_request() {
2048
		$template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
2049
		EE_Registry::instance()->load_helper( 'Template' );
2050
		EEH_Template::display_template( $template_path, array() );
2051
	}
2052
2053
2054
2055
2056
	public static function cached_rss_display( $rss_id, $url ) {
2057
		$loading = '<p class="widget-loading hide-if-no-js">' . __( 'Loading&#8230;' ) . '</p><p class="hide-if-js">' . __( 'This widget requires JavaScript.' ) . '</p>';
2058
		$doing_ajax = ( defined( 'DOING_AJAX' ) && DOING_AJAX );
2059
		$pre = '<div class="espresso-rss-display">' . "\n\t";
2060
		$pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
2061
		$post = '</div>' . "\n";
2062
2063
		$cache_key = 'ee_rss_' . md5( $rss_id );
2064
		if ( FALSE != ( $output = get_transient( $cache_key ) ) ) {
2065
			echo $pre . $output . $post;
2066
			return TRUE;
2067
		}
2068
2069
		if ( ! $doing_ajax ) {
2070
			echo $pre . $loading . $post;
2071
			return FALSE;
2072
		}
2073
2074
		ob_start();
2075
		wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5) );
2076
		set_transient( $cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS );
2077
		return TRUE;
2078
2079
	}
2080
2081
2082
	public function espresso_news_post_box() {
2083
		?>
2084
	  <div class="padding">
2085
	  	<div id="espresso_news_post_box_content" class="infolinks">
2086
	  		<?php
2087
	  		// Get RSS Feed(s)
2088
	  		$feed_url = apply_filters( 'FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/' );
2089
	  		$url = urlencode($feed_url);
2090
	  		self::cached_rss_display( 'espresso_news_post_box_content', $url );
2091
2092
	  		?>
2093
	  	</div>
2094
	  	<?php do_action( 'AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
2095
	  </div>
2096
		<?php
2097
	}
2098
2099
2100
	private function _espresso_links_post_box() {
2101
		//Hiding until we actually have content to put in here...
2102
		//add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
2103
	}
2104
2105
	public function espresso_links_post_box() {
2106
		   //Hiding until we actually have content to put in here...
2107
		   //$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
2108
			//EEH_Template::display_template( $templatepath );
2109
		}
2110
2111
2112
2113
	protected function _espresso_sponsors_post_box() {
2114
2115
		$show_sponsors = apply_filters( 'FHEE_show_sponsors_meta_box', TRUE );
2116
		if ( $show_sponsors )
2117
			add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array( $this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
2118
	}
2119
2120
2121
	public function espresso_sponsors_post_box() {
2122
		$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
2123
		EEH_Template::display_template( $templatepath );
2124
	}
2125
2126
2127
2128
	private function _publish_post_box() {
2129
		$meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
2130
2131
		//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)
2132
		if ( !empty( $this->_labels['publishbox'] ) ) {
2133
			$box_label = is_array( $this->_labels['publishbox'] ) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
2134
		} else {
2135
			$box_label = __('Publish', 'event_espresso');
2136
		}
2137
2138
		$box_label = apply_filters( 'FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this );
2139
2140
		add_meta_box( $meta_box_ref, $box_label, array( $this, 'editor_overview' ), $this->_current_screen->id, 'side', 'high' );
2141
2142
	}
2143
2144
2145
2146
	public function editor_overview() {
2147
		//if we have extra content set let's add it in if not make sure its empty
2148
		$this->_template_args['publish_box_extra_content'] = isset( $this->_template_args['publish_box_extra_content'] ) ? $this->_template_args['publish_box_extra_content'] : '';
2149
		$template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
2150
		echo EEH_Template::display_template( $template_path, $this->_template_args, TRUE );
2151
	}
2152
2153
2154
	/** end of globally available metaboxes section **/
2155
	/*************************************************/
2156
2157
2158
2159
	/**
2160
	 * Public wrapper for the protected method.  Allows plugins/addons to externally call the
2161
	 * protected method.
2162
	 *
2163
	 * @see $this->_set_publish_post_box_vars for param details
2164
	 * @since 4.6.0
2165
	 */
2166
	public function set_publish_post_box_vars( $name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true ) {
2167
		$this->_set_publish_post_box_vars( $name, $id, $delete, $save_close_redirect_URL, $both_btns );
0 ignored issues
show
Documentation introduced by
$id is of type boolean, but the function expects a false|integer.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
Documentation introduced by
$delete is of type boolean, but the function expects a false|string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2168
	}
2169
2170
2171
	/**
2172
	 * Sets the _template_args arguments used by the _publish_post_box shortcut
2173
	 *
2174
	 * Note: currently there is no validation for this.  However if you want the delete button, the
2175
	 * save, and save and close buttons to work properly, then you will want to include a
2176
	 * values for the name and id arguments.
2177
	 *
2178
	 * @todo  Add in validation for name/id arguments.
2179
	 *
2180
	 * @param	string	$name		key used for the action ID (i.e. event_id)
2181
	 * @param	int		$id	id attached to the item published
2182
	 * @param	string	$delete	page route callback for the delete action
2183
	 * @param	string	$post_save_redirect_URL	custom URL to redirect to after Save & Close has been completed
0 ignored issues
show
Bug introduced by
There is no parameter named $post_save_redirect_URL. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
2184
	 * @param	boolean	$both_btns	whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
2185
	 */
2186
	protected function _set_publish_post_box_vars( $name = NULL, $id = FALSE, $delete = FALSE, $save_close_redirect_URL = NULL, $both_btns = TRUE ) {
2187
2188
		// if Save & Close, use a custom redirect URL or default to the main page?
2189
		$save_close_redirect_URL = ! empty( $save_close_redirect_URL ) ? $save_close_redirect_URL : $this->_admin_base_url;
2190
		// create the Save & Close and Save buttons
2191
		$this->_set_save_buttons( $both_btns, array(), array(), $save_close_redirect_URL );
2192
		//if we have extra content set let's add it in if not make sure its empty
2193
		$this->_template_args['publish_box_extra_content'] = isset( $this->_template_args['publish_box_extra_content'] ) ? $this->_template_args['publish_box_extra_content'] : '';
2194
2195
2196
		if ( $delete && ! empty( $id )  ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $delete of type false|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
2197
			$delete = is_bool($delete) ? 'delete' : $delete; //make sure we have a default if just true is sent.
2198
			$delete_link_args = array( $name => $id );
2199
			$delete = $this->get_action_link_or_button( $delete, $delete, $delete_link_args, 'submitdelete deletion');
2200
		}
2201
2202
		$this->_template_args['publish_delete_link'] = !empty( $id ) ? $delete : '';
2203
		if ( ! empty( $name ) && ! empty( $id ) ) {
2204
			$hidden_field_arr[$name] = array(
0 ignored issues
show
Coding Style Comprehensibility introduced by
$hidden_field_arr was never initialized. Although not strictly required by PHP, it is generally a good practice to add $hidden_field_arr = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
2205
				'type' => 'hidden',
2206
				'value' => $id
2207
				);
2208
			$hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
2209
		} else {
2210
			$hf = '';
2211
		}
2212
		// add hidden field
2213
		$this->_template_args['publish_hidden_fields'] = ! empty( $hf ) ? $hf[$name]['field'] : $hf;
2214
2215
	}
2216
2217
2218
2219
2220
	/**
2221
	 * 		displays an error message to ppl who have javascript disabled
2222
	*		@access 		private
2223
	*		@return 		string
2224
	*/
2225
	private function _display_no_javascript_warning() {
2226
		?>
2227
		<noscript>
2228
			<div id="no-js-message" class="error">
2229
				<p style="font-size:1.3em;">
2230
					<span style="color:red;"><?php _e( 'Warning!', 'event_espresso' ); ?></span>
2231
					<?php _e( 'Javascript is currently turned off for your browser. Javascript must be enabled in order for all of the features on this page to function properly. Please turn your javascript back on.', 'event_espresso' ); ?>
2232
				</p>
2233
			</div>
2234
		</noscript>
2235
		<?php
2236
	}
2237
2238
2239
2240
2241
2242
2243
2244
2245
	/**
2246
	 * 		displays espresso success and/or error notices
2247
	*		@access 		private
2248
	*		@return 		string
2249
	*/
2250
	private function _display_espresso_notices() {
2251
		$notices = $this->_get_transient( TRUE );
2252
		echo stripslashes($notices);
2253
	}
2254
2255
2256
2257
2258
2259
2260
	/**
2261
	*		spinny things pacify the masses
2262
	*		@access private
2263
	*		@return string
2264
	*/
2265
	protected function _add_admin_page_ajax_loading_img() {
2266
		?>
2267
			<div id="espresso-ajax-loading" class="ajax-loading-grey">
2268
				<span class="ee-spinner ee-spin"></span><span class="hidden"><?php _e('loading...', 'event_espresso'); ?></span>
2269
			</div>
2270
		<?php
2271
	}
2272
2273
2274
2275
2276
2277
	/**
2278
	*		add admin page overlay for modal boxes
2279
	*		@access private
2280
	*		@return string
2281
	*/
2282
	protected function _add_admin_page_overlay() {
2283
		?>
2284
		<div id="espresso-admin-page-overlay-dv" class=""></div>
2285
		<?php
2286
	}
2287
2288
2289
2290
2291
2292
2293
	/**
2294
	 * facade for add_meta_box
2295
	 * @param string  $action        where the metabox get's displayed
2296
	 * @param string  $title         Title of Metabox (output in metabox header)
2297
	 * @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.
2298
	 * @param array  $callback_args an array of args supplied for the metabox
2299
	 * @param string  $column        what metabox column
2300
	 * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
2301
	 * @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.
2302
	 */
2303
	public function _add_admin_page_meta_box( $action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true ) {
2304
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, $callback );
2305
2306
		//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.
2307
		if ( empty( $callback_args ) && $create_func ) {
2308
			$callback_args = array(
2309
				'template_path' => $this->_template_path,
2310
				'template_args' => $this->_template_args,
2311
				);
2312
		}
2313
2314
		//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)
2315
		$call_back_func = $create_func ? create_function('$post, $metabox', 'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
0 ignored issues
show
Security Best Practice introduced by
The use of create_function is highly discouraged, better use a closure.

create_function can pose a great security vulnerability as it is similar to eval, and could be used for arbitrary code execution. We highly recommend to use a closure instead.

// Instead of
$function = create_function('$a, $b', 'return $a + $b');

// Better use
$function = function($a, $b) { return $a + $b; }
Loading history...
2316
2317
		add_meta_box( str_replace( '_', '-', $action ) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args );
2318
	}
2319
2320
2321
2322
2323
2324
	/**
2325
	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
2326
	 * @return [type] [description]
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
2327
	 */
2328
	public function display_admin_page_with_metabox_columns() {
2329
		$this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
2330
		$this->_template_args['admin_page_content'] = EEH_Template::display_template( $this->_column_template_path, $this->_template_args, TRUE);
2331
2332
		//the final wrapper
2333
		$this->admin_page_wrapper();
2334
	}
2335
2336
2337
2338
2339
2340
2341
2342
	/**
2343
	*		generates  HTML wrapper for an admin details page
2344
	*		@access public
2345
	*		@return void
2346
	*/
2347
	public function display_admin_page_with_sidebar() {
2348
2349
		$this->_display_admin_page(TRUE);
2350
	}
2351
2352
2353
2354
2355
	/**
2356
	*		generates  HTML wrapper for an admin details page (except no sidebar)
2357
	*		@access public
2358
	*		@return void
2359
	*/
2360
	public function display_admin_page_with_no_sidebar() {
2361
		$this->_display_admin_page();
2362
	}
2363
2364
2365
2366
2367
	/**
2368
	 * generates HTML wrapper for an EE about admin page (no sidebar)
2369
	 * @access public
2370
	 * @return void
2371
	 */
2372
	public function display_about_admin_page() {
2373
		$this->_display_admin_page( FALSE, TRUE );
2374
	}
2375
2376
2377
2378
2379
	/**
2380
	 * display_admin_page
2381
	 * contains the code for actually displaying an admin page
2382
	 *
2383
	 * @access private
2384
	 * @param  boolean $sidebar true with sidebar, false without
2385
	 * @param  boolean $about   use the about admin wrapper instead of the default.
2386
	 * @return html           admin_page
2387
	 */
2388
	private function _display_admin_page($sidebar = false, $about = FALSE) {
2389
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
2390
2391
		//custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
2392
		do_action( 'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes' );
2393
2394
		// set current wp page slug - looks like: event-espresso_page_event_categories
2395
		// keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
2396
		$this->_template_args['current_page'] = $this->_wp_page_slug;
2397
2398
		$template_path = $sidebar ?  EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
2399
2400
		if ( defined('DOING_AJAX' ) )
2401
			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
2402
2403
		$template_path = !empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
2404
2405
		$this->_template_args['post_body_content'] = isset( $this->_template_args['admin_page_content'] ) ? $this->_template_args['admin_page_content'] : '';
2406
		$this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
2407
		$this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
2408
		$this->_template_args['admin_page_content'] = EEH_Template::display_template( $template_path, $this->_template_args, TRUE );
2409
2410
2411
		// the final template wrapper
2412
		$this->admin_page_wrapper($about);
2413
	}
2414
2415
2416
2417
2418
2419
	/**
2420
	 * This is used to display caf preview pages.
2421
	 *
2422
	 * @since 4.3.2
2423
	 *
2424
	 * @param string $utm_campaign_source what is the key used for google analytics link
2425
	 * @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.
2426
	 * @return void
2427
	 */
2428
	public function display_admin_caf_preview_page( $utm_campaign_source = '', $display_sidebar = TRUE ) {
2429
		//let's generate a default preview action button if there isn't one already present.
2430
		$this->_labels['buttons']['buy_now'] = __('Upgrade Now', 'event_espresso');
2431
		$buy_now_url = add_query_arg(
2432
			array(
2433
				'ee_ver' => 'ee4',
2434
				'utm_source' => 'ee4_plugin_admin',
2435
				'utm_medium' => 'link',
2436
				'utm_campaign' => $utm_campaign_source,
2437
				'utm_content' => 'buy_now_button'
2438
			),
2439
		'http://eventespresso.com/pricing/'
2440
		);
2441
		$this->_template_args['preview_action_button'] = ! isset( $this->_template_args['preview_action_button'] ) ? $this->get_action_link_or_button( '', 'buy_now', array(), 'button-primary button-large', $buy_now_url, true ) : $this->_template_args['preview_action_button'];
2442
		$template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
2443
		$this->_template_args['admin_page_content'] = EEH_Template::display_template( $template_path, $this->_template_args, TRUE );
2444
		$this->_display_admin_page( $display_sidebar );
2445
	}
2446
2447
2448
	/**
2449
	 * display_admin_list_table_page_with_sidebar
2450
	 * generates HTML wrapper for an admin_page with list_table
2451
	 *
2452
	 * @access public
2453
	 * @return html
2454
	 */
2455
	public function display_admin_list_table_page_with_sidebar() {
2456
		$this->_display_admin_list_table_page(TRUE);
2457
	}
2458
2459
	/**
2460
	 * display_admin_list_table_page_with_no_sidebar
2461
	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
2462
	 *
2463
	 * @access public
2464
	 * @return html
2465
	 */
2466
	public function display_admin_list_table_page_with_no_sidebar() {
2467
		$this->_display_admin_list_table_page();
2468
	}
2469
2470
2471
2472
	/**
2473
	 * generates html wrapper for an admin_list_table page
2474
	 * @access private
2475
	 * @param boolean $sidebar whether to display with sidebar or not.
2476
	 * @return html
2477
	 */
2478
	private function _display_admin_list_table_page( $sidebar = false ) {
2479
		//setup search attributes
2480
		$this->_set_search_attributes();
2481
		$this->_template_args['current_page'] = $this->_wp_page_slug;
2482
		$template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
2483
2484
		$this->_template_args['table_url'] = defined( 'DOING_AJAX') ? add_query_arg( array( 'noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url ) : add_query_arg( array( 'route' => $this->_req_action), $this->_admin_base_url);
2485
		$this->_template_args['list_table'] = $this->_list_table_object;
2486
		$this->_template_args['current_route'] = $this->_req_action;
2487
		$this->_template_args['list_table_class'] = get_class( $this->_list_table_object );
2488
2489
		$ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
2490
		if( ! empty( $ajax_sorting_callback )) {
2491
			$sortable_list_table_form_fields = wp_nonce_field( $ajax_sorting_callback . '_nonce', $ajax_sorting_callback . '_nonce', FALSE, FALSE );
2492
//			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
2493
//			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
2494
			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug .'" />';
2495
			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
2496
		} else {
2497
			$sortable_list_table_form_fields = '';
2498
		}
2499
2500
		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
2501
		$hidden_form_fields = isset( $this->_template_args['list_table_hidden_fields'] ) ? $this->_template_args['list_table_hidden_fields'] : '';
2502
		$nonce_ref = $this->_req_action . '_nonce';
2503
		$hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce( $nonce_ref ) . '">';
2504
		$this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
2505
2506
		//display message about search results?
2507
		$this->_template_args['before_list_table'] .= apply_filters( 'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg', !empty( $this->_req_data['s'] ) ? '<p class="ee-search-results">' . sprintf( __('Displaying search results for the search string: <strong><em>%s</em></strong>', 'event_espresso'), trim($this->_req_data['s'], '%') ) . '</p>' : '', $this->page_slug, $this->_req_data, $this->_req_action );
2508
2509
		$this->_template_args['admin_page_content'] = EEH_Template::display_template( $template_path, $this->_template_args, TRUE );
2510
2511
		// the final template wrapper
2512
		if ( $sidebar )
2513
			$this->display_admin_page_with_sidebar();
2514
		else
2515
			$this->display_admin_page_with_no_sidebar();
2516
	}
2517
2518
2519
2520
2521
2522
	/**
2523
	 * 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.
2524
	 *
2525
	 * $items are expected in an array in the following format:
2526
	 * $legend_items = array(
2527
	 * 		'item_id' => array(
2528
	 * 			'icon' => 'http://url_to_icon_being_described.png',
2529
	 * 			'desc' => __('localized description of item');
2530
	 * 		)
2531
	 * );
2532
	 * @param  array $items  see above for format of array
2533
	 * @return string        html string of legend
2534
	 */
2535
	protected function _display_legend( $items ) {
2536
		$template_args['items'] = apply_filters( 'FHEE__EE_Admin_Page___display_legend__items', (array) $items, $this );
0 ignored issues
show
Coding Style Comprehensibility introduced by
$template_args was never initialized. Although not strictly required by PHP, it is generally a good practice to add $template_args = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
2537
		$legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
2538
		return EEH_Template::display_template($legend_template, $template_args, TRUE);
2539
	}
2540
2541
2542
2543
2544
	/**
2545
	 * this is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
2546
	 *
2547
	 * @param bool $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
2548
	 *
2549
	 * The returned json object is created from an array in the following format:
2550
	 * array(
2551
	 * 	'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
2552
	 * 	'success' => FALSE, //(default FALSE) - contains any special success message.
2553
	 * 	'notices' => '', // - contains any EE_Error formatted notices
2554
	 * 	'content' => 'string can be html', //this is a string of formatted content (can be html)
2555
	 * 	'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 specific template args that might be included in here)
2556
	 * )
2557
	 *
2558
	 * The json object is populated by whatever is set in the $_template_args property.
2559
	 *
2560
	 * @return json object
2561
	 */
2562
	protected function _return_json( $sticky_notices = FALSE ) {
2563
2564
		//make sure any EE_Error notices have been handled.
2565
		$this->_process_notices( array(), true, $sticky_notices );
2566
2567
2568
		$data = isset( $this->_template_args['data'] ) ? $this->_template_args['data'] : array();
2569
		unset($this->_template_args['data']);
2570
		$json = array(
2571
			'error' => isset( $this->_template_args['error'] ) ? $this->_template_args['error'] : FALSE,
2572
			'success' => isset( $this->_template_args['success'] ) ? $this->_template_args['success'] : FALSE,
2573
			'notices' => EE_Error::get_notices(),
2574
			'content' => isset( $this->_template_args['admin_page_content'] ) ? $this->_template_args['admin_page_content'] : '',
2575
			'data' => array_merge( $data, array('template_args' => $this->_template_args ) ),
2576
			'isEEajax' => TRUE //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
2577
			);
2578
2579
2580
		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
2581
		if ( NULL === error_get_last() || ! headers_sent() )
2582
			header('Content-Type: application/json; charset=UTF-8');
2583
                if( function_exists( 'wp_json_encode' ) ) {
2584
                    echo wp_json_encode( $json );
2585
                } else {
2586
                    echo json_encode( $json );
2587
                }
2588
		exit();
2589
	}
2590
2591
2592
2593
	/**
2594
	 * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
2595
	 * @return json_obj|EE_Error
2596
	 */
2597
	public function return_json() {
2598
		if ( defined('DOING_AJAX') && DOING_AJAX )
2599
			$this->_return_json();
2600
2601
		else {
2602
			throw new EE_Error( sprintf( __('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__ ) );
2603
		}
2604
	}
2605
2606
2607
2608
2609
	/**
2610
	 * 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.
2611
	 *
2612
	 * @param EE_Admin_Hooks object $hook_obj This will be the object for the EE_Admin_Hooks child
2613
	 *
2614
	 * @access public
2615
	 * @return void
2616
	 */
2617
	public function set_hook_object( EE_Admin_Hooks $hook_obj ) {
2618
		$this->_hook_obj = $hook_obj;
2619
	}
2620
2621
2622
2623
2624
2625
	/**
2626
	*		generates  HTML wrapper with Tabbed nav for an admin page
2627
	*		@access public
2628
	*		@param  boolean $about whether to use the special about page wrapper or default.
2629
	*		@return void
2630
	*/
2631
	public function admin_page_wrapper($about = FALSE) {
2632
2633
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
2634
2635
		$this->_nav_tabs = $this->_get_main_nav_tabs();
2636
2637
		$this->_template_args['nav_tabs'] = $this->_nav_tabs;
2638
		$this->_template_args['admin_page_title'] = $this->_admin_page_title;
2639
2640
		$this->_template_args['before_admin_page_content'] = apply_filters( 'FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view, isset( $this->_template_args['before_admin_page_content'] ) ? $this->_template_args['before_admin_page_content'] : '');
2641
		$this->_template_args['after_admin_page_content'] = apply_filters( 'FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view, isset( $this->_template_args['after_admin_page_content'] ) ? $this->_template_args['after_admin_page_content'] : '');
2642
2643
		$this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
2644
2645
2646
2647
		// load settings page wrapper template
2648
		$template_path = !defined( 'DOING_AJAX' ) ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
2649
2650
		//about page?
2651
		$template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;
2652
2653
2654
		if ( defined( 'DOING_AJAX' ) ) {
2655
			$this->_template_args['admin_page_content'] = EEH_Template::display_template( $template_path, $this->_template_args, TRUE );
2656
2657
			$this->_return_json();
2658
		} else {
2659
			EEH_Template::display_template( $template_path, $this->_template_args );
2660
		}
2661
2662
	}
2663
2664
2665
2666
	/**
2667
	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
2668
	 * @return string html
2669
	 */
2670
	protected function _get_main_nav_tabs() {
2671
		//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)
2672
		EE_Registry::instance()->load_helper( 'Tabbed_Content' );
2673
		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
0 ignored issues
show
Bug introduced by
It seems like $this->_nav_tabs can also be of type string; however, EEH_Tabbed_Content::display_admin_nav_tabs() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
2674
	}
2675
2676
2677
2678
2679
2680
2681
2682
2683
	/**
2684
	*		sort nav tabs
2685
	*		@access public
2686
	*		@return void
2687
	*/
2688
	private function _sort_nav_tabs( $a, $b ) {
2689
		if ($a['order'] == $b['order']) {
2690
	        return 0;
2691
	    }
2692
	    return ($a['order'] < $b['order']) ? -1 : 1;
2693
	}
2694
2695
2696
2697
2698
2699
	/**
2700
	 * 	generates HTML for the forms used on admin pages
2701
	 * 	@access protected
2702
	 * 	@param	array $input_vars - array of input field details
2703
	 * 	@param	array $id - used for defining unique identifiers for the form.
2704
	 * 	@param string $generator (options are 'string' or 'array', basically use this to indicate which generator to use)
2705
	 * 	@return string
2706
	 * 	@uses EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
2707
	 * 	@uses EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
2708
	 */
2709
	protected function _generate_admin_form_fields( $input_vars = array(), $generator = 'string', $id = FALSE ) {
2710
		EE_Registry::instance()->load_helper( 'Form_Fields' );
2711
		$content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
2712
		return $content;
2713
	}
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
	/**
2724
	 * generates the "Save" and "Save & Close" buttons for edit forms
2725
	 *
2726
	 * @access protected
2727
	 * @param bool $both if true then both buttons will be generated.  If false then just the "Save & Close" button.
2728
	 * @param array $text if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
2729
	 * @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.
2730
	 * @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).
2731
	 */
2732
	protected function _set_save_buttons($both = TRUE, $text = array(), $actions = array(), $referrer = NULL ) {
2733
		//make sure $text and $actions are in an array
2734
		$text = (array) $text;
2735
		$actions = (array) $actions;
2736
		$referrer_url = empty($referrer) ? '' : $referrer;
0 ignored issues
show
Unused Code introduced by
$referrer_url is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
2737
		$referrer_url = !$referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] .'" />' : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer .'" />';
2738
2739
		$button_text = !empty($text) ? $text : array( __('Save', 'event_espresso'), __('Save and Close', 'event_espresso') );
2740
		$default_names = array( 'save', 'save_and_close' );
2741
2742
		//add in a hidden index for the current page (so save and close redirects properly)
2743
		$this->_template_args['save_buttons'] = $referrer_url;
2744
2745
		foreach ( $button_text as $key => $button ) {
2746
			$ref = $default_names[$key];
2747
			$id = $this->_current_view . '_' . $ref;
2748
			$name = !empty($actions) ? $actions[$key] : $ref;
2749
			$this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
2750
			if ( !$both ) break;
2751
		}
2752
2753
	}
2754
2755
2756
	/**
2757
	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
2758
	 *
2759
	 * @see $this->_set_add_edit_form_tags() for details on params
2760
	 * @since 4.6.0
2761
	 *
2762
	 */
2763
	public function set_add_edit_form_tags( $route = '', $additional_hidden_fields = array() ) {
2764
		$this->_set_add_edit_form_tags( $route, $additional_hidden_fields );
2765
	}
2766
2767
2768
2769
	/**
2770
	 * set form open and close tags on add/edit pages.
2771
	 *
2772
	 * @access protected
2773
	 * @param string $route the route you want the form to direct to
2774
	 * @param array $additional_hidden_fields any additional hidden fields required in the form header
2775
	 * @return void
2776
	 */
2777
	protected function _set_add_edit_form_tags( $route = '', $additional_hidden_fields = array() ) {
2778
2779
		if ( empty( $route )) {
2780
			$user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
2781
			$dev_msg = $user_msg . "\n" . sprintf( __('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__ );
2782
			EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
2783
		}
2784
		// open form
2785
		$this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
2786
		// add nonce
2787
		$nonce = wp_nonce_field( $route . '_nonce', $route . '_nonce', FALSE, FALSE );
2788
//		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
2789
		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
2790
		// add REQUIRED form action
2791
		$hidden_fields = array(
2792
				'action' => array( 'type' => 'hidden', 'value' => $route ),
2793
			);
2794
		// merge arrays
2795
		$hidden_fields = is_array( $additional_hidden_fields) ? array_merge( $hidden_fields, $additional_hidden_fields ) : $hidden_fields;
2796
		// generate form fields
2797
		$form_fields = $this->_generate_admin_form_fields( $hidden_fields, 'array' );
2798
		// add fields to form
2799
		foreach ( $form_fields as $field_name => $form_field ) {
0 ignored issues
show
Bug introduced by
The expression $form_fields of type string|array is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
2800
			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
2801
		}
2802
2803
		// close form
2804
		$this->_template_args['after_admin_page_content'] = '</form>';
2805
2806
	}
2807
2808
2809
2810
	/**
2811
	 * Public Wrapper for _redirect_after_action() method since its
2812
	 * discovered it would be useful for external code to have access.
2813
	 *
2814
	 * @see EE_Admin_Page::_redirect_after_action() for params.
2815
	 * @since 4.5.0
2816
	 */
2817
	public function redirect_after_action( $success = FALSE, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = FALSE ) {
2818
		$this->_redirect_after_action( $success, $what, $action_desc, $query_args, $override_overwrite );
0 ignored issues
show
Documentation introduced by
$success is of type boolean, but the function expects a integer.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2819
	}
2820
2821
2822
2823
	/**
2824
	 *    _redirect_after_action
2825
	 *
2826
	 * @param int $success - whether success was for two or more records, or just one, or none
2827
	 *	@param string 	$what 		- what the action was performed on
2828
	 *	@param string 	$action_desc 	- what was done ie: updated, deleted, etc
2829
	 *	@param array 	$query_args		- an array of query_args to be added to the URL to redirect to after the admin action is completed
2830
	 *	@param BOOL     $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
2831
	 *	@access protected
2832
	 *	@return void
2833
	 */
2834
	protected function _redirect_after_action( $success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = FALSE ) {
2835
2836
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
2837
2838
		//class name for actions/filters.
2839
		$classname = get_class($this);
2840
2841
		//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
2842
		$redirect_url = isset( $query_args['page'] ) ? admin_url('admin.php') : $this->_admin_base_url;
2843
		$notices = EE_Error::get_notices( FALSE );
2844
2845
		// overwrite default success messages //BUT ONLY if overwrite not overridden
2846
		if ( ! $override_overwrite || ! empty( $notices['errors'] )) {
2847
			EE_Error::overwrite_success();
2848
		}
2849
		// how many records affected ? more than one record ? or just one ?
2850
		if ( $success > 1 && empty( $notices['errors'] )) {
2851
			// set plural msg
2852
			EE_Error::add_success( sprintf( __('The "%s" have been successfully %s.', 'event_espresso'), $what, $action_desc ), __FILE__, __FUNCTION__, __LINE__);
2853
		} else if ( $success == 1 && empty( $notices['errors'] )) {
2854
			// set singular msg
2855
			EE_Error::add_success( sprintf( __('The "%s" has been successfully %s.', 'event_espresso'), $what, $action_desc), __FILE__, __FUNCTION__, __LINE__ );
2856
		}
2857
2858
		// check that $query_args isn't something crazy
2859
		if ( ! is_array( $query_args )) {
2860
			$query_args = array();
2861
		}
2862
2863
		/**
2864
		 * Allow injecting actions before the query_args are modified for possible different
2865
		 * redirections on save and close actions
2866
		 *
2867
		 * @since 4.2.0
2868
		 *
2869
		 * @param array $query_args   The original query_args array coming into the
2870
		 *                          		method.
2871
		 */
2872
		do_action( 'AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args );
2873
2874
		//calculate where we're going (if we have a "save and close" button pushed)
2875
		if ( isset($this->_req_data['save_and_close'] ) && isset($this->_req_data['save_and_close_referrer'] ) ) {
2876
			// even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
2877
			$parsed_url = parse_url( $this->_req_data['save_and_close_referrer'] );
2878
			// regenerate query args array from refferer URL
2879
			parse_str( $parsed_url['query'], $query_args );
2880
			// correct page and action will be in the query args now
2881
			$redirect_url = admin_url( 'admin.php' );
2882
		}
2883
2884
		//merge any default query_args set in _default_route_query_args property
2885
		if ( ! empty( $this->_default_route_query_args ) && ! $this->_is_UI_request ) {
2886
			$args_to_merge = array();
2887
			foreach ( $this->_default_route_query_args as $query_param => $query_value ) {
2888
				//is there a wp_referer array in our _default_route_query_args property?
2889
				if ( $query_param == 'wp_referer'  ) {
2890
					$query_value = (array) $query_value;
2891
					foreach ( $query_value as $reference => $value ) {
2892
						if ( strpos( $reference, 'nonce' ) !== false ) {
2893
							continue;
2894
						}
2895
2896
						//finally we will override any arguments in the referer with
2897
						//what might be set on the _default_route_query_args array.
2898
						if ( isset( $this->_default_route_query_args[$reference] ) ) {
2899
							$args_to_merge[$reference] = urlencode( $this->_default_route_query_args[$reference] );
2900
						} else {
2901
							$args_to_merge[$reference] = urlencode( $value );
2902
						}
2903
					}
2904
					continue;
2905
				}
2906
2907
				$args_to_merge[$query_param] = $query_value;
2908
			}
2909
2910
			//now let's merge these arguments but override with what was specifically sent in to the
2911
			//redirect.
2912
			$query_args = array_merge( $args_to_merge, $query_args );
2913
		}
2914
2915
		$this->_process_notices($query_args);
0 ignored issues
show
Bug introduced by
It seems like $query_args can also be of type null; however, EE_Admin_Page::_process_notices() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
2916
2917
2918
		// generate redirect url
2919
2920
		// if redirecting to anything other than the main page, add a nonce
2921
		if ( isset( $query_args['action'] )) {
2922
			// manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
2923
			$query_args['_wpnonce'] = wp_create_nonce( $query_args['action'] . '_nonce' );
2924
		}
2925
2926
		//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).
2927
		do_action( 'AHEE_redirect_' . $classname . $this->_req_action, $query_args );
2928
2929
		$redirect_url = apply_filters( 'FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce( $query_args, $redirect_url ), $query_args );
2930
2931
2932
		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
2933
		if ( defined('DOING_AJAX' ) ) {
2934
			$default_data = array(
2935
				'close' => TRUE,
2936
				'redirect_url' => $redirect_url,
2937
				'where' => 'main',
2938
				'what' => 'append',
2939
				);
2940
2941
			$this->_template_args['success'] = $success;
2942
			$this->_template_args['data'] = !empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data'] ): $default_data;
2943
			$this->_return_json();
2944
		}
2945
2946
		wp_safe_redirect( $redirect_url );
2947
		exit();
2948
	}
2949
2950
2951
2952
2953
	/**
2954
	 * process any notices before redirecting (or returning ajax request)
2955
	 * This method sets the $this->_template_args['notices'] attribute;
2956
	 *
2957
	 * @param  array  $query_args any query args that need to be used for notice transient ('action')
2958
	 * @param bool    $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
2959
	 * @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.
2960
	 * @return void
2961
	 */
2962
	protected function _process_notices( $query_args = array(), $skip_route_verify = FALSE , $sticky_notices = TRUE ) {
2963
2964
		$this->_template_args['notices'] = EE_Error::get_notices();
2965
2966
		//IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
2967
		if ( ! defined( 'DOING_AJAX' ) || $sticky_notices ) {
2968
			$route = isset( $query_args['action'] ) ? $query_args['action'] : 'default';
2969
			$this->_add_transient( $route, $this->_template_args['notices'], TRUE, $skip_route_verify );
0 ignored issues
show
Documentation introduced by
$this->_template_args['notices'] is of type null|string|array<string...ng","errors":"string"}>, but the function expects a object<data>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2970
		}
2971
	}
2972
2973
2974
2975
2976
	/**
2977
	 * get_action_link_or_button
2978
	 * returns the button html for adding, editing, or deleting an item (depending on given type)
2979
	 *
2980
	 * @param string $action use this to indicate which action the url is generated with.
2981
	 * @param string $type accepted strings must be defined in the $_labels['button'] array(as the key) property.
2982
	 * @param array $extra_request if the button requires extra params you can include them in $key=>$value pairs.
2983
	 * @param string $class Use this to give the class for the button. Defaults to 'button-primary'
2984
	 * @param string $base_url If this is not provided the _admin_base_url will be used as the default for the button base_url.  Otherwise this value will be used.
2985
	 * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
2986
	 *
2987
	 * @throws EE_Error
2988
	 *
2989
	 * @return string html for button
2990
	 */
2991
	public function get_action_link_or_button($action, $type = 'add', $extra_request = array(), $class = 'button-primary', $base_url = FALSE, $exclude_nonce = false ) {
2992
		//first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
2993
		if ( !isset($this->_page_routes[$action]) && !$base_url )
0 ignored issues
show
Bug Best Practice introduced by
The expression $base_url of type false|string is loosely compared to false; this is ambiguous if the string can be empty. You might want to explicitly use === false instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
2994
			throw new EE_Error( sprintf( __('There is no page route for given action for the button.  This action was given: %s', 'event_espresso'), $action) );
2995
2996
		if ( !isset( $this->_labels['buttons'][$type] ) )
2997
			throw new EE_Error( sprintf( __('There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.', 'event_espresso'), $type) );
2998
2999
		//finally check user access for this button.
3000
		$has_access = $this->check_user_access( $action, TRUE );
3001
		if ( ! $has_access ) {
3002
			return '';
3003
		}
3004
3005
		$_base_url = !$base_url ? $this->_admin_base_url : $base_url;
3006
3007
		$query_args = array(
3008
			'action' => $action  );
3009
3010
		//merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
3011
		if ( !empty($extra_request) )
3012
			$query_args = array_merge( $extra_request, $query_args );
3013
3014
		$url = self::add_query_args_and_nonce( $query_args, $_base_url, false, $exclude_nonce );
3015
3016
		$button = EEH_Template::get_button_or_link( $url, $this->_labels['buttons'][$type], $class );
3017
3018
		return $button;
3019
	}
3020
3021
3022
3023
3024
3025
3026
	/**
3027
	 * _per_page_screen_option
3028
	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
3029
	 * @return void
3030
	 */
3031
	protected function _per_page_screen_option() {
3032
		$option = 'per_page';
3033
		$args = array(
3034
			'label' => $this->_admin_page_title,
3035
			'default' => 10,
3036
			'option' => $this->_current_page . '_' . $this->_current_view . '_per_page'
3037
			);
3038
		//ONLY add the screen option if the user has access to it.
3039
		if ( $this->check_user_access( $this->_current_view, true ) ) {
3040
			add_screen_option( $option, $args );
3041
		}
3042
	}
3043
3044
3045
3046
3047
	/**
3048
	 * set_per_page_screen_option
3049
	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
3050
	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
3051
	 *
3052
	 * @access private
3053
	 * @return void
3054
	 */
3055
	private function _set_per_page_screen_options() {
3056
		if ( isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options']) ) {
3057
			check_admin_referer( 'screen-options-nonce', 'screenoptionnonce' );
3058
3059
			if ( !$user = wp_get_current_user() )
3060
			return;
3061
			$option = $_POST['wp_screen_options']['option'];
3062
			$value = $_POST['wp_screen_options']['value'];
3063
3064
			if ( $option != sanitize_key( $option ) )
3065
				return;
3066
3067
			$map_option = $option;
3068
3069
			$option = str_replace('-', '_', $option);
3070
3071
			switch ( $map_option ) {
3072
				case $this->_current_page . '_' .  $this->_current_view . '_per_page':
3073
					$value = (int) $value;
3074
					if ( $value < 1 || $value > 999 )
3075
						return;
3076
					break;
3077
				default:
3078
					$value = apply_filters( 'FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value );
3079
					if ( false === $value )
3080
						return;
3081
					break;
3082
			}
3083
3084
			update_user_meta($user->ID, $option, $value);
3085
			wp_safe_redirect( remove_query_arg( array('pagenum', 'apage', 'paged'), wp_get_referer() ) );
3086
			exit;
3087
		}
3088
	}
3089
3090
3091
3092
	/**
3093
	 * This just allows for setting the $_template_args property if it needs to be set outside the object
3094
	 * @param array $data array that will be assigned to template args.
3095
	 */
3096
	public function set_template_args( $data ) {
3097
		$this->_template_args = array_merge( $this->_template_args, (array) $data );
3098
	}
3099
3100
3101
3102
3103
	/**
3104
	 * This makes available the WP transient system for temporarily moving data between routes
3105
	 *
3106
	 * @access protected
3107
	 * @param route $route the route that should receive the transient
3108
	 * @param data $data  the data that gets sent
3109
	 * @param bool $notices If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
3110
	 * @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.
3111
	 * @return void
3112
	 */
3113
	protected function _add_transient( $route, $data, $notices = FALSE, $skip_route_verify = FALSE ) {
3114
		$user_id = get_current_user_id();
3115
3116
		if ( !$skip_route_verify )
3117
			$this->_verify_route($route);
3118
3119
3120
		//now let's set the string for what kind of transient we're setting
3121
		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
3122
		$data = $notices ? array( 'notices' => $data ) : $data;
3123
		//is there already a transient for this route?  If there is then let's ADD to that transient
3124
		$existing = is_multisite() && is_network_admin() ? get_site_transient( $transient ) : get_transient( $transient );
3125
		if ( $existing ) {
3126
			$data = array_merge( (array) $data, (array) $existing );
3127
		}
3128
3129
		if ( is_multisite() && is_network_admin() ) {
3130
			set_site_transient( $transient, $data, 8 );
3131
		} else {
3132
			set_transient( $transient, $data, 8 );
3133
		}
3134
	}
3135
3136
3137
3138
3139
	/**
3140
	 * this retrieves the temporary transient that has been set for moving data between routes.
3141
	 * @param bool $notices true we get notices transient. False we just return normal route transient
3142
	 * @return mixed data
3143
	 */
3144
	protected function _get_transient( $notices = FALSE, $route = FALSE ) {
3145
		$user_id = get_current_user_id();
3146
		$route = !$route ? $this->_req_action : $route;
3147
		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
3148
		$data = is_multisite() && is_network_admin() ? get_site_transient( $transient ) : get_transient( $transient );
3149
		//delete transient after retrieval (just in case it hasn't expired);
3150
		if ( is_multisite() && is_network_admin() ) {
3151
			delete_site_transient( $transient );
3152
		} else {
3153
			delete_transient( $transient );
3154
		}
3155
		return $notices && isset( $data['notices'] ) ? $data['notices'] : $data;
3156
	}
3157
3158
3159
3160
3161
	/**
3162
	 * 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.
3163
	 *
3164
	 * 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.)
3165
	 * @return void
3166
	 */
3167
	protected function _transient_garbage_collection() {
3168
		global $wpdb;
3169
3170
		//retrieve all existing transients
3171
		$query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
3172
		if ( $results = $wpdb->get_results( $query ) ) {
3173
			foreach ( $results as $result ) {
3174
				$transient = str_replace( '_transient_', '', $result->option_name );
3175
				get_transient( $transient );
3176
				if ( is_multisite() && is_network_admin() ) {
3177
					get_site_transient( $transient );
3178
				}
3179
			}
3180
		}
3181
	}
3182
3183
3184
3185
3186
3187
	/**
3188
	 * get_view
3189
	 *
3190
	 * @access public
3191
	 * @return string content of _view property
3192
	 */
3193
	public function get_view() {
3194
		return $this->_view;
3195
	}
3196
3197
3198
3199
3200
	/**
3201
	 * getter for the protected $_views property
3202
	 *
3203
	 * @return array
3204
	 */
3205
	public function get_views() {
3206
		return $this->_views;
3207
	}
3208
3209
3210
3211
3212
	/**
3213
	 * get_current_page
3214
	 *
3215
	 * @access public
3216
	 * @return string _current_page property value
3217
	 */
3218
	public function get_current_page() {
3219
		return $this->_current_page;
3220
	}
3221
3222
3223
3224
3225
	/**
3226
	 * get_current_view
3227
	 *
3228
	 * @access public
3229
	 * @return string _current_view property value
3230
	 */
3231
	public function get_current_view() {
3232
		return $this->_current_view;
3233
	}
3234
3235
3236
3237
	/**
3238
	 * get_current_screen
3239
	 *
3240
	 * @access public
3241
	 * @return object The current WP_Screen object
3242
	 */
3243
	public function get_current_screen() {
3244
		return $this->_current_screen;
3245
	}
3246
3247
3248
	/**
3249
	 * get_current_page_view_url
3250
	 *
3251
	 * @access public
3252
	 * @return string This returns the url for the current_page_view.
3253
	 */
3254
	public function get_current_page_view_url() {
3255
		return $this->_current_page_view_url;
3256
	}
3257
3258
3259
3260
3261
	/**
3262
	 * just returns the _req_data property
3263
	 * @return array
3264
	 */
3265
	public function get_request_data() {
3266
		return $this->_req_data;
3267
	}
3268
3269
3270
3271
	/**
3272
	 * returns the _req_data protected property
3273
	 * @return string
3274
	 */
3275
	public function get_req_action() {
3276
		return $this->_req_action;
3277
	}
3278
3279
3280
	/**
3281
	 * @return bool  value of $_is_caf property
3282
	 */
3283
	public function is_caf() {
3284
		return $this->_is_caf;
3285
	}
3286
3287
3288
3289
3290
	/**
3291
	 * updates  espresso configuration settings
3292
	 *
3293
	 * @access 	protected
3294
	 * @param string $tab
3295
	 * @param array $data
0 ignored issues
show
Bug introduced by
There is no parameter named $data. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
3296
	 * @param string $file	file where error occurred
3297
	 * @param string $func function  where error occurred
3298
	 * @param string $line	line no where error occurred
3299
	 * @return boolean
3300
	 */
3301
	protected function _update_espresso_configuration( $tab, $config, $file = '', $func = '', $line = '' ) {
3302
3303
		//remove any options that are NOT going to be saved with the config settings.
3304
		if ( isset( $config->core->ee_ueip_optin ) ) {
3305
			$config->core->ee_ueip_has_notified = TRUE;
3306
			// TODO: remove the following two lines and make sure values are migrated from 3.1
3307
			update_option( 'ee_ueip_optin', $config->core->ee_ueip_optin);
3308
			update_option( 'ee_ueip_has_notified', TRUE );
3309
		}
3310
		// and save it (note we're also doing the network save here)
3311
		$net_saved = is_main_site() ? EE_Network_Config::instance()->update_config( FALSE, FALSE ) : TRUE;
3312
		$config_saved = EE_Config::instance()->update_espresso_config( FALSE, FALSE );
3313
		if ( $config_saved && $net_saved ) {
3314
			EE_Error::add_success( sprintf( __('"%s" have been successfully updated.', 'event_espresso'), $tab ));
3315
			return TRUE;
3316
		} else {
3317
			EE_Error::add_error( sprintf( __('The "%s" were not updated.', 'event_espresso'), $tab ), $file, $func, $line  );
3318
			return FALSE;
3319
		}
3320
	}
3321
3322
3323
3324
3325
3326
	/**
3327
	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
3328
	 * @return array
3329
	 */
3330
	public function get_yes_no_values(){
3331
		return $this->_yes_no_values;
3332
	}
3333
3334
3335
3336
	protected function _get_dir() {
3337
		$reflector = new ReflectionClass(get_class($this));
3338
		return dirname($reflector->getFileName());
3339
	}
3340
3341
3342
3343
3344
	/**
3345
	 * A helper for getting a "next link".
3346
	 *
3347
	 * @param string $url   The url to link to
3348
	 * @param string $class The class to use.
3349
	 *
3350
	 * @return string
3351
	 */
3352
	protected function _next_link( $url, $class = 'dashicons dashicons-arrow-right' ) {
3353
		return '<a class="' . $class . '" href="' . $url . '"></a>';
3354
	}
3355
3356
3357
3358
3359
	/**
3360
	 * A helper for getting a "previous link".
3361
	 *
3362
	 * @param string $url   The url to link to
3363
	 * @param string $class The class to use.
3364
	 *
3365
	 * @return string
3366
	 */
3367
	protected function _previous_link( $url, $class = 'dashicons dashicons-arrow-left' ) {
3368
		return '<a class="' . $class . '" href="' . $url . '"></a>';
3369
	}
3370
3371
3372
3373
3374
3375
3376
3377
	//below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
3378
3379
3380
3381
3382
	/**
3383
	 * 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 array.
3384
	 * @return bool success/fail
3385
	 */
3386
	protected function _process_resend_registration() {
3387
		$this->_template_args['success'] = EED_Messages::process_resend( $this->_req_data );
3388
		do_action( 'AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data );
3389
		return $this->_template_args['success'];
3390
	}
3391
3392
3393
3394
	/**
3395
	 * This automatically processes any payment message notifications when manual payment has been applied.
3396
	 *
3397
	 * @access protected
3398
	 * @param \EE_Payment $payment
3399
	 * @return bool success/fail
3400
	 */
3401
	protected function _process_payment_notification( EE_Payment $payment ) {
3402
		add_filter( 'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true' );
3403
		$success = apply_filters( 'FHEE__EE_Admin_Page___process_admin_payment_notification__success', FALSE, $payment );
3404
		$this->_template_args['success'] = $success;
3405
		return $success;
3406
	}
3407
3408
3409
}
3410
// end of file:  includes/core/admin/EE_Admin_Page.core.php
3411