eventespresso / event-espresso-core

core/admin/EE_Admin_Hooks.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -222,7 +222,7 @@
     /**
      * constructor
      *
-     * @param EE_Admin_Page $admin_page the calling admin_page_object
+     * @param EE_Admin_Page $adminpage the calling admin_page_object
      */
     public function __construct(EE_Admin_Page $adminpage)
     {

Indentation +726 added lines, -726 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -28,729 +28,729 @@ 
 {
 
 
-    /**
-     * we're just going to use this to hold the name of the caller class (child class name)
-     *
-     * @var string
-     */
-    public $caller;
-
-
-
-    /**
-     * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
-     * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
-     * used later to make sure we require the needed files.
-     *
-     * @var bool
-     */
-    protected $_extend;
-
-
-
-    /**
-     * child classes MUST set this property so that the page object can be loaded correctly
-     *
-     * @var string
-     */
-    protected $_name;
-
-
-
-    /**
-     * This is set by child classes and is an associative array of ajax hooks in the format:
-     * array(
-     *    'ajax_action_ref' => 'executing_method'; //must be public
-     * )
-     *
-     * @var array
-     */
-    protected $_ajax_func;
-
-
-    /**
-     * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
-     * array(
-     *    'page_route' => 'executing_method' //must be public
-     * )
-     *
-     * @var array
-     */
-    protected $_init_func;
-
-
-
-    /**
-     * This is an array of methods that output metabox content for the given page route.  Use the following format:
-     * array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route', //must correspond to a page route in the class being connected
-     *        with (i.e. "edit_event") If this is in an array then the same params below will be used but the metabox
-     *        will be added to each route.
-     *        'func' =>  'executing_method',  //must be public (i.e. public function executing_method($post,
-     *        $callback_args){} ).  Note if you include callback args in the array then you need to declare them in the
-     *        method arguments.
-     *        'id' => 'identifier_for_metabox', //so it can be removed by addons (optional, class will set it
-     *        automatically)
-     *        'priority' => 'default', //default 'default' (optional)
-     *        'label' => __('Localized Title', 'event_espresso'),
-     *        'context' => 'advanced' //advanced is default (optional),
-     *    'callback_args' => array() //any callback args to include (optional)
-     * )
-     * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
-     *
-     * @var array
-     */
-    protected $_metaboxes;
-
-
-
-    /**
-     * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
-     * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
-     * array: array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
-     *        that are in the class being connected with (i.e. 'edit', or 'create_new').
-     *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
-     *        'context' => 'normal', //the context for the metabox being removed (has to match)
-     *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
-     *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
-     *        id for the screen the metabox is on.
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_remove_metaboxes;
-
-
-
-    /**
-     * This parent class takes care of loading the scripts and styles if the child class has set the properties for
-     * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
-     * second array index is for indicating what routes each script/style loads on. array(
-     * 'registers' => array(
-     *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
-     *        argument to link scripts together.
-     *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
-     *            'url' => 'http://urltoscript.css.js',
-     *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
-     *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
-     *            gets loaded before the one you are setting here.
-     *            'footer' => TRUE //defaults to true (styles don't use this parameter)
-     *        ),
-     *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
-     *    the script gets enqueued on.
-     *        'script_ref' => array('route_one', 'route_two')
-     *    ),
-     *    'localize' => array( //this allows you to set a localize object.  Indicate which script the object is being
-     *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
-     *    the object.
-     *        'scrip_ref' => array(
-     *            'NAME_OF_JS_OBJECT' => array(
-     *                'translate_ref' => __('localized_string', 'event_espresso'),
-     *                'some_data' => 5
-     *            )
-     *        )
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_scripts_styles;
-
-
-    /**
-     * This is a property that will contain the current route.
-     *
-     * @var string;
-     */
-    protected $_current_route;
-
-
-
-    /**
-     * this optional property can be set by child classes to override the priority for the automatic action/filter hook
-     * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
-     *    'wp_hook_reference' => 1
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_wp_action_filters_priority;
-
-
-
-    /**
-     * This just holds a merged array of the $_POST and $_GET vars in favor of $_POST
-     *
-     * @var array
-     */
-    protected $_req_data;
-
-
-
-    /**
-     * This just holds an instance of the page object for this hook
-     *
-     * @var EE_Admin_Page
-     */
-    protected $_page_object;
-
-
-
-    /**
-     * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
-     *
-     * @var EE_Admin_Page|EE_Admin_Page_CPT
-     */
-    protected $_adminpage_obj;
-
-
-
-    /**
-     * Holds EE_Registry object
-     *
-     * @var EE_Registry
-     */
-    protected $EE = null;
-
-
-
-    /**
-     * constructor
-     *
-     * @param EE_Admin_Page $admin_page the calling admin_page_object
-     */
-    public function __construct(EE_Admin_Page $adminpage)
-    {
-
-        $this->_adminpage_obj = $adminpage;
-        $this->_req_data      = array_merge($_GET, $_POST);
-        $this->_set_defaults();
-        $this->_set_hooks_properties();
-        //first let's verify we're on the right page
-        if (! isset($this->_req_data['page'])
-            || (isset($this->_req_data['page'])
-                && $this->_adminpage_obj->page_slug
-                   != $this->_req_data['page'])) {
-            return;
-        } //get out nothing more to be done here.
-        //allow for extends to modify properties
-        if (method_exists($this, '_extend_properties')) {
-            $this->_extend_properties();
-        }
-        $this->_set_page_object();
-        $this->_init_hooks();
-        $this->_load_custom_methods();
-        $this->_load_routed_hooks();
-        add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        add_action('admin_enqueue_scripts', array($this, 'add_metaboxes'), 20);
-        add_action('admin_enqueue_scripts', array($this, 'remove_metaboxes'), 15);
-        $this->_ajax_hooks();
-    }
-
-
-
-    /**
-     * used by child classes to set the following properties:
-     * $_ajax_func (optional)
-     * $_init_func (optional)
-     * $_metaboxes (optional)
-     * $_scripts (optional)
-     * $_styles (optional)
-     * $_name (required)
-     * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
-     * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
-     * really early on page load (just after admin_init) if they want to have them registered for handling early.
-     *
-     * @access protected
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_hooks_properties();
-
-
-
-    /**
-     * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
-     * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
-     * registered the scripts and styles using wp_register_script and wp_register_style functions.
-     *
-     * @access public
-     * @return void
-     */
-    public function enqueue_scripts_styles()
-    {
-
-        if (! empty($this->_scripts_styles)) {
-            //first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
-                $msg[] = __(
-                    'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
-                    'event_espresso'
-                );
-                $msg[] = sprintf(
-                    __(
-                        'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
-                        'event_espresso'
-                    ),
-                    '<strong>' . $this->caller . '</strong>'
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            foreach ($this->_scripts_styles['registers'] as $ref => $details) {
-                $defaults = array(
-                    'type'    => 'js',
-                    'url'     => '',
-                    'depends' => array(),
-                    'version' => EVENT_ESPRESSO_VERSION,
-                    'footer'  => true,
-                );
-                $details  = wp_parse_args($details, $defaults);
-                extract($details);
-                //let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
-                $this->_scripts_styles['registers'][$ref]['type'] = $type;
-                //let's make sure we're not missing any REQUIRED parameters
-                if (empty($url)) {
-                    $msg[] = sprintf(
-                        __('Missing the url for the requested %s', 'event_espresso'),
-                        $type == 'js' ? 'script' : 'stylesheet'
-                    );
-                    $msg[] = sprintf(
-                        __(
-                            'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $this->caller . '</strong>',
-                        $ref
-                    );
-                    throw new EE_Error(implode('||', $msg));
-                }
-                //made it here so let's do the appropriate registration
-                $type == 'js'
-                    ? wp_register_script($ref, $url, $depends, $version, $footer)
-                    : wp_register_style(
-                    $ref,
-                    $url,
-                    $depends,
-                    $version
-                );
-            }
-            //k now lets do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
-                return;
-            }  //not sure if we should throw an error here or not.
-            foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
-                //make sure $routes is an array
-                $routes = (array)$routes;
-                if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][$ref]['type'] == 'js' ? wp_enqueue_script($ref)
-                        : wp_enqueue_style($ref);
-                    //if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][$ref])) {
-                        foreach ($this->_scripts_styles['localize'][$ref] as $object_name => $indexes) {
-                            wp_localize_script(
-                                $ref,
-                                $object_name,
-                                $this->_scripts_styles['localize'][$ref][$object_name]
-                            );
-                        }
-                    }
-                }
-            }
-            //let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
-                return;
-            }
-            foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
-                $defaults = array(
-                    'type' => 'js',
-                );
-                $details  = wp_parse_args($details, $defaults);
-                extract($details);
-                $type == 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
-            }
-        }
-    }
-
-
-
-    /**
-     * just set the defaults for the hooks properties.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        $this->_ajax_func     = $this->_init_func = $this->_metaboxes = $this->_scripts = $this->_styles = $this->_wp_action_filters_priority = array();
-        $this->_current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
-        $this->caller         = get_class($this);
-        $this->_extend        = stripos($this->caller, 'Extend') ? true : false;
-    }
-
-
-
-    /**
-     * this sets the _page_object property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_page_object()
-    {
-        //first make sure $this->_name is set
-        if (empty($this->_name)) {
-            $msg[] = __('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                __("This is because the %s child class has not set the '_name' property", 'event_espresso'),
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $ref = str_replace('_', ' ', $this->_name); //take the_message -> the message
-        $ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; //take the message -> The_Message
-        //first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . $this->_name . DS . $ref . '.core.php';
-        if (is_readable($decaf_file)) {
-            require_once($decaf_file);
-        }
-        //now we have to do require for extended file (if needed)
-        if ($this->_extend) {
-            require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . DS . 'Extend_' . $ref . '.core.php');
-        }
-        //if we've got an extended class we use that!
-        $ref = $this->_extend ? 'Extend_' . $ref : $ref;
-        //let's make sure the class exists
-        if (! class_exists($ref)) {
-            $msg[] = __('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                __(
-                    'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
-                    'event_espresso'
-                ),
-                $ref
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $a                  = new ReflectionClass($ref);
-        $this->_page_object = $a->newInstance(false);
-    }
-
-
-    /**
-     * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
-     * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
-     * $this->_req_data (all the _POST and _GET data) is available to your methods.
-     *
-     * @access private
-     * @return void
-     */
-    private function _load_custom_methods()
-    {
-        /**
-         * method cannot be named 'default' (@see http://us3.php
-         * .net/manual/en/reserved.keywords.php) so need to
-         * handle routes that are "default"
-         *
-         * @since 4.3.0
-         */
-        $method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
-        //these run before the Admin_Page route executes.
-        if (method_exists($this, $method_callback)) {
-            call_user_func(array($this, $method_callback));
-        }
-        //these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
-        //first the actions
-        //note that these action hooks will have the $query_args value available.
-        $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
-            add_action(
-                'AHEE__'
-                . $admin_class_name
-                . '___redirect_after_action__before_redirect_modification_'
-                . $this->_current_route,
-                array($this, '_redirect_action_early_' . $this->_current_route),
-                10
-            );
-        }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
-            add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_action_' . $this->_current_route),
-                10
-            );
-        }
-        //let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
-            add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_filter_' . $this->_current_route),
-                10,
-                2
-            );
-        }
-    }
-
-
-
-    /**
-     * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
-     * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
-     * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
-     *
-     * @return void
-     */
-    private function _load_routed_hooks()
-    {
-
-        //this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
-        $hook_filter_array = array(
-            'admin_footer'                                                                            => array(
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views'                                                                   => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => array(
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-        );
-        foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[$hook])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[$hook];
-                }
-                if ($args['type'] == 'action') {
-                    add_action(
-                        $hook,
-                        array($this, $this->_current_route . '_' . $hook),
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                } else {
-                    add_filter(
-                        $hook,
-                        array($this, $this->_current_route . '_' . $hook),
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop throught the $_ajax_func array and add_actions for the array.
-     *
-     * @return void
-     */
-    private function _ajax_hooks()
-    {
-
-        if (empty($this->_ajax_func)) {
-            return;
-        } //get out there's nothing to take care of.
-        foreach ($this->_ajax_func as $action => $method) {
-            //make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = __(
-                             'There is no corresponding method for the hook labeled in the _ajax_func array',
-                             'event_espresso'
-                         ) . '<br />';
-                $msg[] = sprintf(
-                    __(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            add_action('wp_ajax_' . $action, array($this, $method));
-        }
-    }
-
-
-
-    /**
-     * Loop throught the $_init_func array and add_actions for the array.
-     *
-     * @return void
-     */
-    protected function _init_hooks()
-    {
-        if (empty($this->_init_func)) {
-            return;
-        } //get out there's nothing to take care of.
-        //We need to determine what page_route we are on!
-        $current_route = isset ($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
-        foreach ($this->_init_func as $route => $method) {
-            //make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = __(
-                             'There is no corresponding method for the hook labeled in the _init_func array',
-                             'event_espresso'
-                         ) . '<br />';
-                $msg[] = sprintf(
-                    __(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            if ($route == $this->_current_route) {
-                add_action('admin_init', array($this, $method));
-            }
-        }
-    }
-
-
-
-    /**
-     * Loop through the _metaboxes property and add_metaboxes accordingly
-     * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
-     *
-     * @access public
-     * @return void
-     */
-    public function add_metaboxes()
-    {
-        if (empty($this->_metaboxes)) {
-            return;
-        } //get out we don't have any metaboxes to set for this connection
-        $this->_handle_metabox_array($this->_metaboxes);
-    }
-
-
-
-    private function _handle_metabox_array($boxes, $add = true)
-    {
-
-        foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
-                continue;
-            } //we dont' have a valid array
-            //let's make sure $box['page_route'] is an array so the "foreach" will work.
-            $box['page_route'] = (array)$box['page_route'];
-            foreach ($box['page_route'] as $route) {
-                if ($route != $this->_current_route) {
-                    continue;
-                } //get out we only add metaboxes for set route.
-                if ($add) {
-                    $this->_add_metabox($box);
-                } else {
-                    $this->_remove_metabox($box);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
-     *
-     * @access public
-     * @return void
-     */
-    public function remove_metaboxes()
-    {
-
-        if (empty($this->_remove_metaboxes)) {
-            return;
-        } //get out there are no metaboxes to remove
-        $this->_handle_metabox_array($this->_remove_metaboxes, false);
-    }
-
-
-    /**
-     * This just handles adding a metabox
-     *
-     * @access private
-     * @param array $args an array of args that have been set for this metabox by the child class
-     */
-    private function _add_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id      = is_object($current_screen) ? $current_screen->id : null;
-        $func           = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
-        //set defaults
-        $defaults = array(
-            'func'          => $func,
-            'id'            => $this->caller . '_' . $func . '_metabox',
-            'priority'      => 'default',
-            'label'         => $this->caller,
-            'context'       => 'advanced',
-            'callback_args' => array(),
-            'page'          => isset($args['page']) ? $args['page'] : $screen_id,
-        );
-        $args = wp_parse_args($args, $defaults);
-        extract($args);
-        //make sure method exists
-        if (! method_exists($this, $func)) {
-            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
-            $msg[] = sprintf(
-                __(
-                    'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                    'event_espresso'
-                ),
-                $func,
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        //everything checks out so lets add the metabox
-        add_meta_box($id, $label, array($this, $func), $page, $context, $priority, $callback_args);
-    }
-
-
-
-    private function _remove_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id      = is_object($current_screen) ? $current_screen->id : null;
-        $func           = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
-        //set defaults
-        $defaults = array(
-            'id'      => isset($args['id'])
-                ? $args['id']
-                : $this->_current_route
-                  . '_'
-                  . $this->caller
-                  . '_'
-                  . $func
-                  . '_metabox',
-            'context' => 'default',
-            'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id
-        );
-        $args = wp_parse_args($args, $defaults);
-        extract($args);
-        //everything checks out so lets remove the box!
-        remove_meta_box($id, $screen, $context);
-    }
+	/**
+	 * we're just going to use this to hold the name of the caller class (child class name)
+	 *
+	 * @var string
+	 */
+	public $caller;
+
+
+
+	/**
+	 * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
+	 * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
+	 * used later to make sure we require the needed files.
+	 *
+	 * @var bool
+	 */
+	protected $_extend;
+
+
+
+	/**
+	 * child classes MUST set this property so that the page object can be loaded correctly
+	 *
+	 * @var string
+	 */
+	protected $_name;
+
+
+
+	/**
+	 * This is set by child classes and is an associative array of ajax hooks in the format:
+	 * array(
+	 *    'ajax_action_ref' => 'executing_method'; //must be public
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_ajax_func;
+
+
+	/**
+	 * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
+	 * array(
+	 *    'page_route' => 'executing_method' //must be public
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_init_func;
+
+
+
+	/**
+	 * This is an array of methods that output metabox content for the given page route.  Use the following format:
+	 * array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route', //must correspond to a page route in the class being connected
+	 *        with (i.e. "edit_event") If this is in an array then the same params below will be used but the metabox
+	 *        will be added to each route.
+	 *        'func' =>  'executing_method',  //must be public (i.e. public function executing_method($post,
+	 *        $callback_args){} ).  Note if you include callback args in the array then you need to declare them in the
+	 *        method arguments.
+	 *        'id' => 'identifier_for_metabox', //so it can be removed by addons (optional, class will set it
+	 *        automatically)
+	 *        'priority' => 'default', //default 'default' (optional)
+	 *        'label' => __('Localized Title', 'event_espresso'),
+	 *        'context' => 'advanced' //advanced is default (optional),
+	 *    'callback_args' => array() //any callback args to include (optional)
+	 * )
+	 * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
+	 *
+	 * @var array
+	 */
+	protected $_metaboxes;
+
+
+
+	/**
+	 * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
+	 * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
+	 * array: array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
+	 *        that are in the class being connected with (i.e. 'edit', or 'create_new').
+	 *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
+	 *        'context' => 'normal', //the context for the metabox being removed (has to match)
+	 *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
+	 *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
+	 *        id for the screen the metabox is on.
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_remove_metaboxes;
+
+
+
+	/**
+	 * This parent class takes care of loading the scripts and styles if the child class has set the properties for
+	 * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
+	 * second array index is for indicating what routes each script/style loads on. array(
+	 * 'registers' => array(
+	 *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
+	 *        argument to link scripts together.
+	 *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
+	 *            'url' => 'http://urltoscript.css.js',
+	 *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
+	 *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
+	 *            gets loaded before the one you are setting here.
+	 *            'footer' => TRUE //defaults to true (styles don't use this parameter)
+	 *        ),
+	 *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
+	 *    the script gets enqueued on.
+	 *        'script_ref' => array('route_one', 'route_two')
+	 *    ),
+	 *    'localize' => array( //this allows you to set a localize object.  Indicate which script the object is being
+	 *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
+	 *    the object.
+	 *        'scrip_ref' => array(
+	 *            'NAME_OF_JS_OBJECT' => array(
+	 *                'translate_ref' => __('localized_string', 'event_espresso'),
+	 *                'some_data' => 5
+	 *            )
+	 *        )
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_scripts_styles;
+
+
+	/**
+	 * This is a property that will contain the current route.
+	 *
+	 * @var string;
+	 */
+	protected $_current_route;
+
+
+
+	/**
+	 * this optional property can be set by child classes to override the priority for the automatic action/filter hook
+	 * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
+	 *    'wp_hook_reference' => 1
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_wp_action_filters_priority;
+
+
+
+	/**
+	 * This just holds a merged array of the $_POST and $_GET vars in favor of $_POST
+	 *
+	 * @var array
+	 */
+	protected $_req_data;
+
+
+
+	/**
+	 * This just holds an instance of the page object for this hook
+	 *
+	 * @var EE_Admin_Page
+	 */
+	protected $_page_object;
+
+
+
+	/**
+	 * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
+	 *
+	 * @var EE_Admin_Page|EE_Admin_Page_CPT
+	 */
+	protected $_adminpage_obj;
+
+
+
+	/**
+	 * Holds EE_Registry object
+	 *
+	 * @var EE_Registry
+	 */
+	protected $EE = null;
+
+
+
+	/**
+	 * constructor
+	 *
+	 * @param EE_Admin_Page $admin_page the calling admin_page_object
+	 */
+	public function __construct(EE_Admin_Page $adminpage)
+	{
+
+		$this->_adminpage_obj = $adminpage;
+		$this->_req_data      = array_merge($_GET, $_POST);
+		$this->_set_defaults();
+		$this->_set_hooks_properties();
+		//first let's verify we're on the right page
+		if (! isset($this->_req_data['page'])
+			|| (isset($this->_req_data['page'])
+				&& $this->_adminpage_obj->page_slug
+				   != $this->_req_data['page'])) {
+			return;
+		} //get out nothing more to be done here.
+		//allow for extends to modify properties
+		if (method_exists($this, '_extend_properties')) {
+			$this->_extend_properties();
+		}
+		$this->_set_page_object();
+		$this->_init_hooks();
+		$this->_load_custom_methods();
+		$this->_load_routed_hooks();
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		add_action('admin_enqueue_scripts', array($this, 'add_metaboxes'), 20);
+		add_action('admin_enqueue_scripts', array($this, 'remove_metaboxes'), 15);
+		$this->_ajax_hooks();
+	}
+
+
+
+	/**
+	 * used by child classes to set the following properties:
+	 * $_ajax_func (optional)
+	 * $_init_func (optional)
+	 * $_metaboxes (optional)
+	 * $_scripts (optional)
+	 * $_styles (optional)
+	 * $_name (required)
+	 * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
+	 * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
+	 * really early on page load (just after admin_init) if they want to have them registered for handling early.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_hooks_properties();
+
+
+
+	/**
+	 * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
+	 * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
+	 * registered the scripts and styles using wp_register_script and wp_register_style functions.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function enqueue_scripts_styles()
+	{
+
+		if (! empty($this->_scripts_styles)) {
+			//first let's do all the registrations
+			if (! isset($this->_scripts_styles['registers'])) {
+				$msg[] = __(
+					'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
+					'event_espresso'
+				);
+				$msg[] = sprintf(
+					__(
+						'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
+						'event_espresso'
+					),
+					'<strong>' . $this->caller . '</strong>'
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			foreach ($this->_scripts_styles['registers'] as $ref => $details) {
+				$defaults = array(
+					'type'    => 'js',
+					'url'     => '',
+					'depends' => array(),
+					'version' => EVENT_ESPRESSO_VERSION,
+					'footer'  => true,
+				);
+				$details  = wp_parse_args($details, $defaults);
+				extract($details);
+				//let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
+				$this->_scripts_styles['registers'][$ref]['type'] = $type;
+				//let's make sure we're not missing any REQUIRED parameters
+				if (empty($url)) {
+					$msg[] = sprintf(
+						__('Missing the url for the requested %s', 'event_espresso'),
+						$type == 'js' ? 'script' : 'stylesheet'
+					);
+					$msg[] = sprintf(
+						__(
+							'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
+							'event_espresso'
+						),
+						'<strong>' . $this->caller . '</strong>',
+						$ref
+					);
+					throw new EE_Error(implode('||', $msg));
+				}
+				//made it here so let's do the appropriate registration
+				$type == 'js'
+					? wp_register_script($ref, $url, $depends, $version, $footer)
+					: wp_register_style(
+					$ref,
+					$url,
+					$depends,
+					$version
+				);
+			}
+			//k now lets do the enqueues
+			if (! isset($this->_scripts_styles['enqueues'])) {
+				return;
+			}  //not sure if we should throw an error here or not.
+			foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
+				//make sure $routes is an array
+				$routes = (array)$routes;
+				if (in_array($this->_current_route, $routes)) {
+					$this->_scripts_styles['registers'][$ref]['type'] == 'js' ? wp_enqueue_script($ref)
+						: wp_enqueue_style($ref);
+					//if we have a localization for the script let's do that too.
+					if (isset($this->_scripts_styles['localize'][$ref])) {
+						foreach ($this->_scripts_styles['localize'][$ref] as $object_name => $indexes) {
+							wp_localize_script(
+								$ref,
+								$object_name,
+								$this->_scripts_styles['localize'][$ref][$object_name]
+							);
+						}
+					}
+				}
+			}
+			//let's do the deregisters
+			if (! isset($this->_scripts_styles['deregisters'])) {
+				return;
+			}
+			foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
+				$defaults = array(
+					'type' => 'js',
+				);
+				$details  = wp_parse_args($details, $defaults);
+				extract($details);
+				$type == 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
+			}
+		}
+	}
+
+
+
+	/**
+	 * just set the defaults for the hooks properties.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		$this->_ajax_func     = $this->_init_func = $this->_metaboxes = $this->_scripts = $this->_styles = $this->_wp_action_filters_priority = array();
+		$this->_current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
+		$this->caller         = get_class($this);
+		$this->_extend        = stripos($this->caller, 'Extend') ? true : false;
+	}
+
+
+
+	/**
+	 * this sets the _page_object property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_page_object()
+	{
+		//first make sure $this->_name is set
+		if (empty($this->_name)) {
+			$msg[] = __('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				__("This is because the %s child class has not set the '_name' property", 'event_espresso'),
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		$ref = str_replace('_', ' ', $this->_name); //take the_message -> the message
+		$ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; //take the message -> The_Message
+		//first default file (if exists)
+		$decaf_file = EE_ADMIN_PAGES . $this->_name . DS . $ref . '.core.php';
+		if (is_readable($decaf_file)) {
+			require_once($decaf_file);
+		}
+		//now we have to do require for extended file (if needed)
+		if ($this->_extend) {
+			require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . DS . 'Extend_' . $ref . '.core.php');
+		}
+		//if we've got an extended class we use that!
+		$ref = $this->_extend ? 'Extend_' . $ref : $ref;
+		//let's make sure the class exists
+		if (! class_exists($ref)) {
+			$msg[] = __('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				__(
+					'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
+					'event_espresso'
+				),
+				$ref
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		$a                  = new ReflectionClass($ref);
+		$this->_page_object = $a->newInstance(false);
+	}
+
+
+	/**
+	 * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
+	 * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
+	 * $this->_req_data (all the _POST and _GET data) is available to your methods.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _load_custom_methods()
+	{
+		/**
+		 * method cannot be named 'default' (@see http://us3.php
+		 * .net/manual/en/reserved.keywords.php) so need to
+		 * handle routes that are "default"
+		 *
+		 * @since 4.3.0
+		 */
+		$method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
+		//these run before the Admin_Page route executes.
+		if (method_exists($this, $method_callback)) {
+			call_user_func(array($this, $method_callback));
+		}
+		//these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
+		//first the actions
+		//note that these action hooks will have the $query_args value available.
+		$admin_class_name = get_class($this->_adminpage_obj);
+		if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+			add_action(
+				'AHEE__'
+				. $admin_class_name
+				. '___redirect_after_action__before_redirect_modification_'
+				. $this->_current_route,
+				array($this, '_redirect_action_early_' . $this->_current_route),
+				10
+			);
+		}
+		if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+			add_action(
+				'AHEE_redirect_' . $admin_class_name . $this->_current_route,
+				array($this, '_redirect_action_' . $this->_current_route),
+				10
+			);
+		}
+		//let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
+		if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+			add_filter(
+				'FHEE_redirect_' . $admin_class_name . $this->_current_route,
+				array($this, '_redirect_filter_' . $this->_current_route),
+				10,
+				2
+			);
+		}
+	}
+
+
+
+	/**
+	 * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
+	 * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
+	 * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
+	 *
+	 * @return void
+	 */
+	private function _load_routed_hooks()
+	{
+
+		//this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
+		$hook_filter_array = array(
+			'admin_footer'                                                                            => array(
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views'                                                                   => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => array(
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+		);
+		foreach ($hook_filter_array as $hook => $args) {
+			if (method_exists($this, $this->_current_route . '_' . $hook)) {
+				if (isset($this->_wp_action_filters_priority[$hook])) {
+					$args['priority'] = $this->_wp_action_filters_priority[$hook];
+				}
+				if ($args['type'] == 'action') {
+					add_action(
+						$hook,
+						array($this, $this->_current_route . '_' . $hook),
+						$args['priority'],
+						$args['argnum']
+					);
+				} else {
+					add_filter(
+						$hook,
+						array($this, $this->_current_route . '_' . $hook),
+						$args['priority'],
+						$args['argnum']
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop throught the $_ajax_func array and add_actions for the array.
+	 *
+	 * @return void
+	 */
+	private function _ajax_hooks()
+	{
+
+		if (empty($this->_ajax_func)) {
+			return;
+		} //get out there's nothing to take care of.
+		foreach ($this->_ajax_func as $action => $method) {
+			//make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = __(
+							 'There is no corresponding method for the hook labeled in the _ajax_func array',
+							 'event_espresso'
+						 ) . '<br />';
+				$msg[] = sprintf(
+					__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			add_action('wp_ajax_' . $action, array($this, $method));
+		}
+	}
+
+
+
+	/**
+	 * Loop throught the $_init_func array and add_actions for the array.
+	 *
+	 * @return void
+	 */
+	protected function _init_hooks()
+	{
+		if (empty($this->_init_func)) {
+			return;
+		} //get out there's nothing to take care of.
+		//We need to determine what page_route we are on!
+		$current_route = isset ($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
+		foreach ($this->_init_func as $route => $method) {
+			//make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = __(
+							 'There is no corresponding method for the hook labeled in the _init_func array',
+							 'event_espresso'
+						 ) . '<br />';
+				$msg[] = sprintf(
+					__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			if ($route == $this->_current_route) {
+				add_action('admin_init', array($this, $method));
+			}
+		}
+	}
+
+
+
+	/**
+	 * Loop through the _metaboxes property and add_metaboxes accordingly
+	 * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function add_metaboxes()
+	{
+		if (empty($this->_metaboxes)) {
+			return;
+		} //get out we don't have any metaboxes to set for this connection
+		$this->_handle_metabox_array($this->_metaboxes);
+	}
+
+
+
+	private function _handle_metabox_array($boxes, $add = true)
+	{
+
+		foreach ($boxes as $box) {
+			if (! isset($box['page_route'])) {
+				continue;
+			} //we dont' have a valid array
+			//let's make sure $box['page_route'] is an array so the "foreach" will work.
+			$box['page_route'] = (array)$box['page_route'];
+			foreach ($box['page_route'] as $route) {
+				if ($route != $this->_current_route) {
+					continue;
+				} //get out we only add metaboxes for set route.
+				if ($add) {
+					$this->_add_metabox($box);
+				} else {
+					$this->_remove_metabox($box);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function remove_metaboxes()
+	{
+
+		if (empty($this->_remove_metaboxes)) {
+			return;
+		} //get out there are no metaboxes to remove
+		$this->_handle_metabox_array($this->_remove_metaboxes, false);
+	}
+
+
+	/**
+	 * This just handles adding a metabox
+	 *
+	 * @access private
+	 * @param array $args an array of args that have been set for this metabox by the child class
+	 */
+	private function _add_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id      = is_object($current_screen) ? $current_screen->id : null;
+		$func           = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
+		//set defaults
+		$defaults = array(
+			'func'          => $func,
+			'id'            => $this->caller . '_' . $func . '_metabox',
+			'priority'      => 'default',
+			'label'         => $this->caller,
+			'context'       => 'advanced',
+			'callback_args' => array(),
+			'page'          => isset($args['page']) ? $args['page'] : $screen_id,
+		);
+		$args = wp_parse_args($args, $defaults);
+		extract($args);
+		//make sure method exists
+		if (! method_exists($this, $func)) {
+			$msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
+			$msg[] = sprintf(
+				__(
+					'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+					'event_espresso'
+				),
+				$func,
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		//everything checks out so lets add the metabox
+		add_meta_box($id, $label, array($this, $func), $page, $context, $priority, $callback_args);
+	}
+
+
+
+	private function _remove_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id      = is_object($current_screen) ? $current_screen->id : null;
+		$func           = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
+		//set defaults
+		$defaults = array(
+			'id'      => isset($args['id'])
+				? $args['id']
+				: $this->_current_route
+				  . '_'
+				  . $this->caller
+				  . '_'
+				  . $func
+				  . '_metabox',
+			'context' => 'default',
+			'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id
+		);
+		$args = wp_parse_args($args, $defaults);
+		extract($args);
+		//everything checks out so lets remove the box!
+		remove_meta_box($id, $screen, $context);
+	}
 }

Spacing +38 added lines, -38 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -232,7 +232,7 @@ 
         $this->_set_defaults();
         $this->_set_hooks_properties();
         //first let's verify we're on the right page
-        if (! isset($this->_req_data['page'])
+        if ( ! isset($this->_req_data['page'])
             || (isset($this->_req_data['page'])
                 && $this->_adminpage_obj->page_slug
                    != $this->_req_data['page'])) {
@@ -285,9 +285,9 @@ 
     public function enqueue_scripts_styles()
     {
 
-        if (! empty($this->_scripts_styles)) {
+        if ( ! empty($this->_scripts_styles)) {
             //first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
+            if ( ! isset($this->_scripts_styles['registers'])) {
                 $msg[] = __(
                     'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
                     'event_espresso'
@@ -297,7 +297,7 @@ 
                         'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
                         'event_espresso'
                     ),
-                    '<strong>' . $this->caller . '</strong>'
+                    '<strong>'.$this->caller.'</strong>'
                 );
                 throw new EE_Error(implode('||', $msg));
             }
@@ -309,7 +309,7 @@ 
                     'version' => EVENT_ESPRESSO_VERSION,
                     'footer'  => true,
                 );
-                $details  = wp_parse_args($details, $defaults);
+                $details = wp_parse_args($details, $defaults);
                 extract($details);
                 //let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
                 $this->_scripts_styles['registers'][$ref]['type'] = $type;
@@ -324,7 +324,7 @@ 
                             'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
                             'event_espresso'
                         ),
-                        '<strong>' . $this->caller . '</strong>',
+                        '<strong>'.$this->caller.'</strong>',
                         $ref
                     );
                     throw new EE_Error(implode('||', $msg));
@@ -340,12 +340,12 @@ 
                 );
             }
             //k now lets do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
+            if ( ! isset($this->_scripts_styles['enqueues'])) {
                 return;
             }  //not sure if we should throw an error here or not.
             foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
                 //make sure $routes is an array
-                $routes = (array)$routes;
+                $routes = (array) $routes;
                 if (in_array($this->_current_route, $routes)) {
                     $this->_scripts_styles['registers'][$ref]['type'] == 'js' ? wp_enqueue_script($ref)
                         : wp_enqueue_style($ref);
@@ -362,7 +362,7 @@ 
                 }
             }
             //let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
+            if ( ! isset($this->_scripts_styles['deregisters'])) {
                 return;
             }
             foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
@@ -412,20 +412,20 @@ 
             throw new EE_Error(implode('||', $msg));
         }
         $ref = str_replace('_', ' ', $this->_name); //take the_message -> the message
-        $ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; //take the message -> The_Message
+        $ref = str_replace(' ', '_', ucwords($ref)).'_Admin_Page'; //take the message -> The_Message
         //first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . $this->_name . DS . $ref . '.core.php';
+        $decaf_file = EE_ADMIN_PAGES.$this->_name.DS.$ref.'.core.php';
         if (is_readable($decaf_file)) {
             require_once($decaf_file);
         }
         //now we have to do require for extended file (if needed)
         if ($this->_extend) {
-            require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . DS . 'Extend_' . $ref . '.core.php');
+            require_once(EE_CORE_CAF_ADMIN_EXTEND.$this->_name.DS.'Extend_'.$ref.'.core.php');
         }
         //if we've got an extended class we use that!
-        $ref = $this->_extend ? 'Extend_' . $ref : $ref;
+        $ref = $this->_extend ? 'Extend_'.$ref : $ref;
         //let's make sure the class exists
-        if (! class_exists($ref)) {
+        if ( ! class_exists($ref)) {
             $msg[] = __('We can\'t load the page object', 'event_espresso');
             $msg[] = sprintf(
                 __(
@@ -467,28 +467,28 @@ 
         //first the actions
         //note that these action hooks will have the $query_args value available.
         $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_early_'.$this->_current_route)) {
             add_action(
                 'AHEE__'
                 . $admin_class_name
                 . '___redirect_after_action__before_redirect_modification_'
                 . $this->_current_route,
-                array($this, '_redirect_action_early_' . $this->_current_route),
+                array($this, '_redirect_action_early_'.$this->_current_route),
                 10
             );
         }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_'.$this->_current_route)) {
             add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_action_' . $this->_current_route),
+                'AHEE_redirect_'.$admin_class_name.$this->_current_route,
+                array($this, '_redirect_action_'.$this->_current_route),
                 10
             );
         }
         //let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_filter_'.$this->_current_route)) {
             add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_filter_' . $this->_current_route),
+                'FHEE_redirect_'.$admin_class_name.$this->_current_route,
+                array($this, '_redirect_filter_'.$this->_current_route),
                 10,
                 2
             );
@@ -514,12 +514,12 @@ 
                 'argnum'   => 1,
                 'priority' => 10,
             ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug.'_'.$this->_current_route => array(
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
             ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug                               => array(
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
@@ -536,21 +536,21 @@ 
             ),
         );
         foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
+            if (method_exists($this, $this->_current_route.'_'.$hook)) {
                 if (isset($this->_wp_action_filters_priority[$hook])) {
                     $args['priority'] = $this->_wp_action_filters_priority[$hook];
                 }
                 if ($args['type'] == 'action') {
                     add_action(
                         $hook,
-                        array($this, $this->_current_route . '_' . $hook),
+                        array($this, $this->_current_route.'_'.$hook),
                         $args['priority'],
                         $args['argnum']
                     );
                 } else {
                     add_filter(
                         $hook,
-                        array($this, $this->_current_route . '_' . $hook),
+                        array($this, $this->_current_route.'_'.$hook),
                         $args['priority'],
                         $args['argnum']
                     );
@@ -573,11 +573,11 @@ 
         } //get out there's nothing to take care of.
         foreach ($this->_ajax_func as $action => $method) {
             //make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = __(
                              'There is no corresponding method for the hook labeled in the _ajax_func array',
                              'event_espresso'
-                         ) . '<br />';
+                         ).'<br />';
                 $msg[] = sprintf(
                     __(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -588,7 +588,7 @@ 
                 );
                 throw new EE_Error(implode('||', $msg));
             }
-            add_action('wp_ajax_' . $action, array($this, $method));
+            add_action('wp_ajax_'.$action, array($this, $method));
         }
     }
 
@@ -608,11 +608,11 @@ 
         $current_route = isset ($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
         foreach ($this->_init_func as $route => $method) {
             //make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = __(
                              'There is no corresponding method for the hook labeled in the _init_func array',
                              'event_espresso'
-                         ) . '<br />';
+                         ).'<br />';
                 $msg[] = sprintf(
                     __(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -652,11 +652,11 @@ 
     {
 
         foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
+            if ( ! isset($box['page_route'])) {
                 continue;
             } //we dont' have a valid array
             //let's make sure $box['page_route'] is an array so the "foreach" will work.
-            $box['page_route'] = (array)$box['page_route'];
+            $box['page_route'] = (array) $box['page_route'];
             foreach ($box['page_route'] as $route) {
                 if ($route != $this->_current_route) {
                     continue;
@@ -702,7 +702,7 @@ 
         //set defaults
         $defaults = array(
             'func'          => $func,
-            'id'            => $this->caller . '_' . $func . '_metabox',
+            'id'            => $this->caller.'_'.$func.'_metabox',
             'priority'      => 'default',
             'label'         => $this->caller,
             'context'       => 'advanced',
@@ -712,8 +712,8 @@ 
         $args = wp_parse_args($args, $defaults);
         extract($args);
         //make sure method exists
-        if (! method_exists($this, $func)) {
-            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
+        if ( ! method_exists($this, $func)) {
+            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso').'<br />';
             $msg[] = sprintf(
                 __(
                     'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',

core/admin/EE_Admin_Page_Init.core.php

Doc Comments +3 added lines, -1 removed lines

@@ -205,7 +205,6 @@ 
      *
      * @access  public
      * @uses    _initialize_admin_page()
-     * @param  string $dir_name directory name for specific admin_page being loaded.
      * @return void
      */
     public function initialize_admin_page()
@@ -221,6 +220,9 @@ 
 
 
 
+    /**
+     * @param string $wp_page_slug
+     */
     public function set_page_dependencies($wp_page_slug)
     {
         if (! $this->_load_page) {

Indentation +438 added lines, -438 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -28,443 +28,443 @@ 
 abstract class EE_Admin_Page_Init extends EE_Base
 {
 
-    //identity properties (set in _set_defaults and _set_init_properties)
-    public $label;
-
-    /**
-     * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
-     * and accessing pages.  If capability is NOT set, then it defaults to the menu_map capability.
-     *
-     * @var string
-     */
-    public $capability;
-
-
-    /**
-     * This holds the menu map object for this admin page.
-     *
-     * @var EE_Admin_Page_Menu_Map
-     */
-    protected $_menu_map;
-
-    /**
-     * deprecated
-     */
-    public $menu_label;
-    public $menu_slug;
-
-
-
-    //set in _set_defaults
-    protected $_folder_name;
-    protected $_folder_path;
-    protected $_file_name;
-    public    $hook_file;
-    protected $_wp_page_slug;
-    protected $_routing;
-
-
-    //will hold page object.
-    protected $_loaded_page_object;
-
-
-    //for caf
-    protected $_files_hooked;
-    protected $_hook_paths;
-
-    //load_page?
-    private $_load_page;
-
-
-
-    /**
-     * @Constructor
-     * @access public
-     * @return void
-     */
-    public function __construct()
-    {
-        //set global defaults
-        $this->_set_defaults();
-        //set properties that are always available with objects.
-        $this->_set_init_properties();
-        //global styles/scripts across all wp admin pages
-        add_action('admin_enqueue_scripts', array($this, 'load_wp_global_scripts_styles'), 5);
-        //load initial stuff.
-        $this->_set_file_and_folder_name();
-        $this->_set_menu_map();
-        if (empty($this->_menu_map) || is_array($this->_menu_map)) {
-            EE_Error::doing_it_wrong(
-                get_class($this) . '::$_menu_map',
-                sprintf(
-                    __(
-                        'The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                ),
-                '4.4.0'
-            );
-            return;
-        }
-        //set default capability
-        $this->_set_capability();
-    }
-
-
-
-    /**
-     * _set_init_properties
-     * Child classes use to set the following properties:
-     * $label
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_init_properties();
-
-
-
-    /**
-     * _set_menu_map is a function that child classes use to set the menu_map property (which should be an instance of
-     * EE_Admin_Page_Menu_Map.  Their menu can either be EE_Admin_Page_Main_Menu or EE_Admin_Page_Sub_Menu.
-     *
-     * @since 4.4.0
-     * @ return void.
-     */
-    protected function _set_menu_map()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * returns the menu map for this admin page
-     *
-     * @since 4.4.0
-     * @return EE_Admin_Page_Menu_Map
-     */
-    public function get_menu_map()
-    {
-        return $this->_menu_map;
-    }
-
-
-
-    /**
-     * This loads scripts and styles for the EE_Admin system
-     * that must be available on ALL WP admin pages (i.e. EE_menu items)
-     *
-     * @return void
-     */
-    public function load_wp_global_scripts_styles()
-    {
-        wp_register_style(
-            'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
-            array('dashicons'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_menu');
-    }
-
-
-
-    /**
-     * this sets default properties (might be overridden in _set_init_properties);
-     *
-     * @access private
-     * @return  void
-     */
-    private function _set_defaults()
-    {
-        $this->_file_name    = $this->_folder_name = $this->_wp_page_slug = $this->capability = null;
-        $this->_routing      = true;
-        $this->_load_page    = false;
-        $this->_files_hooked = $this->_hook_paths = array();
-        //menu_map
-        $this->_menu_map = $this->get_menu_map();
-    }
-
-
-
-    protected function _set_capability()
-    {
-        $capability       = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
-        $this->capability = apply_filters('FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability);
-    }
-
-
-
-    /**
-     * initialize_admin_page
-     * This method is what executes the loading of the specific page class for the given dir_name as called by the
-     * EE_Admin_Init class.
-     *
-     * @access  public
-     * @uses    _initialize_admin_page()
-     * @param  string $dir_name directory name for specific admin_page being loaded.
-     * @return void
-     */
-    public function initialize_admin_page()
-    {
-        //let's check user access first
-        $this->_check_user_access();
-        if (! is_object($this->_loaded_page_object)) {
-            return;
-        }
-        $this->_loaded_page_object->route_admin_request();
-        return;
-    }
-
-
-
-    public function set_page_dependencies($wp_page_slug)
-    {
-        if (! $this->_load_page) {
-            return;
-        }
-        if (! is_object($this->_loaded_page_object)) {
-            $msg[] = __(
-                'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
-                'event_espresso'
-            );
-            $msg[] = $msg[0] . "\r\n" . sprintf(
-                    __(
-                        'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
-                        'event_espresso'
-                    ),
-                    $this->_file_name,
-                    $this->_file_name,
-                    $this->_folder_path . $this->_file_name,
-                    $this->_menu_map->menu_slug
-                );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-        $page_hook = 'load-' . $wp_page_slug;
-        //hook into page load hook so all page specific stuff get's loaded.
-        if (! empty($wp_page_slug)) {
-            add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies'));
-        }
-    }
-
-
-    /**
-     * This executes the intial page loads for EE_Admin pages to take care of any ajax or other code needing to run
-     * before the load-page... hook. Note, the page loads are happening around the wp_init hook.
-     *
-     * @return void
-     */
-    public function do_initial_loads()
-    {
-        //no loading or initializing if menu map is setup incorrectly.
-        if (empty($this->_menu_map) || is_array($this->_menu_map)) {
-            return;
-        }
-        $this->_initialize_admin_page();
-    }
-
-
-    /**
-     * all we're doing here is setting the $_file_name property for later use.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_file_and_folder_name()
-    {
-        $bt = debug_backtrace();
-        //for more reliable determination of folder name
-        //we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
-        $class = get_class($this);
-        foreach ($bt as $index => $values) {
-            if (isset($values['class']) && $values['class'] == $class) {
-                $file_index         = $index - 1;
-                $this->_folder_name = basename(dirname($bt[$file_index]['file']));
-                if (! empty($this->_folder_name)) {
-                    break;
-                }
-            }
-        }
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . DS;
-        $this->_file_name = preg_replace('/^ee/', 'EE', $this->_folder_name);
-        $this->_file_name = ucwords(str_replace('_', ' ', $this->_file_name));
-        $this->_file_name = str_replace(' ', '_', $this->_file_name);
-    }
-
-
-    /**
-     * This automatically checks if we have a hook class in the loaded child directory.  If we DO then we will register
-     * it with the appropriate pages.  That way all we have to do is make sure the file is named correctly and
-     * "dropped" in. Example: if we wanted to set this up for Messages hooking into Events then we would do:
-     * events_Messages_Hooks.class.php
-     *
-     * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks
-     *                     files/classes
-     * @return array
-     */
-    public function register_hooks($extend = false)
-    {
-
-        //get a list of files in the directory that have the "Hook" in their name an
-        //if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
-        if ($extend) {
-            $hook_files_glob_path = apply_filters(
-                'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend',
-                EE_CORE_CAF_ADMIN_EXTEND
-                . $this->_folder_name
-                . DS
-                . '*'
-                . $this->_file_name
-                . '_Hooks_Extend.class.php'
-            );
-            $this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
-        }
-        //loop through decaf folders
-        $hook_files_glob_path = apply_filters(
-            'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
-            $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
-        );
-        $this->_hook_paths    = array_merge(
-            $this->_register_hook_files($hook_files_glob_path),
-            $this->_hook_paths
-        );  //making sure any extended hook paths are later in the array than the core hook paths!
-        return $this->_hook_paths;
-    }
-
-
-
-    protected function _register_hook_files($hook_files_glob_path, $extend = false)
-    {
-        $hook_paths = array();
-        if ($hook_files = glob($hook_files_glob_path)) {
-            if (empty($hook_files)) {
-                return array();
-            }
-            foreach ($hook_files as $file) {
-                //lets get the linked admin.
-                $hook_file    = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . DS, '', $file)
-                    : str_replace($this->_folder_path, '', $file);
-                $replace      = $extend
-                    ? '_' . $this->_file_name . '_Hooks_Extend.class.php'
-                    : '_'
-                      . $this->_file_name
-                      . '_Hooks.class.php';
-                $rel_admin    = str_replace($replace, '', $hook_file);
-                $rel_admin    = strtolower($rel_admin);
-                $hook_paths[] = $file;
-                //make sure we haven't already got a hook setup for this page path
-                if (in_array($rel_admin, $this->_files_hooked)) {
-                    continue;
-                }
-                $this->hook_file       = $hook_file;
-                $rel_admin_hook        = 'FHEE_do_other_page_hooks_' . $rel_admin;
-                $filter                = add_filter($rel_admin_hook, array($this, 'load_admin_hook'));
-                $this->_files_hooked[] = $rel_admin;
-            }
-        }
-        return $hook_paths;
-    }
-
-
-
-    public function load_admin_hook($registered_pages)
-    {
-        $this->hook_file;
-        $hook_file = (array)$this->hook_file;
-        return array_merge($hook_file, $registered_pages);
-    }
-
-
-    /**
-     * _initialize_admin_page
-     *
-     * @see  initialize_admin_page() for info
-     */
-    protected function _initialize_admin_page()
-    {
-
-        //JUST CHECK WE'RE ON RIGHT PAGE.
-        if ((! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing) {
-            return;
-        } //not on the right page so let's get out.
-        $this->_load_page = true;
-        //let's set page specific autoloaders.  Note that this just sets autoloaders for THIS set of admin pages.
-        //		spl_autoload_register(array( $this, 'set_autoloaders') );
-        //we don't need to do a page_request check here because it's only called via WP menu system.
-        $admin_page  = $this->_file_name . '_Admin_Page';
-        $hook_suffix = $this->_menu_map->menu_slug . '_' . $admin_page;
-        $admin_page  = apply_filters(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}",
-            $admin_page
-        );
-        // define requested admin page class name then load the file and instantiate
-        $path_to_file = str_replace(array('\\', '/'), DS, $this->_folder_path . $admin_page . '.core.php');
-        $path_to_file = apply_filters(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",
-            $path_to_file
-        );//so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
-        if (is_readable($path_to_file)) {
-            // This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
-            do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
-            do_action(
-                'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_' . $this->_menu_map->menu_slug
-            );
-            require_once($path_to_file);
-            $a                         = new ReflectionClass($admin_page);
-            $this->_loaded_page_object = $a->newInstance($this->_routing);
-        }
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_' . $this->_menu_map->menu_slug);
-    }
-
-
-
-    public function get_admin_page_name()
-    {
-        return $this->_file_name . '_Admin_Page';
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function loaded_page_object()
-    {
-        return $this->_loaded_page_object;
-    }
-
-
-
-
-
-    //	public function set_autoloaders( $className ) {
-    //		$dir_ref = array(
-    //			$this->_folder_path => array('core','class')
-    //			);
-    //		EEH_Autoloader::try_autoload($dir_ref, $className );
-    //	}
-    /**
-     * _check_user_access
-     * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a
-     * WordPress die message.
-     *
-     * @return bool|die true if pass (or admin) wp_die if fail
-     */
-    private function _check_user_access()
-    {
-        if (! EE_Registry::instance()->CAP->current_user_can(
-            $this->_menu_map->capability,
-            $this->_menu_map->menu_slug
-        )) {
-            wp_die(__('You don\'t have access to this page.'), '', array('back_link' => true));
-        }
-        return true;
-    }
+	//identity properties (set in _set_defaults and _set_init_properties)
+	public $label;
+
+	/**
+	 * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
+	 * and accessing pages.  If capability is NOT set, then it defaults to the menu_map capability.
+	 *
+	 * @var string
+	 */
+	public $capability;
+
+
+	/**
+	 * This holds the menu map object for this admin page.
+	 *
+	 * @var EE_Admin_Page_Menu_Map
+	 */
+	protected $_menu_map;
+
+	/**
+	 * deprecated
+	 */
+	public $menu_label;
+	public $menu_slug;
+
+
+
+	//set in _set_defaults
+	protected $_folder_name;
+	protected $_folder_path;
+	protected $_file_name;
+	public    $hook_file;
+	protected $_wp_page_slug;
+	protected $_routing;
+
+
+	//will hold page object.
+	protected $_loaded_page_object;
+
+
+	//for caf
+	protected $_files_hooked;
+	protected $_hook_paths;
+
+	//load_page?
+	private $_load_page;
+
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 * @return void
+	 */
+	public function __construct()
+	{
+		//set global defaults
+		$this->_set_defaults();
+		//set properties that are always available with objects.
+		$this->_set_init_properties();
+		//global styles/scripts across all wp admin pages
+		add_action('admin_enqueue_scripts', array($this, 'load_wp_global_scripts_styles'), 5);
+		//load initial stuff.
+		$this->_set_file_and_folder_name();
+		$this->_set_menu_map();
+		if (empty($this->_menu_map) || is_array($this->_menu_map)) {
+			EE_Error::doing_it_wrong(
+				get_class($this) . '::$_menu_map',
+				sprintf(
+					__(
+						'The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.',
+						'event_espresso'
+					),
+					get_class($this)
+				),
+				'4.4.0'
+			);
+			return;
+		}
+		//set default capability
+		$this->_set_capability();
+	}
+
+
+
+	/**
+	 * _set_init_properties
+	 * Child classes use to set the following properties:
+	 * $label
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_init_properties();
+
+
+
+	/**
+	 * _set_menu_map is a function that child classes use to set the menu_map property (which should be an instance of
+	 * EE_Admin_Page_Menu_Map.  Their menu can either be EE_Admin_Page_Main_Menu or EE_Admin_Page_Sub_Menu.
+	 *
+	 * @since 4.4.0
+	 * @ return void.
+	 */
+	protected function _set_menu_map()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * returns the menu map for this admin page
+	 *
+	 * @since 4.4.0
+	 * @return EE_Admin_Page_Menu_Map
+	 */
+	public function get_menu_map()
+	{
+		return $this->_menu_map;
+	}
+
+
+
+	/**
+	 * This loads scripts and styles for the EE_Admin system
+	 * that must be available on ALL WP admin pages (i.e. EE_menu items)
+	 *
+	 * @return void
+	 */
+	public function load_wp_global_scripts_styles()
+	{
+		wp_register_style(
+			'espresso_menu',
+			EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+			array('dashicons'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_menu');
+	}
+
+
+
+	/**
+	 * this sets default properties (might be overridden in _set_init_properties);
+	 *
+	 * @access private
+	 * @return  void
+	 */
+	private function _set_defaults()
+	{
+		$this->_file_name    = $this->_folder_name = $this->_wp_page_slug = $this->capability = null;
+		$this->_routing      = true;
+		$this->_load_page    = false;
+		$this->_files_hooked = $this->_hook_paths = array();
+		//menu_map
+		$this->_menu_map = $this->get_menu_map();
+	}
+
+
+
+	protected function _set_capability()
+	{
+		$capability       = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
+		$this->capability = apply_filters('FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability);
+	}
+
+
+
+	/**
+	 * initialize_admin_page
+	 * This method is what executes the loading of the specific page class for the given dir_name as called by the
+	 * EE_Admin_Init class.
+	 *
+	 * @access  public
+	 * @uses    _initialize_admin_page()
+	 * @param  string $dir_name directory name for specific admin_page being loaded.
+	 * @return void
+	 */
+	public function initialize_admin_page()
+	{
+		//let's check user access first
+		$this->_check_user_access();
+		if (! is_object($this->_loaded_page_object)) {
+			return;
+		}
+		$this->_loaded_page_object->route_admin_request();
+		return;
+	}
+
+
+
+	public function set_page_dependencies($wp_page_slug)
+	{
+		if (! $this->_load_page) {
+			return;
+		}
+		if (! is_object($this->_loaded_page_object)) {
+			$msg[] = __(
+				'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
+				'event_espresso'
+			);
+			$msg[] = $msg[0] . "\r\n" . sprintf(
+					__(
+						'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
+						'event_espresso'
+					),
+					$this->_file_name,
+					$this->_file_name,
+					$this->_folder_path . $this->_file_name,
+					$this->_menu_map->menu_slug
+				);
+			throw new EE_Error(implode('||', $msg));
+		}
+		$this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
+		$page_hook = 'load-' . $wp_page_slug;
+		//hook into page load hook so all page specific stuff get's loaded.
+		if (! empty($wp_page_slug)) {
+			add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies'));
+		}
+	}
+
+
+	/**
+	 * This executes the intial page loads for EE_Admin pages to take care of any ajax or other code needing to run
+	 * before the load-page... hook. Note, the page loads are happening around the wp_init hook.
+	 *
+	 * @return void
+	 */
+	public function do_initial_loads()
+	{
+		//no loading or initializing if menu map is setup incorrectly.
+		if (empty($this->_menu_map) || is_array($this->_menu_map)) {
+			return;
+		}
+		$this->_initialize_admin_page();
+	}
+
+
+	/**
+	 * all we're doing here is setting the $_file_name property for later use.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_file_and_folder_name()
+	{
+		$bt = debug_backtrace();
+		//for more reliable determination of folder name
+		//we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
+		$class = get_class($this);
+		foreach ($bt as $index => $values) {
+			if (isset($values['class']) && $values['class'] == $class) {
+				$file_index         = $index - 1;
+				$this->_folder_name = basename(dirname($bt[$file_index]['file']));
+				if (! empty($this->_folder_name)) {
+					break;
+				}
+			}
+		}
+		$this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . DS;
+		$this->_file_name = preg_replace('/^ee/', 'EE', $this->_folder_name);
+		$this->_file_name = ucwords(str_replace('_', ' ', $this->_file_name));
+		$this->_file_name = str_replace(' ', '_', $this->_file_name);
+	}
+
+
+	/**
+	 * This automatically checks if we have a hook class in the loaded child directory.  If we DO then we will register
+	 * it with the appropriate pages.  That way all we have to do is make sure the file is named correctly and
+	 * "dropped" in. Example: if we wanted to set this up for Messages hooking into Events then we would do:
+	 * events_Messages_Hooks.class.php
+	 *
+	 * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks
+	 *                     files/classes
+	 * @return array
+	 */
+	public function register_hooks($extend = false)
+	{
+
+		//get a list of files in the directory that have the "Hook" in their name an
+		//if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
+		if ($extend) {
+			$hook_files_glob_path = apply_filters(
+				'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend',
+				EE_CORE_CAF_ADMIN_EXTEND
+				. $this->_folder_name
+				. DS
+				. '*'
+				. $this->_file_name
+				. '_Hooks_Extend.class.php'
+			);
+			$this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
+		}
+		//loop through decaf folders
+		$hook_files_glob_path = apply_filters(
+			'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
+			$this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
+		);
+		$this->_hook_paths    = array_merge(
+			$this->_register_hook_files($hook_files_glob_path),
+			$this->_hook_paths
+		);  //making sure any extended hook paths are later in the array than the core hook paths!
+		return $this->_hook_paths;
+	}
+
+
+
+	protected function _register_hook_files($hook_files_glob_path, $extend = false)
+	{
+		$hook_paths = array();
+		if ($hook_files = glob($hook_files_glob_path)) {
+			if (empty($hook_files)) {
+				return array();
+			}
+			foreach ($hook_files as $file) {
+				//lets get the linked admin.
+				$hook_file    = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . DS, '', $file)
+					: str_replace($this->_folder_path, '', $file);
+				$replace      = $extend
+					? '_' . $this->_file_name . '_Hooks_Extend.class.php'
+					: '_'
+					  . $this->_file_name
+					  . '_Hooks.class.php';
+				$rel_admin    = str_replace($replace, '', $hook_file);
+				$rel_admin    = strtolower($rel_admin);
+				$hook_paths[] = $file;
+				//make sure we haven't already got a hook setup for this page path
+				if (in_array($rel_admin, $this->_files_hooked)) {
+					continue;
+				}
+				$this->hook_file       = $hook_file;
+				$rel_admin_hook        = 'FHEE_do_other_page_hooks_' . $rel_admin;
+				$filter                = add_filter($rel_admin_hook, array($this, 'load_admin_hook'));
+				$this->_files_hooked[] = $rel_admin;
+			}
+		}
+		return $hook_paths;
+	}
+
+
+
+	public function load_admin_hook($registered_pages)
+	{
+		$this->hook_file;
+		$hook_file = (array)$this->hook_file;
+		return array_merge($hook_file, $registered_pages);
+	}
+
+
+	/**
+	 * _initialize_admin_page
+	 *
+	 * @see  initialize_admin_page() for info
+	 */
+	protected function _initialize_admin_page()
+	{
+
+		//JUST CHECK WE'RE ON RIGHT PAGE.
+		if ((! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing) {
+			return;
+		} //not on the right page so let's get out.
+		$this->_load_page = true;
+		//let's set page specific autoloaders.  Note that this just sets autoloaders for THIS set of admin pages.
+		//		spl_autoload_register(array( $this, 'set_autoloaders') );
+		//we don't need to do a page_request check here because it's only called via WP menu system.
+		$admin_page  = $this->_file_name . '_Admin_Page';
+		$hook_suffix = $this->_menu_map->menu_slug . '_' . $admin_page;
+		$admin_page  = apply_filters(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}",
+			$admin_page
+		);
+		// define requested admin page class name then load the file and instantiate
+		$path_to_file = str_replace(array('\\', '/'), DS, $this->_folder_path . $admin_page . '.core.php');
+		$path_to_file = apply_filters(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",
+			$path_to_file
+		);//so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
+		if (is_readable($path_to_file)) {
+			// This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
+			do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
+			do_action(
+				'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_' . $this->_menu_map->menu_slug
+			);
+			require_once($path_to_file);
+			$a                         = new ReflectionClass($admin_page);
+			$this->_loaded_page_object = $a->newInstance($this->_routing);
+		}
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_' . $this->_menu_map->menu_slug);
+	}
+
+
+
+	public function get_admin_page_name()
+	{
+		return $this->_file_name . '_Admin_Page';
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function loaded_page_object()
+	{
+		return $this->_loaded_page_object;
+	}
+
+
+
+
+
+	//	public function set_autoloaders( $className ) {
+	//		$dir_ref = array(
+	//			$this->_folder_path => array('core','class')
+	//			);
+	//		EEH_Autoloader::try_autoload($dir_ref, $className );
+	//	}
+	/**
+	 * _check_user_access
+	 * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a
+	 * WordPress die message.
+	 *
+	 * @return bool|die true if pass (or admin) wp_die if fail
+	 */
+	private function _check_user_access()
+	{
+		if (! EE_Registry::instance()->CAP->current_user_can(
+			$this->_menu_map->capability,
+			$this->_menu_map->menu_slug
+		)) {
+			wp_die(__('You don\'t have access to this page.'), '', array('back_link' => true));
+		}
+		return true;
+	}
 
 }
 // end of file:  includes/core/admin/EE_Admin_Page_Init.core.php

Spacing +30 added lines, -30 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 /**
@@ -95,7 +95,7 @@ 
         $this->_set_menu_map();
         if (empty($this->_menu_map) || is_array($this->_menu_map)) {
             EE_Error::doing_it_wrong(
-                get_class($this) . '::$_menu_map',
+                get_class($this).'::$_menu_map',
                 sprintf(
                     __(
                         'The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.',
@@ -163,7 +163,7 @@ 
     {
         wp_register_style(
             'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+            EE_ADMIN_URL.'assets/admin-menu-styles.css',
             array('dashicons'),
             EVENT_ESPRESSO_VERSION
         );
@@ -193,7 +193,7 @@ 
     protected function _set_capability()
     {
         $capability       = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
-        $this->capability = apply_filters('FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability);
+        $this->capability = apply_filters('FHEE_'.$this->_menu_map->menu_slug.'_capability', $capability);
     }
 
 
@@ -212,7 +212,7 @@ 
     {
         //let's check user access first
         $this->_check_user_access();
-        if (! is_object($this->_loaded_page_object)) {
+        if ( ! is_object($this->_loaded_page_object)) {
             return;
         }
         $this->_loaded_page_object->route_admin_request();
@@ -223,30 +223,30 @@ 
 
     public function set_page_dependencies($wp_page_slug)
     {
-        if (! $this->_load_page) {
+        if ( ! $this->_load_page) {
             return;
         }
-        if (! is_object($this->_loaded_page_object)) {
+        if ( ! is_object($this->_loaded_page_object)) {
             $msg[] = __(
                 'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
                 'event_espresso'
             );
-            $msg[] = $msg[0] . "\r\n" . sprintf(
+            $msg[] = $msg[0]."\r\n".sprintf(
                     __(
                         'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
                         'event_espresso'
                     ),
                     $this->_file_name,
                     $this->_file_name,
-                    $this->_folder_path . $this->_file_name,
+                    $this->_folder_path.$this->_file_name,
                     $this->_menu_map->menu_slug
                 );
             throw new EE_Error(implode('||', $msg));
         }
         $this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-        $page_hook = 'load-' . $wp_page_slug;
+        $page_hook = 'load-'.$wp_page_slug;
         //hook into page load hook so all page specific stuff get's loaded.
-        if (! empty($wp_page_slug)) {
+        if ( ! empty($wp_page_slug)) {
             add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies'));
         }
     }
@@ -284,12 +284,12 @@ 
             if (isset($values['class']) && $values['class'] == $class) {
                 $file_index         = $index - 1;
                 $this->_folder_name = basename(dirname($bt[$file_index]['file']));
-                if (! empty($this->_folder_name)) {
+                if ( ! empty($this->_folder_name)) {
                     break;
                 }
             }
         }
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . DS;
+        $this->_folder_path = EE_ADMIN_PAGES.$this->_folder_name.DS;
         $this->_file_name = preg_replace('/^ee/', 'EE', $this->_folder_name);
         $this->_file_name = ucwords(str_replace('_', ' ', $this->_file_name));
         $this->_file_name = str_replace(' ', '_', $this->_file_name);
@@ -321,17 +321,17 @@ 
                 . $this->_file_name
                 . '_Hooks_Extend.class.php'
             );
-            $this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
+            $this->_hook_paths = $this->_register_hook_files($hook_files_glob_path, $extend);
         }
         //loop through decaf folders
         $hook_files_glob_path = apply_filters(
             'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
-            $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
+            $this->_folder_path.'*'.$this->_file_name.'_Hooks.class.php'
         );
-        $this->_hook_paths    = array_merge(
+        $this->_hook_paths = array_merge(
             $this->_register_hook_files($hook_files_glob_path),
             $this->_hook_paths
-        );  //making sure any extended hook paths are later in the array than the core hook paths!
+        ); //making sure any extended hook paths are later in the array than the core hook paths!
         return $this->_hook_paths;
     }
 
@@ -346,10 +346,10 @@ 
             }
             foreach ($hook_files as $file) {
                 //lets get the linked admin.
-                $hook_file    = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . DS, '', $file)
+                $hook_file    = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND.$this->_folder_name.DS, '', $file)
                     : str_replace($this->_folder_path, '', $file);
                 $replace      = $extend
-                    ? '_' . $this->_file_name . '_Hooks_Extend.class.php'
+                    ? '_'.$this->_file_name.'_Hooks_Extend.class.php'
                     : '_'
                       . $this->_file_name
                       . '_Hooks.class.php';
@@ -361,7 +361,7 @@ 
                     continue;
                 }
                 $this->hook_file       = $hook_file;
-                $rel_admin_hook        = 'FHEE_do_other_page_hooks_' . $rel_admin;
+                $rel_admin_hook        = 'FHEE_do_other_page_hooks_'.$rel_admin;
                 $filter                = add_filter($rel_admin_hook, array($this, 'load_admin_hook'));
                 $this->_files_hooked[] = $rel_admin;
             }
@@ -374,7 +374,7 @@ 
     public function load_admin_hook($registered_pages)
     {
         $this->hook_file;
-        $hook_file = (array)$this->hook_file;
+        $hook_file = (array) $this->hook_file;
         return array_merge($hook_file, $registered_pages);
     }
 
@@ -388,44 +388,44 @@ 
     {
 
         //JUST CHECK WE'RE ON RIGHT PAGE.
-        if ((! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing) {
+        if (( ! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing) {
             return;
         } //not on the right page so let's get out.
         $this->_load_page = true;
         //let's set page specific autoloaders.  Note that this just sets autoloaders for THIS set of admin pages.
         //		spl_autoload_register(array( $this, 'set_autoloaders') );
         //we don't need to do a page_request check here because it's only called via WP menu system.
-        $admin_page  = $this->_file_name . '_Admin_Page';
-        $hook_suffix = $this->_menu_map->menu_slug . '_' . $admin_page;
+        $admin_page  = $this->_file_name.'_Admin_Page';
+        $hook_suffix = $this->_menu_map->menu_slug.'_'.$admin_page;
         $admin_page  = apply_filters(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}",
             $admin_page
         );
         // define requested admin page class name then load the file and instantiate
-        $path_to_file = str_replace(array('\\', '/'), DS, $this->_folder_path . $admin_page . '.core.php');
+        $path_to_file = str_replace(array('\\', '/'), DS, $this->_folder_path.$admin_page.'.core.php');
         $path_to_file = apply_filters(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",
             $path_to_file
-        );//so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
+        ); //so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
         if (is_readable($path_to_file)) {
             // This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
             do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
             do_action(
-                'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_' . $this->_menu_map->menu_slug
+                'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_'.$this->_menu_map->menu_slug
             );
             require_once($path_to_file);
             $a                         = new ReflectionClass($admin_page);
             $this->_loaded_page_object = $a->newInstance($this->_routing);
         }
         do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_' . $this->_menu_map->menu_slug);
+        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_'.$this->_menu_map->menu_slug);
     }
 
 
 
     public function get_admin_page_name()
     {
-        return $this->_file_name . '_Admin_Page';
+        return $this->_file_name.'_Admin_Page';
     }
 
 
@@ -457,7 +457,7 @@ 
      */
     private function _check_user_access()
     {
-        if (! EE_Registry::instance()->CAP->current_user_can(
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
             $this->_menu_map->capability,
             $this->_menu_map->menu_slug
         )) {

core/admin/EE_Admin_Page_Loader.core.php

Indentation +745 added lines, -745 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -26,750 +26,750 @@ 
 class EE_Admin_Page_Loader
 {
 
-    /**
-     * _installed_pages
-     * objects for page_init objects detected and loaded
-     *
-     * @access private
-     * @var \EE_Admin_Page_Init[]
-     */
-    private $_installed_pages = array();
-
-
-
-    /**
-     * this is used to hold the registry of menu slugs for all the installed admin pages
-     *
-     * @var array
-     */
-    private $_menu_slugs = array();
-
-
-    /**
-     * _caffeinated_extends
-     * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
-     * pieces needed to do so).  This property is defined in the _set_caffeinated method.
-     *
-     * @var array
-     */
-    private $_caffeinated_extends = array();
-
-
-
-    /**
-     * _current_caf_extend_slug
-     * This property is used for holding the page slug that is required for referencing the correct
-     * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
-     *
-     * @var array
-     */
-    private $_current_caf_extend_slug;
-
-
-
-    /**
-     * _caf_autoloader
-     * This property is used for holding an array of folder names of any NEW EE_Admin_Pages found in the
-     * caffeinated/new directory.  This array is then used to setup a corresponding dynamic autoloader for these pages
-     * classes.
-     *
-     * @var array
-     */
-    //	private $_caf_autoloader = array();
-    /**
-     * _prepped_menu_maps
-     * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
-     *
-     * @since  4.4.0
-     * @var EE_Admin_Page_Menu_Map[]
-     */
-    private $_prepped_menu_maps = array();
-
-
-
-    /**
-     * _admin_menu_groups
-     * array that holds the group headings and details for
-     *
-     * @access private
-     * @var array
-     */
-    private $_admin_menu_groups = array();
-
-
-
-    /**
-     * This property will hold the hook file for setting up the filter that does all the connections between admin
-     * pages.
-     *
-     * @var string
-     */
-    public $hook_file;
-
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     * @return \EE_Admin_Page_Loader
-     */
-    public function __construct()
-    {
-        //load menu_map classes
-        EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
-        //define the default "groups" for the admin_pages
-        $this->_set_menu_groups();
-        //let's set default autoloaders.  Note that this just sets autoloaders for root admin files.
-        //		spl_autoload_register( array( $this, 'init_autoloaders') );
-        //let's do a scan and see what installed pages we have
-        $this->_get_installed_pages();
-        //set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
-        add_action('admin_menu', array($this, 'set_menus'));
-        add_action('network_admin_menu', array($this, 'set_network_menus'));
-    }
-
-
-
-    /**
-     * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
-     * files in the caffeinated folder.
-     *
-     * @access private
-     * @return void
-     */
-    private function _define_caffeinated_constants()
-    {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
-        }
-    }
-
-
-
-    /**
-     * _set_menu_groups
-     * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_menu_groups()
-    {
-
-        //set array of EE_Admin_Page_Menu_Group objects
-        $groups = array(
-            'main'       => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Main', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
-                    'menu_slug'    => 'main',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 0,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'management' => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Management', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'management',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 10,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'settings'   => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Settings', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'settings',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 30,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'templates'  => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Templates', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'templates',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 40,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'extras'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'              => __('Extras', 'event_espresso'),
-                    'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_slug'               => 'extras',
-                    'capability'              => 'ee_read_ee',
-                    'menu_order'              => 50,
-                    'parent_slug'             => 'espresso_events',
-                    'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                )
-            ),
-            'tools'      => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __("Tools", "event_espresso"),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'tools',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 60,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'addons'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_label'   => __('Add-ons', 'event_espresso'),
-                    'menu_slug'    => 'addons',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 20,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-        );
-        $this->_admin_menu_groups = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
-            $groups
-        );
-    }
-
-
-
-    /**
-     * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
-     * slug.  The other utility with this function is it validates that all the groups are instances of
-     * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
-     *
-     * @since  4.4.0
-     * @throws \EE_Error
-     * @return EE_Admin_Page_Menu_Group[]
-     */
-    private function _rearrange_menu_groups()
-    {
-        $groups = array();
-        //first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
-        usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
-        foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
-                            'event_espresso'
-                        ),
-                        print_r($group, true)
-                    )
-                );
-            }
-            $groups[$group->menu_slug] = $group;
-        }
-        return $groups;
-    }
-
-
-
-    /**
-     * _get_installed_pages
-     * This just gets the list of installed EE_Admin_pages.
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _get_installed_pages()
-    {
-        $installed_refs = array();
-        $exclude        = array('assets', 'templates');
-        // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
-        if ($admin_screens) {
-            foreach ($admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different EE admin pages
-                    $installed_refs[basename($admin_screen)] = $admin_screen;
-                }
-            }
-        }
-        if (empty($installed_refs)) {
-            $error_msg[] = __(
-                'There are no EE_Admin pages detected, it looks like EE did not install properly',
-                'event_espresso'
-            );
-            $error_msg[] = $error_msg[0] . "\r\n" . sprintf(
-                    __(
-                        'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
-                        'event_espresso'
-                    ),
-                    EE_ADMIN_PAGES
-                );
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        //this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
-        $installed_refs = $this->_set_caffeinated($installed_refs);
-        //allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        $installed_refs             = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            $installed_refs
-        );
-        $this->_caffeinated_extends = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
-            $this->_caffeinated_extends
-        );
-        //loop through admin pages and setup the $_installed_pages array.
-        $hooks_ref = array();
-        foreach ($installed_refs as $page => $path) {
-            // set autoloaders for our admin page classes based on included path information
-            EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
-            // build list of installed pages
-            $this->_installed_pages[$page] = $this->_load_admin_page($page, $path);
-            // verify returned object
-            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
-                    continue;
-                }
-                //skip if in full maintenance mode and maintenance_mode_parent is set
-                $maintenance_mode_parent = $this->_installed_pages[$page]->get_menu_map()->maintenance_mode_parent;
-                if (empty($maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level()
-                       == EE_Maintenance_Mode::level_2_complete_maintenance) {
-                    unset($installed_refs[$page]);
-                    continue;
-                }
-                $this->_menu_slugs[$this->_installed_pages[$page]->get_menu_map()->menu_slug] = $page;
-                //flag for register hooks on extended pages b/c extended pages use the default INIT.
-                $extend = false;
-                //now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
-                if (isset($this->_caffeinated_extends[$page])) {
-                    $this->_current_caf_extend_slug = $page;
-                    $path_hook                      = 'FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__'
-                                                      . $this->_installed_pages[$page]->get_menu_map()->menu_slug
-                                                      . '_'
-                                                      . $this->_installed_pages[$page]->get_admin_page_name();
-                    $path_runtime                   = 'return "'
-                                                      . $this->_caffeinated_extends[$this->_current_caf_extend_slug]["path"]
-                                                      . '";';
-                    $page_hook                      = 'FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__'
-                                                      . $this->_installed_pages[$page]->get_menu_map()->menu_slug
-                                                      . '_'
-                                                      . $this->_installed_pages[$page]->get_admin_page_name();
-                    $page_runtime                   = 'return "'
-                                                      . $this->_caffeinated_extends[$this->_current_caf_extend_slug]["admin_page"]
-                                                      . '";';
-                    $hook_function_path = create_function('$path_to_file', $path_runtime);
-                    $hook_function_page = create_function('$admin_page', $page_runtime);
-                    add_filter($path_hook, $hook_function_path);
-                    add_filter($page_hook, $hook_function_page);
-                    $extend = true;
-                }
-                //let's do the registered hooks
-                $extended_hooks = $this->_installed_pages[$page]->register_hooks($extend);
-                $hooks_ref      = array_merge($hooks_ref, $extended_hooks);
-            }
-        }
-        //the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
-        //first make sure we've got unique values
-        $hooks_ref = array_unique($hooks_ref);
-        //now let's loop and require!
-        foreach ($hooks_ref as $path) {
-            require_once($path);
-        }
-        //make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
-        global $ee_menu_slugs;
-        $ee_menu_slugs = $this->_menu_slugs;
-        //we need to loop again to run any early code
-        foreach ($installed_refs as $page => $path) {
-            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
-                $this->_installed_pages[$page]->do_initial_loads();
-            }
-        }
-        do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
-    }
-
-
-
-    /**
-     * get_admin_page_object
-     *
-     * @param string $page_slug
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page_object($page_slug = '')
-    {
-        if (isset($this->_installed_pages[$page_slug])) {
-            return $this->_installed_pages[$page_slug]->loaded_page_object();
-        }
-        return null;
-    }
-
-
-
-    /**
-     * _get_classname_for_admin_page
-     * generates an "Admin Page" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
-    }
-
-
-
-    /**
-     * _get_classname_for_admin_init_page
-     * generates an "Admin Page Init" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_init_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
-    }
-
-
-
-    /**
-     * _load_admin_page
-     * Loads and instantiates page_init object for a single EE_admin page.
-     *
-     * @param  string $page page_reference
-     * @param string  $path
-     * @throws EE_Error
-     * @return object|bool  return page object if valid, bool false if not.
-     */
-    private function _load_admin_page($page = '', $path = '')
-    {
-        $class_name = $this->_get_classname_for_admin_init_page($page);
-        EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
-            $inner_error_msg = '<br />' . sprintf(
-                    esc_html__(
-                        'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                        'event_espresso'
-                    ),
-                    '<strong>' . $class_name . '</strong>'
-                );
-            $error_msg[]     = sprintf(
-                __('Something went wrong with loading the %s admin page.', 'event_espresso'),
-                $page
-            );
-            $error_msg[]     = $error_msg[0]
-                               . "\r\n"
-                               . sprintf(
-                                   esc_html__(
-                                       'There is no Init class in place for the %s admin page.',
-                                       'event_espresso'
-                                   ),
-                                   $page
-                               )
-                               . $inner_error_msg;
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        $a = new ReflectionClass($class_name);
-        return $a->newInstance();
-    }
-
-
-
-    /**
-     * set_menus
-     * This method sets up the menus for EE Admin Pages
-     *
-     * @access private
-     * @return void
-     */
-    public function set_menus()
-    {
-        //prep the menu pages (sort, group.)
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(false);
-            }
-        }
-    }
-
-
-    /**
-     * set_network_menus
-     * This method sets up the menus for network EE Admin Pages.
-     * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
-     * are only added to the menu map if they are intended for the admin menu
-     *
-     * @return void
-     */
-    public function set_network_menus()
-    {
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(true);
-            }
-        }
-    }
-
-
-
-    /**
-     * _prep_pages
-     * sets the _prepped_menu_maps property
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _prep_pages()
-    {
-        $pages_array = array();
-        //rearrange _admin_menu_groups to be indexed by group slug.
-        $menu_groups = $this->_rearrange_menu_groups();
-        foreach ($this->_installed_pages as $page) {
-            if ($page instanceof EE_Admin_page_Init) {
-                $page_map = $page->get_menu_map();
-                //if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
-                if (is_array($page_map) || empty($page_map)) {
-                    EE_Error::add_persistent_admin_notice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
-                        sprintf(
-                            __(
-                                'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
-                                'event_espresso'
-                            ),
-                            $page->label
-                        )
-                    );
-                    continue;
-                }
-                //if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
-                                'event_espresso'
-                            ),
-                            $page->label,
-                            $page_map
-                        )
-                    );
-                }
-                //use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
-                if (empty($page_map->maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level()
-                       == EE_Maintenance_Mode::level_2_complete_maintenance) {
-                    continue;
-                }
-                //assign to group (remember $page_map has the admin page stored in it).
-                $pages_array[$page_map->menu_group][] = $page_map;
-            }
-        }
-        if (empty($pages_array)) {
-            throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
-        }
-        //let's sort the groups, make sure it's a valid group, add header (if to show).
-        foreach ($pages_array as $group => $menu_maps) {
-            //valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
-                continue;
-            }
-            //sort pages.
-            usort($menu_maps, array($this, '_sort_menu_maps'));
-            //prepend header
-            array_unshift($menu_maps, $menu_groups[$group]);
-            //reset $pages_array with prepped data
-            $pages_array[$group] = $menu_maps;
-        }
-        //now let's setup the _prepped_menu_maps property
-        foreach ($menu_groups as $group => $group_objs) {
-            if (isset($pages_array[$group])) {
-                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[$group]);
-            }
-        }/**/
-    }
-
-
-
-    /**
-     * This method is the "workhorse" for detecting and setting up caffeinated functionality.
-     * In this method there are three checks being done:
-     * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
-     * array) etc.  (new page sets are found in caffeinated/new/{page})
-     * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
-     * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
-     * Extend_Events_Admin_Page extends Events_Admin_Page.
-     * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
-     * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
-     * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
-     * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
-     * admin_pages)
-     *
-     * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
-     *                              loaded.
-     * @return array
-     */
-    private function _set_caffeinated($installed_refs)
-    {
-
-        //first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
-            return $installed_refs;
-        }
-        $this->_define_caffeinated_constants();
-        $exclude = array('tickets');
-        //okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
-        if ($new_admin_screens) {
-            foreach ($new_admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different NEW EE admin pages
-                    $installed_refs[basename($admin_screen)] = $admin_screen;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
-                    //					$this->_caf_autoloader[] = array(
-                    //						'dir' => 'new',
-                    //						'folder' => basename( $admin_screen )
-                    //					);
-                }
-            }
-        }
-        //let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
-        if ($extends) {
-            foreach ($extends as $extend) {
-                if (is_dir($extend)) {
-                    $extend_ref = basename($extend);
-                    //now let's make sure there is a file that matches the expected format
-                    $filename                                              = str_replace(
-                        ' ',
-                        '_',
-                        ucwords(
-                            str_replace(
-                                '_',
-                                ' ',
-                                $extend_ref
-                            )
-                        )
-                    );
-                    $filename                                              = 'Extend_' . $filename . '_Admin_Page';
-                    $this->_caffeinated_extends[$extend_ref]['path']       = str_replace(
-                        array('\\', '/'),
-                        DS,
-                        EE_CORE_CAF_ADMIN
-                        . 'extend'
-                        . DS
-                        . $extend_ref
-                        . DS
-                        . $filename
-                        . '.core.php'
-                    );
-                    $this->_caffeinated_extends[$extend_ref]['admin_page'] = $filename;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
-                    //					$this->_caf_autoloader[] = array(
-                    //						'dir' => 'extend',
-                    //						'folder' => $extend_ref
-                    //					);
-                }
-            }
-        }
-        //let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
-        $ee_admin_hooks = array();
-        $hooks          = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
-        if ($hooks) {
-            foreach ($hooks as $hook) {
-                if (is_readable($hook)) {
-                    require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
-                    $classname = str_replace('.class.php', '', $classname);
-                    if (class_exists($classname)) {
-                        $a                = new ReflectionClass($classname);
-                        $ee_admin_hooks[] = $a->newInstance();
-                    }
-                }
-            }
-        }/**/
-        $ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
-        return $installed_refs;
-    }
-
-
-
-
-
-    /**
-     * Initial autoloader registration
-     * This just sets up the autoloader for the root admin files
-     *
-     * @param  string $className incoming classname to check for autoload
-     * @return void
-     */
-    //	public function init_autoloaders( $className ) {
-    //		$dir_ref = array(
-    //			EE_ADMIN => array('core', 'class')
-    //		);
-    //		EEH_Autoloader::try_autoload($dir_ref, $className );
-    //	}
-    /**
-     * This method takes care of setting up the autoloader dynamically for any NEW EE_Admin pages found in the
-     * caffeinated folders.
-     *
-     * @access public
-     * @param  string $className in coming classname being called
-     * @return void
-     */
-    //	public function caffeinated_autoloaders( $className ) {
-    //		//let's setup an array of paths to check (for each subsystem)
-    //		$dir_ref = array();
-    //		foreach ( $this->_caf_autoloader as $pathinfo) {
-    //			$dir_ref[ EE_CORE_CAF_ADMIN . $pathinfo['dir'] . DS . $pathinfo['folder'] . DS] = array('core', 'class');
-    //		}
-    //
-    //		EEH_Autoloader::try_autoload($dir_ref, $className );
-    //	}
-    /**
-     * Utility method for sorting the _menu_maps (callback for usort php function)
-     *
-     * @since  4.4.0
-     * @param  EE_Admin_Page_Menu_Map $a menu_map object
-     * @param  EE_Admin_Page_Menu_Map $b being compared to
-     * @return int    sort order
-     */
-    private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
-    {
-        if ($a->menu_order == $b->menu_order) {
-            return 0;
-        }
-        return ($a->menu_order < $b->menu_order) ? -1 : 1;
-    }
-
-
-
-    /**
-     * _default_header_link
-     * This is just a dummy method to use with header submenu items
-     *
-     * @return bool false
-     */
-    public function _default_header_link()
-    {
-        return false;
-    }
+	/**
+	 * _installed_pages
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @access private
+	 * @var \EE_Admin_Page_Init[]
+	 */
+	private $_installed_pages = array();
+
+
+
+	/**
+	 * this is used to hold the registry of menu slugs for all the installed admin pages
+	 *
+	 * @var array
+	 */
+	private $_menu_slugs = array();
+
+
+	/**
+	 * _caffeinated_extends
+	 * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
+	 * pieces needed to do so).  This property is defined in the _set_caffeinated method.
+	 *
+	 * @var array
+	 */
+	private $_caffeinated_extends = array();
+
+
+
+	/**
+	 * _current_caf_extend_slug
+	 * This property is used for holding the page slug that is required for referencing the correct
+	 * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
+	 *
+	 * @var array
+	 */
+	private $_current_caf_extend_slug;
+
+
+
+	/**
+	 * _caf_autoloader
+	 * This property is used for holding an array of folder names of any NEW EE_Admin_Pages found in the
+	 * caffeinated/new directory.  This array is then used to setup a corresponding dynamic autoloader for these pages
+	 * classes.
+	 *
+	 * @var array
+	 */
+	//	private $_caf_autoloader = array();
+	/**
+	 * _prepped_menu_maps
+	 * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
+	 *
+	 * @since  4.4.0
+	 * @var EE_Admin_Page_Menu_Map[]
+	 */
+	private $_prepped_menu_maps = array();
+
+
+
+	/**
+	 * _admin_menu_groups
+	 * array that holds the group headings and details for
+	 *
+	 * @access private
+	 * @var array
+	 */
+	private $_admin_menu_groups = array();
+
+
+
+	/**
+	 * This property will hold the hook file for setting up the filter that does all the connections between admin
+	 * pages.
+	 *
+	 * @var string
+	 */
+	public $hook_file;
+
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 * @return \EE_Admin_Page_Loader
+	 */
+	public function __construct()
+	{
+		//load menu_map classes
+		EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
+		//define the default "groups" for the admin_pages
+		$this->_set_menu_groups();
+		//let's set default autoloaders.  Note that this just sets autoloaders for root admin files.
+		//		spl_autoload_register( array( $this, 'init_autoloaders') );
+		//let's do a scan and see what installed pages we have
+		$this->_get_installed_pages();
+		//set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
+		add_action('admin_menu', array($this, 'set_menus'));
+		add_action('network_admin_menu', array($this, 'set_network_menus'));
+	}
+
+
+
+	/**
+	 * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
+	 * files in the caffeinated folder.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _define_caffeinated_constants()
+	{
+		if (! defined('EE_CORE_CAF_ADMIN')) {
+			define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
+			define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
+			define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
+			define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+		}
+	}
+
+
+
+	/**
+	 * _set_menu_groups
+	 * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_menu_groups()
+	{
+
+		//set array of EE_Admin_Page_Menu_Group objects
+		$groups = array(
+			'main'       => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Main', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
+					'menu_slug'    => 'main',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 0,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'management' => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Management', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'management',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 10,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'settings'   => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Settings', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'settings',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 30,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'templates'  => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Templates', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'templates',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 40,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'extras'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'              => __('Extras', 'event_espresso'),
+					'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_slug'               => 'extras',
+					'capability'              => 'ee_read_ee',
+					'menu_order'              => 50,
+					'parent_slug'             => 'espresso_events',
+					'maintenance_mode_parent' => 'espresso_maintenance_settings',
+				)
+			),
+			'tools'      => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __("Tools", "event_espresso"),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'tools',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 60,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'addons'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_label'   => __('Add-ons', 'event_espresso'),
+					'menu_slug'    => 'addons',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 20,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+		);
+		$this->_admin_menu_groups = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
+			$groups
+		);
+	}
+
+
+
+	/**
+	 * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
+	 * slug.  The other utility with this function is it validates that all the groups are instances of
+	 * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
+	 *
+	 * @since  4.4.0
+	 * @throws \EE_Error
+	 * @return EE_Admin_Page_Menu_Group[]
+	 */
+	private function _rearrange_menu_groups()
+	{
+		$groups = array();
+		//first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
+		usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
+		foreach ($this->_admin_menu_groups as $group) {
+			if (! $group instanceof EE_Admin_Page_Menu_Group) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
+							'event_espresso'
+						),
+						print_r($group, true)
+					)
+				);
+			}
+			$groups[$group->menu_slug] = $group;
+		}
+		return $groups;
+	}
+
+
+
+	/**
+	 * _get_installed_pages
+	 * This just gets the list of installed EE_Admin_pages.
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _get_installed_pages()
+	{
+		$installed_refs = array();
+		$exclude        = array('assets', 'templates');
+		// grab everything in the  admin core directory
+		$admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+		if ($admin_screens) {
+			foreach ($admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different EE admin pages
+					$installed_refs[basename($admin_screen)] = $admin_screen;
+				}
+			}
+		}
+		if (empty($installed_refs)) {
+			$error_msg[] = __(
+				'There are no EE_Admin pages detected, it looks like EE did not install properly',
+				'event_espresso'
+			);
+			$error_msg[] = $error_msg[0] . "\r\n" . sprintf(
+					__(
+						'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
+						'event_espresso'
+					),
+					EE_ADMIN_PAGES
+				);
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		//this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
+		$installed_refs = $this->_set_caffeinated($installed_refs);
+		//allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
+		$installed_refs             = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			$installed_refs
+		);
+		$this->_caffeinated_extends = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
+			$this->_caffeinated_extends
+		);
+		//loop through admin pages and setup the $_installed_pages array.
+		$hooks_ref = array();
+		foreach ($installed_refs as $page => $path) {
+			// set autoloaders for our admin page classes based on included path information
+			EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
+			// build list of installed pages
+			$this->_installed_pages[$page] = $this->_load_admin_page($page, $path);
+			// verify returned object
+			if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+				if (! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+					continue;
+				}
+				//skip if in full maintenance mode and maintenance_mode_parent is set
+				$maintenance_mode_parent = $this->_installed_pages[$page]->get_menu_map()->maintenance_mode_parent;
+				if (empty($maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level()
+					   == EE_Maintenance_Mode::level_2_complete_maintenance) {
+					unset($installed_refs[$page]);
+					continue;
+				}
+				$this->_menu_slugs[$this->_installed_pages[$page]->get_menu_map()->menu_slug] = $page;
+				//flag for register hooks on extended pages b/c extended pages use the default INIT.
+				$extend = false;
+				//now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
+				if (isset($this->_caffeinated_extends[$page])) {
+					$this->_current_caf_extend_slug = $page;
+					$path_hook                      = 'FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__'
+													  . $this->_installed_pages[$page]->get_menu_map()->menu_slug
+													  . '_'
+													  . $this->_installed_pages[$page]->get_admin_page_name();
+					$path_runtime                   = 'return "'
+													  . $this->_caffeinated_extends[$this->_current_caf_extend_slug]["path"]
+													  . '";';
+					$page_hook                      = 'FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__'
+													  . $this->_installed_pages[$page]->get_menu_map()->menu_slug
+													  . '_'
+													  . $this->_installed_pages[$page]->get_admin_page_name();
+					$page_runtime                   = 'return "'
+													  . $this->_caffeinated_extends[$this->_current_caf_extend_slug]["admin_page"]
+													  . '";';
+					$hook_function_path = create_function('$path_to_file', $path_runtime);
+					$hook_function_page = create_function('$admin_page', $page_runtime);
+					add_filter($path_hook, $hook_function_path);
+					add_filter($page_hook, $hook_function_page);
+					$extend = true;
+				}
+				//let's do the registered hooks
+				$extended_hooks = $this->_installed_pages[$page]->register_hooks($extend);
+				$hooks_ref      = array_merge($hooks_ref, $extended_hooks);
+			}
+		}
+		//the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
+		//first make sure we've got unique values
+		$hooks_ref = array_unique($hooks_ref);
+		//now let's loop and require!
+		foreach ($hooks_ref as $path) {
+			require_once($path);
+		}
+		//make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
+		global $ee_menu_slugs;
+		$ee_menu_slugs = $this->_menu_slugs;
+		//we need to loop again to run any early code
+		foreach ($installed_refs as $page => $path) {
+			if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+				$this->_installed_pages[$page]->do_initial_loads();
+			}
+		}
+		do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
+	}
+
+
+
+	/**
+	 * get_admin_page_object
+	 *
+	 * @param string $page_slug
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page_object($page_slug = '')
+	{
+		if (isset($this->_installed_pages[$page_slug])) {
+			return $this->_installed_pages[$page_slug]->loaded_page_object();
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * _get_classname_for_admin_page
+	 * generates an "Admin Page" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+	}
+
+
+
+	/**
+	 * _get_classname_for_admin_init_page
+	 * generates an "Admin Page Init" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_init_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+	}
+
+
+
+	/**
+	 * _load_admin_page
+	 * Loads and instantiates page_init object for a single EE_admin page.
+	 *
+	 * @param  string $page page_reference
+	 * @param string  $path
+	 * @throws EE_Error
+	 * @return object|bool  return page object if valid, bool false if not.
+	 */
+	private function _load_admin_page($page = '', $path = '')
+	{
+		$class_name = $this->_get_classname_for_admin_init_page($page);
+		EE_Registry::instance()->load_file($path, $class_name, 'core');
+		if (! class_exists($class_name)) {
+			$inner_error_msg = '<br />' . sprintf(
+					esc_html__(
+						'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+						'event_espresso'
+					),
+					'<strong>' . $class_name . '</strong>'
+				);
+			$error_msg[]     = sprintf(
+				__('Something went wrong with loading the %s admin page.', 'event_espresso'),
+				$page
+			);
+			$error_msg[]     = $error_msg[0]
+							   . "\r\n"
+							   . sprintf(
+								   esc_html__(
+									   'There is no Init class in place for the %s admin page.',
+									   'event_espresso'
+								   ),
+								   $page
+							   )
+							   . $inner_error_msg;
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		$a = new ReflectionClass($class_name);
+		return $a->newInstance();
+	}
+
+
+
+	/**
+	 * set_menus
+	 * This method sets up the menus for EE Admin Pages
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function set_menus()
+	{
+		//prep the menu pages (sort, group.)
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(false);
+			}
+		}
+	}
+
+
+	/**
+	 * set_network_menus
+	 * This method sets up the menus for network EE Admin Pages.
+	 * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
+	 * are only added to the menu map if they are intended for the admin menu
+	 *
+	 * @return void
+	 */
+	public function set_network_menus()
+	{
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(true);
+			}
+		}
+	}
+
+
+
+	/**
+	 * _prep_pages
+	 * sets the _prepped_menu_maps property
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _prep_pages()
+	{
+		$pages_array = array();
+		//rearrange _admin_menu_groups to be indexed by group slug.
+		$menu_groups = $this->_rearrange_menu_groups();
+		foreach ($this->_installed_pages as $page) {
+			if ($page instanceof EE_Admin_page_Init) {
+				$page_map = $page->get_menu_map();
+				//if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
+				if (is_array($page_map) || empty($page_map)) {
+					EE_Error::add_persistent_admin_notice(
+						'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+						sprintf(
+							__(
+								'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
+								'event_espresso'
+							),
+							$page->label
+						)
+					);
+					continue;
+				}
+				//if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
+				if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
+								'event_espresso'
+							),
+							$page->label,
+							$page_map
+						)
+					);
+				}
+				//use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
+				if (empty($page_map->maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level()
+					   == EE_Maintenance_Mode::level_2_complete_maintenance) {
+					continue;
+				}
+				//assign to group (remember $page_map has the admin page stored in it).
+				$pages_array[$page_map->menu_group][] = $page_map;
+			}
+		}
+		if (empty($pages_array)) {
+			throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
+		}
+		//let's sort the groups, make sure it's a valid group, add header (if to show).
+		foreach ($pages_array as $group => $menu_maps) {
+			//valid_group?
+			if (! array_key_exists($group, $menu_groups)) {
+				continue;
+			}
+			//sort pages.
+			usort($menu_maps, array($this, '_sort_menu_maps'));
+			//prepend header
+			array_unshift($menu_maps, $menu_groups[$group]);
+			//reset $pages_array with prepped data
+			$pages_array[$group] = $menu_maps;
+		}
+		//now let's setup the _prepped_menu_maps property
+		foreach ($menu_groups as $group => $group_objs) {
+			if (isset($pages_array[$group])) {
+				$this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[$group]);
+			}
+		}/**/
+	}
+
+
+
+	/**
+	 * This method is the "workhorse" for detecting and setting up caffeinated functionality.
+	 * In this method there are three checks being done:
+	 * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
+	 * array) etc.  (new page sets are found in caffeinated/new/{page})
+	 * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
+	 * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
+	 * Extend_Events_Admin_Page extends Events_Admin_Page.
+	 * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
+	 * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
+	 * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
+	 * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
+	 * admin_pages)
+	 *
+	 * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
+	 *                              loaded.
+	 * @return array
+	 */
+	private function _set_caffeinated($installed_refs)
+	{
+
+		//first let's check if there IS a caffeinated folder. If there is not then lets get out.
+		if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
+			return $installed_refs;
+		}
+		$this->_define_caffeinated_constants();
+		$exclude = array('tickets');
+		//okay let's setup an "New" pages first (we'll return installed refs later)
+		$new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+		if ($new_admin_screens) {
+			foreach ($new_admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different NEW EE admin pages
+					$installed_refs[basename($admin_screen)] = $admin_screen;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
+					//					$this->_caf_autoloader[] = array(
+					//						'dir' => 'new',
+					//						'folder' => basename( $admin_screen )
+					//					);
+				}
+			}
+		}
+		//let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
+		$extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+		if ($extends) {
+			foreach ($extends as $extend) {
+				if (is_dir($extend)) {
+					$extend_ref = basename($extend);
+					//now let's make sure there is a file that matches the expected format
+					$filename                                              = str_replace(
+						' ',
+						'_',
+						ucwords(
+							str_replace(
+								'_',
+								' ',
+								$extend_ref
+							)
+						)
+					);
+					$filename                                              = 'Extend_' . $filename . '_Admin_Page';
+					$this->_caffeinated_extends[$extend_ref]['path']       = str_replace(
+						array('\\', '/'),
+						DS,
+						EE_CORE_CAF_ADMIN
+						. 'extend'
+						. DS
+						. $extend_ref
+						. DS
+						. $filename
+						. '.core.php'
+					);
+					$this->_caffeinated_extends[$extend_ref]['admin_page'] = $filename;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
+					//					$this->_caf_autoloader[] = array(
+					//						'dir' => 'extend',
+					//						'folder' => $extend_ref
+					//					);
+				}
+			}
+		}
+		//let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
+		$ee_admin_hooks = array();
+		$hooks          = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+		if ($hooks) {
+			foreach ($hooks as $hook) {
+				if (is_readable($hook)) {
+					require_once $hook;
+					$classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+					$classname = str_replace('.class.php', '', $classname);
+					if (class_exists($classname)) {
+						$a                = new ReflectionClass($classname);
+						$ee_admin_hooks[] = $a->newInstance();
+					}
+				}
+			}
+		}/**/
+		$ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
+		return $installed_refs;
+	}
+
+
+
+
+
+	/**
+	 * Initial autoloader registration
+	 * This just sets up the autoloader for the root admin files
+	 *
+	 * @param  string $className incoming classname to check for autoload
+	 * @return void
+	 */
+	//	public function init_autoloaders( $className ) {
+	//		$dir_ref = array(
+	//			EE_ADMIN => array('core', 'class')
+	//		);
+	//		EEH_Autoloader::try_autoload($dir_ref, $className );
+	//	}
+	/**
+	 * This method takes care of setting up the autoloader dynamically for any NEW EE_Admin pages found in the
+	 * caffeinated folders.
+	 *
+	 * @access public
+	 * @param  string $className in coming classname being called
+	 * @return void
+	 */
+	//	public function caffeinated_autoloaders( $className ) {
+	//		//let's setup an array of paths to check (for each subsystem)
+	//		$dir_ref = array();
+	//		foreach ( $this->_caf_autoloader as $pathinfo) {
+	//			$dir_ref[ EE_CORE_CAF_ADMIN . $pathinfo['dir'] . DS . $pathinfo['folder'] . DS] = array('core', 'class');
+	//		}
+	//
+	//		EEH_Autoloader::try_autoload($dir_ref, $className );
+	//	}
+	/**
+	 * Utility method for sorting the _menu_maps (callback for usort php function)
+	 *
+	 * @since  4.4.0
+	 * @param  EE_Admin_Page_Menu_Map $a menu_map object
+	 * @param  EE_Admin_Page_Menu_Map $b being compared to
+	 * @return int    sort order
+	 */
+	private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
+	{
+		if ($a->menu_order == $b->menu_order) {
+			return 0;
+		}
+		return ($a->menu_order < $b->menu_order) ? -1 : 1;
+	}
+
+
+
+	/**
+	 * _default_header_link
+	 * This is just a dummy method to use with header submenu items
+	 *
+	 * @return bool false
+	 */
+	public function _default_header_link()
+	{
+		return false;
+	}
 
 
 }

Spacing +31 added lines, -31 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -140,13 +140,13 @@ 
      */
     private function _define_caffeinated_constants()
     {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+        if ( ! defined('EE_CORE_CAF_ADMIN')) {
+            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN.'new/');
+            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN.'extend/');
+            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL.'extend/');
+            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN.'hooks/');
         }
     }
 
@@ -259,7 +259,7 @@ 
         //first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
         usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
         foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
+            if ( ! $group instanceof EE_Admin_Page_Menu_Group) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -290,7 +290,7 @@ 
         $installed_refs = array();
         $exclude        = array('assets', 'templates');
         // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+        $admin_screens = glob(EE_ADMIN_PAGES.'*', GLOB_ONLYDIR);
         if ($admin_screens) {
             foreach ($admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
@@ -305,7 +305,7 @@ 
                 'There are no EE_Admin pages detected, it looks like EE did not install properly',
                 'event_espresso'
             );
-            $error_msg[] = $error_msg[0] . "\r\n" . sprintf(
+            $error_msg[] = $error_msg[0]."\r\n".sprintf(
                     __(
                         'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
                         'event_espresso'
@@ -317,7 +317,7 @@ 
         //this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
         $installed_refs = $this->_set_caffeinated($installed_refs);
         //allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        $installed_refs             = apply_filters(
+        $installed_refs = apply_filters(
             'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
             $installed_refs
         );
@@ -334,7 +334,7 @@ 
             $this->_installed_pages[$page] = $this->_load_admin_page($page, $path);
             // verify returned object
             if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+                if ( ! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
                     continue;
                 }
                 //skip if in full maintenance mode and maintenance_mode_parent is set
@@ -362,7 +362,7 @@ 
                                                       . $this->_installed_pages[$page]->get_menu_map()->menu_slug
                                                       . '_'
                                                       . $this->_installed_pages[$page]->get_admin_page_name();
-                    $page_runtime                   = 'return "'
+                    $page_runtime = 'return "'
                                                       . $this->_caffeinated_extends[$this->_current_caf_extend_slug]["admin_page"]
                                                       . '";';
                     $hook_function_path = create_function('$path_to_file', $path_runtime);
@@ -423,7 +423,7 @@ 
     private function _get_classname_for_admin_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page';
     }
 
 
@@ -438,7 +438,7 @@ 
     private function _get_classname_for_admin_init_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page_Init';
     }
 
 
@@ -456,19 +456,19 @@ 
     {
         $class_name = $this->_get_classname_for_admin_init_page($page);
         EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
-            $inner_error_msg = '<br />' . sprintf(
+        if ( ! class_exists($class_name)) {
+            $inner_error_msg = '<br />'.sprintf(
                     esc_html__(
                         'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
                         'event_espresso'
                     ),
-                    '<strong>' . $class_name . '</strong>'
+                    '<strong>'.$class_name.'</strong>'
                 );
-            $error_msg[]     = sprintf(
+            $error_msg[] = sprintf(
                 __('Something went wrong with loading the %s admin page.', 'event_espresso'),
                 $page
             );
-            $error_msg[]     = $error_msg[0]
+            $error_msg[] = $error_msg[0]
                                . "\r\n"
                                . sprintf(
                                    esc_html__(
@@ -544,7 +544,7 @@ 
                 //if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
                 if (is_array($page_map) || empty($page_map)) {
                     EE_Error::add_persistent_admin_notice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+                        'menu_map_warning_'.str_replace(' ', '_', $page->label).'_'.EVENT_ESPRESSO_VERSION,
                         sprintf(
                             __(
                                 'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
@@ -556,7 +556,7 @@ 
                     continue;
                 }
                 //if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+                if ( ! $page_map instanceof EE_Admin_Page_Menu_Map) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -584,7 +584,7 @@ 
         //let's sort the groups, make sure it's a valid group, add header (if to show).
         foreach ($pages_array as $group => $menu_maps) {
             //valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
+            if ( ! array_key_exists($group, $menu_groups)) {
                 continue;
             }
             //sort pages.
@@ -626,13 +626,13 @@ 
     {
 
         //first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated' . DS . 'admin') || (defined('EE_DECAF') && EE_DECAF)) {
+        if ( ! is_dir(EE_PLUGIN_DIR_PATH.'caffeinated'.DS.'admin') || (defined('EE_DECAF') && EE_DECAF)) {
             return $installed_refs;
         }
         $this->_define_caffeinated_constants();
         $exclude = array('tickets');
         //okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+        $new_admin_screens = glob(EE_CORE_CAF_ADMIN.'new/*', GLOB_ONLYDIR);
         if ($new_admin_screens) {
             foreach ($new_admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
@@ -649,13 +649,13 @@ 
             }
         }
         //let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+        $extends = glob(EE_CORE_CAF_ADMIN.'extend/*', GLOB_ONLYDIR);
         if ($extends) {
             foreach ($extends as $extend) {
                 if (is_dir($extend)) {
                     $extend_ref = basename($extend);
                     //now let's make sure there is a file that matches the expected format
-                    $filename                                              = str_replace(
+                    $filename = str_replace(
                         ' ',
                         '_',
                         ucwords(
@@ -666,7 +666,7 @@ 
                             )
                         )
                     );
-                    $filename                                              = 'Extend_' . $filename . '_Admin_Page';
+                    $filename                                              = 'Extend_'.$filename.'_Admin_Page';
                     $this->_caffeinated_extends[$extend_ref]['path']       = str_replace(
                         array('\\', '/'),
                         DS,
@@ -690,12 +690,12 @@ 
         }
         //let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
         $ee_admin_hooks = array();
-        $hooks          = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+        $hooks          = glob(EE_CORE_CAF_ADMIN.'hooks/*.class.php');
         if ($hooks) {
             foreach ($hooks as $hook) {
                 if (is_readable($hook)) {
                     require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+                    $classname = str_replace(EE_CORE_CAF_ADMIN.'hooks/', '', $hook);
                     $classname = str_replace('.class.php', '', $classname);
                     if (class_exists($classname)) {
                         $a                = new ReflectionClass($classname);

core/db_classes/EE_Message.class.php

Indentation +860 added lines, -860 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -12,869 +12,869 @@ 
 class EE_Message extends EE_Base_Class implements EEI_Admin_Links
 {
 
-    /**
-     * @deprecated 4.9.0  Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_pack;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_variation;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type string
-     */
-    public $content = '';
-
-
-    /**
-     * @type EE_messenger $_messenger
-     */
-    protected $_messenger = null;
-
-    /**
-     * @type EE_message_type $_message_type
-     */
-    protected $_message_type = null;
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
-     *                             format.
-     * @return EE_Message
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        //if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if ( ! $has_object) {
-            EE_Registry::instance()->load_helper('URL');
-            $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
-        }
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets MSG_token
-     *
-     * @return int
-     */
-    public function MSG_token()
-    {
-        return $this->get('MSG_token');
-    }
-
-
-    /**
-     * Sets MSG_token
-     *
-     * @param int $MSG_token
-     */
-    public function set_MSG_token($MSG_token)
-    {
-        $this->set('MSG_token', $MSG_token);
-    }
-
-
-    /**
-     * Gets GRP_ID
-     *
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * Sets GRP_ID
-     *
-     * @param int $GRP_ID
-     */
-    public function set_GRP_ID($GRP_ID)
-    {
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets messenger
-     *
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get('MSG_messenger');
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param string $messenger
-     */
-    public function set_messenger($messenger)
-    {
-        $this->set('MSG_messenger', $messenger);
-    }
-
-
-    /**
-     * Returns corresponding messenger object for the set messenger on this message
-     *
-     * @return EE_messenger | null
-     */
-    public function messenger_object()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param EE_messenger $messenger
-     */
-    public function set_messenger_object(EE_messenger $messenger)
-    {
-        $this->_messenger = $messenger;
-    }
-
-
-    /**
-     * validates messenger
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_messenger($throw_exceptions = false)
-    {
-        if ($this->_messenger instanceof EE_messenger) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->messenger()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * This returns the set localized label for the messenger on this message.
-     * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function messenger_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $messenger  = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[$label_type] : $this->messenger();
-    }
-
-
-    /**
-     * Gets message_type
-     *
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get('MSG_message_type');
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param string $message_type
-     */
-    public function set_message_type($message_type)
-    {
-        $this->set('MSG_message_type', $message_type);
-    }
-
-
-    /**
-     * Returns the message type object for the set message type on this message
-     *
-     * @return EE_message_type | null
-     */
-    public function message_type_object()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param EE_message_type $message_type
-     * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
-     *                                        the message type or not.
-     */
-    public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
-    {
-        $this->_message_type = $message_type;
-        if ($set_priority) {
-            $this->set_priority($this->_message_type->get_priority());
-        }
-    }
-
-
-    /**
-     * validates message_type
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_message_type($throw_exceptions = false)
-    {
-        if ($this->_message_type instanceof EE_message_type) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->message_type()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_valid($throw_exceptions = false)
-    {
-        if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * This validates whether the internal messenger and message type objects are valid for sending.
-     * Three checks are done:
-     * 1. There is a valid messenger object.
-     * 2. There is a valid message type object.
-     * 3. The message type object is active for the messenger.
-     *
-     * @throws EE_Error  But only if $throw_exceptions is set to true.
-     * @param bool $throw_exceptions
-     * @return bool
-     */
-    public function is_valid_for_sending_or_generation($throw_exceptions = false)
-    {
-        $valid = false;
-        if ($this->is_valid($throw_exceptions)) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $valid                    = $message_resource_manager->is_message_type_active_for_messenger($this->messenger(),
-                $this->message_type());
-            if ( ! $valid && $throw_exceptions) {
-                throw new EE_Error(
-                    sprintf(
-                        __('The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
-                            'event_espresso'),
-                        $this->message_type(),
-                        $this->messenger()
-                    )
-                );
-            }
-        }
-        return $valid;
-    }
-
-
-    /**
-     * This returns the set localized label for the message type on this message.
-     * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function message_type_label($plural = false)
-    {
-        $label_type   = $plural ? 'plural' : 'singular';
-        $message_type = $this->message_type_object();
-        return $message_type instanceof EE_message_type ? $message_type->label[$label_type] : str_replace(
-            '_',
-            ' ',
-            $this->message_type()
-        );
-    }
-
-
-    /**
-     * Gets context
-     *
-     * @return string
-     */
-    public function context()
-    {
-        return $this->get('MSG_context');
-    }
-
-
-    /**
-     * This returns the corresponding localized label for the given context slug, if possible from installed message
-     * types. Otherwise, this will just return the set context slug on this object.
-     *
-     * @return string
-     */
-    public function context_label()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $contexts                 = $message_resource_manager->get_all_contexts();
-        return isset($contexts[$this->context()]) ? $contexts[$this->context()] : $this->context();
-    }
-
-
-    /**
-     * Sets context
-     *
-     * @param string $context
-     */
-    public function set_context($context)
-    {
-        $this->set('MSG_context', $context);
-    }
-
-
-    /**
-     * Gets recipient_ID
-     *
-     * @return int
-     */
-    public function recipient_ID()
-    {
-        return $this->get('MSG_recipient_ID');
-    }
-
-
-    /**
-     * Sets recipient_ID
-     *
-     * @param string $recipient_ID
-     */
-    public function set_recipient_ID($recipient_ID)
-    {
-        $this->set('MSG_recipient_ID', $recipient_ID);
-    }
-
-
-    /**
-     * Gets recipient_type
-     *
-     * @return string
-     */
-    public function recipient_type()
-    {
-        return $this->get('MSG_recipient_type');
-    }
-
-
-    /**
-     * Return the related object matching the recipient type and ID.
-     *
-     * @return EE_Base_Class | null
-     */
-    public function recipient_object()
-    {
-        if ( ! $this->recipient_type() || ! $this->recipient_ID()) {
-            return null;
-        }
-
-        return $this->get_first_related($this->recipient_type());
-    }
-
-
-    /**
-     * Sets recipient_type
-     *
-     * @param string $recipient_type
-     */
-    public function set_recipient_type($recipient_type)
-    {
-        $this->set('MSG_recipient_type', $recipient_type);
-    }
-
-
-    /**
-     * Gets content
-     *
-     * @return string
-     */
-    public function content()
-    {
-        return $this->get('MSG_content');
-    }
-
-
-    /**
-     * Sets content
-     *
-     * @param string $content
-     */
-    public function set_content($content)
-    {
-        $this->set('MSG_content', $content);
-    }
-
-
-    /**
-     * Gets subject
-     *
-     * @return string
-     */
-    public function subject()
-    {
-        return $this->get('MSG_subject');
-    }
-
-
-    /**
-     * Sets subject
-     *
-     * @param string $subject
-     */
-    public function set_subject($subject)
-    {
-        $this->set('MSG_subject', $subject);
-    }
-
-
-    /**
-     * Gets to
-     *
-     * @return string
-     */
-    public function to()
-    {
-        $to = $this->get('MSG_to');
-        return empty($to) ? __('No recipient', 'event_espresso') : $to;
-    }
-
-
-    /**
-     * Sets to
-     *
-     * @param string $to
-     */
-    public function set_to($to)
-    {
-        $this->set('MSG_to', $to);
-    }
-
-
-    /**
-     * Gets from
-     *
-     * @return string
-     */
-    public function from()
-    {
-        return $this->get('MSG_from');
-    }
-
-
-    /**
-     * Sets from
-     *
-     * @param string $from
-     */
-    public function set_from($from)
-    {
-        $this->set('MSG_from', $from);
-    }
-
-
-    /**
-     * Gets priority
-     *
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->get('MSG_priority');
-    }
-
-
-    /**
-     * Sets priority
-     * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
-     * this method calls the send_now method to verify that.
-     *
-     * @param int $priority
-     */
-    public function set_priority($priority)
-    {
-        $priority = $this->send_now() ? EEM_Message::priority_high : $priority;
-        parent::set('MSG_priority', $priority);
-    }
-
-
-    /**
-     * Overrides parent::set method so we can capture any sets for priority.
-     *
-     * @see parent::set() for phpdocs
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'MSG_priority') {
-            $this->set_priority($field_value);
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function send_now()
-    {
-        $send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high : $this->priority();
-        return $send_now === EEM_Message::priority_high ? true : false;
-    }
-
-
-    /**
-     * Gets STS_ID
-     *
-     * @return string
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Sets STS_ID
-     *
-     * @param string $STS_ID
-     */
-    public function set_STS_ID($STS_ID)
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Gets created
-     *
-     * @return string
-     */
-    public function created()
-    {
-        return $this->get('MSG_created');
-    }
-
-
-    /**
-     * Sets created
-     *
-     * @param string $created
-     */
-    public function set_created($created)
-    {
-        $this->set('MSG_created', $created);
-    }
-
-
-    /**
-     * Gets modified
-     *
-     * @return string
-     */
-    public function modified()
-    {
-        return $this->get('MSG_modified');
-    }
-
-
-    /**
-     * Sets modified
-     *
-     * @param string $modified
-     */
-    public function set_modified($modified)
-    {
-        $this->set('MSG_modified', $modified);
-    }
-
-
-    /**
-     * Sets generation data for this message.
-     *
-     * @param mixed $data
-     */
-    public function set_generation_data($data)
-    {
-        $this->set_field_or_extra_meta('MSG_generation_data', $data);
-    }
-
-
-    /**
-     * Returns any set generation data for this message.
-     *
-     * @return mixed|null
-     */
-    public function get_generation_data()
-    {
-        return $this->get_field_or_extra_meta('MSG_generation_data');
-    }
-
-
-    /**
-     * Gets any error message.
-     *
-     * @return mixed|null
-     */
-    public function error_message()
-    {
-        return $this->get_field_or_extra_meta('MSG_error');
-    }
-
-
-    /**
-     * Sets an error message.
-     *
-     * @param $message
-     * @return bool|int
-     */
-    public function set_error_message($message)
-    {
-        return $this->set_field_or_extra_meta('MSG_error', $message);
-    }
-
-
-    /**
-     * This retrieves the associated template pack with this message.
-     *
-     * @return EE_Messages_Template_Pack | null
-     */
-    public function get_template_pack()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if ( ! empty($this->template_pack)) {
-            return $this->template_pack;
-        }
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-        //if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if ( ! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
-    }
-
-
-    /**
-     * Retrieves the variation used for generating this message.
-     *
-     * @return string
-     */
-    public function get_template_pack_variation()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if ( ! empty($this->template_variation)) {
-            return $this->template_variation;
-        }
-
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-
-        //if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if ( ! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        EE_Registry::instance()->load_helper('MSG_Template');
-        switch ($this->STS_ID()) {
-            case EEM_Message::status_failed :
-            case EEM_Message::status_debug_only :
-                return EEH_MSG_Template::generate_error_display_trigger($this);
-                break;
-
-            case EEM_Message::status_sent :
-                return EEH_MSG_Template::generate_browser_trigger($this);
-                break;
-
-            default :
-                return '';
-        }
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
-     * it.
-     * Note this also SAVES the current message object to the db because it adds an error message to accompany the status.
-     *
-     */
-    public function set_messenger_is_executing()
-    {
-        $this->set_STS_ID( EEM_Message::status_messenger_executing );
-        $this->set_error_message(
-            esc_html__(
-                'A message with this status indicates that there was a problem that occurred while the message was being
+	/**
+	 * @deprecated 4.9.0  Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_pack;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_variation;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type string
+	 */
+	public $content = '';
+
+
+	/**
+	 * @type EE_messenger $_messenger
+	 */
+	protected $_messenger = null;
+
+	/**
+	 * @type EE_message_type $_message_type
+	 */
+	protected $_message_type = null;
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
+	 *                             format.
+	 * @return EE_Message
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		//if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
+		if ( ! $has_object) {
+			EE_Registry::instance()->load_helper('URL');
+			$props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
+		}
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets MSG_token
+	 *
+	 * @return int
+	 */
+	public function MSG_token()
+	{
+		return $this->get('MSG_token');
+	}
+
+
+	/**
+	 * Sets MSG_token
+	 *
+	 * @param int $MSG_token
+	 */
+	public function set_MSG_token($MSG_token)
+	{
+		$this->set('MSG_token', $MSG_token);
+	}
+
+
+	/**
+	 * Gets GRP_ID
+	 *
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * Sets GRP_ID
+	 *
+	 * @param int $GRP_ID
+	 */
+	public function set_GRP_ID($GRP_ID)
+	{
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets messenger
+	 *
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get('MSG_messenger');
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param string $messenger
+	 */
+	public function set_messenger($messenger)
+	{
+		$this->set('MSG_messenger', $messenger);
+	}
+
+
+	/**
+	 * Returns corresponding messenger object for the set messenger on this message
+	 *
+	 * @return EE_messenger | null
+	 */
+	public function messenger_object()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param EE_messenger $messenger
+	 */
+	public function set_messenger_object(EE_messenger $messenger)
+	{
+		$this->_messenger = $messenger;
+	}
+
+
+	/**
+	 * validates messenger
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_messenger($throw_exceptions = false)
+	{
+		if ($this->_messenger instanceof EE_messenger) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->messenger()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * This returns the set localized label for the messenger on this message.
+	 * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function messenger_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$messenger  = $this->messenger_object();
+		return $messenger instanceof EE_messenger ? $messenger->label[$label_type] : $this->messenger();
+	}
+
+
+	/**
+	 * Gets message_type
+	 *
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get('MSG_message_type');
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param string $message_type
+	 */
+	public function set_message_type($message_type)
+	{
+		$this->set('MSG_message_type', $message_type);
+	}
+
+
+	/**
+	 * Returns the message type object for the set message type on this message
+	 *
+	 * @return EE_message_type | null
+	 */
+	public function message_type_object()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param EE_message_type $message_type
+	 * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
+	 *                                        the message type or not.
+	 */
+	public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
+	{
+		$this->_message_type = $message_type;
+		if ($set_priority) {
+			$this->set_priority($this->_message_type->get_priority());
+		}
+	}
+
+
+	/**
+	 * validates message_type
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type($throw_exceptions = false)
+	{
+		if ($this->_message_type instanceof EE_message_type) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->message_type()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_valid($throw_exceptions = false)
+	{
+		if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * This validates whether the internal messenger and message type objects are valid for sending.
+	 * Three checks are done:
+	 * 1. There is a valid messenger object.
+	 * 2. There is a valid message type object.
+	 * 3. The message type object is active for the messenger.
+	 *
+	 * @throws EE_Error  But only if $throw_exceptions is set to true.
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 */
+	public function is_valid_for_sending_or_generation($throw_exceptions = false)
+	{
+		$valid = false;
+		if ($this->is_valid($throw_exceptions)) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$valid                    = $message_resource_manager->is_message_type_active_for_messenger($this->messenger(),
+				$this->message_type());
+			if ( ! $valid && $throw_exceptions) {
+				throw new EE_Error(
+					sprintf(
+						__('The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
+							'event_espresso'),
+						$this->message_type(),
+						$this->messenger()
+					)
+				);
+			}
+		}
+		return $valid;
+	}
+
+
+	/**
+	 * This returns the set localized label for the message type on this message.
+	 * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function message_type_label($plural = false)
+	{
+		$label_type   = $plural ? 'plural' : 'singular';
+		$message_type = $this->message_type_object();
+		return $message_type instanceof EE_message_type ? $message_type->label[$label_type] : str_replace(
+			'_',
+			' ',
+			$this->message_type()
+		);
+	}
+
+
+	/**
+	 * Gets context
+	 *
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->get('MSG_context');
+	}
+
+
+	/**
+	 * This returns the corresponding localized label for the given context slug, if possible from installed message
+	 * types. Otherwise, this will just return the set context slug on this object.
+	 *
+	 * @return string
+	 */
+	public function context_label()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$contexts                 = $message_resource_manager->get_all_contexts();
+		return isset($contexts[$this->context()]) ? $contexts[$this->context()] : $this->context();
+	}
+
+
+	/**
+	 * Sets context
+	 *
+	 * @param string $context
+	 */
+	public function set_context($context)
+	{
+		$this->set('MSG_context', $context);
+	}
+
+
+	/**
+	 * Gets recipient_ID
+	 *
+	 * @return int
+	 */
+	public function recipient_ID()
+	{
+		return $this->get('MSG_recipient_ID');
+	}
+
+
+	/**
+	 * Sets recipient_ID
+	 *
+	 * @param string $recipient_ID
+	 */
+	public function set_recipient_ID($recipient_ID)
+	{
+		$this->set('MSG_recipient_ID', $recipient_ID);
+	}
+
+
+	/**
+	 * Gets recipient_type
+	 *
+	 * @return string
+	 */
+	public function recipient_type()
+	{
+		return $this->get('MSG_recipient_type');
+	}
+
+
+	/**
+	 * Return the related object matching the recipient type and ID.
+	 *
+	 * @return EE_Base_Class | null
+	 */
+	public function recipient_object()
+	{
+		if ( ! $this->recipient_type() || ! $this->recipient_ID()) {
+			return null;
+		}
+
+		return $this->get_first_related($this->recipient_type());
+	}
+
+
+	/**
+	 * Sets recipient_type
+	 *
+	 * @param string $recipient_type
+	 */
+	public function set_recipient_type($recipient_type)
+	{
+		$this->set('MSG_recipient_type', $recipient_type);
+	}
+
+
+	/**
+	 * Gets content
+	 *
+	 * @return string
+	 */
+	public function content()
+	{
+		return $this->get('MSG_content');
+	}
+
+
+	/**
+	 * Sets content
+	 *
+	 * @param string $content
+	 */
+	public function set_content($content)
+	{
+		$this->set('MSG_content', $content);
+	}
+
+
+	/**
+	 * Gets subject
+	 *
+	 * @return string
+	 */
+	public function subject()
+	{
+		return $this->get('MSG_subject');
+	}
+
+
+	/**
+	 * Sets subject
+	 *
+	 * @param string $subject
+	 */
+	public function set_subject($subject)
+	{
+		$this->set('MSG_subject', $subject);
+	}
+
+
+	/**
+	 * Gets to
+	 *
+	 * @return string
+	 */
+	public function to()
+	{
+		$to = $this->get('MSG_to');
+		return empty($to) ? __('No recipient', 'event_espresso') : $to;
+	}
+
+
+	/**
+	 * Sets to
+	 *
+	 * @param string $to
+	 */
+	public function set_to($to)
+	{
+		$this->set('MSG_to', $to);
+	}
+
+
+	/**
+	 * Gets from
+	 *
+	 * @return string
+	 */
+	public function from()
+	{
+		return $this->get('MSG_from');
+	}
+
+
+	/**
+	 * Sets from
+	 *
+	 * @param string $from
+	 */
+	public function set_from($from)
+	{
+		$this->set('MSG_from', $from);
+	}
+
+
+	/**
+	 * Gets priority
+	 *
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->get('MSG_priority');
+	}
+
+
+	/**
+	 * Sets priority
+	 * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
+	 * this method calls the send_now method to verify that.
+	 *
+	 * @param int $priority
+	 */
+	public function set_priority($priority)
+	{
+		$priority = $this->send_now() ? EEM_Message::priority_high : $priority;
+		parent::set('MSG_priority', $priority);
+	}
+
+
+	/**
+	 * Overrides parent::set method so we can capture any sets for priority.
+	 *
+	 * @see parent::set() for phpdocs
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'MSG_priority') {
+			$this->set_priority($field_value);
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function send_now()
+	{
+		$send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high : $this->priority();
+		return $send_now === EEM_Message::priority_high ? true : false;
+	}
+
+
+	/**
+	 * Gets STS_ID
+	 *
+	 * @return string
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Sets STS_ID
+	 *
+	 * @param string $STS_ID
+	 */
+	public function set_STS_ID($STS_ID)
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Gets created
+	 *
+	 * @return string
+	 */
+	public function created()
+	{
+		return $this->get('MSG_created');
+	}
+
+
+	/**
+	 * Sets created
+	 *
+	 * @param string $created
+	 */
+	public function set_created($created)
+	{
+		$this->set('MSG_created', $created);
+	}
+
+
+	/**
+	 * Gets modified
+	 *
+	 * @return string
+	 */
+	public function modified()
+	{
+		return $this->get('MSG_modified');
+	}
+
+
+	/**
+	 * Sets modified
+	 *
+	 * @param string $modified
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('MSG_modified', $modified);
+	}
+
+
+	/**
+	 * Sets generation data for this message.
+	 *
+	 * @param mixed $data
+	 */
+	public function set_generation_data($data)
+	{
+		$this->set_field_or_extra_meta('MSG_generation_data', $data);
+	}
+
+
+	/**
+	 * Returns any set generation data for this message.
+	 *
+	 * @return mixed|null
+	 */
+	public function get_generation_data()
+	{
+		return $this->get_field_or_extra_meta('MSG_generation_data');
+	}
+
+
+	/**
+	 * Gets any error message.
+	 *
+	 * @return mixed|null
+	 */
+	public function error_message()
+	{
+		return $this->get_field_or_extra_meta('MSG_error');
+	}
+
+
+	/**
+	 * Sets an error message.
+	 *
+	 * @param $message
+	 * @return bool|int
+	 */
+	public function set_error_message($message)
+	{
+		return $this->set_field_or_extra_meta('MSG_error', $message);
+	}
+
+
+	/**
+	 * This retrieves the associated template pack with this message.
+	 *
+	 * @return EE_Messages_Template_Pack | null
+	 */
+	public function get_template_pack()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if ( ! empty($this->template_pack)) {
+			return $this->template_pack;
+		}
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+		//if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if ( ! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
+	}
+
+
+	/**
+	 * Retrieves the variation used for generating this message.
+	 *
+	 * @return string
+	 */
+	public function get_template_pack_variation()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if ( ! empty($this->template_variation)) {
+			return $this->template_variation;
+		}
+
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+
+		//if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if ( ! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		EE_Registry::instance()->load_helper('MSG_Template');
+		switch ($this->STS_ID()) {
+			case EEM_Message::status_failed :
+			case EEM_Message::status_debug_only :
+				return EEH_MSG_Template::generate_error_display_trigger($this);
+				break;
+
+			case EEM_Message::status_sent :
+				return EEH_MSG_Template::generate_browser_trigger($this);
+				break;
+
+			default :
+				return '';
+		}
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
+	 * it.
+	 * Note this also SAVES the current message object to the db because it adds an error message to accompany the status.
+	 *
+	 */
+	public function set_messenger_is_executing()
+	{
+		$this->set_STS_ID( EEM_Message::status_messenger_executing );
+		$this->set_error_message(
+			esc_html__(
+				'A message with this status indicates that there was a problem that occurred while the message was being
                 processed by the messenger.  It is still possible that the message was sent successfully, but at some
                 point during the processing there was a failure.  This usually is indicative of a timeout issue with PHP 
                 or memory limits being reached.  If you see this repeatedly you may want to consider upgrading the memory 
                 available to PHP on your server.',
-                'event_espresso'
-            )
-        );
-    }
+				'event_espresso'
+			)
+		);
+	}
 }
 /* End of file EE_Message.class.php */
 /* Location: /core/db_classes/EE_Message.class.php */
\ No newline at end of file

acceptance_tests/Helpers/BaseCoreAdmin.php

Indentation +59 added lines, -59 removed lines

@@ -13,72 +13,72 @@
 trait BaseCoreAdmin
 {
 
-    /**
-     * Core method for going to an Event Espresso Admin page.
-     * @param string $page
-     * @param string $action
-     * @param string $additional_params
-     */
-    public function amOnEventEspressoAdminPage($page = '', $action = '', $additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(CoreAdmin::adminUrl($page, $action, $additional_params));
-    }
+	/**
+	 * Core method for going to an Event Espresso Admin page.
+	 * @param string $page
+	 * @param string $action
+	 * @param string $additional_params
+	 */
+	public function amOnEventEspressoAdminPage($page = '', $action = '', $additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(CoreAdmin::adminUrl($page, $action, $additional_params));
+	}
 
 
-    /**
-     * Helper method for returning an instance of the Actor.  Intended to help with IDE fill out of methods.
-     * @return \EventEspressoAcceptanceTester;
-     */
-    protected function actor()
-    {
-        /** @var \EventEspressoAcceptanceTester $this */
-        return $this;
-    }
+	/**
+	 * Helper method for returning an instance of the Actor.  Intended to help with IDE fill out of methods.
+	 * @return \EventEspressoAcceptanceTester;
+	 */
+	protected function actor()
+	{
+		/** @var \EventEspressoAcceptanceTester $this */
+		return $this;
+	}
 
 
-    /**
-     * Use this to set the per page option for a list table page.
-     * Assumes you are on a page that has this field exposed.
-     *
-     * @param int|string $per_page_value
-     * @throws \Codeception\Exception\TestRuntimeException
-     */
-    public function setPerPageOptionForScreen($per_page_value)
-    {
-        $this->actor()->click(CoreAdmin::WP_SCREEN_SETTINGS_LINK_SELECTOR);
-        $this->actor()->fillField(CoreAdmin::WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR, $per_page_value);
-        $this->actor()->click(CoreAdmin::WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR);
-        $this->actor()->wait(8);
-    }
+	/**
+	 * Use this to set the per page option for a list table page.
+	 * Assumes you are on a page that has this field exposed.
+	 *
+	 * @param int|string $per_page_value
+	 * @throws \Codeception\Exception\TestRuntimeException
+	 */
+	public function setPerPageOptionForScreen($per_page_value)
+	{
+		$this->actor()->click(CoreAdmin::WP_SCREEN_SETTINGS_LINK_SELECTOR);
+		$this->actor()->fillField(CoreAdmin::WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR, $per_page_value);
+		$this->actor()->click(CoreAdmin::WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR);
+		$this->actor()->wait(8);
+	}
 
 
 
-    /**
-     * Use this to append a given value to a wpEditor instance.
-     * How it works is it first switched the instance to the text (or html) view so that the textarea is exposed and
-     * the value is added to the text area.
-     *
-     * @param $field_reference
-     * @param $value
-     * @throws \Codeception\Exception\ElementNotFound
-     */
-    public function appendToWPEditorField($field_reference, $value)
-    {
-        $this->actor()->click(CoreAdmin::wpEditorTextTabSelector($field_reference));
-        $this->actor()->appendField(CoreAdmin::wpEditorTextAreaSelector($field_reference), $value);
-    }
+	/**
+	 * Use this to append a given value to a wpEditor instance.
+	 * How it works is it first switched the instance to the text (or html) view so that the textarea is exposed and
+	 * the value is added to the text area.
+	 *
+	 * @param $field_reference
+	 * @param $value
+	 * @throws \Codeception\Exception\ElementNotFound
+	 */
+	public function appendToWPEditorField($field_reference, $value)
+	{
+		$this->actor()->click(CoreAdmin::wpEditorTextTabSelector($field_reference));
+		$this->actor()->appendField(CoreAdmin::wpEditorTextAreaSelector($field_reference), $value);
+	}
 
 
-    /**
-     * Use to select and submit the given bulk action.
-     * @param string $bulk_action_option
-     */
-    public function submitBulkActionOnListTable($bulk_action_option)
-    {
-        $this->actor()->selectOption(
-            CoreAdmin::SELECTOR_LIST_TABLE_BULK_ACTION_FIELD,
-            $bulk_action_option
-        );
-        $this->actor()->click(CoreAdmin::SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY);
-    }
+	/**
+	 * Use to select and submit the given bulk action.
+	 * @param string $bulk_action_option
+	 */
+	public function submitBulkActionOnListTable($bulk_action_option)
+	{
+		$this->actor()->selectOption(
+			CoreAdmin::SELECTOR_LIST_TABLE_BULK_ACTION_FIELD,
+			$bulk_action_option
+		);
+		$this->actor()->click(CoreAdmin::SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY);
+	}
 }

acceptance_tests/Helpers/RegistrationsAdmin.php

Indentation +24 added lines, -24 removed lines

@@ -13,30 +13,30 @@
 trait RegistrationsAdmin
 {
 
-    /**
-     * This will select all checkboxes on a registration list table for the given array of
-     * registration ids.
-     * Assumes the actor is on a list table page for registrations.
-     * @param $registration_ids
-     */
-    public function selectBulkActionCheckboxesForRegistrationIds(array $registration_ids)
-    {
-        foreach ($registration_ids as $registration_id) {
-            $this->actor()->checkOption(
-                RegistrationsAdminPage::listTableCheckBoxSelectorForRegistrationId($registration_id)
-            );
-        }
-    }
+	/**
+	 * This will select all checkboxes on a registration list table for the given array of
+	 * registration ids.
+	 * Assumes the actor is on a list table page for registrations.
+	 * @param $registration_ids
+	 */
+	public function selectBulkActionCheckboxesForRegistrationIds(array $registration_ids)
+	{
+		foreach ($registration_ids as $registration_id) {
+			$this->actor()->checkOption(
+				RegistrationsAdminPage::listTableCheckBoxSelectorForRegistrationId($registration_id)
+			);
+		}
+	}
 
 
-    /**
-     * Navigates the actor to the default registration list table page.
-     * @param string $additional_params
-     */
-    public function amOnDefaultRegistrationsListTableAdminPage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(
-            RegistrationsAdminPage::registrationsDefaultAdminListTableUrl($additional_params)
-        );
-    }
+	/**
+	 * Navigates the actor to the default registration list table page.
+	 * @param string $additional_params
+	 */
+	public function amOnDefaultRegistrationsListTableAdminPage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(
+			RegistrationsAdminPage::registrationsDefaultAdminListTableUrl($additional_params)
+		);
+	}
 }
\ No newline at end of file

acceptance_tests/Helpers/Checkout.php

Indentation +57 added lines, -57 removed lines

@@ -13,70 +13,70 @@
  */
 trait Checkout
 {
-    /**
-     * @param     $value
-     * @param int $attendee_number
-     */
-    public function fillOutFirstNameFieldForAttendee($value, $attendee_number = 1)
-    {
-        $this->actor()->fillField(CheckoutPage::firstNameFieldSelectorForAttendeeNumber($attendee_number), $value);
-    }
+	/**
+	 * @param     $value
+	 * @param int $attendee_number
+	 */
+	public function fillOutFirstNameFieldForAttendee($value, $attendee_number = 1)
+	{
+		$this->actor()->fillField(CheckoutPage::firstNameFieldSelectorForAttendeeNumber($attendee_number), $value);
+	}
 
-    /**
-     * @param     $value
-     * @param int $attendee_number
-     */
-    public function fillOutLastNameFieldForAttendee($value, $attendee_number = 1)
-    {
-        $this->actor()->fillField(CheckoutPage::lastNameFieldSelectorForAttendeeNumber($attendee_number), $value);
-    }
+	/**
+	 * @param     $value
+	 * @param int $attendee_number
+	 */
+	public function fillOutLastNameFieldForAttendee($value, $attendee_number = 1)
+	{
+		$this->actor()->fillField(CheckoutPage::lastNameFieldSelectorForAttendeeNumber($attendee_number), $value);
+	}
 
-    /**
-     * @param     $value
-     * @param int $attendee_number
-     */
-    public function fillOutEmailFieldForAttendee($value, $attendee_number = 1)
-    {
-        $this->actor()->fillField(CheckoutPage::emailFieldSelectorForAttendeeNumber($attendee_number), $value);
-    }
+	/**
+	 * @param     $value
+	 * @param int $attendee_number
+	 */
+	public function fillOutEmailFieldForAttendee($value, $attendee_number = 1)
+	{
+		$this->actor()->fillField(CheckoutPage::emailFieldSelectorForAttendeeNumber($attendee_number), $value);
+	}
 
 
-    /**
-     * Clicks the next registration step button.
-     */
-    public function goToNextRegistrationStep()
-    {
-        $this->actor()->click(CheckoutPage::NEXT_STEP_BUTTON_SELECTOR);
-    }
+	/**
+	 * Clicks the next registration step button.
+	 */
+	public function goToNextRegistrationStep()
+	{
+		$this->actor()->click(CheckoutPage::NEXT_STEP_BUTTON_SELECTOR);
+	}
 
 
-    /**
-     * Selects the payment option for the given payment method slug.
-     *
-     * @param string $payment_method_slug
-     * @param bool   $verify_selected      If true, this will wait for the "Important Information" info box after the
-     *                                     payment option select box is complete.  Otherwise its up to calling code to
-     *                                     wait for whatever is needed after selecting the payment method.
-     */
-    public function selectPaymentOptionFor($payment_method_slug = 'invoice', $verify_selected = true)
-    {
-        $this->actor()->selectOption(
-            CheckoutPage::PAYMENT_METHOD_STEP_FORM,
-            $payment_method_slug
-        );
-        if ($verify_selected) {
-            $this->actor()->waitForText('Important information regarding your payment');
-        }
-    }
+	/**
+	 * Selects the payment option for the given payment method slug.
+	 *
+	 * @param string $payment_method_slug
+	 * @param bool   $verify_selected      If true, this will wait for the "Important Information" info box after the
+	 *                                     payment option select box is complete.  Otherwise its up to calling code to
+	 *                                     wait for whatever is needed after selecting the payment method.
+	 */
+	public function selectPaymentOptionFor($payment_method_slug = 'invoice', $verify_selected = true)
+	{
+		$this->actor()->selectOption(
+			CheckoutPage::PAYMENT_METHOD_STEP_FORM,
+			$payment_method_slug
+		);
+		if ($verify_selected) {
+			$this->actor()->waitForText('Important information regarding your payment');
+		}
+	}
 
 
-    /**
-     * Submits the payment options step form.
-     * Assumes the actor is in the context of the payment options SPCO step.
-     */
-    public function submitPaymentOptionsRegistrationStepForm()
-    {
-        $this->actor()->submitForm(CheckoutPage::PAYMENT_METHOD_STEP_FORM, array());
-    }
+	/**
+	 * Submits the payment options step form.
+	 * Assumes the actor is in the context of the payment options SPCO step.
+	 */
+	public function submitPaymentOptionsRegistrationStepForm()
+	{
+		$this->actor()->submitForm(CheckoutPage::PAYMENT_METHOD_STEP_FORM, array());
+	}
 
 }
\ No newline at end of file

acceptance_tests/Helpers/MessagesAdmin.php

Indentation +284 added lines, -284 removed lines

@@ -10,288 +10,288 @@
  */
 trait MessagesAdmin
 {
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnMessagesActivityListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
-    }
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnCustomMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
-    }
-
-
-    /**
-     * Directs to message settings page
-     */
-    public function amOnMessageSettingsPage()
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
-    }
-
-
-    public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
-    {
-        $this->actor()->dragAndDrop(
-            MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
-            MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
-        );
-    }
-
-
-    /**
-     * Assumes you are already on the list table page that has the ui for editing the template.
-     * @param string $message_type_slug
-     * @param string $context [optional] if you want to click directly to the given context in the editor
-     */
-    public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
-    {
-        $this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
-    }
-
-
-    /**
-     * Use this action to verify that the count for the given text in the specified field is as expected.  For example
-     * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
-     *
-     * @param int    $expected_occurence_count
-     * @param string $text_to_check_for
-     * @param string $field
-     * @param string $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     */
-    public function verifyMatchingCountofTextInMessageActivityListTableFor(
-        $expected_occurence_count,
-        $text_to_check_for,
-        $field,
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin'
-    ) {
-        $elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
-            $field,
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $text_to_check_for,
-            0
-        ));
-        $actual_count = count($elements);
-        $this->actor()->assertEquals(
-            $expected_occurence_count,
-            $actual_count,
-            sprintf(
-                'Expected %s of the %s text for the %s field but there were actually %s counted.',
-                $expected_occurence_count,
-                $text_to_check_for,
-                $field,
-                $actual_count
-            )
-        );
-    }
-
-
-    /**
-     * This will create a custom message template for the given messenger and message type from the context of the
-     * default (global) message template list table.
-     * Also takes care of verifying the template was created.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     */
-    public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
-    {
-        $this->amOnDefaultMessageTemplateListTablePage();
-        $this->actor()->click(
-            MessagesPage::createCustomButtonForMessageTypeAndMessenger(
-                $message_type_label,
-                $messenger_label
-            )
-        );
-        $this->actor()->seeInField('#title', 'New Custom Template');
-    }
-
-
-    /**
-     * This switches the context of the current messages template to the given reference.
-     * @param string $context_reference  This should be the visible label for the option.
-     */
-    public function switchContextTo($context_reference)
-    {
-        $this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
-        $this->actor()->waitForText($context_reference, 10, 'h1');
-    }
-
-
-    /**
-     * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
-     * toggling.
-     *
-     * @param string $context_string           What context is being switched (used for the expected state text)
-     * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
-     *                                         (false)
-     */
-    public function toggleContextState($context_string, $expected_state_is_active = true)
-    {
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
-        if ($expected_state_is_active) {
-            $this->actor()->waitForText("The template for $context_string is currently active.");
-        } else {
-            $this->actor()->waitForText("The template for $context_string is currently inactive");
-        }
-    }
-
-
-    /**
-     * Triggers saving the message template.
-     * @param bool $and_close   Use to indicate to click the Save and Close button.
-     */
-    public function saveMessageTemplate($and_close = false)
-    {
-        if ($and_close) {
-            $this->actor()->click('Save and Close');
-        } else {
-            $this->actor()->click('Save');
-        }
-        $this->actor()->waitForText('successfully updated');
-    }
-
-
-    /**
-     * This takes care of clicking the View Message icon for the given parameters.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function viewMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        ));
-    }
-
-
-    /**
-     * Takes care of deleting a message matching the given parameters via the message activity list table.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function deleteMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        );
-        $this->actor()->moveMouseOver(
-            MessagesPage::messagesActivityListTableCellSelectorFor(
-                'to',
-                $message_type_label,
-                $message_status,
-                $messenger,
-                $context,
-                '',
-                $number_in_set
-            ),
-            5,
-            5
-        );
-        $this->actor()->waitForElementVisible(
-            $delete_action_selector
-        );
-        $this->actor()->click(
-            $delete_action_selector
-        );
-        $this->actor()->waitForText('successfully deleted');
-    }
-
-
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is in that window.
-     * @param string $text_to_view
-     */
-    public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
-    {
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        $should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
-        $this->actor()->switchToIframe();
-    }
-
-
-    /**
-     * This returns the value for the link at the given selector in the message modal.
-     * @param string $selector (any selector string accepted by WebDriver)
-     */
-    public function observeLinkAtInMessageModal($selector)
-    {
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        return $this->actor()->observeLinkUrlAt($selector);
-    }
-
-
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is NOT that window.
-     * @param string $text_to_view
-     */
-    public function dontSeeTextInViewMessageModal($text_to_view)
-    {
-        $this->seeTextInViewMessageModal($text_to_view, true);
-    }
-
-
-    public function dismissMessageModal()
-    {
-        $this->actor()->click('#espresso-admin-page-overlay-dv');
-        //this is needed otherwise phantom js gets stuck in the wrong context and any future element events will fail.
-        $this->actor()->click('form#EE_Message_List_Table-table-frm');
-    }
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnMessagesActivityListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
+	}
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnCustomMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * Directs to message settings page
+	 */
+	public function amOnMessageSettingsPage()
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
+	}
+
+
+	public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
+	{
+		$this->actor()->dragAndDrop(
+			MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
+			MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
+		);
+	}
+
+
+	/**
+	 * Assumes you are already on the list table page that has the ui for editing the template.
+	 * @param string $message_type_slug
+	 * @param string $context [optional] if you want to click directly to the given context in the editor
+	 */
+	public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
+	{
+		$this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
+	}
+
+
+	/**
+	 * Use this action to verify that the count for the given text in the specified field is as expected.  For example
+	 * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
+	 *
+	 * @param int    $expected_occurence_count
+	 * @param string $text_to_check_for
+	 * @param string $field
+	 * @param string $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 */
+	public function verifyMatchingCountofTextInMessageActivityListTableFor(
+		$expected_occurence_count,
+		$text_to_check_for,
+		$field,
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin'
+	) {
+		$elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
+			$field,
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$text_to_check_for,
+			0
+		));
+		$actual_count = count($elements);
+		$this->actor()->assertEquals(
+			$expected_occurence_count,
+			$actual_count,
+			sprintf(
+				'Expected %s of the %s text for the %s field but there were actually %s counted.',
+				$expected_occurence_count,
+				$text_to_check_for,
+				$field,
+				$actual_count
+			)
+		);
+	}
+
+
+	/**
+	 * This will create a custom message template for the given messenger and message type from the context of the
+	 * default (global) message template list table.
+	 * Also takes care of verifying the template was created.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 */
+	public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
+	{
+		$this->amOnDefaultMessageTemplateListTablePage();
+		$this->actor()->click(
+			MessagesPage::createCustomButtonForMessageTypeAndMessenger(
+				$message_type_label,
+				$messenger_label
+			)
+		);
+		$this->actor()->seeInField('#title', 'New Custom Template');
+	}
+
+
+	/**
+	 * This switches the context of the current messages template to the given reference.
+	 * @param string $context_reference  This should be the visible label for the option.
+	 */
+	public function switchContextTo($context_reference)
+	{
+		$this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
+		$this->actor()->waitForText($context_reference, 10, 'h1');
+	}
+
+
+	/**
+	 * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
+	 * toggling.
+	 *
+	 * @param string $context_string           What context is being switched (used for the expected state text)
+	 * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
+	 *                                         (false)
+	 */
+	public function toggleContextState($context_string, $expected_state_is_active = true)
+	{
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
+		if ($expected_state_is_active) {
+			$this->actor()->waitForText("The template for $context_string is currently active.");
+		} else {
+			$this->actor()->waitForText("The template for $context_string is currently inactive");
+		}
+	}
+
+
+	/**
+	 * Triggers saving the message template.
+	 * @param bool $and_close   Use to indicate to click the Save and Close button.
+	 */
+	public function saveMessageTemplate($and_close = false)
+	{
+		if ($and_close) {
+			$this->actor()->click('Save and Close');
+		} else {
+			$this->actor()->click('Save');
+		}
+		$this->actor()->waitForText('successfully updated');
+	}
+
+
+	/**
+	 * This takes care of clicking the View Message icon for the given parameters.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function viewMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		));
+	}
+
+
+	/**
+	 * Takes care of deleting a message matching the given parameters via the message activity list table.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function deleteMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		);
+		$this->actor()->moveMouseOver(
+			MessagesPage::messagesActivityListTableCellSelectorFor(
+				'to',
+				$message_type_label,
+				$message_status,
+				$messenger,
+				$context,
+				'',
+				$number_in_set
+			),
+			5,
+			5
+		);
+		$this->actor()->waitForElementVisible(
+			$delete_action_selector
+		);
+		$this->actor()->click(
+			$delete_action_selector
+		);
+		$this->actor()->waitForText('successfully deleted');
+	}
+
+
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is in that window.
+	 * @param string $text_to_view
+	 */
+	public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
+	{
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		$should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
+		$this->actor()->switchToIframe();
+	}
+
+
+	/**
+	 * This returns the value for the link at the given selector in the message modal.
+	 * @param string $selector (any selector string accepted by WebDriver)
+	 */
+	public function observeLinkAtInMessageModal($selector)
+	{
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		return $this->actor()->observeLinkUrlAt($selector);
+	}
+
+
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is NOT that window.
+	 * @param string $text_to_view
+	 */
+	public function dontSeeTextInViewMessageModal($text_to_view)
+	{
+		$this->seeTextInViewMessageModal($text_to_view, true);
+	}
+
+
+	public function dismissMessageModal()
+	{
+		$this->actor()->click('#espresso-admin-page-overlay-dv');
+		//this is needed otherwise phantom js gets stuck in the wrong context and any future element events will fail.
+		$this->actor()->click('form#EE_Message_List_Table-table-frm');
+	}
 }

acceptance_tests/Page/CoreAdmin.php

Indentation +92 added lines, -92 removed lines

@@ -13,96 +13,96 @@
 class CoreAdmin
 {
 
-    /**
-     * @var string
-     */
-    const URL_PREFIX = 'admin.php?page=';
-
-
-    /**
-     * This is the selector for the next page button on list tables.
-     * @var string
-     */
-    const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page';
-
-
-    /**
-     * The selector for the search input submit button on list table pages
-     * @var string
-     */
-    const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit';
-
-
-    /**
-     * Selector for the screen options dropdown.
-     * @var string
-     */
-    const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link';
-
-
-    /**
-     * Selector for the per page field setting selector (found within screen options dropdown)
-     * @var string
-     */
-    const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page';
-
-
-    /**
-     * Selector for apply screen options settings.
-     * @var string
-     */
-    const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply';
-
-
-    /**
-     * Selector for bulk action select field on list tables.
-     */
-    const SELECTOR_LIST_TABLE_BULK_ACTION_FIELD = '#bulk-action-selector-';
-
-
-    /**
-     * Selector for applying a bulk action.
-     */
-    const SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY = '#doaction';
-
-
-    /**
-     * Get the EE admin url for the given properties.
-     * Note, this is JUST the endpoint for the admin route.  It is expected that the actor/test would be calling this
-     * with `amOnAdminPage` action.
-     *
-     * @param string $page
-     * @param string $action
-     * @param string $additional_params
-     * @return string
-     */
-    public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '')
-    {
-        $url = self::URL_PREFIX . $page;
-        $url .= $action ? '&action=' . $action : '';
-        $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : '';
-        return $url;
-    }
-
-
-    /**
-     * Returns the selector for the text tab switcher for a wp-editor instance.
-     * @param $field_reference
-     * @return string
-     */
-    public static function wpEditorTextTabSelector($field_reference)
-    {
-        return '#content-' . $field_reference . '-content-html';
-    }
-
-
-    /**
-     * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance.
-     * @param $field_reference
-     * @return string
-     */
-    public static function wpEditorTextAreaSelector($field_reference)
-    {
-        return '#content-' . $field_reference . '-content';
-    }
+	/**
+	 * @var string
+	 */
+	const URL_PREFIX = 'admin.php?page=';
+
+
+	/**
+	 * This is the selector for the next page button on list tables.
+	 * @var string
+	 */
+	const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page';
+
+
+	/**
+	 * The selector for the search input submit button on list table pages
+	 * @var string
+	 */
+	const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit';
+
+
+	/**
+	 * Selector for the screen options dropdown.
+	 * @var string
+	 */
+	const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link';
+
+
+	/**
+	 * Selector for the per page field setting selector (found within screen options dropdown)
+	 * @var string
+	 */
+	const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page';
+
+
+	/**
+	 * Selector for apply screen options settings.
+	 * @var string
+	 */
+	const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply';
+
+
+	/**
+	 * Selector for bulk action select field on list tables.
+	 */
+	const SELECTOR_LIST_TABLE_BULK_ACTION_FIELD = '#bulk-action-selector-';
+
+
+	/**
+	 * Selector for applying a bulk action.
+	 */
+	const SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY = '#doaction';
+
+
+	/**
+	 * Get the EE admin url for the given properties.
+	 * Note, this is JUST the endpoint for the admin route.  It is expected that the actor/test would be calling this
+	 * with `amOnAdminPage` action.
+	 *
+	 * @param string $page
+	 * @param string $action
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '')
+	{
+		$url = self::URL_PREFIX . $page;
+		$url .= $action ? '&action=' . $action : '';
+		$url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : '';
+		return $url;
+	}
+
+
+	/**
+	 * Returns the selector for the text tab switcher for a wp-editor instance.
+	 * @param $field_reference
+	 * @return string
+	 */
+	public static function wpEditorTextTabSelector($field_reference)
+	{
+		return '#content-' . $field_reference . '-content-html';
+	}
+
+
+	/**
+	 * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance.
+	 * @param $field_reference
+	 * @return string
+	 */
+	public static function wpEditorTextAreaSelector($field_reference)
+	{
+		return '#content-' . $field_reference . '-content';
+	}
 }