Completed
Branch FET/conditional-update-queries (bf32e5)
by
unknown
44:51 queued 36:26
created
public/template_tags.php 1 patch
Spacing   +289 added lines, -289 removed lines patch added patch discarded remove patch
@@ -14,12 +14,12 @@  discard block
 block discarded – undo
14 14
  * @param int | \EE_Event $event
15 15
  * @return bool
16 16
  */
17
-function is_espresso_event( $event = NULL ) {
18
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
17
+function is_espresso_event($event = NULL) {
18
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
19 19
 		// extract EE_Event object from passed param regardless of what it is (within reason of course)
20
-		$event = EEH_Event_View::get_event( $event );
20
+		$event = EEH_Event_View::get_event($event);
21 21
 		// do we have a valid event ?
22
-		return $event instanceof EE_Event  ? TRUE : FALSE;
22
+		return $event instanceof EE_Event ? TRUE : FALSE;
23 23
 	}
24 24
 	return FALSE;
25 25
 }
@@ -31,7 +31,7 @@  discard block
 block discarded – undo
31 31
  * @return bool
32 32
  */
33 33
 function is_espresso_event_single() {
34
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
34
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
35 35
 		global $wp_query;
36 36
 		// return conditionals set by CPTs
37 37
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_single : FALSE;
@@ -46,7 +46,7 @@  discard block
 block discarded – undo
46 46
  * @return bool
47 47
  */
48 48
 function is_espresso_event_archive() {
49
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
49
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
50 50
 		global $wp_query;
51 51
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_archive : FALSE;
52 52
 	}
@@ -60,7 +60,7 @@  discard block
 block discarded – undo
60 60
  * @return bool
61 61
  */
62 62
 function is_espresso_event_taxonomy() {
63
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
63
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
64 64
 		global $wp_query;
65 65
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_event_taxonomy : FALSE;
66 66
 	}
@@ -74,10 +74,10 @@  discard block
 block discarded – undo
74 74
  * @param int | \EE_Venue $venue
75 75
  * @return bool
76 76
  */
77
-function is_espresso_venue( $venue = NULL ) {
78
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
77
+function is_espresso_venue($venue = NULL) {
78
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
79 79
 		// extract EE_Venue object from passed param regardless of what it is (within reason of course)
80
-		$venue = EEH_Venue_View::get_venue( $venue, FALSE );
80
+		$venue = EEH_Venue_View::get_venue($venue, FALSE);
81 81
 		// do we have a valid event ?
82 82
 		return $venue instanceof EE_Venue ? TRUE : FALSE;
83 83
 	}
@@ -91,7 +91,7 @@  discard block
 block discarded – undo
91 91
  * @return bool
92 92
  */
93 93
 function is_espresso_venue_single() {
94
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
94
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
95 95
 		global $wp_query;
96 96
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_single : FALSE;
97 97
 	}
@@ -105,7 +105,7 @@  discard block
 block discarded – undo
105 105
  * @return bool
106 106
  */
107 107
 function is_espresso_venue_archive() {
108
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
108
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
109 109
 		global $wp_query;
110 110
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_archive : FALSE;
111 111
 	}
@@ -119,7 +119,7 @@  discard block
 block discarded – undo
119 119
  * @return bool
120 120
  */
121 121
 function is_espresso_venue_taxonomy() {
122
-	if ( can_use_espresso_conditionals( __FUNCTION__ )) {
122
+	if (can_use_espresso_conditionals(__FUNCTION__)) {
123 123
 		global $wp_query;
124 124
 		return $wp_query instanceof WP_Query ? $wp_query->is_espresso_venue_taxonomy : FALSE;
125 125
 	}
@@ -133,12 +133,12 @@  discard block
 block discarded – undo
133 133
  * @param $conditional_tag
134 134
  * @return bool
135 135
  */
136
-function can_use_espresso_conditionals( $conditional_tag ) {
137
-	if ( ! did_action( 'AHEE__EE_System__initialize' )) {
136
+function can_use_espresso_conditionals($conditional_tag) {
137
+	if ( ! did_action('AHEE__EE_System__initialize')) {
138 138
 		EE_Error::doing_it_wrong(
139 139
 			__FUNCTION__,
140 140
 			sprintf(
141
-				__( 'The "%s" conditional tag can not be used until after the "init" hook has run, but works best when used within a theme\'s template files.','event_espresso'),
141
+				__('The "%s" conditional tag can not be used until after the "init" hook has run, but works best when used within a theme\'s template files.', 'event_espresso'),
142 142
 				$conditional_tag
143 143
 			),
144 144
 			'4.4.0'
@@ -153,13 +153,13 @@  discard block
 block discarded – undo
153 153
 
154 154
 /*************************** Event Queries ***************************/
155 155
 
156
-if ( ! function_exists( 'espresso_get_events' )) {
156
+if ( ! function_exists('espresso_get_events')) {
157 157
 	/**
158 158
 	 * 	espresso_get_events
159 159
 	 * @param array $params
160 160
 	 * @return array
161 161
 	 */
162
-	function espresso_get_events( $params = array() ) {
162
+	function espresso_get_events($params = array()) {
163 163
 		//set default params
164 164
 		$default_espresso_events_params = array(
165 165
 			'limit' => 10,
@@ -170,18 +170,18 @@  discard block
 block discarded – undo
170 170
 			'sort' => 'ASC'
171 171
 		);
172 172
 		// allow the defaults to be filtered
173
-		$default_espresso_events_params = apply_filters( 'espresso_get_events__default_espresso_events_params', $default_espresso_events_params );
173
+		$default_espresso_events_params = apply_filters('espresso_get_events__default_espresso_events_params', $default_espresso_events_params);
174 174
 		// grab params and merge with defaults, then extract
175
-		$params = array_merge( $default_espresso_events_params, $params );
175
+		$params = array_merge($default_espresso_events_params, $params);
176 176
 		// run the query
177
-		$events_query = new EventEspresso\core\domain\services\wp_queries\EventListQuery( $params );
177
+		$events_query = new EventEspresso\core\domain\services\wp_queries\EventListQuery($params);
178 178
 		// assign results to a variable so we can return it
179 179
 		$events = $events_query->have_posts() ? $events_query->posts : array();
180 180
 		// but first reset the query and postdata
181 181
 		wp_reset_query();
182 182
 		wp_reset_postdata();
183 183
 		EED_Events_Archive::remove_all_events_archive_filters();
184
-		unset( $events_query );
184
+		unset($events_query);
185 185
 		return $events;
186 186
 	}
187 187
 }
@@ -195,33 +195,33 @@  discard block
 block discarded – undo
195 195
  * espresso_load_ticket_selector
196 196
  */
197 197
 function espresso_load_ticket_selector() {
198
-	EE_Registry::instance()->load_file( EE_MODULES . 'ticket_selector', 'EED_Ticket_Selector', 'module' );
198
+	EE_Registry::instance()->load_file(EE_MODULES.'ticket_selector', 'EED_Ticket_Selector', 'module');
199 199
 }
200 200
 
201
-if ( ! function_exists( 'espresso_ticket_selector' )) {
201
+if ( ! function_exists('espresso_ticket_selector')) {
202 202
 	/**
203 203
 	 * espresso_ticket_selector
204 204
 	 * @param null $event
205 205
 	 */
206
-	function espresso_ticket_selector( $event = NULL ) {
207
-		if (  ! apply_filters( 'FHEE_disable_espresso_ticket_selector', FALSE ) ) {
206
+	function espresso_ticket_selector($event = NULL) {
207
+		if ( ! apply_filters('FHEE_disable_espresso_ticket_selector', FALSE)) {
208 208
 			espresso_load_ticket_selector();
209 209
             \EED_Ticket_Selector::set_definitions();
210
-			echo EED_Ticket_Selector::display_ticket_selector( $event );
210
+			echo EED_Ticket_Selector::display_ticket_selector($event);
211 211
 		}
212 212
 	}
213 213
 }
214 214
 
215 215
 
216
-	if ( ! function_exists( 'espresso_view_details_btn' )) {
216
+	if ( ! function_exists('espresso_view_details_btn')) {
217 217
 	/**
218 218
 	 * espresso_view_details_btn
219 219
 	 * @param null $event
220 220
 	 */
221
-	function espresso_view_details_btn( $event = NULL ) {
222
-		if (  ! apply_filters( 'FHEE_disable_espresso_view_details_btn', FALSE ) ) {
221
+	function espresso_view_details_btn($event = NULL) {
222
+		if ( ! apply_filters('FHEE_disable_espresso_view_details_btn', FALSE)) {
223 223
 			espresso_load_ticket_selector();
224
-			echo EED_Ticket_Selector::display_ticket_selector( $event, TRUE );
224
+			echo EED_Ticket_Selector::display_ticket_selector($event, TRUE);
225 225
 		}
226 226
 	}
227 227
 }
@@ -231,7 +231,7 @@  discard block
 block discarded – undo
231 231
 
232 232
 /*************************** EEH_Event_View ***************************/
233 233
 
234
-if ( ! function_exists( 'espresso_load_event_list_assets' )) {
234
+if ( ! function_exists('espresso_load_event_list_assets')) {
235 235
 	/**
236 236
 	 * espresso_load_event_list_assets
237 237
 	 * ensures that event list styles and scripts are loaded
@@ -240,13 +240,13 @@  discard block
 block discarded – undo
240 240
 	 */
241 241
 	function espresso_load_event_list_assets() {
242 242
 		$event_list = EED_Events_Archive::instance();
243
-		add_action( 'AHEE__EE_System__initialize_last', array( $event_list, 'load_event_list_assets' ), 10 );
244
-		add_filter( 'FHEE_enable_default_espresso_css', '__return_true' );
243
+		add_action('AHEE__EE_System__initialize_last', array($event_list, 'load_event_list_assets'), 10);
244
+		add_filter('FHEE_enable_default_espresso_css', '__return_true');
245 245
 	}
246 246
 }
247 247
 
248 248
 
249
-if ( ! function_exists( 'espresso_event_reg_button' )) {
249
+if ( ! function_exists('espresso_event_reg_button')) {
250 250
 	/**
251 251
 	 * espresso_event_reg_button
252 252
 	 * returns the "Register Now" button if event is active,
@@ -258,9 +258,9 @@  discard block
 block discarded – undo
258 258
 	 * @param bool $EVT_ID
259 259
 	 * @return string
260 260
 	 */
261
-	function espresso_event_reg_button( $btn_text_if_active = NULL, $btn_text_if_inactive = FALSE, $EVT_ID = FALSE ) {
262
-		$event_status = EEH_Event_View::event_active_status( $EVT_ID );
263
-		switch ( $event_status ) {
261
+	function espresso_event_reg_button($btn_text_if_active = NULL, $btn_text_if_inactive = FALSE, $EVT_ID = FALSE) {
262
+		$event_status = EEH_Event_View::event_active_status($EVT_ID);
263
+		switch ($event_status) {
264 264
 			case EE_Datetime::sold_out :
265 265
 				$btn_text = __('Sold Out', 'event_espresso');
266 266
 				$class = 'ee-pink';
@@ -276,10 +276,10 @@  discard block
 block discarded – undo
276 276
 			case EE_Datetime::upcoming :
277 277
 			case EE_Datetime::active :
278 278
 			default :
279
-				$btn_text =! empty( $btn_text_if_active ) ? $btn_text_if_active : __( 'Register Now', 'event_espresso' );
279
+				$btn_text = ! empty($btn_text_if_active) ? $btn_text_if_active : __('Register Now', 'event_espresso');
280 280
 				$class = 'ee-green';
281 281
 		}
282
-		if ( $event_status < 1 && ! empty( $btn_text_if_inactive )) {
282
+		if ($event_status < 1 && ! empty($btn_text_if_inactive)) {
283 283
 			$btn_text = $btn_text_if_inactive;
284 284
 			$class = 'ee-grey';
285 285
 		}
@@ -293,7 +293,7 @@  discard block
 block discarded – undo
293 293
 
294 294
 
295 295
 
296
-if ( ! function_exists( 'espresso_display_ticket_selector' )) {
296
+if ( ! function_exists('espresso_display_ticket_selector')) {
297 297
 	/**
298 298
 	 * espresso_display_ticket_selector
299 299
 	 * whether or not to display the Ticket Selector for an event
@@ -301,14 +301,14 @@  discard block
 block discarded – undo
301 301
 	 * @param bool $EVT_ID
302 302
 	 * @return boolean
303 303
 	 */
304
-	function espresso_display_ticket_selector( $EVT_ID = FALSE ) {
305
-		return EEH_Event_View::display_ticket_selector( $EVT_ID );
304
+	function espresso_display_ticket_selector($EVT_ID = FALSE) {
305
+		return EEH_Event_View::display_ticket_selector($EVT_ID);
306 306
 	}
307 307
 }
308 308
 
309 309
 
310 310
 
311
-if ( ! function_exists( 'espresso_event_status_banner' )) {
311
+if ( ! function_exists('espresso_event_status_banner')) {
312 312
 	/**
313 313
 	 * espresso_event_status
314 314
 	 * returns a banner showing the event status if it is sold out, expired, or inactive
@@ -316,13 +316,13 @@  discard block
 block discarded – undo
316 316
 	 * @param bool $EVT_ID
317 317
 	 * @return string
318 318
 	 */
319
-	function espresso_event_status_banner( $EVT_ID = FALSE ) {
320
-		return EEH_Event_View::event_status( $EVT_ID );
319
+	function espresso_event_status_banner($EVT_ID = FALSE) {
320
+		return EEH_Event_View::event_status($EVT_ID);
321 321
 	}
322 322
 }
323 323
 
324 324
 
325
-if ( ! function_exists( 'espresso_event_status' )) {
325
+if ( ! function_exists('espresso_event_status')) {
326 326
 	/**
327 327
 	 * espresso_event_status
328 328
 	 * returns the event status if it is sold out, expired, or inactive
@@ -331,13 +331,13 @@  discard block
 block discarded – undo
331 331
 	 * @param bool $echo
332 332
 	 * @return string
333 333
 	 */
334
-	function espresso_event_status( $EVT_ID = 0, $echo = TRUE ) {
335
-		return EEH_Event_View::event_active_status( $EVT_ID, $echo );
334
+	function espresso_event_status($EVT_ID = 0, $echo = TRUE) {
335
+		return EEH_Event_View::event_active_status($EVT_ID, $echo);
336 336
 	}
337 337
 }
338 338
 
339 339
 
340
-if ( ! function_exists( 'espresso_event_categories' )) {
340
+if ( ! function_exists('espresso_event_categories')) {
341 341
 	/**
342 342
 	 * espresso_event_categories
343 343
 	 * returns the terms associated with an event
@@ -347,17 +347,17 @@  discard block
 block discarded – undo
347 347
 	 * @param bool $echo
348 348
 	 * @return string
349 349
 	 */
350
-	function espresso_event_categories( $EVT_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE ) {
351
-		if ( $echo ) {
352
-			echo EEH_Event_View::event_categories( $EVT_ID, $hide_uncategorized );
350
+	function espresso_event_categories($EVT_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE) {
351
+		if ($echo) {
352
+			echo EEH_Event_View::event_categories($EVT_ID, $hide_uncategorized);
353 353
 			return '';
354 354
 		}
355
-		return EEH_Event_View::event_categories( $EVT_ID, $hide_uncategorized );
355
+		return EEH_Event_View::event_categories($EVT_ID, $hide_uncategorized);
356 356
 	}
357 357
 }
358 358
 
359 359
 
360
-if ( ! function_exists( 'espresso_event_tickets_available' )) {
360
+if ( ! function_exists('espresso_event_tickets_available')) {
361 361
 	/**
362 362
 	 * espresso_event_tickets_available
363 363
 	 * returns the ticket types available for purchase for an event
@@ -367,26 +367,26 @@  discard block
 block discarded – undo
367 367
 	 * @param bool $format
368 368
 	 * @return string
369 369
 	 */
370
-	function espresso_event_tickets_available( $EVT_ID = 0, $echo = TRUE, $format = TRUE ) {
371
-		$tickets = EEH_Event_View::event_tickets_available( $EVT_ID );
372
-		if ( is_array( $tickets ) && ! empty( $tickets )) {
370
+	function espresso_event_tickets_available($EVT_ID = 0, $echo = TRUE, $format = TRUE) {
371
+		$tickets = EEH_Event_View::event_tickets_available($EVT_ID);
372
+		if (is_array($tickets) && ! empty($tickets)) {
373 373
 			// if formatting then $html will be a string, else it will be an array of ticket objects
374
-			$html = $format ? '<ul id="ee-event-tickets-ul-' . $EVT_ID . '" class="ee-event-tickets-ul">' : array();
375
-			foreach ( $tickets as $ticket ) {
376
-				if ( $ticket instanceof EE_Ticket ) {
377
-					if ( $format ) {
378
-						$html .= '<li id="ee-event-tickets-li-' . $ticket->ID() . '" class="ee-event-tickets-li">';
379
-						$html .= $ticket->name() . ' ' . EEH_Template::format_currency( $ticket->get_ticket_total_with_taxes() );
374
+			$html = $format ? '<ul id="ee-event-tickets-ul-'.$EVT_ID.'" class="ee-event-tickets-ul">' : array();
375
+			foreach ($tickets as $ticket) {
376
+				if ($ticket instanceof EE_Ticket) {
377
+					if ($format) {
378
+						$html .= '<li id="ee-event-tickets-li-'.$ticket->ID().'" class="ee-event-tickets-li">';
379
+						$html .= $ticket->name().' '.EEH_Template::format_currency($ticket->get_ticket_total_with_taxes());
380 380
 						$html .= '</li>';
381 381
 					} else {
382 382
 						$html[] = $ticket;
383 383
 					}
384 384
 				}
385 385
 			}
386
-			if ( $format ) {
386
+			if ($format) {
387 387
 				$html .= '</ul>';
388 388
 			}
389
-			if ( $echo && $format ) {
389
+			if ($echo && $format) {
390 390
 				echo $html;
391 391
 				return '';
392 392
 			}
@@ -396,7 +396,7 @@  discard block
 block discarded – undo
396 396
 	}
397 397
 }
398 398
 
399
-if ( ! function_exists( 'espresso_event_date_obj' )) {
399
+if ( ! function_exists('espresso_event_date_obj')) {
400 400
 	/**
401 401
 	 * espresso_event_date_obj
402 402
 	 * returns the primary date object for an event
@@ -404,13 +404,13 @@  discard block
 block discarded – undo
404 404
 	 * @param bool $EVT_ID
405 405
 	 * @return object
406 406
 	 */
407
-	function espresso_event_date_obj( $EVT_ID = FALSE ) {
408
-		return EEH_Event_View::get_primary_date_obj( $EVT_ID );
407
+	function espresso_event_date_obj($EVT_ID = FALSE) {
408
+		return EEH_Event_View::get_primary_date_obj($EVT_ID);
409 409
 	}
410 410
 }
411 411
 
412 412
 
413
-if ( ! function_exists( 'espresso_event_date' )) {
413
+if ( ! function_exists('espresso_event_date')) {
414 414
 	/**
415 415
 	 * espresso_event_date
416 416
 	 * returns the primary date for an event
@@ -421,22 +421,22 @@  discard block
 block discarded – undo
421 421
 	 * @param bool $echo
422 422
 	 * @return string
423 423
 	 */
424
-	function espresso_event_date( $date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE ) {
425
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
426
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
427
-		$date_format = apply_filters( 'FHEE__espresso_event_date__date_format', $date_format );
428
-		$time_format = apply_filters( 'FHEE__espresso_event_date__time_format', $time_format );
429
-		if($echo){
430
-			echo EEH_Event_View::the_event_date( $date_format, $time_format, $EVT_ID );
424
+	function espresso_event_date($date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE) {
425
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
426
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
427
+		$date_format = apply_filters('FHEE__espresso_event_date__date_format', $date_format);
428
+		$time_format = apply_filters('FHEE__espresso_event_date__time_format', $time_format);
429
+		if ($echo) {
430
+			echo EEH_Event_View::the_event_date($date_format, $time_format, $EVT_ID);
431 431
 			return '';
432 432
 		}
433
-		return EEH_Event_View::the_event_date( $date_format, $time_format, $EVT_ID );
433
+		return EEH_Event_View::the_event_date($date_format, $time_format, $EVT_ID);
434 434
 
435 435
 	}
436 436
 }
437 437
 
438 438
 
439
-if ( ! function_exists( 'espresso_list_of_event_dates' )) {
439
+if ( ! function_exists('espresso_list_of_event_dates')) {
440 440
 	/**
441 441
 	 * espresso_list_of_event_dates
442 442
 	 * returns a unordered list of dates for an event
@@ -451,40 +451,40 @@  discard block
 block discarded – undo
451 451
 	 * @param null   $limit
452 452
 	 * @return string
453 453
 	 */
454
-	function espresso_list_of_event_dates( $EVT_ID = 0, $date_format = '', $time_format = '', $echo = TRUE, $show_expired = NULL, $format = TRUE, $add_breaks = TRUE, $limit = NULL ) {
455
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
456
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
457
-		$date_format = apply_filters( 'FHEE__espresso_list_of_event_dates__date_format', $date_format );
458
-		$time_format = apply_filters( 'FHEE__espresso_list_of_event_dates__time_format', $time_format );
459
-		$datetimes = EEH_Event_View::get_all_date_obj( $EVT_ID, $show_expired, FALSE, $limit );
460
-		if ( ! $format ) {
461
-			return apply_filters( 'FHEE__espresso_list_of_event_dates__datetimes', $datetimes );
454
+	function espresso_list_of_event_dates($EVT_ID = 0, $date_format = '', $time_format = '', $echo = TRUE, $show_expired = NULL, $format = TRUE, $add_breaks = TRUE, $limit = NULL) {
455
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
456
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
457
+		$date_format = apply_filters('FHEE__espresso_list_of_event_dates__date_format', $date_format);
458
+		$time_format = apply_filters('FHEE__espresso_list_of_event_dates__time_format', $time_format);
459
+		$datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, $show_expired, FALSE, $limit);
460
+		if ( ! $format) {
461
+			return apply_filters('FHEE__espresso_list_of_event_dates__datetimes', $datetimes);
462 462
 		}
463 463
 		//d( $datetimes );
464
-		if ( is_array( $datetimes ) && ! empty( $datetimes )) {
464
+		if (is_array($datetimes) && ! empty($datetimes)) {
465 465
 			global $post;
466
-			$html = $format ? '<ul id="ee-event-datetimes-ul-' . $post->ID . '" class="ee-event-datetimes-ul ee-clearfix">' : '';
467
-			foreach ( $datetimes as $datetime ) {
468
-				if ( $datetime instanceof EE_Datetime ) {
469
-					$html .= '<li id="ee-event-datetimes-li-' . $datetime->ID();
470
-					$html .= '" class="ee-event-datetimes-li ee-event-datetimes-li-' . $datetime->get_active_status() . '">';
466
+			$html = $format ? '<ul id="ee-event-datetimes-ul-'.$post->ID.'" class="ee-event-datetimes-ul ee-clearfix">' : '';
467
+			foreach ($datetimes as $datetime) {
468
+				if ($datetime instanceof EE_Datetime) {
469
+					$html .= '<li id="ee-event-datetimes-li-'.$datetime->ID();
470
+					$html .= '" class="ee-event-datetimes-li ee-event-datetimes-li-'.$datetime->get_active_status().'">';
471 471
 					$datetime_name = $datetime->name();
472
-					$html .= ! empty( $datetime_name ) ? '<strong>' . $datetime_name . '</strong>' : '';
473
-					$html .= ! empty( $datetime_name )  && $add_breaks ? '<br />' : '';
474
-					$html .= '<span class="dashicons dashicons-calendar"></span><span class="ee-event-datetimes-li-daterange">' . $datetime->date_range( $date_format ) . '</span><br/>';
475
-					$html .= '<span class="dashicons dashicons-clock"></span><span class="ee-event-datetimes-li-timerange">' . $datetime->time_range( $time_format ) . '</span>';
472
+					$html .= ! empty($datetime_name) ? '<strong>'.$datetime_name.'</strong>' : '';
473
+					$html .= ! empty($datetime_name) && $add_breaks ? '<br />' : '';
474
+					$html .= '<span class="dashicons dashicons-calendar"></span><span class="ee-event-datetimes-li-daterange">'.$datetime->date_range($date_format).'</span><br/>';
475
+					$html .= '<span class="dashicons dashicons-clock"></span><span class="ee-event-datetimes-li-timerange">'.$datetime->time_range($time_format).'</span>';
476 476
 					$datetime_description = $datetime->description();
477
-					$html .= ! empty( $datetime_description )  && $add_breaks ? '<br />' : '';
478
-					$html .= ! empty( $datetime_description ) ? ' - ' . $datetime_description : '';
479
-					$html = apply_filters( 'FHEE__espresso_list_of_event_dates__datetime_html', $html, $datetime );
477
+					$html .= ! empty($datetime_description) && $add_breaks ? '<br />' : '';
478
+					$html .= ! empty($datetime_description) ? ' - '.$datetime_description : '';
479
+					$html = apply_filters('FHEE__espresso_list_of_event_dates__datetime_html', $html, $datetime);
480 480
 					$html .= '</li>';
481 481
 				}
482 482
 			}
483 483
 			$html .= $format ? '</ul>' : '';
484 484
 		} else {
485
-			$html = $format ?  '<p><span class="dashicons dashicons-marker pink-text"></span>' . __( 'There are no upcoming dates for this event.', 'event_espresso' ) . '</p><br/>' : '';
485
+			$html = $format ? '<p><span class="dashicons dashicons-marker pink-text"></span>'.__('There are no upcoming dates for this event.', 'event_espresso').'</p><br/>' : '';
486 486
 		}
487
-		if ( $echo ) {
487
+		if ($echo) {
488 488
 			echo $html;
489 489
 			return '';
490 490
 		}
@@ -493,7 +493,7 @@  discard block
 block discarded – undo
493 493
 }
494 494
 
495 495
 
496
-if ( ! function_exists( 'espresso_event_end_date' )) {
496
+if ( ! function_exists('espresso_event_end_date')) {
497 497
 	/**
498 498
 	 * espresso_event_end_date
499 499
 	 * returns the last date for an event
@@ -504,20 +504,20 @@  discard block
 block discarded – undo
504 504
 	 * @param bool   $echo
505 505
 	 * @return string
506 506
 	 */
507
-	function espresso_event_end_date( $date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE ) {
508
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
509
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
510
-		$date_format = apply_filters( 'FHEE__espresso_event_end_date__date_format', $date_format );
511
-		$time_format = apply_filters( 'FHEE__espresso_event_end_date__time_format', $time_format );
512
-		if($echo){
513
-			echo EEH_Event_View::the_event_end_date( $date_format, $time_format, $EVT_ID );
507
+	function espresso_event_end_date($date_format = '', $time_format = '', $EVT_ID = FALSE, $echo = TRUE) {
508
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
509
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
510
+		$date_format = apply_filters('FHEE__espresso_event_end_date__date_format', $date_format);
511
+		$time_format = apply_filters('FHEE__espresso_event_end_date__time_format', $time_format);
512
+		if ($echo) {
513
+			echo EEH_Event_View::the_event_end_date($date_format, $time_format, $EVT_ID);
514 514
 			return '';
515 515
 		}
516
-		return EEH_Event_View::the_event_end_date( $date_format, $time_format, $EVT_ID );
516
+		return EEH_Event_View::the_event_end_date($date_format, $time_format, $EVT_ID);
517 517
 	}
518 518
 }
519 519
 
520
-if ( ! function_exists( 'espresso_event_date_range' )) {
520
+if ( ! function_exists('espresso_event_date_range')) {
521 521
 	/**
522 522
 	 * espresso_event_date_range
523 523
 	 * returns the first and last chronologically ordered dates for an event (if different)
@@ -530,31 +530,31 @@  discard block
 block discarded – undo
530 530
 	 * @param bool   $echo
531 531
 	 * @return string
532 532
 	 */
533
-	function espresso_event_date_range( $date_format = '', $time_format = '', $single_date_format = '', $single_time_format = '', $EVT_ID = FALSE, $echo = TRUE ) {
533
+	function espresso_event_date_range($date_format = '', $time_format = '', $single_date_format = '', $single_time_format = '', $EVT_ID = FALSE, $echo = TRUE) {
534 534
 		// set and filter date and time formats when a range is returned
535
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
536
-		$date_format = apply_filters( 'FHEE__espresso_event_date_range__date_format', $date_format );
535
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
536
+		$date_format = apply_filters('FHEE__espresso_event_date_range__date_format', $date_format);
537 537
 		// get the start and end date with NO time portion
538
-		$the_event_date = EEH_Event_View::the_earliest_event_date( $date_format, '', $EVT_ID );
539
-		$the_event_end_date = EEH_Event_View::the_latest_event_date( $date_format, '', $EVT_ID );
538
+		$the_event_date = EEH_Event_View::the_earliest_event_date($date_format, '', $EVT_ID);
539
+		$the_event_end_date = EEH_Event_View::the_latest_event_date($date_format, '', $EVT_ID);
540 540
 		// now we can determine if date range spans more than one day
541
-		if ( $the_event_date != $the_event_end_date ) {
542
-			$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
543
-			$time_format = apply_filters( 'FHEE__espresso_event_date_range__time_format', $time_format );
541
+		if ($the_event_date != $the_event_end_date) {
542
+			$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
543
+			$time_format = apply_filters('FHEE__espresso_event_date_range__time_format', $time_format);
544 544
 			$html = sprintf(
545
-				__( '%1$s - %2$s', 'event_espresso' ),
546
-				EEH_Event_View::the_earliest_event_date( $date_format, $time_format, $EVT_ID ),
547
-				EEH_Event_View::the_latest_event_date( $date_format, $time_format, $EVT_ID )
545
+				__('%1$s - %2$s', 'event_espresso'),
546
+				EEH_Event_View::the_earliest_event_date($date_format, $time_format, $EVT_ID),
547
+				EEH_Event_View::the_latest_event_date($date_format, $time_format, $EVT_ID)
548 548
 			);
549 549
 		} else {
550 550
 			// set and filter date and time formats when only a single datetime is returned
551
-			$single_date_format = ! empty( $single_date_format ) ? $single_date_format : get_option( 'date_format' );
552
-			$single_time_format = ! empty( $single_time_format ) ? $single_time_format : get_option( 'time_format' );
553
-			$single_date_format = apply_filters( 'FHEE__espresso_event_date_range__single_date_format', $single_date_format );
554
-			$single_time_format = apply_filters( 'FHEE__espresso_event_date_range__single_time_format', $single_time_format );
555
-			$html = EEH_Event_View::the_earliest_event_date( $single_date_format, $single_time_format, $EVT_ID );
551
+			$single_date_format = ! empty($single_date_format) ? $single_date_format : get_option('date_format');
552
+			$single_time_format = ! empty($single_time_format) ? $single_time_format : get_option('time_format');
553
+			$single_date_format = apply_filters('FHEE__espresso_event_date_range__single_date_format', $single_date_format);
554
+			$single_time_format = apply_filters('FHEE__espresso_event_date_range__single_time_format', $single_time_format);
555
+			$html = EEH_Event_View::the_earliest_event_date($single_date_format, $single_time_format, $EVT_ID);
556 556
 		}
557
-		if ( $echo ) {
557
+		if ($echo) {
558 558
 			echo $html;
559 559
 			return '';
560 560
 		}
@@ -562,7 +562,7 @@  discard block
 block discarded – undo
562 562
 	}
563 563
 }
564 564
 
565
-if ( ! function_exists( 'espresso_next_upcoming_datetime_obj' )) {
565
+if ( ! function_exists('espresso_next_upcoming_datetime_obj')) {
566 566
 	/**
567 567
 	 * espresso_next_upcoming_datetime_obj
568 568
 	 * returns the next upcoming datetime object for an event
@@ -570,12 +570,12 @@  discard block
 block discarded – undo
570 570
 	 * @param int $EVT_ID
571 571
 	 * @return EE_Datetime|null
572 572
 	 */
573
-	function espresso_next_upcoming_datetime_obj( $EVT_ID = 0 ) {
574
-		return EEH_Event_View::get_next_upcoming_date_obj( $EVT_ID );
573
+	function espresso_next_upcoming_datetime_obj($EVT_ID = 0) {
574
+		return EEH_Event_View::get_next_upcoming_date_obj($EVT_ID);
575 575
 	}
576 576
 }
577 577
 
578
-if ( ! function_exists( 'espresso_next_upcoming_datetime' ) ) {
578
+if ( ! function_exists('espresso_next_upcoming_datetime')) {
579 579
 	/**
580 580
 	 * espresso_next_upcoming_datetime
581 581
 	 * returns the start date and time for the next upcoming event.
@@ -586,30 +586,30 @@  discard block
 block discarded – undo
586 586
 	 * @param bool $echo
587 587
 	 * @return string
588 588
 	 */
589
-	function espresso_next_upcoming_datetime( $date_format = '', $time_format = '', $EVT_ID = 0, $echo = true ) {
589
+	function espresso_next_upcoming_datetime($date_format = '', $time_format = '', $EVT_ID = 0, $echo = true) {
590 590
 
591
-		$date_format = ! empty( $date_format ) ? $date_format : get_option( 'date_format' );
592
-		$date_format = apply_filters( 'FHEE__espresso_next_upcoming_datetime__date_format', $date_format );
591
+		$date_format = ! empty($date_format) ? $date_format : get_option('date_format');
592
+		$date_format = apply_filters('FHEE__espresso_next_upcoming_datetime__date_format', $date_format);
593 593
 
594
-		$time_format = ! empty( $time_format ) ? $time_format : get_option( 'time_format' );
595
-		$time_format = apply_filters( 'FHEE__espresso_next_upcoming_datetime__time_format', $time_format );
594
+		$time_format = ! empty($time_format) ? $time_format : get_option('time_format');
595
+		$time_format = apply_filters('FHEE__espresso_next_upcoming_datetime__time_format', $time_format);
596 596
 
597
-		$datetime_format = trim( $date_format . ' ' . $time_format);
597
+		$datetime_format = trim($date_format.' '.$time_format);
598 598
 
599
-		$datetime = espresso_next_upcoming_datetime_obj( $EVT_ID );
599
+		$datetime = espresso_next_upcoming_datetime_obj($EVT_ID);
600 600
 
601
-		if( ! $datetime instanceof EE_Datetime ) {
601
+		if ( ! $datetime instanceof EE_Datetime) {
602 602
 			return '';
603 603
 		}
604
-		if ( $echo ){
605
-			echo $datetime->get_i18n_datetime( 'DTT_EVT_start', $datetime_format );
604
+		if ($echo) {
605
+			echo $datetime->get_i18n_datetime('DTT_EVT_start', $datetime_format);
606 606
 			return '';
607 607
 		}
608
-		return $datetime->get_i18n_datetime( 'DTT_EVT_start', $datetime_format );
608
+		return $datetime->get_i18n_datetime('DTT_EVT_start', $datetime_format);
609 609
 	}
610 610
 }
611 611
 
612
-if ( ! function_exists( 'espresso_event_date_as_calendar_page' )) {
612
+if ( ! function_exists('espresso_event_date_as_calendar_page')) {
613 613
 	/**
614 614
 	 * espresso_event_date_as_calendar_page
615 615
 	 * returns the primary date for an event, stylized to appear as the page of a calendar
@@ -617,15 +617,15 @@  discard block
 block discarded – undo
617 617
 	 * @param bool $EVT_ID
618 618
 	 * @return string
619 619
 	 */
620
-	function espresso_event_date_as_calendar_page( $EVT_ID = FALSE ) {
621
-		EEH_Event_View::event_date_as_calendar_page( $EVT_ID );
620
+	function espresso_event_date_as_calendar_page($EVT_ID = FALSE) {
621
+		EEH_Event_View::event_date_as_calendar_page($EVT_ID);
622 622
 	}
623 623
 }
624 624
 
625 625
 
626 626
 
627 627
 
628
-if ( ! function_exists( 'espresso_event_link_url' )) {
628
+if ( ! function_exists('espresso_event_link_url')) {
629 629
 	/**
630 630
 	 * espresso_event_link_url
631 631
 	 *
@@ -633,18 +633,18 @@  discard block
 block discarded – undo
633 633
 	 * @param bool $echo
634 634
 	 * @return string
635 635
 	 */
636
-	function espresso_event_link_url( $EVT_ID = 0, $echo = TRUE ) {
637
-		if ( $echo ) {
638
-			echo EEH_Event_View::event_link_url( $EVT_ID );
636
+	function espresso_event_link_url($EVT_ID = 0, $echo = TRUE) {
637
+		if ($echo) {
638
+			echo EEH_Event_View::event_link_url($EVT_ID);
639 639
 			return '';
640 640
 		}
641
-		return EEH_Event_View::event_link_url( $EVT_ID );
641
+		return EEH_Event_View::event_link_url($EVT_ID);
642 642
 	}
643 643
 }
644 644
 
645 645
 
646 646
 
647
-if ( ! function_exists( 'espresso_event_has_content_or_excerpt' )) {
647
+if ( ! function_exists('espresso_event_has_content_or_excerpt')) {
648 648
 	/**
649 649
 	 *    espresso_event_has_content_or_excerpt
650 650
 	 *
@@ -652,15 +652,15 @@  discard block
 block discarded – undo
652 652
 	 * @param bool $EVT_ID
653 653
 	 * @return    boolean
654 654
 	 */
655
-	function espresso_event_has_content_or_excerpt( $EVT_ID = FALSE ) {
656
-		return EEH_Event_View::event_has_content_or_excerpt( $EVT_ID );
655
+	function espresso_event_has_content_or_excerpt($EVT_ID = FALSE) {
656
+		return EEH_Event_View::event_has_content_or_excerpt($EVT_ID);
657 657
 	}
658 658
 }
659 659
 
660 660
 
661 661
 
662 662
 
663
-if ( ! function_exists( 'espresso_event_content_or_excerpt' )) {
663
+if ( ! function_exists('espresso_event_content_or_excerpt')) {
664 664
 	/**
665 665
 	 * espresso_event_content_or_excerpt
666 666
 	 *
@@ -669,18 +669,18 @@  discard block
 block discarded – undo
669 669
 	 * @param bool $echo
670 670
 	 * @return string
671 671
 	 */
672
-	function espresso_event_content_or_excerpt( $num_words = 55, $more = NULL, $echo = TRUE ) {
673
-		if ( $echo ) {
674
-			echo EEH_Event_View::event_content_or_excerpt( $num_words, $more );
672
+	function espresso_event_content_or_excerpt($num_words = 55, $more = NULL, $echo = TRUE) {
673
+		if ($echo) {
674
+			echo EEH_Event_View::event_content_or_excerpt($num_words, $more);
675 675
 			return '';
676 676
 		}
677
-		return EEH_Event_View::event_content_or_excerpt( $num_words, $more );
677
+		return EEH_Event_View::event_content_or_excerpt($num_words, $more);
678 678
 	}
679 679
 }
680 680
 
681 681
 
682 682
 
683
-if ( ! function_exists( 'espresso_event_phone' )) {
683
+if ( ! function_exists('espresso_event_phone')) {
684 684
 	/**
685 685
 	 * espresso_event_phone
686 686
 	 *
@@ -688,18 +688,18 @@  discard block
 block discarded – undo
688 688
 	 * @param bool $echo
689 689
 	 * @return string
690 690
 	 */
691
-	function espresso_event_phone( $EVT_ID = 0, $echo = TRUE ) {
692
-		if ( $echo ) {
693
-			echo EEH_Event_View::event_phone( $EVT_ID );
691
+	function espresso_event_phone($EVT_ID = 0, $echo = TRUE) {
692
+		if ($echo) {
693
+			echo EEH_Event_View::event_phone($EVT_ID);
694 694
 			return '';
695 695
 		}
696
-		return EEH_Event_View::event_phone( $EVT_ID );
696
+		return EEH_Event_View::event_phone($EVT_ID);
697 697
 	}
698 698
 }
699 699
 
700 700
 
701 701
 
702
-if ( ! function_exists( 'espresso_edit_event_link' )) {
702
+if ( ! function_exists('espresso_edit_event_link')) {
703 703
 	/**
704 704
 	 * espresso_edit_event_link
705 705
 	 * returns a link to edit an event
@@ -708,39 +708,39 @@  discard block
 block discarded – undo
708 708
 	 * @param bool $echo
709 709
 	 * @return string
710 710
 	 */
711
-	function espresso_edit_event_link( $EVT_ID = 0, $echo = TRUE ) {
712
-		if ( $echo ) {
713
-			echo EEH_Event_View::edit_event_link( $EVT_ID );
711
+	function espresso_edit_event_link($EVT_ID = 0, $echo = TRUE) {
712
+		if ($echo) {
713
+			echo EEH_Event_View::edit_event_link($EVT_ID);
714 714
 			return '';
715 715
 		}
716
-		return EEH_Event_View::edit_event_link( $EVT_ID );
716
+		return EEH_Event_View::edit_event_link($EVT_ID);
717 717
 	}
718 718
 }
719 719
 
720 720
 
721
-if ( ! function_exists( 'espresso_organization_name' )) {
721
+if ( ! function_exists('espresso_organization_name')) {
722 722
 	/**
723 723
 	 * espresso_organization_name
724 724
 	 * @param bool $echo
725 725
 	 * @return string
726 726
 	 */
727 727
 	function espresso_organization_name($echo = TRUE) {
728
-		if($echo){
729
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'name' );
728
+		if ($echo) {
729
+			echo EE_Registry::instance()->CFG->organization->get_pretty('name');
730 730
 			return '';
731 731
 		}
732
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'name' );
732
+		return EE_Registry::instance()->CFG->organization->get_pretty('name');
733 733
 	}
734 734
 }
735 735
 
736
-if ( ! function_exists( 'espresso_organization_address' )) {
736
+if ( ! function_exists('espresso_organization_address')) {
737 737
 	/**
738 738
 	 * espresso_organization_address
739 739
 	 * @param string $type
740 740
 	 * @return string
741 741
 	 */
742
-	function espresso_organization_address( $type = 'inline' ) {
743
-		if ( EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config ) {
742
+	function espresso_organization_address($type = 'inline') {
743
+		if (EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config) {
744 744
 			$address = new EventEspresso\core\domain\entities\GenericAddress(
745 745
 				EE_Registry::instance()->CFG->organization->address_1,
746 746
 				EE_Registry::instance()->CFG->organization->address_2,
@@ -749,129 +749,129 @@  discard block
 block discarded – undo
749 749
 				EE_Registry::instance()->CFG->organization->zip,
750 750
 				EE_Registry::instance()->CFG->organization->CNT_ISO
751 751
 			);
752
-			return EEH_Address::format( $address, $type );
752
+			return EEH_Address::format($address, $type);
753 753
 		}
754 754
 		return '';
755 755
 	}
756 756
 }
757 757
 
758
-if ( ! function_exists( 'espresso_organization_email' )) {
758
+if ( ! function_exists('espresso_organization_email')) {
759 759
 	/**
760 760
 	 * espresso_organization_email
761 761
 	 * @param bool $echo
762 762
 	 * @return string
763 763
 	 */
764
-	function espresso_organization_email( $echo = TRUE ) {
765
-		if($echo){
766
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'email' );
764
+	function espresso_organization_email($echo = TRUE) {
765
+		if ($echo) {
766
+			echo EE_Registry::instance()->CFG->organization->get_pretty('email');
767 767
 			return '';
768 768
 		}
769
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'email' );
769
+		return EE_Registry::instance()->CFG->organization->get_pretty('email');
770 770
 	}
771 771
 }
772 772
 
773
-if ( ! function_exists( 'espresso_organization_logo_url' )) {
773
+if ( ! function_exists('espresso_organization_logo_url')) {
774 774
 	/**
775 775
 	 * espresso_organization_logo_url
776 776
 	 * @param bool $echo
777 777
 	 * @return string
778 778
 	 */
779
-	function espresso_organization_logo_url( $echo = TRUE ) {
780
-		if($echo){
781
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'logo_url' );
779
+	function espresso_organization_logo_url($echo = TRUE) {
780
+		if ($echo) {
781
+			echo EE_Registry::instance()->CFG->organization->get_pretty('logo_url');
782 782
 			return '';
783 783
 		}
784
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'logo_url' );
784
+		return EE_Registry::instance()->CFG->organization->get_pretty('logo_url');
785 785
 	}
786 786
 }
787 787
 
788
-if ( ! function_exists( 'espresso_organization_facebook' )) {
788
+if ( ! function_exists('espresso_organization_facebook')) {
789 789
 	/**
790 790
 	 * espresso_organization_facebook
791 791
 	 * @param bool $echo
792 792
 	 * @return string
793 793
 	 */
794
-	function espresso_organization_facebook( $echo = TRUE ) {
795
-		if($echo){
796
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'facebook' );
794
+	function espresso_organization_facebook($echo = TRUE) {
795
+		if ($echo) {
796
+			echo EE_Registry::instance()->CFG->organization->get_pretty('facebook');
797 797
 			return '';
798 798
 		}
799
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'facebook' );
799
+		return EE_Registry::instance()->CFG->organization->get_pretty('facebook');
800 800
 	}
801 801
 }
802 802
 
803
-if ( ! function_exists( 'espresso_organization_twitter' )) {
803
+if ( ! function_exists('espresso_organization_twitter')) {
804 804
 	/**
805 805
 	 * espresso_organization_twitter
806 806
 	 * @param bool $echo
807 807
 	 * @return string
808 808
 	 */
809
-	function espresso_organization_twitter( $echo = TRUE ) {
810
-		if($echo){
811
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'twitter' );
809
+	function espresso_organization_twitter($echo = TRUE) {
810
+		if ($echo) {
811
+			echo EE_Registry::instance()->CFG->organization->get_pretty('twitter');
812 812
 			return '';
813 813
 		}
814
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'twitter' );
814
+		return EE_Registry::instance()->CFG->organization->get_pretty('twitter');
815 815
 	}
816 816
 }
817 817
 
818
-if ( ! function_exists( 'espresso_organization_linkedin' )) {
818
+if ( ! function_exists('espresso_organization_linkedin')) {
819 819
 	/**
820 820
 	 * espresso_organization_linkedin
821 821
 	 * @param bool $echo
822 822
 	 * @return string
823 823
 	 */
824
-	function espresso_organization_linkedin( $echo = TRUE ) {
825
-		if($echo){
826
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'linkedin' );
824
+	function espresso_organization_linkedin($echo = TRUE) {
825
+		if ($echo) {
826
+			echo EE_Registry::instance()->CFG->organization->get_pretty('linkedin');
827 827
 			return '';
828 828
 		}
829
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'linkedin' );
829
+		return EE_Registry::instance()->CFG->organization->get_pretty('linkedin');
830 830
 	}
831 831
 }
832 832
 
833
-if ( ! function_exists( 'espresso_organization_pinterest' )) {
833
+if ( ! function_exists('espresso_organization_pinterest')) {
834 834
 	/**
835 835
 	 * espresso_organization_pinterest
836 836
 	 * @param bool $echo
837 837
 	 * @return string
838 838
 	 */
839
-	function espresso_organization_pinterest( $echo = TRUE ) {
840
-		if($echo){
841
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'pinterest' );
839
+	function espresso_organization_pinterest($echo = TRUE) {
840
+		if ($echo) {
841
+			echo EE_Registry::instance()->CFG->organization->get_pretty('pinterest');
842 842
 			return '';
843 843
 		}
844
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'pinterest' );
844
+		return EE_Registry::instance()->CFG->organization->get_pretty('pinterest');
845 845
 	}
846 846
 }
847 847
 
848
-if ( ! function_exists( 'espresso_organization_google' )) {
848
+if ( ! function_exists('espresso_organization_google')) {
849 849
 	/**
850 850
 	 * espresso_organization_google
851 851
 	 * @param bool $echo
852 852
 	 * @return string
853 853
 	 */
854
-	function espresso_organization_google( $echo = TRUE ) {
855
-		if($echo){
856
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'google' );
854
+	function espresso_organization_google($echo = TRUE) {
855
+		if ($echo) {
856
+			echo EE_Registry::instance()->CFG->organization->get_pretty('google');
857 857
 			return '';
858 858
 		}
859
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'google' );
859
+		return EE_Registry::instance()->CFG->organization->get_pretty('google');
860 860
 	}
861 861
 }
862 862
 
863
-if ( ! function_exists( 'espresso_organization_instagram' )) {
863
+if ( ! function_exists('espresso_organization_instagram')) {
864 864
 	/**
865 865
 	 * espresso_organization_instagram
866 866
 	 * @param bool $echo
867 867
 	 * @return string
868 868
 	 */
869
-	function espresso_organization_instagram( $echo = TRUE ) {
870
-		if($echo){
871
-			echo EE_Registry::instance()->CFG->organization->get_pretty( 'instagram' );
869
+	function espresso_organization_instagram($echo = TRUE) {
870
+		if ($echo) {
871
+			echo EE_Registry::instance()->CFG->organization->get_pretty('instagram');
872 872
 			return '';
873 873
 		}
874
-		return EE_Registry::instance()->CFG->organization->get_pretty( 'instagram' );
874
+		return EE_Registry::instance()->CFG->organization->get_pretty('instagram');
875 875
 	}
876 876
 }
877 877
 
@@ -881,7 +881,7 @@  discard block
 block discarded – undo
881 881
 
882 882
 
883 883
 
884
-if ( ! function_exists( 'espresso_event_venues' )) {
884
+if ( ! function_exists('espresso_event_venues')) {
885 885
 	/**
886 886
 	 * espresso_event_venues
887 887
 	 *
@@ -895,7 +895,7 @@  discard block
 block discarded – undo
895 895
 
896 896
 
897 897
 
898
-if ( ! function_exists( 'espresso_venue_id' )) {
898
+if ( ! function_exists('espresso_venue_id')) {
899 899
 	/**
900 900
 	 *    espresso_venue_name
901 901
 	 *
@@ -903,15 +903,15 @@  discard block
 block discarded – undo
903 903
 	 * @param     int $EVT_ID
904 904
 	 * @return    string
905 905
 	 */
906
-	function espresso_venue_id( $EVT_ID = 0 ) {
907
-		$venue = EEH_Venue_View::get_venue( $EVT_ID );
906
+	function espresso_venue_id($EVT_ID = 0) {
907
+		$venue = EEH_Venue_View::get_venue($EVT_ID);
908 908
 		return $venue instanceof EE_Venue ? $venue->ID() : 0;
909 909
 	}
910 910
 }
911 911
 
912 912
 
913 913
 
914
-if ( ! function_exists( 'espresso_is_venue_private' ) ) {
914
+if ( ! function_exists('espresso_is_venue_private')) {
915 915
 	/**
916 916
 	 * Return whether a venue is private or not.
917 917
 	 * @see EEH_Venue_View::get_venue() for more info on expected return results.
@@ -920,45 +920,45 @@  discard block
 block discarded – undo
920 920
 	 *
921 921
 	 * @return bool | null
922 922
 	 */
923
-	function espresso_is_venue_private( $VNU_ID = 0 ) {
924
-		return EEH_Venue_View::is_venue_private( $VNU_ID );
923
+	function espresso_is_venue_private($VNU_ID = 0) {
924
+		return EEH_Venue_View::is_venue_private($VNU_ID);
925 925
 	}
926 926
 }
927 927
 
928 928
 
929 929
 
930
-if ( ! function_exists( 'espresso_venue_is_password_protected' ) ) {
930
+if ( ! function_exists('espresso_venue_is_password_protected')) {
931 931
 	/**
932 932
 	 * returns true or false if a venue is password protected or not
933 933
 	 *
934 934
 	 * @param int     $VNU_ID optional, the venue id to check.
935 935
 	 * @return string
936 936
 	 */
937
-	function espresso_venue_is_password_protected( $VNU_ID = 0 ) {
938
-		EE_Registry::instance()->load_helper( 'Venue_View' );
939
-		return EEH_Venue_View::is_venue_password_protected( $VNU_ID );
937
+	function espresso_venue_is_password_protected($VNU_ID = 0) {
938
+		EE_Registry::instance()->load_helper('Venue_View');
939
+		return EEH_Venue_View::is_venue_password_protected($VNU_ID);
940 940
 	}
941 941
 }
942 942
 
943 943
 
944 944
 
945
-if ( ! function_exists( 'espresso_password_protected_venue_form' ) ) {
945
+if ( ! function_exists('espresso_password_protected_venue_form')) {
946 946
 	/**
947 947
 	 * Returns a password form if venue is password protected.
948 948
 	 *
949 949
 	 * @param int     $VNU_ID optional, the venue id to check.
950 950
 	 * @return string
951 951
 	 */
952
-	function espresso_password_protected_venue_form( $VNU_ID = 0 ) {
953
-		EE_Registry::instance()->load_helper( 'Venue_View' );
954
-		return EEH_Venue_View::password_protected_venue_form( $VNU_ID );
952
+	function espresso_password_protected_venue_form($VNU_ID = 0) {
953
+		EE_Registry::instance()->load_helper('Venue_View');
954
+		return EEH_Venue_View::password_protected_venue_form($VNU_ID);
955 955
 	}
956 956
 }
957 957
 
958 958
 
959 959
 
960 960
 
961
-if ( ! function_exists( 'espresso_venue_name' )) {
961
+if ( ! function_exists('espresso_venue_name')) {
962 962
 	/**
963 963
 	 *    espresso_venue_name
964 964
 	 *
@@ -968,19 +968,19 @@  discard block
 block discarded – undo
968 968
 	 * @param bool   $echo
969 969
 	 * @return    string
970 970
 	 */
971
-	function espresso_venue_name( $VNU_ID = 0, $link_to = 'details', $echo = TRUE ) {
972
-		if($echo){
973
-			echo EEH_Venue_View::venue_name( $link_to, $VNU_ID );
971
+	function espresso_venue_name($VNU_ID = 0, $link_to = 'details', $echo = TRUE) {
972
+		if ($echo) {
973
+			echo EEH_Venue_View::venue_name($link_to, $VNU_ID);
974 974
 			return '';
975 975
 		}
976
-		return EEH_Venue_View::venue_name( $link_to, $VNU_ID );
976
+		return EEH_Venue_View::venue_name($link_to, $VNU_ID);
977 977
 	}
978 978
 }
979 979
 
980 980
 
981 981
 
982 982
 
983
-if ( ! function_exists( 'espresso_venue_link' )) {
983
+if ( ! function_exists('espresso_venue_link')) {
984 984
 	/**
985 985
 	 * 	espresso_venue_link
986 986
 	 *
@@ -989,14 +989,14 @@  discard block
 block discarded – undo
989 989
 	 *  @param 	string 	$text
990 990
 	 *  @return 	string
991 991
 	 */
992
-	function espresso_venue_link( $VNU_ID = 0, $text = '' ) {
993
-		return EEH_Venue_View::venue_details_link( $VNU_ID, $text );
992
+	function espresso_venue_link($VNU_ID = 0, $text = '') {
993
+		return EEH_Venue_View::venue_details_link($VNU_ID, $text);
994 994
 	}
995 995
 }
996 996
 
997 997
 
998 998
 
999
-if ( ! function_exists( 'espresso_venue_description' )) {
999
+if ( ! function_exists('espresso_venue_description')) {
1000 1000
 	/**
1001 1001
 	 *    espresso_venue_description
1002 1002
 	 *
@@ -1005,17 +1005,17 @@  discard block
 block discarded – undo
1005 1005
 	 * @param bool $echo
1006 1006
 	 * @return    string
1007 1007
 	 */
1008
-	function espresso_venue_description( $VNU_ID = FALSE, $echo = TRUE ) {
1009
-		if($echo){
1010
-			echo EEH_Venue_View::venue_description( $VNU_ID );
1008
+	function espresso_venue_description($VNU_ID = FALSE, $echo = TRUE) {
1009
+		if ($echo) {
1010
+			echo EEH_Venue_View::venue_description($VNU_ID);
1011 1011
 			return '';
1012 1012
 		}
1013
-		return EEH_Venue_View::venue_description( $VNU_ID );
1013
+		return EEH_Venue_View::venue_description($VNU_ID);
1014 1014
 	}
1015 1015
 }
1016 1016
 
1017 1017
 
1018
-if ( ! function_exists( 'espresso_venue_excerpt' )) {
1018
+if ( ! function_exists('espresso_venue_excerpt')) {
1019 1019
 	/**
1020 1020
 	 *    espresso_venue_excerpt
1021 1021
 	 *
@@ -1024,18 +1024,18 @@  discard block
 block discarded – undo
1024 1024
 	 * @param bool $echo
1025 1025
 	 * @return    string
1026 1026
 	 */
1027
-	function espresso_venue_excerpt( $VNU_ID = 0,  $echo = TRUE ) {
1028
-		if ( $echo ) {
1029
-			echo EEH_Venue_View::venue_excerpt( $VNU_ID );
1027
+	function espresso_venue_excerpt($VNU_ID = 0, $echo = TRUE) {
1028
+		if ($echo) {
1029
+			echo EEH_Venue_View::venue_excerpt($VNU_ID);
1030 1030
 			return '';
1031 1031
 		}
1032
-		return EEH_Venue_View::venue_excerpt( $VNU_ID );
1032
+		return EEH_Venue_View::venue_excerpt($VNU_ID);
1033 1033
 	}
1034 1034
 }
1035 1035
 
1036 1036
 
1037 1037
 
1038
-if ( ! function_exists( 'espresso_venue_categories' )) {
1038
+if ( ! function_exists('espresso_venue_categories')) {
1039 1039
 	/**
1040 1040
 	 * espresso_venue_categories
1041 1041
 	 * returns the terms associated with a venue
@@ -1045,17 +1045,17 @@  discard block
 block discarded – undo
1045 1045
 	 * @param bool $echo
1046 1046
 	 * @return string
1047 1047
 	 */
1048
-	function espresso_venue_categories( $VNU_ID = 0, $hide_uncategorized = TRUE,  $echo = TRUE ) {
1049
-		if ( $echo ) {
1050
-			echo EEH_Venue_View::venue_categories( $VNU_ID, $hide_uncategorized );
1048
+	function espresso_venue_categories($VNU_ID = 0, $hide_uncategorized = TRUE, $echo = TRUE) {
1049
+		if ($echo) {
1050
+			echo EEH_Venue_View::venue_categories($VNU_ID, $hide_uncategorized);
1051 1051
 			return '';
1052 1052
 		}
1053
-		return EEH_Venue_View::venue_categories( $VNU_ID, $hide_uncategorized );
1053
+		return EEH_Venue_View::venue_categories($VNU_ID, $hide_uncategorized);
1054 1054
 	}
1055 1055
 }
1056 1056
 
1057 1057
 
1058
-if ( ! function_exists( 'espresso_venue_address' )) {
1058
+if ( ! function_exists('espresso_venue_address')) {
1059 1059
 	/**
1060 1060
 	 * espresso_venue_address
1061 1061
 	 * returns a formatted block of html  for displaying a venue's address
@@ -1065,17 +1065,17 @@  discard block
 block discarded – undo
1065 1065
 	 * @param bool   $echo
1066 1066
 	 * @return string
1067 1067
 	 */
1068
-	function espresso_venue_address( $type = 'multiline', $VNU_ID = 0, $echo = TRUE ) {
1069
-		if ( $echo ) {
1070
-			echo EEH_Venue_View::venue_address( $type, $VNU_ID );
1068
+	function espresso_venue_address($type = 'multiline', $VNU_ID = 0, $echo = TRUE) {
1069
+		if ($echo) {
1070
+			echo EEH_Venue_View::venue_address($type, $VNU_ID);
1071 1071
 			return '';
1072 1072
 		}
1073
-		return EEH_Venue_View::venue_address( $type, $VNU_ID );
1073
+		return EEH_Venue_View::venue_address($type, $VNU_ID);
1074 1074
 	}
1075 1075
 }
1076 1076
 
1077 1077
 
1078
-if ( ! function_exists( 'espresso_venue_raw_address' )) {
1078
+if ( ! function_exists('espresso_venue_raw_address')) {
1079 1079
 	/**
1080 1080
 	 * espresso_venue_address
1081 1081
 	 * returns an UN-formatted string containing a venue's address
@@ -1085,17 +1085,17 @@  discard block
 block discarded – undo
1085 1085
 	 * @param bool     $echo
1086 1086
 	 * @return string
1087 1087
 	 */
1088
-	function espresso_venue_raw_address( $type = 'multiline', $VNU_ID = 0, $echo = TRUE ) {
1089
-		if ( $echo ) {
1090
-			echo EEH_Venue_View::venue_address( $type, $VNU_ID, FALSE, FALSE );
1088
+	function espresso_venue_raw_address($type = 'multiline', $VNU_ID = 0, $echo = TRUE) {
1089
+		if ($echo) {
1090
+			echo EEH_Venue_View::venue_address($type, $VNU_ID, FALSE, FALSE);
1091 1091
 			return '';
1092 1092
 		}
1093
-		return EEH_Venue_View::venue_address( $type, $VNU_ID, FALSE, FALSE );
1093
+		return EEH_Venue_View::venue_address($type, $VNU_ID, FALSE, FALSE);
1094 1094
 	}
1095 1095
 }
1096 1096
 
1097 1097
 
1098
-if ( ! function_exists( 'espresso_venue_has_address' )) {
1098
+if ( ! function_exists('espresso_venue_has_address')) {
1099 1099
 	/**
1100 1100
 	 * espresso_venue_has_address
1101 1101
 	 * returns TRUE or FALSE if a Venue has address information
@@ -1103,13 +1103,13 @@  discard block
 block discarded – undo
1103 1103
 	 * @param int $VNU_ID
1104 1104
 	 * @return bool
1105 1105
 	 */
1106
-	function espresso_venue_has_address( $VNU_ID = 0 ) {
1107
-		return EEH_Venue_View::venue_has_address( $VNU_ID );
1106
+	function espresso_venue_has_address($VNU_ID = 0) {
1107
+		return EEH_Venue_View::venue_has_address($VNU_ID);
1108 1108
 	}
1109 1109
 }
1110 1110
 
1111 1111
 
1112
-if ( ! function_exists( 'espresso_venue_gmap' )) {
1112
+if ( ! function_exists('espresso_venue_gmap')) {
1113 1113
 	/**
1114 1114
 	 * espresso_venue_gmap
1115 1115
 	 * returns a google map for the venue address
@@ -1120,17 +1120,17 @@  discard block
 block discarded – undo
1120 1120
 	 * @param bool     $echo
1121 1121
 	 * @return string
1122 1122
 	 */
1123
-	function espresso_venue_gmap( $VNU_ID = 0, $map_ID = FALSE, $gmap = array(), $echo = TRUE  ) {
1124
-		if ( $echo ) {
1125
-			echo EEH_Venue_View::venue_gmap( $VNU_ID, $map_ID, $gmap );
1123
+	function espresso_venue_gmap($VNU_ID = 0, $map_ID = FALSE, $gmap = array(), $echo = TRUE) {
1124
+		if ($echo) {
1125
+			echo EEH_Venue_View::venue_gmap($VNU_ID, $map_ID, $gmap);
1126 1126
 			return '';
1127 1127
 		}
1128
-		return EEH_Venue_View::venue_gmap( $VNU_ID, $map_ID, $gmap );
1128
+		return EEH_Venue_View::venue_gmap($VNU_ID, $map_ID, $gmap);
1129 1129
 	}
1130 1130
 }
1131 1131
 
1132 1132
 
1133
-if ( ! function_exists( 'espresso_venue_phone' )) {
1133
+if ( ! function_exists('espresso_venue_phone')) {
1134 1134
 	/**
1135 1135
 	 * espresso_venue_phone
1136 1136
 	 *
@@ -1138,18 +1138,18 @@  discard block
 block discarded – undo
1138 1138
 	 * @param bool $echo
1139 1139
 	 * @return string
1140 1140
 	 */
1141
-	function espresso_venue_phone( $VNU_ID = 0, $echo = TRUE ) {
1142
-		if ( $echo ) {
1143
-			echo EEH_Venue_View::venue_phone( $VNU_ID );
1141
+	function espresso_venue_phone($VNU_ID = 0, $echo = TRUE) {
1142
+		if ($echo) {
1143
+			echo EEH_Venue_View::venue_phone($VNU_ID);
1144 1144
 			return '';
1145 1145
 		}
1146
-		return EEH_Venue_View::venue_phone( $VNU_ID );
1146
+		return EEH_Venue_View::venue_phone($VNU_ID);
1147 1147
 	}
1148 1148
 }
1149 1149
 
1150 1150
 
1151 1151
 
1152
-if ( ! function_exists( 'espresso_venue_website' )) {
1152
+if ( ! function_exists('espresso_venue_website')) {
1153 1153
 	/**
1154 1154
 	 * espresso_venue_website
1155 1155
 	 *
@@ -1157,18 +1157,18 @@  discard block
 block discarded – undo
1157 1157
 	 * @param bool $echo
1158 1158
 	 * @return string
1159 1159
 	 */
1160
-	function espresso_venue_website( $VNU_ID = 0, $echo = TRUE ) {
1161
-		if ( $echo ) {
1162
-			echo EEH_Venue_View::venue_website_link( $VNU_ID );
1160
+	function espresso_venue_website($VNU_ID = 0, $echo = TRUE) {
1161
+		if ($echo) {
1162
+			echo EEH_Venue_View::venue_website_link($VNU_ID);
1163 1163
 			return '';
1164 1164
 		}
1165
-		return EEH_Venue_View::venue_website_link( $VNU_ID );
1165
+		return EEH_Venue_View::venue_website_link($VNU_ID);
1166 1166
 	}
1167 1167
 }
1168 1168
 
1169 1169
 
1170 1170
 
1171
-if ( ! function_exists( 'espresso_edit_venue_link' )) {
1171
+if ( ! function_exists('espresso_edit_venue_link')) {
1172 1172
 	/**
1173 1173
 	 * espresso_edit_venue_link
1174 1174
 	 *
@@ -1176,12 +1176,12 @@  discard block
 block discarded – undo
1176 1176
 	 * @param bool $echo
1177 1177
 	 * @return string
1178 1178
 	 */
1179
-	function espresso_edit_venue_link( $VNU_ID = 0, $echo = TRUE ) {
1180
-		if($echo){
1181
-			echo EEH_Venue_View::edit_venue_link( $VNU_ID );
1179
+	function espresso_edit_venue_link($VNU_ID = 0, $echo = TRUE) {
1180
+		if ($echo) {
1181
+			echo EEH_Venue_View::edit_venue_link($VNU_ID);
1182 1182
 			return '';
1183 1183
 		}
1184
-		return EEH_Venue_View::edit_venue_link( $VNU_ID );
1184
+		return EEH_Venue_View::edit_venue_link($VNU_ID);
1185 1185
 	}
1186 1186
 }
1187 1187
 
Please login to merge, or discard this patch.
core/helpers/EEH_Event_View.helper.php 1 patch
Indentation   +569 added lines, -569 removed lines patch added patch discarded remove patch
@@ -11,578 +11,578 @@
 block discarded – undo
11 11
 class EEH_Event_View extends EEH_Base
12 12
 {
13 13
 
14
-    /**
15
-     * @var EE_Event $_event
16
-     */
17
-    private static $_event = null;
18
-
19
-
20
-
21
-    /**
22
-     * get_event
23
-     * attempts to retrieve an EE_Event object any way it can
24
-     *
25
-     * @param int|WP_Post $EVT_ID
26
-     * @return EE_Event|null
27
-     * @throws \EE_Error
28
-     */
29
-    public static function get_event($EVT_ID = 0)
30
-    {
31
-        // international newspaper?
32
-        global $post;
33
-        $EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
34
-            ? $EVT_ID->ID
35
-            : absint($EVT_ID);
36
-        // do we already have the Event  you are looking for?
37
-        if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
38
-            return EEH_Event_View::$_event;
39
-        }
40
-        // reset property so that the new event is cached.
41
-        EEH_Event_View::$_event = null;
42
-        if (! $EVT_ID && $post instanceof EE_Event) {
43
-            EEH_Event_View::$_event = $post;
44
-            return EEH_Event_View::$_event;
45
-        }
46
-        // if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
47
-        // then let's just use that cached event on the $post object.
48
-        if ($post instanceof WP_Post
49
-            && $post->post_type === 'espresso_events'
50
-            && isset($post->EE_Event)
51
-            && (
52
-                $EVT_ID === 0
53
-                || $EVT_ID === $post->ID
54
-            )
55
-        ) {
56
-            EEH_Event_View::$_event = $post->EE_Event;
57
-            return EEH_Event_View::$_event;
58
-        }
59
-        // If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
60
-        if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
61
-            EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
62
-        }
63
-        return EEH_Event_View::$_event;
64
-    }
65
-
66
-
67
-
68
-    /**
69
-     *    display_ticket_selector
70
-     *
71
-     * @access    public
72
-     * @param    int $EVT_ID
73
-     * @return    boolean
74
-     */
75
-    public static function display_ticket_selector($EVT_ID = 0)
76
-    {
77
-        $event = EEH_Event_View::get_event($EVT_ID);
78
-        return $event instanceof EE_Event ? $event->display_ticket_selector() : false;
79
-    }
80
-
81
-
82
-
83
-    /**
84
-     *    event_status
85
-     *
86
-     * @access    public
87
-     * @param    int $EVT_ID
88
-     * @return    string
89
-     */
90
-    public static function event_status($EVT_ID = 0)
91
-    {
92
-        $event = EEH_Event_View::get_event($EVT_ID);
93
-        return $event instanceof EE_Event ? $event->pretty_active_status(false) : '';
94
-    }
95
-
96
-
97
-
98
-    /**
99
-     *  event_active_status
100
-     *
101
-     *  @access     public
102
-     * @param    int $EVT_ID
103
-     *  @return     string
104
-     */
105
-    public static function event_active_status($EVT_ID = 0, $echo = true)
106
-    {
107
-        $event = EEH_Event_View::get_event($EVT_ID);
108
-        return $event instanceof EE_Event ? $event->pretty_active_status($echo) : 'inactive';
109
-    }
110
-
111
-
112
-
113
-    /**
114
-     *  event_has_content_or_excerpt
115
-     *
116
-     *  @access     public
117
-     * @param    int $EVT_ID
118
-     *  @return     string
119
-     */
120
-    public static function event_has_content_or_excerpt($EVT_ID = 0)
121
-    {
122
-        $event = EEH_Event_View::get_event($EVT_ID);
123
-        $has_content_or_excerpt = false;
124
-        if ($event instanceof EE_Event) {
125
-            $has_content_or_excerpt = $event->description() != '' || $event->short_description(null, null, true) != '' ? true : false;
126
-        }
127
-        if (is_archive() && ! ( espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list() )) {
128
-            $has_content_or_excerpt = false;
129
-        }
130
-        return $has_content_or_excerpt;
131
-    }
132
-
133
-
134
-
135
-    /**
136
-     *    event_active_status
137
-     *
138
-     * @access    public
139
-     * @param null $num_words
140
-     * @param null $more
141
-     * @return    string
142
-     */
143
-    public static function event_content_or_excerpt($num_words = null, $more = null)
144
-    {
145
-        global $post;
146
-        ob_start();
147
-        if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
148
-            // admin has chosen "full description"
149
-            // for the "Event Espresso - Events > Templates > Display Description" option
150
-            the_content();
151
-        } elseif (( is_archive() && espresso_display_excerpt_in_event_list() )) {
152
-            if (has_excerpt($post->ID)) {
153
-                // admin has chosen "excerpt (short desc)"
154
-                // for the "Event Espresso - Events > Templates > Display Description" option
155
-                // AND an excerpt actually exists
156
-                the_excerpt();
157
-            } else {
158
-                // admin has chosen "excerpt (short desc)"
159
-                // for the "Event Espresso - Events > Templates > Display Description" option
160
-                // but NO excerpt actually exists, so we need to create one
161
-                if (! empty($num_words)) {
162
-                    if (empty($more)) {
163
-                        $more_link_text = __('(more&hellip;)', 'event_espresso');
164
-                        $more = ' <a href="' . get_permalink() . '"';
165
-                        $more .= ' class="more-link"';
166
-                        $more .= \EED_Events_Archive::link_target();
167
-                        $more .= '>' . $more_link_text . '</a>';
168
-                        $more = apply_filters('the_content_more_link', $more, $more_link_text);
169
-                    }
170
-                    $content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
171
-
172
-                    $content =  wp_trim_words($content, $num_words, ' ') . $more;
173
-                } else {
174
-                    $content =  get_the_content();
175
-                }
176
-                global $allowedtags;
177
-                // make sure links are allowed
178
-                $allowedtags['a'] = isset($allowedtags['a'])
179
-                    ? $allowedtags['a']
180
-                    : array();
181
-                // as well as target attribute
182
-                $allowedtags['a']['target'] = isset($allowedtags['a']['target'])
183
-                    ? $allowedtags['a']['target']
184
-                    : false;
185
-                // but get previous value so we can reset it
186
-                $prev_value = $allowedtags['a']['target'];
187
-                $allowedtags['a']['target'] = true;
188
-                $content = wp_kses($content, $allowedtags);
189
-                $content = strip_shortcodes($content);
190
-                echo apply_filters('the_content', $content);
191
-                $allowedtags['a']['target'] = $prev_value;
192
-            }
193
-        } else {
194
-            // admin has chosen "none"
195
-            // for the "Event Espresso - Events > Templates > Display Description" option
196
-            echo apply_filters('the_content', '');
197
-        }
198
-        return ob_get_clean();
199
-    }
200
-
201
-
202
-
203
-    /**
204
-     *  event_tickets_available
205
-     *
206
-     *  @access     public
207
-     * @param    int $EVT_ID
208
-     *  @return     EE_Ticket[]
209
-     */
210
-    public static function event_tickets_available($EVT_ID = 0)
211
-    {
212
-        $event = EEH_Event_View::get_event($EVT_ID);
213
-        $tickets_available_for_purchase = array();
214
-        if ($event instanceof EE_Event) {
215
-            $datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, false);
216
-            foreach ($datetimes as $datetime) {
217
-                $tickets_available_for_purchase = array_merge($tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase());
218
-            }
219
-        }
220
-        return $tickets_available_for_purchase;
221
-    }
222
-
223
-
224
-
225
-    /**
226
-     *    the_event_date
227
-     *
228
-     * @access    public
229
-     * @param    int $EVT_ID
230
-     * @param     bool   $hide_uncategorized
231
-     * @return    string
232
-     */
233
-    public static function event_categories($EVT_ID = 0, $hide_uncategorized = true)
234
-    {
235
-        $category_links = array();
236
-        $event = EEH_Event_View::get_event($EVT_ID);
237
-        if ($event instanceof EE_Event) {
238
-            $event_categories = get_the_terms($event->ID(), 'espresso_event_categories');
239
-            if ($event_categories) {
240
-                // loop thru terms and create links
241
-                foreach ($event_categories as $term) {
242
-                    $url = get_term_link($term, 'espresso_venue_categories');
243
-                    if (! is_wp_error($url) && (( $hide_uncategorized && strtolower($term->name) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized )) {
244
-                        $category_links[] = '<a href="' . esc_url($url)
245
-                                            . '" rel="tag"'
246
-                                            . \EED_Events_Archive::link_target()
247
-                                            .'>'
248
-                                            . $term->name
249
-                                            . '</a>';
250
-                    }
251
-                }
252
-            }
253
-        }
254
-        return implode(', ', $category_links);
255
-    }
256
-
257
-
258
-
259
-    /**
260
-     *    the_event_date - first date by date order
261
-     *
262
-     * @access    public
263
-     * @param string $dt_frmt
264
-     * @param string $tm_frmt
265
-     * @param int    $EVT_ID
266
-     * @return    string
267
-     */
268
-    public static function the_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
269
-    {
270
-        $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
271
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
272
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) :  '';
273
-    }
274
-
275
-
276
-
277
-    /**
278
-     *    the_event_end_date - last date by date order
279
-     *
280
-     * @access    public
281
-     * @param string $dt_frmt
282
-     * @param string $tm_frmt
283
-     * @param int    $EVT_ID
284
-     * @return    string
285
-     */
286
-    public static function the_event_end_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
287
-    {
288
-        $datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
289
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
290
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
291
-    }
292
-
293
-
294
-
295
-    /**
296
-     *    the_earliest_event_date - first date chronologically
297
-     *
298
-     * @access    public
299
-     * @param string $dt_frmt
300
-     * @param string $tm_frmt
301
-     * @param int    $EVT_ID
302
-     * @return    string
303
-     */
304
-    public static function the_earliest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
305
-    {
306
-        $datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
307
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
308
-        return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
309
-    }
310
-
311
-
312
-
313
-    /**
314
-     *    the_latest_event_date - latest date chronologically
315
-     *
316
-     * @access    public
317
-     * @param string $dt_frmt
318
-     * @param string $tm_frmt
319
-     * @param int    $EVT_ID
320
-     * @return    string
321
-     */
322
-    public static function the_latest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
323
-    {
324
-        $datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
325
-        $format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
326
-        return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
327
-    }
328
-
329
-
330
-
331
-    /**
332
-     *    event_date_as_calendar_page
333
-     *
334
-     * @access    public
335
-     * @param int $EVT_ID
336
-     * @return    string
337
-     */
338
-    public static function event_date_as_calendar_page($EVT_ID = 0)
339
-    {
340
-        $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
341
-        if ($datetime instanceof EE_Datetime) {
342
-    ?>
14
+	/**
15
+	 * @var EE_Event $_event
16
+	 */
17
+	private static $_event = null;
18
+
19
+
20
+
21
+	/**
22
+	 * get_event
23
+	 * attempts to retrieve an EE_Event object any way it can
24
+	 *
25
+	 * @param int|WP_Post $EVT_ID
26
+	 * @return EE_Event|null
27
+	 * @throws \EE_Error
28
+	 */
29
+	public static function get_event($EVT_ID = 0)
30
+	{
31
+		// international newspaper?
32
+		global $post;
33
+		$EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
34
+			? $EVT_ID->ID
35
+			: absint($EVT_ID);
36
+		// do we already have the Event  you are looking for?
37
+		if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
38
+			return EEH_Event_View::$_event;
39
+		}
40
+		// reset property so that the new event is cached.
41
+		EEH_Event_View::$_event = null;
42
+		if (! $EVT_ID && $post instanceof EE_Event) {
43
+			EEH_Event_View::$_event = $post;
44
+			return EEH_Event_View::$_event;
45
+		}
46
+		// if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
47
+		// then let's just use that cached event on the $post object.
48
+		if ($post instanceof WP_Post
49
+			&& $post->post_type === 'espresso_events'
50
+			&& isset($post->EE_Event)
51
+			&& (
52
+				$EVT_ID === 0
53
+				|| $EVT_ID === $post->ID
54
+			)
55
+		) {
56
+			EEH_Event_View::$_event = $post->EE_Event;
57
+			return EEH_Event_View::$_event;
58
+		}
59
+		// If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
60
+		if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
61
+			EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
62
+		}
63
+		return EEH_Event_View::$_event;
64
+	}
65
+
66
+
67
+
68
+	/**
69
+	 *    display_ticket_selector
70
+	 *
71
+	 * @access    public
72
+	 * @param    int $EVT_ID
73
+	 * @return    boolean
74
+	 */
75
+	public static function display_ticket_selector($EVT_ID = 0)
76
+	{
77
+		$event = EEH_Event_View::get_event($EVT_ID);
78
+		return $event instanceof EE_Event ? $event->display_ticket_selector() : false;
79
+	}
80
+
81
+
82
+
83
+	/**
84
+	 *    event_status
85
+	 *
86
+	 * @access    public
87
+	 * @param    int $EVT_ID
88
+	 * @return    string
89
+	 */
90
+	public static function event_status($EVT_ID = 0)
91
+	{
92
+		$event = EEH_Event_View::get_event($EVT_ID);
93
+		return $event instanceof EE_Event ? $event->pretty_active_status(false) : '';
94
+	}
95
+
96
+
97
+
98
+	/**
99
+	 *  event_active_status
100
+	 *
101
+	 *  @access     public
102
+	 * @param    int $EVT_ID
103
+	 *  @return     string
104
+	 */
105
+	public static function event_active_status($EVT_ID = 0, $echo = true)
106
+	{
107
+		$event = EEH_Event_View::get_event($EVT_ID);
108
+		return $event instanceof EE_Event ? $event->pretty_active_status($echo) : 'inactive';
109
+	}
110
+
111
+
112
+
113
+	/**
114
+	 *  event_has_content_or_excerpt
115
+	 *
116
+	 *  @access     public
117
+	 * @param    int $EVT_ID
118
+	 *  @return     string
119
+	 */
120
+	public static function event_has_content_or_excerpt($EVT_ID = 0)
121
+	{
122
+		$event = EEH_Event_View::get_event($EVT_ID);
123
+		$has_content_or_excerpt = false;
124
+		if ($event instanceof EE_Event) {
125
+			$has_content_or_excerpt = $event->description() != '' || $event->short_description(null, null, true) != '' ? true : false;
126
+		}
127
+		if (is_archive() && ! ( espresso_display_full_description_in_event_list() || espresso_display_excerpt_in_event_list() )) {
128
+			$has_content_or_excerpt = false;
129
+		}
130
+		return $has_content_or_excerpt;
131
+	}
132
+
133
+
134
+
135
+	/**
136
+	 *    event_active_status
137
+	 *
138
+	 * @access    public
139
+	 * @param null $num_words
140
+	 * @param null $more
141
+	 * @return    string
142
+	 */
143
+	public static function event_content_or_excerpt($num_words = null, $more = null)
144
+	{
145
+		global $post;
146
+		ob_start();
147
+		if (( is_single() ) || ( is_archive() && espresso_display_full_description_in_event_list() )) {
148
+			// admin has chosen "full description"
149
+			// for the "Event Espresso - Events > Templates > Display Description" option
150
+			the_content();
151
+		} elseif (( is_archive() && espresso_display_excerpt_in_event_list() )) {
152
+			if (has_excerpt($post->ID)) {
153
+				// admin has chosen "excerpt (short desc)"
154
+				// for the "Event Espresso - Events > Templates > Display Description" option
155
+				// AND an excerpt actually exists
156
+				the_excerpt();
157
+			} else {
158
+				// admin has chosen "excerpt (short desc)"
159
+				// for the "Event Espresso - Events > Templates > Display Description" option
160
+				// but NO excerpt actually exists, so we need to create one
161
+				if (! empty($num_words)) {
162
+					if (empty($more)) {
163
+						$more_link_text = __('(more&hellip;)', 'event_espresso');
164
+						$more = ' <a href="' . get_permalink() . '"';
165
+						$more .= ' class="more-link"';
166
+						$more .= \EED_Events_Archive::link_target();
167
+						$more .= '>' . $more_link_text . '</a>';
168
+						$more = apply_filters('the_content_more_link', $more, $more_link_text);
169
+					}
170
+					$content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
171
+
172
+					$content =  wp_trim_words($content, $num_words, ' ') . $more;
173
+				} else {
174
+					$content =  get_the_content();
175
+				}
176
+				global $allowedtags;
177
+				// make sure links are allowed
178
+				$allowedtags['a'] = isset($allowedtags['a'])
179
+					? $allowedtags['a']
180
+					: array();
181
+				// as well as target attribute
182
+				$allowedtags['a']['target'] = isset($allowedtags['a']['target'])
183
+					? $allowedtags['a']['target']
184
+					: false;
185
+				// but get previous value so we can reset it
186
+				$prev_value = $allowedtags['a']['target'];
187
+				$allowedtags['a']['target'] = true;
188
+				$content = wp_kses($content, $allowedtags);
189
+				$content = strip_shortcodes($content);
190
+				echo apply_filters('the_content', $content);
191
+				$allowedtags['a']['target'] = $prev_value;
192
+			}
193
+		} else {
194
+			// admin has chosen "none"
195
+			// for the "Event Espresso - Events > Templates > Display Description" option
196
+			echo apply_filters('the_content', '');
197
+		}
198
+		return ob_get_clean();
199
+	}
200
+
201
+
202
+
203
+	/**
204
+	 *  event_tickets_available
205
+	 *
206
+	 *  @access     public
207
+	 * @param    int $EVT_ID
208
+	 *  @return     EE_Ticket[]
209
+	 */
210
+	public static function event_tickets_available($EVT_ID = 0)
211
+	{
212
+		$event = EEH_Event_View::get_event($EVT_ID);
213
+		$tickets_available_for_purchase = array();
214
+		if ($event instanceof EE_Event) {
215
+			$datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, false);
216
+			foreach ($datetimes as $datetime) {
217
+				$tickets_available_for_purchase = array_merge($tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase());
218
+			}
219
+		}
220
+		return $tickets_available_for_purchase;
221
+	}
222
+
223
+
224
+
225
+	/**
226
+	 *    the_event_date
227
+	 *
228
+	 * @access    public
229
+	 * @param    int $EVT_ID
230
+	 * @param     bool   $hide_uncategorized
231
+	 * @return    string
232
+	 */
233
+	public static function event_categories($EVT_ID = 0, $hide_uncategorized = true)
234
+	{
235
+		$category_links = array();
236
+		$event = EEH_Event_View::get_event($EVT_ID);
237
+		if ($event instanceof EE_Event) {
238
+			$event_categories = get_the_terms($event->ID(), 'espresso_event_categories');
239
+			if ($event_categories) {
240
+				// loop thru terms and create links
241
+				foreach ($event_categories as $term) {
242
+					$url = get_term_link($term, 'espresso_venue_categories');
243
+					if (! is_wp_error($url) && (( $hide_uncategorized && strtolower($term->name) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized )) {
244
+						$category_links[] = '<a href="' . esc_url($url)
245
+											. '" rel="tag"'
246
+											. \EED_Events_Archive::link_target()
247
+											.'>'
248
+											. $term->name
249
+											. '</a>';
250
+					}
251
+				}
252
+			}
253
+		}
254
+		return implode(', ', $category_links);
255
+	}
256
+
257
+
258
+
259
+	/**
260
+	 *    the_event_date - first date by date order
261
+	 *
262
+	 * @access    public
263
+	 * @param string $dt_frmt
264
+	 * @param string $tm_frmt
265
+	 * @param int    $EVT_ID
266
+	 * @return    string
267
+	 */
268
+	public static function the_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
269
+	{
270
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
271
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
272
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) :  '';
273
+	}
274
+
275
+
276
+
277
+	/**
278
+	 *    the_event_end_date - last date by date order
279
+	 *
280
+	 * @access    public
281
+	 * @param string $dt_frmt
282
+	 * @param string $tm_frmt
283
+	 * @param int    $EVT_ID
284
+	 * @return    string
285
+	 */
286
+	public static function the_event_end_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
287
+	{
288
+		$datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
289
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
290
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
291
+	}
292
+
293
+
294
+
295
+	/**
296
+	 *    the_earliest_event_date - first date chronologically
297
+	 *
298
+	 * @access    public
299
+	 * @param string $dt_frmt
300
+	 * @param string $tm_frmt
301
+	 * @param int    $EVT_ID
302
+	 * @return    string
303
+	 */
304
+	public static function the_earliest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
305
+	{
306
+		$datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
307
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
308
+		return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
309
+	}
310
+
311
+
312
+
313
+	/**
314
+	 *    the_latest_event_date - latest date chronologically
315
+	 *
316
+	 * @access    public
317
+	 * @param string $dt_frmt
318
+	 * @param string $tm_frmt
319
+	 * @param int    $EVT_ID
320
+	 * @return    string
321
+	 */
322
+	public static function the_latest_event_date($dt_frmt = 'D M jS', $tm_frmt = 'g:i a', $EVT_ID = 0)
323
+	{
324
+		$datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
325
+		$format = ! empty($dt_frmt) && ! empty($tm_frmt) ? $dt_frmt . ' ' . $tm_frmt : $dt_frmt . $tm_frmt;
326
+		return $datetime instanceof EE_Datetime ?  $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
327
+	}
328
+
329
+
330
+
331
+	/**
332
+	 *    event_date_as_calendar_page
333
+	 *
334
+	 * @access    public
335
+	 * @param int $EVT_ID
336
+	 * @return    string
337
+	 */
338
+	public static function event_date_as_calendar_page($EVT_ID = 0)
339
+	{
340
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
341
+		if ($datetime instanceof EE_Datetime) {
342
+	?>
343 343
         <div class="event-date-calendar-page-dv">
344 344
             <div class="event-date-calendar-page-month-dv"><?php echo $datetime->get_i18n_datetime('DTT_EVT_start', 'M');?></div>
345 345
             <div class="event-date-calendar-page-day-dv"><?php echo $datetime->start_date('d');?></div>
346 346
         </div>
347 347
     <?php
348
-        }
349
-    }
350
-
351
-
352
-
353
-    /**
354
-     *    get_primary_date_obj - orders date by DTT_order
355
-     *
356
-     * @access    public
357
-     * @param int $EVT_ID
358
-     * @return    string
359
-     */
360
-    public static function get_primary_date_obj($EVT_ID = 0)
361
-    {
362
-        $event = EEH_Event_View::get_event($EVT_ID);
363
-        if ($event instanceof EE_Event) {
364
-            $datetimes = $event->get_many_related(
365
-                'Datetime',
366
-                array(
367
-                    'limit' => 1,
368
-                    'order_by' => array( 'DTT_order' => 'ASC' )
369
-                )
370
-            );
371
-            return reset($datetimes);
372
-        } else {
373
-             return false;
374
-        }
375
-    }
376
-
377
-
378
-
379
-    /**
380
-     *    get_last_date_obj - orders date by DTT_order
381
-     *
382
-     * @access    public
383
-     * @param int $EVT_ID
384
-     * @return    string
385
-     */
386
-    public static function get_last_date_obj($EVT_ID = 0)
387
-    {
388
-        $event = EEH_Event_View::get_event($EVT_ID);
389
-        if ($event instanceof EE_Event) {
390
-            $datetimes = $event->get_many_related(
391
-                'Datetime',
392
-                array(
393
-                    'limit' => 1,
394
-                    'order_by' => array( 'DTT_order' => 'DESC' )
395
-                )
396
-            );
397
-            return end($datetimes);
398
-        } else {
399
-            return false;
400
-        }
401
-    }
402
-
403
-
404
-
405
-    /**
406
-     *    get_earliest_date_obj - orders date chronologically
407
-     *
408
-     * @access    public
409
-     * @param int $EVT_ID
410
-     * @return    string
411
-     */
412
-    public static function get_earliest_date_obj($EVT_ID = 0)
413
-    {
414
-        $event = EEH_Event_View::get_event($EVT_ID);
415
-        if ($event instanceof EE_Event) {
416
-            $datetimes = $event->get_many_related(
417
-                'Datetime',
418
-                array(
419
-                    'limit' => 1,
420
-                    'order_by' => array( 'DTT_EVT_start' => 'ASC' )
421
-                )
422
-            );
423
-            return reset($datetimes);
424
-        } else {
425
-             return false;
426
-        }
427
-    }
428
-
429
-
430
-
431
-    /**
432
-     *    get_latest_date_obj - orders date chronologically
433
-     *
434
-     * @access    public
435
-     * @param int $EVT_ID
436
-     * @return    string
437
-     */
438
-    public static function get_latest_date_obj($EVT_ID = 0)
439
-    {
440
-        $event = EEH_Event_View::get_event($EVT_ID);
441
-        if ($event instanceof EE_Event) {
442
-            $datetimes = $event->get_many_related(
443
-                'Datetime',
444
-                array(
445
-                    'limit' => 1,
446
-                    'order_by' => array( 'DTT_EVT_start' => 'DESC' )
447
-                )
448
-            );
449
-            return end($datetimes);
450
-        } else {
451
-            return false;
452
-        }
453
-    }
454
-
455
-    /**
456
-     *    get_next_upcoming_date_obj - return the next upcoming datetime
457
-     *
458
-     * @access    public
459
-     * @param int $EVT_ID
460
-     * @return    EE_Datetime|null
461
-     */
462
-    public static function get_next_upcoming_date_obj($EVT_ID = 0)
463
-    {
464
-        $datetime = EEM_Datetime::instance()->get_one(
465
-            array(
466
-                array(
467
-                    'Event.EVT_ID' => $EVT_ID,
468
-                    'DTT_EVT_start' => array('>=', current_time('mysql', true))
469
-                ),
470
-                'order_by' => array('DTT_EVT_start' => 'asc')
471
-            )
472
-        );
473
-        return $datetime instanceof EE_Datetime ? $datetime : null;
474
-    }
475
-
476
-    /**
477
-     *    get_all_date_obj
478
-     *
479
-     * @access    public
480
-     * @param int $EVT_ID
481
-     * @param null $include_expired
482
-     * @param bool $include_deleted
483
-     * @param null $limit
484
-     * @return EE_Datetime[]
485
-     */
486
-    public static function get_all_date_obj($EVT_ID = 0, $include_expired = null, $include_deleted = false, $limit = null)
487
-    {
488
-        $event = EEH_Event_View::get_event($EVT_ID);
489
-        if ($include_expired === null) {
490
-            if ($event instanceof EE_Event && $event->is_expired()) {
491
-                $include_expired = true;
492
-            } else {
493
-                $include_expired = false;
494
-            }
495
-        }
496
-
497
-        if ($event instanceof EE_Event) {
498
-            return $event->datetimes_ordered($include_expired, $include_deleted, $limit);
499
-        } else {
500
-             return array();
501
-        }
502
-    }
503
-
504
-
505
-
506
-    /**
507
-     *    event_link_url
508
-     *
509
-     * @access    public
510
-     * @param int $EVT_ID
511
-     * @return    string
512
-     */
513
-    public static function event_link_url($EVT_ID = 0)
514
-    {
515
-        $event = EEH_Event_View::get_event($EVT_ID);
516
-        if ($event instanceof EE_Event) {
517
-            $url = $event->external_url() !== null && $event->external_url() !== '' ? $event->external_url() : get_permalink($event->ID());
518
-            return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://' . $url;
519
-        }
520
-        return null;
521
-    }
522
-
523
-
524
-
525
-    /**
526
-     *    event_phone
527
-     *
528
-     * @access    public
529
-     * @param int $EVT_ID
530
-     * @return    string
531
-     */
532
-    public static function event_phone($EVT_ID = 0)
533
-    {
534
-        $event = EEH_Event_View::get_event($EVT_ID);
535
-        if ($event instanceof EE_Event) {
536
-            return EEH_Schema::telephone($event->phone());
537
-        }
538
-        return null;
539
-    }
540
-
541
-
542
-
543
-    /**
544
-     *    edit_event_link
545
-     *
546
-     * @access    public
547
-     * @param int    $EVT_ID
548
-     * @param string $link
549
-     * @param string $before
550
-     * @param string $after
551
-     * @return    string
552
-     */
553
-    public static function edit_event_link($EVT_ID = 0, $link = '', $before = '', $after = '')
554
-    {
555
-        $event = EEH_Event_View::get_event($EVT_ID);
556
-        if ($event instanceof EE_Event) {
557
-            // can the user edit this post ?
558
-            if (current_user_can('edit_post', $event->ID())) {
559
-                // set link text
560
-                $link_text = ! empty($link) ? $link : __('edit this event', 'event_espresso');
561
-                // generate nonce
562
-                $nonce = wp_create_nonce('edit_nonce');
563
-                // generate url to event editor for this event
564
-                $url = add_query_arg(array( 'page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce ), admin_url());
565
-                // get edit CPT text
566
-                $post_type_obj = get_post_type_object('espresso_events');
567
-                // build final link html
568
-                $link = '<a class="post-edit-link" href="' . $url . '" ';
569
-                $link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
570
-                $link .= \EED_Events_Archive::link_target();
571
-                $link .='>' . $link_text . '</a>';
572
-                // put it all together
573
-                return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
574
-            }
575
-        }
576
-        return '';
577
-    }
578
-
579
-
580
-
581
-    /**
582
-     * @return string
583
-     */
584
-    public static function event_archive_url()
585
-    {
586
-        return get_post_type_archive_link('espresso_events');
587
-    }
348
+		}
349
+	}
350
+
351
+
352
+
353
+	/**
354
+	 *    get_primary_date_obj - orders date by DTT_order
355
+	 *
356
+	 * @access    public
357
+	 * @param int $EVT_ID
358
+	 * @return    string
359
+	 */
360
+	public static function get_primary_date_obj($EVT_ID = 0)
361
+	{
362
+		$event = EEH_Event_View::get_event($EVT_ID);
363
+		if ($event instanceof EE_Event) {
364
+			$datetimes = $event->get_many_related(
365
+				'Datetime',
366
+				array(
367
+					'limit' => 1,
368
+					'order_by' => array( 'DTT_order' => 'ASC' )
369
+				)
370
+			);
371
+			return reset($datetimes);
372
+		} else {
373
+			 return false;
374
+		}
375
+	}
376
+
377
+
378
+
379
+	/**
380
+	 *    get_last_date_obj - orders date by DTT_order
381
+	 *
382
+	 * @access    public
383
+	 * @param int $EVT_ID
384
+	 * @return    string
385
+	 */
386
+	public static function get_last_date_obj($EVT_ID = 0)
387
+	{
388
+		$event = EEH_Event_View::get_event($EVT_ID);
389
+		if ($event instanceof EE_Event) {
390
+			$datetimes = $event->get_many_related(
391
+				'Datetime',
392
+				array(
393
+					'limit' => 1,
394
+					'order_by' => array( 'DTT_order' => 'DESC' )
395
+				)
396
+			);
397
+			return end($datetimes);
398
+		} else {
399
+			return false;
400
+		}
401
+	}
402
+
403
+
404
+
405
+	/**
406
+	 *    get_earliest_date_obj - orders date chronologically
407
+	 *
408
+	 * @access    public
409
+	 * @param int $EVT_ID
410
+	 * @return    string
411
+	 */
412
+	public static function get_earliest_date_obj($EVT_ID = 0)
413
+	{
414
+		$event = EEH_Event_View::get_event($EVT_ID);
415
+		if ($event instanceof EE_Event) {
416
+			$datetimes = $event->get_many_related(
417
+				'Datetime',
418
+				array(
419
+					'limit' => 1,
420
+					'order_by' => array( 'DTT_EVT_start' => 'ASC' )
421
+				)
422
+			);
423
+			return reset($datetimes);
424
+		} else {
425
+			 return false;
426
+		}
427
+	}
428
+
429
+
430
+
431
+	/**
432
+	 *    get_latest_date_obj - orders date chronologically
433
+	 *
434
+	 * @access    public
435
+	 * @param int $EVT_ID
436
+	 * @return    string
437
+	 */
438
+	public static function get_latest_date_obj($EVT_ID = 0)
439
+	{
440
+		$event = EEH_Event_View::get_event($EVT_ID);
441
+		if ($event instanceof EE_Event) {
442
+			$datetimes = $event->get_many_related(
443
+				'Datetime',
444
+				array(
445
+					'limit' => 1,
446
+					'order_by' => array( 'DTT_EVT_start' => 'DESC' )
447
+				)
448
+			);
449
+			return end($datetimes);
450
+		} else {
451
+			return false;
452
+		}
453
+	}
454
+
455
+	/**
456
+	 *    get_next_upcoming_date_obj - return the next upcoming datetime
457
+	 *
458
+	 * @access    public
459
+	 * @param int $EVT_ID
460
+	 * @return    EE_Datetime|null
461
+	 */
462
+	public static function get_next_upcoming_date_obj($EVT_ID = 0)
463
+	{
464
+		$datetime = EEM_Datetime::instance()->get_one(
465
+			array(
466
+				array(
467
+					'Event.EVT_ID' => $EVT_ID,
468
+					'DTT_EVT_start' => array('>=', current_time('mysql', true))
469
+				),
470
+				'order_by' => array('DTT_EVT_start' => 'asc')
471
+			)
472
+		);
473
+		return $datetime instanceof EE_Datetime ? $datetime : null;
474
+	}
475
+
476
+	/**
477
+	 *    get_all_date_obj
478
+	 *
479
+	 * @access    public
480
+	 * @param int $EVT_ID
481
+	 * @param null $include_expired
482
+	 * @param bool $include_deleted
483
+	 * @param null $limit
484
+	 * @return EE_Datetime[]
485
+	 */
486
+	public static function get_all_date_obj($EVT_ID = 0, $include_expired = null, $include_deleted = false, $limit = null)
487
+	{
488
+		$event = EEH_Event_View::get_event($EVT_ID);
489
+		if ($include_expired === null) {
490
+			if ($event instanceof EE_Event && $event->is_expired()) {
491
+				$include_expired = true;
492
+			} else {
493
+				$include_expired = false;
494
+			}
495
+		}
496
+
497
+		if ($event instanceof EE_Event) {
498
+			return $event->datetimes_ordered($include_expired, $include_deleted, $limit);
499
+		} else {
500
+			 return array();
501
+		}
502
+	}
503
+
504
+
505
+
506
+	/**
507
+	 *    event_link_url
508
+	 *
509
+	 * @access    public
510
+	 * @param int $EVT_ID
511
+	 * @return    string
512
+	 */
513
+	public static function event_link_url($EVT_ID = 0)
514
+	{
515
+		$event = EEH_Event_View::get_event($EVT_ID);
516
+		if ($event instanceof EE_Event) {
517
+			$url = $event->external_url() !== null && $event->external_url() !== '' ? $event->external_url() : get_permalink($event->ID());
518
+			return preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'http://' . $url;
519
+		}
520
+		return null;
521
+	}
522
+
523
+
524
+
525
+	/**
526
+	 *    event_phone
527
+	 *
528
+	 * @access    public
529
+	 * @param int $EVT_ID
530
+	 * @return    string
531
+	 */
532
+	public static function event_phone($EVT_ID = 0)
533
+	{
534
+		$event = EEH_Event_View::get_event($EVT_ID);
535
+		if ($event instanceof EE_Event) {
536
+			return EEH_Schema::telephone($event->phone());
537
+		}
538
+		return null;
539
+	}
540
+
541
+
542
+
543
+	/**
544
+	 *    edit_event_link
545
+	 *
546
+	 * @access    public
547
+	 * @param int    $EVT_ID
548
+	 * @param string $link
549
+	 * @param string $before
550
+	 * @param string $after
551
+	 * @return    string
552
+	 */
553
+	public static function edit_event_link($EVT_ID = 0, $link = '', $before = '', $after = '')
554
+	{
555
+		$event = EEH_Event_View::get_event($EVT_ID);
556
+		if ($event instanceof EE_Event) {
557
+			// can the user edit this post ?
558
+			if (current_user_can('edit_post', $event->ID())) {
559
+				// set link text
560
+				$link_text = ! empty($link) ? $link : __('edit this event', 'event_espresso');
561
+				// generate nonce
562
+				$nonce = wp_create_nonce('edit_nonce');
563
+				// generate url to event editor for this event
564
+				$url = add_query_arg(array( 'page' => 'espresso_events', 'action' => 'edit', 'post' => $event->ID(), 'edit_nonce' => $nonce ), admin_url());
565
+				// get edit CPT text
566
+				$post_type_obj = get_post_type_object('espresso_events');
567
+				// build final link html
568
+				$link = '<a class="post-edit-link" href="' . $url . '" ';
569
+				$link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
570
+				$link .= \EED_Events_Archive::link_target();
571
+				$link .='>' . $link_text . '</a>';
572
+				// put it all together
573
+				return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
574
+			}
575
+		}
576
+		return '';
577
+	}
578
+
579
+
580
+
581
+	/**
582
+	 * @return string
583
+	 */
584
+	public static function event_archive_url()
585
+	{
586
+		return get_post_type_archive_link('espresso_events');
587
+	}
588 588
 }
Please login to merge, or discard this patch.
core/domain/services/custom_post_types/RegisterCustomPostTypes.php 1 patch
Indentation   +295 added lines, -295 removed lines patch added patch discarded remove patch
@@ -18,314 +18,314 @@
 block discarded – undo
18 18
 class RegisterCustomPostTypes
19 19
 {
20 20
 
21
-    /**
22
-     * @var CustomPostTypeDefinitions $custom_post_types
23
-     */
24
-    public $custom_post_types;
21
+	/**
22
+	 * @var CustomPostTypeDefinitions $custom_post_types
23
+	 */
24
+	public $custom_post_types;
25 25
 
26
-    /**
27
-     * @var WP_Post_Type[] $wp_post_types
28
-     */
29
-    public $wp_post_types = array();
26
+	/**
27
+	 * @var WP_Post_Type[] $wp_post_types
28
+	 */
29
+	public $wp_post_types = array();
30 30
 
31 31
 
32
-    /**
33
-     * RegisterCustomPostTypes constructor.
34
-     *
35
-     * @param CustomPostTypeDefinitions $custom_post_types
36
-     */
37
-    public function __construct(CustomPostTypeDefinitions $custom_post_types)
38
-    {
39
-        $this->custom_post_types = $custom_post_types;
40
-    }
32
+	/**
33
+	 * RegisterCustomPostTypes constructor.
34
+	 *
35
+	 * @param CustomPostTypeDefinitions $custom_post_types
36
+	 */
37
+	public function __construct(CustomPostTypeDefinitions $custom_post_types)
38
+	{
39
+		$this->custom_post_types = $custom_post_types;
40
+	}
41 41
 
42 42
 
43
-    /**
44
-     * @return WP_Post_Type[]
45
-     */
46
-    public function getRegisteredCustomPostTypes()
47
-    {
48
-        return $this->wp_post_types;
49
-    }
43
+	/**
44
+	 * @return WP_Post_Type[]
45
+	 */
46
+	public function getRegisteredCustomPostTypes()
47
+	{
48
+		return $this->wp_post_types;
49
+	}
50 50
 
51 51
 
52
-    /**
53
-     * @return void
54
-     * @throws DomainException
55
-     */
56
-    public function registerCustomPostTypes()
57
-    {
58
-        $custom_post_types = $this->custom_post_types->getDefinitions();
59
-        foreach ($custom_post_types as $custom_post_type => $CPT) {
60
-            $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
61
-                $custom_post_type,
62
-                $CPT['singular_name'],
63
-                $CPT['plural_name'],
64
-                $CPT['singular_slug'],
65
-                $CPT['plural_slug'],
66
-                $CPT['args']
67
-            );
68
-        }
69
-    }
52
+	/**
53
+	 * @return void
54
+	 * @throws DomainException
55
+	 */
56
+	public function registerCustomPostTypes()
57
+	{
58
+		$custom_post_types = $this->custom_post_types->getDefinitions();
59
+		foreach ($custom_post_types as $custom_post_type => $CPT) {
60
+			$this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
61
+				$custom_post_type,
62
+				$CPT['singular_name'],
63
+				$CPT['plural_name'],
64
+				$CPT['singular_slug'],
65
+				$CPT['plural_slug'],
66
+				$CPT['args']
67
+			);
68
+		}
69
+	}
70 70
 
71 71
 
72
-    /**
73
-     * Registers a new custom post type. Sets default settings given only the following params.
74
-     * Returns the registered post type object, or an error object.
75
-     *
76
-     * @param string $post_type          the actual post type name
77
-     *                                   IMPORTANT:
78
-     *                                   this must match what the slug is for admin pages related to this CPT
79
-     *                                   Also any models must use this slug as well
80
-     * @param string $singular_name      a pre-internationalized string for the singular name of the objects
81
-     * @param string $plural_name        a pre-internationalized string for the plural name of the objects
82
-     * @param string $singular_slug
83
-     * @param string $plural_slug
84
-     * @param array  $override_arguments exactly like $args as described in
85
-     *                                   http://codex.wordpress.org/Function_Reference/register_post_type
86
-     * @return WP_Post_Type|WP_Error
87
-     * @throws DomainException
88
-     */
89
-    public function registerCustomPostType(
90
-        $post_type,
91
-        $singular_name,
92
-        $plural_name,
93
-        $singular_slug = '',
94
-        $plural_slug = '',
95
-        array $override_arguments = array()
96
-    ) {
97
-        $wp_post_type = register_post_type(
98
-            $post_type,
99
-            $this->prepareArguments(
100
-                $post_type,
101
-                $singular_name,
102
-                $plural_name,
103
-                $singular_slug,
104
-                $plural_slug,
105
-                $override_arguments
106
-            )
107
-        );
108
-        if ($wp_post_type instanceof WP_Error) {
109
-            throw new DomainException($wp_post_type->get_error_message());
110
-        }
111
-        return $wp_post_type;
112
-    }
72
+	/**
73
+	 * Registers a new custom post type. Sets default settings given only the following params.
74
+	 * Returns the registered post type object, or an error object.
75
+	 *
76
+	 * @param string $post_type          the actual post type name
77
+	 *                                   IMPORTANT:
78
+	 *                                   this must match what the slug is for admin pages related to this CPT
79
+	 *                                   Also any models must use this slug as well
80
+	 * @param string $singular_name      a pre-internationalized string for the singular name of the objects
81
+	 * @param string $plural_name        a pre-internationalized string for the plural name of the objects
82
+	 * @param string $singular_slug
83
+	 * @param string $plural_slug
84
+	 * @param array  $override_arguments exactly like $args as described in
85
+	 *                                   http://codex.wordpress.org/Function_Reference/register_post_type
86
+	 * @return WP_Post_Type|WP_Error
87
+	 * @throws DomainException
88
+	 */
89
+	public function registerCustomPostType(
90
+		$post_type,
91
+		$singular_name,
92
+		$plural_name,
93
+		$singular_slug = '',
94
+		$plural_slug = '',
95
+		array $override_arguments = array()
96
+	) {
97
+		$wp_post_type = register_post_type(
98
+			$post_type,
99
+			$this->prepareArguments(
100
+				$post_type,
101
+				$singular_name,
102
+				$plural_name,
103
+				$singular_slug,
104
+				$plural_slug,
105
+				$override_arguments
106
+			)
107
+		);
108
+		if ($wp_post_type instanceof WP_Error) {
109
+			throw new DomainException($wp_post_type->get_error_message());
110
+		}
111
+		return $wp_post_type;
112
+	}
113 113
 
114 114
 
115
-    /**
116
-     * @param string $post_type          the actual post type name
117
-     * @param string $singular_name      a pre-internationalized string for the singular name of the objects
118
-     * @param string $plural_name        a pre-internationalized string for the plural name of the objects
119
-     * @param string $singular_slug
120
-     * @param string $plural_slug
121
-     * @param array  $override_arguments The default values set in this function will be overridden
122
-     *                                   by whatever you set in $override_arguments
123
-     * @return array
124
-     */
125
-    protected function prepareArguments(
126
-        $post_type,
127
-        $singular_name,
128
-        $plural_name,
129
-        $singular_slug,
130
-        $plural_slug,
131
-        array $override_arguments = array()
132
-    ) {
133
-        // verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name
134
-        $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name;
135
-        $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name;
136
-        $labels = $this->getLabels(
137
-            $singular_name,
138
-            $plural_name,
139
-            $singular_slug,
140
-            $plural_slug
141
-        );
142
-        // note the page_templates arg in the supports index is something specific to EE.
143
-        // WordPress doesn't actually have that in their register_post_type api.
144
-        $arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug);
145
-        if ($override_arguments) {
146
-            if (isset($override_arguments['labels'])) {
147
-                $labels = array_merge($arguments['labels'], $override_arguments['labels']);
148
-            }
149
-            $arguments = array_merge($arguments, $override_arguments);
150
-            $arguments['labels'] = $labels;
151
-        }
152
-        return $arguments;
153
-    }
115
+	/**
116
+	 * @param string $post_type          the actual post type name
117
+	 * @param string $singular_name      a pre-internationalized string for the singular name of the objects
118
+	 * @param string $plural_name        a pre-internationalized string for the plural name of the objects
119
+	 * @param string $singular_slug
120
+	 * @param string $plural_slug
121
+	 * @param array  $override_arguments The default values set in this function will be overridden
122
+	 *                                   by whatever you set in $override_arguments
123
+	 * @return array
124
+	 */
125
+	protected function prepareArguments(
126
+		$post_type,
127
+		$singular_name,
128
+		$plural_name,
129
+		$singular_slug,
130
+		$plural_slug,
131
+		array $override_arguments = array()
132
+	) {
133
+		// verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name
134
+		$singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name;
135
+		$plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name;
136
+		$labels = $this->getLabels(
137
+			$singular_name,
138
+			$plural_name,
139
+			$singular_slug,
140
+			$plural_slug
141
+		);
142
+		// note the page_templates arg in the supports index is something specific to EE.
143
+		// WordPress doesn't actually have that in their register_post_type api.
144
+		$arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug);
145
+		if ($override_arguments) {
146
+			if (isset($override_arguments['labels'])) {
147
+				$labels = array_merge($arguments['labels'], $override_arguments['labels']);
148
+			}
149
+			$arguments = array_merge($arguments, $override_arguments);
150
+			$arguments['labels'] = $labels;
151
+		}
152
+		return $arguments;
153
+	}
154 154
 
155 155
 
156
-    /**
157
-     * @param string $singular_name
158
-     * @param string $plural_name
159
-     * @param string $singular_slug
160
-     * @param string $plural_slug
161
-     * @return array
162
-     */
163
-    private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug)
164
-    {
165
-        return array(
166
-            'name'                     => $plural_name,
167
-            'singular_name'            => $singular_name,
168
-            'singular_slug'            => $singular_slug,
169
-            'plural_slug'              => $plural_slug,
170
-            'add_new'                  => sprintf(
171
-                /* Translators: Post Type Label */
172
-                esc_html_x('Add %s', 'Add Event', 'event_espresso'),
173
-                $singular_name
174
-            ),
175
-            'add_new_item'             => sprintf(
176
-                /* Translators: Post Type Label */
177
-                esc_html_x('Add New %s', 'Add New Event', 'event_espresso'),
178
-                $singular_name
179
-            ),
180
-            'edit_item'                => sprintf(
181
-                /* Translators: Post Type Label */
182
-                esc_html_x('Edit %s', 'Edit Event', 'event_espresso'),
183
-                $singular_name
184
-            ),
185
-            'new_item'                 => sprintf(
186
-                /* Translators: Post Type Label */
187
-                esc_html_x('New %s', 'New Event', 'event_espresso'),
188
-                $singular_name
189
-            ),
190
-            'all_items'                => sprintf(
191
-                /* Translators: Post Type Label */
192
-                esc_html_x('All %s', 'All Events', 'event_espresso'),
193
-                $plural_name
194
-            ),
195
-            'view_item'                => sprintf(
196
-                /* Translators: Post Type Label */
197
-                esc_html_x('View %s', 'View Event', 'event_espresso'),
198
-                $singular_name
199
-            ),
200
-            'view_items'               => sprintf(
201
-                /* Translators: Post Type Label */
202
-                esc_html_x('View %s', 'View Events', 'event_espresso'),
203
-                $plural_name
204
-            ),
205
-            'archives'                 => sprintf(
206
-                /* Translators: Post Type Label */
207
-                esc_html_x('%s Archives', 'Event Archives', 'event_espresso'),
208
-                $singular_name
209
-            ),
210
-            'attributes'               => sprintf(
211
-                /* Translators: Post Type Label */
212
-                esc_html_x('%s Attributes', 'Event Attributes', 'event_espresso'),
213
-                $singular_name
214
-            ),
215
-            'insert_into_item'         => sprintf(
216
-                /* Translators: Post Type Label */
217
-                esc_html_x('Insert into this %s', 'Insert into this Event', 'event_espresso'),
218
-                $singular_name
219
-            ),
220
-            'uploaded_to_this_item'    => sprintf(
221
-                /* Translators: Post Type Label */
222
-                esc_html_x('Uploaded to this %s', 'Uploaded to this Event', 'event_espresso'),
223
-                $singular_name
224
-            ),
225
-            'filter_items_list'        => sprintf(
226
-                /* Translators: Post Type Label */
227
-                esc_html_x('Filter %s list', 'Filter Events list', 'event_espresso'),
228
-                $plural_name
229
-            ),
230
-            'items_list_navigation'    => sprintf(
231
-                /* Translators: Post Type Label */
232
-                esc_html_x('%s list navigation', 'Events list navigation', 'event_espresso'),
233
-                $plural_name
234
-            ),
235
-            'items_list'               => sprintf(
236
-                /* Translators: Post Type Label */
237
-                esc_html_x('%s list', 'Events list', 'event_espresso'),
238
-                $plural_name
239
-            ),
240
-            'item_published'           => sprintf(
241
-                /* Translators: Post Type Label */
242
-                esc_html_x('%s published', 'Event published', 'event_espresso'),
243
-                $singular_name
244
-            ),
245
-            'item_published_privately' => sprintf(
246
-                /* Translators: Post Type Label */
247
-                esc_html_x('%s published privately', 'Event published privately', 'event_espresso'),
248
-                $singular_name
249
-            ),
250
-            'item_reverted_to_draft'   => sprintf(
251
-                /* Translators: Post Type Label */
252
-                esc_html_x('%s reverted to draft', 'Event reverted to draft', 'event_espresso'),
253
-                $singular_name
254
-            ),
255
-            'item_scheduled'           => sprintf(
256
-                /* Translators: Post Type Label */
257
-                esc_html_x('%s scheduled', 'Event scheduled', 'event_espresso'),
258
-                $singular_name
259
-            ),
260
-            'item_updated'             => sprintf(
261
-                /* Translators: Post Type Label */
262
-                esc_html_x('%s updated', 'Event updated', 'event_espresso'),
263
-                $singular_name
264
-            ),
265
-            'search_items'             => sprintf(
266
-                /* Translators: Post Type Label */
267
-                esc_html_x('Search %s', 'Search Events', 'event_espresso'),
268
-                $plural_name
269
-            ),
270
-            'not_found'                => sprintf(
271
-                /* Translators: Post Type Label */
272
-                esc_html_x('No %s found', 'No Events found', 'event_espresso'),
273
-                $plural_name
274
-            ),
275
-            'not_found_in_trash'       => sprintf(
276
-                /* Translators: Post Type Label */
277
-                esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'),
278
-                $plural_name
279
-            ),
280
-            'parent_item_colon'        => '',
281
-            'menu_name'                => $plural_name,
282
-        );
283
-    }
156
+	/**
157
+	 * @param string $singular_name
158
+	 * @param string $plural_name
159
+	 * @param string $singular_slug
160
+	 * @param string $plural_slug
161
+	 * @return array
162
+	 */
163
+	private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug)
164
+	{
165
+		return array(
166
+			'name'                     => $plural_name,
167
+			'singular_name'            => $singular_name,
168
+			'singular_slug'            => $singular_slug,
169
+			'plural_slug'              => $plural_slug,
170
+			'add_new'                  => sprintf(
171
+				/* Translators: Post Type Label */
172
+				esc_html_x('Add %s', 'Add Event', 'event_espresso'),
173
+				$singular_name
174
+			),
175
+			'add_new_item'             => sprintf(
176
+				/* Translators: Post Type Label */
177
+				esc_html_x('Add New %s', 'Add New Event', 'event_espresso'),
178
+				$singular_name
179
+			),
180
+			'edit_item'                => sprintf(
181
+				/* Translators: Post Type Label */
182
+				esc_html_x('Edit %s', 'Edit Event', 'event_espresso'),
183
+				$singular_name
184
+			),
185
+			'new_item'                 => sprintf(
186
+				/* Translators: Post Type Label */
187
+				esc_html_x('New %s', 'New Event', 'event_espresso'),
188
+				$singular_name
189
+			),
190
+			'all_items'                => sprintf(
191
+				/* Translators: Post Type Label */
192
+				esc_html_x('All %s', 'All Events', 'event_espresso'),
193
+				$plural_name
194
+			),
195
+			'view_item'                => sprintf(
196
+				/* Translators: Post Type Label */
197
+				esc_html_x('View %s', 'View Event', 'event_espresso'),
198
+				$singular_name
199
+			),
200
+			'view_items'               => sprintf(
201
+				/* Translators: Post Type Label */
202
+				esc_html_x('View %s', 'View Events', 'event_espresso'),
203
+				$plural_name
204
+			),
205
+			'archives'                 => sprintf(
206
+				/* Translators: Post Type Label */
207
+				esc_html_x('%s Archives', 'Event Archives', 'event_espresso'),
208
+				$singular_name
209
+			),
210
+			'attributes'               => sprintf(
211
+				/* Translators: Post Type Label */
212
+				esc_html_x('%s Attributes', 'Event Attributes', 'event_espresso'),
213
+				$singular_name
214
+			),
215
+			'insert_into_item'         => sprintf(
216
+				/* Translators: Post Type Label */
217
+				esc_html_x('Insert into this %s', 'Insert into this Event', 'event_espresso'),
218
+				$singular_name
219
+			),
220
+			'uploaded_to_this_item'    => sprintf(
221
+				/* Translators: Post Type Label */
222
+				esc_html_x('Uploaded to this %s', 'Uploaded to this Event', 'event_espresso'),
223
+				$singular_name
224
+			),
225
+			'filter_items_list'        => sprintf(
226
+				/* Translators: Post Type Label */
227
+				esc_html_x('Filter %s list', 'Filter Events list', 'event_espresso'),
228
+				$plural_name
229
+			),
230
+			'items_list_navigation'    => sprintf(
231
+				/* Translators: Post Type Label */
232
+				esc_html_x('%s list navigation', 'Events list navigation', 'event_espresso'),
233
+				$plural_name
234
+			),
235
+			'items_list'               => sprintf(
236
+				/* Translators: Post Type Label */
237
+				esc_html_x('%s list', 'Events list', 'event_espresso'),
238
+				$plural_name
239
+			),
240
+			'item_published'           => sprintf(
241
+				/* Translators: Post Type Label */
242
+				esc_html_x('%s published', 'Event published', 'event_espresso'),
243
+				$singular_name
244
+			),
245
+			'item_published_privately' => sprintf(
246
+				/* Translators: Post Type Label */
247
+				esc_html_x('%s published privately', 'Event published privately', 'event_espresso'),
248
+				$singular_name
249
+			),
250
+			'item_reverted_to_draft'   => sprintf(
251
+				/* Translators: Post Type Label */
252
+				esc_html_x('%s reverted to draft', 'Event reverted to draft', 'event_espresso'),
253
+				$singular_name
254
+			),
255
+			'item_scheduled'           => sprintf(
256
+				/* Translators: Post Type Label */
257
+				esc_html_x('%s scheduled', 'Event scheduled', 'event_espresso'),
258
+				$singular_name
259
+			),
260
+			'item_updated'             => sprintf(
261
+				/* Translators: Post Type Label */
262
+				esc_html_x('%s updated', 'Event updated', 'event_espresso'),
263
+				$singular_name
264
+			),
265
+			'search_items'             => sprintf(
266
+				/* Translators: Post Type Label */
267
+				esc_html_x('Search %s', 'Search Events', 'event_espresso'),
268
+				$plural_name
269
+			),
270
+			'not_found'                => sprintf(
271
+				/* Translators: Post Type Label */
272
+				esc_html_x('No %s found', 'No Events found', 'event_espresso'),
273
+				$plural_name
274
+			),
275
+			'not_found_in_trash'       => sprintf(
276
+				/* Translators: Post Type Label */
277
+				esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'),
278
+				$plural_name
279
+			),
280
+			'parent_item_colon'        => '',
281
+			'menu_name'                => $plural_name,
282
+		);
283
+	}
284 284
 
285 285
 
286
-    /**
287
-     * @param array  $labels
288
-     * @param string $post_type
289
-     * @param string $plural_slug
290
-     * @return array
291
-     */
292
-    private function getDefaultArguments(array $labels, $post_type, $plural_slug)
293
-    {
294
-        return array(
295
-            'labels'             => $labels,
296
-            'public'             => true,
297
-            'publicly_queryable' => true,
298
-            'show_ui'            => false,
299
-            'show_ee_ui'         => true,
300
-            'show_in_menu'       => false,
301
-            'show_in_nav_menus'  => false,
302
-            'query_var'          => true,
303
-            'rewrite'            => apply_filters(
304
-                'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite',
305
-                // legacy filter applied for now,
306
-                // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
307
-                apply_filters(
308
-                    'FHEE__EE_Register_CPTs__register_CPT__rewrite',
309
-                    array('slug' => $plural_slug),
310
-                    $post_type
311
-                ),
312
-                $post_type,
313
-                $plural_slug
314
-            ),
315
-            'capability_type'    => 'post',
316
-            'map_meta_cap'       => true,
317
-            'has_archive'        => true,
318
-            'hierarchical'       => false,
319
-            'menu_position'      => null,
320
-            'supports'           => array(
321
-                'title',
322
-                'editor',
323
-                'author',
324
-                'thumbnail',
325
-                'excerpt',
326
-                'custom-fields',
327
-                'comments',
328
-            ),
329
-        );
330
-    }
286
+	/**
287
+	 * @param array  $labels
288
+	 * @param string $post_type
289
+	 * @param string $plural_slug
290
+	 * @return array
291
+	 */
292
+	private function getDefaultArguments(array $labels, $post_type, $plural_slug)
293
+	{
294
+		return array(
295
+			'labels'             => $labels,
296
+			'public'             => true,
297
+			'publicly_queryable' => true,
298
+			'show_ui'            => false,
299
+			'show_ee_ui'         => true,
300
+			'show_in_menu'       => false,
301
+			'show_in_nav_menus'  => false,
302
+			'query_var'          => true,
303
+			'rewrite'            => apply_filters(
304
+				'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite',
305
+				// legacy filter applied for now,
306
+				// later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
307
+				apply_filters(
308
+					'FHEE__EE_Register_CPTs__register_CPT__rewrite',
309
+					array('slug' => $plural_slug),
310
+					$post_type
311
+				),
312
+				$post_type,
313
+				$plural_slug
314
+			),
315
+			'capability_type'    => 'post',
316
+			'map_meta_cap'       => true,
317
+			'has_archive'        => true,
318
+			'hierarchical'       => false,
319
+			'menu_position'      => null,
320
+			'supports'           => array(
321
+				'title',
322
+				'editor',
323
+				'author',
324
+				'thumbnail',
325
+				'excerpt',
326
+				'custom-fields',
327
+				'comments',
328
+			),
329
+		);
330
+	}
331 331
 }
Please login to merge, or discard this patch.
core/admin/EE_Admin_List_Table.core.php 2 patches
Indentation   +834 added lines, -834 removed lines patch added patch discarded remove patch
@@ -1,7 +1,7 @@  discard block
 block discarded – undo
1 1
 <?php
2 2
 
3 3
 if (! class_exists('WP_List_Table')) {
4
-    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
4
+	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
5 5
 }
6 6
 
7 7
 
@@ -20,847 +20,847 @@  discard block
 block discarded – undo
20 20
 abstract class EE_Admin_List_Table extends WP_List_Table
21 21
 {
22 22
 
23
-    /**
24
-     * holds the data that will be processed for the table
25
-     *
26
-     * @var array $_data
27
-     */
28
-    protected $_data;
29
-
30
-
31
-    /**
32
-     * This holds the value of all the data available for the given view (for all pages).
33
-     *
34
-     * @var int $_all_data_count
35
-     */
36
-    protected $_all_data_count;
37
-
38
-
39
-    /**
40
-     * Will contain the count of trashed items for the view label.
41
-     *
42
-     * @var int $_trashed_count
43
-     */
44
-    protected $_trashed_count;
45
-
46
-
47
-    /**
48
-     * This is what will be referenced as the slug for the current screen
49
-     *
50
-     * @var string $_screen
51
-     */
52
-    protected $_screen;
53
-
54
-
55
-    /**
56
-     * this is the EE_Admin_Page object
57
-     *
58
-     * @var EE_Admin_Page $_admin_page
59
-     */
60
-    protected $_admin_page;
61
-
62
-
63
-    /**
64
-     * The current view
65
-     *
66
-     * @var string $_view
67
-     */
68
-    protected $_view;
69
-
70
-
71
-    /**
72
-     * array of possible views for this table
73
-     *
74
-     * @var array $_views
75
-     */
76
-    protected $_views;
77
-
78
-
79
-    /**
80
-     * An array of key => value pairs containing information about the current table
81
-     * array(
82
-     *        'plural' => 'plural label',
83
-     *        'singular' => 'singular label',
84
-     *        'ajax' => false, //whether to use ajax or not
85
-     *        'screen' => null, //string used to reference what screen this is
86
-     *        (WP_List_table converts to screen object)
87
-     * )
88
-     *
89
-     * @var array $_wp_list_args
90
-     */
91
-    protected $_wp_list_args;
92
-
93
-    /**
94
-     * an array of column names
95
-     * array(
96
-     *    'internal-name' => 'Title'
97
-     * )
98
-     *
99
-     * @var array $_columns
100
-     */
101
-    protected $_columns;
102
-
103
-    /**
104
-     * An array of sortable columns
105
-     * array(
106
-     *    'internal-name' => 'orderby' //or
107
-     *    'internal-name' => array( 'orderby', true )
108
-     * )
109
-     *
110
-     * @var array $_sortable_columns
111
-     */
112
-    protected $_sortable_columns;
113
-
114
-    /**
115
-     * callback method used to perform AJAX row reordering
116
-     *
117
-     * @var string $_ajax_sorting_callback
118
-     */
119
-    protected $_ajax_sorting_callback;
120
-
121
-    /**
122
-     * An array of hidden columns (if needed)
123
-     * array('internal-name', 'internal-name')
124
-     *
125
-     * @var array $_hidden_columns
126
-     */
127
-    protected $_hidden_columns;
128
-
129
-    /**
130
-     * holds the per_page value
131
-     *
132
-     * @var int $_per_page
133
-     */
134
-    protected $_per_page;
135
-
136
-    /**
137
-     * holds what page number is currently being viewed
138
-     *
139
-     * @var int $_current_page
140
-     */
141
-    protected $_current_page;
142
-
143
-    /**
144
-     * the reference string for the nonce_action
145
-     *
146
-     * @var string $_nonce_action_ref
147
-     */
148
-    protected $_nonce_action_ref;
149
-
150
-    /**
151
-     * property to hold incoming request data (as set by the admin_page_core)
152
-     *
153
-     * @var array $_req_data
154
-     */
155
-    protected $_req_data;
156
-
157
-
158
-    /**
159
-     * yes / no array for admin form fields
160
-     *
161
-     * @var array $_yes_no
162
-     */
163
-    protected $_yes_no = array();
164
-
165
-    /**
166
-     * Array describing buttons that should appear at the bottom of the page
167
-     * Keys are strings that represent the button's function (specifically a key in _labels['buttons']),
168
-     * and the values are another array with the following keys
169
-     * array(
170
-     *    'route' => 'page_route',
171
-     *    'extra_request' => array('evt_id' => 1 ); //extra request vars that need to be included in the button.
172
-     * )
173
-     *
174
-     * @var array $_bottom_buttons
175
-     */
176
-    protected $_bottom_buttons = array();
177
-
178
-
179
-    /**
180
-     * Used to indicate what should be the primary column for the list table.
181
-     * If not present then falls back to what WP calculates
182
-     * as the primary column.
183
-     *
184
-     * @type string $_primary_column
185
-     */
186
-    protected $_primary_column = '';
187
-
188
-
189
-    /**
190
-     * Used to indicate whether the table has a checkbox column or not.
191
-     *
192
-     * @type bool $_has_checkbox_column
193
-     */
194
-    protected $_has_checkbox_column = false;
195
-
196
-
197
-    /**
198
-     * @param \EE_Admin_Page $admin_page we use this for obtaining everything we need in the list table
199
-     */
200
-    public function __construct(EE_Admin_Page $admin_page)
201
-    {
202
-        $this->_admin_page = $admin_page;
203
-        $this->_req_data = $this->_admin_page->get_request_data();
204
-        $this->_view = $this->_admin_page->get_view();
205
-        $this->_views = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
206
-        $this->_current_page = $this->get_pagenum();
207
-        $this->_screen = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
208
-        $this->_yes_no = array(__('No', 'event_espresso'), __('Yes', 'event_espresso'));
209
-
210
-        $this->_per_page = $this->get_items_per_page($this->_screen . '_per_page', 20);
211
-
212
-        $this->_setup_data();
213
-        $this->_add_view_counts();
214
-
215
-        $this->_nonce_action_ref = $this->_view;
216
-
217
-        $this->_set_properties();
218
-
219
-        // set primary column
220
-        add_filter('list_table_primary_column', array($this, 'set_primary_column'));
221
-
222
-        // set parent defaults
223
-        parent::__construct($this->_wp_list_args);
224
-
225
-        $this->prepare_items();
226
-    }
227
-
228
-
229
-    /**
230
-     * _setup_data
231
-     * this method is used to setup the $_data, $_all_data_count, and _per_page properties
232
-     *
233
-     * @uses $this->_admin_page
234
-     * @return void
235
-     */
236
-    abstract protected function _setup_data();
237
-
238
-
239
-    /**
240
-     * set the properties that this class needs to be able to execute wp_list_table properly
241
-     * properties set:
242
-     * _wp_list_args = what the arguments required for the parent _wp_list_table.
243
-     * _columns = set the columns in an array.
244
-     * _sortable_columns = columns that are sortable (array).
245
-     * _hidden_columns = columns that are hidden (array)
246
-     * _default_orderby = the default orderby for sorting.
247
-     *
248
-     * @abstract
249
-     * @access protected
250
-     * @return void
251
-     */
252
-    abstract protected function _set_properties();
253
-
254
-
255
-    /**
256
-     * _get_table_filters
257
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
258
-     * get's shown in the table.
259
-     *
260
-     * @abstract
261
-     * @access protected
262
-     * @return string
263
-     */
264
-    abstract protected function _get_table_filters();
265
-
266
-
267
-    /**
268
-     * this is a method that child class will do to add counts to the views array so when views are displayed the
269
-     * counts of the views is accurate.
270
-     *
271
-     * @abstract
272
-     * @access protected
273
-     * @return void
274
-     */
275
-    abstract protected function _add_view_counts();
276
-
277
-
278
-    /**
279
-     * _get_hidden_fields
280
-     * returns a html string of hidden fields so if any table filters are used the current view will be respected.
281
-     *
282
-     * @return string
283
-     */
284
-    protected function _get_hidden_fields()
285
-    {
286
-        $action = isset($this->_req_data['route']) ? $this->_req_data['route'] : '';
287
-        $action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
288
-        // if action is STILL empty, then we set it to default
289
-        $action = empty($action) ? 'default' : $action;
290
-        $field = '<input type="hidden" name="page" value="' . $this->_req_data['page'] . '" />' . "\n";
291
-        $field .= '<input type="hidden" name="route" value="' . $action . '" />' . "\n";/**/
292
-        $field .= '<input type="hidden" name="perpage" value="' . $this->_per_page . '" />' . "\n";
293
-
294
-        $bulk_actions = $this->_get_bulk_actions();
295
-        foreach ($bulk_actions as $bulk_action => $label) {
296
-            $field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
297
-                      . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
298
-        }
299
-
300
-        return $field;
301
-    }
302
-
303
-
304
-    /**
305
-     * _set_column_info
306
-     * we're using this to set the column headers property.
307
-     *
308
-     * @access protected
309
-     * @return void
310
-     */
311
-    protected function _set_column_info()
312
-    {
313
-        $columns = $this->get_columns();
314
-        $hidden = $this->get_hidden_columns();
315
-        $_sortable = $this->get_sortable_columns();
316
-
317
-        /**
318
-         * Dynamic hook allowing for adding sortable columns in this list table.
319
-         * Note that $this->screen->id is in the format
320
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
321
-         * table it is: event-espresso_page_espresso_messages.
322
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
323
-         * hook prefix ("event-espresso") will be different.
324
-         *
325
-         * @var array
326
-         */
327
-        $_sortable = apply_filters("FHEE_manage_{$this->screen->id}_sortable_columns", $_sortable, $this->_screen);
328
-
329
-        $sortable = array();
330
-        foreach ($_sortable as $id => $data) {
331
-            if (empty($data)) {
332
-                continue;
333
-            }
334
-            // fix for offset errors with WP_List_Table default get_columninfo()
335
-            if (is_array($data)) {
336
-                $_data[0] = key($data);
337
-                $_data[1] = isset($data[1]) ? $data[1] : false;
338
-            } else {
339
-                $_data[0] = $data;
340
-            }
341
-
342
-            $data = (array) $data;
343
-
344
-            if (! isset($data[1])) {
345
-                $_data[1] = false;
346
-            }
347
-
348
-            $sortable[ $id ] = $_data;
349
-        }
350
-        $primary = $this->get_primary_column_name();
351
-        $this->_column_headers = array($columns, $hidden, $sortable, $primary);
352
-    }
353
-
354
-
355
-    /**
356
-     * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
357
-     *
358
-     * @return string
359
-     */
360
-    protected function get_primary_column_name()
361
-    {
362
-        foreach (class_parents($this) as $parent) {
363
-            if ($parent === 'WP_List_Table' && method_exists($parent, 'get_primary_column_name')) {
364
-                return parent::get_primary_column_name();
365
-            }
366
-        }
367
-        return $this->_primary_column;
368
-    }
369
-
370
-
371
-    /**
372
-     * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
373
-     *
374
-     * @param EE_Base_Class $item
375
-     * @param string        $column_name
376
-     * @param string        $primary
377
-     * @return string
378
-     */
379
-    protected function handle_row_actions($item, $column_name, $primary)
380
-    {
381
-        foreach (class_parents($this) as $parent) {
382
-            if ($parent === 'WP_List_Table' && method_exists($parent, 'handle_row_actions')) {
383
-                return parent::handle_row_actions($item, $column_name, $primary);
384
-            }
385
-        }
386
-        return '';
387
-    }
388
-
389
-
390
-    /**
391
-     * _get_bulk_actions
392
-     * This is a wrapper called by WP_List_Table::get_bulk_actions()
393
-     *
394
-     * @access protected
395
-     * @return array bulk_actions
396
-     */
397
-    protected function _get_bulk_actions()
398
-    {
399
-        $actions = array();
400
-        // the _views property should have the bulk_actions, so let's go through and extract them into a properly
401
-        // formatted array for the wp_list_table();
402
-        foreach ($this->_views as $view => $args) {
403
-            if ($this->_view === $view && isset($args['bulk_action']) && is_array($args['bulk_action'])) {
404
-                // each bulk action will correspond with a admin page route, so we can check whatever the capability is
405
-                // for that page route and skip adding the bulk action if no access for the current logged in user.
406
-                foreach ($args['bulk_action'] as $route => $label) {
407
-                    if ($this->_admin_page->check_user_access($route, true)) {
408
-                        $actions[ $route ] = $label;
409
-                    }
410
-                }
411
-            }
412
-        }
413
-        return $actions;
414
-    }
415
-
416
-
417
-    /**
418
-     * Generate the table navigation above or below the table.
419
-     * Overrides the parent table nav in WP_List_Table so we can hide the bulk action div if there are no bulk actions.
420
-     *
421
-     * @since 4.9.44.rc.001
422
-     */
423
-    public function display_tablenav($which)
424
-    {
425
-        if ('top' === $which) {
426
-            wp_nonce_field('bulk-' . $this->_args['plural']);
427
-        }
428
-        ?>
23
+	/**
24
+	 * holds the data that will be processed for the table
25
+	 *
26
+	 * @var array $_data
27
+	 */
28
+	protected $_data;
29
+
30
+
31
+	/**
32
+	 * This holds the value of all the data available for the given view (for all pages).
33
+	 *
34
+	 * @var int $_all_data_count
35
+	 */
36
+	protected $_all_data_count;
37
+
38
+
39
+	/**
40
+	 * Will contain the count of trashed items for the view label.
41
+	 *
42
+	 * @var int $_trashed_count
43
+	 */
44
+	protected $_trashed_count;
45
+
46
+
47
+	/**
48
+	 * This is what will be referenced as the slug for the current screen
49
+	 *
50
+	 * @var string $_screen
51
+	 */
52
+	protected $_screen;
53
+
54
+
55
+	/**
56
+	 * this is the EE_Admin_Page object
57
+	 *
58
+	 * @var EE_Admin_Page $_admin_page
59
+	 */
60
+	protected $_admin_page;
61
+
62
+
63
+	/**
64
+	 * The current view
65
+	 *
66
+	 * @var string $_view
67
+	 */
68
+	protected $_view;
69
+
70
+
71
+	/**
72
+	 * array of possible views for this table
73
+	 *
74
+	 * @var array $_views
75
+	 */
76
+	protected $_views;
77
+
78
+
79
+	/**
80
+	 * An array of key => value pairs containing information about the current table
81
+	 * array(
82
+	 *        'plural' => 'plural label',
83
+	 *        'singular' => 'singular label',
84
+	 *        'ajax' => false, //whether to use ajax or not
85
+	 *        'screen' => null, //string used to reference what screen this is
86
+	 *        (WP_List_table converts to screen object)
87
+	 * )
88
+	 *
89
+	 * @var array $_wp_list_args
90
+	 */
91
+	protected $_wp_list_args;
92
+
93
+	/**
94
+	 * an array of column names
95
+	 * array(
96
+	 *    'internal-name' => 'Title'
97
+	 * )
98
+	 *
99
+	 * @var array $_columns
100
+	 */
101
+	protected $_columns;
102
+
103
+	/**
104
+	 * An array of sortable columns
105
+	 * array(
106
+	 *    'internal-name' => 'orderby' //or
107
+	 *    'internal-name' => array( 'orderby', true )
108
+	 * )
109
+	 *
110
+	 * @var array $_sortable_columns
111
+	 */
112
+	protected $_sortable_columns;
113
+
114
+	/**
115
+	 * callback method used to perform AJAX row reordering
116
+	 *
117
+	 * @var string $_ajax_sorting_callback
118
+	 */
119
+	protected $_ajax_sorting_callback;
120
+
121
+	/**
122
+	 * An array of hidden columns (if needed)
123
+	 * array('internal-name', 'internal-name')
124
+	 *
125
+	 * @var array $_hidden_columns
126
+	 */
127
+	protected $_hidden_columns;
128
+
129
+	/**
130
+	 * holds the per_page value
131
+	 *
132
+	 * @var int $_per_page
133
+	 */
134
+	protected $_per_page;
135
+
136
+	/**
137
+	 * holds what page number is currently being viewed
138
+	 *
139
+	 * @var int $_current_page
140
+	 */
141
+	protected $_current_page;
142
+
143
+	/**
144
+	 * the reference string for the nonce_action
145
+	 *
146
+	 * @var string $_nonce_action_ref
147
+	 */
148
+	protected $_nonce_action_ref;
149
+
150
+	/**
151
+	 * property to hold incoming request data (as set by the admin_page_core)
152
+	 *
153
+	 * @var array $_req_data
154
+	 */
155
+	protected $_req_data;
156
+
157
+
158
+	/**
159
+	 * yes / no array for admin form fields
160
+	 *
161
+	 * @var array $_yes_no
162
+	 */
163
+	protected $_yes_no = array();
164
+
165
+	/**
166
+	 * Array describing buttons that should appear at the bottom of the page
167
+	 * Keys are strings that represent the button's function (specifically a key in _labels['buttons']),
168
+	 * and the values are another array with the following keys
169
+	 * array(
170
+	 *    'route' => 'page_route',
171
+	 *    'extra_request' => array('evt_id' => 1 ); //extra request vars that need to be included in the button.
172
+	 * )
173
+	 *
174
+	 * @var array $_bottom_buttons
175
+	 */
176
+	protected $_bottom_buttons = array();
177
+
178
+
179
+	/**
180
+	 * Used to indicate what should be the primary column for the list table.
181
+	 * If not present then falls back to what WP calculates
182
+	 * as the primary column.
183
+	 *
184
+	 * @type string $_primary_column
185
+	 */
186
+	protected $_primary_column = '';
187
+
188
+
189
+	/**
190
+	 * Used to indicate whether the table has a checkbox column or not.
191
+	 *
192
+	 * @type bool $_has_checkbox_column
193
+	 */
194
+	protected $_has_checkbox_column = false;
195
+
196
+
197
+	/**
198
+	 * @param \EE_Admin_Page $admin_page we use this for obtaining everything we need in the list table
199
+	 */
200
+	public function __construct(EE_Admin_Page $admin_page)
201
+	{
202
+		$this->_admin_page = $admin_page;
203
+		$this->_req_data = $this->_admin_page->get_request_data();
204
+		$this->_view = $this->_admin_page->get_view();
205
+		$this->_views = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
206
+		$this->_current_page = $this->get_pagenum();
207
+		$this->_screen = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
208
+		$this->_yes_no = array(__('No', 'event_espresso'), __('Yes', 'event_espresso'));
209
+
210
+		$this->_per_page = $this->get_items_per_page($this->_screen . '_per_page', 20);
211
+
212
+		$this->_setup_data();
213
+		$this->_add_view_counts();
214
+
215
+		$this->_nonce_action_ref = $this->_view;
216
+
217
+		$this->_set_properties();
218
+
219
+		// set primary column
220
+		add_filter('list_table_primary_column', array($this, 'set_primary_column'));
221
+
222
+		// set parent defaults
223
+		parent::__construct($this->_wp_list_args);
224
+
225
+		$this->prepare_items();
226
+	}
227
+
228
+
229
+	/**
230
+	 * _setup_data
231
+	 * this method is used to setup the $_data, $_all_data_count, and _per_page properties
232
+	 *
233
+	 * @uses $this->_admin_page
234
+	 * @return void
235
+	 */
236
+	abstract protected function _setup_data();
237
+
238
+
239
+	/**
240
+	 * set the properties that this class needs to be able to execute wp_list_table properly
241
+	 * properties set:
242
+	 * _wp_list_args = what the arguments required for the parent _wp_list_table.
243
+	 * _columns = set the columns in an array.
244
+	 * _sortable_columns = columns that are sortable (array).
245
+	 * _hidden_columns = columns that are hidden (array)
246
+	 * _default_orderby = the default orderby for sorting.
247
+	 *
248
+	 * @abstract
249
+	 * @access protected
250
+	 * @return void
251
+	 */
252
+	abstract protected function _set_properties();
253
+
254
+
255
+	/**
256
+	 * _get_table_filters
257
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
258
+	 * get's shown in the table.
259
+	 *
260
+	 * @abstract
261
+	 * @access protected
262
+	 * @return string
263
+	 */
264
+	abstract protected function _get_table_filters();
265
+
266
+
267
+	/**
268
+	 * this is a method that child class will do to add counts to the views array so when views are displayed the
269
+	 * counts of the views is accurate.
270
+	 *
271
+	 * @abstract
272
+	 * @access protected
273
+	 * @return void
274
+	 */
275
+	abstract protected function _add_view_counts();
276
+
277
+
278
+	/**
279
+	 * _get_hidden_fields
280
+	 * returns a html string of hidden fields so if any table filters are used the current view will be respected.
281
+	 *
282
+	 * @return string
283
+	 */
284
+	protected function _get_hidden_fields()
285
+	{
286
+		$action = isset($this->_req_data['route']) ? $this->_req_data['route'] : '';
287
+		$action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
288
+		// if action is STILL empty, then we set it to default
289
+		$action = empty($action) ? 'default' : $action;
290
+		$field = '<input type="hidden" name="page" value="' . $this->_req_data['page'] . '" />' . "\n";
291
+		$field .= '<input type="hidden" name="route" value="' . $action . '" />' . "\n";/**/
292
+		$field .= '<input type="hidden" name="perpage" value="' . $this->_per_page . '" />' . "\n";
293
+
294
+		$bulk_actions = $this->_get_bulk_actions();
295
+		foreach ($bulk_actions as $bulk_action => $label) {
296
+			$field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
297
+					  . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
298
+		}
299
+
300
+		return $field;
301
+	}
302
+
303
+
304
+	/**
305
+	 * _set_column_info
306
+	 * we're using this to set the column headers property.
307
+	 *
308
+	 * @access protected
309
+	 * @return void
310
+	 */
311
+	protected function _set_column_info()
312
+	{
313
+		$columns = $this->get_columns();
314
+		$hidden = $this->get_hidden_columns();
315
+		$_sortable = $this->get_sortable_columns();
316
+
317
+		/**
318
+		 * Dynamic hook allowing for adding sortable columns in this list table.
319
+		 * Note that $this->screen->id is in the format
320
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
321
+		 * table it is: event-espresso_page_espresso_messages.
322
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
323
+		 * hook prefix ("event-espresso") will be different.
324
+		 *
325
+		 * @var array
326
+		 */
327
+		$_sortable = apply_filters("FHEE_manage_{$this->screen->id}_sortable_columns", $_sortable, $this->_screen);
328
+
329
+		$sortable = array();
330
+		foreach ($_sortable as $id => $data) {
331
+			if (empty($data)) {
332
+				continue;
333
+			}
334
+			// fix for offset errors with WP_List_Table default get_columninfo()
335
+			if (is_array($data)) {
336
+				$_data[0] = key($data);
337
+				$_data[1] = isset($data[1]) ? $data[1] : false;
338
+			} else {
339
+				$_data[0] = $data;
340
+			}
341
+
342
+			$data = (array) $data;
343
+
344
+			if (! isset($data[1])) {
345
+				$_data[1] = false;
346
+			}
347
+
348
+			$sortable[ $id ] = $_data;
349
+		}
350
+		$primary = $this->get_primary_column_name();
351
+		$this->_column_headers = array($columns, $hidden, $sortable, $primary);
352
+	}
353
+
354
+
355
+	/**
356
+	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
357
+	 *
358
+	 * @return string
359
+	 */
360
+	protected function get_primary_column_name()
361
+	{
362
+		foreach (class_parents($this) as $parent) {
363
+			if ($parent === 'WP_List_Table' && method_exists($parent, 'get_primary_column_name')) {
364
+				return parent::get_primary_column_name();
365
+			}
366
+		}
367
+		return $this->_primary_column;
368
+	}
369
+
370
+
371
+	/**
372
+	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
373
+	 *
374
+	 * @param EE_Base_Class $item
375
+	 * @param string        $column_name
376
+	 * @param string        $primary
377
+	 * @return string
378
+	 */
379
+	protected function handle_row_actions($item, $column_name, $primary)
380
+	{
381
+		foreach (class_parents($this) as $parent) {
382
+			if ($parent === 'WP_List_Table' && method_exists($parent, 'handle_row_actions')) {
383
+				return parent::handle_row_actions($item, $column_name, $primary);
384
+			}
385
+		}
386
+		return '';
387
+	}
388
+
389
+
390
+	/**
391
+	 * _get_bulk_actions
392
+	 * This is a wrapper called by WP_List_Table::get_bulk_actions()
393
+	 *
394
+	 * @access protected
395
+	 * @return array bulk_actions
396
+	 */
397
+	protected function _get_bulk_actions()
398
+	{
399
+		$actions = array();
400
+		// the _views property should have the bulk_actions, so let's go through and extract them into a properly
401
+		// formatted array for the wp_list_table();
402
+		foreach ($this->_views as $view => $args) {
403
+			if ($this->_view === $view && isset($args['bulk_action']) && is_array($args['bulk_action'])) {
404
+				// each bulk action will correspond with a admin page route, so we can check whatever the capability is
405
+				// for that page route and skip adding the bulk action if no access for the current logged in user.
406
+				foreach ($args['bulk_action'] as $route => $label) {
407
+					if ($this->_admin_page->check_user_access($route, true)) {
408
+						$actions[ $route ] = $label;
409
+					}
410
+				}
411
+			}
412
+		}
413
+		return $actions;
414
+	}
415
+
416
+
417
+	/**
418
+	 * Generate the table navigation above or below the table.
419
+	 * Overrides the parent table nav in WP_List_Table so we can hide the bulk action div if there are no bulk actions.
420
+	 *
421
+	 * @since 4.9.44.rc.001
422
+	 */
423
+	public function display_tablenav($which)
424
+	{
425
+		if ('top' === $which) {
426
+			wp_nonce_field('bulk-' . $this->_args['plural']);
427
+		}
428
+		?>
429 429
         <div class="tablenav <?php echo esc_attr($which); ?>">
430 430
             <?php if ($this->_get_bulk_actions()) { ?>
431 431
                 <div class="alignleft actions bulkactions">
432 432
                     <?php $this->bulk_actions(); ?>
433 433
                 </div>
434 434
             <?php }
435
-            $this->extra_tablenav($which);
436
-            $this->pagination($which);
437
-            ?>
435
+			$this->extra_tablenav($which);
436
+			$this->pagination($which);
437
+			?>
438 438
 
439 439
             <br class="clear"/>
440 440
         </div>
441 441
         <?php
442
-    }
443
-
444
-
445
-    /**
446
-     * _filters
447
-     * This receives the filters array from children _get_table_filters() and assembles the string including the filter
448
-     * button.
449
-     *
450
-     * @access private
451
-     * @return string html showing filters
452
-     */
453
-    private function _filters()
454
-    {
455
-        $classname = get_class($this);
456
-        $filters = apply_filters(
457
-            "FHEE__{$classname}__filters",
458
-            (array) $this->_get_table_filters(),
459
-            $this,
460
-            $this->_screen
461
-        );
462
-
463
-        if (empty($filters)) {
464
-            return;
465
-        }
466
-        foreach ($filters as $filter) {
467
-            echo $filter;
468
-        }
469
-        // add filter button at end
470
-        echo '<input type="submit" class="button-secondary" value="'
471
-             . esc_html__('Filter', 'event_espresso')
472
-             . '" id="post-query-submit" />';
473
-        // add reset filters button at end
474
-        echo '<a class="button button-secondary"  href="'
475
-             . $this->_admin_page->get_current_page_view_url()
476
-             . '" style="display:inline-block">'
477
-             . esc_html__('Reset Filters', 'event_espresso')
478
-             . '</a>';
479
-    }
480
-
481
-
482
-    /**
483
-     * Callback for 'list_table_primary_column' WordPress filter
484
-     * If child EE_Admin_List_Table classes set the _primary_column property then that will be set as the primary
485
-     * column when class is instantiated.
486
-     *
487
-     * @see WP_List_Table::get_primary_column_name
488
-     * @param string $column_name
489
-     * @return string
490
-     */
491
-    public function set_primary_column($column_name)
492
-    {
493
-        return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
494
-    }
495
-
496
-
497
-    /**
498
-     *
499
-     */
500
-    public function prepare_items()
501
-    {
502
-
503
-        $this->_set_column_info();
504
-        // $this->_column_headers = $this->get_column_info();
505
-        $total_items = $this->_all_data_count;
506
-        $this->process_bulk_action();
507
-
508
-        $this->items = $this->_data;
509
-        $this->set_pagination_args(
510
-            array(
511
-                'total_items' => $total_items,
512
-                'per_page'    => $this->_per_page,
513
-                'total_pages' => ceil($total_items / $this->_per_page),
514
-            )
515
-        );
516
-    }
517
-
518
-
519
-    /**
520
-     * This column is the default for when there is no defined column method for a registered column.
521
-     * This can be overridden by child classes, but allows for hooking in for custom columns.
522
-     *
523
-     * @param EE_Base_Class $item
524
-     * @param string        $column_name The column being called.
525
-     * @return string html content for the column
526
-     */
527
-    public function column_default($item, $column_name)
528
-    {
529
-        /**
530
-         * Dynamic hook allowing for adding additional column content in this list table.
531
-         * Note that $this->screen->id is in the format
532
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
533
-         * table it is: event-espresso_page_espresso_messages.
534
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
535
-         * hook prefix ("event-espresso") will be different.
536
-         */
537
-        do_action(
538
-            'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
539
-            $item,
540
-            $this->_screen
541
-        );
542
-    }
543
-
544
-
545
-    /**
546
-     * Get a list of columns. The format is:
547
-     * 'internal-name' => 'Title'
548
-     *
549
-     * @since  3.1.0
550
-     * @access public
551
-     * @abstract
552
-     * @return array
553
-     */
554
-    public function get_columns()
555
-    {
556
-        /**
557
-         * Dynamic hook allowing for adding additional columns in this list table.
558
-         * Note that $this->screen->id is in the format
559
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
560
-         * table it is: event-espresso_page_espresso_messages.
561
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
562
-         * hook prefix ("event-espresso") will be different.
563
-         *
564
-         * @var array
565
-         */
566
-        $columns = apply_filters('FHEE_manage_' . $this->screen->id . '_columns', $this->_columns, $this->_screen);
567
-        return $columns;
568
-    }
569
-
570
-
571
-    /**
572
-     * Get an associative array ( id => link ) with the list
573
-     * of views available on this table.
574
-     *
575
-     * @since  3.1.0
576
-     * @access protected
577
-     * @return array
578
-     */
579
-    public function get_views()
580
-    {
581
-        return $this->_views;
582
-    }
583
-
584
-
585
-    /**
586
-     * Generate the views html.
587
-     */
588
-    public function display_views()
589
-    {
590
-        $views = $this->get_views();
591
-        $assembled_views = array();
592
-
593
-        if (empty($views)) {
594
-            return;
595
-        }
596
-        echo "<ul class='subsubsub'>\n";
597
-        foreach ($views as $view) {
598
-            $count = isset($view['count']) && ! empty($view['count']) ? absint($view['count']) : 0;
599
-            if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
600
-                $assembled_views[ $view['slug'] ] = "\t<li class='" . $view['class'] . "'>"
601
-                                                    . '<a href="' . $view['url'] . '">' . $view['label'] . '</a>'
602
-                                                    . ' <span class="count">(' . $count . ')</span>';
603
-            }
604
-        }
605
-
606
-        echo ! empty($assembled_views) ? implode(" |</li>\n", $assembled_views) . "</li>\n" : '';
607
-        echo "</ul>";
608
-    }
609
-
610
-
611
-    /**
612
-     * Generates content for a single row of the table
613
-     *
614
-     * @since  4.1
615
-     * @access public
616
-     * @param EE_Base_Class $item The current item
617
-     */
618
-    public function single_row($item)
619
-    {
620
-        $row_class = $this->_get_row_class($item);
621
-        echo '<tr class="' . esc_attr($row_class) . '">';
622
-        $this->single_row_columns($item);
623
-        echo '</tr>';
624
-    }
625
-
626
-
627
-    /**
628
-     * This simply sets up the row class for the table rows.
629
-     * Allows for easier overriding of child methods for setting up sorting.
630
-     *
631
-     * @param  EE_Base_Class $item the current item
632
-     * @return string
633
-     */
634
-    protected function _get_row_class($item)
635
-    {
636
-        static $row_class = '';
637
-        $row_class = ($row_class === '' ? 'alternate' : '');
638
-
639
-        $new_row_class = $row_class;
640
-
641
-        if (! empty($this->_ajax_sorting_callback)) {
642
-            $new_row_class .= ' rowsortable';
643
-        }
644
-
645
-        return $new_row_class;
646
-    }
647
-
648
-
649
-    /**
650
-     * @return array
651
-     */
652
-    public function get_sortable_columns()
653
-    {
654
-        return (array) $this->_sortable_columns;
655
-    }
656
-
657
-
658
-    /**
659
-     * @return string
660
-     */
661
-    public function get_ajax_sorting_callback()
662
-    {
663
-        return $this->_ajax_sorting_callback;
664
-    }
665
-
666
-
667
-    /**
668
-     * @return array
669
-     */
670
-    public function get_hidden_columns()
671
-    {
672
-        $user_id = get_current_user_id();
673
-        $has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
674
-        if (empty($has_default) && ! empty($this->_hidden_columns)) {
675
-            update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
676
-            update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
677
-        }
678
-        $ref = 'manage' . $this->screen->id . 'columnshidden';
679
-        return (array) get_user_option($ref, $user_id);
680
-    }
681
-
682
-
683
-    /**
684
-     * Generates the columns for a single row of the table.
685
-     * Overridden from wp_list_table so as to allow us to filter the column content for a given
686
-     * column.
687
-     *
688
-     * @since 3.1.0
689
-     * @param EE_Base_Class $item The current item
690
-     */
691
-    public function single_row_columns($item)
692
-    {
693
-        list($columns, $hidden, $sortable, $primary) = $this->get_column_info();
694
-
695
-        global $wp_version;
696
-        $use_hidden_class = version_compare($wp_version, '4.3-RC', '>=');
697
-
698
-        foreach ($columns as $column_name => $column_display_name) {
699
-
700
-            /**
701
-             * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns
702
-             * are hidden or not instead of using "display:none;".  This bit of code provides backward compat.
703
-             */
704
-            $hidden_class = $use_hidden_class && in_array($column_name, $hidden) ? ' hidden' : '';
705
-            $style = ! $use_hidden_class && in_array($column_name, $hidden) ? ' style="display:none;"' : '';
706
-
707
-            $classes = $column_name . ' column-' . $column_name . $hidden_class;
708
-            if ($primary === $column_name) {
709
-                $classes .= ' has-row-actions column-primary';
710
-            }
711
-
712
-            $data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
713
-
714
-            $class = "class='$classes'";
715
-
716
-            $attributes = "$class$style$data";
717
-
718
-            if ($column_name === 'cb') {
719
-                echo '<th scope="row" class="check-column">';
720
-                echo apply_filters(
721
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content',
722
-                    $this->column_cb($item),
723
-                    $item,
724
-                    $this
725
-                );
726
-                echo '</th>';
727
-            } elseif (method_exists($this, 'column_' . $column_name)) {
728
-                echo "<td $attributes>";
729
-                echo apply_filters(
730
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
731
-                    call_user_func(array($this, 'column_' . $column_name), $item),
732
-                    $item,
733
-                    $this
734
-                );
735
-                echo $this->handle_row_actions($item, $column_name, $primary);
736
-                echo "</td>";
737
-            } else {
738
-                echo "<td $attributes>";
739
-                echo apply_filters(
740
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content',
741
-                    $this->column_default($item, $column_name),
742
-                    $item,
743
-                    $column_name,
744
-                    $this
745
-                );
746
-                echo $this->handle_row_actions($item, $column_name, $primary);
747
-                echo "</td>";
748
-            }
749
-        }
750
-    }
751
-
752
-
753
-    /**
754
-     * Extra controls to be displayed between bulk actions and pagination
755
-     *
756
-     * @access public
757
-     * @param string $which
758
-     * @throws \EE_Error
759
-     */
760
-    public function extra_tablenav($which)
761
-    {
762
-        if ($which === 'top') {
763
-            $this->_filters();
764
-            echo $this->_get_hidden_fields();
765
-        } else {
766
-            echo '<div class="list-table-bottom-buttons alignleft actions">';
767
-            foreach ($this->_bottom_buttons as $type => $action) {
768
-                $route = isset($action['route']) ? $action['route'] : '';
769
-                $extra_request = isset($action['extra_request']) ? $action['extra_request'] : '';
770
-                echo $this->_admin_page->get_action_link_or_button(
771
-                    $route,
772
-                    $type,
773
-                    $extra_request,
774
-                    'button button-secondary',
775
-                    '',
776
-                    false
777
-                );
778
-            }
779
-            do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
780
-            echo '</div>';
781
-        }
782
-        // echo $this->_entries_per_page_dropdown;
783
-    }
784
-
785
-
786
-    /**
787
-     * Get an associative array ( option_name => option_title ) with the list
788
-     * of bulk actions available on this table.
789
-     *
790
-     * @since  3.1.0
791
-     * @access protected
792
-     * @return array
793
-     */
794
-    public function get_bulk_actions()
795
-    {
796
-        return (array) $this->_get_bulk_actions();
797
-    }
798
-
799
-    /**
800
-     * Processing bulk actions.
801
-     */
802
-    public function process_bulk_action()
803
-    {
804
-        // this is not used it is handled by the child EE_Admin_Page class (routes).  However, including here for
805
-        // reference in case there is a case where it gets used.
806
-    }
807
-
808
-
809
-    /**
810
-     * returns the EE admin page this list table is associated with
811
-     *
812
-     * @return EE_Admin_Page
813
-     */
814
-    public function get_admin_page()
815
-    {
816
-        return $this->_admin_page;
817
-    }
818
-
819
-
820
-    /**
821
-     * A "helper" function for all children to provide an html string of
822
-     * actions to output in their content.  It is preferable for child classes
823
-     * to use this method for generating their actions content so that it's
824
-     * filterable by plugins
825
-     *
826
-     * @param string        $action_container           what are the html container
827
-     *                                                  elements for this actions string?
828
-     * @param string        $action_class               What class is for the container
829
-     *                                                  element.
830
-     * @param string        $action_items               The contents for the action items
831
-     *                                                  container.  This is filtered before
832
-     *                                                  returned.
833
-     * @param string        $action_id                  What id (optional) is used for the
834
-     *                                                  container element.
835
-     * @param EE_Base_Class $item                       The object for the column displaying
836
-     *                                                  the actions.
837
-     * @return string The assembled action elements container.
838
-     */
839
-    protected function _action_string(
840
-        $action_items,
841
-        $item,
842
-        $action_container = 'ul',
843
-        $action_class = '',
844
-        $action_id = ''
845
-    ) {
846
-        $content = '';
847
-        $action_class = ! empty($action_class) ? ' class="' . $action_class . '"' : '';
848
-        $action_id = ! empty($action_id) ? ' id="' . $action_id . '"' : '';
849
-        $content .= ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
850
-        try {
851
-            $content .= apply_filters(
852
-                'FHEE__EE_Admin_List_Table___action_string__action_items',
853
-                $action_items,
854
-                $item,
855
-                $this
856
-            );
857
-        } catch (\Exception $e) {
858
-            if (WP_DEBUG) {
859
-                \EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
860
-            }
861
-            $content .= $action_items;
862
-        }
863
-        $content .= ! empty($action_container) ? '</' . $action_container . '>' : '';
864
-        return $content;
865
-    }
442
+	}
443
+
444
+
445
+	/**
446
+	 * _filters
447
+	 * This receives the filters array from children _get_table_filters() and assembles the string including the filter
448
+	 * button.
449
+	 *
450
+	 * @access private
451
+	 * @return string html showing filters
452
+	 */
453
+	private function _filters()
454
+	{
455
+		$classname = get_class($this);
456
+		$filters = apply_filters(
457
+			"FHEE__{$classname}__filters",
458
+			(array) $this->_get_table_filters(),
459
+			$this,
460
+			$this->_screen
461
+		);
462
+
463
+		if (empty($filters)) {
464
+			return;
465
+		}
466
+		foreach ($filters as $filter) {
467
+			echo $filter;
468
+		}
469
+		// add filter button at end
470
+		echo '<input type="submit" class="button-secondary" value="'
471
+			 . esc_html__('Filter', 'event_espresso')
472
+			 . '" id="post-query-submit" />';
473
+		// add reset filters button at end
474
+		echo '<a class="button button-secondary"  href="'
475
+			 . $this->_admin_page->get_current_page_view_url()
476
+			 . '" style="display:inline-block">'
477
+			 . esc_html__('Reset Filters', 'event_espresso')
478
+			 . '</a>';
479
+	}
480
+
481
+
482
+	/**
483
+	 * Callback for 'list_table_primary_column' WordPress filter
484
+	 * If child EE_Admin_List_Table classes set the _primary_column property then that will be set as the primary
485
+	 * column when class is instantiated.
486
+	 *
487
+	 * @see WP_List_Table::get_primary_column_name
488
+	 * @param string $column_name
489
+	 * @return string
490
+	 */
491
+	public function set_primary_column($column_name)
492
+	{
493
+		return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
494
+	}
495
+
496
+
497
+	/**
498
+	 *
499
+	 */
500
+	public function prepare_items()
501
+	{
502
+
503
+		$this->_set_column_info();
504
+		// $this->_column_headers = $this->get_column_info();
505
+		$total_items = $this->_all_data_count;
506
+		$this->process_bulk_action();
507
+
508
+		$this->items = $this->_data;
509
+		$this->set_pagination_args(
510
+			array(
511
+				'total_items' => $total_items,
512
+				'per_page'    => $this->_per_page,
513
+				'total_pages' => ceil($total_items / $this->_per_page),
514
+			)
515
+		);
516
+	}
517
+
518
+
519
+	/**
520
+	 * This column is the default for when there is no defined column method for a registered column.
521
+	 * This can be overridden by child classes, but allows for hooking in for custom columns.
522
+	 *
523
+	 * @param EE_Base_Class $item
524
+	 * @param string        $column_name The column being called.
525
+	 * @return string html content for the column
526
+	 */
527
+	public function column_default($item, $column_name)
528
+	{
529
+		/**
530
+		 * Dynamic hook allowing for adding additional column content in this list table.
531
+		 * Note that $this->screen->id is in the format
532
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
533
+		 * table it is: event-espresso_page_espresso_messages.
534
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
535
+		 * hook prefix ("event-espresso") will be different.
536
+		 */
537
+		do_action(
538
+			'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
539
+			$item,
540
+			$this->_screen
541
+		);
542
+	}
543
+
544
+
545
+	/**
546
+	 * Get a list of columns. The format is:
547
+	 * 'internal-name' => 'Title'
548
+	 *
549
+	 * @since  3.1.0
550
+	 * @access public
551
+	 * @abstract
552
+	 * @return array
553
+	 */
554
+	public function get_columns()
555
+	{
556
+		/**
557
+		 * Dynamic hook allowing for adding additional columns in this list table.
558
+		 * Note that $this->screen->id is in the format
559
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
560
+		 * table it is: event-espresso_page_espresso_messages.
561
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
562
+		 * hook prefix ("event-espresso") will be different.
563
+		 *
564
+		 * @var array
565
+		 */
566
+		$columns = apply_filters('FHEE_manage_' . $this->screen->id . '_columns', $this->_columns, $this->_screen);
567
+		return $columns;
568
+	}
569
+
570
+
571
+	/**
572
+	 * Get an associative array ( id => link ) with the list
573
+	 * of views available on this table.
574
+	 *
575
+	 * @since  3.1.0
576
+	 * @access protected
577
+	 * @return array
578
+	 */
579
+	public function get_views()
580
+	{
581
+		return $this->_views;
582
+	}
583
+
584
+
585
+	/**
586
+	 * Generate the views html.
587
+	 */
588
+	public function display_views()
589
+	{
590
+		$views = $this->get_views();
591
+		$assembled_views = array();
592
+
593
+		if (empty($views)) {
594
+			return;
595
+		}
596
+		echo "<ul class='subsubsub'>\n";
597
+		foreach ($views as $view) {
598
+			$count = isset($view['count']) && ! empty($view['count']) ? absint($view['count']) : 0;
599
+			if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
600
+				$assembled_views[ $view['slug'] ] = "\t<li class='" . $view['class'] . "'>"
601
+													. '<a href="' . $view['url'] . '">' . $view['label'] . '</a>'
602
+													. ' <span class="count">(' . $count . ')</span>';
603
+			}
604
+		}
605
+
606
+		echo ! empty($assembled_views) ? implode(" |</li>\n", $assembled_views) . "</li>\n" : '';
607
+		echo "</ul>";
608
+	}
609
+
610
+
611
+	/**
612
+	 * Generates content for a single row of the table
613
+	 *
614
+	 * @since  4.1
615
+	 * @access public
616
+	 * @param EE_Base_Class $item The current item
617
+	 */
618
+	public function single_row($item)
619
+	{
620
+		$row_class = $this->_get_row_class($item);
621
+		echo '<tr class="' . esc_attr($row_class) . '">';
622
+		$this->single_row_columns($item);
623
+		echo '</tr>';
624
+	}
625
+
626
+
627
+	/**
628
+	 * This simply sets up the row class for the table rows.
629
+	 * Allows for easier overriding of child methods for setting up sorting.
630
+	 *
631
+	 * @param  EE_Base_Class $item the current item
632
+	 * @return string
633
+	 */
634
+	protected function _get_row_class($item)
635
+	{
636
+		static $row_class = '';
637
+		$row_class = ($row_class === '' ? 'alternate' : '');
638
+
639
+		$new_row_class = $row_class;
640
+
641
+		if (! empty($this->_ajax_sorting_callback)) {
642
+			$new_row_class .= ' rowsortable';
643
+		}
644
+
645
+		return $new_row_class;
646
+	}
647
+
648
+
649
+	/**
650
+	 * @return array
651
+	 */
652
+	public function get_sortable_columns()
653
+	{
654
+		return (array) $this->_sortable_columns;
655
+	}
656
+
657
+
658
+	/**
659
+	 * @return string
660
+	 */
661
+	public function get_ajax_sorting_callback()
662
+	{
663
+		return $this->_ajax_sorting_callback;
664
+	}
665
+
666
+
667
+	/**
668
+	 * @return array
669
+	 */
670
+	public function get_hidden_columns()
671
+	{
672
+		$user_id = get_current_user_id();
673
+		$has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
674
+		if (empty($has_default) && ! empty($this->_hidden_columns)) {
675
+			update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
676
+			update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
677
+		}
678
+		$ref = 'manage' . $this->screen->id . 'columnshidden';
679
+		return (array) get_user_option($ref, $user_id);
680
+	}
681
+
682
+
683
+	/**
684
+	 * Generates the columns for a single row of the table.
685
+	 * Overridden from wp_list_table so as to allow us to filter the column content for a given
686
+	 * column.
687
+	 *
688
+	 * @since 3.1.0
689
+	 * @param EE_Base_Class $item The current item
690
+	 */
691
+	public function single_row_columns($item)
692
+	{
693
+		list($columns, $hidden, $sortable, $primary) = $this->get_column_info();
694
+
695
+		global $wp_version;
696
+		$use_hidden_class = version_compare($wp_version, '4.3-RC', '>=');
697
+
698
+		foreach ($columns as $column_name => $column_display_name) {
699
+
700
+			/**
701
+			 * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns
702
+			 * are hidden or not instead of using "display:none;".  This bit of code provides backward compat.
703
+			 */
704
+			$hidden_class = $use_hidden_class && in_array($column_name, $hidden) ? ' hidden' : '';
705
+			$style = ! $use_hidden_class && in_array($column_name, $hidden) ? ' style="display:none;"' : '';
706
+
707
+			$classes = $column_name . ' column-' . $column_name . $hidden_class;
708
+			if ($primary === $column_name) {
709
+				$classes .= ' has-row-actions column-primary';
710
+			}
711
+
712
+			$data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
713
+
714
+			$class = "class='$classes'";
715
+
716
+			$attributes = "$class$style$data";
717
+
718
+			if ($column_name === 'cb') {
719
+				echo '<th scope="row" class="check-column">';
720
+				echo apply_filters(
721
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content',
722
+					$this->column_cb($item),
723
+					$item,
724
+					$this
725
+				);
726
+				echo '</th>';
727
+			} elseif (method_exists($this, 'column_' . $column_name)) {
728
+				echo "<td $attributes>";
729
+				echo apply_filters(
730
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
731
+					call_user_func(array($this, 'column_' . $column_name), $item),
732
+					$item,
733
+					$this
734
+				);
735
+				echo $this->handle_row_actions($item, $column_name, $primary);
736
+				echo "</td>";
737
+			} else {
738
+				echo "<td $attributes>";
739
+				echo apply_filters(
740
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content',
741
+					$this->column_default($item, $column_name),
742
+					$item,
743
+					$column_name,
744
+					$this
745
+				);
746
+				echo $this->handle_row_actions($item, $column_name, $primary);
747
+				echo "</td>";
748
+			}
749
+		}
750
+	}
751
+
752
+
753
+	/**
754
+	 * Extra controls to be displayed between bulk actions and pagination
755
+	 *
756
+	 * @access public
757
+	 * @param string $which
758
+	 * @throws \EE_Error
759
+	 */
760
+	public function extra_tablenav($which)
761
+	{
762
+		if ($which === 'top') {
763
+			$this->_filters();
764
+			echo $this->_get_hidden_fields();
765
+		} else {
766
+			echo '<div class="list-table-bottom-buttons alignleft actions">';
767
+			foreach ($this->_bottom_buttons as $type => $action) {
768
+				$route = isset($action['route']) ? $action['route'] : '';
769
+				$extra_request = isset($action['extra_request']) ? $action['extra_request'] : '';
770
+				echo $this->_admin_page->get_action_link_or_button(
771
+					$route,
772
+					$type,
773
+					$extra_request,
774
+					'button button-secondary',
775
+					'',
776
+					false
777
+				);
778
+			}
779
+			do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
780
+			echo '</div>';
781
+		}
782
+		// echo $this->_entries_per_page_dropdown;
783
+	}
784
+
785
+
786
+	/**
787
+	 * Get an associative array ( option_name => option_title ) with the list
788
+	 * of bulk actions available on this table.
789
+	 *
790
+	 * @since  3.1.0
791
+	 * @access protected
792
+	 * @return array
793
+	 */
794
+	public function get_bulk_actions()
795
+	{
796
+		return (array) $this->_get_bulk_actions();
797
+	}
798
+
799
+	/**
800
+	 * Processing bulk actions.
801
+	 */
802
+	public function process_bulk_action()
803
+	{
804
+		// this is not used it is handled by the child EE_Admin_Page class (routes).  However, including here for
805
+		// reference in case there is a case where it gets used.
806
+	}
807
+
808
+
809
+	/**
810
+	 * returns the EE admin page this list table is associated with
811
+	 *
812
+	 * @return EE_Admin_Page
813
+	 */
814
+	public function get_admin_page()
815
+	{
816
+		return $this->_admin_page;
817
+	}
818
+
819
+
820
+	/**
821
+	 * A "helper" function for all children to provide an html string of
822
+	 * actions to output in their content.  It is preferable for child classes
823
+	 * to use this method for generating their actions content so that it's
824
+	 * filterable by plugins
825
+	 *
826
+	 * @param string        $action_container           what are the html container
827
+	 *                                                  elements for this actions string?
828
+	 * @param string        $action_class               What class is for the container
829
+	 *                                                  element.
830
+	 * @param string        $action_items               The contents for the action items
831
+	 *                                                  container.  This is filtered before
832
+	 *                                                  returned.
833
+	 * @param string        $action_id                  What id (optional) is used for the
834
+	 *                                                  container element.
835
+	 * @param EE_Base_Class $item                       The object for the column displaying
836
+	 *                                                  the actions.
837
+	 * @return string The assembled action elements container.
838
+	 */
839
+	protected function _action_string(
840
+		$action_items,
841
+		$item,
842
+		$action_container = 'ul',
843
+		$action_class = '',
844
+		$action_id = ''
845
+	) {
846
+		$content = '';
847
+		$action_class = ! empty($action_class) ? ' class="' . $action_class . '"' : '';
848
+		$action_id = ! empty($action_id) ? ' id="' . $action_id . '"' : '';
849
+		$content .= ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
850
+		try {
851
+			$content .= apply_filters(
852
+				'FHEE__EE_Admin_List_Table___action_string__action_items',
853
+				$action_items,
854
+				$item,
855
+				$this
856
+			);
857
+		} catch (\Exception $e) {
858
+			if (WP_DEBUG) {
859
+				\EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
860
+			}
861
+			$content .= $action_items;
862
+		}
863
+		$content .= ! empty($action_container) ? '</' . $action_container . '>' : '';
864
+		return $content;
865
+	}
866 866
 }
Please login to merge, or discard this patch.
Spacing   +34 added lines, -34 removed lines patch added patch discarded remove patch
@@ -1,7 +1,7 @@  discard block
 block discarded – undo
1 1
 <?php
2 2
 
3
-if (! class_exists('WP_List_Table')) {
4
-    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
3
+if ( ! class_exists('WP_List_Table')) {
4
+    require_once ABSPATH.'wp-admin/includes/class-wp-list-table.php';
5 5
 }
6 6
 
7 7
 
@@ -204,10 +204,10 @@  discard block
 block discarded – undo
204 204
         $this->_view = $this->_admin_page->get_view();
205 205
         $this->_views = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
206 206
         $this->_current_page = $this->get_pagenum();
207
-        $this->_screen = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
207
+        $this->_screen = $this->_admin_page->get_current_page().'_'.$this->_admin_page->get_current_view();
208 208
         $this->_yes_no = array(__('No', 'event_espresso'), __('Yes', 'event_espresso'));
209 209
 
210
-        $this->_per_page = $this->get_items_per_page($this->_screen . '_per_page', 20);
210
+        $this->_per_page = $this->get_items_per_page($this->_screen.'_per_page', 20);
211 211
 
212 212
         $this->_setup_data();
213 213
         $this->_add_view_counts();
@@ -287,14 +287,14 @@  discard block
 block discarded – undo
287 287
         $action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
288 288
         // if action is STILL empty, then we set it to default
289 289
         $action = empty($action) ? 'default' : $action;
290
-        $field = '<input type="hidden" name="page" value="' . $this->_req_data['page'] . '" />' . "\n";
291
-        $field .= '<input type="hidden" name="route" value="' . $action . '" />' . "\n";/**/
292
-        $field .= '<input type="hidden" name="perpage" value="' . $this->_per_page . '" />' . "\n";
290
+        $field = '<input type="hidden" name="page" value="'.$this->_req_data['page'].'" />'."\n";
291
+        $field .= '<input type="hidden" name="route" value="'.$action.'" />'."\n"; /**/
292
+        $field .= '<input type="hidden" name="perpage" value="'.$this->_per_page.'" />'."\n";
293 293
 
294 294
         $bulk_actions = $this->_get_bulk_actions();
295 295
         foreach ($bulk_actions as $bulk_action => $label) {
296
-            $field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
297
-                      . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
296
+            $field .= '<input type="hidden" name="'.$bulk_action.'_nonce"'
297
+                      . ' value="'.wp_create_nonce($bulk_action.'_nonce').'" />'."\n";
298 298
         }
299 299
 
300 300
         return $field;
@@ -341,11 +341,11 @@  discard block
 block discarded – undo
341 341
 
342 342
             $data = (array) $data;
343 343
 
344
-            if (! isset($data[1])) {
344
+            if ( ! isset($data[1])) {
345 345
                 $_data[1] = false;
346 346
             }
347 347
 
348
-            $sortable[ $id ] = $_data;
348
+            $sortable[$id] = $_data;
349 349
         }
350 350
         $primary = $this->get_primary_column_name();
351 351
         $this->_column_headers = array($columns, $hidden, $sortable, $primary);
@@ -405,7 +405,7 @@  discard block
 block discarded – undo
405 405
                 // for that page route and skip adding the bulk action if no access for the current logged in user.
406 406
                 foreach ($args['bulk_action'] as $route => $label) {
407 407
                     if ($this->_admin_page->check_user_access($route, true)) {
408
-                        $actions[ $route ] = $label;
408
+                        $actions[$route] = $label;
409 409
                     }
410 410
                 }
411 411
             }
@@ -423,7 +423,7 @@  discard block
 block discarded – undo
423 423
     public function display_tablenav($which)
424 424
     {
425 425
         if ('top' === $which) {
426
-            wp_nonce_field('bulk-' . $this->_args['plural']);
426
+            wp_nonce_field('bulk-'.$this->_args['plural']);
427 427
         }
428 428
         ?>
429 429
         <div class="tablenav <?php echo esc_attr($which); ?>">
@@ -535,7 +535,7 @@  discard block
 block discarded – undo
535 535
          * hook prefix ("event-espresso") will be different.
536 536
          */
537 537
         do_action(
538
-            'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
538
+            'AHEE__EE_Admin_List_Table__column_'.$column_name.'__'.$this->screen->id,
539 539
             $item,
540 540
             $this->_screen
541 541
         );
@@ -563,7 +563,7 @@  discard block
 block discarded – undo
563 563
          *
564 564
          * @var array
565 565
          */
566
-        $columns = apply_filters('FHEE_manage_' . $this->screen->id . '_columns', $this->_columns, $this->_screen);
566
+        $columns = apply_filters('FHEE_manage_'.$this->screen->id.'_columns', $this->_columns, $this->_screen);
567 567
         return $columns;
568 568
     }
569 569
 
@@ -597,13 +597,13 @@  discard block
 block discarded – undo
597 597
         foreach ($views as $view) {
598 598
             $count = isset($view['count']) && ! empty($view['count']) ? absint($view['count']) : 0;
599 599
             if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
600
-                $assembled_views[ $view['slug'] ] = "\t<li class='" . $view['class'] . "'>"
601
-                                                    . '<a href="' . $view['url'] . '">' . $view['label'] . '</a>'
602
-                                                    . ' <span class="count">(' . $count . ')</span>';
600
+                $assembled_views[$view['slug']] = "\t<li class='".$view['class']."'>"
601
+                                                    . '<a href="'.$view['url'].'">'.$view['label'].'</a>'
602
+                                                    . ' <span class="count">('.$count.')</span>';
603 603
             }
604 604
         }
605 605
 
606
-        echo ! empty($assembled_views) ? implode(" |</li>\n", $assembled_views) . "</li>\n" : '';
606
+        echo ! empty($assembled_views) ? implode(" |</li>\n", $assembled_views)."</li>\n" : '';
607 607
         echo "</ul>";
608 608
     }
609 609
 
@@ -618,7 +618,7 @@  discard block
 block discarded – undo
618 618
     public function single_row($item)
619 619
     {
620 620
         $row_class = $this->_get_row_class($item);
621
-        echo '<tr class="' . esc_attr($row_class) . '">';
621
+        echo '<tr class="'.esc_attr($row_class).'">';
622 622
         $this->single_row_columns($item);
623 623
         echo '</tr>';
624 624
     }
@@ -638,7 +638,7 @@  discard block
 block discarded – undo
638 638
 
639 639
         $new_row_class = $row_class;
640 640
 
641
-        if (! empty($this->_ajax_sorting_callback)) {
641
+        if ( ! empty($this->_ajax_sorting_callback)) {
642 642
             $new_row_class .= ' rowsortable';
643 643
         }
644 644
 
@@ -670,12 +670,12 @@  discard block
 block discarded – undo
670 670
     public function get_hidden_columns()
671 671
     {
672 672
         $user_id = get_current_user_id();
673
-        $has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
673
+        $has_default = get_user_option('default'.$this->screen->id.'columnshidden', $user_id);
674 674
         if (empty($has_default) && ! empty($this->_hidden_columns)) {
675
-            update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
676
-            update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
675
+            update_user_option($user_id, 'default'.$this->screen->id.'columnshidden', true);
676
+            update_user_option($user_id, 'manage'.$this->screen->id.'columnshidden', $this->_hidden_columns, true);
677 677
         }
678
-        $ref = 'manage' . $this->screen->id . 'columnshidden';
678
+        $ref = 'manage'.$this->screen->id.'columnshidden';
679 679
         return (array) get_user_option($ref, $user_id);
680 680
     }
681 681
 
@@ -704,12 +704,12 @@  discard block
 block discarded – undo
704 704
             $hidden_class = $use_hidden_class && in_array($column_name, $hidden) ? ' hidden' : '';
705 705
             $style = ! $use_hidden_class && in_array($column_name, $hidden) ? ' style="display:none;"' : '';
706 706
 
707
-            $classes = $column_name . ' column-' . $column_name . $hidden_class;
707
+            $classes = $column_name.' column-'.$column_name.$hidden_class;
708 708
             if ($primary === $column_name) {
709 709
                 $classes .= ' has-row-actions column-primary';
710 710
             }
711 711
 
712
-            $data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
712
+            $data = ' data-colname="'.wp_strip_all_tags($column_display_name).'"';
713 713
 
714 714
             $class = "class='$classes'";
715 715
 
@@ -724,11 +724,11 @@  discard block
 block discarded – undo
724 724
                     $this
725 725
                 );
726 726
                 echo '</th>';
727
-            } elseif (method_exists($this, 'column_' . $column_name)) {
727
+            } elseif (method_exists($this, 'column_'.$column_name)) {
728 728
                 echo "<td $attributes>";
729 729
                 echo apply_filters(
730
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
731
-                    call_user_func(array($this, 'column_' . $column_name), $item),
730
+                    'FHEE__EE_Admin_List_Table__single_row_columns__column_'.$column_name.'__column_content',
731
+                    call_user_func(array($this, 'column_'.$column_name), $item),
732 732
                     $item,
733 733
                     $this
734 734
                 );
@@ -844,9 +844,9 @@  discard block
 block discarded – undo
844 844
         $action_id = ''
845 845
     ) {
846 846
         $content = '';
847
-        $action_class = ! empty($action_class) ? ' class="' . $action_class . '"' : '';
848
-        $action_id = ! empty($action_id) ? ' id="' . $action_id . '"' : '';
849
-        $content .= ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
847
+        $action_class = ! empty($action_class) ? ' class="'.$action_class.'"' : '';
848
+        $action_id = ! empty($action_id) ? ' id="'.$action_id.'"' : '';
849
+        $content .= ! empty($action_container) ? '<'.$action_container.$action_class.$action_id.'>' : '';
850 850
         try {
851 851
             $content .= apply_filters(
852 852
                 'FHEE__EE_Admin_List_Table___action_string__action_items',
@@ -860,7 +860,7 @@  discard block
 block discarded – undo
860 860
             }
861 861
             $content .= $action_items;
862 862
         }
863
-        $content .= ! empty($action_container) ? '</' . $action_container . '>' : '';
863
+        $content .= ! empty($action_container) ? '</'.$action_container.'>' : '';
864 864
         return $content;
865 865
     }
866 866
 }
Please login to merge, or discard this patch.
core/admin/EE_Admin_Page.core.php 2 patches
Indentation   +4019 added lines, -4019 removed lines patch added patch discarded remove patch
@@ -17,4086 +17,4086 @@
 block discarded – undo
17 17
 abstract class EE_Admin_Page extends EE_Base implements InterminableInterface
18 18
 {
19 19
 
20
-    /**
21
-     * @var LoaderInterface $loader
22
-     */
23
-    protected $loader;
20
+	/**
21
+	 * @var LoaderInterface $loader
22
+	 */
23
+	protected $loader;
24 24
 
25
-    // set in _init_page_props()
26
-    public $page_slug;
25
+	// set in _init_page_props()
26
+	public $page_slug;
27 27
 
28
-    public $page_label;
28
+	public $page_label;
29 29
 
30
-    public $page_folder;
30
+	public $page_folder;
31 31
 
32
-    // set in define_page_props()
33
-    protected $_admin_base_url;
32
+	// set in define_page_props()
33
+	protected $_admin_base_url;
34 34
 
35
-    protected $_admin_base_path;
35
+	protected $_admin_base_path;
36 36
 
37
-    protected $_admin_page_title;
37
+	protected $_admin_page_title;
38 38
 
39
-    protected $_labels;
39
+	protected $_labels;
40 40
 
41 41
 
42
-    // set early within EE_Admin_Init
43
-    protected $_wp_page_slug;
42
+	// set early within EE_Admin_Init
43
+	protected $_wp_page_slug;
44 44
 
45
-    // navtabs
46
-    protected $_nav_tabs;
45
+	// navtabs
46
+	protected $_nav_tabs;
47 47
 
48
-    protected $_default_nav_tab_name;
48
+	protected $_default_nav_tab_name;
49 49
 
50
-    /**
51
-     * @var array $_help_tour
52
-     */
53
-    protected $_help_tour = array();
50
+	/**
51
+	 * @var array $_help_tour
52
+	 */
53
+	protected $_help_tour = array();
54 54
 
55 55
 
56
-    // template variables (used by templates)
57
-    protected $_template_path;
56
+	// template variables (used by templates)
57
+	protected $_template_path;
58 58
 
59
-    protected $_column_template_path;
59
+	protected $_column_template_path;
60 60
 
61
-    /**
62
-     * @var array $_template_args
63
-     */
64
-    protected $_template_args = array();
61
+	/**
62
+	 * @var array $_template_args
63
+	 */
64
+	protected $_template_args = array();
65 65
 
66
-    /**
67
-     * this will hold the list table object for a given view.
68
-     *
69
-     * @var EE_Admin_List_Table $_list_table_object
70
-     */
71
-    protected $_list_table_object;
66
+	/**
67
+	 * this will hold the list table object for a given view.
68
+	 *
69
+	 * @var EE_Admin_List_Table $_list_table_object
70
+	 */
71
+	protected $_list_table_object;
72 72
 
73
-    // bools
74
-    protected $_is_UI_request = null; // this starts at null so we can have no header routes progress through two states.
73
+	// bools
74
+	protected $_is_UI_request = null; // this starts at null so we can have no header routes progress through two states.
75 75
 
76
-    protected $_routing;
76
+	protected $_routing;
77 77
 
78
-    // list table args
79
-    protected $_view;
78
+	// list table args
79
+	protected $_view;
80 80
 
81
-    protected $_views;
81
+	protected $_views;
82 82
 
83 83
 
84
-    // action => method pairs used for routing incoming requests
85
-    protected $_page_routes;
84
+	// action => method pairs used for routing incoming requests
85
+	protected $_page_routes;
86 86
 
87
-    /**
88
-     * @var array $_page_config
89
-     */
90
-    protected $_page_config;
87
+	/**
88
+	 * @var array $_page_config
89
+	 */
90
+	protected $_page_config;
91 91
 
92
-    /**
93
-     * the current page route and route config
94
-     *
95
-     * @var string $_route
96
-     */
97
-    protected $_route;
92
+	/**
93
+	 * the current page route and route config
94
+	 *
95
+	 * @var string $_route
96
+	 */
97
+	protected $_route;
98 98
 
99
-    /**
100
-     * @var string $_cpt_route
101
-     */
102
-    protected $_cpt_route;
99
+	/**
100
+	 * @var string $_cpt_route
101
+	 */
102
+	protected $_cpt_route;
103 103
 
104
-    /**
105
-     * @var array $_route_config
106
-     */
107
-    protected $_route_config;
108
-
109
-    /**
110
-     * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
111
-     * actions.
112
-     *
113
-     * @since 4.6.x
114
-     * @var array.
115
-     */
116
-    protected $_default_route_query_args;
117
-
118
-    // set via request page and action args.
119
-    protected $_current_page;
120
-
121
-    protected $_current_view;
122
-
123
-    protected $_current_page_view_url;
124
-
125
-    // sanitized request action (and nonce)
126
-
127
-    /**
128
-     * @var string $_req_action
129
-     */
130
-    protected $_req_action;
131
-
132
-    /**
133
-     * @var string $_req_nonce
134
-     */
135
-    protected $_req_nonce;
136
-
137
-    // search related
138
-    protected $_search_btn_label;
139
-
140
-    protected $_search_box_callback;
141
-
142
-    /**
143
-     * WP Current Screen object
144
-     *
145
-     * @var WP_Screen
146
-     */
147
-    protected $_current_screen;
148
-
149
-    // for holding EE_Admin_Hooks object when needed (set via set_hook_object())
150
-    protected $_hook_obj;
151
-
152
-    // for holding incoming request data
153
-    protected $_req_data;
154
-
155
-    // yes / no array for admin form fields
156
-    protected $_yes_no_values = array();
157
-
158
-    // some default things shared by all child classes
159
-    protected $_default_espresso_metaboxes;
160
-
161
-    /**
162
-     *    EE_Registry Object
163
-     *
164
-     * @var    EE_Registry
165
-     */
166
-    protected $EE = null;
167
-
168
-
169
-    /**
170
-     * This is just a property that flags whether the given route is a caffeinated route or not.
171
-     *
172
-     * @var boolean
173
-     */
174
-    protected $_is_caf = false;
175
-
176
-
177
-    /**
178
-     * @Constructor
179
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
180
-     * @throws EE_Error
181
-     * @throws InvalidArgumentException
182
-     * @throws ReflectionException
183
-     * @throws InvalidDataTypeException
184
-     * @throws InvalidInterfaceException
185
-     */
186
-    public function __construct($routing = true)
187
-    {
188
-        $this->loader = LoaderFactory::getLoader();
189
-        if (strpos($this->_get_dir(), 'caffeinated') !== false) {
190
-            $this->_is_caf = true;
191
-        }
192
-        $this->_yes_no_values = array(
193
-            array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
194
-            array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
195
-        );
196
-        // set the _req_data property.
197
-        $this->_req_data = array_merge($_GET, $_POST);
198
-        // routing enabled?
199
-        $this->_routing = $routing;
200
-        // set initial page props (child method)
201
-        $this->_init_page_props();
202
-        // set global defaults
203
-        $this->_set_defaults();
204
-        // set early because incoming requests could be ajax related and we need to register those hooks.
205
-        $this->_global_ajax_hooks();
206
-        $this->_ajax_hooks();
207
-        // other_page_hooks have to be early too.
208
-        $this->_do_other_page_hooks();
209
-        // This just allows us to have extending classes do something specific
210
-        // before the parent constructor runs _page_setup().
211
-        if (method_exists($this, '_before_page_setup')) {
212
-            $this->_before_page_setup();
213
-        }
214
-        // set up page dependencies
215
-        $this->_page_setup();
216
-    }
217
-
218
-
219
-    /**
220
-     * _init_page_props
221
-     * Child classes use to set at least the following properties:
222
-     * $page_slug.
223
-     * $page_label.
224
-     *
225
-     * @abstract
226
-     * @return void
227
-     */
228
-    abstract protected function _init_page_props();
229
-
230
-
231
-    /**
232
-     * _ajax_hooks
233
-     * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
234
-     * Note: within the ajax callback methods.
235
-     *
236
-     * @abstract
237
-     * @return void
238
-     */
239
-    abstract protected function _ajax_hooks();
240
-
241
-
242
-    /**
243
-     * _define_page_props
244
-     * child classes define page properties in here.  Must include at least:
245
-     * $_admin_base_url = base_url for all admin pages
246
-     * $_admin_page_title = default admin_page_title for admin pages
247
-     * $_labels = array of default labels for various automatically generated elements:
248
-     *    array(
249
-     *        'buttons' => array(
250
-     *            'add' => esc_html__('label for add new button'),
251
-     *            'edit' => esc_html__('label for edit button'),
252
-     *            'delete' => esc_html__('label for delete button')
253
-     *            )
254
-     *        )
255
-     *
256
-     * @abstract
257
-     * @return void
258
-     */
259
-    abstract protected function _define_page_props();
260
-
261
-
262
-    /**
263
-     * _set_page_routes
264
-     * child classes use this to define the page routes for all subpages handled by the class.  Page routes are
265
-     * assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also
266
-     * have a 'default' route. Here's the format
267
-     * $this->_page_routes = array(
268
-     *        'default' => array(
269
-     *            'func' => '_default_method_handling_route',
270
-     *            'args' => array('array','of','args'),
271
-     *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e.
272
-     *            ajax request, backend processing)
273
-     *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a
274
-     *            headers route after.  The string you enter here should match the defined route reference for a
275
-     *            headers sent route.
276
-     *            'capability' => 'route_capability', //indicate a string for minimum capability required to access
277
-     *            this route.
278
-     *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability
279
-     *            checks).
280
-     *        ),
281
-     *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a
282
-     *        handling method.
283
-     *        )
284
-     * )
285
-     *
286
-     * @abstract
287
-     * @return void
288
-     */
289
-    abstract protected function _set_page_routes();
290
-
291
-
292
-    /**
293
-     * _set_page_config
294
-     * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the
295
-     * array corresponds to the page_route for the loaded page. Format:
296
-     * $this->_page_config = array(
297
-     *        'default' => array(
298
-     *            'labels' => array(
299
-     *                'buttons' => array(
300
-     *                    'add' => esc_html__('label for adding item'),
301
-     *                    'edit' => esc_html__('label for editing item'),
302
-     *                    'delete' => esc_html__('label for deleting item')
303
-     *                ),
304
-     *                'publishbox' => esc_html__('Localized Title for Publish metabox', 'event_espresso')
305
-     *            ), //optional an array of custom labels for various automatically generated elements to use on the
306
-     *            page. If this isn't present then the defaults will be used as set for the $this->_labels in
307
-     *            _define_page_props() method
308
-     *            'nav' => array(
309
-     *                'label' => esc_html__('Label for Tab', 'event_espresso').
310
-     *                'url' => 'http://someurl', //automatically generated UNLESS you define
311
-     *                'css_class' => 'css-class', //automatically generated UNLESS you define
312
-     *                'order' => 10, //required to indicate tab position.
313
-     *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is
314
-     *                displayed then add this parameter.
315
-     *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
316
-     *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load
317
-     *            metaboxes set for eventespresso admin pages.
318
-     *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have
319
-     *            metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added
320
-     *            later.  We just use this flag to make sure the necessary js gets enqueued on page load.
321
-     *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the
322
-     *            given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
323
-     *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The
324
-     *            array indicates the max number of columns (4) and the default number of columns on page load (2).
325
-     *            There is an option in the "screen_options" dropdown that is setup so users can pick what columns they
326
-     *            want to display.
327
-     *            'help_tabs' => array( //this is used for adding help tabs to a page
328
-     *                'tab_id' => array(
329
-     *                    'title' => 'tab_title',
330
-     *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting
331
-     *                    help tab content.  The fallback if it isn't present is to try a the callback.  Filename
332
-     *                    should match a file in the admin folder's "help_tabs" dir (ie..
333
-     *                    events/help_tabs/name_of_file_containing_content.help_tab.php)
334
-     *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will
335
-     *                    attempt to use the callback which should match the name of a method in the class
336
-     *                    ),
337
-     *                'tab2_id' => array(
338
-     *                    'title' => 'tab2 title',
339
-     *                    'filename' => 'file_name_2'
340
-     *                    'callback' => 'callback_method_for_content',
341
-     *                 ),
342
-     *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the
343
-     *            help tab area on an admin page. @link
344
-     *            http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
345
-     *            'help_tour' => array(
346
-     *                'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located
347
-     *                in a folder for this admin page named "help_tours", a file name matching the key given here
348
-     *                (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
349
-     *            ),
350
-     *            'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is
351
-     *            true if it isn't present).  To remove the requirement for a nonce check when this route is visited
352
-     *            just set
353
-     *            'require_nonce' to FALSE
354
-     *            )
355
-     * )
356
-     *
357
-     * @abstract
358
-     * @return void
359
-     */
360
-    abstract protected function _set_page_config();
361
-
362
-
363
-
364
-
365
-
366
-    /** end sample help_tour methods **/
367
-    /**
368
-     * _add_screen_options
369
-     * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for
370
-     * doing so. Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options
371
-     * to a particular view.
372
-     *
373
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
374
-     *         see also WP_Screen object documents...
375
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
376
-     * @abstract
377
-     * @return void
378
-     */
379
-    abstract protected function _add_screen_options();
380
-
381
-
382
-    /**
383
-     * _add_feature_pointers
384
-     * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
385
-     * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a
386
-     * particular view. Note: this is just a placeholder for now.  Implementation will come down the road See:
387
-     * WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
388
-     * extended) also see:
389
-     *
390
-     * @link   http://eamann.com/tech/wordpress-portland/
391
-     * @abstract
392
-     * @return void
393
-     */
394
-    abstract protected function _add_feature_pointers();
395
-
396
-
397
-    /**
398
-     * load_scripts_styles
399
-     * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for
400
-     * their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific
401
-     * scripts/styles per view by putting them in a dynamic function in this format
402
-     * (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
403
-     *
404
-     * @abstract
405
-     * @return void
406
-     */
407
-    abstract public function load_scripts_styles();
408
-
409
-
410
-    /**
411
-     * admin_init
412
-     * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to
413
-     * all pages/views loaded by child class.
414
-     *
415
-     * @abstract
416
-     * @return void
417
-     */
418
-    abstract public function admin_init();
419
-
420
-
421
-    /**
422
-     * admin_notices
423
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to
424
-     * all pages/views loaded by child class.
425
-     *
426
-     * @abstract
427
-     * @return void
428
-     */
429
-    abstract public function admin_notices();
430
-
431
-
432
-    /**
433
-     * admin_footer_scripts
434
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
435
-     * will apply to all pages/views loaded by child class.
436
-     *
437
-     * @return void
438
-     */
439
-    abstract public function admin_footer_scripts();
440
-
441
-
442
-    /**
443
-     * admin_footer
444
-     * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will
445
-     * apply to all pages/views loaded by child class.
446
-     *
447
-     * @return void
448
-     */
449
-    public function admin_footer()
450
-    {
451
-    }
452
-
453
-
454
-    /**
455
-     * _global_ajax_hooks
456
-     * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
457
-     * Note: within the ajax callback methods.
458
-     *
459
-     * @abstract
460
-     * @return void
461
-     */
462
-    protected function _global_ajax_hooks()
463
-    {
464
-        // for lazy loading of metabox content
465
-        add_action('wp_ajax_espresso-ajax-content', array($this, 'ajax_metabox_content'), 10);
466
-    }
467
-
468
-
469
-    public function ajax_metabox_content()
470
-    {
471
-        $contentid = isset($this->_req_data['contentid']) ? $this->_req_data['contentid'] : '';
472
-        $url = isset($this->_req_data['contenturl']) ? $this->_req_data['contenturl'] : '';
473
-        self::cached_rss_display($contentid, $url);
474
-        wp_die();
475
-    }
476
-
477
-
478
-    /**
479
-     * _page_setup
480
-     * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested
481
-     * doesn't match the object.
482
-     *
483
-     * @final
484
-     * @return void
485
-     * @throws EE_Error
486
-     * @throws InvalidArgumentException
487
-     * @throws ReflectionException
488
-     * @throws InvalidDataTypeException
489
-     * @throws InvalidInterfaceException
490
-     */
491
-    final protected function _page_setup()
492
-    {
493
-        // requires?
494
-        // 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.
495
-        add_action('admin_init', array($this, 'admin_init_global'), 5);
496
-        // next verify if we need to load anything...
497
-        $this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
498
-        $this->page_folder = strtolower(
499
-            str_replace(array('_Admin_Page', 'Extend_'), '', get_class($this))
500
-        );
501
-        global $ee_menu_slugs;
502
-        $ee_menu_slugs = (array) $ee_menu_slugs;
503
-        if (! defined('DOING_AJAX') && (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))) {
504
-            return;
505
-        }
506
-        // 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
507
-        if (isset($this->_req_data['action2']) && $this->_req_data['action'] === '-1') {
508
-            $this->_req_data['action'] = ! empty($this->_req_data['action2']) && $this->_req_data['action2'] !== '-1'
509
-                ? $this->_req_data['action2']
510
-                : $this->_req_data['action'];
511
-        }
512
-        // then set blank or -1 action values to 'default'
513
-        $this->_req_action = isset($this->_req_data['action'])
514
-                             && ! empty($this->_req_data['action'])
515
-                             && $this->_req_data['action'] !== '-1'
516
-            ? sanitize_key($this->_req_data['action'])
517
-            : 'default';
518
-        // if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.
519
-        //  This covers cases where we're coming in from a list table that isn't on the default route.
520
-        $this->_req_action = $this->_req_action === 'default' && isset($this->_req_data['route'])
521
-            ? $this->_req_data['route'] : $this->_req_action;
522
-        // however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
523
-        $this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route'])
524
-            ? $this->_req_data['route']
525
-            : $this->_req_action;
526
-        $this->_current_view = $this->_req_action;
527
-        $this->_req_nonce = $this->_req_action . '_nonce';
528
-        $this->_define_page_props();
529
-        $this->_current_page_view_url = add_query_arg(
530
-            array('page' => $this->_current_page, 'action' => $this->_current_view),
531
-            $this->_admin_base_url
532
-        );
533
-        // default things
534
-        $this->_default_espresso_metaboxes = array(
535
-            '_espresso_news_post_box',
536
-            '_espresso_links_post_box',
537
-            '_espresso_ratings_request',
538
-            '_espresso_sponsors_post_box',
539
-        );
540
-        // set page configs
541
-        $this->_set_page_routes();
542
-        $this->_set_page_config();
543
-        // let's include any referrer data in our default_query_args for this route for "stickiness".
544
-        if (isset($this->_req_data['wp_referer'])) {
545
-            $this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
546
-        }
547
-        // for caffeinated and other extended functionality.
548
-        //  If there is a _extend_page_config method
549
-        // then let's run that to modify the all the various page configuration arrays
550
-        if (method_exists($this, '_extend_page_config')) {
551
-            $this->_extend_page_config();
552
-        }
553
-        // for CPT and other extended functionality.
554
-        // If there is an _extend_page_config_for_cpt
555
-        // then let's run that to modify all the various page configuration arrays.
556
-        if (method_exists($this, '_extend_page_config_for_cpt')) {
557
-            $this->_extend_page_config_for_cpt();
558
-        }
559
-        // filter routes and page_config so addons can add their stuff. Filtering done per class
560
-        $this->_page_routes = apply_filters(
561
-            'FHEE__' . get_class($this) . '__page_setup__page_routes',
562
-            $this->_page_routes,
563
-            $this
564
-        );
565
-        $this->_page_config = apply_filters(
566
-            'FHEE__' . get_class($this) . '__page_setup__page_config',
567
-            $this->_page_config,
568
-            $this
569
-        );
570
-        // if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
571
-        // then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
572
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
573
-            add_action(
574
-                'AHEE__EE_Admin_Page__route_admin_request',
575
-                array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view),
576
-                10,
577
-                2
578
-            );
579
-        }
580
-        // next route only if routing enabled
581
-        if ($this->_routing && ! defined('DOING_AJAX')) {
582
-            $this->_verify_routes();
583
-            // next let's just check user_access and kill if no access
584
-            $this->check_user_access();
585
-            if ($this->_is_UI_request) {
586
-                // admin_init stuff - global, all views for this page class, specific view
587
-                add_action('admin_init', array($this, 'admin_init'), 10);
588
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
589
-                    add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
590
-                }
591
-            } else {
592
-                // hijack regular WP loading and route admin request immediately
593
-                @ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
594
-                $this->route_admin_request();
595
-            }
596
-        }
597
-    }
598
-
599
-
600
-    /**
601
-     * Provides a way for related child admin pages to load stuff on the loaded admin page.
602
-     *
603
-     * @return void
604
-     * @throws ReflectionException
605
-     * @throws EE_Error
606
-     */
607
-    private function _do_other_page_hooks()
608
-    {
609
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
610
-        foreach ($registered_pages as $page) {
611
-            // now let's setup the file name and class that should be present
612
-            $classname = str_replace('.class.php', '', $page);
613
-            // autoloaders should take care of loading file
614
-            if (! class_exists($classname)) {
615
-                $error_msg[] = sprintf(
616
-                    esc_html__(
617
-                        'Something went wrong with loading the %s admin hooks page.',
618
-                        'event_espresso'
619
-                    ),
620
-                    $page
621
-                );
622
-                $error_msg[] = $error_msg[0]
623
-                               . "\r\n"
624
-                               . sprintf(
625
-                                   esc_html__(
626
-                                       'There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
627
-                                       'event_espresso'
628
-                                   ),
629
-                                   $page,
630
-                                   '<br />',
631
-                                   '<strong>' . $classname . '</strong>'
632
-                               );
633
-                throw new EE_Error(implode('||', $error_msg));
634
-            }
635
-            $a = new ReflectionClass($classname);
636
-            // notice we are passing the instance of this class to the hook object.
637
-            $hookobj[] = $a->newInstance($this);
638
-        }
639
-    }
640
-
641
-
642
-    public function load_page_dependencies()
643
-    {
644
-        try {
645
-            $this->_load_page_dependencies();
646
-        } catch (EE_Error $e) {
647
-            $e->get_error();
648
-        }
649
-    }
650
-
651
-
652
-    /**
653
-     * load_page_dependencies
654
-     * loads things specific to this page class when its loaded.  Really helps with efficiency.
655
-     *
656
-     * @return void
657
-     * @throws DomainException
658
-     * @throws EE_Error
659
-     * @throws InvalidArgumentException
660
-     * @throws InvalidDataTypeException
661
-     * @throws InvalidInterfaceException
662
-     * @throws ReflectionException
663
-     */
664
-    protected function _load_page_dependencies()
665
-    {
666
-        // let's set the current_screen and screen options to override what WP set
667
-        $this->_current_screen = get_current_screen();
668
-        // load admin_notices - global, page class, and view specific
669
-        add_action('admin_notices', array($this, 'admin_notices_global'), 5);
670
-        add_action('admin_notices', array($this, 'admin_notices'), 10);
671
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
672
-            add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
673
-        }
674
-        // load network admin_notices - global, page class, and view specific
675
-        add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
676
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
677
-            add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
678
-        }
679
-        // this will save any per_page screen options if they are present
680
-        $this->_set_per_page_screen_options();
681
-        // setup list table properties
682
-        $this->_set_list_table();
683
-        // child classes can "register" a metabox to be automatically handled via the _page_config array property.
684
-        // However in some cases the metaboxes will need to be added within a route handling callback.
685
-        $this->_add_registered_meta_boxes();
686
-        $this->_add_screen_columns();
687
-        // add screen options - global, page child class, and view specific
688
-        $this->_add_global_screen_options();
689
-        $this->_add_screen_options();
690
-        $add_screen_options = "_add_screen_options_{$this->_current_view}";
691
-        if (method_exists($this, $add_screen_options)) {
692
-            $this->{$add_screen_options}();
693
-        }
694
-        // add help tab(s) and tours- set via page_config and qtips.
695
-        $this->_add_help_tour();
696
-        $this->_add_help_tabs();
697
-        $this->_add_qtips();
698
-        // add feature_pointers - global, page child class, and view specific
699
-        $this->_add_feature_pointers();
700
-        $this->_add_global_feature_pointers();
701
-        $add_feature_pointer = "_add_feature_pointer_{$this->_current_view}";
702
-        if (method_exists($this, $add_feature_pointer)) {
703
-            $this->{$add_feature_pointer}();
704
-        }
705
-        // enqueue scripts/styles - global, page class, and view specific
706
-        add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
707
-        add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
708
-        if (method_exists($this, "load_scripts_styles_{$this->_current_view}")) {
709
-            add_action('admin_enqueue_scripts', array($this, "load_scripts_styles_{$this->_current_view}"), 15);
710
-        }
711
-        add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
712
-        // admin_print_footer_scripts - global, page child class, and view specific.
713
-        // NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.
714
-        // In most cases that's doing_it_wrong().  But adding hidden container elements etc.
715
-        // is a good use case. Notice the late priority we're giving these
716
-        add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
717
-        add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
718
-        if (method_exists($this, "admin_footer_scripts_{$this->_current_view}")) {
719
-            add_action('admin_print_footer_scripts', array($this, "admin_footer_scripts_{$this->_current_view}"), 101);
720
-        }
721
-        // admin footer scripts
722
-        add_action('admin_footer', array($this, 'admin_footer_global'), 99);
723
-        add_action('admin_footer', array($this, 'admin_footer'), 100);
724
-        if (method_exists($this, "admin_footer_{$this->_current_view}")) {
725
-            add_action('admin_footer', array($this, "admin_footer_{$this->_current_view}"), 101);
726
-        }
727
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
728
-        // targeted hook
729
-        do_action(
730
-            "FHEE__EE_Admin_Page___load_page_dependencies__after_load__{$this->page_slug}__{$this->_req_action}"
731
-        );
732
-    }
733
-
734
-
735
-    /**
736
-     * _set_defaults
737
-     * This sets some global defaults for class properties.
738
-     */
739
-    private function _set_defaults()
740
-    {
741
-        $this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = null;
742
-        $this->_event = $this->_template_path = $this->_column_template_path = null;
743
-        $this->_nav_tabs = $this->_views = $this->_page_routes = array();
744
-        $this->_page_config = $this->_default_route_query_args = array();
745
-        $this->_default_nav_tab_name = 'overview';
746
-        // init template args
747
-        $this->_template_args = array(
748
-            'admin_page_header'  => '',
749
-            'admin_page_content' => '',
750
-            'post_body_content'  => '',
751
-            'before_list_table'  => '',
752
-            'after_list_table'   => '',
753
-        );
754
-    }
755
-
756
-
757
-    /**
758
-     * route_admin_request
759
-     *
760
-     * @see    _route_admin_request()
761
-     * @return exception|void error
762
-     * @throws InvalidArgumentException
763
-     * @throws InvalidInterfaceException
764
-     * @throws InvalidDataTypeException
765
-     * @throws EE_Error
766
-     * @throws ReflectionException
767
-     */
768
-    public function route_admin_request()
769
-    {
770
-        try {
771
-            $this->_route_admin_request();
772
-        } catch (EE_Error $e) {
773
-            $e->get_error();
774
-        }
775
-    }
776
-
777
-
778
-    public function set_wp_page_slug($wp_page_slug)
779
-    {
780
-        $this->_wp_page_slug = $wp_page_slug;
781
-        // if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
782
-        if (is_network_admin()) {
783
-            $this->_wp_page_slug .= '-network';
784
-        }
785
-    }
786
-
787
-
788
-    /**
789
-     * _verify_routes
790
-     * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so
791
-     * we know if we need to drop out.
792
-     *
793
-     * @return bool
794
-     * @throws EE_Error
795
-     */
796
-    protected function _verify_routes()
797
-    {
798
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
799
-        if (! $this->_current_page && ! defined('DOING_AJAX')) {
800
-            return false;
801
-        }
802
-        $this->_route = false;
803
-        // check that the page_routes array is not empty
804
-        if (empty($this->_page_routes)) {
805
-            // user error msg
806
-            $error_msg = sprintf(
807
-                esc_html__('No page routes have been set for the %s admin page.', 'event_espresso'),
808
-                $this->_admin_page_title
809
-            );
810
-            // developer error msg
811
-            $error_msg .= '||' . $error_msg
812
-                          . esc_html__(
813
-                              ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
814
-                              'event_espresso'
815
-                          );
816
-            throw new EE_Error($error_msg);
817
-        }
818
-        // and that the requested page route exists
819
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
820
-            $this->_route = $this->_page_routes[ $this->_req_action ];
821
-            $this->_route_config = isset($this->_page_config[ $this->_req_action ])
822
-                ? $this->_page_config[ $this->_req_action ] : array();
823
-        } else {
824
-            // user error msg
825
-            $error_msg = sprintf(
826
-                esc_html__(
827
-                    'The requested page route does not exist for the %s admin page.',
828
-                    'event_espresso'
829
-                ),
830
-                $this->_admin_page_title
831
-            );
832
-            // developer error msg
833
-            $error_msg .= '||' . $error_msg
834
-                          . sprintf(
835
-                              esc_html__(
836
-                                  ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
837
-                                  'event_espresso'
838
-                              ),
839
-                              $this->_req_action
840
-                          );
841
-            throw new EE_Error($error_msg);
842
-        }
843
-        // and that a default route exists
844
-        if (! array_key_exists('default', $this->_page_routes)) {
845
-            // user error msg
846
-            $error_msg = sprintf(
847
-                esc_html__(
848
-                    'A default page route has not been set for the % admin page.',
849
-                    'event_espresso'
850
-                ),
851
-                $this->_admin_page_title
852
-            );
853
-            // developer error msg
854
-            $error_msg .= '||' . $error_msg
855
-                          . esc_html__(
856
-                              ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
857
-                              'event_espresso'
858
-                          );
859
-            throw new EE_Error($error_msg);
860
-        }
861
-        // first lets' catch if the UI request has EVER been set.
862
-        if ($this->_is_UI_request === null) {
863
-            // lets set if this is a UI request or not.
864
-            $this->_is_UI_request = ! isset($this->_req_data['noheader']) || $this->_req_data['noheader'] !== true;
865
-            // wait a minute... we might have a noheader in the route array
866
-            $this->_is_UI_request = is_array($this->_route)
867
-                                    && isset($this->_route['noheader'])
868
-                                    && $this->_route['noheader'] ? false : $this->_is_UI_request;
869
-        }
870
-        $this->_set_current_labels();
871
-        return true;
872
-    }
873
-
874
-
875
-    /**
876
-     * this method simply verifies a given route and makes sure its an actual route available for the loaded page
877
-     *
878
-     * @param  string $route the route name we're verifying
879
-     * @return mixed (bool|Exception)      we'll throw an exception if this isn't a valid route.
880
-     * @throws EE_Error
881
-     */
882
-    protected function _verify_route($route)
883
-    {
884
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
885
-            return true;
886
-        }
887
-        // user error msg
888
-        $error_msg = sprintf(
889
-            esc_html__('The given page route does not exist for the %s admin page.', 'event_espresso'),
890
-            $this->_admin_page_title
891
-        );
892
-        // developer error msg
893
-        $error_msg .= '||' . $error_msg
894
-                      . sprintf(
895
-                          esc_html__(
896
-                              ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
897
-                              'event_espresso'
898
-                          ),
899
-                          $route
900
-                      );
901
-        throw new EE_Error($error_msg);
902
-    }
903
-
904
-
905
-    /**
906
-     * perform nonce verification
907
-     * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces
908
-     * using this method (and save retyping!)
909
-     *
910
-     * @param  string $nonce     The nonce sent
911
-     * @param  string $nonce_ref The nonce reference string (name0)
912
-     * @return void
913
-     * @throws EE_Error
914
-     */
915
-    protected function _verify_nonce($nonce, $nonce_ref)
916
-    {
917
-        // verify nonce against expected value
918
-        if (! wp_verify_nonce($nonce, $nonce_ref)) {
919
-            // these are not the droids you are looking for !!!
920
-            $msg = sprintf(
921
-                esc_html__('%sNonce Fail.%s', 'event_espresso'),
922
-                '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">',
923
-                '</a>'
924
-            );
925
-            if (WP_DEBUG) {
926
-                $msg .= "\n  "
927
-                        . sprintf(
928
-                            esc_html__(
929
-                                'In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!',
930
-                                'event_espresso'
931
-                            ),
932
-                            __CLASS__
933
-                        );
934
-            }
935
-            if (! defined('DOING_AJAX')) {
936
-                wp_die($msg);
937
-            } else {
938
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
939
-                $this->_return_json();
940
-            }
941
-        }
942
-    }
943
-
944
-
945
-    /**
946
-     * _route_admin_request()
947
-     * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
948
-     * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
949
-     * in the page routes and then will try to load the corresponding method.
950
-     *
951
-     * @return void
952
-     * @throws EE_Error
953
-     * @throws InvalidArgumentException
954
-     * @throws InvalidDataTypeException
955
-     * @throws InvalidInterfaceException
956
-     * @throws ReflectionException
957
-     */
958
-    protected function _route_admin_request()
959
-    {
960
-        if (! $this->_is_UI_request) {
961
-            $this->_verify_routes();
962
-        }
963
-        $nonce_check = isset($this->_route_config['require_nonce'])
964
-            ? $this->_route_config['require_nonce']
965
-            : true;
966
-        if ($this->_req_action !== 'default' && $nonce_check) {
967
-            // set nonce from post data
968
-            $nonce = isset($this->_req_data[ $this->_req_nonce ])
969
-                ? sanitize_text_field($this->_req_data[ $this->_req_nonce ])
970
-                : '';
971
-            $this->_verify_nonce($nonce, $this->_req_nonce);
972
-        }
973
-        // set the nav_tabs array but ONLY if this is  UI_request
974
-        if ($this->_is_UI_request) {
975
-            $this->_set_nav_tabs();
976
-        }
977
-        // grab callback function
978
-        $func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
979
-        // check if callback has args
980
-        $args = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : array();
981
-        $error_msg = '';
982
-        // action right before calling route
983
-        // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
984
-        if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
985
-            do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
986
-        }
987
-        // right before calling the route, let's remove _wp_http_referer from the
988
-        // $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
989
-        $_SERVER['REQUEST_URI'] = remove_query_arg(
990
-            '_wp_http_referer',
991
-            wp_unslash($_SERVER['REQUEST_URI'])
992
-        );
993
-        if (! empty($func)) {
994
-            if (is_array($func)) {
995
-                list($class, $method) = $func;
996
-            } elseif (strpos($func, '::') !== false) {
997
-                list($class, $method) = explode('::', $func);
998
-            } else {
999
-                $class = $this;
1000
-                $method = $func;
1001
-            }
1002
-            if (! (is_object($class) && $class === $this)) {
1003
-                // send along this admin page object for access by addons.
1004
-                $args['admin_page_object'] = $this;
1005
-            }
1006
-            if (// is it a method on a class that doesn't work?
1007
-                (
1008
-                    (
1009
-                        method_exists($class, $method)
1010
-                        && call_user_func_array(array($class, $method), $args) === false
1011
-                    )
1012
-                    && (
1013
-                        // is it a standalone function that doesn't work?
1014
-                        function_exists($method)
1015
-                        && call_user_func_array(
1016
-                            $func,
1017
-                            array_merge(array('admin_page_object' => $this), $args)
1018
-                        ) === false
1019
-                    )
1020
-                )
1021
-                || (
1022
-                    // is it neither a class method NOR a standalone function?
1023
-                    ! method_exists($class, $method)
1024
-                    && ! function_exists($method)
1025
-                )
1026
-            ) {
1027
-                // user error msg
1028
-                $error_msg = esc_html__(
1029
-                    'An error occurred. The  requested page route could not be found.',
1030
-                    'event_espresso'
1031
-                );
1032
-                // developer error msg
1033
-                $error_msg .= '||';
1034
-                $error_msg .= sprintf(
1035
-                    esc_html__(
1036
-                        'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
1037
-                        'event_espresso'
1038
-                    ),
1039
-                    $method
1040
-                );
1041
-            }
1042
-            if (! empty($error_msg)) {
1043
-                throw new EE_Error($error_msg);
1044
-            }
1045
-        }
1046
-        // if we've routed and this route has a no headers route AND a sent_headers_route,
1047
-        // then we need to reset the routing properties to the new route.
1048
-        // 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.
1049
-        if ($this->_is_UI_request === false
1050
-            && is_array($this->_route)
1051
-            && ! empty($this->_route['headers_sent_route'])
1052
-        ) {
1053
-            $this->_reset_routing_properties($this->_route['headers_sent_route']);
1054
-        }
1055
-    }
1056
-
1057
-
1058
-    /**
1059
-     * This method just allows the resetting of page properties in the case where a no headers
1060
-     * route redirects to a headers route in its route config.
1061
-     *
1062
-     * @since   4.3.0
1063
-     * @param  string $new_route New (non header) route to redirect to.
1064
-     * @return   void
1065
-     * @throws ReflectionException
1066
-     * @throws InvalidArgumentException
1067
-     * @throws InvalidInterfaceException
1068
-     * @throws InvalidDataTypeException
1069
-     * @throws EE_Error
1070
-     */
1071
-    protected function _reset_routing_properties($new_route)
1072
-    {
1073
-        $this->_is_UI_request = true;
1074
-        // now we set the current route to whatever the headers_sent_route is set at
1075
-        $this->_req_data['action'] = $new_route;
1076
-        // rerun page setup
1077
-        $this->_page_setup();
1078
-    }
1079
-
1080
-
1081
-    /**
1082
-     * _add_query_arg
1083
-     * adds nonce to array of arguments then calls WP add_query_arg function
1084
-     *(internally just uses EEH_URL's function with the same name)
1085
-     *
1086
-     * @param array  $args
1087
-     * @param string $url
1088
-     * @param bool   $sticky                  if true, then the existing Request params will be appended to the
1089
-     *                                        generated url in an associative array indexed by the key 'wp_referer';
1090
-     *                                        Example usage: If the current page is:
1091
-     *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
1092
-     *                                        &action=default&event_id=20&month_range=March%202015
1093
-     *                                        &_wpnonce=5467821
1094
-     *                                        and you call:
1095
-     *                                        EE_Admin_Page::add_query_args_and_nonce(
1096
-     *                                        array(
1097
-     *                                        'action' => 'resend_something',
1098
-     *                                        'page=>espresso_registrations'
1099
-     *                                        ),
1100
-     *                                        $some_url,
1101
-     *                                        true
1102
-     *                                        );
1103
-     *                                        It will produce a url in this structure:
1104
-     *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
1105
-     *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
1106
-     *                                        month_range]=March%202015
1107
-     * @param   bool $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
1108
-     * @return string
1109
-     */
1110
-    public static function add_query_args_and_nonce(
1111
-        $args = array(),
1112
-        $url = false,
1113
-        $sticky = false,
1114
-        $exclude_nonce = false
1115
-    ) {
1116
-        // if there is a _wp_http_referer include the values from the request but only if sticky = true
1117
-        if ($sticky) {
1118
-            $request = $_REQUEST;
1119
-            unset($request['_wp_http_referer']);
1120
-            unset($request['wp_referer']);
1121
-            foreach ($request as $key => $value) {
1122
-                // do not add nonces
1123
-                if (strpos($key, 'nonce') !== false) {
1124
-                    continue;
1125
-                }
1126
-                $args[ 'wp_referer[' . $key . ']' ] = $value;
1127
-            }
1128
-        }
1129
-        return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
1130
-    }
1131
-
1132
-
1133
-    /**
1134
-     * This returns a generated link that will load the related help tab.
1135
-     *
1136
-     * @param  string $help_tab_id the id for the connected help tab
1137
-     * @param  string $icon_style  (optional) include css class for the style you want to use for the help icon.
1138
-     * @param  string $help_text   (optional) send help text you want to use for the link if default not to be used
1139
-     * @uses EEH_Template::get_help_tab_link()
1140
-     * @return string              generated link
1141
-     */
1142
-    protected function _get_help_tab_link($help_tab_id, $icon_style = '', $help_text = '')
1143
-    {
1144
-        return EEH_Template::get_help_tab_link(
1145
-            $help_tab_id,
1146
-            $this->page_slug,
1147
-            $this->_req_action,
1148
-            $icon_style,
1149
-            $help_text
1150
-        );
1151
-    }
1152
-
1153
-
1154
-    /**
1155
-     * _add_help_tabs
1156
-     * Note child classes define their help tabs within the page_config array.
1157
-     *
1158
-     * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
1159
-     * @return void
1160
-     * @throws DomainException
1161
-     * @throws EE_Error
1162
-     */
1163
-    protected function _add_help_tabs()
1164
-    {
1165
-        $tour_buttons = '';
1166
-        if (isset($this->_page_config[ $this->_req_action ])) {
1167
-            $config = $this->_page_config[ $this->_req_action ];
1168
-            // is there a help tour for the current route?  if there is let's setup the tour buttons
1169
-            if (isset($this->_help_tour[ $this->_req_action ])) {
1170
-                $tb = array();
1171
-                $tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
1172
-                foreach ($this->_help_tour['tours'] as $tour) {
1173
-                    // if this is the end tour then we don't need to setup a button
1174
-                    if ($tour instanceof EE_Help_Tour_final_stop || ! $tour instanceof EE_Help_Tour) {
1175
-                        continue;
1176
-                    }
1177
-                    $tb[] = '<button id="trigger-tour-'
1178
-                            . $tour->get_slug()
1179
-                            . '" class="button-primary trigger-ee-help-tour">'
1180
-                            . $tour->get_label()
1181
-                            . '</button>';
1182
-                }
1183
-                $tour_buttons .= implode('<br />', $tb);
1184
-                $tour_buttons .= '</div></div>';
1185
-            }
1186
-            // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
1187
-            if (is_array($config) && isset($config['help_sidebar'])) {
1188
-                // check that the callback given is valid
1189
-                if (! method_exists($this, $config['help_sidebar'])) {
1190
-                    throw new EE_Error(
1191
-                        sprintf(
1192
-                            esc_html__(
1193
-                                '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',
1194
-                                'event_espresso'
1195
-                            ),
1196
-                            $config['help_sidebar'],
1197
-                            get_class($this)
1198
-                        )
1199
-                    );
1200
-                }
1201
-                $content = apply_filters(
1202
-                    'FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar',
1203
-                    $this->{$config['help_sidebar']}()
1204
-                );
1205
-                $content .= $tour_buttons; // add help tour buttons.
1206
-                // do we have any help tours setup?  Cause if we do we want to add the buttons
1207
-                $this->_current_screen->set_help_sidebar($content);
1208
-            }
1209
-            // if we DON'T have config help sidebar and there ARE tour buttons then we'll just add the tour buttons to the sidebar.
1210
-            if (! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
1211
-                $this->_current_screen->set_help_sidebar($tour_buttons);
1212
-            }
1213
-            // handle if no help_tabs are set so the sidebar will still show for the help tour buttons
1214
-            if (! isset($config['help_tabs']) && ! empty($tour_buttons)) {
1215
-                $_ht['id'] = $this->page_slug;
1216
-                $_ht['title'] = esc_html__('Help Tours', 'event_espresso');
1217
-                $_ht['content'] = '<p>'
1218
-                                  . esc_html__(
1219
-                                      'The buttons to the right allow you to start/restart any help tours available for this page',
1220
-                                      'event_espresso'
1221
-                                  ) . '</p>';
1222
-                $this->_current_screen->add_help_tab($_ht);
1223
-            }
1224
-            if (! isset($config['help_tabs'])) {
1225
-                return;
1226
-            } //no help tabs for this route
1227
-            foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
1228
-                // we're here so there ARE help tabs!
1229
-                // make sure we've got what we need
1230
-                if (! isset($cfg['title'])) {
1231
-                    throw new EE_Error(
1232
-                        esc_html__(
1233
-                            'The _page_config array is not set up properly for help tabs.  It is missing a title',
1234
-                            'event_espresso'
1235
-                        )
1236
-                    );
1237
-                }
1238
-                if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
1239
-                    throw new EE_Error(
1240
-                        esc_html__(
1241
-                            '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',
1242
-                            'event_espresso'
1243
-                        )
1244
-                    );
1245
-                }
1246
-                // first priority goes to content.
1247
-                if (! empty($cfg['content'])) {
1248
-                    $content = ! empty($cfg['content']) ? $cfg['content'] : null;
1249
-                    // second priority goes to filename
1250
-                } elseif (! empty($cfg['filename'])) {
1251
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
1252
-                    // 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)
1253
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
1254
-                                                             . basename($this->_get_dir())
1255
-                                                             . '/help_tabs/'
1256
-                                                             . $cfg['filename']
1257
-                                                             . '.help_tab.php' : $file_path;
1258
-                    // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1259
-                    if (! isset($cfg['callback']) && ! is_readable($file_path)) {
1260
-                        EE_Error::add_error(
1261
-                            sprintf(
1262
-                                esc_html__(
1263
-                                    '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',
1264
-                                    'event_espresso'
1265
-                                ),
1266
-                                $tab_id,
1267
-                                key($config),
1268
-                                $file_path
1269
-                            ),
1270
-                            __FILE__,
1271
-                            __FUNCTION__,
1272
-                            __LINE__
1273
-                        );
1274
-                        return;
1275
-                    }
1276
-                    $template_args['admin_page_obj'] = $this;
1277
-                    $content = EEH_Template::display_template(
1278
-                        $file_path,
1279
-                        $template_args,
1280
-                        true
1281
-                    );
1282
-                } else {
1283
-                    $content = '';
1284
-                }
1285
-                // check if callback is valid
1286
-                if (empty($content) && (
1287
-                        ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback'])
1288
-                    )
1289
-                ) {
1290
-                    EE_Error::add_error(
1291
-                        sprintf(
1292
-                            esc_html__(
1293
-                                '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.',
1294
-                                'event_espresso'
1295
-                            ),
1296
-                            $cfg['title']
1297
-                        ),
1298
-                        __FILE__,
1299
-                        __FUNCTION__,
1300
-                        __LINE__
1301
-                    );
1302
-                    return;
1303
-                }
1304
-                // setup config array for help tab method
1305
-                $id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
1306
-                $_ht = array(
1307
-                    'id'       => $id,
1308
-                    'title'    => $cfg['title'],
1309
-                    'callback' => isset($cfg['callback']) && empty($content) ? array($this, $cfg['callback']) : null,
1310
-                    'content'  => $content,
1311
-                );
1312
-                $this->_current_screen->add_help_tab($_ht);
1313
-            }
1314
-        }
1315
-    }
1316
-
1317
-
1318
-    /**
1319
-     * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is
1320
-     * an array with properties for setting up usage of the joyride plugin
1321
-     *
1322
-     * @link   http://zurb.com/playground/jquery-joyride-feature-tour-plugin
1323
-     * @see    instructions regarding the format and construction of the "help_tour" array element is found in the
1324
-     *         _set_page_config() comments
1325
-     * @return void
1326
-     * @throws EE_Error
1327
-     * @throws InvalidArgumentException
1328
-     * @throws InvalidDataTypeException
1329
-     * @throws InvalidInterfaceException
1330
-     */
1331
-    protected function _add_help_tour()
1332
-    {
1333
-        $tours = array();
1334
-        $this->_help_tour = array();
1335
-        // exit early if help tours are turned off globally
1336
-        if ((defined('EE_DISABLE_HELP_TOURS') && EE_DISABLE_HELP_TOURS)
1337
-            || ! EE_Registry::instance()->CFG->admin->help_tour_activation
1338
-        ) {
1339
-            return;
1340
-        }
1341
-        // loop through _page_config to find any help_tour defined
1342
-        foreach ($this->_page_config as $route => $config) {
1343
-            // we're only going to set things up for this route
1344
-            if ($route !== $this->_req_action) {
1345
-                continue;
1346
-            }
1347
-            if (isset($config['help_tour'])) {
1348
-                foreach ($config['help_tour'] as $tour) {
1349
-                    $file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
1350
-                    // let's see if we can get that file...
1351
-                    // if not its possible this is a decaf route not set in caffeinated
1352
-                    // so lets try and get the caffeinated equivalent
1353
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
1354
-                                                             . basename($this->_get_dir())
1355
-                                                             . '/help_tours/'
1356
-                                                             . $tour
1357
-                                                             . '.class.php' : $file_path;
1358
-                    // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1359
-                    if (! is_readable($file_path)) {
1360
-                        EE_Error::add_error(
1361
-                            sprintf(
1362
-                                esc_html__(
1363
-                                    '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',
1364
-                                    'event_espresso'
1365
-                                ),
1366
-                                $file_path,
1367
-                                $tour
1368
-                            ),
1369
-                            __FILE__,
1370
-                            __FUNCTION__,
1371
-                            __LINE__
1372
-                        );
1373
-                        return;
1374
-                    }
1375
-                    require_once $file_path;
1376
-                    if (! class_exists($tour)) {
1377
-                        $error_msg[] = sprintf(
1378
-                            esc_html__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'),
1379
-                            $tour
1380
-                        );
1381
-                        $error_msg[] = $error_msg[0] . "\r\n"
1382
-                                       . sprintf(
1383
-                                           esc_html__(
1384
-                                               '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.',
1385
-                                               'event_espresso'
1386
-                                           ),
1387
-                                           $tour,
1388
-                                           '<br />',
1389
-                                           $tour,
1390
-                                           $this->_req_action,
1391
-                                           get_class($this)
1392
-                                       );
1393
-                        throw new EE_Error(implode('||', $error_msg));
1394
-                    }
1395
-                    $tour_obj = new $tour($this->_is_caf);
1396
-                    $tours[] = $tour_obj;
1397
-                    $this->_help_tour[ $route ][] = EEH_Template::help_tour_stops_generator($tour_obj);
1398
-                }
1399
-                // let's inject the end tour stop element common to all pages... this will only get seen once per machine.
1400
-                $end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
1401
-                $tours[] = $end_stop_tour;
1402
-                $this->_help_tour[ $route ][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
1403
-            }
1404
-        }
1405
-        if (! empty($tours)) {
1406
-            $this->_help_tour['tours'] = $tours;
1407
-        }
1408
-        // that's it!  Now that the $_help_tours property is set (or not)
1409
-        // the scripts and html should be taken care of automatically.
1410
-    }
1411
-
1412
-
1413
-    /**
1414
-     * This simply sets up any qtips that have been defined in the page config
1415
-     *
1416
-     * @return void
1417
-     */
1418
-    protected function _add_qtips()
1419
-    {
1420
-        if (isset($this->_route_config['qtips'])) {
1421
-            $qtips = (array) $this->_route_config['qtips'];
1422
-            // load qtip loader
1423
-            $path = array(
1424
-                $this->_get_dir() . '/qtips/',
1425
-                EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
1426
-            );
1427
-            EEH_Qtip_Loader::instance()->register($qtips, $path);
1428
-        }
1429
-    }
1430
-
1431
-
1432
-    /**
1433
-     * _set_nav_tabs
1434
-     * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you
1435
-     * wish to add additional tabs or modify accordingly.
1436
-     *
1437
-     * @return void
1438
-     * @throws InvalidArgumentException
1439
-     * @throws InvalidInterfaceException
1440
-     * @throws InvalidDataTypeException
1441
-     */
1442
-    protected function _set_nav_tabs()
1443
-    {
1444
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1445
-        $i = 0;
1446
-        foreach ($this->_page_config as $slug => $config) {
1447
-            if (! is_array($config)
1448
-                || (
1449
-                    is_array($config)
1450
-                    && (
1451
-                        (isset($config['nav']) && ! $config['nav'])
1452
-                        || ! isset($config['nav'])
1453
-                    )
1454
-                )
1455
-            ) {
1456
-                continue;
1457
-            }
1458
-            // no nav tab for this config
1459
-            // check for persistent flag
1460
-            if ($slug !== $this->_req_action && isset($config['nav']['persistent']) && ! $config['nav']['persistent']) {
1461
-                // nav tab is only to appear when route requested.
1462
-                continue;
1463
-            }
1464
-            if (! $this->check_user_access($slug, true)) {
1465
-                // no nav tab because current user does not have access.
1466
-                continue;
1467
-            }
1468
-            $css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
1469
-            $this->_nav_tabs[ $slug ] = array(
1470
-                'url'       => isset($config['nav']['url'])
1471
-                    ? $config['nav']['url']
1472
-                    : self::add_query_args_and_nonce(
1473
-                        array('action' => $slug),
1474
-                        $this->_admin_base_url
1475
-                    ),
1476
-                'link_text' => isset($config['nav']['label'])
1477
-                    ? $config['nav']['label']
1478
-                    : ucwords(
1479
-                        str_replace('_', ' ', $slug)
1480
-                    ),
1481
-                'css_class' => $this->_req_action === $slug ? $css_class . 'nav-tab-active' : $css_class,
1482
-                'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
1483
-            );
1484
-            $i++;
1485
-        }
1486
-        // if $this->_nav_tabs is empty then lets set the default
1487
-        if (empty($this->_nav_tabs)) {
1488
-            $this->_nav_tabs[ $this->_default_nav_tab_name ] = array(
1489
-                'url'       => $this->_admin_base_url,
1490
-                'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
1491
-                'css_class' => 'nav-tab-active',
1492
-                'order'     => 10,
1493
-            );
1494
-        }
1495
-        // now let's sort the tabs according to order
1496
-        usort($this->_nav_tabs, array($this, '_sort_nav_tabs'));
1497
-    }
1498
-
1499
-
1500
-    /**
1501
-     * _set_current_labels
1502
-     * This method modifies the _labels property with any optional specific labels indicated in the _page_routes
1503
-     * property array
1504
-     *
1505
-     * @return void
1506
-     */
1507
-    private function _set_current_labels()
1508
-    {
1509
-        if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
1510
-            foreach ($this->_route_config['labels'] as $label => $text) {
1511
-                if (is_array($text)) {
1512
-                    foreach ($text as $sublabel => $subtext) {
1513
-                        $this->_labels[ $label ][ $sublabel ] = $subtext;
1514
-                    }
1515
-                } else {
1516
-                    $this->_labels[ $label ] = $text;
1517
-                }
1518
-            }
1519
-        }
1520
-    }
1521
-
1522
-
1523
-    /**
1524
-     *        verifies user access for this admin page
1525
-     *
1526
-     * @param string $route_to_check if present then the capability for the route matching this string is checked.
1527
-     * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just
1528
-     *                               return false if verify fail.
1529
-     * @return bool
1530
-     * @throws InvalidArgumentException
1531
-     * @throws InvalidDataTypeException
1532
-     * @throws InvalidInterfaceException
1533
-     */
1534
-    public function check_user_access($route_to_check = '', $verify_only = false)
1535
-    {
1536
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1537
-        $route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
1538
-        $capability = ! empty($route_to_check) && isset($this->_page_routes[ $route_to_check ])
1539
-                      && is_array(
1540
-                          $this->_page_routes[ $route_to_check ]
1541
-                      )
1542
-                      && ! empty($this->_page_routes[ $route_to_check ]['capability'])
1543
-            ? $this->_page_routes[ $route_to_check ]['capability'] : null;
1544
-        if (empty($capability) && empty($route_to_check)) {
1545
-            $capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options'
1546
-                : $this->_route['capability'];
1547
-        } else {
1548
-            $capability = empty($capability) ? 'manage_options' : $capability;
1549
-        }
1550
-        $id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
1551
-        if (! defined('DOING_AJAX')
1552
-            && (
1553
-                ! function_exists('is_admin')
1554
-                || ! EE_Registry::instance()->CAP->current_user_can(
1555
-                    $capability,
1556
-                    $this->page_slug
1557
-                    . '_'
1558
-                    . $route_to_check,
1559
-                    $id
1560
-                )
1561
-            )
1562
-        ) {
1563
-            if ($verify_only) {
1564
-                return false;
1565
-            }
1566
-            if (is_user_logged_in()) {
1567
-                wp_die(__('You do not have access to this route.', 'event_espresso'));
1568
-            } else {
1569
-                return false;
1570
-            }
1571
-        }
1572
-        return true;
1573
-    }
1574
-
1575
-
1576
-    /**
1577
-     * admin_init_global
1578
-     * This runs all the code that we want executed within the WP admin_init hook.
1579
-     * This method executes for ALL EE Admin pages.
1580
-     *
1581
-     * @return void
1582
-     */
1583
-    public function admin_init_global()
1584
-    {
1585
-    }
1586
-
1587
-
1588
-    /**
1589
-     * wp_loaded_global
1590
-     * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an
1591
-     * EE_Admin page and will execute on every EE Admin Page load
1592
-     *
1593
-     * @return void
1594
-     */
1595
-    public function wp_loaded()
1596
-    {
1597
-    }
1598
-
1599
-
1600
-    /**
1601
-     * admin_notices
1602
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on
1603
-     * ALL EE_Admin pages.
1604
-     *
1605
-     * @return void
1606
-     */
1607
-    public function admin_notices_global()
1608
-    {
1609
-        $this->_display_no_javascript_warning();
1610
-        $this->_display_espresso_notices();
1611
-    }
1612
-
1613
-
1614
-    public function network_admin_notices_global()
1615
-    {
1616
-        $this->_display_no_javascript_warning();
1617
-        $this->_display_espresso_notices();
1618
-    }
1619
-
1620
-
1621
-    /**
1622
-     * admin_footer_scripts_global
1623
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
1624
-     * will apply on ALL EE_Admin pages.
1625
-     *
1626
-     * @return void
1627
-     */
1628
-    public function admin_footer_scripts_global()
1629
-    {
1630
-        $this->_add_admin_page_ajax_loading_img();
1631
-        $this->_add_admin_page_overlay();
1632
-        // if metaboxes are present we need to add the nonce field
1633
-        if (isset($this->_route_config['metaboxes'])
1634
-            || isset($this->_route_config['list_table'])
1635
-            || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes'])
1636
-        ) {
1637
-            wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
1638
-            wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
1639
-        }
1640
-    }
1641
-
1642
-
1643
-    /**
1644
-     * admin_footer_global
1645
-     * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particular method will apply on
1646
-     * ALL EE_Admin Pages.
1647
-     *
1648
-     * @return void
1649
-     * @throws EE_Error
1650
-     */
1651
-    public function admin_footer_global()
1652
-    {
1653
-        // dialog container for dialog helper
1654
-        $d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
1655
-        $d_cont .= '<div class="ee-notices"></div>';
1656
-        $d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
1657
-        $d_cont .= '</div>';
1658
-        echo $d_cont;
1659
-        // help tour stuff?
1660
-        if (isset($this->_help_tour[ $this->_req_action ])) {
1661
-            echo implode('<br />', $this->_help_tour[ $this->_req_action ]);
1662
-        }
1663
-        // current set timezone for timezone js
1664
-        echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
1665
-    }
1666
-
1667
-
1668
-    /**
1669
-     * This function sees if there is a method for help popup content existing for the given route.  If there is then
1670
-     * we'll use the retrieved array to output the content using the template. For child classes: If you want to have
1671
-     * help popups then in your templates or your content you set "triggers" for the content using the
1672
-     * "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method
1673
-     * for the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup
1674
-     * method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content
1675
-     * for the
1676
-     * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined
1677
-     * "help_popup_content_..." method.  You must prepare and return an array in the following format array(
1678
-     *    'help_trigger_id' => array(
1679
-     *        'title' => esc_html__('localized title for popup', 'event_espresso'),
1680
-     *        'content' => esc_html__('localized content for popup', 'event_espresso')
1681
-     *    )
1682
-     * );
1683
-     * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
1684
-     *
1685
-     * @param array $help_array
1686
-     * @param bool  $display
1687
-     * @return string content
1688
-     * @throws DomainException
1689
-     * @throws EE_Error
1690
-     */
1691
-    protected function _set_help_popup_content($help_array = array(), $display = false)
1692
-    {
1693
-        $content = '';
1694
-        $help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
1695
-        // loop through the array and setup content
1696
-        foreach ($help_array as $trigger => $help) {
1697
-            // make sure the array is setup properly
1698
-            if (! isset($help['title']) || ! isset($help['content'])) {
1699
-                throw new EE_Error(
1700
-                    esc_html__(
1701
-                        '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',
1702
-                        'event_espresso'
1703
-                    )
1704
-                );
1705
-            }
1706
-            // we're good so let'd setup the template vars and then assign parsed template content to our content.
1707
-            $template_args = array(
1708
-                'help_popup_id'      => $trigger,
1709
-                'help_popup_title'   => $help['title'],
1710
-                'help_popup_content' => $help['content'],
1711
-            );
1712
-            $content .= EEH_Template::display_template(
1713
-                EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
1714
-                $template_args,
1715
-                true
1716
-            );
1717
-        }
1718
-        if ($display) {
1719
-            echo $content;
1720
-            return '';
1721
-        }
1722
-        return $content;
1723
-    }
1724
-
1725
-
1726
-    /**
1727
-     * All this does is retrieve the help content array if set by the EE_Admin_Page child
1728
-     *
1729
-     * @return array properly formatted array for help popup content
1730
-     * @throws EE_Error
1731
-     */
1732
-    private function _get_help_content()
1733
-    {
1734
-        // what is the method we're looking for?
1735
-        $method_name = '_help_popup_content_' . $this->_req_action;
1736
-        // if method doesn't exist let's get out.
1737
-        if (! method_exists($this, $method_name)) {
1738
-            return array();
1739
-        }
1740
-        // k we're good to go let's retrieve the help array
1741
-        $help_array = call_user_func(array($this, $method_name));
1742
-        // make sure we've got an array!
1743
-        if (! is_array($help_array)) {
1744
-            throw new EE_Error(
1745
-                esc_html__(
1746
-                    'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
1747
-                    'event_espresso'
1748
-                )
1749
-            );
1750
-        }
1751
-        return $help_array;
1752
-    }
1753
-
1754
-
1755
-    /**
1756
-     * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
1757
-     * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
1758
-     * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
1759
-     *
1760
-     * @param string  $trigger_id reference for retrieving the trigger content for the popup
1761
-     * @param boolean $display    if false then we return the trigger string
1762
-     * @param array   $dimensions an array of dimensions for the box (array(h,w))
1763
-     * @return string
1764
-     * @throws DomainException
1765
-     * @throws EE_Error
1766
-     */
1767
-    protected function _set_help_trigger($trigger_id, $display = true, $dimensions = array('400', '640'))
1768
-    {
1769
-        if (defined('DOING_AJAX')) {
1770
-            return '';
1771
-        }
1772
-        // 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
1773
-        $help_array = $this->_get_help_content();
1774
-        $help_content = '';
1775
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
1776
-            $help_array[ $trigger_id ] = array(
1777
-                'title'   => esc_html__('Missing Content', 'event_espresso'),
1778
-                'content' => esc_html__(
1779
-                    '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.)',
1780
-                    'event_espresso'
1781
-                ),
1782
-            );
1783
-            $help_content = $this->_set_help_popup_content($help_array, false);
1784
-        }
1785
-        // let's setup the trigger
1786
-        $content = '<a class="ee-dialog" href="?height='
1787
-                   . $dimensions[0]
1788
-                   . '&width='
1789
-                   . $dimensions[1]
1790
-                   . '&inlineId='
1791
-                   . $trigger_id
1792
-                   . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
1793
-        $content .= $help_content;
1794
-        if ($display) {
1795
-            echo $content;
1796
-            return '';
1797
-        }
1798
-        return $content;
1799
-    }
1800
-
1801
-
1802
-    /**
1803
-     * _add_global_screen_options
1804
-     * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
1805
-     * This particular method will add_screen_options on ALL EE_Admin Pages
1806
-     *
1807
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
1808
-     *         see also WP_Screen object documents...
1809
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
1810
-     * @abstract
1811
-     * @return void
1812
-     */
1813
-    private function _add_global_screen_options()
1814
-    {
1815
-    }
1816
-
1817
-
1818
-    /**
1819
-     * _add_global_feature_pointers
1820
-     * This method is used for implementing any "feature pointers" (using built-in WP styling js).
1821
-     * This particular method will implement feature pointers for ALL EE_Admin pages.
1822
-     * Note: this is just a placeholder for now.  Implementation will come down the road
1823
-     *
1824
-     * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
1825
-     *         extended) also see:
1826
-     * @link   http://eamann.com/tech/wordpress-portland/
1827
-     * @abstract
1828
-     * @return void
1829
-     */
1830
-    private function _add_global_feature_pointers()
1831
-    {
1832
-    }
1833
-
1834
-
1835
-    /**
1836
-     * load_global_scripts_styles
1837
-     * The scripts and styles enqueued in here will be loaded on every EE Admin page
1838
-     *
1839
-     * @return void
1840
-     * @throws EE_Error
1841
-     */
1842
-    public function load_global_scripts_styles()
1843
-    {
1844
-        /** STYLES **/
1845
-        // add debugging styles
1846
-        if (WP_DEBUG) {
1847
-            add_action('admin_head', array($this, 'add_xdebug_style'));
1848
-        }
1849
-        // register all styles
1850
-        wp_register_style(
1851
-            'espresso-ui-theme',
1852
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
1853
-            array(),
1854
-            EVENT_ESPRESSO_VERSION
1855
-        );
1856
-        wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
1857
-        // helpers styles
1858
-        wp_register_style(
1859
-            'ee-text-links',
1860
-            EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css',
1861
-            array(),
1862
-            EVENT_ESPRESSO_VERSION
1863
-        );
1864
-        /** SCRIPTS **/
1865
-        // register all scripts
1866
-        wp_register_script(
1867
-            'ee-dialog',
1868
-            EE_ADMIN_URL . 'assets/ee-dialog-helper.js',
1869
-            array('jquery', 'jquery-ui-draggable'),
1870
-            EVENT_ESPRESSO_VERSION,
1871
-            true
1872
-        );
1873
-        wp_register_script(
1874
-            'ee_admin_js',
1875
-            EE_ADMIN_URL . 'assets/ee-admin-page.js',
1876
-            array('espresso_core', 'ee-parse-uri', 'ee-dialog'),
1877
-            EVENT_ESPRESSO_VERSION,
1878
-            true
1879
-        );
1880
-        wp_register_script(
1881
-            'jquery-ui-timepicker-addon',
1882
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js',
1883
-            array('jquery-ui-datepicker', 'jquery-ui-slider'),
1884
-            EVENT_ESPRESSO_VERSION,
1885
-            true
1886
-        );
1887
-        add_filter('FHEE_load_joyride', '__return_true');
1888
-        // script for sorting tables
1889
-        wp_register_script(
1890
-            'espresso_ajax_table_sorting',
1891
-            EE_ADMIN_URL . 'assets/espresso_ajax_table_sorting.js',
1892
-            array('ee_admin_js', 'jquery-ui-sortable'),
1893
-            EVENT_ESPRESSO_VERSION,
1894
-            true
1895
-        );
1896
-        // script for parsing uri's
1897
-        wp_register_script(
1898
-            'ee-parse-uri',
1899
-            EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js',
1900
-            array(),
1901
-            EVENT_ESPRESSO_VERSION,
1902
-            true
1903
-        );
1904
-        // and parsing associative serialized form elements
1905
-        wp_register_script(
1906
-            'ee-serialize-full-array',
1907
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js',
1908
-            array('jquery'),
1909
-            EVENT_ESPRESSO_VERSION,
1910
-            true
1911
-        );
1912
-        // helpers scripts
1913
-        wp_register_script(
1914
-            'ee-text-links',
1915
-            EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js',
1916
-            array('jquery'),
1917
-            EVENT_ESPRESSO_VERSION,
1918
-            true
1919
-        );
1920
-        wp_register_script(
1921
-            'ee-moment-core',
1922
-            EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js',
1923
-            array(),
1924
-            EVENT_ESPRESSO_VERSION,
1925
-            true
1926
-        );
1927
-        wp_register_script(
1928
-            'ee-moment',
1929
-            EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js',
1930
-            array('ee-moment-core'),
1931
-            EVENT_ESPRESSO_VERSION,
1932
-            true
1933
-        );
1934
-        wp_register_script(
1935
-            'ee-datepicker',
1936
-            EE_ADMIN_URL . 'assets/ee-datepicker.js',
1937
-            array('jquery-ui-timepicker-addon', 'ee-moment'),
1938
-            EVENT_ESPRESSO_VERSION,
1939
-            true
1940
-        );
1941
-        // google charts
1942
-        wp_register_script(
1943
-            'google-charts',
1944
-            'https://www.gstatic.com/charts/loader.js',
1945
-            array(),
1946
-            EVENT_ESPRESSO_VERSION,
1947
-            false
1948
-        );
1949
-        // ENQUEUE ALL BASICS BY DEFAULT
1950
-        wp_enqueue_style('ee-admin-css');
1951
-        wp_enqueue_script('ee_admin_js');
1952
-        wp_enqueue_script('ee-accounting');
1953
-        wp_enqueue_script('jquery-validate');
1954
-        // taking care of metaboxes
1955
-        if (empty($this->_cpt_route)
1956
-            && (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
1957
-        ) {
1958
-            wp_enqueue_script('dashboard');
1959
-        }
1960
-        // LOCALIZED DATA
1961
-        // localize script for ajax lazy loading
1962
-        $lazy_loader_container_ids = apply_filters(
1963
-            'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
1964
-            array('espresso_news_post_box_content')
1965
-        );
1966
-        wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
1967
-        /**
1968
-         * help tour stuff
1969
-         */
1970
-        if (! empty($this->_help_tour)) {
1971
-            // register the js for kicking things off
1972
-            wp_enqueue_script(
1973
-                'ee-help-tour',
1974
-                EE_ADMIN_URL . 'assets/ee-help-tour.js',
1975
-                array('jquery-joyride'),
1976
-                EVENT_ESPRESSO_VERSION,
1977
-                true
1978
-            );
1979
-            $tours = array();
1980
-            // setup tours for the js tour object
1981
-            foreach ($this->_help_tour['tours'] as $tour) {
1982
-                if ($tour instanceof EE_Help_Tour) {
1983
-                    $tours[] = array(
1984
-                        'id'      => $tour->get_slug(),
1985
-                        'options' => $tour->get_options(),
1986
-                    );
1987
-                }
1988
-            }
1989
-            wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
1990
-            // admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
1991
-        }
1992
-    }
1993
-
1994
-
1995
-    /**
1996
-     *        admin_footer_scripts_eei18n_js_strings
1997
-     *
1998
-     * @return        void
1999
-     */
2000
-    public function admin_footer_scripts_eei18n_js_strings()
2001
-    {
2002
-        EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
2003
-        EE_Registry::$i18n_js_strings['confirm_delete'] = esc_html__(
2004
-            '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!!!',
2005
-            'event_espresso'
2006
-        );
2007
-        EE_Registry::$i18n_js_strings['January'] = esc_html__('January', 'event_espresso');
2008
-        EE_Registry::$i18n_js_strings['February'] = esc_html__('February', 'event_espresso');
2009
-        EE_Registry::$i18n_js_strings['March'] = esc_html__('March', 'event_espresso');
2010
-        EE_Registry::$i18n_js_strings['April'] = esc_html__('April', 'event_espresso');
2011
-        EE_Registry::$i18n_js_strings['May'] = esc_html__('May', 'event_espresso');
2012
-        EE_Registry::$i18n_js_strings['June'] = esc_html__('June', 'event_espresso');
2013
-        EE_Registry::$i18n_js_strings['July'] = esc_html__('July', 'event_espresso');
2014
-        EE_Registry::$i18n_js_strings['August'] = esc_html__('August', 'event_espresso');
2015
-        EE_Registry::$i18n_js_strings['September'] = esc_html__('September', 'event_espresso');
2016
-        EE_Registry::$i18n_js_strings['October'] = esc_html__('October', 'event_espresso');
2017
-        EE_Registry::$i18n_js_strings['November'] = esc_html__('November', 'event_espresso');
2018
-        EE_Registry::$i18n_js_strings['December'] = esc_html__('December', 'event_espresso');
2019
-        EE_Registry::$i18n_js_strings['Jan'] = esc_html__('Jan', 'event_espresso');
2020
-        EE_Registry::$i18n_js_strings['Feb'] = esc_html__('Feb', 'event_espresso');
2021
-        EE_Registry::$i18n_js_strings['Mar'] = esc_html__('Mar', 'event_espresso');
2022
-        EE_Registry::$i18n_js_strings['Apr'] = esc_html__('Apr', 'event_espresso');
2023
-        EE_Registry::$i18n_js_strings['May'] = esc_html__('May', 'event_espresso');
2024
-        EE_Registry::$i18n_js_strings['Jun'] = esc_html__('Jun', 'event_espresso');
2025
-        EE_Registry::$i18n_js_strings['Jul'] = esc_html__('Jul', 'event_espresso');
2026
-        EE_Registry::$i18n_js_strings['Aug'] = esc_html__('Aug', 'event_espresso');
2027
-        EE_Registry::$i18n_js_strings['Sep'] = esc_html__('Sep', 'event_espresso');
2028
-        EE_Registry::$i18n_js_strings['Oct'] = esc_html__('Oct', 'event_espresso');
2029
-        EE_Registry::$i18n_js_strings['Nov'] = esc_html__('Nov', 'event_espresso');
2030
-        EE_Registry::$i18n_js_strings['Dec'] = esc_html__('Dec', 'event_espresso');
2031
-        EE_Registry::$i18n_js_strings['Sunday'] = esc_html__('Sunday', 'event_espresso');
2032
-        EE_Registry::$i18n_js_strings['Monday'] = esc_html__('Monday', 'event_espresso');
2033
-        EE_Registry::$i18n_js_strings['Tuesday'] = esc_html__('Tuesday', 'event_espresso');
2034
-        EE_Registry::$i18n_js_strings['Wednesday'] = esc_html__('Wednesday', 'event_espresso');
2035
-        EE_Registry::$i18n_js_strings['Thursday'] = esc_html__('Thursday', 'event_espresso');
2036
-        EE_Registry::$i18n_js_strings['Friday'] = esc_html__('Friday', 'event_espresso');
2037
-        EE_Registry::$i18n_js_strings['Saturday'] = esc_html__('Saturday', 'event_espresso');
2038
-        EE_Registry::$i18n_js_strings['Sun'] = esc_html__('Sun', 'event_espresso');
2039
-        EE_Registry::$i18n_js_strings['Mon'] = esc_html__('Mon', 'event_espresso');
2040
-        EE_Registry::$i18n_js_strings['Tue'] = esc_html__('Tue', 'event_espresso');
2041
-        EE_Registry::$i18n_js_strings['Wed'] = esc_html__('Wed', 'event_espresso');
2042
-        EE_Registry::$i18n_js_strings['Thu'] = esc_html__('Thu', 'event_espresso');
2043
-        EE_Registry::$i18n_js_strings['Fri'] = esc_html__('Fri', 'event_espresso');
2044
-        EE_Registry::$i18n_js_strings['Sat'] = esc_html__('Sat', 'event_espresso');
2045
-    }
2046
-
2047
-
2048
-    /**
2049
-     *        load enhanced xdebug styles for ppl with failing eyesight
2050
-     *
2051
-     * @return        void
2052
-     */
2053
-    public function add_xdebug_style()
2054
-    {
2055
-        echo '<style>.xdebug-error { font-size:1.5em; }</style>';
2056
-    }
2057
-
2058
-
2059
-    /************************/
2060
-    /** LIST TABLE METHODS **/
2061
-    /************************/
2062
-    /**
2063
-     * this sets up the list table if the current view requires it.
2064
-     *
2065
-     * @return void
2066
-     * @throws EE_Error
2067
-     */
2068
-    protected function _set_list_table()
2069
-    {
2070
-        // first is this a list_table view?
2071
-        if (! isset($this->_route_config['list_table'])) {
2072
-            return;
2073
-        } //not a list_table view so get out.
2074
-        // list table functions are per view specific (because some admin pages might have more than one list table!)
2075
-        $list_table_view = '_set_list_table_views_' . $this->_req_action;
2076
-        if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
2077
-            // user error msg
2078
-            $error_msg = esc_html__(
2079
-                'An error occurred. The requested list table views could not be found.',
2080
-                'event_espresso'
2081
-            );
2082
-            // developer error msg
2083
-            $error_msg .= '||'
2084
-                          . sprintf(
2085
-                              esc_html__(
2086
-                                  '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.',
2087
-                                  'event_espresso'
2088
-                              ),
2089
-                              $this->_req_action,
2090
-                              $list_table_view
2091
-                          );
2092
-            throw new EE_Error($error_msg);
2093
-        }
2094
-        // let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
2095
-        $this->_views = apply_filters(
2096
-            'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
2097
-            $this->_views
2098
-        );
2099
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
2100
-        $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
2101
-        $this->_set_list_table_view();
2102
-        $this->_set_list_table_object();
2103
-    }
2104
-
2105
-
2106
-    /**
2107
-     * set current view for List Table
2108
-     *
2109
-     * @return void
2110
-     */
2111
-    protected function _set_list_table_view()
2112
-    {
2113
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2114
-        // looking at active items or dumpster diving ?
2115
-        if (! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
2116
-            $this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
2117
-        } else {
2118
-            $this->_view = sanitize_key($this->_req_data['status']);
2119
-        }
2120
-    }
2121
-
2122
-
2123
-    /**
2124
-     * _set_list_table_object
2125
-     * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
2126
-     *
2127
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2128
-     * @throws \InvalidArgumentException
2129
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2130
-     * @throws EE_Error
2131
-     * @throws InvalidInterfaceException
2132
-     */
2133
-    protected function _set_list_table_object()
2134
-    {
2135
-        if (isset($this->_route_config['list_table'])) {
2136
-            if (! class_exists($this->_route_config['list_table'])) {
2137
-                throw new EE_Error(
2138
-                    sprintf(
2139
-                        esc_html__(
2140
-                            '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.',
2141
-                            'event_espresso'
2142
-                        ),
2143
-                        $this->_route_config['list_table'],
2144
-                        get_class($this)
2145
-                    )
2146
-                );
2147
-            }
2148
-            $this->_list_table_object = $this->loader->getShared(
2149
-                $this->_route_config['list_table'],
2150
-                array($this)
2151
-            );
2152
-        }
2153
-    }
2154
-
2155
-
2156
-    /**
2157
-     * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
2158
-     *
2159
-     * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
2160
-     *                                                    urls.  The array should be indexed by the view it is being
2161
-     *                                                    added to.
2162
-     * @return array
2163
-     */
2164
-    public function get_list_table_view_RLs($extra_query_args = array())
2165
-    {
2166
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2167
-        if (empty($this->_views)) {
2168
-            $this->_views = array();
2169
-        }
2170
-        // cycle thru views
2171
-        foreach ($this->_views as $key => $view) {
2172
-            $query_args = array();
2173
-            // check for current view
2174
-            $this->_views[ $key ]['class'] = $this->_view === $view['slug'] ? 'current' : '';
2175
-            $query_args['action'] = $this->_req_action;
2176
-            $query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
2177
-            $query_args['status'] = $view['slug'];
2178
-            // merge any other arguments sent in.
2179
-            if (isset($extra_query_args[ $view['slug'] ])) {
2180
-                $query_args = array_merge($query_args, $extra_query_args[ $view['slug'] ]);
2181
-            }
2182
-            $this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
2183
-        }
2184
-        return $this->_views;
2185
-    }
2186
-
2187
-
2188
-    /**
2189
-     * _entries_per_page_dropdown
2190
-     * generates a drop down box for selecting the number of visible rows in an admin page list table
2191
-     *
2192
-     * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how
2193
-     *         WP does it.
2194
-     * @param int $max_entries total number of rows in the table
2195
-     * @return string
2196
-     */
2197
-    protected function _entries_per_page_dropdown($max_entries = 0)
2198
-    {
2199
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2200
-        $values = array(10, 25, 50, 100);
2201
-        $per_page = (! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
2202
-        if ($max_entries) {
2203
-            $values[] = $max_entries;
2204
-            sort($values);
2205
-        }
2206
-        $entries_per_page_dropdown = '
104
+	/**
105
+	 * @var array $_route_config
106
+	 */
107
+	protected $_route_config;
108
+
109
+	/**
110
+	 * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
111
+	 * actions.
112
+	 *
113
+	 * @since 4.6.x
114
+	 * @var array.
115
+	 */
116
+	protected $_default_route_query_args;
117
+
118
+	// set via request page and action args.
119
+	protected $_current_page;
120
+
121
+	protected $_current_view;
122
+
123
+	protected $_current_page_view_url;
124
+
125
+	// sanitized request action (and nonce)
126
+
127
+	/**
128
+	 * @var string $_req_action
129
+	 */
130
+	protected $_req_action;
131
+
132
+	/**
133
+	 * @var string $_req_nonce
134
+	 */
135
+	protected $_req_nonce;
136
+
137
+	// search related
138
+	protected $_search_btn_label;
139
+
140
+	protected $_search_box_callback;
141
+
142
+	/**
143
+	 * WP Current Screen object
144
+	 *
145
+	 * @var WP_Screen
146
+	 */
147
+	protected $_current_screen;
148
+
149
+	// for holding EE_Admin_Hooks object when needed (set via set_hook_object())
150
+	protected $_hook_obj;
151
+
152
+	// for holding incoming request data
153
+	protected $_req_data;
154
+
155
+	// yes / no array for admin form fields
156
+	protected $_yes_no_values = array();
157
+
158
+	// some default things shared by all child classes
159
+	protected $_default_espresso_metaboxes;
160
+
161
+	/**
162
+	 *    EE_Registry Object
163
+	 *
164
+	 * @var    EE_Registry
165
+	 */
166
+	protected $EE = null;
167
+
168
+
169
+	/**
170
+	 * This is just a property that flags whether the given route is a caffeinated route or not.
171
+	 *
172
+	 * @var boolean
173
+	 */
174
+	protected $_is_caf = false;
175
+
176
+
177
+	/**
178
+	 * @Constructor
179
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
180
+	 * @throws EE_Error
181
+	 * @throws InvalidArgumentException
182
+	 * @throws ReflectionException
183
+	 * @throws InvalidDataTypeException
184
+	 * @throws InvalidInterfaceException
185
+	 */
186
+	public function __construct($routing = true)
187
+	{
188
+		$this->loader = LoaderFactory::getLoader();
189
+		if (strpos($this->_get_dir(), 'caffeinated') !== false) {
190
+			$this->_is_caf = true;
191
+		}
192
+		$this->_yes_no_values = array(
193
+			array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
194
+			array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
195
+		);
196
+		// set the _req_data property.
197
+		$this->_req_data = array_merge($_GET, $_POST);
198
+		// routing enabled?
199
+		$this->_routing = $routing;
200
+		// set initial page props (child method)
201
+		$this->_init_page_props();
202
+		// set global defaults
203
+		$this->_set_defaults();
204
+		// set early because incoming requests could be ajax related and we need to register those hooks.
205
+		$this->_global_ajax_hooks();
206
+		$this->_ajax_hooks();
207
+		// other_page_hooks have to be early too.
208
+		$this->_do_other_page_hooks();
209
+		// This just allows us to have extending classes do something specific
210
+		// before the parent constructor runs _page_setup().
211
+		if (method_exists($this, '_before_page_setup')) {
212
+			$this->_before_page_setup();
213
+		}
214
+		// set up page dependencies
215
+		$this->_page_setup();
216
+	}
217
+
218
+
219
+	/**
220
+	 * _init_page_props
221
+	 * Child classes use to set at least the following properties:
222
+	 * $page_slug.
223
+	 * $page_label.
224
+	 *
225
+	 * @abstract
226
+	 * @return void
227
+	 */
228
+	abstract protected function _init_page_props();
229
+
230
+
231
+	/**
232
+	 * _ajax_hooks
233
+	 * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
234
+	 * Note: within the ajax callback methods.
235
+	 *
236
+	 * @abstract
237
+	 * @return void
238
+	 */
239
+	abstract protected function _ajax_hooks();
240
+
241
+
242
+	/**
243
+	 * _define_page_props
244
+	 * child classes define page properties in here.  Must include at least:
245
+	 * $_admin_base_url = base_url for all admin pages
246
+	 * $_admin_page_title = default admin_page_title for admin pages
247
+	 * $_labels = array of default labels for various automatically generated elements:
248
+	 *    array(
249
+	 *        'buttons' => array(
250
+	 *            'add' => esc_html__('label for add new button'),
251
+	 *            'edit' => esc_html__('label for edit button'),
252
+	 *            'delete' => esc_html__('label for delete button')
253
+	 *            )
254
+	 *        )
255
+	 *
256
+	 * @abstract
257
+	 * @return void
258
+	 */
259
+	abstract protected function _define_page_props();
260
+
261
+
262
+	/**
263
+	 * _set_page_routes
264
+	 * child classes use this to define the page routes for all subpages handled by the class.  Page routes are
265
+	 * assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also
266
+	 * have a 'default' route. Here's the format
267
+	 * $this->_page_routes = array(
268
+	 *        'default' => array(
269
+	 *            'func' => '_default_method_handling_route',
270
+	 *            'args' => array('array','of','args'),
271
+	 *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e.
272
+	 *            ajax request, backend processing)
273
+	 *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a
274
+	 *            headers route after.  The string you enter here should match the defined route reference for a
275
+	 *            headers sent route.
276
+	 *            'capability' => 'route_capability', //indicate a string for minimum capability required to access
277
+	 *            this route.
278
+	 *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability
279
+	 *            checks).
280
+	 *        ),
281
+	 *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a
282
+	 *        handling method.
283
+	 *        )
284
+	 * )
285
+	 *
286
+	 * @abstract
287
+	 * @return void
288
+	 */
289
+	abstract protected function _set_page_routes();
290
+
291
+
292
+	/**
293
+	 * _set_page_config
294
+	 * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the
295
+	 * array corresponds to the page_route for the loaded page. Format:
296
+	 * $this->_page_config = array(
297
+	 *        'default' => array(
298
+	 *            'labels' => array(
299
+	 *                'buttons' => array(
300
+	 *                    'add' => esc_html__('label for adding item'),
301
+	 *                    'edit' => esc_html__('label for editing item'),
302
+	 *                    'delete' => esc_html__('label for deleting item')
303
+	 *                ),
304
+	 *                'publishbox' => esc_html__('Localized Title for Publish metabox', 'event_espresso')
305
+	 *            ), //optional an array of custom labels for various automatically generated elements to use on the
306
+	 *            page. If this isn't present then the defaults will be used as set for the $this->_labels in
307
+	 *            _define_page_props() method
308
+	 *            'nav' => array(
309
+	 *                'label' => esc_html__('Label for Tab', 'event_espresso').
310
+	 *                'url' => 'http://someurl', //automatically generated UNLESS you define
311
+	 *                'css_class' => 'css-class', //automatically generated UNLESS you define
312
+	 *                'order' => 10, //required to indicate tab position.
313
+	 *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is
314
+	 *                displayed then add this parameter.
315
+	 *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
316
+	 *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load
317
+	 *            metaboxes set for eventespresso admin pages.
318
+	 *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have
319
+	 *            metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added
320
+	 *            later.  We just use this flag to make sure the necessary js gets enqueued on page load.
321
+	 *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the
322
+	 *            given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
323
+	 *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The
324
+	 *            array indicates the max number of columns (4) and the default number of columns on page load (2).
325
+	 *            There is an option in the "screen_options" dropdown that is setup so users can pick what columns they
326
+	 *            want to display.
327
+	 *            'help_tabs' => array( //this is used for adding help tabs to a page
328
+	 *                'tab_id' => array(
329
+	 *                    'title' => 'tab_title',
330
+	 *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting
331
+	 *                    help tab content.  The fallback if it isn't present is to try a the callback.  Filename
332
+	 *                    should match a file in the admin folder's "help_tabs" dir (ie..
333
+	 *                    events/help_tabs/name_of_file_containing_content.help_tab.php)
334
+	 *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will
335
+	 *                    attempt to use the callback which should match the name of a method in the class
336
+	 *                    ),
337
+	 *                'tab2_id' => array(
338
+	 *                    'title' => 'tab2 title',
339
+	 *                    'filename' => 'file_name_2'
340
+	 *                    'callback' => 'callback_method_for_content',
341
+	 *                 ),
342
+	 *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the
343
+	 *            help tab area on an admin page. @link
344
+	 *            http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
345
+	 *            'help_tour' => array(
346
+	 *                'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located
347
+	 *                in a folder for this admin page named "help_tours", a file name matching the key given here
348
+	 *                (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
349
+	 *            ),
350
+	 *            'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is
351
+	 *            true if it isn't present).  To remove the requirement for a nonce check when this route is visited
352
+	 *            just set
353
+	 *            'require_nonce' to FALSE
354
+	 *            )
355
+	 * )
356
+	 *
357
+	 * @abstract
358
+	 * @return void
359
+	 */
360
+	abstract protected function _set_page_config();
361
+
362
+
363
+
364
+
365
+
366
+	/** end sample help_tour methods **/
367
+	/**
368
+	 * _add_screen_options
369
+	 * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for
370
+	 * doing so. Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options
371
+	 * to a particular view.
372
+	 *
373
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
374
+	 *         see also WP_Screen object documents...
375
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
376
+	 * @abstract
377
+	 * @return void
378
+	 */
379
+	abstract protected function _add_screen_options();
380
+
381
+
382
+	/**
383
+	 * _add_feature_pointers
384
+	 * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
385
+	 * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a
386
+	 * particular view. Note: this is just a placeholder for now.  Implementation will come down the road See:
387
+	 * WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
388
+	 * extended) also see:
389
+	 *
390
+	 * @link   http://eamann.com/tech/wordpress-portland/
391
+	 * @abstract
392
+	 * @return void
393
+	 */
394
+	abstract protected function _add_feature_pointers();
395
+
396
+
397
+	/**
398
+	 * load_scripts_styles
399
+	 * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for
400
+	 * their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific
401
+	 * scripts/styles per view by putting them in a dynamic function in this format
402
+	 * (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
403
+	 *
404
+	 * @abstract
405
+	 * @return void
406
+	 */
407
+	abstract public function load_scripts_styles();
408
+
409
+
410
+	/**
411
+	 * admin_init
412
+	 * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to
413
+	 * all pages/views loaded by child class.
414
+	 *
415
+	 * @abstract
416
+	 * @return void
417
+	 */
418
+	abstract public function admin_init();
419
+
420
+
421
+	/**
422
+	 * admin_notices
423
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to
424
+	 * all pages/views loaded by child class.
425
+	 *
426
+	 * @abstract
427
+	 * @return void
428
+	 */
429
+	abstract public function admin_notices();
430
+
431
+
432
+	/**
433
+	 * admin_footer_scripts
434
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
435
+	 * will apply to all pages/views loaded by child class.
436
+	 *
437
+	 * @return void
438
+	 */
439
+	abstract public function admin_footer_scripts();
440
+
441
+
442
+	/**
443
+	 * admin_footer
444
+	 * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will
445
+	 * apply to all pages/views loaded by child class.
446
+	 *
447
+	 * @return void
448
+	 */
449
+	public function admin_footer()
450
+	{
451
+	}
452
+
453
+
454
+	/**
455
+	 * _global_ajax_hooks
456
+	 * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
457
+	 * Note: within the ajax callback methods.
458
+	 *
459
+	 * @abstract
460
+	 * @return void
461
+	 */
462
+	protected function _global_ajax_hooks()
463
+	{
464
+		// for lazy loading of metabox content
465
+		add_action('wp_ajax_espresso-ajax-content', array($this, 'ajax_metabox_content'), 10);
466
+	}
467
+
468
+
469
+	public function ajax_metabox_content()
470
+	{
471
+		$contentid = isset($this->_req_data['contentid']) ? $this->_req_data['contentid'] : '';
472
+		$url = isset($this->_req_data['contenturl']) ? $this->_req_data['contenturl'] : '';
473
+		self::cached_rss_display($contentid, $url);
474
+		wp_die();
475
+	}
476
+
477
+
478
+	/**
479
+	 * _page_setup
480
+	 * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested
481
+	 * doesn't match the object.
482
+	 *
483
+	 * @final
484
+	 * @return void
485
+	 * @throws EE_Error
486
+	 * @throws InvalidArgumentException
487
+	 * @throws ReflectionException
488
+	 * @throws InvalidDataTypeException
489
+	 * @throws InvalidInterfaceException
490
+	 */
491
+	final protected function _page_setup()
492
+	{
493
+		// requires?
494
+		// 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.
495
+		add_action('admin_init', array($this, 'admin_init_global'), 5);
496
+		// next verify if we need to load anything...
497
+		$this->_current_page = ! empty($_GET['page']) ? sanitize_key($_GET['page']) : '';
498
+		$this->page_folder = strtolower(
499
+			str_replace(array('_Admin_Page', 'Extend_'), '', get_class($this))
500
+		);
501
+		global $ee_menu_slugs;
502
+		$ee_menu_slugs = (array) $ee_menu_slugs;
503
+		if (! defined('DOING_AJAX') && (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))) {
504
+			return;
505
+		}
506
+		// 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
507
+		if (isset($this->_req_data['action2']) && $this->_req_data['action'] === '-1') {
508
+			$this->_req_data['action'] = ! empty($this->_req_data['action2']) && $this->_req_data['action2'] !== '-1'
509
+				? $this->_req_data['action2']
510
+				: $this->_req_data['action'];
511
+		}
512
+		// then set blank or -1 action values to 'default'
513
+		$this->_req_action = isset($this->_req_data['action'])
514
+							 && ! empty($this->_req_data['action'])
515
+							 && $this->_req_data['action'] !== '-1'
516
+			? sanitize_key($this->_req_data['action'])
517
+			: 'default';
518
+		// if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.
519
+		//  This covers cases where we're coming in from a list table that isn't on the default route.
520
+		$this->_req_action = $this->_req_action === 'default' && isset($this->_req_data['route'])
521
+			? $this->_req_data['route'] : $this->_req_action;
522
+		// however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
523
+		$this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route'])
524
+			? $this->_req_data['route']
525
+			: $this->_req_action;
526
+		$this->_current_view = $this->_req_action;
527
+		$this->_req_nonce = $this->_req_action . '_nonce';
528
+		$this->_define_page_props();
529
+		$this->_current_page_view_url = add_query_arg(
530
+			array('page' => $this->_current_page, 'action' => $this->_current_view),
531
+			$this->_admin_base_url
532
+		);
533
+		// default things
534
+		$this->_default_espresso_metaboxes = array(
535
+			'_espresso_news_post_box',
536
+			'_espresso_links_post_box',
537
+			'_espresso_ratings_request',
538
+			'_espresso_sponsors_post_box',
539
+		);
540
+		// set page configs
541
+		$this->_set_page_routes();
542
+		$this->_set_page_config();
543
+		// let's include any referrer data in our default_query_args for this route for "stickiness".
544
+		if (isset($this->_req_data['wp_referer'])) {
545
+			$this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
546
+		}
547
+		// for caffeinated and other extended functionality.
548
+		//  If there is a _extend_page_config method
549
+		// then let's run that to modify the all the various page configuration arrays
550
+		if (method_exists($this, '_extend_page_config')) {
551
+			$this->_extend_page_config();
552
+		}
553
+		// for CPT and other extended functionality.
554
+		// If there is an _extend_page_config_for_cpt
555
+		// then let's run that to modify all the various page configuration arrays.
556
+		if (method_exists($this, '_extend_page_config_for_cpt')) {
557
+			$this->_extend_page_config_for_cpt();
558
+		}
559
+		// filter routes and page_config so addons can add their stuff. Filtering done per class
560
+		$this->_page_routes = apply_filters(
561
+			'FHEE__' . get_class($this) . '__page_setup__page_routes',
562
+			$this->_page_routes,
563
+			$this
564
+		);
565
+		$this->_page_config = apply_filters(
566
+			'FHEE__' . get_class($this) . '__page_setup__page_config',
567
+			$this->_page_config,
568
+			$this
569
+		);
570
+		// if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
571
+		// then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
572
+		if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
573
+			add_action(
574
+				'AHEE__EE_Admin_Page__route_admin_request',
575
+				array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view),
576
+				10,
577
+				2
578
+			);
579
+		}
580
+		// next route only if routing enabled
581
+		if ($this->_routing && ! defined('DOING_AJAX')) {
582
+			$this->_verify_routes();
583
+			// next let's just check user_access and kill if no access
584
+			$this->check_user_access();
585
+			if ($this->_is_UI_request) {
586
+				// admin_init stuff - global, all views for this page class, specific view
587
+				add_action('admin_init', array($this, 'admin_init'), 10);
588
+				if (method_exists($this, 'admin_init_' . $this->_current_view)) {
589
+					add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
590
+				}
591
+			} else {
592
+				// hijack regular WP loading and route admin request immediately
593
+				@ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
594
+				$this->route_admin_request();
595
+			}
596
+		}
597
+	}
598
+
599
+
600
+	/**
601
+	 * Provides a way for related child admin pages to load stuff on the loaded admin page.
602
+	 *
603
+	 * @return void
604
+	 * @throws ReflectionException
605
+	 * @throws EE_Error
606
+	 */
607
+	private function _do_other_page_hooks()
608
+	{
609
+		$registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
610
+		foreach ($registered_pages as $page) {
611
+			// now let's setup the file name and class that should be present
612
+			$classname = str_replace('.class.php', '', $page);
613
+			// autoloaders should take care of loading file
614
+			if (! class_exists($classname)) {
615
+				$error_msg[] = sprintf(
616
+					esc_html__(
617
+						'Something went wrong with loading the %s admin hooks page.',
618
+						'event_espresso'
619
+					),
620
+					$page
621
+				);
622
+				$error_msg[] = $error_msg[0]
623
+							   . "\r\n"
624
+							   . sprintf(
625
+								   esc_html__(
626
+									   'There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
627
+									   'event_espresso'
628
+								   ),
629
+								   $page,
630
+								   '<br />',
631
+								   '<strong>' . $classname . '</strong>'
632
+							   );
633
+				throw new EE_Error(implode('||', $error_msg));
634
+			}
635
+			$a = new ReflectionClass($classname);
636
+			// notice we are passing the instance of this class to the hook object.
637
+			$hookobj[] = $a->newInstance($this);
638
+		}
639
+	}
640
+
641
+
642
+	public function load_page_dependencies()
643
+	{
644
+		try {
645
+			$this->_load_page_dependencies();
646
+		} catch (EE_Error $e) {
647
+			$e->get_error();
648
+		}
649
+	}
650
+
651
+
652
+	/**
653
+	 * load_page_dependencies
654
+	 * loads things specific to this page class when its loaded.  Really helps with efficiency.
655
+	 *
656
+	 * @return void
657
+	 * @throws DomainException
658
+	 * @throws EE_Error
659
+	 * @throws InvalidArgumentException
660
+	 * @throws InvalidDataTypeException
661
+	 * @throws InvalidInterfaceException
662
+	 * @throws ReflectionException
663
+	 */
664
+	protected function _load_page_dependencies()
665
+	{
666
+		// let's set the current_screen and screen options to override what WP set
667
+		$this->_current_screen = get_current_screen();
668
+		// load admin_notices - global, page class, and view specific
669
+		add_action('admin_notices', array($this, 'admin_notices_global'), 5);
670
+		add_action('admin_notices', array($this, 'admin_notices'), 10);
671
+		if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
672
+			add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
673
+		}
674
+		// load network admin_notices - global, page class, and view specific
675
+		add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
676
+		if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
677
+			add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
678
+		}
679
+		// this will save any per_page screen options if they are present
680
+		$this->_set_per_page_screen_options();
681
+		// setup list table properties
682
+		$this->_set_list_table();
683
+		// child classes can "register" a metabox to be automatically handled via the _page_config array property.
684
+		// However in some cases the metaboxes will need to be added within a route handling callback.
685
+		$this->_add_registered_meta_boxes();
686
+		$this->_add_screen_columns();
687
+		// add screen options - global, page child class, and view specific
688
+		$this->_add_global_screen_options();
689
+		$this->_add_screen_options();
690
+		$add_screen_options = "_add_screen_options_{$this->_current_view}";
691
+		if (method_exists($this, $add_screen_options)) {
692
+			$this->{$add_screen_options}();
693
+		}
694
+		// add help tab(s) and tours- set via page_config and qtips.
695
+		$this->_add_help_tour();
696
+		$this->_add_help_tabs();
697
+		$this->_add_qtips();
698
+		// add feature_pointers - global, page child class, and view specific
699
+		$this->_add_feature_pointers();
700
+		$this->_add_global_feature_pointers();
701
+		$add_feature_pointer = "_add_feature_pointer_{$this->_current_view}";
702
+		if (method_exists($this, $add_feature_pointer)) {
703
+			$this->{$add_feature_pointer}();
704
+		}
705
+		// enqueue scripts/styles - global, page class, and view specific
706
+		add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5);
707
+		add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10);
708
+		if (method_exists($this, "load_scripts_styles_{$this->_current_view}")) {
709
+			add_action('admin_enqueue_scripts', array($this, "load_scripts_styles_{$this->_current_view}"), 15);
710
+		}
711
+		add_action('admin_enqueue_scripts', array($this, 'admin_footer_scripts_eei18n_js_strings'), 100);
712
+		// admin_print_footer_scripts - global, page child class, and view specific.
713
+		// NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.
714
+		// In most cases that's doing_it_wrong().  But adding hidden container elements etc.
715
+		// is a good use case. Notice the late priority we're giving these
716
+		add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts_global'), 99);
717
+		add_action('admin_print_footer_scripts', array($this, 'admin_footer_scripts'), 100);
718
+		if (method_exists($this, "admin_footer_scripts_{$this->_current_view}")) {
719
+			add_action('admin_print_footer_scripts', array($this, "admin_footer_scripts_{$this->_current_view}"), 101);
720
+		}
721
+		// admin footer scripts
722
+		add_action('admin_footer', array($this, 'admin_footer_global'), 99);
723
+		add_action('admin_footer', array($this, 'admin_footer'), 100);
724
+		if (method_exists($this, "admin_footer_{$this->_current_view}")) {
725
+			add_action('admin_footer', array($this, "admin_footer_{$this->_current_view}"), 101);
726
+		}
727
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
728
+		// targeted hook
729
+		do_action(
730
+			"FHEE__EE_Admin_Page___load_page_dependencies__after_load__{$this->page_slug}__{$this->_req_action}"
731
+		);
732
+	}
733
+
734
+
735
+	/**
736
+	 * _set_defaults
737
+	 * This sets some global defaults for class properties.
738
+	 */
739
+	private function _set_defaults()
740
+	{
741
+		$this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = null;
742
+		$this->_event = $this->_template_path = $this->_column_template_path = null;
743
+		$this->_nav_tabs = $this->_views = $this->_page_routes = array();
744
+		$this->_page_config = $this->_default_route_query_args = array();
745
+		$this->_default_nav_tab_name = 'overview';
746
+		// init template args
747
+		$this->_template_args = array(
748
+			'admin_page_header'  => '',
749
+			'admin_page_content' => '',
750
+			'post_body_content'  => '',
751
+			'before_list_table'  => '',
752
+			'after_list_table'   => '',
753
+		);
754
+	}
755
+
756
+
757
+	/**
758
+	 * route_admin_request
759
+	 *
760
+	 * @see    _route_admin_request()
761
+	 * @return exception|void error
762
+	 * @throws InvalidArgumentException
763
+	 * @throws InvalidInterfaceException
764
+	 * @throws InvalidDataTypeException
765
+	 * @throws EE_Error
766
+	 * @throws ReflectionException
767
+	 */
768
+	public function route_admin_request()
769
+	{
770
+		try {
771
+			$this->_route_admin_request();
772
+		} catch (EE_Error $e) {
773
+			$e->get_error();
774
+		}
775
+	}
776
+
777
+
778
+	public function set_wp_page_slug($wp_page_slug)
779
+	{
780
+		$this->_wp_page_slug = $wp_page_slug;
781
+		// if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
782
+		if (is_network_admin()) {
783
+			$this->_wp_page_slug .= '-network';
784
+		}
785
+	}
786
+
787
+
788
+	/**
789
+	 * _verify_routes
790
+	 * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so
791
+	 * we know if we need to drop out.
792
+	 *
793
+	 * @return bool
794
+	 * @throws EE_Error
795
+	 */
796
+	protected function _verify_routes()
797
+	{
798
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
799
+		if (! $this->_current_page && ! defined('DOING_AJAX')) {
800
+			return false;
801
+		}
802
+		$this->_route = false;
803
+		// check that the page_routes array is not empty
804
+		if (empty($this->_page_routes)) {
805
+			// user error msg
806
+			$error_msg = sprintf(
807
+				esc_html__('No page routes have been set for the %s admin page.', 'event_espresso'),
808
+				$this->_admin_page_title
809
+			);
810
+			// developer error msg
811
+			$error_msg .= '||' . $error_msg
812
+						  . esc_html__(
813
+							  ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
814
+							  'event_espresso'
815
+						  );
816
+			throw new EE_Error($error_msg);
817
+		}
818
+		// and that the requested page route exists
819
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
820
+			$this->_route = $this->_page_routes[ $this->_req_action ];
821
+			$this->_route_config = isset($this->_page_config[ $this->_req_action ])
822
+				? $this->_page_config[ $this->_req_action ] : array();
823
+		} else {
824
+			// user error msg
825
+			$error_msg = sprintf(
826
+				esc_html__(
827
+					'The requested page route does not exist for the %s admin page.',
828
+					'event_espresso'
829
+				),
830
+				$this->_admin_page_title
831
+			);
832
+			// developer error msg
833
+			$error_msg .= '||' . $error_msg
834
+						  . sprintf(
835
+							  esc_html__(
836
+								  ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
837
+								  'event_espresso'
838
+							  ),
839
+							  $this->_req_action
840
+						  );
841
+			throw new EE_Error($error_msg);
842
+		}
843
+		// and that a default route exists
844
+		if (! array_key_exists('default', $this->_page_routes)) {
845
+			// user error msg
846
+			$error_msg = sprintf(
847
+				esc_html__(
848
+					'A default page route has not been set for the % admin page.',
849
+					'event_espresso'
850
+				),
851
+				$this->_admin_page_title
852
+			);
853
+			// developer error msg
854
+			$error_msg .= '||' . $error_msg
855
+						  . esc_html__(
856
+							  ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
857
+							  'event_espresso'
858
+						  );
859
+			throw new EE_Error($error_msg);
860
+		}
861
+		// first lets' catch if the UI request has EVER been set.
862
+		if ($this->_is_UI_request === null) {
863
+			// lets set if this is a UI request or not.
864
+			$this->_is_UI_request = ! isset($this->_req_data['noheader']) || $this->_req_data['noheader'] !== true;
865
+			// wait a minute... we might have a noheader in the route array
866
+			$this->_is_UI_request = is_array($this->_route)
867
+									&& isset($this->_route['noheader'])
868
+									&& $this->_route['noheader'] ? false : $this->_is_UI_request;
869
+		}
870
+		$this->_set_current_labels();
871
+		return true;
872
+	}
873
+
874
+
875
+	/**
876
+	 * this method simply verifies a given route and makes sure its an actual route available for the loaded page
877
+	 *
878
+	 * @param  string $route the route name we're verifying
879
+	 * @return mixed (bool|Exception)      we'll throw an exception if this isn't a valid route.
880
+	 * @throws EE_Error
881
+	 */
882
+	protected function _verify_route($route)
883
+	{
884
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
885
+			return true;
886
+		}
887
+		// user error msg
888
+		$error_msg = sprintf(
889
+			esc_html__('The given page route does not exist for the %s admin page.', 'event_espresso'),
890
+			$this->_admin_page_title
891
+		);
892
+		// developer error msg
893
+		$error_msg .= '||' . $error_msg
894
+					  . sprintf(
895
+						  esc_html__(
896
+							  ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
897
+							  'event_espresso'
898
+						  ),
899
+						  $route
900
+					  );
901
+		throw new EE_Error($error_msg);
902
+	}
903
+
904
+
905
+	/**
906
+	 * perform nonce verification
907
+	 * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces
908
+	 * using this method (and save retyping!)
909
+	 *
910
+	 * @param  string $nonce     The nonce sent
911
+	 * @param  string $nonce_ref The nonce reference string (name0)
912
+	 * @return void
913
+	 * @throws EE_Error
914
+	 */
915
+	protected function _verify_nonce($nonce, $nonce_ref)
916
+	{
917
+		// verify nonce against expected value
918
+		if (! wp_verify_nonce($nonce, $nonce_ref)) {
919
+			// these are not the droids you are looking for !!!
920
+			$msg = sprintf(
921
+				esc_html__('%sNonce Fail.%s', 'event_espresso'),
922
+				'<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">',
923
+				'</a>'
924
+			);
925
+			if (WP_DEBUG) {
926
+				$msg .= "\n  "
927
+						. sprintf(
928
+							esc_html__(
929
+								'In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!',
930
+								'event_espresso'
931
+							),
932
+							__CLASS__
933
+						);
934
+			}
935
+			if (! defined('DOING_AJAX')) {
936
+				wp_die($msg);
937
+			} else {
938
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
939
+				$this->_return_json();
940
+			}
941
+		}
942
+	}
943
+
944
+
945
+	/**
946
+	 * _route_admin_request()
947
+	 * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
948
+	 * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
949
+	 * in the page routes and then will try to load the corresponding method.
950
+	 *
951
+	 * @return void
952
+	 * @throws EE_Error
953
+	 * @throws InvalidArgumentException
954
+	 * @throws InvalidDataTypeException
955
+	 * @throws InvalidInterfaceException
956
+	 * @throws ReflectionException
957
+	 */
958
+	protected function _route_admin_request()
959
+	{
960
+		if (! $this->_is_UI_request) {
961
+			$this->_verify_routes();
962
+		}
963
+		$nonce_check = isset($this->_route_config['require_nonce'])
964
+			? $this->_route_config['require_nonce']
965
+			: true;
966
+		if ($this->_req_action !== 'default' && $nonce_check) {
967
+			// set nonce from post data
968
+			$nonce = isset($this->_req_data[ $this->_req_nonce ])
969
+				? sanitize_text_field($this->_req_data[ $this->_req_nonce ])
970
+				: '';
971
+			$this->_verify_nonce($nonce, $this->_req_nonce);
972
+		}
973
+		// set the nav_tabs array but ONLY if this is  UI_request
974
+		if ($this->_is_UI_request) {
975
+			$this->_set_nav_tabs();
976
+		}
977
+		// grab callback function
978
+		$func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
979
+		// check if callback has args
980
+		$args = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : array();
981
+		$error_msg = '';
982
+		// action right before calling route
983
+		// (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
984
+		if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
985
+			do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
986
+		}
987
+		// right before calling the route, let's remove _wp_http_referer from the
988
+		// $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
989
+		$_SERVER['REQUEST_URI'] = remove_query_arg(
990
+			'_wp_http_referer',
991
+			wp_unslash($_SERVER['REQUEST_URI'])
992
+		);
993
+		if (! empty($func)) {
994
+			if (is_array($func)) {
995
+				list($class, $method) = $func;
996
+			} elseif (strpos($func, '::') !== false) {
997
+				list($class, $method) = explode('::', $func);
998
+			} else {
999
+				$class = $this;
1000
+				$method = $func;
1001
+			}
1002
+			if (! (is_object($class) && $class === $this)) {
1003
+				// send along this admin page object for access by addons.
1004
+				$args['admin_page_object'] = $this;
1005
+			}
1006
+			if (// is it a method on a class that doesn't work?
1007
+				(
1008
+					(
1009
+						method_exists($class, $method)
1010
+						&& call_user_func_array(array($class, $method), $args) === false
1011
+					)
1012
+					&& (
1013
+						// is it a standalone function that doesn't work?
1014
+						function_exists($method)
1015
+						&& call_user_func_array(
1016
+							$func,
1017
+							array_merge(array('admin_page_object' => $this), $args)
1018
+						) === false
1019
+					)
1020
+				)
1021
+				|| (
1022
+					// is it neither a class method NOR a standalone function?
1023
+					! method_exists($class, $method)
1024
+					&& ! function_exists($method)
1025
+				)
1026
+			) {
1027
+				// user error msg
1028
+				$error_msg = esc_html__(
1029
+					'An error occurred. The  requested page route could not be found.',
1030
+					'event_espresso'
1031
+				);
1032
+				// developer error msg
1033
+				$error_msg .= '||';
1034
+				$error_msg .= sprintf(
1035
+					esc_html__(
1036
+						'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
1037
+						'event_espresso'
1038
+					),
1039
+					$method
1040
+				);
1041
+			}
1042
+			if (! empty($error_msg)) {
1043
+				throw new EE_Error($error_msg);
1044
+			}
1045
+		}
1046
+		// if we've routed and this route has a no headers route AND a sent_headers_route,
1047
+		// then we need to reset the routing properties to the new route.
1048
+		// 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.
1049
+		if ($this->_is_UI_request === false
1050
+			&& is_array($this->_route)
1051
+			&& ! empty($this->_route['headers_sent_route'])
1052
+		) {
1053
+			$this->_reset_routing_properties($this->_route['headers_sent_route']);
1054
+		}
1055
+	}
1056
+
1057
+
1058
+	/**
1059
+	 * This method just allows the resetting of page properties in the case where a no headers
1060
+	 * route redirects to a headers route in its route config.
1061
+	 *
1062
+	 * @since   4.3.0
1063
+	 * @param  string $new_route New (non header) route to redirect to.
1064
+	 * @return   void
1065
+	 * @throws ReflectionException
1066
+	 * @throws InvalidArgumentException
1067
+	 * @throws InvalidInterfaceException
1068
+	 * @throws InvalidDataTypeException
1069
+	 * @throws EE_Error
1070
+	 */
1071
+	protected function _reset_routing_properties($new_route)
1072
+	{
1073
+		$this->_is_UI_request = true;
1074
+		// now we set the current route to whatever the headers_sent_route is set at
1075
+		$this->_req_data['action'] = $new_route;
1076
+		// rerun page setup
1077
+		$this->_page_setup();
1078
+	}
1079
+
1080
+
1081
+	/**
1082
+	 * _add_query_arg
1083
+	 * adds nonce to array of arguments then calls WP add_query_arg function
1084
+	 *(internally just uses EEH_URL's function with the same name)
1085
+	 *
1086
+	 * @param array  $args
1087
+	 * @param string $url
1088
+	 * @param bool   $sticky                  if true, then the existing Request params will be appended to the
1089
+	 *                                        generated url in an associative array indexed by the key 'wp_referer';
1090
+	 *                                        Example usage: If the current page is:
1091
+	 *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
1092
+	 *                                        &action=default&event_id=20&month_range=March%202015
1093
+	 *                                        &_wpnonce=5467821
1094
+	 *                                        and you call:
1095
+	 *                                        EE_Admin_Page::add_query_args_and_nonce(
1096
+	 *                                        array(
1097
+	 *                                        'action' => 'resend_something',
1098
+	 *                                        'page=>espresso_registrations'
1099
+	 *                                        ),
1100
+	 *                                        $some_url,
1101
+	 *                                        true
1102
+	 *                                        );
1103
+	 *                                        It will produce a url in this structure:
1104
+	 *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
1105
+	 *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
1106
+	 *                                        month_range]=March%202015
1107
+	 * @param   bool $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
1108
+	 * @return string
1109
+	 */
1110
+	public static function add_query_args_and_nonce(
1111
+		$args = array(),
1112
+		$url = false,
1113
+		$sticky = false,
1114
+		$exclude_nonce = false
1115
+	) {
1116
+		// if there is a _wp_http_referer include the values from the request but only if sticky = true
1117
+		if ($sticky) {
1118
+			$request = $_REQUEST;
1119
+			unset($request['_wp_http_referer']);
1120
+			unset($request['wp_referer']);
1121
+			foreach ($request as $key => $value) {
1122
+				// do not add nonces
1123
+				if (strpos($key, 'nonce') !== false) {
1124
+					continue;
1125
+				}
1126
+				$args[ 'wp_referer[' . $key . ']' ] = $value;
1127
+			}
1128
+		}
1129
+		return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
1130
+	}
1131
+
1132
+
1133
+	/**
1134
+	 * This returns a generated link that will load the related help tab.
1135
+	 *
1136
+	 * @param  string $help_tab_id the id for the connected help tab
1137
+	 * @param  string $icon_style  (optional) include css class for the style you want to use for the help icon.
1138
+	 * @param  string $help_text   (optional) send help text you want to use for the link if default not to be used
1139
+	 * @uses EEH_Template::get_help_tab_link()
1140
+	 * @return string              generated link
1141
+	 */
1142
+	protected function _get_help_tab_link($help_tab_id, $icon_style = '', $help_text = '')
1143
+	{
1144
+		return EEH_Template::get_help_tab_link(
1145
+			$help_tab_id,
1146
+			$this->page_slug,
1147
+			$this->_req_action,
1148
+			$icon_style,
1149
+			$help_text
1150
+		);
1151
+	}
1152
+
1153
+
1154
+	/**
1155
+	 * _add_help_tabs
1156
+	 * Note child classes define their help tabs within the page_config array.
1157
+	 *
1158
+	 * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
1159
+	 * @return void
1160
+	 * @throws DomainException
1161
+	 * @throws EE_Error
1162
+	 */
1163
+	protected function _add_help_tabs()
1164
+	{
1165
+		$tour_buttons = '';
1166
+		if (isset($this->_page_config[ $this->_req_action ])) {
1167
+			$config = $this->_page_config[ $this->_req_action ];
1168
+			// is there a help tour for the current route?  if there is let's setup the tour buttons
1169
+			if (isset($this->_help_tour[ $this->_req_action ])) {
1170
+				$tb = array();
1171
+				$tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
1172
+				foreach ($this->_help_tour['tours'] as $tour) {
1173
+					// if this is the end tour then we don't need to setup a button
1174
+					if ($tour instanceof EE_Help_Tour_final_stop || ! $tour instanceof EE_Help_Tour) {
1175
+						continue;
1176
+					}
1177
+					$tb[] = '<button id="trigger-tour-'
1178
+							. $tour->get_slug()
1179
+							. '" class="button-primary trigger-ee-help-tour">'
1180
+							. $tour->get_label()
1181
+							. '</button>';
1182
+				}
1183
+				$tour_buttons .= implode('<br />', $tb);
1184
+				$tour_buttons .= '</div></div>';
1185
+			}
1186
+			// let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
1187
+			if (is_array($config) && isset($config['help_sidebar'])) {
1188
+				// check that the callback given is valid
1189
+				if (! method_exists($this, $config['help_sidebar'])) {
1190
+					throw new EE_Error(
1191
+						sprintf(
1192
+							esc_html__(
1193
+								'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',
1194
+								'event_espresso'
1195
+							),
1196
+							$config['help_sidebar'],
1197
+							get_class($this)
1198
+						)
1199
+					);
1200
+				}
1201
+				$content = apply_filters(
1202
+					'FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar',
1203
+					$this->{$config['help_sidebar']}()
1204
+				);
1205
+				$content .= $tour_buttons; // add help tour buttons.
1206
+				// do we have any help tours setup?  Cause if we do we want to add the buttons
1207
+				$this->_current_screen->set_help_sidebar($content);
1208
+			}
1209
+			// if we DON'T have config help sidebar and there ARE tour buttons then we'll just add the tour buttons to the sidebar.
1210
+			if (! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
1211
+				$this->_current_screen->set_help_sidebar($tour_buttons);
1212
+			}
1213
+			// handle if no help_tabs are set so the sidebar will still show for the help tour buttons
1214
+			if (! isset($config['help_tabs']) && ! empty($tour_buttons)) {
1215
+				$_ht['id'] = $this->page_slug;
1216
+				$_ht['title'] = esc_html__('Help Tours', 'event_espresso');
1217
+				$_ht['content'] = '<p>'
1218
+								  . esc_html__(
1219
+									  'The buttons to the right allow you to start/restart any help tours available for this page',
1220
+									  'event_espresso'
1221
+								  ) . '</p>';
1222
+				$this->_current_screen->add_help_tab($_ht);
1223
+			}
1224
+			if (! isset($config['help_tabs'])) {
1225
+				return;
1226
+			} //no help tabs for this route
1227
+			foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
1228
+				// we're here so there ARE help tabs!
1229
+				// make sure we've got what we need
1230
+				if (! isset($cfg['title'])) {
1231
+					throw new EE_Error(
1232
+						esc_html__(
1233
+							'The _page_config array is not set up properly for help tabs.  It is missing a title',
1234
+							'event_espresso'
1235
+						)
1236
+					);
1237
+				}
1238
+				if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
1239
+					throw new EE_Error(
1240
+						esc_html__(
1241
+							'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',
1242
+							'event_espresso'
1243
+						)
1244
+					);
1245
+				}
1246
+				// first priority goes to content.
1247
+				if (! empty($cfg['content'])) {
1248
+					$content = ! empty($cfg['content']) ? $cfg['content'] : null;
1249
+					// second priority goes to filename
1250
+				} elseif (! empty($cfg['filename'])) {
1251
+					$file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
1252
+					// 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)
1253
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
1254
+															 . basename($this->_get_dir())
1255
+															 . '/help_tabs/'
1256
+															 . $cfg['filename']
1257
+															 . '.help_tab.php' : $file_path;
1258
+					// if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1259
+					if (! isset($cfg['callback']) && ! is_readable($file_path)) {
1260
+						EE_Error::add_error(
1261
+							sprintf(
1262
+								esc_html__(
1263
+									'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',
1264
+									'event_espresso'
1265
+								),
1266
+								$tab_id,
1267
+								key($config),
1268
+								$file_path
1269
+							),
1270
+							__FILE__,
1271
+							__FUNCTION__,
1272
+							__LINE__
1273
+						);
1274
+						return;
1275
+					}
1276
+					$template_args['admin_page_obj'] = $this;
1277
+					$content = EEH_Template::display_template(
1278
+						$file_path,
1279
+						$template_args,
1280
+						true
1281
+					);
1282
+				} else {
1283
+					$content = '';
1284
+				}
1285
+				// check if callback is valid
1286
+				if (empty($content) && (
1287
+						! isset($cfg['callback']) || ! method_exists($this, $cfg['callback'])
1288
+					)
1289
+				) {
1290
+					EE_Error::add_error(
1291
+						sprintf(
1292
+							esc_html__(
1293
+								'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.',
1294
+								'event_espresso'
1295
+							),
1296
+							$cfg['title']
1297
+						),
1298
+						__FILE__,
1299
+						__FUNCTION__,
1300
+						__LINE__
1301
+					);
1302
+					return;
1303
+				}
1304
+				// setup config array for help tab method
1305
+				$id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
1306
+				$_ht = array(
1307
+					'id'       => $id,
1308
+					'title'    => $cfg['title'],
1309
+					'callback' => isset($cfg['callback']) && empty($content) ? array($this, $cfg['callback']) : null,
1310
+					'content'  => $content,
1311
+				);
1312
+				$this->_current_screen->add_help_tab($_ht);
1313
+			}
1314
+		}
1315
+	}
1316
+
1317
+
1318
+	/**
1319
+	 * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is
1320
+	 * an array with properties for setting up usage of the joyride plugin
1321
+	 *
1322
+	 * @link   http://zurb.com/playground/jquery-joyride-feature-tour-plugin
1323
+	 * @see    instructions regarding the format and construction of the "help_tour" array element is found in the
1324
+	 *         _set_page_config() comments
1325
+	 * @return void
1326
+	 * @throws EE_Error
1327
+	 * @throws InvalidArgumentException
1328
+	 * @throws InvalidDataTypeException
1329
+	 * @throws InvalidInterfaceException
1330
+	 */
1331
+	protected function _add_help_tour()
1332
+	{
1333
+		$tours = array();
1334
+		$this->_help_tour = array();
1335
+		// exit early if help tours are turned off globally
1336
+		if ((defined('EE_DISABLE_HELP_TOURS') && EE_DISABLE_HELP_TOURS)
1337
+			|| ! EE_Registry::instance()->CFG->admin->help_tour_activation
1338
+		) {
1339
+			return;
1340
+		}
1341
+		// loop through _page_config to find any help_tour defined
1342
+		foreach ($this->_page_config as $route => $config) {
1343
+			// we're only going to set things up for this route
1344
+			if ($route !== $this->_req_action) {
1345
+				continue;
1346
+			}
1347
+			if (isset($config['help_tour'])) {
1348
+				foreach ($config['help_tour'] as $tour) {
1349
+					$file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
1350
+					// let's see if we can get that file...
1351
+					// if not its possible this is a decaf route not set in caffeinated
1352
+					// so lets try and get the caffeinated equivalent
1353
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
1354
+															 . basename($this->_get_dir())
1355
+															 . '/help_tours/'
1356
+															 . $tour
1357
+															 . '.class.php' : $file_path;
1358
+					// if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1359
+					if (! is_readable($file_path)) {
1360
+						EE_Error::add_error(
1361
+							sprintf(
1362
+								esc_html__(
1363
+									'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',
1364
+									'event_espresso'
1365
+								),
1366
+								$file_path,
1367
+								$tour
1368
+							),
1369
+							__FILE__,
1370
+							__FUNCTION__,
1371
+							__LINE__
1372
+						);
1373
+						return;
1374
+					}
1375
+					require_once $file_path;
1376
+					if (! class_exists($tour)) {
1377
+						$error_msg[] = sprintf(
1378
+							esc_html__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'),
1379
+							$tour
1380
+						);
1381
+						$error_msg[] = $error_msg[0] . "\r\n"
1382
+									   . sprintf(
1383
+										   esc_html__(
1384
+											   '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.',
1385
+											   'event_espresso'
1386
+										   ),
1387
+										   $tour,
1388
+										   '<br />',
1389
+										   $tour,
1390
+										   $this->_req_action,
1391
+										   get_class($this)
1392
+									   );
1393
+						throw new EE_Error(implode('||', $error_msg));
1394
+					}
1395
+					$tour_obj = new $tour($this->_is_caf);
1396
+					$tours[] = $tour_obj;
1397
+					$this->_help_tour[ $route ][] = EEH_Template::help_tour_stops_generator($tour_obj);
1398
+				}
1399
+				// let's inject the end tour stop element common to all pages... this will only get seen once per machine.
1400
+				$end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
1401
+				$tours[] = $end_stop_tour;
1402
+				$this->_help_tour[ $route ][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
1403
+			}
1404
+		}
1405
+		if (! empty($tours)) {
1406
+			$this->_help_tour['tours'] = $tours;
1407
+		}
1408
+		// that's it!  Now that the $_help_tours property is set (or not)
1409
+		// the scripts and html should be taken care of automatically.
1410
+	}
1411
+
1412
+
1413
+	/**
1414
+	 * This simply sets up any qtips that have been defined in the page config
1415
+	 *
1416
+	 * @return void
1417
+	 */
1418
+	protected function _add_qtips()
1419
+	{
1420
+		if (isset($this->_route_config['qtips'])) {
1421
+			$qtips = (array) $this->_route_config['qtips'];
1422
+			// load qtip loader
1423
+			$path = array(
1424
+				$this->_get_dir() . '/qtips/',
1425
+				EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
1426
+			);
1427
+			EEH_Qtip_Loader::instance()->register($qtips, $path);
1428
+		}
1429
+	}
1430
+
1431
+
1432
+	/**
1433
+	 * _set_nav_tabs
1434
+	 * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you
1435
+	 * wish to add additional tabs or modify accordingly.
1436
+	 *
1437
+	 * @return void
1438
+	 * @throws InvalidArgumentException
1439
+	 * @throws InvalidInterfaceException
1440
+	 * @throws InvalidDataTypeException
1441
+	 */
1442
+	protected function _set_nav_tabs()
1443
+	{
1444
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1445
+		$i = 0;
1446
+		foreach ($this->_page_config as $slug => $config) {
1447
+			if (! is_array($config)
1448
+				|| (
1449
+					is_array($config)
1450
+					&& (
1451
+						(isset($config['nav']) && ! $config['nav'])
1452
+						|| ! isset($config['nav'])
1453
+					)
1454
+				)
1455
+			) {
1456
+				continue;
1457
+			}
1458
+			// no nav tab for this config
1459
+			// check for persistent flag
1460
+			if ($slug !== $this->_req_action && isset($config['nav']['persistent']) && ! $config['nav']['persistent']) {
1461
+				// nav tab is only to appear when route requested.
1462
+				continue;
1463
+			}
1464
+			if (! $this->check_user_access($slug, true)) {
1465
+				// no nav tab because current user does not have access.
1466
+				continue;
1467
+			}
1468
+			$css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
1469
+			$this->_nav_tabs[ $slug ] = array(
1470
+				'url'       => isset($config['nav']['url'])
1471
+					? $config['nav']['url']
1472
+					: self::add_query_args_and_nonce(
1473
+						array('action' => $slug),
1474
+						$this->_admin_base_url
1475
+					),
1476
+				'link_text' => isset($config['nav']['label'])
1477
+					? $config['nav']['label']
1478
+					: ucwords(
1479
+						str_replace('_', ' ', $slug)
1480
+					),
1481
+				'css_class' => $this->_req_action === $slug ? $css_class . 'nav-tab-active' : $css_class,
1482
+				'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
1483
+			);
1484
+			$i++;
1485
+		}
1486
+		// if $this->_nav_tabs is empty then lets set the default
1487
+		if (empty($this->_nav_tabs)) {
1488
+			$this->_nav_tabs[ $this->_default_nav_tab_name ] = array(
1489
+				'url'       => $this->_admin_base_url,
1490
+				'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
1491
+				'css_class' => 'nav-tab-active',
1492
+				'order'     => 10,
1493
+			);
1494
+		}
1495
+		// now let's sort the tabs according to order
1496
+		usort($this->_nav_tabs, array($this, '_sort_nav_tabs'));
1497
+	}
1498
+
1499
+
1500
+	/**
1501
+	 * _set_current_labels
1502
+	 * This method modifies the _labels property with any optional specific labels indicated in the _page_routes
1503
+	 * property array
1504
+	 *
1505
+	 * @return void
1506
+	 */
1507
+	private function _set_current_labels()
1508
+	{
1509
+		if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
1510
+			foreach ($this->_route_config['labels'] as $label => $text) {
1511
+				if (is_array($text)) {
1512
+					foreach ($text as $sublabel => $subtext) {
1513
+						$this->_labels[ $label ][ $sublabel ] = $subtext;
1514
+					}
1515
+				} else {
1516
+					$this->_labels[ $label ] = $text;
1517
+				}
1518
+			}
1519
+		}
1520
+	}
1521
+
1522
+
1523
+	/**
1524
+	 *        verifies user access for this admin page
1525
+	 *
1526
+	 * @param string $route_to_check if present then the capability for the route matching this string is checked.
1527
+	 * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just
1528
+	 *                               return false if verify fail.
1529
+	 * @return bool
1530
+	 * @throws InvalidArgumentException
1531
+	 * @throws InvalidDataTypeException
1532
+	 * @throws InvalidInterfaceException
1533
+	 */
1534
+	public function check_user_access($route_to_check = '', $verify_only = false)
1535
+	{
1536
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1537
+		$route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
1538
+		$capability = ! empty($route_to_check) && isset($this->_page_routes[ $route_to_check ])
1539
+					  && is_array(
1540
+						  $this->_page_routes[ $route_to_check ]
1541
+					  )
1542
+					  && ! empty($this->_page_routes[ $route_to_check ]['capability'])
1543
+			? $this->_page_routes[ $route_to_check ]['capability'] : null;
1544
+		if (empty($capability) && empty($route_to_check)) {
1545
+			$capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options'
1546
+				: $this->_route['capability'];
1547
+		} else {
1548
+			$capability = empty($capability) ? 'manage_options' : $capability;
1549
+		}
1550
+		$id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
1551
+		if (! defined('DOING_AJAX')
1552
+			&& (
1553
+				! function_exists('is_admin')
1554
+				|| ! EE_Registry::instance()->CAP->current_user_can(
1555
+					$capability,
1556
+					$this->page_slug
1557
+					. '_'
1558
+					. $route_to_check,
1559
+					$id
1560
+				)
1561
+			)
1562
+		) {
1563
+			if ($verify_only) {
1564
+				return false;
1565
+			}
1566
+			if (is_user_logged_in()) {
1567
+				wp_die(__('You do not have access to this route.', 'event_espresso'));
1568
+			} else {
1569
+				return false;
1570
+			}
1571
+		}
1572
+		return true;
1573
+	}
1574
+
1575
+
1576
+	/**
1577
+	 * admin_init_global
1578
+	 * This runs all the code that we want executed within the WP admin_init hook.
1579
+	 * This method executes for ALL EE Admin pages.
1580
+	 *
1581
+	 * @return void
1582
+	 */
1583
+	public function admin_init_global()
1584
+	{
1585
+	}
1586
+
1587
+
1588
+	/**
1589
+	 * wp_loaded_global
1590
+	 * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an
1591
+	 * EE_Admin page and will execute on every EE Admin Page load
1592
+	 *
1593
+	 * @return void
1594
+	 */
1595
+	public function wp_loaded()
1596
+	{
1597
+	}
1598
+
1599
+
1600
+	/**
1601
+	 * admin_notices
1602
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on
1603
+	 * ALL EE_Admin pages.
1604
+	 *
1605
+	 * @return void
1606
+	 */
1607
+	public function admin_notices_global()
1608
+	{
1609
+		$this->_display_no_javascript_warning();
1610
+		$this->_display_espresso_notices();
1611
+	}
1612
+
1613
+
1614
+	public function network_admin_notices_global()
1615
+	{
1616
+		$this->_display_no_javascript_warning();
1617
+		$this->_display_espresso_notices();
1618
+	}
1619
+
1620
+
1621
+	/**
1622
+	 * admin_footer_scripts_global
1623
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
1624
+	 * will apply on ALL EE_Admin pages.
1625
+	 *
1626
+	 * @return void
1627
+	 */
1628
+	public function admin_footer_scripts_global()
1629
+	{
1630
+		$this->_add_admin_page_ajax_loading_img();
1631
+		$this->_add_admin_page_overlay();
1632
+		// if metaboxes are present we need to add the nonce field
1633
+		if (isset($this->_route_config['metaboxes'])
1634
+			|| isset($this->_route_config['list_table'])
1635
+			|| (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes'])
1636
+		) {
1637
+			wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
1638
+			wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
1639
+		}
1640
+	}
1641
+
1642
+
1643
+	/**
1644
+	 * admin_footer_global
1645
+	 * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particular method will apply on
1646
+	 * ALL EE_Admin Pages.
1647
+	 *
1648
+	 * @return void
1649
+	 * @throws EE_Error
1650
+	 */
1651
+	public function admin_footer_global()
1652
+	{
1653
+		// dialog container for dialog helper
1654
+		$d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
1655
+		$d_cont .= '<div class="ee-notices"></div>';
1656
+		$d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
1657
+		$d_cont .= '</div>';
1658
+		echo $d_cont;
1659
+		// help tour stuff?
1660
+		if (isset($this->_help_tour[ $this->_req_action ])) {
1661
+			echo implode('<br />', $this->_help_tour[ $this->_req_action ]);
1662
+		}
1663
+		// current set timezone for timezone js
1664
+		echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
1665
+	}
1666
+
1667
+
1668
+	/**
1669
+	 * This function sees if there is a method for help popup content existing for the given route.  If there is then
1670
+	 * we'll use the retrieved array to output the content using the template. For child classes: If you want to have
1671
+	 * help popups then in your templates or your content you set "triggers" for the content using the
1672
+	 * "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method
1673
+	 * for the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup
1674
+	 * method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content
1675
+	 * for the
1676
+	 * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined
1677
+	 * "help_popup_content_..." method.  You must prepare and return an array in the following format array(
1678
+	 *    'help_trigger_id' => array(
1679
+	 *        'title' => esc_html__('localized title for popup', 'event_espresso'),
1680
+	 *        'content' => esc_html__('localized content for popup', 'event_espresso')
1681
+	 *    )
1682
+	 * );
1683
+	 * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
1684
+	 *
1685
+	 * @param array $help_array
1686
+	 * @param bool  $display
1687
+	 * @return string content
1688
+	 * @throws DomainException
1689
+	 * @throws EE_Error
1690
+	 */
1691
+	protected function _set_help_popup_content($help_array = array(), $display = false)
1692
+	{
1693
+		$content = '';
1694
+		$help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
1695
+		// loop through the array and setup content
1696
+		foreach ($help_array as $trigger => $help) {
1697
+			// make sure the array is setup properly
1698
+			if (! isset($help['title']) || ! isset($help['content'])) {
1699
+				throw new EE_Error(
1700
+					esc_html__(
1701
+						'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',
1702
+						'event_espresso'
1703
+					)
1704
+				);
1705
+			}
1706
+			// we're good so let'd setup the template vars and then assign parsed template content to our content.
1707
+			$template_args = array(
1708
+				'help_popup_id'      => $trigger,
1709
+				'help_popup_title'   => $help['title'],
1710
+				'help_popup_content' => $help['content'],
1711
+			);
1712
+			$content .= EEH_Template::display_template(
1713
+				EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
1714
+				$template_args,
1715
+				true
1716
+			);
1717
+		}
1718
+		if ($display) {
1719
+			echo $content;
1720
+			return '';
1721
+		}
1722
+		return $content;
1723
+	}
1724
+
1725
+
1726
+	/**
1727
+	 * All this does is retrieve the help content array if set by the EE_Admin_Page child
1728
+	 *
1729
+	 * @return array properly formatted array for help popup content
1730
+	 * @throws EE_Error
1731
+	 */
1732
+	private function _get_help_content()
1733
+	{
1734
+		// what is the method we're looking for?
1735
+		$method_name = '_help_popup_content_' . $this->_req_action;
1736
+		// if method doesn't exist let's get out.
1737
+		if (! method_exists($this, $method_name)) {
1738
+			return array();
1739
+		}
1740
+		// k we're good to go let's retrieve the help array
1741
+		$help_array = call_user_func(array($this, $method_name));
1742
+		// make sure we've got an array!
1743
+		if (! is_array($help_array)) {
1744
+			throw new EE_Error(
1745
+				esc_html__(
1746
+					'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
1747
+					'event_espresso'
1748
+				)
1749
+			);
1750
+		}
1751
+		return $help_array;
1752
+	}
1753
+
1754
+
1755
+	/**
1756
+	 * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
1757
+	 * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
1758
+	 * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
1759
+	 *
1760
+	 * @param string  $trigger_id reference for retrieving the trigger content for the popup
1761
+	 * @param boolean $display    if false then we return the trigger string
1762
+	 * @param array   $dimensions an array of dimensions for the box (array(h,w))
1763
+	 * @return string
1764
+	 * @throws DomainException
1765
+	 * @throws EE_Error
1766
+	 */
1767
+	protected function _set_help_trigger($trigger_id, $display = true, $dimensions = array('400', '640'))
1768
+	{
1769
+		if (defined('DOING_AJAX')) {
1770
+			return '';
1771
+		}
1772
+		// 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
1773
+		$help_array = $this->_get_help_content();
1774
+		$help_content = '';
1775
+		if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
1776
+			$help_array[ $trigger_id ] = array(
1777
+				'title'   => esc_html__('Missing Content', 'event_espresso'),
1778
+				'content' => esc_html__(
1779
+					'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.)',
1780
+					'event_espresso'
1781
+				),
1782
+			);
1783
+			$help_content = $this->_set_help_popup_content($help_array, false);
1784
+		}
1785
+		// let's setup the trigger
1786
+		$content = '<a class="ee-dialog" href="?height='
1787
+				   . $dimensions[0]
1788
+				   . '&width='
1789
+				   . $dimensions[1]
1790
+				   . '&inlineId='
1791
+				   . $trigger_id
1792
+				   . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
1793
+		$content .= $help_content;
1794
+		if ($display) {
1795
+			echo $content;
1796
+			return '';
1797
+		}
1798
+		return $content;
1799
+	}
1800
+
1801
+
1802
+	/**
1803
+	 * _add_global_screen_options
1804
+	 * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
1805
+	 * This particular method will add_screen_options on ALL EE_Admin Pages
1806
+	 *
1807
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
1808
+	 *         see also WP_Screen object documents...
1809
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
1810
+	 * @abstract
1811
+	 * @return void
1812
+	 */
1813
+	private function _add_global_screen_options()
1814
+	{
1815
+	}
1816
+
1817
+
1818
+	/**
1819
+	 * _add_global_feature_pointers
1820
+	 * This method is used for implementing any "feature pointers" (using built-in WP styling js).
1821
+	 * This particular method will implement feature pointers for ALL EE_Admin pages.
1822
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
1823
+	 *
1824
+	 * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
1825
+	 *         extended) also see:
1826
+	 * @link   http://eamann.com/tech/wordpress-portland/
1827
+	 * @abstract
1828
+	 * @return void
1829
+	 */
1830
+	private function _add_global_feature_pointers()
1831
+	{
1832
+	}
1833
+
1834
+
1835
+	/**
1836
+	 * load_global_scripts_styles
1837
+	 * The scripts and styles enqueued in here will be loaded on every EE Admin page
1838
+	 *
1839
+	 * @return void
1840
+	 * @throws EE_Error
1841
+	 */
1842
+	public function load_global_scripts_styles()
1843
+	{
1844
+		/** STYLES **/
1845
+		// add debugging styles
1846
+		if (WP_DEBUG) {
1847
+			add_action('admin_head', array($this, 'add_xdebug_style'));
1848
+		}
1849
+		// register all styles
1850
+		wp_register_style(
1851
+			'espresso-ui-theme',
1852
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
1853
+			array(),
1854
+			EVENT_ESPRESSO_VERSION
1855
+		);
1856
+		wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
1857
+		// helpers styles
1858
+		wp_register_style(
1859
+			'ee-text-links',
1860
+			EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css',
1861
+			array(),
1862
+			EVENT_ESPRESSO_VERSION
1863
+		);
1864
+		/** SCRIPTS **/
1865
+		// register all scripts
1866
+		wp_register_script(
1867
+			'ee-dialog',
1868
+			EE_ADMIN_URL . 'assets/ee-dialog-helper.js',
1869
+			array('jquery', 'jquery-ui-draggable'),
1870
+			EVENT_ESPRESSO_VERSION,
1871
+			true
1872
+		);
1873
+		wp_register_script(
1874
+			'ee_admin_js',
1875
+			EE_ADMIN_URL . 'assets/ee-admin-page.js',
1876
+			array('espresso_core', 'ee-parse-uri', 'ee-dialog'),
1877
+			EVENT_ESPRESSO_VERSION,
1878
+			true
1879
+		);
1880
+		wp_register_script(
1881
+			'jquery-ui-timepicker-addon',
1882
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js',
1883
+			array('jquery-ui-datepicker', 'jquery-ui-slider'),
1884
+			EVENT_ESPRESSO_VERSION,
1885
+			true
1886
+		);
1887
+		add_filter('FHEE_load_joyride', '__return_true');
1888
+		// script for sorting tables
1889
+		wp_register_script(
1890
+			'espresso_ajax_table_sorting',
1891
+			EE_ADMIN_URL . 'assets/espresso_ajax_table_sorting.js',
1892
+			array('ee_admin_js', 'jquery-ui-sortable'),
1893
+			EVENT_ESPRESSO_VERSION,
1894
+			true
1895
+		);
1896
+		// script for parsing uri's
1897
+		wp_register_script(
1898
+			'ee-parse-uri',
1899
+			EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js',
1900
+			array(),
1901
+			EVENT_ESPRESSO_VERSION,
1902
+			true
1903
+		);
1904
+		// and parsing associative serialized form elements
1905
+		wp_register_script(
1906
+			'ee-serialize-full-array',
1907
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js',
1908
+			array('jquery'),
1909
+			EVENT_ESPRESSO_VERSION,
1910
+			true
1911
+		);
1912
+		// helpers scripts
1913
+		wp_register_script(
1914
+			'ee-text-links',
1915
+			EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js',
1916
+			array('jquery'),
1917
+			EVENT_ESPRESSO_VERSION,
1918
+			true
1919
+		);
1920
+		wp_register_script(
1921
+			'ee-moment-core',
1922
+			EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js',
1923
+			array(),
1924
+			EVENT_ESPRESSO_VERSION,
1925
+			true
1926
+		);
1927
+		wp_register_script(
1928
+			'ee-moment',
1929
+			EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js',
1930
+			array('ee-moment-core'),
1931
+			EVENT_ESPRESSO_VERSION,
1932
+			true
1933
+		);
1934
+		wp_register_script(
1935
+			'ee-datepicker',
1936
+			EE_ADMIN_URL . 'assets/ee-datepicker.js',
1937
+			array('jquery-ui-timepicker-addon', 'ee-moment'),
1938
+			EVENT_ESPRESSO_VERSION,
1939
+			true
1940
+		);
1941
+		// google charts
1942
+		wp_register_script(
1943
+			'google-charts',
1944
+			'https://www.gstatic.com/charts/loader.js',
1945
+			array(),
1946
+			EVENT_ESPRESSO_VERSION,
1947
+			false
1948
+		);
1949
+		// ENQUEUE ALL BASICS BY DEFAULT
1950
+		wp_enqueue_style('ee-admin-css');
1951
+		wp_enqueue_script('ee_admin_js');
1952
+		wp_enqueue_script('ee-accounting');
1953
+		wp_enqueue_script('jquery-validate');
1954
+		// taking care of metaboxes
1955
+		if (empty($this->_cpt_route)
1956
+			&& (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
1957
+		) {
1958
+			wp_enqueue_script('dashboard');
1959
+		}
1960
+		// LOCALIZED DATA
1961
+		// localize script for ajax lazy loading
1962
+		$lazy_loader_container_ids = apply_filters(
1963
+			'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
1964
+			array('espresso_news_post_box_content')
1965
+		);
1966
+		wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
1967
+		/**
1968
+		 * help tour stuff
1969
+		 */
1970
+		if (! empty($this->_help_tour)) {
1971
+			// register the js for kicking things off
1972
+			wp_enqueue_script(
1973
+				'ee-help-tour',
1974
+				EE_ADMIN_URL . 'assets/ee-help-tour.js',
1975
+				array('jquery-joyride'),
1976
+				EVENT_ESPRESSO_VERSION,
1977
+				true
1978
+			);
1979
+			$tours = array();
1980
+			// setup tours for the js tour object
1981
+			foreach ($this->_help_tour['tours'] as $tour) {
1982
+				if ($tour instanceof EE_Help_Tour) {
1983
+					$tours[] = array(
1984
+						'id'      => $tour->get_slug(),
1985
+						'options' => $tour->get_options(),
1986
+					);
1987
+				}
1988
+			}
1989
+			wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours));
1990
+			// admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
1991
+		}
1992
+	}
1993
+
1994
+
1995
+	/**
1996
+	 *        admin_footer_scripts_eei18n_js_strings
1997
+	 *
1998
+	 * @return        void
1999
+	 */
2000
+	public function admin_footer_scripts_eei18n_js_strings()
2001
+	{
2002
+		EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
2003
+		EE_Registry::$i18n_js_strings['confirm_delete'] = esc_html__(
2004
+			'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!!!',
2005
+			'event_espresso'
2006
+		);
2007
+		EE_Registry::$i18n_js_strings['January'] = esc_html__('January', 'event_espresso');
2008
+		EE_Registry::$i18n_js_strings['February'] = esc_html__('February', 'event_espresso');
2009
+		EE_Registry::$i18n_js_strings['March'] = esc_html__('March', 'event_espresso');
2010
+		EE_Registry::$i18n_js_strings['April'] = esc_html__('April', 'event_espresso');
2011
+		EE_Registry::$i18n_js_strings['May'] = esc_html__('May', 'event_espresso');
2012
+		EE_Registry::$i18n_js_strings['June'] = esc_html__('June', 'event_espresso');
2013
+		EE_Registry::$i18n_js_strings['July'] = esc_html__('July', 'event_espresso');
2014
+		EE_Registry::$i18n_js_strings['August'] = esc_html__('August', 'event_espresso');
2015
+		EE_Registry::$i18n_js_strings['September'] = esc_html__('September', 'event_espresso');
2016
+		EE_Registry::$i18n_js_strings['October'] = esc_html__('October', 'event_espresso');
2017
+		EE_Registry::$i18n_js_strings['November'] = esc_html__('November', 'event_espresso');
2018
+		EE_Registry::$i18n_js_strings['December'] = esc_html__('December', 'event_espresso');
2019
+		EE_Registry::$i18n_js_strings['Jan'] = esc_html__('Jan', 'event_espresso');
2020
+		EE_Registry::$i18n_js_strings['Feb'] = esc_html__('Feb', 'event_espresso');
2021
+		EE_Registry::$i18n_js_strings['Mar'] = esc_html__('Mar', 'event_espresso');
2022
+		EE_Registry::$i18n_js_strings['Apr'] = esc_html__('Apr', 'event_espresso');
2023
+		EE_Registry::$i18n_js_strings['May'] = esc_html__('May', 'event_espresso');
2024
+		EE_Registry::$i18n_js_strings['Jun'] = esc_html__('Jun', 'event_espresso');
2025
+		EE_Registry::$i18n_js_strings['Jul'] = esc_html__('Jul', 'event_espresso');
2026
+		EE_Registry::$i18n_js_strings['Aug'] = esc_html__('Aug', 'event_espresso');
2027
+		EE_Registry::$i18n_js_strings['Sep'] = esc_html__('Sep', 'event_espresso');
2028
+		EE_Registry::$i18n_js_strings['Oct'] = esc_html__('Oct', 'event_espresso');
2029
+		EE_Registry::$i18n_js_strings['Nov'] = esc_html__('Nov', 'event_espresso');
2030
+		EE_Registry::$i18n_js_strings['Dec'] = esc_html__('Dec', 'event_espresso');
2031
+		EE_Registry::$i18n_js_strings['Sunday'] = esc_html__('Sunday', 'event_espresso');
2032
+		EE_Registry::$i18n_js_strings['Monday'] = esc_html__('Monday', 'event_espresso');
2033
+		EE_Registry::$i18n_js_strings['Tuesday'] = esc_html__('Tuesday', 'event_espresso');
2034
+		EE_Registry::$i18n_js_strings['Wednesday'] = esc_html__('Wednesday', 'event_espresso');
2035
+		EE_Registry::$i18n_js_strings['Thursday'] = esc_html__('Thursday', 'event_espresso');
2036
+		EE_Registry::$i18n_js_strings['Friday'] = esc_html__('Friday', 'event_espresso');
2037
+		EE_Registry::$i18n_js_strings['Saturday'] = esc_html__('Saturday', 'event_espresso');
2038
+		EE_Registry::$i18n_js_strings['Sun'] = esc_html__('Sun', 'event_espresso');
2039
+		EE_Registry::$i18n_js_strings['Mon'] = esc_html__('Mon', 'event_espresso');
2040
+		EE_Registry::$i18n_js_strings['Tue'] = esc_html__('Tue', 'event_espresso');
2041
+		EE_Registry::$i18n_js_strings['Wed'] = esc_html__('Wed', 'event_espresso');
2042
+		EE_Registry::$i18n_js_strings['Thu'] = esc_html__('Thu', 'event_espresso');
2043
+		EE_Registry::$i18n_js_strings['Fri'] = esc_html__('Fri', 'event_espresso');
2044
+		EE_Registry::$i18n_js_strings['Sat'] = esc_html__('Sat', 'event_espresso');
2045
+	}
2046
+
2047
+
2048
+	/**
2049
+	 *        load enhanced xdebug styles for ppl with failing eyesight
2050
+	 *
2051
+	 * @return        void
2052
+	 */
2053
+	public function add_xdebug_style()
2054
+	{
2055
+		echo '<style>.xdebug-error { font-size:1.5em; }</style>';
2056
+	}
2057
+
2058
+
2059
+	/************************/
2060
+	/** LIST TABLE METHODS **/
2061
+	/************************/
2062
+	/**
2063
+	 * this sets up the list table if the current view requires it.
2064
+	 *
2065
+	 * @return void
2066
+	 * @throws EE_Error
2067
+	 */
2068
+	protected function _set_list_table()
2069
+	{
2070
+		// first is this a list_table view?
2071
+		if (! isset($this->_route_config['list_table'])) {
2072
+			return;
2073
+		} //not a list_table view so get out.
2074
+		// list table functions are per view specific (because some admin pages might have more than one list table!)
2075
+		$list_table_view = '_set_list_table_views_' . $this->_req_action;
2076
+		if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
2077
+			// user error msg
2078
+			$error_msg = esc_html__(
2079
+				'An error occurred. The requested list table views could not be found.',
2080
+				'event_espresso'
2081
+			);
2082
+			// developer error msg
2083
+			$error_msg .= '||'
2084
+						  . sprintf(
2085
+							  esc_html__(
2086
+								  '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.',
2087
+								  'event_espresso'
2088
+							  ),
2089
+							  $this->_req_action,
2090
+							  $list_table_view
2091
+						  );
2092
+			throw new EE_Error($error_msg);
2093
+		}
2094
+		// let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
2095
+		$this->_views = apply_filters(
2096
+			'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
2097
+			$this->_views
2098
+		);
2099
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
2100
+		$this->_views = apply_filters('FHEE_list_table_views', $this->_views);
2101
+		$this->_set_list_table_view();
2102
+		$this->_set_list_table_object();
2103
+	}
2104
+
2105
+
2106
+	/**
2107
+	 * set current view for List Table
2108
+	 *
2109
+	 * @return void
2110
+	 */
2111
+	protected function _set_list_table_view()
2112
+	{
2113
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2114
+		// looking at active items or dumpster diving ?
2115
+		if (! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
2116
+			$this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
2117
+		} else {
2118
+			$this->_view = sanitize_key($this->_req_data['status']);
2119
+		}
2120
+	}
2121
+
2122
+
2123
+	/**
2124
+	 * _set_list_table_object
2125
+	 * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
2126
+	 *
2127
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2128
+	 * @throws \InvalidArgumentException
2129
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2130
+	 * @throws EE_Error
2131
+	 * @throws InvalidInterfaceException
2132
+	 */
2133
+	protected function _set_list_table_object()
2134
+	{
2135
+		if (isset($this->_route_config['list_table'])) {
2136
+			if (! class_exists($this->_route_config['list_table'])) {
2137
+				throw new EE_Error(
2138
+					sprintf(
2139
+						esc_html__(
2140
+							'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.',
2141
+							'event_espresso'
2142
+						),
2143
+						$this->_route_config['list_table'],
2144
+						get_class($this)
2145
+					)
2146
+				);
2147
+			}
2148
+			$this->_list_table_object = $this->loader->getShared(
2149
+				$this->_route_config['list_table'],
2150
+				array($this)
2151
+			);
2152
+		}
2153
+	}
2154
+
2155
+
2156
+	/**
2157
+	 * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
2158
+	 *
2159
+	 * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
2160
+	 *                                                    urls.  The array should be indexed by the view it is being
2161
+	 *                                                    added to.
2162
+	 * @return array
2163
+	 */
2164
+	public function get_list_table_view_RLs($extra_query_args = array())
2165
+	{
2166
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2167
+		if (empty($this->_views)) {
2168
+			$this->_views = array();
2169
+		}
2170
+		// cycle thru views
2171
+		foreach ($this->_views as $key => $view) {
2172
+			$query_args = array();
2173
+			// check for current view
2174
+			$this->_views[ $key ]['class'] = $this->_view === $view['slug'] ? 'current' : '';
2175
+			$query_args['action'] = $this->_req_action;
2176
+			$query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
2177
+			$query_args['status'] = $view['slug'];
2178
+			// merge any other arguments sent in.
2179
+			if (isset($extra_query_args[ $view['slug'] ])) {
2180
+				$query_args = array_merge($query_args, $extra_query_args[ $view['slug'] ]);
2181
+			}
2182
+			$this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
2183
+		}
2184
+		return $this->_views;
2185
+	}
2186
+
2187
+
2188
+	/**
2189
+	 * _entries_per_page_dropdown
2190
+	 * generates a drop down box for selecting the number of visible rows in an admin page list table
2191
+	 *
2192
+	 * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how
2193
+	 *         WP does it.
2194
+	 * @param int $max_entries total number of rows in the table
2195
+	 * @return string
2196
+	 */
2197
+	protected function _entries_per_page_dropdown($max_entries = 0)
2198
+	{
2199
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2200
+		$values = array(10, 25, 50, 100);
2201
+		$per_page = (! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
2202
+		if ($max_entries) {
2203
+			$values[] = $max_entries;
2204
+			sort($values);
2205
+		}
2206
+		$entries_per_page_dropdown = '
2207 2207
 			<div id="entries-per-page-dv" class="alignleft actions">
2208 2208
 				<label class="hide-if-no-js">
2209 2209
 					Show
2210 2210
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
2211
-        foreach ($values as $value) {
2212
-            if ($value < $max_entries) {
2213
-                $selected = $value === $per_page ? ' selected="' . $per_page . '"' : '';
2214
-                $entries_per_page_dropdown .= '
2211
+		foreach ($values as $value) {
2212
+			if ($value < $max_entries) {
2213
+				$selected = $value === $per_page ? ' selected="' . $per_page . '"' : '';
2214
+				$entries_per_page_dropdown .= '
2215 2215
 						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
2216
-            }
2217
-        }
2218
-        $selected = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
2219
-        $entries_per_page_dropdown .= '
2216
+			}
2217
+		}
2218
+		$selected = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
2219
+		$entries_per_page_dropdown .= '
2220 2220
 						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
2221
-        $entries_per_page_dropdown .= '
2221
+		$entries_per_page_dropdown .= '
2222 2222
 					</select>
2223 2223
 					entries
2224 2224
 				</label>
2225 2225
 				<input id="entries-per-page-btn" class="button-secondary" type="submit" value="Go" >
2226 2226
 			</div>
2227 2227
 		';
2228
-        return $entries_per_page_dropdown;
2229
-    }
2230
-
2231
-
2232
-    /**
2233
-     *        _set_search_attributes
2234
-     *
2235
-     * @return        void
2236
-     */
2237
-    public function _set_search_attributes()
2238
-    {
2239
-        $this->_template_args['search']['btn_label'] = sprintf(
2240
-            esc_html__('Search %s', 'event_espresso'),
2241
-            empty($this->_search_btn_label) ? $this->page_label
2242
-                : $this->_search_btn_label
2243
-        );
2244
-        $this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
2245
-    }
2246
-
2247
-
2248
-
2249
-    /*** END LIST TABLE METHODS **/
2250
-
2251
-
2252
-    /**
2253
-     * _add_registered_metaboxes
2254
-     *  this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
2255
-     *
2256
-     * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
2257
-     * @return void
2258
-     * @throws EE_Error
2259
-     */
2260
-    private function _add_registered_meta_boxes()
2261
-    {
2262
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2263
-        // we only add meta boxes if the page_route calls for it
2264
-        if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
2265
-            && is_array(
2266
-                $this->_route_config['metaboxes']
2267
-            )
2268
-        ) {
2269
-            // this simply loops through the callbacks provided
2270
-            // and checks if there is a corresponding callback registered by the child
2271
-            // if there is then we go ahead and process the metabox loader.
2272
-            foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
2273
-                // first check for Closures
2274
-                if ($metabox_callback instanceof Closure) {
2275
-                    $result = $metabox_callback();
2276
-                } elseif (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
2277
-                    $result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
2278
-                } else {
2279
-                    $result = call_user_func(array($this, &$metabox_callback));
2280
-                }
2281
-                if ($result === false) {
2282
-                    // user error msg
2283
-                    $error_msg = esc_html__(
2284
-                        'An error occurred. The  requested metabox could not be found.',
2285
-                        'event_espresso'
2286
-                    );
2287
-                    // developer error msg
2288
-                    $error_msg .= '||'
2289
-                                  . sprintf(
2290
-                                      esc_html__(
2291
-                                          '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.',
2292
-                                          'event_espresso'
2293
-                                      ),
2294
-                                      $metabox_callback
2295
-                                  );
2296
-                    throw new EE_Error($error_msg);
2297
-                }
2298
-            }
2299
-        }
2300
-    }
2301
-
2302
-
2303
-    /**
2304
-     * _add_screen_columns
2305
-     * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as
2306
-     * the dynamic column template and we'll setup the column options for the page.
2307
-     *
2308
-     * @return void
2309
-     */
2310
-    private function _add_screen_columns()
2311
-    {
2312
-        if (is_array($this->_route_config)
2313
-            && isset($this->_route_config['columns'])
2314
-            && is_array($this->_route_config['columns'])
2315
-            && count($this->_route_config['columns']) === 2
2316
-        ) {
2317
-            add_screen_option(
2318
-                'layout_columns',
2319
-                array(
2320
-                    'max'     => (int) $this->_route_config['columns'][0],
2321
-                    'default' => (int) $this->_route_config['columns'][1],
2322
-                )
2323
-            );
2324
-            $this->_template_args['num_columns'] = $this->_route_config['columns'][0];
2325
-            $screen_id = $this->_current_screen->id;
2326
-            $screen_columns = (int) get_user_option("screen_layout_{$screen_id}");
2327
-            $total_columns = ! empty($screen_columns)
2328
-                ? $screen_columns
2329
-                : $this->_route_config['columns'][1];
2330
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
2331
-            $this->_template_args['current_page'] = $this->_wp_page_slug;
2332
-            $this->_template_args['screen'] = $this->_current_screen;
2333
-            $this->_column_template_path = EE_ADMIN_TEMPLATE
2334
-                                           . 'admin_details_metabox_column_wrapper.template.php';
2335
-            // finally if we don't have has_metaboxes set in the route config
2336
-            // let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
2337
-            $this->_route_config['has_metaboxes'] = true;
2338
-        }
2339
-    }
2340
-
2341
-
2342
-
2343
-    /** GLOBALLY AVAILABLE METABOXES **/
2344
-
2345
-
2346
-    /**
2347
-     * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply
2348
-     * referencing the callback in the _page_config array property.  This way you can be very specific about what pages
2349
-     * these get loaded on.
2350
-     */
2351
-    private function _espresso_news_post_box()
2352
-    {
2353
-        $news_box_title = apply_filters(
2354
-            'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
2355
-            esc_html__('New @ Event Espresso', 'event_espresso')
2356
-        );
2357
-        add_meta_box(
2358
-            'espresso_news_post_box',
2359
-            $news_box_title,
2360
-            array(
2361
-                $this,
2362
-                'espresso_news_post_box',
2363
-            ),
2364
-            $this->_wp_page_slug,
2365
-            'side'
2366
-        );
2367
-    }
2368
-
2369
-
2370
-    /**
2371
-     * Code for setting up espresso ratings request metabox.
2372
-     */
2373
-    protected function _espresso_ratings_request()
2374
-    {
2375
-        if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
2376
-            return;
2377
-        }
2378
-        $ratings_box_title = apply_filters(
2379
-            'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
2380
-            esc_html__('Keep Event Espresso Decaf Free', 'event_espresso')
2381
-        );
2382
-        add_meta_box(
2383
-            'espresso_ratings_request',
2384
-            $ratings_box_title,
2385
-            array(
2386
-                $this,
2387
-                'espresso_ratings_request',
2388
-            ),
2389
-            $this->_wp_page_slug,
2390
-            'side'
2391
-        );
2392
-    }
2393
-
2394
-
2395
-    /**
2396
-     * Code for setting up espresso ratings request metabox content.
2397
-     *
2398
-     * @throws DomainException
2399
-     */
2400
-    public function espresso_ratings_request()
2401
-    {
2402
-        EEH_Template::display_template(
2403
-            EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php',
2404
-            array()
2405
-        );
2406
-    }
2407
-
2408
-
2409
-    public static function cached_rss_display($rss_id, $url)
2410
-    {
2411
-        $loading = '<p class="widget-loading hide-if-no-js">'
2412
-                   . __('Loading&#8230;', 'event_espresso')
2413
-                   . '</p><p class="hide-if-js">'
2414
-                   . esc_html__('This widget requires JavaScript.', 'event_espresso')
2415
-                   . '</p>';
2416
-        $pre = '<div class="espresso-rss-display">' . "\n\t";
2417
-        $pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
2418
-        $post = '</div>' . "\n";
2419
-        $cache_key = 'ee_rss_' . md5($rss_id);
2420
-        $output = get_transient($cache_key);
2421
-        if ($output !== false) {
2422
-            echo $pre . $output . $post;
2423
-            return true;
2424
-        }
2425
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
2426
-            echo $pre . $loading . $post;
2427
-            return false;
2428
-        }
2429
-        ob_start();
2430
-        wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
2431
-        set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
2432
-        return true;
2433
-    }
2434
-
2435
-
2436
-    public function espresso_news_post_box()
2437
-    {
2438
-        ?>
2228
+		return $entries_per_page_dropdown;
2229
+	}
2230
+
2231
+
2232
+	/**
2233
+	 *        _set_search_attributes
2234
+	 *
2235
+	 * @return        void
2236
+	 */
2237
+	public function _set_search_attributes()
2238
+	{
2239
+		$this->_template_args['search']['btn_label'] = sprintf(
2240
+			esc_html__('Search %s', 'event_espresso'),
2241
+			empty($this->_search_btn_label) ? $this->page_label
2242
+				: $this->_search_btn_label
2243
+		);
2244
+		$this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
2245
+	}
2246
+
2247
+
2248
+
2249
+	/*** END LIST TABLE METHODS **/
2250
+
2251
+
2252
+	/**
2253
+	 * _add_registered_metaboxes
2254
+	 *  this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
2255
+	 *
2256
+	 * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
2257
+	 * @return void
2258
+	 * @throws EE_Error
2259
+	 */
2260
+	private function _add_registered_meta_boxes()
2261
+	{
2262
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2263
+		// we only add meta boxes if the page_route calls for it
2264
+		if (is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
2265
+			&& is_array(
2266
+				$this->_route_config['metaboxes']
2267
+			)
2268
+		) {
2269
+			// this simply loops through the callbacks provided
2270
+			// and checks if there is a corresponding callback registered by the child
2271
+			// if there is then we go ahead and process the metabox loader.
2272
+			foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
2273
+				// first check for Closures
2274
+				if ($metabox_callback instanceof Closure) {
2275
+					$result = $metabox_callback();
2276
+				} elseif (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
2277
+					$result = call_user_func(array($metabox_callback[0], $metabox_callback[1]));
2278
+				} else {
2279
+					$result = call_user_func(array($this, &$metabox_callback));
2280
+				}
2281
+				if ($result === false) {
2282
+					// user error msg
2283
+					$error_msg = esc_html__(
2284
+						'An error occurred. The  requested metabox could not be found.',
2285
+						'event_espresso'
2286
+					);
2287
+					// developer error msg
2288
+					$error_msg .= '||'
2289
+								  . sprintf(
2290
+									  esc_html__(
2291
+										  '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.',
2292
+										  'event_espresso'
2293
+									  ),
2294
+									  $metabox_callback
2295
+								  );
2296
+					throw new EE_Error($error_msg);
2297
+				}
2298
+			}
2299
+		}
2300
+	}
2301
+
2302
+
2303
+	/**
2304
+	 * _add_screen_columns
2305
+	 * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as
2306
+	 * the dynamic column template and we'll setup the column options for the page.
2307
+	 *
2308
+	 * @return void
2309
+	 */
2310
+	private function _add_screen_columns()
2311
+	{
2312
+		if (is_array($this->_route_config)
2313
+			&& isset($this->_route_config['columns'])
2314
+			&& is_array($this->_route_config['columns'])
2315
+			&& count($this->_route_config['columns']) === 2
2316
+		) {
2317
+			add_screen_option(
2318
+				'layout_columns',
2319
+				array(
2320
+					'max'     => (int) $this->_route_config['columns'][0],
2321
+					'default' => (int) $this->_route_config['columns'][1],
2322
+				)
2323
+			);
2324
+			$this->_template_args['num_columns'] = $this->_route_config['columns'][0];
2325
+			$screen_id = $this->_current_screen->id;
2326
+			$screen_columns = (int) get_user_option("screen_layout_{$screen_id}");
2327
+			$total_columns = ! empty($screen_columns)
2328
+				? $screen_columns
2329
+				: $this->_route_config['columns'][1];
2330
+			$this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
2331
+			$this->_template_args['current_page'] = $this->_wp_page_slug;
2332
+			$this->_template_args['screen'] = $this->_current_screen;
2333
+			$this->_column_template_path = EE_ADMIN_TEMPLATE
2334
+										   . 'admin_details_metabox_column_wrapper.template.php';
2335
+			// finally if we don't have has_metaboxes set in the route config
2336
+			// let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
2337
+			$this->_route_config['has_metaboxes'] = true;
2338
+		}
2339
+	}
2340
+
2341
+
2342
+
2343
+	/** GLOBALLY AVAILABLE METABOXES **/
2344
+
2345
+
2346
+	/**
2347
+	 * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply
2348
+	 * referencing the callback in the _page_config array property.  This way you can be very specific about what pages
2349
+	 * these get loaded on.
2350
+	 */
2351
+	private function _espresso_news_post_box()
2352
+	{
2353
+		$news_box_title = apply_filters(
2354
+			'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
2355
+			esc_html__('New @ Event Espresso', 'event_espresso')
2356
+		);
2357
+		add_meta_box(
2358
+			'espresso_news_post_box',
2359
+			$news_box_title,
2360
+			array(
2361
+				$this,
2362
+				'espresso_news_post_box',
2363
+			),
2364
+			$this->_wp_page_slug,
2365
+			'side'
2366
+		);
2367
+	}
2368
+
2369
+
2370
+	/**
2371
+	 * Code for setting up espresso ratings request metabox.
2372
+	 */
2373
+	protected function _espresso_ratings_request()
2374
+	{
2375
+		if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
2376
+			return;
2377
+		}
2378
+		$ratings_box_title = apply_filters(
2379
+			'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
2380
+			esc_html__('Keep Event Espresso Decaf Free', 'event_espresso')
2381
+		);
2382
+		add_meta_box(
2383
+			'espresso_ratings_request',
2384
+			$ratings_box_title,
2385
+			array(
2386
+				$this,
2387
+				'espresso_ratings_request',
2388
+			),
2389
+			$this->_wp_page_slug,
2390
+			'side'
2391
+		);
2392
+	}
2393
+
2394
+
2395
+	/**
2396
+	 * Code for setting up espresso ratings request metabox content.
2397
+	 *
2398
+	 * @throws DomainException
2399
+	 */
2400
+	public function espresso_ratings_request()
2401
+	{
2402
+		EEH_Template::display_template(
2403
+			EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php',
2404
+			array()
2405
+		);
2406
+	}
2407
+
2408
+
2409
+	public static function cached_rss_display($rss_id, $url)
2410
+	{
2411
+		$loading = '<p class="widget-loading hide-if-no-js">'
2412
+				   . __('Loading&#8230;', 'event_espresso')
2413
+				   . '</p><p class="hide-if-js">'
2414
+				   . esc_html__('This widget requires JavaScript.', 'event_espresso')
2415
+				   . '</p>';
2416
+		$pre = '<div class="espresso-rss-display">' . "\n\t";
2417
+		$pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
2418
+		$post = '</div>' . "\n";
2419
+		$cache_key = 'ee_rss_' . md5($rss_id);
2420
+		$output = get_transient($cache_key);
2421
+		if ($output !== false) {
2422
+			echo $pre . $output . $post;
2423
+			return true;
2424
+		}
2425
+		if (! (defined('DOING_AJAX') && DOING_AJAX)) {
2426
+			echo $pre . $loading . $post;
2427
+			return false;
2428
+		}
2429
+		ob_start();
2430
+		wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5));
2431
+		set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
2432
+		return true;
2433
+	}
2434
+
2435
+
2436
+	public function espresso_news_post_box()
2437
+	{
2438
+		?>
2439 2439
         <div class="padding">
2440 2440
             <div id="espresso_news_post_box_content" class="infolinks">
2441 2441
                 <?php
2442
-                // Get RSS Feed(s)
2443
-                self::cached_rss_display(
2444
-                    'espresso_news_post_box_content',
2445
-                    urlencode(
2446
-                        apply_filters(
2447
-                            'FHEE__EE_Admin_Page__espresso_news_post_box__feed_url',
2448
-                            'http://eventespresso.com/feed/'
2449
-                        )
2450
-                    )
2451
-                );
2452
-                ?>
2442
+				// Get RSS Feed(s)
2443
+				self::cached_rss_display(
2444
+					'espresso_news_post_box_content',
2445
+					urlencode(
2446
+						apply_filters(
2447
+							'FHEE__EE_Admin_Page__espresso_news_post_box__feed_url',
2448
+							'http://eventespresso.com/feed/'
2449
+						)
2450
+					)
2451
+				);
2452
+				?>
2453 2453
             </div>
2454 2454
             <?php do_action('AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
2455 2455
         </div>
2456 2456
         <?php
2457
-    }
2458
-
2459
-
2460
-    private function _espresso_links_post_box()
2461
-    {
2462
-        // Hiding until we actually have content to put in here...
2463
-        // add_meta_box('espresso_links_post_box', esc_html__('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
2464
-    }
2465
-
2466
-
2467
-    public function espresso_links_post_box()
2468
-    {
2469
-        // Hiding until we actually have content to put in here...
2470
-        // EEH_Template::display_template(
2471
-        //     EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php'
2472
-        // );
2473
-    }
2474
-
2475
-
2476
-    protected function _espresso_sponsors_post_box()
2477
-    {
2478
-        if (apply_filters('FHEE_show_sponsors_meta_box', true)) {
2479
-            add_meta_box(
2480
-                'espresso_sponsors_post_box',
2481
-                esc_html__('Event Espresso Highlights', 'event_espresso'),
2482
-                array($this, 'espresso_sponsors_post_box'),
2483
-                $this->_wp_page_slug,
2484
-                'side'
2485
-            );
2486
-        }
2487
-    }
2488
-
2489
-
2490
-    public function espresso_sponsors_post_box()
2491
-    {
2492
-        EEH_Template::display_template(
2493
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
2494
-        );
2495
-    }
2496
-
2497
-
2498
-    private function _publish_post_box()
2499
-    {
2500
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
2501
-        // if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array
2502
-        // then we'll use that for the metabox label.
2503
-        // Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
2504
-        if (! empty($this->_labels['publishbox'])) {
2505
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][ $this->_req_action ]
2506
-                : $this->_labels['publishbox'];
2507
-        } else {
2508
-            $box_label = esc_html__('Publish', 'event_espresso');
2509
-        }
2510
-        $box_label = apply_filters(
2511
-            'FHEE__EE_Admin_Page___publish_post_box__box_label',
2512
-            $box_label,
2513
-            $this->_req_action,
2514
-            $this
2515
-        );
2516
-        add_meta_box(
2517
-            $meta_box_ref,
2518
-            $box_label,
2519
-            array($this, 'editor_overview'),
2520
-            $this->_current_screen->id,
2521
-            'side',
2522
-            'high'
2523
-        );
2524
-    }
2525
-
2526
-
2527
-    public function editor_overview()
2528
-    {
2529
-        // if we have extra content set let's add it in if not make sure its empty
2530
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content'])
2531
-            ? $this->_template_args['publish_box_extra_content']
2532
-            : '';
2533
-        echo EEH_Template::display_template(
2534
-            EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
2535
-            $this->_template_args,
2536
-            true
2537
-        );
2538
-    }
2539
-
2540
-
2541
-    /** end of globally available metaboxes section **/
2542
-
2543
-
2544
-    /**
2545
-     * Public wrapper for the protected method.  Allows plugins/addons to externally call the
2546
-     * protected method.
2547
-     *
2548
-     * @see   $this->_set_publish_post_box_vars for param details
2549
-     * @since 4.6.0
2550
-     * @param string $name
2551
-     * @param int    $id
2552
-     * @param bool   $delete
2553
-     * @param string $save_close_redirect_URL
2554
-     * @param bool   $both_btns
2555
-     * @throws EE_Error
2556
-     * @throws InvalidArgumentException
2557
-     * @throws InvalidDataTypeException
2558
-     * @throws InvalidInterfaceException
2559
-     */
2560
-    public function set_publish_post_box_vars(
2561
-        $name = '',
2562
-        $id = 0,
2563
-        $delete = false,
2564
-        $save_close_redirect_URL = '',
2565
-        $both_btns = true
2566
-    ) {
2567
-        $this->_set_publish_post_box_vars(
2568
-            $name,
2569
-            $id,
2570
-            $delete,
2571
-            $save_close_redirect_URL,
2572
-            $both_btns
2573
-        );
2574
-    }
2575
-
2576
-
2577
-    /**
2578
-     * Sets the _template_args arguments used by the _publish_post_box shortcut
2579
-     * Note: currently there is no validation for this.  However if you want the delete button, the
2580
-     * save, and save and close buttons to work properly, then you will want to include a
2581
-     * values for the name and id arguments.
2582
-     *
2583
-     * @todo  Add in validation for name/id arguments.
2584
-     * @param    string  $name                    key used for the action ID (i.e. event_id)
2585
-     * @param    int     $id                      id attached to the item published
2586
-     * @param    string  $delete                  page route callback for the delete action
2587
-     * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
2588
-     * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just
2589
-     *                                            the Save button
2590
-     * @throws EE_Error
2591
-     * @throws InvalidArgumentException
2592
-     * @throws InvalidDataTypeException
2593
-     * @throws InvalidInterfaceException
2594
-     */
2595
-    protected function _set_publish_post_box_vars(
2596
-        $name = '',
2597
-        $id = 0,
2598
-        $delete = '',
2599
-        $save_close_redirect_URL = '',
2600
-        $both_btns = true
2601
-    ) {
2602
-        // if Save & Close, use a custom redirect URL or default to the main page?
2603
-        $save_close_redirect_URL = ! empty($save_close_redirect_URL)
2604
-            ? $save_close_redirect_URL
2605
-            : $this->_admin_base_url;
2606
-        // create the Save & Close and Save buttons
2607
-        $this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
2608
-        // if we have extra content set let's add it in if not make sure its empty
2609
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content'])
2610
-            ? $this->_template_args['publish_box_extra_content']
2611
-            : '';
2612
-        if ($delete && ! empty($id)) {
2613
-            // make sure we have a default if just true is sent.
2614
-            $delete = ! empty($delete) ? $delete : 'delete';
2615
-            $delete_link_args = array($name => $id);
2616
-            $delete = $this->get_action_link_or_button(
2617
-                $delete,
2618
-                $delete,
2619
-                $delete_link_args,
2620
-                'submitdelete deletion',
2621
-                '',
2622
-                false
2623
-            );
2624
-        }
2625
-        $this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
2626
-        if (! empty($name) && ! empty($id)) {
2627
-            $hidden_field_arr[ $name ] = array(
2628
-                'type'  => 'hidden',
2629
-                'value' => $id,
2630
-            );
2631
-            $hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
2632
-        } else {
2633
-            $hf = '';
2634
-        }
2635
-        // add hidden field
2636
-        $this->_template_args['publish_hidden_fields'] = is_array($hf) && ! empty($name)
2637
-            ? $hf[ $name ]['field']
2638
-            : $hf;
2639
-    }
2640
-
2641
-
2642
-    /**
2643
-     * displays an error message to ppl who have javascript disabled
2644
-     *
2645
-     * @return void
2646
-     */
2647
-    private function _display_no_javascript_warning()
2648
-    {
2649
-        ?>
2457
+	}
2458
+
2459
+
2460
+	private function _espresso_links_post_box()
2461
+	{
2462
+		// Hiding until we actually have content to put in here...
2463
+		// add_meta_box('espresso_links_post_box', esc_html__('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
2464
+	}
2465
+
2466
+
2467
+	public function espresso_links_post_box()
2468
+	{
2469
+		// Hiding until we actually have content to put in here...
2470
+		// EEH_Template::display_template(
2471
+		//     EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php'
2472
+		// );
2473
+	}
2474
+
2475
+
2476
+	protected function _espresso_sponsors_post_box()
2477
+	{
2478
+		if (apply_filters('FHEE_show_sponsors_meta_box', true)) {
2479
+			add_meta_box(
2480
+				'espresso_sponsors_post_box',
2481
+				esc_html__('Event Espresso Highlights', 'event_espresso'),
2482
+				array($this, 'espresso_sponsors_post_box'),
2483
+				$this->_wp_page_slug,
2484
+				'side'
2485
+			);
2486
+		}
2487
+	}
2488
+
2489
+
2490
+	public function espresso_sponsors_post_box()
2491
+	{
2492
+		EEH_Template::display_template(
2493
+			EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
2494
+		);
2495
+	}
2496
+
2497
+
2498
+	private function _publish_post_box()
2499
+	{
2500
+		$meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
2501
+		// if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array
2502
+		// then we'll use that for the metabox label.
2503
+		// Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
2504
+		if (! empty($this->_labels['publishbox'])) {
2505
+			$box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][ $this->_req_action ]
2506
+				: $this->_labels['publishbox'];
2507
+		} else {
2508
+			$box_label = esc_html__('Publish', 'event_espresso');
2509
+		}
2510
+		$box_label = apply_filters(
2511
+			'FHEE__EE_Admin_Page___publish_post_box__box_label',
2512
+			$box_label,
2513
+			$this->_req_action,
2514
+			$this
2515
+		);
2516
+		add_meta_box(
2517
+			$meta_box_ref,
2518
+			$box_label,
2519
+			array($this, 'editor_overview'),
2520
+			$this->_current_screen->id,
2521
+			'side',
2522
+			'high'
2523
+		);
2524
+	}
2525
+
2526
+
2527
+	public function editor_overview()
2528
+	{
2529
+		// if we have extra content set let's add it in if not make sure its empty
2530
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content'])
2531
+			? $this->_template_args['publish_box_extra_content']
2532
+			: '';
2533
+		echo EEH_Template::display_template(
2534
+			EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
2535
+			$this->_template_args,
2536
+			true
2537
+		);
2538
+	}
2539
+
2540
+
2541
+	/** end of globally available metaboxes section **/
2542
+
2543
+
2544
+	/**
2545
+	 * Public wrapper for the protected method.  Allows plugins/addons to externally call the
2546
+	 * protected method.
2547
+	 *
2548
+	 * @see   $this->_set_publish_post_box_vars for param details
2549
+	 * @since 4.6.0
2550
+	 * @param string $name
2551
+	 * @param int    $id
2552
+	 * @param bool   $delete
2553
+	 * @param string $save_close_redirect_URL
2554
+	 * @param bool   $both_btns
2555
+	 * @throws EE_Error
2556
+	 * @throws InvalidArgumentException
2557
+	 * @throws InvalidDataTypeException
2558
+	 * @throws InvalidInterfaceException
2559
+	 */
2560
+	public function set_publish_post_box_vars(
2561
+		$name = '',
2562
+		$id = 0,
2563
+		$delete = false,
2564
+		$save_close_redirect_URL = '',
2565
+		$both_btns = true
2566
+	) {
2567
+		$this->_set_publish_post_box_vars(
2568
+			$name,
2569
+			$id,
2570
+			$delete,
2571
+			$save_close_redirect_URL,
2572
+			$both_btns
2573
+		);
2574
+	}
2575
+
2576
+
2577
+	/**
2578
+	 * Sets the _template_args arguments used by the _publish_post_box shortcut
2579
+	 * Note: currently there is no validation for this.  However if you want the delete button, the
2580
+	 * save, and save and close buttons to work properly, then you will want to include a
2581
+	 * values for the name and id arguments.
2582
+	 *
2583
+	 * @todo  Add in validation for name/id arguments.
2584
+	 * @param    string  $name                    key used for the action ID (i.e. event_id)
2585
+	 * @param    int     $id                      id attached to the item published
2586
+	 * @param    string  $delete                  page route callback for the delete action
2587
+	 * @param    string  $save_close_redirect_URL custom URL to redirect to after Save & Close has been completed
2588
+	 * @param    boolean $both_btns               whether to display BOTH the "Save & Close" and "Save" buttons or just
2589
+	 *                                            the Save button
2590
+	 * @throws EE_Error
2591
+	 * @throws InvalidArgumentException
2592
+	 * @throws InvalidDataTypeException
2593
+	 * @throws InvalidInterfaceException
2594
+	 */
2595
+	protected function _set_publish_post_box_vars(
2596
+		$name = '',
2597
+		$id = 0,
2598
+		$delete = '',
2599
+		$save_close_redirect_URL = '',
2600
+		$both_btns = true
2601
+	) {
2602
+		// if Save & Close, use a custom redirect URL or default to the main page?
2603
+		$save_close_redirect_URL = ! empty($save_close_redirect_URL)
2604
+			? $save_close_redirect_URL
2605
+			: $this->_admin_base_url;
2606
+		// create the Save & Close and Save buttons
2607
+		$this->_set_save_buttons($both_btns, array(), array(), $save_close_redirect_URL);
2608
+		// if we have extra content set let's add it in if not make sure its empty
2609
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content'])
2610
+			? $this->_template_args['publish_box_extra_content']
2611
+			: '';
2612
+		if ($delete && ! empty($id)) {
2613
+			// make sure we have a default if just true is sent.
2614
+			$delete = ! empty($delete) ? $delete : 'delete';
2615
+			$delete_link_args = array($name => $id);
2616
+			$delete = $this->get_action_link_or_button(
2617
+				$delete,
2618
+				$delete,
2619
+				$delete_link_args,
2620
+				'submitdelete deletion',
2621
+				'',
2622
+				false
2623
+			);
2624
+		}
2625
+		$this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
2626
+		if (! empty($name) && ! empty($id)) {
2627
+			$hidden_field_arr[ $name ] = array(
2628
+				'type'  => 'hidden',
2629
+				'value' => $id,
2630
+			);
2631
+			$hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
2632
+		} else {
2633
+			$hf = '';
2634
+		}
2635
+		// add hidden field
2636
+		$this->_template_args['publish_hidden_fields'] = is_array($hf) && ! empty($name)
2637
+			? $hf[ $name ]['field']
2638
+			: $hf;
2639
+	}
2640
+
2641
+
2642
+	/**
2643
+	 * displays an error message to ppl who have javascript disabled
2644
+	 *
2645
+	 * @return void
2646
+	 */
2647
+	private function _display_no_javascript_warning()
2648
+	{
2649
+		?>
2650 2650
         <noscript>
2651 2651
             <div id="no-js-message" class="error">
2652 2652
                 <p style="font-size:1.3em;">
2653 2653
                     <span style="color:red;"><?php esc_html_e('Warning!', 'event_espresso'); ?></span>
2654 2654
                     <?php esc_html_e(
2655
-                        '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.',
2656
-                        'event_espresso'
2657
-                    ); ?>
2655
+						'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.',
2656
+						'event_espresso'
2657
+					); ?>
2658 2658
                 </p>
2659 2659
             </div>
2660 2660
         </noscript>
2661 2661
         <?php
2662
-    }
2663
-
2664
-
2665
-    /**
2666
-     * displays espresso success and/or error notices
2667
-     *
2668
-     * @return void
2669
-     */
2670
-    private function _display_espresso_notices()
2671
-    {
2672
-        $notices = $this->_get_transient(true);
2673
-        echo stripslashes($notices);
2674
-    }
2675
-
2676
-
2677
-    /**
2678
-     * spinny things pacify the masses
2679
-     *
2680
-     * @return void
2681
-     */
2682
-    protected function _add_admin_page_ajax_loading_img()
2683
-    {
2684
-        ?>
2662
+	}
2663
+
2664
+
2665
+	/**
2666
+	 * displays espresso success and/or error notices
2667
+	 *
2668
+	 * @return void
2669
+	 */
2670
+	private function _display_espresso_notices()
2671
+	{
2672
+		$notices = $this->_get_transient(true);
2673
+		echo stripslashes($notices);
2674
+	}
2675
+
2676
+
2677
+	/**
2678
+	 * spinny things pacify the masses
2679
+	 *
2680
+	 * @return void
2681
+	 */
2682
+	protected function _add_admin_page_ajax_loading_img()
2683
+	{
2684
+		?>
2685 2685
         <div id="espresso-ajax-loading" class="ajax-loading-grey">
2686 2686
             <span class="ee-spinner ee-spin"></span><span class="hidden"><?php
2687
-                esc_html_e('loading...', 'event_espresso'); ?></span>
2687
+				esc_html_e('loading...', 'event_espresso'); ?></span>
2688 2688
         </div>
2689 2689
         <?php
2690
-    }
2690
+	}
2691 2691
 
2692 2692
 
2693
-    /**
2694
-     * add admin page overlay for modal boxes
2695
-     *
2696
-     * @return void
2697
-     */
2698
-    protected function _add_admin_page_overlay()
2699
-    {
2700
-        ?>
2693
+	/**
2694
+	 * add admin page overlay for modal boxes
2695
+	 *
2696
+	 * @return void
2697
+	 */
2698
+	protected function _add_admin_page_overlay()
2699
+	{
2700
+		?>
2701 2701
         <div id="espresso-admin-page-overlay-dv" class=""></div>
2702 2702
         <?php
2703
-    }
2704
-
2705
-
2706
-    /**
2707
-     * facade for add_meta_box
2708
-     *
2709
-     * @param string  $action        where the metabox get's displayed
2710
-     * @param string  $title         Title of Metabox (output in metabox header)
2711
-     * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback
2712
-     *                               instead of the one created in here.
2713
-     * @param array   $callback_args an array of args supplied for the metabox
2714
-     * @param string  $column        what metabox column
2715
-     * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
2716
-     * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function
2717
-     *                               created but just set our own callback for wp's add_meta_box.
2718
-     * @throws \DomainException
2719
-     */
2720
-    public function _add_admin_page_meta_box(
2721
-        $action,
2722
-        $title,
2723
-        $callback,
2724
-        $callback_args,
2725
-        $column = 'normal',
2726
-        $priority = 'high',
2727
-        $create_func = true
2728
-    ) {
2729
-        do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
2730
-        // 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.
2731
-        if (empty($callback_args) && $create_func) {
2732
-            $callback_args = array(
2733
-                'template_path' => $this->_template_path,
2734
-                'template_args' => $this->_template_args,
2735
-            );
2736
-        }
2737
-        // 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)
2738
-        $call_back_func = $create_func
2739
-            ? function ($post, $metabox) {
2740
-                do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2741
-                echo EEH_Template::display_template(
2742
-                    $metabox['args']['template_path'],
2743
-                    $metabox['args']['template_args'],
2744
-                    true
2745
-                );
2746
-            }
2747
-            : $callback;
2748
-        add_meta_box(
2749
-            str_replace('_', '-', $action) . '-mbox',
2750
-            $title,
2751
-            $call_back_func,
2752
-            $this->_wp_page_slug,
2753
-            $column,
2754
-            $priority,
2755
-            $callback_args
2756
-        );
2757
-    }
2758
-
2759
-
2760
-    /**
2761
-     * generates HTML wrapper for and admin details page that contains metaboxes in columns
2762
-     *
2763
-     * @throws DomainException
2764
-     * @throws EE_Error
2765
-     */
2766
-    public function display_admin_page_with_metabox_columns()
2767
-    {
2768
-        $this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
2769
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
2770
-            $this->_column_template_path,
2771
-            $this->_template_args,
2772
-            true
2773
-        );
2774
-        // the final wrapper
2775
-        $this->admin_page_wrapper();
2776
-    }
2777
-
2778
-
2779
-    /**
2780
-     * generates  HTML wrapper for an admin details page
2781
-     *
2782
-     * @return void
2783
-     * @throws EE_Error
2784
-     * @throws DomainException
2785
-     */
2786
-    public function display_admin_page_with_sidebar()
2787
-    {
2788
-        $this->_display_admin_page(true);
2789
-    }
2790
-
2791
-
2792
-    /**
2793
-     * generates  HTML wrapper for an admin details page (except no sidebar)
2794
-     *
2795
-     * @return void
2796
-     * @throws EE_Error
2797
-     * @throws DomainException
2798
-     */
2799
-    public function display_admin_page_with_no_sidebar()
2800
-    {
2801
-        $this->_display_admin_page();
2802
-    }
2803
-
2804
-
2805
-    /**
2806
-     * generates HTML wrapper for an EE about admin page (no sidebar)
2807
-     *
2808
-     * @return void
2809
-     * @throws EE_Error
2810
-     * @throws DomainException
2811
-     */
2812
-    public function display_about_admin_page()
2813
-    {
2814
-        $this->_display_admin_page(false, true);
2815
-    }
2816
-
2817
-
2818
-    /**
2819
-     * display_admin_page
2820
-     * contains the code for actually displaying an admin page
2821
-     *
2822
-     * @param  boolean $sidebar true with sidebar, false without
2823
-     * @param  boolean $about   use the about admin wrapper instead of the default.
2824
-     * @return void
2825
-     * @throws DomainException
2826
-     * @throws EE_Error
2827
-     */
2828
-    private function _display_admin_page($sidebar = false, $about = false)
2829
-    {
2830
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2831
-        // custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
2832
-        do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
2833
-        // set current wp page slug - looks like: event-espresso_page_event_categories
2834
-        // keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
2835
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
2836
-        $this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
2837
-            ? 'poststuff'
2838
-            : 'espresso-default-admin';
2839
-        $template_path = $sidebar
2840
-            ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
2841
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
2842
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2843
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
2844
-        }
2845
-        $template_path = ! empty($this->_column_template_path)
2846
-            ? $this->_column_template_path : $template_path;
2847
-        $this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content'])
2848
-            ? $this->_template_args['admin_page_content']
2849
-            : '';
2850
-        $this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content'])
2851
-            ? $this->_template_args['before_admin_page_content']
2852
-            : '';
2853
-        $this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content'])
2854
-            ? $this->_template_args['after_admin_page_content']
2855
-            : '';
2856
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
2857
-            $template_path,
2858
-            $this->_template_args,
2859
-            true
2860
-        );
2861
-        // the final template wrapper
2862
-        $this->admin_page_wrapper($about);
2863
-    }
2864
-
2865
-
2866
-    /**
2867
-     * This is used to display caf preview pages.
2868
-     *
2869
-     * @since 4.3.2
2870
-     * @param string $utm_campaign_source what is the key used for google analytics link
2871
-     * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE
2872
-     *                                    = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
2873
-     * @return void
2874
-     * @throws DomainException
2875
-     * @throws EE_Error
2876
-     * @throws InvalidArgumentException
2877
-     * @throws InvalidDataTypeException
2878
-     * @throws InvalidInterfaceException
2879
-     */
2880
-    public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
2881
-    {
2882
-        // let's generate a default preview action button if there isn't one already present.
2883
-        $this->_labels['buttons']['buy_now'] = esc_html__(
2884
-            'Upgrade to Event Espresso 4 Right Now',
2885
-            'event_espresso'
2886
-        );
2887
-        $buy_now_url = add_query_arg(
2888
-            array(
2889
-                'ee_ver'       => 'ee4',
2890
-                'utm_source'   => 'ee4_plugin_admin',
2891
-                'utm_medium'   => 'link',
2892
-                'utm_campaign' => $utm_campaign_source,
2893
-                'utm_content'  => 'buy_now_button',
2894
-            ),
2895
-            'http://eventespresso.com/pricing/'
2896
-        );
2897
-        $this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
2898
-            ? $this->get_action_link_or_button(
2899
-                '',
2900
-                'buy_now',
2901
-                array(),
2902
-                'button-primary button-large',
2903
-                $buy_now_url,
2904
-                true
2905
-            )
2906
-            : $this->_template_args['preview_action_button'];
2907
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
2908
-            EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
2909
-            $this->_template_args,
2910
-            true
2911
-        );
2912
-        $this->_display_admin_page($display_sidebar);
2913
-    }
2914
-
2915
-
2916
-    /**
2917
-     * display_admin_list_table_page_with_sidebar
2918
-     * generates HTML wrapper for an admin_page with list_table
2919
-     *
2920
-     * @return void
2921
-     * @throws EE_Error
2922
-     * @throws DomainException
2923
-     */
2924
-    public function display_admin_list_table_page_with_sidebar()
2925
-    {
2926
-        $this->_display_admin_list_table_page(true);
2927
-    }
2928
-
2929
-
2930
-    /**
2931
-     * display_admin_list_table_page_with_no_sidebar
2932
-     * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
2933
-     *
2934
-     * @return void
2935
-     * @throws EE_Error
2936
-     * @throws DomainException
2937
-     */
2938
-    public function display_admin_list_table_page_with_no_sidebar()
2939
-    {
2940
-        $this->_display_admin_list_table_page();
2941
-    }
2942
-
2943
-
2944
-    /**
2945
-     * generates html wrapper for an admin_list_table page
2946
-     *
2947
-     * @param boolean $sidebar whether to display with sidebar or not.
2948
-     * @return void
2949
-     * @throws DomainException
2950
-     * @throws EE_Error
2951
-     */
2952
-    private function _display_admin_list_table_page($sidebar = false)
2953
-    {
2954
-        // setup search attributes
2955
-        $this->_set_search_attributes();
2956
-        $this->_template_args['current_page'] = $this->_wp_page_slug;
2957
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
2958
-        $this->_template_args['table_url'] = defined('DOING_AJAX')
2959
-            ? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
2960
-            : add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
2961
-        $this->_template_args['list_table'] = $this->_list_table_object;
2962
-        $this->_template_args['current_route'] = $this->_req_action;
2963
-        $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
2964
-        $ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
2965
-        if (! empty($ajax_sorting_callback)) {
2966
-            $sortable_list_table_form_fields = wp_nonce_field(
2967
-                $ajax_sorting_callback . '_nonce',
2968
-                $ajax_sorting_callback . '_nonce',
2969
-                false,
2970
-                false
2971
-            );
2972
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="'
2973
-                                                . $this->page_slug
2974
-                                                . '" />';
2975
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="'
2976
-                                                . $ajax_sorting_callback
2977
-                                                . '" />';
2978
-        } else {
2979
-            $sortable_list_table_form_fields = '';
2980
-        }
2981
-        $this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
2982
-        $hidden_form_fields = isset($this->_template_args['list_table_hidden_fields'])
2983
-            ? $this->_template_args['list_table_hidden_fields']
2984
-            : '';
2985
-        $nonce_ref = $this->_req_action . '_nonce';
2986
-        $hidden_form_fields .= '<input type="hidden" name="'
2987
-                               . $nonce_ref
2988
-                               . '" value="'
2989
-                               . wp_create_nonce($nonce_ref)
2990
-                               . '">';
2991
-        $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
2992
-        // display message about search results?
2993
-        $this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
2994
-            ? '<p class="ee-search-results">' . sprintf(
2995
-                esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
2996
-                trim($this->_req_data['s'], '%')
2997
-            ) . '</p>'
2998
-            : '';
2999
-        // filter before_list_table template arg
3000
-        $this->_template_args['before_list_table'] = apply_filters(
3001
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
3002
-            $this->_template_args['before_list_table'],
3003
-            $this->page_slug,
3004
-            $this->_req_data,
3005
-            $this->_req_action
3006
-        );
3007
-        // convert to array and filter again
3008
-        // arrays are easier to inject new items in a specific location,
3009
-        // but would not be backwards compatible, so we have to add a new filter
3010
-        $this->_template_args['before_list_table'] = implode(
3011
-            " \n",
3012
-            (array) apply_filters(
3013
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
3014
-                (array) $this->_template_args['before_list_table'],
3015
-                $this->page_slug,
3016
-                $this->_req_data,
3017
-                $this->_req_action
3018
-            )
3019
-        );
3020
-        // filter after_list_table template arg
3021
-        $this->_template_args['after_list_table'] = apply_filters(
3022
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
3023
-            $this->_template_args['after_list_table'],
3024
-            $this->page_slug,
3025
-            $this->_req_data,
3026
-            $this->_req_action
3027
-        );
3028
-        // convert to array and filter again
3029
-        // arrays are easier to inject new items in a specific location,
3030
-        // but would not be backwards compatible, so we have to add a new filter
3031
-        $this->_template_args['after_list_table'] = implode(
3032
-            " \n",
3033
-            (array) apply_filters(
3034
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
3035
-                (array) $this->_template_args['after_list_table'],
3036
-                $this->page_slug,
3037
-                $this->_req_data,
3038
-                $this->_req_action
3039
-            )
3040
-        );
3041
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
3042
-            $template_path,
3043
-            $this->_template_args,
3044
-            true
3045
-        );
3046
-        // the final template wrapper
3047
-        if ($sidebar) {
3048
-            $this->display_admin_page_with_sidebar();
3049
-        } else {
3050
-            $this->display_admin_page_with_no_sidebar();
3051
-        }
3052
-    }
3053
-
3054
-
3055
-    /**
3056
-     * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the
3057
-     * html string for the legend.
3058
-     * $items are expected in an array in the following format:
3059
-     * $legend_items = array(
3060
-     *        'item_id' => array(
3061
-     *            'icon' => 'http://url_to_icon_being_described.png',
3062
-     *            'desc' => esc_html__('localized description of item');
3063
-     *        )
3064
-     * );
3065
-     *
3066
-     * @param  array $items see above for format of array
3067
-     * @return string html string of legend
3068
-     * @throws DomainException
3069
-     */
3070
-    protected function _display_legend($items)
3071
-    {
3072
-        $this->_template_args['items'] = apply_filters(
3073
-            'FHEE__EE_Admin_Page___display_legend__items',
3074
-            (array) $items,
3075
-            $this
3076
-        );
3077
-        return EEH_Template::display_template(
3078
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
3079
-            $this->_template_args,
3080
-            true
3081
-        );
3082
-    }
3083
-
3084
-
3085
-    /**
3086
-     * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
3087
-     * The returned json object is created from an array in the following format:
3088
-     * array(
3089
-     *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
3090
-     *  'success' => FALSE, //(default FALSE) - contains any special success message.
3091
-     *  'notices' => '', // - contains any EE_Error formatted notices
3092
-     *  'content' => 'string can be html', //this is a string of formatted content (can be html)
3093
-     *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
3094
-     *  We're also going to include the template args with every package (so js can pick out any specific template args
3095
-     *  that might be included in here)
3096
-     * )
3097
-     * The json object is populated by whatever is set in the $_template_args property.
3098
-     *
3099
-     * @param bool  $sticky_notices    Used to indicate whether you want to ensure notices are added to a transient
3100
-     *                                 instead of displayed.
3101
-     * @param array $notices_arguments Use this to pass any additional args on to the _process_notices.
3102
-     * @return void
3103
-     * @throws EE_Error
3104
-     */
3105
-    protected function _return_json($sticky_notices = false, $notices_arguments = array())
3106
-    {
3107
-        // make sure any EE_Error notices have been handled.
3108
-        $this->_process_notices($notices_arguments, true, $sticky_notices);
3109
-        $data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
3110
-        unset($this->_template_args['data']);
3111
-        $json = array(
3112
-            'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
3113
-            'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
3114
-            'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
3115
-            'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
3116
-            'notices'   => EE_Error::get_notices(),
3117
-            'content'   => isset($this->_template_args['admin_page_content'])
3118
-                ? $this->_template_args['admin_page_content'] : '',
3119
-            'data'      => array_merge($data, array('template_args' => $this->_template_args)),
3120
-            'isEEajax'  => true
3121
-            // special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
3122
-        );
3123
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
3124
-        if (null === error_get_last() || ! headers_sent()) {
3125
-            header('Content-Type: application/json; charset=UTF-8');
3126
-        }
3127
-        echo wp_json_encode($json);
3128
-        exit();
3129
-    }
3130
-
3131
-
3132
-    /**
3133
-     * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
3134
-     *
3135
-     * @return void
3136
-     * @throws EE_Error
3137
-     */
3138
-    public function return_json()
3139
-    {
3140
-        if (defined('DOING_AJAX') && DOING_AJAX) {
3141
-            $this->_return_json();
3142
-        } else {
3143
-            throw new EE_Error(
3144
-                sprintf(
3145
-                    esc_html__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'),
3146
-                    __FUNCTION__
3147
-                )
3148
-            );
3149
-        }
3150
-    }
3151
-
3152
-
3153
-    /**
3154
-     * This provides a way for child hook classes to send along themselves by reference so methods/properties within
3155
-     * them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
3156
-     *
3157
-     * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
3158
-     */
3159
-    public function set_hook_object(EE_Admin_Hooks $hook_obj)
3160
-    {
3161
-        $this->_hook_obj = $hook_obj;
3162
-    }
3163
-
3164
-
3165
-    /**
3166
-     *        generates  HTML wrapper with Tabbed nav for an admin page
3167
-     *
3168
-     * @param  boolean $about whether to use the special about page wrapper or default.
3169
-     * @return void
3170
-     * @throws DomainException
3171
-     * @throws EE_Error
3172
-     */
3173
-    public function admin_page_wrapper($about = false)
3174
-    {
3175
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3176
-        $this->_nav_tabs = $this->_get_main_nav_tabs();
3177
-        $this->_template_args['nav_tabs'] = $this->_nav_tabs;
3178
-        $this->_template_args['admin_page_title'] = $this->_admin_page_title;
3179
-        $this->_template_args['before_admin_page_content'] = apply_filters(
3180
-            "FHEE_before_admin_page_content{$this->_current_page}{$this->_current_view}",
3181
-            isset($this->_template_args['before_admin_page_content'])
3182
-                ? $this->_template_args['before_admin_page_content']
3183
-                : ''
3184
-        );
3185
-        $this->_template_args['after_admin_page_content'] = apply_filters(
3186
-            "FHEE_after_admin_page_content{$this->_current_page}{$this->_current_view}",
3187
-            isset($this->_template_args['after_admin_page_content'])
3188
-                ? $this->_template_args['after_admin_page_content']
3189
-                : ''
3190
-        );
3191
-        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
3192
-        // load settings page wrapper template
3193
-        $template_path = ! defined('DOING_AJAX')
3194
-            ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php'
3195
-            : EE_ADMIN_TEMPLATE
3196
-              . 'admin_wrapper_ajax.template.php';
3197
-        // about page?
3198
-        $template_path = $about
3199
-            ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
3200
-            : $template_path;
3201
-        if (defined('DOING_AJAX')) {
3202
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template(
3203
-                $template_path,
3204
-                $this->_template_args,
3205
-                true
3206
-            );
3207
-            $this->_return_json();
3208
-        } else {
3209
-            EEH_Template::display_template($template_path, $this->_template_args);
3210
-        }
3211
-    }
3212
-
3213
-
3214
-    /**
3215
-     * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
3216
-     *
3217
-     * @return string html
3218
-     * @throws EE_Error
3219
-     */
3220
-    protected function _get_main_nav_tabs()
3221
-    {
3222
-        // let's generate the html using the EEH_Tabbed_Content helper.
3223
-        // We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute
3224
-        // (rather than setting in the page_routes array)
3225
-        return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
3226
-    }
3227
-
3228
-
3229
-    /**
3230
-     *        sort nav tabs
3231
-     *
3232
-     * @param $a
3233
-     * @param $b
3234
-     * @return int
3235
-     */
3236
-    private function _sort_nav_tabs($a, $b)
3237
-    {
3238
-        if ($a['order'] === $b['order']) {
3239
-            return 0;
3240
-        }
3241
-        return ($a['order'] < $b['order']) ? -1 : 1;
3242
-    }
3243
-
3244
-
3245
-    /**
3246
-     *    generates HTML for the forms used on admin pages
3247
-     *
3248
-     * @param    array $input_vars - array of input field details
3249
-     * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to
3250
-     *                             use)
3251
-     * @param bool     $id
3252
-     * @return string
3253
-     * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
3254
-     * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
3255
-     */
3256
-    protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
3257
-    {
3258
-        $content = $generator === 'string'
3259
-            ? EEH_Form_Fields::get_form_fields($input_vars, $id)
3260
-            : EEH_Form_Fields::get_form_fields_array($input_vars);
3261
-        return $content;
3262
-    }
3263
-
3264
-
3265
-    /**
3266
-     * generates the "Save" and "Save & Close" buttons for edit forms
3267
-     *
3268
-     * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save &
3269
-     *                                   Close" button.
3270
-     * @param array            $text     if included, generator will use the given text for the buttons ( array([0] =>
3271
-     *                                   'Save', [1] => 'save & close')
3272
-     * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e.
3273
-     *                                   via the "name" value in the button).  We can also use this to just dump
3274
-     *                                   default actions by submitting some other value.
3275
-     * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it
3276
-     *                                   will use the $referrer string. IF null, then we don't do ANYTHING on save and
3277
-     *                                   close (normal form handling).
3278
-     */
3279
-    protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
3280
-    {
3281
-        // make sure $text and $actions are in an array
3282
-        $text = (array) $text;
3283
-        $actions = (array) $actions;
3284
-        $referrer_url = empty($referrer)
3285
-            ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
3286
-              . $_SERVER['REQUEST_URI']
3287
-              . '" />'
3288
-            : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
3289
-              . $referrer
3290
-              . '" />';
3291
-        $button_text = ! empty($text)
3292
-            ? $text
3293
-            : array(
3294
-                esc_html__('Save', 'event_espresso'),
3295
-                esc_html__('Save and Close', 'event_espresso'),
3296
-            );
3297
-        $default_names = array('save', 'save_and_close');
3298
-        // add in a hidden index for the current page (so save and close redirects properly)
3299
-        $this->_template_args['save_buttons'] = $referrer_url;
3300
-        foreach ($button_text as $key => $button) {
3301
-            $ref = $default_names[ $key ];
3302
-            $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary '
3303
-                                                     . $ref
3304
-                                                     . '" value="'
3305
-                                                     . $button
3306
-                                                     . '" name="'
3307
-                                                     . (! empty($actions) ? $actions[ $key ] : $ref)
3308
-                                                     . '" id="'
3309
-                                                     . $this->_current_view . '_' . $ref
3310
-                                                     . '" />';
3311
-            if (! $both) {
3312
-                break;
3313
-            }
3314
-        }
3315
-    }
3316
-
3317
-
3318
-    /**
3319
-     * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
3320
-     *
3321
-     * @see   $this->_set_add_edit_form_tags() for details on params
3322
-     * @since 4.6.0
3323
-     * @param string $route
3324
-     * @param array  $additional_hidden_fields
3325
-     */
3326
-    public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
3327
-    {
3328
-        $this->_set_add_edit_form_tags($route, $additional_hidden_fields);
3329
-    }
3330
-
3331
-
3332
-    /**
3333
-     * set form open and close tags on add/edit pages.
3334
-     *
3335
-     * @param string $route                    the route you want the form to direct to
3336
-     * @param array  $additional_hidden_fields any additional hidden fields required in the form header
3337
-     * @return void
3338
-     */
3339
-    protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
3340
-    {
3341
-        if (empty($route)) {
3342
-            $user_msg = esc_html__(
3343
-                'An error occurred. No action was set for this page\'s form.',
3344
-                'event_espresso'
3345
-            );
3346
-            $dev_msg = $user_msg . "\n"
3347
-                       . sprintf(
3348
-                           esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
3349
-                           __FUNCTION__,
3350
-                           __CLASS__
3351
-                       );
3352
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
3353
-        }
3354
-        // open form
3355
-        $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="'
3356
-                                                             . $this->_admin_base_url
3357
-                                                             . '" id="'
3358
-                                                             . $route
3359
-                                                             . '_event_form" >';
3360
-        // add nonce
3361
-        $nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
3362
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
3363
-        // add REQUIRED form action
3364
-        $hidden_fields = array(
3365
-            'action' => array('type' => 'hidden', 'value' => $route),
3366
-        );
3367
-        // merge arrays
3368
-        $hidden_fields = is_array($additional_hidden_fields)
3369
-            ? array_merge($hidden_fields, $additional_hidden_fields)
3370
-            : $hidden_fields;
3371
-        // generate form fields
3372
-        $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
3373
-        // add fields to form
3374
-        foreach ((array) $form_fields as $field_name => $form_field) {
3375
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
3376
-        }
3377
-        // close form
3378
-        $this->_template_args['after_admin_page_content'] = '</form>';
3379
-    }
3380
-
3381
-
3382
-    /**
3383
-     * Public Wrapper for _redirect_after_action() method since its
3384
-     * discovered it would be useful for external code to have access.
3385
-     *
3386
-     * @see   EE_Admin_Page::_redirect_after_action() for params.
3387
-     * @since 4.5.0
3388
-     * @param bool   $success
3389
-     * @param string $what
3390
-     * @param string $action_desc
3391
-     * @param array  $query_args
3392
-     * @param bool   $override_overwrite
3393
-     * @throws EE_Error
3394
-     */
3395
-    public function redirect_after_action(
3396
-        $success = false,
3397
-        $what = 'item',
3398
-        $action_desc = 'processed',
3399
-        $query_args = array(),
3400
-        $override_overwrite = false
3401
-    ) {
3402
-        $this->_redirect_after_action(
3403
-            $success,
3404
-            $what,
3405
-            $action_desc,
3406
-            $query_args,
3407
-            $override_overwrite
3408
-        );
3409
-    }
3410
-
3411
-
3412
-    /**
3413
-     *    _redirect_after_action
3414
-     *
3415
-     * @param int    $success            - whether success was for two or more records, or just one, or none
3416
-     * @param string $what               - what the action was performed on
3417
-     * @param string $action_desc        - what was done ie: updated, deleted, etc
3418
-     * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin
3419
-     *                                   action is completed
3420
-     * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to
3421
-     *                                   override this so that they show.
3422
-     * @return void
3423
-     * @throws EE_Error
3424
-     */
3425
-    protected function _redirect_after_action(
3426
-        $success = 0,
3427
-        $what = 'item',
3428
-        $action_desc = 'processed',
3429
-        $query_args = array(),
3430
-        $override_overwrite = false
3431
-    ) {
3432
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3433
-        // class name for actions/filters.
3434
-        $classname = get_class($this);
3435
-        // set redirect url.
3436
-        // Note if there is a "page" index in the $query_args then we go with vanilla admin.php route,
3437
-        // otherwise we go with whatever is set as the _admin_base_url
3438
-        $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
3439
-        $notices = EE_Error::get_notices(false);
3440
-        // overwrite default success messages //BUT ONLY if overwrite not overridden
3441
-        if (! $override_overwrite || ! empty($notices['errors'])) {
3442
-            EE_Error::overwrite_success();
3443
-        }
3444
-        if (! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
3445
-            // how many records affected ? more than one record ? or just one ?
3446
-            if ($success > 1) {
3447
-                // set plural msg
3448
-                EE_Error::add_success(
3449
-                    sprintf(
3450
-                        esc_html__('The "%s" have been successfully %s.', 'event_espresso'),
3451
-                        $what,
3452
-                        $action_desc
3453
-                    ),
3454
-                    __FILE__,
3455
-                    __FUNCTION__,
3456
-                    __LINE__
3457
-                );
3458
-            } elseif ($success === 1) {
3459
-                // set singular msg
3460
-                EE_Error::add_success(
3461
-                    sprintf(
3462
-                        esc_html__('The "%s" has been successfully %s.', 'event_espresso'),
3463
-                        $what,
3464
-                        $action_desc
3465
-                    ),
3466
-                    __FILE__,
3467
-                    __FUNCTION__,
3468
-                    __LINE__
3469
-                );
3470
-            }
3471
-        }
3472
-        // check that $query_args isn't something crazy
3473
-        if (! is_array($query_args)) {
3474
-            $query_args = array();
3475
-        }
3476
-        /**
3477
-         * Allow injecting actions before the query_args are modified for possible different
3478
-         * redirections on save and close actions
3479
-         *
3480
-         * @since 4.2.0
3481
-         * @param array $query_args       The original query_args array coming into the
3482
-         *                                method.
3483
-         */
3484
-        do_action(
3485
-            "AHEE__{$classname}___redirect_after_action__before_redirect_modification_{$this->_req_action}",
3486
-            $query_args
3487
-        );
3488
-        // calculate where we're going (if we have a "save and close" button pushed)
3489
-        if (isset($this->_req_data['save_and_close'], $this->_req_data['save_and_close_referrer'])) {
3490
-            // even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
3491
-            $parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
3492
-            // regenerate query args array from referrer URL
3493
-            parse_str($parsed_url['query'], $query_args);
3494
-            // correct page and action will be in the query args now
3495
-            $redirect_url = admin_url('admin.php');
3496
-        }
3497
-        // merge any default query_args set in _default_route_query_args property
3498
-        if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
3499
-            $args_to_merge = array();
3500
-            foreach ($this->_default_route_query_args as $query_param => $query_value) {
3501
-                // is there a wp_referer array in our _default_route_query_args property?
3502
-                if ($query_param === 'wp_referer') {
3503
-                    $query_value = (array) $query_value;
3504
-                    foreach ($query_value as $reference => $value) {
3505
-                        if (strpos($reference, 'nonce') !== false) {
3506
-                            continue;
3507
-                        }
3508
-                        // finally we will override any arguments in the referer with
3509
-                        // what might be set on the _default_route_query_args array.
3510
-                        if (isset($this->_default_route_query_args[ $reference ])) {
3511
-                            $args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
3512
-                        } else {
3513
-                            $args_to_merge[ $reference ] = urlencode($value);
3514
-                        }
3515
-                    }
3516
-                    continue;
3517
-                }
3518
-                $args_to_merge[ $query_param ] = $query_value;
3519
-            }
3520
-            // now let's merge these arguments but override with what was specifically sent in to the
3521
-            // redirect.
3522
-            $query_args = array_merge($args_to_merge, $query_args);
3523
-        }
3524
-        $this->_process_notices($query_args);
3525
-        // generate redirect url
3526
-        // if redirecting to anything other than the main page, add a nonce
3527
-        if (isset($query_args['action'])) {
3528
-            // manually generate wp_nonce and merge that with the query vars
3529
-            // becuz the wp_nonce_url function wrecks havoc on some vars
3530
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
3531
-        }
3532
-        // we're adding some hooks and filters in here for processing any things just before redirects
3533
-        // (example: an admin page has done an insert or update and we want to run something after that).
3534
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
3535
-        $redirect_url = apply_filters(
3536
-            'FHEE_redirect_' . $classname . $this->_req_action,
3537
-            self::add_query_args_and_nonce($query_args, $redirect_url),
3538
-            $query_args
3539
-        );
3540
-        // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
3541
-        if (defined('DOING_AJAX')) {
3542
-            $default_data = array(
3543
-                'close'        => true,
3544
-                'redirect_url' => $redirect_url,
3545
-                'where'        => 'main',
3546
-                'what'         => 'append',
3547
-            );
3548
-            $this->_template_args['success'] = $success;
3549
-            $this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge(
3550
-                $default_data,
3551
-                $this->_template_args['data']
3552
-            ) : $default_data;
3553
-            $this->_return_json();
3554
-        }
3555
-        wp_safe_redirect($redirect_url);
3556
-        exit();
3557
-    }
3558
-
3559
-
3560
-    /**
3561
-     * process any notices before redirecting (or returning ajax request)
3562
-     * This method sets the $this->_template_args['notices'] attribute;
3563
-     *
3564
-     * @param  array $query_args        any query args that need to be used for notice transient ('action')
3565
-     * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and
3566
-     *                                  page_routes haven't been defined yet.
3567
-     * @param bool   $sticky_notices    This is used to flag that regardless of whether this is doing_ajax or not, we
3568
-     *                                  still save a transient for the notice.
3569
-     * @return void
3570
-     * @throws EE_Error
3571
-     */
3572
-    protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
3573
-    {
3574
-        // first let's set individual error properties if doing_ajax and the properties aren't already set.
3575
-        if (defined('DOING_AJAX') && DOING_AJAX) {
3576
-            $notices = EE_Error::get_notices(false);
3577
-            if (empty($this->_template_args['success'])) {
3578
-                $this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
3579
-            }
3580
-            if (empty($this->_template_args['errors'])) {
3581
-                $this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
3582
-            }
3583
-            if (empty($this->_template_args['attention'])) {
3584
-                $this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
3585
-            }
3586
-        }
3587
-        $this->_template_args['notices'] = EE_Error::get_notices();
3588
-        // IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
3589
-        if (! defined('DOING_AJAX') || $sticky_notices) {
3590
-            $route = isset($query_args['action']) ? $query_args['action'] : 'default';
3591
-            $this->_add_transient(
3592
-                $route,
3593
-                $this->_template_args['notices'],
3594
-                true,
3595
-                $skip_route_verify
3596
-            );
3597
-        }
3598
-    }
3599
-
3600
-
3601
-    /**
3602
-     * get_action_link_or_button
3603
-     * returns the button html for adding, editing, or deleting an item (depending on given type)
3604
-     *
3605
-     * @param string $action        use this to indicate which action the url is generated with.
3606
-     * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key)
3607
-     *                              property.
3608
-     * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
3609
-     * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
3610
-     * @param string $base_url      If this is not provided
3611
-     *                              the _admin_base_url will be used as the default for the button base_url.
3612
-     *                              Otherwise this value will be used.
3613
-     * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
3614
-     * @return string
3615
-     * @throws InvalidArgumentException
3616
-     * @throws InvalidInterfaceException
3617
-     * @throws InvalidDataTypeException
3618
-     * @throws EE_Error
3619
-     */
3620
-    public function get_action_link_or_button(
3621
-        $action,
3622
-        $type = 'add',
3623
-        $extra_request = array(),
3624
-        $class = 'button-primary',
3625
-        $base_url = '',
3626
-        $exclude_nonce = false
3627
-    ) {
3628
-        // first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
3629
-        if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
3630
-            throw new EE_Error(
3631
-                sprintf(
3632
-                    esc_html__(
3633
-                        'There is no page route for given action for the button.  This action was given: %s',
3634
-                        'event_espresso'
3635
-                    ),
3636
-                    $action
3637
-                )
3638
-            );
3639
-        }
3640
-        if (! isset($this->_labels['buttons'][ $type ])) {
3641
-            throw new EE_Error(
3642
-                sprintf(
3643
-                    __(
3644
-                        'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
3645
-                        'event_espresso'
3646
-                    ),
3647
-                    $type
3648
-                )
3649
-            );
3650
-        }
3651
-        // finally check user access for this button.
3652
-        $has_access = $this->check_user_access($action, true);
3653
-        if (! $has_access) {
3654
-            return '';
3655
-        }
3656
-        $_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
3657
-        $query_args = array(
3658
-            'action' => $action,
3659
-        );
3660
-        // merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
3661
-        if (! empty($extra_request)) {
3662
-            $query_args = array_merge($extra_request, $query_args);
3663
-        }
3664
-        $url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
3665
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
3666
-    }
3667
-
3668
-
3669
-    /**
3670
-     * _per_page_screen_option
3671
-     * Utility function for adding in a per_page_option in the screen_options_dropdown.
3672
-     *
3673
-     * @return void
3674
-     * @throws InvalidArgumentException
3675
-     * @throws InvalidInterfaceException
3676
-     * @throws InvalidDataTypeException
3677
-     */
3678
-    protected function _per_page_screen_option()
3679
-    {
3680
-        $option = 'per_page';
3681
-        $args = array(
3682
-            'label'   => apply_filters(
3683
-                'FHEE__EE_Admin_Page___per_page_screen_options___label',
3684
-                $this->_admin_page_title,
3685
-                $this
3686
-            ),
3687
-            'default' => (int) apply_filters(
3688
-                'FHEE__EE_Admin_Page___per_page_screen_options__default',
3689
-                20
3690
-            ),
3691
-            'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
3692
-        );
3693
-        // ONLY add the screen option if the user has access to it.
3694
-        if ($this->check_user_access($this->_current_view, true)) {
3695
-            add_screen_option($option, $args);
3696
-        }
3697
-    }
3698
-
3699
-
3700
-    /**
3701
-     * set_per_page_screen_option
3702
-     * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
3703
-     * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than
3704
-     * admin_menu.
3705
-     *
3706
-     * @return void
3707
-     */
3708
-    private function _set_per_page_screen_options()
3709
-    {
3710
-        if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
3711
-            check_admin_referer('screen-options-nonce', 'screenoptionnonce');
3712
-            if (! $user = wp_get_current_user()) {
3713
-                return;
3714
-            }
3715
-            $option = $_POST['wp_screen_options']['option'];
3716
-            $value = $_POST['wp_screen_options']['value'];
3717
-            if ($option != sanitize_key($option)) {
3718
-                return;
3719
-            }
3720
-            $map_option = $option;
3721
-            $option = str_replace('-', '_', $option);
3722
-            switch ($map_option) {
3723
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
3724
-                    $value = (int) $value;
3725
-                    $max_value = apply_filters(
3726
-                        'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
3727
-                        999,
3728
-                        $this->_current_page,
3729
-                        $this->_current_view
3730
-                    );
3731
-                    if ($value < 1) {
3732
-                        return;
3733
-                    }
3734
-                    $value = min($value, $max_value);
3735
-                    break;
3736
-                default:
3737
-                    $value = apply_filters(
3738
-                        'FHEE__EE_Admin_Page___set_per_page_screen_options__value',
3739
-                        false,
3740
-                        $option,
3741
-                        $value
3742
-                    );
3743
-                    if (false === $value) {
3744
-                        return;
3745
-                    }
3746
-                    break;
3747
-            }
3748
-            update_user_meta($user->ID, $option, $value);
3749
-            wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
3750
-            exit;
3751
-        }
3752
-    }
3753
-
3754
-
3755
-    /**
3756
-     * This just allows for setting the $_template_args property if it needs to be set outside the object
3757
-     *
3758
-     * @param array $data array that will be assigned to template args.
3759
-     */
3760
-    public function set_template_args($data)
3761
-    {
3762
-        $this->_template_args = array_merge($this->_template_args, (array) $data);
3763
-    }
3764
-
3765
-
3766
-    /**
3767
-     * This makes available the WP transient system for temporarily moving data between routes
3768
-     *
3769
-     * @param string $route             the route that should receive the transient
3770
-     * @param array  $data              the data that gets sent
3771
-     * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a
3772
-     *                                  normal route transient.
3773
-     * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used
3774
-     *                                  when we are adding a transient before page_routes have been defined.
3775
-     * @return void
3776
-     * @throws EE_Error
3777
-     */
3778
-    protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
3779
-    {
3780
-        $user_id = get_current_user_id();
3781
-        if (! $skip_route_verify) {
3782
-            $this->_verify_route($route);
3783
-        }
3784
-        // now let's set the string for what kind of transient we're setting
3785
-        $transient = $notices
3786
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
3787
-            : 'rte_tx_' . $route . '_' . $user_id;
3788
-        $data = $notices ? array('notices' => $data) : $data;
3789
-        // is there already a transient for this route?  If there is then let's ADD to that transient
3790
-        $existing = is_multisite() && is_network_admin()
3791
-            ? get_site_transient($transient)
3792
-            : get_transient($transient);
3793
-        if ($existing) {
3794
-            $data = array_merge((array) $data, (array) $existing);
3795
-        }
3796
-        if (is_multisite() && is_network_admin()) {
3797
-            set_site_transient($transient, $data, 8);
3798
-        } else {
3799
-            set_transient($transient, $data, 8);
3800
-        }
3801
-    }
3802
-
3803
-
3804
-    /**
3805
-     * this retrieves the temporary transient that has been set for moving data between routes.
3806
-     *
3807
-     * @param bool   $notices true we get notices transient. False we just return normal route transient
3808
-     * @param string $route
3809
-     * @return mixed data
3810
-     */
3811
-    protected function _get_transient($notices = false, $route = '')
3812
-    {
3813
-        $user_id = get_current_user_id();
3814
-        $route = ! $route ? $this->_req_action : $route;
3815
-        $transient = $notices
3816
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
3817
-            : 'rte_tx_' . $route . '_' . $user_id;
3818
-        $data = is_multisite() && is_network_admin()
3819
-            ? get_site_transient($transient)
3820
-            : get_transient($transient);
3821
-        // delete transient after retrieval (just in case it hasn't expired);
3822
-        if (is_multisite() && is_network_admin()) {
3823
-            delete_site_transient($transient);
3824
-        } else {
3825
-            delete_transient($transient);
3826
-        }
3827
-        return $notices && isset($data['notices']) ? $data['notices'] : $data;
3828
-    }
3829
-
3830
-
3831
-    /**
3832
-     * The purpose of this method is just to run garbage collection on any EE transients that might have expired but
3833
-     * would not be called later. This will be assigned to run on a specific EE Admin page. (place the method in the
3834
-     * default route callback on the EE_Admin page you want it run.)
3835
-     *
3836
-     * @return void
3837
-     */
3838
-    protected function _transient_garbage_collection()
3839
-    {
3840
-        global $wpdb;
3841
-        // retrieve all existing transients
3842
-        $query = "SELECT option_name FROM {$wpdb->options} WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
3843
-        if ($results = $wpdb->get_results($query)) {
3844
-            foreach ($results as $result) {
3845
-                $transient = str_replace('_transient_', '', $result->option_name);
3846
-                get_transient($transient);
3847
-                if (is_multisite() && is_network_admin()) {
3848
-                    get_site_transient($transient);
3849
-                }
3850
-            }
3851
-        }
3852
-    }
3853
-
3854
-
3855
-    /**
3856
-     * get_view
3857
-     *
3858
-     * @return string content of _view property
3859
-     */
3860
-    public function get_view()
3861
-    {
3862
-        return $this->_view;
3863
-    }
3864
-
3865
-
3866
-    /**
3867
-     * getter for the protected $_views property
3868
-     *
3869
-     * @return array
3870
-     */
3871
-    public function get_views()
3872
-    {
3873
-        return $this->_views;
3874
-    }
3875
-
3876
-
3877
-    /**
3878
-     * get_current_page
3879
-     *
3880
-     * @return string _current_page property value
3881
-     */
3882
-    public function get_current_page()
3883
-    {
3884
-        return $this->_current_page;
3885
-    }
3886
-
3887
-
3888
-    /**
3889
-     * get_current_view
3890
-     *
3891
-     * @return string _current_view property value
3892
-     */
3893
-    public function get_current_view()
3894
-    {
3895
-        return $this->_current_view;
3896
-    }
3897
-
3898
-
3899
-    /**
3900
-     * get_current_screen
3901
-     *
3902
-     * @return object The current WP_Screen object
3903
-     */
3904
-    public function get_current_screen()
3905
-    {
3906
-        return $this->_current_screen;
3907
-    }
3908
-
3909
-
3910
-    /**
3911
-     * get_current_page_view_url
3912
-     *
3913
-     * @return string This returns the url for the current_page_view.
3914
-     */
3915
-    public function get_current_page_view_url()
3916
-    {
3917
-        return $this->_current_page_view_url;
3918
-    }
3919
-
3920
-
3921
-    /**
3922
-     * just returns the _req_data property
3923
-     *
3924
-     * @return array
3925
-     */
3926
-    public function get_request_data()
3927
-    {
3928
-        return $this->_req_data;
3929
-    }
3930
-
3931
-
3932
-    /**
3933
-     * returns the _req_data protected property
3934
-     *
3935
-     * @return string
3936
-     */
3937
-    public function get_req_action()
3938
-    {
3939
-        return $this->_req_action;
3940
-    }
3941
-
3942
-
3943
-    /**
3944
-     * @return bool  value of $_is_caf property
3945
-     */
3946
-    public function is_caf()
3947
-    {
3948
-        return $this->_is_caf;
3949
-    }
3950
-
3951
-
3952
-    /**
3953
-     * @return mixed
3954
-     */
3955
-    public function default_espresso_metaboxes()
3956
-    {
3957
-        return $this->_default_espresso_metaboxes;
3958
-    }
3959
-
3960
-
3961
-    /**
3962
-     * @return mixed
3963
-     */
3964
-    public function admin_base_url()
3965
-    {
3966
-        return $this->_admin_base_url;
3967
-    }
3968
-
3969
-
3970
-    /**
3971
-     * @return mixed
3972
-     */
3973
-    public function wp_page_slug()
3974
-    {
3975
-        return $this->_wp_page_slug;
3976
-    }
3977
-
3978
-
3979
-    /**
3980
-     * updates  espresso configuration settings
3981
-     *
3982
-     * @param string                   $tab
3983
-     * @param EE_Config_Base|EE_Config $config
3984
-     * @param string                   $file file where error occurred
3985
-     * @param string                   $func function  where error occurred
3986
-     * @param string                   $line line no where error occurred
3987
-     * @return boolean
3988
-     */
3989
-    protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
3990
-    {
3991
-        // remove any options that are NOT going to be saved with the config settings.
3992
-        if (isset($config->core->ee_ueip_optin)) {
3993
-            // TODO: remove the following two lines and make sure values are migrated from 3.1
3994
-            update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
3995
-            update_option('ee_ueip_has_notified', true);
3996
-        }
3997
-        // and save it (note we're also doing the network save here)
3998
-        $net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
3999
-        $config_saved = EE_Config::instance()->update_espresso_config(false, false);
4000
-        if ($config_saved && $net_saved) {
4001
-            EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
4002
-            return true;
4003
-        }
4004
-        EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
4005
-        return false;
4006
-    }
4007
-
4008
-
4009
-    /**
4010
-     * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
4011
-     *
4012
-     * @return array
4013
-     */
4014
-    public function get_yes_no_values()
4015
-    {
4016
-        return $this->_yes_no_values;
4017
-    }
4018
-
4019
-
4020
-    protected function _get_dir()
4021
-    {
4022
-        $reflector = new ReflectionClass(get_class($this));
4023
-        return dirname($reflector->getFileName());
4024
-    }
4025
-
4026
-
4027
-    /**
4028
-     * A helper for getting a "next link".
4029
-     *
4030
-     * @param string $url   The url to link to
4031
-     * @param string $class The class to use.
4032
-     * @return string
4033
-     */
4034
-    protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
4035
-    {
4036
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
4037
-    }
4038
-
4039
-
4040
-    /**
4041
-     * A helper for getting a "previous link".
4042
-     *
4043
-     * @param string $url   The url to link to
4044
-     * @param string $class The class to use.
4045
-     * @return string
4046
-     */
4047
-    protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
4048
-    {
4049
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
4050
-    }
4051
-
4052
-
4053
-
4054
-
4055
-
4056
-
4057
-
4058
-    // below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
4059
-
4060
-
4061
-    /**
4062
-     * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller
4063
-     * 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
4064
-     * _req_data array.
4065
-     *
4066
-     * @return bool success/fail
4067
-     * @throws EE_Error
4068
-     * @throws InvalidArgumentException
4069
-     * @throws ReflectionException
4070
-     * @throws InvalidDataTypeException
4071
-     * @throws InvalidInterfaceException
4072
-     */
4073
-    protected function _process_resend_registration()
4074
-    {
4075
-        $this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
4076
-        do_action(
4077
-            'AHEE__EE_Admin_Page___process_resend_registration',
4078
-            $this->_template_args['success'],
4079
-            $this->_req_data
4080
-        );
4081
-        return $this->_template_args['success'];
4082
-    }
4083
-
4084
-
4085
-    /**
4086
-     * This automatically processes any payment message notifications when manual payment has been applied.
4087
-     *
4088
-     * @param \EE_Payment $payment
4089
-     * @return bool success/fail
4090
-     */
4091
-    protected function _process_payment_notification(EE_Payment $payment)
4092
-    {
4093
-        add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
4094
-        do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
4095
-        $this->_template_args['success'] = apply_filters(
4096
-            'FHEE__EE_Admin_Page___process_admin_payment_notification__success',
4097
-            false,
4098
-            $payment
4099
-        );
4100
-        return $this->_template_args['success'];
4101
-    }
2703
+	}
2704
+
2705
+
2706
+	/**
2707
+	 * facade for add_meta_box
2708
+	 *
2709
+	 * @param string  $action        where the metabox get's displayed
2710
+	 * @param string  $title         Title of Metabox (output in metabox header)
2711
+	 * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback
2712
+	 *                               instead of the one created in here.
2713
+	 * @param array   $callback_args an array of args supplied for the metabox
2714
+	 * @param string  $column        what metabox column
2715
+	 * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
2716
+	 * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function
2717
+	 *                               created but just set our own callback for wp's add_meta_box.
2718
+	 * @throws \DomainException
2719
+	 */
2720
+	public function _add_admin_page_meta_box(
2721
+		$action,
2722
+		$title,
2723
+		$callback,
2724
+		$callback_args,
2725
+		$column = 'normal',
2726
+		$priority = 'high',
2727
+		$create_func = true
2728
+	) {
2729
+		do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
2730
+		// 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.
2731
+		if (empty($callback_args) && $create_func) {
2732
+			$callback_args = array(
2733
+				'template_path' => $this->_template_path,
2734
+				'template_args' => $this->_template_args,
2735
+			);
2736
+		}
2737
+		// 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)
2738
+		$call_back_func = $create_func
2739
+			? function ($post, $metabox) {
2740
+				do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2741
+				echo EEH_Template::display_template(
2742
+					$metabox['args']['template_path'],
2743
+					$metabox['args']['template_args'],
2744
+					true
2745
+				);
2746
+			}
2747
+			: $callback;
2748
+		add_meta_box(
2749
+			str_replace('_', '-', $action) . '-mbox',
2750
+			$title,
2751
+			$call_back_func,
2752
+			$this->_wp_page_slug,
2753
+			$column,
2754
+			$priority,
2755
+			$callback_args
2756
+		);
2757
+	}
2758
+
2759
+
2760
+	/**
2761
+	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
2762
+	 *
2763
+	 * @throws DomainException
2764
+	 * @throws EE_Error
2765
+	 */
2766
+	public function display_admin_page_with_metabox_columns()
2767
+	{
2768
+		$this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
2769
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
2770
+			$this->_column_template_path,
2771
+			$this->_template_args,
2772
+			true
2773
+		);
2774
+		// the final wrapper
2775
+		$this->admin_page_wrapper();
2776
+	}
2777
+
2778
+
2779
+	/**
2780
+	 * generates  HTML wrapper for an admin details page
2781
+	 *
2782
+	 * @return void
2783
+	 * @throws EE_Error
2784
+	 * @throws DomainException
2785
+	 */
2786
+	public function display_admin_page_with_sidebar()
2787
+	{
2788
+		$this->_display_admin_page(true);
2789
+	}
2790
+
2791
+
2792
+	/**
2793
+	 * generates  HTML wrapper for an admin details page (except no sidebar)
2794
+	 *
2795
+	 * @return void
2796
+	 * @throws EE_Error
2797
+	 * @throws DomainException
2798
+	 */
2799
+	public function display_admin_page_with_no_sidebar()
2800
+	{
2801
+		$this->_display_admin_page();
2802
+	}
2803
+
2804
+
2805
+	/**
2806
+	 * generates HTML wrapper for an EE about admin page (no sidebar)
2807
+	 *
2808
+	 * @return void
2809
+	 * @throws EE_Error
2810
+	 * @throws DomainException
2811
+	 */
2812
+	public function display_about_admin_page()
2813
+	{
2814
+		$this->_display_admin_page(false, true);
2815
+	}
2816
+
2817
+
2818
+	/**
2819
+	 * display_admin_page
2820
+	 * contains the code for actually displaying an admin page
2821
+	 *
2822
+	 * @param  boolean $sidebar true with sidebar, false without
2823
+	 * @param  boolean $about   use the about admin wrapper instead of the default.
2824
+	 * @return void
2825
+	 * @throws DomainException
2826
+	 * @throws EE_Error
2827
+	 */
2828
+	private function _display_admin_page($sidebar = false, $about = false)
2829
+	{
2830
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2831
+		// custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
2832
+		do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
2833
+		// set current wp page slug - looks like: event-espresso_page_event_categories
2834
+		// keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
2835
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
2836
+		$this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
2837
+			? 'poststuff'
2838
+			: 'espresso-default-admin';
2839
+		$template_path = $sidebar
2840
+			? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
2841
+			: EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
2842
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2843
+			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
2844
+		}
2845
+		$template_path = ! empty($this->_column_template_path)
2846
+			? $this->_column_template_path : $template_path;
2847
+		$this->_template_args['post_body_content'] = isset($this->_template_args['admin_page_content'])
2848
+			? $this->_template_args['admin_page_content']
2849
+			: '';
2850
+		$this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content'])
2851
+			? $this->_template_args['before_admin_page_content']
2852
+			: '';
2853
+		$this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content'])
2854
+			? $this->_template_args['after_admin_page_content']
2855
+			: '';
2856
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
2857
+			$template_path,
2858
+			$this->_template_args,
2859
+			true
2860
+		);
2861
+		// the final template wrapper
2862
+		$this->admin_page_wrapper($about);
2863
+	}
2864
+
2865
+
2866
+	/**
2867
+	 * This is used to display caf preview pages.
2868
+	 *
2869
+	 * @since 4.3.2
2870
+	 * @param string $utm_campaign_source what is the key used for google analytics link
2871
+	 * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE
2872
+	 *                                    = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
2873
+	 * @return void
2874
+	 * @throws DomainException
2875
+	 * @throws EE_Error
2876
+	 * @throws InvalidArgumentException
2877
+	 * @throws InvalidDataTypeException
2878
+	 * @throws InvalidInterfaceException
2879
+	 */
2880
+	public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
2881
+	{
2882
+		// let's generate a default preview action button if there isn't one already present.
2883
+		$this->_labels['buttons']['buy_now'] = esc_html__(
2884
+			'Upgrade to Event Espresso 4 Right Now',
2885
+			'event_espresso'
2886
+		);
2887
+		$buy_now_url = add_query_arg(
2888
+			array(
2889
+				'ee_ver'       => 'ee4',
2890
+				'utm_source'   => 'ee4_plugin_admin',
2891
+				'utm_medium'   => 'link',
2892
+				'utm_campaign' => $utm_campaign_source,
2893
+				'utm_content'  => 'buy_now_button',
2894
+			),
2895
+			'http://eventespresso.com/pricing/'
2896
+		);
2897
+		$this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
2898
+			? $this->get_action_link_or_button(
2899
+				'',
2900
+				'buy_now',
2901
+				array(),
2902
+				'button-primary button-large',
2903
+				$buy_now_url,
2904
+				true
2905
+			)
2906
+			: $this->_template_args['preview_action_button'];
2907
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
2908
+			EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
2909
+			$this->_template_args,
2910
+			true
2911
+		);
2912
+		$this->_display_admin_page($display_sidebar);
2913
+	}
2914
+
2915
+
2916
+	/**
2917
+	 * display_admin_list_table_page_with_sidebar
2918
+	 * generates HTML wrapper for an admin_page with list_table
2919
+	 *
2920
+	 * @return void
2921
+	 * @throws EE_Error
2922
+	 * @throws DomainException
2923
+	 */
2924
+	public function display_admin_list_table_page_with_sidebar()
2925
+	{
2926
+		$this->_display_admin_list_table_page(true);
2927
+	}
2928
+
2929
+
2930
+	/**
2931
+	 * display_admin_list_table_page_with_no_sidebar
2932
+	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
2933
+	 *
2934
+	 * @return void
2935
+	 * @throws EE_Error
2936
+	 * @throws DomainException
2937
+	 */
2938
+	public function display_admin_list_table_page_with_no_sidebar()
2939
+	{
2940
+		$this->_display_admin_list_table_page();
2941
+	}
2942
+
2943
+
2944
+	/**
2945
+	 * generates html wrapper for an admin_list_table page
2946
+	 *
2947
+	 * @param boolean $sidebar whether to display with sidebar or not.
2948
+	 * @return void
2949
+	 * @throws DomainException
2950
+	 * @throws EE_Error
2951
+	 */
2952
+	private function _display_admin_list_table_page($sidebar = false)
2953
+	{
2954
+		// setup search attributes
2955
+		$this->_set_search_attributes();
2956
+		$this->_template_args['current_page'] = $this->_wp_page_slug;
2957
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
2958
+		$this->_template_args['table_url'] = defined('DOING_AJAX')
2959
+			? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
2960
+			: add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
2961
+		$this->_template_args['list_table'] = $this->_list_table_object;
2962
+		$this->_template_args['current_route'] = $this->_req_action;
2963
+		$this->_template_args['list_table_class'] = get_class($this->_list_table_object);
2964
+		$ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
2965
+		if (! empty($ajax_sorting_callback)) {
2966
+			$sortable_list_table_form_fields = wp_nonce_field(
2967
+				$ajax_sorting_callback . '_nonce',
2968
+				$ajax_sorting_callback . '_nonce',
2969
+				false,
2970
+				false
2971
+			);
2972
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="'
2973
+												. $this->page_slug
2974
+												. '" />';
2975
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="'
2976
+												. $ajax_sorting_callback
2977
+												. '" />';
2978
+		} else {
2979
+			$sortable_list_table_form_fields = '';
2980
+		}
2981
+		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
2982
+		$hidden_form_fields = isset($this->_template_args['list_table_hidden_fields'])
2983
+			? $this->_template_args['list_table_hidden_fields']
2984
+			: '';
2985
+		$nonce_ref = $this->_req_action . '_nonce';
2986
+		$hidden_form_fields .= '<input type="hidden" name="'
2987
+							   . $nonce_ref
2988
+							   . '" value="'
2989
+							   . wp_create_nonce($nonce_ref)
2990
+							   . '">';
2991
+		$this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
2992
+		// display message about search results?
2993
+		$this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
2994
+			? '<p class="ee-search-results">' . sprintf(
2995
+				esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
2996
+				trim($this->_req_data['s'], '%')
2997
+			) . '</p>'
2998
+			: '';
2999
+		// filter before_list_table template arg
3000
+		$this->_template_args['before_list_table'] = apply_filters(
3001
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
3002
+			$this->_template_args['before_list_table'],
3003
+			$this->page_slug,
3004
+			$this->_req_data,
3005
+			$this->_req_action
3006
+		);
3007
+		// convert to array and filter again
3008
+		// arrays are easier to inject new items in a specific location,
3009
+		// but would not be backwards compatible, so we have to add a new filter
3010
+		$this->_template_args['before_list_table'] = implode(
3011
+			" \n",
3012
+			(array) apply_filters(
3013
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
3014
+				(array) $this->_template_args['before_list_table'],
3015
+				$this->page_slug,
3016
+				$this->_req_data,
3017
+				$this->_req_action
3018
+			)
3019
+		);
3020
+		// filter after_list_table template arg
3021
+		$this->_template_args['after_list_table'] = apply_filters(
3022
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
3023
+			$this->_template_args['after_list_table'],
3024
+			$this->page_slug,
3025
+			$this->_req_data,
3026
+			$this->_req_action
3027
+		);
3028
+		// convert to array and filter again
3029
+		// arrays are easier to inject new items in a specific location,
3030
+		// but would not be backwards compatible, so we have to add a new filter
3031
+		$this->_template_args['after_list_table'] = implode(
3032
+			" \n",
3033
+			(array) apply_filters(
3034
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
3035
+				(array) $this->_template_args['after_list_table'],
3036
+				$this->page_slug,
3037
+				$this->_req_data,
3038
+				$this->_req_action
3039
+			)
3040
+		);
3041
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
3042
+			$template_path,
3043
+			$this->_template_args,
3044
+			true
3045
+		);
3046
+		// the final template wrapper
3047
+		if ($sidebar) {
3048
+			$this->display_admin_page_with_sidebar();
3049
+		} else {
3050
+			$this->display_admin_page_with_no_sidebar();
3051
+		}
3052
+	}
3053
+
3054
+
3055
+	/**
3056
+	 * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the
3057
+	 * html string for the legend.
3058
+	 * $items are expected in an array in the following format:
3059
+	 * $legend_items = array(
3060
+	 *        'item_id' => array(
3061
+	 *            'icon' => 'http://url_to_icon_being_described.png',
3062
+	 *            'desc' => esc_html__('localized description of item');
3063
+	 *        )
3064
+	 * );
3065
+	 *
3066
+	 * @param  array $items see above for format of array
3067
+	 * @return string html string of legend
3068
+	 * @throws DomainException
3069
+	 */
3070
+	protected function _display_legend($items)
3071
+	{
3072
+		$this->_template_args['items'] = apply_filters(
3073
+			'FHEE__EE_Admin_Page___display_legend__items',
3074
+			(array) $items,
3075
+			$this
3076
+		);
3077
+		return EEH_Template::display_template(
3078
+			EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
3079
+			$this->_template_args,
3080
+			true
3081
+		);
3082
+	}
3083
+
3084
+
3085
+	/**
3086
+	 * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
3087
+	 * The returned json object is created from an array in the following format:
3088
+	 * array(
3089
+	 *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
3090
+	 *  'success' => FALSE, //(default FALSE) - contains any special success message.
3091
+	 *  'notices' => '', // - contains any EE_Error formatted notices
3092
+	 *  'content' => 'string can be html', //this is a string of formatted content (can be html)
3093
+	 *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
3094
+	 *  We're also going to include the template args with every package (so js can pick out any specific template args
3095
+	 *  that might be included in here)
3096
+	 * )
3097
+	 * The json object is populated by whatever is set in the $_template_args property.
3098
+	 *
3099
+	 * @param bool  $sticky_notices    Used to indicate whether you want to ensure notices are added to a transient
3100
+	 *                                 instead of displayed.
3101
+	 * @param array $notices_arguments Use this to pass any additional args on to the _process_notices.
3102
+	 * @return void
3103
+	 * @throws EE_Error
3104
+	 */
3105
+	protected function _return_json($sticky_notices = false, $notices_arguments = array())
3106
+	{
3107
+		// make sure any EE_Error notices have been handled.
3108
+		$this->_process_notices($notices_arguments, true, $sticky_notices);
3109
+		$data = isset($this->_template_args['data']) ? $this->_template_args['data'] : array();
3110
+		unset($this->_template_args['data']);
3111
+		$json = array(
3112
+			'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
3113
+			'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
3114
+			'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
3115
+			'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
3116
+			'notices'   => EE_Error::get_notices(),
3117
+			'content'   => isset($this->_template_args['admin_page_content'])
3118
+				? $this->_template_args['admin_page_content'] : '',
3119
+			'data'      => array_merge($data, array('template_args' => $this->_template_args)),
3120
+			'isEEajax'  => true
3121
+			// special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
3122
+		);
3123
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
3124
+		if (null === error_get_last() || ! headers_sent()) {
3125
+			header('Content-Type: application/json; charset=UTF-8');
3126
+		}
3127
+		echo wp_json_encode($json);
3128
+		exit();
3129
+	}
3130
+
3131
+
3132
+	/**
3133
+	 * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
3134
+	 *
3135
+	 * @return void
3136
+	 * @throws EE_Error
3137
+	 */
3138
+	public function return_json()
3139
+	{
3140
+		if (defined('DOING_AJAX') && DOING_AJAX) {
3141
+			$this->_return_json();
3142
+		} else {
3143
+			throw new EE_Error(
3144
+				sprintf(
3145
+					esc_html__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'),
3146
+					__FUNCTION__
3147
+				)
3148
+			);
3149
+		}
3150
+	}
3151
+
3152
+
3153
+	/**
3154
+	 * This provides a way for child hook classes to send along themselves by reference so methods/properties within
3155
+	 * them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
3156
+	 *
3157
+	 * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
3158
+	 */
3159
+	public function set_hook_object(EE_Admin_Hooks $hook_obj)
3160
+	{
3161
+		$this->_hook_obj = $hook_obj;
3162
+	}
3163
+
3164
+
3165
+	/**
3166
+	 *        generates  HTML wrapper with Tabbed nav for an admin page
3167
+	 *
3168
+	 * @param  boolean $about whether to use the special about page wrapper or default.
3169
+	 * @return void
3170
+	 * @throws DomainException
3171
+	 * @throws EE_Error
3172
+	 */
3173
+	public function admin_page_wrapper($about = false)
3174
+	{
3175
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3176
+		$this->_nav_tabs = $this->_get_main_nav_tabs();
3177
+		$this->_template_args['nav_tabs'] = $this->_nav_tabs;
3178
+		$this->_template_args['admin_page_title'] = $this->_admin_page_title;
3179
+		$this->_template_args['before_admin_page_content'] = apply_filters(
3180
+			"FHEE_before_admin_page_content{$this->_current_page}{$this->_current_view}",
3181
+			isset($this->_template_args['before_admin_page_content'])
3182
+				? $this->_template_args['before_admin_page_content']
3183
+				: ''
3184
+		);
3185
+		$this->_template_args['after_admin_page_content'] = apply_filters(
3186
+			"FHEE_after_admin_page_content{$this->_current_page}{$this->_current_view}",
3187
+			isset($this->_template_args['after_admin_page_content'])
3188
+				? $this->_template_args['after_admin_page_content']
3189
+				: ''
3190
+		);
3191
+		$this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
3192
+		// load settings page wrapper template
3193
+		$template_path = ! defined('DOING_AJAX')
3194
+			? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php'
3195
+			: EE_ADMIN_TEMPLATE
3196
+			  . 'admin_wrapper_ajax.template.php';
3197
+		// about page?
3198
+		$template_path = $about
3199
+			? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
3200
+			: $template_path;
3201
+		if (defined('DOING_AJAX')) {
3202
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template(
3203
+				$template_path,
3204
+				$this->_template_args,
3205
+				true
3206
+			);
3207
+			$this->_return_json();
3208
+		} else {
3209
+			EEH_Template::display_template($template_path, $this->_template_args);
3210
+		}
3211
+	}
3212
+
3213
+
3214
+	/**
3215
+	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
3216
+	 *
3217
+	 * @return string html
3218
+	 * @throws EE_Error
3219
+	 */
3220
+	protected function _get_main_nav_tabs()
3221
+	{
3222
+		// let's generate the html using the EEH_Tabbed_Content helper.
3223
+		// We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute
3224
+		// (rather than setting in the page_routes array)
3225
+		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
3226
+	}
3227
+
3228
+
3229
+	/**
3230
+	 *        sort nav tabs
3231
+	 *
3232
+	 * @param $a
3233
+	 * @param $b
3234
+	 * @return int
3235
+	 */
3236
+	private function _sort_nav_tabs($a, $b)
3237
+	{
3238
+		if ($a['order'] === $b['order']) {
3239
+			return 0;
3240
+		}
3241
+		return ($a['order'] < $b['order']) ? -1 : 1;
3242
+	}
3243
+
3244
+
3245
+	/**
3246
+	 *    generates HTML for the forms used on admin pages
3247
+	 *
3248
+	 * @param    array $input_vars - array of input field details
3249
+	 * @param string   $generator  (options are 'string' or 'array', basically use this to indicate which generator to
3250
+	 *                             use)
3251
+	 * @param bool     $id
3252
+	 * @return string
3253
+	 * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
3254
+	 * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
3255
+	 */
3256
+	protected function _generate_admin_form_fields($input_vars = array(), $generator = 'string', $id = false)
3257
+	{
3258
+		$content = $generator === 'string'
3259
+			? EEH_Form_Fields::get_form_fields($input_vars, $id)
3260
+			: EEH_Form_Fields::get_form_fields_array($input_vars);
3261
+		return $content;
3262
+	}
3263
+
3264
+
3265
+	/**
3266
+	 * generates the "Save" and "Save & Close" buttons for edit forms
3267
+	 *
3268
+	 * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save &
3269
+	 *                                   Close" button.
3270
+	 * @param array            $text     if included, generator will use the given text for the buttons ( array([0] =>
3271
+	 *                                   'Save', [1] => 'save & close')
3272
+	 * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e.
3273
+	 *                                   via the "name" value in the button).  We can also use this to just dump
3274
+	 *                                   default actions by submitting some other value.
3275
+	 * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it
3276
+	 *                                   will use the $referrer string. IF null, then we don't do ANYTHING on save and
3277
+	 *                                   close (normal form handling).
3278
+	 */
3279
+	protected function _set_save_buttons($both = true, $text = array(), $actions = array(), $referrer = null)
3280
+	{
3281
+		// make sure $text and $actions are in an array
3282
+		$text = (array) $text;
3283
+		$actions = (array) $actions;
3284
+		$referrer_url = empty($referrer)
3285
+			? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
3286
+			  . $_SERVER['REQUEST_URI']
3287
+			  . '" />'
3288
+			: '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
3289
+			  . $referrer
3290
+			  . '" />';
3291
+		$button_text = ! empty($text)
3292
+			? $text
3293
+			: array(
3294
+				esc_html__('Save', 'event_espresso'),
3295
+				esc_html__('Save and Close', 'event_espresso'),
3296
+			);
3297
+		$default_names = array('save', 'save_and_close');
3298
+		// add in a hidden index for the current page (so save and close redirects properly)
3299
+		$this->_template_args['save_buttons'] = $referrer_url;
3300
+		foreach ($button_text as $key => $button) {
3301
+			$ref = $default_names[ $key ];
3302
+			$this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary '
3303
+													 . $ref
3304
+													 . '" value="'
3305
+													 . $button
3306
+													 . '" name="'
3307
+													 . (! empty($actions) ? $actions[ $key ] : $ref)
3308
+													 . '" id="'
3309
+													 . $this->_current_view . '_' . $ref
3310
+													 . '" />';
3311
+			if (! $both) {
3312
+				break;
3313
+			}
3314
+		}
3315
+	}
3316
+
3317
+
3318
+	/**
3319
+	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
3320
+	 *
3321
+	 * @see   $this->_set_add_edit_form_tags() for details on params
3322
+	 * @since 4.6.0
3323
+	 * @param string $route
3324
+	 * @param array  $additional_hidden_fields
3325
+	 */
3326
+	public function set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
3327
+	{
3328
+		$this->_set_add_edit_form_tags($route, $additional_hidden_fields);
3329
+	}
3330
+
3331
+
3332
+	/**
3333
+	 * set form open and close tags on add/edit pages.
3334
+	 *
3335
+	 * @param string $route                    the route you want the form to direct to
3336
+	 * @param array  $additional_hidden_fields any additional hidden fields required in the form header
3337
+	 * @return void
3338
+	 */
3339
+	protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = array())
3340
+	{
3341
+		if (empty($route)) {
3342
+			$user_msg = esc_html__(
3343
+				'An error occurred. No action was set for this page\'s form.',
3344
+				'event_espresso'
3345
+			);
3346
+			$dev_msg = $user_msg . "\n"
3347
+					   . sprintf(
3348
+						   esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
3349
+						   __FUNCTION__,
3350
+						   __CLASS__
3351
+					   );
3352
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
3353
+		}
3354
+		// open form
3355
+		$this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="'
3356
+															 . $this->_admin_base_url
3357
+															 . '" id="'
3358
+															 . $route
3359
+															 . '_event_form" >';
3360
+		// add nonce
3361
+		$nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
3362
+		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
3363
+		// add REQUIRED form action
3364
+		$hidden_fields = array(
3365
+			'action' => array('type' => 'hidden', 'value' => $route),
3366
+		);
3367
+		// merge arrays
3368
+		$hidden_fields = is_array($additional_hidden_fields)
3369
+			? array_merge($hidden_fields, $additional_hidden_fields)
3370
+			: $hidden_fields;
3371
+		// generate form fields
3372
+		$form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
3373
+		// add fields to form
3374
+		foreach ((array) $form_fields as $field_name => $form_field) {
3375
+			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
3376
+		}
3377
+		// close form
3378
+		$this->_template_args['after_admin_page_content'] = '</form>';
3379
+	}
3380
+
3381
+
3382
+	/**
3383
+	 * Public Wrapper for _redirect_after_action() method since its
3384
+	 * discovered it would be useful for external code to have access.
3385
+	 *
3386
+	 * @see   EE_Admin_Page::_redirect_after_action() for params.
3387
+	 * @since 4.5.0
3388
+	 * @param bool   $success
3389
+	 * @param string $what
3390
+	 * @param string $action_desc
3391
+	 * @param array  $query_args
3392
+	 * @param bool   $override_overwrite
3393
+	 * @throws EE_Error
3394
+	 */
3395
+	public function redirect_after_action(
3396
+		$success = false,
3397
+		$what = 'item',
3398
+		$action_desc = 'processed',
3399
+		$query_args = array(),
3400
+		$override_overwrite = false
3401
+	) {
3402
+		$this->_redirect_after_action(
3403
+			$success,
3404
+			$what,
3405
+			$action_desc,
3406
+			$query_args,
3407
+			$override_overwrite
3408
+		);
3409
+	}
3410
+
3411
+
3412
+	/**
3413
+	 *    _redirect_after_action
3414
+	 *
3415
+	 * @param int    $success            - whether success was for two or more records, or just one, or none
3416
+	 * @param string $what               - what the action was performed on
3417
+	 * @param string $action_desc        - what was done ie: updated, deleted, etc
3418
+	 * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin
3419
+	 *                                   action is completed
3420
+	 * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to
3421
+	 *                                   override this so that they show.
3422
+	 * @return void
3423
+	 * @throws EE_Error
3424
+	 */
3425
+	protected function _redirect_after_action(
3426
+		$success = 0,
3427
+		$what = 'item',
3428
+		$action_desc = 'processed',
3429
+		$query_args = array(),
3430
+		$override_overwrite = false
3431
+	) {
3432
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3433
+		// class name for actions/filters.
3434
+		$classname = get_class($this);
3435
+		// set redirect url.
3436
+		// Note if there is a "page" index in the $query_args then we go with vanilla admin.php route,
3437
+		// otherwise we go with whatever is set as the _admin_base_url
3438
+		$redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
3439
+		$notices = EE_Error::get_notices(false);
3440
+		// overwrite default success messages //BUT ONLY if overwrite not overridden
3441
+		if (! $override_overwrite || ! empty($notices['errors'])) {
3442
+			EE_Error::overwrite_success();
3443
+		}
3444
+		if (! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
3445
+			// how many records affected ? more than one record ? or just one ?
3446
+			if ($success > 1) {
3447
+				// set plural msg
3448
+				EE_Error::add_success(
3449
+					sprintf(
3450
+						esc_html__('The "%s" have been successfully %s.', 'event_espresso'),
3451
+						$what,
3452
+						$action_desc
3453
+					),
3454
+					__FILE__,
3455
+					__FUNCTION__,
3456
+					__LINE__
3457
+				);
3458
+			} elseif ($success === 1) {
3459
+				// set singular msg
3460
+				EE_Error::add_success(
3461
+					sprintf(
3462
+						esc_html__('The "%s" has been successfully %s.', 'event_espresso'),
3463
+						$what,
3464
+						$action_desc
3465
+					),
3466
+					__FILE__,
3467
+					__FUNCTION__,
3468
+					__LINE__
3469
+				);
3470
+			}
3471
+		}
3472
+		// check that $query_args isn't something crazy
3473
+		if (! is_array($query_args)) {
3474
+			$query_args = array();
3475
+		}
3476
+		/**
3477
+		 * Allow injecting actions before the query_args are modified for possible different
3478
+		 * redirections on save and close actions
3479
+		 *
3480
+		 * @since 4.2.0
3481
+		 * @param array $query_args       The original query_args array coming into the
3482
+		 *                                method.
3483
+		 */
3484
+		do_action(
3485
+			"AHEE__{$classname}___redirect_after_action__before_redirect_modification_{$this->_req_action}",
3486
+			$query_args
3487
+		);
3488
+		// calculate where we're going (if we have a "save and close" button pushed)
3489
+		if (isset($this->_req_data['save_and_close'], $this->_req_data['save_and_close_referrer'])) {
3490
+			// even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
3491
+			$parsed_url = parse_url($this->_req_data['save_and_close_referrer']);
3492
+			// regenerate query args array from referrer URL
3493
+			parse_str($parsed_url['query'], $query_args);
3494
+			// correct page and action will be in the query args now
3495
+			$redirect_url = admin_url('admin.php');
3496
+		}
3497
+		// merge any default query_args set in _default_route_query_args property
3498
+		if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
3499
+			$args_to_merge = array();
3500
+			foreach ($this->_default_route_query_args as $query_param => $query_value) {
3501
+				// is there a wp_referer array in our _default_route_query_args property?
3502
+				if ($query_param === 'wp_referer') {
3503
+					$query_value = (array) $query_value;
3504
+					foreach ($query_value as $reference => $value) {
3505
+						if (strpos($reference, 'nonce') !== false) {
3506
+							continue;
3507
+						}
3508
+						// finally we will override any arguments in the referer with
3509
+						// what might be set on the _default_route_query_args array.
3510
+						if (isset($this->_default_route_query_args[ $reference ])) {
3511
+							$args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
3512
+						} else {
3513
+							$args_to_merge[ $reference ] = urlencode($value);
3514
+						}
3515
+					}
3516
+					continue;
3517
+				}
3518
+				$args_to_merge[ $query_param ] = $query_value;
3519
+			}
3520
+			// now let's merge these arguments but override with what was specifically sent in to the
3521
+			// redirect.
3522
+			$query_args = array_merge($args_to_merge, $query_args);
3523
+		}
3524
+		$this->_process_notices($query_args);
3525
+		// generate redirect url
3526
+		// if redirecting to anything other than the main page, add a nonce
3527
+		if (isset($query_args['action'])) {
3528
+			// manually generate wp_nonce and merge that with the query vars
3529
+			// becuz the wp_nonce_url function wrecks havoc on some vars
3530
+			$query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
3531
+		}
3532
+		// we're adding some hooks and filters in here for processing any things just before redirects
3533
+		// (example: an admin page has done an insert or update and we want to run something after that).
3534
+		do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
3535
+		$redirect_url = apply_filters(
3536
+			'FHEE_redirect_' . $classname . $this->_req_action,
3537
+			self::add_query_args_and_nonce($query_args, $redirect_url),
3538
+			$query_args
3539
+		);
3540
+		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
3541
+		if (defined('DOING_AJAX')) {
3542
+			$default_data = array(
3543
+				'close'        => true,
3544
+				'redirect_url' => $redirect_url,
3545
+				'where'        => 'main',
3546
+				'what'         => 'append',
3547
+			);
3548
+			$this->_template_args['success'] = $success;
3549
+			$this->_template_args['data'] = ! empty($this->_template_args['data']) ? array_merge(
3550
+				$default_data,
3551
+				$this->_template_args['data']
3552
+			) : $default_data;
3553
+			$this->_return_json();
3554
+		}
3555
+		wp_safe_redirect($redirect_url);
3556
+		exit();
3557
+	}
3558
+
3559
+
3560
+	/**
3561
+	 * process any notices before redirecting (or returning ajax request)
3562
+	 * This method sets the $this->_template_args['notices'] attribute;
3563
+	 *
3564
+	 * @param  array $query_args        any query args that need to be used for notice transient ('action')
3565
+	 * @param bool   $skip_route_verify This is typically used when we are processing notices REALLY early and
3566
+	 *                                  page_routes haven't been defined yet.
3567
+	 * @param bool   $sticky_notices    This is used to flag that regardless of whether this is doing_ajax or not, we
3568
+	 *                                  still save a transient for the notice.
3569
+	 * @return void
3570
+	 * @throws EE_Error
3571
+	 */
3572
+	protected function _process_notices($query_args = array(), $skip_route_verify = false, $sticky_notices = true)
3573
+	{
3574
+		// first let's set individual error properties if doing_ajax and the properties aren't already set.
3575
+		if (defined('DOING_AJAX') && DOING_AJAX) {
3576
+			$notices = EE_Error::get_notices(false);
3577
+			if (empty($this->_template_args['success'])) {
3578
+				$this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
3579
+			}
3580
+			if (empty($this->_template_args['errors'])) {
3581
+				$this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
3582
+			}
3583
+			if (empty($this->_template_args['attention'])) {
3584
+				$this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
3585
+			}
3586
+		}
3587
+		$this->_template_args['notices'] = EE_Error::get_notices();
3588
+		// IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
3589
+		if (! defined('DOING_AJAX') || $sticky_notices) {
3590
+			$route = isset($query_args['action']) ? $query_args['action'] : 'default';
3591
+			$this->_add_transient(
3592
+				$route,
3593
+				$this->_template_args['notices'],
3594
+				true,
3595
+				$skip_route_verify
3596
+			);
3597
+		}
3598
+	}
3599
+
3600
+
3601
+	/**
3602
+	 * get_action_link_or_button
3603
+	 * returns the button html for adding, editing, or deleting an item (depending on given type)
3604
+	 *
3605
+	 * @param string $action        use this to indicate which action the url is generated with.
3606
+	 * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key)
3607
+	 *                              property.
3608
+	 * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
3609
+	 * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
3610
+	 * @param string $base_url      If this is not provided
3611
+	 *                              the _admin_base_url will be used as the default for the button base_url.
3612
+	 *                              Otherwise this value will be used.
3613
+	 * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
3614
+	 * @return string
3615
+	 * @throws InvalidArgumentException
3616
+	 * @throws InvalidInterfaceException
3617
+	 * @throws InvalidDataTypeException
3618
+	 * @throws EE_Error
3619
+	 */
3620
+	public function get_action_link_or_button(
3621
+		$action,
3622
+		$type = 'add',
3623
+		$extra_request = array(),
3624
+		$class = 'button-primary',
3625
+		$base_url = '',
3626
+		$exclude_nonce = false
3627
+	) {
3628
+		// first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
3629
+		if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
3630
+			throw new EE_Error(
3631
+				sprintf(
3632
+					esc_html__(
3633
+						'There is no page route for given action for the button.  This action was given: %s',
3634
+						'event_espresso'
3635
+					),
3636
+					$action
3637
+				)
3638
+			);
3639
+		}
3640
+		if (! isset($this->_labels['buttons'][ $type ])) {
3641
+			throw new EE_Error(
3642
+				sprintf(
3643
+					__(
3644
+						'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
3645
+						'event_espresso'
3646
+					),
3647
+					$type
3648
+				)
3649
+			);
3650
+		}
3651
+		// finally check user access for this button.
3652
+		$has_access = $this->check_user_access($action, true);
3653
+		if (! $has_access) {
3654
+			return '';
3655
+		}
3656
+		$_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
3657
+		$query_args = array(
3658
+			'action' => $action,
3659
+		);
3660
+		// merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
3661
+		if (! empty($extra_request)) {
3662
+			$query_args = array_merge($extra_request, $query_args);
3663
+		}
3664
+		$url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
3665
+		return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
3666
+	}
3667
+
3668
+
3669
+	/**
3670
+	 * _per_page_screen_option
3671
+	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
3672
+	 *
3673
+	 * @return void
3674
+	 * @throws InvalidArgumentException
3675
+	 * @throws InvalidInterfaceException
3676
+	 * @throws InvalidDataTypeException
3677
+	 */
3678
+	protected function _per_page_screen_option()
3679
+	{
3680
+		$option = 'per_page';
3681
+		$args = array(
3682
+			'label'   => apply_filters(
3683
+				'FHEE__EE_Admin_Page___per_page_screen_options___label',
3684
+				$this->_admin_page_title,
3685
+				$this
3686
+			),
3687
+			'default' => (int) apply_filters(
3688
+				'FHEE__EE_Admin_Page___per_page_screen_options__default',
3689
+				20
3690
+			),
3691
+			'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
3692
+		);
3693
+		// ONLY add the screen option if the user has access to it.
3694
+		if ($this->check_user_access($this->_current_view, true)) {
3695
+			add_screen_option($option, $args);
3696
+		}
3697
+	}
3698
+
3699
+
3700
+	/**
3701
+	 * set_per_page_screen_option
3702
+	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
3703
+	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than
3704
+	 * admin_menu.
3705
+	 *
3706
+	 * @return void
3707
+	 */
3708
+	private function _set_per_page_screen_options()
3709
+	{
3710
+		if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
3711
+			check_admin_referer('screen-options-nonce', 'screenoptionnonce');
3712
+			if (! $user = wp_get_current_user()) {
3713
+				return;
3714
+			}
3715
+			$option = $_POST['wp_screen_options']['option'];
3716
+			$value = $_POST['wp_screen_options']['value'];
3717
+			if ($option != sanitize_key($option)) {
3718
+				return;
3719
+			}
3720
+			$map_option = $option;
3721
+			$option = str_replace('-', '_', $option);
3722
+			switch ($map_option) {
3723
+				case $this->_current_page . '_' . $this->_current_view . '_per_page':
3724
+					$value = (int) $value;
3725
+					$max_value = apply_filters(
3726
+						'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
3727
+						999,
3728
+						$this->_current_page,
3729
+						$this->_current_view
3730
+					);
3731
+					if ($value < 1) {
3732
+						return;
3733
+					}
3734
+					$value = min($value, $max_value);
3735
+					break;
3736
+				default:
3737
+					$value = apply_filters(
3738
+						'FHEE__EE_Admin_Page___set_per_page_screen_options__value',
3739
+						false,
3740
+						$option,
3741
+						$value
3742
+					);
3743
+					if (false === $value) {
3744
+						return;
3745
+					}
3746
+					break;
3747
+			}
3748
+			update_user_meta($user->ID, $option, $value);
3749
+			wp_safe_redirect(remove_query_arg(array('pagenum', 'apage', 'paged'), wp_get_referer()));
3750
+			exit;
3751
+		}
3752
+	}
3753
+
3754
+
3755
+	/**
3756
+	 * This just allows for setting the $_template_args property if it needs to be set outside the object
3757
+	 *
3758
+	 * @param array $data array that will be assigned to template args.
3759
+	 */
3760
+	public function set_template_args($data)
3761
+	{
3762
+		$this->_template_args = array_merge($this->_template_args, (array) $data);
3763
+	}
3764
+
3765
+
3766
+	/**
3767
+	 * This makes available the WP transient system for temporarily moving data between routes
3768
+	 *
3769
+	 * @param string $route             the route that should receive the transient
3770
+	 * @param array  $data              the data that gets sent
3771
+	 * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a
3772
+	 *                                  normal route transient.
3773
+	 * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used
3774
+	 *                                  when we are adding a transient before page_routes have been defined.
3775
+	 * @return void
3776
+	 * @throws EE_Error
3777
+	 */
3778
+	protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
3779
+	{
3780
+		$user_id = get_current_user_id();
3781
+		if (! $skip_route_verify) {
3782
+			$this->_verify_route($route);
3783
+		}
3784
+		// now let's set the string for what kind of transient we're setting
3785
+		$transient = $notices
3786
+			? 'ee_rte_n_tx_' . $route . '_' . $user_id
3787
+			: 'rte_tx_' . $route . '_' . $user_id;
3788
+		$data = $notices ? array('notices' => $data) : $data;
3789
+		// is there already a transient for this route?  If there is then let's ADD to that transient
3790
+		$existing = is_multisite() && is_network_admin()
3791
+			? get_site_transient($transient)
3792
+			: get_transient($transient);
3793
+		if ($existing) {
3794
+			$data = array_merge((array) $data, (array) $existing);
3795
+		}
3796
+		if (is_multisite() && is_network_admin()) {
3797
+			set_site_transient($transient, $data, 8);
3798
+		} else {
3799
+			set_transient($transient, $data, 8);
3800
+		}
3801
+	}
3802
+
3803
+
3804
+	/**
3805
+	 * this retrieves the temporary transient that has been set for moving data between routes.
3806
+	 *
3807
+	 * @param bool   $notices true we get notices transient. False we just return normal route transient
3808
+	 * @param string $route
3809
+	 * @return mixed data
3810
+	 */
3811
+	protected function _get_transient($notices = false, $route = '')
3812
+	{
3813
+		$user_id = get_current_user_id();
3814
+		$route = ! $route ? $this->_req_action : $route;
3815
+		$transient = $notices
3816
+			? 'ee_rte_n_tx_' . $route . '_' . $user_id
3817
+			: 'rte_tx_' . $route . '_' . $user_id;
3818
+		$data = is_multisite() && is_network_admin()
3819
+			? get_site_transient($transient)
3820
+			: get_transient($transient);
3821
+		// delete transient after retrieval (just in case it hasn't expired);
3822
+		if (is_multisite() && is_network_admin()) {
3823
+			delete_site_transient($transient);
3824
+		} else {
3825
+			delete_transient($transient);
3826
+		}
3827
+		return $notices && isset($data['notices']) ? $data['notices'] : $data;
3828
+	}
3829
+
3830
+
3831
+	/**
3832
+	 * The purpose of this method is just to run garbage collection on any EE transients that might have expired but
3833
+	 * would not be called later. This will be assigned to run on a specific EE Admin page. (place the method in the
3834
+	 * default route callback on the EE_Admin page you want it run.)
3835
+	 *
3836
+	 * @return void
3837
+	 */
3838
+	protected function _transient_garbage_collection()
3839
+	{
3840
+		global $wpdb;
3841
+		// retrieve all existing transients
3842
+		$query = "SELECT option_name FROM {$wpdb->options} WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
3843
+		if ($results = $wpdb->get_results($query)) {
3844
+			foreach ($results as $result) {
3845
+				$transient = str_replace('_transient_', '', $result->option_name);
3846
+				get_transient($transient);
3847
+				if (is_multisite() && is_network_admin()) {
3848
+					get_site_transient($transient);
3849
+				}
3850
+			}
3851
+		}
3852
+	}
3853
+
3854
+
3855
+	/**
3856
+	 * get_view
3857
+	 *
3858
+	 * @return string content of _view property
3859
+	 */
3860
+	public function get_view()
3861
+	{
3862
+		return $this->_view;
3863
+	}
3864
+
3865
+
3866
+	/**
3867
+	 * getter for the protected $_views property
3868
+	 *
3869
+	 * @return array
3870
+	 */
3871
+	public function get_views()
3872
+	{
3873
+		return $this->_views;
3874
+	}
3875
+
3876
+
3877
+	/**
3878
+	 * get_current_page
3879
+	 *
3880
+	 * @return string _current_page property value
3881
+	 */
3882
+	public function get_current_page()
3883
+	{
3884
+		return $this->_current_page;
3885
+	}
3886
+
3887
+
3888
+	/**
3889
+	 * get_current_view
3890
+	 *
3891
+	 * @return string _current_view property value
3892
+	 */
3893
+	public function get_current_view()
3894
+	{
3895
+		return $this->_current_view;
3896
+	}
3897
+
3898
+
3899
+	/**
3900
+	 * get_current_screen
3901
+	 *
3902
+	 * @return object The current WP_Screen object
3903
+	 */
3904
+	public function get_current_screen()
3905
+	{
3906
+		return $this->_current_screen;
3907
+	}
3908
+
3909
+
3910
+	/**
3911
+	 * get_current_page_view_url
3912
+	 *
3913
+	 * @return string This returns the url for the current_page_view.
3914
+	 */
3915
+	public function get_current_page_view_url()
3916
+	{
3917
+		return $this->_current_page_view_url;
3918
+	}
3919
+
3920
+
3921
+	/**
3922
+	 * just returns the _req_data property
3923
+	 *
3924
+	 * @return array
3925
+	 */
3926
+	public function get_request_data()
3927
+	{
3928
+		return $this->_req_data;
3929
+	}
3930
+
3931
+
3932
+	/**
3933
+	 * returns the _req_data protected property
3934
+	 *
3935
+	 * @return string
3936
+	 */
3937
+	public function get_req_action()
3938
+	{
3939
+		return $this->_req_action;
3940
+	}
3941
+
3942
+
3943
+	/**
3944
+	 * @return bool  value of $_is_caf property
3945
+	 */
3946
+	public function is_caf()
3947
+	{
3948
+		return $this->_is_caf;
3949
+	}
3950
+
3951
+
3952
+	/**
3953
+	 * @return mixed
3954
+	 */
3955
+	public function default_espresso_metaboxes()
3956
+	{
3957
+		return $this->_default_espresso_metaboxes;
3958
+	}
3959
+
3960
+
3961
+	/**
3962
+	 * @return mixed
3963
+	 */
3964
+	public function admin_base_url()
3965
+	{
3966
+		return $this->_admin_base_url;
3967
+	}
3968
+
3969
+
3970
+	/**
3971
+	 * @return mixed
3972
+	 */
3973
+	public function wp_page_slug()
3974
+	{
3975
+		return $this->_wp_page_slug;
3976
+	}
3977
+
3978
+
3979
+	/**
3980
+	 * updates  espresso configuration settings
3981
+	 *
3982
+	 * @param string                   $tab
3983
+	 * @param EE_Config_Base|EE_Config $config
3984
+	 * @param string                   $file file where error occurred
3985
+	 * @param string                   $func function  where error occurred
3986
+	 * @param string                   $line line no where error occurred
3987
+	 * @return boolean
3988
+	 */
3989
+	protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
3990
+	{
3991
+		// remove any options that are NOT going to be saved with the config settings.
3992
+		if (isset($config->core->ee_ueip_optin)) {
3993
+			// TODO: remove the following two lines and make sure values are migrated from 3.1
3994
+			update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
3995
+			update_option('ee_ueip_has_notified', true);
3996
+		}
3997
+		// and save it (note we're also doing the network save here)
3998
+		$net_saved = is_main_site() ? EE_Network_Config::instance()->update_config(false, false) : true;
3999
+		$config_saved = EE_Config::instance()->update_espresso_config(false, false);
4000
+		if ($config_saved && $net_saved) {
4001
+			EE_Error::add_success(sprintf(__('"%s" have been successfully updated.', 'event_espresso'), $tab));
4002
+			return true;
4003
+		}
4004
+		EE_Error::add_error(sprintf(__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
4005
+		return false;
4006
+	}
4007
+
4008
+
4009
+	/**
4010
+	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
4011
+	 *
4012
+	 * @return array
4013
+	 */
4014
+	public function get_yes_no_values()
4015
+	{
4016
+		return $this->_yes_no_values;
4017
+	}
4018
+
4019
+
4020
+	protected function _get_dir()
4021
+	{
4022
+		$reflector = new ReflectionClass(get_class($this));
4023
+		return dirname($reflector->getFileName());
4024
+	}
4025
+
4026
+
4027
+	/**
4028
+	 * A helper for getting a "next link".
4029
+	 *
4030
+	 * @param string $url   The url to link to
4031
+	 * @param string $class The class to use.
4032
+	 * @return string
4033
+	 */
4034
+	protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
4035
+	{
4036
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
4037
+	}
4038
+
4039
+
4040
+	/**
4041
+	 * A helper for getting a "previous link".
4042
+	 *
4043
+	 * @param string $url   The url to link to
4044
+	 * @param string $class The class to use.
4045
+	 * @return string
4046
+	 */
4047
+	protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
4048
+	{
4049
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
4050
+	}
4051
+
4052
+
4053
+
4054
+
4055
+
4056
+
4057
+
4058
+	// below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
4059
+
4060
+
4061
+	/**
4062
+	 * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller
4063
+	 * 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
4064
+	 * _req_data array.
4065
+	 *
4066
+	 * @return bool success/fail
4067
+	 * @throws EE_Error
4068
+	 * @throws InvalidArgumentException
4069
+	 * @throws ReflectionException
4070
+	 * @throws InvalidDataTypeException
4071
+	 * @throws InvalidInterfaceException
4072
+	 */
4073
+	protected function _process_resend_registration()
4074
+	{
4075
+		$this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
4076
+		do_action(
4077
+			'AHEE__EE_Admin_Page___process_resend_registration',
4078
+			$this->_template_args['success'],
4079
+			$this->_req_data
4080
+		);
4081
+		return $this->_template_args['success'];
4082
+	}
4083
+
4084
+
4085
+	/**
4086
+	 * This automatically processes any payment message notifications when manual payment has been applied.
4087
+	 *
4088
+	 * @param \EE_Payment $payment
4089
+	 * @return bool success/fail
4090
+	 */
4091
+	protected function _process_payment_notification(EE_Payment $payment)
4092
+	{
4093
+		add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
4094
+		do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
4095
+		$this->_template_args['success'] = apply_filters(
4096
+			'FHEE__EE_Admin_Page___process_admin_payment_notification__success',
4097
+			false,
4098
+			$payment
4099
+		);
4100
+		return $this->_template_args['success'];
4101
+	}
4102 4102
 }
Please login to merge, or discard this patch.
Spacing   +183 added lines, -183 removed lines patch added patch discarded remove patch
@@ -500,7 +500,7 @@  discard block
 block discarded – undo
500 500
         );
501 501
         global $ee_menu_slugs;
502 502
         $ee_menu_slugs = (array) $ee_menu_slugs;
503
-        if (! defined('DOING_AJAX') && (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))) {
503
+        if ( ! defined('DOING_AJAX') && ( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page]))) {
504 504
             return;
505 505
         }
506 506
         // 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
@@ -524,7 +524,7 @@  discard block
 block discarded – undo
524 524
             ? $this->_req_data['route']
525 525
             : $this->_req_action;
526 526
         $this->_current_view = $this->_req_action;
527
-        $this->_req_nonce = $this->_req_action . '_nonce';
527
+        $this->_req_nonce = $this->_req_action.'_nonce';
528 528
         $this->_define_page_props();
529 529
         $this->_current_page_view_url = add_query_arg(
530 530
             array('page' => $this->_current_page, 'action' => $this->_current_view),
@@ -558,21 +558,21 @@  discard block
 block discarded – undo
558 558
         }
559 559
         // filter routes and page_config so addons can add their stuff. Filtering done per class
560 560
         $this->_page_routes = apply_filters(
561
-            'FHEE__' . get_class($this) . '__page_setup__page_routes',
561
+            'FHEE__'.get_class($this).'__page_setup__page_routes',
562 562
             $this->_page_routes,
563 563
             $this
564 564
         );
565 565
         $this->_page_config = apply_filters(
566
-            'FHEE__' . get_class($this) . '__page_setup__page_config',
566
+            'FHEE__'.get_class($this).'__page_setup__page_config',
567 567
             $this->_page_config,
568 568
             $this
569 569
         );
570 570
         // if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
571 571
         // then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
572
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
572
+        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view)) {
573 573
             add_action(
574 574
                 'AHEE__EE_Admin_Page__route_admin_request',
575
-                array($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view),
575
+                array($this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view),
576 576
                 10,
577 577
                 2
578 578
             );
@@ -585,8 +585,8 @@  discard block
 block discarded – undo
585 585
             if ($this->_is_UI_request) {
586 586
                 // admin_init stuff - global, all views for this page class, specific view
587 587
                 add_action('admin_init', array($this, 'admin_init'), 10);
588
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
589
-                    add_action('admin_init', array($this, 'admin_init_' . $this->_current_view), 15);
588
+                if (method_exists($this, 'admin_init_'.$this->_current_view)) {
589
+                    add_action('admin_init', array($this, 'admin_init_'.$this->_current_view), 15);
590 590
                 }
591 591
             } else {
592 592
                 // hijack regular WP loading and route admin request immediately
@@ -606,12 +606,12 @@  discard block
 block discarded – undo
606 606
      */
607 607
     private function _do_other_page_hooks()
608 608
     {
609
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, array());
609
+        $registered_pages = apply_filters('FHEE_do_other_page_hooks_'.$this->page_slug, array());
610 610
         foreach ($registered_pages as $page) {
611 611
             // now let's setup the file name and class that should be present
612 612
             $classname = str_replace('.class.php', '', $page);
613 613
             // autoloaders should take care of loading file
614
-            if (! class_exists($classname)) {
614
+            if ( ! class_exists($classname)) {
615 615
                 $error_msg[] = sprintf(
616 616
                     esc_html__(
617 617
                         'Something went wrong with loading the %s admin hooks page.',
@@ -628,7 +628,7 @@  discard block
 block discarded – undo
628 628
                                    ),
629 629
                                    $page,
630 630
                                    '<br />',
631
-                                   '<strong>' . $classname . '</strong>'
631
+                                   '<strong>'.$classname.'</strong>'
632 632
                                );
633 633
                 throw new EE_Error(implode('||', $error_msg));
634 634
             }
@@ -668,13 +668,13 @@  discard block
 block discarded – undo
668 668
         // load admin_notices - global, page class, and view specific
669 669
         add_action('admin_notices', array($this, 'admin_notices_global'), 5);
670 670
         add_action('admin_notices', array($this, 'admin_notices'), 10);
671
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
672
-            add_action('admin_notices', array($this, 'admin_notices_' . $this->_current_view), 15);
671
+        if (method_exists($this, 'admin_notices_'.$this->_current_view)) {
672
+            add_action('admin_notices', array($this, 'admin_notices_'.$this->_current_view), 15);
673 673
         }
674 674
         // load network admin_notices - global, page class, and view specific
675 675
         add_action('network_admin_notices', array($this, 'network_admin_notices_global'), 5);
676
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
677
-            add_action('network_admin_notices', array($this, 'network_admin_notices_' . $this->_current_view));
676
+        if (method_exists($this, 'network_admin_notices_'.$this->_current_view)) {
677
+            add_action('network_admin_notices', array($this, 'network_admin_notices_'.$this->_current_view));
678 678
         }
679 679
         // this will save any per_page screen options if they are present
680 680
         $this->_set_per_page_screen_options();
@@ -796,7 +796,7 @@  discard block
 block discarded – undo
796 796
     protected function _verify_routes()
797 797
     {
798 798
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
799
-        if (! $this->_current_page && ! defined('DOING_AJAX')) {
799
+        if ( ! $this->_current_page && ! defined('DOING_AJAX')) {
800 800
             return false;
801 801
         }
802 802
         $this->_route = false;
@@ -808,7 +808,7 @@  discard block
 block discarded – undo
808 808
                 $this->_admin_page_title
809 809
             );
810 810
             // developer error msg
811
-            $error_msg .= '||' . $error_msg
811
+            $error_msg .= '||'.$error_msg
812 812
                           . esc_html__(
813 813
                               ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
814 814
                               'event_espresso'
@@ -817,9 +817,9 @@  discard block
 block discarded – undo
817 817
         }
818 818
         // and that the requested page route exists
819 819
         if (array_key_exists($this->_req_action, $this->_page_routes)) {
820
-            $this->_route = $this->_page_routes[ $this->_req_action ];
821
-            $this->_route_config = isset($this->_page_config[ $this->_req_action ])
822
-                ? $this->_page_config[ $this->_req_action ] : array();
820
+            $this->_route = $this->_page_routes[$this->_req_action];
821
+            $this->_route_config = isset($this->_page_config[$this->_req_action])
822
+                ? $this->_page_config[$this->_req_action] : array();
823 823
         } else {
824 824
             // user error msg
825 825
             $error_msg = sprintf(
@@ -830,7 +830,7 @@  discard block
 block discarded – undo
830 830
                 $this->_admin_page_title
831 831
             );
832 832
             // developer error msg
833
-            $error_msg .= '||' . $error_msg
833
+            $error_msg .= '||'.$error_msg
834 834
                           . sprintf(
835 835
                               esc_html__(
836 836
                                   ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
@@ -841,7 +841,7 @@  discard block
 block discarded – undo
841 841
             throw new EE_Error($error_msg);
842 842
         }
843 843
         // and that a default route exists
844
-        if (! array_key_exists('default', $this->_page_routes)) {
844
+        if ( ! array_key_exists('default', $this->_page_routes)) {
845 845
             // user error msg
846 846
             $error_msg = sprintf(
847 847
                 esc_html__(
@@ -851,7 +851,7 @@  discard block
 block discarded – undo
851 851
                 $this->_admin_page_title
852 852
             );
853 853
             // developer error msg
854
-            $error_msg .= '||' . $error_msg
854
+            $error_msg .= '||'.$error_msg
855 855
                           . esc_html__(
856 856
                               ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
857 857
                               'event_espresso'
@@ -890,7 +890,7 @@  discard block
 block discarded – undo
890 890
             $this->_admin_page_title
891 891
         );
892 892
         // developer error msg
893
-        $error_msg .= '||' . $error_msg
893
+        $error_msg .= '||'.$error_msg
894 894
                       . sprintf(
895 895
                           esc_html__(
896 896
                               ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
@@ -915,7 +915,7 @@  discard block
 block discarded – undo
915 915
     protected function _verify_nonce($nonce, $nonce_ref)
916 916
     {
917 917
         // verify nonce against expected value
918
-        if (! wp_verify_nonce($nonce, $nonce_ref)) {
918
+        if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
919 919
             // these are not the droids you are looking for !!!
920 920
             $msg = sprintf(
921 921
                 esc_html__('%sNonce Fail.%s', 'event_espresso'),
@@ -932,7 +932,7 @@  discard block
 block discarded – undo
932 932
                             __CLASS__
933 933
                         );
934 934
             }
935
-            if (! defined('DOING_AJAX')) {
935
+            if ( ! defined('DOING_AJAX')) {
936 936
                 wp_die($msg);
937 937
             } else {
938 938
                 EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
@@ -957,7 +957,7 @@  discard block
 block discarded – undo
957 957
      */
958 958
     protected function _route_admin_request()
959 959
     {
960
-        if (! $this->_is_UI_request) {
960
+        if ( ! $this->_is_UI_request) {
961 961
             $this->_verify_routes();
962 962
         }
963 963
         $nonce_check = isset($this->_route_config['require_nonce'])
@@ -965,8 +965,8 @@  discard block
 block discarded – undo
965 965
             : true;
966 966
         if ($this->_req_action !== 'default' && $nonce_check) {
967 967
             // set nonce from post data
968
-            $nonce = isset($this->_req_data[ $this->_req_nonce ])
969
-                ? sanitize_text_field($this->_req_data[ $this->_req_nonce ])
968
+            $nonce = isset($this->_req_data[$this->_req_nonce])
969
+                ? sanitize_text_field($this->_req_data[$this->_req_nonce])
970 970
                 : '';
971 971
             $this->_verify_nonce($nonce, $this->_req_nonce);
972 972
         }
@@ -981,7 +981,7 @@  discard block
 block discarded – undo
981 981
         $error_msg = '';
982 982
         // action right before calling route
983 983
         // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
984
-        if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
984
+        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
985 985
             do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
986 986
         }
987 987
         // right before calling the route, let's remove _wp_http_referer from the
@@ -990,7 +990,7 @@  discard block
 block discarded – undo
990 990
             '_wp_http_referer',
991 991
             wp_unslash($_SERVER['REQUEST_URI'])
992 992
         );
993
-        if (! empty($func)) {
993
+        if ( ! empty($func)) {
994 994
             if (is_array($func)) {
995 995
                 list($class, $method) = $func;
996 996
             } elseif (strpos($func, '::') !== false) {
@@ -999,7 +999,7 @@  discard block
 block discarded – undo
999 999
                 $class = $this;
1000 1000
                 $method = $func;
1001 1001
             }
1002
-            if (! (is_object($class) && $class === $this)) {
1002
+            if ( ! (is_object($class) && $class === $this)) {
1003 1003
                 // send along this admin page object for access by addons.
1004 1004
                 $args['admin_page_object'] = $this;
1005 1005
             }
@@ -1039,7 +1039,7 @@  discard block
 block discarded – undo
1039 1039
                     $method
1040 1040
                 );
1041 1041
             }
1042
-            if (! empty($error_msg)) {
1042
+            if ( ! empty($error_msg)) {
1043 1043
                 throw new EE_Error($error_msg);
1044 1044
             }
1045 1045
         }
@@ -1123,7 +1123,7 @@  discard block
 block discarded – undo
1123 1123
                 if (strpos($key, 'nonce') !== false) {
1124 1124
                     continue;
1125 1125
                 }
1126
-                $args[ 'wp_referer[' . $key . ']' ] = $value;
1126
+                $args['wp_referer['.$key.']'] = $value;
1127 1127
             }
1128 1128
         }
1129 1129
         return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
@@ -1163,10 +1163,10 @@  discard block
 block discarded – undo
1163 1163
     protected function _add_help_tabs()
1164 1164
     {
1165 1165
         $tour_buttons = '';
1166
-        if (isset($this->_page_config[ $this->_req_action ])) {
1167
-            $config = $this->_page_config[ $this->_req_action ];
1166
+        if (isset($this->_page_config[$this->_req_action])) {
1167
+            $config = $this->_page_config[$this->_req_action];
1168 1168
             // is there a help tour for the current route?  if there is let's setup the tour buttons
1169
-            if (isset($this->_help_tour[ $this->_req_action ])) {
1169
+            if (isset($this->_help_tour[$this->_req_action])) {
1170 1170
                 $tb = array();
1171 1171
                 $tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
1172 1172
                 foreach ($this->_help_tour['tours'] as $tour) {
@@ -1186,7 +1186,7 @@  discard block
 block discarded – undo
1186 1186
             // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
1187 1187
             if (is_array($config) && isset($config['help_sidebar'])) {
1188 1188
                 // check that the callback given is valid
1189
-                if (! method_exists($this, $config['help_sidebar'])) {
1189
+                if ( ! method_exists($this, $config['help_sidebar'])) {
1190 1190
                     throw new EE_Error(
1191 1191
                         sprintf(
1192 1192
                             esc_html__(
@@ -1199,7 +1199,7 @@  discard block
 block discarded – undo
1199 1199
                     );
1200 1200
                 }
1201 1201
                 $content = apply_filters(
1202
-                    'FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar',
1202
+                    'FHEE__'.get_class($this).'__add_help_tabs__help_sidebar',
1203 1203
                     $this->{$config['help_sidebar']}()
1204 1204
                 );
1205 1205
                 $content .= $tour_buttons; // add help tour buttons.
@@ -1207,27 +1207,27 @@  discard block
 block discarded – undo
1207 1207
                 $this->_current_screen->set_help_sidebar($content);
1208 1208
             }
1209 1209
             // if we DON'T have config help sidebar and there ARE tour buttons then we'll just add the tour buttons to the sidebar.
1210
-            if (! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
1210
+            if ( ! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
1211 1211
                 $this->_current_screen->set_help_sidebar($tour_buttons);
1212 1212
             }
1213 1213
             // handle if no help_tabs are set so the sidebar will still show for the help tour buttons
1214
-            if (! isset($config['help_tabs']) && ! empty($tour_buttons)) {
1214
+            if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
1215 1215
                 $_ht['id'] = $this->page_slug;
1216 1216
                 $_ht['title'] = esc_html__('Help Tours', 'event_espresso');
1217 1217
                 $_ht['content'] = '<p>'
1218 1218
                                   . esc_html__(
1219 1219
                                       'The buttons to the right allow you to start/restart any help tours available for this page',
1220 1220
                                       'event_espresso'
1221
-                                  ) . '</p>';
1221
+                                  ).'</p>';
1222 1222
                 $this->_current_screen->add_help_tab($_ht);
1223 1223
             }
1224
-            if (! isset($config['help_tabs'])) {
1224
+            if ( ! isset($config['help_tabs'])) {
1225 1225
                 return;
1226 1226
             } //no help tabs for this route
1227 1227
             foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
1228 1228
                 // we're here so there ARE help tabs!
1229 1229
                 // make sure we've got what we need
1230
-                if (! isset($cfg['title'])) {
1230
+                if ( ! isset($cfg['title'])) {
1231 1231
                     throw new EE_Error(
1232 1232
                         esc_html__(
1233 1233
                             'The _page_config array is not set up properly for help tabs.  It is missing a title',
@@ -1235,7 +1235,7 @@  discard block
 block discarded – undo
1235 1235
                         )
1236 1236
                     );
1237 1237
                 }
1238
-                if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
1238
+                if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
1239 1239
                     throw new EE_Error(
1240 1240
                         esc_html__(
1241 1241
                             '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',
@@ -1244,11 +1244,11 @@  discard block
 block discarded – undo
1244 1244
                     );
1245 1245
                 }
1246 1246
                 // first priority goes to content.
1247
-                if (! empty($cfg['content'])) {
1247
+                if ( ! empty($cfg['content'])) {
1248 1248
                     $content = ! empty($cfg['content']) ? $cfg['content'] : null;
1249 1249
                     // second priority goes to filename
1250
-                } elseif (! empty($cfg['filename'])) {
1251
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
1250
+                } elseif ( ! empty($cfg['filename'])) {
1251
+                    $file_path = $this->_get_dir().'/help_tabs/'.$cfg['filename'].'.help_tab.php';
1252 1252
                     // 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)
1253 1253
                     $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
1254 1254
                                                              . basename($this->_get_dir())
@@ -1256,7 +1256,7 @@  discard block
 block discarded – undo
1256 1256
                                                              . $cfg['filename']
1257 1257
                                                              . '.help_tab.php' : $file_path;
1258 1258
                     // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1259
-                    if (! isset($cfg['callback']) && ! is_readable($file_path)) {
1259
+                    if ( ! isset($cfg['callback']) && ! is_readable($file_path)) {
1260 1260
                         EE_Error::add_error(
1261 1261
                             sprintf(
1262 1262
                                 esc_html__(
@@ -1302,7 +1302,7 @@  discard block
 block discarded – undo
1302 1302
                     return;
1303 1303
                 }
1304 1304
                 // setup config array for help tab method
1305
-                $id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
1305
+                $id = $this->page_slug.'-'.$this->_req_action.'-'.$tab_id;
1306 1306
                 $_ht = array(
1307 1307
                     'id'       => $id,
1308 1308
                     'title'    => $cfg['title'],
@@ -1346,7 +1346,7 @@  discard block
 block discarded – undo
1346 1346
             }
1347 1347
             if (isset($config['help_tour'])) {
1348 1348
                 foreach ($config['help_tour'] as $tour) {
1349
-                    $file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
1349
+                    $file_path = $this->_get_dir().'/help_tours/'.$tour.'.class.php';
1350 1350
                     // let's see if we can get that file...
1351 1351
                     // if not its possible this is a decaf route not set in caffeinated
1352 1352
                     // so lets try and get the caffeinated equivalent
@@ -1356,7 +1356,7 @@  discard block
 block discarded – undo
1356 1356
                                                              . $tour
1357 1357
                                                              . '.class.php' : $file_path;
1358 1358
                     // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
1359
-                    if (! is_readable($file_path)) {
1359
+                    if ( ! is_readable($file_path)) {
1360 1360
                         EE_Error::add_error(
1361 1361
                             sprintf(
1362 1362
                                 esc_html__(
@@ -1373,12 +1373,12 @@  discard block
 block discarded – undo
1373 1373
                         return;
1374 1374
                     }
1375 1375
                     require_once $file_path;
1376
-                    if (! class_exists($tour)) {
1376
+                    if ( ! class_exists($tour)) {
1377 1377
                         $error_msg[] = sprintf(
1378 1378
                             esc_html__('Something went wrong with loading the %s Help Tour Class.', 'event_espresso'),
1379 1379
                             $tour
1380 1380
                         );
1381
-                        $error_msg[] = $error_msg[0] . "\r\n"
1381
+                        $error_msg[] = $error_msg[0]."\r\n"
1382 1382
                                        . sprintf(
1383 1383
                                            esc_html__(
1384 1384
                                                '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.',
@@ -1394,15 +1394,15 @@  discard block
 block discarded – undo
1394 1394
                     }
1395 1395
                     $tour_obj = new $tour($this->_is_caf);
1396 1396
                     $tours[] = $tour_obj;
1397
-                    $this->_help_tour[ $route ][] = EEH_Template::help_tour_stops_generator($tour_obj);
1397
+                    $this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($tour_obj);
1398 1398
                 }
1399 1399
                 // let's inject the end tour stop element common to all pages... this will only get seen once per machine.
1400 1400
                 $end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
1401 1401
                 $tours[] = $end_stop_tour;
1402
-                $this->_help_tour[ $route ][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
1402
+                $this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator($end_stop_tour);
1403 1403
             }
1404 1404
         }
1405
-        if (! empty($tours)) {
1405
+        if ( ! empty($tours)) {
1406 1406
             $this->_help_tour['tours'] = $tours;
1407 1407
         }
1408 1408
         // that's it!  Now that the $_help_tours property is set (or not)
@@ -1421,8 +1421,8 @@  discard block
 block discarded – undo
1421 1421
             $qtips = (array) $this->_route_config['qtips'];
1422 1422
             // load qtip loader
1423 1423
             $path = array(
1424
-                $this->_get_dir() . '/qtips/',
1425
-                EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
1424
+                $this->_get_dir().'/qtips/',
1425
+                EE_ADMIN_PAGES.basename($this->_get_dir()).'/qtips/',
1426 1426
             );
1427 1427
             EEH_Qtip_Loader::instance()->register($qtips, $path);
1428 1428
         }
@@ -1444,7 +1444,7 @@  discard block
 block discarded – undo
1444 1444
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1445 1445
         $i = 0;
1446 1446
         foreach ($this->_page_config as $slug => $config) {
1447
-            if (! is_array($config)
1447
+            if ( ! is_array($config)
1448 1448
                 || (
1449 1449
                     is_array($config)
1450 1450
                     && (
@@ -1461,12 +1461,12 @@  discard block
 block discarded – undo
1461 1461
                 // nav tab is only to appear when route requested.
1462 1462
                 continue;
1463 1463
             }
1464
-            if (! $this->check_user_access($slug, true)) {
1464
+            if ( ! $this->check_user_access($slug, true)) {
1465 1465
                 // no nav tab because current user does not have access.
1466 1466
                 continue;
1467 1467
             }
1468
-            $css_class = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
1469
-            $this->_nav_tabs[ $slug ] = array(
1468
+            $css_class = isset($config['css_class']) ? $config['css_class'].' ' : '';
1469
+            $this->_nav_tabs[$slug] = array(
1470 1470
                 'url'       => isset($config['nav']['url'])
1471 1471
                     ? $config['nav']['url']
1472 1472
                     : self::add_query_args_and_nonce(
@@ -1478,14 +1478,14 @@  discard block
 block discarded – undo
1478 1478
                     : ucwords(
1479 1479
                         str_replace('_', ' ', $slug)
1480 1480
                     ),
1481
-                'css_class' => $this->_req_action === $slug ? $css_class . 'nav-tab-active' : $css_class,
1481
+                'css_class' => $this->_req_action === $slug ? $css_class.'nav-tab-active' : $css_class,
1482 1482
                 'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
1483 1483
             );
1484 1484
             $i++;
1485 1485
         }
1486 1486
         // if $this->_nav_tabs is empty then lets set the default
1487 1487
         if (empty($this->_nav_tabs)) {
1488
-            $this->_nav_tabs[ $this->_default_nav_tab_name ] = array(
1488
+            $this->_nav_tabs[$this->_default_nav_tab_name] = array(
1489 1489
                 'url'       => $this->_admin_base_url,
1490 1490
                 'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
1491 1491
                 'css_class' => 'nav-tab-active',
@@ -1510,10 +1510,10 @@  discard block
 block discarded – undo
1510 1510
             foreach ($this->_route_config['labels'] as $label => $text) {
1511 1511
                 if (is_array($text)) {
1512 1512
                     foreach ($text as $sublabel => $subtext) {
1513
-                        $this->_labels[ $label ][ $sublabel ] = $subtext;
1513
+                        $this->_labels[$label][$sublabel] = $subtext;
1514 1514
                     }
1515 1515
                 } else {
1516
-                    $this->_labels[ $label ] = $text;
1516
+                    $this->_labels[$label] = $text;
1517 1517
                 }
1518 1518
             }
1519 1519
         }
@@ -1535,12 +1535,12 @@  discard block
 block discarded – undo
1535 1535
     {
1536 1536
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1537 1537
         $route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
1538
-        $capability = ! empty($route_to_check) && isset($this->_page_routes[ $route_to_check ])
1538
+        $capability = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check])
1539 1539
                       && is_array(
1540
-                          $this->_page_routes[ $route_to_check ]
1540
+                          $this->_page_routes[$route_to_check]
1541 1541
                       )
1542
-                      && ! empty($this->_page_routes[ $route_to_check ]['capability'])
1543
-            ? $this->_page_routes[ $route_to_check ]['capability'] : null;
1542
+                      && ! empty($this->_page_routes[$route_to_check]['capability'])
1543
+            ? $this->_page_routes[$route_to_check]['capability'] : null;
1544 1544
         if (empty($capability) && empty($route_to_check)) {
1545 1545
             $capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options'
1546 1546
                 : $this->_route['capability'];
@@ -1548,7 +1548,7 @@  discard block
 block discarded – undo
1548 1548
             $capability = empty($capability) ? 'manage_options' : $capability;
1549 1549
         }
1550 1550
         $id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
1551
-        if (! defined('DOING_AJAX')
1551
+        if ( ! defined('DOING_AJAX')
1552 1552
             && (
1553 1553
                 ! function_exists('is_admin')
1554 1554
                 || ! EE_Registry::instance()->CAP->current_user_can(
@@ -1651,17 +1651,17 @@  discard block
 block discarded – undo
1651 1651
     public function admin_footer_global()
1652 1652
     {
1653 1653
         // dialog container for dialog helper
1654
-        $d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
1654
+        $d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">'."\n";
1655 1655
         $d_cont .= '<div class="ee-notices"></div>';
1656 1656
         $d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
1657 1657
         $d_cont .= '</div>';
1658 1658
         echo $d_cont;
1659 1659
         // help tour stuff?
1660
-        if (isset($this->_help_tour[ $this->_req_action ])) {
1661
-            echo implode('<br />', $this->_help_tour[ $this->_req_action ]);
1660
+        if (isset($this->_help_tour[$this->_req_action])) {
1661
+            echo implode('<br />', $this->_help_tour[$this->_req_action]);
1662 1662
         }
1663 1663
         // current set timezone for timezone js
1664
-        echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
1664
+        echo '<span id="current_timezone" class="hidden">'.EEH_DTT_Helper::get_timezone().'</span>';
1665 1665
     }
1666 1666
 
1667 1667
 
@@ -1695,7 +1695,7 @@  discard block
 block discarded – undo
1695 1695
         // loop through the array and setup content
1696 1696
         foreach ($help_array as $trigger => $help) {
1697 1697
             // make sure the array is setup properly
1698
-            if (! isset($help['title']) || ! isset($help['content'])) {
1698
+            if ( ! isset($help['title']) || ! isset($help['content'])) {
1699 1699
                 throw new EE_Error(
1700 1700
                     esc_html__(
1701 1701
                         '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',
@@ -1710,7 +1710,7 @@  discard block
 block discarded – undo
1710 1710
                 'help_popup_content' => $help['content'],
1711 1711
             );
1712 1712
             $content .= EEH_Template::display_template(
1713
-                EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
1713
+                EE_ADMIN_TEMPLATE.'admin_help_popup.template.php',
1714 1714
                 $template_args,
1715 1715
                 true
1716 1716
             );
@@ -1732,15 +1732,15 @@  discard block
 block discarded – undo
1732 1732
     private function _get_help_content()
1733 1733
     {
1734 1734
         // what is the method we're looking for?
1735
-        $method_name = '_help_popup_content_' . $this->_req_action;
1735
+        $method_name = '_help_popup_content_'.$this->_req_action;
1736 1736
         // if method doesn't exist let's get out.
1737
-        if (! method_exists($this, $method_name)) {
1737
+        if ( ! method_exists($this, $method_name)) {
1738 1738
             return array();
1739 1739
         }
1740 1740
         // k we're good to go let's retrieve the help array
1741 1741
         $help_array = call_user_func(array($this, $method_name));
1742 1742
         // make sure we've got an array!
1743
-        if (! is_array($help_array)) {
1743
+        if ( ! is_array($help_array)) {
1744 1744
             throw new EE_Error(
1745 1745
                 esc_html__(
1746 1746
                     'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
@@ -1772,8 +1772,8 @@  discard block
 block discarded – undo
1772 1772
         // 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
1773 1773
         $help_array = $this->_get_help_content();
1774 1774
         $help_content = '';
1775
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
1776
-            $help_array[ $trigger_id ] = array(
1775
+        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
1776
+            $help_array[$trigger_id] = array(
1777 1777
                 'title'   => esc_html__('Missing Content', 'event_espresso'),
1778 1778
                 'content' => esc_html__(
1779 1779
                     '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.)',
@@ -1849,15 +1849,15 @@  discard block
 block discarded – undo
1849 1849
         // register all styles
1850 1850
         wp_register_style(
1851 1851
             'espresso-ui-theme',
1852
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
1852
+            EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
1853 1853
             array(),
1854 1854
             EVENT_ESPRESSO_VERSION
1855 1855
         );
1856
-        wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
1856
+        wp_register_style('ee-admin-css', EE_ADMIN_URL.'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
1857 1857
         // helpers styles
1858 1858
         wp_register_style(
1859 1859
             'ee-text-links',
1860
-            EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css',
1860
+            EE_PLUGIN_DIR_URL.'core/helpers/assets/ee_text_list_helper.css',
1861 1861
             array(),
1862 1862
             EVENT_ESPRESSO_VERSION
1863 1863
         );
@@ -1865,21 +1865,21 @@  discard block
 block discarded – undo
1865 1865
         // register all scripts
1866 1866
         wp_register_script(
1867 1867
             'ee-dialog',
1868
-            EE_ADMIN_URL . 'assets/ee-dialog-helper.js',
1868
+            EE_ADMIN_URL.'assets/ee-dialog-helper.js',
1869 1869
             array('jquery', 'jquery-ui-draggable'),
1870 1870
             EVENT_ESPRESSO_VERSION,
1871 1871
             true
1872 1872
         );
1873 1873
         wp_register_script(
1874 1874
             'ee_admin_js',
1875
-            EE_ADMIN_URL . 'assets/ee-admin-page.js',
1875
+            EE_ADMIN_URL.'assets/ee-admin-page.js',
1876 1876
             array('espresso_core', 'ee-parse-uri', 'ee-dialog'),
1877 1877
             EVENT_ESPRESSO_VERSION,
1878 1878
             true
1879 1879
         );
1880 1880
         wp_register_script(
1881 1881
             'jquery-ui-timepicker-addon',
1882
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js',
1882
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery-ui-timepicker-addon.js',
1883 1883
             array('jquery-ui-datepicker', 'jquery-ui-slider'),
1884 1884
             EVENT_ESPRESSO_VERSION,
1885 1885
             true
@@ -1888,7 +1888,7 @@  discard block
 block discarded – undo
1888 1888
         // script for sorting tables
1889 1889
         wp_register_script(
1890 1890
             'espresso_ajax_table_sorting',
1891
-            EE_ADMIN_URL . 'assets/espresso_ajax_table_sorting.js',
1891
+            EE_ADMIN_URL.'assets/espresso_ajax_table_sorting.js',
1892 1892
             array('ee_admin_js', 'jquery-ui-sortable'),
1893 1893
             EVENT_ESPRESSO_VERSION,
1894 1894
             true
@@ -1896,7 +1896,7 @@  discard block
 block discarded – undo
1896 1896
         // script for parsing uri's
1897 1897
         wp_register_script(
1898 1898
             'ee-parse-uri',
1899
-            EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js',
1899
+            EE_GLOBAL_ASSETS_URL.'scripts/parseuri.js',
1900 1900
             array(),
1901 1901
             EVENT_ESPRESSO_VERSION,
1902 1902
             true
@@ -1904,7 +1904,7 @@  discard block
 block discarded – undo
1904 1904
         // and parsing associative serialized form elements
1905 1905
         wp_register_script(
1906 1906
             'ee-serialize-full-array',
1907
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js',
1907
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery.serializefullarray.js',
1908 1908
             array('jquery'),
1909 1909
             EVENT_ESPRESSO_VERSION,
1910 1910
             true
@@ -1912,28 +1912,28 @@  discard block
 block discarded – undo
1912 1912
         // helpers scripts
1913 1913
         wp_register_script(
1914 1914
             'ee-text-links',
1915
-            EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js',
1915
+            EE_PLUGIN_DIR_URL.'core/helpers/assets/ee_text_list_helper.js',
1916 1916
             array('jquery'),
1917 1917
             EVENT_ESPRESSO_VERSION,
1918 1918
             true
1919 1919
         );
1920 1920
         wp_register_script(
1921 1921
             'ee-moment-core',
1922
-            EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js',
1922
+            EE_THIRD_PARTY_URL.'moment/moment-with-locales.min.js',
1923 1923
             array(),
1924 1924
             EVENT_ESPRESSO_VERSION,
1925 1925
             true
1926 1926
         );
1927 1927
         wp_register_script(
1928 1928
             'ee-moment',
1929
-            EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js',
1929
+            EE_THIRD_PARTY_URL.'moment/moment-timezone-with-data.min.js',
1930 1930
             array('ee-moment-core'),
1931 1931
             EVENT_ESPRESSO_VERSION,
1932 1932
             true
1933 1933
         );
1934 1934
         wp_register_script(
1935 1935
             'ee-datepicker',
1936
-            EE_ADMIN_URL . 'assets/ee-datepicker.js',
1936
+            EE_ADMIN_URL.'assets/ee-datepicker.js',
1937 1937
             array('jquery-ui-timepicker-addon', 'ee-moment'),
1938 1938
             EVENT_ESPRESSO_VERSION,
1939 1939
             true
@@ -1967,11 +1967,11 @@  discard block
 block discarded – undo
1967 1967
         /**
1968 1968
          * help tour stuff
1969 1969
          */
1970
-        if (! empty($this->_help_tour)) {
1970
+        if ( ! empty($this->_help_tour)) {
1971 1971
             // register the js for kicking things off
1972 1972
             wp_enqueue_script(
1973 1973
                 'ee-help-tour',
1974
-                EE_ADMIN_URL . 'assets/ee-help-tour.js',
1974
+                EE_ADMIN_URL.'assets/ee-help-tour.js',
1975 1975
                 array('jquery-joyride'),
1976 1976
                 EVENT_ESPRESSO_VERSION,
1977 1977
                 true
@@ -2068,12 +2068,12 @@  discard block
 block discarded – undo
2068 2068
     protected function _set_list_table()
2069 2069
     {
2070 2070
         // first is this a list_table view?
2071
-        if (! isset($this->_route_config['list_table'])) {
2071
+        if ( ! isset($this->_route_config['list_table'])) {
2072 2072
             return;
2073 2073
         } //not a list_table view so get out.
2074 2074
         // list table functions are per view specific (because some admin pages might have more than one list table!)
2075
-        $list_table_view = '_set_list_table_views_' . $this->_req_action;
2076
-        if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
2075
+        $list_table_view = '_set_list_table_views_'.$this->_req_action;
2076
+        if ( ! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
2077 2077
             // user error msg
2078 2078
             $error_msg = esc_html__(
2079 2079
                 'An error occurred. The requested list table views could not be found.',
@@ -2093,10 +2093,10 @@  discard block
 block discarded – undo
2093 2093
         }
2094 2094
         // let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
2095 2095
         $this->_views = apply_filters(
2096
-            'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
2096
+            'FHEE_list_table_views_'.$this->page_slug.'_'.$this->_req_action,
2097 2097
             $this->_views
2098 2098
         );
2099
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
2099
+        $this->_views = apply_filters('FHEE_list_table_views_'.$this->page_slug, $this->_views);
2100 2100
         $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
2101 2101
         $this->_set_list_table_view();
2102 2102
         $this->_set_list_table_object();
@@ -2112,7 +2112,7 @@  discard block
 block discarded – undo
2112 2112
     {
2113 2113
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2114 2114
         // looking at active items or dumpster diving ?
2115
-        if (! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
2115
+        if ( ! isset($this->_req_data['status']) || ! array_key_exists($this->_req_data['status'], $this->_views)) {
2116 2116
             $this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
2117 2117
         } else {
2118 2118
             $this->_view = sanitize_key($this->_req_data['status']);
@@ -2133,7 +2133,7 @@  discard block
 block discarded – undo
2133 2133
     protected function _set_list_table_object()
2134 2134
     {
2135 2135
         if (isset($this->_route_config['list_table'])) {
2136
-            if (! class_exists($this->_route_config['list_table'])) {
2136
+            if ( ! class_exists($this->_route_config['list_table'])) {
2137 2137
                 throw new EE_Error(
2138 2138
                     sprintf(
2139 2139
                         esc_html__(
@@ -2171,15 +2171,15 @@  discard block
 block discarded – undo
2171 2171
         foreach ($this->_views as $key => $view) {
2172 2172
             $query_args = array();
2173 2173
             // check for current view
2174
-            $this->_views[ $key ]['class'] = $this->_view === $view['slug'] ? 'current' : '';
2174
+            $this->_views[$key]['class'] = $this->_view === $view['slug'] ? 'current' : '';
2175 2175
             $query_args['action'] = $this->_req_action;
2176
-            $query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
2176
+            $query_args[$this->_req_action.'_nonce'] = wp_create_nonce($query_args['action'].'_nonce');
2177 2177
             $query_args['status'] = $view['slug'];
2178 2178
             // merge any other arguments sent in.
2179
-            if (isset($extra_query_args[ $view['slug'] ])) {
2180
-                $query_args = array_merge($query_args, $extra_query_args[ $view['slug'] ]);
2179
+            if (isset($extra_query_args[$view['slug']])) {
2180
+                $query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
2181 2181
             }
2182
-            $this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
2182
+            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
2183 2183
         }
2184 2184
         return $this->_views;
2185 2185
     }
@@ -2198,7 +2198,7 @@  discard block
 block discarded – undo
2198 2198
     {
2199 2199
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2200 2200
         $values = array(10, 25, 50, 100);
2201
-        $per_page = (! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
2201
+        $per_page = ( ! empty($this->_req_data['per_page'])) ? absint($this->_req_data['per_page']) : 10;
2202 2202
         if ($max_entries) {
2203 2203
             $values[] = $max_entries;
2204 2204
             sort($values);
@@ -2210,14 +2210,14 @@  discard block
 block discarded – undo
2210 2210
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
2211 2211
         foreach ($values as $value) {
2212 2212
             if ($value < $max_entries) {
2213
-                $selected = $value === $per_page ? ' selected="' . $per_page . '"' : '';
2213
+                $selected = $value === $per_page ? ' selected="'.$per_page.'"' : '';
2214 2214
                 $entries_per_page_dropdown .= '
2215
-						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
2215
+						<option value="' . $value.'"'.$selected.'>'.$value.'&nbsp;&nbsp;</option>';
2216 2216
             }
2217 2217
         }
2218
-        $selected = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
2218
+        $selected = $max_entries === $per_page ? ' selected="'.$per_page.'"' : '';
2219 2219
         $entries_per_page_dropdown .= '
2220
-						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
2220
+						<option value="' . $max_entries.'"'.$selected.'>All&nbsp;&nbsp;</option>';
2221 2221
         $entries_per_page_dropdown .= '
2222 2222
 					</select>
2223 2223
 					entries
@@ -2241,7 +2241,7 @@  discard block
 block discarded – undo
2241 2241
             empty($this->_search_btn_label) ? $this->page_label
2242 2242
                 : $this->_search_btn_label
2243 2243
         );
2244
-        $this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
2244
+        $this->_template_args['search']['callback'] = 'search_'.$this->page_slug;
2245 2245
     }
2246 2246
 
2247 2247
 
@@ -2327,7 +2327,7 @@  discard block
 block discarded – undo
2327 2327
             $total_columns = ! empty($screen_columns)
2328 2328
                 ? $screen_columns
2329 2329
                 : $this->_route_config['columns'][1];
2330
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
2330
+            $this->_template_args['current_screen_widget_class'] = 'columns-'.$total_columns;
2331 2331
             $this->_template_args['current_page'] = $this->_wp_page_slug;
2332 2332
             $this->_template_args['screen'] = $this->_current_screen;
2333 2333
             $this->_column_template_path = EE_ADMIN_TEMPLATE
@@ -2372,7 +2372,7 @@  discard block
 block discarded – undo
2372 2372
      */
2373 2373
     protected function _espresso_ratings_request()
2374 2374
     {
2375
-        if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
2375
+        if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
2376 2376
             return;
2377 2377
         }
2378 2378
         $ratings_box_title = apply_filters(
@@ -2400,7 +2400,7 @@  discard block
 block discarded – undo
2400 2400
     public function espresso_ratings_request()
2401 2401
     {
2402 2402
         EEH_Template::display_template(
2403
-            EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php',
2403
+            EE_ADMIN_TEMPLATE.'espresso_ratings_request_content.template.php',
2404 2404
             array()
2405 2405
         );
2406 2406
     }
@@ -2413,17 +2413,17 @@  discard block
 block discarded – undo
2413 2413
                    . '</p><p class="hide-if-js">'
2414 2414
                    . esc_html__('This widget requires JavaScript.', 'event_espresso')
2415 2415
                    . '</p>';
2416
-        $pre = '<div class="espresso-rss-display">' . "\n\t";
2417
-        $pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
2418
-        $post = '</div>' . "\n";
2419
-        $cache_key = 'ee_rss_' . md5($rss_id);
2416
+        $pre = '<div class="espresso-rss-display">'."\n\t";
2417
+        $pre .= '<span id="'.$rss_id.'_url" class="hidden">'.$url.'</span>';
2418
+        $post = '</div>'."\n";
2419
+        $cache_key = 'ee_rss_'.md5($rss_id);
2420 2420
         $output = get_transient($cache_key);
2421 2421
         if ($output !== false) {
2422
-            echo $pre . $output . $post;
2422
+            echo $pre.$output.$post;
2423 2423
             return true;
2424 2424
         }
2425
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
2426
-            echo $pre . $loading . $post;
2425
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
2426
+            echo $pre.$loading.$post;
2427 2427
             return false;
2428 2428
         }
2429 2429
         ob_start();
@@ -2490,19 +2490,19 @@  discard block
 block discarded – undo
2490 2490
     public function espresso_sponsors_post_box()
2491 2491
     {
2492 2492
         EEH_Template::display_template(
2493
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
2493
+            EE_ADMIN_TEMPLATE.'admin_general_metabox_contents_espresso_sponsors.template.php'
2494 2494
         );
2495 2495
     }
2496 2496
 
2497 2497
 
2498 2498
     private function _publish_post_box()
2499 2499
     {
2500
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
2500
+        $meta_box_ref = 'espresso_'.$this->page_slug.'_editor_overview';
2501 2501
         // if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array
2502 2502
         // then we'll use that for the metabox label.
2503 2503
         // Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
2504
-        if (! empty($this->_labels['publishbox'])) {
2505
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][ $this->_req_action ]
2504
+        if ( ! empty($this->_labels['publishbox'])) {
2505
+            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action]
2506 2506
                 : $this->_labels['publishbox'];
2507 2507
         } else {
2508 2508
             $box_label = esc_html__('Publish', 'event_espresso');
@@ -2531,7 +2531,7 @@  discard block
 block discarded – undo
2531 2531
             ? $this->_template_args['publish_box_extra_content']
2532 2532
             : '';
2533 2533
         echo EEH_Template::display_template(
2534
-            EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
2534
+            EE_ADMIN_TEMPLATE.'admin_details_publish_metabox.template.php',
2535 2535
             $this->_template_args,
2536 2536
             true
2537 2537
         );
@@ -2623,8 +2623,8 @@  discard block
 block discarded – undo
2623 2623
             );
2624 2624
         }
2625 2625
         $this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
2626
-        if (! empty($name) && ! empty($id)) {
2627
-            $hidden_field_arr[ $name ] = array(
2626
+        if ( ! empty($name) && ! empty($id)) {
2627
+            $hidden_field_arr[$name] = array(
2628 2628
                 'type'  => 'hidden',
2629 2629
                 'value' => $id,
2630 2630
             );
@@ -2634,7 +2634,7 @@  discard block
 block discarded – undo
2634 2634
         }
2635 2635
         // add hidden field
2636 2636
         $this->_template_args['publish_hidden_fields'] = is_array($hf) && ! empty($name)
2637
-            ? $hf[ $name ]['field']
2637
+            ? $hf[$name]['field']
2638 2638
             : $hf;
2639 2639
     }
2640 2640
 
@@ -2736,7 +2736,7 @@  discard block
 block discarded – undo
2736 2736
         }
2737 2737
         // 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)
2738 2738
         $call_back_func = $create_func
2739
-            ? function ($post, $metabox) {
2739
+            ? function($post, $metabox) {
2740 2740
                 do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2741 2741
                 echo EEH_Template::display_template(
2742 2742
                     $metabox['args']['template_path'],
@@ -2746,7 +2746,7 @@  discard block
 block discarded – undo
2746 2746
             }
2747 2747
             : $callback;
2748 2748
         add_meta_box(
2749
-            str_replace('_', '-', $action) . '-mbox',
2749
+            str_replace('_', '-', $action).'-mbox',
2750 2750
             $title,
2751 2751
             $call_back_func,
2752 2752
             $this->_wp_page_slug,
@@ -2838,9 +2838,9 @@  discard block
 block discarded – undo
2838 2838
             : 'espresso-default-admin';
2839 2839
         $template_path = $sidebar
2840 2840
             ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
2841
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
2841
+            : EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar.template.php';
2842 2842
         if (defined('DOING_AJAX') && DOING_AJAX) {
2843
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
2843
+            $template_path = EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar_ajax.template.php';
2844 2844
         }
2845 2845
         $template_path = ! empty($this->_column_template_path)
2846 2846
             ? $this->_column_template_path : $template_path;
@@ -2905,7 +2905,7 @@  discard block
 block discarded – undo
2905 2905
             )
2906 2906
             : $this->_template_args['preview_action_button'];
2907 2907
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
2908
-            EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
2908
+            EE_ADMIN_TEMPLATE.'admin_caf_full_page_preview.template.php',
2909 2909
             $this->_template_args,
2910 2910
             true
2911 2911
         );
@@ -2954,7 +2954,7 @@  discard block
 block discarded – undo
2954 2954
         // setup search attributes
2955 2955
         $this->_set_search_attributes();
2956 2956
         $this->_template_args['current_page'] = $this->_wp_page_slug;
2957
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
2957
+        $template_path = EE_ADMIN_TEMPLATE.'admin_list_wrapper.template.php';
2958 2958
         $this->_template_args['table_url'] = defined('DOING_AJAX')
2959 2959
             ? add_query_arg(array('noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url)
2960 2960
             : add_query_arg(array('route' => $this->_req_action), $this->_admin_base_url);
@@ -2962,10 +2962,10 @@  discard block
 block discarded – undo
2962 2962
         $this->_template_args['current_route'] = $this->_req_action;
2963 2963
         $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
2964 2964
         $ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
2965
-        if (! empty($ajax_sorting_callback)) {
2965
+        if ( ! empty($ajax_sorting_callback)) {
2966 2966
             $sortable_list_table_form_fields = wp_nonce_field(
2967
-                $ajax_sorting_callback . '_nonce',
2968
-                $ajax_sorting_callback . '_nonce',
2967
+                $ajax_sorting_callback.'_nonce',
2968
+                $ajax_sorting_callback.'_nonce',
2969 2969
                 false,
2970 2970
                 false
2971 2971
             );
@@ -2982,7 +2982,7 @@  discard block
 block discarded – undo
2982 2982
         $hidden_form_fields = isset($this->_template_args['list_table_hidden_fields'])
2983 2983
             ? $this->_template_args['list_table_hidden_fields']
2984 2984
             : '';
2985
-        $nonce_ref = $this->_req_action . '_nonce';
2985
+        $nonce_ref = $this->_req_action.'_nonce';
2986 2986
         $hidden_form_fields .= '<input type="hidden" name="'
2987 2987
                                . $nonce_ref
2988 2988
                                . '" value="'
@@ -2991,10 +2991,10 @@  discard block
 block discarded – undo
2991 2991
         $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
2992 2992
         // display message about search results?
2993 2993
         $this->_template_args['before_list_table'] .= ! empty($this->_req_data['s'])
2994
-            ? '<p class="ee-search-results">' . sprintf(
2994
+            ? '<p class="ee-search-results">'.sprintf(
2995 2995
                 esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
2996 2996
                 trim($this->_req_data['s'], '%')
2997
-            ) . '</p>'
2997
+            ).'</p>'
2998 2998
             : '';
2999 2999
         // filter before_list_table template arg
3000 3000
         $this->_template_args['before_list_table'] = apply_filters(
@@ -3075,7 +3075,7 @@  discard block
 block discarded – undo
3075 3075
             $this
3076 3076
         );
3077 3077
         return EEH_Template::display_template(
3078
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
3078
+            EE_ADMIN_TEMPLATE.'admin_details_legend.template.php',
3079 3079
             $this->_template_args,
3080 3080
             true
3081 3081
         );
@@ -3298,17 +3298,17 @@  discard block
 block discarded – undo
3298 3298
         // add in a hidden index for the current page (so save and close redirects properly)
3299 3299
         $this->_template_args['save_buttons'] = $referrer_url;
3300 3300
         foreach ($button_text as $key => $button) {
3301
-            $ref = $default_names[ $key ];
3301
+            $ref = $default_names[$key];
3302 3302
             $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary '
3303 3303
                                                      . $ref
3304 3304
                                                      . '" value="'
3305 3305
                                                      . $button
3306 3306
                                                      . '" name="'
3307
-                                                     . (! empty($actions) ? $actions[ $key ] : $ref)
3307
+                                                     . ( ! empty($actions) ? $actions[$key] : $ref)
3308 3308
                                                      . '" id="'
3309
-                                                     . $this->_current_view . '_' . $ref
3309
+                                                     . $this->_current_view.'_'.$ref
3310 3310
                                                      . '" />';
3311
-            if (! $both) {
3311
+            if ( ! $both) {
3312 3312
                 break;
3313 3313
             }
3314 3314
         }
@@ -3343,13 +3343,13 @@  discard block
 block discarded – undo
3343 3343
                 'An error occurred. No action was set for this page\'s form.',
3344 3344
                 'event_espresso'
3345 3345
             );
3346
-            $dev_msg = $user_msg . "\n"
3346
+            $dev_msg = $user_msg."\n"
3347 3347
                        . sprintf(
3348 3348
                            esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
3349 3349
                            __FUNCTION__,
3350 3350
                            __CLASS__
3351 3351
                        );
3352
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
3352
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
3353 3353
         }
3354 3354
         // open form
3355 3355
         $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="'
@@ -3358,8 +3358,8 @@  discard block
 block discarded – undo
3358 3358
                                                              . $route
3359 3359
                                                              . '_event_form" >';
3360 3360
         // add nonce
3361
-        $nonce = wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
3362
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
3361
+        $nonce = wp_nonce_field($route.'_nonce', $route.'_nonce', false, false);
3362
+        $this->_template_args['before_admin_page_content'] .= "\n\t".$nonce;
3363 3363
         // add REQUIRED form action
3364 3364
         $hidden_fields = array(
3365 3365
             'action' => array('type' => 'hidden', 'value' => $route),
@@ -3372,7 +3372,7 @@  discard block
 block discarded – undo
3372 3372
         $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
3373 3373
         // add fields to form
3374 3374
         foreach ((array) $form_fields as $field_name => $form_field) {
3375
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
3375
+            $this->_template_args['before_admin_page_content'] .= "\n\t".$form_field['field'];
3376 3376
         }
3377 3377
         // close form
3378 3378
         $this->_template_args['after_admin_page_content'] = '</form>';
@@ -3438,10 +3438,10 @@  discard block
 block discarded – undo
3438 3438
         $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
3439 3439
         $notices = EE_Error::get_notices(false);
3440 3440
         // overwrite default success messages //BUT ONLY if overwrite not overridden
3441
-        if (! $override_overwrite || ! empty($notices['errors'])) {
3441
+        if ( ! $override_overwrite || ! empty($notices['errors'])) {
3442 3442
             EE_Error::overwrite_success();
3443 3443
         }
3444
-        if (! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
3444
+        if ( ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
3445 3445
             // how many records affected ? more than one record ? or just one ?
3446 3446
             if ($success > 1) {
3447 3447
                 // set plural msg
@@ -3470,7 +3470,7 @@  discard block
 block discarded – undo
3470 3470
             }
3471 3471
         }
3472 3472
         // check that $query_args isn't something crazy
3473
-        if (! is_array($query_args)) {
3473
+        if ( ! is_array($query_args)) {
3474 3474
             $query_args = array();
3475 3475
         }
3476 3476
         /**
@@ -3495,7 +3495,7 @@  discard block
 block discarded – undo
3495 3495
             $redirect_url = admin_url('admin.php');
3496 3496
         }
3497 3497
         // merge any default query_args set in _default_route_query_args property
3498
-        if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
3498
+        if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
3499 3499
             $args_to_merge = array();
3500 3500
             foreach ($this->_default_route_query_args as $query_param => $query_value) {
3501 3501
                 // is there a wp_referer array in our _default_route_query_args property?
@@ -3507,15 +3507,15 @@  discard block
 block discarded – undo
3507 3507
                         }
3508 3508
                         // finally we will override any arguments in the referer with
3509 3509
                         // what might be set on the _default_route_query_args array.
3510
-                        if (isset($this->_default_route_query_args[ $reference ])) {
3511
-                            $args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
3510
+                        if (isset($this->_default_route_query_args[$reference])) {
3511
+                            $args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
3512 3512
                         } else {
3513
-                            $args_to_merge[ $reference ] = urlencode($value);
3513
+                            $args_to_merge[$reference] = urlencode($value);
3514 3514
                         }
3515 3515
                     }
3516 3516
                     continue;
3517 3517
                 }
3518
-                $args_to_merge[ $query_param ] = $query_value;
3518
+                $args_to_merge[$query_param] = $query_value;
3519 3519
             }
3520 3520
             // now let's merge these arguments but override with what was specifically sent in to the
3521 3521
             // redirect.
@@ -3527,13 +3527,13 @@  discard block
 block discarded – undo
3527 3527
         if (isset($query_args['action'])) {
3528 3528
             // manually generate wp_nonce and merge that with the query vars
3529 3529
             // becuz the wp_nonce_url function wrecks havoc on some vars
3530
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
3530
+            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'].'_nonce');
3531 3531
         }
3532 3532
         // we're adding some hooks and filters in here for processing any things just before redirects
3533 3533
         // (example: an admin page has done an insert or update and we want to run something after that).
3534
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
3534
+        do_action('AHEE_redirect_'.$classname.$this->_req_action, $query_args);
3535 3535
         $redirect_url = apply_filters(
3536
-            'FHEE_redirect_' . $classname . $this->_req_action,
3536
+            'FHEE_redirect_'.$classname.$this->_req_action,
3537 3537
             self::add_query_args_and_nonce($query_args, $redirect_url),
3538 3538
             $query_args
3539 3539
         );
@@ -3586,7 +3586,7 @@  discard block
 block discarded – undo
3586 3586
         }
3587 3587
         $this->_template_args['notices'] = EE_Error::get_notices();
3588 3588
         // IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
3589
-        if (! defined('DOING_AJAX') || $sticky_notices) {
3589
+        if ( ! defined('DOING_AJAX') || $sticky_notices) {
3590 3590
             $route = isset($query_args['action']) ? $query_args['action'] : 'default';
3591 3591
             $this->_add_transient(
3592 3592
                 $route,
@@ -3626,7 +3626,7 @@  discard block
 block discarded – undo
3626 3626
         $exclude_nonce = false
3627 3627
     ) {
3628 3628
         // first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
3629
-        if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
3629
+        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
3630 3630
             throw new EE_Error(
3631 3631
                 sprintf(
3632 3632
                     esc_html__(
@@ -3637,7 +3637,7 @@  discard block
 block discarded – undo
3637 3637
                 )
3638 3638
             );
3639 3639
         }
3640
-        if (! isset($this->_labels['buttons'][ $type ])) {
3640
+        if ( ! isset($this->_labels['buttons'][$type])) {
3641 3641
             throw new EE_Error(
3642 3642
                 sprintf(
3643 3643
                     __(
@@ -3650,7 +3650,7 @@  discard block
 block discarded – undo
3650 3650
         }
3651 3651
         // finally check user access for this button.
3652 3652
         $has_access = $this->check_user_access($action, true);
3653
-        if (! $has_access) {
3653
+        if ( ! $has_access) {
3654 3654
             return '';
3655 3655
         }
3656 3656
         $_base_url = ! $base_url ? $this->_admin_base_url : $base_url;
@@ -3658,11 +3658,11 @@  discard block
 block discarded – undo
3658 3658
             'action' => $action,
3659 3659
         );
3660 3660
         // merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
3661
-        if (! empty($extra_request)) {
3661
+        if ( ! empty($extra_request)) {
3662 3662
             $query_args = array_merge($extra_request, $query_args);
3663 3663
         }
3664 3664
         $url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
3665
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
3665
+        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
3666 3666
     }
3667 3667
 
3668 3668
 
@@ -3688,7 +3688,7 @@  discard block
 block discarded – undo
3688 3688
                 'FHEE__EE_Admin_Page___per_page_screen_options__default',
3689 3689
                 20
3690 3690
             ),
3691
-            'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
3691
+            'option'  => $this->_current_page.'_'.$this->_current_view.'_per_page',
3692 3692
         );
3693 3693
         // ONLY add the screen option if the user has access to it.
3694 3694
         if ($this->check_user_access($this->_current_view, true)) {
@@ -3709,7 +3709,7 @@  discard block
 block discarded – undo
3709 3709
     {
3710 3710
         if (isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options'])) {
3711 3711
             check_admin_referer('screen-options-nonce', 'screenoptionnonce');
3712
-            if (! $user = wp_get_current_user()) {
3712
+            if ( ! $user = wp_get_current_user()) {
3713 3713
                 return;
3714 3714
             }
3715 3715
             $option = $_POST['wp_screen_options']['option'];
@@ -3720,7 +3720,7 @@  discard block
 block discarded – undo
3720 3720
             $map_option = $option;
3721 3721
             $option = str_replace('-', '_', $option);
3722 3722
             switch ($map_option) {
3723
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
3723
+                case $this->_current_page.'_'.$this->_current_view.'_per_page':
3724 3724
                     $value = (int) $value;
3725 3725
                     $max_value = apply_filters(
3726 3726
                         'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
@@ -3778,13 +3778,13 @@  discard block
 block discarded – undo
3778 3778
     protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
3779 3779
     {
3780 3780
         $user_id = get_current_user_id();
3781
-        if (! $skip_route_verify) {
3781
+        if ( ! $skip_route_verify) {
3782 3782
             $this->_verify_route($route);
3783 3783
         }
3784 3784
         // now let's set the string for what kind of transient we're setting
3785 3785
         $transient = $notices
3786
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
3787
-            : 'rte_tx_' . $route . '_' . $user_id;
3786
+            ? 'ee_rte_n_tx_'.$route.'_'.$user_id
3787
+            : 'rte_tx_'.$route.'_'.$user_id;
3788 3788
         $data = $notices ? array('notices' => $data) : $data;
3789 3789
         // is there already a transient for this route?  If there is then let's ADD to that transient
3790 3790
         $existing = is_multisite() && is_network_admin()
@@ -3813,8 +3813,8 @@  discard block
 block discarded – undo
3813 3813
         $user_id = get_current_user_id();
3814 3814
         $route = ! $route ? $this->_req_action : $route;
3815 3815
         $transient = $notices
3816
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
3817
-            : 'rte_tx_' . $route . '_' . $user_id;
3816
+            ? 'ee_rte_n_tx_'.$route.'_'.$user_id
3817
+            : 'rte_tx_'.$route.'_'.$user_id;
3818 3818
         $data = is_multisite() && is_network_admin()
3819 3819
             ? get_site_transient($transient)
3820 3820
             : get_transient($transient);
@@ -4033,7 +4033,7 @@  discard block
 block discarded – undo
4033 4033
      */
4034 4034
     protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
4035 4035
     {
4036
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
4036
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
4037 4037
     }
4038 4038
 
4039 4039
 
@@ -4046,7 +4046,7 @@  discard block
 block discarded – undo
4046 4046
      */
4047 4047
     protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
4048 4048
     {
4049
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
4049
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
4050 4050
     }
4051 4051
 
4052 4052
 
Please login to merge, or discard this patch.
core/admin/EE_Admin.core.php 2 patches
Indentation   +987 added lines, -987 removed lines patch added patch discarded remove patch
@@ -20,487 +20,487 @@  discard block
 block discarded – undo
20 20
 final class EE_Admin implements InterminableInterface
21 21
 {
22 22
 
23
-    /**
24
-     * @var EE_Admin $_instance
25
-     */
26
-    private static $_instance;
27
-
28
-    /**
29
-     * @var PersistentAdminNoticeManager $persistent_admin_notice_manager
30
-     */
31
-    private $persistent_admin_notice_manager;
32
-
33
-    /**
34
-     * @var LoaderInterface
35
-     */
36
-    protected $loader;
37
-
38
-    /**
39
-     * @singleton method used to instantiate class object
40
-     * @return EE_Admin
41
-     * @throws EE_Error
42
-     */
43
-    public static function instance()
44
-    {
45
-        // check if class object is instantiated
46
-        if (! self::$_instance instanceof EE_Admin) {
47
-            self::$_instance = new self();
48
-        }
49
-        return self::$_instance;
50
-    }
51
-
52
-
53
-    /**
54
-     * @return EE_Admin
55
-     * @throws EE_Error
56
-     */
57
-    public static function reset()
58
-    {
59
-        self::$_instance = null;
60
-        return self::instance();
61
-    }
62
-
63
-
64
-    /**
65
-     * class constructor
66
-     *
67
-     * @throws EE_Error
68
-     * @throws InvalidDataTypeException
69
-     * @throws InvalidInterfaceException
70
-     * @throws InvalidArgumentException
71
-     */
72
-    protected function __construct()
73
-    {
74
-        // define global EE_Admin constants
75
-        $this->_define_all_constants();
76
-        // set autoloaders for our admin page classes based on included path information
77
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
78
-        // admin hooks
79
-        add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
80
-        // load EE_Request_Handler early
81
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
82
-        add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
83
-        add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
84
-        add_action('wp_loaded', array($this, 'wp_loaded'), 100);
85
-        add_action('admin_init', array($this, 'admin_init'), 100);
86
-        add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
87
-        add_action('admin_notices', array($this, 'display_admin_notices'), 10);
88
-        add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
89
-        add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
90
-        add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
91
-        add_action('load-plugins.php', array($this, 'hookIntoWpPluginsPage'));
92
-        add_action('display_post_states', array($this, 'displayStateForCriticalPages'), 10, 2);
93
-        // reset Environment config (we only do this on admin page loads);
94
-        EE_Registry::instance()->CFG->environment->recheck_values();
95
-        do_action('AHEE__EE_Admin__loaded');
96
-    }
97
-
98
-
99
-    /**
100
-     * _define_all_constants
101
-     * define constants that are set globally for all admin pages
102
-     *
103
-     * @return void
104
-     */
105
-    private function _define_all_constants()
106
-    {
107
-        if (! defined('EE_ADMIN_URL')) {
108
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
109
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
110
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS);
111
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
112
-            define('WP_AJAX_URL', admin_url('admin-ajax.php'));
113
-        }
114
-    }
115
-
116
-
117
-    /**
118
-     * filter_plugin_actions - adds links to the Plugins page listing
119
-     *
120
-     * @param    array  $links
121
-     * @param    string $plugin
122
-     * @return    array
123
-     */
124
-    public function filter_plugin_actions($links, $plugin)
125
-    {
126
-        // set $main_file in stone
127
-        static $main_file;
128
-        // if $main_file is not set yet
129
-        if (! $main_file) {
130
-            $main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
131
-        }
132
-        if ($plugin === $main_file) {
133
-            // compare current plugin to this one
134
-            if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
135
-                $maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
136
-                                    . ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
137
-                                    . esc_html__('Maintenance Mode Active', 'event_espresso')
138
-                                    . '</a>';
139
-                array_unshift($links, $maintenance_link);
140
-            } else {
141
-                $org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
142
-                                     . esc_html__('Settings', 'event_espresso')
143
-                                     . '</a>';
144
-                $events_link = '<a href="admin.php?page=espresso_events">'
145
-                               . esc_html__('Events', 'event_espresso')
146
-                               . '</a>';
147
-                // add before other links
148
-                array_unshift($links, $org_settings_link, $events_link);
149
-            }
150
-        }
151
-        return $links;
152
-    }
153
-
154
-
155
-    /**
156
-     * _get_request
157
-     *
158
-     * @return void
159
-     * @throws EE_Error
160
-     * @throws InvalidArgumentException
161
-     * @throws InvalidDataTypeException
162
-     * @throws InvalidInterfaceException
163
-     * @throws ReflectionException
164
-     */
165
-    public function get_request()
166
-    {
167
-        EE_Registry::instance()->load_core('Request_Handler');
168
-    }
169
-
170
-
171
-    /**
172
-     * hide_admin_pages_except_maintenance_mode
173
-     *
174
-     * @param array $admin_page_folder_names
175
-     * @return array
176
-     */
177
-    public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
178
-    {
179
-        return array(
180
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
181
-            'about'       => EE_ADMIN_PAGES . 'about' . DS,
182
-            'support'     => EE_ADMIN_PAGES . 'support' . DS,
183
-        );
184
-    }
185
-
186
-
187
-    /**
188
-     * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
189
-     * EE_Front_Controller's init phases have run
190
-     *
191
-     * @return void
192
-     * @throws EE_Error
193
-     * @throws InvalidArgumentException
194
-     * @throws InvalidDataTypeException
195
-     * @throws InvalidInterfaceException
196
-     * @throws ReflectionException
197
-     * @throws ServiceNotFoundException
198
-     */
199
-    public function init()
200
-    {
201
-        // only enable most of the EE_Admin IF we're not in full maintenance mode
202
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
203
-            $this->initModelsReady();
204
-        }
205
-        // run the admin page factory but ONLY if we are doing an ee admin ajax request
206
-        if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
207
-            try {
208
-                // this loads the controller for the admin pages which will setup routing etc
209
-                EE_Registry::instance()->load_core('Admin_Page_Loader');
210
-            } catch (EE_Error $e) {
211
-                $e->get_error();
212
-            }
213
-        }
214
-        add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
215
-        // make sure our CPTs and custom taxonomy metaboxes get shown for first time users
216
-        add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
217
-        add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
218
-        // exclude EE critical pages from all nav menus and wp_list_pages
219
-        add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
220
-    }
221
-
222
-
223
-    /**
224
-     * Gets the loader (and if it wasn't previously set, sets it)
225
-     * @return LoaderInterface
226
-     * @throws InvalidArgumentException
227
-     * @throws InvalidDataTypeException
228
-     * @throws InvalidInterfaceException
229
-     */
230
-    protected function getLoader()
231
-    {
232
-        if (! $this->loader instanceof LoaderInterface) {
233
-            $this->loader = LoaderFactory::getLoader();
234
-        }
235
-        return $this->loader;
236
-    }
237
-
238
-
239
-    /**
240
-     * Method that's fired on admin requests (including admin ajax) but only when the models are usable
241
-     * (ie, the site isn't in maintenance mode)
242
-     * @since 4.9.63.p
243
-     * @return void
244
-     */
245
-    protected function initModelsReady()
246
-    {
247
-        // ok so we want to enable the entire admin
248
-        $this->persistent_admin_notice_manager = $this->getLoader()->getShared(
249
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
250
-        );
251
-        $this->persistent_admin_notice_manager->setReturnUrl(
252
-            EE_Admin_Page::add_query_args_and_nonce(
253
-                array(
254
-                    'page'   => EE_Registry::instance()->REQ->get('page', ''),
255
-                    'action' => EE_Registry::instance()->REQ->get('action', ''),
256
-                ),
257
-                EE_ADMIN_URL
258
-            )
259
-        );
260
-        $this->maybeSetDatetimeWarningNotice();
261
-        // at a glance dashboard widget
262
-        add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
263
-        // filter for get_edit_post_link used on comments for custom post types
264
-        add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
265
-    }
266
-
267
-
268
-    /**
269
-     *    get_persistent_admin_notices
270
-     *
271
-     * @access    public
272
-     * @return void
273
-     * @throws EE_Error
274
-     * @throws InvalidArgumentException
275
-     * @throws InvalidDataTypeException
276
-     * @throws InvalidInterfaceException
277
-     */
278
-    public function maybeSetDatetimeWarningNotice()
279
-    {
280
-        // add dismissable notice for datetime changes.  Only valid if site does not have a timezone_string set.
281
-        // @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
282
-        // with this.  But after enough time (indeterminate at this point) we can just remove this notice.
283
-        // this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
284
-        if (apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
285
-            && ! get_option('timezone_string')
286
-            && EEM_Event::instance()->count() > 0
287
-        ) {
288
-            new PersistentAdminNotice(
289
-                'datetime_fix_notice',
290
-                sprintf(
291
-                    esc_html__(
292
-                        '%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
293
-                        'event_espresso'
294
-                    ),
295
-                    '<strong>',
296
-                    '</strong>',
297
-                    '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
298
-                    '</a>',
299
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
300
-                        array(
301
-                            'page'   => 'espresso_maintenance_settings',
302
-                            'action' => 'datetime_tools',
303
-                        ),
304
-                        admin_url('admin.php')
305
-                    ) . '">'
306
-                ),
307
-                false,
308
-                'manage_options',
309
-                'datetime_fix_persistent_notice'
310
-            );
311
-        }
312
-    }
313
-
314
-
315
-    /**
316
-     * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
317
-     * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
318
-     * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
319
-     * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
320
-     * normal property on the post_type object.  It's found ONLY in this particular context.
321
-     *
322
-     * @param WP_Post $post_type WP post type object
323
-     * @return WP_Post
324
-     * @throws InvalidArgumentException
325
-     * @throws InvalidDataTypeException
326
-     * @throws InvalidInterfaceException
327
-     */
328
-    public function remove_pages_from_nav_menu($post_type)
329
-    {
330
-        // if this isn't the "pages" post type let's get out
331
-        if ($post_type->name !== 'page') {
332
-            return $post_type;
333
-        }
334
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
335
-        $post_type->_default_query = array(
336
-            'post__not_in' => $critical_pages,
337
-        );
338
-        return $post_type;
339
-    }
340
-
341
-
342
-    /**
343
-     * WP by default only shows three metaboxes in "nav-menus.php" for first times users.  We want to make sure our
344
-     * metaboxes get shown as well
345
-     *
346
-     * @return void
347
-     */
348
-    public function enable_hidden_ee_nav_menu_metaboxes()
349
-    {
350
-        global $wp_meta_boxes, $pagenow;
351
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
352
-            return;
353
-        }
354
-        $user = wp_get_current_user();
355
-        // has this been done yet?
356
-        if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
357
-            return;
358
-        }
359
-
360
-        $hidden_meta_boxes = get_user_option('metaboxhidden_nav-menus', $user->ID);
361
-        $initial_meta_boxes = apply_filters(
362
-            'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
363
-            array(
364
-                'nav-menu-theme-locations',
365
-                'add-page',
366
-                'add-custom-links',
367
-                'add-category',
368
-                'add-espresso_events',
369
-                'add-espresso_venues',
370
-                'add-espresso_event_categories',
371
-                'add-espresso_venue_categories',
372
-                'add-post-type-post',
373
-                'add-post-type-page',
374
-            )
375
-        );
376
-
377
-        if (is_array($hidden_meta_boxes)) {
378
-            foreach ($hidden_meta_boxes as $key => $meta_box_id) {
379
-                if (in_array($meta_box_id, $initial_meta_boxes, true)) {
380
-                    unset($hidden_meta_boxes[ $key ]);
381
-                }
382
-            }
383
-        }
384
-        update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
385
-        update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
386
-    }
387
-
388
-
389
-    /**
390
-     * This method simply registers custom nav menu boxes for "nav_menus.php route"
391
-     * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
392
-     *
393
-     * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
394
-     *         addons etc.
395
-     * @return void
396
-     */
397
-    public function register_custom_nav_menu_boxes()
398
-    {
399
-        add_meta_box(
400
-            'add-extra-nav-menu-pages',
401
-            esc_html__('Event Espresso Pages', 'event_espresso'),
402
-            array($this, 'ee_cpt_archive_pages'),
403
-            'nav-menus',
404
-            'side',
405
-            'core'
406
-        );
407
-    }
408
-
409
-
410
-    /**
411
-     * Use this to edit the post link for our cpts so that the edit link points to the correct page.
412
-     *
413
-     * @since   4.3.0
414
-     * @param string $link the original link generated by wp
415
-     * @param int    $id   post id
416
-     * @return string  the (maybe) modified link
417
-     */
418
-    public function modify_edit_post_link($link, $id)
419
-    {
420
-        if (! $post = get_post($id)) {
421
-            return $link;
422
-        }
423
-        if ($post->post_type === 'espresso_attendees') {
424
-            $query_args = array(
425
-                'action' => 'edit_attendee',
426
-                'post'   => $id,
427
-            );
428
-            return EEH_URL::add_query_args_and_nonce(
429
-                $query_args,
430
-                admin_url('admin.php?page=espresso_registrations')
431
-            );
432
-        }
433
-        return $link;
434
-    }
435
-
436
-
437
-    public function ee_cpt_archive_pages()
438
-    {
439
-        global $nav_menu_selected_id;
440
-        $db_fields = false;
441
-        $walker = new Walker_Nav_Menu_Checklist($db_fields);
442
-        $current_tab = 'event-archives';
443
-        $removed_args = array(
444
-            'action',
445
-            'customlink-tab',
446
-            'edit-menu-item',
447
-            'menu-item',
448
-            'page-tab',
449
-            '_wpnonce',
450
-        );
451
-        ?>
23
+	/**
24
+	 * @var EE_Admin $_instance
25
+	 */
26
+	private static $_instance;
27
+
28
+	/**
29
+	 * @var PersistentAdminNoticeManager $persistent_admin_notice_manager
30
+	 */
31
+	private $persistent_admin_notice_manager;
32
+
33
+	/**
34
+	 * @var LoaderInterface
35
+	 */
36
+	protected $loader;
37
+
38
+	/**
39
+	 * @singleton method used to instantiate class object
40
+	 * @return EE_Admin
41
+	 * @throws EE_Error
42
+	 */
43
+	public static function instance()
44
+	{
45
+		// check if class object is instantiated
46
+		if (! self::$_instance instanceof EE_Admin) {
47
+			self::$_instance = new self();
48
+		}
49
+		return self::$_instance;
50
+	}
51
+
52
+
53
+	/**
54
+	 * @return EE_Admin
55
+	 * @throws EE_Error
56
+	 */
57
+	public static function reset()
58
+	{
59
+		self::$_instance = null;
60
+		return self::instance();
61
+	}
62
+
63
+
64
+	/**
65
+	 * class constructor
66
+	 *
67
+	 * @throws EE_Error
68
+	 * @throws InvalidDataTypeException
69
+	 * @throws InvalidInterfaceException
70
+	 * @throws InvalidArgumentException
71
+	 */
72
+	protected function __construct()
73
+	{
74
+		// define global EE_Admin constants
75
+		$this->_define_all_constants();
76
+		// set autoloaders for our admin page classes based on included path information
77
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
78
+		// admin hooks
79
+		add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
80
+		// load EE_Request_Handler early
81
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
82
+		add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
83
+		add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
84
+		add_action('wp_loaded', array($this, 'wp_loaded'), 100);
85
+		add_action('admin_init', array($this, 'admin_init'), 100);
86
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
87
+		add_action('admin_notices', array($this, 'display_admin_notices'), 10);
88
+		add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
89
+		add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
90
+		add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
91
+		add_action('load-plugins.php', array($this, 'hookIntoWpPluginsPage'));
92
+		add_action('display_post_states', array($this, 'displayStateForCriticalPages'), 10, 2);
93
+		// reset Environment config (we only do this on admin page loads);
94
+		EE_Registry::instance()->CFG->environment->recheck_values();
95
+		do_action('AHEE__EE_Admin__loaded');
96
+	}
97
+
98
+
99
+	/**
100
+	 * _define_all_constants
101
+	 * define constants that are set globally for all admin pages
102
+	 *
103
+	 * @return void
104
+	 */
105
+	private function _define_all_constants()
106
+	{
107
+		if (! defined('EE_ADMIN_URL')) {
108
+			define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
109
+			define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
110
+			define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS);
111
+			define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
112
+			define('WP_AJAX_URL', admin_url('admin-ajax.php'));
113
+		}
114
+	}
115
+
116
+
117
+	/**
118
+	 * filter_plugin_actions - adds links to the Plugins page listing
119
+	 *
120
+	 * @param    array  $links
121
+	 * @param    string $plugin
122
+	 * @return    array
123
+	 */
124
+	public function filter_plugin_actions($links, $plugin)
125
+	{
126
+		// set $main_file in stone
127
+		static $main_file;
128
+		// if $main_file is not set yet
129
+		if (! $main_file) {
130
+			$main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
131
+		}
132
+		if ($plugin === $main_file) {
133
+			// compare current plugin to this one
134
+			if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
135
+				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
136
+									. ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
137
+									. esc_html__('Maintenance Mode Active', 'event_espresso')
138
+									. '</a>';
139
+				array_unshift($links, $maintenance_link);
140
+			} else {
141
+				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
142
+									 . esc_html__('Settings', 'event_espresso')
143
+									 . '</a>';
144
+				$events_link = '<a href="admin.php?page=espresso_events">'
145
+							   . esc_html__('Events', 'event_espresso')
146
+							   . '</a>';
147
+				// add before other links
148
+				array_unshift($links, $org_settings_link, $events_link);
149
+			}
150
+		}
151
+		return $links;
152
+	}
153
+
154
+
155
+	/**
156
+	 * _get_request
157
+	 *
158
+	 * @return void
159
+	 * @throws EE_Error
160
+	 * @throws InvalidArgumentException
161
+	 * @throws InvalidDataTypeException
162
+	 * @throws InvalidInterfaceException
163
+	 * @throws ReflectionException
164
+	 */
165
+	public function get_request()
166
+	{
167
+		EE_Registry::instance()->load_core('Request_Handler');
168
+	}
169
+
170
+
171
+	/**
172
+	 * hide_admin_pages_except_maintenance_mode
173
+	 *
174
+	 * @param array $admin_page_folder_names
175
+	 * @return array
176
+	 */
177
+	public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
178
+	{
179
+		return array(
180
+			'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
181
+			'about'       => EE_ADMIN_PAGES . 'about' . DS,
182
+			'support'     => EE_ADMIN_PAGES . 'support' . DS,
183
+		);
184
+	}
185
+
186
+
187
+	/**
188
+	 * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
189
+	 * EE_Front_Controller's init phases have run
190
+	 *
191
+	 * @return void
192
+	 * @throws EE_Error
193
+	 * @throws InvalidArgumentException
194
+	 * @throws InvalidDataTypeException
195
+	 * @throws InvalidInterfaceException
196
+	 * @throws ReflectionException
197
+	 * @throws ServiceNotFoundException
198
+	 */
199
+	public function init()
200
+	{
201
+		// only enable most of the EE_Admin IF we're not in full maintenance mode
202
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
203
+			$this->initModelsReady();
204
+		}
205
+		// run the admin page factory but ONLY if we are doing an ee admin ajax request
206
+		if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
207
+			try {
208
+				// this loads the controller for the admin pages which will setup routing etc
209
+				EE_Registry::instance()->load_core('Admin_Page_Loader');
210
+			} catch (EE_Error $e) {
211
+				$e->get_error();
212
+			}
213
+		}
214
+		add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
215
+		// make sure our CPTs and custom taxonomy metaboxes get shown for first time users
216
+		add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
217
+		add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
218
+		// exclude EE critical pages from all nav menus and wp_list_pages
219
+		add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
220
+	}
221
+
222
+
223
+	/**
224
+	 * Gets the loader (and if it wasn't previously set, sets it)
225
+	 * @return LoaderInterface
226
+	 * @throws InvalidArgumentException
227
+	 * @throws InvalidDataTypeException
228
+	 * @throws InvalidInterfaceException
229
+	 */
230
+	protected function getLoader()
231
+	{
232
+		if (! $this->loader instanceof LoaderInterface) {
233
+			$this->loader = LoaderFactory::getLoader();
234
+		}
235
+		return $this->loader;
236
+	}
237
+
238
+
239
+	/**
240
+	 * Method that's fired on admin requests (including admin ajax) but only when the models are usable
241
+	 * (ie, the site isn't in maintenance mode)
242
+	 * @since 4.9.63.p
243
+	 * @return void
244
+	 */
245
+	protected function initModelsReady()
246
+	{
247
+		// ok so we want to enable the entire admin
248
+		$this->persistent_admin_notice_manager = $this->getLoader()->getShared(
249
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
250
+		);
251
+		$this->persistent_admin_notice_manager->setReturnUrl(
252
+			EE_Admin_Page::add_query_args_and_nonce(
253
+				array(
254
+					'page'   => EE_Registry::instance()->REQ->get('page', ''),
255
+					'action' => EE_Registry::instance()->REQ->get('action', ''),
256
+				),
257
+				EE_ADMIN_URL
258
+			)
259
+		);
260
+		$this->maybeSetDatetimeWarningNotice();
261
+		// at a glance dashboard widget
262
+		add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
263
+		// filter for get_edit_post_link used on comments for custom post types
264
+		add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
265
+	}
266
+
267
+
268
+	/**
269
+	 *    get_persistent_admin_notices
270
+	 *
271
+	 * @access    public
272
+	 * @return void
273
+	 * @throws EE_Error
274
+	 * @throws InvalidArgumentException
275
+	 * @throws InvalidDataTypeException
276
+	 * @throws InvalidInterfaceException
277
+	 */
278
+	public function maybeSetDatetimeWarningNotice()
279
+	{
280
+		// add dismissable notice for datetime changes.  Only valid if site does not have a timezone_string set.
281
+		// @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
282
+		// with this.  But after enough time (indeterminate at this point) we can just remove this notice.
283
+		// this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
284
+		if (apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
285
+			&& ! get_option('timezone_string')
286
+			&& EEM_Event::instance()->count() > 0
287
+		) {
288
+			new PersistentAdminNotice(
289
+				'datetime_fix_notice',
290
+				sprintf(
291
+					esc_html__(
292
+						'%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
293
+						'event_espresso'
294
+					),
295
+					'<strong>',
296
+					'</strong>',
297
+					'<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
298
+					'</a>',
299
+					'<a href="' . EE_Admin_Page::add_query_args_and_nonce(
300
+						array(
301
+							'page'   => 'espresso_maintenance_settings',
302
+							'action' => 'datetime_tools',
303
+						),
304
+						admin_url('admin.php')
305
+					) . '">'
306
+				),
307
+				false,
308
+				'manage_options',
309
+				'datetime_fix_persistent_notice'
310
+			);
311
+		}
312
+	}
313
+
314
+
315
+	/**
316
+	 * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
317
+	 * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
318
+	 * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
319
+	 * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
320
+	 * normal property on the post_type object.  It's found ONLY in this particular context.
321
+	 *
322
+	 * @param WP_Post $post_type WP post type object
323
+	 * @return WP_Post
324
+	 * @throws InvalidArgumentException
325
+	 * @throws InvalidDataTypeException
326
+	 * @throws InvalidInterfaceException
327
+	 */
328
+	public function remove_pages_from_nav_menu($post_type)
329
+	{
330
+		// if this isn't the "pages" post type let's get out
331
+		if ($post_type->name !== 'page') {
332
+			return $post_type;
333
+		}
334
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
335
+		$post_type->_default_query = array(
336
+			'post__not_in' => $critical_pages,
337
+		);
338
+		return $post_type;
339
+	}
340
+
341
+
342
+	/**
343
+	 * WP by default only shows three metaboxes in "nav-menus.php" for first times users.  We want to make sure our
344
+	 * metaboxes get shown as well
345
+	 *
346
+	 * @return void
347
+	 */
348
+	public function enable_hidden_ee_nav_menu_metaboxes()
349
+	{
350
+		global $wp_meta_boxes, $pagenow;
351
+		if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
352
+			return;
353
+		}
354
+		$user = wp_get_current_user();
355
+		// has this been done yet?
356
+		if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
357
+			return;
358
+		}
359
+
360
+		$hidden_meta_boxes = get_user_option('metaboxhidden_nav-menus', $user->ID);
361
+		$initial_meta_boxes = apply_filters(
362
+			'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
363
+			array(
364
+				'nav-menu-theme-locations',
365
+				'add-page',
366
+				'add-custom-links',
367
+				'add-category',
368
+				'add-espresso_events',
369
+				'add-espresso_venues',
370
+				'add-espresso_event_categories',
371
+				'add-espresso_venue_categories',
372
+				'add-post-type-post',
373
+				'add-post-type-page',
374
+			)
375
+		);
376
+
377
+		if (is_array($hidden_meta_boxes)) {
378
+			foreach ($hidden_meta_boxes as $key => $meta_box_id) {
379
+				if (in_array($meta_box_id, $initial_meta_boxes, true)) {
380
+					unset($hidden_meta_boxes[ $key ]);
381
+				}
382
+			}
383
+		}
384
+		update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
385
+		update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
386
+	}
387
+
388
+
389
+	/**
390
+	 * This method simply registers custom nav menu boxes for "nav_menus.php route"
391
+	 * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
392
+	 *
393
+	 * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
394
+	 *         addons etc.
395
+	 * @return void
396
+	 */
397
+	public function register_custom_nav_menu_boxes()
398
+	{
399
+		add_meta_box(
400
+			'add-extra-nav-menu-pages',
401
+			esc_html__('Event Espresso Pages', 'event_espresso'),
402
+			array($this, 'ee_cpt_archive_pages'),
403
+			'nav-menus',
404
+			'side',
405
+			'core'
406
+		);
407
+	}
408
+
409
+
410
+	/**
411
+	 * Use this to edit the post link for our cpts so that the edit link points to the correct page.
412
+	 *
413
+	 * @since   4.3.0
414
+	 * @param string $link the original link generated by wp
415
+	 * @param int    $id   post id
416
+	 * @return string  the (maybe) modified link
417
+	 */
418
+	public function modify_edit_post_link($link, $id)
419
+	{
420
+		if (! $post = get_post($id)) {
421
+			return $link;
422
+		}
423
+		if ($post->post_type === 'espresso_attendees') {
424
+			$query_args = array(
425
+				'action' => 'edit_attendee',
426
+				'post'   => $id,
427
+			);
428
+			return EEH_URL::add_query_args_and_nonce(
429
+				$query_args,
430
+				admin_url('admin.php?page=espresso_registrations')
431
+			);
432
+		}
433
+		return $link;
434
+	}
435
+
436
+
437
+	public function ee_cpt_archive_pages()
438
+	{
439
+		global $nav_menu_selected_id;
440
+		$db_fields = false;
441
+		$walker = new Walker_Nav_Menu_Checklist($db_fields);
442
+		$current_tab = 'event-archives';
443
+		$removed_args = array(
444
+			'action',
445
+			'customlink-tab',
446
+			'edit-menu-item',
447
+			'menu-item',
448
+			'page-tab',
449
+			'_wpnonce',
450
+		);
451
+		?>
452 452
         <div id="posttype-extra-nav-menu-pages" class="posttypediv">
453 453
             <ul id="posttype-extra-nav-menu-pages-tabs" class="posttype-tabs add-menu-item-tabs">
454 454
                 <li <?php echo('event-archives' === $current_tab ? ' class="tabs"' : ''); ?>>
455 455
                     <a class="nav-tab-link" data-type="tabs-panel-posttype-extra-nav-menu-pages-event-archives"
456 456
                        href="<?php
457
-                        if ($nav_menu_selected_id) {
458
-                            echo esc_url(
459
-                                add_query_arg(
460
-                                    'extra-nav-menu-pages-tab',
461
-                                    'event-archives',
462
-                                    remove_query_arg($removed_args)
463
-                                )
464
-                            );
465
-                        }
466
-                        ?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
457
+						if ($nav_menu_selected_id) {
458
+							echo esc_url(
459
+								add_query_arg(
460
+									'extra-nav-menu-pages-tab',
461
+									'event-archives',
462
+									remove_query_arg($removed_args)
463
+								)
464
+							);
465
+						}
466
+						?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
467 467
                         <?php _e('Event Archive Pages', 'event_espresso'); ?>
468 468
                     </a>
469 469
                 </li>
470 470
             </ul><!-- .posttype-tabs -->
471 471
 
472 472
             <div id="tabs-panel-posttype-extra-nav-menu-pages-event-archives" class="tabs-panel <?php
473
-            echo('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
474
-            ?>">
473
+			echo('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
474
+			?>">
475 475
                 <ul id="extra-nav-menu-pageschecklist-event-archives" class="categorychecklist form-no-clear">
476 476
                     <?php
477
-                    $pages = $this->_get_extra_nav_menu_pages_items();
478
-                    $args['walker'] = $walker;
479
-                    echo walk_nav_menu_tree(
480
-                        array_map(
481
-                            array($this, '_setup_extra_nav_menu_pages_items'),
482
-                            $pages
483
-                        ),
484
-                        0,
485
-                        (object) $args
486
-                    );
487
-                    ?>
477
+					$pages = $this->_get_extra_nav_menu_pages_items();
478
+					$args['walker'] = $walker;
479
+					echo walk_nav_menu_tree(
480
+						array_map(
481
+							array($this, '_setup_extra_nav_menu_pages_items'),
482
+							$pages
483
+						),
484
+						0,
485
+						(object) $args
486
+					);
487
+					?>
488 488
                 </ul>
489 489
             </div><!-- /.tabs-panel -->
490 490
 
491 491
             <p class="button-controls">
492 492
                 <span class="list-controls">
493 493
                     <a href="<?php
494
-                             echo esc_url(
495
-                                 add_query_arg(
496
-                                     array(
497
-                                         'extra-nav-menu-pages-tab' => 'event-archives',
498
-                                         'selectall'                => 1,
499
-                                     ),
500
-                                     remove_query_arg($removed_args)
501
-                                 )
502
-                             );
503
-                        ?>#posttype-extra-nav-menu-pages>" class="select-all"><?php _e('Select All', 'event_espresso'); ?></a>
494
+							 echo esc_url(
495
+								 add_query_arg(
496
+									 array(
497
+										 'extra-nav-menu-pages-tab' => 'event-archives',
498
+										 'selectall'                => 1,
499
+									 ),
500
+									 remove_query_arg($removed_args)
501
+								 )
502
+							 );
503
+						?>#posttype-extra-nav-menu-pages>" class="select-all"><?php _e('Select All', 'event_espresso'); ?></a>
504 504
                 </span>
505 505
                 <span class="add-to-menu">
506 506
                     <input type="submit"<?php wp_nav_menu_disabled_check($nav_menu_selected_id); ?>
@@ -513,529 +513,529 @@  discard block
 block discarded – undo
513 513
 
514 514
         </div><!-- /.posttypediv -->
515 515
         <?php
516
-    }
517
-
518
-
519
-    /**
520
-     * Returns an array of event archive nav items.
521
-     *
522
-     * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
523
-     *        method we use for getting the extra nav menu items
524
-     * @return array
525
-     */
526
-    private function _get_extra_nav_menu_pages_items()
527
-    {
528
-        $menuitems[] = array(
529
-            'title'       => esc_html__('Event List', 'event_espresso'),
530
-            'url'         => get_post_type_archive_link('espresso_events'),
531
-            'description' => esc_html__('Archive page for all events.', 'event_espresso'),
532
-        );
533
-        return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
534
-    }
535
-
536
-
537
-    /**
538
-     * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
539
-     * the properties and converts it to the menu item object.
540
-     *
541
-     * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
542
-     * @param $menu_item_values
543
-     * @return stdClass
544
-     */
545
-    private function _setup_extra_nav_menu_pages_items($menu_item_values)
546
-    {
547
-        $menu_item = new stdClass();
548
-        $keys = array(
549
-            'ID'               => 0,
550
-            'db_id'            => 0,
551
-            'menu_item_parent' => 0,
552
-            'object_id'        => -1,
553
-            'post_parent'      => 0,
554
-            'type'             => 'custom',
555
-            'object'           => '',
556
-            'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
557
-            'title'            => '',
558
-            'url'              => '',
559
-            'target'           => '',
560
-            'attr_title'       => '',
561
-            'description'      => '',
562
-            'classes'          => array(),
563
-            'xfn'              => '',
564
-        );
565
-
566
-        foreach ($keys as $key => $value) {
567
-            $menu_item->{$key} = isset($menu_item_values[ $key ]) ? $menu_item_values[ $key ] : $value;
568
-        }
569
-        return $menu_item;
570
-    }
571
-
572
-
573
-    /**
574
-     * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
575
-     * EE_Admin_Page route is called.
576
-     *
577
-     * @return void
578
-     */
579
-    public function route_admin_request()
580
-    {
581
-    }
582
-
583
-
584
-    /**
585
-     * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
586
-     *
587
-     * @return void
588
-     */
589
-    public function wp_loaded()
590
-    {
591
-    }
592
-
593
-
594
-    /**
595
-     * admin_init
596
-     *
597
-     * @return void
598
-     * @throws EE_Error
599
-     * @throws InvalidArgumentException
600
-     * @throws InvalidDataTypeException
601
-     * @throws InvalidInterfaceException
602
-     * @throws ReflectionException
603
-     */
604
-    public function admin_init()
605
-    {
606
-        /**
607
-         * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
608
-         * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
609
-         * - check if doing post processing.
610
-         * - check if doing post processing of one of EE CPTs
611
-         * - instantiate the corresponding EE CPT model for the post_type being processed.
612
-         */
613
-        if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
614
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
615
-            $custom_post_types = $this->getLoader()->getShared(
616
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
617
-            );
618
-            $custom_post_types->getCustomPostTypeModels($_POST['post_type']);
619
-        }
620
-
621
-
622
-        /**
623
-         * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
624
-         * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
625
-         * Pages" tab in the EE General Settings Admin page.
626
-         * This is for user-proofing.
627
-         */
628
-        add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
629
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
630
-            $this->adminInitModelsReady();
631
-        }
632
-    }
633
-
634
-
635
-    /**
636
-     * Runs on admin_init but only if models are usable (ie, we're not in maintenanc emode)
637
-     */
638
-    protected function adminInitModelsReady()
639
-    {
640
-        if (function_exists('wp_add_privacy_policy_content')) {
641
-            $this->getLoader()->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
642
-        }
643
-    }
644
-
645
-
646
-    /**
647
-     * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
648
-     *
649
-     * @param string $output Current output.
650
-     * @return string
651
-     * @throws InvalidArgumentException
652
-     * @throws InvalidDataTypeException
653
-     * @throws InvalidInterfaceException
654
-     */
655
-    public function modify_dropdown_pages($output)
656
-    {
657
-        // get critical pages
658
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
659
-
660
-        // split current output by line break for easier parsing.
661
-        $split_output = explode("\n", $output);
662
-
663
-        // loop through to remove any critical pages from the array.
664
-        foreach ($critical_pages as $page_id) {
665
-            $needle = 'value="' . $page_id . '"';
666
-            foreach ($split_output as $key => $haystack) {
667
-                if (strpos($haystack, $needle) !== false) {
668
-                    unset($split_output[ $key ]);
669
-                }
670
-            }
671
-        }
672
-        // replace output with the new contents
673
-        return implode("\n", $split_output);
674
-    }
675
-
676
-
677
-    /**
678
-     * enqueue all admin scripts that need loaded for admin pages
679
-     *
680
-     * @return void
681
-     */
682
-    public function enqueue_admin_scripts()
683
-    {
684
-        // this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
685
-        // Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script
686
-        // calls.
687
-        wp_enqueue_script(
688
-            'ee-inject-wp',
689
-            EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
690
-            array('jquery'),
691
-            EVENT_ESPRESSO_VERSION,
692
-            true
693
-        );
694
-        // register cookie script for future dependencies
695
-        wp_register_script(
696
-            'jquery-cookie',
697
-            EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
698
-            array('jquery'),
699
-            '2.1',
700
-            true
701
-        );
702
-        // joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again
703
-        // via: add_filter('FHEE_load_joyride', '__return_true' );
704
-        if (apply_filters('FHEE_load_joyride', false)) {
705
-            // joyride style
706
-            wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
707
-            wp_register_style(
708
-                'ee-joyride-css',
709
-                EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
710
-                array('joyride-css'),
711
-                EVENT_ESPRESSO_VERSION
712
-            );
713
-            wp_register_script(
714
-                'joyride-modernizr',
715
-                EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
716
-                array(),
717
-                '2.1',
718
-                true
719
-            );
720
-            // joyride JS
721
-            wp_register_script(
722
-                'jquery-joyride',
723
-                EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
724
-                array('jquery-cookie', 'joyride-modernizr'),
725
-                '2.1',
726
-                true
727
-            );
728
-            // wanna go for a joyride?
729
-            wp_enqueue_style('ee-joyride-css');
730
-            wp_enqueue_script('jquery-joyride');
731
-        }
732
-    }
733
-
734
-
735
-    /**
736
-     * display_admin_notices
737
-     *
738
-     * @return void
739
-     */
740
-    public function display_admin_notices()
741
-    {
742
-        echo EE_Error::get_notices();
743
-    }
744
-
745
-
746
-    /**
747
-     * @param array $elements
748
-     * @return array
749
-     * @throws EE_Error
750
-     * @throws InvalidArgumentException
751
-     * @throws InvalidDataTypeException
752
-     * @throws InvalidInterfaceException
753
-     */
754
-    public function dashboard_glance_items($elements)
755
-    {
756
-        $elements = is_array($elements) ? $elements : array($elements);
757
-        $events = EEM_Event::instance()->count();
758
-        $items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce(
759
-            array('page' => 'espresso_events'),
760
-            admin_url('admin.php')
761
-        );
762
-        $items['events']['text'] = sprintf(_n('%s Event', '%s Events', $events, 'event_espresso'), number_format_i18n($events));
763
-        $items['events']['title'] = esc_html__('Click to view all Events', 'event_espresso');
764
-        $registrations = EEM_Registration::instance()->count(
765
-            array(
766
-                array(
767
-                    'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
768
-                ),
769
-            )
770
-        );
771
-        $items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
772
-            array('page' => 'espresso_registrations'),
773
-            admin_url('admin.php')
774
-        );
775
-        $items['registrations']['text'] = sprintf(
776
-            _n('%s Registration', '%s Registrations', $registrations, 'event_espresso'),
777
-            number_format_i18n($registrations)
778
-        );
779
-        $items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
780
-
781
-        $items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
782
-
783
-        foreach ($items as $type => $item_properties) {
784
-            $elements[] = sprintf(
785
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
786
-                $item_properties['url'],
787
-                $item_properties['title'],
788
-                $item_properties['text']
789
-            );
790
-        }
791
-        return $elements;
792
-    }
793
-
794
-
795
-    /**
796
-     * check_for_invalid_datetime_formats
797
-     * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
798
-     * their selected format can be parsed by PHP
799
-     *
800
-     * @param    $value
801
-     * @param    $option
802
-     * @throws EE_Error
803
-     * @return    string
804
-     */
805
-    public function check_for_invalid_datetime_formats($value, $option)
806
-    {
807
-        // check for date_format or time_format
808
-        switch ($option) {
809
-            case 'date_format':
810
-                $date_time_format = $value . ' ' . get_option('time_format');
811
-                break;
812
-            case 'time_format':
813
-                $date_time_format = get_option('date_format') . ' ' . $value;
814
-                break;
815
-            default:
816
-                $date_time_format = false;
817
-        }
818
-        // do we have a date_time format to check ?
819
-        if ($date_time_format) {
820
-            $error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
821
-
822
-            if (is_array($error_msg)) {
823
-                $msg = '<p>'
824
-                       . sprintf(
825
-                           esc_html__(
826
-                               'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
827
-                               'event_espresso'
828
-                           ),
829
-                           date($date_time_format),
830
-                           $date_time_format
831
-                       )
832
-                       . '</p><p><ul>';
833
-
834
-
835
-                foreach ($error_msg as $error) {
836
-                    $msg .= '<li>' . $error . '</li>';
837
-                }
838
-
839
-                $msg .= '</ul></p><p>'
840
-                        . sprintf(
841
-                            esc_html__(
842
-                                '%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
843
-                                'event_espresso'
844
-                            ),
845
-                            '<span style="color:#D54E21;">',
846
-                            '</span>'
847
-                        )
848
-                        . '</p>';
849
-
850
-                // trigger WP settings error
851
-                add_settings_error(
852
-                    'date_format',
853
-                    'date_format',
854
-                    $msg
855
-                );
856
-
857
-                // set format to something valid
858
-                switch ($option) {
859
-                    case 'date_format':
860
-                        $value = 'F j, Y';
861
-                        break;
862
-                    case 'time_format':
863
-                        $value = 'g:i a';
864
-                        break;
865
-                }
866
-            }
867
-        }
868
-        return $value;
869
-    }
870
-
871
-
872
-    /**
873
-     * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
874
-     *
875
-     * @param $content
876
-     * @return    string
877
-     */
878
-    public function its_eSpresso($content)
879
-    {
880
-        return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
881
-    }
882
-
883
-
884
-    /**
885
-     * espresso_admin_footer
886
-     *
887
-     * @return    string
888
-     */
889
-    public function espresso_admin_footer()
890
-    {
891
-        return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
892
-    }
893
-
894
-
895
-    /**
896
-     * static method for registering ee admin page.
897
-     * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
898
-     *
899
-     * @since      4.3.0
900
-     * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
901
-     * @see        EE_Register_Admin_Page::register()
902
-     * @param       $page_basename
903
-     * @param       $page_path
904
-     * @param array $config
905
-     * @return void
906
-     * @throws EE_Error
907
-     */
908
-    public static function register_ee_admin_page($page_basename, $page_path, $config = array())
909
-    {
910
-        EE_Error::doing_it_wrong(
911
-            __METHOD__,
912
-            sprintf(
913
-                esc_html__(
914
-                    'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
915
-                    'event_espresso'
916
-                ),
917
-                $page_basename
918
-            ),
919
-            '4.3'
920
-        );
921
-        if (class_exists('EE_Register_Admin_Page')) {
922
-            $config['page_path'] = $page_path;
923
-        }
924
-        EE_Register_Admin_Page::register($page_basename, $config);
925
-    }
926
-
927
-
928
-    /**
929
-     * @deprecated 4.8.41
930
-     * @param  int      $post_ID
931
-     * @param  \WP_Post $post
932
-     * @return void
933
-     */
934
-    public static function parse_post_content_on_save($post_ID, $post)
935
-    {
936
-        EE_Error::doing_it_wrong(
937
-            __METHOD__,
938
-            esc_html__('Usage is deprecated', 'event_espresso'),
939
-            '4.8.41'
940
-        );
941
-    }
942
-
943
-
944
-    /**
945
-     * @deprecated 4.8.41
946
-     * @param  $option
947
-     * @param  $old_value
948
-     * @param  $value
949
-     * @return void
950
-     */
951
-    public function reset_page_for_posts_on_change($option, $old_value, $value)
952
-    {
953
-        EE_Error::doing_it_wrong(
954
-            __METHOD__,
955
-            esc_html__('Usage is deprecated', 'event_espresso'),
956
-            '4.8.41'
957
-        );
958
-    }
959
-
960
-
961
-    /**
962
-     * @deprecated 4.9.27
963
-     * @return void
964
-     */
965
-    public function get_persistent_admin_notices()
966
-    {
967
-        EE_Error::doing_it_wrong(
968
-            __METHOD__,
969
-            sprintf(
970
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
971
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
972
-            ),
973
-            '4.9.27'
974
-        );
975
-    }
976
-
977
-
978
-    /**
979
-     * @deprecated 4.9.27
980
-     * @throws InvalidInterfaceException
981
-     * @throws InvalidDataTypeException
982
-     * @throws DomainException
983
-     */
984
-    public function dismiss_ee_nag_notice_callback()
985
-    {
986
-        EE_Error::doing_it_wrong(
987
-            __METHOD__,
988
-            sprintf(
989
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
990
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
991
-            ),
992
-            '4.9.27'
993
-        );
994
-        $this->persistent_admin_notice_manager->dismissNotice();
995
-    }
996
-
997
-
998
-    /**
999
-     * Callback on load-plugins.php hook for setting up anything hooking into the wp plugins page.
1000
-     *
1001
-     * @throws InvalidArgumentException
1002
-     * @throws InvalidDataTypeException
1003
-     * @throws InvalidInterfaceException
1004
-     */
1005
-    public function hookIntoWpPluginsPage()
1006
-    {
1007
-        $this->getLoader()->getShared('EventEspresso\core\domain\services\admin\ExitModal');
1008
-        $this->getLoader()
1009
-                     ->getShared('EventEspresso\core\domain\services\admin\PluginUpsells')
1010
-                     ->decafUpsells();
1011
-    }
1012
-
1013
-
1014
-    /**
1015
-     * Hooks into the "post states" filter in a wp post type list table.
1016
-     *
1017
-     * @param array   $post_states
1018
-     * @param WP_Post $post
1019
-     * @return array
1020
-     * @throws InvalidArgumentException
1021
-     * @throws InvalidDataTypeException
1022
-     * @throws InvalidInterfaceException
1023
-     */
1024
-    public function displayStateForCriticalPages($post_states, $post)
1025
-    {
1026
-        $post_states = (array) $post_states;
1027
-        if (! $post instanceof WP_Post || $post->post_type !== 'page') {
1028
-            return $post_states;
1029
-        }
1030
-        /** @var EE_Core_Config $config */
1031
-        $config = $this->getLoader()->getShared('EE_Config')->core;
1032
-        if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
1033
-            $post_states[] = sprintf(
1034
-                /* Translators: Using company name - Event Espresso Critical Page */
1035
-                esc_html__('%s Critical Page', 'event_espresso'),
1036
-                'Event Espresso'
1037
-            );
1038
-        }
1039
-        return $post_states;
1040
-    }
516
+	}
517
+
518
+
519
+	/**
520
+	 * Returns an array of event archive nav items.
521
+	 *
522
+	 * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
523
+	 *        method we use for getting the extra nav menu items
524
+	 * @return array
525
+	 */
526
+	private function _get_extra_nav_menu_pages_items()
527
+	{
528
+		$menuitems[] = array(
529
+			'title'       => esc_html__('Event List', 'event_espresso'),
530
+			'url'         => get_post_type_archive_link('espresso_events'),
531
+			'description' => esc_html__('Archive page for all events.', 'event_espresso'),
532
+		);
533
+		return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
534
+	}
535
+
536
+
537
+	/**
538
+	 * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
539
+	 * the properties and converts it to the menu item object.
540
+	 *
541
+	 * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
542
+	 * @param $menu_item_values
543
+	 * @return stdClass
544
+	 */
545
+	private function _setup_extra_nav_menu_pages_items($menu_item_values)
546
+	{
547
+		$menu_item = new stdClass();
548
+		$keys = array(
549
+			'ID'               => 0,
550
+			'db_id'            => 0,
551
+			'menu_item_parent' => 0,
552
+			'object_id'        => -1,
553
+			'post_parent'      => 0,
554
+			'type'             => 'custom',
555
+			'object'           => '',
556
+			'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
557
+			'title'            => '',
558
+			'url'              => '',
559
+			'target'           => '',
560
+			'attr_title'       => '',
561
+			'description'      => '',
562
+			'classes'          => array(),
563
+			'xfn'              => '',
564
+		);
565
+
566
+		foreach ($keys as $key => $value) {
567
+			$menu_item->{$key} = isset($menu_item_values[ $key ]) ? $menu_item_values[ $key ] : $value;
568
+		}
569
+		return $menu_item;
570
+	}
571
+
572
+
573
+	/**
574
+	 * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
575
+	 * EE_Admin_Page route is called.
576
+	 *
577
+	 * @return void
578
+	 */
579
+	public function route_admin_request()
580
+	{
581
+	}
582
+
583
+
584
+	/**
585
+	 * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
586
+	 *
587
+	 * @return void
588
+	 */
589
+	public function wp_loaded()
590
+	{
591
+	}
592
+
593
+
594
+	/**
595
+	 * admin_init
596
+	 *
597
+	 * @return void
598
+	 * @throws EE_Error
599
+	 * @throws InvalidArgumentException
600
+	 * @throws InvalidDataTypeException
601
+	 * @throws InvalidInterfaceException
602
+	 * @throws ReflectionException
603
+	 */
604
+	public function admin_init()
605
+	{
606
+		/**
607
+		 * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
608
+		 * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
609
+		 * - check if doing post processing.
610
+		 * - check if doing post processing of one of EE CPTs
611
+		 * - instantiate the corresponding EE CPT model for the post_type being processed.
612
+		 */
613
+		if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
614
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
615
+			$custom_post_types = $this->getLoader()->getShared(
616
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
617
+			);
618
+			$custom_post_types->getCustomPostTypeModels($_POST['post_type']);
619
+		}
620
+
621
+
622
+		/**
623
+		 * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
624
+		 * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
625
+		 * Pages" tab in the EE General Settings Admin page.
626
+		 * This is for user-proofing.
627
+		 */
628
+		add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
629
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
630
+			$this->adminInitModelsReady();
631
+		}
632
+	}
633
+
634
+
635
+	/**
636
+	 * Runs on admin_init but only if models are usable (ie, we're not in maintenanc emode)
637
+	 */
638
+	protected function adminInitModelsReady()
639
+	{
640
+		if (function_exists('wp_add_privacy_policy_content')) {
641
+			$this->getLoader()->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
642
+		}
643
+	}
644
+
645
+
646
+	/**
647
+	 * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
648
+	 *
649
+	 * @param string $output Current output.
650
+	 * @return string
651
+	 * @throws InvalidArgumentException
652
+	 * @throws InvalidDataTypeException
653
+	 * @throws InvalidInterfaceException
654
+	 */
655
+	public function modify_dropdown_pages($output)
656
+	{
657
+		// get critical pages
658
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
659
+
660
+		// split current output by line break for easier parsing.
661
+		$split_output = explode("\n", $output);
662
+
663
+		// loop through to remove any critical pages from the array.
664
+		foreach ($critical_pages as $page_id) {
665
+			$needle = 'value="' . $page_id . '"';
666
+			foreach ($split_output as $key => $haystack) {
667
+				if (strpos($haystack, $needle) !== false) {
668
+					unset($split_output[ $key ]);
669
+				}
670
+			}
671
+		}
672
+		// replace output with the new contents
673
+		return implode("\n", $split_output);
674
+	}
675
+
676
+
677
+	/**
678
+	 * enqueue all admin scripts that need loaded for admin pages
679
+	 *
680
+	 * @return void
681
+	 */
682
+	public function enqueue_admin_scripts()
683
+	{
684
+		// this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
685
+		// Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script
686
+		// calls.
687
+		wp_enqueue_script(
688
+			'ee-inject-wp',
689
+			EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
690
+			array('jquery'),
691
+			EVENT_ESPRESSO_VERSION,
692
+			true
693
+		);
694
+		// register cookie script for future dependencies
695
+		wp_register_script(
696
+			'jquery-cookie',
697
+			EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
698
+			array('jquery'),
699
+			'2.1',
700
+			true
701
+		);
702
+		// joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again
703
+		// via: add_filter('FHEE_load_joyride', '__return_true' );
704
+		if (apply_filters('FHEE_load_joyride', false)) {
705
+			// joyride style
706
+			wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
707
+			wp_register_style(
708
+				'ee-joyride-css',
709
+				EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
710
+				array('joyride-css'),
711
+				EVENT_ESPRESSO_VERSION
712
+			);
713
+			wp_register_script(
714
+				'joyride-modernizr',
715
+				EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
716
+				array(),
717
+				'2.1',
718
+				true
719
+			);
720
+			// joyride JS
721
+			wp_register_script(
722
+				'jquery-joyride',
723
+				EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
724
+				array('jquery-cookie', 'joyride-modernizr'),
725
+				'2.1',
726
+				true
727
+			);
728
+			// wanna go for a joyride?
729
+			wp_enqueue_style('ee-joyride-css');
730
+			wp_enqueue_script('jquery-joyride');
731
+		}
732
+	}
733
+
734
+
735
+	/**
736
+	 * display_admin_notices
737
+	 *
738
+	 * @return void
739
+	 */
740
+	public function display_admin_notices()
741
+	{
742
+		echo EE_Error::get_notices();
743
+	}
744
+
745
+
746
+	/**
747
+	 * @param array $elements
748
+	 * @return array
749
+	 * @throws EE_Error
750
+	 * @throws InvalidArgumentException
751
+	 * @throws InvalidDataTypeException
752
+	 * @throws InvalidInterfaceException
753
+	 */
754
+	public function dashboard_glance_items($elements)
755
+	{
756
+		$elements = is_array($elements) ? $elements : array($elements);
757
+		$events = EEM_Event::instance()->count();
758
+		$items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce(
759
+			array('page' => 'espresso_events'),
760
+			admin_url('admin.php')
761
+		);
762
+		$items['events']['text'] = sprintf(_n('%s Event', '%s Events', $events, 'event_espresso'), number_format_i18n($events));
763
+		$items['events']['title'] = esc_html__('Click to view all Events', 'event_espresso');
764
+		$registrations = EEM_Registration::instance()->count(
765
+			array(
766
+				array(
767
+					'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
768
+				),
769
+			)
770
+		);
771
+		$items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
772
+			array('page' => 'espresso_registrations'),
773
+			admin_url('admin.php')
774
+		);
775
+		$items['registrations']['text'] = sprintf(
776
+			_n('%s Registration', '%s Registrations', $registrations, 'event_espresso'),
777
+			number_format_i18n($registrations)
778
+		);
779
+		$items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
780
+
781
+		$items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
782
+
783
+		foreach ($items as $type => $item_properties) {
784
+			$elements[] = sprintf(
785
+				'<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
786
+				$item_properties['url'],
787
+				$item_properties['title'],
788
+				$item_properties['text']
789
+			);
790
+		}
791
+		return $elements;
792
+	}
793
+
794
+
795
+	/**
796
+	 * check_for_invalid_datetime_formats
797
+	 * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
798
+	 * their selected format can be parsed by PHP
799
+	 *
800
+	 * @param    $value
801
+	 * @param    $option
802
+	 * @throws EE_Error
803
+	 * @return    string
804
+	 */
805
+	public function check_for_invalid_datetime_formats($value, $option)
806
+	{
807
+		// check for date_format or time_format
808
+		switch ($option) {
809
+			case 'date_format':
810
+				$date_time_format = $value . ' ' . get_option('time_format');
811
+				break;
812
+			case 'time_format':
813
+				$date_time_format = get_option('date_format') . ' ' . $value;
814
+				break;
815
+			default:
816
+				$date_time_format = false;
817
+		}
818
+		// do we have a date_time format to check ?
819
+		if ($date_time_format) {
820
+			$error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
821
+
822
+			if (is_array($error_msg)) {
823
+				$msg = '<p>'
824
+					   . sprintf(
825
+						   esc_html__(
826
+							   'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
827
+							   'event_espresso'
828
+						   ),
829
+						   date($date_time_format),
830
+						   $date_time_format
831
+					   )
832
+					   . '</p><p><ul>';
833
+
834
+
835
+				foreach ($error_msg as $error) {
836
+					$msg .= '<li>' . $error . '</li>';
837
+				}
838
+
839
+				$msg .= '</ul></p><p>'
840
+						. sprintf(
841
+							esc_html__(
842
+								'%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
843
+								'event_espresso'
844
+							),
845
+							'<span style="color:#D54E21;">',
846
+							'</span>'
847
+						)
848
+						. '</p>';
849
+
850
+				// trigger WP settings error
851
+				add_settings_error(
852
+					'date_format',
853
+					'date_format',
854
+					$msg
855
+				);
856
+
857
+				// set format to something valid
858
+				switch ($option) {
859
+					case 'date_format':
860
+						$value = 'F j, Y';
861
+						break;
862
+					case 'time_format':
863
+						$value = 'g:i a';
864
+						break;
865
+				}
866
+			}
867
+		}
868
+		return $value;
869
+	}
870
+
871
+
872
+	/**
873
+	 * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
874
+	 *
875
+	 * @param $content
876
+	 * @return    string
877
+	 */
878
+	public function its_eSpresso($content)
879
+	{
880
+		return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
881
+	}
882
+
883
+
884
+	/**
885
+	 * espresso_admin_footer
886
+	 *
887
+	 * @return    string
888
+	 */
889
+	public function espresso_admin_footer()
890
+	{
891
+		return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
892
+	}
893
+
894
+
895
+	/**
896
+	 * static method for registering ee admin page.
897
+	 * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
898
+	 *
899
+	 * @since      4.3.0
900
+	 * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
901
+	 * @see        EE_Register_Admin_Page::register()
902
+	 * @param       $page_basename
903
+	 * @param       $page_path
904
+	 * @param array $config
905
+	 * @return void
906
+	 * @throws EE_Error
907
+	 */
908
+	public static function register_ee_admin_page($page_basename, $page_path, $config = array())
909
+	{
910
+		EE_Error::doing_it_wrong(
911
+			__METHOD__,
912
+			sprintf(
913
+				esc_html__(
914
+					'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
915
+					'event_espresso'
916
+				),
917
+				$page_basename
918
+			),
919
+			'4.3'
920
+		);
921
+		if (class_exists('EE_Register_Admin_Page')) {
922
+			$config['page_path'] = $page_path;
923
+		}
924
+		EE_Register_Admin_Page::register($page_basename, $config);
925
+	}
926
+
927
+
928
+	/**
929
+	 * @deprecated 4.8.41
930
+	 * @param  int      $post_ID
931
+	 * @param  \WP_Post $post
932
+	 * @return void
933
+	 */
934
+	public static function parse_post_content_on_save($post_ID, $post)
935
+	{
936
+		EE_Error::doing_it_wrong(
937
+			__METHOD__,
938
+			esc_html__('Usage is deprecated', 'event_espresso'),
939
+			'4.8.41'
940
+		);
941
+	}
942
+
943
+
944
+	/**
945
+	 * @deprecated 4.8.41
946
+	 * @param  $option
947
+	 * @param  $old_value
948
+	 * @param  $value
949
+	 * @return void
950
+	 */
951
+	public function reset_page_for_posts_on_change($option, $old_value, $value)
952
+	{
953
+		EE_Error::doing_it_wrong(
954
+			__METHOD__,
955
+			esc_html__('Usage is deprecated', 'event_espresso'),
956
+			'4.8.41'
957
+		);
958
+	}
959
+
960
+
961
+	/**
962
+	 * @deprecated 4.9.27
963
+	 * @return void
964
+	 */
965
+	public function get_persistent_admin_notices()
966
+	{
967
+		EE_Error::doing_it_wrong(
968
+			__METHOD__,
969
+			sprintf(
970
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
971
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
972
+			),
973
+			'4.9.27'
974
+		);
975
+	}
976
+
977
+
978
+	/**
979
+	 * @deprecated 4.9.27
980
+	 * @throws InvalidInterfaceException
981
+	 * @throws InvalidDataTypeException
982
+	 * @throws DomainException
983
+	 */
984
+	public function dismiss_ee_nag_notice_callback()
985
+	{
986
+		EE_Error::doing_it_wrong(
987
+			__METHOD__,
988
+			sprintf(
989
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
990
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
991
+			),
992
+			'4.9.27'
993
+		);
994
+		$this->persistent_admin_notice_manager->dismissNotice();
995
+	}
996
+
997
+
998
+	/**
999
+	 * Callback on load-plugins.php hook for setting up anything hooking into the wp plugins page.
1000
+	 *
1001
+	 * @throws InvalidArgumentException
1002
+	 * @throws InvalidDataTypeException
1003
+	 * @throws InvalidInterfaceException
1004
+	 */
1005
+	public function hookIntoWpPluginsPage()
1006
+	{
1007
+		$this->getLoader()->getShared('EventEspresso\core\domain\services\admin\ExitModal');
1008
+		$this->getLoader()
1009
+					 ->getShared('EventEspresso\core\domain\services\admin\PluginUpsells')
1010
+					 ->decafUpsells();
1011
+	}
1012
+
1013
+
1014
+	/**
1015
+	 * Hooks into the "post states" filter in a wp post type list table.
1016
+	 *
1017
+	 * @param array   $post_states
1018
+	 * @param WP_Post $post
1019
+	 * @return array
1020
+	 * @throws InvalidArgumentException
1021
+	 * @throws InvalidDataTypeException
1022
+	 * @throws InvalidInterfaceException
1023
+	 */
1024
+	public function displayStateForCriticalPages($post_states, $post)
1025
+	{
1026
+		$post_states = (array) $post_states;
1027
+		if (! $post instanceof WP_Post || $post->post_type !== 'page') {
1028
+			return $post_states;
1029
+		}
1030
+		/** @var EE_Core_Config $config */
1031
+		$config = $this->getLoader()->getShared('EE_Config')->core;
1032
+		if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
1033
+			$post_states[] = sprintf(
1034
+				/* Translators: Using company name - Event Espresso Critical Page */
1035
+				esc_html__('%s Critical Page', 'event_espresso'),
1036
+				'Event Espresso'
1037
+			);
1038
+		}
1039
+		return $post_states;
1040
+	}
1041 1041
 }
Please login to merge, or discard this patch.
Spacing   +31 added lines, -31 removed lines patch added patch discarded remove patch
@@ -43,7 +43,7 @@  discard block
 block discarded – undo
43 43
     public static function instance()
44 44
     {
45 45
         // check if class object is instantiated
46
-        if (! self::$_instance instanceof EE_Admin) {
46
+        if ( ! self::$_instance instanceof EE_Admin) {
47 47
             self::$_instance = new self();
48 48
         }
49 49
         return self::$_instance;
@@ -104,11 +104,11 @@  discard block
 block discarded – undo
104 104
      */
105 105
     private function _define_all_constants()
106 106
     {
107
-        if (! defined('EE_ADMIN_URL')) {
108
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
109
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
110
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS);
111
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
107
+        if ( ! defined('EE_ADMIN_URL')) {
108
+            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL.'core/admin/');
109
+            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL.'admin_pages/');
110
+            define('EE_ADMIN_TEMPLATE', EE_ADMIN.'templates'.DS);
111
+            define('WP_ADMIN_PATH', ABSPATH.'wp-admin/');
112 112
             define('WP_AJAX_URL', admin_url('admin-ajax.php'));
113 113
         }
114 114
     }
@@ -126,7 +126,7 @@  discard block
 block discarded – undo
126 126
         // set $main_file in stone
127 127
         static $main_file;
128 128
         // if $main_file is not set yet
129
-        if (! $main_file) {
129
+        if ( ! $main_file) {
130 130
             $main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
131 131
         }
132 132
         if ($plugin === $main_file) {
@@ -177,9 +177,9 @@  discard block
 block discarded – undo
177 177
     public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
178 178
     {
179 179
         return array(
180
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
181
-            'about'       => EE_ADMIN_PAGES . 'about' . DS,
182
-            'support'     => EE_ADMIN_PAGES . 'support' . DS,
180
+            'maintenance' => EE_ADMIN_PAGES.'maintenance'.DS,
181
+            'about'       => EE_ADMIN_PAGES.'about'.DS,
182
+            'support'     => EE_ADMIN_PAGES.'support'.DS,
183 183
         );
184 184
     }
185 185
 
@@ -203,7 +203,7 @@  discard block
 block discarded – undo
203 203
             $this->initModelsReady();
204 204
         }
205 205
         // run the admin page factory but ONLY if we are doing an ee admin ajax request
206
-        if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
206
+        if ( ! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
207 207
             try {
208 208
                 // this loads the controller for the admin pages which will setup routing etc
209 209
                 EE_Registry::instance()->load_core('Admin_Page_Loader');
@@ -229,7 +229,7 @@  discard block
 block discarded – undo
229 229
      */
230 230
     protected function getLoader()
231 231
     {
232
-        if (! $this->loader instanceof LoaderInterface) {
232
+        if ( ! $this->loader instanceof LoaderInterface) {
233 233
             $this->loader = LoaderFactory::getLoader();
234 234
         }
235 235
         return $this->loader;
@@ -296,13 +296,13 @@  discard block
 block discarded – undo
296 296
                     '</strong>',
297 297
                     '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
298 298
                     '</a>',
299
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
299
+                    '<a href="'.EE_Admin_Page::add_query_args_and_nonce(
300 300
                         array(
301 301
                             'page'   => 'espresso_maintenance_settings',
302 302
                             'action' => 'datetime_tools',
303 303
                         ),
304 304
                         admin_url('admin.php')
305
-                    ) . '">'
305
+                    ).'">'
306 306
                 ),
307 307
                 false,
308 308
                 'manage_options',
@@ -348,7 +348,7 @@  discard block
 block discarded – undo
348 348
     public function enable_hidden_ee_nav_menu_metaboxes()
349 349
     {
350 350
         global $wp_meta_boxes, $pagenow;
351
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
351
+        if ( ! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
352 352
             return;
353 353
         }
354 354
         $user = wp_get_current_user();
@@ -377,7 +377,7 @@  discard block
 block discarded – undo
377 377
         if (is_array($hidden_meta_boxes)) {
378 378
             foreach ($hidden_meta_boxes as $key => $meta_box_id) {
379 379
                 if (in_array($meta_box_id, $initial_meta_boxes, true)) {
380
-                    unset($hidden_meta_boxes[ $key ]);
380
+                    unset($hidden_meta_boxes[$key]);
381 381
                 }
382 382
             }
383 383
         }
@@ -417,7 +417,7 @@  discard block
 block discarded – undo
417 417
      */
418 418
     public function modify_edit_post_link($link, $id)
419 419
     {
420
-        if (! $post = get_post($id)) {
420
+        if ( ! $post = get_post($id)) {
421 421
             return $link;
422 422
         }
423 423
         if ($post->post_type === 'espresso_attendees') {
@@ -564,7 +564,7 @@  discard block
 block discarded – undo
564 564
         );
565 565
 
566 566
         foreach ($keys as $key => $value) {
567
-            $menu_item->{$key} = isset($menu_item_values[ $key ]) ? $menu_item_values[ $key ] : $value;
567
+            $menu_item->{$key} = isset($menu_item_values[$key]) ? $menu_item_values[$key] : $value;
568 568
         }
569 569
         return $menu_item;
570 570
     }
@@ -662,10 +662,10 @@  discard block
 block discarded – undo
662 662
 
663 663
         // loop through to remove any critical pages from the array.
664 664
         foreach ($critical_pages as $page_id) {
665
-            $needle = 'value="' . $page_id . '"';
665
+            $needle = 'value="'.$page_id.'"';
666 666
             foreach ($split_output as $key => $haystack) {
667 667
                 if (strpos($haystack, $needle) !== false) {
668
-                    unset($split_output[ $key ]);
668
+                    unset($split_output[$key]);
669 669
                 }
670 670
             }
671 671
         }
@@ -686,7 +686,7 @@  discard block
 block discarded – undo
686 686
         // calls.
687 687
         wp_enqueue_script(
688 688
             'ee-inject-wp',
689
-            EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
689
+            EE_ADMIN_URL.'assets/ee-cpt-wp-injects.js',
690 690
             array('jquery'),
691 691
             EVENT_ESPRESSO_VERSION,
692 692
             true
@@ -694,7 +694,7 @@  discard block
 block discarded – undo
694 694
         // register cookie script for future dependencies
695 695
         wp_register_script(
696 696
             'jquery-cookie',
697
-            EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
697
+            EE_THIRD_PARTY_URL.'joyride/jquery.cookie.js',
698 698
             array('jquery'),
699 699
             '2.1',
700 700
             true
@@ -703,16 +703,16 @@  discard block
 block discarded – undo
703 703
         // via: add_filter('FHEE_load_joyride', '__return_true' );
704 704
         if (apply_filters('FHEE_load_joyride', false)) {
705 705
             // joyride style
706
-            wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
706
+            wp_register_style('joyride-css', EE_THIRD_PARTY_URL.'joyride/joyride-2.1.css', array(), '2.1');
707 707
             wp_register_style(
708 708
                 'ee-joyride-css',
709
-                EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
709
+                EE_GLOBAL_ASSETS_URL.'css/ee-joyride-styles.css',
710 710
                 array('joyride-css'),
711 711
                 EVENT_ESPRESSO_VERSION
712 712
             );
713 713
             wp_register_script(
714 714
                 'joyride-modernizr',
715
-                EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
715
+                EE_THIRD_PARTY_URL.'joyride/modernizr.mq.js',
716 716
                 array(),
717 717
                 '2.1',
718 718
                 true
@@ -720,7 +720,7 @@  discard block
 block discarded – undo
720 720
             // joyride JS
721 721
             wp_register_script(
722 722
                 'jquery-joyride',
723
-                EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
723
+                EE_THIRD_PARTY_URL.'joyride/jquery.joyride-2.1.js',
724 724
                 array('jquery-cookie', 'joyride-modernizr'),
725 725
                 '2.1',
726 726
                 true
@@ -782,7 +782,7 @@  discard block
 block discarded – undo
782 782
 
783 783
         foreach ($items as $type => $item_properties) {
784 784
             $elements[] = sprintf(
785
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
785
+                '<a class="ee-dashboard-link-'.$type.'" href="%s" title="%s">%s</a>',
786 786
                 $item_properties['url'],
787 787
                 $item_properties['title'],
788 788
                 $item_properties['text']
@@ -807,10 +807,10 @@  discard block
 block discarded – undo
807 807
         // check for date_format or time_format
808 808
         switch ($option) {
809 809
             case 'date_format':
810
-                $date_time_format = $value . ' ' . get_option('time_format');
810
+                $date_time_format = $value.' '.get_option('time_format');
811 811
                 break;
812 812
             case 'time_format':
813
-                $date_time_format = get_option('date_format') . ' ' . $value;
813
+                $date_time_format = get_option('date_format').' '.$value;
814 814
                 break;
815 815
             default:
816 816
                 $date_time_format = false;
@@ -833,7 +833,7 @@  discard block
 block discarded – undo
833 833
 
834 834
 
835 835
                 foreach ($error_msg as $error) {
836
-                    $msg .= '<li>' . $error . '</li>';
836
+                    $msg .= '<li>'.$error.'</li>';
837 837
                 }
838 838
 
839 839
                 $msg .= '</ul></p><p>'
@@ -1024,7 +1024,7 @@  discard block
 block discarded – undo
1024 1024
     public function displayStateForCriticalPages($post_states, $post)
1025 1025
     {
1026 1026
         $post_states = (array) $post_states;
1027
-        if (! $post instanceof WP_Post || $post->post_type !== 'page') {
1027
+        if ( ! $post instanceof WP_Post || $post->post_type !== 'page') {
1028 1028
             return $post_states;
1029 1029
         }
1030 1030
         /** @var EE_Core_Config $config */
Please login to merge, or discard this patch.
admin/extend/registrations/EE_Registration_CheckIn_List_Table.class.php 2 patches
Indentation   +222 added lines, -222 removed lines patch added patch discarded remove patch
@@ -18,226 +18,226 @@
 block discarded – undo
18 18
 class EE_Registration_CheckIn_List_Table extends EE_Admin_List_Table
19 19
 {
20 20
 
21
-    /**
22
-     * EE_Registration_CheckIn_List_Table constructor.
23
-     *
24
-     * @param EE_Admin_Page $admin_page
25
-     */
26
-    public function __construct($admin_page)
27
-    {
28
-        parent::__construct($admin_page);
29
-    }
30
-
31
-
32
-    /**
33
-     * @throws EE_Error
34
-     */
35
-    protected function _setup_data()
36
-    {
37
-        $this->_data = $this->_get_checkins($this->_per_page);
38
-        $this->_all_data_count = $this->_get_checkins($this->_per_page, true);
39
-    }
40
-
41
-
42
-    /**
43
-     * Sets up the properties for the list table.
44
-     */
45
-    protected function _set_properties()
46
-    {
47
-        $this->_wp_list_args = array(
48
-            'singular' => __('check-in', 'event_espresso'),
49
-            'plural'   => __('check-ins', 'event_espresso'),
50
-            'ajax'     => true,
51
-            'screen'   => $this->_admin_page->get_current_screen()->id,
52
-        );
53
-
54
-        $this->_columns = array(
55
-            'cb'            => '<input type="checkbox" />', // Render a checkbox instead of text
56
-            'CHK_in'        => __('Check-In', 'event_espresso'),
57
-            'CHK_timestamp' => __('Timestamp', 'event_espresso'),
58
-        );
59
-
60
-        $this->_sortable_columns = array(
61
-            'CHK_timestamp' => array('CHK_timestamp' => true),
62
-        );
63
-
64
-        $this->_primary_column = 'CHK_in';
65
-
66
-        $this->_hidden_columns = array();
67
-    }
68
-
69
-
70
-    /**
71
-     * @return array
72
-     */
73
-    protected function _get_table_filters()
74
-    {
75
-        return [];
76
-    }
77
-
78
-
79
-    /**
80
-     * Returning an empty string to remove the search box for this view.
81
-     *
82
-     * @param string $text
83
-     * @param string $input_id
84
-     * @return string
85
-     */
86
-    public function search_box($text, $input_id)
87
-    {
88
-        return '';
89
-    }
90
-
91
-
92
-    /**
93
-     * @throws EE_Error
94
-     */
95
-    protected function _add_view_counts()
96
-    {
97
-        $this->_views['all']['count'] = $this->_get_checkins(null, true);
98
-    }
99
-
100
-
101
-    /**
102
-     * @param EE_Checkin $item
103
-     * @return string
104
-     * @throws EE_Error
105
-     * @throws InvalidArgumentException
106
-     * @throws ReflectionException
107
-     * @throws InvalidDataTypeException
108
-     * @throws InvalidInterfaceException
109
-     */
110
-    public function column_cb($item)
111
-    {
112
-        return sprintf('<input type="checkbox" name="checkbox[%1$s]" />', $item->ID());
113
-    }
114
-
115
-
116
-    /**
117
-     * @param EE_Checkin $item
118
-     * @return string
119
-     * @throws EE_Error
120
-     * @throws InvalidArgumentException
121
-     * @throws InvalidDataTypeException
122
-     * @throws InvalidInterfaceException
123
-     * @throws ReflectionException
124
-     */
125
-    public function column_CHK_in(EE_Checkin $item)
126
-    {
127
-        $checkin_status_dashicon = CheckinStatusDashicon::fromCheckin($item);
128
-        return '<span class="'
129
-               . $checkin_status_dashicon->cssClasses()
130
-               . '"></span><span class="show-on-mobile-view-only">'
131
-               . $item->get_datetime('CHK_timestamp')
132
-               . '</span>';
133
-    }
134
-
135
-
136
-    /**
137
-     * @param EE_Checkin $item
138
-     * @return string
139
-     * @throws EE_Error
140
-     * @throws InvalidArgumentException
141
-     * @throws InvalidDataTypeException
142
-     * @throws InvalidInterfaceException
143
-     * @throws ReflectionException
144
-     */
145
-    public function column_CHK_timestamp(EE_Checkin $item)
146
-    {
147
-        $actions = array();
148
-        $delete_url = EE_Admin_Page::add_query_args_and_nonce(
149
-            array(
150
-                'action'  => 'delete_checkin_row',
151
-                'DTT_ID'  => $this->_req_data['DTT_ID'],
152
-                '_REG_ID' => $this->_req_data['_REG_ID'],
153
-                'CHK_ID'  => $item->ID(),
154
-            )
155
-        );
156
-        $actions['delete_checkin'] = EE_Registry::instance()->CAP->current_user_can(
157
-            'ee_delete_checkins',
158
-            'espresso_registrations_delete_checkin_row'
159
-        )
160
-            ? '<a href="' . $delete_url . '" title="'
161
-              . esc_attr__('Click here to delete this check-in record', 'event_espresso') . '">'
162
-              . __('Delete', 'event_espresso') . '</a>'
163
-            : '';
164
-
165
-        return sprintf(
166
-            '%1$s %2$s',
167
-            $item->get_datetime('CHK_timestamp', '', 'H:m:s a'),
168
-            $this->row_actions($actions)
169
-        );
170
-    }
171
-
172
-
173
-    /**
174
-     * This retrieves all the Check-ins for the given parameters.
175
-     * experimenting with having the query for the table values within the list table.
176
-     *
177
-     * @param int  $per_page How many to retrieve per page
178
-     * @param bool $count    Whether to return a count or not
179
-     * @return EE_Checkin[]|int
180
-     * @throws EE_Error
181
-     * @throws InvalidArgumentException
182
-     * @throws InvalidDataTypeException
183
-     * @throws InvalidInterfaceException
184
-     */
185
-    protected function _get_checkins($per_page = 10, $count = false)
186
-    {
187
-        $REG_ID = isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : false;
188
-        $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : false;
189
-
190
-        // if user does not have the capability for the checkins for this registration then get out!
191
-        if (! EE_Registry::instance()->CAP->current_user_can(
192
-            'ee_read_checkin',
193
-            'espresso_registrations_registration_checkins',
194
-            $REG_ID
195
-        )) {
196
-            return $count ? 0 : array();
197
-        }
198
-
199
-        // if no reg id then get out cause need a reg id
200
-        if (empty($REG_ID) || empty($DTT_ID)) {
201
-            throw new EE_Error(
202
-                __(
203
-                    'This route cannot be viewed unless registration and datetime IDs are included in the request (via REG_ID and DTT_ID parameters)',
204
-                    'event_espresso'
205
-                )
206
-            );
207
-        }
208
-
209
-        // set orderby
210
-        // note that with this table we're only providing the option to orderby the timestamp value.
211
-        $orderby = 'CHK_timestamp';
212
-
213
-        $order = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
214
-
215
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
216
-            ? $this->_req_data['paged']
217
-            : 1;
218
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
219
-            ? $this->_req_data['perpage']
220
-            : $per_page;
221
-        $limit = null;
222
-        if (! $count) {
223
-            $offset = ($current_page - 1) * $per_page;
224
-            $limit = array($offset, $per_page);
225
-        }
226
-
227
-        $_where = array(
228
-            'REG_ID' => $REG_ID,
229
-            'DTT_ID' => $DTT_ID,
230
-        );
231
-
232
-        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
233
-
234
-        // if no per_page value then we just want to return a count of all Check-ins
235
-        if ($count) {
236
-            return EEM_Checkin::instance()->count(array($_where));
237
-        }
238
-
239
-        return $count
240
-            ? EEM_Checkin::instance()->count(array($_where))
241
-            : EEM_Checkin::instance()->get_all($query_params);
242
-    }
21
+	/**
22
+	 * EE_Registration_CheckIn_List_Table constructor.
23
+	 *
24
+	 * @param EE_Admin_Page $admin_page
25
+	 */
26
+	public function __construct($admin_page)
27
+	{
28
+		parent::__construct($admin_page);
29
+	}
30
+
31
+
32
+	/**
33
+	 * @throws EE_Error
34
+	 */
35
+	protected function _setup_data()
36
+	{
37
+		$this->_data = $this->_get_checkins($this->_per_page);
38
+		$this->_all_data_count = $this->_get_checkins($this->_per_page, true);
39
+	}
40
+
41
+
42
+	/**
43
+	 * Sets up the properties for the list table.
44
+	 */
45
+	protected function _set_properties()
46
+	{
47
+		$this->_wp_list_args = array(
48
+			'singular' => __('check-in', 'event_espresso'),
49
+			'plural'   => __('check-ins', 'event_espresso'),
50
+			'ajax'     => true,
51
+			'screen'   => $this->_admin_page->get_current_screen()->id,
52
+		);
53
+
54
+		$this->_columns = array(
55
+			'cb'            => '<input type="checkbox" />', // Render a checkbox instead of text
56
+			'CHK_in'        => __('Check-In', 'event_espresso'),
57
+			'CHK_timestamp' => __('Timestamp', 'event_espresso'),
58
+		);
59
+
60
+		$this->_sortable_columns = array(
61
+			'CHK_timestamp' => array('CHK_timestamp' => true),
62
+		);
63
+
64
+		$this->_primary_column = 'CHK_in';
65
+
66
+		$this->_hidden_columns = array();
67
+	}
68
+
69
+
70
+	/**
71
+	 * @return array
72
+	 */
73
+	protected function _get_table_filters()
74
+	{
75
+		return [];
76
+	}
77
+
78
+
79
+	/**
80
+	 * Returning an empty string to remove the search box for this view.
81
+	 *
82
+	 * @param string $text
83
+	 * @param string $input_id
84
+	 * @return string
85
+	 */
86
+	public function search_box($text, $input_id)
87
+	{
88
+		return '';
89
+	}
90
+
91
+
92
+	/**
93
+	 * @throws EE_Error
94
+	 */
95
+	protected function _add_view_counts()
96
+	{
97
+		$this->_views['all']['count'] = $this->_get_checkins(null, true);
98
+	}
99
+
100
+
101
+	/**
102
+	 * @param EE_Checkin $item
103
+	 * @return string
104
+	 * @throws EE_Error
105
+	 * @throws InvalidArgumentException
106
+	 * @throws ReflectionException
107
+	 * @throws InvalidDataTypeException
108
+	 * @throws InvalidInterfaceException
109
+	 */
110
+	public function column_cb($item)
111
+	{
112
+		return sprintf('<input type="checkbox" name="checkbox[%1$s]" />', $item->ID());
113
+	}
114
+
115
+
116
+	/**
117
+	 * @param EE_Checkin $item
118
+	 * @return string
119
+	 * @throws EE_Error
120
+	 * @throws InvalidArgumentException
121
+	 * @throws InvalidDataTypeException
122
+	 * @throws InvalidInterfaceException
123
+	 * @throws ReflectionException
124
+	 */
125
+	public function column_CHK_in(EE_Checkin $item)
126
+	{
127
+		$checkin_status_dashicon = CheckinStatusDashicon::fromCheckin($item);
128
+		return '<span class="'
129
+			   . $checkin_status_dashicon->cssClasses()
130
+			   . '"></span><span class="show-on-mobile-view-only">'
131
+			   . $item->get_datetime('CHK_timestamp')
132
+			   . '</span>';
133
+	}
134
+
135
+
136
+	/**
137
+	 * @param EE_Checkin $item
138
+	 * @return string
139
+	 * @throws EE_Error
140
+	 * @throws InvalidArgumentException
141
+	 * @throws InvalidDataTypeException
142
+	 * @throws InvalidInterfaceException
143
+	 * @throws ReflectionException
144
+	 */
145
+	public function column_CHK_timestamp(EE_Checkin $item)
146
+	{
147
+		$actions = array();
148
+		$delete_url = EE_Admin_Page::add_query_args_and_nonce(
149
+			array(
150
+				'action'  => 'delete_checkin_row',
151
+				'DTT_ID'  => $this->_req_data['DTT_ID'],
152
+				'_REG_ID' => $this->_req_data['_REG_ID'],
153
+				'CHK_ID'  => $item->ID(),
154
+			)
155
+		);
156
+		$actions['delete_checkin'] = EE_Registry::instance()->CAP->current_user_can(
157
+			'ee_delete_checkins',
158
+			'espresso_registrations_delete_checkin_row'
159
+		)
160
+			? '<a href="' . $delete_url . '" title="'
161
+			  . esc_attr__('Click here to delete this check-in record', 'event_espresso') . '">'
162
+			  . __('Delete', 'event_espresso') . '</a>'
163
+			: '';
164
+
165
+		return sprintf(
166
+			'%1$s %2$s',
167
+			$item->get_datetime('CHK_timestamp', '', 'H:m:s a'),
168
+			$this->row_actions($actions)
169
+		);
170
+	}
171
+
172
+
173
+	/**
174
+	 * This retrieves all the Check-ins for the given parameters.
175
+	 * experimenting with having the query for the table values within the list table.
176
+	 *
177
+	 * @param int  $per_page How many to retrieve per page
178
+	 * @param bool $count    Whether to return a count or not
179
+	 * @return EE_Checkin[]|int
180
+	 * @throws EE_Error
181
+	 * @throws InvalidArgumentException
182
+	 * @throws InvalidDataTypeException
183
+	 * @throws InvalidInterfaceException
184
+	 */
185
+	protected function _get_checkins($per_page = 10, $count = false)
186
+	{
187
+		$REG_ID = isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : false;
188
+		$DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : false;
189
+
190
+		// if user does not have the capability for the checkins for this registration then get out!
191
+		if (! EE_Registry::instance()->CAP->current_user_can(
192
+			'ee_read_checkin',
193
+			'espresso_registrations_registration_checkins',
194
+			$REG_ID
195
+		)) {
196
+			return $count ? 0 : array();
197
+		}
198
+
199
+		// if no reg id then get out cause need a reg id
200
+		if (empty($REG_ID) || empty($DTT_ID)) {
201
+			throw new EE_Error(
202
+				__(
203
+					'This route cannot be viewed unless registration and datetime IDs are included in the request (via REG_ID and DTT_ID parameters)',
204
+					'event_espresso'
205
+				)
206
+			);
207
+		}
208
+
209
+		// set orderby
210
+		// note that with this table we're only providing the option to orderby the timestamp value.
211
+		$orderby = 'CHK_timestamp';
212
+
213
+		$order = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
214
+
215
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
216
+			? $this->_req_data['paged']
217
+			: 1;
218
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
219
+			? $this->_req_data['perpage']
220
+			: $per_page;
221
+		$limit = null;
222
+		if (! $count) {
223
+			$offset = ($current_page - 1) * $per_page;
224
+			$limit = array($offset, $per_page);
225
+		}
226
+
227
+		$_where = array(
228
+			'REG_ID' => $REG_ID,
229
+			'DTT_ID' => $DTT_ID,
230
+		);
231
+
232
+		$query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
233
+
234
+		// if no per_page value then we just want to return a count of all Check-ins
235
+		if ($count) {
236
+			return EEM_Checkin::instance()->count(array($_where));
237
+		}
238
+
239
+		return $count
240
+			? EEM_Checkin::instance()->count(array($_where))
241
+			: EEM_Checkin::instance()->get_all($query_params);
242
+	}
243 243
 }
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -157,9 +157,9 @@  discard block
 block discarded – undo
157 157
             'ee_delete_checkins',
158 158
             'espresso_registrations_delete_checkin_row'
159 159
         )
160
-            ? '<a href="' . $delete_url . '" title="'
161
-              . esc_attr__('Click here to delete this check-in record', 'event_espresso') . '">'
162
-              . __('Delete', 'event_espresso') . '</a>'
160
+            ? '<a href="'.$delete_url.'" title="'
161
+              . esc_attr__('Click here to delete this check-in record', 'event_espresso').'">'
162
+              . __('Delete', 'event_espresso').'</a>'
163 163
             : '';
164 164
 
165 165
         return sprintf(
@@ -188,7 +188,7 @@  discard block
 block discarded – undo
188 188
         $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : false;
189 189
 
190 190
         // if user does not have the capability for the checkins for this registration then get out!
191
-        if (! EE_Registry::instance()->CAP->current_user_can(
191
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
192 192
             'ee_read_checkin',
193 193
             'espresso_registrations_registration_checkins',
194 194
             $REG_ID
@@ -219,7 +219,7 @@  discard block
 block discarded – undo
219 219
             ? $this->_req_data['perpage']
220 220
             : $per_page;
221 221
         $limit = null;
222
-        if (! $count) {
222
+        if ( ! $count) {
223 223
             $offset = ($current_page - 1) * $per_page;
224 224
             $limit = array($offset, $per_page);
225 225
         }
Please login to merge, or discard this patch.
core/services/assets/Registry.php 2 patches
Indentation   +583 added lines, -583 removed lines patch added patch discarded remove patch
@@ -23,594 +23,594 @@
 block discarded – undo
23 23
 class Registry
24 24
 {
25 25
 
26
-    const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
27
-
28
-    /**
29
-     * @var AssetCollection $assets
30
-     */
31
-    protected $assets;
32
-
33
-    /**
34
-     * @var I18nRegistry
35
-     */
36
-    private $i18n_registry;
37
-
38
-    /**
39
-     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
40
-     *
41
-     * @var array
42
-     */
43
-    protected $jsdata = array();
44
-
45
-    /**
46
-     * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
47
-     * page source.
48
-     *
49
-     * @var array
50
-     */
51
-    private $script_handles_with_data = array();
52
-
53
-
54
-    /**
55
-     * Holds the manifest data obtained from registered manifest files.
56
-     * Manifests are maps of asset chunk name to actual built asset file names.
57
-     * Shape of this array is:
58
-     * array(
59
-     *  'some_namespace_slug' => array(
60
-     *      'some_chunk_name' => array(
61
-     *          'js' => 'filename.js'
62
-     *          'css' => 'filename.js'
63
-     *      ),
64
-     *      'url_base' => 'https://baseurl.com/to/assets
65
-     *  )
66
-     * )
67
-     *
68
-     * @var array
69
-     */
70
-    private $manifest_data = array();
71
-
72
-
73
-    /**
74
-     * Registry constructor.
75
-     * Hooking into WP actions for script registry.
76
-     *
77
-     * @param AssetCollection $assets
78
-     * @param I18nRegistry    $i18n_registry
79
-     */
80
-    public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
81
-    {
82
-        $this->assets = $assets;
83
-        $this->i18n_registry = $i18n_registry;
84
-        add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
85
-        add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
86
-        add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
87
-        add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
88
-        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
89
-        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
90
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
91
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
92
-    }
93
-
94
-
95
-    /**
96
-     * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
97
-     * translation handling.
98
-     *
99
-     * @return I18nRegistry
100
-     */
101
-    public function getI18nRegistry()
102
-    {
103
-        return $this->i18n_registry;
104
-    }
105
-
106
-
107
-    /**
108
-     * Callback for the wp_enqueue_scripts actions used to register assets.
109
-     *
110
-     * @since 4.9.62.p
111
-     * @throws Exception
112
-     */
113
-    public function registerScriptsAndStyles()
114
-    {
115
-        try {
116
-            $this->registerScripts($this->assets->getJavascriptAssets());
117
-            $this->registerStyles($this->assets->getStylesheetAssets());
118
-        } catch (Exception $exception) {
119
-            new ExceptionStackTraceDisplay($exception);
120
-        }
121
-    }
122
-
123
-
124
-    /**
125
-     * Registers JS assets with WP core
126
-     *
127
-     * @since 4.9.62.p
128
-     * @param JavascriptAsset[] $scripts
129
-     * @throws AssetRegistrationException
130
-     * @throws InvalidDataTypeException
131
-     */
132
-    public function registerScripts(array $scripts)
133
-    {
134
-        foreach ($scripts as $script) {
135
-            // skip to next script if this has already been done
136
-            if ($script->isRegistered()) {
137
-                continue;
138
-            }
139
-            do_action(
140
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
141
-                $script
142
-            );
143
-            $registered = wp_register_script(
144
-                $script->handle(),
145
-                $script->source(),
146
-                $script->dependencies(),
147
-                $script->version(),
148
-                $script->loadInFooter()
149
-            );
150
-            if (! $registered && $this->debug()) {
151
-                throw new AssetRegistrationException($script->handle());
152
-            }
153
-            $script->setRegistered($registered);
154
-            if ($script->requiresTranslation()) {
155
-                $this->registerTranslation($script->handle());
156
-            }
157
-            do_action(
158
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
159
-                $script
160
-            );
161
-        }
162
-    }
163
-
164
-
165
-    /**
166
-     * Registers CSS assets with WP core
167
-     *
168
-     * @since 4.9.62.p
169
-     * @param StylesheetAsset[] $styles
170
-     * @throws InvalidDataTypeException
171
-     */
172
-    public function registerStyles(array $styles)
173
-    {
174
-        foreach ($styles as $style) {
175
-            // skip to next style if this has already been done
176
-            if ($style->isRegistered()) {
177
-                continue;
178
-            }
179
-            do_action(
180
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
181
-                $style
182
-            );
183
-            wp_register_style(
184
-                $style->handle(),
185
-                $style->source(),
186
-                $style->dependencies(),
187
-                $style->version(),
188
-                $style->media()
189
-            );
190
-            $style->setRegistered();
191
-            do_action(
192
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
193
-                $style
194
-            );
195
-        }
196
-    }
197
-
198
-
199
-    /**
200
-     * Call back for the script print in frontend and backend.
201
-     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
202
-     *
203
-     * @since 4.9.31.rc.015
204
-     */
205
-    public function enqueueData()
206
-    {
207
-        $this->removeAlreadyRegisteredDataForScriptHandles();
208
-        wp_add_inline_script(
209
-            'eejs-core',
210
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
211
-            'before'
212
-        );
213
-        $scripts = $this->assets->getJavascriptAssetsWithData();
214
-        foreach ($scripts as $script) {
215
-            $this->addRegisteredScriptHandlesWithData($script->handle());
216
-            if ($script->hasInlineDataCallback()) {
217
-                $localize = $script->inlineDataCallback();
218
-                $localize();
219
-            }
220
-        }
221
-    }
222
-
223
-
224
-    /**
225
-     * Used to add data to eejs.data object.
226
-     * Note:  Overriding existing data is not allowed.
227
-     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
228
-     * If the data you add is something like this:
229
-     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
230
-     * It will be exposed in the page source as:
231
-     *  eejs.data.my_plugin_data.foo == gar
232
-     *
233
-     * @param string       $key   Key used to access your data
234
-     * @param string|array $value Value to attach to key
235
-     * @throws InvalidArgumentException
236
-     */
237
-    public function addData($key, $value)
238
-    {
239
-        if ($this->verifyDataNotExisting($key)) {
240
-            $this->jsdata[ $key ] = $value;
241
-        }
242
-    }
243
-
244
-
245
-    /**
246
-     * Similar to addData except this allows for users to push values to an existing key where the values on key are
247
-     * elements in an array.
248
-     *
249
-     * When you use this method, the value you include will be merged with the array on $key.
250
-     * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
251
-     * object like this, eejs.data.test = [ my_data,
252
-     * ]
253
-     * If there has already been a scalar value attached to the data object given key (via addData for instance), then
254
-     * this will throw an exception.
255
-     *
256
-     * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
257
-     * key potentially overriding the existing data on merge (specifically with associative arrays).
258
-     *
259
-     * @param string       $key   Key to attach data to.
260
-     * @param string|array $value Value being registered.
261
-     * @throws InvalidArgumentException
262
-     */
263
-    public function pushData($key, $value)
264
-    {
265
-        if (isset($this->jsdata[ $key ])
266
-            && ! is_array($this->jsdata[ $key ])
267
-        ) {
268
-            if (! $this->debug()) {
269
-                return;
270
-            }
271
-            throw new InvalidArgumentException(
272
-                sprintf(
273
-                    __(
274
-                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
26
+	const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
27
+
28
+	/**
29
+	 * @var AssetCollection $assets
30
+	 */
31
+	protected $assets;
32
+
33
+	/**
34
+	 * @var I18nRegistry
35
+	 */
36
+	private $i18n_registry;
37
+
38
+	/**
39
+	 * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
40
+	 *
41
+	 * @var array
42
+	 */
43
+	protected $jsdata = array();
44
+
45
+	/**
46
+	 * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
47
+	 * page source.
48
+	 *
49
+	 * @var array
50
+	 */
51
+	private $script_handles_with_data = array();
52
+
53
+
54
+	/**
55
+	 * Holds the manifest data obtained from registered manifest files.
56
+	 * Manifests are maps of asset chunk name to actual built asset file names.
57
+	 * Shape of this array is:
58
+	 * array(
59
+	 *  'some_namespace_slug' => array(
60
+	 *      'some_chunk_name' => array(
61
+	 *          'js' => 'filename.js'
62
+	 *          'css' => 'filename.js'
63
+	 *      ),
64
+	 *      'url_base' => 'https://baseurl.com/to/assets
65
+	 *  )
66
+	 * )
67
+	 *
68
+	 * @var array
69
+	 */
70
+	private $manifest_data = array();
71
+
72
+
73
+	/**
74
+	 * Registry constructor.
75
+	 * Hooking into WP actions for script registry.
76
+	 *
77
+	 * @param AssetCollection $assets
78
+	 * @param I18nRegistry    $i18n_registry
79
+	 */
80
+	public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
81
+	{
82
+		$this->assets = $assets;
83
+		$this->i18n_registry = $i18n_registry;
84
+		add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
85
+		add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
86
+		add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
87
+		add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
88
+		add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
89
+		add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
90
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
91
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
92
+	}
93
+
94
+
95
+	/**
96
+	 * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
97
+	 * translation handling.
98
+	 *
99
+	 * @return I18nRegistry
100
+	 */
101
+	public function getI18nRegistry()
102
+	{
103
+		return $this->i18n_registry;
104
+	}
105
+
106
+
107
+	/**
108
+	 * Callback for the wp_enqueue_scripts actions used to register assets.
109
+	 *
110
+	 * @since 4.9.62.p
111
+	 * @throws Exception
112
+	 */
113
+	public function registerScriptsAndStyles()
114
+	{
115
+		try {
116
+			$this->registerScripts($this->assets->getJavascriptAssets());
117
+			$this->registerStyles($this->assets->getStylesheetAssets());
118
+		} catch (Exception $exception) {
119
+			new ExceptionStackTraceDisplay($exception);
120
+		}
121
+	}
122
+
123
+
124
+	/**
125
+	 * Registers JS assets with WP core
126
+	 *
127
+	 * @since 4.9.62.p
128
+	 * @param JavascriptAsset[] $scripts
129
+	 * @throws AssetRegistrationException
130
+	 * @throws InvalidDataTypeException
131
+	 */
132
+	public function registerScripts(array $scripts)
133
+	{
134
+		foreach ($scripts as $script) {
135
+			// skip to next script if this has already been done
136
+			if ($script->isRegistered()) {
137
+				continue;
138
+			}
139
+			do_action(
140
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
141
+				$script
142
+			);
143
+			$registered = wp_register_script(
144
+				$script->handle(),
145
+				$script->source(),
146
+				$script->dependencies(),
147
+				$script->version(),
148
+				$script->loadInFooter()
149
+			);
150
+			if (! $registered && $this->debug()) {
151
+				throw new AssetRegistrationException($script->handle());
152
+			}
153
+			$script->setRegistered($registered);
154
+			if ($script->requiresTranslation()) {
155
+				$this->registerTranslation($script->handle());
156
+			}
157
+			do_action(
158
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
159
+				$script
160
+			);
161
+		}
162
+	}
163
+
164
+
165
+	/**
166
+	 * Registers CSS assets with WP core
167
+	 *
168
+	 * @since 4.9.62.p
169
+	 * @param StylesheetAsset[] $styles
170
+	 * @throws InvalidDataTypeException
171
+	 */
172
+	public function registerStyles(array $styles)
173
+	{
174
+		foreach ($styles as $style) {
175
+			// skip to next style if this has already been done
176
+			if ($style->isRegistered()) {
177
+				continue;
178
+			}
179
+			do_action(
180
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
181
+				$style
182
+			);
183
+			wp_register_style(
184
+				$style->handle(),
185
+				$style->source(),
186
+				$style->dependencies(),
187
+				$style->version(),
188
+				$style->media()
189
+			);
190
+			$style->setRegistered();
191
+			do_action(
192
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
193
+				$style
194
+			);
195
+		}
196
+	}
197
+
198
+
199
+	/**
200
+	 * Call back for the script print in frontend and backend.
201
+	 * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
202
+	 *
203
+	 * @since 4.9.31.rc.015
204
+	 */
205
+	public function enqueueData()
206
+	{
207
+		$this->removeAlreadyRegisteredDataForScriptHandles();
208
+		wp_add_inline_script(
209
+			'eejs-core',
210
+			'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
211
+			'before'
212
+		);
213
+		$scripts = $this->assets->getJavascriptAssetsWithData();
214
+		foreach ($scripts as $script) {
215
+			$this->addRegisteredScriptHandlesWithData($script->handle());
216
+			if ($script->hasInlineDataCallback()) {
217
+				$localize = $script->inlineDataCallback();
218
+				$localize();
219
+			}
220
+		}
221
+	}
222
+
223
+
224
+	/**
225
+	 * Used to add data to eejs.data object.
226
+	 * Note:  Overriding existing data is not allowed.
227
+	 * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
228
+	 * If the data you add is something like this:
229
+	 *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
230
+	 * It will be exposed in the page source as:
231
+	 *  eejs.data.my_plugin_data.foo == gar
232
+	 *
233
+	 * @param string       $key   Key used to access your data
234
+	 * @param string|array $value Value to attach to key
235
+	 * @throws InvalidArgumentException
236
+	 */
237
+	public function addData($key, $value)
238
+	{
239
+		if ($this->verifyDataNotExisting($key)) {
240
+			$this->jsdata[ $key ] = $value;
241
+		}
242
+	}
243
+
244
+
245
+	/**
246
+	 * Similar to addData except this allows for users to push values to an existing key where the values on key are
247
+	 * elements in an array.
248
+	 *
249
+	 * When you use this method, the value you include will be merged with the array on $key.
250
+	 * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
251
+	 * object like this, eejs.data.test = [ my_data,
252
+	 * ]
253
+	 * If there has already been a scalar value attached to the data object given key (via addData for instance), then
254
+	 * this will throw an exception.
255
+	 *
256
+	 * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
257
+	 * key potentially overriding the existing data on merge (specifically with associative arrays).
258
+	 *
259
+	 * @param string       $key   Key to attach data to.
260
+	 * @param string|array $value Value being registered.
261
+	 * @throws InvalidArgumentException
262
+	 */
263
+	public function pushData($key, $value)
264
+	{
265
+		if (isset($this->jsdata[ $key ])
266
+			&& ! is_array($this->jsdata[ $key ])
267
+		) {
268
+			if (! $this->debug()) {
269
+				return;
270
+			}
271
+			throw new InvalidArgumentException(
272
+				sprintf(
273
+					__(
274
+						'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
275 275
                          push values to this data element when it is an array.',
276
-                        'event_espresso'
277
-                    ),
278
-                    $key,
279
-                    __METHOD__
280
-                )
281
-            );
282
-        }
283
-        if ( ! isset( $this->jsdata[ $key ] ) ) {
284
-            $this->jsdata[ $key ] = is_array($value) ? $value : [$value];
285
-        } else {
286
-            $this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
287
-        }
288
-    }
289
-
290
-
291
-    /**
292
-     * Used to set content used by javascript for a template.
293
-     * Note: Overrides of existing registered templates are not allowed.
294
-     *
295
-     * @param string $template_reference
296
-     * @param string $template_content
297
-     * @throws InvalidArgumentException
298
-     */
299
-    public function addTemplate($template_reference, $template_content)
300
-    {
301
-        if (! isset($this->jsdata['templates'])) {
302
-            $this->jsdata['templates'] = array();
303
-        }
304
-        //no overrides allowed.
305
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
306
-            if (! $this->debug()) {
307
-                return;
308
-            }
309
-            throw new InvalidArgumentException(
310
-                sprintf(
311
-                    __(
312
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
313
-                        'event_espresso'
314
-                    ),
315
-                    $template_reference
316
-                )
317
-            );
318
-        }
319
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
320
-    }
321
-
322
-
323
-    /**
324
-     * Retrieve the template content already registered for the given reference.
325
-     *
326
-     * @param string $template_reference
327
-     * @return string
328
-     */
329
-    public function getTemplate($template_reference)
330
-    {
331
-        return isset($this->jsdata['templates'][ $template_reference ])
332
-            ? $this->jsdata['templates'][ $template_reference ]
333
-            : '';
334
-    }
335
-
336
-
337
-    /**
338
-     * Retrieve registered data.
339
-     *
340
-     * @param string $key Name of key to attach data to.
341
-     * @return mixed                If there is no for the given key, then false is returned.
342
-     */
343
-    public function getData($key)
344
-    {
345
-        return isset($this->jsdata[ $key ])
346
-            ? $this->jsdata[ $key ]
347
-            : false;
348
-    }
349
-
350
-
351
-    /**
352
-     * Verifies whether the given data exists already on the jsdata array.
353
-     * Overriding data is not allowed.
354
-     *
355
-     * @param string $key Index for data.
356
-     * @return bool        If valid then return true.
357
-     * @throws InvalidArgumentException if data already exists.
358
-     */
359
-    protected function verifyDataNotExisting($key)
360
-    {
361
-        if (isset($this->jsdata[ $key ])) {
362
-            if (! $this->debug()) {
363
-                return false;
364
-            }
365
-            if (is_array($this->jsdata[ $key ])) {
366
-                throw new InvalidArgumentException(
367
-                    sprintf(
368
-                        __(
369
-                            'The value for %1$s already exists in the Registry::eejs object.
276
+						'event_espresso'
277
+					),
278
+					$key,
279
+					__METHOD__
280
+				)
281
+			);
282
+		}
283
+		if ( ! isset( $this->jsdata[ $key ] ) ) {
284
+			$this->jsdata[ $key ] = is_array($value) ? $value : [$value];
285
+		} else {
286
+			$this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
287
+		}
288
+	}
289
+
290
+
291
+	/**
292
+	 * Used to set content used by javascript for a template.
293
+	 * Note: Overrides of existing registered templates are not allowed.
294
+	 *
295
+	 * @param string $template_reference
296
+	 * @param string $template_content
297
+	 * @throws InvalidArgumentException
298
+	 */
299
+	public function addTemplate($template_reference, $template_content)
300
+	{
301
+		if (! isset($this->jsdata['templates'])) {
302
+			$this->jsdata['templates'] = array();
303
+		}
304
+		//no overrides allowed.
305
+		if (isset($this->jsdata['templates'][ $template_reference ])) {
306
+			if (! $this->debug()) {
307
+				return;
308
+			}
309
+			throw new InvalidArgumentException(
310
+				sprintf(
311
+					__(
312
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
313
+						'event_espresso'
314
+					),
315
+					$template_reference
316
+				)
317
+			);
318
+		}
319
+		$this->jsdata['templates'][ $template_reference ] = $template_content;
320
+	}
321
+
322
+
323
+	/**
324
+	 * Retrieve the template content already registered for the given reference.
325
+	 *
326
+	 * @param string $template_reference
327
+	 * @return string
328
+	 */
329
+	public function getTemplate($template_reference)
330
+	{
331
+		return isset($this->jsdata['templates'][ $template_reference ])
332
+			? $this->jsdata['templates'][ $template_reference ]
333
+			: '';
334
+	}
335
+
336
+
337
+	/**
338
+	 * Retrieve registered data.
339
+	 *
340
+	 * @param string $key Name of key to attach data to.
341
+	 * @return mixed                If there is no for the given key, then false is returned.
342
+	 */
343
+	public function getData($key)
344
+	{
345
+		return isset($this->jsdata[ $key ])
346
+			? $this->jsdata[ $key ]
347
+			: false;
348
+	}
349
+
350
+
351
+	/**
352
+	 * Verifies whether the given data exists already on the jsdata array.
353
+	 * Overriding data is not allowed.
354
+	 *
355
+	 * @param string $key Index for data.
356
+	 * @return bool        If valid then return true.
357
+	 * @throws InvalidArgumentException if data already exists.
358
+	 */
359
+	protected function verifyDataNotExisting($key)
360
+	{
361
+		if (isset($this->jsdata[ $key ])) {
362
+			if (! $this->debug()) {
363
+				return false;
364
+			}
365
+			if (is_array($this->jsdata[ $key ])) {
366
+				throw new InvalidArgumentException(
367
+					sprintf(
368
+						__(
369
+							'The value for %1$s already exists in the Registry::eejs object.
370 370
                             Overrides are not allowed. Since the value of this data is an array, you may want to use the
371 371
                             %2$s method to push your value to the array.',
372
-                            'event_espresso'
373
-                        ),
374
-                        $key,
375
-                        'pushData()'
376
-                    )
377
-                );
378
-            }
379
-            throw new InvalidArgumentException(
380
-                sprintf(
381
-                    __(
382
-                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
372
+							'event_espresso'
373
+						),
374
+						$key,
375
+						'pushData()'
376
+					)
377
+				);
378
+			}
379
+			throw new InvalidArgumentException(
380
+				sprintf(
381
+					__(
382
+						'The value for %1$s already exists in the Registry::eejs object. Overrides are not
383 383
                         allowed.  Consider attaching your value to a different key',
384
-                        'event_espresso'
385
-                    ),
386
-                    $key
387
-                )
388
-            );
389
-        }
390
-        return true;
391
-    }
392
-
393
-
394
-    /**
395
-     * Get the actual asset path for asset manifests.
396
-     * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
397
-     *
398
-     * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
399
-     *                           asset file location.
400
-     * @param string $chunk_name
401
-     * @param string $asset_type
402
-     * @return string
403
-     * @since 4.9.59.p
404
-     */
405
-    public function getAssetUrl($namespace, $chunk_name, $asset_type)
406
-    {
407
-        $url = isset(
408
-            $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
409
-            $this->manifest_data[ $namespace ]['url_base']
410
-        )
411
-            ? $this->manifest_data[ $namespace ]['url_base']
412
-              . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
413
-            : $chunk_name;
414
-        return apply_filters(
415
-            'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
416
-            $url,
417
-            $namespace,
418
-            $chunk_name,
419
-            $asset_type
420
-        );
421
-    }
422
-
423
-
424
-
425
-    /**
426
-     * Return the url to a js file for the given namespace and chunk name.
427
-     *
428
-     * @param string $namespace
429
-     * @param string $chunk_name
430
-     * @return string
431
-     */
432
-    public function getJsUrl($namespace, $chunk_name)
433
-    {
434
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
435
-    }
436
-
437
-
438
-    /**
439
-     * Return the url to a css file for the given namespace and chunk name.
440
-     *
441
-     * @param string $namespace
442
-     * @param string $chunk_name
443
-     * @return string
444
-     */
445
-    public function getCssUrl($namespace, $chunk_name)
446
-    {
447
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
448
-    }
449
-
450
-
451
-    /**
452
-     * @since 4.9.62.p
453
-     * @throws InvalidArgumentException
454
-     * @throws InvalidFilePathException
455
-     */
456
-    public function registerManifestFiles()
457
-    {
458
-        $manifest_files = $this->assets->getManifestFiles();
459
-        foreach ($manifest_files as $manifest_file) {
460
-            $this->registerManifestFile(
461
-                $manifest_file->assetNamespace(),
462
-                $manifest_file->urlBase(),
463
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
464
-            );
465
-        }
466
-    }
467
-
468
-
469
-    /**
470
-     * Used to register a js/css manifest file with the registered_manifest_files property.
471
-     *
472
-     * @param string $namespace     Provided to associate the manifest file with a specific namespace.
473
-     * @param string $url_base      The url base for the manifest file location.
474
-     * @param string $manifest_file The absolute path to the manifest file.
475
-     * @throws InvalidArgumentException
476
-     * @throws InvalidFilePathException
477
-     * @since 4.9.59.p
478
-     */
479
-    public function registerManifestFile($namespace, $url_base, $manifest_file)
480
-    {
481
-        if (isset($this->manifest_data[ $namespace ])) {
482
-            if (! $this->debug()) {
483
-                return;
484
-            }
485
-            throw new InvalidArgumentException(
486
-                sprintf(
487
-                    esc_html__(
488
-                        'The namespace for this manifest file has already been registered, choose a namespace other than %s',
489
-                        'event_espresso'
490
-                    ),
491
-                    $namespace
492
-                )
493
-            );
494
-        }
495
-        if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
496
-            if (is_admin()) {
497
-                EE_Error::add_error(
498
-                    sprintf(
499
-                        esc_html__(
500
-                            'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
501
-                            'event_espresso'
502
-                        ),
503
-                        'Event Espresso',
504
-                        $url_base,
505
-                        'plugins_url',
506
-                        'WP_PLUGIN_URL'
507
-                    ),
508
-                    __FILE__,
509
-                    __FUNCTION__,
510
-                    __LINE__
511
-                );
512
-            }
513
-            return;
514
-        }
515
-        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
516
-        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
517
-            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
518
-        }
519
-    }
520
-
521
-
522
-    /**
523
-     * Decodes json from the provided manifest file.
524
-     *
525
-     * @since 4.9.59.p
526
-     * @param string $manifest_file Path to manifest file.
527
-     * @return array
528
-     * @throws InvalidFilePathException
529
-     */
530
-    private function decodeManifestFile($manifest_file)
531
-    {
532
-        if (! file_exists($manifest_file)) {
533
-            throw new InvalidFilePathException($manifest_file);
534
-        }
535
-        return json_decode(file_get_contents($manifest_file), true);
536
-    }
537
-
538
-
539
-    /**
540
-     * This is used to set registered script handles that have data.
541
-     *
542
-     * @param string $script_handle
543
-     */
544
-    private function addRegisteredScriptHandlesWithData($script_handle)
545
-    {
546
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
547
-    }
548
-
549
-
550
-    /**i
384
+						'event_espresso'
385
+					),
386
+					$key
387
+				)
388
+			);
389
+		}
390
+		return true;
391
+	}
392
+
393
+
394
+	/**
395
+	 * Get the actual asset path for asset manifests.
396
+	 * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
397
+	 *
398
+	 * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
399
+	 *                           asset file location.
400
+	 * @param string $chunk_name
401
+	 * @param string $asset_type
402
+	 * @return string
403
+	 * @since 4.9.59.p
404
+	 */
405
+	public function getAssetUrl($namespace, $chunk_name, $asset_type)
406
+	{
407
+		$url = isset(
408
+			$this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
409
+			$this->manifest_data[ $namespace ]['url_base']
410
+		)
411
+			? $this->manifest_data[ $namespace ]['url_base']
412
+			  . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
413
+			: $chunk_name;
414
+		return apply_filters(
415
+			'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
416
+			$url,
417
+			$namespace,
418
+			$chunk_name,
419
+			$asset_type
420
+		);
421
+	}
422
+
423
+
424
+
425
+	/**
426
+	 * Return the url to a js file for the given namespace and chunk name.
427
+	 *
428
+	 * @param string $namespace
429
+	 * @param string $chunk_name
430
+	 * @return string
431
+	 */
432
+	public function getJsUrl($namespace, $chunk_name)
433
+	{
434
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
435
+	}
436
+
437
+
438
+	/**
439
+	 * Return the url to a css file for the given namespace and chunk name.
440
+	 *
441
+	 * @param string $namespace
442
+	 * @param string $chunk_name
443
+	 * @return string
444
+	 */
445
+	public function getCssUrl($namespace, $chunk_name)
446
+	{
447
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
448
+	}
449
+
450
+
451
+	/**
452
+	 * @since 4.9.62.p
453
+	 * @throws InvalidArgumentException
454
+	 * @throws InvalidFilePathException
455
+	 */
456
+	public function registerManifestFiles()
457
+	{
458
+		$manifest_files = $this->assets->getManifestFiles();
459
+		foreach ($manifest_files as $manifest_file) {
460
+			$this->registerManifestFile(
461
+				$manifest_file->assetNamespace(),
462
+				$manifest_file->urlBase(),
463
+				$manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
464
+			);
465
+		}
466
+	}
467
+
468
+
469
+	/**
470
+	 * Used to register a js/css manifest file with the registered_manifest_files property.
471
+	 *
472
+	 * @param string $namespace     Provided to associate the manifest file with a specific namespace.
473
+	 * @param string $url_base      The url base for the manifest file location.
474
+	 * @param string $manifest_file The absolute path to the manifest file.
475
+	 * @throws InvalidArgumentException
476
+	 * @throws InvalidFilePathException
477
+	 * @since 4.9.59.p
478
+	 */
479
+	public function registerManifestFile($namespace, $url_base, $manifest_file)
480
+	{
481
+		if (isset($this->manifest_data[ $namespace ])) {
482
+			if (! $this->debug()) {
483
+				return;
484
+			}
485
+			throw new InvalidArgumentException(
486
+				sprintf(
487
+					esc_html__(
488
+						'The namespace for this manifest file has already been registered, choose a namespace other than %s',
489
+						'event_espresso'
490
+					),
491
+					$namespace
492
+				)
493
+			);
494
+		}
495
+		if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
496
+			if (is_admin()) {
497
+				EE_Error::add_error(
498
+					sprintf(
499
+						esc_html__(
500
+							'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
501
+							'event_espresso'
502
+						),
503
+						'Event Espresso',
504
+						$url_base,
505
+						'plugins_url',
506
+						'WP_PLUGIN_URL'
507
+					),
508
+					__FILE__,
509
+					__FUNCTION__,
510
+					__LINE__
511
+				);
512
+			}
513
+			return;
514
+		}
515
+		$this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
516
+		if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
517
+			$this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
518
+		}
519
+	}
520
+
521
+
522
+	/**
523
+	 * Decodes json from the provided manifest file.
524
+	 *
525
+	 * @since 4.9.59.p
526
+	 * @param string $manifest_file Path to manifest file.
527
+	 * @return array
528
+	 * @throws InvalidFilePathException
529
+	 */
530
+	private function decodeManifestFile($manifest_file)
531
+	{
532
+		if (! file_exists($manifest_file)) {
533
+			throw new InvalidFilePathException($manifest_file);
534
+		}
535
+		return json_decode(file_get_contents($manifest_file), true);
536
+	}
537
+
538
+
539
+	/**
540
+	 * This is used to set registered script handles that have data.
541
+	 *
542
+	 * @param string $script_handle
543
+	 */
544
+	private function addRegisteredScriptHandlesWithData($script_handle)
545
+	{
546
+		$this->script_handles_with_data[ $script_handle ] = $script_handle;
547
+	}
548
+
549
+
550
+	/**i
551 551
      * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the
552 552
      * Dependency stored in WP_Scripts if its set.
553 553
      */
554
-    private function removeAlreadyRegisteredDataForScriptHandles()
555
-    {
556
-        if (empty($this->script_handles_with_data)) {
557
-            return;
558
-        }
559
-        foreach ($this->script_handles_with_data as $script_handle) {
560
-            $this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
561
-        }
562
-    }
563
-
564
-
565
-    /**
566
-     * Removes any data dependency registered in WP_Scripts if its set.
567
-     *
568
-     * @param string $script_handle
569
-     */
570
-    private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
571
-    {
572
-        if (isset($this->script_handles_with_data[ $script_handle ])) {
573
-            global $wp_scripts;
574
-            $unset_handle = false;
575
-            if ($wp_scripts->get_data($script_handle, 'data')) {
576
-                unset($wp_scripts->registered[ $script_handle ]->extra['data']);
577
-                $unset_handle = true;
578
-            }
579
-            //deal with inline_scripts
580
-            if ($wp_scripts->get_data($script_handle, 'before')) {
581
-                unset($wp_scripts->registered[ $script_handle ]->extra['before']);
582
-                $unset_handle = true;
583
-            }
584
-            if ($wp_scripts->get_data($script_handle, 'after')) {
585
-                unset($wp_scripts->registered[ $script_handle ]->extra['after']);
586
-            }
587
-            if ($unset_handle) {
588
-                unset($this->script_handles_with_data[ $script_handle ]);
589
-            }
590
-        }
591
-    }
592
-
593
-
594
-    /**
595
-     * register translations for a registered script
596
-     *
597
-     * @param string $handle
598
-     */
599
-    public function registerTranslation($handle)
600
-    {
601
-        $this->i18n_registry->registerScriptI18n($handle);
602
-    }
603
-
604
-
605
-    /**
606
-     * @since 4.9.63.p
607
-     * @return bool
608
-     */
609
-    private function debug()
610
-    {
611
-        return apply_filters(
612
-            'FHEE__EventEspresso_core_services_assets_Registry__debug',
613
-            defined('EE_DEBUG') && EE_DEBUG
614
-        );
615
-    }
554
+	private function removeAlreadyRegisteredDataForScriptHandles()
555
+	{
556
+		if (empty($this->script_handles_with_data)) {
557
+			return;
558
+		}
559
+		foreach ($this->script_handles_with_data as $script_handle) {
560
+			$this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
561
+		}
562
+	}
563
+
564
+
565
+	/**
566
+	 * Removes any data dependency registered in WP_Scripts if its set.
567
+	 *
568
+	 * @param string $script_handle
569
+	 */
570
+	private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
571
+	{
572
+		if (isset($this->script_handles_with_data[ $script_handle ])) {
573
+			global $wp_scripts;
574
+			$unset_handle = false;
575
+			if ($wp_scripts->get_data($script_handle, 'data')) {
576
+				unset($wp_scripts->registered[ $script_handle ]->extra['data']);
577
+				$unset_handle = true;
578
+			}
579
+			//deal with inline_scripts
580
+			if ($wp_scripts->get_data($script_handle, 'before')) {
581
+				unset($wp_scripts->registered[ $script_handle ]->extra['before']);
582
+				$unset_handle = true;
583
+			}
584
+			if ($wp_scripts->get_data($script_handle, 'after')) {
585
+				unset($wp_scripts->registered[ $script_handle ]->extra['after']);
586
+			}
587
+			if ($unset_handle) {
588
+				unset($this->script_handles_with_data[ $script_handle ]);
589
+			}
590
+		}
591
+	}
592
+
593
+
594
+	/**
595
+	 * register translations for a registered script
596
+	 *
597
+	 * @param string $handle
598
+	 */
599
+	public function registerTranslation($handle)
600
+	{
601
+		$this->i18n_registry->registerScriptI18n($handle);
602
+	}
603
+
604
+
605
+	/**
606
+	 * @since 4.9.63.p
607
+	 * @return bool
608
+	 */
609
+	private function debug()
610
+	{
611
+		return apply_filters(
612
+			'FHEE__EventEspresso_core_services_assets_Registry__debug',
613
+			defined('EE_DEBUG') && EE_DEBUG
614
+		);
615
+	}
616 616
 }
Please login to merge, or discard this patch.
Spacing   +37 added lines, -37 removed lines patch added patch discarded remove patch
@@ -147,7 +147,7 @@  discard block
 block discarded – undo
147 147
                 $script->version(),
148 148
                 $script->loadInFooter()
149 149
             );
150
-            if (! $registered && $this->debug()) {
150
+            if ( ! $registered && $this->debug()) {
151 151
                 throw new AssetRegistrationException($script->handle());
152 152
             }
153 153
             $script->setRegistered($registered);
@@ -207,7 +207,7 @@  discard block
 block discarded – undo
207 207
         $this->removeAlreadyRegisteredDataForScriptHandles();
208 208
         wp_add_inline_script(
209 209
             'eejs-core',
210
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
210
+            'var eejsdata='.wp_json_encode(array('data' => $this->jsdata)),
211 211
             'before'
212 212
         );
213 213
         $scripts = $this->assets->getJavascriptAssetsWithData();
@@ -237,7 +237,7 @@  discard block
 block discarded – undo
237 237
     public function addData($key, $value)
238 238
     {
239 239
         if ($this->verifyDataNotExisting($key)) {
240
-            $this->jsdata[ $key ] = $value;
240
+            $this->jsdata[$key] = $value;
241 241
         }
242 242
     }
243 243
 
@@ -262,10 +262,10 @@  discard block
 block discarded – undo
262 262
      */
263 263
     public function pushData($key, $value)
264 264
     {
265
-        if (isset($this->jsdata[ $key ])
266
-            && ! is_array($this->jsdata[ $key ])
265
+        if (isset($this->jsdata[$key])
266
+            && ! is_array($this->jsdata[$key])
267 267
         ) {
268
-            if (! $this->debug()) {
268
+            if ( ! $this->debug()) {
269 269
                 return;
270 270
             }
271 271
             throw new InvalidArgumentException(
@@ -280,10 +280,10 @@  discard block
 block discarded – undo
280 280
                 )
281 281
             );
282 282
         }
283
-        if ( ! isset( $this->jsdata[ $key ] ) ) {
284
-            $this->jsdata[ $key ] = is_array($value) ? $value : [$value];
283
+        if ( ! isset($this->jsdata[$key])) {
284
+            $this->jsdata[$key] = is_array($value) ? $value : [$value];
285 285
         } else {
286
-            $this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
286
+            $this->jsdata[$key] = array_merge($this->jsdata[$key], (array) $value);
287 287
         }
288 288
     }
289 289
 
@@ -298,12 +298,12 @@  discard block
 block discarded – undo
298 298
      */
299 299
     public function addTemplate($template_reference, $template_content)
300 300
     {
301
-        if (! isset($this->jsdata['templates'])) {
301
+        if ( ! isset($this->jsdata['templates'])) {
302 302
             $this->jsdata['templates'] = array();
303 303
         }
304 304
         //no overrides allowed.
305
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
306
-            if (! $this->debug()) {
305
+        if (isset($this->jsdata['templates'][$template_reference])) {
306
+            if ( ! $this->debug()) {
307 307
                 return;
308 308
             }
309 309
             throw new InvalidArgumentException(
@@ -316,7 +316,7 @@  discard block
 block discarded – undo
316 316
                 )
317 317
             );
318 318
         }
319
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
319
+        $this->jsdata['templates'][$template_reference] = $template_content;
320 320
     }
321 321
 
322 322
 
@@ -328,8 +328,8 @@  discard block
 block discarded – undo
328 328
      */
329 329
     public function getTemplate($template_reference)
330 330
     {
331
-        return isset($this->jsdata['templates'][ $template_reference ])
332
-            ? $this->jsdata['templates'][ $template_reference ]
331
+        return isset($this->jsdata['templates'][$template_reference])
332
+            ? $this->jsdata['templates'][$template_reference]
333 333
             : '';
334 334
     }
335 335
 
@@ -342,8 +342,8 @@  discard block
 block discarded – undo
342 342
      */
343 343
     public function getData($key)
344 344
     {
345
-        return isset($this->jsdata[ $key ])
346
-            ? $this->jsdata[ $key ]
345
+        return isset($this->jsdata[$key])
346
+            ? $this->jsdata[$key]
347 347
             : false;
348 348
     }
349 349
 
@@ -358,11 +358,11 @@  discard block
 block discarded – undo
358 358
      */
359 359
     protected function verifyDataNotExisting($key)
360 360
     {
361
-        if (isset($this->jsdata[ $key ])) {
362
-            if (! $this->debug()) {
361
+        if (isset($this->jsdata[$key])) {
362
+            if ( ! $this->debug()) {
363 363
                 return false;
364 364
             }
365
-            if (is_array($this->jsdata[ $key ])) {
365
+            if (is_array($this->jsdata[$key])) {
366 366
                 throw new InvalidArgumentException(
367 367
                     sprintf(
368 368
                         __(
@@ -405,11 +405,11 @@  discard block
 block discarded – undo
405 405
     public function getAssetUrl($namespace, $chunk_name, $asset_type)
406 406
     {
407 407
         $url = isset(
408
-            $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
409
-            $this->manifest_data[ $namespace ]['url_base']
408
+            $this->manifest_data[$namespace][$chunk_name.'.'.$asset_type],
409
+            $this->manifest_data[$namespace]['url_base']
410 410
         )
411
-            ? $this->manifest_data[ $namespace ]['url_base']
412
-              . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
411
+            ? $this->manifest_data[$namespace]['url_base']
412
+              . $this->manifest_data[$namespace][$chunk_name.'.'.$asset_type]
413 413
             : $chunk_name;
414 414
         return apply_filters(
415 415
             'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
@@ -460,7 +460,7 @@  discard block
 block discarded – undo
460 460
             $this->registerManifestFile(
461 461
                 $manifest_file->assetNamespace(),
462 462
                 $manifest_file->urlBase(),
463
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
463
+                $manifest_file->filepath().Registry::FILE_NAME_BUILD_MANIFEST
464 464
             );
465 465
         }
466 466
     }
@@ -478,8 +478,8 @@  discard block
 block discarded – undo
478 478
      */
479 479
     public function registerManifestFile($namespace, $url_base, $manifest_file)
480 480
     {
481
-        if (isset($this->manifest_data[ $namespace ])) {
482
-            if (! $this->debug()) {
481
+        if (isset($this->manifest_data[$namespace])) {
482
+            if ( ! $this->debug()) {
483 483
                 return;
484 484
             }
485 485
             throw new InvalidArgumentException(
@@ -512,9 +512,9 @@  discard block
 block discarded – undo
512 512
             }
513 513
             return;
514 514
         }
515
-        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
516
-        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
517
-            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
515
+        $this->manifest_data[$namespace] = $this->decodeManifestFile($manifest_file);
516
+        if ( ! isset($this->manifest_data[$namespace]['url_base'])) {
517
+            $this->manifest_data[$namespace]['url_base'] = trailingslashit($url_base);
518 518
         }
519 519
     }
520 520
 
@@ -529,7 +529,7 @@  discard block
 block discarded – undo
529 529
      */
530 530
     private function decodeManifestFile($manifest_file)
531 531
     {
532
-        if (! file_exists($manifest_file)) {
532
+        if ( ! file_exists($manifest_file)) {
533 533
             throw new InvalidFilePathException($manifest_file);
534 534
         }
535 535
         return json_decode(file_get_contents($manifest_file), true);
@@ -543,7 +543,7 @@  discard block
 block discarded – undo
543 543
      */
544 544
     private function addRegisteredScriptHandlesWithData($script_handle)
545 545
     {
546
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
546
+        $this->script_handles_with_data[$script_handle] = $script_handle;
547 547
     }
548 548
 
549 549
 
@@ -569,23 +569,23 @@  discard block
 block discarded – undo
569 569
      */
570 570
     private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
571 571
     {
572
-        if (isset($this->script_handles_with_data[ $script_handle ])) {
572
+        if (isset($this->script_handles_with_data[$script_handle])) {
573 573
             global $wp_scripts;
574 574
             $unset_handle = false;
575 575
             if ($wp_scripts->get_data($script_handle, 'data')) {
576
-                unset($wp_scripts->registered[ $script_handle ]->extra['data']);
576
+                unset($wp_scripts->registered[$script_handle]->extra['data']);
577 577
                 $unset_handle = true;
578 578
             }
579 579
             //deal with inline_scripts
580 580
             if ($wp_scripts->get_data($script_handle, 'before')) {
581
-                unset($wp_scripts->registered[ $script_handle ]->extra['before']);
581
+                unset($wp_scripts->registered[$script_handle]->extra['before']);
582 582
                 $unset_handle = true;
583 583
             }
584 584
             if ($wp_scripts->get_data($script_handle, 'after')) {
585
-                unset($wp_scripts->registered[ $script_handle ]->extra['after']);
585
+                unset($wp_scripts->registered[$script_handle]->extra['after']);
586 586
             }
587 587
             if ($unset_handle) {
588
-                unset($this->script_handles_with_data[ $script_handle ]);
588
+                unset($this->script_handles_with_data[$script_handle]);
589 589
             }
590 590
         }
591 591
     }
Please login to merge, or discard this patch.
espresso.php 1 patch
Indentation   +80 added lines, -80 removed lines patch added patch discarded remove patch
@@ -38,103 +38,103 @@
 block discarded – undo
38 38
  * @since           4.0
39 39
  */
40 40
 if (function_exists('espresso_version')) {
41
-    if (! function_exists('espresso_duplicate_plugin_error')) {
42
-        /**
43
-         *    espresso_duplicate_plugin_error
44
-         *    displays if more than one version of EE is activated at the same time
45
-         */
46
-        function espresso_duplicate_plugin_error()
47
-        {
48
-            ?>
41
+	if (! function_exists('espresso_duplicate_plugin_error')) {
42
+		/**
43
+		 *    espresso_duplicate_plugin_error
44
+		 *    displays if more than one version of EE is activated at the same time
45
+		 */
46
+		function espresso_duplicate_plugin_error()
47
+		{
48
+			?>
49 49
             <div class="error">
50 50
                 <p>
51 51
                     <?php
52
-                    echo esc_html__(
53
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
-                        'event_espresso'
55
-                    ); ?>
52
+					echo esc_html__(
53
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
+						'event_espresso'
55
+					); ?>
56 56
                 </p>
57 57
             </div>
58 58
             <?php
59
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
60
-        }
61
-    }
62
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
59
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
60
+		}
61
+	}
62
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
63 63
 } else {
64
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
65
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
-        /**
67
-         * espresso_minimum_php_version_error
68
-         *
69
-         * @return void
70
-         */
71
-        function espresso_minimum_php_version_error()
72
-        {
73
-            ?>
64
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
65
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
+		/**
67
+		 * espresso_minimum_php_version_error
68
+		 *
69
+		 * @return void
70
+		 */
71
+		function espresso_minimum_php_version_error()
72
+		{
73
+			?>
74 74
             <div class="error">
75 75
                 <p>
76 76
                     <?php
77
-                    printf(
78
-                        esc_html__(
79
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
-                            'event_espresso'
81
-                        ),
82
-                        EE_MIN_PHP_VER_REQUIRED,
83
-                        PHP_VERSION,
84
-                        '<br/>',
85
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
-                    );
87
-                    ?>
77
+					printf(
78
+						esc_html__(
79
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
+							'event_espresso'
81
+						),
82
+						EE_MIN_PHP_VER_REQUIRED,
83
+						PHP_VERSION,
84
+						'<br/>',
85
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
+					);
87
+					?>
88 88
                 </p>
89 89
             </div>
90 90
             <?php
91
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
92
-        }
91
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
92
+		}
93 93
 
94
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
-    } else {
96
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
97
-        /**
98
-         * espresso_version
99
-         * Returns the plugin version
100
-         *
101
-         * @return string
102
-         */
103
-        function espresso_version()
104
-        {
105
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.78.rc.021');
106
-        }
94
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
+	} else {
96
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
97
+		/**
98
+		 * espresso_version
99
+		 * Returns the plugin version
100
+		 *
101
+		 * @return string
102
+		 */
103
+		function espresso_version()
104
+		{
105
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.78.rc.021');
106
+		}
107 107
 
108
-        /**
109
-         * espresso_plugin_activation
110
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
111
-         */
112
-        function espresso_plugin_activation()
113
-        {
114
-            update_option('ee_espresso_activation', true);
115
-        }
108
+		/**
109
+		 * espresso_plugin_activation
110
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
111
+		 */
112
+		function espresso_plugin_activation()
113
+		{
114
+			update_option('ee_espresso_activation', true);
115
+		}
116 116
 
117
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
117
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
118 118
 
119
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
120
-        bootstrap_espresso();
121
-    }
119
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
120
+		bootstrap_espresso();
121
+	}
122 122
 }
123 123
 if (! function_exists('espresso_deactivate_plugin')) {
124
-    /**
125
-     *    deactivate_plugin
126
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
127
-     *
128
-     * @access public
129
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
130
-     * @return    void
131
-     */
132
-    function espresso_deactivate_plugin($plugin_basename = '')
133
-    {
134
-        if (! function_exists('deactivate_plugins')) {
135
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
136
-        }
137
-        unset($_GET['activate'], $_REQUEST['activate']);
138
-        deactivate_plugins($plugin_basename);
139
-    }
124
+	/**
125
+	 *    deactivate_plugin
126
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
127
+	 *
128
+	 * @access public
129
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
130
+	 * @return    void
131
+	 */
132
+	function espresso_deactivate_plugin($plugin_basename = '')
133
+	{
134
+		if (! function_exists('deactivate_plugins')) {
135
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
136
+		}
137
+		unset($_GET['activate'], $_REQUEST['activate']);
138
+		deactivate_plugins($plugin_basename);
139
+	}
140 140
 }
Please login to merge, or discard this patch.