eventespresso / event-espresso-core

core/db_classes/EE_Event.class.php

Indentation +1353 added lines, -1353 removed lines

@@ -13,1357 +13,1357 @@
 class EE_Event extends EE_CPT_Base implements EEI_Line_Item_Object, EEI_Admin_Links, EEI_Has_Icon, EEI_Event
 {
 
-    /**
-     * cached value for the the logical active status for the event
-     *
-     * @see get_active_status()
-     * @var string
-     */
-    protected $_active_status = '';
-
-    /**
-     * This is just used for caching the Primary Datetime for the Event on initial retrieval
-     *
-     * @var EE_Datetime
-     */
-    protected $_Primary_Datetime;
-
-    /**
-     * @var EventSpacesCalculator $available_spaces_calculator
-     */
-    protected $available_spaces_calculator;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Event
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Event
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return EventSpacesCalculator
-     * @throws \EE_Error
-     */
-    public function getAvailableSpacesCalculator()
-    {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
-            $this->available_spaces_calculator = new EventSpacesCalculator($this);
-        }
-        return $this->available_spaces_calculator;
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'status':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     *    set_status
-     * Checks if event status is being changed to SOLD OUT
-     * and updates event meta data with previous event status
-     * so that we can revert things if/when the event is no longer sold out
-     *
-     * @access public
-     * @param string $new_status
-     * @param bool   $use_default
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_status($new_status = null, $use_default = false)
-    {
-        // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
-        if (empty($new_status) && ! $use_default) {
-            return;
-        }
-        // get current Event status
-        $old_status = $this->status();
-        // if status has changed
-        if ($old_status !== $new_status) {
-            // TO sold_out
-            if ($new_status === EEM_Event::sold_out) {
-                // save the previous event status so that we can revert if the event is no longer sold out
-                $this->add_post_meta('_previous_event_status', $old_status);
-                do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
-                // OR FROM  sold_out
-            } elseif ($old_status === EEM_Event::sold_out) {
-                $this->delete_post_meta('_previous_event_status');
-                do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
-            }
-            // clear out the active status so that it gets reset the next time it is requested
-            $this->_active_status = null;
-            // update status
-            parent::set('status', $new_status, $use_default);
-            do_action('AHEE__EE_Event__set_status__after_update', $this);
-            return;
-        }
-        // even though the old value matches the new value, it's still good to
-        // allow the parent set method to have a say
-        parent::set('status', $new_status, $use_default);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes($query_params = array())
-    {
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
-     *
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_in_chronological_order()
-    {
-        return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
-     * @darren, we should probably UNSET timezone on the EEM_Datetime model
-     * after running our query, so that this timezone isn't set for EVERY query
-     * on EEM_Datetime for the rest of the request, no?
-     *
-     * @param boolean $show_expired whether or not to include expired events
-     * @param boolean $show_deleted whether or not to include deleted events
-     * @param null    $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted,
-            $limit
-        );
-    }
-
-
-    /**
-     * Returns one related datetime. Mostly only used by some legacy code.
-     *
-     * @return EE_Base_Class|EE_Datetime
-     * @throws EE_Error
-     */
-    public function first_datetime()
-    {
-        return $this->get_first_related('Datetime');
-    }
-
-
-    /**
-     * Returns the 'primary' datetime for the event
-     *
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
-    {
-        if (! empty($this->_Primary_Datetime)) {
-            return $this->_Primary_Datetime;
-        }
-        $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
-            $this->ID(),
-            $try_to_exclude_expired,
-            $try_to_exclude_deleted
-        );
-        return $this->_Primary_Datetime;
-    }
-
-
-    /**
-     * Gets all the tickets available for purchase of this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function tickets($query_params = array())
-    {
-        // first get all datetimes
-        $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
-            return array();
-        }
-        $datetime_ids = array();
-        foreach ($datetimes as $datetime) {
-            $datetime_ids[] = $datetime->ID();
-        }
-        $where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
-        // if incoming $query_params has where conditions let's merge but not override existing.
-        if (is_array($query_params) && isset($query_params[0])) {
-            $where_params = array_merge($query_params[0], $where_params);
-            unset($query_params[0]);
-        }
-        // now add $where_params to $query_params
-        $query_params[0] = $where_params;
-        return EEM_Ticket::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * get all unexpired untrashed tickets
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function active_tickets()
-    {
-        return $this->tickets(
-            array(
-                array(
-                    'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
-                    'TKT_deleted'  => false,
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function additional_limit()
-    {
-        return $this->get('EVT_additional_limit');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function allow_overflow()
-    {
-        return $this->get('EVT_allow_overflow');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function created()
-    {
-        return $this->get('EVT_created');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('EVT_desc');
-    }
-
-
-    /**
-     * Runs do_shortcode and wpautop on the description
-     *
-     * @return string of html
-     * @throws EE_Error
-     */
-    public function description_filtered()
-    {
-        return $this->get_pretty('EVT_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_description()
-    {
-        return $this->get('EVT_display_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_ticket_selector()
-    {
-        return (bool) $this->get('EVT_display_ticket_selector');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function external_url()
-    {
-        return $this->get('EVT_external_URL');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function member_only()
-    {
-        return $this->get('EVT_member_only');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function phone()
-    {
-        return $this->get('EVT_phone');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function modified()
-    {
-        return $this->get('EVT_modified');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('EVT_name');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function order()
-    {
-        return $this->get('EVT_order');
-    }
-
-
-    /**
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function default_registration_status()
-    {
-        $event_default_registration_status = $this->get('EVT_default_registration_status');
-        return ! empty($event_default_registration_status)
-            ? $event_default_registration_status
-            : EE_Registry::instance()->CFG->registration->default_STS_ID;
-    }
-
-
-    /**
-     * @param int  $num_words
-     * @param null $more
-     * @param bool $not_full_desc
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function short_description($num_words = 55, $more = null, $not_full_desc = false)
-    {
-        $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
-            return $short_desc;
-        }
-        $full_desc = $this->get('EVT_desc');
-        return wp_trim_words($full_desc, $num_words, $more);
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function slug()
-    {
-        return $this->get('EVT_slug');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function timezone_string()
-    {
-        return $this->get('EVT_timezone_string');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function visible_on()
-    {
-        return $this->get('EVT_visible_on');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('EVT_wp_user');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function donations()
-    {
-        return $this->get('EVT_donations');
-    }
-
-
-    /**
-     * @param $limit
-     * @throws EE_Error
-     */
-    public function set_additional_limit($limit)
-    {
-        $this->set('EVT_additional_limit', $limit);
-    }
-
-
-    /**
-     * @param $created
-     * @throws EE_Error
-     */
-    public function set_created($created)
-    {
-        $this->set('EVT_created', $created);
-    }
-
-
-    /**
-     * @param $desc
-     * @throws EE_Error
-     */
-    public function set_description($desc)
-    {
-        $this->set('EVT_desc', $desc);
-    }
-
-
-    /**
-     * @param $display_desc
-     * @throws EE_Error
-     */
-    public function set_display_description($display_desc)
-    {
-        $this->set('EVT_display_desc', $display_desc);
-    }
-
-
-    /**
-     * @param $display_ticket_selector
-     * @throws EE_Error
-     */
-    public function set_display_ticket_selector($display_ticket_selector)
-    {
-        $this->set('EVT_display_ticket_selector', $display_ticket_selector);
-    }
-
-
-    /**
-     * @param $external_url
-     * @throws EE_Error
-     */
-    public function set_external_url($external_url)
-    {
-        $this->set('EVT_external_URL', $external_url);
-    }
-
-
-    /**
-     * @param $member_only
-     * @throws EE_Error
-     */
-    public function set_member_only($member_only)
-    {
-        $this->set('EVT_member_only', $member_only);
-    }
-
-
-    /**
-     * @param $event_phone
-     * @throws EE_Error
-     */
-    public function set_event_phone($event_phone)
-    {
-        $this->set('EVT_phone', $event_phone);
-    }
-
-
-    /**
-     * @param $modified
-     * @throws EE_Error
-     */
-    public function set_modified($modified)
-    {
-        $this->set('EVT_modified', $modified);
-    }
-
-
-    /**
-     * @param $name
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('EVT_name', $name);
-    }
-
-
-    /**
-     * @param $order
-     * @throws EE_Error
-     */
-    public function set_order($order)
-    {
-        $this->set('EVT_order', $order);
-    }
-
-
-    /**
-     * @param $short_desc
-     * @throws EE_Error
-     */
-    public function set_short_description($short_desc)
-    {
-        $this->set('EVT_short_desc', $short_desc);
-    }
-
-
-    /**
-     * @param $slug
-     * @throws EE_Error
-     */
-    public function set_slug($slug)
-    {
-        $this->set('EVT_slug', $slug);
-    }
-
-
-    /**
-     * @param $timezone_string
-     * @throws EE_Error
-     */
-    public function set_timezone_string($timezone_string)
-    {
-        $this->set('EVT_timezone_string', $timezone_string);
-    }
-
-
-    /**
-     * @param $visible_on
-     * @throws EE_Error
-     */
-    public function set_visible_on($visible_on)
-    {
-        $this->set('EVT_visible_on', $visible_on);
-    }
-
-
-    /**
-     * @param $wp_user
-     * @throws EE_Error
-     */
-    public function set_wp_user($wp_user)
-    {
-        $this->set('EVT_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param $default_registration_status
-     * @throws EE_Error
-     */
-    public function set_default_registration_status($default_registration_status)
-    {
-        $this->set('EVT_default_registration_status', $default_registration_status);
-    }
-
-
-    /**
-     * @param $donations
-     * @throws EE_Error
-     */
-    public function set_donations($donations)
-    {
-        $this->set('EVT_donations', $donations);
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function add_venue($venue_id_or_obj)
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function remove_venue($venue_id_or_obj)
-    {
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets all the venues related ot the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Venue[]
-     * @throws EE_Error
-     */
-    public function venues($query_params = array())
-    {
-        return $this->get_many_related('Venue', $query_params);
-    }
-
-
-    /**
-     * check if event id is present and if event is published
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    private function _has_ID_and_is_published()
-    {
-        // first check if event id is present and not NULL,
-        // then check if this event is published (or any of the equivalent "published" statuses)
-        return
-            $this->ID() && $this->ID() !== null
-            && (
-                $this->status() === 'publish'
-                || $this->status() === EEM_Event::sold_out
-                || $this->status() === EEM_Event::postponed
-                || $this->status() === EEM_Event::cancelled
-            );
-    }
-
-
-    /**
-     * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    public function is_upcoming()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $upcoming = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is active then we return false.
-                if ($datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check upcoming status
-                $upcoming = $datetime->is_upcoming();
-            }
-        }
-        return $upcoming;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $active = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be active.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is upcoming then we return false.
-                if ($datetime->is_upcoming()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $active = $datetime->is_active();
-            }
-        }
-        return $active;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_expired()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $expired = false;
-        // first let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is upcoming or active then we return false.
-                if ($datetime->is_upcoming() || $datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $expired = $datetime->is_expired();
-            }
-        }
-        return $expired;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_inactive()
-    {
-        // check if event id is present and if this event is published
-        if ($this->_has_ID_and_is_published()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @param array $tickets
-     * @param bool  $filtered
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining($tickets = array(), $filtered = true)
-    {
-        $this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
-        $spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
-        return $filtered
-            ? apply_filters(
-                'FHEE_EE_Event__spaces_remaining',
-                $spaces_remaining,
-                $this,
-                $tickets
-            )
-            : $spaces_remaining;
-    }
-
-
-    /**
-     *    perform_sold_out_status_check
-     *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
-     *    available... if NOT, then the event status will get toggled to 'sold_out'
-     *
-     * @return bool    return the ACTUAL sold out state.
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function perform_sold_out_status_check()
-    {
-        // get all unexpired untrashed tickets
-        $tickets = $this->tickets(
-            array(
-                array('TKT_deleted' => false),
-                'order_by' => array('TKT_qty' => 'ASC'),
-            )
-        );
-        $all_expired = true;
-        foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
-                $all_expired = false;
-                break;
-            }
-        }
-        // if all the tickets are just expired, then don't update the event status to sold out
-        if ($all_expired) {
-            return true;
-        }
-        $spaces_remaining = $this->spaces_remaining($tickets);
-        if ($spaces_remaining < 1) {
-            if ($this->status() !== EEM_Event::post_status_private) {
-                $this->set_status(EEM_Event::sold_out);
-                $this->save();
-            }
-            $sold_out = true;
-        } else {
-            $sold_out = false;
-            // was event previously marked as sold out ?
-            if ($this->status() === EEM_Event::sold_out) {
-                // revert status to previous value, if it was set
-                $previous_event_status = $this->get_post_meta('_previous_event_status', true);
-                if ($previous_event_status) {
-                    $this->set_status($previous_event_status);
-                    $this->save();
-                }
-            }
-        }
-        do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
-        return $sold_out;
-    }
-
-
-    /**
-     * This returns the total remaining spaces for sale on this event.
-     *
-     * @uses EE_Event::total_available_spaces()
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining_for_sale()
-    {
-        return $this->total_available_spaces(true);
-    }
-
-
-    /**
-     * This returns the total spaces available for an event
-     * while considering all the qtys on the tickets and the reg limits
-     * on the datetimes attached to this event.
-     *
-     * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
-     *                              If this is false, then we return the most tickets that could ever be sold
-     *                              for this event with the datetime and tickets setup on the event under optimal
-     *                              selling conditions.  Otherwise we return a live calculation of spaces available
-     *                              based on tickets sold.  Depending on setup and stage of sales, this
-     *                              may appear to equal remaining tickets.  However, the more tickets are
-     *                              sold out, the more accurate the "live" total is.
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function total_available_spaces($consider_sold = false)
-    {
-        $spaces_available = $consider_sold
-            ? $this->getAvailableSpacesCalculator()->spacesRemaining()
-            : $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
-        return apply_filters(
-            'FHEE_EE_Event__total_available_spaces__spaces_available',
-            $spaces_available,
-            $this,
-            $this->getAvailableSpacesCalculator()->getDatetimes(),
-            $this->getAvailableSpacesCalculator()->getActiveTickets()
-        );
-    }
-
-
-    /**
-     * Checks if the event is set to sold out
-     *
-     * @param  bool $actual whether or not to perform calculations to not only figure the
-     *                      actual status but also to flip the status if necessary to sold
-     *                      out If false, we just check the existing status of the event
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_sold_out($actual = false)
-    {
-        if (! $actual) {
-            return $this->status() === EEM_Event::sold_out;
-        }
-        return $this->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Checks if the event is marked as postponed
-     *
-     * @return boolean
-     */
-    public function is_postponed()
-    {
-        return $this->status() === EEM_Event::postponed;
-    }
-
-
-    /**
-     * Checks if the event is marked as cancelled
-     *
-     * @return boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status() === EEM_Event::cancelled;
-    }
-
-
-    /**
-     * Get the logical active status in a hierarchical order for all the datetimes.  Note
-     * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
-     * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
-     * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
-     * the event is considered expired.
-     * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
-     * status set on the EVENT when it is not published and thus is done
-     *
-     * @param bool $reset
-     * @return bool | string - based on EE_Datetime active constants or FALSE if error.
-     * @throws EE_Error
-     */
-    public function get_active_status($reset = false)
-    {
-        // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
-            return $this->_active_status;
-        }
-        // first check if event id is present on this object
-        if (! $this->ID()) {
-            return false;
-        }
-        $where_params_for_event = array(array('EVT_ID' => $this->ID()));
-        // if event is published:
-        if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
-            // active?
-            if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                EE_Datetime::active,
-                $where_params_for_event
-            ) > 0) {
-                $this->_active_status = EE_Datetime::active;
-            } else {
-                // upcoming?
-                if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                    EE_Datetime::upcoming,
-                    $where_params_for_event
-                ) > 0) {
-                    $this->_active_status = EE_Datetime::upcoming;
-                } else {
-                    // expired?
-                    if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                        EE_Datetime::expired,
-                        $where_params_for_event
-                    ) > 0
-                    ) {
-                        $this->_active_status = EE_Datetime::expired;
-                    } else {
-                        // it would be odd if things make it this far because it basically means there are no datetime's
-                        // attached to the event.  So in this case it will just be considered inactive.
-                        $this->_active_status = EE_Datetime::inactive;
-                    }
-                }
-            }
-        } else {
-            // the event is not published, so let's just set it's active status according to its' post status
-            switch ($this->status()) {
-                case EEM_Event::sold_out:
-                    $this->_active_status = EE_Datetime::sold_out;
-                    break;
-                case EEM_Event::cancelled:
-                    $this->_active_status = EE_Datetime::cancelled;
-                    break;
-                case EEM_Event::postponed:
-                    $this->_active_status = EE_Datetime::postponed;
-                    break;
-                default:
-                    $this->_active_status = EE_Datetime::inactive;
-            }
-        }
-        return $this->_active_status;
-    }
-
-
-    /**
-     *    pretty_active_status
-     *
-     * @access public
-     * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
-     * @return mixed void|string
-     * @throws EE_Error
-     */
-    public function pretty_active_status($echo = true)
-    {
-        $active_status = $this->get_active_status();
-        $status = '<span class="ee-status event-active-status-'
-                  . $active_status
-                  . '">'
-                  . EEH_Template::pretty_status($active_status, false, 'sentence')
-                  . '</span>';
-        if ($echo) {
-            echo $status;
-            return '';
-        }
-        return $status;
-    }
-
-
-    /**
-     * @return bool|int
-     * @throws EE_Error
-     */
-    public function get_number_of_tickets_sold()
-    {
-        $tkt_sold = 0;
-        if (! $this->ID()) {
-            return 0;
-        }
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $tkt_sold += $datetime->sold();
-            }
-        }
-        return $tkt_sold;
-    }
-
-
-    /**
-     * This just returns a count of all the registrations for this event
-     *
-     * @access  public
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_count_of_all_registrations()
-    {
-        return EEM_Event::instance()->count_related($this, 'Registration');
-    }
-
-
-    /**
-     * This returns the ticket with the earliest start time that is
-     * available for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     */
-    public function get_ticket_with_earliest_start_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the ticket with the latest end time that is available
-     * for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     */
-    public function get_ticket_with_latest_end_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the number of different ticket types currently on sale for this event.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function countTicketsOnSale()
-    {
-        $where = array(
-            'Datetime.EVT_ID' => $this->ID(),
-            'TKT_start_date'  => array('<', time()),
-            'TKT_end_date'    => array('>', time()),
-        );
-        return EEM_Ticket::instance()->count(array($where));
-    }
-
-
-    /**
-     * This returns whether there are any tickets on sale for this event.
-     *
-     * @return bool true = YES tickets on sale.
-     * @throws EE_Error
-     */
-    public function tickets_on_sale()
-    {
-        return $this->countTicketsOnSale() > 0;
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end. Overrides parent
-     * to check for an external URL first
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_permalink()
-    {
-        if ($this->external_url()) {
-            return $this->external_url();
-        }
-        return parent::get_permalink();
-    }
-
-
-    /**
-     * Gets the first term for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class|EE_Term|null
-     * @throws EE_Error
-     */
-    public function first_event_category($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_one($query_params);
-    }
-
-
-    /**
-     * Gets all terms for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Term[]
-     * @throws EE_Error
-     */
-    public function get_all_event_categories($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Adds a question group to this event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool                  $for_primary if true, the question group will be added for the primary
-     *                                           registrant, if false will be added for others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     */
-    public function add_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        $extra = $for_primary
-            ? array('EQG_primary' => 1)
-            : array();
-        return $this->_add_relation_to($question_group_id_or_obj, 'Question_Group', $extra);
-    }
-
-
-    /**
-     * Removes a question group from the event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool                  $for_primary if true, the question group will be removed from the primary
-     *                                           registrant, if false will be removed from others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     */
-    public function remove_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        $where = $for_primary
-            ? array('EQG_primary' => 1)
-            : array();
-        return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group', $where);
-    }
-
-
-    /**
-     * Gets all the question groups, ordering them by QSG_order ascending
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Question_Group[]
-     * @throws EE_Error
-     */
-    public function question_groups($query_params = array())
-    {
-        $query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
-        return $this->get_many_related('Question_Group', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @see EEI_Visual_Representation for comments
-     * @return string
-     */
-    public function get_icon()
-    {
-        return '<span class="dashicons dashicons-flag"></span>';
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_edit_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'edit',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default_event_settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * cached value for the the logical active status for the event
+	 *
+	 * @see get_active_status()
+	 * @var string
+	 */
+	protected $_active_status = '';
+
+	/**
+	 * This is just used for caching the Primary Datetime for the Event on initial retrieval
+	 *
+	 * @var EE_Datetime
+	 */
+	protected $_Primary_Datetime;
+
+	/**
+	 * @var EventSpacesCalculator $available_spaces_calculator
+	 */
+	protected $available_spaces_calculator;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Event
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Event
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return EventSpacesCalculator
+	 * @throws \EE_Error
+	 */
+	public function getAvailableSpacesCalculator()
+	{
+		if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+			$this->available_spaces_calculator = new EventSpacesCalculator($this);
+		}
+		return $this->available_spaces_calculator;
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'status':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 *    set_status
+	 * Checks if event status is being changed to SOLD OUT
+	 * and updates event meta data with previous event status
+	 * so that we can revert things if/when the event is no longer sold out
+	 *
+	 * @access public
+	 * @param string $new_status
+	 * @param bool   $use_default
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_status($new_status = null, $use_default = false)
+	{
+		// if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
+		if (empty($new_status) && ! $use_default) {
+			return;
+		}
+		// get current Event status
+		$old_status = $this->status();
+		// if status has changed
+		if ($old_status !== $new_status) {
+			// TO sold_out
+			if ($new_status === EEM_Event::sold_out) {
+				// save the previous event status so that we can revert if the event is no longer sold out
+				$this->add_post_meta('_previous_event_status', $old_status);
+				do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
+				// OR FROM  sold_out
+			} elseif ($old_status === EEM_Event::sold_out) {
+				$this->delete_post_meta('_previous_event_status');
+				do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
+			}
+			// clear out the active status so that it gets reset the next time it is requested
+			$this->_active_status = null;
+			// update status
+			parent::set('status', $new_status, $use_default);
+			do_action('AHEE__EE_Event__set_status__after_update', $this);
+			return;
+		}
+		// even though the old value matches the new value, it's still good to
+		// allow the parent set method to have a say
+		parent::set('status', $new_status, $use_default);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes($query_params = array())
+	{
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
+	 *
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_in_chronological_order()
+	{
+		return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
+	 * @darren, we should probably UNSET timezone on the EEM_Datetime model
+	 * after running our query, so that this timezone isn't set for EVERY query
+	 * on EEM_Datetime for the rest of the request, no?
+	 *
+	 * @param boolean $show_expired whether or not to include expired events
+	 * @param boolean $show_deleted whether or not to include deleted events
+	 * @param null    $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted,
+			$limit
+		);
+	}
+
+
+	/**
+	 * Returns one related datetime. Mostly only used by some legacy code.
+	 *
+	 * @return EE_Base_Class|EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function first_datetime()
+	{
+		return $this->get_first_related('Datetime');
+	}
+
+
+	/**
+	 * Returns the 'primary' datetime for the event
+	 *
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
+	{
+		if (! empty($this->_Primary_Datetime)) {
+			return $this->_Primary_Datetime;
+		}
+		$this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
+			$this->ID(),
+			$try_to_exclude_expired,
+			$try_to_exclude_deleted
+		);
+		return $this->_Primary_Datetime;
+	}
+
+
+	/**
+	 * Gets all the tickets available for purchase of this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function tickets($query_params = array())
+	{
+		// first get all datetimes
+		$datetimes = $this->datetimes_ordered();
+		if (! $datetimes) {
+			return array();
+		}
+		$datetime_ids = array();
+		foreach ($datetimes as $datetime) {
+			$datetime_ids[] = $datetime->ID();
+		}
+		$where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
+		// if incoming $query_params has where conditions let's merge but not override existing.
+		if (is_array($query_params) && isset($query_params[0])) {
+			$where_params = array_merge($query_params[0], $where_params);
+			unset($query_params[0]);
+		}
+		// now add $where_params to $query_params
+		$query_params[0] = $where_params;
+		return EEM_Ticket::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * get all unexpired untrashed tickets
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function active_tickets()
+	{
+		return $this->tickets(
+			array(
+				array(
+					'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
+					'TKT_deleted'  => false,
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function additional_limit()
+	{
+		return $this->get('EVT_additional_limit');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function allow_overflow()
+	{
+		return $this->get('EVT_allow_overflow');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function created()
+	{
+		return $this->get('EVT_created');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('EVT_desc');
+	}
+
+
+	/**
+	 * Runs do_shortcode and wpautop on the description
+	 *
+	 * @return string of html
+	 * @throws EE_Error
+	 */
+	public function description_filtered()
+	{
+		return $this->get_pretty('EVT_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_description()
+	{
+		return $this->get('EVT_display_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_ticket_selector()
+	{
+		return (bool) $this->get('EVT_display_ticket_selector');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function external_url()
+	{
+		return $this->get('EVT_external_URL');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function member_only()
+	{
+		return $this->get('EVT_member_only');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function phone()
+	{
+		return $this->get('EVT_phone');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function modified()
+	{
+		return $this->get('EVT_modified');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('EVT_name');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function order()
+	{
+		return $this->get('EVT_order');
+	}
+
+
+	/**
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function default_registration_status()
+	{
+		$event_default_registration_status = $this->get('EVT_default_registration_status');
+		return ! empty($event_default_registration_status)
+			? $event_default_registration_status
+			: EE_Registry::instance()->CFG->registration->default_STS_ID;
+	}
+
+
+	/**
+	 * @param int  $num_words
+	 * @param null $more
+	 * @param bool $not_full_desc
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function short_description($num_words = 55, $more = null, $not_full_desc = false)
+	{
+		$short_desc = $this->get('EVT_short_desc');
+		if (! empty($short_desc) || $not_full_desc) {
+			return $short_desc;
+		}
+		$full_desc = $this->get('EVT_desc');
+		return wp_trim_words($full_desc, $num_words, $more);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function slug()
+	{
+		return $this->get('EVT_slug');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function timezone_string()
+	{
+		return $this->get('EVT_timezone_string');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function visible_on()
+	{
+		return $this->get('EVT_visible_on');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('EVT_wp_user');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function donations()
+	{
+		return $this->get('EVT_donations');
+	}
+
+
+	/**
+	 * @param $limit
+	 * @throws EE_Error
+	 */
+	public function set_additional_limit($limit)
+	{
+		$this->set('EVT_additional_limit', $limit);
+	}
+
+
+	/**
+	 * @param $created
+	 * @throws EE_Error
+	 */
+	public function set_created($created)
+	{
+		$this->set('EVT_created', $created);
+	}
+
+
+	/**
+	 * @param $desc
+	 * @throws EE_Error
+	 */
+	public function set_description($desc)
+	{
+		$this->set('EVT_desc', $desc);
+	}
+
+
+	/**
+	 * @param $display_desc
+	 * @throws EE_Error
+	 */
+	public function set_display_description($display_desc)
+	{
+		$this->set('EVT_display_desc', $display_desc);
+	}
+
+
+	/**
+	 * @param $display_ticket_selector
+	 * @throws EE_Error
+	 */
+	public function set_display_ticket_selector($display_ticket_selector)
+	{
+		$this->set('EVT_display_ticket_selector', $display_ticket_selector);
+	}
+
+
+	/**
+	 * @param $external_url
+	 * @throws EE_Error
+	 */
+	public function set_external_url($external_url)
+	{
+		$this->set('EVT_external_URL', $external_url);
+	}
+
+
+	/**
+	 * @param $member_only
+	 * @throws EE_Error
+	 */
+	public function set_member_only($member_only)
+	{
+		$this->set('EVT_member_only', $member_only);
+	}
+
+
+	/**
+	 * @param $event_phone
+	 * @throws EE_Error
+	 */
+	public function set_event_phone($event_phone)
+	{
+		$this->set('EVT_phone', $event_phone);
+	}
+
+
+	/**
+	 * @param $modified
+	 * @throws EE_Error
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('EVT_modified', $modified);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('EVT_name', $name);
+	}
+
+
+	/**
+	 * @param $order
+	 * @throws EE_Error
+	 */
+	public function set_order($order)
+	{
+		$this->set('EVT_order', $order);
+	}
+
+
+	/**
+	 * @param $short_desc
+	 * @throws EE_Error
+	 */
+	public function set_short_description($short_desc)
+	{
+		$this->set('EVT_short_desc', $short_desc);
+	}
+
+
+	/**
+	 * @param $slug
+	 * @throws EE_Error
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('EVT_slug', $slug);
+	}
+
+
+	/**
+	 * @param $timezone_string
+	 * @throws EE_Error
+	 */
+	public function set_timezone_string($timezone_string)
+	{
+		$this->set('EVT_timezone_string', $timezone_string);
+	}
+
+
+	/**
+	 * @param $visible_on
+	 * @throws EE_Error
+	 */
+	public function set_visible_on($visible_on)
+	{
+		$this->set('EVT_visible_on', $visible_on);
+	}
+
+
+	/**
+	 * @param $wp_user
+	 * @throws EE_Error
+	 */
+	public function set_wp_user($wp_user)
+	{
+		$this->set('EVT_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param $default_registration_status
+	 * @throws EE_Error
+	 */
+	public function set_default_registration_status($default_registration_status)
+	{
+		$this->set('EVT_default_registration_status', $default_registration_status);
+	}
+
+
+	/**
+	 * @param $donations
+	 * @throws EE_Error
+	 */
+	public function set_donations($donations)
+	{
+		$this->set('EVT_donations', $donations);
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function add_venue($venue_id_or_obj)
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function remove_venue($venue_id_or_obj)
+	{
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets all the venues related ot the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Venue[]
+	 * @throws EE_Error
+	 */
+	public function venues($query_params = array())
+	{
+		return $this->get_many_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * check if event id is present and if event is published
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	private function _has_ID_and_is_published()
+	{
+		// first check if event id is present and not NULL,
+		// then check if this event is published (or any of the equivalent "published" statuses)
+		return
+			$this->ID() && $this->ID() !== null
+			&& (
+				$this->status() === 'publish'
+				|| $this->status() === EEM_Event::sold_out
+				|| $this->status() === EEM_Event::postponed
+				|| $this->status() === EEM_Event::cancelled
+			);
+	}
+
+
+	/**
+	 * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	public function is_upcoming()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$upcoming = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is active then we return false.
+				if ($datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check upcoming status
+				$upcoming = $datetime->is_upcoming();
+			}
+		}
+		return $upcoming;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$active = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be active.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is upcoming then we return false.
+				if ($datetime->is_upcoming()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$active = $datetime->is_active();
+			}
+		}
+		return $active;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_expired()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$expired = false;
+		// first let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is upcoming or active then we return false.
+				if ($datetime->is_upcoming() || $datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$expired = $datetime->is_expired();
+			}
+		}
+		return $expired;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_inactive()
+	{
+		// check if event id is present and if this event is published
+		if ($this->_has_ID_and_is_published()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @param array $tickets
+	 * @param bool  $filtered
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining($tickets = array(), $filtered = true)
+	{
+		$this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
+		$spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
+		return $filtered
+			? apply_filters(
+				'FHEE_EE_Event__spaces_remaining',
+				$spaces_remaining,
+				$this,
+				$tickets
+			)
+			: $spaces_remaining;
+	}
+
+
+	/**
+	 *    perform_sold_out_status_check
+	 *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
+	 *    available... if NOT, then the event status will get toggled to 'sold_out'
+	 *
+	 * @return bool    return the ACTUAL sold out state.
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function perform_sold_out_status_check()
+	{
+		// get all unexpired untrashed tickets
+		$tickets = $this->tickets(
+			array(
+				array('TKT_deleted' => false),
+				'order_by' => array('TKT_qty' => 'ASC'),
+			)
+		);
+		$all_expired = true;
+		foreach ($tickets as $ticket) {
+			if (! $ticket->is_expired()) {
+				$all_expired = false;
+				break;
+			}
+		}
+		// if all the tickets are just expired, then don't update the event status to sold out
+		if ($all_expired) {
+			return true;
+		}
+		$spaces_remaining = $this->spaces_remaining($tickets);
+		if ($spaces_remaining < 1) {
+			if ($this->status() !== EEM_Event::post_status_private) {
+				$this->set_status(EEM_Event::sold_out);
+				$this->save();
+			}
+			$sold_out = true;
+		} else {
+			$sold_out = false;
+			// was event previously marked as sold out ?
+			if ($this->status() === EEM_Event::sold_out) {
+				// revert status to previous value, if it was set
+				$previous_event_status = $this->get_post_meta('_previous_event_status', true);
+				if ($previous_event_status) {
+					$this->set_status($previous_event_status);
+					$this->save();
+				}
+			}
+		}
+		do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
+		return $sold_out;
+	}
+
+
+	/**
+	 * This returns the total remaining spaces for sale on this event.
+	 *
+	 * @uses EE_Event::total_available_spaces()
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining_for_sale()
+	{
+		return $this->total_available_spaces(true);
+	}
+
+
+	/**
+	 * This returns the total spaces available for an event
+	 * while considering all the qtys on the tickets and the reg limits
+	 * on the datetimes attached to this event.
+	 *
+	 * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
+	 *                              If this is false, then we return the most tickets that could ever be sold
+	 *                              for this event with the datetime and tickets setup on the event under optimal
+	 *                              selling conditions.  Otherwise we return a live calculation of spaces available
+	 *                              based on tickets sold.  Depending on setup and stage of sales, this
+	 *                              may appear to equal remaining tickets.  However, the more tickets are
+	 *                              sold out, the more accurate the "live" total is.
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function total_available_spaces($consider_sold = false)
+	{
+		$spaces_available = $consider_sold
+			? $this->getAvailableSpacesCalculator()->spacesRemaining()
+			: $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
+		return apply_filters(
+			'FHEE_EE_Event__total_available_spaces__spaces_available',
+			$spaces_available,
+			$this,
+			$this->getAvailableSpacesCalculator()->getDatetimes(),
+			$this->getAvailableSpacesCalculator()->getActiveTickets()
+		);
+	}
+
+
+	/**
+	 * Checks if the event is set to sold out
+	 *
+	 * @param  bool $actual whether or not to perform calculations to not only figure the
+	 *                      actual status but also to flip the status if necessary to sold
+	 *                      out If false, we just check the existing status of the event
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_sold_out($actual = false)
+	{
+		if (! $actual) {
+			return $this->status() === EEM_Event::sold_out;
+		}
+		return $this->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Checks if the event is marked as postponed
+	 *
+	 * @return boolean
+	 */
+	public function is_postponed()
+	{
+		return $this->status() === EEM_Event::postponed;
+	}
+
+
+	/**
+	 * Checks if the event is marked as cancelled
+	 *
+	 * @return boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status() === EEM_Event::cancelled;
+	}
+
+
+	/**
+	 * Get the logical active status in a hierarchical order for all the datetimes.  Note
+	 * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
+	 * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
+	 * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
+	 * the event is considered expired.
+	 * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
+	 * status set on the EVENT when it is not published and thus is done
+	 *
+	 * @param bool $reset
+	 * @return bool | string - based on EE_Datetime active constants or FALSE if error.
+	 * @throws EE_Error
+	 */
+	public function get_active_status($reset = false)
+	{
+		// if the active status has already been set, then just use that value (unless we are resetting it)
+		if (! empty($this->_active_status) && ! $reset) {
+			return $this->_active_status;
+		}
+		// first check if event id is present on this object
+		if (! $this->ID()) {
+			return false;
+		}
+		$where_params_for_event = array(array('EVT_ID' => $this->ID()));
+		// if event is published:
+		if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
+			// active?
+			if (EEM_Datetime::instance()->get_datetime_count_for_status(
+				EE_Datetime::active,
+				$where_params_for_event
+			) > 0) {
+				$this->_active_status = EE_Datetime::active;
+			} else {
+				// upcoming?
+				if (EEM_Datetime::instance()->get_datetime_count_for_status(
+					EE_Datetime::upcoming,
+					$where_params_for_event
+				) > 0) {
+					$this->_active_status = EE_Datetime::upcoming;
+				} else {
+					// expired?
+					if (EEM_Datetime::instance()->get_datetime_count_for_status(
+						EE_Datetime::expired,
+						$where_params_for_event
+					) > 0
+					) {
+						$this->_active_status = EE_Datetime::expired;
+					} else {
+						// it would be odd if things make it this far because it basically means there are no datetime's
+						// attached to the event.  So in this case it will just be considered inactive.
+						$this->_active_status = EE_Datetime::inactive;
+					}
+				}
+			}
+		} else {
+			// the event is not published, so let's just set it's active status according to its' post status
+			switch ($this->status()) {
+				case EEM_Event::sold_out:
+					$this->_active_status = EE_Datetime::sold_out;
+					break;
+				case EEM_Event::cancelled:
+					$this->_active_status = EE_Datetime::cancelled;
+					break;
+				case EEM_Event::postponed:
+					$this->_active_status = EE_Datetime::postponed;
+					break;
+				default:
+					$this->_active_status = EE_Datetime::inactive;
+			}
+		}
+		return $this->_active_status;
+	}
+
+
+	/**
+	 *    pretty_active_status
+	 *
+	 * @access public
+	 * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
+	 * @return mixed void|string
+	 * @throws EE_Error
+	 */
+	public function pretty_active_status($echo = true)
+	{
+		$active_status = $this->get_active_status();
+		$status = '<span class="ee-status event-active-status-'
+				  . $active_status
+				  . '">'
+				  . EEH_Template::pretty_status($active_status, false, 'sentence')
+				  . '</span>';
+		if ($echo) {
+			echo $status;
+			return '';
+		}
+		return $status;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	public function get_number_of_tickets_sold()
+	{
+		$tkt_sold = 0;
+		if (! $this->ID()) {
+			return 0;
+		}
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$tkt_sold += $datetime->sold();
+			}
+		}
+		return $tkt_sold;
+	}
+
+
+	/**
+	 * This just returns a count of all the registrations for this event
+	 *
+	 * @access  public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_count_of_all_registrations()
+	{
+		return EEM_Event::instance()->count_related($this, 'Registration');
+	}
+
+
+	/**
+	 * This returns the ticket with the earliest start time that is
+	 * available for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 */
+	public function get_ticket_with_earliest_start_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the ticket with the latest end time that is available
+	 * for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 */
+	public function get_ticket_with_latest_end_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the number of different ticket types currently on sale for this event.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function countTicketsOnSale()
+	{
+		$where = array(
+			'Datetime.EVT_ID' => $this->ID(),
+			'TKT_start_date'  => array('<', time()),
+			'TKT_end_date'    => array('>', time()),
+		);
+		return EEM_Ticket::instance()->count(array($where));
+	}
+
+
+	/**
+	 * This returns whether there are any tickets on sale for this event.
+	 *
+	 * @return bool true = YES tickets on sale.
+	 * @throws EE_Error
+	 */
+	public function tickets_on_sale()
+	{
+		return $this->countTicketsOnSale() > 0;
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end. Overrides parent
+	 * to check for an external URL first
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_permalink()
+	{
+		if ($this->external_url()) {
+			return $this->external_url();
+		}
+		return parent::get_permalink();
+	}
+
+
+	/**
+	 * Gets the first term for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class|EE_Term|null
+	 * @throws EE_Error
+	 */
+	public function first_event_category($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_one($query_params);
+	}
+
+
+	/**
+	 * Gets all terms for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Term[]
+	 * @throws EE_Error
+	 */
+	public function get_all_event_categories($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Adds a question group to this event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool                  $for_primary if true, the question group will be added for the primary
+	 *                                           registrant, if false will be added for others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 */
+	public function add_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		$extra = $for_primary
+			? array('EQG_primary' => 1)
+			: array();
+		return $this->_add_relation_to($question_group_id_or_obj, 'Question_Group', $extra);
+	}
+
+
+	/**
+	 * Removes a question group from the event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool                  $for_primary if true, the question group will be removed from the primary
+	 *                                           registrant, if false will be removed from others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 */
+	public function remove_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		$where = $for_primary
+			? array('EQG_primary' => 1)
+			: array();
+		return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group', $where);
+	}
+
+
+	/**
+	 * Gets all the question groups, ordering them by QSG_order ascending
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Question_Group[]
+	 * @throws EE_Error
+	 */
+	public function question_groups($query_params = array())
+	{
+		$query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
+		return $this->get_many_related('Question_Group', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @see EEI_Visual_Representation for comments
+	 * @return string
+	 */
+	public function get_icon()
+	{
+		return '<span class="dashicons dashicons-flag"></span>';
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_edit_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'edit',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default_event_settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
 }

core/EE_Config.core.php

Spacing +122 added lines, -122 removed lines

@@ -145,7 +145,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Config) {
+        if ( ! self::$_instance instanceof EE_Config) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -283,7 +283,7 @@ 
                 $this
             );
             if (is_object($settings) && property_exists($this, $config)) {
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
+                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__'.$config, $settings);
                 // call configs populate method to ensure any defaults are set for empty values.
                 if (method_exists($settings, 'populate')) {
                     $this->{$config}->populate();
@@ -556,7 +556,7 @@ 
                         break;
                     // TEST #2 : check that settings section exists
                     case 2:
-                        if (! isset($this->{$section})) {
+                        if ( ! isset($this->{$section})) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -570,7 +570,7 @@ 
                         break;
                     // TEST #3 : check that section is the proper format
                     case 3:
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
+                        if ( ! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
                         ) {
                             if ($display_errors) {
                                 throw new EE_Error(
@@ -616,7 +616,7 @@ 
                         break;
                     // TEST #6 : verify config class is accessible
                     case 6:
-                        if (! class_exists($config_class)) {
+                        if ( ! class_exists($config_class)) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -633,7 +633,7 @@ 
                         break;
                     // TEST #7 : check that config has even been set
                     case 7:
-                        if (! isset($this->{$section}->{$name})) {
+                        if ( ! isset($this->{$section}->{$name})) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -651,7 +651,7 @@ 
                         break;
                     // TEST #8 : check that config is the requested type
                     case 8:
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
+                        if ( ! $this->{$section}->{$name} instanceof $config_class) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -670,7 +670,7 @@ 
                         break;
                     // TEST #9 : verify config object
                     case 9:
-                        if (! $config_obj instanceof EE_Config_Base) {
+                        if ( ! $config_obj instanceof EE_Config_Base) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -702,7 +702,7 @@ 
      */
     private function _generate_config_option_name($section = '', $name = '')
     {
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
+        return 'ee_config-'.strtolower($section.'-'.str_replace(array('EE_', 'EED_'), '', $name));
     }
 
 
@@ -719,7 +719,7 @@ 
     {
         return ! empty($config_class)
             ? $config_class
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
+            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))).'_Config';
     }
 
 
@@ -738,17 +738,17 @@ 
         // ensure config class is set to something
         $config_class = $this->_set_config_class($config_class, $name);
         // run tests 1-4, 6, and 7 to verify all config params are set and valid
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+        if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
             return null;
         }
         $config_option_name = $this->_generate_config_option_name($section, $name);
         // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
+        if ( ! isset($this->_addon_option_names[$config_option_name])) {
+            $this->_addon_option_names[$config_option_name] = $config_class;
             $this->update_addon_option_names();
         }
         // verify the incoming config object but suppress errors
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+        if ( ! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
             $config_obj = new $config_class();
         }
         if (get_option($config_option_name)) {
@@ -795,7 +795,7 @@ 
         // get class name of the incoming object
         $config_class = get_class($config_obj);
         // run tests 1-5 and 9 to verify config
-        if (! $this->_verify_config_params(
+        if ( ! $this->_verify_config_params(
             $section,
             $name,
             $config_class,
@@ -807,7 +807,7 @@ 
         }
         $config_option_name = $this->_generate_config_option_name($section, $name);
         // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
+        if ( ! isset($this->_addon_option_names[$config_option_name])) {
             // save new config to db
             if ($this->set_config($section, $name, $config_class, $config_obj)) {
                 return true;
@@ -833,7 +833,7 @@ 
                             'event_espresso'
                         ),
                         $config_class,
-                        'EE_Config->' . $section . '->' . $name
+                        'EE_Config->'.$section.'->'.$name
                     ),
                     __FILE__,
                     __FUNCTION__,
@@ -859,7 +859,7 @@ 
         // ensure config class is set to something
         $config_class = $this->_set_config_class($config_class, $name);
         // run tests 1-4, 6 and 7 to verify that all params have been set
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+        if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
             return null;
         }
         // now test if the requested config object exists, but suppress errors
@@ -904,7 +904,7 @@ 
         // retrieve the wp-option for this config class.
         $config_option = maybe_unserialize(get_option($config_option_name, array()));
         if (empty($config_option)) {
-            EE_Config::log($config_option_name . '-NOT-FOUND');
+            EE_Config::log($config_option_name.'-NOT-FOUND');
         }
         return $config_option;
     }
@@ -922,7 +922,7 @@ 
             // copy incoming $_REQUEST and sanitize it so we can save it
             $_request = $_REQUEST;
             array_walk_recursive($_request, 'sanitize_text_field');
-            $config_log[ (string) microtime(true) ] = array(
+            $config_log[(string) microtime(true)] = array(
                 'config_name' => $config_option_name,
                 'request'     => $_request,
             );
@@ -937,7 +937,7 @@ 
      */
     public static function trim_log()
     {
-        if (! EE_Config::logging_enabled()) {
+        if ( ! EE_Config::logging_enabled()) {
             return;
         }
         $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
@@ -961,7 +961,7 @@ 
     public static function get_page_for_posts()
     {
         $page_for_posts = get_option('page_for_posts');
-        if (! $page_for_posts) {
+        if ( ! $page_for_posts) {
             return 'posts';
         }
         /** @type WPDB $wpdb */
@@ -1011,20 +1011,20 @@ 
     {
         // only init widgets on admin pages when not in complete maintenance, and
         // on frontend when not in any maintenance mode
-        if (! EE_Maintenance_Mode::instance()->level()
+        if ( ! EE_Maintenance_Mode::instance()->level()
             || (
                 is_admin()
                 && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
             )
         ) {
             // grab list of installed widgets
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
+            $widgets_to_register = glob(EE_WIDGETS.'*', GLOB_ONLYDIR);
             // filter list of modules to register
             $widgets_to_register = apply_filters(
                 'FHEE__EE_Config__register_widgets__widgets_to_register',
                 $widgets_to_register
             );
-            if (! empty($widgets_to_register)) {
+            if ( ! empty($widgets_to_register)) {
                 // cycle thru widget folders
                 foreach ($widgets_to_register as $widget_path) {
                     // add to list of installed widget modules
@@ -1074,31 +1074,31 @@ 
         // create classname from widget directory name
         $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
         // add class prefix
-        $widget_class = 'EEW_' . $widget;
+        $widget_class = 'EEW_'.$widget;
         // does the widget exist ?
-        if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
+        if ( ! is_readable($widget_path.DS.$widget_class.$widget_ext)) {
             $msg = sprintf(
                 __(
                     'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
                     'event_espresso'
                 ),
                 $widget_class,
-                $widget_path . DS . $widget_class . $widget_ext
+                $widget_path.DS.$widget_class.$widget_ext
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return;
         }
         // load the widget class file
-        require_once($widget_path . DS . $widget_class . $widget_ext);
+        require_once($widget_path.DS.$widget_class.$widget_ext);
         // verify that class exists
-        if (! class_exists($widget_class)) {
+        if ( ! class_exists($widget_class)) {
             $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return;
         }
         register_widget($widget_class);
         // add to array of registered widgets
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
+        EE_Registry::instance()->widgets->{$widget_class} = $widget_path.DS.$widget_class.$widget_ext;
     }
 
 
@@ -1111,18 +1111,18 @@ 
     private function _register_modules()
     {
         // grab list of installed modules
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
+        $modules_to_register = glob(EE_MODULES.'*', GLOB_ONLYDIR);
         // filter list of modules to register
         $modules_to_register = apply_filters(
             'FHEE__EE_Config__register_modules__modules_to_register',
             $modules_to_register
         );
-        if (! empty($modules_to_register)) {
+        if ( ! empty($modules_to_register)) {
             // loop through folders
             foreach ($modules_to_register as $module_path) {
                 /**TEMPORARILY EXCLUDE gateways from modules for time being**/
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
-                    && $module_path !== EE_MODULES . 'gateways'
+                if ($module_path !== EE_MODULES.'zzz-copy-this-module-template'
+                    && $module_path !== EE_MODULES.'gateways'
                 ) {
                     // add to list of installed modules
                     EE_Config::register_module($module_path);
@@ -1159,25 +1159,25 @@ 
             // remove last segment
             array_pop($module_path);
             // glue it back together
-            $module_path = implode(DS, $module_path) . DS;
+            $module_path = implode(DS, $module_path).DS;
             // take first segment from file name pieces and sanitize it
             $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
             // ensure class prefix is added
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
+            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_'.$module : $module;
         } else {
             // we need to generate the filename based off of the folder name
             // grab and sanitize module name
             $module = strtolower(basename($module_path));
             $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
             // like trailingslashit()
-            $module_path = rtrim($module_path, DS) . DS;
+            $module_path = rtrim($module_path, DS).DS;
             // create classname from module directory name
             $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
             // add class prefix
-            $module_class = 'EED_' . $module;
+            $module_class = 'EED_'.$module;
         }
         // does the module exist ?
-        if (! is_readable($module_path . DS . $module_class . $module_ext)) {
+        if ( ! is_readable($module_path.DS.$module_class.$module_ext)) {
             $msg = sprintf(
                 __(
                     'The requested %s module file could not be found or is not readable due to file permissions.',
@@ -1185,19 +1185,19 @@ 
                 ),
                 $module
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the module class file
-        require_once($module_path . $module_class . $module_ext);
+        require_once($module_path.$module_class.$module_ext);
         // verify that class exists
-        if (! class_exists($module_class)) {
+        if ( ! class_exists($module_class)) {
             $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // add to array of registered modules
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
+        EE_Registry::instance()->modules->{$module_class} = $module_path.$module_class.$module_ext;
         do_action(
             'AHEE__EE_Config__register_module__complete',
             $module_class,
@@ -1248,26 +1248,26 @@ 
     {
         do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
         $module = str_replace('EED_', '', $module);
-        $module_class = 'EED_' . $module;
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
+        $module_class = 'EED_'.$module;
+        if ( ! isset(EE_Registry::instance()->modules->{$module_class})) {
             $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         if (empty($route)) {
             $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        if (! method_exists('EED_' . $module, $method_name)) {
+        if ( ! method_exists('EED_'.$module, $method_name)) {
             $msg = sprintf(
                 __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
+        EE_Config::$_module_route_map[(string) $key][(string) $route] = array('EED_'.$module, $method_name);
         return true;
     }
 
@@ -1284,8 +1284,8 @@ 
     {
         do_action('AHEE__EE_Config__get_route__begin', $route);
         $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
-            return EE_Config::$_module_route_map[ $key ][ $route ];
+        if (isset(EE_Config::$_module_route_map[$key][$route])) {
+            return EE_Config::$_module_route_map[$key][$route];
         }
         return null;
     }
@@ -1317,47 +1317,47 @@ 
     public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
     {
         do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+        if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) {
             $msg = sprintf(
                 __('The module route %s for this forward has not been registered.', 'event_espresso'),
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         if (empty($forward)) {
             $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         if (is_array($forward)) {
-            if (! isset($forward[1])) {
+            if ( ! isset($forward[1])) {
                 $msg = sprintf(
                     __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
                     $route
                 );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+                EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
                 return false;
             }
-            if (! method_exists($forward[0], $forward[1])) {
+            if ( ! method_exists($forward[0], $forward[1])) {
                 $msg = sprintf(
                     __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
                     $forward[1],
                     $route
                 );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+                EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
                 return false;
             }
-        } elseif (! function_exists($forward)) {
+        } elseif ( ! function_exists($forward)) {
             $msg = sprintf(
                 __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
                 $forward,
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
+        EE_Config::$_module_forward_map[$key][$route][absint($status)] = $forward;
         return true;
     }
 
@@ -1375,10 +1375,10 @@ 
     public static function get_forward($route = null, $status = 0, $key = 'ee')
     {
         do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
+        if (isset(EE_Config::$_module_forward_map[$key][$route][$status])) {
             return apply_filters(
                 'FHEE__EE_Config__get_forward',
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
+                EE_Config::$_module_forward_map[$key][$route][$status],
                 $route,
                 $status
             );
@@ -1402,15 +1402,15 @@ 
     public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
     {
         do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+        if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) {
             $msg = sprintf(
                 __('The module route %s for this view has not been registered.', 'event_espresso'),
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        if (! is_readable($view)) {
+        if ( ! is_readable($view)) {
             $msg = sprintf(
                 __(
                     'The %s view file could not be found or is not readable due to file permissions.',
@@ -1418,10 +1418,10 @@ 
                 ),
                 $view
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
+        EE_Config::$_module_view_map[$key][$route][absint($status)] = $view;
         return true;
     }
 
@@ -1439,10 +1439,10 @@ 
     public static function get_view($route = null, $status = 0, $key = 'ee')
     {
         do_action('AHEE__EE_Config__get_view__begin', $route, $status);
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
+        if (isset(EE_Config::$_module_view_map[$key][$route][$status])) {
             return apply_filters(
                 'FHEE__EE_Config__get_view',
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
+                EE_Config::$_module_view_map[$key][$route][$status],
                 $route,
                 $status
             );
@@ -1469,7 +1469,7 @@ 
     public static function getLegacyShortcodesManager()
     {
 
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
+        if ( ! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
             EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
                 EE_Registry::instance()
             );
@@ -1516,7 +1516,7 @@ 
      */
     public function get_pretty($property)
     {
-        if (! property_exists($this, $property)) {
+        if ( ! property_exists($this, $property)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -1745,11 +1745,11 @@ 
      */
     public function reg_page_url()
     {
-        if (! $this->reg_page_url) {
+        if ( ! $this->reg_page_url) {
             $this->reg_page_url = add_query_arg(
                 array('uts' => time()),
                 get_permalink($this->reg_page_id)
-            ) . '#checkout';
+            ).'#checkout';
         }
         return $this->reg_page_url;
     }
@@ -1765,7 +1765,7 @@ 
      */
     public function txn_page_url($query_args = array())
     {
-        if (! $this->txn_page_url) {
+        if ( ! $this->txn_page_url) {
             $this->txn_page_url = get_permalink($this->txn_page_id);
         }
         if ($query_args) {
@@ -1786,7 +1786,7 @@ 
      */
     public function thank_you_page_url($query_args = array())
     {
-        if (! $this->thank_you_page_url) {
+        if ( ! $this->thank_you_page_url) {
             $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
         }
         if ($query_args) {
@@ -1805,7 +1805,7 @@ 
      */
     public function cancel_page_url()
     {
-        if (! $this->cancel_page_url) {
+        if ( ! $this->cancel_page_url) {
             $this->cancel_page_url = get_permalink($this->cancel_page_id);
         }
         return $this->cancel_page_url;
@@ -1848,13 +1848,13 @@ 
         $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
         $option = self::OPTION_NAME_UXIP;
         // set correct table for query
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
+        $table_name = $wpdb->get_blog_prefix($current_main_site_id).'options';
         // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
         // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
         // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
         // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
         // for the purpose of caching.
-        $pre = apply_filters('pre_option_' . $option, false, $option);
+        $pre = apply_filters('pre_option_'.$option, false, $option);
         if (false !== $pre) {
             EE_Core_Config::$ee_ueip_option = $pre;
             return EE_Core_Config::$ee_ueip_option;
@@ -1868,10 +1868,10 @@ 
         if (is_object($row)) {
             $value = $row->option_value;
         } else { // option does not exist so use default.
-            EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
+            EE_Core_Config::$ee_ueip_option = apply_filters('default_option_'.$option, false, $option);
             return EE_Core_Config::$ee_ueip_option;
         }
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
+        EE_Core_Config::$ee_ueip_option = apply_filters('option_'.$option, maybe_unserialize($value), $option);
         return EE_Core_Config::$ee_ueip_option;
     }
 
@@ -2125,37 +2125,37 @@ 
         // but override if requested
         $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
         // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
-        if (! empty($CNT_ISO)
+        if ( ! empty($CNT_ISO)
             && EE_Maintenance_Mode::instance()->models_can_query()
             && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
         ) {
             // retrieve the country settings from the db, just in case they have been customized
             $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
             if ($country instanceof EE_Country) {
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
-                $this->name = $country->currency_name_single();    // Dollar
-                $this->plural = $country->currency_name_plural();    // Dollars
-                $this->sign = $country->currency_sign();            // currency sign: $
+                $this->code = $country->currency_code(); // currency code: USD, CAD, EUR
+                $this->name = $country->currency_name_single(); // Dollar
+                $this->plural = $country->currency_name_plural(); // Dollars
+                $this->sign = $country->currency_sign(); // currency sign: $
                 $this->sign_b4 = $country->currency_sign_before(
-                );        // currency sign before or after: $TRUE  or  FALSE$
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
+                ); // currency sign before or after: $TRUE  or  FALSE$
+                $this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00  3 = 0.000
                 $this->dec_mrk = $country->currency_decimal_mark(
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+                ); // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
                 $this->thsnds = $country->currency_thousands_separator(
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+                ); // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
             }
         }
         // fallback to hardcoded defaults, in case the above failed
         if (empty($this->code)) {
             // set default currency settings
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
-            $this->sign = '$';    // currency sign: $
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+            $this->code = 'USD'; // currency code: USD, CAD, EUR
+            $this->name = __('Dollar', 'event_espresso'); // Dollar
+            $this->plural = __('Dollars', 'event_espresso'); // Dollars
+            $this->sign = '$'; // currency sign: $
+            $this->sign_b4 = true; // currency sign before or after: $TRUE  or  FALSE$
+            $this->dec_plc = 2; // decimal places: 2 = 0.00  3 = 0.000
+            $this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+            $this->thsnds = ','; // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
         }
     }
 }
@@ -2414,8 +2414,8 @@ 
             $closing_a_tag = '';
             if (function_exists('get_privacy_policy_url')) {
                 $privacy_page_url = get_privacy_policy_url();
-                if (! empty($privacy_page_url)) {
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
+                if ( ! empty($privacy_page_url)) {
+                    $opening_a_tag = '<a href="'.$privacy_page_url.'" target="_blank">';
                     $closing_a_tag = '</a>';
                 }
             }
@@ -2627,7 +2627,7 @@ 
     public function log_file_name($reset = false)
     {
         if (empty($this->log_file_name) || $reset) {
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
+            $this->log_file_name = sanitize_key('espresso_log_'.md5(uniqid('', true))).'.txt';
             EE_Config::instance()->update_espresso_config(false, false);
         }
         return $this->log_file_name;
@@ -2641,7 +2641,7 @@ 
     public function debug_file_name($reset = false)
     {
         if (empty($this->debug_file_name) || $reset) {
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
+            $this->debug_file_name = sanitize_key('espresso_debug_'.md5(uniqid('', true))).'.txt';
             EE_Config::instance()->update_espresso_config(false, false);
         }
         return $this->debug_file_name;
@@ -2845,21 +2845,21 @@ 
         $this->use_google_maps = true;
         $this->google_map_api_key = '';
         // for event details pages (reg page)
-        $this->event_details_map_width = 585;            // ee_map_width_single
-        $this->event_details_map_height = 362;            // ee_map_height_single
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
-        $this->event_details_map_align = 'center';            // ee_map_align_single
+        $this->event_details_map_width = 585; // ee_map_width_single
+        $this->event_details_map_height = 362; // ee_map_height_single
+        $this->event_details_map_zoom = 14; // ee_map_zoom_single
+        $this->event_details_display_nav = true; // ee_map_nav_display_single
+        $this->event_details_nav_size = false; // ee_map_nav_size_single
+        $this->event_details_control_type = 'default'; // ee_map_type_control_single
+        $this->event_details_map_align = 'center'; // ee_map_align_single
         // for event list pages
-        $this->event_list_map_width = 300;            // ee_map_width
-        $this->event_list_map_height = 185;        // ee_map_height
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
-        $this->event_list_display_nav = false;        // ee_map_nav_display
-        $this->event_list_nav_size = true;            // ee_map_nav_size
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
-        $this->event_list_map_align = 'center';            // ee_map_align
+        $this->event_list_map_width = 300; // ee_map_width
+        $this->event_list_map_height = 185; // ee_map_height
+        $this->event_list_map_zoom = 12; // ee_map_zoom
+        $this->event_list_display_nav = false; // ee_map_nav_display
+        $this->event_list_nav_size = true; // ee_map_nav_size
+        $this->event_list_control_type = 'dropdown'; // ee_map_type_control
+        $this->event_list_map_align = 'center'; // ee_map_align
     }
 }
 
@@ -3177,7 +3177,7 @@ 
      */
     public function max_input_vars_limit_check($input_count = 0)
     {
-        if (! empty($this->php->max_input_vars)
+        if ( ! empty($this->php->max_input_vars)
             && ($input_count >= $this->php->max_input_vars)
         ) {
             // check the server setting because the config value could be stale

Indentation +3151 added lines, -3151 removed lines

@@ -14,2509 +14,2509 @@ 
 final class EE_Config implements ResettableInterface
 {
 
-    const OPTION_NAME = 'ee_config';
-
-    const LOG_NAME = 'ee_config_log';
-
-    const LOG_LENGTH = 100;
-
-    const ADDON_OPTION_NAMES = 'ee_config_option_names';
-
-    /**
-     *    instance of the EE_Config object
-     *
-     * @var    EE_Config $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var boolean $_logging_enabled
-     */
-    private static $_logging_enabled = false;
-
-    /**
-     * @var LegacyShortcodesManager $legacy_shortcodes_manager
-     */
-    private $legacy_shortcodes_manager;
-
-    /**
-     * An StdClass whose property names are addon slugs,
-     * and values are their config classes
-     *
-     * @var StdClass
-     */
-    public $addons;
-
-    /**
-     * @var EE_Admin_Config
-     */
-    public $admin;
-
-    /**
-     * @var EE_Core_Config
-     */
-    public $core;
-
-    /**
-     * @var EE_Currency_Config
-     */
-    public $currency;
-
-    /**
-     * @var EE_Organization_Config
-     */
-    public $organization;
-
-    /**
-     * @var EE_Registration_Config
-     */
-    public $registration;
-
-    /**
-     * @var EE_Template_Config
-     */
-    public $template_settings;
-
-    /**
-     * Holds EE environment values.
-     *
-     * @var EE_Environment_Config
-     */
-    public $environment;
-
-    /**
-     * settings pertaining to Google maps
-     *
-     * @var EE_Map_Config
-     */
-    public $map_settings;
-
-    /**
-     * settings pertaining to Taxes
-     *
-     * @var EE_Tax_Config
-     */
-    public $tax_settings;
-
-    /**
-     * Settings pertaining to global messages settings.
-     *
-     * @var EE_Messages_Config
-     */
-    public $messages;
-
-    /**
-     * @deprecated
-     * @var EE_Gateway_Config
-     */
-    public $gateway;
-
-    /**
-     * @var    array $_addon_option_names
-     * @access    private
-     */
-    private $_addon_option_names = array();
-
-    /**
-     * @var    array $_module_route_map
-     * @access    private
-     */
-    private static $_module_route_map = array();
-
-    /**
-     * @var    array $_module_forward_map
-     * @access    private
-     */
-    private static $_module_forward_map = array();
-
-    /**
-     * @var    array $_module_view_map
-     * @access    private
-     */
-    private static $_module_view_map = array();
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Config instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Config) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the config
-     *
-     * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
-     *                               (default) leaves the database alone, and merely resets the EE_Config object to
-     *                               reflect its state in the database
-     * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
-     *                               $_instance as NULL. Useful in case you want to forget about the old instance on
-     *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
-     *                               site was put into maintenance mode)
-     * @return EE_Config
-     */
-    public static function reset($hard_reset = false, $reinstantiate = true)
-    {
-        if (self::$_instance instanceof EE_Config) {
-            if ($hard_reset) {
-                self::$_instance->legacy_shortcodes_manager = null;
-                self::$_instance->_addon_option_names = array();
-                self::$_instance->_initialize_config();
-                self::$_instance->update_espresso_config();
-            }
-            self::$_instance->update_addon_option_names();
-        }
-        self::$_instance = null;
-        // we don't need to reset the static properties imo because those should
-        // only change when a module is added or removed. Currently we don't
-        // support removing a module during a request when it previously existed
-        if ($reinstantiate) {
-            return self::instance();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     *    class constructor
-     *
-     * @access    private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Config__construct__begin', $this);
-        EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
-        // setup empty config classes
-        $this->_initialize_config();
-        // load existing EE site settings
-        $this->_load_core_config();
-        // confirm everything loaded correctly and set filtered defaults if not
-        $this->_verify_config();
-        //  register shortcodes and modules
-        add_action(
-            'AHEE__EE_System__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_and_modules'),
-            999
-        );
-        //  initialize shortcodes and modules
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
-        // register widgets
-        add_action('widgets_init', array($this, 'widgets_init'), 10);
-        // shutdown
-        add_action('shutdown', array($this, 'shutdown'), 10);
-        // construct__end hook
-        do_action('AHEE__EE_Config__construct__end', $this);
-        // hardcoded hack
-        $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public static function logging_enabled()
-    {
-        return self::$_logging_enabled;
-    }
-
-
-    /**
-     * use to get the current theme if needed from static context
-     *
-     * @return string current theme set.
-     */
-    public static function get_current_theme()
-    {
-        return isset(self::$_instance->template_settings->current_espresso_theme)
-            ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
-    }
-
-
-    /**
-     *        _initialize_config
-     *
-     * @access private
-     * @return void
-     */
-    private function _initialize_config()
-    {
-        EE_Config::trim_log();
-        // set defaults
-        $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
-        $this->addons = new stdClass();
-        // set _module_route_map
-        EE_Config::$_module_route_map = array();
-        // set _module_forward_map
-        EE_Config::$_module_forward_map = array();
-        // set _module_view_map
-        EE_Config::$_module_view_map = array();
-    }
-
-
-    /**
-     *        load core plugin configuration
-     *
-     * @access private
-     * @return void
-     */
-    private function _load_core_config()
-    {
-        // load_core_config__start hook
-        do_action('AHEE__EE_Config___load_core_config__start', $this);
-        $espresso_config = $this->get_espresso_config();
-        foreach ($espresso_config as $config => $settings) {
-            // load_core_config__start hook
-            $settings = apply_filters(
-                'FHEE__EE_Config___load_core_config__config_settings',
-                $settings,
-                $config,
-                $this
-            );
-            if (is_object($settings) && property_exists($this, $config)) {
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
-                // call configs populate method to ensure any defaults are set for empty values.
-                if (method_exists($settings, 'populate')) {
-                    $this->{$config}->populate();
-                }
-                if (method_exists($settings, 'do_hooks')) {
-                    $this->{$config}->do_hooks();
-                }
-            }
-        }
-        if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
-            $this->update_espresso_config();
-        }
-        // load_core_config__end hook
-        do_action('AHEE__EE_Config___load_core_config__end', $this);
-    }
-
-
-    /**
-     *    _verify_config
-     *
-     * @access    protected
-     * @return    void
-     */
-    protected function _verify_config()
-    {
-        $this->core = $this->core instanceof EE_Core_Config
-            ? $this->core
-            : new EE_Core_Config();
-        $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
-        $this->organization = $this->organization instanceof EE_Organization_Config
-            ? $this->organization
-            : new EE_Organization_Config();
-        $this->organization = apply_filters(
-            'FHEE__EE_Config___initialize_config__organization',
-            $this->organization
-        );
-        $this->currency = $this->currency instanceof EE_Currency_Config
-            ? $this->currency
-            : new EE_Currency_Config();
-        $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
-        $this->registration = $this->registration instanceof EE_Registration_Config
-            ? $this->registration
-            : new EE_Registration_Config();
-        $this->registration = apply_filters(
-            'FHEE__EE_Config___initialize_config__registration',
-            $this->registration
-        );
-        $this->admin = $this->admin instanceof EE_Admin_Config
-            ? $this->admin
-            : new EE_Admin_Config();
-        $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
-        $this->template_settings = $this->template_settings instanceof EE_Template_Config
-            ? $this->template_settings
-            : new EE_Template_Config();
-        $this->template_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__template_settings',
-            $this->template_settings
-        );
-        $this->map_settings = $this->map_settings instanceof EE_Map_Config
-            ? $this->map_settings
-            : new EE_Map_Config();
-        $this->map_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__map_settings',
-            $this->map_settings
-        );
-        $this->environment = $this->environment instanceof EE_Environment_Config
-            ? $this->environment
-            : new EE_Environment_Config();
-        $this->environment = apply_filters(
-            'FHEE__EE_Config___initialize_config__environment',
-            $this->environment
-        );
-        $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
-            ? $this->tax_settings
-            : new EE_Tax_Config();
-        $this->tax_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__tax_settings',
-            $this->tax_settings
-        );
-        $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
-        $this->messages = $this->messages instanceof EE_Messages_Config
-            ? $this->messages
-            : new EE_Messages_Config();
-        $this->gateway = $this->gateway instanceof EE_Gateway_Config
-            ? $this->gateway
-            : new EE_Gateway_Config();
-        $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
-        $this->legacy_shortcodes_manager = null;
-    }
-
-
-    /**
-     *    get_espresso_config
-     *
-     * @access    public
-     * @return    array of espresso config stuff
-     */
-    public function get_espresso_config()
-    {
-        // grab espresso configuration
-        return apply_filters(
-            'FHEE__EE_Config__get_espresso_config__CFG',
-            get_option(EE_Config::OPTION_NAME, array())
-        );
-    }
-
-
-    /**
-     *    double_check_config_comparison
-     *
-     * @access    public
-     * @param string $option
-     * @param        $old_value
-     * @param        $value
-     */
-    public function double_check_config_comparison($option = '', $old_value, $value)
-    {
-        // make sure we're checking the ee config
-        if ($option === EE_Config::OPTION_NAME) {
-            // run a loose comparison of the old value against the new value for type and properties,
-            // but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
-            if ($value != $old_value) {
-                // if they are NOT the same, then remove the hook,
-                // which means the subsequent update results will be based solely on the update query results
-                // the reason we do this is because, as stated above,
-                // WP update_option performs an exact instance comparison (===) on any update values passed to it
-                // this happens PRIOR to serialization and any subsequent update.
-                // If values are found to match their previous old value,
-                // then WP bails before performing any update.
-                // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
-                // it just pulled from the db, with the one being passed to it (which will not match).
-                // HOWEVER, once the object is serialized and passed off to MySQL to update,
-                // MySQL MAY ALSO NOT perform the update because
-                // the string it sees in the db looks the same as the new one it has been passed!!!
-                // This results in the query returning an "affected rows" value of ZERO,
-                // which gets returned immediately by WP update_option and looks like an error.
-                remove_action('update_option', array($this, 'check_config_updated'));
-            }
-        }
-    }
-
-
-    /**
-     *    update_espresso_config
-     *
-     * @access   public
-     */
-    protected function _reset_espresso_addon_config()
-    {
-        $this->_addon_option_names = array();
-        foreach ($this->addons as $addon_name => $addon_config_obj) {
-            $addon_config_obj = maybe_unserialize($addon_config_obj);
-            if ($addon_config_obj instanceof EE_Config_Base) {
-                $this->update_config('addons', $addon_name, $addon_config_obj, false);
-            }
-            $this->addons->{$addon_name} = null;
-        }
-    }
-
-
-    /**
-     *    update_espresso_config
-     *
-     * @access   public
-     * @param   bool $add_success
-     * @param   bool $add_error
-     * @return   bool
-     */
-    public function update_espresso_config($add_success = false, $add_error = true)
-    {
-        // don't allow config updates during WP heartbeats
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
-            return false;
-        }
-        // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
-        // $clone = clone( self::$_instance );
-        // self::$_instance = NULL;
-        do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
-        $this->_reset_espresso_addon_config();
-        // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
-        // but BEFORE the actual update occurs
-        add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
-        // don't want to persist legacy_shortcodes_manager, but don't want to lose it either
-        $legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
-        $this->legacy_shortcodes_manager = null;
-        // now update "ee_config"
-        $saved = update_option(EE_Config::OPTION_NAME, $this);
-        $this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
-        EE_Config::log(EE_Config::OPTION_NAME);
-        // if not saved... check if the hook we just added still exists;
-        // if it does, it means one of two things:
-        // that update_option bailed at the($value === $old_value) conditional,
-        // or...
-        // the db update query returned 0 rows affected
-        // (probably because the data  value was the same from it's perspective)
-        // so the existence of the hook means that a negative result from update_option is NOT an error,
-        // but just means no update occurred, so don't display an error to the user.
-        // BUT... if update_option returns FALSE, AND the hook is missing,
-        // then it means that something truly went wrong
-        $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
-        // remove our action since we don't want it in the system anymore
-        remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
-        do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
-        // self::$_instance = $clone;
-        // unset( $clone );
-        // if config remains the same or was updated successfully
-        if ($saved) {
-            if ($add_success) {
-                EE_Error::add_success(
-                    __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return true;
-        } else {
-            if ($add_error) {
-                EE_Error::add_error(
-                    __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return false;
-        }
-    }
-
-
-    /**
-     *    _verify_config_params
-     *
-     * @access    private
-     * @param    string         $section
-     * @param    string         $name
-     * @param    string         $config_class
-     * @param    EE_Config_Base $config_obj
-     * @param    array          $tests_to_run
-     * @param    bool           $display_errors
-     * @return    bool    TRUE on success, FALSE on fail
-     */
-    private function _verify_config_params(
-        $section = '',
-        $name = '',
-        $config_class = '',
-        $config_obj = null,
-        $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
-        $display_errors = true
-    ) {
-        try {
-            foreach ($tests_to_run as $test) {
-                switch ($test) {
-                    // TEST #1 : check that section was set
-                    case 1:
-                        if (empty($section)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'No configuration section has been provided while attempting to save "%s".',
-                                            'event_espresso'
-                                        ),
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #2 : check that settings section exists
-                    case 2:
-                        if (! isset($this->{$section})) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('The "%s" configuration section does not exist.', 'event_espresso'),
-                                        $section
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #3 : check that section is the proper format
-                    case 3:
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
-                        ) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The "%s" configuration settings have not been formatted correctly.',
-                                            'event_espresso'
-                                        ),
-                                        $section
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #4 : check that config section name has been set
-                    case 4:
-                        if (empty($name)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    __(
-                                        'No name has been provided for the specific configuration section.',
-                                        'event_espresso'
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #5 : check that a config class name has been set
-                    case 5:
-                        if (empty($config_class)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    __(
-                                        'No class name has been provided for the specific configuration section.',
-                                        'event_espresso'
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #6 : verify config class is accessible
-                    case 6:
-                        if (! class_exists($config_class)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
-                                            'event_espresso'
-                                        ),
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #7 : check that config has even been set
-                    case 7:
-                        if (! isset($this->{$section}->{$name})) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
-                                        $section,
-                                        $name
-                                    )
-                                );
-                            }
-                            return false;
-                        } else {
-                            // and make sure it's not serialized
-                            $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
-                        }
-                        break;
-                    // TEST #8 : check that config is the requested type
-                    case 8:
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
-                                            'event_espresso'
-                                        ),
-                                        $section,
-                                        $name,
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #9 : verify config object
-                    case 9:
-                        if (! $config_obj instanceof EE_Config_Base) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
-                                        print_r($config_obj, true)
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        // you have successfully run the gauntlet
-        return true;
-    }
-
-
-    /**
-     *    _generate_config_option_name
-     *
-     * @access        protected
-     * @param        string $section
-     * @param        string $name
-     * @return        string
-     */
-    private function _generate_config_option_name($section = '', $name = '')
-    {
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
-    }
-
-
-    /**
-     *    _set_config_class
-     * ensures that a config class is set, either from a passed config class or one generated from the config name
-     *
-     * @access    private
-     * @param    string $config_class
-     * @param    string $name
-     * @return    string
-     */
-    private function _set_config_class($config_class = '', $name = '')
-    {
-        return ! empty($config_class)
-            ? $config_class
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
-    }
-
-
-    /**
-     *    set_config
-     *
-     * @access    protected
-     * @param    string         $section
-     * @param    string         $name
-     * @param    string         $config_class
-     * @param    EE_Config_Base $config_obj
-     * @return    EE_Config_Base
-     */
-    public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
-    {
-        // ensure config class is set to something
-        $config_class = $this->_set_config_class($config_class, $name);
-        // run tests 1-4, 6, and 7 to verify all config params are set and valid
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
-            return null;
-        }
-        $config_option_name = $this->_generate_config_option_name($section, $name);
-        // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
-            $this->update_addon_option_names();
-        }
-        // verify the incoming config object but suppress errors
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
-            $config_obj = new $config_class();
-        }
-        if (get_option($config_option_name)) {
-            EE_Config::log($config_option_name);
-            update_option($config_option_name, $config_obj);
-            $this->{$section}->{$name} = $config_obj;
-            return $this->{$section}->{$name};
-        } else {
-            // create a wp-option for this config
-            if (add_option($config_option_name, $config_obj, '', 'no')) {
-                $this->{$section}->{$name} = maybe_unserialize($config_obj);
-                return $this->{$section}->{$name};
-            } else {
-                EE_Error::add_error(
-                    sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return null;
-            }
-        }
-    }
-
-
-    /**
-     *    update_config
-     * Important: the config object must ALREADY be set, otherwise this will produce an error.
-     *
-     * @access    public
-     * @param    string                $section
-     * @param    string                $name
-     * @param    EE_Config_Base|string $config_obj
-     * @param    bool                  $throw_errors
-     * @return    bool
-     */
-    public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
-    {
-        // don't allow config updates during WP heartbeats
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
-            return false;
-        }
-        $config_obj = maybe_unserialize($config_obj);
-        // get class name of the incoming object
-        $config_class = get_class($config_obj);
-        // run tests 1-5 and 9 to verify config
-        if (! $this->_verify_config_params(
-            $section,
-            $name,
-            $config_class,
-            $config_obj,
-            array(1, 2, 3, 4, 7, 9)
-        )
-        ) {
-            return false;
-        }
-        $config_option_name = $this->_generate_config_option_name($section, $name);
-        // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            // save new config to db
-            if ($this->set_config($section, $name, $config_class, $config_obj)) {
-                return true;
-            }
-        } else {
-            // first check if the record already exists
-            $existing_config = get_option($config_option_name);
-            $config_obj = serialize($config_obj);
-            // just return if db record is already up to date (NOT type safe comparison)
-            if ($existing_config == $config_obj) {
-                $this->{$section}->{$name} = $config_obj;
-                return true;
-            } elseif (update_option($config_option_name, $config_obj)) {
-                EE_Config::log($config_option_name);
-                // update wp-option for this config class
-                $this->{$section}->{$name} = $config_obj;
-                return true;
-            } elseif ($throw_errors) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
-                            'event_espresso'
-                        ),
-                        $config_class,
-                        'EE_Config->' . $section . '->' . $name
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    get_config
-     *
-     * @access    public
-     * @param    string $section
-     * @param    string $name
-     * @param    string $config_class
-     * @return    mixed EE_Config_Base | NULL
-     */
-    public function get_config($section = '', $name = '', $config_class = '')
-    {
-        // ensure config class is set to something
-        $config_class = $this->_set_config_class($config_class, $name);
-        // run tests 1-4, 6 and 7 to verify that all params have been set
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
-            return null;
-        }
-        // now test if the requested config object exists, but suppress errors
-        if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
-            // config already exists, so pass it back
-            return $this->{$section}->{$name};
-        }
-        // load config option from db if it exists
-        $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
-        // verify the newly retrieved config object, but suppress errors
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
-            // config is good, so set it and pass it back
-            $this->{$section}->{$name} = $config_obj;
-            return $this->{$section}->{$name};
-        }
-        // oops! $config_obj is not already set and does not exist in the db, so create a new one
-        $config_obj = $this->set_config($section, $name, $config_class);
-        // verify the newly created config object
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
-            return $this->{$section}->{$name};
-        } else {
-            EE_Error::add_error(
-                sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_config_option
-     *
-     * @access    public
-     * @param    string $config_option_name
-     * @return    mixed EE_Config_Base | FALSE
-     */
-    public function get_config_option($config_option_name = '')
-    {
-        // retrieve the wp-option for this config class.
-        $config_option = maybe_unserialize(get_option($config_option_name, array()));
-        if (empty($config_option)) {
-            EE_Config::log($config_option_name . '-NOT-FOUND');
-        }
-        return $config_option;
-    }
-
-
-    /**
-     * log
-     *
-     * @param string $config_option_name
-     */
-    public static function log($config_option_name = '')
-    {
-        if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
-            $config_log = get_option(EE_Config::LOG_NAME, array());
-            // copy incoming $_REQUEST and sanitize it so we can save it
-            $_request = $_REQUEST;
-            array_walk_recursive($_request, 'sanitize_text_field');
-            $config_log[ (string) microtime(true) ] = array(
-                'config_name' => $config_option_name,
-                'request'     => $_request,
-            );
-            update_option(EE_Config::LOG_NAME, $config_log);
-        }
-    }
-
-
-    /**
-     * trim_log
-     * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
-     */
-    public static function trim_log()
-    {
-        if (! EE_Config::logging_enabled()) {
-            return;
-        }
-        $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
-        $log_length = count($config_log);
-        if ($log_length > EE_Config::LOG_LENGTH) {
-            ksort($config_log);
-            $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
-            update_option(EE_Config::LOG_NAME, $config_log);
-        }
-    }
-
-
-    /**
-     *    get_page_for_posts
-     *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
-     *    wp-option "page_for_posts", or "posts" if no page is selected
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function get_page_for_posts()
-    {
-        $page_for_posts = get_option('page_for_posts');
-        if (! $page_for_posts) {
-            return 'posts';
-        }
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
-        return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
-    }
-
-
-    /**
-     *    register_shortcodes_and_modules.
-     *    At this point, it's too early to tell if we're maintenance mode or not.
-     *    In fact, this is where we give modules a chance to let core know they exist
-     *    so they can help trigger maintenance mode if it's needed
-     *
-     * @access    public
-     * @return    void
-     */
-    public function register_shortcodes_and_modules()
-    {
-        // allow modules to set hooks for the rest of the system
-        EE_Registry::instance()->modules = $this->_register_modules();
-    }
-
-
-    /**
-     *    initialize_shortcodes_and_modules
-     *    meaning they can start adding their hooks to get stuff done
-     *
-     * @access    public
-     * @return    void
-     */
-    public function initialize_shortcodes_and_modules()
-    {
-        // allow modules to set hooks for the rest of the system
-        $this->_initialize_modules();
-    }
-
-
-    /**
-     *    widgets_init
-     *
-     * @access private
-     * @return void
-     */
-    public function widgets_init()
-    {
-        // only init widgets on admin pages when not in complete maintenance, and
-        // on frontend when not in any maintenance mode
-        if (! EE_Maintenance_Mode::instance()->level()
-            || (
-                is_admin()
-                && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
-            )
-        ) {
-            // grab list of installed widgets
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
-            // filter list of modules to register
-            $widgets_to_register = apply_filters(
-                'FHEE__EE_Config__register_widgets__widgets_to_register',
-                $widgets_to_register
-            );
-            if (! empty($widgets_to_register)) {
-                // cycle thru widget folders
-                foreach ($widgets_to_register as $widget_path) {
-                    // add to list of installed widget modules
-                    EE_Config::register_ee_widget($widget_path);
-                }
-            }
-            // filter list of installed modules
-            EE_Registry::instance()->widgets = apply_filters(
-                'FHEE__EE_Config__register_widgets__installed_widgets',
-                EE_Registry::instance()->widgets
-            );
-        }
-    }
-
-
-    /**
-     *    register_ee_widget - makes core aware of this widget
-     *
-     * @access    public
-     * @param    string $widget_path - full path up to and including widget folder
-     * @return    void
-     */
-    public static function register_ee_widget($widget_path = null)
-    {
-        do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
-        $widget_ext = '.widget.php';
-        // make all separators match
-        $widget_path = rtrim(str_replace('\\', DS, $widget_path), DS);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($widget_path, $widget_ext) !== false) {
-            // grab and shortcode file name from directory name and break apart at dots
-            $file_name = explode('.', basename($widget_path));
-            // take first segment from file name pieces and remove class prefix if it exists
-            $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
-            // sanitize shortcode directory name
-            $widget = sanitize_key($widget);
-            // now we need to rebuild the shortcode path
-            $widget_path = explode(DS, $widget_path);
-            // remove last segment
-            array_pop($widget_path);
-            // glue it back together
-            $widget_path = implode(DS, $widget_path);
-        } else {
-            // grab and sanitize widget directory name
-            $widget = sanitize_key(basename($widget_path));
-        }
-        // create classname from widget directory name
-        $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
-        // add class prefix
-        $widget_class = 'EEW_' . $widget;
-        // does the widget exist ?
-        if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
-            $msg = sprintf(
-                __(
-                    'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
-                    'event_espresso'
-                ),
-                $widget_class,
-                $widget_path . DS . $widget_class . $widget_ext
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        // load the widget class file
-        require_once($widget_path . DS . $widget_class . $widget_ext);
-        // verify that class exists
-        if (! class_exists($widget_class)) {
-            $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        register_widget($widget_class);
-        // add to array of registered widgets
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
-    }
-
-
-    /**
-     *        _register_modules
-     *
-     * @access private
-     * @return array
-     */
-    private function _register_modules()
-    {
-        // grab list of installed modules
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $modules_to_register = apply_filters(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            $modules_to_register
-        );
-        if (! empty($modules_to_register)) {
-            // loop through folders
-            foreach ($modules_to_register as $module_path) {
-                /**TEMPORARILY EXCLUDE gateways from modules for time being**/
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
-                    && $module_path !== EE_MODULES . 'gateways'
-                ) {
-                    // add to list of installed modules
-                    EE_Config::register_module($module_path);
-                }
-            }
-        }
-        // filter list of installed modules
-        return apply_filters(
-            'FHEE__EE_Config___register_modules__installed_modules',
-            EE_Registry::instance()->modules
-        );
-    }
-
-
-    /**
-     *    register_module - makes core aware of this module
-     *
-     * @access    public
-     * @param    string $module_path - full path up to and including module folder
-     * @return    bool
-     */
-    public static function register_module($module_path = null)
-    {
-        do_action('AHEE__EE_Config__register_module__begin', $module_path);
-        $module_ext = '.module.php';
-        // make all separators match
-        $module_path = str_replace(array('\\', '/'), DS, $module_path);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($module_path, $module_ext) !== false) {
-            // grab and shortcode file name from directory name and break apart at dots
-            $module_file = explode('.', basename($module_path));
-            // now we need to rebuild the shortcode path
-            $module_path = explode(DS, $module_path);
-            // remove last segment
-            array_pop($module_path);
-            // glue it back together
-            $module_path = implode(DS, $module_path) . DS;
-            // take first segment from file name pieces and sanitize it
-            $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
-            // ensure class prefix is added
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
-        } else {
-            // we need to generate the filename based off of the folder name
-            // grab and sanitize module name
-            $module = strtolower(basename($module_path));
-            $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
-            // like trailingslashit()
-            $module_path = rtrim($module_path, DS) . DS;
-            // create classname from module directory name
-            $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
-            // add class prefix
-            $module_class = 'EED_' . $module;
-        }
-        // does the module exist ?
-        if (! is_readable($module_path . DS . $module_class . $module_ext)) {
-            $msg = sprintf(
-                __(
-                    'The requested %s module file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($module_path . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
-        do_action(
-            'AHEE__EE_Config__register_module__complete',
-            $module_class,
-            EE_Registry::instance()->modules->{$module_class}
-        );
-        return true;
-    }
-
-
-    /**
-     *    _initialize_modules
-     *    allow modules to set hooks for the rest of the system
-     *
-     * @access private
-     * @return void
-     */
-    private function _initialize_modules()
-    {
-        // cycle thru shortcode folders
-        foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
-            // which set hooks ?
-            if (is_admin()) {
-                // fire immediately
-                call_user_func(array($module_class, 'set_hooks_admin'));
-            } else {
-                // delay until other systems are online
-                add_action(
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-                    array($module_class, 'set_hooks')
-                );
-            }
-        }
-    }
-
-
-    /**
-     *    register_route - adds module method routes to route_map
-     *
-     * @access    public
-     * @param    string $route       - "pretty" public alias for module method
-     * @param    string $module      - module name (classname without EED_ prefix)
-     * @param    string $method_name - the actual module method to be routed to
-     * @param    string $key         - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
-        $module = str_replace('EED_', '', $module);
-        $module_class = 'EED_' . $module;
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
-            $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (empty($route)) {
-            $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (! method_exists('EED_' . $module, $method_name)) {
-            $msg = sprintf(
-                __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
-        return true;
-    }
-
-
-    /**
-     *    get_route - get module method route
-     *
-     * @access    public
-     * @param    string $route - "pretty" public alias for module method
-     * @param    string $key   - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_route($route = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_route__begin', $route);
-        $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
-            return EE_Config::$_module_route_map[ $key ][ $route ];
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_routes - get ALL module method routes
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function get_routes()
-    {
-        return EE_Config::$_module_route_map;
-    }
-
-
-    /**
-     *    register_forward - allows modules to forward request to another module for further processing
-     *
-     * @access    public
-     * @param    string       $route   - "pretty" public alias for module method
-     * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
-     *                                 class, allows different forwards to be served based on status
-     * @param    array|string $forward - function name or array( class, method )
-     * @param    string       $key     - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
-            $msg = sprintf(
-                __('The module route %s for this forward has not been registered.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (empty($forward)) {
-            $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (is_array($forward)) {
-            if (! isset($forward[1])) {
-                $msg = sprintf(
-                    __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
-                    $route
-                );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-            if (! method_exists($forward[0], $forward[1])) {
-                $msg = sprintf(
-                    __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
-                    $forward[1],
-                    $route
-                );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-        } elseif (! function_exists($forward)) {
-            $msg = sprintf(
-                __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
-                $forward,
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
-        return true;
-    }
-
-
-    /**
-     *    get_forward - get forwarding route
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different forwards to be served based on status
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_forward($route = null, $status = 0, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
-            return apply_filters(
-                'FHEE__EE_Config__get_forward',
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
-                $route,
-                $status
-            );
-        }
-        return null;
-    }
-
-
-    /**
-     *    register_forward - allows modules to specify different view templates for different method routes and status
-     *    results
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different views to be served based on status
-     * @param    string  $view
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
-            $msg = sprintf(
-                __('The module route %s for this view has not been registered.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (! is_readable($view)) {
-            $msg = sprintf(
-                __(
-                    'The %s view file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $view
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
-        return true;
-    }
-
-
-    /**
-     *    get_view - get view for route and status
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different views to be served based on status
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_view($route = null, $status = 0, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_view__begin', $route, $status);
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
-            return apply_filters(
-                'FHEE__EE_Config__get_view',
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
-                $route,
-                $status
-            );
-        }
-        return null;
-    }
-
-
-    public function update_addon_option_names()
-    {
-        update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
-    }
-
-
-    public function shutdown()
-    {
-        $this->update_addon_option_names();
-    }
-
-
-    /**
-     * @return LegacyShortcodesManager
-     */
-    public static function getLegacyShortcodesManager()
-    {
-
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
-            EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
-                EE_Registry::instance()
-            );
-        }
-        return EE_Config::instance()->legacy_shortcodes_manager;
-    }
-
-
-    /**
-     * register_shortcode - makes core aware of this shortcode
-     *
-     * @deprecated 4.9.26
-     * @param    string $shortcode_path - full path up to and including shortcode folder
-     * @return    bool
-     */
-    public static function register_shortcode($shortcode_path = null)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
-    }
-}
-
-/**
- * Base class used for config classes. These classes should generally not have
- * magic functions in use, except we'll allow them to magically set and get stuff...
- * basically, they should just be well-defined stdClasses
- */
-class EE_Config_Base
-{
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws \EE_Error
-     */
-    public function get_pretty($property)
-    {
-        if (! property_exists($this, $property)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $property
-                )
-            );
-        }
-        // just handling escaping of strings for now.
-        if (is_string($this->{$property})) {
-            return stripslashes($this->{$property});
-        }
-        return $this->{$property};
-    }
-
-
-    public function populate()
-    {
-        // grab defaults via a new instance of this class.
-        $class_name = get_class($this);
-        $defaults = new $class_name;
-        // loop through the properties for this class and see if they are set.  If they are NOT, then grab the
-        // default from our $defaults object.
-        foreach (get_object_vars($defaults) as $property => $value) {
-            if ($this->{$property} === null) {
-                $this->{$property} = $value;
-            }
-        }
-        // cleanup
-        unset($defaults);
-    }
-
-
-    /**
-     *        __isset
-     *
-     * @param $a
-     * @return bool
-     */
-    public function __isset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     *        __unset
-     *
-     * @param $a
-     * @return bool
-     */
-    public function __unset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     *        __clone
-     */
-    public function __clone()
-    {
-    }
-
-
-    /**
-     *        __wakeup
-     */
-    public function __wakeup()
-    {
-    }
-
-
-    /**
-     *        __destruct
-     */
-    public function __destruct()
-    {
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to registration settings
- */
-class EE_Core_Config extends EE_Config_Base
-{
-
-    const OPTION_NAME_UXIP = 'ee_ueip_optin';
-
-
-    public $current_blog_id;
-
-    public $ee_ueip_optin;
-
-    public $ee_ueip_has_notified;
-
-    /**
-     * Not to be confused with the 4 critical page variables (See
-     * get_critical_pages_array()), this is just an array of wp posts that have EE
-     * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
-     * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
-     *
-     * @var array
-     */
-    public $post_shortcodes;
-
-    public $module_route_map;
-
-    public $module_forward_map;
-
-    public $module_view_map;
-
-    /**
-     * The next 4 vars are the IDs of critical EE pages.
-     *
-     * @var int
-     */
-    public $reg_page_id;
-
-    public $txn_page_id;
-
-    public $thank_you_page_id;
-
-    public $cancel_page_id;
-
-    /**
-     * The next 4 vars are the URLs of critical EE pages.
-     *
-     * @var int
-     */
-    public $reg_page_url;
-
-    public $txn_page_url;
-
-    public $thank_you_page_url;
-
-    public $cancel_page_url;
-
-    /**
-     * The next vars relate to the custom slugs for EE CPT routes
-     */
-    public $event_cpt_slug;
-
-    /**
-     * This caches the _ee_ueip_option in case this config is reset in the same
-     * request across blog switches in a multisite context.
-     * Avoids extra queries to the db for this option.
-     *
-     * @var bool
-     */
-    public static $ee_ueip_option;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default organization settings
-        $this->current_blog_id = get_current_blog_id();
-        $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
-        $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
-        $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
-        $this->post_shortcodes = array();
-        $this->module_route_map = array();
-        $this->module_forward_map = array();
-        $this->module_view_map = array();
-        // critical EE page IDs
-        $this->reg_page_id = 0;
-        $this->txn_page_id = 0;
-        $this->thank_you_page_id = 0;
-        $this->cancel_page_id = 0;
-        // critical EE page URLs
-        $this->reg_page_url = '';
-        $this->txn_page_url = '';
-        $this->thank_you_page_url = '';
-        $this->cancel_page_url = '';
-        // cpt slugs
-        $this->event_cpt_slug = __('events', 'event_espresso');
-        // ueip constant check
-        if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
-            $this->ee_ueip_optin = false;
-            $this->ee_ueip_has_notified = true;
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_array()
-    {
-        return array(
-            $this->reg_page_id,
-            $this->txn_page_id,
-            $this->thank_you_page_id,
-            $this->cancel_page_id,
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_shortcodes_array()
-    {
-        return array(
-            $this->reg_page_id       => 'ESPRESSO_CHECKOUT',
-            $this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
-            $this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
-            $this->cancel_page_id    => 'ESPRESSO_CANCELLED',
-        );
-    }
-
-
-    /**
-     *  gets/returns URL for EE reg_page
-     *
-     * @access    public
-     * @return    string
-     */
-    public function reg_page_url()
-    {
-        if (! $this->reg_page_url) {
-            $this->reg_page_url = add_query_arg(
-                array('uts' => time()),
-                get_permalink($this->reg_page_id)
-            ) . '#checkout';
-        }
-        return $this->reg_page_url;
-    }
-
-
-    /**
-     *  gets/returns URL for EE txn_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @access    public
-     * @return    string
-     */
-    public function txn_page_url($query_args = array())
-    {
-        if (! $this->txn_page_url) {
-            $this->txn_page_url = get_permalink($this->txn_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->txn_page_url);
-        } else {
-            return $this->txn_page_url;
-        }
-    }
-
-
-    /**
-     *  gets/returns URL for EE thank_you_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @access    public
-     * @return    string
-     */
-    public function thank_you_page_url($query_args = array())
-    {
-        if (! $this->thank_you_page_url) {
-            $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->thank_you_page_url);
-        } else {
-            return $this->thank_you_page_url;
-        }
-    }
-
-
-    /**
-     *  gets/returns URL for EE cancel_page
-     *
-     * @access    public
-     * @return    string
-     */
-    public function cancel_page_url()
-    {
-        if (! $this->cancel_page_url) {
-            $this->cancel_page_url = get_permalink($this->cancel_page_id);
-        }
-        return $this->cancel_page_url;
-    }
-
-
-    /**
-     * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
-     *
-     * @since 4.7.5
-     */
-    protected function _reset_urls()
-    {
-        $this->reg_page_url = '';
-        $this->txn_page_url = '';
-        $this->cancel_page_url = '';
-        $this->thank_you_page_url = '';
-    }
-
-
-    /**
-     * Used to return what the optin value is set for the EE User Experience Program.
-     * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
-     * on the main site only.
-     *
-     * @return bool
-     */
-    protected function _get_main_ee_ueip_optin()
-    {
-        // if this is the main site then we can just bypass our direct query.
-        if (is_main_site()) {
-            return get_option(self::OPTION_NAME_UXIP, false);
-        }
-        // is this already cached for this request?  If so use it.
-        if (EE_Core_Config::$ee_ueip_option !== null) {
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        global $wpdb;
-        $current_network_main_site = is_multisite() ? get_current_site() : null;
-        $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
-        $option = self::OPTION_NAME_UXIP;
-        // set correct table for query
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
-        // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
-        // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
-        // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
-        // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
-        // for the purpose of caching.
-        $pre = apply_filters('pre_option_' . $option, false, $option);
-        if (false !== $pre) {
-            EE_Core_Config::$ee_ueip_option = $pre;
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        $row = $wpdb->get_row(
-            $wpdb->prepare(
-                "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
-                $option
-            )
-        );
-        if (is_object($row)) {
-            $value = $row->option_value;
-        } else { // option does not exist so use default.
-            EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
-        return EE_Core_Config::$ee_ueip_option;
-    }
-
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws \EE_Error
-     */
-    public function get_pretty($property)
-    {
-        if ($property === self::OPTION_NAME_UXIP) {
-            return $this->ee_ueip_optin ? 'yes' : 'no';
-        }
-        return parent::get_pretty($property);
-    }
-
-
-    /**
-     * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
-     * on the object.
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // reset all url properties
-        $this->_reset_urls();
-        // return what to save to db
-        return array_keys(get_object_vars($this));
-    }
-}
-
-/**
- * Config class for storing info on the Organization
- */
-class EE_Organization_Config extends EE_Config_Base
-{
-
-    /**
-     * @var string $name
-     * eg EE4.1
-     */
-    public $name;
-
-    /**
-     * @var string $address_1
-     * eg 123 Onna Road
-     */
-    public $address_1 = '';
-
-    /**
-     * @var string $address_2
-     * eg PO Box 123
-     */
-    public $address_2 = '';
-
-    /**
-     * @var string $city
-     * eg Inna City
-     */
-    public $city = '';
-
-    /**
-     * @var int $STA_ID
-     * eg 4
-     */
-    public $STA_ID = 0;
-
-    /**
-     * @var string $CNT_ISO
-     * eg US
-     */
-    public $CNT_ISO = '';
-
-    /**
-     * @var string $zip
-     * eg 12345  or V1A 2B3
-     */
-    public $zip = '';
-
-    /**
-     * @var string $email
-     * eg support@eventespresso.com
-     */
-    public $email;
-
-    /**
-     * @var string $phone
-     * eg. 111-111-1111
-     */
-    public $phone = '';
-
-    /**
-     * @var string $vat
-     * VAT/Tax Number
-     */
-    public $vat = '';
-
-    /**
-     * @var string $logo_url
-     * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
-     */
-    public $logo_url = '';
-
-    /**
-     * The below are all various properties for holding links to organization social network profiles
-     *
-     * @var string
-     */
-    /**
-     * facebook (facebook.com/profile.name)
-     *
-     * @var string
-     */
-    public $facebook = '';
-
-    /**
-     * twitter (twitter.com/twitter_handle)
-     *
-     * @var string
-     */
-    public $twitter = '';
-
-    /**
-     * linkedin (linkedin.com/in/profile_name)
-     *
-     * @var string
-     */
-    public $linkedin = '';
-
-    /**
-     * pinterest (www.pinterest.com/profile_name)
-     *
-     * @var string
-     */
-    public $pinterest = '';
-
-    /**
-     * google+ (google.com/+profileName)
-     *
-     * @var string
-     */
-    public $google = '';
-
-    /**
-     * instagram (instagram.com/handle)
-     *
-     * @var string
-     */
-    public $instagram = '';
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default organization settings
-        // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
-        $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
-        $this->email = get_bloginfo('admin_email');
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to currency
- */
-class EE_Currency_Config extends EE_Config_Base
-{
-
-    /**
-     * @var string $code
-     * eg 'US'
-     */
-    public $code;
-
-    /**
-     * @var string $name
-     * eg 'Dollar'
-     */
-    public $name;
-
-    /**
-     * plural name
-     *
-     * @var string $plural
-     * eg 'Dollars'
-     */
-    public $plural;
-
-    /**
-     * currency sign
-     *
-     * @var string $sign
-     * eg '$'
-     */
-    public $sign;
-
-    /**
-     * Whether the currency sign should come before the number or not
-     *
-     * @var boolean $sign_b4
-     */
-    public $sign_b4;
-
-    /**
-     * How many digits should come after the decimal place
-     *
-     * @var int $dec_plc
-     */
-    public $dec_plc;
-
-    /**
-     * Symbol to use for decimal mark
-     *
-     * @var string $dec_mrk
-     * eg '.'
-     */
-    public $dec_mrk;
-
-    /**
-     * Symbol to use for thousands
-     *
-     * @var string $thsnds
-     * eg ','
-     */
-    public $thsnds;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param string $CNT_ISO
-     * @throws \EE_Error
-     */
-    public function __construct($CNT_ISO = '')
-    {
-        /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
-        $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        // get country code from organization settings or use default
-        $ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
-                   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : '';
-        // but override if requested
-        $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
-        // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
-        if (! empty($CNT_ISO)
-            && EE_Maintenance_Mode::instance()->models_can_query()
-            && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
-        ) {
-            // retrieve the country settings from the db, just in case they have been customized
-            $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
-            if ($country instanceof EE_Country) {
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
-                $this->name = $country->currency_name_single();    // Dollar
-                $this->plural = $country->currency_name_plural();    // Dollars
-                $this->sign = $country->currency_sign();            // currency sign: $
-                $this->sign_b4 = $country->currency_sign_before(
-                );        // currency sign before or after: $TRUE  or  FALSE$
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
-                $this->dec_mrk = $country->currency_decimal_mark(
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-                $this->thsnds = $country->currency_thousands_separator(
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-            }
-        }
-        // fallback to hardcoded defaults, in case the above failed
-        if (empty($this->code)) {
-            // set default currency settings
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
-            $this->sign = '$';    // currency sign: $
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-        }
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to registration settings
- */
-class EE_Registration_Config extends EE_Config_Base
-{
-
-    /**
-     * Default registration status
-     *
-     * @var string $default_STS_ID
-     * eg 'RPP'
-     */
-    public $default_STS_ID;
-
-    /**
-     * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
-     * registrations)
-     *
-     * @var int
-     */
-    public $default_maximum_number_of_tickets;
-
-    /**
-     * level of validation to apply to email addresses
-     *
-     * @var string $email_validation_level
-     * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
-     */
-    public $email_validation_level;
-
-    /**
-     *    whether or not to show alternate payment options during the reg process if payment status is pending
-     *
-     * @var boolean $show_pending_payment_options
-     */
-    public $show_pending_payment_options;
-
-    /**
-     * Whether to skip the registration confirmation page
-     *
-     * @var boolean $skip_reg_confirmation
-     */
-    public $skip_reg_confirmation;
-
-    /**
-     * an array of SPCO reg steps where:
-     *        the keys denotes the reg step order
-     *        each element consists of an array with the following elements:
-     *            "file_path" => the file path to the EE_SPCO_Reg_Step class
-     *            "class_name" => the specific EE_SPCO_Reg_Step child class name
-     *            "slug" => the URL param used to trigger the reg step
-     *
-     * @var array $reg_steps
-     */
-    public $reg_steps;
-
-    /**
-     * Whether registration confirmation should be the last page of SPCO
-     *
-     * @var boolean $reg_confirmation_last
-     */
-    public $reg_confirmation_last;
-
-    /**
-     * Whether or not to enable the EE Bot Trap
-     *
-     * @var boolean $use_bot_trap
-     */
-    public $use_bot_trap;
-
-    /**
-     * Whether or not to encrypt some data sent by the EE Bot Trap
-     *
-     * @var boolean $use_encryption
-     */
-    public $use_encryption;
-
-    /**
-     * Whether or not to use ReCaptcha
-     *
-     * @var boolean $use_captcha
-     */
-    public $use_captcha;
-
-    /**
-     * ReCaptcha Theme
-     *
-     * @var string $recaptcha_theme
-     *    options: 'dark', 'light', 'invisible'
-     */
-    public $recaptcha_theme;
-
-    /**
-     * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
-     *
-     * @var string $recaptcha_badge
-     *    options: 'bottomright', 'bottomleft', 'inline'
-     */
-    public $recaptcha_badge;
+	const OPTION_NAME = 'ee_config';
+
+	const LOG_NAME = 'ee_config_log';
+
+	const LOG_LENGTH = 100;
+
+	const ADDON_OPTION_NAMES = 'ee_config_option_names';
+
+	/**
+	 *    instance of the EE_Config object
+	 *
+	 * @var    EE_Config $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var boolean $_logging_enabled
+	 */
+	private static $_logging_enabled = false;
+
+	/**
+	 * @var LegacyShortcodesManager $legacy_shortcodes_manager
+	 */
+	private $legacy_shortcodes_manager;
+
+	/**
+	 * An StdClass whose property names are addon slugs,
+	 * and values are their config classes
+	 *
+	 * @var StdClass
+	 */
+	public $addons;
+
+	/**
+	 * @var EE_Admin_Config
+	 */
+	public $admin;
+
+	/**
+	 * @var EE_Core_Config
+	 */
+	public $core;
+
+	/**
+	 * @var EE_Currency_Config
+	 */
+	public $currency;
+
+	/**
+	 * @var EE_Organization_Config
+	 */
+	public $organization;
+
+	/**
+	 * @var EE_Registration_Config
+	 */
+	public $registration;
+
+	/**
+	 * @var EE_Template_Config
+	 */
+	public $template_settings;
+
+	/**
+	 * Holds EE environment values.
+	 *
+	 * @var EE_Environment_Config
+	 */
+	public $environment;
+
+	/**
+	 * settings pertaining to Google maps
+	 *
+	 * @var EE_Map_Config
+	 */
+	public $map_settings;
+
+	/**
+	 * settings pertaining to Taxes
+	 *
+	 * @var EE_Tax_Config
+	 */
+	public $tax_settings;
+
+	/**
+	 * Settings pertaining to global messages settings.
+	 *
+	 * @var EE_Messages_Config
+	 */
+	public $messages;
+
+	/**
+	 * @deprecated
+	 * @var EE_Gateway_Config
+	 */
+	public $gateway;
+
+	/**
+	 * @var    array $_addon_option_names
+	 * @access    private
+	 */
+	private $_addon_option_names = array();
+
+	/**
+	 * @var    array $_module_route_map
+	 * @access    private
+	 */
+	private static $_module_route_map = array();
+
+	/**
+	 * @var    array $_module_forward_map
+	 * @access    private
+	 */
+	private static $_module_forward_map = array();
+
+	/**
+	 * @var    array $_module_view_map
+	 * @access    private
+	 */
+	private static $_module_view_map = array();
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Config instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Config) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the config
+	 *
+	 * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
+	 *                               (default) leaves the database alone, and merely resets the EE_Config object to
+	 *                               reflect its state in the database
+	 * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
+	 *                               $_instance as NULL. Useful in case you want to forget about the old instance on
+	 *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
+	 *                               site was put into maintenance mode)
+	 * @return EE_Config
+	 */
+	public static function reset($hard_reset = false, $reinstantiate = true)
+	{
+		if (self::$_instance instanceof EE_Config) {
+			if ($hard_reset) {
+				self::$_instance->legacy_shortcodes_manager = null;
+				self::$_instance->_addon_option_names = array();
+				self::$_instance->_initialize_config();
+				self::$_instance->update_espresso_config();
+			}
+			self::$_instance->update_addon_option_names();
+		}
+		self::$_instance = null;
+		// we don't need to reset the static properties imo because those should
+		// only change when a module is added or removed. Currently we don't
+		// support removing a module during a request when it previously existed
+		if ($reinstantiate) {
+			return self::instance();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Config__construct__begin', $this);
+		EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
+		// setup empty config classes
+		$this->_initialize_config();
+		// load existing EE site settings
+		$this->_load_core_config();
+		// confirm everything loaded correctly and set filtered defaults if not
+		$this->_verify_config();
+		//  register shortcodes and modules
+		add_action(
+			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_and_modules'),
+			999
+		);
+		//  initialize shortcodes and modules
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
+		// register widgets
+		add_action('widgets_init', array($this, 'widgets_init'), 10);
+		// shutdown
+		add_action('shutdown', array($this, 'shutdown'), 10);
+		// construct__end hook
+		do_action('AHEE__EE_Config__construct__end', $this);
+		// hardcoded hack
+		$this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public static function logging_enabled()
+	{
+		return self::$_logging_enabled;
+	}
+
+
+	/**
+	 * use to get the current theme if needed from static context
+	 *
+	 * @return string current theme set.
+	 */
+	public static function get_current_theme()
+	{
+		return isset(self::$_instance->template_settings->current_espresso_theme)
+			? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
+	}
+
+
+	/**
+	 *        _initialize_config
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _initialize_config()
+	{
+		EE_Config::trim_log();
+		// set defaults
+		$this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
+		$this->addons = new stdClass();
+		// set _module_route_map
+		EE_Config::$_module_route_map = array();
+		// set _module_forward_map
+		EE_Config::$_module_forward_map = array();
+		// set _module_view_map
+		EE_Config::$_module_view_map = array();
+	}
+
+
+	/**
+	 *        load core plugin configuration
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _load_core_config()
+	{
+		// load_core_config__start hook
+		do_action('AHEE__EE_Config___load_core_config__start', $this);
+		$espresso_config = $this->get_espresso_config();
+		foreach ($espresso_config as $config => $settings) {
+			// load_core_config__start hook
+			$settings = apply_filters(
+				'FHEE__EE_Config___load_core_config__config_settings',
+				$settings,
+				$config,
+				$this
+			);
+			if (is_object($settings) && property_exists($this, $config)) {
+				$this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
+				// call configs populate method to ensure any defaults are set for empty values.
+				if (method_exists($settings, 'populate')) {
+					$this->{$config}->populate();
+				}
+				if (method_exists($settings, 'do_hooks')) {
+					$this->{$config}->do_hooks();
+				}
+			}
+		}
+		if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
+			$this->update_espresso_config();
+		}
+		// load_core_config__end hook
+		do_action('AHEE__EE_Config___load_core_config__end', $this);
+	}
+
+
+	/**
+	 *    _verify_config
+	 *
+	 * @access    protected
+	 * @return    void
+	 */
+	protected function _verify_config()
+	{
+		$this->core = $this->core instanceof EE_Core_Config
+			? $this->core
+			: new EE_Core_Config();
+		$this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
+		$this->organization = $this->organization instanceof EE_Organization_Config
+			? $this->organization
+			: new EE_Organization_Config();
+		$this->organization = apply_filters(
+			'FHEE__EE_Config___initialize_config__organization',
+			$this->organization
+		);
+		$this->currency = $this->currency instanceof EE_Currency_Config
+			? $this->currency
+			: new EE_Currency_Config();
+		$this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
+		$this->registration = $this->registration instanceof EE_Registration_Config
+			? $this->registration
+			: new EE_Registration_Config();
+		$this->registration = apply_filters(
+			'FHEE__EE_Config___initialize_config__registration',
+			$this->registration
+		);
+		$this->admin = $this->admin instanceof EE_Admin_Config
+			? $this->admin
+			: new EE_Admin_Config();
+		$this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
+		$this->template_settings = $this->template_settings instanceof EE_Template_Config
+			? $this->template_settings
+			: new EE_Template_Config();
+		$this->template_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__template_settings',
+			$this->template_settings
+		);
+		$this->map_settings = $this->map_settings instanceof EE_Map_Config
+			? $this->map_settings
+			: new EE_Map_Config();
+		$this->map_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__map_settings',
+			$this->map_settings
+		);
+		$this->environment = $this->environment instanceof EE_Environment_Config
+			? $this->environment
+			: new EE_Environment_Config();
+		$this->environment = apply_filters(
+			'FHEE__EE_Config___initialize_config__environment',
+			$this->environment
+		);
+		$this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
+			? $this->tax_settings
+			: new EE_Tax_Config();
+		$this->tax_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__tax_settings',
+			$this->tax_settings
+		);
+		$this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
+		$this->messages = $this->messages instanceof EE_Messages_Config
+			? $this->messages
+			: new EE_Messages_Config();
+		$this->gateway = $this->gateway instanceof EE_Gateway_Config
+			? $this->gateway
+			: new EE_Gateway_Config();
+		$this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
+		$this->legacy_shortcodes_manager = null;
+	}
+
+
+	/**
+	 *    get_espresso_config
+	 *
+	 * @access    public
+	 * @return    array of espresso config stuff
+	 */
+	public function get_espresso_config()
+	{
+		// grab espresso configuration
+		return apply_filters(
+			'FHEE__EE_Config__get_espresso_config__CFG',
+			get_option(EE_Config::OPTION_NAME, array())
+		);
+	}
+
+
+	/**
+	 *    double_check_config_comparison
+	 *
+	 * @access    public
+	 * @param string $option
+	 * @param        $old_value
+	 * @param        $value
+	 */
+	public function double_check_config_comparison($option = '', $old_value, $value)
+	{
+		// make sure we're checking the ee config
+		if ($option === EE_Config::OPTION_NAME) {
+			// run a loose comparison of the old value against the new value for type and properties,
+			// but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
+			if ($value != $old_value) {
+				// if they are NOT the same, then remove the hook,
+				// which means the subsequent update results will be based solely on the update query results
+				// the reason we do this is because, as stated above,
+				// WP update_option performs an exact instance comparison (===) on any update values passed to it
+				// this happens PRIOR to serialization and any subsequent update.
+				// If values are found to match their previous old value,
+				// then WP bails before performing any update.
+				// Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
+				// it just pulled from the db, with the one being passed to it (which will not match).
+				// HOWEVER, once the object is serialized and passed off to MySQL to update,
+				// MySQL MAY ALSO NOT perform the update because
+				// the string it sees in the db looks the same as the new one it has been passed!!!
+				// This results in the query returning an "affected rows" value of ZERO,
+				// which gets returned immediately by WP update_option and looks like an error.
+				remove_action('update_option', array($this, 'check_config_updated'));
+			}
+		}
+	}
+
+
+	/**
+	 *    update_espresso_config
+	 *
+	 * @access   public
+	 */
+	protected function _reset_espresso_addon_config()
+	{
+		$this->_addon_option_names = array();
+		foreach ($this->addons as $addon_name => $addon_config_obj) {
+			$addon_config_obj = maybe_unserialize($addon_config_obj);
+			if ($addon_config_obj instanceof EE_Config_Base) {
+				$this->update_config('addons', $addon_name, $addon_config_obj, false);
+			}
+			$this->addons->{$addon_name} = null;
+		}
+	}
+
+
+	/**
+	 *    update_espresso_config
+	 *
+	 * @access   public
+	 * @param   bool $add_success
+	 * @param   bool $add_error
+	 * @return   bool
+	 */
+	public function update_espresso_config($add_success = false, $add_error = true)
+	{
+		// don't allow config updates during WP heartbeats
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
+			return false;
+		}
+		// commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
+		// $clone = clone( self::$_instance );
+		// self::$_instance = NULL;
+		do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
+		$this->_reset_espresso_addon_config();
+		// hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
+		// but BEFORE the actual update occurs
+		add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
+		// don't want to persist legacy_shortcodes_manager, but don't want to lose it either
+		$legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
+		$this->legacy_shortcodes_manager = null;
+		// now update "ee_config"
+		$saved = update_option(EE_Config::OPTION_NAME, $this);
+		$this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
+		EE_Config::log(EE_Config::OPTION_NAME);
+		// if not saved... check if the hook we just added still exists;
+		// if it does, it means one of two things:
+		// that update_option bailed at the($value === $old_value) conditional,
+		// or...
+		// the db update query returned 0 rows affected
+		// (probably because the data  value was the same from it's perspective)
+		// so the existence of the hook means that a negative result from update_option is NOT an error,
+		// but just means no update occurred, so don't display an error to the user.
+		// BUT... if update_option returns FALSE, AND the hook is missing,
+		// then it means that something truly went wrong
+		$saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
+		// remove our action since we don't want it in the system anymore
+		remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
+		do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
+		// self::$_instance = $clone;
+		// unset( $clone );
+		// if config remains the same or was updated successfully
+		if ($saved) {
+			if ($add_success) {
+				EE_Error::add_success(
+					__('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return true;
+		} else {
+			if ($add_error) {
+				EE_Error::add_error(
+					__('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return false;
+		}
+	}
+
+
+	/**
+	 *    _verify_config_params
+	 *
+	 * @access    private
+	 * @param    string         $section
+	 * @param    string         $name
+	 * @param    string         $config_class
+	 * @param    EE_Config_Base $config_obj
+	 * @param    array          $tests_to_run
+	 * @param    bool           $display_errors
+	 * @return    bool    TRUE on success, FALSE on fail
+	 */
+	private function _verify_config_params(
+		$section = '',
+		$name = '',
+		$config_class = '',
+		$config_obj = null,
+		$tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
+		$display_errors = true
+	) {
+		try {
+			foreach ($tests_to_run as $test) {
+				switch ($test) {
+					// TEST #1 : check that section was set
+					case 1:
+						if (empty($section)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'No configuration section has been provided while attempting to save "%s".',
+											'event_espresso'
+										),
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #2 : check that settings section exists
+					case 2:
+						if (! isset($this->{$section})) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('The "%s" configuration section does not exist.', 'event_espresso'),
+										$section
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #3 : check that section is the proper format
+					case 3:
+						if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
+						) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The "%s" configuration settings have not been formatted correctly.',
+											'event_espresso'
+										),
+										$section
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #4 : check that config section name has been set
+					case 4:
+						if (empty($name)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									__(
+										'No name has been provided for the specific configuration section.',
+										'event_espresso'
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #5 : check that a config class name has been set
+					case 5:
+						if (empty($config_class)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									__(
+										'No class name has been provided for the specific configuration section.',
+										'event_espresso'
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #6 : verify config class is accessible
+					case 6:
+						if (! class_exists($config_class)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
+											'event_espresso'
+										),
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #7 : check that config has even been set
+					case 7:
+						if (! isset($this->{$section}->{$name})) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
+										$section,
+										$name
+									)
+								);
+							}
+							return false;
+						} else {
+							// and make sure it's not serialized
+							$this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
+						}
+						break;
+					// TEST #8 : check that config is the requested type
+					case 8:
+						if (! $this->{$section}->{$name} instanceof $config_class) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
+											'event_espresso'
+										),
+										$section,
+										$name,
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #9 : verify config object
+					case 9:
+						if (! $config_obj instanceof EE_Config_Base) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
+										print_r($config_obj, true)
+									)
+								);
+							}
+							return false;
+						}
+						break;
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		// you have successfully run the gauntlet
+		return true;
+	}
+
+
+	/**
+	 *    _generate_config_option_name
+	 *
+	 * @access        protected
+	 * @param        string $section
+	 * @param        string $name
+	 * @return        string
+	 */
+	private function _generate_config_option_name($section = '', $name = '')
+	{
+		return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
+	}
+
+
+	/**
+	 *    _set_config_class
+	 * ensures that a config class is set, either from a passed config class or one generated from the config name
+	 *
+	 * @access    private
+	 * @param    string $config_class
+	 * @param    string $name
+	 * @return    string
+	 */
+	private function _set_config_class($config_class = '', $name = '')
+	{
+		return ! empty($config_class)
+			? $config_class
+			: str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
+	}
+
+
+	/**
+	 *    set_config
+	 *
+	 * @access    protected
+	 * @param    string         $section
+	 * @param    string         $name
+	 * @param    string         $config_class
+	 * @param    EE_Config_Base $config_obj
+	 * @return    EE_Config_Base
+	 */
+	public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
+	{
+		// ensure config class is set to something
+		$config_class = $this->_set_config_class($config_class, $name);
+		// run tests 1-4, 6, and 7 to verify all config params are set and valid
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+			return null;
+		}
+		$config_option_name = $this->_generate_config_option_name($section, $name);
+		// if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
+			$this->_addon_option_names[ $config_option_name ] = $config_class;
+			$this->update_addon_option_names();
+		}
+		// verify the incoming config object but suppress errors
+		if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+			$config_obj = new $config_class();
+		}
+		if (get_option($config_option_name)) {
+			EE_Config::log($config_option_name);
+			update_option($config_option_name, $config_obj);
+			$this->{$section}->{$name} = $config_obj;
+			return $this->{$section}->{$name};
+		} else {
+			// create a wp-option for this config
+			if (add_option($config_option_name, $config_obj, '', 'no')) {
+				$this->{$section}->{$name} = maybe_unserialize($config_obj);
+				return $this->{$section}->{$name};
+			} else {
+				EE_Error::add_error(
+					sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return null;
+			}
+		}
+	}
+
+
+	/**
+	 *    update_config
+	 * Important: the config object must ALREADY be set, otherwise this will produce an error.
+	 *
+	 * @access    public
+	 * @param    string                $section
+	 * @param    string                $name
+	 * @param    EE_Config_Base|string $config_obj
+	 * @param    bool                  $throw_errors
+	 * @return    bool
+	 */
+	public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
+	{
+		// don't allow config updates during WP heartbeats
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
+			return false;
+		}
+		$config_obj = maybe_unserialize($config_obj);
+		// get class name of the incoming object
+		$config_class = get_class($config_obj);
+		// run tests 1-5 and 9 to verify config
+		if (! $this->_verify_config_params(
+			$section,
+			$name,
+			$config_class,
+			$config_obj,
+			array(1, 2, 3, 4, 7, 9)
+		)
+		) {
+			return false;
+		}
+		$config_option_name = $this->_generate_config_option_name($section, $name);
+		// check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
+			// save new config to db
+			if ($this->set_config($section, $name, $config_class, $config_obj)) {
+				return true;
+			}
+		} else {
+			// first check if the record already exists
+			$existing_config = get_option($config_option_name);
+			$config_obj = serialize($config_obj);
+			// just return if db record is already up to date (NOT type safe comparison)
+			if ($existing_config == $config_obj) {
+				$this->{$section}->{$name} = $config_obj;
+				return true;
+			} elseif (update_option($config_option_name, $config_obj)) {
+				EE_Config::log($config_option_name);
+				// update wp-option for this config class
+				$this->{$section}->{$name} = $config_obj;
+				return true;
+			} elseif ($throw_errors) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
+							'event_espresso'
+						),
+						$config_class,
+						'EE_Config->' . $section . '->' . $name
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    get_config
+	 *
+	 * @access    public
+	 * @param    string $section
+	 * @param    string $name
+	 * @param    string $config_class
+	 * @return    mixed EE_Config_Base | NULL
+	 */
+	public function get_config($section = '', $name = '', $config_class = '')
+	{
+		// ensure config class is set to something
+		$config_class = $this->_set_config_class($config_class, $name);
+		// run tests 1-4, 6 and 7 to verify that all params have been set
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+			return null;
+		}
+		// now test if the requested config object exists, but suppress errors
+		if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
+			// config already exists, so pass it back
+			return $this->{$section}->{$name};
+		}
+		// load config option from db if it exists
+		$config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
+		// verify the newly retrieved config object, but suppress errors
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+			// config is good, so set it and pass it back
+			$this->{$section}->{$name} = $config_obj;
+			return $this->{$section}->{$name};
+		}
+		// oops! $config_obj is not already set and does not exist in the db, so create a new one
+		$config_obj = $this->set_config($section, $name, $config_class);
+		// verify the newly created config object
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
+			return $this->{$section}->{$name};
+		} else {
+			EE_Error::add_error(
+				sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_config_option
+	 *
+	 * @access    public
+	 * @param    string $config_option_name
+	 * @return    mixed EE_Config_Base | FALSE
+	 */
+	public function get_config_option($config_option_name = '')
+	{
+		// retrieve the wp-option for this config class.
+		$config_option = maybe_unserialize(get_option($config_option_name, array()));
+		if (empty($config_option)) {
+			EE_Config::log($config_option_name . '-NOT-FOUND');
+		}
+		return $config_option;
+	}
+
+
+	/**
+	 * log
+	 *
+	 * @param string $config_option_name
+	 */
+	public static function log($config_option_name = '')
+	{
+		if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
+			$config_log = get_option(EE_Config::LOG_NAME, array());
+			// copy incoming $_REQUEST and sanitize it so we can save it
+			$_request = $_REQUEST;
+			array_walk_recursive($_request, 'sanitize_text_field');
+			$config_log[ (string) microtime(true) ] = array(
+				'config_name' => $config_option_name,
+				'request'     => $_request,
+			);
+			update_option(EE_Config::LOG_NAME, $config_log);
+		}
+	}
+
+
+	/**
+	 * trim_log
+	 * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
+	 */
+	public static function trim_log()
+	{
+		if (! EE_Config::logging_enabled()) {
+			return;
+		}
+		$config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
+		$log_length = count($config_log);
+		if ($log_length > EE_Config::LOG_LENGTH) {
+			ksort($config_log);
+			$config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
+			update_option(EE_Config::LOG_NAME, $config_log);
+		}
+	}
+
+
+	/**
+	 *    get_page_for_posts
+	 *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
+	 *    wp-option "page_for_posts", or "posts" if no page is selected
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function get_page_for_posts()
+	{
+		$page_for_posts = get_option('page_for_posts');
+		if (! $page_for_posts) {
+			return 'posts';
+		}
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
+		return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
+	}
+
+
+	/**
+	 *    register_shortcodes_and_modules.
+	 *    At this point, it's too early to tell if we're maintenance mode or not.
+	 *    In fact, this is where we give modules a chance to let core know they exist
+	 *    so they can help trigger maintenance mode if it's needed
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function register_shortcodes_and_modules()
+	{
+		// allow modules to set hooks for the rest of the system
+		EE_Registry::instance()->modules = $this->_register_modules();
+	}
+
+
+	/**
+	 *    initialize_shortcodes_and_modules
+	 *    meaning they can start adding their hooks to get stuff done
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function initialize_shortcodes_and_modules()
+	{
+		// allow modules to set hooks for the rest of the system
+		$this->_initialize_modules();
+	}
+
+
+	/**
+	 *    widgets_init
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function widgets_init()
+	{
+		// only init widgets on admin pages when not in complete maintenance, and
+		// on frontend when not in any maintenance mode
+		if (! EE_Maintenance_Mode::instance()->level()
+			|| (
+				is_admin()
+				&& EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
+			)
+		) {
+			// grab list of installed widgets
+			$widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
+			// filter list of modules to register
+			$widgets_to_register = apply_filters(
+				'FHEE__EE_Config__register_widgets__widgets_to_register',
+				$widgets_to_register
+			);
+			if (! empty($widgets_to_register)) {
+				// cycle thru widget folders
+				foreach ($widgets_to_register as $widget_path) {
+					// add to list of installed widget modules
+					EE_Config::register_ee_widget($widget_path);
+				}
+			}
+			// filter list of installed modules
+			EE_Registry::instance()->widgets = apply_filters(
+				'FHEE__EE_Config__register_widgets__installed_widgets',
+				EE_Registry::instance()->widgets
+			);
+		}
+	}
+
+
+	/**
+	 *    register_ee_widget - makes core aware of this widget
+	 *
+	 * @access    public
+	 * @param    string $widget_path - full path up to and including widget folder
+	 * @return    void
+	 */
+	public static function register_ee_widget($widget_path = null)
+	{
+		do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
+		$widget_ext = '.widget.php';
+		// make all separators match
+		$widget_path = rtrim(str_replace('\\', DS, $widget_path), DS);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($widget_path, $widget_ext) !== false) {
+			// grab and shortcode file name from directory name and break apart at dots
+			$file_name = explode('.', basename($widget_path));
+			// take first segment from file name pieces and remove class prefix if it exists
+			$widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
+			// sanitize shortcode directory name
+			$widget = sanitize_key($widget);
+			// now we need to rebuild the shortcode path
+			$widget_path = explode(DS, $widget_path);
+			// remove last segment
+			array_pop($widget_path);
+			// glue it back together
+			$widget_path = implode(DS, $widget_path);
+		} else {
+			// grab and sanitize widget directory name
+			$widget = sanitize_key(basename($widget_path));
+		}
+		// create classname from widget directory name
+		$widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
+		// add class prefix
+		$widget_class = 'EEW_' . $widget;
+		// does the widget exist ?
+		if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
+			$msg = sprintf(
+				__(
+					'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
+					'event_espresso'
+				),
+				$widget_class,
+				$widget_path . DS . $widget_class . $widget_ext
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		// load the widget class file
+		require_once($widget_path . DS . $widget_class . $widget_ext);
+		// verify that class exists
+		if (! class_exists($widget_class)) {
+			$msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		register_widget($widget_class);
+		// add to array of registered widgets
+		EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
+	}
+
+
+	/**
+	 *        _register_modules
+	 *
+	 * @access private
+	 * @return array
+	 */
+	private function _register_modules()
+	{
+		// grab list of installed modules
+		$modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$modules_to_register = apply_filters(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			$modules_to_register
+		);
+		if (! empty($modules_to_register)) {
+			// loop through folders
+			foreach ($modules_to_register as $module_path) {
+				/**TEMPORARILY EXCLUDE gateways from modules for time being**/
+				if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
+					&& $module_path !== EE_MODULES . 'gateways'
+				) {
+					// add to list of installed modules
+					EE_Config::register_module($module_path);
+				}
+			}
+		}
+		// filter list of installed modules
+		return apply_filters(
+			'FHEE__EE_Config___register_modules__installed_modules',
+			EE_Registry::instance()->modules
+		);
+	}
+
+
+	/**
+	 *    register_module - makes core aware of this module
+	 *
+	 * @access    public
+	 * @param    string $module_path - full path up to and including module folder
+	 * @return    bool
+	 */
+	public static function register_module($module_path = null)
+	{
+		do_action('AHEE__EE_Config__register_module__begin', $module_path);
+		$module_ext = '.module.php';
+		// make all separators match
+		$module_path = str_replace(array('\\', '/'), DS, $module_path);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($module_path, $module_ext) !== false) {
+			// grab and shortcode file name from directory name and break apart at dots
+			$module_file = explode('.', basename($module_path));
+			// now we need to rebuild the shortcode path
+			$module_path = explode(DS, $module_path);
+			// remove last segment
+			array_pop($module_path);
+			// glue it back together
+			$module_path = implode(DS, $module_path) . DS;
+			// take first segment from file name pieces and sanitize it
+			$module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
+			// ensure class prefix is added
+			$module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
+		} else {
+			// we need to generate the filename based off of the folder name
+			// grab and sanitize module name
+			$module = strtolower(basename($module_path));
+			$module = preg_replace('/[^a-z0-9_\-]/', '', $module);
+			// like trailingslashit()
+			$module_path = rtrim($module_path, DS) . DS;
+			// create classname from module directory name
+			$module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
+			// add class prefix
+			$module_class = 'EED_' . $module;
+		}
+		// does the module exist ?
+		if (! is_readable($module_path . DS . $module_class . $module_ext)) {
+			$msg = sprintf(
+				__(
+					'The requested %s module file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($module_path . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
+		do_action(
+			'AHEE__EE_Config__register_module__complete',
+			$module_class,
+			EE_Registry::instance()->modules->{$module_class}
+		);
+		return true;
+	}
+
+
+	/**
+	 *    _initialize_modules
+	 *    allow modules to set hooks for the rest of the system
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _initialize_modules()
+	{
+		// cycle thru shortcode folders
+		foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
+			// which set hooks ?
+			if (is_admin()) {
+				// fire immediately
+				call_user_func(array($module_class, 'set_hooks_admin'));
+			} else {
+				// delay until other systems are online
+				add_action(
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
+					array($module_class, 'set_hooks')
+				);
+			}
+		}
+	}
+
+
+	/**
+	 *    register_route - adds module method routes to route_map
+	 *
+	 * @access    public
+	 * @param    string $route       - "pretty" public alias for module method
+	 * @param    string $module      - module name (classname without EED_ prefix)
+	 * @param    string $method_name - the actual module method to be routed to
+	 * @param    string $key         - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
+		$module = str_replace('EED_', '', $module);
+		$module_class = 'EED_' . $module;
+		if (! isset(EE_Registry::instance()->modules->{$module_class})) {
+			$msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (empty($route)) {
+			$msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (! method_exists('EED_' . $module, $method_name)) {
+			$msg = sprintf(
+				__('A valid class method for the %s route has not been supplied.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
+		return true;
+	}
+
+
+	/**
+	 *    get_route - get module method route
+	 *
+	 * @access    public
+	 * @param    string $route - "pretty" public alias for module method
+	 * @param    string $key   - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_route($route = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_route__begin', $route);
+		$route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
+		if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
+			return EE_Config::$_module_route_map[ $key ][ $route ];
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_routes - get ALL module method routes
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function get_routes()
+	{
+		return EE_Config::$_module_route_map;
+	}
+
+
+	/**
+	 *    register_forward - allows modules to forward request to another module for further processing
+	 *
+	 * @access    public
+	 * @param    string       $route   - "pretty" public alias for module method
+	 * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
+	 *                                 class, allows different forwards to be served based on status
+	 * @param    array|string $forward - function name or array( class, method )
+	 * @param    string       $key     - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+			$msg = sprintf(
+				__('The module route %s for this forward has not been registered.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (empty($forward)) {
+			$msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (is_array($forward)) {
+			if (! isset($forward[1])) {
+				$msg = sprintf(
+					__('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
+					$route
+				);
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+			if (! method_exists($forward[0], $forward[1])) {
+				$msg = sprintf(
+					__('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
+					$forward[1],
+					$route
+				);
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+		} elseif (! function_exists($forward)) {
+			$msg = sprintf(
+				__('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
+				$forward,
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
+		return true;
+	}
+
+
+	/**
+	 *    get_forward - get forwarding route
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different forwards to be served based on status
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_forward($route = null, $status = 0, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
+		if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
+			return apply_filters(
+				'FHEE__EE_Config__get_forward',
+				EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
+				$route,
+				$status
+			);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    register_forward - allows modules to specify different view templates for different method routes and status
+	 *    results
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different views to be served based on status
+	 * @param    string  $view
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+			$msg = sprintf(
+				__('The module route %s for this view has not been registered.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (! is_readable($view)) {
+			$msg = sprintf(
+				__(
+					'The %s view file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$view
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
+		return true;
+	}
+
+
+	/**
+	 *    get_view - get view for route and status
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different views to be served based on status
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_view($route = null, $status = 0, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_view__begin', $route, $status);
+		if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
+			return apply_filters(
+				'FHEE__EE_Config__get_view',
+				EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
+				$route,
+				$status
+			);
+		}
+		return null;
+	}
+
+
+	public function update_addon_option_names()
+	{
+		update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
+	}
+
+
+	public function shutdown()
+	{
+		$this->update_addon_option_names();
+	}
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 */
+	public static function getLegacyShortcodesManager()
+	{
+
+		if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
+			EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
+				EE_Registry::instance()
+			);
+		}
+		return EE_Config::instance()->legacy_shortcodes_manager;
+	}
+
+
+	/**
+	 * register_shortcode - makes core aware of this shortcode
+	 *
+	 * @deprecated 4.9.26
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
+	 * @return    bool
+	 */
+	public static function register_shortcode($shortcode_path = null)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
+	}
+}
 
-    /**
-     * ReCaptcha Type
-     *
-     * @var string $recaptcha_type
-     *    options: 'audio', 'image'
-     */
-    public $recaptcha_type;
+/**
+ * Base class used for config classes. These classes should generally not have
+ * magic functions in use, except we'll allow them to magically set and get stuff...
+ * basically, they should just be well-defined stdClasses
+ */
+class EE_Config_Base
+{
 
-    /**
-     * ReCaptcha language
-     *
-     * @var string $recaptcha_language
-     * eg 'en'
-     */
-    public $recaptcha_language;
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($property)
+	{
+		if (! property_exists($this, $property)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
+						'event_espresso'
+					),
+					get_class($this),
+					$property
+				)
+			);
+		}
+		// just handling escaping of strings for now.
+		if (is_string($this->{$property})) {
+			return stripslashes($this->{$property});
+		}
+		return $this->{$property};
+	}
+
+
+	public function populate()
+	{
+		// grab defaults via a new instance of this class.
+		$class_name = get_class($this);
+		$defaults = new $class_name;
+		// loop through the properties for this class and see if they are set.  If they are NOT, then grab the
+		// default from our $defaults object.
+		foreach (get_object_vars($defaults) as $property => $value) {
+			if ($this->{$property} === null) {
+				$this->{$property} = $value;
+			}
+		}
+		// cleanup
+		unset($defaults);
+	}
+
+
+	/**
+	 *        __isset
+	 *
+	 * @param $a
+	 * @return bool
+	 */
+	public function __isset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 *        __unset
+	 *
+	 * @param $a
+	 * @return bool
+	 */
+	public function __unset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 *        __clone
+	 */
+	public function __clone()
+	{
+	}
+
+
+	/**
+	 *        __wakeup
+	 */
+	public function __wakeup()
+	{
+	}
+
+
+	/**
+	 *        __destruct
+	 */
+	public function __destruct()
+	{
+	}
+}
 
-    /**
-     * ReCaptcha public key
-     *
-     * @var string $recaptcha_publickey
-     */
-    public $recaptcha_publickey;
+/**
+ * Class for defining what's in the EE_Config relating to registration settings
+ */
+class EE_Core_Config extends EE_Config_Base
+{
 
-    /**
-     * ReCaptcha private key
-     *
-     * @var string $recaptcha_privatekey
-     */
-    public $recaptcha_privatekey;
+	const OPTION_NAME_UXIP = 'ee_ueip_optin';
+
+
+	public $current_blog_id;
+
+	public $ee_ueip_optin;
+
+	public $ee_ueip_has_notified;
+
+	/**
+	 * Not to be confused with the 4 critical page variables (See
+	 * get_critical_pages_array()), this is just an array of wp posts that have EE
+	 * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
+	 * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
+	 *
+	 * @var array
+	 */
+	public $post_shortcodes;
+
+	public $module_route_map;
+
+	public $module_forward_map;
+
+	public $module_view_map;
+
+	/**
+	 * The next 4 vars are the IDs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public $reg_page_id;
+
+	public $txn_page_id;
+
+	public $thank_you_page_id;
+
+	public $cancel_page_id;
+
+	/**
+	 * The next 4 vars are the URLs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public $reg_page_url;
+
+	public $txn_page_url;
+
+	public $thank_you_page_url;
+
+	public $cancel_page_url;
+
+	/**
+	 * The next vars relate to the custom slugs for EE CPT routes
+	 */
+	public $event_cpt_slug;
+
+	/**
+	 * This caches the _ee_ueip_option in case this config is reset in the same
+	 * request across blog switches in a multisite context.
+	 * Avoids extra queries to the db for this option.
+	 *
+	 * @var bool
+	 */
+	public static $ee_ueip_option;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default organization settings
+		$this->current_blog_id = get_current_blog_id();
+		$this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
+		$this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
+		$this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
+		$this->post_shortcodes = array();
+		$this->module_route_map = array();
+		$this->module_forward_map = array();
+		$this->module_view_map = array();
+		// critical EE page IDs
+		$this->reg_page_id = 0;
+		$this->txn_page_id = 0;
+		$this->thank_you_page_id = 0;
+		$this->cancel_page_id = 0;
+		// critical EE page URLs
+		$this->reg_page_url = '';
+		$this->txn_page_url = '';
+		$this->thank_you_page_url = '';
+		$this->cancel_page_url = '';
+		// cpt slugs
+		$this->event_cpt_slug = __('events', 'event_espresso');
+		// ueip constant check
+		if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
+			$this->ee_ueip_optin = false;
+			$this->ee_ueip_has_notified = true;
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_array()
+	{
+		return array(
+			$this->reg_page_id,
+			$this->txn_page_id,
+			$this->thank_you_page_id,
+			$this->cancel_page_id,
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_shortcodes_array()
+	{
+		return array(
+			$this->reg_page_id       => 'ESPRESSO_CHECKOUT',
+			$this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
+			$this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
+			$this->cancel_page_id    => 'ESPRESSO_CANCELLED',
+		);
+	}
+
+
+	/**
+	 *  gets/returns URL for EE reg_page
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function reg_page_url()
+	{
+		if (! $this->reg_page_url) {
+			$this->reg_page_url = add_query_arg(
+				array('uts' => time()),
+				get_permalink($this->reg_page_id)
+			) . '#checkout';
+		}
+		return $this->reg_page_url;
+	}
+
+
+	/**
+	 *  gets/returns URL for EE txn_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @access    public
+	 * @return    string
+	 */
+	public function txn_page_url($query_args = array())
+	{
+		if (! $this->txn_page_url) {
+			$this->txn_page_url = get_permalink($this->txn_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->txn_page_url);
+		} else {
+			return $this->txn_page_url;
+		}
+	}
+
+
+	/**
+	 *  gets/returns URL for EE thank_you_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @access    public
+	 * @return    string
+	 */
+	public function thank_you_page_url($query_args = array())
+	{
+		if (! $this->thank_you_page_url) {
+			$this->thank_you_page_url = get_permalink($this->thank_you_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->thank_you_page_url);
+		} else {
+			return $this->thank_you_page_url;
+		}
+	}
+
+
+	/**
+	 *  gets/returns URL for EE cancel_page
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function cancel_page_url()
+	{
+		if (! $this->cancel_page_url) {
+			$this->cancel_page_url = get_permalink($this->cancel_page_id);
+		}
+		return $this->cancel_page_url;
+	}
+
+
+	/**
+	 * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
+	 *
+	 * @since 4.7.5
+	 */
+	protected function _reset_urls()
+	{
+		$this->reg_page_url = '';
+		$this->txn_page_url = '';
+		$this->cancel_page_url = '';
+		$this->thank_you_page_url = '';
+	}
+
+
+	/**
+	 * Used to return what the optin value is set for the EE User Experience Program.
+	 * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
+	 * on the main site only.
+	 *
+	 * @return bool
+	 */
+	protected function _get_main_ee_ueip_optin()
+	{
+		// if this is the main site then we can just bypass our direct query.
+		if (is_main_site()) {
+			return get_option(self::OPTION_NAME_UXIP, false);
+		}
+		// is this already cached for this request?  If so use it.
+		if (EE_Core_Config::$ee_ueip_option !== null) {
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		global $wpdb;
+		$current_network_main_site = is_multisite() ? get_current_site() : null;
+		$current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
+		$option = self::OPTION_NAME_UXIP;
+		// set correct table for query
+		$table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
+		// rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
+		// get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
+		// re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
+		// this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
+		// for the purpose of caching.
+		$pre = apply_filters('pre_option_' . $option, false, $option);
+		if (false !== $pre) {
+			EE_Core_Config::$ee_ueip_option = $pre;
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		$row = $wpdb->get_row(
+			$wpdb->prepare(
+				"SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
+				$option
+			)
+		);
+		if (is_object($row)) {
+			$value = $row->option_value;
+		} else { // option does not exist so use default.
+			EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
+		return EE_Core_Config::$ee_ueip_option;
+	}
+
+
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($property)
+	{
+		if ($property === self::OPTION_NAME_UXIP) {
+			return $this->ee_ueip_optin ? 'yes' : 'no';
+		}
+		return parent::get_pretty($property);
+	}
+
+
+	/**
+	 * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
+	 * on the object.
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// reset all url properties
+		$this->_reset_urls();
+		// return what to save to db
+		return array_keys(get_object_vars($this));
+	}
+}
 
-    /**
-     * array of form names protected by ReCaptcha
-     *
-     * @var array $recaptcha_protected_forms
-     */
-    public $recaptcha_protected_forms;
+/**
+ * Config class for storing info on the Organization
+ */
+class EE_Organization_Config extends EE_Config_Base
+{
 
-    /**
-     * ReCaptcha width
-     *
-     * @var int $recaptcha_width
-     * @deprecated
-     */
-    public $recaptcha_width;
+	/**
+	 * @var string $name
+	 * eg EE4.1
+	 */
+	public $name;
+
+	/**
+	 * @var string $address_1
+	 * eg 123 Onna Road
+	 */
+	public $address_1 = '';
+
+	/**
+	 * @var string $address_2
+	 * eg PO Box 123
+	 */
+	public $address_2 = '';
+
+	/**
+	 * @var string $city
+	 * eg Inna City
+	 */
+	public $city = '';
+
+	/**
+	 * @var int $STA_ID
+	 * eg 4
+	 */
+	public $STA_ID = 0;
+
+	/**
+	 * @var string $CNT_ISO
+	 * eg US
+	 */
+	public $CNT_ISO = '';
+
+	/**
+	 * @var string $zip
+	 * eg 12345  or V1A 2B3
+	 */
+	public $zip = '';
+
+	/**
+	 * @var string $email
+	 * eg support@eventespresso.com
+	 */
+	public $email;
+
+	/**
+	 * @var string $phone
+	 * eg. 111-111-1111
+	 */
+	public $phone = '';
+
+	/**
+	 * @var string $vat
+	 * VAT/Tax Number
+	 */
+	public $vat = '';
+
+	/**
+	 * @var string $logo_url
+	 * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
+	 */
+	public $logo_url = '';
+
+	/**
+	 * The below are all various properties for holding links to organization social network profiles
+	 *
+	 * @var string
+	 */
+	/**
+	 * facebook (facebook.com/profile.name)
+	 *
+	 * @var string
+	 */
+	public $facebook = '';
+
+	/**
+	 * twitter (twitter.com/twitter_handle)
+	 *
+	 * @var string
+	 */
+	public $twitter = '';
+
+	/**
+	 * linkedin (linkedin.com/in/profile_name)
+	 *
+	 * @var string
+	 */
+	public $linkedin = '';
+
+	/**
+	 * pinterest (www.pinterest.com/profile_name)
+	 *
+	 * @var string
+	 */
+	public $pinterest = '';
+
+	/**
+	 * google+ (google.com/+profileName)
+	 *
+	 * @var string
+	 */
+	public $google = '';
+
+	/**
+	 * instagram (instagram.com/handle)
+	 *
+	 * @var string
+	 */
+	public $instagram = '';
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default organization settings
+		// decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
+		$this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
+		$this->email = get_bloginfo('admin_email');
+	}
+}
 
-    /**
-     * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
-     *
-     * @var boolean $track_invalid_checkout_access
-     */
-    protected $track_invalid_checkout_access = true;
+/**
+ * Class for defining what's in the EE_Config relating to currency
+ */
+class EE_Currency_Config extends EE_Config_Base
+{
 
-    /**
-     * Whether or not to show the privacy policy consent checkbox
-     *
-     * @var bool
-     */
-    public $consent_checkbox_enabled;
+	/**
+	 * @var string $code
+	 * eg 'US'
+	 */
+	public $code;
+
+	/**
+	 * @var string $name
+	 * eg 'Dollar'
+	 */
+	public $name;
+
+	/**
+	 * plural name
+	 *
+	 * @var string $plural
+	 * eg 'Dollars'
+	 */
+	public $plural;
+
+	/**
+	 * currency sign
+	 *
+	 * @var string $sign
+	 * eg '$'
+	 */
+	public $sign;
+
+	/**
+	 * Whether the currency sign should come before the number or not
+	 *
+	 * @var boolean $sign_b4
+	 */
+	public $sign_b4;
+
+	/**
+	 * How many digits should come after the decimal place
+	 *
+	 * @var int $dec_plc
+	 */
+	public $dec_plc;
+
+	/**
+	 * Symbol to use for decimal mark
+	 *
+	 * @var string $dec_mrk
+	 * eg '.'
+	 */
+	public $dec_mrk;
+
+	/**
+	 * Symbol to use for thousands
+	 *
+	 * @var string $thsnds
+	 * eg ','
+	 */
+	public $thsnds;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param string $CNT_ISO
+	 * @throws \EE_Error
+	 */
+	public function __construct($CNT_ISO = '')
+	{
+		/** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
+		$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		// get country code from organization settings or use default
+		$ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
+				   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: '';
+		// but override if requested
+		$CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
+		// so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
+		if (! empty($CNT_ISO)
+			&& EE_Maintenance_Mode::instance()->models_can_query()
+			&& $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
+		) {
+			// retrieve the country settings from the db, just in case they have been customized
+			$country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
+			if ($country instanceof EE_Country) {
+				$this->code = $country->currency_code();    // currency code: USD, CAD, EUR
+				$this->name = $country->currency_name_single();    // Dollar
+				$this->plural = $country->currency_name_plural();    // Dollars
+				$this->sign = $country->currency_sign();            // currency sign: $
+				$this->sign_b4 = $country->currency_sign_before(
+				);        // currency sign before or after: $TRUE  or  FALSE$
+				$this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
+				$this->dec_mrk = $country->currency_decimal_mark(
+				);    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+				$this->thsnds = $country->currency_thousands_separator(
+				);    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+			}
+		}
+		// fallback to hardcoded defaults, in case the above failed
+		if (empty($this->code)) {
+			// set default currency settings
+			$this->code = 'USD';    // currency code: USD, CAD, EUR
+			$this->name = __('Dollar', 'event_espresso');    // Dollar
+			$this->plural = __('Dollars', 'event_espresso');    // Dollars
+			$this->sign = '$';    // currency sign: $
+			$this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
+			$this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
+			$this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+			$this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+		}
+	}
+}
 
-    /**
-     * Label text to show on the checkbox
-     *
-     * @var string
-     */
-    public $consent_checkbox_label_text;
+/**
+ * Class for defining what's in the EE_Config relating to registration settings
+ */
+class EE_Registration_Config extends EE_Config_Base
+{
 
-    /*
+	/**
+	 * Default registration status
+	 *
+	 * @var string $default_STS_ID
+	 * eg 'RPP'
+	 */
+	public $default_STS_ID;
+
+	/**
+	 * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
+	 * registrations)
+	 *
+	 * @var int
+	 */
+	public $default_maximum_number_of_tickets;
+
+	/**
+	 * level of validation to apply to email addresses
+	 *
+	 * @var string $email_validation_level
+	 * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
+	 */
+	public $email_validation_level;
+
+	/**
+	 *    whether or not to show alternate payment options during the reg process if payment status is pending
+	 *
+	 * @var boolean $show_pending_payment_options
+	 */
+	public $show_pending_payment_options;
+
+	/**
+	 * Whether to skip the registration confirmation page
+	 *
+	 * @var boolean $skip_reg_confirmation
+	 */
+	public $skip_reg_confirmation;
+
+	/**
+	 * an array of SPCO reg steps where:
+	 *        the keys denotes the reg step order
+	 *        each element consists of an array with the following elements:
+	 *            "file_path" => the file path to the EE_SPCO_Reg_Step class
+	 *            "class_name" => the specific EE_SPCO_Reg_Step child class name
+	 *            "slug" => the URL param used to trigger the reg step
+	 *
+	 * @var array $reg_steps
+	 */
+	public $reg_steps;
+
+	/**
+	 * Whether registration confirmation should be the last page of SPCO
+	 *
+	 * @var boolean $reg_confirmation_last
+	 */
+	public $reg_confirmation_last;
+
+	/**
+	 * Whether or not to enable the EE Bot Trap
+	 *
+	 * @var boolean $use_bot_trap
+	 */
+	public $use_bot_trap;
+
+	/**
+	 * Whether or not to encrypt some data sent by the EE Bot Trap
+	 *
+	 * @var boolean $use_encryption
+	 */
+	public $use_encryption;
+
+	/**
+	 * Whether or not to use ReCaptcha
+	 *
+	 * @var boolean $use_captcha
+	 */
+	public $use_captcha;
+
+	/**
+	 * ReCaptcha Theme
+	 *
+	 * @var string $recaptcha_theme
+	 *    options: 'dark', 'light', 'invisible'
+	 */
+	public $recaptcha_theme;
+
+	/**
+	 * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
+	 *
+	 * @var string $recaptcha_badge
+	 *    options: 'bottomright', 'bottomleft', 'inline'
+	 */
+	public $recaptcha_badge;
+
+	/**
+	 * ReCaptcha Type
+	 *
+	 * @var string $recaptcha_type
+	 *    options: 'audio', 'image'
+	 */
+	public $recaptcha_type;
+
+	/**
+	 * ReCaptcha language
+	 *
+	 * @var string $recaptcha_language
+	 * eg 'en'
+	 */
+	public $recaptcha_language;
+
+	/**
+	 * ReCaptcha public key
+	 *
+	 * @var string $recaptcha_publickey
+	 */
+	public $recaptcha_publickey;
+
+	/**
+	 * ReCaptcha private key
+	 *
+	 * @var string $recaptcha_privatekey
+	 */
+	public $recaptcha_privatekey;
+
+	/**
+	 * array of form names protected by ReCaptcha
+	 *
+	 * @var array $recaptcha_protected_forms
+	 */
+	public $recaptcha_protected_forms;
+
+	/**
+	 * ReCaptcha width
+	 *
+	 * @var int $recaptcha_width
+	 * @deprecated
+	 */
+	public $recaptcha_width;
+
+	/**
+	 * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
+	 *
+	 * @var boolean $track_invalid_checkout_access
+	 */
+	protected $track_invalid_checkout_access = true;
+
+	/**
+	 * Whether or not to show the privacy policy consent checkbox
+	 *
+	 * @var bool
+	 */
+	public $consent_checkbox_enabled;
+
+	/**
+	 * Label text to show on the checkbox
+	 *
+	 * @var string
+	 */
+	public $consent_checkbox_label_text;
+
+	/*
      * String describing how long to keep payment logs. Passed into DateTime constructor
      * @var string
      */
-    public $gateway_log_lifespan = '1 week';
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default registration settings
-        $this->default_STS_ID = EEM_Registration::status_id_pending_payment;
-        $this->email_validation_level = 'wp_default';
-        $this->show_pending_payment_options = true;
-        $this->skip_reg_confirmation = true;
-        $this->reg_steps = array();
-        $this->reg_confirmation_last = false;
-        $this->use_bot_trap = true;
-        $this->use_encryption = true;
-        $this->use_captcha = false;
-        $this->recaptcha_theme = 'light';
-        $this->recaptcha_badge = 'bottomleft';
-        $this->recaptcha_type = 'image';
-        $this->recaptcha_language = 'en';
-        $this->recaptcha_publickey = null;
-        $this->recaptcha_privatekey = null;
-        $this->recaptcha_protected_forms = array();
-        $this->recaptcha_width = 500;
-        $this->default_maximum_number_of_tickets = 10;
-        $this->consent_checkbox_enabled = false;
-        $this->consent_checkbox_label_text = '';
-        $this->gateway_log_lifespan = '7 days';
-    }
-
-
-    /**
-     * This is called by the config loader and hooks are initialized AFTER the config has been populated.
-     *
-     * @since 4.8.8.rc.019
-     */
-    public function do_hooks()
-    {
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
-        add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
-    }
-
-
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
-     * EVT_default_registration_status field matches the config setting for default_STS_ID.
-     */
-    public function set_default_reg_status_on_EEM_Event()
-    {
-        EEM_Event::set_default_reg_status($this->default_STS_ID);
-    }
-
-
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
-     * for Events matches the config setting for default_maximum_number_of_tickets
-     */
-    public function set_default_max_ticket_on_EEM_Event()
-    {
-        EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
-    }
-
-
-    /**
-     * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
-     * constructed because that happens before we can get the privacy policy page's permalink.
-     *
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function setDefaultCheckboxLabelText()
-    {
-        if ($this->getConsentCheckboxLabelText() === null
-            || $this->getConsentCheckboxLabelText() === '') {
-            $opening_a_tag = '';
-            $closing_a_tag = '';
-            if (function_exists('get_privacy_policy_url')) {
-                $privacy_page_url = get_privacy_policy_url();
-                if (! empty($privacy_page_url)) {
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
-                    $closing_a_tag = '</a>';
-                }
-            }
-            $loader = LoaderFactory::getLoader();
-            $org_config = $loader->getShared('EE_Organization_Config');
-            /**
-             * @var $org_config EE_Organization_Config
-             */
-
-            $this->setConsentCheckboxLabelText(
-                sprintf(
-                    esc_html__(
-                        'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
-                        'event_espresso'
-                    ),
-                    $org_config->name,
-                    $opening_a_tag,
-                    $closing_a_tag
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function track_invalid_checkout_access()
-    {
-        return $this->track_invalid_checkout_access;
-    }
-
-
-    /**
-     * @param boolean $track_invalid_checkout_access
-     */
-    public function set_track_invalid_checkout_access($track_invalid_checkout_access)
-    {
-        $this->track_invalid_checkout_access = filter_var(
-            $track_invalid_checkout_access,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * Gets the options to make availalbe for the gateway log lifespan
-     * @return array
-     */
-    public function gatewayLogLifespanOptions()
-    {
-        return (array) apply_filters(
-            'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
-            array(
-                '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
-                '1 day' => esc_html__('1 Day', 'event_espresso'),
-                '7 days' => esc_html__('7 Days', 'event_espresso'),
-                '14 days' => esc_html__('14 Days', 'event_espresso'),
-                '30 days' => esc_html__('30 Days', 'event_espresso')
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isConsentCheckboxEnabled()
-    {
-        return $this->consent_checkbox_enabled;
-    }
-
-
-    /**
-     * @param bool $consent_checkbox_enabled
-     */
-    public function setConsentCheckboxEnabled($consent_checkbox_enabled)
-    {
-        $this->consent_checkbox_enabled = filter_var(
-            $consent_checkbox_enabled,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getConsentCheckboxLabelText()
-    {
-        return $this->consent_checkbox_label_text;
-    }
-
-
-    /**
-     * @param string $consent_checkbox_label_text
-     */
-    public function setConsentCheckboxLabelText($consent_checkbox_label_text)
-    {
-        $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
-    }
+	public $gateway_log_lifespan = '1 week';
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default registration settings
+		$this->default_STS_ID = EEM_Registration::status_id_pending_payment;
+		$this->email_validation_level = 'wp_default';
+		$this->show_pending_payment_options = true;
+		$this->skip_reg_confirmation = true;
+		$this->reg_steps = array();
+		$this->reg_confirmation_last = false;
+		$this->use_bot_trap = true;
+		$this->use_encryption = true;
+		$this->use_captcha = false;
+		$this->recaptcha_theme = 'light';
+		$this->recaptcha_badge = 'bottomleft';
+		$this->recaptcha_type = 'image';
+		$this->recaptcha_language = 'en';
+		$this->recaptcha_publickey = null;
+		$this->recaptcha_privatekey = null;
+		$this->recaptcha_protected_forms = array();
+		$this->recaptcha_width = 500;
+		$this->default_maximum_number_of_tickets = 10;
+		$this->consent_checkbox_enabled = false;
+		$this->consent_checkbox_label_text = '';
+		$this->gateway_log_lifespan = '7 days';
+	}
+
+
+	/**
+	 * This is called by the config loader and hooks are initialized AFTER the config has been populated.
+	 *
+	 * @since 4.8.8.rc.019
+	 */
+	public function do_hooks()
+	{
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
+		add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
+	 * EVT_default_registration_status field matches the config setting for default_STS_ID.
+	 */
+	public function set_default_reg_status_on_EEM_Event()
+	{
+		EEM_Event::set_default_reg_status($this->default_STS_ID);
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
+	 * for Events matches the config setting for default_maximum_number_of_tickets
+	 */
+	public function set_default_max_ticket_on_EEM_Event()
+	{
+		EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
+	}
+
+
+	/**
+	 * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
+	 * constructed because that happens before we can get the privacy policy page's permalink.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function setDefaultCheckboxLabelText()
+	{
+		if ($this->getConsentCheckboxLabelText() === null
+			|| $this->getConsentCheckboxLabelText() === '') {
+			$opening_a_tag = '';
+			$closing_a_tag = '';
+			if (function_exists('get_privacy_policy_url')) {
+				$privacy_page_url = get_privacy_policy_url();
+				if (! empty($privacy_page_url)) {
+					$opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
+					$closing_a_tag = '</a>';
+				}
+			}
+			$loader = LoaderFactory::getLoader();
+			$org_config = $loader->getShared('EE_Organization_Config');
+			/**
+			 * @var $org_config EE_Organization_Config
+			 */
+
+			$this->setConsentCheckboxLabelText(
+				sprintf(
+					esc_html__(
+						'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
+						'event_espresso'
+					),
+					$org_config->name,
+					$opening_a_tag,
+					$closing_a_tag
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function track_invalid_checkout_access()
+	{
+		return $this->track_invalid_checkout_access;
+	}
+
+
+	/**
+	 * @param boolean $track_invalid_checkout_access
+	 */
+	public function set_track_invalid_checkout_access($track_invalid_checkout_access)
+	{
+		$this->track_invalid_checkout_access = filter_var(
+			$track_invalid_checkout_access,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * Gets the options to make availalbe for the gateway log lifespan
+	 * @return array
+	 */
+	public function gatewayLogLifespanOptions()
+	{
+		return (array) apply_filters(
+			'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
+			array(
+				'1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
+				'1 day' => esc_html__('1 Day', 'event_espresso'),
+				'7 days' => esc_html__('7 Days', 'event_espresso'),
+				'14 days' => esc_html__('14 Days', 'event_espresso'),
+				'30 days' => esc_html__('30 Days', 'event_espresso')
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isConsentCheckboxEnabled()
+	{
+		return $this->consent_checkbox_enabled;
+	}
+
+
+	/**
+	 * @param bool $consent_checkbox_enabled
+	 */
+	public function setConsentCheckboxEnabled($consent_checkbox_enabled)
+	{
+		$this->consent_checkbox_enabled = filter_var(
+			$consent_checkbox_enabled,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getConsentCheckboxLabelText()
+	{
+		return $this->consent_checkbox_label_text;
+	}
+
+
+	/**
+	 * @param string $consent_checkbox_label_text
+	 */
+	public function setConsentCheckboxLabelText($consent_checkbox_label_text)
+	{
+		$this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
+	}
 }
 
 /**
@@ -2525,154 +2525,154 @@ 
 class EE_Admin_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $use_personnel_manager
-     */
-    public $use_personnel_manager;
-
-    /**
-     * @var boolean $use_dashboard_widget
-     */
-    public $use_dashboard_widget;
-
-    /**
-     * @var int $events_in_dashboard
-     */
-    public $events_in_dashboard;
-
-    /**
-     * @var boolean $use_event_timezones
-     */
-    public $use_event_timezones;
-
-    /**
-     * @var boolean $use_full_logging
-     */
-    public $use_full_logging;
-
-    /**
-     * @var string $log_file_name
-     */
-    public $log_file_name;
-
-    /**
-     * @var string $debug_file_name
-     */
-    public $debug_file_name;
-
-    /**
-     * @var boolean $use_remote_logging
-     */
-    public $use_remote_logging;
-
-    /**
-     * @var string $remote_logging_url
-     */
-    public $remote_logging_url;
-
-    /**
-     * @var boolean $show_reg_footer
-     */
-    public $show_reg_footer;
-
-    /**
-     * @var string $affiliate_id
-     */
-    public $affiliate_id;
-
-    /**
-     * help tours on or off (global setting)
-     *
-     * @var boolean
-     */
-    public $help_tour_activation;
-
-    /**
-     * adds extra layer of encoding to session data to prevent serialization errors
-     * but is incompatible with some server configuration errors
-     * if you get "500 internal server errors" during registration, try turning this on
-     * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
-     *
-     * @var boolean $encode_session_data
-     */
-    private $encode_session_data = false;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default general admin settings
-        $this->use_personnel_manager = true;
-        $this->use_dashboard_widget = true;
-        $this->events_in_dashboard = 30;
-        $this->use_event_timezones = false;
-        $this->use_full_logging = false;
-        $this->use_remote_logging = false;
-        $this->remote_logging_url = null;
-        $this->show_reg_footer = true;
-        $this->affiliate_id = 'default';
-        $this->help_tour_activation = true;
-        $this->encode_session_data = false;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function log_file_name($reset = false)
-    {
-        if (empty($this->log_file_name) || $reset) {
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return $this->log_file_name;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function debug_file_name($reset = false)
-    {
-        if (empty($this->debug_file_name) || $reset) {
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return $this->debug_file_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function affiliate_id()
-    {
-        return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function encode_session_data()
-    {
-        return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param boolean $encode_session_data
-     */
-    public function set_encode_session_data($encode_session_data)
-    {
-        $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @var boolean $use_personnel_manager
+	 */
+	public $use_personnel_manager;
+
+	/**
+	 * @var boolean $use_dashboard_widget
+	 */
+	public $use_dashboard_widget;
+
+	/**
+	 * @var int $events_in_dashboard
+	 */
+	public $events_in_dashboard;
+
+	/**
+	 * @var boolean $use_event_timezones
+	 */
+	public $use_event_timezones;
+
+	/**
+	 * @var boolean $use_full_logging
+	 */
+	public $use_full_logging;
+
+	/**
+	 * @var string $log_file_name
+	 */
+	public $log_file_name;
+
+	/**
+	 * @var string $debug_file_name
+	 */
+	public $debug_file_name;
+
+	/**
+	 * @var boolean $use_remote_logging
+	 */
+	public $use_remote_logging;
+
+	/**
+	 * @var string $remote_logging_url
+	 */
+	public $remote_logging_url;
+
+	/**
+	 * @var boolean $show_reg_footer
+	 */
+	public $show_reg_footer;
+
+	/**
+	 * @var string $affiliate_id
+	 */
+	public $affiliate_id;
+
+	/**
+	 * help tours on or off (global setting)
+	 *
+	 * @var boolean
+	 */
+	public $help_tour_activation;
+
+	/**
+	 * adds extra layer of encoding to session data to prevent serialization errors
+	 * but is incompatible with some server configuration errors
+	 * if you get "500 internal server errors" during registration, try turning this on
+	 * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
+	 *
+	 * @var boolean $encode_session_data
+	 */
+	private $encode_session_data = false;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default general admin settings
+		$this->use_personnel_manager = true;
+		$this->use_dashboard_widget = true;
+		$this->events_in_dashboard = 30;
+		$this->use_event_timezones = false;
+		$this->use_full_logging = false;
+		$this->use_remote_logging = false;
+		$this->remote_logging_url = null;
+		$this->show_reg_footer = true;
+		$this->affiliate_id = 'default';
+		$this->help_tour_activation = true;
+		$this->encode_session_data = false;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function log_file_name($reset = false)
+	{
+		if (empty($this->log_file_name) || $reset) {
+			$this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return $this->log_file_name;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function debug_file_name($reset = false)
+	{
+		if (empty($this->debug_file_name) || $reset) {
+			$this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return $this->debug_file_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function affiliate_id()
+	{
+		return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function encode_session_data()
+	{
+		return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param boolean $encode_session_data
+	 */
+	public function set_encode_session_data($encode_session_data)
+	{
+		$this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
 }
 
 /**
@@ -2681,70 +2681,70 @@ 
 class EE_Template_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $enable_default_style
-     */
-    public $enable_default_style;
-
-    /**
-     * @var string $custom_style_sheet
-     */
-    public $custom_style_sheet;
-
-    /**
-     * @var boolean $display_address_in_regform
-     */
-    public $display_address_in_regform;
-
-    /**
-     * @var int $display_description_on_multi_reg_page
-     */
-    public $display_description_on_multi_reg_page;
-
-    /**
-     * @var boolean $use_custom_templates
-     */
-    public $use_custom_templates;
-
-    /**
-     * @var string $current_espresso_theme
-     */
-    public $current_espresso_theme;
-
-    /**
-     * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
-     */
-    public $EED_Ticket_Selector;
-
-    /**
-     * @var EE_Event_Single_Config $EED_Event_Single
-     */
-    public $EED_Event_Single;
-
-    /**
-     * @var EE_Events_Archive_Config $EED_Events_Archive
-     */
-    public $EED_Events_Archive;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default template settings
-        $this->enable_default_style = true;
-        $this->custom_style_sheet = null;
-        $this->display_address_in_regform = true;
-        $this->display_description_on_multi_reg_page = false;
-        $this->use_custom_templates = false;
-        $this->current_espresso_theme = 'Espresso_Arabica_2014';
-        $this->EED_Event_Single = null;
-        $this->EED_Events_Archive = null;
-        $this->EED_Ticket_Selector = null;
-    }
+	/**
+	 * @var boolean $enable_default_style
+	 */
+	public $enable_default_style;
+
+	/**
+	 * @var string $custom_style_sheet
+	 */
+	public $custom_style_sheet;
+
+	/**
+	 * @var boolean $display_address_in_regform
+	 */
+	public $display_address_in_regform;
+
+	/**
+	 * @var int $display_description_on_multi_reg_page
+	 */
+	public $display_description_on_multi_reg_page;
+
+	/**
+	 * @var boolean $use_custom_templates
+	 */
+	public $use_custom_templates;
+
+	/**
+	 * @var string $current_espresso_theme
+	 */
+	public $current_espresso_theme;
+
+	/**
+	 * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
+	 */
+	public $EED_Ticket_Selector;
+
+	/**
+	 * @var EE_Event_Single_Config $EED_Event_Single
+	 */
+	public $EED_Event_Single;
+
+	/**
+	 * @var EE_Events_Archive_Config $EED_Events_Archive
+	 */
+	public $EED_Events_Archive;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default template settings
+		$this->enable_default_style = true;
+		$this->custom_style_sheet = null;
+		$this->display_address_in_regform = true;
+		$this->display_description_on_multi_reg_page = false;
+		$this->use_custom_templates = false;
+		$this->current_espresso_theme = 'Espresso_Arabica_2014';
+		$this->EED_Event_Single = null;
+		$this->EED_Events_Archive = null;
+		$this->EED_Ticket_Selector = null;
+	}
 }
 
 /**
@@ -2753,114 +2753,114 @@ 
 class EE_Map_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $use_google_maps
-     */
-    public $use_google_maps;
-
-    /**
-     * @var string $api_key
-     */
-    public $google_map_api_key;
-
-    /**
-     * @var int $event_details_map_width
-     */
-    public $event_details_map_width;
-
-    /**
-     * @var int $event_details_map_height
-     */
-    public $event_details_map_height;
-
-    /**
-     * @var int $event_details_map_zoom
-     */
-    public $event_details_map_zoom;
-
-    /**
-     * @var boolean $event_details_display_nav
-     */
-    public $event_details_display_nav;
-
-    /**
-     * @var boolean $event_details_nav_size
-     */
-    public $event_details_nav_size;
-
-    /**
-     * @var string $event_details_control_type
-     */
-    public $event_details_control_type;
-
-    /**
-     * @var string $event_details_map_align
-     */
-    public $event_details_map_align;
-
-    /**
-     * @var int $event_list_map_width
-     */
-    public $event_list_map_width;
-
-    /**
-     * @var int $event_list_map_height
-     */
-    public $event_list_map_height;
-
-    /**
-     * @var int $event_list_map_zoom
-     */
-    public $event_list_map_zoom;
-
-    /**
-     * @var boolean $event_list_display_nav
-     */
-    public $event_list_display_nav;
-
-    /**
-     * @var boolean $event_list_nav_size
-     */
-    public $event_list_nav_size;
-
-    /**
-     * @var string $event_list_control_type
-     */
-    public $event_list_control_type;
-
-    /**
-     * @var string $event_list_map_align
-     */
-    public $event_list_map_align;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default map settings
-        $this->use_google_maps = true;
-        $this->google_map_api_key = '';
-        // for event details pages (reg page)
-        $this->event_details_map_width = 585;            // ee_map_width_single
-        $this->event_details_map_height = 362;            // ee_map_height_single
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
-        $this->event_details_map_align = 'center';            // ee_map_align_single
-        // for event list pages
-        $this->event_list_map_width = 300;            // ee_map_width
-        $this->event_list_map_height = 185;        // ee_map_height
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
-        $this->event_list_display_nav = false;        // ee_map_nav_display
-        $this->event_list_nav_size = true;            // ee_map_nav_size
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
-        $this->event_list_map_align = 'center';            // ee_map_align
-    }
+	/**
+	 * @var boolean $use_google_maps
+	 */
+	public $use_google_maps;
+
+	/**
+	 * @var string $api_key
+	 */
+	public $google_map_api_key;
+
+	/**
+	 * @var int $event_details_map_width
+	 */
+	public $event_details_map_width;
+
+	/**
+	 * @var int $event_details_map_height
+	 */
+	public $event_details_map_height;
+
+	/**
+	 * @var int $event_details_map_zoom
+	 */
+	public $event_details_map_zoom;
+
+	/**
+	 * @var boolean $event_details_display_nav
+	 */
+	public $event_details_display_nav;
+
+	/**
+	 * @var boolean $event_details_nav_size
+	 */
+	public $event_details_nav_size;
+
+	/**
+	 * @var string $event_details_control_type
+	 */
+	public $event_details_control_type;
+
+	/**
+	 * @var string $event_details_map_align
+	 */
+	public $event_details_map_align;
+
+	/**
+	 * @var int $event_list_map_width
+	 */
+	public $event_list_map_width;
+
+	/**
+	 * @var int $event_list_map_height
+	 */
+	public $event_list_map_height;
+
+	/**
+	 * @var int $event_list_map_zoom
+	 */
+	public $event_list_map_zoom;
+
+	/**
+	 * @var boolean $event_list_display_nav
+	 */
+	public $event_list_display_nav;
+
+	/**
+	 * @var boolean $event_list_nav_size
+	 */
+	public $event_list_nav_size;
+
+	/**
+	 * @var string $event_list_control_type
+	 */
+	public $event_list_control_type;
+
+	/**
+	 * @var string $event_list_map_align
+	 */
+	public $event_list_map_align;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default map settings
+		$this->use_google_maps = true;
+		$this->google_map_api_key = '';
+		// for event details pages (reg page)
+		$this->event_details_map_width = 585;            // ee_map_width_single
+		$this->event_details_map_height = 362;            // ee_map_height_single
+		$this->event_details_map_zoom = 14;            // ee_map_zoom_single
+		$this->event_details_display_nav = true;            // ee_map_nav_display_single
+		$this->event_details_nav_size = false;            // ee_map_nav_size_single
+		$this->event_details_control_type = 'default';        // ee_map_type_control_single
+		$this->event_details_map_align = 'center';            // ee_map_align_single
+		// for event list pages
+		$this->event_list_map_width = 300;            // ee_map_width
+		$this->event_list_map_height = 185;        // ee_map_height
+		$this->event_list_map_zoom = 12;            // ee_map_zoom
+		$this->event_list_display_nav = false;        // ee_map_nav_display
+		$this->event_list_nav_size = true;            // ee_map_nav_size
+		$this->event_list_control_type = 'dropdown';        // ee_map_type_control
+		$this->event_list_map_align = 'center';            // ee_map_align
+	}
 }
 
 /**
@@ -2869,46 +2869,46 @@ 
 class EE_Events_Archive_Config extends EE_Config_Base
 {
 
-    public $display_status_banner;
+	public $display_status_banner;
 
-    public $display_description;
+	public $display_description;
 
-    public $display_ticket_selector;
+	public $display_ticket_selector;
 
-    public $display_datetimes;
+	public $display_datetimes;
 
-    public $display_venue;
+	public $display_venue;
 
-    public $display_expired_events;
+	public $display_expired_events;
 
-    public $use_sortable_display_order;
+	public $use_sortable_display_order;
 
-    public $display_order_tickets;
+	public $display_order_tickets;
 
-    public $display_order_datetimes;
+	public $display_order_datetimes;
 
-    public $display_order_event;
+	public $display_order_event;
 
-    public $display_order_venue;
+	public $display_order_venue;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->display_status_banner = 0;
-        $this->display_description = 1;
-        $this->display_ticket_selector = 0;
-        $this->display_datetimes = 1;
-        $this->display_venue = 0;
-        $this->display_expired_events = 0;
-        $this->use_sortable_display_order = false;
-        $this->display_order_tickets = 100;
-        $this->display_order_datetimes = 110;
-        $this->display_order_event = 120;
-        $this->display_order_venue = 130;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->display_status_banner = 0;
+		$this->display_description = 1;
+		$this->display_ticket_selector = 0;
+		$this->display_datetimes = 1;
+		$this->display_venue = 0;
+		$this->display_expired_events = 0;
+		$this->use_sortable_display_order = false;
+		$this->display_order_tickets = 100;
+		$this->display_order_datetimes = 110;
+		$this->display_order_event = 120;
+		$this->display_order_venue = 130;
+	}
 }
 
 /**
@@ -2917,34 +2917,34 @@ 
 class EE_Event_Single_Config extends EE_Config_Base
 {
 
-    public $display_status_banner_single;
+	public $display_status_banner_single;
 
-    public $display_venue;
+	public $display_venue;
 
-    public $use_sortable_display_order;
+	public $use_sortable_display_order;
 
-    public $display_order_tickets;
+	public $display_order_tickets;
 
-    public $display_order_datetimes;
+	public $display_order_datetimes;
 
-    public $display_order_event;
+	public $display_order_event;
 
-    public $display_order_venue;
+	public $display_order_venue;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->display_status_banner_single = 0;
-        $this->display_venue = 1;
-        $this->use_sortable_display_order = false;
-        $this->display_order_tickets = 100;
-        $this->display_order_datetimes = 110;
-        $this->display_order_event = 120;
-        $this->display_order_venue = 130;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->display_status_banner_single = 0;
+		$this->display_venue = 1;
+		$this->use_sortable_display_order = false;
+		$this->display_order_tickets = 100;
+		$this->display_order_datetimes = 110;
+		$this->display_order_event = 120;
+		$this->display_order_venue = 130;
+	}
 }
 
 /**
@@ -2953,172 +2953,172 @@ 
 class EE_Ticket_Selector_Config extends EE_Config_Base
 {
 
-    /**
-     * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
-     */
-    const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
-
-    /**
-     * constant to indicate that a datetime selector should only be shown for ticket selectors
-     * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
-     */
-    const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
-
-    /**
-     * @var boolean $show_ticket_sale_columns
-     */
-    public $show_ticket_sale_columns;
-
-    /**
-     * @var boolean $show_ticket_details
-     */
-    public $show_ticket_details;
-
-    /**
-     * @var boolean $show_expired_tickets
-     */
-    public $show_expired_tickets;
-
-    /**
-     * whether or not to display a dropdown box populated with event datetimes
-     * that toggles which tickets are displayed for a ticket selector.
-     * uses one of the *_DATETIME_SELECTOR constants defined above
-     *
-     * @var string $show_datetime_selector
-     */
-    private $show_datetime_selector = 'no_datetime_selector';
-
-    /**
-     * the number of datetimes an event has to have before conditionally displaying a datetime selector
-     *
-     * @var int $datetime_selector_threshold
-     */
-    private $datetime_selector_threshold = 3;
-
-    /**
-     * determines the maximum number of "checked" dates in the date and time filter
-     *
-     * @var int $datetime_selector_checked
-     */
-    private $datetime_selector_max_checked = 10;
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->show_ticket_sale_columns = true;
-        $this->show_ticket_details = true;
-        $this->show_expired_tickets = true;
-        $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
-        $this->datetime_selector_threshold = 3;
-        $this->datetime_selector_max_checked = 10;
-    }
-
-
-    /**
-     * returns true if a datetime selector should be displayed
-     *
-     * @param array $datetimes
-     * @return bool
-     */
-    public function showDatetimeSelector(array $datetimes)
-    {
-        // if the settings are NOT: don't show OR below threshold, THEN active = true
-        return ! (
-            $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
-            || (
-                $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
-                && count($datetimes) < $this->getDatetimeSelectorThreshold()
-            )
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getShowDatetimeSelector()
-    {
-        return $this->show_datetime_selector;
-    }
-
-
-    /**
-     * @param bool $keys_only
-     * @return array
-     */
-    public function getShowDatetimeSelectorOptions($keys_only = true)
-    {
-        return $keys_only
-            ? array(
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
-            )
-            : array(
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
-                    'Do not show date & time filter',
-                    'event_espresso'
-                ),
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
-                    'Maybe show date & time filter',
-                    'event_espresso'
-                ),
-            );
-    }
-
-
-    /**
-     * @param string $show_datetime_selector
-     */
-    public function setShowDatetimeSelector($show_datetime_selector)
-    {
-        $this->show_datetime_selector = in_array(
-            $show_datetime_selector,
-            $this->getShowDatetimeSelectorOptions(),
-            true
-        )
-            ? $show_datetime_selector
-            : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getDatetimeSelectorThreshold()
-    {
-        return $this->datetime_selector_threshold;
-    }
-
-
-    /**
-     * @param int $datetime_selector_threshold
-     */
-    public function setDatetimeSelectorThreshold($datetime_selector_threshold)
-    {
-        $datetime_selector_threshold = absint($datetime_selector_threshold);
-        $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getDatetimeSelectorMaxChecked()
-    {
-        return $this->datetime_selector_max_checked;
-    }
-
-
-    /**
-     * @param int $datetime_selector_max_checked
-     */
-    public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked)
-    {
-        $this->datetime_selector_max_checked = absint($datetime_selector_max_checked);
-    }
+	/**
+	 * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
+	 */
+	const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
+
+	/**
+	 * constant to indicate that a datetime selector should only be shown for ticket selectors
+	 * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
+	 */
+	const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
+
+	/**
+	 * @var boolean $show_ticket_sale_columns
+	 */
+	public $show_ticket_sale_columns;
+
+	/**
+	 * @var boolean $show_ticket_details
+	 */
+	public $show_ticket_details;
+
+	/**
+	 * @var boolean $show_expired_tickets
+	 */
+	public $show_expired_tickets;
+
+	/**
+	 * whether or not to display a dropdown box populated with event datetimes
+	 * that toggles which tickets are displayed for a ticket selector.
+	 * uses one of the *_DATETIME_SELECTOR constants defined above
+	 *
+	 * @var string $show_datetime_selector
+	 */
+	private $show_datetime_selector = 'no_datetime_selector';
+
+	/**
+	 * the number of datetimes an event has to have before conditionally displaying a datetime selector
+	 *
+	 * @var int $datetime_selector_threshold
+	 */
+	private $datetime_selector_threshold = 3;
+
+	/**
+	 * determines the maximum number of "checked" dates in the date and time filter
+	 *
+	 * @var int $datetime_selector_checked
+	 */
+	private $datetime_selector_max_checked = 10;
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->show_ticket_sale_columns = true;
+		$this->show_ticket_details = true;
+		$this->show_expired_tickets = true;
+		$this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
+		$this->datetime_selector_threshold = 3;
+		$this->datetime_selector_max_checked = 10;
+	}
+
+
+	/**
+	 * returns true if a datetime selector should be displayed
+	 *
+	 * @param array $datetimes
+	 * @return bool
+	 */
+	public function showDatetimeSelector(array $datetimes)
+	{
+		// if the settings are NOT: don't show OR below threshold, THEN active = true
+		return ! (
+			$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
+			|| (
+				$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
+				&& count($datetimes) < $this->getDatetimeSelectorThreshold()
+			)
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getShowDatetimeSelector()
+	{
+		return $this->show_datetime_selector;
+	}
+
+
+	/**
+	 * @param bool $keys_only
+	 * @return array
+	 */
+	public function getShowDatetimeSelectorOptions($keys_only = true)
+	{
+		return $keys_only
+			? array(
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
+			)
+			: array(
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
+					'Do not show date & time filter',
+					'event_espresso'
+				),
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
+					'Maybe show date & time filter',
+					'event_espresso'
+				),
+			);
+	}
+
+
+	/**
+	 * @param string $show_datetime_selector
+	 */
+	public function setShowDatetimeSelector($show_datetime_selector)
+	{
+		$this->show_datetime_selector = in_array(
+			$show_datetime_selector,
+			$this->getShowDatetimeSelectorOptions(),
+			true
+		)
+			? $show_datetime_selector
+			: \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getDatetimeSelectorThreshold()
+	{
+		return $this->datetime_selector_threshold;
+	}
+
+
+	/**
+	 * @param int $datetime_selector_threshold
+	 */
+	public function setDatetimeSelectorThreshold($datetime_selector_threshold)
+	{
+		$datetime_selector_threshold = absint($datetime_selector_threshold);
+		$this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getDatetimeSelectorMaxChecked()
+	{
+		return $this->datetime_selector_max_checked;
+	}
+
+
+	/**
+	 * @param int $datetime_selector_max_checked
+	 */
+	public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked)
+	{
+		$this->datetime_selector_max_checked = absint($datetime_selector_max_checked);
+	}
 }
 
 /**
@@ -3131,86 +3131,86 @@ 
 class EE_Environment_Config extends EE_Config_Base
 {
 
-    /**
-     * Hold any php environment variables that we want to track.
-     *
-     * @var stdClass;
-     */
-    public $php;
-
-
-    /**
-     *    constructor
-     */
-    public function __construct()
-    {
-        $this->php = new stdClass();
-        $this->_set_php_values();
-    }
-
-
-    /**
-     * This sets the php environment variables.
-     *
-     * @since 4.4.0
-     * @return void
-     */
-    protected function _set_php_values()
-    {
-        $this->php->max_input_vars = ini_get('max_input_vars');
-        $this->php->version = phpversion();
-    }
-
-
-    /**
-     * helper method for determining whether input_count is
-     * reaching the potential maximum the server can handle
-     * according to max_input_vars
-     *
-     * @param int   $input_count the count of input vars.
-     * @return array {
-     *                           An array that represents whether available space and if no available space the error
-     *                           message.
-     * @type bool   $has_space   whether more inputs can be added.
-     * @type string $msg         Any message to be displayed.
-     *                           }
-     */
-    public function max_input_vars_limit_check($input_count = 0)
-    {
-        if (! empty($this->php->max_input_vars)
-            && ($input_count >= $this->php->max_input_vars)
-        ) {
-            // check the server setting because the config value could be stale
-            $max_input_vars = ini_get('max_input_vars');
-            if ($input_count >= $max_input_vars) {
-                return sprintf(
-                    esc_html__(
-                        'The maximum number of inputs on this page has been exceeded. You cannot make edits to this page because of your server\'s PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.%1$sPlease contact your web host and ask them to raise the "max_input_vars" limit.',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    $input_count,
-                    $max_input_vars
-                );
-            } else {
-                return '';
-            }
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
-     *
-     * @since 4.4.1
-     * @return void
-     */
-    public function recheck_values()
-    {
-        $this->_set_php_values();
-    }
+	/**
+	 * Hold any php environment variables that we want to track.
+	 *
+	 * @var stdClass;
+	 */
+	public $php;
+
+
+	/**
+	 *    constructor
+	 */
+	public function __construct()
+	{
+		$this->php = new stdClass();
+		$this->_set_php_values();
+	}
+
+
+	/**
+	 * This sets the php environment variables.
+	 *
+	 * @since 4.4.0
+	 * @return void
+	 */
+	protected function _set_php_values()
+	{
+		$this->php->max_input_vars = ini_get('max_input_vars');
+		$this->php->version = phpversion();
+	}
+
+
+	/**
+	 * helper method for determining whether input_count is
+	 * reaching the potential maximum the server can handle
+	 * according to max_input_vars
+	 *
+	 * @param int   $input_count the count of input vars.
+	 * @return array {
+	 *                           An array that represents whether available space and if no available space the error
+	 *                           message.
+	 * @type bool   $has_space   whether more inputs can be added.
+	 * @type string $msg         Any message to be displayed.
+	 *                           }
+	 */
+	public function max_input_vars_limit_check($input_count = 0)
+	{
+		if (! empty($this->php->max_input_vars)
+			&& ($input_count >= $this->php->max_input_vars)
+		) {
+			// check the server setting because the config value could be stale
+			$max_input_vars = ini_get('max_input_vars');
+			if ($input_count >= $max_input_vars) {
+				return sprintf(
+					esc_html__(
+						'The maximum number of inputs on this page has been exceeded. You cannot make edits to this page because of your server\'s PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.%1$sPlease contact your web host and ask them to raise the "max_input_vars" limit.',
+						'event_espresso'
+					),
+					'<br>',
+					$input_count,
+					$max_input_vars
+				);
+			} else {
+				return '';
+			}
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
+	 *
+	 * @since 4.4.1
+	 * @return void
+	 */
+	public function recheck_values()
+	{
+		$this->_set_php_values();
+	}
 }
 
 /**
@@ -3223,21 +3223,21 @@ 
 class EE_Tax_Config extends EE_Config_Base
 {
 
-    /*
+	/*
      * flag to indicate whether or not to display ticket prices with the taxes included
      *
      * @var boolean $prices_displayed_including_taxes
      */
-    public $prices_displayed_including_taxes;
+	public $prices_displayed_including_taxes;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->prices_displayed_including_taxes = true;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->prices_displayed_including_taxes = true;
+	}
 }
 
 /**
@@ -3251,19 +3251,19 @@ 
 class EE_Messages_Config extends EE_Config_Base
 {
 
-    /**
-     * This is an integer representing the deletion threshold in months for when old messages will get deleted.
-     * A value of 0 represents never deleting.  Default is 0.
-     *
-     * @var integer
-     */
-    public $delete_threshold;
+	/**
+	 * This is an integer representing the deletion threshold in months for when old messages will get deleted.
+	 * A value of 0 represents never deleting.  Default is 0.
+	 *
+	 * @var integer
+	 */
+	public $delete_threshold;
 
 
-    public function __construct()
-    {
-        $this->delete_threshold = 0;
-    }
+	public function __construct()
+	{
+		$this->delete_threshold = 0;
+	}
 }
 
 /**
@@ -3274,31 +3274,31 @@ 
 class EE_Gateway_Config extends EE_Config_Base
 {
 
-    /**
-     * Array with keys that are payment gateways slugs, and values are arrays
-     * with any config info the gateway wants to store
-     *
-     * @var array
-     */
-    public $payment_settings;
-
-    /**
-     * Where keys are gateway slugs, and values are booleans indicating whether or not
-     * the gateway is stored in the uploads directory
-     *
-     * @var array
-     */
-    public $active_gateways;
-
-
-    /**
-     *    class constructor
-     *
-     * @deprecated
-     */
-    public function __construct()
-    {
-        $this->payment_settings = array();
-        $this->active_gateways = array('Invoice' => false);
-    }
+	/**
+	 * Array with keys that are payment gateways slugs, and values are arrays
+	 * with any config info the gateway wants to store
+	 *
+	 * @var array
+	 */
+	public $payment_settings;
+
+	/**
+	 * Where keys are gateway slugs, and values are booleans indicating whether or not
+	 * the gateway is stored in the uploads directory
+	 *
+	 * @var array
+	 */
+	public $active_gateways;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @deprecated
+	 */
+	public function __construct()
+	{
+		$this->payment_settings = array();
+		$this->active_gateways = array('Invoice' => false);
+	}
 }

admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php

Indentation +150 added lines, -150 removed lines

@@ -15,168 +15,168 @@
  */
 class EE_Registration_Custom_Questions_Form extends EE_Form_Section_Proper
 {
-    /**
-     *
-     * @var EE_Registration
-     */
-    protected $_registration = null;
+	/**
+	 *
+	 * @var EE_Registration
+	 */
+	protected $_registration = null;
 
-    /**
-     *
-     * @param EE_Registration $reg
-     * @param array $options
-     */
-    public function __construct(EE_Registration $reg, $options = array())
-    {
-        $this->_registration = $reg;
-        if (! isset($options['layout_strategy'])) {
-            $options['layout_strategy'] = new EE_Admin_Two_Column_Layout();
-        }
-        if (! isset($options['html_id'])) {
-            $options['html_id'] = 'reg-admin-attendee-questions-frm';
-        }
-        $this->build_form_from_registration();
-        parent::__construct($options);
-    }
+	/**
+	 *
+	 * @param EE_Registration $reg
+	 * @param array $options
+	 */
+	public function __construct(EE_Registration $reg, $options = array())
+	{
+		$this->_registration = $reg;
+		if (! isset($options['layout_strategy'])) {
+			$options['layout_strategy'] = new EE_Admin_Two_Column_Layout();
+		}
+		if (! isset($options['html_id'])) {
+			$options['html_id'] = 'reg-admin-attendee-questions-frm';
+		}
+		$this->build_form_from_registration();
+		parent::__construct($options);
+	}
 
 
-    /**
-     * Gets the registration object this form is about
-     * @return EE_Registration
-     */
-    public function get_registration()
-    {
-        return $this->_registration;
-    }
+	/**
+	 * Gets the registration object this form is about
+	 * @return EE_Registration
+	 */
+	public function get_registration()
+	{
+		return $this->_registration;
+	}
 
-    public function build_form_from_registration()
-    {
-        $reg = $this->get_registration();
-        if (! $reg instanceof EE_Registration) {
-            throw new EE_Error(__('We cannot build the registration custom questions form because there is no registration set on it yet', 'event_espresso'));
-        }
-        // we want to get all their question groups
-        $question_groups = EEM_Question_Group::instance()->get_all(
-            array(
-                array(
-                    'Event_Question_Group.EVT_ID' => $reg->event_ID(),
-                    'Event_Question_Group.EQG_primary' => $reg->count() == 1 ? true : false,
-                    'OR' => array(
-                        'Question.QST_system*blank' =>  '',
-                        'Question.QST_system*null' => array( 'IS_NULL' )
-                    )
-                ),
-                'order_by' => array( 'QSG_order' => 'ASC' )
-            )
-        );
-        // get each question groups questions
-        foreach ($question_groups as $question_group) {
-            if ($question_group instanceof EE_Question_Group) {
-                $this->_subsections[ $question_group->ID() ] = $this->build_subform_from_question_group(
-                    $question_group,
-                    $reg
-                );
-            }
-        }
-    }
+	public function build_form_from_registration()
+	{
+		$reg = $this->get_registration();
+		if (! $reg instanceof EE_Registration) {
+			throw new EE_Error(__('We cannot build the registration custom questions form because there is no registration set on it yet', 'event_espresso'));
+		}
+		// we want to get all their question groups
+		$question_groups = EEM_Question_Group::instance()->get_all(
+			array(
+				array(
+					'Event_Question_Group.EVT_ID' => $reg->event_ID(),
+					'Event_Question_Group.EQG_primary' => $reg->count() == 1 ? true : false,
+					'OR' => array(
+						'Question.QST_system*blank' =>  '',
+						'Question.QST_system*null' => array( 'IS_NULL' )
+					)
+				),
+				'order_by' => array( 'QSG_order' => 'ASC' )
+			)
+		);
+		// get each question groups questions
+		foreach ($question_groups as $question_group) {
+			if ($question_group instanceof EE_Question_Group) {
+				$this->_subsections[ $question_group->ID() ] = $this->build_subform_from_question_group(
+					$question_group,
+					$reg
+				);
+			}
+		}
+	}
 
 
 
-    /**
-     *
-     * @param EE_Question_Group $question_group
-     * @param EE_Registration   $registration
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public function build_subform_from_question_group($question_group, $registration)
-    {
-        if (! $question_group instanceof EE_Question_Group ||
-            ! $registration instanceof EE_Registration) {
-            throw new EE_Error(__('A valid question group and registration must be passed to EE_Registration_Custom_Question_Form', 'event_espresso'));
-        }
-        $parts_of_subsection = array(
-            'title' => new EE_Form_Section_HTML(
-                EEH_HTML::h5(
-                    $question_group->name(),
-                    $question_group->identifier(),
-                    'espresso-question-group-title-h5 section-title'
-                )
-            )
-        );
-        $questions = $question_group->questions(
-            array(
-                array(
-                    'OR' => array(
-                        'QST_system*blank' => '',
-                        'QST_system*null' => array( 'IS_NULL' )
-                    )
-                )
-            )
-        );
-        foreach ($questions as $question) {
-            $parts_of_subsection[ $question->ID() ] = $question->generate_form_input($registration);
-        }
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_registration',
-            'edit-reg-questions-mbox',
-            $this->_registration->ID()
-        )) {
-            $parts_of_subsection['edit_link'] = new EE_Form_Section_HTML(
-                '<tr><th/><td class="reg-admin-edit-attendee-question-td"><a class="reg-admin-edit-attendee-question-lnk" href="#" aria-label="' . esc_attr__('click to edit question', 'event_espresso') . '">
+	/**
+	 *
+	 * @param EE_Question_Group $question_group
+	 * @param EE_Registration   $registration
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public function build_subform_from_question_group($question_group, $registration)
+	{
+		if (! $question_group instanceof EE_Question_Group ||
+			! $registration instanceof EE_Registration) {
+			throw new EE_Error(__('A valid question group and registration must be passed to EE_Registration_Custom_Question_Form', 'event_espresso'));
+		}
+		$parts_of_subsection = array(
+			'title' => new EE_Form_Section_HTML(
+				EEH_HTML::h5(
+					$question_group->name(),
+					$question_group->identifier(),
+					'espresso-question-group-title-h5 section-title'
+				)
+			)
+		);
+		$questions = $question_group->questions(
+			array(
+				array(
+					'OR' => array(
+						'QST_system*blank' => '',
+						'QST_system*null' => array( 'IS_NULL' )
+					)
+				)
+			)
+		);
+		foreach ($questions as $question) {
+			$parts_of_subsection[ $question->ID() ] = $question->generate_form_input($registration);
+		}
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_registration',
+			'edit-reg-questions-mbox',
+			$this->_registration->ID()
+		)) {
+			$parts_of_subsection['edit_link'] = new EE_Form_Section_HTML(
+				'<tr><th/><td class="reg-admin-edit-attendee-question-td"><a class="reg-admin-edit-attendee-question-lnk" href="#" aria-label="' . esc_attr__('click to edit question', 'event_espresso') . '">
 		  			<span class="reg-admin-edit-question-group-spn">' . __('edit the above question group', 'event_espresso') . '</span>
 		  			<div class="dashicons dashicons-edit"></div>
 		  		</a></td></tr>'
-            );
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'subsections' => $parts_of_subsection,
-                'html_class' => 'question-group-questions',
-            )
-        );
-    }
+			);
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'subsections' => $parts_of_subsection,
+				'html_class' => 'question-group-questions',
+			)
+		);
+	}
 
-    /**
-     * Overrides parent so if inputs were disabled, we leave those with their defaults
-     * from the answers in the DB
-     * @param array $req_data like $_POST
-     * @return void
-     */
-    protected function _normalize($req_data)
-    {
-        $this->_received_submission = true;
-        $this->_validation_errors = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if ($subsection->form_data_present_in($req_data)) {
-                try {
-                    $subsection->_normalize($req_data);
-                } catch (EE_Validation_Error $e) {
-                    $subsection->add_validation_error($e);
-                }
-            }
-        }
-    }
+	/**
+	 * Overrides parent so if inputs were disabled, we leave those with their defaults
+	 * from the answers in the DB
+	 * @param array $req_data like $_POST
+	 * @return void
+	 */
+	protected function _normalize($req_data)
+	{
+		$this->_received_submission = true;
+		$this->_validation_errors = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if ($subsection->form_data_present_in($req_data)) {
+				try {
+					$subsection->_normalize($req_data);
+				} catch (EE_Validation_Error $e) {
+					$subsection->add_validation_error($e);
+				}
+			}
+		}
+	}
 
 
 
-    /**
-     * Performs validation on this form section and its subsections. For each subsection,
-     * calls _validate_{subsection_name} on THIS form (if the function exists) and passes it the subsection, then calls _validate on that subsection.
-     * If you need to perform validation on the form as a whole (considering multiple) you would be best to override this _validate method,
-     * calling parent::_validate() first.
-     */
-    protected function _validate()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if ($subsection->form_data_present_in(array_merge($_GET, $_POST))) {
-                if (method_exists($this, '_validate_'.$subsection_name)) {
-                    call_user_func_array(array($this,'_validate_'.$subsection_name), array($subsection));
-                }
-                $subsection->_validate();
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                $subsection->_received_submission = true;
-            }
-        }
-    }
+	/**
+	 * Performs validation on this form section and its subsections. For each subsection,
+	 * calls _validate_{subsection_name} on THIS form (if the function exists) and passes it the subsection, then calls _validate on that subsection.
+	 * If you need to perform validation on the form as a whole (considering multiple) you would be best to override this _validate method,
+	 * calling parent::_validate() first.
+	 */
+	protected function _validate()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
+			if ($subsection->form_data_present_in(array_merge($_GET, $_POST))) {
+				if (method_exists($this, '_validate_'.$subsection_name)) {
+					call_user_func_array(array($this,'_validate_'.$subsection_name), array($subsection));
+				}
+				$subsection->_validate();
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				$subsection->_received_submission = true;
+			}
+		}
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -29,10 +29,10 @@ 
     public function __construct(EE_Registration $reg, $options = array())
     {
         $this->_registration = $reg;
-        if (! isset($options['layout_strategy'])) {
+        if ( ! isset($options['layout_strategy'])) {
             $options['layout_strategy'] = new EE_Admin_Two_Column_Layout();
         }
-        if (! isset($options['html_id'])) {
+        if ( ! isset($options['html_id'])) {
             $options['html_id'] = 'reg-admin-attendee-questions-frm';
         }
         $this->build_form_from_registration();
@@ -52,7 +52,7 @@ 
     public function build_form_from_registration()
     {
         $reg = $this->get_registration();
-        if (! $reg instanceof EE_Registration) {
+        if ( ! $reg instanceof EE_Registration) {
             throw new EE_Error(__('We cannot build the registration custom questions form because there is no registration set on it yet', 'event_espresso'));
         }
         // we want to get all their question groups
@@ -63,16 +63,16 @@ 
                     'Event_Question_Group.EQG_primary' => $reg->count() == 1 ? true : false,
                     'OR' => array(
                         'Question.QST_system*blank' =>  '',
-                        'Question.QST_system*null' => array( 'IS_NULL' )
+                        'Question.QST_system*null' => array('IS_NULL')
                     )
                 ),
-                'order_by' => array( 'QSG_order' => 'ASC' )
+                'order_by' => array('QSG_order' => 'ASC')
             )
         );
         // get each question groups questions
         foreach ($question_groups as $question_group) {
             if ($question_group instanceof EE_Question_Group) {
-                $this->_subsections[ $question_group->ID() ] = $this->build_subform_from_question_group(
+                $this->_subsections[$question_group->ID()] = $this->build_subform_from_question_group(
                     $question_group,
                     $reg
                 );
@@ -91,7 +91,7 @@ 
      */
     public function build_subform_from_question_group($question_group, $registration)
     {
-        if (! $question_group instanceof EE_Question_Group ||
+        if ( ! $question_group instanceof EE_Question_Group ||
             ! $registration instanceof EE_Registration) {
             throw new EE_Error(__('A valid question group and registration must be passed to EE_Registration_Custom_Question_Form', 'event_espresso'));
         }
@@ -109,13 +109,13 @@ 
                 array(
                     'OR' => array(
                         'QST_system*blank' => '',
-                        'QST_system*null' => array( 'IS_NULL' )
+                        'QST_system*null' => array('IS_NULL')
                     )
                 )
             )
         );
         foreach ($questions as $question) {
-            $parts_of_subsection[ $question->ID() ] = $question->generate_form_input($registration);
+            $parts_of_subsection[$question->ID()] = $question->generate_form_input($registration);
         }
         if (EE_Registry::instance()->CAP->current_user_can(
             'ee_edit_registration',
@@ -123,8 +123,8 @@ 
             $this->_registration->ID()
         )) {
             $parts_of_subsection['edit_link'] = new EE_Form_Section_HTML(
-                '<tr><th/><td class="reg-admin-edit-attendee-question-td"><a class="reg-admin-edit-attendee-question-lnk" href="#" aria-label="' . esc_attr__('click to edit question', 'event_espresso') . '">
-		  			<span class="reg-admin-edit-question-group-spn">' . __('edit the above question group', 'event_espresso') . '</span>
+                '<tr><th/><td class="reg-admin-edit-attendee-question-td"><a class="reg-admin-edit-attendee-question-lnk" href="#" aria-label="'.esc_attr__('click to edit question', 'event_espresso').'">
+		  			<span class="reg-admin-edit-question-group-spn">' . __('edit the above question group', 'event_espresso').'</span>
 		  			<div class="dashicons dashicons-edit"></div>
 		  		</a></td></tr>'
             );
@@ -171,7 +171,7 @@ 
         foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
             if ($subsection->form_data_present_in(array_merge($_GET, $_POST))) {
                 if (method_exists($this, '_validate_'.$subsection_name)) {
-                    call_user_func_array(array($this,'_validate_'.$subsection_name), array($subsection));
+                    call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection));
                 }
                 $subsection->_validate();
             } elseif ($subsection instanceof EE_Form_Section_Proper) {

core/admin/EE_Admin.core.php

Indentation +1018 added lines, -1018 removed lines

@@ -20,488 +20,488 @@ 
 final class EE_Admin implements InterminableInterface
 {
 
-    /**
-     * @var EE_Admin $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var PersistentAdminNoticeManager $persistent_admin_notice_manager
-     */
-    private $persistent_admin_notice_manager;
-
-    /**
-     * @var LoaderInterface
-     */
-    protected $loader;
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Admin
-     * @throws EE_Error
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Admin) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @return EE_Admin
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * class constructor
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct()
-    {
-        // define global EE_Admin constants
-        $this->_define_all_constants();
-        // set autoloaders for our admin page classes based on included path information
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
-        // admin hooks
-        add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
-        // load EE_Request_Handler early
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
-        add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
-        add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
-        add_action('wp_loaded', array($this, 'wp_loaded'), 100);
-        add_action('admin_init', array($this, 'admin_init'), 100);
-        add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
-        add_action('admin_notices', array($this, 'display_admin_notices'), 10);
-        add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
-        add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
-        add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
-        add_action('load-plugins.php', array($this, 'hookIntoWpPluginsPage'));
-        add_action('display_post_states', array($this, 'displayStateForCriticalPages'), 10, 2);
-        add_filter('plugin_row_meta', array($this, 'addLinksToPluginRowMeta'), 10, 2);
-        // reset Environment config (we only do this on admin page loads);
-        EE_Registry::instance()->CFG->environment->recheck_values();
-        do_action('AHEE__EE_Admin__loaded');
-    }
-
-
-    /**
-     * _define_all_constants
-     * define constants that are set globally for all admin pages
-     *
-     * @return void
-     */
-    private function _define_all_constants()
-    {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS);
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
-            define('WP_AJAX_URL', admin_url('admin-ajax.php'));
-        }
-    }
-
-
-    /**
-     * filter_plugin_actions - adds links to the Plugins page listing
-     *
-     * @param    array  $links
-     * @param    string $plugin
-     * @return    array
-     */
-    public function filter_plugin_actions($links, $plugin)
-    {
-        // set $main_file in stone
-        static $main_file;
-        // if $main_file is not set yet
-        if (! $main_file) {
-            $main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
-        }
-        if ($plugin === $main_file) {
-            // compare current plugin to this one
-            if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
-                $maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
-                                    . ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
-                                    . esc_html__('Maintenance Mode Active', 'event_espresso')
-                                    . '</a>';
-                array_unshift($links, $maintenance_link);
-            } else {
-                $org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
-                                     . esc_html__('Settings', 'event_espresso')
-                                     . '</a>';
-                $events_link = '<a href="admin.php?page=espresso_events">'
-                               . esc_html__('Events', 'event_espresso')
-                               . '</a>';
-                // add before other links
-                array_unshift($links, $org_settings_link, $events_link);
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * _get_request
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_request()
-    {
-        EE_Registry::instance()->load_core('Request_Handler');
-    }
-
-
-    /**
-     * hide_admin_pages_except_maintenance_mode
-     *
-     * @param array $admin_page_folder_names
-     * @return array
-     */
-    public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
-    {
-        return array(
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
-            'about'       => EE_ADMIN_PAGES . 'about' . DS,
-            'support'     => EE_ADMIN_PAGES . 'support' . DS,
-        );
-    }
-
-
-    /**
-     * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
-     * EE_Front_Controller's init phases have run
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws ServiceNotFoundException
-     */
-    public function init()
-    {
-        // only enable most of the EE_Admin IF we're not in full maintenance mode
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $this->initModelsReady();
-        }
-        // run the admin page factory but ONLY if we are doing an ee admin ajax request
-        if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
-            try {
-                // this loads the controller for the admin pages which will setup routing etc
-                EE_Registry::instance()->load_core('Admin_Page_Loader');
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
-        // make sure our CPTs and custom taxonomy metaboxes get shown for first time users
-        add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
-        add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
-        // exclude EE critical pages from all nav menus and wp_list_pages
-        add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
-    }
-
-
-    /**
-     * Gets the loader (and if it wasn't previously set, sets it)
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader()
-    {
-        if (! $this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
-
-
-    /**
-     * Method that's fired on admin requests (including admin ajax) but only when the models are usable
-     * (ie, the site isn't in maintenance mode)
-     * @since 4.9.63.p
-     * @return void
-     */
-    protected function initModelsReady()
-    {
-        // ok so we want to enable the entire admin
-        $this->persistent_admin_notice_manager = $this->getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $this->persistent_admin_notice_manager->setReturnUrl(
-            EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'page'   => EE_Registry::instance()->REQ->get('page', ''),
-                    'action' => EE_Registry::instance()->REQ->get('action', ''),
-                ),
-                EE_ADMIN_URL
-            )
-        );
-        $this->maybeSetDatetimeWarningNotice();
-        // at a glance dashboard widget
-        add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
-        // filter for get_edit_post_link used on comments for custom post types
-        add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
-    }
-
-
-    /**
-     *    get_persistent_admin_notices
-     *
-     * @access    public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function maybeSetDatetimeWarningNotice()
-    {
-        // add dismissable notice for datetime changes.  Only valid if site does not have a timezone_string set.
-        // @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
-        // with this.  But after enough time (indeterminate at this point) we can just remove this notice.
-        // this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
-        if (apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
-            && ! get_option('timezone_string')
-            && EEM_Event::instance()->count() > 0
-        ) {
-            new PersistentAdminNotice(
-                'datetime_fix_notice',
-                sprintf(
-                    esc_html__(
-                        '%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>',
-                    '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
-                    '</a>',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'page'   => 'espresso_maintenance_settings',
-                            'action' => 'datetime_tools',
-                        ),
-                        admin_url('admin.php')
-                    ) . '">'
-                ),
-                false,
-                'manage_options',
-                'datetime_fix_persistent_notice'
-            );
-        }
-    }
-
-
-    /**
-     * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
-     * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
-     * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
-     * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
-     * normal property on the post_type object.  It's found ONLY in this particular context.
-     *
-     * @param WP_Post $post_type WP post type object
-     * @return WP_Post
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_pages_from_nav_menu($post_type)
-    {
-        // if this isn't the "pages" post type let's get out
-        if ($post_type->name !== 'page') {
-            return $post_type;
-        }
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-        $post_type->_default_query = array(
-            'post__not_in' => $critical_pages,
-        );
-        return $post_type;
-    }
-
-
-    /**
-     * WP by default only shows three metaboxes in "nav-menus.php" for first times users.  We want to make sure our
-     * metaboxes get shown as well
-     *
-     * @return void
-     */
-    public function enable_hidden_ee_nav_menu_metaboxes()
-    {
-        global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
-            return;
-        }
-        $user = wp_get_current_user();
-        // has this been done yet?
-        if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
-            return;
-        }
-
-        $hidden_meta_boxes = get_user_option('metaboxhidden_nav-menus', $user->ID);
-        $initial_meta_boxes = apply_filters(
-            'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
-            array(
-                'nav-menu-theme-locations',
-                'add-page',
-                'add-custom-links',
-                'add-category',
-                'add-espresso_events',
-                'add-espresso_venues',
-                'add-espresso_event_categories',
-                'add-espresso_venue_categories',
-                'add-post-type-post',
-                'add-post-type-page',
-            )
-        );
-
-        if (is_array($hidden_meta_boxes)) {
-            foreach ($hidden_meta_boxes as $key => $meta_box_id) {
-                if (in_array($meta_box_id, $initial_meta_boxes, true)) {
-                    unset($hidden_meta_boxes[ $key ]);
-                }
-            }
-        }
-        update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
-        update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
-    }
-
-
-    /**
-     * This method simply registers custom nav menu boxes for "nav_menus.php route"
-     * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
-     *
-     * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
-     *         addons etc.
-     * @return void
-     */
-    public function register_custom_nav_menu_boxes()
-    {
-        add_meta_box(
-            'add-extra-nav-menu-pages',
-            esc_html__('Event Espresso Pages', 'event_espresso'),
-            array($this, 'ee_cpt_archive_pages'),
-            'nav-menus',
-            'side',
-            'core'
-        );
-    }
-
-
-    /**
-     * Use this to edit the post link for our cpts so that the edit link points to the correct page.
-     *
-     * @since   4.3.0
-     * @param string $link the original link generated by wp
-     * @param int    $id   post id
-     * @return string  the (maybe) modified link
-     */
-    public function modify_edit_post_link($link, $id)
-    {
-        if (! $post = get_post($id)) {
-            return $link;
-        }
-        if ($post->post_type === 'espresso_attendees') {
-            $query_args = array(
-                'action' => 'edit_attendee',
-                'post'   => $id,
-            );
-            return EEH_URL::add_query_args_and_nonce(
-                $query_args,
-                admin_url('admin.php?page=espresso_registrations')
-            );
-        }
-        return $link;
-    }
-
-
-    public function ee_cpt_archive_pages()
-    {
-        global $nav_menu_selected_id;
-        $db_fields = false;
-        $walker = new Walker_Nav_Menu_Checklist($db_fields);
-        $current_tab = 'event-archives';
-        $removed_args = array(
-            'action',
-            'customlink-tab',
-            'edit-menu-item',
-            'menu-item',
-            'page-tab',
-            '_wpnonce',
-        );
-        ?>
+	/**
+	 * @var EE_Admin $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var PersistentAdminNoticeManager $persistent_admin_notice_manager
+	 */
+	private $persistent_admin_notice_manager;
+
+	/**
+	 * @var LoaderInterface
+	 */
+	protected $loader;
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Admin
+	 * @throws EE_Error
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Admin) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Admin
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * class constructor
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct()
+	{
+		// define global EE_Admin constants
+		$this->_define_all_constants();
+		// set autoloaders for our admin page classes based on included path information
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
+		// admin hooks
+		add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
+		// load EE_Request_Handler early
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
+		add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
+		add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
+		add_action('wp_loaded', array($this, 'wp_loaded'), 100);
+		add_action('admin_init', array($this, 'admin_init'), 100);
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
+		add_action('admin_notices', array($this, 'display_admin_notices'), 10);
+		add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
+		add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
+		add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
+		add_action('load-plugins.php', array($this, 'hookIntoWpPluginsPage'));
+		add_action('display_post_states', array($this, 'displayStateForCriticalPages'), 10, 2);
+		add_filter('plugin_row_meta', array($this, 'addLinksToPluginRowMeta'), 10, 2);
+		// reset Environment config (we only do this on admin page loads);
+		EE_Registry::instance()->CFG->environment->recheck_values();
+		do_action('AHEE__EE_Admin__loaded');
+	}
+
+
+	/**
+	 * _define_all_constants
+	 * define constants that are set globally for all admin pages
+	 *
+	 * @return void
+	 */
+	private function _define_all_constants()
+	{
+		if (! defined('EE_ADMIN_URL')) {
+			define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
+			define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
+			define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS);
+			define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+			define('WP_AJAX_URL', admin_url('admin-ajax.php'));
+		}
+	}
+
+
+	/**
+	 * filter_plugin_actions - adds links to the Plugins page listing
+	 *
+	 * @param    array  $links
+	 * @param    string $plugin
+	 * @return    array
+	 */
+	public function filter_plugin_actions($links, $plugin)
+	{
+		// set $main_file in stone
+		static $main_file;
+		// if $main_file is not set yet
+		if (! $main_file) {
+			$main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
+		}
+		if ($plugin === $main_file) {
+			// compare current plugin to this one
+			if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
+				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
+									. ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
+									. esc_html__('Maintenance Mode Active', 'event_espresso')
+									. '</a>';
+				array_unshift($links, $maintenance_link);
+			} else {
+				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
+									 . esc_html__('Settings', 'event_espresso')
+									 . '</a>';
+				$events_link = '<a href="admin.php?page=espresso_events">'
+							   . esc_html__('Events', 'event_espresso')
+							   . '</a>';
+				// add before other links
+				array_unshift($links, $org_settings_link, $events_link);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * _get_request
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_request()
+	{
+		EE_Registry::instance()->load_core('Request_Handler');
+	}
+
+
+	/**
+	 * hide_admin_pages_except_maintenance_mode
+	 *
+	 * @param array $admin_page_folder_names
+	 * @return array
+	 */
+	public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
+	{
+		return array(
+			'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
+			'about'       => EE_ADMIN_PAGES . 'about' . DS,
+			'support'     => EE_ADMIN_PAGES . 'support' . DS,
+		);
+	}
+
+
+	/**
+	 * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
+	 * EE_Front_Controller's init phases have run
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws ServiceNotFoundException
+	 */
+	public function init()
+	{
+		// only enable most of the EE_Admin IF we're not in full maintenance mode
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$this->initModelsReady();
+		}
+		// run the admin page factory but ONLY if we are doing an ee admin ajax request
+		if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
+			try {
+				// this loads the controller for the admin pages which will setup routing etc
+				EE_Registry::instance()->load_core('Admin_Page_Loader');
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
+		// make sure our CPTs and custom taxonomy metaboxes get shown for first time users
+		add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
+		add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
+		// exclude EE critical pages from all nav menus and wp_list_pages
+		add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
+	}
+
+
+	/**
+	 * Gets the loader (and if it wasn't previously set, sets it)
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader()
+	{
+		if (! $this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
+
+
+	/**
+	 * Method that's fired on admin requests (including admin ajax) but only when the models are usable
+	 * (ie, the site isn't in maintenance mode)
+	 * @since 4.9.63.p
+	 * @return void
+	 */
+	protected function initModelsReady()
+	{
+		// ok so we want to enable the entire admin
+		$this->persistent_admin_notice_manager = $this->getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$this->persistent_admin_notice_manager->setReturnUrl(
+			EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'page'   => EE_Registry::instance()->REQ->get('page', ''),
+					'action' => EE_Registry::instance()->REQ->get('action', ''),
+				),
+				EE_ADMIN_URL
+			)
+		);
+		$this->maybeSetDatetimeWarningNotice();
+		// at a glance dashboard widget
+		add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
+		// filter for get_edit_post_link used on comments for custom post types
+		add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
+	}
+
+
+	/**
+	 *    get_persistent_admin_notices
+	 *
+	 * @access    public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function maybeSetDatetimeWarningNotice()
+	{
+		// add dismissable notice for datetime changes.  Only valid if site does not have a timezone_string set.
+		// @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
+		// with this.  But after enough time (indeterminate at this point) we can just remove this notice.
+		// this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
+		if (apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
+			&& ! get_option('timezone_string')
+			&& EEM_Event::instance()->count() > 0
+		) {
+			new PersistentAdminNotice(
+				'datetime_fix_notice',
+				sprintf(
+					esc_html__(
+						'%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>',
+					'<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
+					'</a>',
+					'<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'page'   => 'espresso_maintenance_settings',
+							'action' => 'datetime_tools',
+						),
+						admin_url('admin.php')
+					) . '">'
+				),
+				false,
+				'manage_options',
+				'datetime_fix_persistent_notice'
+			);
+		}
+	}
+
+
+	/**
+	 * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
+	 * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
+	 * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
+	 * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
+	 * normal property on the post_type object.  It's found ONLY in this particular context.
+	 *
+	 * @param WP_Post $post_type WP post type object
+	 * @return WP_Post
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_pages_from_nav_menu($post_type)
+	{
+		// if this isn't the "pages" post type let's get out
+		if ($post_type->name !== 'page') {
+			return $post_type;
+		}
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+		$post_type->_default_query = array(
+			'post__not_in' => $critical_pages,
+		);
+		return $post_type;
+	}
+
+
+	/**
+	 * WP by default only shows three metaboxes in "nav-menus.php" for first times users.  We want to make sure our
+	 * metaboxes get shown as well
+	 *
+	 * @return void
+	 */
+	public function enable_hidden_ee_nav_menu_metaboxes()
+	{
+		global $wp_meta_boxes, $pagenow;
+		if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+			return;
+		}
+		$user = wp_get_current_user();
+		// has this been done yet?
+		if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
+			return;
+		}
+
+		$hidden_meta_boxes = get_user_option('metaboxhidden_nav-menus', $user->ID);
+		$initial_meta_boxes = apply_filters(
+			'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
+			array(
+				'nav-menu-theme-locations',
+				'add-page',
+				'add-custom-links',
+				'add-category',
+				'add-espresso_events',
+				'add-espresso_venues',
+				'add-espresso_event_categories',
+				'add-espresso_venue_categories',
+				'add-post-type-post',
+				'add-post-type-page',
+			)
+		);
+
+		if (is_array($hidden_meta_boxes)) {
+			foreach ($hidden_meta_boxes as $key => $meta_box_id) {
+				if (in_array($meta_box_id, $initial_meta_boxes, true)) {
+					unset($hidden_meta_boxes[ $key ]);
+				}
+			}
+		}
+		update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
+		update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
+	}
+
+
+	/**
+	 * This method simply registers custom nav menu boxes for "nav_menus.php route"
+	 * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
+	 *
+	 * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
+	 *         addons etc.
+	 * @return void
+	 */
+	public function register_custom_nav_menu_boxes()
+	{
+		add_meta_box(
+			'add-extra-nav-menu-pages',
+			esc_html__('Event Espresso Pages', 'event_espresso'),
+			array($this, 'ee_cpt_archive_pages'),
+			'nav-menus',
+			'side',
+			'core'
+		);
+	}
+
+
+	/**
+	 * Use this to edit the post link for our cpts so that the edit link points to the correct page.
+	 *
+	 * @since   4.3.0
+	 * @param string $link the original link generated by wp
+	 * @param int    $id   post id
+	 * @return string  the (maybe) modified link
+	 */
+	public function modify_edit_post_link($link, $id)
+	{
+		if (! $post = get_post($id)) {
+			return $link;
+		}
+		if ($post->post_type === 'espresso_attendees') {
+			$query_args = array(
+				'action' => 'edit_attendee',
+				'post'   => $id,
+			);
+			return EEH_URL::add_query_args_and_nonce(
+				$query_args,
+				admin_url('admin.php?page=espresso_registrations')
+			);
+		}
+		return $link;
+	}
+
+
+	public function ee_cpt_archive_pages()
+	{
+		global $nav_menu_selected_id;
+		$db_fields = false;
+		$walker = new Walker_Nav_Menu_Checklist($db_fields);
+		$current_tab = 'event-archives';
+		$removed_args = array(
+			'action',
+			'customlink-tab',
+			'edit-menu-item',
+			'menu-item',
+			'page-tab',
+			'_wpnonce',
+		);
+		?>
         <div id="posttype-extra-nav-menu-pages" class="posttypediv">
             <ul id="posttype-extra-nav-menu-pages-tabs" class="posttype-tabs add-menu-item-tabs">
                 <li <?php echo('event-archives' === $current_tab ? ' class="tabs"' : ''); ?>>
                     <a class="nav-tab-link" data-type="tabs-panel-posttype-extra-nav-menu-pages-event-archives"
                        href="<?php
-                        if ($nav_menu_selected_id) {
-                            echo esc_url(
-                                add_query_arg(
-                                    'extra-nav-menu-pages-tab',
-                                    'event-archives',
-                                    remove_query_arg($removed_args)
-                                )
-                            );
-                        }
-                        ?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
+						if ($nav_menu_selected_id) {
+							echo esc_url(
+								add_query_arg(
+									'extra-nav-menu-pages-tab',
+									'event-archives',
+									remove_query_arg($removed_args)
+								)
+							);
+						}
+						?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
                         <?php _e('Event Archive Pages', 'event_espresso'); ?>
                     </a>
                 </li>
             </ul><!-- .posttype-tabs -->
 
             <div id="tabs-panel-posttype-extra-nav-menu-pages-event-archives" class="tabs-panel <?php
-            echo('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
-            ?>">
+			echo('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
+			?>">
                 <ul id="extra-nav-menu-pageschecklist-event-archives" class="categorychecklist form-no-clear">
                     <?php
-                    $pages = $this->_get_extra_nav_menu_pages_items();
-                    $args['walker'] = $walker;
-                    echo walk_nav_menu_tree(
-                        array_map(
-                            array($this, '_setup_extra_nav_menu_pages_items'),
-                            $pages
-                        ),
-                        0,
-                        (object) $args
-                    );
-                    ?>
+					$pages = $this->_get_extra_nav_menu_pages_items();
+					$args['walker'] = $walker;
+					echo walk_nav_menu_tree(
+						array_map(
+							array($this, '_setup_extra_nav_menu_pages_items'),
+							$pages
+						),
+						0,
+						(object) $args
+					);
+					?>
                 </ul>
             </div><!-- /.tabs-panel -->
 
             <p class="button-controls">
                 <span class="list-controls">
                     <a href="<?php
-                             echo esc_url(
-                                 add_query_arg(
-                                     array(
-                                         'extra-nav-menu-pages-tab' => 'event-archives',
-                                         'selectall'                => 1,
-                                     ),
-                                     remove_query_arg($removed_args)
-                                 )
-                             );
-                        ?>#posttype-extra-nav-menu-pages>" class="select-all"><?php _e('Select All', 'event_espresso'); ?></a>
+							 echo esc_url(
+								 add_query_arg(
+									 array(
+										 'extra-nav-menu-pages-tab' => 'event-archives',
+										 'selectall'                => 1,
+									 ),
+									 remove_query_arg($removed_args)
+								 )
+							 );
+						?>#posttype-extra-nav-menu-pages>" class="select-all"><?php _e('Select All', 'event_espresso'); ?></a>
                 </span>
                 <span class="add-to-menu">
                     <input type="submit"<?php wp_nav_menu_disabled_check($nav_menu_selected_id); ?>
@@ -514,559 +514,559 @@ 
 
         </div><!-- /.posttypediv -->
         <?php
-    }
-
-
-    /**
-     * Returns an array of event archive nav items.
-     *
-     * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
-     *        method we use for getting the extra nav menu items
-     * @return array
-     */
-    private function _get_extra_nav_menu_pages_items()
-    {
-        $menuitems[] = array(
-            'title'       => esc_html__('Event List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_events'),
-            'description' => esc_html__('Archive page for all events.', 'event_espresso'),
-        );
-        return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
-    }
-
-
-    /**
-     * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
-     * the properties and converts it to the menu item object.
-     *
-     * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
-     * @param $menu_item_values
-     * @return stdClass
-     */
-    private function _setup_extra_nav_menu_pages_items($menu_item_values)
-    {
-        $menu_item = new stdClass();
-        $keys = array(
-            'ID'               => 0,
-            'db_id'            => 0,
-            'menu_item_parent' => 0,
-            'object_id'        => -1,
-            'post_parent'      => 0,
-            'type'             => 'custom',
-            'object'           => '',
-            'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
-            'title'            => '',
-            'url'              => '',
-            'target'           => '',
-            'attr_title'       => '',
-            'description'      => '',
-            'classes'          => array(),
-            'xfn'              => '',
-        );
-
-        foreach ($keys as $key => $value) {
-            $menu_item->{$key} = isset($menu_item_values[ $key ]) ? $menu_item_values[ $key ] : $value;
-        }
-        return $menu_item;
-    }
-
-
-    /**
-     * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
-     * EE_Admin_Page route is called.
-     *
-     * @return void
-     */
-    public function route_admin_request()
-    {
-    }
-
-
-    /**
-     * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
-     *
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-    /**
-     * admin_init
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function admin_init()
-    {
-        /**
-         * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
-         * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
-         * - check if doing post processing.
-         * - check if doing post processing of one of EE CPTs
-         * - instantiate the corresponding EE CPT model for the post_type being processed.
-         */
-        if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = $this->getLoader()->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-            );
-            $custom_post_types->getCustomPostTypeModels($_POST['post_type']);
-        }
-
-
-        /**
-         * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
-         * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
-         * Pages" tab in the EE General Settings Admin page.
-         * This is for user-proofing.
-         */
-        add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $this->adminInitModelsReady();
-        }
-    }
-
-
-    /**
-     * Runs on admin_init but only if models are usable (ie, we're not in maintenanc emode)
-     */
-    protected function adminInitModelsReady()
-    {
-        if (function_exists('wp_add_privacy_policy_content')) {
-            $this->getLoader()->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
-        }
-    }
-
-
-    /**
-     * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
-     *
-     * @param string $output Current output.
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function modify_dropdown_pages($output)
-    {
-        // get critical pages
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-
-        // split current output by line break for easier parsing.
-        $split_output = explode("\n", $output);
-
-        // loop through to remove any critical pages from the array.
-        foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
-            foreach ($split_output as $key => $haystack) {
-                if (strpos($haystack, $needle) !== false) {
-                    unset($split_output[ $key ]);
-                }
-            }
-        }
-        // replace output with the new contents
-        return implode("\n", $split_output);
-    }
-
-
-    /**
-     * enqueue all admin scripts that need loaded for admin pages
-     *
-     * @return void
-     */
-    public function enqueue_admin_scripts()
-    {
-        // this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
-        // Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script
-        // calls.
-        wp_enqueue_script(
-            'ee-inject-wp',
-            EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // register cookie script for future dependencies
-        wp_register_script(
-            'jquery-cookie',
-            EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
-            array('jquery'),
-            '2.1',
-            true
-        );
-        // joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again
-        // via: add_filter('FHEE_load_joyride', '__return_true' );
-        if (apply_filters('FHEE_load_joyride', false)) {
-            // joyride style
-            wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
-            wp_register_style(
-                'ee-joyride-css',
-                EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
-                array('joyride-css'),
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_register_script(
-                'joyride-modernizr',
-                EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
-                array(),
-                '2.1',
-                true
-            );
-            // joyride JS
-            wp_register_script(
-                'jquery-joyride',
-                EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
-                array('jquery-cookie', 'joyride-modernizr'),
-                '2.1',
-                true
-            );
-            // wanna go for a joyride?
-            wp_enqueue_style('ee-joyride-css');
-            wp_enqueue_script('jquery-joyride');
-        }
-    }
-
-
-    /**
-     * display_admin_notices
-     *
-     * @return void
-     */
-    public function display_admin_notices()
-    {
-        echo EE_Error::get_notices();
-    }
-
-
-    /**
-     * @param array $elements
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function dashboard_glance_items($elements)
-    {
-        $elements = is_array($elements) ? $elements : array($elements);
-        $events = EEM_Event::instance()->count();
-        $items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('page' => 'espresso_events'),
-            admin_url('admin.php')
-        );
-        $items['events']['text'] = sprintf(_n('%s Event', '%s Events', $events, 'event_espresso'), number_format_i18n($events));
-        $items['events']['title'] = esc_html__('Click to view all Events', 'event_espresso');
-        $registrations = EEM_Registration::instance()->count(
-            array(
-                array(
-                    'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
-                ),
-            )
-        );
-        $items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('page' => 'espresso_registrations'),
-            admin_url('admin.php')
-        );
-        $items['registrations']['text'] = sprintf(
-            _n('%s Registration', '%s Registrations', $registrations, 'event_espresso'),
-            number_format_i18n($registrations)
-        );
-        $items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
-
-        $items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
-
-        foreach ($items as $type => $item_properties) {
-            $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
-                $item_properties['url'],
-                $item_properties['title'],
-                $item_properties['text']
-            );
-        }
-        return $elements;
-    }
-
-
-    /**
-     * check_for_invalid_datetime_formats
-     * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
-     * their selected format can be parsed by PHP
-     *
-     * @param    $value
-     * @param    $option
-     * @throws EE_Error
-     * @return    string
-     */
-    public function check_for_invalid_datetime_formats($value, $option)
-    {
-        // check for date_format or time_format
-        switch ($option) {
-            case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
-                break;
-            case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
-                break;
-            default:
-                $date_time_format = false;
-        }
-        // do we have a date_time format to check ?
-        if ($date_time_format) {
-            $error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
-
-            if (is_array($error_msg)) {
-                $msg = '<p>'
-                       . sprintf(
-                           esc_html__(
-                               'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
-                               'event_espresso'
-                           ),
-                           date($date_time_format),
-                           $date_time_format
-                       )
-                       . '</p><p><ul>';
-
-
-                foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
-                }
-
-                $msg .= '</ul></p><p>'
-                        . sprintf(
-                            esc_html__(
-                                '%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
-                                'event_espresso'
-                            ),
-                            '<span style="color:#D54E21;">',
-                            '</span>'
-                        )
-                        . '</p>';
-
-                // trigger WP settings error
-                add_settings_error(
-                    'date_format',
-                    'date_format',
-                    $msg
-                );
-
-                // set format to something valid
-                switch ($option) {
-                    case 'date_format':
-                        $value = 'F j, Y';
-                        break;
-                    case 'time_format':
-                        $value = 'g:i a';
-                        break;
-                }
-            }
-        }
-        return $value;
-    }
-
-
-    /**
-     * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
-     *
-     * @param $content
-     * @return    string
-     */
-    public function its_eSpresso($content)
-    {
-        return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
-    }
-
-
-    /**
-     * espresso_admin_footer
-     *
-     * @return    string
-     */
-    public function espresso_admin_footer()
-    {
-        return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
-    }
-
-
-    /**
-     * static method for registering ee admin page.
-     * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
-     *
-     * @since      4.3.0
-     * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
-     * @see        EE_Register_Admin_Page::register()
-     * @param       $page_basename
-     * @param       $page_path
-     * @param array $config
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_ee_admin_page($page_basename, $page_path, $config = array())
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
-                    'event_espresso'
-                ),
-                $page_basename
-            ),
-            '4.3'
-        );
-        if (class_exists('EE_Register_Admin_Page')) {
-            $config['page_path'] = $page_path;
-        }
-        EE_Register_Admin_Page::register($page_basename, $config);
-    }
-
-
-    /**
-     * @deprecated 4.8.41
-     * @param  int      $post_ID
-     * @param  \WP_Post $post
-     * @return void
-     */
-    public static function parse_post_content_on_save($post_ID, $post)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.8.41
-     * @param  $option
-     * @param  $old_value
-     * @param  $value
-     * @return void
-     */
-    public function reset_page_for_posts_on_change($option, $old_value, $value)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @return void
-     */
-    public function get_persistent_admin_notices()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    public function dismiss_ee_nag_notice_callback()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-        $this->persistent_admin_notice_manager->dismissNotice();
-    }
-
-
-    /**
-     * Callback on load-plugins.php hook for setting up anything hooking into the wp plugins page.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function hookIntoWpPluginsPage()
-    {
-        $this->getLoader()->getShared('EventEspresso\core\domain\services\admin\ExitModal');
-        $this->getLoader()
-                     ->getShared('EventEspresso\core\domain\services\admin\PluginUpsells')
-                     ->decafUpsells();
-    }
-
-
-    /**
-     * Hooks into the "post states" filter in a wp post type list table.
-     *
-     * @param array   $post_states
-     * @param WP_Post $post
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function displayStateForCriticalPages($post_states, $post)
-    {
-        $post_states = (array) $post_states;
-        if (! $post instanceof WP_Post || $post->post_type !== 'page') {
-            return $post_states;
-        }
-        /** @var EE_Core_Config $config */
-        $config = $this->getLoader()->getShared('EE_Config')->core;
-        if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
-            $post_states[] = sprintf(
-                /* Translators: Using company name - Event Espresso Critical Page */
-                esc_html__('%s Critical Page', 'event_espresso'),
-                'Event Espresso'
-            );
-        }
-        return $post_states;
-    }
-
-
-    /**
-     * Show documentation links on the plugins page
-     *
-     * @param mixed $meta Plugin Row Meta
-     * @param mixed $file Plugin Base file
-     * @return array
-     */
-    public function addLinksToPluginRowMeta($meta, $file)
-    {
-        if (EE_PLUGIN_BASENAME === $file) {
-            $row_meta = array(
-                'docs' => '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4"'
-                          . ' aria-label="'
-                          . esc_attr__('View Event Espresso documentation', 'event_espresso')
-                          . '">'
-                          . esc_html__('Docs', 'event_espresso')
-                          . '</a>',
-                'api'  => '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API"'
-                          . ' aria-label="'
-                          . esc_attr__('View Event Espresso API docs', 'event_espresso')
-                          . '">'
-                          . esc_html__('API docs', 'event_espresso')
-                          . '</a>',
-            );
-            return array_merge($meta, $row_meta);
-        }
-        return (array) $meta;
-    }
+	}
+
+
+	/**
+	 * Returns an array of event archive nav items.
+	 *
+	 * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
+	 *        method we use for getting the extra nav menu items
+	 * @return array
+	 */
+	private function _get_extra_nav_menu_pages_items()
+	{
+		$menuitems[] = array(
+			'title'       => esc_html__('Event List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_events'),
+			'description' => esc_html__('Archive page for all events.', 'event_espresso'),
+		);
+		return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
+	}
+
+
+	/**
+	 * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
+	 * the properties and converts it to the menu item object.
+	 *
+	 * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
+	 * @param $menu_item_values
+	 * @return stdClass
+	 */
+	private function _setup_extra_nav_menu_pages_items($menu_item_values)
+	{
+		$menu_item = new stdClass();
+		$keys = array(
+			'ID'               => 0,
+			'db_id'            => 0,
+			'menu_item_parent' => 0,
+			'object_id'        => -1,
+			'post_parent'      => 0,
+			'type'             => 'custom',
+			'object'           => '',
+			'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
+			'title'            => '',
+			'url'              => '',
+			'target'           => '',
+			'attr_title'       => '',
+			'description'      => '',
+			'classes'          => array(),
+			'xfn'              => '',
+		);
+
+		foreach ($keys as $key => $value) {
+			$menu_item->{$key} = isset($menu_item_values[ $key ]) ? $menu_item_values[ $key ] : $value;
+		}
+		return $menu_item;
+	}
+
+
+	/**
+	 * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
+	 * EE_Admin_Page route is called.
+	 *
+	 * @return void
+	 */
+	public function route_admin_request()
+	{
+	}
+
+
+	/**
+	 * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
+	 *
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+	/**
+	 * admin_init
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function admin_init()
+	{
+		/**
+		 * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
+		 * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
+		 * - check if doing post processing.
+		 * - check if doing post processing of one of EE CPTs
+		 * - instantiate the corresponding EE CPT model for the post_type being processed.
+		 */
+		if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = $this->getLoader()->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+			);
+			$custom_post_types->getCustomPostTypeModels($_POST['post_type']);
+		}
+
+
+		/**
+		 * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
+		 * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
+		 * Pages" tab in the EE General Settings Admin page.
+		 * This is for user-proofing.
+		 */
+		add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$this->adminInitModelsReady();
+		}
+	}
+
+
+	/**
+	 * Runs on admin_init but only if models are usable (ie, we're not in maintenanc emode)
+	 */
+	protected function adminInitModelsReady()
+	{
+		if (function_exists('wp_add_privacy_policy_content')) {
+			$this->getLoader()->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
+		}
+	}
+
+
+	/**
+	 * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
+	 *
+	 * @param string $output Current output.
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function modify_dropdown_pages($output)
+	{
+		// get critical pages
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+
+		// split current output by line break for easier parsing.
+		$split_output = explode("\n", $output);
+
+		// loop through to remove any critical pages from the array.
+		foreach ($critical_pages as $page_id) {
+			$needle = 'value="' . $page_id . '"';
+			foreach ($split_output as $key => $haystack) {
+				if (strpos($haystack, $needle) !== false) {
+					unset($split_output[ $key ]);
+				}
+			}
+		}
+		// replace output with the new contents
+		return implode("\n", $split_output);
+	}
+
+
+	/**
+	 * enqueue all admin scripts that need loaded for admin pages
+	 *
+	 * @return void
+	 */
+	public function enqueue_admin_scripts()
+	{
+		// this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
+		// Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script
+		// calls.
+		wp_enqueue_script(
+			'ee-inject-wp',
+			EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// register cookie script for future dependencies
+		wp_register_script(
+			'jquery-cookie',
+			EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
+			array('jquery'),
+			'2.1',
+			true
+		);
+		// joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again
+		// via: add_filter('FHEE_load_joyride', '__return_true' );
+		if (apply_filters('FHEE_load_joyride', false)) {
+			// joyride style
+			wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
+			wp_register_style(
+				'ee-joyride-css',
+				EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
+				array('joyride-css'),
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_register_script(
+				'joyride-modernizr',
+				EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
+				array(),
+				'2.1',
+				true
+			);
+			// joyride JS
+			wp_register_script(
+				'jquery-joyride',
+				EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
+				array('jquery-cookie', 'joyride-modernizr'),
+				'2.1',
+				true
+			);
+			// wanna go for a joyride?
+			wp_enqueue_style('ee-joyride-css');
+			wp_enqueue_script('jquery-joyride');
+		}
+	}
+
+
+	/**
+	 * display_admin_notices
+	 *
+	 * @return void
+	 */
+	public function display_admin_notices()
+	{
+		echo EE_Error::get_notices();
+	}
+
+
+	/**
+	 * @param array $elements
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function dashboard_glance_items($elements)
+	{
+		$elements = is_array($elements) ? $elements : array($elements);
+		$events = EEM_Event::instance()->count();
+		$items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('page' => 'espresso_events'),
+			admin_url('admin.php')
+		);
+		$items['events']['text'] = sprintf(_n('%s Event', '%s Events', $events, 'event_espresso'), number_format_i18n($events));
+		$items['events']['title'] = esc_html__('Click to view all Events', 'event_espresso');
+		$registrations = EEM_Registration::instance()->count(
+			array(
+				array(
+					'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
+				),
+			)
+		);
+		$items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('page' => 'espresso_registrations'),
+			admin_url('admin.php')
+		);
+		$items['registrations']['text'] = sprintf(
+			_n('%s Registration', '%s Registrations', $registrations, 'event_espresso'),
+			number_format_i18n($registrations)
+		);
+		$items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
+
+		$items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
+
+		foreach ($items as $type => $item_properties) {
+			$elements[] = sprintf(
+				'<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+				$item_properties['url'],
+				$item_properties['title'],
+				$item_properties['text']
+			);
+		}
+		return $elements;
+	}
+
+
+	/**
+	 * check_for_invalid_datetime_formats
+	 * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
+	 * their selected format can be parsed by PHP
+	 *
+	 * @param    $value
+	 * @param    $option
+	 * @throws EE_Error
+	 * @return    string
+	 */
+	public function check_for_invalid_datetime_formats($value, $option)
+	{
+		// check for date_format or time_format
+		switch ($option) {
+			case 'date_format':
+				$date_time_format = $value . ' ' . get_option('time_format');
+				break;
+			case 'time_format':
+				$date_time_format = get_option('date_format') . ' ' . $value;
+				break;
+			default:
+				$date_time_format = false;
+		}
+		// do we have a date_time format to check ?
+		if ($date_time_format) {
+			$error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
+
+			if (is_array($error_msg)) {
+				$msg = '<p>'
+					   . sprintf(
+						   esc_html__(
+							   'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
+							   'event_espresso'
+						   ),
+						   date($date_time_format),
+						   $date_time_format
+					   )
+					   . '</p><p><ul>';
+
+
+				foreach ($error_msg as $error) {
+					$msg .= '<li>' . $error . '</li>';
+				}
+
+				$msg .= '</ul></p><p>'
+						. sprintf(
+							esc_html__(
+								'%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
+								'event_espresso'
+							),
+							'<span style="color:#D54E21;">',
+							'</span>'
+						)
+						. '</p>';
+
+				// trigger WP settings error
+				add_settings_error(
+					'date_format',
+					'date_format',
+					$msg
+				);
+
+				// set format to something valid
+				switch ($option) {
+					case 'date_format':
+						$value = 'F j, Y';
+						break;
+					case 'time_format':
+						$value = 'g:i a';
+						break;
+				}
+			}
+		}
+		return $value;
+	}
+
+
+	/**
+	 * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
+	 *
+	 * @param $content
+	 * @return    string
+	 */
+	public function its_eSpresso($content)
+	{
+		return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
+	}
+
+
+	/**
+	 * espresso_admin_footer
+	 *
+	 * @return    string
+	 */
+	public function espresso_admin_footer()
+	{
+		return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
+	}
+
+
+	/**
+	 * static method for registering ee admin page.
+	 * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
+	 *
+	 * @since      4.3.0
+	 * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
+	 * @see        EE_Register_Admin_Page::register()
+	 * @param       $page_basename
+	 * @param       $page_path
+	 * @param array $config
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_ee_admin_page($page_basename, $page_path, $config = array())
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
+					'event_espresso'
+				),
+				$page_basename
+			),
+			'4.3'
+		);
+		if (class_exists('EE_Register_Admin_Page')) {
+			$config['page_path'] = $page_path;
+		}
+		EE_Register_Admin_Page::register($page_basename, $config);
+	}
+
+
+	/**
+	 * @deprecated 4.8.41
+	 * @param  int      $post_ID
+	 * @param  \WP_Post $post
+	 * @return void
+	 */
+	public static function parse_post_content_on_save($post_ID, $post)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.8.41
+	 * @param  $option
+	 * @param  $old_value
+	 * @param  $value
+	 * @return void
+	 */
+	public function reset_page_for_posts_on_change($option, $old_value, $value)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @return void
+	 */
+	public function get_persistent_admin_notices()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	public function dismiss_ee_nag_notice_callback()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+		$this->persistent_admin_notice_manager->dismissNotice();
+	}
+
+
+	/**
+	 * Callback on load-plugins.php hook for setting up anything hooking into the wp plugins page.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function hookIntoWpPluginsPage()
+	{
+		$this->getLoader()->getShared('EventEspresso\core\domain\services\admin\ExitModal');
+		$this->getLoader()
+					 ->getShared('EventEspresso\core\domain\services\admin\PluginUpsells')
+					 ->decafUpsells();
+	}
+
+
+	/**
+	 * Hooks into the "post states" filter in a wp post type list table.
+	 *
+	 * @param array   $post_states
+	 * @param WP_Post $post
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function displayStateForCriticalPages($post_states, $post)
+	{
+		$post_states = (array) $post_states;
+		if (! $post instanceof WP_Post || $post->post_type !== 'page') {
+			return $post_states;
+		}
+		/** @var EE_Core_Config $config */
+		$config = $this->getLoader()->getShared('EE_Config')->core;
+		if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
+			$post_states[] = sprintf(
+				/* Translators: Using company name - Event Espresso Critical Page */
+				esc_html__('%s Critical Page', 'event_espresso'),
+				'Event Espresso'
+			);
+		}
+		return $post_states;
+	}
+
+
+	/**
+	 * Show documentation links on the plugins page
+	 *
+	 * @param mixed $meta Plugin Row Meta
+	 * @param mixed $file Plugin Base file
+	 * @return array
+	 */
+	public function addLinksToPluginRowMeta($meta, $file)
+	{
+		if (EE_PLUGIN_BASENAME === $file) {
+			$row_meta = array(
+				'docs' => '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4"'
+						  . ' aria-label="'
+						  . esc_attr__('View Event Espresso documentation', 'event_espresso')
+						  . '">'
+						  . esc_html__('Docs', 'event_espresso')
+						  . '</a>',
+				'api'  => '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API"'
+						  . ' aria-label="'
+						  . esc_attr__('View Event Espresso API docs', 'event_espresso')
+						  . '">'
+						  . esc_html__('API docs', 'event_espresso')
+						  . '</a>',
+			);
+			return array_merge($meta, $row_meta);
+		}
+		return (array) $meta;
+	}
 }

core/libraries/rest_api/ModelDataTranslator.php

Unused Use Statements -4 removed lines

@@ -4,14 +4,10 @@
 
 use DomainException;
 use EE_Boolean_Field;
-use EE_Capabilities;
 use EE_Datetime_Field;
 use EE_Error;
 use EE_Infinite_Integer_Field;
-use EE_Maybe_Serialized_Simple_HTML_Field;
 use EE_Model_Field_Base;
-use EE_Password_Field;
-use EE_Restriction_Generator_Base;
 use EE_Serialized_Text_Field;
 use EED_Core_Rest_Api;
 use EEM_Base;

Indentation +642 added lines, -642 removed lines

@@ -39,646 +39,646 @@
 class ModelDataTranslator
 {
 
-    /**
-     * We used to use -1 for infinity in the rest api, but that's ambiguous for
-     * fields that COULD contain -1; so we use null
-     */
-    const EE_INF_IN_REST = null;
-
-
-    /**
-     * Prepares a possible array of input values from JSON for use by the models
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value_maybe_array
-     * @param string              $requested_version
-     * @param string              $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws RestException
-     */
-    public static function prepareFieldValuesFromJson(
-        $field_obj,
-        $original_value_maybe_array,
-        $requested_version,
-        $timezone_string = 'UTC'
-    ) {
-        if (is_array($original_value_maybe_array)
-            && ! $field_obj instanceof EE_Serialized_Text_Field
-        ) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson(
-                    $field_obj,
-                    $array_item,
-                    $requested_version,
-                    $timezone_string
-                );
-            }
-        } else {
-            $new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
-                $field_obj,
-                $original_value_maybe_array,
-                $requested_version,
-                $timezone_string
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-    /**
-     * Prepares an array of field values FOR use in JSON/REST API
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value_maybe_array
-     * @param string              $request_version (eg 4.8.36)
-     * @return array
-     */
-    public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
-    {
-        if (is_array($original_value_maybe_array)) {
-            $new_value = array();
-            foreach ($original_value_maybe_array as $key => $value) {
-                $new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson(
-                    $field_obj,
-                    $value,
-                    $request_version
-                );
-            }
-        } else {
-            $new_value = ModelDataTranslator::prepareFieldValueForJson(
-                $field_obj,
-                $original_value_maybe_array,
-                $request_version
-            );
-        }
-        return $new_value;
-    }
-
-
-    /**
-     * Prepares incoming data from the json or $_REQUEST parameters for the models'
-     * "$query_params".
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value
-     * @param string              $requested_version
-     * @param string              $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws RestException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function prepareFieldValueFromJson(
-        $field_obj,
-        $original_value,
-        $requested_version,
-        $timezone_string = 'UTC' // UTC
-    ) {
-        // check if they accidentally submitted an error value. If so throw an exception
-        if (is_array($original_value)
-            && isset($original_value['error_code'], $original_value['error_message'])) {
-            throw new RestException(
-                'rest_submitted_error_value',
-                sprintf(
-                    esc_html__(
-                        'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
-                        'event_espresso'
-                    ),
-                    $field_obj->get_name()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-        // double-check for serialized PHP. We never accept serialized PHP. No way Jose.
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
-        $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
-        $new_value = null;
-        // walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
-        // way Jose.
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
-        if ($field_obj instanceof EE_Infinite_Integer_Field
-            && in_array($original_value, array(null, ''), true)
-        ) {
-            $new_value = EE_INF;
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
-            $new_value = rest_parse_date(
-                self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string)
-            );
-            if ($new_value === false) {
-                throw new RestException(
-                    'invalid_format_for_timestamp',
-                    sprintf(
-                        esc_html__(
-                            'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format.  The timestamp provided (%3$s) is not that format.',
-                            'event_espresso'
-                        ),
-                        'RFC3339',
-                        'ISO8601',
-                        $original_value
-                    ),
-                    array(
-                        'status' => 400,
-                    )
-                );
-            }
-        } elseif ($field_obj instanceof EE_Boolean_Field) {
-            // Interpreted the strings "false", "true", "on", "off" appropriately.
-            $new_value = filter_var($original_value, FILTER_VALIDATE_BOOLEAN);
-        } else {
-            $new_value = $original_value;
-        }
-        return $new_value;
-    }
-
-
-    /**
-     * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone
-     * information via details obtained from the host site.
-     *
-     * @param string            $original_timestamp
-     * @param EE_Datetime_Field $datetime_field
-     * @param                   $timezone_string
-     * @return string
-     * @throws DomainException
-     */
-    private static function getTimestampWithTimezoneOffset(
-        $original_timestamp,
-        EE_Datetime_Field $datetime_field,
-        $timezone_string
-    ) {
-        // already have timezone information?
-        if (preg_match('/Z|(\+|\-)(\d{2}:\d{2})/', $original_timestamp)) {
-            // yes, we're ignoring the timezone.
-            return $original_timestamp;
-        }
-        // need to append timezone
-        list($offset_sign, $offset_secs) = self::parseTimezoneOffset(
-            $datetime_field->get_timezone_offset(
-                new \DateTimeZone($timezone_string),
-                $original_timestamp
-            )
-        );
-        $offset_string =
-            str_pad(
-                floor($offset_secs / HOUR_IN_SECONDS),
-                2,
-                '0',
-                STR_PAD_LEFT
-            )
-            . ':'
-            . str_pad(
-                ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
-                2,
-                '0',
-                STR_PAD_LEFT
-            );
-        return $original_timestamp . $offset_sign . $offset_string;
-    }
-
-
-    /**
-     * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
-     * think that can happen). If $data is an array, recurses into its keys and values
-     *
-     * @param mixed $data
-     * @throws RestException
-     * @return void
-     */
-    public static function throwExceptionIfContainsSerializedData($data)
-    {
-        if (is_array($data)) {
-            foreach ($data as $key => $value) {
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
-            }
-        } else {
-            if (is_serialized($data) || is_object($data)) {
-                throw new RestException(
-                    'serialized_data_submission_prohibited',
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * determines what's going on with them timezone strings
-     *
-     * @param int $timezone_offset
-     * @return array
-     */
-    private static function parseTimezoneOffset($timezone_offset)
-    {
-        $first_char = substr((string) $timezone_offset, 0, 1);
-        if ($first_char === '+' || $first_char === '-') {
-            $offset_sign = $first_char;
-            $offset_secs = substr((string) $timezone_offset, 1);
-        } else {
-            $offset_sign = '+';
-            $offset_secs = $timezone_offset;
-        }
-        return array($offset_sign, $offset_secs);
-    }
-
-
-    /**
-     * Prepares a field's value for display in the API
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value
-     * @param string              $requested_version
-     * @return mixed
-     */
-    public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
-    {
-        if ($original_value === EE_INF) {
-            $new_value = ModelDataTranslator::EE_INF_IN_REST;
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
-            if (is_string($original_value)) {
-                // did they submit a string of a unix timestamp?
-                if (is_numeric($original_value)) {
-                    $datetime_obj = new \DateTime();
-                    $datetime_obj->setTimestamp((int) $original_value);
-                } else {
-                    // first, check if its a MySQL timestamp in GMT
-                    $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
-                }
-                if (! $datetime_obj instanceof \DateTime) {
-                    // so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
-                    $datetime_obj = $field_obj->prepare_for_set($original_value);
-                }
-                $original_value = $datetime_obj;
-            }
-            if ($original_value instanceof \DateTime) {
-                $new_value = $original_value->format('Y-m-d H:i:s');
-            } elseif (is_int($original_value) || is_float($original_value)) {
-                $new_value = date('Y-m-d H:i:s', $original_value);
-            } elseif ($original_value === null || $original_value === '') {
-                $new_value = null;
-            } else {
-                // so it's not a datetime object, unix timestamp (as string or int),
-                // MySQL timestamp, or even a string in the field object's format. So no idea what it is
-                throw new \EE_Error(
-                    sprintf(
-                        esc_html__(
-                        // @codingStandardsIgnoreStart
-                            'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                        $original_value,
-                        $field_obj->get_name(),
-                        $field_obj->get_model_name(),
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
-                    )
-                );
-            }
-            if ($new_value !== null) {
-                $new_value = mysql_to_rfc3339($new_value);
-            }
-        } else {
-            $new_value = $original_value;
-        }
-        // are we about to send an object? just don't. We have no good way to represent it in JSON.
-        // can't just check using is_object() because that missed PHP incomplete objects
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
-            $new_value = array(
-                'error_code'    => 'php_object_not_return',
-                'error_message' => esc_html__(
-                    'The value of this field in the database is a PHP object, which can\'t be represented in JSON.',
-                    'event_espresso'
-                ),
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            $new_value,
-            $field_obj,
-            $original_value,
-            $requested_version
-        );
-    }
-
-
-    /**
-     * Prepares condition-query-parameters (like what's in where and having) from
-     * the format expected in the API to use in the models
-     *
-     * @param array $inputted_query_params_of_this_type
-     * @param EEM_Base $model
-     * @param string $requested_version
-     * @param boolean $writing whether this data will be written to the DB, or if we're just building a query.
-     *                          If we're writing to the DB, we don't expect any operators, or any logic query
-     *                          parameters, and we also won't accept serialized data unless the current user has
-     *                          unfiltered_html.
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RestException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function prepareConditionsQueryParamsForModels(
-        $inputted_query_params_of_this_type,
-        EEM_Base $model,
-        $requested_version,
-        $writing = false
-    ) {
-        $query_param_for_models = array();
-        $context = new RestIncomingQueryParamContext($model, $requested_version, $writing);
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $query_param_meta = new RestIncomingQueryParamMetadata($query_param_key, $query_param_value, $context);
-            if ($query_param_meta->getField() instanceof EE_Model_Field_Base) {
-                $translated_value = $query_param_meta->determineConditionsQueryParameterValue();
-                if ((isset($query_param_for_models[ $query_param_meta->getQueryParamKey() ]) && $query_param_meta->isGmtField())
-                    || $translated_value === null
-                ) {
-                    // they have already provided a non-gmt field, ignore the gmt one. That's what WP core
-                    // currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
-                    // OR we couldn't create a translated value from their input
-                    continue;
-                }
-                $query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $translated_value;
-            } else {
-                $nested_query_params = $query_param_meta->determineNestedConditionQueryParameters();
-                if ($nested_query_params) {
-                    $query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $nested_query_params;
-                }
-            }
-        }
-        return $query_param_for_models;
-    }
-
-    /**
-     * Mostly checks if the last 4 characters are "_gmt", indicating its a
-     * gmt date field name
-     *
-     * @param string $field_name
-     * @return boolean
-     */
-    public static function isGmtDateFieldName($field_name)
-    {
-        return substr(
-            ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name),
-            -4,
-            4
-        ) === '_gmt';
-    }
-
-
-    /**
-     * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function removeGmtFromFieldName($field_name)
-    {
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
-            return $field_name;
-        }
-        $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-            $field_name
-        );
-        $query_param_sans_gmt_and_sans_stars = substr(
-            $query_param_sans_stars,
-            0,
-            strrpos(
-                $field_name,
-                '_gmt'
-            )
-        );
-        return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
-    }
-
-
-    /**
-     * Takes a field name from the REST API and prepares it for the model querying
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function prepareFieldNameFromJson($field_name)
-    {
-        if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
-            return ModelDataTranslator::removeGmtFromFieldName($field_name);
-        }
-        return $field_name;
-    }
-
-
-    /**
-     * Takes array of field names from REST API and prepares for models
-     *
-     * @param array $field_names
-     * @return array of field names (possibly include model prefixes)
-     */
-    public static function prepareFieldNamesFromJson(array $field_names)
-    {
-        $new_array = array();
-        foreach ($field_names as $key => $field_name) {
-            $new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
-        }
-        return $new_array;
-    }
-
-
-    /**
-     * Takes array where array keys are field names (possibly with model path prefixes)
-     * from the REST API and prepares them for model querying
-     *
-     * @param array $field_names_as_keys
-     * @return array
-     */
-    public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
-    {
-        $new_array = array();
-        foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value;
-        }
-        return $new_array;
-    }
-
-
-    /**
-     * Prepares an array of model query params for use in the REST API
-     *
-     * @param array    $model_query_params
-     * @param EEM_Base $model
-     * @param string   $requested_version  eg "4.8.36". If null is provided, defaults to the latest release of the EE4
-     *                                     REST API
-     * @return array which can be passed into the EE4 REST API when querying a model resource
-     * @throws EE_Error
-     */
-    public static function prepareQueryParamsForRestApi(
-        array $model_query_params,
-        EEM_Base $model,
-        $requested_version = null
-    ) {
-        if ($requested_version === null) {
-            $requested_version = EED_Core_Rest_Api::latest_rest_api_version();
-        }
-        $rest_query_params = $model_query_params;
-        if (isset($model_query_params[0])) {
-            $rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                $model_query_params[0],
-                $model,
-                $requested_version
-            );
-            unset($rest_query_params[0]);
-        }
-        if (isset($model_query_params['having'])) {
-            $rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                $model_query_params['having'],
-                $model,
-                $requested_version
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
-            $rest_query_params,
-            $model_query_params,
-            $model,
-            $requested_version
-        );
-    }
-
-
-    /**
-     * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
-     *
-     * @param array    $inputted_query_params_of_this_type  eg like the "where" or "having" conditions query params
-     *                                                      @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @param EEM_Base $model
-     * @param string   $requested_version                   eg "4.8.36"
-     * @return array ready for use in the rest api query params
-     * @throws EE_Error
-     * @throws ObjectDetectedException if somehow a PHP object were in the query params' values,
-     *                                                      (which would be really unusual)
-     */
-    public static function prepareConditionsQueryParamsForRestApi(
-        $inputted_query_params_of_this_type,
-        EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = array();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
-                $model
-            );
-            if ($field instanceof EE_Model_Field_Base) {
-                // did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op = $query_param_value[0];
-                    $translated_value = array($op);
-                    if (isset($query_param_value[1])) {
-                        $value = $query_param_value[1];
-                        $translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
-                            $field,
-                            $value,
-                            $requested_version
-                        );
-                    }
-                } else {
-                    $translated_value = ModelDataTranslator::prepareFieldValueForJson(
-                        $field,
-                        $query_param_value,
-                        $requested_version
-                    );
-                }
-                $query_param_for_models[ $query_param_key ] = $translated_value;
-            } else {
-                // so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                    $query_param_value,
-                    $model,
-                    $requested_version
-                );
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-    /**
-     * @param $condition_query_param_key
-     * @return string
-     */
-    public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
-    {
-        $pos_of_star = strpos($condition_query_param_key, '*');
-        if ($pos_of_star === false) {
-            return $condition_query_param_key;
-        } else {
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
-            return $condition_query_param_sans_star;
-        }
-    }
-
-
-    /**
-     * Takes the input parameter and finds the model field that it indicates.
-     *
-     * @param string   $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @param EEM_Base $model
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
-    {
-        // ok, now proceed with deducing which part is the model's name, and which is the field's name
-        // which will help us find the database table and column
-        $query_param_parts = explode('.', $query_param_name);
-        if (empty($query_param_parts)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '_extract_column_name is empty when trying to extract column and table name from %s',
-                        'event_espresso'
-                    ),
-                    $query_param_name
-                )
-            );
-        }
-        $number_of_parts = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
-        if ($number_of_parts === 1) {
-            $field_name = $last_query_param_part;
-        } else {// $number_of_parts >= 2
-            // the last part is the column name, and there are only 2parts. therefore...
-            $field_name = $last_query_param_part;
-            $model = \EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]);
-        }
-        try {
-            return $model->field_settings_for($field_name, false);
-        } catch (EE_Error $e) {
-            return null;
-        }
-    }
-
-
-    /**
-     * Returns true if $data can be easily represented in JSON.
-     * Basically, objects and resources can't be represented in JSON easily.
-     *
-     * @param mixed $data
-     * @return bool
-     */
-    protected static function isRepresentableInJson($data)
-    {
-        return is_scalar($data)
-               || is_array($data)
-               || is_null($data);
-    }
+	/**
+	 * We used to use -1 for infinity in the rest api, but that's ambiguous for
+	 * fields that COULD contain -1; so we use null
+	 */
+	const EE_INF_IN_REST = null;
+
+
+	/**
+	 * Prepares a possible array of input values from JSON for use by the models
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value_maybe_array
+	 * @param string              $requested_version
+	 * @param string              $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws RestException
+	 */
+	public static function prepareFieldValuesFromJson(
+		$field_obj,
+		$original_value_maybe_array,
+		$requested_version,
+		$timezone_string = 'UTC'
+	) {
+		if (is_array($original_value_maybe_array)
+			&& ! $field_obj instanceof EE_Serialized_Text_Field
+		) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson(
+					$field_obj,
+					$array_item,
+					$requested_version,
+					$timezone_string
+				);
+			}
+		} else {
+			$new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
+				$field_obj,
+				$original_value_maybe_array,
+				$requested_version,
+				$timezone_string
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+	/**
+	 * Prepares an array of field values FOR use in JSON/REST API
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value_maybe_array
+	 * @param string              $request_version (eg 4.8.36)
+	 * @return array
+	 */
+	public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
+	{
+		if (is_array($original_value_maybe_array)) {
+			$new_value = array();
+			foreach ($original_value_maybe_array as $key => $value) {
+				$new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson(
+					$field_obj,
+					$value,
+					$request_version
+				);
+			}
+		} else {
+			$new_value = ModelDataTranslator::prepareFieldValueForJson(
+				$field_obj,
+				$original_value_maybe_array,
+				$request_version
+			);
+		}
+		return $new_value;
+	}
+
+
+	/**
+	 * Prepares incoming data from the json or $_REQUEST parameters for the models'
+	 * "$query_params".
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value
+	 * @param string              $requested_version
+	 * @param string              $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws RestException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function prepareFieldValueFromJson(
+		$field_obj,
+		$original_value,
+		$requested_version,
+		$timezone_string = 'UTC' // UTC
+	) {
+		// check if they accidentally submitted an error value. If so throw an exception
+		if (is_array($original_value)
+			&& isset($original_value['error_code'], $original_value['error_message'])) {
+			throw new RestException(
+				'rest_submitted_error_value',
+				sprintf(
+					esc_html__(
+						'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
+						'event_espresso'
+					),
+					$field_obj->get_name()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+		// double-check for serialized PHP. We never accept serialized PHP. No way Jose.
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
+		$timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
+		$new_value = null;
+		// walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
+		// way Jose.
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
+		if ($field_obj instanceof EE_Infinite_Integer_Field
+			&& in_array($original_value, array(null, ''), true)
+		) {
+			$new_value = EE_INF;
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
+			$new_value = rest_parse_date(
+				self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string)
+			);
+			if ($new_value === false) {
+				throw new RestException(
+					'invalid_format_for_timestamp',
+					sprintf(
+						esc_html__(
+							'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format.  The timestamp provided (%3$s) is not that format.',
+							'event_espresso'
+						),
+						'RFC3339',
+						'ISO8601',
+						$original_value
+					),
+					array(
+						'status' => 400,
+					)
+				);
+			}
+		} elseif ($field_obj instanceof EE_Boolean_Field) {
+			// Interpreted the strings "false", "true", "on", "off" appropriately.
+			$new_value = filter_var($original_value, FILTER_VALIDATE_BOOLEAN);
+		} else {
+			$new_value = $original_value;
+		}
+		return $new_value;
+	}
+
+
+	/**
+	 * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone
+	 * information via details obtained from the host site.
+	 *
+	 * @param string            $original_timestamp
+	 * @param EE_Datetime_Field $datetime_field
+	 * @param                   $timezone_string
+	 * @return string
+	 * @throws DomainException
+	 */
+	private static function getTimestampWithTimezoneOffset(
+		$original_timestamp,
+		EE_Datetime_Field $datetime_field,
+		$timezone_string
+	) {
+		// already have timezone information?
+		if (preg_match('/Z|(\+|\-)(\d{2}:\d{2})/', $original_timestamp)) {
+			// yes, we're ignoring the timezone.
+			return $original_timestamp;
+		}
+		// need to append timezone
+		list($offset_sign, $offset_secs) = self::parseTimezoneOffset(
+			$datetime_field->get_timezone_offset(
+				new \DateTimeZone($timezone_string),
+				$original_timestamp
+			)
+		);
+		$offset_string =
+			str_pad(
+				floor($offset_secs / HOUR_IN_SECONDS),
+				2,
+				'0',
+				STR_PAD_LEFT
+			)
+			. ':'
+			. str_pad(
+				($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
+				2,
+				'0',
+				STR_PAD_LEFT
+			);
+		return $original_timestamp . $offset_sign . $offset_string;
+	}
+
+
+	/**
+	 * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
+	 * think that can happen). If $data is an array, recurses into its keys and values
+	 *
+	 * @param mixed $data
+	 * @throws RestException
+	 * @return void
+	 */
+	public static function throwExceptionIfContainsSerializedData($data)
+	{
+		if (is_array($data)) {
+			foreach ($data as $key => $value) {
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
+			}
+		} else {
+			if (is_serialized($data) || is_object($data)) {
+				throw new RestException(
+					'serialized_data_submission_prohibited',
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * determines what's going on with them timezone strings
+	 *
+	 * @param int $timezone_offset
+	 * @return array
+	 */
+	private static function parseTimezoneOffset($timezone_offset)
+	{
+		$first_char = substr((string) $timezone_offset, 0, 1);
+		if ($first_char === '+' || $first_char === '-') {
+			$offset_sign = $first_char;
+			$offset_secs = substr((string) $timezone_offset, 1);
+		} else {
+			$offset_sign = '+';
+			$offset_secs = $timezone_offset;
+		}
+		return array($offset_sign, $offset_secs);
+	}
+
+
+	/**
+	 * Prepares a field's value for display in the API
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value
+	 * @param string              $requested_version
+	 * @return mixed
+	 */
+	public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
+	{
+		if ($original_value === EE_INF) {
+			$new_value = ModelDataTranslator::EE_INF_IN_REST;
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
+			if (is_string($original_value)) {
+				// did they submit a string of a unix timestamp?
+				if (is_numeric($original_value)) {
+					$datetime_obj = new \DateTime();
+					$datetime_obj->setTimestamp((int) $original_value);
+				} else {
+					// first, check if its a MySQL timestamp in GMT
+					$datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
+				}
+				if (! $datetime_obj instanceof \DateTime) {
+					// so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
+					$datetime_obj = $field_obj->prepare_for_set($original_value);
+				}
+				$original_value = $datetime_obj;
+			}
+			if ($original_value instanceof \DateTime) {
+				$new_value = $original_value->format('Y-m-d H:i:s');
+			} elseif (is_int($original_value) || is_float($original_value)) {
+				$new_value = date('Y-m-d H:i:s', $original_value);
+			} elseif ($original_value === null || $original_value === '') {
+				$new_value = null;
+			} else {
+				// so it's not a datetime object, unix timestamp (as string or int),
+				// MySQL timestamp, or even a string in the field object's format. So no idea what it is
+				throw new \EE_Error(
+					sprintf(
+						esc_html__(
+						// @codingStandardsIgnoreStart
+							'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+						$original_value,
+						$field_obj->get_name(),
+						$field_obj->get_model_name(),
+						$field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
+					)
+				);
+			}
+			if ($new_value !== null) {
+				$new_value = mysql_to_rfc3339($new_value);
+			}
+		} else {
+			$new_value = $original_value;
+		}
+		// are we about to send an object? just don't. We have no good way to represent it in JSON.
+		// can't just check using is_object() because that missed PHP incomplete objects
+		if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
+			$new_value = array(
+				'error_code'    => 'php_object_not_return',
+				'error_message' => esc_html__(
+					'The value of this field in the database is a PHP object, which can\'t be represented in JSON.',
+					'event_espresso'
+				),
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			$new_value,
+			$field_obj,
+			$original_value,
+			$requested_version
+		);
+	}
+
+
+	/**
+	 * Prepares condition-query-parameters (like what's in where and having) from
+	 * the format expected in the API to use in the models
+	 *
+	 * @param array $inputted_query_params_of_this_type
+	 * @param EEM_Base $model
+	 * @param string $requested_version
+	 * @param boolean $writing whether this data will be written to the DB, or if we're just building a query.
+	 *                          If we're writing to the DB, we don't expect any operators, or any logic query
+	 *                          parameters, and we also won't accept serialized data unless the current user has
+	 *                          unfiltered_html.
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function prepareConditionsQueryParamsForModels(
+		$inputted_query_params_of_this_type,
+		EEM_Base $model,
+		$requested_version,
+		$writing = false
+	) {
+		$query_param_for_models = array();
+		$context = new RestIncomingQueryParamContext($model, $requested_version, $writing);
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$query_param_meta = new RestIncomingQueryParamMetadata($query_param_key, $query_param_value, $context);
+			if ($query_param_meta->getField() instanceof EE_Model_Field_Base) {
+				$translated_value = $query_param_meta->determineConditionsQueryParameterValue();
+				if ((isset($query_param_for_models[ $query_param_meta->getQueryParamKey() ]) && $query_param_meta->isGmtField())
+					|| $translated_value === null
+				) {
+					// they have already provided a non-gmt field, ignore the gmt one. That's what WP core
+					// currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
+					// OR we couldn't create a translated value from their input
+					continue;
+				}
+				$query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $translated_value;
+			} else {
+				$nested_query_params = $query_param_meta->determineNestedConditionQueryParameters();
+				if ($nested_query_params) {
+					$query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $nested_query_params;
+				}
+			}
+		}
+		return $query_param_for_models;
+	}
+
+	/**
+	 * Mostly checks if the last 4 characters are "_gmt", indicating its a
+	 * gmt date field name
+	 *
+	 * @param string $field_name
+	 * @return boolean
+	 */
+	public static function isGmtDateFieldName($field_name)
+	{
+		return substr(
+			ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name),
+			-4,
+			4
+		) === '_gmt';
+	}
+
+
+	/**
+	 * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function removeGmtFromFieldName($field_name)
+	{
+		if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
+			return $field_name;
+		}
+		$query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+			$field_name
+		);
+		$query_param_sans_gmt_and_sans_stars = substr(
+			$query_param_sans_stars,
+			0,
+			strrpos(
+				$field_name,
+				'_gmt'
+			)
+		);
+		return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
+	}
+
+
+	/**
+	 * Takes a field name from the REST API and prepares it for the model querying
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function prepareFieldNameFromJson($field_name)
+	{
+		if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
+			return ModelDataTranslator::removeGmtFromFieldName($field_name);
+		}
+		return $field_name;
+	}
+
+
+	/**
+	 * Takes array of field names from REST API and prepares for models
+	 *
+	 * @param array $field_names
+	 * @return array of field names (possibly include model prefixes)
+	 */
+	public static function prepareFieldNamesFromJson(array $field_names)
+	{
+		$new_array = array();
+		foreach ($field_names as $key => $field_name) {
+			$new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
+		}
+		return $new_array;
+	}
+
+
+	/**
+	 * Takes array where array keys are field names (possibly with model path prefixes)
+	 * from the REST API and prepares them for model querying
+	 *
+	 * @param array $field_names_as_keys
+	 * @return array
+	 */
+	public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
+	{
+		$new_array = array();
+		foreach ($field_names_as_keys as $field_name => $value) {
+			$new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value;
+		}
+		return $new_array;
+	}
+
+
+	/**
+	 * Prepares an array of model query params for use in the REST API
+	 *
+	 * @param array    $model_query_params
+	 * @param EEM_Base $model
+	 * @param string   $requested_version  eg "4.8.36". If null is provided, defaults to the latest release of the EE4
+	 *                                     REST API
+	 * @return array which can be passed into the EE4 REST API when querying a model resource
+	 * @throws EE_Error
+	 */
+	public static function prepareQueryParamsForRestApi(
+		array $model_query_params,
+		EEM_Base $model,
+		$requested_version = null
+	) {
+		if ($requested_version === null) {
+			$requested_version = EED_Core_Rest_Api::latest_rest_api_version();
+		}
+		$rest_query_params = $model_query_params;
+		if (isset($model_query_params[0])) {
+			$rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+				$model_query_params[0],
+				$model,
+				$requested_version
+			);
+			unset($rest_query_params[0]);
+		}
+		if (isset($model_query_params['having'])) {
+			$rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+				$model_query_params['having'],
+				$model,
+				$requested_version
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
+			$rest_query_params,
+			$model_query_params,
+			$model,
+			$requested_version
+		);
+	}
+
+
+	/**
+	 * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
+	 *
+	 * @param array    $inputted_query_params_of_this_type  eg like the "where" or "having" conditions query params
+	 *                                                      @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @param EEM_Base $model
+	 * @param string   $requested_version                   eg "4.8.36"
+	 * @return array ready for use in the rest api query params
+	 * @throws EE_Error
+	 * @throws ObjectDetectedException if somehow a PHP object were in the query params' values,
+	 *                                                      (which would be really unusual)
+	 */
+	public static function prepareConditionsQueryParamsForRestApi(
+		$inputted_query_params_of_this_type,
+		EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = array();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$field = ModelDataTranslator::deduceFieldFromQueryParam(
+				ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
+				$model
+			);
+			if ($field instanceof EE_Model_Field_Base) {
+				// did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op = $query_param_value[0];
+					$translated_value = array($op);
+					if (isset($query_param_value[1])) {
+						$value = $query_param_value[1];
+						$translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
+							$field,
+							$value,
+							$requested_version
+						);
+					}
+				} else {
+					$translated_value = ModelDataTranslator::prepareFieldValueForJson(
+						$field,
+						$query_param_value,
+						$requested_version
+					);
+				}
+				$query_param_for_models[ $query_param_key ] = $translated_value;
+			} else {
+				// so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[ $query_param_key ] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+					$query_param_value,
+					$model,
+					$requested_version
+				);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+	/**
+	 * @param $condition_query_param_key
+	 * @return string
+	 */
+	public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
+	{
+		$pos_of_star = strpos($condition_query_param_key, '*');
+		if ($pos_of_star === false) {
+			return $condition_query_param_key;
+		} else {
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
+			return $condition_query_param_sans_star;
+		}
+	}
+
+
+	/**
+	 * Takes the input parameter and finds the model field that it indicates.
+	 *
+	 * @param string   $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @param EEM_Base $model
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
+	{
+		// ok, now proceed with deducing which part is the model's name, and which is the field's name
+		// which will help us find the database table and column
+		$query_param_parts = explode('.', $query_param_name);
+		if (empty($query_param_parts)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'_extract_column_name is empty when trying to extract column and table name from %s',
+						'event_espresso'
+					),
+					$query_param_name
+				)
+			);
+		}
+		$number_of_parts = count($query_param_parts);
+		$last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
+		if ($number_of_parts === 1) {
+			$field_name = $last_query_param_part;
+		} else {// $number_of_parts >= 2
+			// the last part is the column name, and there are only 2parts. therefore...
+			$field_name = $last_query_param_part;
+			$model = \EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]);
+		}
+		try {
+			return $model->field_settings_for($field_name, false);
+		} catch (EE_Error $e) {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Returns true if $data can be easily represented in JSON.
+	 * Basically, objects and resources can't be represented in JSON easily.
+	 *
+	 * @param mixed $data
+	 * @return bool
+	 */
+	protected static function isRepresentableInJson($data)
+	{
+		return is_scalar($data)
+			   || is_array($data)
+			   || is_null($data);
+	}
 }

espresso.php

Indentation +80 added lines, -80 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.4.0');
-    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.4.0');
+	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.79.rc.012');
-        }
+		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.79.rc.012');
+		}
 
-        /**
-         * 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);
+	}
 }