EE_Admin_Page::__construct() - Code Metrics - Inspection of "Daily Inspection: just delete commented out code;..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Branch — BUG-9622-fix-broken-cpt-crud (e3e588)

unknown
created 2016-04-18 21:17 UTC
EE_Admin_Page::__construct() A

↳ Parent: EE_Admin_Page
Complexity

Conditions	3
Paths	4
Size

Total Lines	47
Code Lines	21
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
c	1
b	0
f	1
dl	0
loc	47
rs	9.0303
cc	3
eloc	21
nc	4
nop	1
<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
/**
 * Event Espresso
 *
 * Event Registration and Management Plugin for WordPress
 *
 * @ package			Event Espresso
 * @ author				Seth Shoultes
 * @ copyright		(c) 2008-2011 Event Espresso  All Rights Reserved.
 * @ license			{@link http://eventespresso.com/support/terms-conditions/}   * see Plugin Licensing *
 * @ link				{@link http://www.eventespresso.com}
 * @ since		 		4.0
 *
 * ------------------------------------------------------------------------
 */



/**
 * EE_Admin_Page class
 *
 * @package		Event Espresso
 * @subpackage		includes/core/admin/EE_Admin_Page.core.php
 * @abstract
 * @author		Brent Christensen, Darren Ethier
 *
 * ------------------------------------------------------------------------
 */
abstract class EE_Admin_Page extends EE_BASE {


	//set in _init_page_props()
	public $page_slug;
	public $page_label;
	public $page_folder;

	//set in define_page_props()
	protected $_admin_base_url;
	protected $_admin_base_path;
	protected $_admin_page_title;
	protected $_labels;


	//set early within EE_Admin_Init
	protected $_wp_page_slug;

	//navtabs
	protected $_nav_tabs;
	protected $_default_nav_tab_name;

	//helptourstops
	protected $_help_tour = array();


	//template variables (used by templates)
	protected $_template_path;
	protected $_column_template_path;

	/**
	 * @var array $_template_args
	 */
	protected $_template_args = array();

	//this will hold the list table object for a given view.
	protected $_list_table_object;

	//bools
	protected $_is_UI_request = NULL; //this starts at null so we can have no header routes progress through two states.
	protected $_routing;

	//list table args
	protected $_view;
	protected $_views;


	//action => method pairs used for routing incoming requests
	protected $_page_routes;
	protected $_page_config;

	//the current page route and route config
	protected $_route;
	protected $_route_config;

	/**
	 * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
	 * actions.
	 *
	 * @since 4.6.x
	 * @var array.
	 */
	protected $_default_route_query_args;

	//set via request page and action args.
	protected $_current_page;
	protected $_current_view;
	protected $_current_page_view_url;

	//sanitized request action (and nonce)
	/**
	 * @var string $_req_action
	 */
	protected $_req_action;

	/**
	 * @var string $_req_nonce
	 */
	protected $_req_nonce;

	//search related
	protected $_search_btn_label;
	protected $_search_box_callback;

	/**
	 * WP Current Screen object
	 *
	 * @var WP_Screen
	 */
	protected $_current_screen;

	//for holding EE_Admin_Hooks object when needed (set via set_hook_object())
	protected $_hook_obj;

	//for holding incoming request data
	protected $_req_data;

	// yes / no array for admin form fields
	protected $_yes_no_values = array();

	//some default things shared by all child classes
	protected $_default_espresso_metaboxes;

	/**
	 * 	EE_Registry Object
	 *	@var 	EE_Registry
	 * 	@access 	protected
	 */
	protected $EE = NULL;



	/**
	 * This is just a property that flags whether the given route is a caffeinated route or not.
	 * @var boolean
	 */
	protected $_is_caf = FALSE;





	/**
	 * 		@Constructor
	 *
	 * 		@param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
	 * 		@access public
	 */
	public function __construct( $routing = TRUE ) {
		EE_Admin::debug_log(
			__METHOD__,
			array(
				'class_name' => get_class( $this ),
				'spl_object_hash' => spl_object_hash( $this )
			)
		);
		if ( strpos( $this->_get_dir(), 'caffeinated' ) !== false )
			$this->_is_caf = TRUE;

		$this->_yes_no_values = array(
			array('id' => TRUE, 'text' => __('Yes', 'event_espresso')),
			array('id' => FALSE, 'text' => __('No', 'event_espresso'))
		);



		//set the _req_data property.
		$this->_req_data = array_merge( $_GET, $_POST );


		//routing enabled?
		$this->_routing = $routing;

		//set initial page props (child method)
		$this->_init_page_props();

		//set global defaults
		$this->_set_defaults();

		//set early because incoming requests could be ajax related and we need to register those hooks.
		$this->_global_ajax_hooks();
		$this->_ajax_hooks();


		//other_page_hooks have to be early too.
		$this->_do_other_page_hooks();

		//This just allows us to have extending classes do something specific before the parent constructor runs _page_setup.
		if ( method_exists( $this, '_before_page_setup' ) )
			$this->_before_page_setup();


		//set up page dependencies
		$this->_page_setup();

	}




	/**
	 * _init_page_props
	 * Child classes use to set at least the following properties:
	 * $page_slug.
	 * $page_label.
	 *
	 * @abstract
	 * @access protected
	 * @return void
	 */
	abstract protected function _init_page_props();



	/**
	 * _ajax_hooks
	 * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
	 * Note: within the ajax callback methods.
	 *
	 * @abstract
	 * @access protected
	 * @return void
	 */
	abstract protected function _ajax_hooks();




	/**
	 * _define_page_props
	 * child classes define page properties in here.  Must include at least:
	 * $_admin_base_url = base_url for all admin pages
	 * $_admin_page_title = default admin_page_title for admin pages
	 * $_labels = array of default labels for various automatically generated elements:
	 * 	array(
	 * 		'buttons' => array(
	 * 			'add' => __('label for add new button'),
	 * 	 		'edit' => __('label for edit button'),
	 * 	  		'delete' => __('label for delete button')
	 * 	  	 	)
	 * 	  	)
	 *
	 * @abstract
	 * @access protected
	 * @return void
	 */
	abstract protected function _define_page_props();





	/**
	 * _set_page_routes
	 * child classes use this to define the page routes for all subpages handled by the class.  Page routes are assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also have a 'default' route. Here's the format
	 * $this->_page_routes = array(
	 * 		'default' => array(
	 * 			'func' => '_default_method_handling_route',
	 * 			'args' => array('array','of','args'),
	 * 			'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e. ajax request, backend processing)
	 *			'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a headers route after.  The string you enter here should match the defined route reference for a headers sent route.
	 *			'capability' => 'route_capability', //indicate a string for minimum capability required to access this route.
	 *			'obj_id' => 10 // if this route has an object id, then this can include it (used for capability checks).
	 * 		),
	 * 		'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a handling method.
	 * 		)
	 *
	 * )
	 *
	 *
	 * @abstract
	 * @access protected
	 * @return void
	 */
	abstract protected function _set_page_routes();






	/**
	 * _set_page_config
	 * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the array corresponds to the page_route for the loaded page.
	 * Format:
	 * $this->_page_config = array(
	 * 		'default' => array(
	 * 			'labels' => array(
	 * 				'buttons' => array(
	 * 					'add' => __('label for adding item'),
	 * 				 	'edit' => __('label for editing item'),
	 * 				  	'delete' => __('label for deleting item')
	 * 			    ),
	 * 			    'publishbox' => __('Localized Title for Publish metabox', 'event_espresso')
	 * 			), //optional an array of custom labels for various automatically generated elements to use on the page. If this isn't present then the defaults will be used as set for the $this->_labels in _define_page_props() method
	 * 			'nav' => array(
	 * 				'label' => __('Label for Tab', 'event_espresso').
	 *     			'url' => 'http://someurl', //automatically generated UNLESS you define
	 *     			'css_class' => 'css-class', //automatically generated UNLESS you define
	 *     			'order' => 10, //required to indicate tab position.
	 *     			'persistent' => false //if you want the nav tab to ONLY display when the specific route is displayed then add this parameter.
	 *     		'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
	 *     		'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load metaboxes set for eventespresso admin pages.
	 *     		'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added later.  We just use this flag to make sure the necessary js gets enqueued on page load.
	 *     		'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
	 *     		'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The array indicates the max number of columns (4) and the default number of columns on page load (2).  There is an option in the "screen_options" dropdown that is setup so users can pick what columns they want to display.
	 *     		'help_tabs' => array( //this is used for adding help tabs to a page
	 *     			'tab_id' => array(
	 *     				'title' => 'tab_title',
	 *     				'filename' => 'name_of_file_containing_content', //this is the primary method for setting help tab content.  The fallback if it isn't present is to try a the callback.  Filename should match a file in the admin folder's "help_tabs" dir (ie.. events/help_tabs/name_of_file_containing_content.help_tab.php)
	 *     				'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will attempt to use the callback which should match the name of a method in the class
	 *     				),
	 *     			'tab2_id' => array(
	 *     			 	'title' => 'tab2 title',
	 *     			 	'filename' => 'file_name_2'
	 *     			 	'callback' => 'callback_method_for_content',
	 *     			 ),
	 *     	   	'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the help tab area on an admin page. @link http://make.wordpress.org/core/2011/12/06/help-and-screen-api-changes-in-3-3/
	 *     		'help_tour' => array(
	 *     			'name_of_help_tour_class', //all help tours shoudl be a child class of EE_Help_Tour and located in a folder for this admin page named "help_tours", a file name matching the key given here (name_of_help_tour_class.class.php), and class matching key given here (name_of_help_tour_class)
	 *     		),
	 *     		'require_nonce' => TRUE //this is used if you want to set a route to NOT require a nonce (default is true if it isn't present).  To remove the requirement for a nonce check when this route is visited just set 'require_nonce' to FALSE
	 *     		)
	 *
	 * )
	 *
	 *
	 * @abstract
	 * @access protected
	 * @return void
	 */
	abstract protected function _set_page_config();





	/** end sample help_tour methods **/


	/**
	 * _add_screen_options
	 * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
	 * Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options to a particular view.
	 * @link http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
	 * see also WP_Screen object documents...
	 * @link http://codex.wordpress.org/Class_Reference/WP_Screen
	 *
	 * @abstract
	 * @access protected
	 * @return void
	 */
	abstract protected function _add_screen_options();







	/**
	 * _add_feature_pointers
	 * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
	 * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a particular view.
	 * Note: this is just a placeholder for now.  Implementation will come down the road
	 * See: WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
	 * @link http://eamann.com/tech/wordpress-portland/
	 *
	 * @abstract
	 * @access protected
	 * @return void
	 */
	abstract protected function _add_feature_pointers();





	/**
	 * load_scripts_styles
	 * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific scripts/styles per view by putting them in a dynamic function in this format (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
	 *
	 * @abstract
	 * @access public
	 * @return void
	 */
	abstract public function load_scripts_styles();






	/**
	 * admin_init
	 * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to all pages/views loaded by child class.
	 *
	 * @abstract
	 * @access public
	 * @return void
	 */
	abstract public function admin_init();






	/**
	 * admin_notices
	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to all pages/views loaded by child class.
	 *
	 * @abstract
	 * @access public
	 * @return void
	 */
	abstract public function admin_notices();





	/**
	 * admin_footer_scripts
	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply to all pages/views loaded by child class.
	 *
	 * @access public
	 * @return void
	 */
	abstract public function admin_footer_scripts();






	/**
	 * admin_footer
	 * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will apply to all pages/views loaded by child class.
	 *
	 * @access  public
	 * @return void
	 */
	public function admin_footer() {}




	/**
	 * _global_ajax_hooks
	 * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
	 * Note: within the ajax callback methods.
	 *
	 * @abstract
	 * @access protected
	 * @return void
	 */
	protected function _global_ajax_hooks() {
		//for lazy loading of metabox content
		add_action( 'wp_ajax_espresso-ajax-content', array( $this, 'ajax_metabox_content'), 10 );
	}



	public function ajax_metabox_content() {
		$contentid = isset( $this->_req_data['contentid'] ) ? $this->_req_data['contentid'] : '';
		$url = isset( $this->_req_data['contenturl'] ) ? $this->_req_data['contenturl'] : '';

		self::cached_rss_display( $contentid, $url );
		wp_die();
	}



	/**
	 * _page_setup
	 * Makes sure any things that need to be loaded early get handled.  We also escape early here if the page requested doesn't match the object.
	 *
	 * @final
	 * @access protected
	 * @return void
	 */
	final protected function _page_setup() {

		//requires?
		EE_Registry::instance()->load_helper('Template');


		//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.
		add_action( 'admin_init', array( $this, 'admin_init_global' ), 5 );


		//next verify if we need to load anything...
		$this->_current_page = !empty( $_GET['page'] ) ? sanitize_key( $_GET['page'] ) : FALSE;
		$this->page_folder = strtolower( str_replace( '_Admin_Page', '', str_replace( 'Extend_', '', get_class($this) ) ) );

		global $ee_menu_slugs;
		$ee_menu_slugs = (array) $ee_menu_slugs;

		if ( ( !$this->_current_page || ! isset( $ee_menu_slugs[$this->_current_page] ) ) && !defined( 'DOING_AJAX') ) return FALSE;


		// 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
		if ( isset( $this->_req_data['action2'] ) && $this->_req_data['action'] == -1 ) {
			$this->_req_data['action'] = ! empty( $this->_req_data['action2'] ) && $this->_req_data['action2'] != -1 ? $this->_req_data['action2'] : $this->_req_data['action'];
		}
		// then set blank or -1 action values to 'default'
		$this->_req_action = isset( $this->_req_data['action'] ) && ! empty( $this->_req_data['action'] ) && $this->_req_data['action'] != -1 ? sanitize_key( $this->_req_data['action'] ) : 'default';

		//if action is 'default' after the above BUT we have  'route' var set, then let's use the route as the action.  This covers cases where we're coming in from a list table that isn't on the default route.
		$this->_req_action = $this->_req_action == 'default' && isset( $this->_req_data['route'] ) ? $this->_req_data['route'] : $this->_req_action;

		//however if we are doing_ajax and we've got a 'route' set then that's what the req_action will be
		$this->_req_action = defined('DOING_AJAX') && isset($this->_req_data['route']) ? $this->_req_data['route'] : $this->_req_action;

		$this->_current_view = $this->_req_action;
		$this->_req_nonce = $this->_req_action . '_nonce';
		$this->_define_page_props();

		$this->_current_page_view_url = add_query_arg( array( 'page' => $this->_current_page, 'action' => $this->_current_view ),  $this->_admin_base_url );

		//default things
		$this->_default_espresso_metaboxes = array('_espresso_news_post_box', '_espresso_links_post_box', '_espresso_ratings_request', '_espresso_sponsors_post_box' );

		//set page configs
		$this->_set_page_routes();
		$this->_set_page_config();

		//let's include any referrer data in our default_query_args for this route for "stickiness".
		if ( isset( $this->_req_data['wp_referer'] ) ) {
			$this->_default_route_query_args['wp_referer'] = $this->_req_data['wp_referer'];
		}

		//for caffeinated and other extended functionality.  If there is a _extend_page_config method then let's run that to modify the all the various page configuration arrays
		if ( method_exists( $this, '_extend_page_config' ) )
			$this->_extend_page_config();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

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

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

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

		//for CPT and other extended functionality. If there is an _extend_page_config_for_cpt then let's run that to modify all the various page configuration arrays.
		if ( method_exists( $this, '_extend_page_config_for_cpt' ) )
			$this->_extend_page_config_for_cpt();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

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

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

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

		//filter routes and page_config so addons can add their stuff. Filtering done per class
		$this->_page_routes = apply_filters( 'FHEE__' . get_class($this) . '__page_setup__page_routes', $this->_page_routes, $this );
		$this->_page_config = apply_filters( 'FHEE__' . get_class($this) . '__page_setup__page_config', $this->_page_config, $this );


		//if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
		if ( method_exists( $this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view ) ) {
			add_action( 'AHEE__EE_Admin_Page__route_admin_request', array( $this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view ), 10, 2 );
		}


		//next route only if routing enabled
		if ( $this->_routing && !defined('DOING_AJAX') ) {

			$this->_verify_routes();

			//next let's just check user_access and kill if no access
			$this->check_user_access();

			if ( $this->_is_UI_request ) {
				//admin_init stuff - global, all views for this page class, specific view
				add_action( 'admin_init', array( $this, 'admin_init' ), 10 );
				if ( method_exists( $this, 'admin_init_' . $this->_current_view )) {
					add_action( 'admin_init', array( $this, 'admin_init_' . $this->_current_view ), 15 );
				}

			} else {
				//hijack regular WP loading and route admin request immediately
				@ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', WP_MAX_MEMORY_LIMIT ) );
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
				$this->route_admin_request();
			}
		}
	}





	/**
	 * Provides a way for related child admin pages to load stuff on the loaded admin page.
	 *
	 * @access private
	 * @return void
	 */
	private function _do_other_page_hooks() {
		$registered_pages = apply_filters( 'FHEE_do_other_page_hooks_' . $this->page_slug, array() );

		foreach ( $registered_pages as $page ) {

			//now let's setup the file name and class that should be present
			$classname = str_replace('.class.php', '', $page);

			//autoloaders should take care of loading file
			if ( !class_exists( $classname ) ) {
				$error_msg[] = sprintf( __('Something went wrong with loading the %s admin hooks page.', 'event_espresso' ), $page);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
				$error_msg[] = $error_msg[0] . "\r\n" . sprintf( __( 'There is no class in place for the %s admin hooks page.%sMake sure you have <strong>%s</strong> defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class', 'event_espresso'), $page, '<br />', $classname );
				throw new EE_Error( implode( '||', $error_msg ));
			}

			$a = new ReflectionClass($classname);

			//notice we are passing the instance of this class to the hook object.
			$hookobj[] = $a->newInstance($this);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
		}
	}



	public function load_page_dependencies() {
		try {
			$this->_load_page_dependencies();
		} catch ( EE_Error $e ) {
			$e->get_error();
		}
	}



	/**
	 * load_page_dependencies
	 * loads things specific to this page class when its loaded.  Really helps with efficiency.
	 * @access public
	 * @return void
	 */
	protected function _load_page_dependencies() {
		//let's set the current_screen and screen options to override what WP set
		$this->_current_screen = get_current_screen();

		//load admin_notices - global, page class, and view specific
		add_action( 'admin_notices', array( $this, 'admin_notices_global'), 5 );
		add_action( 'admin_notices', array( $this, 'admin_notices' ), 10 );
		if ( method_exists( $this, 'admin_notices_' . $this->_current_view ) ) {
			add_action( 'admin_notices', array( $this, 'admin_notices_' . $this->_current_view ), 15 );
		}

		//load network admin_notices - global, page class, and view specific
		add_action( 'network_admin_notices', array( $this, 'network_admin_notices_global'), 5 );
		if ( method_exists( $this, 'network_admin_notices_' . $this->_current_view ) ) {
			add_action( 'network_admin_notices', array( $this, 'network_admin_notices_' . $this->_current_view ) );
		}

		//this will save any per_page screen options if they are present
		$this->_set_per_page_screen_options();

		//setup list table properties
		$this->_set_list_table();

		// child classes can "register" a metabox to be automatically handled via the _page_config array property.  However in some cases the metaboxes will need to be added within a route handling callback.
		$this->_add_registered_meta_boxes();
		$this->_add_screen_columns();

		//add screen options - global, page child class, and view specific
		$this->_add_global_screen_options();
class User
{
    private $email;

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

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
		$this->_add_screen_options();
		if ( method_exists( $this, '_add_screen_options_' . $this->_current_view ) )
			call_user_func( array( $this, '_add_screen_options_' . $this->_current_view ) );


		//add help tab(s) and tours- set via page_config and qtips.
		$this->_add_help_tour();
		$this->_add_help_tabs();
		$this->_add_qtips();

		//add feature_pointers - global, page child class, and view specific
		$this->_add_feature_pointers();
		$this->_add_global_feature_pointers();
class User
{
    private $email;

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

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
		if ( method_exists( $this, '_add_feature_pointer_' . $this->_current_view ) )
			call_user_func( array( $this, '_add_feature_pointer_' . $this->_current_view ) );

		//enqueue scripts/styles - global, page class, and view specific
		add_action('admin_enqueue_scripts', array($this, 'load_global_scripts_styles'), 5 );
		add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles'), 10 );
		if ( method_exists( $this, 'load_scripts_styles_' . $this->_current_view ) )
			add_action('admin_enqueue_scripts', array($this, 'load_scripts_styles_' . $this->_current_view ), 15 );

		add_action('admin_enqueue_scripts', array( $this, 'admin_footer_scripts_eei18n_js_strings' ), 100 );

		//admin_print_footer_scripts - global, page child class, and view specific.  NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.  In most cases that's doing_it_wrong().  But adding hidden container elements etc. is a good use case. Notice the late priority we're giving these
		add_action('admin_print_footer_scripts', array( $this, 'admin_footer_scripts_global' ), 99 );
		add_action('admin_print_footer_scripts', array( $this, 'admin_footer_scripts' ), 100 );
		if ( method_exists( $this, 'admin_footer_scripts_' . $this->_current_view ) )
			add_action('admin_print_footer_scripts', array( $this, 'admin_footer_scripts_' . $this->_current_view ), 101 );

		//admin footer scripts
		add_action('admin_footer', array( $this, 'admin_footer_global' ), 99 );
		add_action('admin_footer', array( $this, 'admin_footer'), 100 );
		if ( method_exists( $this, 'admin_footer_' . $this->_current_view ) )
			add_action('admin_footer', array( $this, 'admin_footer_' . $this->_current_view ), 101 );


		do_action( 'FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug );
		//targeted hook
		do_action( 'FHEE__EE_Admin_Page___load_page_dependencies__after_load__' . $this->page_slug . '__' . $this->_req_action );

	}





	/**
	 * _set_defaults
	 * This sets some global defaults for class properties.
	 */
	private function _set_defaults() {
		$this->_current_screen = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = $this->_event = $this->_template_path = $this->_column_template_path = NULL;
<?php

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

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

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

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

}

		$this->_nav_tabs = $this_views = $this->_page_routes = $this->_page_config =  $this->_default_route_query_args = array();
$myVar = 'Value';
$higher = false;

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

		$this->default_nav_tab_name = 'overview';


		//init template args
		$this->_template_args = array(
			'admin_page_header' => '',
			'admin_page_content' => '',
			'post_body_content' => '',
			'before_list_table' => '',
			'after_list_table' => ''
		);
	}




	/**
	 * route_admin_request
	 *
	 * @see _route_admin_request()
	 * @access public
	 * @return void|exception error
	 */
	public function route_admin_request() {
		try {
			$this->_route_admin_request();
		} catch ( EE_Error $e ) {
			$e->get_error();
		}
	}



	public function set_wp_page_slug($wp_page_slug) {
		$this->_wp_page_slug = $wp_page_slug;

		//if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
		if ( is_network_admin() ) {
			$this->_wp_page_slug .= '-network';
		}
	}

	/**
	 * _verify_routes
	 * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so we know if we need to drop out.
	 *
	 * @access protected
	 * @return void
	 */
	protected function _verify_routes() {
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );

		if ( !$this->_current_page && !defined( 'DOING_AJAX')) return FALSE;

		$this->_route = FALSE;
		$func = FALSE;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$args = array();
$myVar = 'Value';
$higher = false;

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

		// check that the page_routes array is not empty
		if ( empty( $this->_page_routes )) {
			// user error msg
			$error_msg = sprintf( __('No page routes have been set for the %s admin page.', 'event_espresso'), $this->_admin_page_title );
			// developer error msg
			$error_msg .=  '||' . $error_msg . __( ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.', 'event_espresso' );
			throw new EE_Error( $error_msg );
		}

		// and that the requested page route exists
		if ( array_key_exists( $this->_req_action, $this->_page_routes )) {
			$this->_route = $this->_page_routes[ $this->_req_action ];
			$this->_route_config = isset($this->_page_config[$this->_req_action]) ? $this->_page_config[$this->_req_action] : array();
		} else {
			// user error msg
			$error_msg =  sprintf( __( 'The requested page route does not exist for the %s admin page.', 'event_espresso' ), $this->_admin_page_title );
			// developer error msg
			$error_msg .=  '||' . $error_msg . sprintf( __( ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.', 'event_espresso' ), $this->_req_action );
			throw new EE_Error( $error_msg );
		}

		// and that a default route exists
		if ( ! array_key_exists( 'default', $this->_page_routes )) {
			// user error msg
			$error_msg = sprintf( __( 'A default page route has not been set for the % admin page.', 'event_espresso' ), $this->_admin_page_title );
			// developer error msg
			$error_msg .=  '||' . $error_msg . __( ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.', 'event_espresso' );
			throw new EE_Error( $error_msg );
		}


		//first lets' catch if the UI request has EVER been set.
		if ( $this->_is_UI_request === NULL ) {
			//lets set if this is a UI request or not.
			$this->_is_UI_request = ( ! isset( $this->_req_data['noheader'] ) || $this->_req_data['noheader'] !== TRUE ) ? TRUE : FALSE;


			//wait a minute... we might have a noheader in the route array
			$this->_is_UI_request = is_array($this->_route) && isset($this->_route['noheader'] ) && $this->_route['noheader'] ? FALSE : $this->_is_UI_request;
		}

		$this->_set_current_labels();

	}




	/**
	 * this method simply verifies a given route and makes sure its an actual route available for the loaded page
	 * @param  string $route the route name we're verifying
	 * @return mixed  (bool|Exception)      we'll throw an exception if this isn't a valid route.
	 */
	protected function _verify_route( $route ) {
		if ( array_key_exists( $this->_req_action, $this->_page_routes )) {
			return true;
		} else {
			// user error msg
			$error_msg =  sprintf( __( 'The given page route does not exist for the %s admin page.', 'event_espresso' ), $this->_admin_page_title );
			// developer error msg
			$error_msg .=  '||' . $error_msg . sprintf( __( ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property', 'event_espresso' ), $route );
			throw new EE_Error( $error_msg );
		}
	}




	/**
	 * perform nonce verification
	 * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces using this method (and save retyping!)
	 * @param  string $nonce     The nonce sent
	 * @param  string $nonce_ref The nonce reference string (name0)
	 * @return mixed (bool|die)
	 */
	protected function _verify_nonce( $nonce, $nonce_ref ) {
		// verify nonce against expected value
		if ( ! wp_verify_nonce( $nonce, $nonce_ref) ) {
			// these are not the droids you are looking for !!!
			$msg = sprintf(__('%sNonce Fail.%s' , 'event_espresso'), '<a href="http://www.youtube.com/watch?v=56_S0WeTkzs">', '</a>' );
			if ( WP_DEBUG ) {
				$msg .= "\n  " . sprintf( __('In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!', 'event_espresso' ), __CLASS__  );
			}
			if ( ! defined( 'DOING_AJAX' )) {
				wp_die( $msg );
			} else {
				EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ );
				$this->_return_json();
			}
		}
	}




	/**
	 * _route_admin_request()
	 * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are some doodads to work the magic and handle the flingjangy.
	 * Translation:  Checks if the requested action is listed in the page routes and then will try to load the corresponding method.
	 *
	 * @access protected
	 * @return void
	 */
	protected function _route_admin_request() {
		if (  ! $this->_is_UI_request )
			$this->_verify_routes();

		$nonce_check = isset( $this->_route_config['require_nonce'] ) ? $this->_route_config['require_nonce'] : TRUE;

		if ( $this->_req_action != 'default' && $nonce_check ) {
			// set nonce from post data
			$nonce = isset($this->_req_data[ $this->_req_nonce  ]) ? sanitize_text_field( $this->_req_data[ $this->_req_nonce  ] ) : '';
			$this->_verify_nonce( $nonce, $this->_req_nonce );
		}
		//set the nav_tabs array but ONLY if this is  UI_request
		if ( $this->_is_UI_request )
			$this->_set_nav_tabs();

		// grab callback function
		$func = is_array( $this->_route ) ? $this->_route['func'] : $this->_route;

		// check if callback has args
		$args = is_array( $this->_route ) && isset( $this->_route['args'] ) ? $this->_route['args'] : array();

		$error_msg = '';

		//action right before calling route (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
		if ( !did_action('AHEE__EE_Admin_Page__route_admin_request')) {
			do_action( 'AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this );
		}

		//right before calling the route, let's remove _wp_http_referer from the $_SERVER[REQUEST_URI] global (its now in _req_data for route processing).
		$_SERVER['REQUEST_URI'] = remove_query_arg( '_wp_http_referer', wp_unslash( $_SERVER['REQUEST_URI'] ) );

		if ( ! empty( $func )) {
			$base_call = $addon_call = FALSE;
			//try to access page route via this class
			if ( ! is_array( $func ) && method_exists( $this, $func ) && ( $base_call = call_user_func_array( array( $this, &$func  ), $args ) ) === FALSE ) {
				// user error msg
				$error_msg =  __( 'An error occurred. The  requested page route could not be found.', 'event_espresso' );
				// developer error msg
				$error_msg .= '||' . sprintf( __( 'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.', 'event_espresso' ), $func );
			}

			//for pluggability by addons first let's see if just the function exists (this will also work in the case where $func is an array indicating class/method)
			$args['admin_page_object'] = $this; //send along this admin page object for access by addons.

			if ( $base_call === FALSE && ( $addon_call = call_user_func_array( $func, $args ) )=== FALSE ) {
				$error_msg = __('An error occurred. The requested page route could not be found', 'event_espresso' );
				$error_msg .= '||' . sprintf( __('Page route "%s" could not be called.  Check that the spelling for the function name and action in the "_page_routes" array filtered by your plugin is correct.', 'event_espresso'), $func );
			}


			if ( !empty( $error_msg ) && $base_call === FALSE && $addon_call === FALSE )
				throw new EE_Error( $error_msg );
		}

		//if we've routed and this route has a no headers route AND a sent_headers_route, then we need to reset the routing properties to the new route.
		//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.
		if ( $this->_is_UI_request === FALSE && is_array( $this->_route) && ! empty( $this->_route['headers_sent_route'] ) ) {
			$this->_reset_routing_properties( $this->_route['headers_sent_route'] );
		}
	}




	/**
	 * This method just allows the resetting of page properties in the case where a no headers
	 * route redirects to a headers route in its route config.
	 *
	 * @since   4.3.0
	 *
	 * @param  string    $new_route   New (non header) route to redirect to.
	 * @return   void
	 */
	protected function _reset_routing_properties( $new_route ) {
		$this->_is_UI_request = TRUE;
		//now we set the current route to whatever the headers_sent_route is set at
		$this->_req_data['action'] = $new_route;
		//rerun page setup
		$this->_page_setup();
	}




	/**
	 * _add_query_arg
	 * adds nonce to array of arguments then calls WP add_query_arg function
	 *(internally just uses EEH_URL's function with the same name)
	 * 	@access public
	 *	@param array $args
	 *	@param string $url
	 *	@param bool $sticky if true, then the existing Request params will be appended to the generated
	 *	                    		url in an associative array indexed by the key 'wp_referer';
	 *	                    		Example usage:
	 *
	 *	                    		If the current page is:
	 *	                    		http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
	 *	                    		&action=default&event_id=20&month_range=March%202015
	 *	                    		&_wpnonce=5467821
	 *
	 *	                    		and you call:
	 *
	 *	                    		EE_Admin_Page::add_query_args_and_nonce(
	 *	                    			array(
	 *	                    				'action' => 'resend_something',
	 *	                    				'page=>espresso_registrations'
	 *	                    				),
	 *	                    			$some_url,
	 *	                    			true
	 *	                    		 );
	 *
	 *	                    		It will produce a url in this structure:
	 *
	 *	                      		http://{$some_url}/?page=espresso_registrations&action=resend_something
	 *	                        	&wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
	 *	                        	month_range]=March%202015
	 * @param   bool    $exclude_nonce  If true, the the nonce will be excluded from the generated nonce.
	 * 	@return string
	 */
	public static function add_query_args_and_nonce( $args = array(), $url = false, $sticky = false, $exclude_nonce = false ) {
		EE_Registry::instance()->load_helper('URL');

		//if there is a _wp_http_referer include the values from the request but only if sticky = true
		if ( $sticky ) {
			$request = $_REQUEST;
			unset( $request['_wp_http_referer'] );
			unset( $request['wp_referer'] );
			foreach ( $request as $key => $value ) {
				//do not add nonces
				if ( strpos( $key, 'nonce' ) !== false ) {
					continue;
				}
				$args['wp_referer[' . $key . ']'] = $value;
			}
		}

		return EEH_URL::add_query_args_and_nonce( $args, $url, $exclude_nonce );

	}




	/**
	 * This returns a generated link that will load the related help tab.
	 *
	 *
	 * @param  string $help_tab_id the id for the connected help tab
	 * @param  string $icon_style (optional) include css class for the style you want to use for the help icon.
	 * @param  string $help_text (optional) send help text you want to use for the link if default not to be used
	 * @uses EEH_Template::get_help_tab_link()
	 * @return string              generated link
	 */
	protected function _get_help_tab_link( $help_tab_id, $icon_style = FALSE, $help_text = FALSE ) {
		return EEH_Template::get_help_tab_link( $help_tab_id, $this->page_slug, $this->_req_action, $icon_style, $help_text );
	}




	/**
	 * _add_help_tabs
	 *
	 * Note child classes define their help tabs within the page_config array.
	 * @link http://codex.wordpress.org/Function_Reference/add_help_tab
	 *
	 * @access protected
	 * @return void
	 */
	protected function _add_help_tabs() {
		$tour_buttons = '';
		if ( isset( $this->_page_config[$this->_req_action] ) ) {
			$config = $this->_page_config[$this->_req_action];

			//is there a help tour for the current route?  if there is let's setup the tour buttons
			if ( isset( $this->_help_tour[$this->_req_action]) ) {
				$tb = array();
				$tour_buttons = '<div class="ee-abs-container"><div class="ee-help-tour-restart-buttons">';
				foreach ( $this->_help_tour['tours'] as $tour ) {
					//if this is the end tour then we don't need to setup a button
					if ( $tour instanceof EE_Help_Tour_final_stop )
						continue;
					$tb[] = '<button id="trigger-tour-' . $tour->get_slug() . '" class="button-primary trigger-ee-help-tour">' . $tour->get_label() . '</button>';
				}
				$tour_buttons .= implode('<br />', $tb);
				$tour_buttons .= '</div></div>';
			}

			// let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
			if ( is_array( $config ) && isset( $config['help_sidebar'] ) ) {
				//check that the callback given is valid
				if ( !method_exists($this, $config['help_sidebar'] ) )
					throw new EE_Error( sprintf( __('The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s', 'event_espresso'), $config['help_sidebar'], get_class($this) ) );

				$content = apply_filters( 'FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar', call_user_func( array( $this, $config['help_sidebar'] ) ) );

				$content .= $tour_buttons; //add help tour buttons.

				//do we have any help tours setup?  Cause if we do we want to add the buttons
				$this->_current_screen->set_help_sidebar($content);
			}

			//if we DON'T have config help sidebar and there ARE toure buttons then we'll just add the tour buttons to the sidebar.
			if ( !isset( $config['help_sidebar'] ) && !empty( $tour_buttons ) ) {
				$this->_current_screen->set_help_sidebar($tour_buttons);
			}

			//handle if no help_tabs are set so the sidebar will still show for the help tour buttons
			if ( !isset( $config['help_tabs'] ) && !empty($tour_buttons) ) {
				$_ht['id'] = $this->page_slug;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
				$_ht['title'] = __('Help Tours', 'event_espresso');
				$_ht['content'] = '<p>' . __('The buttons to the right allow you to start/restart any help tours available for this page', 'event_espresso') . '</p>';
				$this->_current_screen->add_help_tab($_ht);
				}/**/


			if ( !isset( $config['help_tabs'] ) ) return; //no help tabs for this route

			foreach ( (array) $config['help_tabs'] as $tab_id => $cfg ) {
				//we're here so there ARE help tabs!

				//make sure we've got what we need
				if ( !isset( $cfg['title'] ) )
					throw new EE_Error( __('The _page_config array is not set up properly for help tabs.  It is missing a title', 'event_espresso') );


				if ( !isset($cfg['filename']) && !isset( $cfg['callback'] ) && !isset( $cfg['content'] ) )
					throw new EE_Error( __('The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab', 'event_espresso') );



				//first priority goes to content.
				if ( !empty($cfg['content'] ) ) {
					$content = !empty($cfg['content']) ? $cfg['content'] : NULL;

				//second priority goes to filename
				} else if ( !empty($cfg['filename'] ) ) {
					$file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';


					//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)
					$file_path = !is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tabs/' . $cfg['filename'] . '.help_tab.php' : $file_path;

					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
					if ( !is_readable($file_path) && !isset($cfg['callback']) ) {
						EE_Error::add_error( sprintf( __('The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s', 'event_espresso'), $tab_id, key($config), $file_path ), __FILE__, __FUNCTION__, __LINE__ );
						return;
					}
					$template_args['admin_page_obj'] = $this;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
					$content = EEH_Template::display_template($file_path, $template_args, true);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
				} else {
					$content = '';
				}


				//check if callback is valid
				if ( empty($content) && ( !isset($cfg['callback']) || !method_exists( $this, $cfg['callback'] ) ) ) {
					EE_Error::add_error( sprintf( __('The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.', 'event_espresso'), $cfg['title'] ), __FILE__, __FUNCTION__, __LINE__ );
					return;
				}

				//setup config array for help tab method
				$id = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
				$_ht = array(
					'id' => $id,
					'title' => $cfg['title'],
					'callback' => isset( $cfg['callback'] ) && empty($content) ? array( $this, $cfg['callback'] ) : NULL,
					'content' => $content
					);

				$this->_current_screen->add_help_tab( $_ht );
			}
		}
	}



	/**
	 * This basically checks loaded $_page_config property to see if there are any help_tours defined.  "help_tours" is an array with properties for setting up usage of the joyride plugin
	 *
	 * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
	 * @see instructions regarding the format and construction of the "help_tour" array element is found in the _set_page_config() comments
	 * @access protected
	 * @return void
	 */
	protected function _add_help_tour() {
		$tours = array();
		$this->_help_tour = array();

		//exit early if help tours are turned off globally
		if ( ! EE_Registry::instance()->CFG->admin->help_tour_activation || ( defined( 'EE_DISABLE_HELP_TOURS' ) && EE_DISABLE_HELP_TOURS ) )
			return;

		//loop through _page_config to find any help_tour defined
		foreach ( $this->_page_config as $route => $config ) {
			//we're only going to set things up for this route
			if ( $route !== $this->_req_action )
				continue;

			if ( isset( $config['help_tour'] ) ) {

				foreach( $config['help_tour'] as $tour ) {
					$file_path = $this->_get_dir() . '/help_tours/' . $tour . '.class.php';
					//let's see if we can get that file... if not its possible this is a decaf route not set in caffienated so lets try and get the caffeinated equivalent
					$file_path = !is_readable($file_path) ? EE_ADMIN_PAGES . basename($this->_get_dir()) . '/help_tours/' . $tour . '.class.php' : $file_path;

					//if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
					if ( !is_readable($file_path) ) {
						EE_Error::add_error( sprintf( __('The file path given for the help tour (%s) is not a valid path.  Please check that the string you set for the help tour on this route (%s) is the correct spelling', 'event_espresso'), $file_path, $tour ), __FILE__, __FUNCTION__, __LINE__ );
						return;
					}

					require_once $file_path;
					if ( !class_exists( $tour ) ) {
						$error_msg[] = sprintf( __('Something went wrong with loading the %s Help Tour Class.', 'event_espresso' ), $tour);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
						$error_msg[] = $error_msg[0] . "\r\n" . sprintf( __( 'There is no class in place for the %s help tour.%s Make sure you have <strong>%s</strong> defined in the "help_tour" array for the %s route of the % admin page.', 'event_espresso'), $tour, '<br />', $tour, $this->_req_action, get_class($this) );
						throw new EE_Error( implode( '||', $error_msg ));
					}
					$a = new ReflectionClass($tour);
					$tour_obj = $a->newInstance($this->_is_caf);

					$tours[] = $tour_obj;
					$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator( $tour_obj );
				}

				//let's inject the end tour stop element common to all pages... this will only get seen once per machine.
				$end_stop_tour = new EE_Help_Tour_final_stop($this->_is_caf);
				$tours[] = $end_stop_tour;
				$this->_help_tour[$route][] = EEH_Template::help_tour_stops_generator( $end_stop_tour );
			}
		}

		if ( !empty( $tours ) )
			$this->_help_tour['tours'] = $tours;

		//thats it!  Now that the $_help_tours property is set (or not) the scripts and html should be taken care of automatically.
	}




	/**
	 * This simply sets up any qtips that have been defined in the page config
	 *
	 * @access protected
	 * @return void
	 */
	protected function _add_qtips() {
		if ( isset( $this->_route_config['qtips'] ) ) {
			$qtips = (array) $this->_route_config['qtips'];
			//load qtip loader
			EE_Registry::instance()->load_helper('Qtip_Loader', array(), TRUE);
			$path = array(
				$this->_get_dir() . '/qtips/',
				EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/'
				);
			EEH_Qtip_Loader::instance()->register($qtips, $path);
		}
	}




	/**
	 * _set_nav_tabs
	 * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you wish to add additional tabs or modify accordingly.
	 *
	 * @access protected
	 * @return void
	 */
	protected function _set_nav_tabs() {
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
		$i = 0;
		foreach ( $this->_page_config as $slug => $config ) {
			if ( !is_array( $config ) || ( is_array($config) && (isset($config['nav']) && !$config['nav'] ) || !isset($config['nav'] ) ) )
				continue; //no nav tab for this config

			//check for persistent flag
			if ( isset( $config['nav']['persistent']) && !$config['nav']['persistent'] && $slug !== $this->_req_action )
				continue; //nav tab is only to appear when route requested.

			if ( ! $this->check_user_access( $slug, TRUE ) )
				continue; //no nav tab becasue current user does not have access.

			$css_class = isset( $config['css_class'] ) ? $config['css_class'] . ' ' : '';
			$this->_nav_tabs[$slug] = array(
				'url' => isset($config['nav']['url']) ? $config['nav']['url'] : self::add_query_args_and_nonce( array( 'action'=>$slug ), $this->_admin_base_url ),
				'link_text' => isset( $config['nav']['label'] ) ? $config['nav']['label'] : ucwords(str_replace('_', ' ', $slug ) ),
				'css_class' => $this->_req_action == $slug ? $css_class . 'nav-tab-active' : $css_class,
				'order' => isset( $config['nav']['order'] ) ? $config['nav']['order'] : $i
				);
			$i++;
		}

		//if $this->_nav_tabs is empty then lets set the default
		if ( empty( $this->_nav_tabs ) ) {
			$this->_nav_tabs[$this->default_nav_tab_name] = array(

				'url' => $this->admin_base_url,

				'link_text' => ucwords( str_replace( '_', ' ', $this->default_nav_tab_name ) ),

				'css_class' => 'nav-tab-active',
				'order' => 10
				);
		}

		//now let's sort the tabs according to order
		usort( $this->_nav_tabs, array($this, '_sort_nav_tabs' ));

	}





	/**
	 * _set_current_labels
	 * This method modifies the _labels property with any optional specific labels indicated in the _page_routes property array
	 *
	 * @access private
	 * @return void
	 */
	private function _set_current_labels() {
		if ( is_array($this->_route_config) && isset($this->_route_config['labels']) ) {
			foreach ( $this->_route_config['labels'] as $label => $text ) {
				if ( is_array($text) ) {
					foreach ( $text as $sublabel => $subtext ) {
						$this->_labels[$label][$sublabel] = $subtext;
					}
				} else {
					$this->_labels[$label] = $text;
				}
			}
		}
	}






	/**
	 * 		verifies user access for this admin page
	 * 		@param string $route_to_check if present then the capability for the route matching this string is checked.
	 * 		@param bool   $verify_only Default is FALSE which means if user check fails then wp_die().  Otherwise just return false if verify fail.
	*		@return 		BOOL|wp_die()

	*/
	public function check_user_access( $route_to_check = '', $verify_only = FALSE ) {
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
		$route_to_check = empty( $route_to_check ) ? $this->_req_action : $route_to_check;
		$capability = ! empty( $route_to_check ) && isset( $this->_page_routes[$route_to_check] ) && is_array( $this->_page_routes[$route_to_check] ) && ! empty( $this->_page_routes[$route_to_check]['capability'] ) ? $this->_page_routes[$route_to_check]['capability'] : NULL;

		if ( empty( $capability ) && empty( $route_to_check )  ) {
			$capability = is_array( $this->_route ) && empty( $this->_route['capability'] ) ? 'manage_options' : $this->_route['capability'];
		} else {
			$capability = empty( $capability ) ? 'manage_options' : $capability;
		}

		$id = is_array( $this->_route ) && ! empty( $this->_route['obj_id'] ) ? $this->_route['obj_id'] : 0;

		if (( ! function_exists( 'is_admin' ) || ! EE_Registry::instance()->CAP->current_user_can( $capability, $this->page_slug . '_' . $route_to_check, $id ) ) && ! defined( 'DOING_AJAX')) {
			if ( $verify_only ) {
				return FALSE;
			} else {
				wp_die( __('You do not have access to this route.', 'event_espresso' ) );
			}
		}
		return TRUE;
	}







	/**
	 * admin_init_global
	 * This runs all the code that we want executed within the WP admin_init hook.
	 * This method executes for ALL EE Admin pages.
	 *
	 * @access public
	 * @return void
	 */
	public function admin_init_global() {
	}






	/**
	 * wp_loaded_global
	 * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an EE_Admin page and will execute on every EE Admin Page load
	 *
	 * @access public
	 * @return void
	 */
	public function wp_loaded() {}






	/**
	 * admin_notices
	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on ALL EE_Admin pages.
	 *
	 * @access public
	 * @return void
	 */
	public function admin_notices_global() {
		$this->_display_no_javascript_warning();
		$this->_display_espresso_notices();
	}




	public function network_admin_notices_global() {
		$this->_display_no_javascript_warning();
		$this->_display_espresso_notices();
	}




	/**
	 * admin_footer_scripts_global
	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method will apply on ALL EE_Admin pages.
	 *
	 * @access public
	 * @return void
	 */
	public function admin_footer_scripts_global() {
		$this->_add_admin_page_ajax_loading_img();
		$this->_add_admin_page_overlay();
class User
{
    private $email;

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

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

		//if metaboxes are present we need to add the nonce field
		if ( ( isset($this->_route_config['metaboxes']) || ( isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes'] ) || isset($this->_route_config['list_table']) ) ) {
			wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
			wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
		}
	}





	/**
	 * admin_footer_global
	 * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particluar method will apply on ALL EE_Admin Pages.
	 *
	 * @access  public
	 * @return  void
	 */
	public function admin_footer_global() {
		//dialog container for dialog helper
		$d_cont = '<div class="ee-admin-dialog-container auto-hide hidden">' . "\n";
		$d_cont .= '<div class="ee-notices"></div>';
		$d_cont .= '<div class="ee-admin-dialog-container-inner-content"></div>';
		$d_cont .= '</div>';
		echo $d_cont;

		//help tour stuff?
		if ( isset( $this->_help_tour[$this->_req_action] ) ) {
			echo implode('<br />', $this->_help_tour[$this->_req_action]);
		}

		//current set timezone for timezone js
		EE_Registry::instance()->load_helper('DTT_Helper');
		echo '<span id="current_timezone" class="hidden">' . EEH_DTT_Helper::get_timezone() . '</span>';
	}


	/**
	 * This function sees if there is a method for help popup content existing for the given route.  If there is then we'll use the retrieved array to output the content using the template.
	 *
	 * For child classes:
	 * If you want to have help popups then in your templates or your content you set "triggers" for the content using the "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method for the help popup content on that page.
	 * Then in your Child_Admin_Page class you need to define a help popup method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content for the 'edit_event' route you should have a method named "_help_popup_content_edit_route".
	 * In your defined "help_popup_content_..." method.  You must prepare and return an array in the following format
	 * array(
	 * 	'help_trigger_id' => array(
	 * 		'title' => __('localized title for popup', 'event_espresso'),
	 * 		'content' => __('localized content for popup', 'event_espresso')
	 * 	)
	 * );
	 *
	 * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
	 *
	 *
	 * @access protected
	 * @return string content
	 */
	protected function _set_help_popup_content( $help_array = array(), $display = FALSE ) {
		$content = '';

		$help_array = empty( $help_array ) ? $this->_get_help_content() : $help_array;
		$template_path = EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php';


		//loop through the array and setup content
		foreach ( $help_array as $trigger => $help ) {
			//make sure the array is setup properly
			if ( !isset($help['title']) || !isset($help['content'] ) ) {
				throw new EE_Error( __('Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class', 'event_espresso') );
			}

			//we're good so let'd setup the template vars and then assign parsed template content to our content.
			$template_args = array(
				'help_popup_id' => $trigger,
				'help_popup_title' => $help['title'],
				'help_popup_content' => $help['content']
				);

			$content .= EEH_Template::display_template( $template_path, $template_args, TRUE );
		}

		if ( $display )
			echo $content;
		else
			return $content;
	}




	/**
	 * All this does is retrive the help content array if set by the EE_Admin_Page child
	 *
	 * @access private
	 * @return array properly formatted array for help popup content
	 */
	private function _get_help_content() {
		//what is the method we're looking for?
		$method_name = '_help_popup_content_' . $this->_req_action;

		//if method doesn't exist let's get out.
		if ( !method_exists( $this, $method_name ) )
			return array();

		//k we're good to go let's retrieve the help array
		$help_array = call_user_func( array( $this, $method_name ) );

		//make sure we've got an array!
		if ( !is_array($help_array) ) {
			throw new EE_Error( __('Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.', 'event_espresso' ) );
		}

		return $help_array;
	}



	/**
	 * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
	 *
	 * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
	 *
	 * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
	 *
	 *
	 * @access protected
	 * @param string  $trigger_id reference for retrieving the trigger content for the popup
	 * @param boolean $display    if false then we return the trigger string
	 * @param array $dimensions an array of dimensions for the box (array(h,w))
	 * @return string
	 */
	protected function _set_help_trigger( $trigger_id, $display = TRUE, $dimensions = array( '400', '640') ) {

		if ( defined('DOING_AJAX') ) return;

		//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
		$help_array = $this->_get_help_content();
		$help_content = '';

		if ( empty( $help_array ) || !isset( $help_array[$trigger_id] ) ) {
			$help_array[$trigger_id] = array(
				'title' => __('Missing Content', 'event_espresso'),
				'content' => __('A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)', 'event_espresso')
				);
			$help_content = $this->_set_help_popup_content( $help_array, FALSE );
		}

		//let's setup the trigger
		$content = '<a class="ee-dialog" href="?height='. $dimensions[0] . '&width=' . $dimensions[1] . '&inlineId=' . $trigger_id . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
		$content = $content . $help_content;

		if ( $display )
			echo $content;
		else
			return $content;
	}


	/**
	 * _add_global_screen_options
	 * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
	 * This particular method will add_screen_options on ALL EE_Admin Pages
	 * @link http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
	 * see also WP_Screen object documents...
	 * @link http://codex.wordpress.org/Class_Reference/WP_Screen
	 *
	 * @abstract
	 * @access private
	 * @return void
	 */
	private function _add_global_screen_options() {}









	/**
	 * _add_global_feature_pointers
	 * This method is used for implementing any "feature pointers" (using built-in WP styling js).
	 * This particular method will implement feature pointers for ALL EE_Admin pages.
	 * Note: this is just a placeholder for now.  Implementation will come down the road
	 * @see WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be extended) also see:
	 * @link http://eamann.com/tech/wordpress-portland/
	 *
	 * @abstract
	 * @access protected
	 * @return void
	 */
	private function _add_global_feature_pointers() {}






	/**
	 * load_global_scripts_styles
	 * The scripts and styles enqueued in here will be loaded on every EE Admin page
	 *
	 * @return void
	 */
	public function load_global_scripts_styles() {
		/** STYLES **/
		// add debugging styles
		if ( WP_DEBUG ) {
			add_action('admin_head', array( $this, 'add_xdebug_style' ));
		}

		//register all styles
		wp_register_style( 'espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(),EVENT_ESPRESSO_VERSION );
		wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', array(), EVENT_ESPRESSO_VERSION);
		//helpers styles
		wp_register_style('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css', array(), EVENT_ESPRESSO_VERSION );
		//enqueue global styles
		wp_enqueue_style('ee-admin-css');


		/** SCRIPTS **/

		//register all scripts
		wp_register_script( 'espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE );
		wp_register_script('ee-dialog', EE_ADMIN_URL . 'assets/ee-dialog-helper.js', array('jquery', 'jquery-ui-draggable'), EVENT_ESPRESSO_VERSION, TRUE );
		wp_register_script('ee_admin_js', EE_ADMIN_URL . 'assets/ee-admin-page.js', array( 'espresso_core', 'ee-parse-uri', 'ee-dialog'), EVENT_ESPRESSO_VERSION, true );

		wp_register_script('jquery-ui-timepicker-addon', EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js', array('jquery-ui-datepicker', 'jquery-ui-slider'), EVENT_ESPRESSO_VERSION, true );
		// register jQuery Validate - see /includes/functions/wp_hooks.php
		add_filter( 'FHEE_load_jquery_validate', '__return_true' );
		add_filter('FHEE_load_joyride', '__return_true');

		//script for sorting tables
		wp_register_script('espresso_ajax_table_sorting', EE_ADMIN_URL . "assets/espresso_ajax_table_sorting.js", array('ee_admin_js', 'jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, TRUE);
		//script for parsing uri's
		wp_register_script( 'ee-parse-uri', EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js', array(), EVENT_ESPRESSO_VERSION, TRUE );
		//and parsing associative serialized form elements
		wp_register_script( 'ee-serialize-full-array', EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE );
		//helpers scripts
		wp_register_script('ee-text-links', EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE );
		wp_register_script( 'ee-moment-core', EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js', array(), EVENT_ESPRESSO_VERSION, TRUE );
		wp_register_script( 'ee-moment', EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js', array('ee-moment-core'), EVENT_ESPRESSO_VERSION, TRUE );
		wp_register_script( 'ee-datepicker', EE_ADMIN_URL . 'assets/ee-datepicker.js', array('jquery-ui-timepicker-addon','ee-moment'), EVENT_ESPRESSO_VERSION, TRUE );

		//google charts
		wp_register_script( 'google-charts', 'https://www.gstatic.com/charts/loader.js', array(), EVENT_ESPRESSO_VERSION, false );

		//enqueue global scripts

		//taking care of metaboxes
		if ( ( isset($this->_route_config['metaboxes'] ) || isset($this->_route_config['has_metaboxes']) ) && empty( $this->_cpt_route) ) {

			wp_enqueue_script('dashboard');
		}

		//enqueue thickbox for ee help popups.  default is to enqueue unless its explicitly set to false since we're assuming all EE pages will have popups
		if ( ! isset( $this->_route_config['has_help_popups']) || ( isset( $this->_route_config['has_help_popups']) && $this->_route_config['has_help_popups'] ) ) {
			wp_enqueue_script('ee_admin_js');
			wp_enqueue_style('ee-admin-css');
		}


		//localize script for ajax lazy loading
		$lazy_loader_container_ids = apply_filters( 'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers', array('espresso_news_post_box_content') );
		wp_localize_script( 'ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);


		/**
		 * help tour stuff
		 */
		if ( !empty( $this->_help_tour ) ) {

			//register the js for kicking things off
			wp_enqueue_script('ee-help-tour', EE_ADMIN_URL . 'assets/ee-help-tour.js', array('jquery-joyride'), EVENT_ESPRESSO_VERSION, TRUE );

			//setup tours for the js tour object
			foreach ( $this->_help_tour['tours'] as $tour ) {
				$tours[] = array(
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
					'id' => $tour->get_slug(),
					'options' => $tour->get_options()
					);
			}

			wp_localize_script('ee-help-tour', 'EE_HELP_TOUR', array('tours' => $tours ) );
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

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

			//admin_footer_global will take care of making sure our help_tour skeleton gets printed via the info stored in $this->_help_tour
		}
	}




	/**
	*		admin_footer_scripts_eei18n_js_strings
	*
	*		@access 		public
	*		@return 		void
	*/
	public function admin_footer_scripts_eei18n_js_strings() {

		EE_Registry::$i18n_js_strings['ajax_url'] = WP_AJAX_URL;
		EE_Registry::$i18n_js_strings['confirm_delete'] = __( 'Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!', 'event_espresso' );

		EE_Registry::$i18n_js_strings['January'] = __( 'January', 'event_espresso' );
		EE_Registry::$i18n_js_strings['February'] = __( 'February', 'event_espresso' );
		EE_Registry::$i18n_js_strings['March'] = __( 'March', 'event_espresso' );
		EE_Registry::$i18n_js_strings['April'] = __( 'April', 'event_espresso' );
		EE_Registry::$i18n_js_strings['May'] = __( 'May', 'event_espresso' );
		EE_Registry::$i18n_js_strings['June'] = __( 'June', 'event_espresso' );
		EE_Registry::$i18n_js_strings['July'] = __( 'July', 'event_espresso' );
		EE_Registry::$i18n_js_strings['August'] = __( 'August', 'event_espresso' );
		EE_Registry::$i18n_js_strings['September'] = __( 'September', 'event_espresso' );
		EE_Registry::$i18n_js_strings['October'] = __( 'October', 'event_espresso' );
		EE_Registry::$i18n_js_strings['November'] = __( 'November', 'event_espresso' );
		EE_Registry::$i18n_js_strings['December'] = __( 'December', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Jan'] = __( 'Jan', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Feb'] = __( 'Feb', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Mar'] = __( 'Mar', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Apr'] = __( 'Apr', 'event_espresso' );
		EE_Registry::$i18n_js_strings['May'] = __( 'May', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Jun'] = __( 'Jun', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Jul'] = __( 'Jul', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Aug'] = __( 'Aug', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Sep'] = __( 'Sep', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Oct'] = __( 'Oct', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Nov'] = __( 'Nov', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Dec'] = __( 'Dec', 'event_espresso' );

		EE_Registry::$i18n_js_strings['Sunday'] = __( 'Sunday', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Monday'] = __( 'Monday', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Tuesday'] = __( 'Tuesday', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Wednesday'] = __( 'Wednesday', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Thursday'] = __( 'Thursday', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Friday'] = __( 'Friday', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Saturday'] = __( 'Saturday', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Sun'] = __( 'Sun', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Mon'] = __( 'Mon', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Tue'] = __( 'Tue', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Wed'] = __( 'Wed', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Thu'] = __( 'Thu', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Fri'] = __( 'Fri', 'event_espresso' );
		EE_Registry::$i18n_js_strings['Sat'] = __( 'Sat', 'event_espresso' );

		//setting on espresso_core instead of ee_admin_js because espresso_core is enqueued by the maintenance
		//admin page when in maintenance mode and ee_admin_js is not loaded then.  This works everywhere else because
		//espresso_core is listed as a dependency of ee_admin_js.
		wp_localize_script( 'espresso_core', 'eei18n', EE_Registry::$i18n_js_strings );

	}



	/**
	*		load enhanced xdebug styles for ppl with failing eyesight
	*
	*		@access 		public
	*		@return 		void
	*/
	public function add_xdebug_style() {
		echo '<style>.xdebug-error { font-size:1.5em; }</style>';
	}


	/************************/
	/** LIST TABLE METHODS **/
	/************************/





	/**
	 * this sets up the list table if the current view requires it.
	 *
	 * @access protected
	 * @return void
	 */
	protected function _set_list_table() {

		//first is this a list_table view?
		if ( !isset($this->_route_config['list_table']) )
			return; //not a list_table view so get out.

		//list table functions are per view specific (because some admin pages might have more than one listtable!)

		if ( call_user_func( array( $this, '_set_list_table_views_' . $this->_req_action ) ) === FALSE ) {
			//user error msg
			$error_msg = __('An error occurred. The requested list table views could not be found.', 'event_espresso' );
			//developer error msg
			$error_msg .= '||' . sprintf( __('List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.', 'event_espresso' ), $this->_req_action, '_set_list_table_views_' . $this->_req_action );
			throw new EE_Error( $error_msg );
		}

		//let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
		$this->_views = apply_filters( 'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action, $this->_views );
		$this->_views = apply_filters( 'FHEE_list_table_views_' . $this->page_slug, $this->_views );
		$this->_views = apply_filters( 'FHEE_list_table_views', $this->_views );

		$this->_set_list_table_view();
		$this->_set_list_table_object();

	}










	/**
	 * 		set current view for List Table
	*		@access public
	*		@return array
	*/
	protected function _set_list_table_view() {
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );


		// looking at active items or dumpster diving ?
		if ( ! isset( $this->_req_data['status'] ) || ! array_key_exists( $this->_req_data['status'], $this->_views )) {
			$this->_view = isset( $this->_views['in_use'] ) ? 'in_use' : 'all';
		} else {
			$this->_view = sanitize_key( $this->_req_data['status'] );
		}
	}



	/**
	 * _set_list_table_object
	 * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
	 */
	protected function _set_list_table_object() {
		if ( isset($this->_route_config['list_table'] ) ) {
			if ( !class_exists( $this->_route_config['list_table'] ) )
				throw new EE_Error( sprintf( __('The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.', 'event_espresso'), $this->_route_config['list_table'], get_class($this) ) );
			$a = new ReflectionClass($this->_route_config['list_table']);
			$this->_list_table_object = $a->newInstance($this);
		}
	}





	/**
	 * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
	 *
	 * @param array $extra_query_args Optional. An array of extra query args to add to the generated
	 *                                		          	urls.  The array should be indexed by the view it is being
	 *                                		          	added to.
	 *
	 * @return array
	 */
	public function get_list_table_view_RLs( $extra_query_args = array() ) {

		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );

		if ( empty( $this->_views )) {
			$this->_views = array();
		}

		// cycle thru views
		foreach ( $this->_views as $key => $view ) {
			$query_args = array();
			// check for current view
			$this->_views[ $key ]['class'] = $this->_view == $view['slug'] ? 'current' : '';
			$query_args['action'] = $this->_req_action;
			$query_args[$this->_req_action.'_nonce'] = wp_create_nonce( $query_args['action'] . '_nonce' );
			$query_args['status'] = $view['slug'];
			//merge any other arguments sent in.
			if ( isset( $extra_query_args[$view['slug']] ) ) {
				$query_args = array_merge( $query_args, $extra_query_args[$view['slug']] );
			}
			$this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce( $query_args, $this->_admin_base_url );
		}

		return $this->_views;
	}




	/**
	 * _entries_per_page_dropdown
	 * generates a drop down box for selecting the number of visiable rows in an admin page list table
	 * @todo: Note: ideally this should be added to the screen options dropdown as that would be consistent with how WP does it.
	 * @access protected
	 * @param int $max_entries total number of rows in the table
	 * @return string
	*/
	protected function _entries_per_page_dropdown( $max_entries = FALSE ) {

		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
		$values = array( 10, 25, 50, 100 );
		$per_page = ( ! empty( $this->_req_data['per_page'] )) ? absint( $this->_req_data['per_page'] ) : 10;

		if ( $max_entries ) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			$values[] = $max_entries;
			sort( $values );
		}

		$entries_per_page_dropdown = '
			<div id="entries-per-page-dv" class="alignleft actions">
				<label class="hide-if-no-js">
					Show
					<select id="entries-per-page-slct" name="entries-per-page-slct">';

		foreach ( $values as $value ) {
			if ( $value < $max_entries ) {
				$selected = $value == $per_page ?  ' selected="' . $per_page . '"' : '';
				$entries_per_page_dropdown .= '
						<option value="'.$value.'"'.$selected.'>'.$value.'&nbsp;&nbsp;</option>';
			}
		}

		$selected = $max_entries == $per_page ?  ' selected="' . $per_page . '"' : '';
		$entries_per_page_dropdown .= '
						<option value="'.$max_entries.'"'.$selected.'>All&nbsp;&nbsp;</option>';

		$entries_per_page_dropdown .= '
					</select>
					entries
				</label>
				<input id="entries-per-page-btn" class="button-secondary" type="submit" value="Go" >
			</div>
		';
		return $entries_per_page_dropdown;
	}




	/**
	 * 		_set_search_attributes
	*		@access 		protected
	*		@return 		void
	*/
	public function _set_search_attributes() {
		$this->_template_args['search']['btn_label'] = sprintf( __( 'Search %s', 'event_espresso' ), empty( $this->_search_btn_label ) ? $this->page_label : $this->_search_btn_label );
		$this->_template_args['search']['callback'] = 'search_' . $this->page_slug;
	}

	/*** END LIST TABLE METHODS **/
	/*****************************/





	/**
	 * 		_add_registered_metaboxes
	 * 		this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
	 *
	 * @link http://codex.wordpress.org/Function_Reference/add_meta_box
	 * @access private
	 * @return void
	*/
	private function _add_registered_meta_boxes() {
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );

		//we only add meta boxes if the page_route calls for it
		if ( is_array($this->_route_config) && isset( $this->_route_config['metaboxes'] ) && is_array($this->_route_config['metaboxes']) ) {


			//this simply loops through the callbacks provided and checks if there is a corresponding callback registered by the child - if there is then we go ahead and process the metabox loader.
			foreach ( $this->_route_config['metaboxes'] as $metabox_callback ) {
				if ( call_user_func( array($this, &$metabox_callback) ) === FALSE ) {
					// user error msg
				$error_msg =  __( 'An error occurred. The  requested metabox could not be found.', 'event_espresso' );
				// developer error msg
				$error_msg .= '||' . sprintf( __( 'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.', 'event_espresso' ), $metabox_callback );
				throw new EE_Error( $error_msg );
				}
			}
		}
	}




	/**
	 * _add_screen_columns
	 * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as the dynamic column template and we'll setup the column options for the page.
	 *
	 * @access private
	 * @return void
	 */
	private function _add_screen_columns() {
		if ( is_array($this->_route_config) && isset( $this->_route_config['columns'] ) && is_array($this->_route_config['columns']) && count( $this->_route_config['columns'] == 2 ) ) {

			add_screen_option('layout_columns', array('max' => (int) $this->_route_config['columns'][0], 'default' => (int) $this->_route_config['columns'][1] ) );
			$this->_template_args['num_columns'] = $this->_route_config['columns'][0];
			$screen_id = $this->_current_screen->id;
			$screen_columns = (int) get_user_option("screen_layout_$screen_id");
			$total_columns = !empty($screen_columns) ? $screen_columns : $this->_route_config['columns'][1];
			$this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
			$this->_template_args['current_page'] = $this->_wp_page_slug;
			$this->_template_args['screen'] = $this->_current_screen;
			$this->_column_template_path = EE_ADMIN_TEMPLATE . 'admin_details_metabox_column_wrapper.template.php';

			//finally if we don't have has_metaboxes set in the route config let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
			$this->_route_config['has_metaboxes'] = TRUE;
		}
	}



	/**********************************/
	/** GLOBALLY AVAILABLE METABOXES **/

	/**
	 * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply referencing the callback in the _page_config array property.  This way you can be very specific about what pages these get loaded on.
	 */

	private function _espresso_news_post_box() {
		$news_box_title = apply_filters( 'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __( 'New @ Event Espresso', 'event_espresso' ) );
		add_meta_box( 'espresso_news_post_box', $news_box_title, array(
			$this,
			'espresso_news_post_box'
		), $this->_wp_page_slug, 'side' );
	}


	/**
	 * Code for setting up espresso ratings request metabox.
	 */
	protected function _espresso_ratings_request() {
		if ( ! apply_filters( 'FHEE_show_ratings_request_meta_box', true ) ) {
			return '';
		}
		$ratings_box_title = apply_filters( 'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title', __('Keep Event Espresso Decaf Free', 'event_espresso') );
		add_meta_box( 'espresso_ratings_request', $ratings_box_title, array(
			$this,
			'espresso_ratings_request'
		), $this->_wp_page_slug, 'side' );
	}


	/**
	 * Code for setting up espresso ratings request metabox content.
	 */
	public function espresso_ratings_request() {
		$template_path = EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php';
		EE_Registry::instance()->load_helper( 'Template' );
		EEH_Template::display_template( $template_path, array() );
	}




	public static function cached_rss_display( $rss_id, $url ) {
		$loading = '<p class="widget-loading hide-if-no-js">' . __( 'Loading&#8230;' ) . '</p><p class="hide-if-js">' . __( 'This widget requires JavaScript.' ) . '</p>';
		$doing_ajax = ( defined( 'DOING_AJAX' ) && DOING_AJAX );
		$pre = '<div class="espresso-rss-display">' . "\n\t";
		$pre .= '<span id="' . $rss_id . '_url" class="hidden">' . $url . '</span>';
		$post = '</div>' . "\n";

		$cache_key = 'ee_rss_' . md5( $rss_id );
		if ( FALSE != ( $output = get_transient( $cache_key ) ) ) {
			echo $pre . $output . $post;
			return TRUE;
		}

		if ( ! $doing_ajax ) {
			echo $pre . $loading . $post;
			return FALSE;
		}

		ob_start();
		wp_widget_rss_output($url, array('show_date' => 0, 'items' => 5) );
		set_transient( $cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS );
		return TRUE;

	}


	public function espresso_news_post_box() {
		?>
	  <div class="padding">
	  	<div id="espresso_news_post_box_content" class="infolinks">
	  		<?php
	  		// Get RSS Feed(s)
	  		$feed_url = apply_filters( 'FHEE__EE_Admin_Page__espresso_news_post_box__feed_url', 'http://eventespresso.com/feed/' );
	  		$url = urlencode($feed_url);
	  		self::cached_rss_display( 'espresso_news_post_box_content', $url );

	  		?>
	  	</div>
	  	<?php do_action( 'AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
	  </div>
		<?php
	}


	private function _espresso_links_post_box() {
		//Hiding until we actually have content to put in here...
		//add_meta_box('espresso_links_post_box', __('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
	}

	public function espresso_links_post_box() {
		   //Hiding until we actually have content to put in here...
		   //$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php';
			//EEH_Template::display_template( $templatepath );
		}



	protected function _espresso_sponsors_post_box() {

		$show_sponsors = apply_filters( 'FHEE_show_sponsors_meta_box', TRUE );
		if ( $show_sponsors )
			add_meta_box('espresso_sponsors_post_box', __('Event Espresso Highlights', 'event_espresso'), array( $this, 'espresso_sponsors_post_box'), $this->_wp_page_slug, 'side');
	}


	public function espresso_sponsors_post_box() {
		$templatepath = EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php';
		EEH_Template::display_template( $templatepath );
	}



	private function _publish_post_box() {
		$meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';

		//if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array then we'll use that for the metabox label.  Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
		if ( !empty( $this->_labels['publishbox'] ) ) {
			$box_label = is_array( $this->_labels['publishbox'] ) ? $this->_labels['publishbox'][$this->_req_action] : $this->_labels['publishbox'];
		} else {
			$box_label = __('Publish', 'event_espresso');
		}

		$box_label = apply_filters( 'FHEE__EE_Admin_Page___publish_post_box__box_label', $box_label, $this->_req_action, $this );

		add_meta_box( $meta_box_ref, $box_label, array( $this, 'editor_overview' ), $this->_current_screen->id, 'side', 'high' );

	}



	public function editor_overview() {
		//if we have extra content set let's add it in if not make sure its empty
		$this->_template_args['publish_box_extra_content'] = isset( $this->_template_args['publish_box_extra_content'] ) ? $this->_template_args['publish_box_extra_content'] : '';
		$template_path = EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php';
		echo EEH_Template::display_template( $template_path, $this->_template_args, TRUE );
	}


	/** end of globally available metaboxes section **/
	/*************************************************/



	/**
	 * Public wrapper for the protected method.  Allows plugins/addons to externally call the
	 * protected method.
	 *
	 * @see $this->_set_publish_post_box_vars for param details
	 * @since 4.6.0
	 */
	public function set_publish_post_box_vars( $name = null, $id = false, $delete = false, $save_close_redirect_URL = null, $both_btns = true ) {
		$this->_set_publish_post_box_vars( $name, $id, $delete, $save_close_redirect_URL, $both_btns );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}


	/**
	 * Sets the _template_args arguments used by the _publish_post_box shortcut
	 *
	 * Note: currently there is no validation for this.  However if you want the delete button, the
	 * save, and save and close buttons to work properly, then you will want to include a
	 * values for the name and id arguments.
	 *
	 * @todo  Add in validation for name/id arguments.
	 *
	 * @param	string	$name		key used for the action ID (i.e. event_id)
	 * @param	int		$id	id attached to the item published
	 * @param	string	$delete	page route callback for the delete action
	 * @param	string	$post_save_redirect_URL	custom URL to redirect to after Save & Close has been completed
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param	boolean	$both_btns	whether to display BOTH the "Save & Close" and "Save" buttons or just the Save button
	 */
	protected function _set_publish_post_box_vars( $name = NULL, $id = FALSE, $delete = FALSE, $save_close_redirect_URL = NULL, $both_btns = TRUE ) {

		// if Save & Close, use a custom redirect URL or default to the main page?
		$save_close_redirect_URL = ! empty( $save_close_redirect_URL ) ? $save_close_redirect_URL : $this->_admin_base_url;
		// create the Save & Close and Save buttons
		$this->_set_save_buttons( $both_btns, array(), array(), $save_close_redirect_URL );
		//if we have extra content set let's add it in if not make sure its empty
		$this->_template_args['publish_box_extra_content'] = isset( $this->_template_args['publish_box_extra_content'] ) ? $this->_template_args['publish_box_extra_content'] : '';


		if ( $delete && ! empty( $id )  ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$delete = is_bool($delete) ? 'delete' : $delete; //make sure we have a default if just true is sent.
			$delete_link_args = array( $name => $id );
			$delete = $this->get_action_link_or_button( $delete, $delete, $delete_link_args, 'submitdelete deletion');
		}

		$this->_template_args['publish_delete_link'] = !empty( $id ) ? $delete : '';
		if ( ! empty( $name ) && ! empty( $id ) ) {
			$hidden_field_arr[$name] = array(
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
				'type' => 'hidden',
				'value' => $id
				);
			$hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
		} else {
			$hf = '';
		}
		// add hidden field
		$this->_template_args['publish_hidden_fields'] = ! empty( $hf ) ? $hf[$name]['field'] : $hf;

	}




	/**
	 * 		displays an error message to ppl who have javascript disabled
	*		@access 		private
	*		@return 		string
	*/
	private function _display_no_javascript_warning() {
		?>
		<noscript>
			<div id="no-js-message" class="error">
				<p style="font-size:1.3em;">
					<span style="color:red;"><?php _e( 'Warning!', 'event_espresso' ); ?></span>
					<?php _e( 'Javascript is currently turned off for your browser. Javascript must be enabled in order for all of the features on this page to function properly. Please turn your javascript back on.', 'event_espresso' ); ?>
				</p>
			</div>
		</noscript>
		<?php
	}








	/**
	 * 		displays espresso success and/or error notices
	*		@access 		private
	*		@return 		string
	*/
	private function _display_espresso_notices() {
		$notices = $this->_get_transient( TRUE );
		echo stripslashes($notices);
	}






	/**
	*		spinny things pacify the masses
	*		@access private
	*		@return string
	*/
	protected function _add_admin_page_ajax_loading_img() {
		?>
			<div id="espresso-ajax-loading" class="ajax-loading-grey">
				<span class="ee-spinner ee-spin"></span><span class="hidden"><?php _e('loading...', 'event_espresso'); ?></span>
			</div>
		<?php
	}





	/**
	*		add admin page overlay for modal boxes
	*		@access private
	*		@return string
	*/
	protected function _add_admin_page_overlay() {
		?>
		<div id="espresso-admin-page-overlay-dv" class=""></div>
		<?php
	}






	/**
	 * facade for add_meta_box
	 * @param string  $action        where the metabox get's displayed
	 * @param string  $title         Title of Metabox (output in metabox header)
	 * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback instead of the one created in here.
	 * @param array  $callback_args an array of args supplied for the metabox
	 * @param string  $column        what metabox column
	 * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
	 * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function created but just set our own callback for wp's add_meta_box.
	 */
	public function _add_admin_page_meta_box( $action, $title, $callback, $callback_args, $column = 'normal', $priority = 'high', $create_func = true ) {
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, $callback );

		//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.
		if ( empty( $callback_args ) && $create_func ) {
			$callback_args = array(
				'template_path' => $this->_template_path,
				'template_args' => $this->_template_args,
				);
		}

		//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)
		$call_back_func = $create_func ? create_function('$post, $metabox', 'do_action( "AHEE_log", __FILE__, __FUNCTION__, ""); echo EEH_Template::display_template( $metabox["args"]["template_path"], $metabox["args"]["template_args"], TRUE );') : $callback;
// Instead of
$function = create_function('$a, $b', 'return $a + $b');

// Better use
$function = function($a, $b) { return $a + $b; }

		add_meta_box( str_replace( '_', '-', $action ) . '-mbox', $title, $call_back_func, $this->_wp_page_slug, $column, $priority, $callback_args );
	}





	/**
	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
	 * @return [type] [description]

	 */
	public function display_admin_page_with_metabox_columns() {
		$this->_template_args['post_body_content'] = $this->_template_args['admin_page_content'];
		$this->_template_args['admin_page_content'] = EEH_Template::display_template( $this->_column_template_path, $this->_template_args, TRUE);

		//the final wrapper
		$this->admin_page_wrapper();
	}







	/**
	*		generates  HTML wrapper for an admin details page
	*		@access public
	*		@return void
	*/
	public function display_admin_page_with_sidebar() {

		$this->_display_admin_page(TRUE);
	}




	/**
	*		generates  HTML wrapper for an admin details page (except no sidebar)
	*		@access public
	*		@return void
	*/
	public function display_admin_page_with_no_sidebar() {
		$this->_display_admin_page();
	}




	/**
	 * generates HTML wrapper for an EE about admin page (no sidebar)
	 * @access public
	 * @return void
	 */
	public function display_about_admin_page() {
		$this->_display_admin_page( FALSE, TRUE );
	}




	/**
	 * display_admin_page
	 * contains the code for actually displaying an admin page
	 *
	 * @access private
	 * @param  boolean $sidebar true with sidebar, false without
	 * @param  boolean $about   use the about admin wrapper instead of the default.
	 * @return html           admin_page
	 */
	private function _display_admin_page($sidebar = false, $about = FALSE) {
		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );

		//custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
		do_action( 'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes' );

		// set current wp page slug - looks like: event-espresso_page_event_categories
		// keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
		$this->_template_args['current_page'] = $this->_wp_page_slug;

		$template_path = $sidebar ?  EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';

		if ( defined('DOING_AJAX' ) )
			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';

		$template_path = !empty($this->_column_template_path) ? $this->_column_template_path : $template_path;

		$this->_template_args['post_body_content'] = isset( $this->_template_args['admin_page_content'] ) ? $this->_template_args['admin_page_content'] : '';
		$this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content']) ? $this->_template_args['before_admin_page_content'] : '';
		$this->_template_args['after_admin_page_content'] = isset($this->_template_args['after_admin_page_content']) ? $this->_template_args['after_admin_page_content'] : '';
		$this->_template_args['admin_page_content'] = EEH_Template::display_template( $template_path, $this->_template_args, TRUE );


		// the final template wrapper
		$this->admin_page_wrapper($about);
	}





	/**
	 * This is used to display caf preview pages.
	 *
	 * @since 4.3.2
	 *
	 * @param string $utm_campaign_source what is the key used for google analytics link
	 * @param bool   $display_sidebar whether to use the sidebar template or the full template for the page.  TRUE = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
	 * @return void
	 */
	public function display_admin_caf_preview_page( $utm_campaign_source = '', $display_sidebar = TRUE ) {
		//let's generate a default preview action button if there isn't one already present.
		$this->_labels['buttons']['buy_now'] = __('Upgrade Now', 'event_espresso');
		$buy_now_url = add_query_arg(
			array(
				'ee_ver' => 'ee4',
				'utm_source' => 'ee4_plugin_admin',
				'utm_medium' => 'link',
				'utm_campaign' => $utm_campaign_source,
				'utm_content' => 'buy_now_button'
			),
		'http://eventespresso.com/pricing/'
		);
		$this->_template_args['preview_action_button'] = ! isset( $this->_template_args['preview_action_button'] ) ? $this->get_action_link_or_button( '', 'buy_now', array(), 'button-primary button-large', $buy_now_url, true ) : $this->_template_args['preview_action_button'];
		$template_path = EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php';
		$this->_template_args['admin_page_content'] = EEH_Template::display_template( $template_path, $this->_template_args, TRUE );
		$this->_display_admin_page( $display_sidebar );
	}


	/**
	 * display_admin_list_table_page_with_sidebar
	 * generates HTML wrapper for an admin_page with list_table
	 *
	 * @access public
	 * @return html
	 */
	public function display_admin_list_table_page_with_sidebar() {
		$this->_display_admin_list_table_page(TRUE);
	}

	/**
	 * display_admin_list_table_page_with_no_sidebar
	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
	 *
	 * @access public
	 * @return html
	 */
	public function display_admin_list_table_page_with_no_sidebar() {
		$this->_display_admin_list_table_page();
	}



	/**
	 * generates html wrapper for an admin_list_table page
	 * @access private
	 * @param boolean $sidebar whether to display with sidebar or not.
	 * @return html
	 */
	private function _display_admin_list_table_page( $sidebar = false ) {
		//setup search attributes
		$this->_set_search_attributes();
		$this->_template_args['current_page'] = $this->_wp_page_slug;
		$template_path = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';

		$this->_template_args['table_url'] = defined( 'DOING_AJAX') ? add_query_arg( array( 'noheader' => 'true', 'route' => $this->_req_action), $this->_admin_base_url ) : add_query_arg( array( 'route' => $this->_req_action), $this->_admin_base_url);
		$this->_template_args['list_table'] = $this->_list_table_object;
		$this->_template_args['current_route'] = $this->_req_action;
		$this->_template_args['list_table_class'] = get_class( $this->_list_table_object );

		$ajax_sorting_callback = $this->_list_table_object->get_ajax_sorting_callback();
		if( ! empty( $ajax_sorting_callback )) {
			$sortable_list_table_form_fields = wp_nonce_field( $ajax_sorting_callback . '_nonce', $ajax_sorting_callback . '_nonce', FALSE, FALSE );
//			$reorder_action = 'espresso_' . $ajax_sorting_callback . '_nonce';
//			$sortable_list_table_form_fields = wp_nonce_field( $reorder_action, 'ajax_table_sort_nonce', FALSE, FALSE );
			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="' . $this->page_slug .'" />';
			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="' . $ajax_sorting_callback . '" />';
		} else {
			$sortable_list_table_form_fields = '';
		}

		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
		$hidden_form_fields = isset( $this->_template_args['list_table_hidden_fields'] ) ? $this->_template_args['list_table_hidden_fields'] : '';
		$nonce_ref = $this->_req_action . '_nonce';
		$hidden_form_fields .= '<input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce( $nonce_ref ) . '">';
		$this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;

		//display message about search results?
		$this->_template_args['before_list_table'] .= apply_filters( 'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg', !empty( $this->_req_data['s'] ) ? '<p class="ee-search-results">' . sprintf( __('Displaying search results for the search string: <strong><em>%s</em></strong>', 'event_espresso'), trim($this->_req_data['s'], '%') ) . '</p>' : '', $this->page_slug, $this->_req_data, $this->_req_action );

		$this->_template_args['admin_page_content'] = EEH_Template::display_template( $template_path, $this->_template_args, TRUE );

		// the final template wrapper
		if ( $sidebar )
			$this->display_admin_page_with_sidebar();
		else
			$this->display_admin_page_with_no_sidebar();
	}





	/**
	 * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the html string for the legend.
	 *
	 * $items are expected in an array in the following format:
	 * $legend_items = array(
	 * 		'item_id' => array(
	 * 			'icon' => 'http://url_to_icon_being_described.png',
	 * 			'desc' => __('localized description of item');
	 * 		)
	 * );
	 * @param  array $items  see above for format of array
	 * @return string        html string of legend
	 */
	protected function _display_legend( $items ) {
		$template_args['items'] = apply_filters( 'FHEE__EE_Admin_Page___display_legend__items', (array) $items, $this );
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
		$legend_template = EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php';
		return EEH_Template::display_template($legend_template, $template_args, TRUE);
	}




	/**
	 * this is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
	 *
	 * @param bool $sticky_notices Used to indicate whether you want to ensure notices are added to a transient instead of displayed.
	 *
	 * The returned json object is created from an array in the following format:
	 * array(
	 * 	'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
	 * 	'success' => FALSE, //(default FALSE) - contains any special success message.
	 * 	'notices' => '', // - contains any EE_Error formatted notices
	 * 	'content' => 'string can be html', //this is a string of formatted content (can be html)
	 * 	'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. We're also going to include the template args with every package (so js can pick out any specific template args that might be included in here)
	 * )
	 *
	 * The json object is populated by whatever is set in the $_template_args property.
	 *
	 * @return json object
	 */
	protected function _return_json( $sticky_notices = FALSE ) {

		//make sure any EE_Error notices have been handled.
		$this->_process_notices( array(), true, $sticky_notices );


		$data = isset( $this->_template_args['data'] ) ? $this->_template_args['data'] : array();
		unset($this->_template_args['data']);
		$json = array(
			'error' => isset( $this->_template_args['error'] ) ? $this->_template_args['error'] : FALSE,
			'success' => isset( $this->_template_args['success'] ) ? $this->_template_args['success'] : FALSE,
			'notices' => EE_Error::get_notices(),
			'content' => isset( $this->_template_args['admin_page_content'] ) ? $this->_template_args['admin_page_content'] : '',
			'data' => array_merge( $data, array('template_args' => $this->_template_args ) ),
			'isEEajax' => TRUE //special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
			);


		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
		if ( NULL === error_get_last() || ! headers_sent() )
			header('Content-Type: application/json; charset=UTF-8');
                if( function_exists( 'wp_json_encode' ) ) {
                    echo wp_json_encode( $json );
                } else {
                    echo json_encode( $json );
                }
		exit();
	}



	/**
	 * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
	 * @return json_obj|EE_Error
	 */
	public function return_json() {
		if ( defined('DOING_AJAX') && DOING_AJAX )
			$this->_return_json();

		else {
			throw new EE_Error( sprintf( __('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'), __FUNCTION__ ) );
		}
	}




	/**
	 * This provides a way for child hook classes to send along themselves by reference so methods/properties within them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
	 *
	 * @param EE_Admin_Hooks object $hook_obj This will be the object for the EE_Admin_Hooks child
	 *
	 * @access public
	 * @return void
	 */
	public function set_hook_object( EE_Admin_Hooks $hook_obj ) {
		$this->_hook_obj = $hook_obj;
	}





	/**
	*		generates  HTML wrapper with Tabbed nav for an admin page
	*		@access public
	*		@param  boolean $about whether to use the special about page wrapper or default.
	*		@return void
	*/
	public function admin_page_wrapper($about = FALSE) {

		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );

		$this->_nav_tabs = $this->_get_main_nav_tabs();

		$this->_template_args['nav_tabs'] = $this->_nav_tabs;
		$this->_template_args['admin_page_title'] = $this->_admin_page_title;

		$this->_template_args['before_admin_page_content'] = apply_filters( 'FHEE_before_admin_page_content' . $this->_current_page . $this->_current_view, isset( $this->_template_args['before_admin_page_content'] ) ? $this->_template_args['before_admin_page_content'] : '');
		$this->_template_args['after_admin_page_content'] = apply_filters( 'FHEE_after_admin_page_content' . $this->_current_page . $this->_current_view, isset( $this->_template_args['after_admin_page_content'] ) ? $this->_template_args['after_admin_page_content'] : '');

		$this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();



		// load settings page wrapper template
		$template_path = !defined( 'DOING_AJAX' ) ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php' : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';

		//about page?
		$template_path = $about ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php' : $template_path;


		if ( defined( 'DOING_AJAX' ) ) {
			$this->_template_args['admin_page_content'] = EEH_Template::display_template( $template_path, $this->_template_args, TRUE );

			$this->_return_json();
		} else {
			EEH_Template::display_template( $template_path, $this->_template_args );
		}

	}



	/**
	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
	 * @return string html
	 */
	protected function _get_main_nav_tabs() {
		//let's generate the html using the EEH_Tabbed_Content helper.  We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute (rather than setting in the page_routes array)
		EE_Registry::instance()->load_helper( 'Tabbed_Content' );
		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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








	/**
	*		sort nav tabs
	*		@access public
	*		@return void
	*/
	private function _sort_nav_tabs( $a, $b ) {
		if ($a['order'] == $b['order']) {
	        return 0;
	    }
	    return ($a['order'] < $b['order']) ? -1 : 1;
	}





	/**
	 * 	generates HTML for the forms used on admin pages
	 * 	@access protected
	 * 	@param	array $input_vars - array of input field details
	 * 	@param	array $id - used for defining unique identifiers for the form.
	 * 	@param string $generator (options are 'string' or 'array', basically use this to indicate which generator to use)
	 * 	@return string
	 * 	@uses EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
	 * 	@uses EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
	 */
	protected function _generate_admin_form_fields( $input_vars = array(), $generator = 'string', $id = FALSE ) {
		EE_Registry::instance()->load_helper( 'Form_Fields' );
		$content = $generator == 'string' ? EEH_Form_Fields::get_form_fields($input_vars, $id) : EEH_Form_Fields::get_form_fields_array($input_vars);
		return $content;
	}









	/**
	 * generates the "Save" and "Save & Close" buttons for edit forms
	 *
	 * @access protected
	 * @param bool $both if true then both buttons will be generated.  If false then just the "Save & Close" button.
	 * @param array $text if included, generator will use the given text for the buttons ( array([0] => 'Save', [1] => 'save & close')
	 * @param array $actions if included allows us to set the actions that each button will carry out (i.e. via the "name" value in the button).  We can also use this to just dump default actions by submitting some other value.
	 * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it will use the $referrer string. IF null, then we don't do ANYTHING on save and close (normal form handling).
	 */
	protected function _set_save_buttons($both = TRUE, $text = array(), $actions = array(), $referrer = NULL ) {
		//make sure $text and $actions are in an array
		$text = (array) $text;
		$actions = (array) $actions;
		$referrer_url = empty($referrer) ? '' : $referrer;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$referrer_url = !$referrer ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $_SERVER['REQUEST_URI'] .'" />' : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="' . $referrer .'" />';

		$button_text = !empty($text) ? $text : array( __('Save', 'event_espresso'), __('Save and Close', 'event_espresso') );
		$default_names = array( 'save', 'save_and_close' );

		//add in a hidden index for the current page (so save and close redirects properly)
		$this->_template_args['save_buttons'] = $referrer_url;

		foreach ( $button_text as $key => $button ) {
			$ref = $default_names[$key];
			$id = $this->_current_view . '_' . $ref;
			$name = !empty($actions) ? $actions[$key] : $ref;
			$this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary ' . $ref . '" value="' . $button . '" name="' . $name . '" id="' . $id . '" />';
			if ( !$both ) break;
		}

	}


	/**
	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
	 *
	 * @see $this->_set_add_edit_form_tags() for details on params
	 * @since 4.6.0
	 *
	 */
	public function set_add_edit_form_tags( $route = '', $additional_hidden_fields = array() ) {
		$this->_set_add_edit_form_tags( $route, $additional_hidden_fields );
	}



	/**
	 * set form open and close tags on add/edit pages.
	 *
	 * @access protected
	 * @param string $route the route you want the form to direct to
	 * @param array $additional_hidden_fields any additional hidden fields required in the form header
	 * @return void
	 */
	protected function _set_add_edit_form_tags( $route = '', $additional_hidden_fields = array() ) {

		if ( empty( $route )) {
			$user_msg = __('An error occurred. No action was set for this page\'s form.', 'event_espresso');
			$dev_msg = $user_msg . "\n" . sprintf( __('The $route argument is required for the %s->%s method.', 'event_espresso'), __FUNCTION__, __CLASS__ );
			EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
		}
		// open form
		$this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="' . $this->_admin_base_url . '" id="' . $route . '_event_form" >';
		// add nonce
		$nonce = wp_nonce_field( $route . '_nonce', $route . '_nonce', FALSE, FALSE );
//		$nonce = wp_nonce_field( $route . '_nonce', '_wpnonce', FALSE, FALSE );
		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
		// add REQUIRED form action
		$hidden_fields = array(
				'action' => array( 'type' => 'hidden', 'value' => $route ),
			);
		// merge arrays
		$hidden_fields = is_array( $additional_hidden_fields) ? array_merge( $hidden_fields, $additional_hidden_fields ) : $hidden_fields;
		// generate form fields
		$form_fields = $this->_generate_admin_form_fields( $hidden_fields, 'array' );
		// add fields to form
		foreach ( $form_fields as $field_name => $form_field ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
		}

		// close form
		$this->_template_args['after_admin_page_content'] = '</form>';

	}



	/**
	 * Public Wrapper for _redirect_after_action() method since its
	 * discovered it would be useful for external code to have access.
	 *
	 * @see EE_Admin_Page::_redirect_after_action() for params.
	 * @since 4.5.0
	 */
	public function redirect_after_action( $success = FALSE, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = FALSE ) {
		$this->_redirect_after_action( $success, $what, $action_desc, $query_args, $override_overwrite );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}



	/**
	 *    _redirect_after_action
	 *
	 * @param int $success - whether success was for two or more records, or just one, or none
	 *	@param string 	$what 		- what the action was performed on
	 *	@param string 	$action_desc 	- what was done ie: updated, deleted, etc
	 *	@param array 	$query_args		- an array of query_args to be added to the URL to redirect to after the admin action is completed
	 *	@param BOOL     $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to override this so that they show.
	 *	@access protected
	 *	@return void
	 */
	protected function _redirect_after_action( $success = 0, $what = 'item', $action_desc = 'processed', $query_args = array(), $override_overwrite = FALSE ) {

		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );

		//class name for actions/filters.
		$classname = get_class($this);

		//set redirect url. Note if there is a "page" index in the $query_args then we go with vanilla admin.php route, otherwise we go with whatever is set as the _admin_base_url
		$redirect_url = isset( $query_args['page'] ) ? admin_url('admin.php') : $this->_admin_base_url;
		$notices = EE_Error::get_notices( FALSE );

		// overwrite default success messages //BUT ONLY if overwrite not overridden
		if ( ! $override_overwrite || ! empty( $notices['errors'] )) {
			EE_Error::overwrite_success();
		}
		// how many records affected ? more than one record ? or just one ?
		if ( $success > 1 && empty( $notices['errors'] )) {
			// set plural msg
			EE_Error::add_success( sprintf( __('The "%s" have been successfully %s.', 'event_espresso'), $what, $action_desc ), __FILE__, __FUNCTION__, __LINE__);
		} else if ( $success == 1 && empty( $notices['errors'] )) {
			// set singular msg
			EE_Error::add_success( sprintf( __('The "%s" has been successfully %s.', 'event_espresso'), $what, $action_desc), __FILE__, __FUNCTION__, __LINE__ );
		}

		// check that $query_args isn't something crazy
		if ( ! is_array( $query_args )) {
			$query_args = array();
		}

		/**
		 * Allow injecting actions before the query_args are modified for possible different
		 * redirections on save and close actions
		 *
		 * @since 4.2.0
		 *
		 * @param array $query_args   The original query_args array coming into the
		 *                          		method.
		 */
		do_action( 'AHEE__' . $classname . '___redirect_after_action__before_redirect_modification_' . $this->_req_action, $query_args );

		//calculate where we're going (if we have a "save and close" button pushed)
		if ( isset($this->_req_data['save_and_close'] ) && isset($this->_req_data['save_and_close_referrer'] ) ) {
			// even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
			$parsed_url = parse_url( $this->_req_data['save_and_close_referrer'] );
			// regenerate query args array from refferer URL
			parse_str( $parsed_url['query'], $query_args );
			// correct page and action will be in the query args now
			$redirect_url = admin_url( 'admin.php' );
		}

		//merge any default query_args set in _default_route_query_args property
		if ( ! empty( $this->_default_route_query_args ) && ! $this->_is_UI_request ) {
			$args_to_merge = array();
			foreach ( $this->_default_route_query_args as $query_param => $query_value ) {
				//is there a wp_referer array in our _default_route_query_args property?
				if ( $query_param == 'wp_referer'  ) {
					$query_value = (array) $query_value;
					foreach ( $query_value as $reference => $value ) {
						if ( strpos( $reference, 'nonce' ) !== false ) {
							continue;
						}

						//finally we will override any arguments in the referer with
						//what might be set on the _default_route_query_args array.
						if ( isset( $this->_default_route_query_args[$reference] ) ) {
							$args_to_merge[$reference] = urlencode( $this->_default_route_query_args[$reference] );
						} else {
							$args_to_merge[$reference] = urlencode( $value );
						}
					}
					continue;
				}

				$args_to_merge[$query_param] = $query_value;
			}

			//now let's merge these arguments but override with what was specifically sent in to the
			//redirect.
			$query_args = array_merge( $args_to_merge, $query_args );
		}

		$this->_process_notices($query_args);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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


		// generate redirect url

		// if redirecting to anything other than the main page, add a nonce
		if ( isset( $query_args['action'] )) {
			// manually generate wp_nonce and merge that with the query vars becuz the wp_nonce_url function wrecks havoc on some vars
			$query_args['_wpnonce'] = wp_create_nonce( $query_args['action'] . '_nonce' );
		}

		//we're adding some hooks and filters in here for processing any things just before redirects (example: an admin page has done an insert or update and we want to run something after that).
		do_action( 'AHEE_redirect_' . $classname . $this->_req_action, $query_args );

		$redirect_url = apply_filters( 'FHEE_redirect_' . $classname . $this->_req_action, self::add_query_args_and_nonce( $query_args, $redirect_url ), $query_args );


		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
		if ( defined('DOING_AJAX' ) ) {
			$default_data = array(
				'close' => TRUE,
				'redirect_url' => $redirect_url,
				'where' => 'main',
				'what' => 'append',
				);

			$this->_template_args['success'] = $success;
			$this->_template_args['data'] = !empty($this->_template_args['data']) ? array_merge($default_data, $this->_template_args['data'] ): $default_data;
			$this->_return_json();
		}

		wp_safe_redirect( $redirect_url );
		exit();
	}




	/**
	 * process any notices before redirecting (or returning ajax request)
	 * This method sets the $this->_template_args['notices'] attribute;
	 *
	 * @param  array  $query_args any query args that need to be used for notice transient ('action')
	 * @param bool    $skip_route_verify This is typically used when we are processing notices REALLY early and page_routes haven't been defined yet.
	 * @param bool    $sticky_notices      This is used to flag that regardless of whether this is doing_ajax or not, we still save a transient for the notice.
	 * @return void
	 */
	protected function _process_notices( $query_args = array(), $skip_route_verify = FALSE , $sticky_notices = TRUE ) {

		$this->_template_args['notices'] = EE_Error::get_notices();

		//IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
		if ( ! defined( 'DOING_AJAX' ) || $sticky_notices ) {
			$route = isset( $query_args['action'] ) ? $query_args['action'] : 'default';
			$this->_add_transient( $route, $this->_template_args['notices'], TRUE, $skip_route_verify );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		}
	}




	/**
	 * get_action_link_or_button
	 * returns the button html for adding, editing, or deleting an item (depending on given type)
	 *
	 * @param string $action use this to indicate which action the url is generated with.
	 * @param string $type accepted strings must be defined in the $_labels['button'] array(as the key) property.
	 * @param array $extra_request if the button requires extra params you can include them in $key=>$value pairs.
	 * @param string $class Use this to give the class for the button. Defaults to 'button-primary'
	 * @param string $base_url If this is not provided the _admin_base_url will be used as the default for the button base_url.  Otherwise this value will be used.
	 * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
	 *
	 * @throws EE_Error
	 *
	 * @return string html for button
	 */
	public function get_action_link_or_button($action, $type = 'add', $extra_request = array(), $class = 'button-primary', $base_url = FALSE, $exclude_nonce = false ) {
		//first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
		if ( !isset($this->_page_routes[$action]) && !$base_url )
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			throw new EE_Error( sprintf( __('There is no page route for given action for the button.  This action was given: %s', 'event_espresso'), $action) );

		if ( !isset( $this->_labels['buttons'][$type] ) )
			throw new EE_Error( sprintf( __('There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.', 'event_espresso'), $type) );

		//finally check user access for this button.
		$has_access = $this->check_user_access( $action, TRUE );
		if ( ! $has_access ) {
			return '';
		}

		$_base_url = !$base_url ? $this->_admin_base_url : $base_url;

		$query_args = array(
			'action' => $action  );

		//merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
		if ( !empty($extra_request) )
			$query_args = array_merge( $extra_request, $query_args );

		$url = self::add_query_args_and_nonce( $query_args, $_base_url, false, $exclude_nonce );

		$button = EEH_Template::get_button_or_link( $url, $this->_labels['buttons'][$type], $class );

		return $button;
	}






	/**
	 * _per_page_screen_option
	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
	 * @return void
	 */
	protected function _per_page_screen_option() {
		$option = 'per_page';
		$args = array(
			'label' => $this->_admin_page_title,
			'default' => 10,
			'option' => $this->_current_page . '_' . $this->_current_view . '_per_page'
			);
		//ONLY add the screen option if the user has access to it.
		if ( $this->check_user_access( $this->_current_view, true ) ) {
			add_screen_option( $option, $args );
		}
	}




	/**
	 * set_per_page_screen_option
	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than admin_menu.
	 *
	 * @access private
	 * @return void
	 */
	private function _set_per_page_screen_options() {
		if ( isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options']) ) {
			check_admin_referer( 'screen-options-nonce', 'screenoptionnonce' );

			if ( !$user = wp_get_current_user() )
			return;
			$option = $_POST['wp_screen_options']['option'];
			$value = $_POST['wp_screen_options']['value'];

			if ( $option != sanitize_key( $option ) )
				return;

			$map_option = $option;

			$option = str_replace('-', '_', $option);

			switch ( $map_option ) {
				case $this->_current_page . '_' .  $this->_current_view . '_per_page':
					$value = (int) $value;
					if ( $value < 1 || $value > 999 )
						return;
					break;
				default:
					$value = apply_filters( 'FHEE__EE_Admin_Page___set_per_page_screen_options__value', false, $option, $value );
					if ( false === $value )
						return;
					break;
			}

			update_user_meta($user->ID, $option, $value);
			wp_safe_redirect( remove_query_arg( array('pagenum', 'apage', 'paged'), wp_get_referer() ) );
			exit;
		}
	}



	/**
	 * This just allows for setting the $_template_args property if it needs to be set outside the object
	 * @param array $data array that will be assigned to template args.
	 */
	public function set_template_args( $data ) {
		$this->_template_args = array_merge( $this->_template_args, (array) $data );
	}




	/**
	 * This makes available the WP transient system for temporarily moving data between routes
	 *
	 * @access protected
	 * @param route $route the route that should receive the transient
	 * @param data $data  the data that gets sent
	 * @param bool $notices If this is for notices then we use this to indicate so, otherwise its just a normal route transient.
	 * @param bool $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used when we are adding a transient before page_routes have been defined.
	 * @return void
	 */
	protected function _add_transient( $route, $data, $notices = FALSE, $skip_route_verify = FALSE ) {
		$user_id = get_current_user_id();

		if ( !$skip_route_verify )
			$this->_verify_route($route);


		//now let's set the string for what kind of transient we're setting
		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
		$data = $notices ? array( 'notices' => $data ) : $data;
		//is there already a transient for this route?  If there is then let's ADD to that transient
		$existing = is_multisite() && is_network_admin() ? get_site_transient( $transient ) : get_transient( $transient );
		if ( $existing ) {
			$data = array_merge( (array) $data, (array) $existing );
		}

		if ( is_multisite() && is_network_admin() ) {
			set_site_transient( $transient, $data, 8 );
		} else {
			set_transient( $transient, $data, 8 );
		}
	}




	/**
	 * this retrieves the temporary transient that has been set for moving data between routes.
	 * @param bool $notices true we get notices transient. False we just return normal route transient
	 * @return mixed data
	 */
	protected function _get_transient( $notices = FALSE, $route = FALSE ) {
		$user_id = get_current_user_id();
		$route = !$route ? $this->_req_action : $route;
		$transient = $notices ? 'ee_rte_n_tx_' . $route . '_' . $user_id : 'rte_tx_' . $route . '_' . $user_id;
		$data = is_multisite() && is_network_admin() ? get_site_transient( $transient ) : get_transient( $transient );
		//delete transient after retrieval (just in case it hasn't expired);
		if ( is_multisite() && is_network_admin() ) {
			delete_site_transient( $transient );
		} else {
			delete_transient( $transient );
		}
		return $notices && isset( $data['notices'] ) ? $data['notices'] : $data;
	}




	/**
	 * The purpose of this method is just to run garbage collection on any EE transients that might have expired but would not be called later.
	 *
	 * This will be assigned to run on a specific EE Admin page. (place the method in the default route callback on the EE_Admin page you want it run.)
	 * @return void
	 */
	protected function _transient_garbage_collection() {
		global $wpdb;

		//retrieve all existing transients
		$query = "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
		if ( $results = $wpdb->get_results( $query ) ) {
			foreach ( $results as $result ) {
				$transient = str_replace( '_transient_', '', $result->option_name );
				get_transient( $transient );
				if ( is_multisite() && is_network_admin() ) {
					get_site_transient( $transient );
				}
			}
		}
	}





	/**
	 * get_view
	 *
	 * @access public
	 * @return string content of _view property
	 */
	public function get_view() {
		return $this->_view;
	}




	/**
	 * getter for the protected $_views property
	 *
	 * @return array
	 */
	public function get_views() {
		return $this->_views;
	}




	/**
	 * get_current_page
	 *
	 * @access public
	 * @return string _current_page property value
	 */
	public function get_current_page() {
		return $this->_current_page;
	}




	/**
	 * get_current_view
	 *
	 * @access public
	 * @return string _current_view property value
	 */
	public function get_current_view() {
		return $this->_current_view;
	}



	/**
	 * get_current_screen
	 *
	 * @access public
	 * @return object The current WP_Screen object
	 */
	public function get_current_screen() {
		return $this->_current_screen;
	}


	/**
	 * get_current_page_view_url
	 *
	 * @access public
	 * @return string This returns the url for the current_page_view.
	 */
	public function get_current_page_view_url() {
		return $this->_current_page_view_url;
	}




	/**
	 * just returns the _req_data property
	 * @return array
	 */
	public function get_request_data() {
		return $this->_req_data;
	}



	/**
	 * returns the _req_data protected property
	 * @return string
	 */
	public function get_req_action() {
		return $this->_req_action;
	}


	/**
	 * @return bool  value of $_is_caf property
	 */
	public function is_caf() {
		return $this->_is_caf;
	}




	/**
	 * updates  espresso configuration settings
	 *
	 * @access 	protected
	 * @param string $tab
	 * @param array $data
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param string $file	file where error occurred
	 * @param string $func function  where error occurred
	 * @param string $line	line no where error occurred
	 * @return boolean
	 */
	protected function _update_espresso_configuration( $tab, $config, $file = '', $func = '', $line = '' ) {

		//remove any options that are NOT going to be saved with the config settings.
		if ( isset( $config->core->ee_ueip_optin ) ) {
			$config->core->ee_ueip_has_notified = TRUE;
			// TODO: remove the following two lines and make sure values are migrated from 3.1
			update_option( 'ee_ueip_optin', $config->core->ee_ueip_optin);
			update_option( 'ee_ueip_has_notified', TRUE );
		}
		// and save it (note we're also doing the network save here)
		$net_saved = is_main_site() ? EE_Network_Config::instance()->update_config( FALSE, FALSE ) : TRUE;
		$config_saved = EE_Config::instance()->update_espresso_config( FALSE, FALSE );
		if ( $config_saved && $net_saved ) {
			EE_Error::add_success( sprintf( __('"%s" have been successfully updated.', 'event_espresso'), $tab ));
			return TRUE;
		} else {
			EE_Error::add_error( sprintf( __('The "%s" were not updated.', 'event_espresso'), $tab ), $file, $func, $line  );
			return FALSE;
		}
	}





	/**
	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
	 * @return array
	 */
	public function get_yes_no_values(){
		return $this->_yes_no_values;
	}



	protected function _get_dir() {
		$reflector = new ReflectionClass(get_class($this));
		return dirname($reflector->getFileName());
	}




	/**
	 * A helper for getting a "next link".
	 *
	 * @param string $url   The url to link to
	 * @param string $class The class to use.
	 *
	 * @return string
	 */
	protected function _next_link( $url, $class = 'dashicons dashicons-arrow-right' ) {
		return '<a class="' . $class . '" href="' . $url . '"></a>';
	}




	/**
	 * A helper for getting a "previous link".
	 *
	 * @param string $url   The url to link to
	 * @param string $class The class to use.
	 *
	 * @return string
	 */
	protected function _previous_link( $url, $class = 'dashicons dashicons-arrow-left' ) {
		return '<a class="' . $class . '" href="' . $url . '"></a>';
	}







	//below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific




	/**
	 * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the _req_data array.
	 * @return bool success/fail
	 */
	protected function _process_resend_registration() {
		$this->_template_args['success'] = EED_Messages::process_resend( $this->_req_data );
		do_action( 'AHEE__EE_Admin_Page___process_resend_registration', $this->_template_args['success'], $this->_req_data );
		return $this->_template_args['success'];
	}



	/**
	 * This automatically processes any payment message notifications when manual payment has been applied.
	 *
	 * @access protected
	 * @param \EE_Payment $payment
	 * @return bool success/fail
	 */
	protected function _process_payment_notification( EE_Payment $payment ) {
		add_filter( 'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true' );
		$success = apply_filters( 'FHEE__EE_Admin_Page___process_admin_payment_notification__success', FALSE, $payment );
		$this->_template_args['success'] = $success;
		return $success;
	}


}
// end of file:  includes/core/admin/EE_Admin_Page.core.php

Branch — BUG-9622-fix-broken-cpt-crud (e3e588)

EE_Admin_Page::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

eventespresso / event-espresso-core

Branch — BUG-9622-fix-broken-cpt-crud (e3e588)

EE_Admin_Page::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
