eventespresso / event-espresso-core

core/db_models/EEM_Datetime.model.php

Indentation +652 added lines, -652 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -14,657 +14,657 @@ 
 class EEM_Datetime extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Datetime $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string $timezone A string representing the timezone we want to set for returned Date Time Strings
-     *                         (and any incoming timezone data that gets saved).
-     *                         Note this just sends the timezone info to the date time model field objects.
-     *                         Default is NULL
-     *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item           = esc_html__('Datetime', 'event_espresso');
-        $this->plural_item             = esc_html__('Datetimes', 'event_espresso');
-        $this->_tables                 = array(
-            'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
-        );
-        $this->_fields                 = array(
-            'Datetime' => array(
-                'DTT_ID'          => new EE_Primary_Key_Int_Field(
-                    'DTT_ID',
-                    esc_html__('Datetime ID', 'event_espresso')
-                ),
-                'EVT_ID'          => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'DTT_name'        => new EE_Plain_Text_Field(
-                    'DTT_name',
-                    esc_html__('Datetime Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_description' => new EE_Post_Content_Field(
-                    'DTT_description',
-                    esc_html__('Description for Datetime', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_EVT_start'   => new EE_Datetime_Field(
-                    'DTT_EVT_start',
-                    esc_html__('Start time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_EVT_end'     => new EE_Datetime_Field(
-                    'DTT_EVT_end',
-                    esc_html__('End time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
-                    'DTT_reg_limit',
-                    esc_html__('Registration Limit for this time', 'event_espresso'),
-                    true,
-                    EE_INF
-                ),
-                'DTT_sold'        => new EE_Integer_Field(
-                    'DTT_sold',
-                    esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_reserved'    => new EE_Integer_Field(
-                    'DTT_reserved',
-                    esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_is_primary'  => new EE_Boolean_Field(
-                    'DTT_is_primary',
-                    esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'DTT_order'       => new EE_Integer_Field(
-                    'DTT_order',
-                    esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_parent'      => new EE_Integer_Field(
-                    'DTT_parent',
-                    esc_html__('Indicates what DTT_ID is the parent of this DTT_ID'),
-                    true,
-                    0
-                ),
-                'DTT_deleted'     => new EE_Trashed_Flag_Field(
-                    'DTT_deleted',
-                    esc_html__('Flag indicating datetime is archived', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations        = array(
-            'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Event'   => new EE_Belongs_To_Relation(),
-            'Checkin' => new EE_Has_Many_Relation(),
-        );
-        $this->_model_chain_to_wp_user = 'Event';
-        //this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
-            'Event'
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
-            'Event'
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
-            'Event'
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
-            'Event',
-            EEM_Base::caps_edit
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * create new blank datetime
-     *
-     * @access public
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function create_new_blank_datetime()
-    {
-        //makes sure timezone is always set.
-        $timezone_string = $this->get_timezone();
-        $blank_datetime  = EE_Datetime::new_instance(
-            array(
-                'DTT_EVT_start' => $this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS,
-                'DTT_EVT_end'   => $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS,
-                'DTT_order'     => 1,
-                'DTT_reg_limit' => EE_INF,
-            ),
-            $timezone_string
-        );
-        $blank_datetime->set_start_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_start',
-                '8am',
-                'ga',
-                $timezone_string
-            )
-        );
-        $blank_datetime->set_end_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_end',
-                '5pm',
-                'ga',
-                $timezone_string
-            )
-        );
-        return array($blank_datetime);
-    }
-
-
-    /**
-     * get event start date from db
-     *
-     * @access public
-     * @param  int $EVT_ID
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_all_event_dates($EVT_ID = 0)
-    {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
-            return $this->create_new_blank_datetime();
-        }
-        $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
-        if (empty($results)) {
-            return $this->create_new_blank_datetime();
-        }
-        return $results;
-    }
-
-
-    /**
-     * get all datetimes attached to an event ordered by the DTT_order field
-     *
-     * @public
-     * @param  int    $EVT_ID     event id
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param  int    $limit      If included then limit the count of results by
-     *                            the given number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_DTT_order(
-        $EVT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        //sanitize EVT_ID
-        $EVT_ID         = absint($EVT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $where_params = array('Event.EVT_ID' => $EVT_ID);
-        $query_params = ! empty($limit)
-            ? array(
-                $where_params,
-                'limit'                    => $limit,
-                'order_by'                 => array('DTT_order' => 'ASC'),
-                'default_where_conditions' => 'none',
-            )
-            : array(
-                $where_params,
-                'order_by'                 => array('DTT_order' => 'ASC'),
-                'default_where_conditions' => 'none',
-            );
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets the datetimes for the event (with the given limit), and orders them by "importance".
-     * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
-     * and then the earlier datetimes are the most important.
-     * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
-     *
-     * @param int $EVT_ID
-     * @param int $limit
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_importance($EVT_ID = 0, $limit = null)
-    {
-        return $this->get_all(
-            array(
-                array('Event.EVT_ID' => $EVT_ID),
-                'limit'                    => $limit,
-                'order_by'                 => array('DTT_EVT_start' => 'ASC'),
-                'default_where_conditions' => 'none',
-            )
-        );
-    }
-
-
-    /**
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_oldest_datetime_for_event($EVT_ID, $include_expired = false, $include_deleted = false)
-    {
-        $results = $this->get_datetimes_for_event_ordered_by_start_time(
-            $EVT_ID,
-            $include_expired,
-            $include_deleted,
-            1
-        );
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the 'primary' datetime for an event.
-     *
-     * @param int  $EVT_ID
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return \EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_primary_datetime_for_event(
-        $EVT_ID,
-        $try_to_exclude_expired = true,
-        $try_to_exclude_deleted = true
-    ) {
-        if ($try_to_exclude_expired) {
-            $non_expired = $this->get_oldest_datetime_for_event($EVT_ID, false, false);
-            if ($non_expired) {
-                return $non_expired;
-            }
-        }
-        if ($try_to_exclude_deleted) {
-            $expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
-            if ($expired_even) {
-                return $expired_even;
-            }
-        }
-        return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_start_time(
-        $EVT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        //sanitize EVT_ID
-        $EVT_ID         = absint($EVT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $TKT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_ticket_ordered_by_start_time(
-        $TKT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        //sanitize TKT_ID
-        $TKT_ID         = absint($TKT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
-     * datetimes.
-     *
-     * @param  int      $TKT_ID          ID of ticket to retrieve the datetimes for
-     * @param  boolean  $include_expired whether to include expired datetimes or not
-     * @param  boolean  $include_deleted whether to include trashed datetimes or not.
-     * @param  int|null $limit           if null, no limit, if int then limit results by
-     *                                   that number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_ticket_ordered_by_DTT_order(
-        $TKT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        //sanitize id.
-        $TKT_ID         = absint($TKT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $where_params = array('Ticket.TKT_ID' => $TKT_ID);
-        $query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
-     * reason it doesn't exist, we consider the earliest event the most important)
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_most_important_datetime_for_event($EVT_ID)
-    {
-        $results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
-     * grouped by month and year.
-     *
-     * @param  array  $where_params      Array of query_params as described in the comments for EEM_Base::get_all()
-     * @param  string $evt_active_status A string representing the evt active status to filter the months by.
-     *                                   Can be:
-     *                                   - '' = no filter
-     *                                   - upcoming = Published events with at least one upcoming datetime.
-     *                                   - expired = Events with all datetimes expired.
-     *                                   - active = Events that are published and have at least one datetime that
-     *                                   starts before now and ends after now.
-     *                                   - inactive = Events that are either not published.
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    public function get_dtt_months_and_years($where_params, $evt_active_status = '')
-    {
-        $current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
-        $current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
-        switch ($evt_active_status) {
-            case 'upcoming' :
-                $where_params['Event.status'] = 'publish';
-                //if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
-                }
-                $where_params['DTT_EVT_start'] = array('>', $current_time_for_DTT_EVT_start);
-                break;
-            case 'expired' :
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                //get events to exclude
-                $exclude_query[0] = array_merge($where_params,
-                    array('DTT_EVT_end' => array('>', $current_time_for_DTT_EVT_end)));
-                //first get all events that have datetimes where its not expired.
-                $event_ids = $this->_get_all_wpdb_results(
-                    $exclude_query,
-                    OBJECT_K,
-                    'Datetime.EVT_ID'
-                );
-                $event_ids = array_keys($event_ids);
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_end']  = array('<', $current_time_for_DTT_EVT_end);
-                $where_params['Event.EVT_ID'] = array('NOT IN', $event_ids);
-                break;
-            case 'active' :
-                $where_params['Event.status'] = 'publish';
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
-                }
-                if (isset($where_params['Datetime.DTT_EVT_end'])) {
-                    $where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_start'] = array('<', $current_time_for_DTT_EVT_start);
-                $where_params['DTT_EVT_end']   = array('>', $current_time_for_DTT_EVT_end);
-                break;
-            case 'inactive' :
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                if (isset($where_params['OR'])) {
-                    $where_params['AND']['OR'] = $where_params['OR'];
-                }
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                    unset($where_params['DTT_EVT_end']);
-                }
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
-                    unset($where_params['DTT_EVT_start']);
-                }
-                $where_params['AND']['Event.status'] = array('!=', 'publish');
-                break;
-        }
-        $query_params[0]          = $where_params;
-        $query_params['group_by'] = array('dtt_year', 'dtt_month');
-        $query_params['order_by'] = array('DTT_EVT_start' => 'DESC');
-        $query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(),
-            'DTT_EVT_start');
-        $columns_to_select        = array(
-            'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
-            'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
-            'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
-        );
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-    /**
-     * Updates the DTT_sold attribute on each datetime (based on the registrations
-     * for the tickets for each datetime)
-     *
-     * @param EE_Base_Class[]|EE_Datetime[] $datetimes
-     * @throws EE_Error
-     */
-    public function update_sold($datetimes)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
-                'event_espresso'
-            ),
-            '4.9.32.rc.005'
-        );
-        foreach ($datetimes as $datetime) {
-            $datetime->update_sold();
-        }
-    }
-
-
-    /**
-     *    Gets the total number of tickets available at a particular datetime
-     *    (does NOT take into account the datetime's spaces available)
-     *
-     * @param int   $DTT_ID
-     * @param array $query_params
-     * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
-     *             tickets attached to datetime then FALSE is returned.
-     */
-    public function sum_tickets_currently_available_at_datetime($DTT_ID, array $query_params = array())
-    {
-        $datetime = $this->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime) {
-            return $datetime->tickets_remaining($query_params);
-        }
-        return 0;
-    }
-
-
-    /**
-     * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
-     *
-     * @param  array $stati_to_include If included you can restrict the statuses we return counts for by including the
-     *                                 stati you want counts for as values in the array.  An empty array returns counts
-     *                                 for all valid stati.
-     * @param  array $query_params     If included can be used to refine the conditions for returning the count (i.e.
-     *                                 only for Datetimes connected to a specific event, or specific ticket.
-     * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
-     * @throws EE_Error
-     *                                 stati used as index keys are: EE_Datetime::active EE_Datetime::upcoming
-     *                                 EE_Datetime::expired
-     */
-    public function get_datetime_counts_by_status(array $stati_to_include = array(), array $query_params = array())
-    {
-        //only accept where conditions for this query.
-        $_where            = isset($query_params[0]) ? $query_params[0] : array();
-        $status_query_args = array(
-            EE_Datetime::active   => array_merge(
-                $_where,
-                array('DTT_EVT_start' => array('<', time()), 'DTT_EVT_end' => array('>', time()))
-            ),
-            EE_Datetime::upcoming => array_merge(
-                $_where,
-                array('DTT_EVT_start' => array('>', time()))
-            ),
-            EE_Datetime::expired  => array_merge(
-                $_where,
-                array('DTT_EVT_end' => array('<', time()))
-            ),
-        );
-        if (! empty($stati_to_include)) {
-            foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $stati_to_include, true)) {
-                    unset($status_query_args[ $status ]);
-                }
-            }
-        }
-        //loop through and query counts for each stati.
-        $status_query_results = array();
-        foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
-                array($status_where_conditions),
-                'DTT_ID',
-                true
-            );
-        }
-        return $status_query_results;
-    }
-
-
-    /**
-     * Returns the specific count for a given Datetime status matching any given query_params.
-     *
-     * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
-    {
-        $count = $this->get_datetime_counts_by_status(array($status), $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
-    }
+	/**
+	 * @var EEM_Datetime $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string $timezone A string representing the timezone we want to set for returned Date Time Strings
+	 *                         (and any incoming timezone data that gets saved).
+	 *                         Note this just sends the timezone info to the date time model field objects.
+	 *                         Default is NULL
+	 *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item           = esc_html__('Datetime', 'event_espresso');
+		$this->plural_item             = esc_html__('Datetimes', 'event_espresso');
+		$this->_tables                 = array(
+			'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
+		);
+		$this->_fields                 = array(
+			'Datetime' => array(
+				'DTT_ID'          => new EE_Primary_Key_Int_Field(
+					'DTT_ID',
+					esc_html__('Datetime ID', 'event_espresso')
+				),
+				'EVT_ID'          => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'DTT_name'        => new EE_Plain_Text_Field(
+					'DTT_name',
+					esc_html__('Datetime Name', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_description' => new EE_Post_Content_Field(
+					'DTT_description',
+					esc_html__('Description for Datetime', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_EVT_start'   => new EE_Datetime_Field(
+					'DTT_EVT_start',
+					esc_html__('Start time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_EVT_end'     => new EE_Datetime_Field(
+					'DTT_EVT_end',
+					esc_html__('End time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
+					'DTT_reg_limit',
+					esc_html__('Registration Limit for this time', 'event_espresso'),
+					true,
+					EE_INF
+				),
+				'DTT_sold'        => new EE_Integer_Field(
+					'DTT_sold',
+					esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_reserved'    => new EE_Integer_Field(
+					'DTT_reserved',
+					esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_is_primary'  => new EE_Boolean_Field(
+					'DTT_is_primary',
+					esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
+					false,
+					false
+				),
+				'DTT_order'       => new EE_Integer_Field(
+					'DTT_order',
+					esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_parent'      => new EE_Integer_Field(
+					'DTT_parent',
+					esc_html__('Indicates what DTT_ID is the parent of this DTT_ID'),
+					true,
+					0
+				),
+				'DTT_deleted'     => new EE_Trashed_Flag_Field(
+					'DTT_deleted',
+					esc_html__('Flag indicating datetime is archived', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations        = array(
+			'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Event'   => new EE_Belongs_To_Relation(),
+			'Checkin' => new EE_Has_Many_Relation(),
+		);
+		$this->_model_chain_to_wp_user = 'Event';
+		//this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
+			'Event'
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+			'Event'
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
+			'Event'
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
+			'Event',
+			EEM_Base::caps_edit
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * create new blank datetime
+	 *
+	 * @access public
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function create_new_blank_datetime()
+	{
+		//makes sure timezone is always set.
+		$timezone_string = $this->get_timezone();
+		$blank_datetime  = EE_Datetime::new_instance(
+			array(
+				'DTT_EVT_start' => $this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS,
+				'DTT_EVT_end'   => $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS,
+				'DTT_order'     => 1,
+				'DTT_reg_limit' => EE_INF,
+			),
+			$timezone_string
+		);
+		$blank_datetime->set_start_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_start',
+				'8am',
+				'ga',
+				$timezone_string
+			)
+		);
+		$blank_datetime->set_end_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_end',
+				'5pm',
+				'ga',
+				$timezone_string
+			)
+		);
+		return array($blank_datetime);
+	}
+
+
+	/**
+	 * get event start date from db
+	 *
+	 * @access public
+	 * @param  int $EVT_ID
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_all_event_dates($EVT_ID = 0)
+	{
+		if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+			return $this->create_new_blank_datetime();
+		}
+		$results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
+		if (empty($results)) {
+			return $this->create_new_blank_datetime();
+		}
+		return $results;
+	}
+
+
+	/**
+	 * get all datetimes attached to an event ordered by the DTT_order field
+	 *
+	 * @public
+	 * @param  int    $EVT_ID     event id
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param  int    $limit      If included then limit the count of results by
+	 *                            the given number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_DTT_order(
+		$EVT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		//sanitize EVT_ID
+		$EVT_ID         = absint($EVT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$where_params = array('Event.EVT_ID' => $EVT_ID);
+		$query_params = ! empty($limit)
+			? array(
+				$where_params,
+				'limit'                    => $limit,
+				'order_by'                 => array('DTT_order' => 'ASC'),
+				'default_where_conditions' => 'none',
+			)
+			: array(
+				$where_params,
+				'order_by'                 => array('DTT_order' => 'ASC'),
+				'default_where_conditions' => 'none',
+			);
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets the datetimes for the event (with the given limit), and orders them by "importance".
+	 * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
+	 * and then the earlier datetimes are the most important.
+	 * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
+	 *
+	 * @param int $EVT_ID
+	 * @param int $limit
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_importance($EVT_ID = 0, $limit = null)
+	{
+		return $this->get_all(
+			array(
+				array('Event.EVT_ID' => $EVT_ID),
+				'limit'                    => $limit,
+				'order_by'                 => array('DTT_EVT_start' => 'ASC'),
+				'default_where_conditions' => 'none',
+			)
+		);
+	}
+
+
+	/**
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_oldest_datetime_for_event($EVT_ID, $include_expired = false, $include_deleted = false)
+	{
+		$results = $this->get_datetimes_for_event_ordered_by_start_time(
+			$EVT_ID,
+			$include_expired,
+			$include_deleted,
+			1
+		);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the 'primary' datetime for an event.
+	 *
+	 * @param int  $EVT_ID
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return \EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_primary_datetime_for_event(
+		$EVT_ID,
+		$try_to_exclude_expired = true,
+		$try_to_exclude_deleted = true
+	) {
+		if ($try_to_exclude_expired) {
+			$non_expired = $this->get_oldest_datetime_for_event($EVT_ID, false, false);
+			if ($non_expired) {
+				return $non_expired;
+			}
+		}
+		if ($try_to_exclude_deleted) {
+			$expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
+			if ($expired_even) {
+				return $expired_even;
+			}
+		}
+		return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_start_time(
+		$EVT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		//sanitize EVT_ID
+		$EVT_ID         = absint($EVT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $TKT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_ticket_ordered_by_start_time(
+		$TKT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		//sanitize TKT_ID
+		$TKT_ID         = absint($TKT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
+	 * datetimes.
+	 *
+	 * @param  int      $TKT_ID          ID of ticket to retrieve the datetimes for
+	 * @param  boolean  $include_expired whether to include expired datetimes or not
+	 * @param  boolean  $include_deleted whether to include trashed datetimes or not.
+	 * @param  int|null $limit           if null, no limit, if int then limit results by
+	 *                                   that number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_ticket_ordered_by_DTT_order(
+		$TKT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		//sanitize id.
+		$TKT_ID         = absint($TKT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$where_params = array('Ticket.TKT_ID' => $TKT_ID);
+		$query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
+	 * reason it doesn't exist, we consider the earliest event the most important)
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_most_important_datetime_for_event($EVT_ID)
+	{
+		$results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
+	 * grouped by month and year.
+	 *
+	 * @param  array  $where_params      Array of query_params as described in the comments for EEM_Base::get_all()
+	 * @param  string $evt_active_status A string representing the evt active status to filter the months by.
+	 *                                   Can be:
+	 *                                   - '' = no filter
+	 *                                   - upcoming = Published events with at least one upcoming datetime.
+	 *                                   - expired = Events with all datetimes expired.
+	 *                                   - active = Events that are published and have at least one datetime that
+	 *                                   starts before now and ends after now.
+	 *                                   - inactive = Events that are either not published.
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	public function get_dtt_months_and_years($where_params, $evt_active_status = '')
+	{
+		$current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
+		$current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
+		switch ($evt_active_status) {
+			case 'upcoming' :
+				$where_params['Event.status'] = 'publish';
+				//if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
+				}
+				$where_params['DTT_EVT_start'] = array('>', $current_time_for_DTT_EVT_start);
+				break;
+			case 'expired' :
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				//get events to exclude
+				$exclude_query[0] = array_merge($where_params,
+					array('DTT_EVT_end' => array('>', $current_time_for_DTT_EVT_end)));
+				//first get all events that have datetimes where its not expired.
+				$event_ids = $this->_get_all_wpdb_results(
+					$exclude_query,
+					OBJECT_K,
+					'Datetime.EVT_ID'
+				);
+				$event_ids = array_keys($event_ids);
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_end']  = array('<', $current_time_for_DTT_EVT_end);
+				$where_params['Event.EVT_ID'] = array('NOT IN', $event_ids);
+				break;
+			case 'active' :
+				$where_params['Event.status'] = 'publish';
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
+				}
+				if (isset($where_params['Datetime.DTT_EVT_end'])) {
+					$where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_start'] = array('<', $current_time_for_DTT_EVT_start);
+				$where_params['DTT_EVT_end']   = array('>', $current_time_for_DTT_EVT_end);
+				break;
+			case 'inactive' :
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				if (isset($where_params['OR'])) {
+					$where_params['AND']['OR'] = $where_params['OR'];
+				}
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+					unset($where_params['DTT_EVT_end']);
+				}
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
+					unset($where_params['DTT_EVT_start']);
+				}
+				$where_params['AND']['Event.status'] = array('!=', 'publish');
+				break;
+		}
+		$query_params[0]          = $where_params;
+		$query_params['group_by'] = array('dtt_year', 'dtt_month');
+		$query_params['order_by'] = array('DTT_EVT_start' => 'DESC');
+		$query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(),
+			'DTT_EVT_start');
+		$columns_to_select        = array(
+			'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
+			'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
+			'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
+		);
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+	/**
+	 * Updates the DTT_sold attribute on each datetime (based on the registrations
+	 * for the tickets for each datetime)
+	 *
+	 * @param EE_Base_Class[]|EE_Datetime[] $datetimes
+	 * @throws EE_Error
+	 */
+	public function update_sold($datetimes)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
+				'event_espresso'
+			),
+			'4.9.32.rc.005'
+		);
+		foreach ($datetimes as $datetime) {
+			$datetime->update_sold();
+		}
+	}
+
+
+	/**
+	 *    Gets the total number of tickets available at a particular datetime
+	 *    (does NOT take into account the datetime's spaces available)
+	 *
+	 * @param int   $DTT_ID
+	 * @param array $query_params
+	 * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
+	 *             tickets attached to datetime then FALSE is returned.
+	 */
+	public function sum_tickets_currently_available_at_datetime($DTT_ID, array $query_params = array())
+	{
+		$datetime = $this->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime) {
+			return $datetime->tickets_remaining($query_params);
+		}
+		return 0;
+	}
+
+
+	/**
+	 * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
+	 *
+	 * @param  array $stati_to_include If included you can restrict the statuses we return counts for by including the
+	 *                                 stati you want counts for as values in the array.  An empty array returns counts
+	 *                                 for all valid stati.
+	 * @param  array $query_params     If included can be used to refine the conditions for returning the count (i.e.
+	 *                                 only for Datetimes connected to a specific event, or specific ticket.
+	 * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
+	 * @throws EE_Error
+	 *                                 stati used as index keys are: EE_Datetime::active EE_Datetime::upcoming
+	 *                                 EE_Datetime::expired
+	 */
+	public function get_datetime_counts_by_status(array $stati_to_include = array(), array $query_params = array())
+	{
+		//only accept where conditions for this query.
+		$_where            = isset($query_params[0]) ? $query_params[0] : array();
+		$status_query_args = array(
+			EE_Datetime::active   => array_merge(
+				$_where,
+				array('DTT_EVT_start' => array('<', time()), 'DTT_EVT_end' => array('>', time()))
+			),
+			EE_Datetime::upcoming => array_merge(
+				$_where,
+				array('DTT_EVT_start' => array('>', time()))
+			),
+			EE_Datetime::expired  => array_merge(
+				$_where,
+				array('DTT_EVT_end' => array('<', time()))
+			),
+		);
+		if (! empty($stati_to_include)) {
+			foreach (array_keys($status_query_args) as $status) {
+				if (! in_array($status, $stati_to_include, true)) {
+					unset($status_query_args[ $status ]);
+				}
+			}
+		}
+		//loop through and query counts for each stati.
+		$status_query_results = array();
+		foreach ($status_query_args as $status => $status_where_conditions) {
+			$status_query_results[ $status ] = EEM_Datetime::count(
+				array($status_where_conditions),
+				'DTT_ID',
+				true
+			);
+		}
+		return $status_query_results;
+	}
+
+
+	/**
+	 * Returns the specific count for a given Datetime status matching any given query_params.
+	 *
+	 * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
+	{
+		$count = $this->get_datetime_counts_by_status(array($status), $query_params);
+		return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+	}
 }
 // End of file EEM_Datetime.model.php
 // Location: /includes/models/EEM_Datetime.model.php

Spacing +19 added lines, -19 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -122,23 +122,23 @@ 
                 ),
             ),
         );
-        $this->_model_relations        = array(
+        $this->_model_relations = array(
             'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
             'Event'   => new EE_Belongs_To_Relation(),
             'Checkin' => new EE_Has_Many_Relation(),
         );
         $this->_model_chain_to_wp_user = 'Event';
         //this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       = new EE_Restriction_Generator_Event_Related_Public(
             'Event'
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Event_Related_Protected(
             'Event'
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       = new EE_Restriction_Generator_Event_Related_Protected(
             'Event'
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     = new EE_Restriction_Generator_Event_Related_Protected(
             'Event',
             EEM_Base::caps_edit
         );
@@ -196,7 +196,7 @@ 
      */
     public function get_all_event_dates($EVT_ID = 0)
     {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+        if ( ! $EVT_ID) { // on add_new_event event_id gets set to 0
             return $this->create_new_blank_datetime();
         }
         $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
@@ -242,7 +242,7 @@ 
                 'order_by'                 => array('DTT_order' => 'ASC'),
                 'default_where_conditions' => 'none',
             );
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -353,7 +353,7 @@ 
         $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -391,7 +391,7 @@ 
         $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -431,7 +431,7 @@ 
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $where_params = array('Ticket.TKT_ID' => $TKT_ID);
         $query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -551,9 +551,9 @@ 
         $query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(),
             'DTT_EVT_start');
         $columns_to_select        = array(
-            'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
-            'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
-            'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
+            'dtt_year'      => array('YEAR('.$query_interval.')', '%s'),
+            'dtt_month'     => array('MONTHNAME('.$query_interval.')', '%s'),
+            'dtt_month_num' => array('MONTH('.$query_interval.')', '%s'),
         );
         return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
     }
@@ -632,17 +632,17 @@ 
                 array('DTT_EVT_end' => array('<', time()))
             ),
         );
-        if (! empty($stati_to_include)) {
+        if ( ! empty($stati_to_include)) {
             foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $stati_to_include, true)) {
-                    unset($status_query_args[ $status ]);
+                if ( ! in_array($status, $stati_to_include, true)) {
+                    unset($status_query_args[$status]);
                 }
             }
         }
         //loop through and query counts for each stati.
         $status_query_results = array();
         foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
+            $status_query_results[$status] = EEM_Datetime::count(
                 array($status_where_conditions),
                 'DTT_ID',
                 true
@@ -663,7 +663,7 @@ 
     public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
     {
         $count = $this->get_datetime_counts_by_status(array($status), $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+        return ! empty($count[$status]) ? $count[$status] : 0;
     }
 }
 // End of file EEM_Datetime.model.php

espresso.php

Indentation +79 added lines, -79 removed lines

@@ -38,103 +38,103 @@
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.58.rc.016');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.58.rc.016');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/EE_Registry.core.php

Indentation +1587 added lines, -1587 removed lines

@@ -23,1593 +23,1593 @@
 class EE_Registry implements ResettableInterface
 {
 
-    /**
-     * @var EE_Registry $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     */
-    protected $_dependency_map;
-
-    /**
-     * @var array $_class_abbreviations
-     */
-    protected $_class_abbreviations = array();
-
-    /**
-     * @var CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     * @var EE_Cart $CART
-     */
-    public $CART;
-
-    /**
-     * @var EE_Config $CFG
-     */
-    public $CFG;
-
-    /**
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG;
-
-    /**
-     * StdClass object for storing library classes in
-     *
-     * @var StdClass $LIB
-     */
-    public $LIB;
-
-    /**
-     * @var EE_Request_Handler $REQ
-     */
-    public $REQ;
-
-    /**
-     * @var EE_Session $SSN
-     */
-    public $SSN;
-
-    /**
-     * @since 4.5.0
-     * @var EE_Capabilities $CAP
-     */
-    public $CAP;
-
-    /**
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager $MRM
-     */
-    public $MRM;
-
-
-    /**
-     * @var Registry $AssetsRegistry
-     */
-    public $AssetsRegistry;
-
-    /**
-     * StdClass object for holding addons which have registered themselves to work with EE core
-     *
-     * @var EE_Addon[] $addons
-     */
-    public $addons;
-
-    /**
-     * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     *
-     * @var EEM_Base[] $models
-     */
-    public $models = array();
-
-    /**
-     * @var EED_Module[] $modules
-     */
-    public $modules;
-
-    /**
-     * @var EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes;
-
-    /**
-     * @var WP_Widget[] $widgets
-     */
-    public $widgets;
-
-    /**
-     * this is an array of all implemented model names (i.e. not the parent abstract models, or models
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
-     * classnames (eg "EEM_Event")
-     *
-     * @var array $non_abstract_db_models
-     */
-    public $non_abstract_db_models = array();
-
-
-    /**
-     * internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @var array $i18n_js_strings
-     */
-    public static $i18n_js_strings = array();
-
-
-    /**
-     * $main_file - path to espresso.php
-     *
-     * @var array $main_file
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @var ReflectionClass[] $_reflectors
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param  EE_Dependency_Map $dependency_map
-     * @return EE_Registry instance
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function instance(EE_Dependency_Map $dependency_map = null)
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registry) {
-            self::$_instance = new self($dependency_map);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param  EE_Dependency_Map $dependency_map
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct(EE_Dependency_Map $dependency_map)
-    {
-        $this->_dependency_map = $dependency_map;
-        // $registry_container = new RegistryContainer();
-        $this->LIB = new RegistryContainer();
-        $this->addons = new RegistryContainer();
-        $this->modules = new RegistryContainer();
-        $this->shortcodes = new RegistryContainer();
-        $this->widgets = new RegistryContainer();
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-    }
-
-
-
-    /**
-     * initialize
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize()
-    {
-        $this->_class_abbreviations = apply_filters(
-            'FHEE__EE_Registry____construct___class_abbreviations',
-            array(
-                'EE_Config'                                       => 'CFG',
-                'EE_Session'                                      => 'SSN',
-                'EE_Capabilities'                                 => 'CAP',
-                'EE_Cart'                                         => 'CART',
-                'EE_Network_Config'                               => 'NET_CFG',
-                'EE_Request_Handler'                              => 'REQ',
-                'EE_Message_Resource_Manager'                     => 'MRM',
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
-                'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
-            )
-        );
-        $this->load_core('Base', array(), true);
-        // add our request and response objects to the cache
-        $request_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Request'
-        );
-        $this->_set_cached_class(
-            $request_loader(),
-            'EventEspresso\core\services\request\Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Response'
-        );
-        $this->_set_cached_class(
-            $response_loader(),
-            'EventEspresso\core\services\request\Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function init()
-    {
-        // Get current page protocol
-        $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
-        // Output admin-ajax.php URL with same protocol as current page
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
-    }
-
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings()
-    {
-        $i18n_js_strings = (array)self::$i18n_js_strings;
-        foreach ($i18n_js_strings as $key => $value) {
-            if (is_scalar($value)) {
-                $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8');
-            }
-        }
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
-    }
-
-
-
-    /**
-     * @param mixed string | EED_Module $module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_module($module)
-    {
-        if ($module instanceof EED_Module) {
-            $module_class = get_class($module);
-            $this->modules->{$module_class} = $module;
-        } else {
-            if ( ! class_exists('EE_Module_Request_Router', false)) {
-                $this->load_core('Module_Request_Router');
-            }
-            EE_Module_Request_Router::module_factory($module);
-        }
-    }
-
-
-
-    /**
-     * @param string $module_name
-     * @return mixed EED_Module | NULL
-     */
-    public function get_module($module_name = '')
-    {
-        return isset($this->modules->{$module_name})
-            ? $this->modules->{$module_name}
-            : null;
-    }
-
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_core($class_name, $arguments = array(), $load_only = false)
-    {
-        $core_paths = apply_filters(
-            'FHEE__EE_Registry__load_core__core_paths',
-            array(
-                EE_CORE,
-                EE_ADMIN,
-                EE_CPTS,
-                EE_CORE . 'data_migration_scripts' . DS,
-                EE_CORE . 'capabilities' . DS,
-                EE_CORE . 'request_stack' . DS,
-                EE_CORE . 'middleware' . DS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $core_paths,
-            'EE_',
-            $class_name,
-            'core',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-
-    /**
-     * loads service classes
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_service($class_name, $arguments = array(), $load_only = false)
-    {
-        $service_paths = apply_filters(
-            'FHEE__EE_Registry__load_service__service_paths',
-            array(
-                EE_CORE . 'services' . DS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $service_paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-
-    /**
-     * loads data_migration_scripts
-     *
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
-     * @param mixed  $arguments
-     * @return EE_Data_Migration_Script_Base|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_dms($class_name, $arguments = array())
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
-            'EE_DMS_',
-            $class_name,
-            'dms',
-            $arguments,
-            false,
-            false
-        );
-    }
-
-
-
-    /**
-     * loads object creating classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: attendee
-     * @param mixed  $arguments  - an array of arguments to pass to the class
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
-     *                           instantiate
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
-     *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
-     *                           (default)
-     * @return EE_Base_Class | bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
-    {
-        $paths = apply_filters(
-            'FHEE__EE_Registry__load_class__paths', array(
-            EE_CORE,
-            EE_CLASSES,
-            EE_BUSINESS,
-        )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            $from_db,
-            $cache,
-            $load_only
-        );
-    }
-
-
-
-    /**
-     * loads helper classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEH_Base | bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_helper($class_name, $arguments = array(), $load_only = true)
-    {
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
-        $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
-        // retrieve instantiated class
-        return $this->_load(
-            $helper_paths,
-            'EEH_',
-            $class_name,
-            'helper',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @param bool   $cache      whether to cache the object or not.
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
-    {
-        $paths = array(
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages' . DS,
-            EE_LIBRARIES . 'shortcodes' . DS,
-            EE_LIBRARIES . 'qtips' . DS,
-            EE_LIBRARIES . 'payment_methods' . DS,
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'lib',
-            $arguments,
-            false,
-            $cache,
-            $load_only
-        );
-    }
-
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEM_Base | bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_model($class_name, $arguments = array(), $load_only = false)
-    {
-        $paths = apply_filters(
-            'FHEE__EE_Registry__load_model__paths', array(
-            EE_MODELS,
-            EE_CORE,
-        )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EEM_',
-            $class_name,
-            'model',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed | bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_model_class($class_name, $arguments = array(), $load_only = true)
-    {
-        $paths = array(
-            EE_MODELS . 'fields' . DS,
-            EE_MODELS . 'helpers' . DS,
-            EE_MODELS . 'relations' . DS,
-            EE_MODELS . 'strategies' . DS,
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            '',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-
-    /**
-     * Determines if $model_name is the name of an actual EE model.
-     *
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
-     * @return boolean
-     */
-    public function is_model_name($model_name)
-    {
-        return isset($this->models[$model_name]);
-    }
-
-
-
-    /**
-     * generic class loader
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            $path_to_file,
-            '',
-            $file_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-
-    /**
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $class_name   - full class name  ie:  My_Class
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|EE_Addon|object
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            $path_to_file,
-            'addon',
-            $class_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-
-    /**
-     * instantiates, caches, and automatically resolves dependencies
-     * for classes that use a Fully Qualified Class Name.
-     * if the class is not capable of being loaded using PSR-4 autoloading,
-     * then you need to use one of the existing load_*() methods
-     * which can resolve the classname and filepath from the passed arguments
-     *
-     * @param bool|string $class_name   Fully Qualified Class Name
-     * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
-     * @return bool|null|mixed          null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create(
-        $class_name = false,
-        $arguments = array(),
-        $cache = false,
-        $from_db = false,
-        $load_only = false,
-        $addon = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        $class_name = $this->_dependency_map->get_alias($class_name);
-        $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
-        // if a non-FQCN was passed, then verifyClassExists() might return an object
-        // or it could return null if the class just could not be found anywhere
-        if ($class_exists instanceof $class_name || $class_exists === null){
-            // either way, return the results
-            return $class_exists;
-        }
-        $class_name = $class_exists;
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only) {
-            return true;
-        }
-        $addon = $addon
-            ? 'addon'
-            : '';
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $addon);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);
-        // instantiate the requested object
-        if ($loader instanceof Closure) {
-            $class_obj = $loader($arguments);
-        } else if ($loader && method_exists($this, $loader)) {
-            $class_obj = $this->{$loader}($class_name, $arguments);
-        } else {
-            $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-        }
-        if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class($class_obj, $class_name, $addon, $from_db);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-    /**
-     * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
-     *
-     * @param string $class_name
-     * @param array  $arguments
-     * @param int    $attempt
-     * @return mixed
-     */
-    private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1) {
-        if (is_object($class_name) || class_exists($class_name)) {
-            return $class_name;
-        }
-        switch ($attempt) {
-            case 1:
-                // if it's a FQCN then maybe the class is registered with a preceding \
-                $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
-                    : $class_name;
-                break;
-            case 2:
-                //
-                $loader = $this->_dependency_map->class_loader($class_name);
-                if ($loader && method_exists($this, $loader)) {
-                    return $this->{$loader}($class_name, $arguments);
-                }
-                break;
-            case 3:
-            default;
-                return null;
-        }
-        $attempt++;
-        return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
-    }
-
-
-
-    /**
-     * instantiates, caches, and injects dependencies for classes
-     *
-     * @param array       $file_paths   an array of paths to folders to look in
-     * @param string      $class_prefix EE  or EEM or... ???
-     * @param bool|string $class_name   $class name
-     * @param string      $type         file type - core? class? helper? model?
-     * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @return bool|null|object null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _load(
-        $file_paths = array(),
-        $class_prefix = 'EE_',
-        $class_name = false,
-        $type = 'class',
-        $arguments = array(),
-        $from_db = false,
-        $cache = true,
-        $load_only = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name = $this->_dependency_map->get_alias($class_name);
-        $class_exists = class_exists($class_name, false);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if loading failed, or we are only loading a file but NOT instantiating an object
-            if (! $loaded || $load_only) {
-                // return boolean if only loading, or null if an object was expected
-                return $load_only
-                    ? $loaded
-                    : null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @param string $default have to specify something, but not anything that will conflict
-     * @return mixed|string
-     */
-    protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
-    {
-        return isset($this->_class_abbreviations[$class_name])
-            ? $this->_class_abbreviations[$class_name]
-            : $default;
-    }
-
-    /**
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @param string $class_name
-     * @param string $class_prefix
-     * @return mixed
-     * @throws OutOfBoundsException
-     */
-    protected function _get_cached_class($class_name, $class_prefix = '')
-    {
-        if ($class_name === 'EE_Registry') {
-            return $this;
-        }
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        $class_name = str_replace('\\', '_', $class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        }
-        if (isset ($this->{$class_name})) {
-            return $this->{$class_name};
-        }
-        if (isset ($this->LIB->{$class_name})) {
-            return $this->LIB->{$class_name};
-        }
-        if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        }
-        return null;
-    }
-
-
-
-    /**
-     * removes a cached version of the requested class
-     *
-     * @param string  $class_name
-     * @param boolean $addon
-     * @return boolean
-     * @throws OutOfBoundsException
-     */
-    public function clear_cached_class($class_name, $addon = false)
-    {
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        $class_name = str_replace('\\', '_', $class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            $this->{$class_abbreviation} = null;
-            return true;
-        }
-        if (isset($this->{$class_name})) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if (isset($this->LIB->{$class_name})) {
-            unset($this->LIB->{$class_name});
-            return true;
-        }
-        if ($addon && isset($this->addons->{$class_name})) {
-            unset($this->addons->{$class_name});
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path($class_name, $type = '', $file_paths = array())
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths)
-            ? $file_paths
-            : array($file_paths);
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper DS, if no filepath, then use EE_CLASSES
-            $file_path = $file_path
-                ? str_replace(array('/', '\\'), DS, $file_path)
-                : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type)
-                ? trim($type, '.') . '.'
-                : '';
-            // build full file path
-            $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
-            //does the file exist and can be read ?
-            if (is_readable($file_paths[$key])) {
-                return $file_paths[$key];
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @param  string $path
-     * @param  string $class_name
-     * @param  string $type
-     * @param  array  $file_paths
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _require_file($path, $class_name, $type = '', $file_paths = array())
-    {
-        $this->resolve_legacy_class_parent($class_name);
-        // don't give up! you gotta...
-        try {
-            //does the file exist and can it be read ?
-            if (! $path) {
-                // just in case the file has already been autoloaded,
-                // but discrepancies in the naming schema are preventing it from
-                // being loaded via one of the EE_Registry::load_*() methods,
-                // then let's try one last hail mary before throwing an exception
-                // and call class_exists() again, but with autoloading turned ON
-                if(class_exists($class_name)) {
-                    return true;
-                }
-                // so sorry, can't find the file
-                throw new EE_Error (
-                    sprintf(
-                        esc_html__(
-                            'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
-                            'event_espresso'
-                        ),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('The %s file %s does not appear to contain the %s Class.', 'event_espresso'),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Some of our legacy classes that extended a parent class would simply use a require() statement
-     * before their class declaration in order to ensure that the parent class was loaded.
-     * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
-     * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
-     *
-     * @param string $class_name
-     */
-    protected function resolve_legacy_class_parent($class_name = '')
-    {
-        try {
-            $legacy_parent_class_map = array(
-                'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php'
-            );
-            if(isset($legacy_parent_class_map[$class_name])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[$class_name];
-            }
-        } catch (Exception $exception) {
-        }
-    }
-
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null|object
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
-    {
-        // create reflection
-        $reflector = $this->get_ReflectionClass($class_name);
-        // make sure arguments are an array
-        $arguments = is_array($arguments)
-            ? $arguments
-            : array($arguments);
-        // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : array($arguments);
-        // attempt to inject dependencies ?
-        if ($this->_dependency_map->has($class_name)) {
-            $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-        }
-        // instantiate the class if possible
-        if ($reflector->isAbstract()) {
-            // nothing to instantiate, loading file was enough
-            // does not throw an exception so $instantiation_mode is unused
-            // $instantiation_mode = "1) no constructor abstract class";
-            return true;
-        }
-        if (empty($arguments) && $reflector->getConstructor() === null && $reflector->isInstantiable()) {
-            // no constructor = static methods only... nothing to instantiate, loading file was enough
-            // $instantiation_mode = "2) no constructor but instantiable";
-            return $reflector->newInstance();
-        }
-        if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-            // $instantiation_mode = "3) new_instance_from_db()";
-            return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
-        }
-        if (method_exists($class_name, 'new_instance')) {
-            // $instantiation_mode = "4) new_instance()";
-            return call_user_func_array(array($class_name, 'new_instance'), $arguments);
-        }
-        if (method_exists($class_name, 'instance')) {
-            // $instantiation_mode = "5) instance()";
-            return call_user_func_array(array($class_name, 'instance'), $arguments);
-        }
-        if ($reflector->isInstantiable()) {
-            // $instantiation_mode = "6) constructor";
-            return $reflector->newInstanceArgs($arguments);
-        }
-        // heh ? something's not right !
-        throw new EE_Error(
-            sprintf(
-                __('The %s file %s could not be instantiated.', 'event_espresso'),
-                $type,
-                $class_name
-            )
-        );
-    }
-
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    protected function _array_is_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array)
-            ? array_keys($array) === range(0, count($array) - 1)
-            : true;
-    }
-
-
-
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     */
-    public function get_ReflectionClass($class_name)
-    {
-        if (
-            ! isset($this->_reflectors[$class_name])
-            || ! $this->_reflectors[$class_name] instanceof ReflectionClass
-        ) {
-            $this->_reflectors[$class_name] = new ReflectionClass($class_name);
-        }
-        return $this->_reflectors[$class_name];
-    }
-
-
-
-    /**
-     * _resolve_dependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
-    {
-        // let's examine the constructor
-        $constructor = $reflector->getConstructor();
-        // whu? huh? nothing?
-        if (! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $constructor->getParameters();
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            // is this a dependency for a specific class ?
-            $param_class = $param->getClass()
-                ? $param->getClass()->name
-                : null;
-            // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
-            $param_class = $this->_dependency_map->has_alias($param_class, $class_name)
-                ? $this->_dependency_map->get_alias($param_class, $class_name)
-                : $param_class;
-            if (
-                // param is not even a class
-                $param_class === null
-                // and something already exists in the incoming arguments for this param
-                && array_key_exists($index, $argument_keys)
-                && array_key_exists($argument_keys[$index], $arguments)
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            }
-            if (
-                // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                $param_class !== null
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-                && $arguments[$argument_keys[$index]] instanceof $param_class
-            ) {
-                // skip this argument and move on to the next
-                continue;
-            }
-            if (
-                // parameter is type hinted as a class, and should be injected
-                $param_class !== null
-                && $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
-            ) {
-                $arguments = $this->_resolve_dependency(
-                    $class_name,
-                    $param_class,
-                    $arguments,
-                    $index,
-                    $argument_keys
-                );
-            } else {
-                try {
-                    $arguments[$index] = $param->isDefaultValueAvailable()
-                        ? $param->getDefaultValue()
-                        : null;
-                } catch (ReflectionException $e) {
-                    throw new ReflectionException(
-                        sprintf(
-                            esc_html__('%1$s for parameter "$%2$s on classname "%3$s"', 'event_espresso'),
-                            $e->getMessage(),
-                            $param->getName(),
-                            $class_name
-                        )
-                    );
-                }
-            }
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @param array  $argument_keys
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _resolve_dependency($class_name, $param_class, $arguments, $index, array $argument_keys)
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
-            $class_name,
-            $param_class
-        );
-        $cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on
-            ? $this->_get_cached_class($param_class)
-            : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } else if ($param_class !== $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader($arguments);
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if ($loader && method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = LoaderFactory::getLoader()->load(
-                        $param_class,
-                        array(),
-                        $cache_on
-                    );
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[$index] = $dependency;
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @return void
-     * @throws OutOfBoundsException
-     */
-    protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
-    {
-        if ($class_name === 'EE_Registry' || empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        $class_abbreviation = $this->get_class_abbreviation($class_name, '');
-        if ($class_abbreviation) {
-            $this->{$class_abbreviation} = $class_obj;
-            return;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-            return;
-        }
-        if ($class_prefix === 'addon') {
-            $this->addons->{$class_name} = $class_obj;
-            return;
-        }
-        if (! $from_db) {
-            $this->LIB->{$class_name} = $class_obj;
-        }
-    }
-
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory($classname, $arguments = array())
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        }
-        if (method_exists(self::instance(), $loader)) {
-            return self::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets the addon by its class name
-     *
-     * @param string $class_name
-     * @return EE_Addon
-     * @throws OutOfBoundsException
-     */
-    public function getAddon($class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        return $this->addons->{$class_name};
-    }
-
-
-    /**
-     * removes the addon from the internal cache
-     *
-     * @param string $class_name
-     * @return void
-     */
-    public function removeAddon($class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        unset($this->addons->{$class_name});
-    }
-
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the get_addon() method above
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name($name)
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() === $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names.
-     * (ie, what each returns for their name() function)
-     * They're already available on EE_Registry::instance()->addons as properties,
-     * where each property's name is the addon's classname,
-     * So if you just want to get the addon by classname,
-     * OR use the get_addon() method above.
-     * PLEASE  NOTE:
-     * addons with Fully Qualified Class Names
-     * have had the namespace separators converted to underscores,
-     * so a classname like Fully\Qualified\ClassName
-     * would have been converted to Fully_Qualified_ClassName
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name()
-    {
-        $addons = array();
-        foreach ($this->addons as $addon) {
-            $addons[$addon->name()] = $addon;
-        }
-        return $addons;
-    }
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function reset_model($model_name)
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0
-            ? "EEM_{$model_name}"
-            : $model_name;
-        if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
-            return null;
-        }
-        //get that model reset it and make sure we nuke the old reference to it
-        if ($this->LIB->{$model_class_name} instanceof $model_class_name
-            && is_callable(
-                array($model_class_name, 'reset')
-            )) {
-            $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
-        } else {
-            throw new EE_Error(sprintf(esc_html__('Model %s does not have a method "reset"', 'event_espresso'), $model_name));
-        }
-        return $this->LIB->{$model_class_name};
-    }
-
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when
-     * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
-     * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             [deprecated]
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
-     *                                  sure if you CAN currently reinstantiate the singletons at the moment)
-     * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
-     *                                  client
-     *                                  code instead can just change the model context to a different blog id if
-     *                                  necessary
-     * @return EE_Registry
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
-    {
-        $instance = self::instance();
-        $instance->_cache_on = true;
-        // reset some "special" classes
-        EEH_Activation::reset();
-        $hard = apply_filters( 'FHEE__EE_Registry__reset__hard', $hard);
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        $instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry');
-        //messages reset
-        EED_Messages::reset();
-        //handle of objects cached on LIB
-        foreach (array('LIB', 'modules') as $cache) {
-            foreach ($instance->{$cache} as $class_name => $class) {
-                if (self::_reset_and_unset_object($class, $reset_models)) {
-                    unset($instance->{$cache}->{$class_name});
-                }
-            }
-        }
-        return $instance;
-    }
-
-
-
-    /**
-     * if passed object implements ResettableInterface, then call it's reset() method
-     * if passed object implements InterminableInterface, then return false,
-     * to indicate that it should NOT be cleared from the Registry cache
-     *
-     * @param      $object
-     * @param bool $reset_models
-     * @return bool returns true if cached object should be unset
-     */
-    private static function _reset_and_unset_object($object, $reset_models)
-    {
-        if (! is_object($object)) {
-            // don't unset anything that's not an object
-            return false;
-        }
-        if ($object instanceof EED_Module) {
-            $object::reset();
-            // don't unset modules
-            return false;
-        }
-        if ($object instanceof ResettableInterface) {
-            if ($object instanceof EEM_Base) {
-                if ($reset_models) {
-                    $object->reset();
-                    return true;
-                }
-                return false;
-            }
-            $object->reset();
-            return true;
-        }
-        if (! $object instanceof InterminableInterface) {
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models()
-    {
-        $cpt_models = array();
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[$short_name] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
-
-
-
-    /**
-     * @return \EE_Config
-     */
-    public static function CFG()
-    {
-        return self::instance()->CFG;
-    }
+	/**
+	 * @var EE_Registry $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 */
+	protected $_dependency_map;
+
+	/**
+	 * @var array $_class_abbreviations
+	 */
+	protected $_class_abbreviations = array();
+
+	/**
+	 * @var CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 * @var EE_Cart $CART
+	 */
+	public $CART;
+
+	/**
+	 * @var EE_Config $CFG
+	 */
+	public $CFG;
+
+	/**
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG;
+
+	/**
+	 * StdClass object for storing library classes in
+	 *
+	 * @var StdClass $LIB
+	 */
+	public $LIB;
+
+	/**
+	 * @var EE_Request_Handler $REQ
+	 */
+	public $REQ;
+
+	/**
+	 * @var EE_Session $SSN
+	 */
+	public $SSN;
+
+	/**
+	 * @since 4.5.0
+	 * @var EE_Capabilities $CAP
+	 */
+	public $CAP;
+
+	/**
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager $MRM
+	 */
+	public $MRM;
+
+
+	/**
+	 * @var Registry $AssetsRegistry
+	 */
+	public $AssetsRegistry;
+
+	/**
+	 * StdClass object for holding addons which have registered themselves to work with EE core
+	 *
+	 * @var EE_Addon[] $addons
+	 */
+	public $addons;
+
+	/**
+	 * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 *
+	 * @var EEM_Base[] $models
+	 */
+	public $models = array();
+
+	/**
+	 * @var EED_Module[] $modules
+	 */
+	public $modules;
+
+	/**
+	 * @var EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes;
+
+	/**
+	 * @var WP_Widget[] $widgets
+	 */
+	public $widgets;
+
+	/**
+	 * this is an array of all implemented model names (i.e. not the parent abstract models, or models
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
+	 * classnames (eg "EEM_Event")
+	 *
+	 * @var array $non_abstract_db_models
+	 */
+	public $non_abstract_db_models = array();
+
+
+	/**
+	 * internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @var array $i18n_js_strings
+	 */
+	public static $i18n_js_strings = array();
+
+
+	/**
+	 * $main_file - path to espresso.php
+	 *
+	 * @var array $main_file
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @var ReflectionClass[] $_reflectors
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param  EE_Dependency_Map $dependency_map
+	 * @return EE_Registry instance
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function instance(EE_Dependency_Map $dependency_map = null)
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Registry) {
+			self::$_instance = new self($dependency_map);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param  EE_Dependency_Map $dependency_map
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct(EE_Dependency_Map $dependency_map)
+	{
+		$this->_dependency_map = $dependency_map;
+		// $registry_container = new RegistryContainer();
+		$this->LIB = new RegistryContainer();
+		$this->addons = new RegistryContainer();
+		$this->modules = new RegistryContainer();
+		$this->shortcodes = new RegistryContainer();
+		$this->widgets = new RegistryContainer();
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+	}
+
+
+
+	/**
+	 * initialize
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize()
+	{
+		$this->_class_abbreviations = apply_filters(
+			'FHEE__EE_Registry____construct___class_abbreviations',
+			array(
+				'EE_Config'                                       => 'CFG',
+				'EE_Session'                                      => 'SSN',
+				'EE_Capabilities'                                 => 'CAP',
+				'EE_Cart'                                         => 'CART',
+				'EE_Network_Config'                               => 'NET_CFG',
+				'EE_Request_Handler'                              => 'REQ',
+				'EE_Message_Resource_Manager'                     => 'MRM',
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
+				'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
+			)
+		);
+		$this->load_core('Base', array(), true);
+		// add our request and response objects to the cache
+		$request_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Request'
+		);
+		$this->_set_cached_class(
+			$request_loader(),
+			'EventEspresso\core\services\request\Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Response'
+		);
+		$this->_set_cached_class(
+			$response_loader(),
+			'EventEspresso\core\services\request\Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function init()
+	{
+		// Get current page protocol
+		$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
+		// Output admin-ajax.php URL with same protocol as current page
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
+	}
+
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings()
+	{
+		$i18n_js_strings = (array)self::$i18n_js_strings;
+		foreach ($i18n_js_strings as $key => $value) {
+			if (is_scalar($value)) {
+				$i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8');
+			}
+		}
+		return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+	}
+
+
+
+	/**
+	 * @param mixed string | EED_Module $module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_module($module)
+	{
+		if ($module instanceof EED_Module) {
+			$module_class = get_class($module);
+			$this->modules->{$module_class} = $module;
+		} else {
+			if ( ! class_exists('EE_Module_Request_Router', false)) {
+				$this->load_core('Module_Request_Router');
+			}
+			EE_Module_Request_Router::module_factory($module);
+		}
+	}
+
+
+
+	/**
+	 * @param string $module_name
+	 * @return mixed EED_Module | NULL
+	 */
+	public function get_module($module_name = '')
+	{
+		return isset($this->modules->{$module_name})
+			? $this->modules->{$module_name}
+			: null;
+	}
+
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_core($class_name, $arguments = array(), $load_only = false)
+	{
+		$core_paths = apply_filters(
+			'FHEE__EE_Registry__load_core__core_paths',
+			array(
+				EE_CORE,
+				EE_ADMIN,
+				EE_CPTS,
+				EE_CORE . 'data_migration_scripts' . DS,
+				EE_CORE . 'capabilities' . DS,
+				EE_CORE . 'request_stack' . DS,
+				EE_CORE . 'middleware' . DS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$core_paths,
+			'EE_',
+			$class_name,
+			'core',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+
+	/**
+	 * loads service classes
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_service($class_name, $arguments = array(), $load_only = false)
+	{
+		$service_paths = apply_filters(
+			'FHEE__EE_Registry__load_service__service_paths',
+			array(
+				EE_CORE . 'services' . DS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$service_paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+
+	/**
+	 * loads data_migration_scripts
+	 *
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
+	 * @param mixed  $arguments
+	 * @return EE_Data_Migration_Script_Base|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_dms($class_name, $arguments = array())
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
+			'EE_DMS_',
+			$class_name,
+			'dms',
+			$arguments,
+			false,
+			false
+		);
+	}
+
+
+
+	/**
+	 * loads object creating classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: attendee
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
+	 *                           instantiate
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
+	 *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
+	 *                           (default)
+	 * @return EE_Base_Class | bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
+	{
+		$paths = apply_filters(
+			'FHEE__EE_Registry__load_class__paths', array(
+			EE_CORE,
+			EE_CLASSES,
+			EE_BUSINESS,
+		)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			$from_db,
+			$cache,
+			$load_only
+		);
+	}
+
+
+
+	/**
+	 * loads helper classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEH_Base | bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_helper($class_name, $arguments = array(), $load_only = true)
+	{
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
+		$helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
+		// retrieve instantiated class
+		return $this->_load(
+			$helper_paths,
+			'EEH_',
+			$class_name,
+			'helper',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @param bool   $cache      whether to cache the object or not.
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
+	{
+		$paths = array(
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages' . DS,
+			EE_LIBRARIES . 'shortcodes' . DS,
+			EE_LIBRARIES . 'qtips' . DS,
+			EE_LIBRARIES . 'payment_methods' . DS,
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'lib',
+			$arguments,
+			false,
+			$cache,
+			$load_only
+		);
+	}
+
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEM_Base | bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_model($class_name, $arguments = array(), $load_only = false)
+	{
+		$paths = apply_filters(
+			'FHEE__EE_Registry__load_model__paths', array(
+			EE_MODELS,
+			EE_CORE,
+		)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EEM_',
+			$class_name,
+			'model',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed | bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_model_class($class_name, $arguments = array(), $load_only = true)
+	{
+		$paths = array(
+			EE_MODELS . 'fields' . DS,
+			EE_MODELS . 'helpers' . DS,
+			EE_MODELS . 'relations' . DS,
+			EE_MODELS . 'strategies' . DS,
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+
+	/**
+	 * Determines if $model_name is the name of an actual EE model.
+	 *
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
+	 * @return boolean
+	 */
+	public function is_model_name($model_name)
+	{
+		return isset($this->models[$model_name]);
+	}
+
+
+
+	/**
+	 * generic class loader
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			$path_to_file,
+			'',
+			$file_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+
+	/**
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $class_name   - full class name  ie:  My_Class
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|EE_Addon|object
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			$path_to_file,
+			'addon',
+			$class_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+
+	/**
+	 * instantiates, caches, and automatically resolves dependencies
+	 * for classes that use a Fully Qualified Class Name.
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
+	 * then you need to use one of the existing load_*() methods
+	 * which can resolve the classname and filepath from the passed arguments
+	 *
+	 * @param bool|string $class_name   Fully Qualified Class Name
+	 * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
+	 * @return bool|null|mixed          null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create(
+		$class_name = false,
+		$arguments = array(),
+		$cache = false,
+		$from_db = false,
+		$load_only = false,
+		$addon = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		$class_name = $this->_dependency_map->get_alias($class_name);
+		$class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
+		// if a non-FQCN was passed, then verifyClassExists() might return an object
+		// or it could return null if the class just could not be found anywhere
+		if ($class_exists instanceof $class_name || $class_exists === null){
+			// either way, return the results
+			return $class_exists;
+		}
+		$class_name = $class_exists;
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only) {
+			return true;
+		}
+		$addon = $addon
+			? 'addon'
+			: '';
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $addon);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// obtain the loader method from the dependency map
+		$loader = $this->_dependency_map->class_loader($class_name);
+		// instantiate the requested object
+		if ($loader instanceof Closure) {
+			$class_obj = $loader($arguments);
+		} else if ($loader && method_exists($this, $loader)) {
+			$class_obj = $this->{$loader}($class_name, $arguments);
+		} else {
+			$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+		}
+		if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class($class_obj, $class_name, $addon, $from_db);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
+	 *
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param int    $attempt
+	 * @return mixed
+	 */
+	private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1) {
+		if (is_object($class_name) || class_exists($class_name)) {
+			return $class_name;
+		}
+		switch ($attempt) {
+			case 1:
+				// if it's a FQCN then maybe the class is registered with a preceding \
+				$class_name = strpos($class_name, '\\') !== false
+					? '\\' . ltrim($class_name, '\\')
+					: $class_name;
+				break;
+			case 2:
+				//
+				$loader = $this->_dependency_map->class_loader($class_name);
+				if ($loader && method_exists($this, $loader)) {
+					return $this->{$loader}($class_name, $arguments);
+				}
+				break;
+			case 3:
+			default;
+				return null;
+		}
+		$attempt++;
+		return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
+	}
+
+
+
+	/**
+	 * instantiates, caches, and injects dependencies for classes
+	 *
+	 * @param array       $file_paths   an array of paths to folders to look in
+	 * @param string      $class_prefix EE  or EEM or... ???
+	 * @param bool|string $class_name   $class name
+	 * @param string      $type         file type - core? class? helper? model?
+	 * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @return bool|null|object null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _load(
+		$file_paths = array(),
+		$class_prefix = 'EE_',
+		$class_name = false,
+		$type = 'class',
+		$arguments = array(),
+		$from_db = false,
+		$cache = true,
+		$load_only = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if (! empty($class_prefix) && $class_prefix !== 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name = $this->_dependency_map->get_alias($class_name);
+		$class_exists = class_exists($class_name, false);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if (! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if loading failed, or we are only loading a file but NOT instantiating an object
+			if (! $loaded || $load_only) {
+				// return boolean if only loading, or null if an object was expected
+				return $load_only
+					? $loaded
+					: null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $default have to specify something, but not anything that will conflict
+	 * @return mixed|string
+	 */
+	protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
+	{
+		return isset($this->_class_abbreviations[$class_name])
+			? $this->_class_abbreviations[$class_name]
+			: $default;
+	}
+
+	/**
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @return mixed
+	 * @throws OutOfBoundsException
+	 */
+	protected function _get_cached_class($class_name, $class_prefix = '')
+	{
+		if ($class_name === 'EE_Registry') {
+			return $this;
+		}
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		$class_name = str_replace('\\', '_', $class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		}
+		if (isset ($this->{$class_name})) {
+			return $this->{$class_name};
+		}
+		if (isset ($this->LIB->{$class_name})) {
+			return $this->LIB->{$class_name};
+		}
+		if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * removes a cached version of the requested class
+	 *
+	 * @param string  $class_name
+	 * @param boolean $addon
+	 * @return boolean
+	 * @throws OutOfBoundsException
+	 */
+	public function clear_cached_class($class_name, $addon = false)
+	{
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		$class_name = str_replace('\\', '_', $class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			$this->{$class_abbreviation} = null;
+			return true;
+		}
+		if (isset($this->{$class_name})) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if (isset($this->LIB->{$class_name})) {
+			unset($this->LIB->{$class_name});
+			return true;
+		}
+		if ($addon && isset($this->addons->{$class_name})) {
+			unset($this->addons->{$class_name});
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path($class_name, $type = '', $file_paths = array())
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths)
+			? $file_paths
+			: array($file_paths);
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper DS, if no filepath, then use EE_CLASSES
+			$file_path = $file_path
+				? str_replace(array('/', '\\'), DS, $file_path)
+				: EE_CLASSES;
+			// prep file type
+			$type = ! empty($type)
+				? trim($type, '.') . '.'
+				: '';
+			// build full file path
+			$file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
+			//does the file exist and can be read ?
+			if (is_readable($file_paths[$key])) {
+				return $file_paths[$key];
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @param  string $path
+	 * @param  string $class_name
+	 * @param  string $type
+	 * @param  array  $file_paths
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _require_file($path, $class_name, $type = '', $file_paths = array())
+	{
+		$this->resolve_legacy_class_parent($class_name);
+		// don't give up! you gotta...
+		try {
+			//does the file exist and can it be read ?
+			if (! $path) {
+				// just in case the file has already been autoloaded,
+				// but discrepancies in the naming schema are preventing it from
+				// being loaded via one of the EE_Registry::load_*() methods,
+				// then let's try one last hail mary before throwing an exception
+				// and call class_exists() again, but with autoloading turned ON
+				if(class_exists($class_name)) {
+					return true;
+				}
+				// so sorry, can't find the file
+				throw new EE_Error (
+					sprintf(
+						esc_html__(
+							'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
+							'event_espresso'
+						),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						esc_html__('The %s file %s does not appear to contain the %s Class.', 'event_espresso'),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Some of our legacy classes that extended a parent class would simply use a require() statement
+	 * before their class declaration in order to ensure that the parent class was loaded.
+	 * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
+	 * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
+	 *
+	 * @param string $class_name
+	 */
+	protected function resolve_legacy_class_parent($class_name = '')
+	{
+		try {
+			$legacy_parent_class_map = array(
+				'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php'
+			);
+			if(isset($legacy_parent_class_map[$class_name])) {
+				require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[$class_name];
+			}
+		} catch (Exception $exception) {
+		}
+	}
+
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null|object
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
+	{
+		// create reflection
+		$reflector = $this->get_ReflectionClass($class_name);
+		// make sure arguments are an array
+		$arguments = is_array($arguments)
+			? $arguments
+			: array($arguments);
+		// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: array($arguments);
+		// attempt to inject dependencies ?
+		if ($this->_dependency_map->has($class_name)) {
+			$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+		}
+		// instantiate the class if possible
+		if ($reflector->isAbstract()) {
+			// nothing to instantiate, loading file was enough
+			// does not throw an exception so $instantiation_mode is unused
+			// $instantiation_mode = "1) no constructor abstract class";
+			return true;
+		}
+		if (empty($arguments) && $reflector->getConstructor() === null && $reflector->isInstantiable()) {
+			// no constructor = static methods only... nothing to instantiate, loading file was enough
+			// $instantiation_mode = "2) no constructor but instantiable";
+			return $reflector->newInstance();
+		}
+		if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+			// $instantiation_mode = "3) new_instance_from_db()";
+			return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
+		}
+		if (method_exists($class_name, 'new_instance')) {
+			// $instantiation_mode = "4) new_instance()";
+			return call_user_func_array(array($class_name, 'new_instance'), $arguments);
+		}
+		if (method_exists($class_name, 'instance')) {
+			// $instantiation_mode = "5) instance()";
+			return call_user_func_array(array($class_name, 'instance'), $arguments);
+		}
+		if ($reflector->isInstantiable()) {
+			// $instantiation_mode = "6) constructor";
+			return $reflector->newInstanceArgs($arguments);
+		}
+		// heh ? something's not right !
+		throw new EE_Error(
+			sprintf(
+				__('The %s file %s could not be instantiated.', 'event_espresso'),
+				$type,
+				$class_name
+			)
+		);
+	}
+
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	protected function _array_is_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array)
+			? array_keys($array) === range(0, count($array) - 1)
+			: true;
+	}
+
+
+
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 */
+	public function get_ReflectionClass($class_name)
+	{
+		if (
+			! isset($this->_reflectors[$class_name])
+			|| ! $this->_reflectors[$class_name] instanceof ReflectionClass
+		) {
+			$this->_reflectors[$class_name] = new ReflectionClass($class_name);
+		}
+		return $this->_reflectors[$class_name];
+	}
+
+
+
+	/**
+	 * _resolve_dependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
+	{
+		// let's examine the constructor
+		$constructor = $reflector->getConstructor();
+		// whu? huh? nothing?
+		if (! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $constructor->getParameters();
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			// is this a dependency for a specific class ?
+			$param_class = $param->getClass()
+				? $param->getClass()->name
+				: null;
+			// BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
+			$param_class = $this->_dependency_map->has_alias($param_class, $class_name)
+				? $this->_dependency_map->get_alias($param_class, $class_name)
+				: $param_class;
+			if (
+				// param is not even a class
+				$param_class === null
+				// and something already exists in the incoming arguments for this param
+				&& array_key_exists($index, $argument_keys)
+				&& array_key_exists($argument_keys[$index], $arguments)
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			}
+			if (
+				// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
+				$param_class !== null
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+				&& $arguments[$argument_keys[$index]] instanceof $param_class
+			) {
+				// skip this argument and move on to the next
+				continue;
+			}
+			if (
+				// parameter is type hinted as a class, and should be injected
+				$param_class !== null
+				&& $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
+			) {
+				$arguments = $this->_resolve_dependency(
+					$class_name,
+					$param_class,
+					$arguments,
+					$index,
+					$argument_keys
+				);
+			} else {
+				try {
+					$arguments[$index] = $param->isDefaultValueAvailable()
+						? $param->getDefaultValue()
+						: null;
+				} catch (ReflectionException $e) {
+					throw new ReflectionException(
+						sprintf(
+							esc_html__('%1$s for parameter "$%2$s on classname "%3$s"', 'event_espresso'),
+							$e->getMessage(),
+							$param->getName(),
+							$class_name
+						)
+					);
+				}
+			}
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @param array  $argument_keys
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _resolve_dependency($class_name, $param_class, $arguments, $index, array $argument_keys)
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
+			$class_name,
+			$param_class
+		);
+		$cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on
+			? $this->_get_cached_class($param_class)
+			: null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} else if ($param_class !== $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader($arguments);
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if ($loader && method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = LoaderFactory::getLoader()->load(
+						$param_class,
+						array(),
+						$cache_on
+					);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			$arguments[$index] = $dependency;
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @return void
+	 * @throws OutOfBoundsException
+	 */
+	protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
+	{
+		if ($class_name === 'EE_Registry' || empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		$class_abbreviation = $this->get_class_abbreviation($class_name, '');
+		if ($class_abbreviation) {
+			$this->{$class_abbreviation} = $class_obj;
+			return;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+			return;
+		}
+		if ($class_prefix === 'addon') {
+			$this->addons->{$class_name} = $class_obj;
+			return;
+		}
+		if (! $from_db) {
+			$this->LIB->{$class_name} = $class_obj;
+		}
+	}
+
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory($classname, $arguments = array())
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		}
+		if (method_exists(self::instance(), $loader)) {
+			return self::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets the addon by its class name
+	 *
+	 * @param string $class_name
+	 * @return EE_Addon
+	 * @throws OutOfBoundsException
+	 */
+	public function getAddon($class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		return $this->addons->{$class_name};
+	}
+
+
+	/**
+	 * removes the addon from the internal cache
+	 *
+	 * @param string $class_name
+	 * @return void
+	 */
+	public function removeAddon($class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		unset($this->addons->{$class_name});
+	}
+
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the get_addon() method above
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name($name)
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() === $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names.
+	 * (ie, what each returns for their name() function)
+	 * They're already available on EE_Registry::instance()->addons as properties,
+	 * where each property's name is the addon's classname,
+	 * So if you just want to get the addon by classname,
+	 * OR use the get_addon() method above.
+	 * PLEASE  NOTE:
+	 * addons with Fully Qualified Class Names
+	 * have had the namespace separators converted to underscores,
+	 * so a classname like Fully\Qualified\ClassName
+	 * would have been converted to Fully_Qualified_ClassName
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name()
+	{
+		$addons = array();
+		foreach ($this->addons as $addon) {
+			$addons[$addon->name()] = $addon;
+		}
+		return $addons;
+	}
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function reset_model($model_name)
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0
+			? "EEM_{$model_name}"
+			: $model_name;
+		if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
+			return null;
+		}
+		//get that model reset it and make sure we nuke the old reference to it
+		if ($this->LIB->{$model_class_name} instanceof $model_class_name
+			&& is_callable(
+				array($model_class_name, 'reset')
+			)) {
+			$this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
+		} else {
+			throw new EE_Error(sprintf(esc_html__('Model %s does not have a method "reset"', 'event_espresso'), $model_name));
+		}
+		return $this->LIB->{$model_class_name};
+	}
+
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when
+	 * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
+	 * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             [deprecated]
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
+	 *                                  sure if you CAN currently reinstantiate the singletons at the moment)
+	 * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
+	 *                                  client
+	 *                                  code instead can just change the model context to a different blog id if
+	 *                                  necessary
+	 * @return EE_Registry
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
+	{
+		$instance = self::instance();
+		$instance->_cache_on = true;
+		// reset some "special" classes
+		EEH_Activation::reset();
+		$hard = apply_filters( 'FHEE__EE_Registry__reset__hard', $hard);
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		$instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry');
+		//messages reset
+		EED_Messages::reset();
+		//handle of objects cached on LIB
+		foreach (array('LIB', 'modules') as $cache) {
+			foreach ($instance->{$cache} as $class_name => $class) {
+				if (self::_reset_and_unset_object($class, $reset_models)) {
+					unset($instance->{$cache}->{$class_name});
+				}
+			}
+		}
+		return $instance;
+	}
+
+
+
+	/**
+	 * if passed object implements ResettableInterface, then call it's reset() method
+	 * if passed object implements InterminableInterface, then return false,
+	 * to indicate that it should NOT be cleared from the Registry cache
+	 *
+	 * @param      $object
+	 * @param bool $reset_models
+	 * @return bool returns true if cached object should be unset
+	 */
+	private static function _reset_and_unset_object($object, $reset_models)
+	{
+		if (! is_object($object)) {
+			// don't unset anything that's not an object
+			return false;
+		}
+		if ($object instanceof EED_Module) {
+			$object::reset();
+			// don't unset modules
+			return false;
+		}
+		if ($object instanceof ResettableInterface) {
+			if ($object instanceof EEM_Base) {
+				if ($reset_models) {
+					$object->reset();
+					return true;
+				}
+				return false;
+			}
+			$object->reset();
+			return true;
+		}
+		if (! $object instanceof InterminableInterface) {
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models()
+	{
+		$cpt_models = array();
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[$short_name] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
+
+
+
+	/**
+	 * @return \EE_Config
+	 */
+	public static function CFG()
+	{
+		return self::instance()->CFG;
+	}
 
 
 }

core/admin/EE_Admin_Page_CPT.core.php

Indentation +1432 added lines, -1432 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\core\services\request\middleware\RecommendedVersions;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -28,470 +28,470 @@ 
 {
 
 
-    /**
-     * This gets set in _setup_cpt
-     * It will contain the object for the custom post type.
-     *
-     * @var EE_CPT_Base
-     */
-    protected $_cpt_object;
-
-
-
-    /**
-     * a boolean flag to set whether the current route is a cpt route or not.
-     *
-     * @var bool
-     */
-    protected $_cpt_route = false;
-
-
-
-    /**
-     * This property allows cpt classes to define multiple routes as cpt routes.
-     * //in this array we define what the custom post type for this route is.
-     * array(
-     * 'route_name' => 'custom_post_type_slug'
-     * )
-     *
-     * @var array
-     */
-    protected $_cpt_routes = array();
-
+	/**
+	 * This gets set in _setup_cpt
+	 * It will contain the object for the custom post type.
+	 *
+	 * @var EE_CPT_Base
+	 */
+	protected $_cpt_object;
+
+
+
+	/**
+	 * a boolean flag to set whether the current route is a cpt route or not.
+	 *
+	 * @var bool
+	 */
+	protected $_cpt_route = false;
+
+
+
+	/**
+	 * This property allows cpt classes to define multiple routes as cpt routes.
+	 * //in this array we define what the custom post type for this route is.
+	 * array(
+	 * 'route_name' => 'custom_post_type_slug'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_cpt_routes = array();
+
 
 
-    /**
-     * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
-     * in this format:
-     * array(
-     * 'post_type_slug' => 'edit_route'
-     * )
-     *
-     * @var array
-     */
-    protected $_cpt_edit_routes = array();
-
-
-
-    /**
-     * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
-     * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
-     * _cpt_model_names property should be in the following format: array(
-     * 'route_defined_by_action_param' => 'Model_Name')
-     *
-     * @var array $_cpt_model_names
-     */
-    protected $_cpt_model_names = array();
-
-
-    /**
-     * @var EE_CPT_Base
-     */
-    protected $_cpt_model_obj = false;
-
-
-
-    /**
-     * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
-     * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
-     * the _register_autosave_containers() method so that we don't override any other containers already registered.
-     * Registration of containers should be done before load_page_dependencies() is run.
-     *
-     * @var array()
-     */
-    protected $_autosave_containers = array();
-    protected $_autosave_fields = array();
-
-    /**
-     * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
-     * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
-     *
-     * @var array
-     */
-    protected $_pagenow_map;
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.  Child classes are required to declare this method.  Typically you would use this to save any additional
-     * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important.  When a
-     * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data
-     * containing any extra info you may have from other meta saves.  So MAKE sure that you handle this accordingly.
-     *
-     * @access protected
-     * @abstract
-     * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param  EE_CPT_Base $post    The post object of the cpt that was saved.
-     * @return void
-     */
-    abstract protected function _insert_update_cpt_item($post_id, $post);
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
-     *
-     * @abstract
-     * @access public
-     * @param  string $post_id The ID of the cpt that was trashed
-     * @return void
-     */
-    abstract public function trash_cpt_item($post_id);
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
-     *
-     * @param  string $post_id theID of the cpt that was untrashed
-     * @return void
-     */
-    abstract public function restore_cpt_item($post_id);
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
-     * from the db
-     *
-     * @param  string $post_id the ID of the cpt that was deleted
-     * @return void
-     */
-    abstract public function delete_cpt_item($post_id);
-
-
-
-    /**
-     * Just utilizing the method EE_Admin exposes for doing things before page setup.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _before_page_setup()
-    {
-        $page = isset($this->_req_data['page']) ? $this->_req_data['page'] : $this->page_slug;
-        $this->_cpt_routes = array_merge(array(
-            'create_new' => $this->page_slug,
-            'edit'       => $this->page_slug,
-            'trash'      => $this->page_slug,
-        ), $this->_cpt_routes);
-        //let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page
-        $this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']])
-            ? get_post_type_object($this->_cpt_routes[$this->_req_data['action']])
-            : get_post_type_object($page);
-        //tweak pagenow for page loading.
-        if ( ! $this->_pagenow_map) {
-            $this->_pagenow_map = array(
-                'create_new' => 'post-new.php',
-                'edit'       => 'post.php',
-                'trash'      => 'post.php',
-            );
-        }
-        add_action('current_screen', array($this, 'modify_pagenow'));
-        //TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
-        //get current page from autosave
-        $current_page = isset($this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page'])
-            ? $this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page']
-            : null;
-        $this->_current_page = isset($this->_req_data['current_page'])
-            ? $this->_req_data['current_page']
-            : $current_page;
-        //autosave... make sure its only for the correct page
-        //if ( ! empty($this->_current_page) && $this->_current_page == $this->page_slug) {
-            //setup autosave ajax hook
-            //add_action('wp_ajax_ee-autosave', array( $this, 'do_extra_autosave_stuff' ), 10 ); //TODO reactivate when 4.2 autosave is implemented
-        //}
-    }
-
-
-
-    /**
-     * Simply ensure that we simulate the correct post route for cpt screens
-     *
-     * @param WP_Screen $current_screen
-     * @return void
-     */
-    public function modify_pagenow($current_screen)
-    {
-        global $pagenow, $hook_suffix;
-        //possibly reset pagenow.
-        if ( ! empty($this->_req_data['page'])
-             && $this->_req_data['page'] == $this->page_slug
-             && ! empty($this->_req_data['action'])
-             && isset($this->_pagenow_map[$this->_req_data['action']])
-        ) {
-            $pagenow = $this->_pagenow_map[$this->_req_data['action']];
-            $hook_suffix = $pagenow;
-        }
-    }
-
-
-
-    /**
-     * This method is used to register additional autosave containers to the _autosave_containers property.
-     *
-     * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
-     *       automatically register the id for the post metabox as a container.
-     * @param  array $ids an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
-     *                    you would send along the id of a metabox container.
-     * @return void
-     */
-    protected function _register_autosave_containers($ids)
-    {
-        $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids);
-    }
-
-
-
-    /**
-     * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
-     * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
-     */
-    protected function _set_autosave_containers()
-    {
-        global $wp_meta_boxes;
-        $containers = array();
-        if (empty($wp_meta_boxes)) {
-            return;
-        }
-        $current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array();
-        foreach ($current_metaboxes as $box_context) {
-            foreach ($box_context as $box_details) {
-                foreach ($box_details as $box) {
-                    if (
-                        is_array($box['callback'])
-                        && (
-                            $box['callback'][0] instanceof EE_Admin_Page
-                            || $box['callback'][0] instanceof EE_Admin_Hooks
-                        )
-                    ) {
-                        $containers[] = $box['id'];
-                    }
-                }
-            }
-        }
-        $this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
-        //add hidden inputs container
-        $this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
-    }
-
-
-
-    protected function _load_autosave_scripts_styles()
-    {
-        /*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
+	/**
+	 * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
+	 * in this format:
+	 * array(
+	 * 'post_type_slug' => 'edit_route'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_cpt_edit_routes = array();
+
+
+
+	/**
+	 * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
+	 * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
+	 * _cpt_model_names property should be in the following format: array(
+	 * 'route_defined_by_action_param' => 'Model_Name')
+	 *
+	 * @var array $_cpt_model_names
+	 */
+	protected $_cpt_model_names = array();
+
+
+	/**
+	 * @var EE_CPT_Base
+	 */
+	protected $_cpt_model_obj = false;
+
+
+
+	/**
+	 * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
+	 * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
+	 * the _register_autosave_containers() method so that we don't override any other containers already registered.
+	 * Registration of containers should be done before load_page_dependencies() is run.
+	 *
+	 * @var array()
+	 */
+	protected $_autosave_containers = array();
+	protected $_autosave_fields = array();
+
+	/**
+	 * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
+	 * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
+	 *
+	 * @var array
+	 */
+	protected $_pagenow_map;
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.  Child classes are required to declare this method.  Typically you would use this to save any additional
+	 * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important.  When a
+	 * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data
+	 * containing any extra info you may have from other meta saves.  So MAKE sure that you handle this accordingly.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param  EE_CPT_Base $post    The post object of the cpt that was saved.
+	 * @return void
+	 */
+	abstract protected function _insert_update_cpt_item($post_id, $post);
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
+	 *
+	 * @abstract
+	 * @access public
+	 * @param  string $post_id The ID of the cpt that was trashed
+	 * @return void
+	 */
+	abstract public function trash_cpt_item($post_id);
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
+	 *
+	 * @param  string $post_id theID of the cpt that was untrashed
+	 * @return void
+	 */
+	abstract public function restore_cpt_item($post_id);
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
+	 * from the db
+	 *
+	 * @param  string $post_id the ID of the cpt that was deleted
+	 * @return void
+	 */
+	abstract public function delete_cpt_item($post_id);
+
+
+
+	/**
+	 * Just utilizing the method EE_Admin exposes for doing things before page setup.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _before_page_setup()
+	{
+		$page = isset($this->_req_data['page']) ? $this->_req_data['page'] : $this->page_slug;
+		$this->_cpt_routes = array_merge(array(
+			'create_new' => $this->page_slug,
+			'edit'       => $this->page_slug,
+			'trash'      => $this->page_slug,
+		), $this->_cpt_routes);
+		//let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page
+		$this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']])
+			? get_post_type_object($this->_cpt_routes[$this->_req_data['action']])
+			: get_post_type_object($page);
+		//tweak pagenow for page loading.
+		if ( ! $this->_pagenow_map) {
+			$this->_pagenow_map = array(
+				'create_new' => 'post-new.php',
+				'edit'       => 'post.php',
+				'trash'      => 'post.php',
+			);
+		}
+		add_action('current_screen', array($this, 'modify_pagenow'));
+		//TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
+		//get current page from autosave
+		$current_page = isset($this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page'])
+			? $this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page']
+			: null;
+		$this->_current_page = isset($this->_req_data['current_page'])
+			? $this->_req_data['current_page']
+			: $current_page;
+		//autosave... make sure its only for the correct page
+		//if ( ! empty($this->_current_page) && $this->_current_page == $this->page_slug) {
+			//setup autosave ajax hook
+			//add_action('wp_ajax_ee-autosave', array( $this, 'do_extra_autosave_stuff' ), 10 ); //TODO reactivate when 4.2 autosave is implemented
+		//}
+	}
+
+
+
+	/**
+	 * Simply ensure that we simulate the correct post route for cpt screens
+	 *
+	 * @param WP_Screen $current_screen
+	 * @return void
+	 */
+	public function modify_pagenow($current_screen)
+	{
+		global $pagenow, $hook_suffix;
+		//possibly reset pagenow.
+		if ( ! empty($this->_req_data['page'])
+			 && $this->_req_data['page'] == $this->page_slug
+			 && ! empty($this->_req_data['action'])
+			 && isset($this->_pagenow_map[$this->_req_data['action']])
+		) {
+			$pagenow = $this->_pagenow_map[$this->_req_data['action']];
+			$hook_suffix = $pagenow;
+		}
+	}
+
+
+
+	/**
+	 * This method is used to register additional autosave containers to the _autosave_containers property.
+	 *
+	 * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
+	 *       automatically register the id for the post metabox as a container.
+	 * @param  array $ids an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
+	 *                    you would send along the id of a metabox container.
+	 * @return void
+	 */
+	protected function _register_autosave_containers($ids)
+	{
+		$this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids);
+	}
+
+
+
+	/**
+	 * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
+	 * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
+	 */
+	protected function _set_autosave_containers()
+	{
+		global $wp_meta_boxes;
+		$containers = array();
+		if (empty($wp_meta_boxes)) {
+			return;
+		}
+		$current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array();
+		foreach ($current_metaboxes as $box_context) {
+			foreach ($box_context as $box_details) {
+				foreach ($box_details as $box) {
+					if (
+						is_array($box['callback'])
+						&& (
+							$box['callback'][0] instanceof EE_Admin_Page
+							|| $box['callback'][0] instanceof EE_Admin_Hooks
+						)
+					) {
+						$containers[] = $box['id'];
+					}
+				}
+			}
+		}
+		$this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
+		//add hidden inputs container
+		$this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
+	}
+
+
+
+	protected function _load_autosave_scripts_styles()
+	{
+		/*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
         wp_enqueue_script('cpt-autosave');/**/ //todo re-enable when we start doing autosave again in 4.2
 
-        //filter _autosave_containers
-        $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
-            $this->_autosave_containers, $this);
-        $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
-            $containers, $this);
-
-        wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS',
-            $containers); //todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
-
-        $unsaved_data_msg = array(
-            'eventmsg'     => sprintf(__("The changes you made to this %s will be lost if you navigate away from this page.",
-                'event_espresso'), $this->_cpt_object->labels->singular_name),
-            'inputChanged' => 0,
-        );
-        wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
-    }
-
-
-
-    public function load_page_dependencies()
-    {
-        try {
-            $this->_load_page_dependencies();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _load_page_dependencies()
-    {
-        //we only add stuff if this is a cpt_route!
-        if ( ! $this->_cpt_route) {
-            parent::_load_page_dependencies();
-            return;
-        }
-        // now let's do some automatic filters into the wp_system
-        // and we'll check to make sure the CHILD class
-        // automatically has the required methods in place.
-        // the following filters are for setting all the redirects
-        // on DEFAULT WP custom post type actions
-        // let's add a hidden input to the post-edit form
-        // so we know when we have to trigger our custom redirects!
-        // Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
-        add_action('edit_form_after_title', array($this, 'cpt_post_form_hidden_input'));
-        // inject our Admin page nav tabs...
-        // let's make sure the nav tabs are set if they aren't already
-        // if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
-        add_action('post_edit_form_tag', array($this, 'inject_nav_tabs'));
-        // modify the post_updated messages array
-        add_action('post_updated_messages', array($this, 'post_update_messages'), 10);
-        // add shortlink button to cpt edit screens.  We can do this as a universal thing BECAUSE,
-        // cpts use the same format for shortlinks as posts!
-        add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4);
-        // This basically allows us to change the title of the "publish" metabox area
-        // on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
-        if ( ! empty($this->_labels['publishbox'])) {
-            $box_label = is_array($this->_labels['publishbox'])
-                         && isset($this->_labels['publishbox'][$this->_req_action])
-                    ? $this->_labels['publishbox'][$this->_req_action]
-                    : $this->_labels['publishbox'];
-            add_meta_box(
-                'submitdiv',
-                $box_label,
-                'post_submit_meta_box',
-                $this->_cpt_routes[$this->_req_action],
-                'side',
-                'core'
-            );
-        }
-        //let's add page_templates metabox if this cpt added support for it.
-        if ($this->_supports_page_templates($this->_cpt_object->name)) {
-            add_meta_box(
-                'page_templates',
-                __('Page Template', 'event_espresso'),
-                array($this, 'page_template_meta_box'),
-                $this->_cpt_routes[$this->_req_action],
-                'side',
-                'default'
-            );
-        }
-        //this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
-        if (method_exists($this, 'extra_permalink_field_buttons')) {
-            add_filter('get_sample_permalink_html', array($this, 'extra_permalink_field_buttons'), 10, 4);
-        }
-        //add preview button
-        add_filter('get_sample_permalink_html', array($this, 'preview_button_html'), 5, 4);
-        //insert our own post_stati dropdown
-        add_action('post_submitbox_misc_actions', array($this, 'custom_post_stati_dropdown'), 10);
-        //This allows adding additional information to the publish post submitbox on the wp post edit form
-        if (method_exists($this, 'extra_misc_actions_publish_box')) {
-            add_action('post_submitbox_misc_actions', array($this, 'extra_misc_actions_publish_box'), 10);
-        }
-        // This allows for adding additional stuff after the title field on the wp post edit form.
-        // This is also before the wp_editor for post description field.
-        if (method_exists($this, 'edit_form_after_title')) {
-            add_action('edit_form_after_title', array($this, 'edit_form_after_title'), 10);
-        }
-        /**
-         * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
-         */
-        add_filter('clean_url', array($this, 'switch_core_wp_urls_with_ours'), 10, 3);
-        parent::_load_page_dependencies();
-        // notice we are ALSO going to load the pagenow hook set for this route
-        // (see _before_page_setup for the reset of the pagenow global ).
-        // This is for any plugins that are doing things properly
-        // and hooking into the load page hook for core wp cpt routes.
-        global $pagenow;
-        do_action('load-' . $pagenow);
-        $this->modify_current_screen();
-        add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30);
-        //we route REALLY early.
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * Since we don't want users going to default core wp routes, this will check any wp urls run through the
-     * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
-     * route instead.
-     *
-     * @param string $good_protocol_url The escaped url.
-     * @param string $original_url      The original url.
-     * @param string $_context          The context sent to the esc_url method.
-     * @return string possibly a new url for our route.
-     */
-    public function switch_core_wp_urls_with_ours($good_protocol_url, $original_url, $_context)
-    {
-        $routes_to_match = array(
-            0 => array(
-                'edit.php?post_type=espresso_attendees',
-                'admin.php?page=espresso_registrations&action=contact_list',
-            ),
-            1 => array(
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
-            ),
-        );
-        foreach ($routes_to_match as $route_matches) {
-            if (strpos($good_protocol_url, $route_matches[0]) !== false) {
-                return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
-            }
-        }
-        return $good_protocol_url;
-    }
-
-
-
-    /**
-     * Determine whether the current cpt supports page templates or not.
-     *
-     * @since %VER%
-     * @param string $cpt_name The cpt slug we're checking on.
-     * @return bool True supported, false not.
-     */
-    private function _supports_page_templates($cpt_name)
-    {
-
-        $cpt_args = EE_Register_CPTs::get_CPTs();
-        $cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array();
-        $cpt_has_support = ! empty($cpt_args['page_templates']);
-
-        //if the installed version of WP is > 4.7 we do some additional checks.
-        if (RecommendedVersions::compareWordPressVersion('4.7','>=')) {
-            $post_templates = wp_get_theme()->get_post_templates();
-            //if there are $post_templates for this cpt, then we return false for this method because
-            //that means we aren't going to load our page template manager and leave that up to the native
-            //cpt template manager.
-            $cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false;
-        }
-
-        return $cpt_has_support;
-    }
-
-
-    /**
-     * Callback for the page_templates metabox selector.
-     *
-     * @since %VER%
-     * @return void
-     */
-    public function page_template_meta_box()
-    {
-        global $post;
-        $template = '';
-
-        if (RecommendedVersions::compareWordPressVersion('4.7','>=')) {
-            $page_template_count = count(get_page_templates());
-        } else {
-            $page_template_count = count(get_page_templates($post));
-        };
-
-        if ($page_template_count) {
-            $page_template = get_post_meta($post->ID, '_wp_page_template', true);
-            $template      = ! empty($page_template) ? $page_template : '';
-        }
-        ?>
+		//filter _autosave_containers
+		$containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
+			$this->_autosave_containers, $this);
+		$containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+			$containers, $this);
+
+		wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS',
+			$containers); //todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
+
+		$unsaved_data_msg = array(
+			'eventmsg'     => sprintf(__("The changes you made to this %s will be lost if you navigate away from this page.",
+				'event_espresso'), $this->_cpt_object->labels->singular_name),
+			'inputChanged' => 0,
+		);
+		wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
+	}
+
+
+
+	public function load_page_dependencies()
+	{
+		try {
+			$this->_load_page_dependencies();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _load_page_dependencies()
+	{
+		//we only add stuff if this is a cpt_route!
+		if ( ! $this->_cpt_route) {
+			parent::_load_page_dependencies();
+			return;
+		}
+		// now let's do some automatic filters into the wp_system
+		// and we'll check to make sure the CHILD class
+		// automatically has the required methods in place.
+		// the following filters are for setting all the redirects
+		// on DEFAULT WP custom post type actions
+		// let's add a hidden input to the post-edit form
+		// so we know when we have to trigger our custom redirects!
+		// Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
+		add_action('edit_form_after_title', array($this, 'cpt_post_form_hidden_input'));
+		// inject our Admin page nav tabs...
+		// let's make sure the nav tabs are set if they aren't already
+		// if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
+		add_action('post_edit_form_tag', array($this, 'inject_nav_tabs'));
+		// modify the post_updated messages array
+		add_action('post_updated_messages', array($this, 'post_update_messages'), 10);
+		// add shortlink button to cpt edit screens.  We can do this as a universal thing BECAUSE,
+		// cpts use the same format for shortlinks as posts!
+		add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4);
+		// This basically allows us to change the title of the "publish" metabox area
+		// on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
+		if ( ! empty($this->_labels['publishbox'])) {
+			$box_label = is_array($this->_labels['publishbox'])
+						 && isset($this->_labels['publishbox'][$this->_req_action])
+					? $this->_labels['publishbox'][$this->_req_action]
+					: $this->_labels['publishbox'];
+			add_meta_box(
+				'submitdiv',
+				$box_label,
+				'post_submit_meta_box',
+				$this->_cpt_routes[$this->_req_action],
+				'side',
+				'core'
+			);
+		}
+		//let's add page_templates metabox if this cpt added support for it.
+		if ($this->_supports_page_templates($this->_cpt_object->name)) {
+			add_meta_box(
+				'page_templates',
+				__('Page Template', 'event_espresso'),
+				array($this, 'page_template_meta_box'),
+				$this->_cpt_routes[$this->_req_action],
+				'side',
+				'default'
+			);
+		}
+		//this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
+		if (method_exists($this, 'extra_permalink_field_buttons')) {
+			add_filter('get_sample_permalink_html', array($this, 'extra_permalink_field_buttons'), 10, 4);
+		}
+		//add preview button
+		add_filter('get_sample_permalink_html', array($this, 'preview_button_html'), 5, 4);
+		//insert our own post_stati dropdown
+		add_action('post_submitbox_misc_actions', array($this, 'custom_post_stati_dropdown'), 10);
+		//This allows adding additional information to the publish post submitbox on the wp post edit form
+		if (method_exists($this, 'extra_misc_actions_publish_box')) {
+			add_action('post_submitbox_misc_actions', array($this, 'extra_misc_actions_publish_box'), 10);
+		}
+		// This allows for adding additional stuff after the title field on the wp post edit form.
+		// This is also before the wp_editor for post description field.
+		if (method_exists($this, 'edit_form_after_title')) {
+			add_action('edit_form_after_title', array($this, 'edit_form_after_title'), 10);
+		}
+		/**
+		 * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
+		 */
+		add_filter('clean_url', array($this, 'switch_core_wp_urls_with_ours'), 10, 3);
+		parent::_load_page_dependencies();
+		// notice we are ALSO going to load the pagenow hook set for this route
+		// (see _before_page_setup for the reset of the pagenow global ).
+		// This is for any plugins that are doing things properly
+		// and hooking into the load page hook for core wp cpt routes.
+		global $pagenow;
+		do_action('load-' . $pagenow);
+		$this->modify_current_screen();
+		add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30);
+		//we route REALLY early.
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * Since we don't want users going to default core wp routes, this will check any wp urls run through the
+	 * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
+	 * route instead.
+	 *
+	 * @param string $good_protocol_url The escaped url.
+	 * @param string $original_url      The original url.
+	 * @param string $_context          The context sent to the esc_url method.
+	 * @return string possibly a new url for our route.
+	 */
+	public function switch_core_wp_urls_with_ours($good_protocol_url, $original_url, $_context)
+	{
+		$routes_to_match = array(
+			0 => array(
+				'edit.php?post_type=espresso_attendees',
+				'admin.php?page=espresso_registrations&action=contact_list',
+			),
+			1 => array(
+				'edit.php?post_type=' . $this->_cpt_object->name,
+				'admin.php?page=' . $this->_cpt_object->name,
+			),
+		);
+		foreach ($routes_to_match as $route_matches) {
+			if (strpos($good_protocol_url, $route_matches[0]) !== false) {
+				return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
+			}
+		}
+		return $good_protocol_url;
+	}
+
+
+
+	/**
+	 * Determine whether the current cpt supports page templates or not.
+	 *
+	 * @since %VER%
+	 * @param string $cpt_name The cpt slug we're checking on.
+	 * @return bool True supported, false not.
+	 */
+	private function _supports_page_templates($cpt_name)
+	{
+
+		$cpt_args = EE_Register_CPTs::get_CPTs();
+		$cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array();
+		$cpt_has_support = ! empty($cpt_args['page_templates']);
+
+		//if the installed version of WP is > 4.7 we do some additional checks.
+		if (RecommendedVersions::compareWordPressVersion('4.7','>=')) {
+			$post_templates = wp_get_theme()->get_post_templates();
+			//if there are $post_templates for this cpt, then we return false for this method because
+			//that means we aren't going to load our page template manager and leave that up to the native
+			//cpt template manager.
+			$cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false;
+		}
+
+		return $cpt_has_support;
+	}
+
+
+	/**
+	 * Callback for the page_templates metabox selector.
+	 *
+	 * @since %VER%
+	 * @return void
+	 */
+	public function page_template_meta_box()
+	{
+		global $post;
+		$template = '';
+
+		if (RecommendedVersions::compareWordPressVersion('4.7','>=')) {
+			$page_template_count = count(get_page_templates());
+		} else {
+			$page_template_count = count(get_page_templates($post));
+		};
+
+		if ($page_template_count) {
+			$page_template = get_post_meta($post->ID, '_wp_page_template', true);
+			$template      = ! empty($page_template) ? $page_template : '';
+		}
+		?>
         <p><strong><?php _e('Template') ?></strong></p>
         <label class="screen-reader-text" for="page_template"><?php _e('Page Template') ?></label><select
             name="page_template" id="page_template">
@@ -499,450 +499,450 @@ 
         <?php page_template_dropdown($template); ?>
     </select>
         <?php
-    }
-
-
-
-    /**
-     * if this post is a draft or scheduled post then we provide a preview button for user to click
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param  string $return    the current html
-     * @param  int    $id        the post id for the page
-     * @param  string $new_title What the title is
-     * @param  string $new_slug  what the slug is
-     * @return string            The new html string for the permalink area
-     */
-    public function preview_button_html($return, $id, $new_title, $new_slug)
-    {
-        $post = get_post($id);
-        if ('publish' !== get_post_status($post)) {
-            //include shims for the `get_preview_post_link` function
-            require_once( EE_CORE . 'wordpress-shims.php' );
-            $return .= '<span_id="view-post-btn"><a target="_blank" href="'
-                       . get_preview_post_link($id)
-                       . '" class="button button-small">'
-                       . __('Preview', 'event_espresso')
-                       . '</a></span>'
-                       . "\n";
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * add our custom post stati dropdown on the wp post page for this cpt
-     *
-     * @return void
-     */
-    public function custom_post_stati_dropdown()
-    {
-
-        $statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
-        $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
-            ? $statuses[$this->_cpt_model_obj->status()]
-            : '';
-        $template_args    = array(
-            'cur_status'            => $this->_cpt_model_obj->status(),
-            'statuses'              => $statuses,
-            'cur_status_label'      => $cur_status_label,
-            'localized_status_save' => sprintf(__('Save %s', 'event_espresso'), $cur_status_label),
-        );
-        //we'll add a trash post status (WP doesn't add one for some reason)
-        if ($this->_cpt_model_obj->status() === 'trash') {
-            $template_args['cur_status_label'] = __('Trashed', 'event_espresso');
-            $statuses['trash']                 = __('Trashed', 'event_espresso');
-            $template_args['statuses']         = $statuses;
-        }
-
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-
-    public function setup_autosave_hooks()
-    {
-        $this->_set_autosave_containers();
-        $this->_load_autosave_scripts_styles();
-    }
-
-
-
-    /**
-     * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a $_POST object (available
-     * in $this->_req_data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
-     * for the nonce in here, but then this method looks for two things:
-     * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
-     * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
-     * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
-     * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
-     * template args.
-     *    1. $template_args['error'] = IF there is an error you can add the message in here.
-     *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
-     *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
-     *    $this->_template_args['data']['items'] = array(
-     *        'event-datetime-ids' => '1,2,3';
-     *    );
-     *    Keep in mind the following things:
-     *    - "where" index is for the input with the id as that string.
-     *    - "what" index is what will be used for the value of that input.
-     *
-     * @return void
-     */
-    public function do_extra_autosave_stuff()
-    {
-        //next let's check for the autosave nonce (we'll use _verify_nonce )
-        $nonce = isset($this->_req_data['autosavenonce'])
-                ? $this->_req_data['autosavenonce']
-                : null;
-        $this->_verify_nonce($nonce, 'autosave');
-        //make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
-        if ( ! defined('DOING_AUTOSAVE')) {
-            define('DOING_AUTOSAVE', true);
-        }
-        //if we made it here then the nonce checked out.  Let's run our methods and actions
-        $autosave = "_ee_autosave_{$this->_current_view}";
-        if (method_exists($this, $autosave)) {
-            $this->$autosave();
-        } else {
-            $this->_template_args['success'] = true;
-        }
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
-        //now let's return json
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * This takes care of setting up default routes and pages that utilize the core WP admin pages.
-     * Child classes can override the defaults (in cases for adding metaboxes etc.)
-     * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
-     *
-     * @access protected
-     * @throws EE_Error
-     * @return void
-     */
-    protected function _extend_page_config_for_cpt()
-    {
-        //before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
-        if (isset($this->_req_data['page']) && $this->_req_data['page'] !== $this->page_slug) {
-            return;
-        }
-        //set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
-        if ( ! empty($this->_cpt_object)) {
-            $this->_page_routes = array_merge(array(
-                'create_new' => '_create_new_cpt_item',
-                'edit'       => '_edit_cpt_item',
-            ), $this->_page_routes);
-            $this->_page_config = array_merge(array(
-                'create_new' => array(
-                    'nav'           => array(
-                        'label' => $this->_cpt_object->labels->add_new_item,
-                        'order' => 5,
-                    ),
-                    'require_nonce' => false,
-                ),
-                'edit'       => array(
-                    'nav'           => array(
-                        'label'      => $this->_cpt_object->labels->edit_item,
-                        'order'      => 5,
-                        'persistent' => false,
-                        'url'        => '',
-                    ),
-                    'require_nonce' => false,
-                ),
-            ),
-                $this->_page_config
-            );
-        }
-        //load the next section only if this is a matching cpt route as set in the cpt routes array.
-        if ( ! isset($this->_cpt_routes[$this->_req_action])) {
-            return;
-        }
-        $this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false;
-        //add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
-        if (empty($this->_cpt_object)) {
-            $msg = sprintf(__('This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).'),
-                $this->page_slug, $this->_req_action, get_class($this));
-            throw new EE_Error($msg);
-        }
-        if ($this->_cpt_route) {
-            $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
-            $this->_set_model_object($id);
-        }
-    }
-
-
-
-    /**
-     * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
-     *
-     * @access protected
-     * @param int  $id The id to retrieve the model object for. If empty we set a default object.
-     * @param bool $ignore_route_check
-     * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT
-     * @throws EE_Error
-     */
-    protected function _set_model_object($id = null, $ignore_route_check = false, $req_type = '')
-    {
-        $model = null;
-        if (
-            empty($this->_cpt_model_names)
-            || (
-                ! $ignore_route_check
-                && ! isset($this->_cpt_routes[$this->_req_action])
-            ) || (
-                $this->_cpt_model_obj instanceof EE_CPT_Base
-                && $this->_cpt_model_obj->ID() === $id
-            )
-        ) {
-            //get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
-            return;
-        }
-        //if ignore_route_check is true, then get the model name via EE_Register_CPTs
-        if ($ignore_route_check) {
-            $model_names = EE_Register_CPTs::get_cpt_model_names();
-            $post_type   = get_post_type($id);
-            if (isset($model_names[$post_type])) {
-                $model = EE_Registry::instance()->load_model($model_names[$post_type]);
-            }
-        } else {
-            $model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]);
-        }
-        if ($model instanceof EEM_Base) {
-            $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
-        }
-        do_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            $this->_cpt_model_obj,
-            $req_type
-        );
-    }
-
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_init_global()
-    {
-        $post = isset($this->_req_data['post']) ? get_post($this->_req_data['post']) : null;
-        //its possible this is a new save so let's catch that instead
-        $post = isset($this->_req_data['post_ID']) ? get_post($this->_req_data['post_ID']) : $post;
-        $post_type = $post ? $post->post_type : false;
-        $current_route = isset($this->_req_data['current_route'])
-            ? $this->_req_data['current_route']
-            : 'shouldneverwork';
-        $route_to_check = $post_type && isset($this->_cpt_routes[$current_route])
-            ? $this->_cpt_routes[$current_route]
-            : '';
-        add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3);
-        add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3);
-        if ($post_type === $route_to_check) {
-            add_filter('redirect_post_location', array($this, 'cpt_post_location_redirect'), 10, 2);
-        }
-        //now let's filter redirect if we're on a revision page and the revision is for an event CPT.
-        $revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
-        if ( ! empty($revision)) {
-            $action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null;
-            //doing a restore?
-            if ( ! empty($action) && $action === 'restore') {
-                //get post for revision
-                $rev_post = get_post($revision);
-                $rev_parent = get_post($rev_post->post_parent);
-                //only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
-                if ($rev_parent && $rev_parent->post_type === $this->page_slug) {
-                    add_filter('wp_redirect', array($this, 'revision_redirect'), 10, 2);
-                    //restores of revisions
-                    add_action('wp_restore_post_revision', array($this, 'restore_revision'), 10, 2);
-                }
-            }
-        }
-        //NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
-        if ($post_type && $post_type === $route_to_check) {
-            //$post_id, $post
-            add_action('save_post', array($this, 'insert_update'), 10, 3);
-            //$post_id
-            add_action('trashed_post', array($this, 'before_trash_cpt_item'), 10);
-            add_action('trashed_post', array($this, 'dont_permanently_delete_ee_cpts'), 10);
-            add_action('untrashed_post', array($this, 'before_restore_cpt_item'), 10);
-            add_action('after_delete_post', array($this, 'before_delete_cpt_item'), 10);
-        }
-    }
-
-
-
-    /**
-     * Callback for the WordPress trashed_post hook.
-     * Execute some basic checks before calling the trash_cpt_item declared in the child class.
-     *
-     * @param int $post_id
-     * @throws \EE_Error
-     */
-    public function before_trash_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'trash');
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->trash_cpt_item($post_id);
-    }
-
-
-
-    /**
-     * Callback for the WordPress untrashed_post hook.
-     * Execute some basic checks before calling the restore_cpt_method in the child class.
-     *
-     * @param $post_id
-     * @throws \EE_Error
-     */
-    public function before_restore_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'restore');
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->restore_cpt_item($post_id);
-    }
-
-
-
-    /**
-     * Callback for the WordPress after_delete_post hook.
-     * Execute some basic checks before calling the delete_cpt_item method in the child class.
-     *
-     * @param $post_id
-     * @throws \EE_Error
-     */
-    public function before_delete_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'delete');
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->delete_cpt_item($post_id);
-    }
-
-
-
-    /**
-     * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
-     * accordingly.
-     *
-     * @access public
-     * @throws EE_Error
-     * @return void
-     */
-    public function verify_cpt_object()
-    {
-        $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
-        // verify event object
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            throw new EE_Error(sprintf(__('Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
-                    'event_espresso'), $label));
-        }
-        //if auto-draft then throw an error
-        if ($this->_cpt_model_obj->get('status') === 'auto-draft') {
-            EE_Error::overwrite_errors();
-            EE_Error::add_error(sprintf(__('This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.'),
-                    $label), __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply on ALL EE_Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-    }
-
-
-
-    /**
-     * add in any global scripts for cpt routes
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        parent::load_global_scripts_styles();
-        if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
-            //setup custom post status object for localize script but only if we've got a cpt object
-            $statuses = $this->_cpt_model_obj->get_custom_post_statuses();
-            if ( ! empty($statuses)) {
-                //get ALL statuses!
-                $statuses = $this->_cpt_model_obj->get_all_post_statuses();
-                //setup object
-                $ee_cpt_statuses = array();
-                foreach ($statuses as $status => $label) {
-                    $ee_cpt_statuses[$status] = array(
-                        'label'      => $label,
-                        'save_label' => sprintf(__('Save as %s', 'event_espresso'), $label),
-                    );
-                }
-                wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
-            }
-        }
-    }
-
-
-
-    /**
-     * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
-     * insert/updates
-     *
-     * @param  int     $post_id ID of post being updated
-     * @param  WP_Post $post    Post object from WP
-     * @param  bool    $update  Whether this is an update or a new save.
-     * @return void
-     * @throws \EE_Error
-     */
-    public function insert_update($post_id, $post, $update)
-    {
-        //make sure that if this is a revision OR trash action that we don't do any updates!
-        if (
-            isset($this->_req_data['action'])
-            && (
-                $this->_req_data['action'] === 'restore'
-                || $this->_req_data['action'] === 'trash'
-            )
-        ) {
-            return;
-        }
-        $this->_set_model_object($post_id, true, 'insert_update');
-        //if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
-        if ($update
-            && (
-                ! $this->_cpt_model_obj instanceof EE_CPT_Base
-                || $this->_cpt_model_obj->ID() !== $post_id
-            )
-        ) {
-            return;
-        }
-        //check for autosave and update our req_data property accordingly.
-        /*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
+	}
+
+
+
+	/**
+	 * if this post is a draft or scheduled post then we provide a preview button for user to click
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param  string $return    the current html
+	 * @param  int    $id        the post id for the page
+	 * @param  string $new_title What the title is
+	 * @param  string $new_slug  what the slug is
+	 * @return string            The new html string for the permalink area
+	 */
+	public function preview_button_html($return, $id, $new_title, $new_slug)
+	{
+		$post = get_post($id);
+		if ('publish' !== get_post_status($post)) {
+			//include shims for the `get_preview_post_link` function
+			require_once( EE_CORE . 'wordpress-shims.php' );
+			$return .= '<span_id="view-post-btn"><a target="_blank" href="'
+					   . get_preview_post_link($id)
+					   . '" class="button button-small">'
+					   . __('Preview', 'event_espresso')
+					   . '</a></span>'
+					   . "\n";
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * add our custom post stati dropdown on the wp post page for this cpt
+	 *
+	 * @return void
+	 */
+	public function custom_post_stati_dropdown()
+	{
+
+		$statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
+		$cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
+			? $statuses[$this->_cpt_model_obj->status()]
+			: '';
+		$template_args    = array(
+			'cur_status'            => $this->_cpt_model_obj->status(),
+			'statuses'              => $statuses,
+			'cur_status_label'      => $cur_status_label,
+			'localized_status_save' => sprintf(__('Save %s', 'event_espresso'), $cur_status_label),
+		);
+		//we'll add a trash post status (WP doesn't add one for some reason)
+		if ($this->_cpt_model_obj->status() === 'trash') {
+			$template_args['cur_status_label'] = __('Trashed', 'event_espresso');
+			$statuses['trash']                 = __('Trashed', 'event_espresso');
+			$template_args['statuses']         = $statuses;
+		}
+
+		$template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+
+	public function setup_autosave_hooks()
+	{
+		$this->_set_autosave_containers();
+		$this->_load_autosave_scripts_styles();
+	}
+
+
+
+	/**
+	 * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a $_POST object (available
+	 * in $this->_req_data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
+	 * for the nonce in here, but then this method looks for two things:
+	 * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
+	 * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
+	 * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
+	 * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
+	 * template args.
+	 *    1. $template_args['error'] = IF there is an error you can add the message in here.
+	 *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
+	 *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
+	 *    $this->_template_args['data']['items'] = array(
+	 *        'event-datetime-ids' => '1,2,3';
+	 *    );
+	 *    Keep in mind the following things:
+	 *    - "where" index is for the input with the id as that string.
+	 *    - "what" index is what will be used for the value of that input.
+	 *
+	 * @return void
+	 */
+	public function do_extra_autosave_stuff()
+	{
+		//next let's check for the autosave nonce (we'll use _verify_nonce )
+		$nonce = isset($this->_req_data['autosavenonce'])
+				? $this->_req_data['autosavenonce']
+				: null;
+		$this->_verify_nonce($nonce, 'autosave');
+		//make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
+		if ( ! defined('DOING_AUTOSAVE')) {
+			define('DOING_AUTOSAVE', true);
+		}
+		//if we made it here then the nonce checked out.  Let's run our methods and actions
+		$autosave = "_ee_autosave_{$this->_current_view}";
+		if (method_exists($this, $autosave)) {
+			$this->$autosave();
+		} else {
+			$this->_template_args['success'] = true;
+		}
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+		//now let's return json
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * This takes care of setting up default routes and pages that utilize the core WP admin pages.
+	 * Child classes can override the defaults (in cases for adding metaboxes etc.)
+	 * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
+	 *
+	 * @access protected
+	 * @throws EE_Error
+	 * @return void
+	 */
+	protected function _extend_page_config_for_cpt()
+	{
+		//before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
+		if (isset($this->_req_data['page']) && $this->_req_data['page'] !== $this->page_slug) {
+			return;
+		}
+		//set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
+		if ( ! empty($this->_cpt_object)) {
+			$this->_page_routes = array_merge(array(
+				'create_new' => '_create_new_cpt_item',
+				'edit'       => '_edit_cpt_item',
+			), $this->_page_routes);
+			$this->_page_config = array_merge(array(
+				'create_new' => array(
+					'nav'           => array(
+						'label' => $this->_cpt_object->labels->add_new_item,
+						'order' => 5,
+					),
+					'require_nonce' => false,
+				),
+				'edit'       => array(
+					'nav'           => array(
+						'label'      => $this->_cpt_object->labels->edit_item,
+						'order'      => 5,
+						'persistent' => false,
+						'url'        => '',
+					),
+					'require_nonce' => false,
+				),
+			),
+				$this->_page_config
+			);
+		}
+		//load the next section only if this is a matching cpt route as set in the cpt routes array.
+		if ( ! isset($this->_cpt_routes[$this->_req_action])) {
+			return;
+		}
+		$this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false;
+		//add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
+		if (empty($this->_cpt_object)) {
+			$msg = sprintf(__('This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).'),
+				$this->page_slug, $this->_req_action, get_class($this));
+			throw new EE_Error($msg);
+		}
+		if ($this->_cpt_route) {
+			$id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
+			$this->_set_model_object($id);
+		}
+	}
+
+
+
+	/**
+	 * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
+	 *
+	 * @access protected
+	 * @param int  $id The id to retrieve the model object for. If empty we set a default object.
+	 * @param bool $ignore_route_check
+	 * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT
+	 * @throws EE_Error
+	 */
+	protected function _set_model_object($id = null, $ignore_route_check = false, $req_type = '')
+	{
+		$model = null;
+		if (
+			empty($this->_cpt_model_names)
+			|| (
+				! $ignore_route_check
+				&& ! isset($this->_cpt_routes[$this->_req_action])
+			) || (
+				$this->_cpt_model_obj instanceof EE_CPT_Base
+				&& $this->_cpt_model_obj->ID() === $id
+			)
+		) {
+			//get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
+			return;
+		}
+		//if ignore_route_check is true, then get the model name via EE_Register_CPTs
+		if ($ignore_route_check) {
+			$model_names = EE_Register_CPTs::get_cpt_model_names();
+			$post_type   = get_post_type($id);
+			if (isset($model_names[$post_type])) {
+				$model = EE_Registry::instance()->load_model($model_names[$post_type]);
+			}
+		} else {
+			$model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]);
+		}
+		if ($model instanceof EEM_Base) {
+			$this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
+		}
+		do_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			$this->_cpt_model_obj,
+			$req_type
+		);
+	}
+
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+		$post = isset($this->_req_data['post']) ? get_post($this->_req_data['post']) : null;
+		//its possible this is a new save so let's catch that instead
+		$post = isset($this->_req_data['post_ID']) ? get_post($this->_req_data['post_ID']) : $post;
+		$post_type = $post ? $post->post_type : false;
+		$current_route = isset($this->_req_data['current_route'])
+			? $this->_req_data['current_route']
+			: 'shouldneverwork';
+		$route_to_check = $post_type && isset($this->_cpt_routes[$current_route])
+			? $this->_cpt_routes[$current_route]
+			: '';
+		add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3);
+		add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3);
+		if ($post_type === $route_to_check) {
+			add_filter('redirect_post_location', array($this, 'cpt_post_location_redirect'), 10, 2);
+		}
+		//now let's filter redirect if we're on a revision page and the revision is for an event CPT.
+		$revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
+		if ( ! empty($revision)) {
+			$action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null;
+			//doing a restore?
+			if ( ! empty($action) && $action === 'restore') {
+				//get post for revision
+				$rev_post = get_post($revision);
+				$rev_parent = get_post($rev_post->post_parent);
+				//only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
+				if ($rev_parent && $rev_parent->post_type === $this->page_slug) {
+					add_filter('wp_redirect', array($this, 'revision_redirect'), 10, 2);
+					//restores of revisions
+					add_action('wp_restore_post_revision', array($this, 'restore_revision'), 10, 2);
+				}
+			}
+		}
+		//NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
+		if ($post_type && $post_type === $route_to_check) {
+			//$post_id, $post
+			add_action('save_post', array($this, 'insert_update'), 10, 3);
+			//$post_id
+			add_action('trashed_post', array($this, 'before_trash_cpt_item'), 10);
+			add_action('trashed_post', array($this, 'dont_permanently_delete_ee_cpts'), 10);
+			add_action('untrashed_post', array($this, 'before_restore_cpt_item'), 10);
+			add_action('after_delete_post', array($this, 'before_delete_cpt_item'), 10);
+		}
+	}
+
+
+
+	/**
+	 * Callback for the WordPress trashed_post hook.
+	 * Execute some basic checks before calling the trash_cpt_item declared in the child class.
+	 *
+	 * @param int $post_id
+	 * @throws \EE_Error
+	 */
+	public function before_trash_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'trash');
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->trash_cpt_item($post_id);
+	}
+
+
+
+	/**
+	 * Callback for the WordPress untrashed_post hook.
+	 * Execute some basic checks before calling the restore_cpt_method in the child class.
+	 *
+	 * @param $post_id
+	 * @throws \EE_Error
+	 */
+	public function before_restore_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'restore');
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->restore_cpt_item($post_id);
+	}
+
+
+
+	/**
+	 * Callback for the WordPress after_delete_post hook.
+	 * Execute some basic checks before calling the delete_cpt_item method in the child class.
+	 *
+	 * @param $post_id
+	 * @throws \EE_Error
+	 */
+	public function before_delete_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'delete');
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->delete_cpt_item($post_id);
+	}
+
+
+
+	/**
+	 * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
+	 * accordingly.
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public function verify_cpt_object()
+	{
+		$label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
+		// verify event object
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			throw new EE_Error(sprintf(__('Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
+					'event_espresso'), $label));
+		}
+		//if auto-draft then throw an error
+		if ($this->_cpt_model_obj->get('status') === 'auto-draft') {
+			EE_Error::overwrite_errors();
+			EE_Error::add_error(sprintf(__('This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.'),
+					$label), __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply on ALL EE_Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+	}
+
+
+
+	/**
+	 * add in any global scripts for cpt routes
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		parent::load_global_scripts_styles();
+		if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
+			//setup custom post status object for localize script but only if we've got a cpt object
+			$statuses = $this->_cpt_model_obj->get_custom_post_statuses();
+			if ( ! empty($statuses)) {
+				//get ALL statuses!
+				$statuses = $this->_cpt_model_obj->get_all_post_statuses();
+				//setup object
+				$ee_cpt_statuses = array();
+				foreach ($statuses as $status => $label) {
+					$ee_cpt_statuses[$status] = array(
+						'label'      => $label,
+						'save_label' => sprintf(__('Save as %s', 'event_espresso'), $label),
+					);
+				}
+				wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
+			}
+		}
+	}
+
+
+
+	/**
+	 * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
+	 * insert/updates
+	 *
+	 * @param  int     $post_id ID of post being updated
+	 * @param  WP_Post $post    Post object from WP
+	 * @param  bool    $update  Whether this is an update or a new save.
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function insert_update($post_id, $post, $update)
+	{
+		//make sure that if this is a revision OR trash action that we don't do any updates!
+		if (
+			isset($this->_req_data['action'])
+			&& (
+				$this->_req_data['action'] === 'restore'
+				|| $this->_req_data['action'] === 'trash'
+			)
+		) {
+			return;
+		}
+		$this->_set_model_object($post_id, true, 'insert_update');
+		//if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
+		if ($update
+			&& (
+				! $this->_cpt_model_obj instanceof EE_CPT_Base
+				|| $this->_cpt_model_obj->ID() !== $post_id
+			)
+		) {
+			return;
+		}
+		//check for autosave and update our req_data property accordingly.
+		/*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
             foreach( (array) $this->_req_data['ee_autosave_data'] as $id => $values ) {
 
                 foreach ( (array) $values as $key => $value ) {
@@ -952,542 +952,542 @@ 
 
         }/**/ //TODO reactivate after autosave is implemented in 4.2
 
-        //take care of updating any selected page_template IF this cpt supports it.
-        if ($this->_supports_page_templates($post->post_type) && ! empty($this->_req_data['page_template'])) {
-            //wp version aware.
-            if (RecommendedVersions::compareWordPressVersion('4.7', '>=')) {
-                $page_templates = wp_get_theme()->get_page_templates();
-            } else {
-                $post->page_template = $this->_req_data['page_template'];
-                $page_templates      = wp_get_theme()->get_page_templates($post);
-            }
-            if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) {
-                EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            } else {
-                update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']);
-            }
-        }
-        if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
-            return;
-        } //TODO we'll remove this after reimplementing autosave in 4.2
-        $this->_insert_update_cpt_item($post_id, $post);
-    }
-
-
-
-    /**
-     * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
-     * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
-     * so we don't have to check for our CPT.
-     *
-     * @param  int $post_id ID of the post
-     * @return void
-     */
-    public function dont_permanently_delete_ee_cpts($post_id)
-    {
-        //only do this if we're actually processing one of our CPTs
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            return;
-        }
-        delete_post_meta($post_id, '_wp_trash_meta_status');
-        delete_post_meta($post_id, '_wp_trash_meta_time');
-        //our cpts may have comments so let's take care of that too
-        delete_post_meta($post_id, '_wp_trash_meta_comments_status');
-    }
-
-
-
-    /**
-     * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
-     * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
-     * in them. We also have our OWN action in here so addons can hook into the restore process easily.
-     *
-     * @param  int $post_id     ID of cpt item
-     * @param  int $revision_id ID of revision being restored
-     * @return void
-     */
-    public function restore_revision($post_id, $revision_id)
-    {
-        $this->_restore_cpt_item($post_id, $revision_id);
-        //global action
-        do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
-        //class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
-    }
-
-
-
-    /**
-     * @see restore_revision() for details
-     * @param  int $post_id     ID of cpt item
-     * @param  int $revision_id ID of revision for item
-     * @return void
-     */
-    abstract protected function _restore_cpt_item($post_id, $revision_id);
-
-
-
-    /**
-     * Execution of this method is added to the end of the load_page_dependencies method in the parent
-     * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
-     * To fix we have to reset the current_screen using the page_slug
-     * (which is identical - or should be - to our registered_post_type id.)
-     * Also, since the core WP file loads the admin_header.php for WP
-     * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
-     * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
-     *
-     * @return void
-     */
-    public function modify_current_screen()
-    {
-        //ONLY do this if the current page_route IS a cpt route
-        if ( ! $this->_cpt_route) {
-            return;
-        }
-        //routing things REALLY early b/c this is a cpt admin page
-        set_current_screen($this->_cpt_routes[$this->_req_action]);
-        $this->_current_screen       = get_current_screen();
-        $this->_current_screen->base = 'event-espresso';
-        $this->_add_help_tabs(); //we make sure we add any help tabs back in!
-        /*try {
+		//take care of updating any selected page_template IF this cpt supports it.
+		if ($this->_supports_page_templates($post->post_type) && ! empty($this->_req_data['page_template'])) {
+			//wp version aware.
+			if (RecommendedVersions::compareWordPressVersion('4.7', '>=')) {
+				$page_templates = wp_get_theme()->get_page_templates();
+			} else {
+				$post->page_template = $this->_req_data['page_template'];
+				$page_templates      = wp_get_theme()->get_page_templates($post);
+			}
+			if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) {
+				EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			} else {
+				update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']);
+			}
+		}
+		if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
+			return;
+		} //TODO we'll remove this after reimplementing autosave in 4.2
+		$this->_insert_update_cpt_item($post_id, $post);
+	}
+
+
+
+	/**
+	 * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
+	 * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
+	 * so we don't have to check for our CPT.
+	 *
+	 * @param  int $post_id ID of the post
+	 * @return void
+	 */
+	public function dont_permanently_delete_ee_cpts($post_id)
+	{
+		//only do this if we're actually processing one of our CPTs
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			return;
+		}
+		delete_post_meta($post_id, '_wp_trash_meta_status');
+		delete_post_meta($post_id, '_wp_trash_meta_time');
+		//our cpts may have comments so let's take care of that too
+		delete_post_meta($post_id, '_wp_trash_meta_comments_status');
+	}
+
+
+
+	/**
+	 * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
+	 * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
+	 * in them. We also have our OWN action in here so addons can hook into the restore process easily.
+	 *
+	 * @param  int $post_id     ID of cpt item
+	 * @param  int $revision_id ID of revision being restored
+	 * @return void
+	 */
+	public function restore_revision($post_id, $revision_id)
+	{
+		$this->_restore_cpt_item($post_id, $revision_id);
+		//global action
+		do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
+		//class specific action so you can limit hooking into a specific page.
+		do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+	}
+
+
+
+	/**
+	 * @see restore_revision() for details
+	 * @param  int $post_id     ID of cpt item
+	 * @param  int $revision_id ID of revision for item
+	 * @return void
+	 */
+	abstract protected function _restore_cpt_item($post_id, $revision_id);
+
+
+
+	/**
+	 * Execution of this method is added to the end of the load_page_dependencies method in the parent
+	 * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
+	 * To fix we have to reset the current_screen using the page_slug
+	 * (which is identical - or should be - to our registered_post_type id.)
+	 * Also, since the core WP file loads the admin_header.php for WP
+	 * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
+	 * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
+	 *
+	 * @return void
+	 */
+	public function modify_current_screen()
+	{
+		//ONLY do this if the current page_route IS a cpt route
+		if ( ! $this->_cpt_route) {
+			return;
+		}
+		//routing things REALLY early b/c this is a cpt admin page
+		set_current_screen($this->_cpt_routes[$this->_req_action]);
+		$this->_current_screen       = get_current_screen();
+		$this->_current_screen->base = 'event-espresso';
+		$this->_add_help_tabs(); //we make sure we add any help tabs back in!
+		/*try {
             $this->_route_admin_request();
         } catch ( EE_Error $e ) {
             $e->get_error();
         }/**/
-    }
-
-
-
-    /**
-     * This allows child classes to modify the default editor title that appears when people add a new or edit an
-     * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
-     * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
-     * default to be.
-     *
-     * @param string $title The new title (or existing if there is no editor_title defined)
-     * @return string
-     */
-    public function add_custom_editor_default_title($title)
-    {
-        return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]])
-            ? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]
-            : $title;
-    }
-
-
-
-    /**
-     * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
-     *
-     * @param string $shortlink   The already generated shortlink
-     * @param int    $id          Post ID for this item
-     * @param string $context     The context for the link
-     * @param bool   $allow_slugs Whether to allow post slugs in the shortlink.
-     * @return string
-     */
-    public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs)
-    {
-        if ( ! empty($id) && get_option('permalink_structure') !== '') {
-            $post = get_post($id);
-            if (isset($post->post_type) && $this->page_slug === $post->post_type) {
-                $shortlink = home_url('?p=' . $post->ID);
-            }
-        }
-        return $shortlink;
-    }
-
-
-
-    /**
-     * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
-     * already run in modify_current_screen())
-     *
-     * @return void
-     */
-    public function route_admin_request()
-    {
-        if ($this->_cpt_route) {
-            return;
-        }
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
-     *
-     * @return void
-     */
-    public function cpt_post_form_hidden_input()
-    {
-        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />';
-        //we're also going to add the route value and the current page so we can direct autosave parsing correctly
-        echo '<div id="ee-cpt-hidden-inputs">';
-        echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />';
-        echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />';
-        echo '</div>';
-    }
-
-
-
-    /**
-     * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
-     *
-     * @param  string $location Original location url
-     * @param  int    $status   Status for http header
-     * @return string           new (or original) url to redirect to.
-     */
-    public function revision_redirect($location, $status)
-    {
-        //get revision
-        $rev_id = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
-        //can't do anything without revision so let's get out if not present
-        if (empty($rev_id)) {
-            return $location;
-        }
-        //get rev_post_data
-        $rev = get_post($rev_id);
-        $admin_url = $this->_admin_base_url;
-        $query_args = array(
-            'action'   => 'edit',
-            'post'     => $rev->post_parent,
-            'revision' => $rev_id,
-            'message'  => 5,
-        );
-        $this->_process_notices($query_args, true);
-        return self::add_query_args_and_nonce($query_args, $admin_url);
-    }
-
-
-
-    /**
-     * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
-     *
-     * @param  string $link    the original generated link
-     * @param  int    $id      post id
-     * @param  string $context optional, defaults to display.  How to write the '&'
-     * @return string          the link
-     */
-    public function modify_edit_post_link($link, $id, $context)
-    {
-        $post = get_post($id);
-        if ( ! isset($this->_req_data['action'])
-             || ! isset($this->_cpt_routes[$this->_req_data['action']])
-             || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
-        ) {
-            return $link;
-        }
-        $query_args = array(
-            'action' => isset($this->_cpt_edit_routes[$post->post_type])
-                ? $this->_cpt_edit_routes[$post->post_type]
-                : 'edit',
-            'post'   => $id,
-        );
-        return self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-    }
-
-
-    /**
-     * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
-     * our routes.
-     *
-     * @param  string $delete_link  original delete link
-     * @param  int    $post_id      id of cpt object
-     * @param  bool   $force_delete whether this is forcing a hard delete instead of trash
-     * @return string new delete link
-     * @throws EE_Error
-     */
-    public function modify_delete_post_link($delete_link, $post_id, $force_delete)
-    {
-        $post = get_post($post_id);
-
-        if (empty($this->_req_data['action'])
-            || ! isset($this->_cpt_routes[$this->_req_data['action']])
-            || ! $post instanceof WP_Post
-            || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
-        ) {
-            return $delete_link;
-        }
-        $this->_set_model_object($post->ID, true);
-
-        //returns something like `trash_event` or `trash_attendee` or `trash_venue`
-        $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
-
-        return EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'page' => $this->_req_data['page'],
-                'action' => $action,
-                $this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name()
-                    => $post->ID
-            ),
-            admin_url()
-        );
-    }
-
-
-
-    /**
-     * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
-     * so that we can hijack the default redirect locations for wp custom post types
-     * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
-     *
-     * @param  string $location This is the incoming currently set redirect location
-     * @param  string $post_id  This is the 'ID' value of the wp_posts table
-     * @return string           the new location to redirect to
-     */
-    public function cpt_post_location_redirect($location, $post_id)
-    {
-        //we DO have a match so let's setup the url
-        //we have to get the post to determine our route
-        $post       = get_post($post_id);
-        $edit_route = $this->_cpt_edit_routes[$post->post_type];
-        //shared query_args
-        $query_args = array('action' => $edit_route, 'post' => $post_id);
-        $admin_url  = $this->_admin_base_url;
-        if (isset($this->_req_data['save']) || isset($this->_req_data['publish'])) {
-            $status = get_post_status($post_id);
-            if (isset($this->_req_data['publish'])) {
-                switch ($status) {
-                    case 'pending':
-                        $message = 8;
-                        break;
-                    case 'future':
-                        $message = 9;
-                        break;
-                    default:
-                        $message = 6;
-                }
-            } else {
-                $message = 'draft' === $status ? 10 : 1;
-            }
-        } else if (isset($this->_req_data['addmeta']) && $this->_req_data['addmeta']) {
-            $message = 2;
-            //			$append = '#postcustom';
-        } else if (isset($this->_req_data['deletemeta']) && $this->_req_data['deletemeta']) {
-            $message = 3;
-            //			$append = '#postcustom';
-        } elseif ($this->_req_data['action'] === 'post-quickpress-save-cont') {
-            $message = 7;
-        } else {
-            $message = 4;
-        }
-        //change the message if the post type is not viewable on the frontend
-        $this->_cpt_object = get_post_type_object($post->post_type);
-        $message           = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
-        $query_args = array_merge(array('message' => $message), $query_args);
-        $this->_process_notices($query_args, true);
-        return self::add_query_args_and_nonce($query_args, $admin_url);
-    }
-
-
-
-    /**
-     * This method is called to inject nav tabs on core WP cpt pages
-     *
-     * @access public
-     * @return void
-     */
-    public function inject_nav_tabs()
-    {
-        //can we hijack and insert the nav_tabs?
-        $nav_tabs = $this->_get_main_nav_tabs();
-        //first close off existing form tag
-        $html = '>';
-        $html .= $nav_tabs;
-        //now let's handle the remaining tag ( missing ">" is CORRECT )
-        $html .= '<span></span';
-        echo $html;
-    }
-
-
-
-    /**
-     * This just sets up the post update messages when an update form is loaded
-     *
-     * @access public
-     * @param  array $messages the original messages array
-     * @return array           the new messages array
-     */
-    public function post_update_messages($messages)
-    {
-        global $post;
-        $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
-        $id = empty($id) && is_object($post) ? $post->ID : null;
-        //		$post_type = $post ? $post->post_type : false;
-        /*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork';
+	}
+
+
+
+	/**
+	 * This allows child classes to modify the default editor title that appears when people add a new or edit an
+	 * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
+	 * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
+	 * default to be.
+	 *
+	 * @param string $title The new title (or existing if there is no editor_title defined)
+	 * @return string
+	 */
+	public function add_custom_editor_default_title($title)
+	{
+		return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]])
+			? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]
+			: $title;
+	}
+
+
+
+	/**
+	 * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
+	 *
+	 * @param string $shortlink   The already generated shortlink
+	 * @param int    $id          Post ID for this item
+	 * @param string $context     The context for the link
+	 * @param bool   $allow_slugs Whether to allow post slugs in the shortlink.
+	 * @return string
+	 */
+	public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs)
+	{
+		if ( ! empty($id) && get_option('permalink_structure') !== '') {
+			$post = get_post($id);
+			if (isset($post->post_type) && $this->page_slug === $post->post_type) {
+				$shortlink = home_url('?p=' . $post->ID);
+			}
+		}
+		return $shortlink;
+	}
+
+
+
+	/**
+	 * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
+	 * already run in modify_current_screen())
+	 *
+	 * @return void
+	 */
+	public function route_admin_request()
+	{
+		if ($this->_cpt_route) {
+			return;
+		}
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
+	 *
+	 * @return void
+	 */
+	public function cpt_post_form_hidden_input()
+	{
+		echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />';
+		//we're also going to add the route value and the current page so we can direct autosave parsing correctly
+		echo '<div id="ee-cpt-hidden-inputs">';
+		echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />';
+		echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />';
+		echo '</div>';
+	}
+
+
+
+	/**
+	 * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
+	 *
+	 * @param  string $location Original location url
+	 * @param  int    $status   Status for http header
+	 * @return string           new (or original) url to redirect to.
+	 */
+	public function revision_redirect($location, $status)
+	{
+		//get revision
+		$rev_id = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
+		//can't do anything without revision so let's get out if not present
+		if (empty($rev_id)) {
+			return $location;
+		}
+		//get rev_post_data
+		$rev = get_post($rev_id);
+		$admin_url = $this->_admin_base_url;
+		$query_args = array(
+			'action'   => 'edit',
+			'post'     => $rev->post_parent,
+			'revision' => $rev_id,
+			'message'  => 5,
+		);
+		$this->_process_notices($query_args, true);
+		return self::add_query_args_and_nonce($query_args, $admin_url);
+	}
+
+
+
+	/**
+	 * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
+	 *
+	 * @param  string $link    the original generated link
+	 * @param  int    $id      post id
+	 * @param  string $context optional, defaults to display.  How to write the '&'
+	 * @return string          the link
+	 */
+	public function modify_edit_post_link($link, $id, $context)
+	{
+		$post = get_post($id);
+		if ( ! isset($this->_req_data['action'])
+			 || ! isset($this->_cpt_routes[$this->_req_data['action']])
+			 || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
+		) {
+			return $link;
+		}
+		$query_args = array(
+			'action' => isset($this->_cpt_edit_routes[$post->post_type])
+				? $this->_cpt_edit_routes[$post->post_type]
+				: 'edit',
+			'post'   => $id,
+		);
+		return self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+	}
+
+
+	/**
+	 * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
+	 * our routes.
+	 *
+	 * @param  string $delete_link  original delete link
+	 * @param  int    $post_id      id of cpt object
+	 * @param  bool   $force_delete whether this is forcing a hard delete instead of trash
+	 * @return string new delete link
+	 * @throws EE_Error
+	 */
+	public function modify_delete_post_link($delete_link, $post_id, $force_delete)
+	{
+		$post = get_post($post_id);
+
+		if (empty($this->_req_data['action'])
+			|| ! isset($this->_cpt_routes[$this->_req_data['action']])
+			|| ! $post instanceof WP_Post
+			|| $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
+		) {
+			return $delete_link;
+		}
+		$this->_set_model_object($post->ID, true);
+
+		//returns something like `trash_event` or `trash_attendee` or `trash_venue`
+		$action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
+
+		return EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'page' => $this->_req_data['page'],
+				'action' => $action,
+				$this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name()
+					=> $post->ID
+			),
+			admin_url()
+		);
+	}
+
+
+
+	/**
+	 * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
+	 * so that we can hijack the default redirect locations for wp custom post types
+	 * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
+	 *
+	 * @param  string $location This is the incoming currently set redirect location
+	 * @param  string $post_id  This is the 'ID' value of the wp_posts table
+	 * @return string           the new location to redirect to
+	 */
+	public function cpt_post_location_redirect($location, $post_id)
+	{
+		//we DO have a match so let's setup the url
+		//we have to get the post to determine our route
+		$post       = get_post($post_id);
+		$edit_route = $this->_cpt_edit_routes[$post->post_type];
+		//shared query_args
+		$query_args = array('action' => $edit_route, 'post' => $post_id);
+		$admin_url  = $this->_admin_base_url;
+		if (isset($this->_req_data['save']) || isset($this->_req_data['publish'])) {
+			$status = get_post_status($post_id);
+			if (isset($this->_req_data['publish'])) {
+				switch ($status) {
+					case 'pending':
+						$message = 8;
+						break;
+					case 'future':
+						$message = 9;
+						break;
+					default:
+						$message = 6;
+				}
+			} else {
+				$message = 'draft' === $status ? 10 : 1;
+			}
+		} else if (isset($this->_req_data['addmeta']) && $this->_req_data['addmeta']) {
+			$message = 2;
+			//			$append = '#postcustom';
+		} else if (isset($this->_req_data['deletemeta']) && $this->_req_data['deletemeta']) {
+			$message = 3;
+			//			$append = '#postcustom';
+		} elseif ($this->_req_data['action'] === 'post-quickpress-save-cont') {
+			$message = 7;
+		} else {
+			$message = 4;
+		}
+		//change the message if the post type is not viewable on the frontend
+		$this->_cpt_object = get_post_type_object($post->post_type);
+		$message           = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
+		$query_args = array_merge(array('message' => $message), $query_args);
+		$this->_process_notices($query_args, true);
+		return self::add_query_args_and_nonce($query_args, $admin_url);
+	}
+
+
+
+	/**
+	 * This method is called to inject nav tabs on core WP cpt pages
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function inject_nav_tabs()
+	{
+		//can we hijack and insert the nav_tabs?
+		$nav_tabs = $this->_get_main_nav_tabs();
+		//first close off existing form tag
+		$html = '>';
+		$html .= $nav_tabs;
+		//now let's handle the remaining tag ( missing ">" is CORRECT )
+		$html .= '<span></span';
+		echo $html;
+	}
+
+
+
+	/**
+	 * This just sets up the post update messages when an update form is loaded
+	 *
+	 * @access public
+	 * @param  array $messages the original messages array
+	 * @return array           the new messages array
+	 */
+	public function post_update_messages($messages)
+	{
+		global $post;
+		$id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
+		$id = empty($id) && is_object($post) ? $post->ID : null;
+		//		$post_type = $post ? $post->post_type : false;
+		/*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork';
 
         $route_to_check = $post_type && isset( $this->_cpt_routes[$current_route]) ? $this->_cpt_routes[$current_route] : '';/**/
-        $messages[$post->post_type] = array(
-            0 => '', //Unused. Messages start at index 1.
-            1 => sprintf(
-                __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            2 => __('Custom field updated'),
-            3 => __('Custom field deleted.'),
-            4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false))
-                : false,
-            6 => sprintf(
-                __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            8 => sprintf(
-                __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
-                '</a>'
-            ),
-            9 => sprintf(
-                __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
-                '</a>'
-            ),
-            10 => sprintf(
-                __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
-                '</a>'
-            ),
-        );
-        return $messages;
-    }
-
-
-
-    /**
-     * default method for the 'create_new' route for cpt admin pages.
-     * For reference what to include in here, see wp-admin/post-new.php
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _create_new_cpt_item()
-    {
-        // gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        $post_type        = $this->_cpt_routes[$this->_req_action];
-        $post_type_object = $this->_cpt_object;
-        $title            = $post_type_object->labels->add_new_item;
-        $post    = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
-        add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
-        //modify the default editor title field with default title.
-        add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
-        $this->loadEditorTemplate(true);
-    }
-
-
-    /**
-     * Enqueues auto-save and loads the editor template
-     *
-     * @param bool $creating
-     */
-    private function loadEditorTemplate($creating = true) {
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        //these vars are used by the template
-        $editing = true;
-        $post_ID = $post->ID;
-        if (apply_filters('FHEE__EE_Admin_Page_CPT___create_new_cpt_item__replace_editor', false, $post) === false) {
-            //only enqueue autosave when creating event (necessary to get permalink/url generated)
-            //otherwise EE doesn't support autosave fully, so to prevent user confusion we disable it in edit context.
-            if ($creating) {
-                wp_enqueue_script('autosave');
-            } else {
-                if (isset($this->_cpt_routes[$this->_req_data['action']])
-                    && ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']])
-                ) {
-                    $create_new_action = apply_filters('FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
-                        'create_new', $this);
-                    $post_new_file = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action' => $create_new_action,
-                        'page'   => $this->page_slug,
-                    ), 'admin.php');
-                }
-            }
-            include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
-        }
-    }
-
-
-
-    public function add_new_admin_page_global()
-    {
-        $admin_page = ! empty($this->_req_data['post']) ? 'post-php' : 'post-new-php';
-        ?>
+		$messages[$post->post_type] = array(
+			0 => '', //Unused. Messages start at index 1.
+			1 => sprintf(
+				__('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			2 => __('Custom field updated'),
+			3 => __('Custom field deleted.'),
+			4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false))
+				: false,
+			6 => sprintf(
+				__('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			8 => sprintf(
+				__('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+				'</a>'
+			),
+			9 => sprintf(
+				__('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>',
+				'<a target="_blank" href="' . esc_url(get_permalink($id)),
+				'</a>'
+			),
+			10 => sprintf(
+				__('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+				'</a>'
+			),
+		);
+		return $messages;
+	}
+
+
+
+	/**
+	 * default method for the 'create_new' route for cpt admin pages.
+	 * For reference what to include in here, see wp-admin/post-new.php
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _create_new_cpt_item()
+	{
+		// gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		$post_type        = $this->_cpt_routes[$this->_req_action];
+		$post_type_object = $this->_cpt_object;
+		$title            = $post_type_object->labels->add_new_item;
+		$post    = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
+		add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
+		//modify the default editor title field with default title.
+		add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
+		$this->loadEditorTemplate(true);
+	}
+
+
+	/**
+	 * Enqueues auto-save and loads the editor template
+	 *
+	 * @param bool $creating
+	 */
+	private function loadEditorTemplate($creating = true) {
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		//these vars are used by the template
+		$editing = true;
+		$post_ID = $post->ID;
+		if (apply_filters('FHEE__EE_Admin_Page_CPT___create_new_cpt_item__replace_editor', false, $post) === false) {
+			//only enqueue autosave when creating event (necessary to get permalink/url generated)
+			//otherwise EE doesn't support autosave fully, so to prevent user confusion we disable it in edit context.
+			if ($creating) {
+				wp_enqueue_script('autosave');
+			} else {
+				if (isset($this->_cpt_routes[$this->_req_data['action']])
+					&& ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']])
+				) {
+					$create_new_action = apply_filters('FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
+						'create_new', $this);
+					$post_new_file = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action' => $create_new_action,
+						'page'   => $this->page_slug,
+					), 'admin.php');
+				}
+			}
+			include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+		}
+	}
+
+
+
+	public function add_new_admin_page_global()
+	{
+		$admin_page = ! empty($this->_req_data['post']) ? 'post-php' : 'post-new-php';
+		?>
         <script type="text/javascript">
             adminpage = '<?php echo $admin_page; ?>';
         </script>
         <?php
-    }
-
-
-
-    /**
-     * default method for the 'edit' route for cpt admin pages
-     * For reference on what to put in here, refer to wp-admin/post.php
-     *
-     * @access protected
-     * @return string   template for edit cpt form
-     */
-    protected function _edit_cpt_item()
-    {
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        $post_id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
-        $post = ! empty($post_id) ? get_post($post_id, OBJECT, 'edit') : null;
-        if (empty ($post)) {
-            wp_die(__('You attempted to edit an item that doesn&#8217;t exist. Perhaps it was deleted?'));
-        }
-        if ( ! empty($_GET['get-post-lock'])) {
-            wp_set_post_lock($post_id);
-            wp_redirect(get_edit_post_link($post_id, 'url'));
-            exit();
-        }
-
-        // template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        $post_type        = $this->_cpt_routes[$this->_req_action];
-        $post_type_object = $this->_cpt_object;
-
-        if ( ! wp_check_post_lock($post->ID)) {
-            wp_set_post_lock($post->ID);
-        }
-        add_action('admin_footer', '_admin_notice_post_locked');
-        if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) {
-            wp_enqueue_script('admin-comments');
-            enqueue_comment_hotkeys_js();
-        }
-        add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
-        //modify the default editor title field with default title.
-        add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
-        $this->loadEditorTemplate(false);
-    }
-
-
-
-    /**
-     * some getters
-     */
-    /**
-     * This returns the protected _cpt_model_obj property
-     *
-     * @return EE_CPT_Base
-     */
-    public function get_cpt_model_obj()
-    {
-        return $this->_cpt_model_obj;
-    }
+	}
+
+
+
+	/**
+	 * default method for the 'edit' route for cpt admin pages
+	 * For reference on what to put in here, refer to wp-admin/post.php
+	 *
+	 * @access protected
+	 * @return string   template for edit cpt form
+	 */
+	protected function _edit_cpt_item()
+	{
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		$post_id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
+		$post = ! empty($post_id) ? get_post($post_id, OBJECT, 'edit') : null;
+		if (empty ($post)) {
+			wp_die(__('You attempted to edit an item that doesn&#8217;t exist. Perhaps it was deleted?'));
+		}
+		if ( ! empty($_GET['get-post-lock'])) {
+			wp_set_post_lock($post_id);
+			wp_redirect(get_edit_post_link($post_id, 'url'));
+			exit();
+		}
+
+		// template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
+		$post_type        = $this->_cpt_routes[$this->_req_action];
+		$post_type_object = $this->_cpt_object;
+
+		if ( ! wp_check_post_lock($post->ID)) {
+			wp_set_post_lock($post->ID);
+		}
+		add_action('admin_footer', '_admin_notice_post_locked');
+		if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) {
+			wp_enqueue_script('admin-comments');
+			enqueue_comment_hotkeys_js();
+		}
+		add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
+		//modify the default editor title field with default title.
+		add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
+		$this->loadEditorTemplate(false);
+	}
+
+
+
+	/**
+	 * some getters
+	 */
+	/**
+	 * This returns the protected _cpt_model_obj property
+	 *
+	 * @return EE_CPT_Base
+	 */
+	public function get_cpt_model_obj()
+	{
+		return $this->_cpt_model_obj;
+	}
 
 }

Spacing +25 added lines, -25 removed lines

@@ -239,7 +239,7 @@ 
      */
     protected function _register_autosave_containers($ids)
     {
-        $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids);
+        $this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids);
     }
 
 
@@ -286,7 +286,7 @@ 
         //filter _autosave_containers
         $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
             $this->_autosave_containers, $this);
-        $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+        $containers = apply_filters('FHEE__EE_Admin_Page_CPT__'.get_class($this).'___load_autosave_scripts_styles__containers',
             $containers, $this);
 
         wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS',
@@ -398,7 +398,7 @@ 
         // This is for any plugins that are doing things properly
         // and hooking into the load page hook for core wp cpt routes.
         global $pagenow;
-        do_action('load-' . $pagenow);
+        do_action('load-'.$pagenow);
         $this->modify_current_screen();
         add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30);
         //we route REALLY early.
@@ -429,8 +429,8 @@ 
                 'admin.php?page=espresso_registrations&action=contact_list',
             ),
             1 => array(
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
+                'edit.php?post_type='.$this->_cpt_object->name,
+                'admin.php?page='.$this->_cpt_object->name,
             ),
         );
         foreach ($routes_to_match as $route_matches) {
@@ -458,7 +458,7 @@ 
         $cpt_has_support = ! empty($cpt_args['page_templates']);
 
         //if the installed version of WP is > 4.7 we do some additional checks.
-        if (RecommendedVersions::compareWordPressVersion('4.7','>=')) {
+        if (RecommendedVersions::compareWordPressVersion('4.7', '>=')) {
             $post_templates = wp_get_theme()->get_post_templates();
             //if there are $post_templates for this cpt, then we return false for this method because
             //that means we aren't going to load our page template manager and leave that up to the native
@@ -481,7 +481,7 @@ 
         global $post;
         $template = '';
 
-        if (RecommendedVersions::compareWordPressVersion('4.7','>=')) {
+        if (RecommendedVersions::compareWordPressVersion('4.7', '>=')) {
             $page_template_count = count(get_page_templates());
         } else {
             $page_template_count = count(get_page_templates($post));
@@ -518,7 +518,7 @@ 
         $post = get_post($id);
         if ('publish' !== get_post_status($post)) {
             //include shims for the `get_preview_post_link` function
-            require_once( EE_CORE . 'wordpress-shims.php' );
+            require_once(EE_CORE.'wordpress-shims.php');
             $return .= '<span_id="view-post-btn"><a target="_blank" href="'
                        . get_preview_post_link($id)
                        . '" class="button button-small">'
@@ -556,7 +556,7 @@ 
             $template_args['statuses']         = $statuses;
         }
 
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+        $template = EE_ADMIN_TEMPLATE.'status_dropdown.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -610,7 +610,7 @@ 
             $this->_template_args['success'] = true;
         }
         do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_'.get_class($this), $this);
         //now let's return json
         $this->_return_json();
     }
@@ -1013,7 +1013,7 @@ 
         //global action
         do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
         //class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+        do_action('AHEE_EE_Admin_Page_CPT_'.get_class($this).'__restore_revision', $post_id, $revision_id);
     }
 
 
@@ -1091,7 +1091,7 @@ 
         if ( ! empty($id) && get_option('permalink_structure') !== '') {
             $post = get_post($id);
             if (isset($post->post_type) && $this->page_slug === $post->post_type) {
-                $shortlink = home_url('?p=' . $post->ID);
+                $shortlink = home_url('?p='.$post->ID);
             }
         }
         return $shortlink;
@@ -1126,11 +1126,11 @@ 
      */
     public function cpt_post_form_hidden_input()
     {
-        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />';
+        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="'.$this->_admin_base_url.'" />';
         //we're also going to add the route value and the current page so we can direct autosave parsing correctly
         echo '<div id="ee-cpt-hidden-inputs">';
-        echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />';
-        echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />';
+        echo '<input type="hidden" id="current_route" name="current_route" value="'.$this->_current_view.'" />';
+        echo '<input type="hidden" id="current_page" name="current_page" value="'.$this->page_slug.'" />';
         echo '</div>';
     }
 
@@ -1217,7 +1217,7 @@ 
         $this->_set_model_object($post->ID, true);
 
         //returns something like `trash_event` or `trash_attendee` or `trash_venue`
-        $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
+        $action = 'trash_'.str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
 
         return EE_Admin_Page::add_query_args_and_nonce(
             array(
@@ -1328,39 +1328,39 @@ 
             1 => sprintf(
                 __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
+                '<a href="'.esc_url(get_permalink($id)).'">',
                 '</a>'
             ),
             2 => __('Custom field updated'),
             3 => __('Custom field deleted.'),
             4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
             5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false))
+                $this->_cpt_object->labels->singular_name, wp_post_revision_title((int) $_GET['revision'], false))
                 : false,
             6 => sprintf(
                 __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
+                '<a href="'.esc_url(get_permalink($id)).'">',
                 '</a>'
             ),
             7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
             8 => sprintf(
                 __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+                '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))).'">',
                 '</a>'
             ),
             9 => sprintf(
                 __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
+                '<strong>'.date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)).'</strong>',
+                '<a target="_blank" href="'.esc_url(get_permalink($id)),
                 '</a>'
             ),
             10 => sprintf(
                 __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+                '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))),
                 '</a>'
             ),
         );
@@ -1383,7 +1383,7 @@ 
         $post_type        = $this->_cpt_routes[$this->_req_action];
         $post_type_object = $this->_cpt_object;
         $title            = $post_type_object->labels->add_new_item;
-        $post    = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
+        $post = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
         add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
         //modify the default editor title field with default title.
         add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
@@ -1418,7 +1418,7 @@ 
                     ), 'admin.php');
                 }
             }
-            include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+            include_once WP_ADMIN_PATH.'edit-form-advanced.php';
         }
     }