eventespresso / event-espresso-core

core/db_models/EEM_Datetime.model.php

Indentation +581 added lines, -581 removed lines

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

admin_pages/messages/Messages_Admin_Page.core.php

Spacing +119 added lines, -119 removed lines

@@ -87,7 +87,7 @@ 
         $this->_admin_base_url  = EE_MSG_ADMIN_URL;
         $this->_admin_base_path = EE_MSG_ADMIN;
         
-        $this->_activate_state = isset($this->_req_data['activate_state']) ? (array)$this->_req_data['activate_state'] : array();
+        $this->_activate_state = isset($this->_req_data['activate_state']) ? (array) $this->_req_data['activate_state'] : array();
         
         $this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
         $this->_load_message_resource_manager();
@@ -219,7 +219,7 @@ 
             array('none_selected' => __('Show All Messengers', 'event_espresso')),
             $messenger_options
         );
-        $input             = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $messenger_options,
             array(
                 'html_name'  => 'ee_messenger_filter_by',
@@ -257,7 +257,7 @@ 
             array('none_selected' => __('Show All Message Types', 'event_espresso')),
             $message_type_options
         );
-        $input                = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $message_type_options,
             array(
                 'html_name'  => 'ee_message_type_filter_by',
@@ -295,7 +295,7 @@ 
             array('none_selected' => __('Show all Contexts', 'event_espresso')),
             $context_options
         );
-        $input           = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $context_options,
             array(
                 'html_name'  => 'ee_context_filter_by',
@@ -676,47 +676,47 @@ 
     
     public function messages_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_help_tab.template.php');
     }
     
     
     public function messengers_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messenger_help_tab.template.php');
     }
     
     
     public function message_types_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_message_type_help_tab.template.php');
     }
     
     
     public function messages_overview_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_overview_help_tab.template.php');
     }
     
     
     public function message_templates_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_message_templates_help_tab.template.php');
     }
     
     
     public function edit_message_template_help_tab()
     {
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="' . esc_attr__('Editor Title',
-                'event_espresso') . '" />';
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="' . esc_attr__('Context Switcher and Preview',
-                'event_espresso') . '" />';
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="' . esc_attr__('Message Template Form Fields',
-                'event_espresso') . '" />';
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="' . esc_attr__('Shortcodes Metabox',
-                'event_espresso') . '" />';
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="' . esc_attr__('Publish Metabox',
-                'event_espresso') . '" />';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
+        $args['img1'] = '<img src="'.EE_MSG_ASSETS_URL.'images/editor.png'.'" alt="'.esc_attr__('Editor Title',
+                'event_espresso').'" />';
+        $args['img2'] = '<img src="'.EE_MSG_ASSETS_URL.'images/switch-context.png'.'" alt="'.esc_attr__('Context Switcher and Preview',
+                'event_espresso').'" />';
+        $args['img3'] = '<img class="left" src="'.EE_MSG_ASSETS_URL.'images/form-fields.png'.'" alt="'.esc_attr__('Message Template Form Fields',
+                'event_espresso').'" />';
+        $args['img4'] = '<img class="right" src="'.EE_MSG_ASSETS_URL.'images/shortcodes-metabox.png'.'" alt="'.esc_attr__('Shortcodes Metabox',
+                'event_espresso').'" />';
+        $args['img5'] = '<img class="right" src="'.EE_MSG_ASSETS_URL.'images/publish-meta-box.png'.'" alt="'.esc_attr__('Publish Metabox',
+                'event_espresso').'" />';
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_templates_editor_help_tab.template.php',
             $args);
     }
     
@@ -725,37 +725,37 @@ 
     {
         $this->_set_shortcodes();
         $args['shortcodes'] = $this->_shortcodes;
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_shortcodes_help_tab.template.php',
             $args);
     }
     
     
     public function preview_message_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_preview_help_tab.template.php');
     }
     
     
     public function settings_help_tab()
     {
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '" alt="' . esc_attr__('Active Email Tab',
-                'event_espresso') . '" />';
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png' . '" alt="' . esc_attr__('Inactive Email Tab',
-                'event_espresso') . '" />';
+        $args['img1'] = '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-active.png'.'" alt="'.esc_attr__('Active Email Tab',
+                'event_espresso').'" />';
+        $args['img2'] = '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-inactive.png'.'" alt="'.esc_attr__('Inactive Email Tab',
+                'event_espresso').'" />';
         $args['img3'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked"><label for="ee-on-off-toggle-on"></label>';
         $args['img4'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox"><label for="ee-on-off-toggle-on"></label>';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_settings_help_tab.template.php', $args);
     }
     
     
     public function load_scripts_styles()
     {
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
+        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL.'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso_ee_msg');
         
-        wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
+        wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL.'ee-messages-settings.js',
             array('jquery-ui-droppable', 'ee-serialize-full-array'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
+        wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL.'ee_message_admin_list_table.js',
             array('ee-dialog'), EVENT_ESPRESSO_VERSION);
     }
     
@@ -787,7 +787,7 @@ 
         
         $this->_set_shortcodes();
         
-        EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
+        EE_Registry::$i18n_js_strings['confirm_default_reset'] = sprintf(
             __('Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
                 'event_espresso'),
             $this->_message_template_group->messenger_obj()->label['singular'],
@@ -796,7 +796,7 @@ 
         EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = __('Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
             'event_espresso');
         
-        wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL . 'ee_message_editor.js', array('jquery'),
+        wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL.'ee_message_editor.js', array('jquery'),
             EVENT_ESPRESSO_VERSION);
         
         wp_enqueue_script('ee_admin_js');
@@ -827,7 +827,7 @@ 
     
     public function load_scripts_styles_settings()
     {
-        wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL . 'ee_message_settings.css', array(),
+        wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL.'ee_message_settings.css', array(),
             EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('ee-text-links');
         wp_enqueue_style('ee-message-settings');
@@ -893,7 +893,7 @@ 
             }
             $status_bulk_actions = $common_bulk_actions;
             //unset bulk actions not applying to status
-            if (! empty($status_bulk_actions)) {
+            if ( ! empty($status_bulk_actions)) {
                 switch ($status) {
                     case EEM_Message::status_idle:
                     case EEM_Message::status_resend:
@@ -918,7 +918,7 @@ 
             }
 
             //skip adding messenger executing status to views because it will be included with the Failed view.
-            if ( $status === EEM_Message::status_messenger_executing ) {
+            if ($status === EEM_Message::status_messenger_executing) {
                 continue;
             }
             
@@ -944,7 +944,7 @@ 
         $this->_search_btn_label                   = __('Message Activity', 'event_espresso');
         $this->_template_args['per_column']        = 6;
         $this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
-        $this->_template_args['before_list_table'] = '<h3>' . EEM_Message::instance()->get_pretty_label_for_results() . '</h3>';
+        $this->_template_args['before_list_table'] = '<h3>'.EEM_Message::instance()->get_pretty_label_for_results().'</h3>';
         $this->display_admin_list_table_page_with_no_sidebar();
     }
     
@@ -968,37 +968,37 @@ 
         /** @type array $status_items status legend setup */
         $status_items = array(
             'sent_status'       => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_sent,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence')
             ),
             'idle_status'       => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_idle,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence')
             ),
             'failed_status'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_failed,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence')
             ),
             'messenger_executing_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_messenger_executing,
                 'desc' => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence')
             ),
             'resend_status'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_resend,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence')
             ),
             'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_incomplete,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence')
             ),
             'retry_status'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_retry,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence')
             )
         );
         if (EEM_Message::debug()) {
             $status_items['debug_only_status'] = array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_debug_only,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence')
             );
         }
@@ -1010,10 +1010,10 @@ 
     protected function _custom_mtps_preview()
     {
         $this->_admin_page_title              = __('Custom Message Templates (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png" alt="' . esc_attr__('Preview Custom Message Templates screenshot',
-                'event_espresso') . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . __('Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
-                'event_espresso') . '</strong>';
+        $this->_template_args['preview_img']  = '<img src="'.EE_MSG_ASSETS_URL.'images/custom_mtps_preview.png" alt="'.esc_attr__('Preview Custom Message Templates screenshot',
+                'event_espresso').'" />';
+        $this->_template_args['preview_text'] = '<strong>'.__('Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
+                'event_espresso').'</strong>';
         $this->display_admin_caf_preview_page('custom_message_types', false);
     }
     
@@ -1261,7 +1261,7 @@ 
                             //let's verify if we need this extra field via the shortcodes parameter.
                             $continue = false;
                             if (isset($extra_array['shortcodes_required'])) {
-                                foreach ((array)$extra_array['shortcodes_required'] as $shortcode) {
+                                foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
                                     if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
                                         $continue = true;
                                     }
@@ -1271,9 +1271,9 @@ 
                                 }
                             }
                             
-                            $field_id                                = $reference_field . '-' . $extra_field . '-content';
+                            $field_id                                = $reference_field.'-'.$extra_field.'-content';
                             $template_form_fields[$field_id]         = $extra_array;
-                            $template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $reference_field . '][content][' . $extra_field . ']';
+                            $template_form_fields[$field_id]['name'] = 'MTP_template_fields['.$reference_field.'][content]['.$extra_field.']';
                             $css_class                               = isset($extra_array['css_class']) ? $extra_array['css_class'] : '';
                             
                             $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
@@ -1283,7 +1283,7 @@ 
                                                                                 is_array($validators[$extra_field])
                                                                                 && isset($validators[$extra_field]['msg'])
                                                                             )
-                                ? 'validate-error ' . $css_class
+                                ? 'validate-error '.$css_class
                                 : $css_class;
                             
                             $template_form_fields[$field_id]['value'] = ! empty($message_templates) && isset($content[$extra_field])
@@ -1311,11 +1311,11 @@ 
                                 
                             }/**/
                         }
-                        $templatefield_MTP_id          = $reference_field . '-MTP_ID';
-                        $templatefield_templatename_id = $reference_field . '-name';
+                        $templatefield_MTP_id          = $reference_field.'-MTP_ID';
+                        $templatefield_templatename_id = $reference_field.'-name';
                         
                         $template_form_fields[$templatefield_MTP_id] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
+                            'name'       => 'MTP_template_fields['.$reference_field.'][MTP_ID]',
                             'label'      => null,
                             'input'      => 'hidden',
                             'type'       => 'int',
@@ -1328,7 +1328,7 @@ 
                         );
                         
                         $template_form_fields[$templatefield_templatename_id] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
+                            'name'       => 'MTP_template_fields['.$reference_field.'][name]',
                             'label'      => null,
                             'input'      => 'hidden',
                             'type'       => 'string',
@@ -1342,9 +1342,9 @@ 
                     }
                     continue; //skip the next stuff, we got the necessary fields here for this dataset.
                 } else {
-                    $field_id                                 = $template_field . '-content';
+                    $field_id                                 = $template_field.'-content';
                     $template_form_fields[$field_id]          = $field_setup_array;
-                    $template_form_fields[$field_id]['name']  = 'MTP_template_fields[' . $template_field . '][content]';
+                    $template_form_fields[$field_id]['name']  = 'MTP_template_fields['.$template_field.'][content]';
                     $message_template                         = isset($message_templates[$context][$template_field])
                         ? $message_templates[$context][$template_field]
                         : null;
@@ -1365,7 +1365,7 @@ 
                     $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
                                                                     && in_array($template_field, $v_fields)
                                                                     && isset($validators[$template_field]['msg'])
-                        ? 'validate-error ' . $css_class
+                        ? 'validate-error '.$css_class
                         : $css_class;
                     
                     //shortcode selector
@@ -1376,12 +1376,12 @@ 
                 
                 //k took care of content field(s) now let's take care of others.
                 
-                $templatefield_MTP_id                = $template_field . '-MTP_ID';
-                $templatefield_field_templatename_id = $template_field . '-name';
+                $templatefield_MTP_id                = $template_field.'-MTP_ID';
+                $templatefield_field_templatename_id = $template_field.'-name';
                 
                 //foreach template field there are actually two form fields created
                 $template_form_fields[$templatefield_MTP_id] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
+                    'name'       => 'MTP_template_fields['.$template_field.'][MTP_ID]',
                     'label'      => null,
                     'input'      => 'hidden',
                     'type'       => 'int',
@@ -1394,7 +1394,7 @@ 
                 );
                 
                 $template_form_fields[$templatefield_field_templatename_id] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
+                    'name'       => 'MTP_template_fields['.$template_field.'][name]',
                     'label'      => null,
                     'input'      => 'hidden',
                     'type'       => 'string',
@@ -1512,7 +1512,7 @@ 
                 'format'     => '%d',
                 'db-col'     => 'MTP_deleted'
             );
-            $sidebar_form_fields['ee-msg-author']  = array(
+            $sidebar_form_fields['ee-msg-author'] = array(
                 'name'       => 'MTP_user_id',
                 'label'      => __('Author', 'event_espresso'),
                 'input'      => 'hidden',
@@ -1531,17 +1531,17 @@ 
                 'value' => $action
             );
             
-            $sidebar_form_fields['ee-msg-id']        = array(
+            $sidebar_form_fields['ee-msg-id'] = array(
                 'name'  => 'id',
                 'input' => 'hidden',
                 'type'  => 'int',
                 'value' => $GRP_ID
             );
             $sidebar_form_fields['ee-msg-evt-nonce'] = array(
-                'name'  => $action . '_nonce',
+                'name'  => $action.'_nonce',
                 'input' => 'hidden',
                 'type'  => 'string',
-                'value' => wp_create_nonce($action . '_nonce')
+                'value' => wp_create_nonce($action.'_nonce')
             );
             
             if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
@@ -1573,7 +1573,7 @@ 
         );
         
         //add preview button
-        $preview_url    = parent::add_query_args_and_nonce(
+        $preview_url = parent::add_query_args_and_nonce(
             array(
                 'message_type' => $message_template_group->message_type(),
                 'messenger'    => $message_template_group->messenger(),
@@ -1583,8 +1583,8 @@ 
             ),
             $this->_admin_base_url
         );
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">' . __('Preview',
-                'event_espresso') . '</a>';
+        $preview_button = '<a href="'.$preview_url.'" class="button-secondary messages-preview-button">'.__('Preview',
+                'event_espresso').'</a>';
         
         
         //setup context switcher
@@ -1612,8 +1612,8 @@ 
         $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
         
         $this->_template_path = $this->_template_args['GRP_ID']
-            ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
+            ? EE_MSG_TEMPLATE_PATH.'ee_msg_details_main_edit_meta_box.template.php'
+            : EE_MSG_TEMPLATE_PATH.'ee_msg_details_main_add_meta_box.template.php';
         
         //send along EE_Message_Template_Group object for further template use.
         $this->_template_args['MTP'] = $message_template_group;
@@ -1648,7 +1648,7 @@ 
     
     public function _add_form_element_before()
     {
-        return '<form method="post" action="' . $this->_template_args["edit_message_template_form_url"] . '" id="ee-msg-edit-frm">';
+        return '<form method="post" action="'.$this->_template_args["edit_message_template_form_url"].'" id="ee-msg-edit-frm">';
     }
     
     public function _add_form_element_after()
@@ -1843,14 +1843,14 @@ 
         }
         
         //let's add a button to go back to the edit view
-        $query_args             = array(
+        $query_args = array(
             'id'      => $this->_req_data['GRP_ID'],
             'context' => $this->_req_data['context'],
             'action'  => 'edit_message_template'
         );
         $go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        $preview_button         = '<a href="' . $go_back_url . '" class="button-secondary messages-preview-go-back-button">' . __('Go Back to Edit',
-                'event_espresso') . '</a>';
+        $preview_button         = '<a href="'.$go_back_url.'" class="button-secondary messages-preview-go-back-button">'.__('Go Back to Edit',
+                'event_espresso').'</a>';
         $message_types          = $this->get_installed_message_types();
         $active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
         $active_messenger_label = $active_messenger instanceof EE_messenger
@@ -1864,7 +1864,7 @@ 
         );
         //setup display of preview.
         $this->_admin_page_title                    = $preview_title;
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . stripslashes($preview);
+        $this->_template_args['admin_page_content'] = $preview_button.'<br />'.stripslashes($preview);
         $this->_template_args['data']['force_json'] = true;
         
         return '';
@@ -1946,7 +1946,7 @@ 
         }
         
         //setup variation select values for the currently selected template.
-        $variations               = $this->_message_template_group->get_template_pack()->get_variations(
+        $variations = $this->_message_template_group->get_template_pack()->get_variations(
             $this->_message_template_group->messenger(),
             $this->_message_template_group->message_type()
         );
@@ -1960,12 +1960,12 @@ 
         
         $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
         
-        $template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
+        $template_args['template_packs_selector'] = EEH_Form_Fields::select_input(
             'MTP_template_pack',
             $tp_select_values,
             $this->_message_template_group->get_template_pack_name()
         );
-        $template_args['variations_selector']            = EEH_Form_Fields::select_input(
+        $template_args['variations_selector'] = EEH_Form_Fields::select_input(
             'MTP_template_variation',
             $variations_select_values,
             $this->_message_template_group->get_template_pack_variation()
@@ -1975,7 +1975,7 @@ 
         $template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
         $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
         
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
+        $template = EE_MSG_TEMPLATE_PATH.'template_pack_and_variations_metabox.template.php';
         
         EEH_Template::display_template($template, $template_args);
     }
@@ -2004,7 +2004,7 @@ 
         if ( ! empty($fields)) {
             //yup there be fields
             foreach ($fields as $field => $config) {
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
+                $field_id = $this->_message_template_group->messenger().'_'.$field;
                 $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
                 $default  = isset($config['default']) ? $config['default'] : '';
                 $default  = isset($config['value']) ? $config['value'] : $default;
@@ -2019,7 +2019,7 @@ 
                     : $fix;
                 
                 $template_form_fields[$field_id] = array(
-                    'name'       => 'test_settings_fld[' . $field . ']',
+                    'name'       => 'test_settings_fld['.$field.']',
                     'label'      => $config['label'],
                     'input'      => $config['input'],
                     'type'       => $config['type'],
@@ -2049,7 +2049,7 @@ 
         }
         
         //and button
-        $test_settings_html .= '<p>' . __('Need to reset this message type and start over?', 'event_espresso') . '</p>';
+        $test_settings_html .= '<p>'.__('Need to reset this message type and start over?', 'event_espresso').'</p>';
         $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
         $test_settings_html .= $this->get_action_link_or_button(
             'reset_to_default',
@@ -2080,7 +2080,7 @@ 
             'linked_input_id' => $linked_input_id
         );
         
-        return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
+        return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'shortcode_selector_skeleton.template.php',
             $template_args, true);
     }
     
@@ -2098,7 +2098,7 @@ 
         //$messenger = $this->_message_template_group->messenger_obj();
         //now let's set the content depending on the status of the shortcodes array
         if (empty($shortcodes)) {
-            $content = '<p>' . __('There are no valid shortcodes available', 'event_espresso') . '</p>';
+            $content = '<p>'.__('There are no valid shortcodes available', 'event_espresso').'</p>';
             echo $content;
         } else {
             //$alt = 0;
@@ -2215,7 +2215,7 @@ 
                     <?php
                 }
                 //setup nonce_url
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
+                wp_nonce_field($args['action'].'_nonce', $args['action'].'_nonce', false);
                 ?>
                 <select name="context">
                     <?php
@@ -2313,7 +2313,7 @@ 
             : '';
         $context      = ucwords(str_replace('_', ' ', $context_slug));
         
-        $item_desc = $messenger_label && $message_type_label ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' ' : '';
+        $item_desc = $messenger_label && $message_type_label ? $messenger_label.' '.$message_type_label.' '.$context.' ' : '';
         $item_desc .= 'Message Template';
         $query_args  = array();
         $edit_array  = array();
@@ -2682,8 +2682,8 @@ 
      */
     protected function _learn_more_about_message_templates_link()
     {
-        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >' . __('learn more about how message templates works',
-            'event_espresso') . '</a>';
+        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'.__('learn more about how message templates works',
+            'event_espresso').'</a>';
     }
     
     
@@ -2759,10 +2759,10 @@ 
                 
                 $this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array(
                     'label'    => ucwords($message_type->label['singular']),
-                    'class'    => 'message-type-' . $a_or_i,
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
+                    'class'    => 'message-type-'.$a_or_i,
+                    'slug_id'  => $message_type->name.'-messagetype-'.$messenger->name,
+                    'mt_nonce' => wp_create_nonce($message_type->name.'_nonce'),
+                    'href'     => 'espresso_'.$message_type->name.'_message_type_settings',
                     'title'    => $a_or_i == 'active'
                         ? __('Drag this message type to the Inactive window to deactivate', 'event_espresso')
                         : __('Drag this message type to the messenger to activate', 'event_espresso'),
@@ -2798,9 +2798,9 @@ 
             $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
             
             foreach ($fields as $fldname => $fldprops) {
-                $field_id                       = $messenger->name . '-' . $message_type->name . '-' . $fldname;
+                $field_id                       = $messenger->name.'-'.$message_type->name.'-'.$fldname;
                 $template_form_field[$field_id] = array(
-                    'name'       => 'message_type_settings[' . $fldname . ']',
+                    'name'       => 'message_type_settings['.$fldname.']',
                     'label'      => $fldprops['label'],
                     'input'      => $fldprops['field_type'],
                     'type'       => $fldprops['value_type'],
@@ -2841,7 +2841,7 @@ 
         $settings_template_args['show_form']     = empty($settings_template_args['template_form_fields']) ? ' hidden' : '';
         
         
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
+        $template = EE_MSG_TEMPLATE_PATH.'ee_msg_mt_settings_content.template.php';
         $content  = EEH_Template::display_template($template, $settings_template_args, true);
         
         return $content;
@@ -2871,11 +2871,11 @@ 
                 $active_mt_tabs                         = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active'])
                     ? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
                     : '';
-                $m_boxes[$messenger . '_a_box']         = sprintf(
+                $m_boxes[$messenger.'_a_box']         = sprintf(
                     __('%s Settings', 'event_espresso'),
                     $tab_array['label']
                 );
-                $m_template_args[$messenger . '_a_box'] = array(
+                $m_template_args[$messenger.'_a_box'] = array(
                     'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
                     'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
                         ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
@@ -2889,8 +2889,8 @@ 
                 // message type meta boxes
                 // (which is really just the inactive container for each messenger
                 // showing inactive message types for that messenger)
-                $mt_boxes[$messenger . '_i_box']         = __('Inactive Message Types', 'event_espresso');
-                $mt_template_args[$messenger . '_i_box'] = array(
+                $mt_boxes[$messenger.'_i_box']         = __('Inactive Message Types', 'event_espresso');
+                $mt_template_args[$messenger.'_i_box'] = array(
                     'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
                     'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
                         ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
@@ -2906,14 +2906,14 @@ 
         
         
         //register messenger metaboxes
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
+        $m_template_path = EE_MSG_TEMPLATE_PATH.'ee_msg_details_messenger_mt_meta_box.template.php';
         foreach ($m_boxes as $box => $label) {
             $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]);
             $msgr          = str_replace('_a_box', '', $box);
             add_meta_box(
-                'espresso_' . $msgr . '_settings',
+                'espresso_'.$msgr.'_settings',
                 $label,
-                function ($post, $metabox) {
+                function($post, $metabox) {
                     echo EEH_Template::display_template($metabox["args"]["template_path"],
                         $metabox["args"]["template_args"], true);
                 },
@@ -2925,17 +2925,17 @@ 
         }
         
         //register message type metaboxes
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
+        $mt_template_path = EE_MSG_TEMPLATE_PATH.'ee_msg_details_messenger_meta_box.template.php';
         foreach ($mt_boxes as $box => $label) {
             $callback_args = array(
                 'template_path' => $mt_template_path,
                 'template_args' => $mt_template_args[$box]
             );
-            $mt            = str_replace('_i_box', '', $box);
+            $mt = str_replace('_i_box', '', $box);
             add_meta_box(
-                'espresso_' . $mt . '_inactive_mts',
+                'espresso_'.$mt.'_inactive_mts',
                 $label,
-                function ($post, $metabox) {
+                function($post, $metabox) {
                     echo EEH_Template::display_template($metabox["args"]["template_path"],
                         $metabox["args"]["template_args"], true);
                 },
@@ -3037,7 +3037,7 @@ 
             if ($form->is_valid()) {
                 $valid_data = $form->valid_data();
                 foreach ($valid_data as $property => $value) {
-                    $setter = 'set_' . $property;
+                    $setter = 'set_'.$property;
                     if (method_exists($network_config, $setter)) {
                         $network_config->{$setter}($value);
                     } else if (
@@ -3066,8 +3066,8 @@ 
      */
     protected function _get_mt_tabs($tab_array)
     {
-        $tab_array = (array)$tab_array;
-        $template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
+        $tab_array = (array) $tab_array;
+        $template  = EE_MSG_TEMPLATE_PATH.'ee_msg_details_mt_settings_tab_item.template.php';
         $tabs      = '';
         
         foreach ($tab_array as $tab) {
@@ -3100,9 +3100,9 @@ 
             $existing_settings = $messenger->get_existing_admin_settings();
             
             foreach ($fields as $fldname => $fldprops) {
-                $field_id                       = $messenger->name . '-' . $fldname;
+                $field_id                       = $messenger->name.'-'.$fldname;
                 $template_form_field[$field_id] = array(
-                    'name'       => 'messenger_settings[' . $field_id . ']',
+                    'name'       => 'messenger_settings['.$field_id.']',
                     'label'      => $fldprops['label'],
                     'input'      => $fldprops['field_type'],
                     'type'       => $fldprops['value_type'],
@@ -3137,7 +3137,7 @@ 
         //make sure any active message types that are existing are included in the hidden fields
         if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
             foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
-                $settings_template_args['hidden_fields']['messenger_settings[message_types][' . $mt . ']'] = array(
+                $settings_template_args['hidden_fields']['messenger_settings[message_types]['.$mt.']'] = array(
                     'type'  => 'hidden',
                     'value' => $mt
                 );
@@ -3147,7 +3147,7 @@ 
             $settings_template_args['hidden_fields'],
             'array'
         );
-        $active                                  = $this->_message_resource_manager->is_messenger_active($messenger->name);
+        $active = $this->_message_resource_manager->is_messenger_active($messenger->name);
         
         $settings_template_args['messenger']           = $messenger->name;
         $settings_template_args['description']         = $messenger->description;
@@ -3164,9 +3164,9 @@ 
         
         
         $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
-        $settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
+        $settings_template_args['nonce']         = wp_create_nonce('activate_'.$messenger->name.'_toggle_nonce');
         $settings_template_args['on_off_status'] = $active ? true : false;
-        $template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
+        $template                                = EE_MSG_TEMPLATE_PATH.'ee_msg_m_settings_content.template.php';
         $content                                 = EEH_Template::display_template($template, $settings_template_args,
             true);
         
@@ -3194,7 +3194,7 @@ 
         
         //do a nonce check here since we're not arriving via a normal route
         $nonce     = isset($this->_req_data['activate_nonce']) ? sanitize_text_field($this->_req_data['activate_nonce']) : '';
-        $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
+        $nonce_ref = 'activate_'.$this->_req_data['messenger'].'_toggle_nonce';
         
         $this->_verify_nonce($nonce, $nonce_ref);
         
@@ -3296,7 +3296,7 @@ 
         
         //do a nonce check here since we're not arriving via a normal route
         $nonce     = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
-        $nonce_ref = $this->_req_data['message_type'] . '_nonce';
+        $nonce_ref = $this->_req_data['message_type'].'_nonce';
         
         $this->_verify_nonce($nonce, $nonce_ref);
         

Indentation +3620 added lines, -3620 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -17,2213 +17,2213 @@ 
 class Messages_Admin_Page extends EE_Admin_Page
 {
     
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-    
-    /**
-     * @type string $_active_message_type_name
-     */
-    protected $_active_message_type_name = '';
-    
-    /**
-     * @type EE_messenger $_active_messenger
-     */
-    protected $_active_messenger;
-    protected $_activate_state;
-    protected $_activate_meta_box_type;
-    protected $_current_message_meta_box;
-    protected $_current_message_meta_box_object;
-    protected $_context_switcher;
-    protected $_shortcodes = array();
-    protected $_active_messengers = array();
-    protected $_active_message_types = array();
-    
-    /**
-     * @var EE_Message_Template_Group $_message_template_group
-     */
-    protected $_message_template_group;
-    protected $_m_mt_settings = array();
-    
-    
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
-     * IF there is no group then it gets automatically set to the Default template pack.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_template_pack;
-    
-    
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
-     * group is.  If there is no group then it automatically gets set to default.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_variation;
-    
-    
-    /**
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        //make sure messages autoloader is running
-        EED_Messages::set_autoloaders();
-        parent::__construct($routing);
-    }
-    
-    
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EE_MSG_PG_SLUG;
-        $this->page_label       = __('Messages Settings', 'event_espresso');
-        $this->_admin_base_url  = EE_MSG_ADMIN_URL;
-        $this->_admin_base_path = EE_MSG_ADMIN;
-        
-        $this->_activate_state = isset($this->_req_data['activate_state']) ? (array)$this->_req_data['activate_state'] : array();
-        
-        $this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
-        $this->_load_message_resource_manager();
-    }
-    
-    
-    /**
-     * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
-     *
-     *
-     * @throws EE_Error
-     */
-    protected function _load_message_resource_manager()
-    {
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
-    
-    
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     */
-    public function get_messengers_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+    
+	/**
+	 * @type string $_active_message_type_name
+	 */
+	protected $_active_message_type_name = '';
+    
+	/**
+	 * @type EE_messenger $_active_messenger
+	 */
+	protected $_active_messenger;
+	protected $_activate_state;
+	protected $_activate_meta_box_type;
+	protected $_current_message_meta_box;
+	protected $_current_message_meta_box_object;
+	protected $_context_switcher;
+	protected $_shortcodes = array();
+	protected $_active_messengers = array();
+	protected $_active_message_types = array();
+    
+	/**
+	 * @var EE_Message_Template_Group $_message_template_group
+	 */
+	protected $_message_template_group;
+	protected $_m_mt_settings = array();
+    
+    
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
+	 * IF there is no group then it gets automatically set to the Default template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_template_pack;
+    
+    
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
+	 * group is.  If there is no group then it automatically gets set to default.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_variation;
+    
+    
+	/**
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		//make sure messages autoloader is running
+		EED_Messages::set_autoloaders();
+		parent::__construct($routing);
+	}
+    
+    
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EE_MSG_PG_SLUG;
+		$this->page_label       = __('Messages Settings', 'event_espresso');
+		$this->_admin_base_url  = EE_MSG_ADMIN_URL;
+		$this->_admin_base_path = EE_MSG_ADMIN;
+        
+		$this->_activate_state = isset($this->_req_data['activate_state']) ? (array)$this->_req_data['activate_state'] : array();
+        
+		$this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
+		$this->_load_message_resource_manager();
+	}
+    
+    
+	/**
+	 * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
+	 *
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _load_message_resource_manager()
+	{
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	}
+    
+    
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 */
+	public function get_messengers_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
 			values for use in creating a messenger filter dropdown which is now generated differently via
 			 Messages_Admin_Page::get_messengers_select_input', 'event_espresso'),
-            '4.9.9.rc.014'
-        );
-        
-        $m_values          = array();
-        $active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
-        //setup messengers for selects
-        $i = 1;
-        foreach ($active_messengers as $active_messenger) {
-            if ($active_messenger instanceof EE_Message) {
-                $m_values[$i]['id']   = $active_messenger->messenger();
-                $m_values[$i]['text'] = ucwords($active_messenger->messenger_label());
-                $i++;
-            }
-        }
-        
-        return $m_values;
-    }
-    
-    
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     */
-    public function get_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
+			'4.9.9.rc.014'
+		);
+        
+		$m_values          = array();
+		$active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
+		//setup messengers for selects
+		$i = 1;
+		foreach ($active_messengers as $active_messenger) {
+			if ($active_messenger instanceof EE_Message) {
+				$m_values[$i]['id']   = $active_messenger->messenger();
+				$m_values[$i]['text'] = ucwords($active_messenger->messenger_label());
+				$i++;
+			}
+		}
+        
+		return $m_values;
+	}
+    
+    
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 */
+	public function get_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
 			values for use in creating a message type filter dropdown which is now generated differently via
 			 Messages_Admin_Page::get_message_types_select_input', 'event_espresso'),
-            '4.9.9.rc.014'
-        );
-        
-        $mt_values       = array();
-        $active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
-        $i               = 1;
-        foreach ($active_messages as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $mt_values[$i]['id']   = $active_message->message_type();
-                $mt_values[$i]['text'] = ucwords($active_message->message_type_label());
-                $i++;
-            }
-        }
-        
-        return $mt_values;
-    }
-    
-    
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     */
-    public function get_contexts_for_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
+			'4.9.9.rc.014'
+		);
+        
+		$mt_values       = array();
+		$active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
+		$i               = 1;
+		foreach ($active_messages as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$mt_values[$i]['id']   = $active_message->message_type();
+				$mt_values[$i]['text'] = ucwords($active_message->message_type_label());
+				$i++;
+			}
+		}
+        
+		return $mt_values;
+	}
+    
+    
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 */
+	public function get_contexts_for_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
 			values for use in creating a message type context filter dropdown which is now generated differently via
 			 Messages_Admin_Page::get_contexts_for_message_types_select_input', 'event_espresso'),
-            '4.9.9.rc.014'
-        );
-        
-        $contexts                = array();
-        $active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
-        foreach ($active_message_contexts as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type = $active_message->message_type_object();
-                if ($message_type instanceof EE_message_type) {
-                    $message_type_contexts = $message_type->get_contexts();
-                    foreach ($message_type_contexts as $context => $context_details) {
-                        $contexts[$context] = $context_details['label'];
-                    }
-                }
-            }
-        }
-        
-        return $contexts;
-    }
-    
-    
-    /**
-     * Generate select input with provided messenger options array.
-     *
-     * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
-     *                                 labels.
-     *
-     * @return string
-     */
-    public function get_messengers_select_input($messenger_options)
-    {
-        //if empty or just one value then just return an empty string
-        if (empty($messenger_options)
-            || ! is_array($messenger_options)
-            || count($messenger_options) === 1
-        ) {
-            return '';
-        }
-        //merge in default
-        $messenger_options = array_merge(
-            array('none_selected' => __('Show All Messengers', 'event_espresso')),
-            $messenger_options
-        );
-        $input             = new EE_Select_Input(
-            $messenger_options,
-            array(
-                'html_name'  => 'ee_messenger_filter_by',
-                'html_id'    => 'ee_messenger_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_messenger_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_messenger_filter_by'])
-                    : 'none_selected'
-            )
-        );
-        
-        return $input->get_html_for_input();
-    }
-    
-    
-    /**
-     * Generate select input with provided message type options array.
-     *
-     * @param array $message_type_options Array of message types indexed by message type slug, and values are the
-     *                                    message type labels
-     *
-     * @return string
-     */
-    public function get_message_types_select_input($message_type_options)
-    {
-        //if empty or count of options is 1 then just return an empty string
-        if (empty($message_type_options)
-            || ! is_array($message_type_options)
-            || count($message_type_options) === 1
-        ) {
-            return '';
-        }
-        //merge in default
-        $message_type_options = array_merge(
-            array('none_selected' => __('Show All Message Types', 'event_espresso')),
-            $message_type_options
-        );
-        $input                = new EE_Select_Input(
-            $message_type_options,
-            array(
-                'html_name'  => 'ee_message_type_filter_by',
-                'html_id'    => 'ee_message_type_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_message_type_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_message_type_filter_by'])
-                    : 'none_selected',
-            )
-        );
-        
-        return $input->get_html_for_input();
-    }
-    
-    
-    /**
-     * Generate select input with provide message type contexts array.
-     *
-     * @param array $context_options Array of message type contexts indexed by context slug, and values are the
-     *                               context label.
-     *
-     * @return string
-     */
-    public function get_contexts_for_message_types_select_input($context_options)
-    {
-        //if empty or count of options is one then just return empty string
-        if (empty($context_options)
-            || ! is_array($context_options)
-            || count($context_options) === 1
-        ) {
-            return '';
-        }
-        //merge in default
-        $context_options = array_merge(
-            array('none_selected' => __('Show all Contexts', 'event_espresso')),
-            $context_options
-        );
-        $input           = new EE_Select_Input(
-            $context_options,
-            array(
-                'html_name'  => 'ee_context_filter_by',
-                'html_id'    => 'ee_context_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_context_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_context_filter_by'])
-                    : 'none_selected',
-            )
-        );
-        
-        return $input->get_html_for_input();
-    }
-    
-    
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle'));
-        add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle'));
-        add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings'));
-        add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form'));
-        add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack'));
-    }
-    
-    
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = array(
-            'buttons'    => array(
-                'add'    => __('Add New Message Template', 'event_espresso'),
-                'edit'   => __('Edit Message Template', 'event_espresso'),
-                'delete' => __('Delete Message Template', 'event_espresso')
-            ),
-            'publishbox' => __('Update Actions', 'event_espresso')
-        );
-    }
-    
-    
-    /**
-     *        an array for storing key => value pairs of request actions and their corresponding methods
-     * @access protected
-     * @return void
-     */
-    protected function _set_page_routes()
-    {
-        $grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID'])
-            ? $this->_req_data['GRP_ID']
-            : 0;
-        $grp_id = empty($grp_id) && ! empty($this->_req_data['id'])
-            ? $this->_req_data['id']
-            : $grp_id;
-        $msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID'])
-            ? $this->_req_data['MSG_ID']
-            : 0;
-        
-        $this->_page_routes = array(
-            'default'                          => array(
-                'func'       => '_message_queue_list_table',
-                'capability' => 'ee_read_global_messages'
-            ),
-            'global_mtps'                      => array(
-                'func'       => '_ee_default_messages_overview_list_table',
-                'capability' => 'ee_read_global_messages'
-            ),
-            'custom_mtps'                      => array(
-                'func'       => '_custom_mtps_preview',
-                'capability' => 'ee_read_messages'
-            ),
-            'add_new_message_template'         => array(
-                'func'       => '_add_message_template',
-                'capability' => 'ee_edit_messages',
-                'noheader'   => true
-            ),
-            'edit_message_template'            => array(
-                'func'       => '_edit_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id
-            ),
-            'preview_message'                  => array(
-                'func'               => '_preview_message',
-                'capability'         => 'ee_read_message',
-                'obj_id'             => $grp_id,
-                'noheader'           => true,
-                'headers_sent_route' => 'display_preview_message'
-            ),
-            'display_preview_message'          => array(
-                'func'       => '_display_preview_message',
-                'capability' => 'ee_read_message',
-                'obj_id'     => $grp_id
-            ),
-            'insert_message_template'          => array(
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_messages',
-                'args'       => array('new_template' => true),
-                'noheader'   => true
-            ),
-            'update_message_template'          => array(
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('new_template' => false),
-                'noheader'   => true
-            ),
-            'trash_message_template'           => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => true, 'all' => true),
-                'noheader'   => true
-            ),
-            'trash_message_template_context'   => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => true),
-                'noheader'   => true
-            ),
-            'restore_message_template'         => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => false, 'all' => true),
-                'noheader'   => true
-            ),
-            'restore_message_template_context' => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => false),
-                'noheader'   => true
-            ),
-            'delete_message_template'          => array(
-                'func'       => '_delete_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'noheader'   => true
-            ),
-            'reset_to_default'                 => array(
-                'func'       => '_reset_to_default_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id,
-                'noheader'   => true
-            ),
-            'settings'                         => array(
-                'func'       => '_settings',
-                'capability' => 'manage_options'
-            ),
-            'update_global_settings'           => array(
-                'func'       => '_update_global_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true
-            ),
-            'generate_now'                     => array(
-                'func'       => '_generate_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'generate_and_send_now'            => array(
-                'func'       => '_generate_and_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'queue_for_resending'              => array(
-                'func'       => '_queue_for_resending',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'send_now'                         => array(
-                'func'       => '_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'delete_ee_message'                => array(
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_message',
-                'noheader'   => true
-            ),
-            'delete_ee_messages'               => array(
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_messages',
-                'noheader'   => true,
-                'obj_id'     => $msg_id
-            )
-        );
-    }
-    
-    
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'                  => array(
-                'nav'           => array(
-                    'label' => __('Message Activity', 'event_espresso'),
-                    'order' => 10
-                ),
-                'list_table'    => 'EE_Message_List_Table',
-                // 'qtips' => array( 'EE_Message_List_Table_Tips' ),
-                'require_nonce' => false
-            ),
-            'global_mtps'              => array(
-                'nav'           => array(
-                    'label' => __('Default Message Templates', 'event_espresso'),
-                    'order' => 20
-                ),
-                'list_table'    => 'Messages_Template_List_Table',
-                'help_tabs'     => array(
-                    'messages_overview_help_tab'                                => array(
-                        'title'    => __('Messages Overview', 'event_espresso'),
-                        'filename' => 'messages_overview'
-                    ),
-                    'messages_overview_messages_table_column_headings_help_tab' => array(
-                        'title'    => __('Messages Table Column Headings', 'event_espresso'),
-                        'filename' => 'messages_overview_table_column_headings'
-                    ),
-                    'messages_overview_messages_filters_help_tab'               => array(
-                        'title'    => __('Message Filters', 'event_espresso'),
-                        'filename' => 'messages_overview_filters'
-                    ),
-                    'messages_overview_messages_views_help_tab'                 => array(
-                        'title'    => __('Message Views', 'event_espresso'),
-                        'filename' => 'messages_overview_views'
-                    ),
-                    'message_overview_message_types_help_tab'                   => array(
-                        'title'    => __('Message Types', 'event_espresso'),
-                        'filename' => 'messages_overview_types'
-                    ),
-                    'messages_overview_messengers_help_tab'                     => array(
-                        'title'    => __('Messengers', 'event_espresso'),
-                        'filename' => 'messages_overview_messengers',
-                    ),
-                    'messages_overview_other_help_tab'                          => array(
-                        'title'    => __('Messages Other', 'event_espresso'),
-                        'filename' => 'messages_overview_other',
-                    ),
-                ),
-                'help_tour'     => array('Messages_Overview_Help_Tour'),
-                'require_nonce' => false
-            ),
-            'custom_mtps'              => array(
-                'nav'           => array(
-                    'label' => __('Custom Message Templates', 'event_espresso'),
-                    'order' => 30
-                ),
-                'help_tabs'     => array(),
-                'help_tour'     => array(),
-                'require_nonce' => false
-            ),
-            'add_new_message_template' => array(
-                'nav'           => array(
-                    'label'      => __('Add New Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false
-                ),
-                'require_nonce' => false
-            ),
-            'edit_message_template'    => array(
-                'labels'        => array(
-                    'buttons'    => array(
-                        'reset' => __('Reset Templates'),
-                    ),
-                    'publishbox' => __('Update Actions', 'event_espresso')
-                ),
-                'nav'           => array(
-                    'label'      => __('Edit Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => ''
-                ),
-                'metaboxes'     => array('_publish_post_box', '_register_edit_meta_boxes'),
-                'has_metaboxes' => true,
-                'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
-                'help_tabs'     => array(
-                    'edit_message_template'       => array(
-                        'title'    => __('Message Template Editor', 'event_espresso'),
-                        'callback' => 'edit_message_template_help_tab'
-                    ),
-                    'message_templates_help_tab'  => array(
-                        'title'    => __('Message Templates', 'event_espresso'),
-                        'filename' => 'messages_templates'
-                    ),
-                    'message_template_shortcodes' => array(
-                        'title'    => __('Message Shortcodes', 'event_espresso'),
-                        'callback' => 'message_template_shortcodes_help_tab'
-                    ),
-                    'message_preview_help_tab'    => array(
-                        'title'    => __('Message Preview', 'event_espresso'),
-                        'filename' => 'messages_preview'
-                    ),
-                ),
-                'require_nonce' => false
-            ),
-            'display_preview_message'  => array(
-                'nav'           => array(
-                    'label'      => __('Message Preview', 'event_espresso'),
-                    'order'      => 5,
-                    'url'        => '',
-                    'persistent' => false
-                ),
-                'help_tabs'     => array(
-                    'preview_message' => array(
-                        'title'    => __('About Previews', 'event_espresso'),
-                        'callback' => 'preview_message_help_tab'
-                    )
-                ),
-                'require_nonce' => false
-            ),
-            'settings'                 => array(
-                'nav'           => array(
-                    'label' => __('Settings', 'event_espresso'),
-                    'order' => 40
-                ),
-                'metaboxes'     => array('_messages_settings_metaboxes'),
-                'help_tabs'     => array(
-                    'messages_settings_help_tab'               => array(
-                        'title'    => __('Messages Settings', 'event_espresso'),
-                        'filename' => 'messages_settings'
-                    ),
-                    'messages_settings_message_types_help_tab' => array(
-                        'title'    => __('Activating / Deactivating Message Types', 'event_espresso'),
-                        'filename' => 'messages_settings_message_types'
-                    ),
-                    'messages_settings_messengers_help_tab'    => array(
-                        'title'    => __('Activating / Deactivating Messengers', 'event_espresso'),
-                        'filename' => 'messages_settings_messengers'
-                    ),
-                ),
-                'help_tour'     => array('Messages_Settings_Help_Tour'),
-                'require_nonce' => false
-            )
-        );
-    }
-    
-    
-    protected function _add_screen_options()
-    {
-        //todo
-    }
-    
-    
-    protected function _add_screen_options_global_mtps()
-    {
-        /**
-         * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
-         * uses the $_admin_page_title property and we want different outputs in the different spots.
-         */
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = __('Global Message Templates', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-    
-    
-    protected function _add_screen_options_default()
-    {
-        $this->_admin_page_title = __('Message Activity', 'event_espresso');
-        $this->_per_page_screen_option();
-    }
-    
-    
-    //none of the below group are currently used for Messages
-    protected function _add_feature_pointers()
-    {
-    }
-    
-    public function admin_init()
-    {
-    }
-    
-    public function admin_notices()
-    {
-    }
-    
-    public function admin_footer_scripts()
-    {
-    }
-    
-    
-    public function messages_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
-    }
-    
-    
-    public function messengers_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
-    }
-    
-    
-    public function message_types_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
-    }
-    
-    
-    public function messages_overview_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
-    }
-    
-    
-    public function message_templates_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
-    }
-    
-    
-    public function edit_message_template_help_tab()
-    {
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="' . esc_attr__('Editor Title',
-                'event_espresso') . '" />';
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="' . esc_attr__('Context Switcher and Preview',
-                'event_espresso') . '" />';
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="' . esc_attr__('Message Template Form Fields',
-                'event_espresso') . '" />';
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="' . esc_attr__('Shortcodes Metabox',
-                'event_espresso') . '" />';
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="' . esc_attr__('Publish Metabox',
-                'event_espresso') . '" />';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
-            $args);
-    }
-    
-    
-    public function message_template_shortcodes_help_tab()
-    {
-        $this->_set_shortcodes();
-        $args['shortcodes'] = $this->_shortcodes;
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
-            $args);
-    }
+			'4.9.9.rc.014'
+		);
+        
+		$contexts                = array();
+		$active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
+		foreach ($active_message_contexts as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type = $active_message->message_type_object();
+				if ($message_type instanceof EE_message_type) {
+					$message_type_contexts = $message_type->get_contexts();
+					foreach ($message_type_contexts as $context => $context_details) {
+						$contexts[$context] = $context_details['label'];
+					}
+				}
+			}
+		}
+        
+		return $contexts;
+	}
+    
+    
+	/**
+	 * Generate select input with provided messenger options array.
+	 *
+	 * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
+	 *                                 labels.
+	 *
+	 * @return string
+	 */
+	public function get_messengers_select_input($messenger_options)
+	{
+		//if empty or just one value then just return an empty string
+		if (empty($messenger_options)
+			|| ! is_array($messenger_options)
+			|| count($messenger_options) === 1
+		) {
+			return '';
+		}
+		//merge in default
+		$messenger_options = array_merge(
+			array('none_selected' => __('Show All Messengers', 'event_espresso')),
+			$messenger_options
+		);
+		$input             = new EE_Select_Input(
+			$messenger_options,
+			array(
+				'html_name'  => 'ee_messenger_filter_by',
+				'html_id'    => 'ee_messenger_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_messenger_filter_by'])
+					? sanitize_title($this->_req_data['ee_messenger_filter_by'])
+					: 'none_selected'
+			)
+		);
+        
+		return $input->get_html_for_input();
+	}
+    
+    
+	/**
+	 * Generate select input with provided message type options array.
+	 *
+	 * @param array $message_type_options Array of message types indexed by message type slug, and values are the
+	 *                                    message type labels
+	 *
+	 * @return string
+	 */
+	public function get_message_types_select_input($message_type_options)
+	{
+		//if empty or count of options is 1 then just return an empty string
+		if (empty($message_type_options)
+			|| ! is_array($message_type_options)
+			|| count($message_type_options) === 1
+		) {
+			return '';
+		}
+		//merge in default
+		$message_type_options = array_merge(
+			array('none_selected' => __('Show All Message Types', 'event_espresso')),
+			$message_type_options
+		);
+		$input                = new EE_Select_Input(
+			$message_type_options,
+			array(
+				'html_name'  => 'ee_message_type_filter_by',
+				'html_id'    => 'ee_message_type_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_message_type_filter_by'])
+					? sanitize_title($this->_req_data['ee_message_type_filter_by'])
+					: 'none_selected',
+			)
+		);
+        
+		return $input->get_html_for_input();
+	}
+    
+    
+	/**
+	 * Generate select input with provide message type contexts array.
+	 *
+	 * @param array $context_options Array of message type contexts indexed by context slug, and values are the
+	 *                               context label.
+	 *
+	 * @return string
+	 */
+	public function get_contexts_for_message_types_select_input($context_options)
+	{
+		//if empty or count of options is one then just return empty string
+		if (empty($context_options)
+			|| ! is_array($context_options)
+			|| count($context_options) === 1
+		) {
+			return '';
+		}
+		//merge in default
+		$context_options = array_merge(
+			array('none_selected' => __('Show all Contexts', 'event_espresso')),
+			$context_options
+		);
+		$input           = new EE_Select_Input(
+			$context_options,
+			array(
+				'html_name'  => 'ee_context_filter_by',
+				'html_id'    => 'ee_context_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_context_filter_by'])
+					? sanitize_title($this->_req_data['ee_context_filter_by'])
+					: 'none_selected',
+			)
+		);
+        
+		return $input->get_html_for_input();
+	}
+    
+    
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle'));
+		add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle'));
+		add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings'));
+		add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form'));
+		add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack'));
+	}
+    
+    
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = array(
+			'buttons'    => array(
+				'add'    => __('Add New Message Template', 'event_espresso'),
+				'edit'   => __('Edit Message Template', 'event_espresso'),
+				'delete' => __('Delete Message Template', 'event_espresso')
+			),
+			'publishbox' => __('Update Actions', 'event_espresso')
+		);
+	}
+    
+    
+	/**
+	 *        an array for storing key => value pairs of request actions and their corresponding methods
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_page_routes()
+	{
+		$grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID'])
+			? $this->_req_data['GRP_ID']
+			: 0;
+		$grp_id = empty($grp_id) && ! empty($this->_req_data['id'])
+			? $this->_req_data['id']
+			: $grp_id;
+		$msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID'])
+			? $this->_req_data['MSG_ID']
+			: 0;
+        
+		$this->_page_routes = array(
+			'default'                          => array(
+				'func'       => '_message_queue_list_table',
+				'capability' => 'ee_read_global_messages'
+			),
+			'global_mtps'                      => array(
+				'func'       => '_ee_default_messages_overview_list_table',
+				'capability' => 'ee_read_global_messages'
+			),
+			'custom_mtps'                      => array(
+				'func'       => '_custom_mtps_preview',
+				'capability' => 'ee_read_messages'
+			),
+			'add_new_message_template'         => array(
+				'func'       => '_add_message_template',
+				'capability' => 'ee_edit_messages',
+				'noheader'   => true
+			),
+			'edit_message_template'            => array(
+				'func'       => '_edit_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id
+			),
+			'preview_message'                  => array(
+				'func'               => '_preview_message',
+				'capability'         => 'ee_read_message',
+				'obj_id'             => $grp_id,
+				'noheader'           => true,
+				'headers_sent_route' => 'display_preview_message'
+			),
+			'display_preview_message'          => array(
+				'func'       => '_display_preview_message',
+				'capability' => 'ee_read_message',
+				'obj_id'     => $grp_id
+			),
+			'insert_message_template'          => array(
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_messages',
+				'args'       => array('new_template' => true),
+				'noheader'   => true
+			),
+			'update_message_template'          => array(
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('new_template' => false),
+				'noheader'   => true
+			),
+			'trash_message_template'           => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => true, 'all' => true),
+				'noheader'   => true
+			),
+			'trash_message_template_context'   => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => true),
+				'noheader'   => true
+			),
+			'restore_message_template'         => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => false, 'all' => true),
+				'noheader'   => true
+			),
+			'restore_message_template_context' => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => false),
+				'noheader'   => true
+			),
+			'delete_message_template'          => array(
+				'func'       => '_delete_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'noheader'   => true
+			),
+			'reset_to_default'                 => array(
+				'func'       => '_reset_to_default_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id,
+				'noheader'   => true
+			),
+			'settings'                         => array(
+				'func'       => '_settings',
+				'capability' => 'manage_options'
+			),
+			'update_global_settings'           => array(
+				'func'       => '_update_global_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true
+			),
+			'generate_now'                     => array(
+				'func'       => '_generate_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'generate_and_send_now'            => array(
+				'func'       => '_generate_and_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'queue_for_resending'              => array(
+				'func'       => '_queue_for_resending',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'send_now'                         => array(
+				'func'       => '_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'delete_ee_message'                => array(
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_message',
+				'noheader'   => true
+			),
+			'delete_ee_messages'               => array(
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_messages',
+				'noheader'   => true,
+				'obj_id'     => $msg_id
+			)
+		);
+	}
+    
+    
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'                  => array(
+				'nav'           => array(
+					'label' => __('Message Activity', 'event_espresso'),
+					'order' => 10
+				),
+				'list_table'    => 'EE_Message_List_Table',
+				// 'qtips' => array( 'EE_Message_List_Table_Tips' ),
+				'require_nonce' => false
+			),
+			'global_mtps'              => array(
+				'nav'           => array(
+					'label' => __('Default Message Templates', 'event_espresso'),
+					'order' => 20
+				),
+				'list_table'    => 'Messages_Template_List_Table',
+				'help_tabs'     => array(
+					'messages_overview_help_tab'                                => array(
+						'title'    => __('Messages Overview', 'event_espresso'),
+						'filename' => 'messages_overview'
+					),
+					'messages_overview_messages_table_column_headings_help_tab' => array(
+						'title'    => __('Messages Table Column Headings', 'event_espresso'),
+						'filename' => 'messages_overview_table_column_headings'
+					),
+					'messages_overview_messages_filters_help_tab'               => array(
+						'title'    => __('Message Filters', 'event_espresso'),
+						'filename' => 'messages_overview_filters'
+					),
+					'messages_overview_messages_views_help_tab'                 => array(
+						'title'    => __('Message Views', 'event_espresso'),
+						'filename' => 'messages_overview_views'
+					),
+					'message_overview_message_types_help_tab'                   => array(
+						'title'    => __('Message Types', 'event_espresso'),
+						'filename' => 'messages_overview_types'
+					),
+					'messages_overview_messengers_help_tab'                     => array(
+						'title'    => __('Messengers', 'event_espresso'),
+						'filename' => 'messages_overview_messengers',
+					),
+					'messages_overview_other_help_tab'                          => array(
+						'title'    => __('Messages Other', 'event_espresso'),
+						'filename' => 'messages_overview_other',
+					),
+				),
+				'help_tour'     => array('Messages_Overview_Help_Tour'),
+				'require_nonce' => false
+			),
+			'custom_mtps'              => array(
+				'nav'           => array(
+					'label' => __('Custom Message Templates', 'event_espresso'),
+					'order' => 30
+				),
+				'help_tabs'     => array(),
+				'help_tour'     => array(),
+				'require_nonce' => false
+			),
+			'add_new_message_template' => array(
+				'nav'           => array(
+					'label'      => __('Add New Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false
+				),
+				'require_nonce' => false
+			),
+			'edit_message_template'    => array(
+				'labels'        => array(
+					'buttons'    => array(
+						'reset' => __('Reset Templates'),
+					),
+					'publishbox' => __('Update Actions', 'event_espresso')
+				),
+				'nav'           => array(
+					'label'      => __('Edit Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => ''
+				),
+				'metaboxes'     => array('_publish_post_box', '_register_edit_meta_boxes'),
+				'has_metaboxes' => true,
+				'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
+				'help_tabs'     => array(
+					'edit_message_template'       => array(
+						'title'    => __('Message Template Editor', 'event_espresso'),
+						'callback' => 'edit_message_template_help_tab'
+					),
+					'message_templates_help_tab'  => array(
+						'title'    => __('Message Templates', 'event_espresso'),
+						'filename' => 'messages_templates'
+					),
+					'message_template_shortcodes' => array(
+						'title'    => __('Message Shortcodes', 'event_espresso'),
+						'callback' => 'message_template_shortcodes_help_tab'
+					),
+					'message_preview_help_tab'    => array(
+						'title'    => __('Message Preview', 'event_espresso'),
+						'filename' => 'messages_preview'
+					),
+				),
+				'require_nonce' => false
+			),
+			'display_preview_message'  => array(
+				'nav'           => array(
+					'label'      => __('Message Preview', 'event_espresso'),
+					'order'      => 5,
+					'url'        => '',
+					'persistent' => false
+				),
+				'help_tabs'     => array(
+					'preview_message' => array(
+						'title'    => __('About Previews', 'event_espresso'),
+						'callback' => 'preview_message_help_tab'
+					)
+				),
+				'require_nonce' => false
+			),
+			'settings'                 => array(
+				'nav'           => array(
+					'label' => __('Settings', 'event_espresso'),
+					'order' => 40
+				),
+				'metaboxes'     => array('_messages_settings_metaboxes'),
+				'help_tabs'     => array(
+					'messages_settings_help_tab'               => array(
+						'title'    => __('Messages Settings', 'event_espresso'),
+						'filename' => 'messages_settings'
+					),
+					'messages_settings_message_types_help_tab' => array(
+						'title'    => __('Activating / Deactivating Message Types', 'event_espresso'),
+						'filename' => 'messages_settings_message_types'
+					),
+					'messages_settings_messengers_help_tab'    => array(
+						'title'    => __('Activating / Deactivating Messengers', 'event_espresso'),
+						'filename' => 'messages_settings_messengers'
+					),
+				),
+				'help_tour'     => array('Messages_Settings_Help_Tour'),
+				'require_nonce' => false
+			)
+		);
+	}
+    
+    
+	protected function _add_screen_options()
+	{
+		//todo
+	}
+    
+    
+	protected function _add_screen_options_global_mtps()
+	{
+		/**
+		 * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
+		 * uses the $_admin_page_title property and we want different outputs in the different spots.
+		 */
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = __('Global Message Templates', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+    
+    
+	protected function _add_screen_options_default()
+	{
+		$this->_admin_page_title = __('Message Activity', 'event_espresso');
+		$this->_per_page_screen_option();
+	}
+    
+    
+	//none of the below group are currently used for Messages
+	protected function _add_feature_pointers()
+	{
+	}
+    
+	public function admin_init()
+	{
+	}
+    
+	public function admin_notices()
+	{
+	}
+    
+	public function admin_footer_scripts()
+	{
+	}
+    
+    
+	public function messages_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
+	}
+    
+    
+	public function messengers_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
+	}
+    
+    
+	public function message_types_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
+	}
+    
+    
+	public function messages_overview_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
+	}
+    
+    
+	public function message_templates_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
+	}
+    
+    
+	public function edit_message_template_help_tab()
+	{
+		$args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="' . esc_attr__('Editor Title',
+				'event_espresso') . '" />';
+		$args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="' . esc_attr__('Context Switcher and Preview',
+				'event_espresso') . '" />';
+		$args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="' . esc_attr__('Message Template Form Fields',
+				'event_espresso') . '" />';
+		$args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="' . esc_attr__('Shortcodes Metabox',
+				'event_espresso') . '" />';
+		$args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="' . esc_attr__('Publish Metabox',
+				'event_espresso') . '" />';
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
+			$args);
+	}
+    
+    
+	public function message_template_shortcodes_help_tab()
+	{
+		$this->_set_shortcodes();
+		$args['shortcodes'] = $this->_shortcodes;
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
+			$args);
+	}
     
     
-    public function preview_message_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
-    }
+	public function preview_message_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
+	}
     
-    
-    public function settings_help_tab()
-    {
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '" alt="' . esc_attr__('Active Email Tab',
-                'event_espresso') . '" />';
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png' . '" alt="' . esc_attr__('Inactive Email Tab',
-                'event_espresso') . '" />';
-        $args['img3'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked"><label for="ee-on-off-toggle-on"></label>';
-        $args['img4'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox"><label for="ee-on-off-toggle-on"></label>';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
-    }
+    
+	public function settings_help_tab()
+	{
+		$args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '" alt="' . esc_attr__('Active Email Tab',
+				'event_espresso') . '" />';
+		$args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png' . '" alt="' . esc_attr__('Inactive Email Tab',
+				'event_espresso') . '" />';
+		$args['img3'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked"><label for="ee-on-off-toggle-on"></label>';
+		$args['img4'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox"><label for="ee-on-off-toggle-on"></label>';
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
+	}
     
     
-    public function load_scripts_styles()
-    {
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_ee_msg');
+	public function load_scripts_styles()
+	{
+		wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_ee_msg');
         
-        wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
-            array('jquery-ui-droppable', 'ee-serialize-full-array'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
-            array('ee-dialog'), EVENT_ESPRESSO_VERSION);
-    }
+		wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
+			array('jquery-ui-droppable', 'ee-serialize-full-array'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
+			array('ee-dialog'), EVENT_ESPRESSO_VERSION);
+	}
     
     
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_script('ee-msg-list-table-js');
-    }
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_script('ee-msg-list-table-js');
+	}
     
     
-    public function wp_editor_css($mce_css)
-    {
-        //if we're on the edit_message_template route
-        if ($this->_req_action == 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
-            $message_type_name = $this->_active_message_type_name;
+	public function wp_editor_css($mce_css)
+	{
+		//if we're on the edit_message_template route
+		if ($this->_req_action == 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
+			$message_type_name = $this->_active_message_type_name;
             
-            //we're going to REPLACE the existing mce css
-            //we need to get the css file location from the active messenger
-            $mce_css = $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true,
-                'wpeditor', $this->_variation);
-        }
+			//we're going to REPLACE the existing mce css
+			//we need to get the css file location from the active messenger
+			$mce_css = $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true,
+				'wpeditor', $this->_variation);
+		}
         
-        return $mce_css;
-    }
-    
-    
-    public function load_scripts_styles_edit_message_template()
-    {
-        
-        $this->_set_shortcodes();
+		return $mce_css;
+	}
+    
+    
+	public function load_scripts_styles_edit_message_template()
+	{
+        
+		$this->_set_shortcodes();
         
-        EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
-            __('Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
-                'event_espresso'),
-            $this->_message_template_group->messenger_obj()->label['singular'],
-            $this->_message_template_group->message_type_obj()->label['singular']
-        );
-        EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = __('Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
-            'event_espresso');
-        
-        wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL . 'ee_message_editor.js', array('jquery'),
-            EVENT_ESPRESSO_VERSION);
-        
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee_msgs_edit_js');
-        
-        //add in special css for tiny_mce
-        add_filter('mce_css', array($this, 'wp_editor_css'));
-    }
-    
-    
-    public function load_scripts_styles_display_preview_message()
-    {
-        
-        $this->_set_message_template_group();
-        
-        if (isset($this->_req_data['messenger'])) {
-            $this->_active_messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
-        }
-        
-        $message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : '';
-        
-        
-        wp_enqueue_style('espresso_preview_css',
-            $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true, 'preview',
-                $this->_variation));
-    }
-    
-    
-    public function load_scripts_styles_settings()
-    {
-        wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL . 'ee_message_settings.css', array(),
-            EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('ee-text-links');
-        wp_enqueue_style('ee-message-settings');
-        
-        wp_enqueue_script('ee-messages-settings');
-    }
-    
-    
-    /**
-     * set views array for List Table
-     */
-    public function _set_list_table_views_global_mtps()
-    {
-        $this->_views = array(
-            'in_use' => array(
-                'slug'        => 'in_use',
-                'label'       => __('In Use', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_message_template' => __('Move to Trash', 'event_espresso')
-                )
-            )
-        );
-    }
-    
-    
-    /**
-     * set views array for message queue list table
-     */
-    public function _set_list_table_views_default()
-    {
-        EE_Registry::instance()->load_helper('Template');
-        
-        $common_bulk_actions = EE_Registry::instance()->CAP->current_user_can('ee_send_message',
-            'message_list_table_bulk_actions')
-            ? array(
-                'generate_now'          => __('Generate Now', 'event_espresso'),
-                'generate_and_send_now' => __('Generate and Send Now', 'event_espresso'),
-                'queue_for_resending'   => __('Queue for Resending', 'event_espresso'),
-                'send_now'              => __('Send Now', 'event_espresso')
-            )
-            : array();
-        
-        $delete_bulk_action = EE_Registry::instance()->CAP->current_user_can('ee_delete_messages',
-            'message_list_table_bulk_actions')
-            ? array('delete_ee_messages' => __('Delete Messages', 'event_espresso'))
-            : array();
-        
-        
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => __('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action)
-            )
-        );
-        
-        
-        foreach (EEM_Message::instance()->all_statuses() as $status) {
-            if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
-                continue;
-            }
-            $status_bulk_actions = $common_bulk_actions;
-            //unset bulk actions not applying to status
-            if (! empty($status_bulk_actions)) {
-                switch ($status) {
-                    case EEM_Message::status_idle:
-                    case EEM_Message::status_resend:
-                        $status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
-                        break;
+		EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
+			__('Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
+				'event_espresso'),
+			$this->_message_template_group->messenger_obj()->label['singular'],
+			$this->_message_template_group->message_type_obj()->label['singular']
+		);
+		EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = __('Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
+			'event_espresso');
+        
+		wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL . 'ee_message_editor.js', array('jquery'),
+			EVENT_ESPRESSO_VERSION);
+        
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee_msgs_edit_js');
+        
+		//add in special css for tiny_mce
+		add_filter('mce_css', array($this, 'wp_editor_css'));
+	}
+    
+    
+	public function load_scripts_styles_display_preview_message()
+	{
+        
+		$this->_set_message_template_group();
+        
+		if (isset($this->_req_data['messenger'])) {
+			$this->_active_messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
+		}
+        
+		$message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : '';
+        
+        
+		wp_enqueue_style('espresso_preview_css',
+			$this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true, 'preview',
+				$this->_variation));
+	}
+    
+    
+	public function load_scripts_styles_settings()
+	{
+		wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL . 'ee_message_settings.css', array(),
+			EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('ee-text-links');
+		wp_enqueue_style('ee-message-settings');
+        
+		wp_enqueue_script('ee-messages-settings');
+	}
+    
+    
+	/**
+	 * set views array for List Table
+	 */
+	public function _set_list_table_views_global_mtps()
+	{
+		$this->_views = array(
+			'in_use' => array(
+				'slug'        => 'in_use',
+				'label'       => __('In Use', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_message_template' => __('Move to Trash', 'event_espresso')
+				)
+			)
+		);
+	}
+    
+    
+	/**
+	 * set views array for message queue list table
+	 */
+	public function _set_list_table_views_default()
+	{
+		EE_Registry::instance()->load_helper('Template');
+        
+		$common_bulk_actions = EE_Registry::instance()->CAP->current_user_can('ee_send_message',
+			'message_list_table_bulk_actions')
+			? array(
+				'generate_now'          => __('Generate Now', 'event_espresso'),
+				'generate_and_send_now' => __('Generate and Send Now', 'event_espresso'),
+				'queue_for_resending'   => __('Queue for Resending', 'event_espresso'),
+				'send_now'              => __('Send Now', 'event_espresso')
+			)
+			: array();
+        
+		$delete_bulk_action = EE_Registry::instance()->CAP->current_user_can('ee_delete_messages',
+			'message_list_table_bulk_actions')
+			? array('delete_ee_messages' => __('Delete Messages', 'event_espresso'))
+			: array();
+        
+        
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => __('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action)
+			)
+		);
+        
+        
+		foreach (EEM_Message::instance()->all_statuses() as $status) {
+			if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
+				continue;
+			}
+			$status_bulk_actions = $common_bulk_actions;
+			//unset bulk actions not applying to status
+			if (! empty($status_bulk_actions)) {
+				switch ($status) {
+					case EEM_Message::status_idle:
+					case EEM_Message::status_resend:
+						$status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
+						break;
                     
-                    case EEM_Message::status_failed:
-                    case EEM_Message::status_debug_only:
-                    case EEM_Message::status_messenger_executing:
-                        $status_bulk_actions = array();
-                        break;
+					case EEM_Message::status_failed:
+					case EEM_Message::status_debug_only:
+					case EEM_Message::status_messenger_executing:
+						$status_bulk_actions = array();
+						break;
                     
-                    case EEM_Message::status_incomplete:
-                        unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
-                        break;
+					case EEM_Message::status_incomplete:
+						unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
+						break;
                     
-                    case EEM_Message::status_retry:
-                    case EEM_Message::status_sent:
-                        unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
-                        break;
-                }
-            }
+					case EEM_Message::status_retry:
+					case EEM_Message::status_sent:
+						unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
+						break;
+				}
+			}
 
-            //skip adding messenger executing status to views because it will be included with the Failed view.
-            if ( $status === EEM_Message::status_messenger_executing ) {
-                continue;
-            }
+			//skip adding messenger executing status to views because it will be included with the Failed view.
+			if ( $status === EEM_Message::status_messenger_executing ) {
+				continue;
+			}
             
-            $this->_views[strtolower($status)] = array(
-                'slug'        => strtolower($status),
-                'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
-                'count'       => 0,
-                'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action)
-            );
-        }
-    }
-    
-    
-    protected function _ee_default_messages_overview_list_table()
-    {
-        $this->_admin_page_title = __('Default Message Templates', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-    
-    
-    protected function _message_queue_list_table()
-    {
-        $this->_search_btn_label                   = __('Message Activity', 'event_espresso');
-        $this->_template_args['per_column']        = 6;
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
-        $this->_template_args['before_list_table'] = '<h3>' . EEM_Message::instance()->get_pretty_label_for_results() . '</h3>';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-    
-    
-    protected function _message_legend_items()
-    {
-        
-        $action_css_classes = EEH_MSG_Template::get_message_action_icons();
-        $action_items       = array();
-        
-        foreach ($action_css_classes as $action_item => $action_details) {
-            if ($action_item === 'see_notifications_for') {
-                continue;
-            }
-            $action_items[$action_item] = array(
-                'class' => $action_details['css_class'],
-                'desc'  => $action_details['label']
-            );
-        }
-        
-        /** @type array $status_items status legend setup */
-        $status_items = array(
-            'sent_status'       => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence')
-            ),
-            'idle_status'       => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence')
-            ),
-            'failed_status'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence')
-            ),
-            'messenger_executing_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
-                'desc' => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence')
-            ),
-            'resend_status'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence')
-            ),
-            'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence')
-            ),
-            'retry_status'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence')
-            )
-        );
-        if (EEM_Message::debug()) {
-            $status_items['debug_only_status'] = array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence')
-            );
-        }
-        
-        return array_merge($action_items, $status_items);
-    }
-    
-    
-    protected function _custom_mtps_preview()
-    {
-        $this->_admin_page_title              = __('Custom Message Templates (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png" alt="' . esc_attr__('Preview Custom Message Templates screenshot',
-                'event_espresso') . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . __('Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
-                'event_espresso') . '</strong>';
-        $this->display_admin_caf_preview_page('custom_message_types', false);
-    }
-    
-    
-    /**
-     * get_message_templates
-     * This gets all the message templates for listing on the overview list.
-     *
-     * @access public
-     *
-     * @param int    $perpage the amount of templates groups to show per page
-     * @param string $type    the current _view we're getting templates for
-     * @param bool   $count   return count?
-     * @param bool   $all     disregard any paging info (get all data);
-     * @param bool   $global  whether to return just global (true) or custom templates (false)
-     *
-     * @return array
-     */
-    public function get_message_templates($perpage = 10, $type = 'in_use', $count = false, $all = false, $global = true)
-    {
-        
-        $MTP = EEM_Message_Template_Group::instance();
-        
-        $this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby'];
-        $orderby                    = $this->_req_data['orderby'];
-        
-        $order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC';
-        
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
-        $per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $perpage;
-        
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = $all ? null : array($offset, $per_page);
-        
-        
-        //options will match what is in the _views array property
-        switch ($type) {
+			$this->_views[strtolower($status)] = array(
+				'slug'        => strtolower($status),
+				'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
+				'count'       => 0,
+				'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action)
+			);
+		}
+	}
+    
+    
+	protected function _ee_default_messages_overview_list_table()
+	{
+		$this->_admin_page_title = __('Default Message Templates', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+    
+    
+	protected function _message_queue_list_table()
+	{
+		$this->_search_btn_label                   = __('Message Activity', 'event_espresso');
+		$this->_template_args['per_column']        = 6;
+		$this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
+		$this->_template_args['before_list_table'] = '<h3>' . EEM_Message::instance()->get_pretty_label_for_results() . '</h3>';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+    
+    
+	protected function _message_legend_items()
+	{
+        
+		$action_css_classes = EEH_MSG_Template::get_message_action_icons();
+		$action_items       = array();
+        
+		foreach ($action_css_classes as $action_item => $action_details) {
+			if ($action_item === 'see_notifications_for') {
+				continue;
+			}
+			$action_items[$action_item] = array(
+				'class' => $action_details['css_class'],
+				'desc'  => $action_details['label']
+			);
+		}
+        
+		/** @type array $status_items status legend setup */
+		$status_items = array(
+			'sent_status'       => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence')
+			),
+			'idle_status'       => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence')
+			),
+			'failed_status'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence')
+			),
+			'messenger_executing_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
+				'desc' => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence')
+			),
+			'resend_status'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence')
+			),
+			'incomplete_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence')
+			),
+			'retry_status'      => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence')
+			)
+		);
+		if (EEM_Message::debug()) {
+			$status_items['debug_only_status'] = array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence')
+			);
+		}
+        
+		return array_merge($action_items, $status_items);
+	}
+    
+    
+	protected function _custom_mtps_preview()
+	{
+		$this->_admin_page_title              = __('Custom Message Templates (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png" alt="' . esc_attr__('Preview Custom Message Templates screenshot',
+				'event_espresso') . '" />';
+		$this->_template_args['preview_text'] = '<strong>' . __('Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
+				'event_espresso') . '</strong>';
+		$this->display_admin_caf_preview_page('custom_message_types', false);
+	}
+    
+    
+	/**
+	 * get_message_templates
+	 * This gets all the message templates for listing on the overview list.
+	 *
+	 * @access public
+	 *
+	 * @param int    $perpage the amount of templates groups to show per page
+	 * @param string $type    the current _view we're getting templates for
+	 * @param bool   $count   return count?
+	 * @param bool   $all     disregard any paging info (get all data);
+	 * @param bool   $global  whether to return just global (true) or custom templates (false)
+	 *
+	 * @return array
+	 */
+	public function get_message_templates($perpage = 10, $type = 'in_use', $count = false, $all = false, $global = true)
+	{
+        
+		$MTP = EEM_Message_Template_Group::instance();
+        
+		$this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby'];
+		$orderby                    = $this->_req_data['orderby'];
+        
+		$order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC';
+        
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
+		$per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $perpage;
+        
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = $all ? null : array($offset, $per_page);
+        
+        
+		//options will match what is in the _views array property
+		switch ($type) {
             
-            case 'in_use':
-                $templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
-                break;
+			case 'in_use':
+				$templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
+				break;
             
-            default:
-                $templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
+			default:
+				$templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
             
-        }
-        
-        return $templates;
-    }
-    
-    
-    /**
-     * filters etc might need a list of installed message_types
-     * @return array an array of message type objects
-     */
-    public function get_installed_message_types()
-    {
-        $installed_message_types = $this->_message_resource_manager->installed_message_types();
-        $installed               = array();
-        
-        foreach ($installed_message_types as $message_type) {
-            $installed[$message_type->name] = $message_type;
-        }
-        
-        return $installed;
-    }
-    
-    
-    /**
-     * _add_message_template
-     *
-     * This is used when creating a custom template. All Custom Templates start based off another template.
-     *
-     * @param string $message_type
-     * @param string $messenger
-     * @param string $GRP_ID
-     *
-     * @throws EE_error
-     */
-    protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
-    {
-        //set values override any request data
-        $message_type = ! empty($message_type) ? $message_type : '';
-        $message_type = empty($message_type) && ! empty($this->_req_data['message_type']) ? $this->_req_data['message_type'] : $message_type;
-        
-        $messenger = ! empty($messenger) ? $messenger : '';
-        $messenger = empty($messenger) && ! empty($this->_req_data['messenger']) ? $this->_req_data['messenger'] : $messenger;
-        
-        $GRP_ID = ! empty($GRP_ID) ? $GRP_ID : '';
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID;
-        
-        //we need messenger and message type.  They should be coming from the event editor. If not here then return error
-        if (empty($message_type) || empty($messenger)) {
-            throw new EE_error(__('Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
-                'event_espresso'));
-        }
-        
-        //we need the GRP_ID for the template being used as the base for the new template
-        if (empty($GRP_ID)) {
-            throw new EE_Error(__('In order to create a custom message template the GRP_ID of the template being used as a base is needed',
-                'event_espresso'));
-        }
-        
-        //let's just make sure the template gets generated!
-        
-        //we need to reassign some variables for what the insert is expecting
-        $this->_req_data['MTP_messenger']    = $messenger;
-        $this->_req_data['MTP_message_type'] = $message_type;
-        $this->_req_data['GRP_ID']           = $GRP_ID;
-        $this->_insert_or_update_message_template(true);
-    }
-    
-    
-    /**
-     * public wrapper for the _add_message_template method
-     *
-     * @param string $message_type     message type slug
-     * @param string $messenger        messenger slug
-     * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
-     *                                 off of.
-     */
-    public function add_message_template($message_type, $messenger, $GRP_ID)
-    {
-        $this->_add_message_template($message_type, $messenger, $GRP_ID);
-    }
-    
-    
-    /**
-     * _edit_message_template
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $template_fields = '';
-        $sidebar_fields  = '';
-        //we filter the tinyMCE settings to remove the validation since message templates by their nature will not have valid html in the templates.
-        add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2);
-        
-        $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
-            ? absint($this->_req_data['id'])
-            : false;
-        
-        $this->_set_shortcodes(); //this also sets the _message_template property.
-        $message_template_group = $this->_message_template_group;
-        $c_label                = $message_template_group->context_label();
-        $c_config               = $message_template_group->contexts_config();
-        
-        reset($c_config);
-        $context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
-            ? strtolower($this->_req_data['context'])
-            : key($c_config);
-        
-        
-        if (empty($GRP_ID)) {
-            $action = 'insert_message_template';
-            //$button_both = false;
-            //$button_text = array( __( 'Save','event_espresso') );
-            //$button_actions = array('something_different');
-            //$referrer = false;
-            $edit_message_template_form_url = add_query_arg(
-                array('action' => $action, 'noheader' => true),
-                EE_MSG_ADMIN_URL
-            );
-        } else {
-            $action = 'update_message_template';
-            //$button_both = true;
-            //$button_text = array();
-            //$button_actions = array();
-            //$referrer = $this->_admin_base_url;
-            $edit_message_template_form_url = add_query_arg(
-                array('action' => $action, 'noheader' => true),
-                EE_MSG_ADMIN_URL
-            );
-        }
-        
-        //set active messenger for this view
-        $this->_active_messenger         = $this->_message_resource_manager->get_active_messenger(
-            $message_template_group->messenger()
-        );
-        $this->_active_message_type_name = $message_template_group->message_type();
-        
-        
-        //Do we have any validation errors?
-        $validators = $this->_get_transient();
-        $v_fields   = ! empty($validators) ? array_keys($validators) : array();
-        
-        
-        //we need to assemble the title from Various details
-        $context_label = sprintf(
-            __('(%s %s)', 'event_espresso'),
-            $c_config[$context]['label'],
-            ucwords($c_label['label'])
-        );
-        
-        $title = sprintf(
-            __(' %s %s Template %s', 'event_espresso'),
-            ucwords($message_template_group->messenger_obj()->label['singular']),
-            ucwords($message_template_group->message_type_obj()->label['singular']),
-            $context_label
-        );
-        
-        $this->_template_args['GRP_ID']           = $GRP_ID;
-        $this->_template_args['message_template'] = $message_template_group;
-        $this->_template_args['is_extra_fields']  = false;
-        
-        
-        //let's get EEH_MSG_Template so we can get template form fields
-        $template_field_structure = EEH_MSG_Template::get_fields(
-            $message_template_group->messenger(),
-            $message_template_group->message_type()
-        );
-        
-        if ( ! $template_field_structure) {
-            $template_field_structure = false;
-            $template_fields          = __('There was an error in assembling the fields for this display (you should see an error message)',
-                'event_espresso');
-        }
-        
-        
-        $message_templates = $message_template_group->context_templates();
-        
-        
-        //if we have the extra key.. then we need to remove the content index from the template_field_structure as it will get handled in the "extra" array.
-        if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) {
-            foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) {
-                unset($template_field_structure[$context][$reference_field]);
-            }
-        }
-        
-        //let's loop through the template_field_structure and actually assemble the input fields!
-        if ( ! empty($template_field_structure)) {
-            foreach ($template_field_structure[$context] as $template_field => $field_setup_array) {
-                //if this is an 'extra' template field then we need to remove any existing fields that are keyed up in the extra array and reset them.
-                if ($template_field == 'extra') {
-                    $this->_template_args['is_extra_fields'] = true;
-                    foreach ($field_setup_array as $reference_field => $new_fields_array) {
-                        $message_template = $message_templates[$context][$reference_field];
-                        $content          = $message_template instanceof EE_Message_Template
-                            ? $message_template->get('MTP_content')
-                            : '';
-                        foreach ($new_fields_array as $extra_field => $extra_array) {
-                            //let's verify if we need this extra field via the shortcodes parameter.
-                            $continue = false;
-                            if (isset($extra_array['shortcodes_required'])) {
-                                foreach ((array)$extra_array['shortcodes_required'] as $shortcode) {
-                                    if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
-                                        $continue = true;
-                                    }
-                                }
-                                if ($continue) {
-                                    continue;
-                                }
-                            }
+		}
+        
+		return $templates;
+	}
+    
+    
+	/**
+	 * filters etc might need a list of installed message_types
+	 * @return array an array of message type objects
+	 */
+	public function get_installed_message_types()
+	{
+		$installed_message_types = $this->_message_resource_manager->installed_message_types();
+		$installed               = array();
+        
+		foreach ($installed_message_types as $message_type) {
+			$installed[$message_type->name] = $message_type;
+		}
+        
+		return $installed;
+	}
+    
+    
+	/**
+	 * _add_message_template
+	 *
+	 * This is used when creating a custom template. All Custom Templates start based off another template.
+	 *
+	 * @param string $message_type
+	 * @param string $messenger
+	 * @param string $GRP_ID
+	 *
+	 * @throws EE_error
+	 */
+	protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
+	{
+		//set values override any request data
+		$message_type = ! empty($message_type) ? $message_type : '';
+		$message_type = empty($message_type) && ! empty($this->_req_data['message_type']) ? $this->_req_data['message_type'] : $message_type;
+        
+		$messenger = ! empty($messenger) ? $messenger : '';
+		$messenger = empty($messenger) && ! empty($this->_req_data['messenger']) ? $this->_req_data['messenger'] : $messenger;
+        
+		$GRP_ID = ! empty($GRP_ID) ? $GRP_ID : '';
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID;
+        
+		//we need messenger and message type.  They should be coming from the event editor. If not here then return error
+		if (empty($message_type) || empty($messenger)) {
+			throw new EE_error(__('Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
+				'event_espresso'));
+		}
+        
+		//we need the GRP_ID for the template being used as the base for the new template
+		if (empty($GRP_ID)) {
+			throw new EE_Error(__('In order to create a custom message template the GRP_ID of the template being used as a base is needed',
+				'event_espresso'));
+		}
+        
+		//let's just make sure the template gets generated!
+        
+		//we need to reassign some variables for what the insert is expecting
+		$this->_req_data['MTP_messenger']    = $messenger;
+		$this->_req_data['MTP_message_type'] = $message_type;
+		$this->_req_data['GRP_ID']           = $GRP_ID;
+		$this->_insert_or_update_message_template(true);
+	}
+    
+    
+	/**
+	 * public wrapper for the _add_message_template method
+	 *
+	 * @param string $message_type     message type slug
+	 * @param string $messenger        messenger slug
+	 * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
+	 *                                 off of.
+	 */
+	public function add_message_template($message_type, $messenger, $GRP_ID)
+	{
+		$this->_add_message_template($message_type, $messenger, $GRP_ID);
+	}
+    
+    
+	/**
+	 * _edit_message_template
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$template_fields = '';
+		$sidebar_fields  = '';
+		//we filter the tinyMCE settings to remove the validation since message templates by their nature will not have valid html in the templates.
+		add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2);
+        
+		$GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
+			? absint($this->_req_data['id'])
+			: false;
+        
+		$this->_set_shortcodes(); //this also sets the _message_template property.
+		$message_template_group = $this->_message_template_group;
+		$c_label                = $message_template_group->context_label();
+		$c_config               = $message_template_group->contexts_config();
+        
+		reset($c_config);
+		$context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
+			? strtolower($this->_req_data['context'])
+			: key($c_config);
+        
+        
+		if (empty($GRP_ID)) {
+			$action = 'insert_message_template';
+			//$button_both = false;
+			//$button_text = array( __( 'Save','event_espresso') );
+			//$button_actions = array('something_different');
+			//$referrer = false;
+			$edit_message_template_form_url = add_query_arg(
+				array('action' => $action, 'noheader' => true),
+				EE_MSG_ADMIN_URL
+			);
+		} else {
+			$action = 'update_message_template';
+			//$button_both = true;
+			//$button_text = array();
+			//$button_actions = array();
+			//$referrer = $this->_admin_base_url;
+			$edit_message_template_form_url = add_query_arg(
+				array('action' => $action, 'noheader' => true),
+				EE_MSG_ADMIN_URL
+			);
+		}
+        
+		//set active messenger for this view
+		$this->_active_messenger         = $this->_message_resource_manager->get_active_messenger(
+			$message_template_group->messenger()
+		);
+		$this->_active_message_type_name = $message_template_group->message_type();
+        
+        
+		//Do we have any validation errors?
+		$validators = $this->_get_transient();
+		$v_fields   = ! empty($validators) ? array_keys($validators) : array();
+        
+        
+		//we need to assemble the title from Various details
+		$context_label = sprintf(
+			__('(%s %s)', 'event_espresso'),
+			$c_config[$context]['label'],
+			ucwords($c_label['label'])
+		);
+        
+		$title = sprintf(
+			__(' %s %s Template %s', 'event_espresso'),
+			ucwords($message_template_group->messenger_obj()->label['singular']),
+			ucwords($message_template_group->message_type_obj()->label['singular']),
+			$context_label
+		);
+        
+		$this->_template_args['GRP_ID']           = $GRP_ID;
+		$this->_template_args['message_template'] = $message_template_group;
+		$this->_template_args['is_extra_fields']  = false;
+        
+        
+		//let's get EEH_MSG_Template so we can get template form fields
+		$template_field_structure = EEH_MSG_Template::get_fields(
+			$message_template_group->messenger(),
+			$message_template_group->message_type()
+		);
+        
+		if ( ! $template_field_structure) {
+			$template_field_structure = false;
+			$template_fields          = __('There was an error in assembling the fields for this display (you should see an error message)',
+				'event_espresso');
+		}
+        
+        
+		$message_templates = $message_template_group->context_templates();
+        
+        
+		//if we have the extra key.. then we need to remove the content index from the template_field_structure as it will get handled in the "extra" array.
+		if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) {
+			foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) {
+				unset($template_field_structure[$context][$reference_field]);
+			}
+		}
+        
+		//let's loop through the template_field_structure and actually assemble the input fields!
+		if ( ! empty($template_field_structure)) {
+			foreach ($template_field_structure[$context] as $template_field => $field_setup_array) {
+				//if this is an 'extra' template field then we need to remove any existing fields that are keyed up in the extra array and reset them.
+				if ($template_field == 'extra') {
+					$this->_template_args['is_extra_fields'] = true;
+					foreach ($field_setup_array as $reference_field => $new_fields_array) {
+						$message_template = $message_templates[$context][$reference_field];
+						$content          = $message_template instanceof EE_Message_Template
+							? $message_template->get('MTP_content')
+							: '';
+						foreach ($new_fields_array as $extra_field => $extra_array) {
+							//let's verify if we need this extra field via the shortcodes parameter.
+							$continue = false;
+							if (isset($extra_array['shortcodes_required'])) {
+								foreach ((array)$extra_array['shortcodes_required'] as $shortcode) {
+									if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
+										$continue = true;
+									}
+								}
+								if ($continue) {
+									continue;
+								}
+							}
                             
-                            $field_id                                = $reference_field . '-' . $extra_field . '-content';
-                            $template_form_fields[$field_id]         = $extra_array;
-                            $template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $reference_field . '][content][' . $extra_field . ']';
-                            $css_class                               = isset($extra_array['css_class']) ? $extra_array['css_class'] : '';
+							$field_id                                = $reference_field . '-' . $extra_field . '-content';
+							$template_form_fields[$field_id]         = $extra_array;
+							$template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $reference_field . '][content][' . $extra_field . ']';
+							$css_class                               = isset($extra_array['css_class']) ? $extra_array['css_class'] : '';
                             
-                            $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
-                                                                            && in_array($extra_field, $v_fields)
-                                                                            &&
-                                                                            (
-                                                                                is_array($validators[$extra_field])
-                                                                                && isset($validators[$extra_field]['msg'])
-                                                                            )
-                                ? 'validate-error ' . $css_class
-                                : $css_class;
+							$template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
+																			&& in_array($extra_field, $v_fields)
+																			&&
+																			(
+																				is_array($validators[$extra_field])
+																				&& isset($validators[$extra_field]['msg'])
+																			)
+								? 'validate-error ' . $css_class
+								: $css_class;
                             
-                            $template_form_fields[$field_id]['value'] = ! empty($message_templates) && isset($content[$extra_field])
-                                ? stripslashes(html_entity_decode($content[$extra_field], ENT_QUOTES, "UTF-8"))
-                                : '';
+							$template_form_fields[$field_id]['value'] = ! empty($message_templates) && isset($content[$extra_field])
+								? stripslashes(html_entity_decode($content[$extra_field], ENT_QUOTES, "UTF-8"))
+								: '';
                             
-                            //do we have a validation error?  if we do then let's use that value instead
-                            $template_form_fields[$field_id]['value'] = isset($validators[$extra_field]) ? $validators[$extra_field]['value'] : $template_form_fields[$field_id]['value'];
+							//do we have a validation error?  if we do then let's use that value instead
+							$template_form_fields[$field_id]['value'] = isset($validators[$extra_field]) ? $validators[$extra_field]['value'] : $template_form_fields[$field_id]['value'];
                             
                             
-                            $template_form_fields[$field_id]['db-col'] = 'MTP_content';
+							$template_form_fields[$field_id]['db-col'] = 'MTP_content';
                             
-                            //shortcode selector
-                            $field_name_to_use                                 = $extra_field == 'main' ? 'content' : $extra_field;
-                            $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
-                                $field_name_to_use,
-                                $field_id
-                            );
+							//shortcode selector
+							$field_name_to_use                                 = $extra_field == 'main' ? 'content' : $extra_field;
+							$template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
+								$field_name_to_use,
+								$field_id
+							);
                             
-                            if (isset($extra_array['input']) && $extra_array['input'] == 'wp_editor') {
-                                //we want to decode the entities
-                                $template_form_fields[$field_id]['value'] = stripslashes(
-                                    html_entity_decode($template_form_fields[$field_id]['value'], ENT_QUOTES, "UTF-8")
-                                );
+							if (isset($extra_array['input']) && $extra_array['input'] == 'wp_editor') {
+								//we want to decode the entities
+								$template_form_fields[$field_id]['value'] = stripslashes(
+									html_entity_decode($template_form_fields[$field_id]['value'], ENT_QUOTES, "UTF-8")
+								);
                                 
-                            }/**/
-                        }
-                        $templatefield_MTP_id          = $reference_field . '-MTP_ID';
-                        $templatefield_templatename_id = $reference_field . '-name';
+							}/**/
+						}
+						$templatefield_MTP_id          = $reference_field . '-MTP_ID';
+						$templatefield_templatename_id = $reference_field . '-name';
                         
-                        $template_form_fields[$templatefield_MTP_id] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'int',
-                            'required'   => false,
-                            'validation' => false,
-                            'value'      => ! empty($message_templates) ? $message_template->ID() : '',
-                            'css_class'  => '',
-                            'format'     => '%d',
-                            'db-col'     => 'MTP_ID'
-                        );
+						$template_form_fields[$templatefield_MTP_id] = array(
+							'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'int',
+							'required'   => false,
+							'validation' => false,
+							'value'      => ! empty($message_templates) ? $message_template->ID() : '',
+							'css_class'  => '',
+							'format'     => '%d',
+							'db-col'     => 'MTP_ID'
+						);
                         
-                        $template_form_fields[$templatefield_templatename_id] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'string',
-                            'required'   => false,
-                            'validation' => true,
-                            'value'      => $reference_field,
-                            'css_class'  => '',
-                            'format'     => '%s',
-                            'db-col'     => 'MTP_template_field'
-                        );
-                    }
-                    continue; //skip the next stuff, we got the necessary fields here for this dataset.
-                } else {
-                    $field_id                                 = $template_field . '-content';
-                    $template_form_fields[$field_id]          = $field_setup_array;
-                    $template_form_fields[$field_id]['name']  = 'MTP_template_fields[' . $template_field . '][content]';
-                    $message_template                         = isset($message_templates[$context][$template_field])
-                        ? $message_templates[$context][$template_field]
-                        : null;
-                    $template_form_fields[$field_id]['value'] = ! empty($message_templates)
-                                                                && is_array($message_templates[$context])
-                                                                && $message_template instanceof EE_Message_Template
-                        ? $message_template->get('MTP_content')
-                        : '';
+						$template_form_fields[$templatefield_templatename_id] = array(
+							'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'string',
+							'required'   => false,
+							'validation' => true,
+							'value'      => $reference_field,
+							'css_class'  => '',
+							'format'     => '%s',
+							'db-col'     => 'MTP_template_field'
+						);
+					}
+					continue; //skip the next stuff, we got the necessary fields here for this dataset.
+				} else {
+					$field_id                                 = $template_field . '-content';
+					$template_form_fields[$field_id]          = $field_setup_array;
+					$template_form_fields[$field_id]['name']  = 'MTP_template_fields[' . $template_field . '][content]';
+					$message_template                         = isset($message_templates[$context][$template_field])
+						? $message_templates[$context][$template_field]
+						: null;
+					$template_form_fields[$field_id]['value'] = ! empty($message_templates)
+																&& is_array($message_templates[$context])
+																&& $message_template instanceof EE_Message_Template
+						? $message_template->get('MTP_content')
+						: '';
                     
-                    //do we have a validator error for this field?  if we do then we'll use that value instead
-                    $template_form_fields[$field_id]['value'] = isset($validators[$template_field])
-                        ? $validators[$template_field]['value']
-                        : $template_form_fields[$field_id]['value'];
+					//do we have a validator error for this field?  if we do then we'll use that value instead
+					$template_form_fields[$field_id]['value'] = isset($validators[$template_field])
+						? $validators[$template_field]['value']
+						: $template_form_fields[$field_id]['value'];
                     
                     
-                    $template_form_fields[$field_id]['db-col']    = 'MTP_content';
-                    $css_class                                    = isset($field_setup_array['css_class']) ? $field_setup_array['css_class'] : '';
-                    $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
-                                                                    && in_array($template_field, $v_fields)
-                                                                    && isset($validators[$template_field]['msg'])
-                        ? 'validate-error ' . $css_class
-                        : $css_class;
+					$template_form_fields[$field_id]['db-col']    = 'MTP_content';
+					$css_class                                    = isset($field_setup_array['css_class']) ? $field_setup_array['css_class'] : '';
+					$template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
+																	&& in_array($template_field, $v_fields)
+																	&& isset($validators[$template_field]['msg'])
+						? 'validate-error ' . $css_class
+						: $css_class;
                     
-                    //shortcode selector
-                    $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
-                        $template_field, $field_id
-                    );
-                }
+					//shortcode selector
+					$template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
+						$template_field, $field_id
+					);
+				}
                 
-                //k took care of content field(s) now let's take care of others.
+				//k took care of content field(s) now let's take care of others.
                 
-                $templatefield_MTP_id                = $template_field . '-MTP_ID';
-                $templatefield_field_templatename_id = $template_field . '-name';
+				$templatefield_MTP_id                = $template_field . '-MTP_ID';
+				$templatefield_field_templatename_id = $template_field . '-name';
                 
-                //foreach template field there are actually two form fields created
-                $template_form_fields[$templatefield_MTP_id] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'int',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
-                    'css_class'  => '',
-                    'format'     => '%d',
-                    'db-col'     => 'MTP_ID'
-                );
+				//foreach template field there are actually two form fields created
+				$template_form_fields[$templatefield_MTP_id] = array(
+					'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'int',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
+					'css_class'  => '',
+					'format'     => '%d',
+					'db-col'     => 'MTP_ID'
+				);
                 
-                $template_form_fields[$templatefield_field_templatename_id] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'string',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $template_field,
-                    'css_class'  => '',
-                    'format'     => '%s',
-                    'db-col'     => 'MTP_template_field'
-                );
+				$template_form_fields[$templatefield_field_templatename_id] = array(
+					'name'       => 'MTP_template_fields[' . $template_field . '][name]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'string',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $template_field,
+					'css_class'  => '',
+					'format'     => '%s',
+					'db-col'     => 'MTP_template_field'
+				);
                 
-            }
+			}
             
-            //add other fields
-            $template_form_fields['ee-msg-current-context'] = array(
-                'name'       => 'MTP_context',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $context,
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_context'
-            );
+			//add other fields
+			$template_form_fields['ee-msg-current-context'] = array(
+				'name'       => 'MTP_context',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $context,
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_context'
+			);
             
-            $template_form_fields['ee-msg-grp-id'] = array(
-                'name'       => 'GRP_ID',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $GRP_ID,
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'GRP_ID'
-            );
+			$template_form_fields['ee-msg-grp-id'] = array(
+				'name'       => 'GRP_ID',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $GRP_ID,
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'GRP_ID'
+			);
             
-            $template_form_fields['ee-msg-messenger'] = array(
-                'name'       => 'MTP_messenger',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->messenger(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_messenger'
-            );
+			$template_form_fields['ee-msg-messenger'] = array(
+				'name'       => 'MTP_messenger',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->messenger(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_messenger'
+			);
             
-            $template_form_fields['ee-msg-message-type'] = array(
-                'name'       => 'MTP_message_type',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->message_type(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_message_type'
-            );
+			$template_form_fields['ee-msg-message-type'] = array(
+				'name'       => 'MTP_message_type',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->message_type(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_message_type'
+			);
             
-            $sidebar_form_fields['ee-msg-is-global'] = array(
-                'name'       => 'MTP_is_global',
-                'label'      => __('Global Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_global'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_global'
-            );
+			$sidebar_form_fields['ee-msg-is-global'] = array(
+				'name'       => 'MTP_is_global',
+				'label'      => __('Global Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_global'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_global'
+			);
             
-            $sidebar_form_fields['ee-msg-is-override'] = array(
-                'name'       => 'MTP_is_override',
-                'label'      => __('Override all custom', 'event_espresso'),
-                'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_override'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_override'
-            );
+			$sidebar_form_fields['ee-msg-is-override'] = array(
+				'name'       => 'MTP_is_override',
+				'label'      => __('Override all custom', 'event_espresso'),
+				'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_override'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_override'
+			);
             
-            $sidebar_form_fields['ee-msg-is-active'] = array(
-                'name'       => 'MTP_is_active',
-                'label'      => __('Active Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->is_active(),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_active'
-            );
+			$sidebar_form_fields['ee-msg-is-active'] = array(
+				'name'       => 'MTP_is_active',
+				'label'      => __('Active Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->is_active(),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_active'
+			);
             
-            $sidebar_form_fields['ee-msg-deleted'] = array(
-                'name'       => 'MTP_deleted',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_deleted'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_deleted'
-            );
-            $sidebar_form_fields['ee-msg-author']  = array(
-                'name'       => 'MTP_user_id',
-                'label'      => __('Author', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => false,
-                'value'      => $message_template_group->user(),
-                'format'     => '%d',
-                'db-col'     => 'MTP_user_id'
-            );
+			$sidebar_form_fields['ee-msg-deleted'] = array(
+				'name'       => 'MTP_deleted',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_deleted'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_deleted'
+			);
+			$sidebar_form_fields['ee-msg-author']  = array(
+				'name'       => 'MTP_user_id',
+				'label'      => __('Author', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => false,
+				'value'      => $message_template_group->user(),
+				'format'     => '%d',
+				'db-col'     => 'MTP_user_id'
+			);
             
-            $sidebar_form_fields['ee-msg-route'] = array(
-                'name'  => 'action',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => $action
-            );
+			$sidebar_form_fields['ee-msg-route'] = array(
+				'name'  => 'action',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => $action
+			);
             
-            $sidebar_form_fields['ee-msg-id']        = array(
-                'name'  => 'id',
-                'input' => 'hidden',
-                'type'  => 'int',
-                'value' => $GRP_ID
-            );
-            $sidebar_form_fields['ee-msg-evt-nonce'] = array(
-                'name'  => $action . '_nonce',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => wp_create_nonce($action . '_nonce')
-            );
+			$sidebar_form_fields['ee-msg-id']        = array(
+				'name'  => 'id',
+				'input' => 'hidden',
+				'type'  => 'int',
+				'value' => $GRP_ID
+			);
+			$sidebar_form_fields['ee-msg-evt-nonce'] = array(
+				'name'  => $action . '_nonce',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => wp_create_nonce($action . '_nonce')
+			);
             
-            if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
-                $sidebar_form_fields['ee-msg-template-switch'] = array(
-                    'name'  => 'template_switch',
-                    'input' => 'hidden',
-                    'type'  => 'int',
-                    'value' => 1
-                );
-            }
+			if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
+				$sidebar_form_fields['ee-msg-template-switch'] = array(
+					'name'  => 'template_switch',
+					'input' => 'hidden',
+					'type'  => 'int',
+					'value' => 1
+				);
+			}
             
             
-            $template_fields = $this->_generate_admin_form_fields($template_form_fields);
-            $sidebar_fields  = $this->_generate_admin_form_fields($sidebar_form_fields);
+			$template_fields = $this->_generate_admin_form_fields($template_form_fields);
+			$sidebar_fields  = $this->_generate_admin_form_fields($sidebar_form_fields);
             
             
-        } //end if ( !empty($template_field_structure) )
+		} //end if ( !empty($template_field_structure) )
         
-        //set extra content for publish box
-        $this->_template_args['publish_box_extra_content'] = $sidebar_fields;
-        $this->_set_publish_post_box_vars(
-            'id',
-            $GRP_ID,
-            false,
-            add_query_arg(
-                array('action' => 'global_mtps'),
-                $this->_admin_base_url
-            )
-        );
-        
-        //add preview button
-        $preview_url    = parent::add_query_args_and_nonce(
-            array(
-                'message_type' => $message_template_group->message_type(),
-                'messenger'    => $message_template_group->messenger(),
-                'context'      => $context,
-                'GRP_ID'       => $GRP_ID,
-                'action'       => 'preview_message'
-            ),
-            $this->_admin_base_url
-        );
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">' . __('Preview',
-                'event_espresso') . '</a>';
-        
-        
-        //setup context switcher
-        $context_switcher_args = array(
-            'page'    => 'espresso_messages',
-            'action'  => 'edit_message_template',
-            'id'      => $GRP_ID,
-            'context' => $context,
-            'extra'   => $preview_button
-        );
-        $this->_set_context_switcher($message_template_group, $context_switcher_args);
-        
-        
-        //main box
-        $this->_template_args['template_fields']                         = $template_fields;
-        $this->_template_args['sidebar_box_id']                          = 'details';
-        $this->_template_args['action']                                  = $action;
-        $this->_template_args['context']                                 = $context;
-        $this->_template_args['edit_message_template_form_url']          = $edit_message_template_form_url;
-        $this->_template_args['learn_more_about_message_templates_link'] = $this->_learn_more_about_message_templates_link();
-        
-        
-        $this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
-        $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
-        $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
-        
-        $this->_template_path = $this->_template_args['GRP_ID']
-            ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
-        
-        //send along EE_Message_Template_Group object for further template use.
-        $this->_template_args['MTP'] = $message_template_group;
-        
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
-            $this->_template_args, true);
-        
-        
-        //finally, let's set the admin_page title
-        $this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
-        
-        
-        //we need to take care of setting the shortcodes property for use elsewhere.
-        $this->_set_shortcodes();
-        
-        
-        //final template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-    
-    
-    public function filter_tinymce_init($mceInit, $editor_id)
-    {
-        return $mceInit;
-    }
-    
-    
-    public function add_context_switcher()
-    {
-        return $this->_context_switcher;
-    }
-    
-    public function _add_form_element_before()
-    {
-        return '<form method="post" action="' . $this->_template_args["edit_message_template_form_url"] . '" id="ee-msg-edit-frm">';
-    }
-    
-    public function _add_form_element_after()
-    {
-        return '</form>';
-    }
-    
-    
-    /**
-     * This executes switching the template pack for a message template.
-     *
-     * @since 4.5.0
-     *
-     */
-    public function switch_template_pack()
-    {
-        $GRP_ID        = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-        $template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
-        
-        //verify we have needed values.
-        if (empty($GRP_ID) || empty($template_pack)) {
-            $this->_template_args['error'] = true;
-            EE_Error::add_error(__('The required date for switching templates is not available.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            //get template, set the new template_pack and then reset to default
-            /** @type EE_Message_Template_Group $message_template_group */
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+		//set extra content for publish box
+		$this->_template_args['publish_box_extra_content'] = $sidebar_fields;
+		$this->_set_publish_post_box_vars(
+			'id',
+			$GRP_ID,
+			false,
+			add_query_arg(
+				array('action' => 'global_mtps'),
+				$this->_admin_base_url
+			)
+		);
+        
+		//add preview button
+		$preview_url    = parent::add_query_args_and_nonce(
+			array(
+				'message_type' => $message_template_group->message_type(),
+				'messenger'    => $message_template_group->messenger(),
+				'context'      => $context,
+				'GRP_ID'       => $GRP_ID,
+				'action'       => 'preview_message'
+			),
+			$this->_admin_base_url
+		);
+		$preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">' . __('Preview',
+				'event_espresso') . '</a>';
+        
+        
+		//setup context switcher
+		$context_switcher_args = array(
+			'page'    => 'espresso_messages',
+			'action'  => 'edit_message_template',
+			'id'      => $GRP_ID,
+			'context' => $context,
+			'extra'   => $preview_button
+		);
+		$this->_set_context_switcher($message_template_group, $context_switcher_args);
+        
+        
+		//main box
+		$this->_template_args['template_fields']                         = $template_fields;
+		$this->_template_args['sidebar_box_id']                          = 'details';
+		$this->_template_args['action']                                  = $action;
+		$this->_template_args['context']                                 = $context;
+		$this->_template_args['edit_message_template_form_url']          = $edit_message_template_form_url;
+		$this->_template_args['learn_more_about_message_templates_link'] = $this->_learn_more_about_message_templates_link();
+        
+        
+		$this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
+		$this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
+		$this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
+        
+		$this->_template_path = $this->_template_args['GRP_ID']
+			? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
+			: EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
+        
+		//send along EE_Message_Template_Group object for further template use.
+		$this->_template_args['MTP'] = $message_template_group;
+        
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
+			$this->_template_args, true);
+        
+        
+		//finally, let's set the admin_page title
+		$this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
+        
+        
+		//we need to take care of setting the shortcodes property for use elsewhere.
+		$this->_set_shortcodes();
+        
+        
+		//final template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+    
+    
+	public function filter_tinymce_init($mceInit, $editor_id)
+	{
+		return $mceInit;
+	}
+    
+    
+	public function add_context_switcher()
+	{
+		return $this->_context_switcher;
+	}
+    
+	public function _add_form_element_before()
+	{
+		return '<form method="post" action="' . $this->_template_args["edit_message_template_form_url"] . '" id="ee-msg-edit-frm">';
+	}
+    
+	public function _add_form_element_after()
+	{
+		return '</form>';
+	}
+    
+    
+	/**
+	 * This executes switching the template pack for a message template.
+	 *
+	 * @since 4.5.0
+	 *
+	 */
+	public function switch_template_pack()
+	{
+		$GRP_ID        = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+		$template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
+        
+		//verify we have needed values.
+		if (empty($GRP_ID) || empty($template_pack)) {
+			$this->_template_args['error'] = true;
+			EE_Error::add_error(__('The required date for switching templates is not available.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__);
+		} else {
+			//get template, set the new template_pack and then reset to default
+			/** @type EE_Message_Template_Group $message_template_group */
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
             
-            $message_template_group->set_template_pack_name($template_pack);
-            $this->_req_data['msgr'] = $message_template_group->messenger();
-            $this->_req_data['mt']   = $message_template_group->message_type();
+			$message_template_group->set_template_pack_name($template_pack);
+			$this->_req_data['msgr'] = $message_template_group->messenger();
+			$this->_req_data['mt']   = $message_template_group->message_type();
             
-            $query_args = $this->_reset_to_default_template();
+			$query_args = $this->_reset_to_default_template();
             
-            if (empty($query_args['id'])) {
-                EE_Error::add_error(
-                    __(
-                        'Something went wrong with switching the template pack. Please try again or contact EE support',
-                        'event_espresso'
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                $this->_template_args['error'] = true;
-            } else {
-                $template_label       = $message_template_group->get_template_pack()->label;
-                $template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
-                EE_Error::add_success(
-                    sprintf(
-                        __(
-                            'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
-                            'event_espresso'
-                        ),
-                        $template_label,
-                        $template_pack_labels->template_pack
-                    )
-                );
-                //generate the redirect url for js.
-                $url                                          = self::add_query_args_and_nonce($query_args,
-                    $this->_admin_base_url);
-                $this->_template_args['data']['redirect_url'] = $url;
-                $this->_template_args['success']              = true;
-            }
+			if (empty($query_args['id'])) {
+				EE_Error::add_error(
+					__(
+						'Something went wrong with switching the template pack. Please try again or contact EE support',
+						'event_espresso'
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				$this->_template_args['error'] = true;
+			} else {
+				$template_label       = $message_template_group->get_template_pack()->label;
+				$template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
+				EE_Error::add_success(
+					sprintf(
+						__(
+							'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
+							'event_espresso'
+						),
+						$template_label,
+						$template_pack_labels->template_pack
+					)
+				);
+				//generate the redirect url for js.
+				$url                                          = self::add_query_args_and_nonce($query_args,
+					$this->_admin_base_url);
+				$this->_template_args['data']['redirect_url'] = $url;
+				$this->_template_args['success']              = true;
+			}
             
-            $this->_return_json();
+			$this->_return_json();
             
-        }
-    }
-    
-    
-    /**
-     * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
-     * they want.
-     *
-     * @access protected
-     * @return array|null
-     */
-    protected function _reset_to_default_template()
-    {
-        
-        $templates = array();
-        $GRP_ID    = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-        //we need to make sure we've got the info we need.
-        if ( ! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
-            EE_Error::add_error(
-                __(
-                    'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        
-        // all templates will be reset to whatever the defaults are
-        // for the global template matching the messenger and message type.
-        $success = ! empty($GRP_ID) ? true : false;
-        
-        if ($success) {
+		}
+	}
+    
+    
+	/**
+	 * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
+	 * they want.
+	 *
+	 * @access protected
+	 * @return array|null
+	 */
+	protected function _reset_to_default_template()
+	{
+        
+		$templates = array();
+		$GRP_ID    = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+		//we need to make sure we've got the info we need.
+		if ( ! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
+			EE_Error::add_error(
+				__(
+					'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+        
+		// all templates will be reset to whatever the defaults are
+		// for the global template matching the messenger and message type.
+		$success = ! empty($GRP_ID) ? true : false;
+        
+		if ($success) {
             
-            //let's first determine if the incoming template is a global template,
-            // if it isn't then we need to get the global template matching messenger and message type.
-            //$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
+			//let's first determine if the incoming template is a global template,
+			// if it isn't then we need to get the global template matching messenger and message type.
+			//$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
             
             
-            //note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
-            $success = $this->_delete_mtp_permanently($GRP_ID, false);
+			//note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
+			$success = $this->_delete_mtp_permanently($GRP_ID, false);
             
-            if ($success) {
-                // if successfully deleted, lets generate the new ones.
-                // Note. We set GLOBAL to true, because resets on ANY template
-                // will use the related global template defaults for regeneration.
-                // This means that if a custom template is reset it resets to whatever the related global template is.
-                // HOWEVER, we DO keep the template pack and template variation set
-                // for the current custom template when resetting.
-                $templates = $this->_generate_new_templates(
-                    $this->_req_data['msgr'],
-                    $this->_req_data['mt'],
-                    $GRP_ID,
-                    true
-                );
-            }
+			if ($success) {
+				// if successfully deleted, lets generate the new ones.
+				// Note. We set GLOBAL to true, because resets on ANY template
+				// will use the related global template defaults for regeneration.
+				// This means that if a custom template is reset it resets to whatever the related global template is.
+				// HOWEVER, we DO keep the template pack and template variation set
+				// for the current custom template when resetting.
+				$templates = $this->_generate_new_templates(
+					$this->_req_data['msgr'],
+					$this->_req_data['mt'],
+					$GRP_ID,
+					true
+				);
+			}
             
-        }
-        
-        //any error messages?
-        if ( ! $success) {
-            EE_Error::add_error(
-                __('Something went wrong with deleting existing templates. Unable to reset to default',
-                    'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        
-        //all good, let's add a success message!
-        if ($success && ! empty($templates)) {
-            $templates = $templates[0]; //the info for the template we generated is the first element in the returned array.
-            EE_Error::overwrite_success();
-            EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
-        }
-        
-        
-        $query_args = array(
-            'id'      => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null,
-            'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null,
-            'action'  => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps'
-        );
-        
-        //if called via ajax then we return query args otherwise redirect
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            return $query_args;
-        } else {
-            $this->_redirect_after_action(false, '', '', $query_args, true);
+		}
+        
+		//any error messages?
+		if ( ! $success) {
+			EE_Error::add_error(
+				__('Something went wrong with deleting existing templates. Unable to reset to default',
+					'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+        
+		//all good, let's add a success message!
+		if ($success && ! empty($templates)) {
+			$templates = $templates[0]; //the info for the template we generated is the first element in the returned array.
+			EE_Error::overwrite_success();
+			EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
+		}
+        
+        
+		$query_args = array(
+			'id'      => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null,
+			'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null,
+			'action'  => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps'
+		);
+        
+		//if called via ajax then we return query args otherwise redirect
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			return $query_args;
+		} else {
+			$this->_redirect_after_action(false, '', '', $query_args, true);
             
-            return null;
-        }
-    }
-    
-    
-    /**
-     * Retrieve and set the message preview for display.
-     *
-     * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
-     *
-     * @return string
-     */
-    public function _preview_message($send = false)
-    {
-        //first make sure we've got the necessary parameters
-        if (
-        ! isset(
-            $this->_req_data['message_type'],
-            $this->_req_data['messenger'],
-            $this->_req_data['messenger'],
-            $this->_req_data['GRP_ID']
-        )
-        ) {
-            EE_Error::add_error(
-                __('Missing necessary parameters for displaying preview', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        
-        EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
-        
-        
-        //get the preview!
-        $preview = EED_Messages::preview_message($this->_req_data['message_type'], $this->_req_data['context'],
-            $this->_req_data['messenger'], $send);
-        
-        if ($send) {
-            return $preview;
-        }
-        
-        //let's add a button to go back to the edit view
-        $query_args             = array(
-            'id'      => $this->_req_data['GRP_ID'],
-            'context' => $this->_req_data['context'],
-            'action'  => 'edit_message_template'
-        );
-        $go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        $preview_button         = '<a href="' . $go_back_url . '" class="button-secondary messages-preview-go-back-button">' . __('Go Back to Edit',
-                'event_espresso') . '</a>';
-        $message_types          = $this->get_installed_message_types();
-        $active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
-        $active_messenger_label = $active_messenger instanceof EE_messenger
-            ? ucwords($active_messenger->label['singular'])
-            : esc_html__('Unknown Messenger', 'event_espresso');
-        //let's provide a helpful title for context
-        $preview_title = sprintf(
-            __('Viewing Preview for %s %s Message Template', 'event_espresso'),
-            $active_messenger_label,
-            ucwords($message_types[$this->_req_data['message_type']]->label['singular'])
-        );
-        //setup display of preview.
-        $this->_admin_page_title                    = $preview_title;
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . stripslashes($preview);
-        $this->_template_args['data']['force_json'] = true;
-        
-        return '';
-    }
-    
-    
-    /**
-     * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
-     * gets called automatically.
-     *
-     * @since 4.5.0
-     *
-     * @return string
-     */
-    protected function _display_preview_message()
-    {
-        $this->display_admin_page_with_no_sidebar();
-    }
-    
-    
-    /**
-     * registers metaboxes that should show up on the "edit_message_template" page
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _register_edit_meta_boxes()
-    {
-        add_meta_box('mtp_valid_shortcodes', __('Valid Shortcodes', 'event_espresso'),
-            array($this, 'shortcode_meta_box'), $this->_current_screen->id, 'side', 'default');
-        add_meta_box('mtp_extra_actions', __('Extra Actions', 'event_espresso'), array($this, 'extra_actions_meta_box'),
-            $this->_current_screen->id, 'side', 'high');
-        add_meta_box('mtp_templates', __('Template Styles', 'event_espresso'), array($this, 'template_pack_meta_box'),
-            $this->_current_screen->id, 'side', 'high');
-    }
-    
-    
-    /**
-     * metabox content for all template pack and variation selection.
-     *
-     * @since 4.5.0
-     *
-     * @return string
-     */
-    public function template_pack_meta_box()
-    {
-        $this->_set_message_template_group();
-        
-        $tp_collection = EEH_MSG_Template::get_template_pack_collection();
-        
-        $tp_select_values = array();
-        
-        foreach ($tp_collection as $tp) {
-            //only include template packs that support this messenger and message type!
-            $supports = $tp->get_supports();
-            if (
-                ! isset($supports[$this->_message_template_group->messenger()])
-                || ! in_array(
-                    $this->_message_template_group->message_type(),
-                    $supports[$this->_message_template_group->messenger()]
-                )
-            ) {
-                //not supported
-                continue;
-            }
+			return null;
+		}
+	}
+    
+    
+	/**
+	 * Retrieve and set the message preview for display.
+	 *
+	 * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
+	 *
+	 * @return string
+	 */
+	public function _preview_message($send = false)
+	{
+		//first make sure we've got the necessary parameters
+		if (
+		! isset(
+			$this->_req_data['message_type'],
+			$this->_req_data['messenger'],
+			$this->_req_data['messenger'],
+			$this->_req_data['GRP_ID']
+		)
+		) {
+			EE_Error::add_error(
+				__('Missing necessary parameters for displaying preview', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+        
+		EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
+        
+        
+		//get the preview!
+		$preview = EED_Messages::preview_message($this->_req_data['message_type'], $this->_req_data['context'],
+			$this->_req_data['messenger'], $send);
+        
+		if ($send) {
+			return $preview;
+		}
+        
+		//let's add a button to go back to the edit view
+		$query_args             = array(
+			'id'      => $this->_req_data['GRP_ID'],
+			'context' => $this->_req_data['context'],
+			'action'  => 'edit_message_template'
+		);
+		$go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		$preview_button         = '<a href="' . $go_back_url . '" class="button-secondary messages-preview-go-back-button">' . __('Go Back to Edit',
+				'event_espresso') . '</a>';
+		$message_types          = $this->get_installed_message_types();
+		$active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
+		$active_messenger_label = $active_messenger instanceof EE_messenger
+			? ucwords($active_messenger->label['singular'])
+			: esc_html__('Unknown Messenger', 'event_espresso');
+		//let's provide a helpful title for context
+		$preview_title = sprintf(
+			__('Viewing Preview for %s %s Message Template', 'event_espresso'),
+			$active_messenger_label,
+			ucwords($message_types[$this->_req_data['message_type']]->label['singular'])
+		);
+		//setup display of preview.
+		$this->_admin_page_title                    = $preview_title;
+		$this->_template_args['admin_page_content'] = $preview_button . '<br />' . stripslashes($preview);
+		$this->_template_args['data']['force_json'] = true;
+        
+		return '';
+	}
+    
+    
+	/**
+	 * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
+	 * gets called automatically.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string
+	 */
+	protected function _display_preview_message()
+	{
+		$this->display_admin_page_with_no_sidebar();
+	}
+    
+    
+	/**
+	 * registers metaboxes that should show up on the "edit_message_template" page
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _register_edit_meta_boxes()
+	{
+		add_meta_box('mtp_valid_shortcodes', __('Valid Shortcodes', 'event_espresso'),
+			array($this, 'shortcode_meta_box'), $this->_current_screen->id, 'side', 'default');
+		add_meta_box('mtp_extra_actions', __('Extra Actions', 'event_espresso'), array($this, 'extra_actions_meta_box'),
+			$this->_current_screen->id, 'side', 'high');
+		add_meta_box('mtp_templates', __('Template Styles', 'event_espresso'), array($this, 'template_pack_meta_box'),
+			$this->_current_screen->id, 'side', 'high');
+	}
+    
+    
+	/**
+	 * metabox content for all template pack and variation selection.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string
+	 */
+	public function template_pack_meta_box()
+	{
+		$this->_set_message_template_group();
+        
+		$tp_collection = EEH_MSG_Template::get_template_pack_collection();
+        
+		$tp_select_values = array();
+        
+		foreach ($tp_collection as $tp) {
+			//only include template packs that support this messenger and message type!
+			$supports = $tp->get_supports();
+			if (
+				! isset($supports[$this->_message_template_group->messenger()])
+				|| ! in_array(
+					$this->_message_template_group->message_type(),
+					$supports[$this->_message_template_group->messenger()]
+				)
+			) {
+				//not supported
+				continue;
+			}
             
-            $tp_select_values[] = array(
-                'text' => $tp->label,
-                'id'   => $tp->dbref
-            );
-        }
-        
-        //if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by the default template pack.  This still allows for the odd template pack to override.
-        if (empty($tp_select_values)) {
-            $tp_select_values[] = array(
-                'text' => __('Default', 'event_espresso'),
-                'id'   => 'default'
-            );
-        }
-        
-        //setup variation select values for the currently selected template.
-        $variations               = $this->_message_template_group->get_template_pack()->get_variations(
-            $this->_message_template_group->messenger(),
-            $this->_message_template_group->message_type()
-        );
-        $variations_select_values = array();
-        foreach ($variations as $variation => $label) {
-            $variations_select_values[] = array(
-                'text' => $label,
-                'id'   => $variation
-            );
-        }
-        
-        $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
-        
-        $template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
-            'MTP_template_pack',
-            $tp_select_values,
-            $this->_message_template_group->get_template_pack_name()
-        );
-        $template_args['variations_selector']            = EEH_Form_Fields::select_input(
-            'MTP_template_variation',
-            $variations_select_values,
-            $this->_message_template_group->get_template_pack_variation()
-        );
-        $template_args['template_pack_label']            = $template_pack_labels->template_pack;
-        $template_args['template_variation_label']       = $template_pack_labels->template_variation;
-        $template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
-        $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
-        
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
-        
-        EEH_Template::display_template($template, $template_args);
-    }
-    
-    
-    /**
-     * This meta box holds any extra actions related to Message Templates
-     * For now, this includes Resetting templates to defaults and sending a test email.
-     *
-     * @access  public
-     * @return void
-     * @throws \EE_Error
-     */
-    public function extra_actions_meta_box()
-    {
-        $template_form_fields = array();
-        
-        $extra_args = array(
-            'msgr'   => $this->_message_template_group->messenger(),
-            'mt'     => $this->_message_template_group->message_type(),
-            'GRP_ID' => $this->_message_template_group->GRP_ID()
-        );
-        //first we need to see if there are any fields
-        $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
-        
-        if ( ! empty($fields)) {
-            //yup there be fields
-            foreach ($fields as $field => $config) {
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
-                $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
-                $default  = isset($config['default']) ? $config['default'] : '';
-                $default  = isset($config['value']) ? $config['value'] : $default;
+			$tp_select_values[] = array(
+				'text' => $tp->label,
+				'id'   => $tp->dbref
+			);
+		}
+        
+		//if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by the default template pack.  This still allows for the odd template pack to override.
+		if (empty($tp_select_values)) {
+			$tp_select_values[] = array(
+				'text' => __('Default', 'event_espresso'),
+				'id'   => 'default'
+			);
+		}
+        
+		//setup variation select values for the currently selected template.
+		$variations               = $this->_message_template_group->get_template_pack()->get_variations(
+			$this->_message_template_group->messenger(),
+			$this->_message_template_group->message_type()
+		);
+		$variations_select_values = array();
+		foreach ($variations as $variation => $label) {
+			$variations_select_values[] = array(
+				'text' => $label,
+				'id'   => $variation
+			);
+		}
+        
+		$template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
+        
+		$template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
+			'MTP_template_pack',
+			$tp_select_values,
+			$this->_message_template_group->get_template_pack_name()
+		);
+		$template_args['variations_selector']            = EEH_Form_Fields::select_input(
+			'MTP_template_variation',
+			$variations_select_values,
+			$this->_message_template_group->get_template_pack_variation()
+		);
+		$template_args['template_pack_label']            = $template_pack_labels->template_pack;
+		$template_args['template_variation_label']       = $template_pack_labels->template_variation;
+		$template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
+		$template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
+        
+		$template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
+        
+		EEH_Template::display_template($template, $template_args);
+	}
+    
+    
+	/**
+	 * This meta box holds any extra actions related to Message Templates
+	 * For now, this includes Resetting templates to defaults and sending a test email.
+	 *
+	 * @access  public
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function extra_actions_meta_box()
+	{
+		$template_form_fields = array();
+        
+		$extra_args = array(
+			'msgr'   => $this->_message_template_group->messenger(),
+			'mt'     => $this->_message_template_group->message_type(),
+			'GRP_ID' => $this->_message_template_group->GRP_ID()
+		);
+		//first we need to see if there are any fields
+		$fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
+        
+		if ( ! empty($fields)) {
+			//yup there be fields
+			foreach ($fields as $field => $config) {
+				$field_id = $this->_message_template_group->messenger() . '_' . $field;
+				$existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
+				$default  = isset($config['default']) ? $config['default'] : '';
+				$default  = isset($config['value']) ? $config['value'] : $default;
                 
-                // if type is hidden and the value is empty
-                // something may have gone wrong so let's correct with the defaults
-                $fix              = $config['input'] === 'hidden' && isset($existing[$field]) && empty($existing[$field])
-                    ? $default
-                    : '';
-                $existing[$field] = isset($existing[$field]) && empty($fix)
-                    ? $existing[$field]
-                    : $fix;
+				// if type is hidden and the value is empty
+				// something may have gone wrong so let's correct with the defaults
+				$fix              = $config['input'] === 'hidden' && isset($existing[$field]) && empty($existing[$field])
+					? $default
+					: '';
+				$existing[$field] = isset($existing[$field]) && empty($fix)
+					? $existing[$field]
+					: $fix;
                 
-                $template_form_fields[$field_id] = array(
-                    'name'       => 'test_settings_fld[' . $field . ']',
-                    'label'      => $config['label'],
-                    'input'      => $config['input'],
-                    'type'       => $config['type'],
-                    'required'   => $config['required'],
-                    'validation' => $config['validation'],
-                    'value'      => isset($existing[$field]) ? $existing[$field] : $default,
-                    'css_class'  => $config['css_class'],
-                    'options'    => isset($config['options']) ? $config['options'] : array(),
-                    'default'    => $default,
-                    'format'     => $config['format']
-                );
-            }
-        }
-        
-        $test_settings_fields = ! empty($template_form_fields)
-            ? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
-            : '';
-        
-        $test_settings_html = '';
-        //print out $test_settings_fields
-        if ( ! empty($test_settings_fields)) {
-            echo $test_settings_fields;
-            $test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
-            $test_settings_html .= 'name="test_button" value="';
-            $test_settings_html .= __('Test Send', 'event_espresso');
-            $test_settings_html .= '" /><div style="clear:both"></div>';
-        }
-        
-        //and button
-        $test_settings_html .= '<p>' . __('Need to reset this message type and start over?', 'event_espresso') . '</p>';
-        $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
-        $test_settings_html .= $this->get_action_link_or_button(
-            'reset_to_default',
-            'reset',
-            $extra_args,
-            'button-primary reset-default-button'
-        );
-        $test_settings_html .= '</div><div style="clear:both"></div>';
-        echo $test_settings_html;
-    }
-    
-    
-    /**
-     * This returns the shortcode selector skeleton for a given context and field.
-     *
-     * @since 4.9.rc.000
-     *
-     * @param string $field           The name of the field retrieving shortcodes for.
-     * @param string $linked_input_id The css id of the input that the shortcodes get added to.
-     *
-     * @return string
-     */
-    protected function _get_shortcode_selector($field, $linked_input_id)
-    {
-        $template_args = array(
-            'shortcodes'      => $this->_get_shortcodes(array($field), true),
-            'fieldname'       => $field,
-            'linked_input_id' => $linked_input_id
-        );
-        
-        return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
-            $template_args, true);
-    }
-    
-    
-    /**
-     * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
-     * page)
-     *
-     * @access public
-     * @return void
-     */
-    public function shortcode_meta_box()
-    {
-        $shortcodes = $this->_get_shortcodes(array(), false); //just make sure shortcodes property is set
-        //$messenger = $this->_message_template_group->messenger_obj();
-        //now let's set the content depending on the status of the shortcodes array
-        if (empty($shortcodes)) {
-            $content = '<p>' . __('There are no valid shortcodes available', 'event_espresso') . '</p>';
-            echo $content;
-        } else {
-            //$alt = 0;
-            ?>
+				$template_form_fields[$field_id] = array(
+					'name'       => 'test_settings_fld[' . $field . ']',
+					'label'      => $config['label'],
+					'input'      => $config['input'],
+					'type'       => $config['type'],
+					'required'   => $config['required'],
+					'validation' => $config['validation'],
+					'value'      => isset($existing[$field]) ? $existing[$field] : $default,
+					'css_class'  => $config['css_class'],
+					'options'    => isset($config['options']) ? $config['options'] : array(),
+					'default'    => $default,
+					'format'     => $config['format']
+				);
+			}
+		}
+        
+		$test_settings_fields = ! empty($template_form_fields)
+			? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
+			: '';
+        
+		$test_settings_html = '';
+		//print out $test_settings_fields
+		if ( ! empty($test_settings_fields)) {
+			echo $test_settings_fields;
+			$test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
+			$test_settings_html .= 'name="test_button" value="';
+			$test_settings_html .= __('Test Send', 'event_espresso');
+			$test_settings_html .= '" /><div style="clear:both"></div>';
+		}
+        
+		//and button
+		$test_settings_html .= '<p>' . __('Need to reset this message type and start over?', 'event_espresso') . '</p>';
+		$test_settings_html .= '<div class="publishing-action alignright resetbutton">';
+		$test_settings_html .= $this->get_action_link_or_button(
+			'reset_to_default',
+			'reset',
+			$extra_args,
+			'button-primary reset-default-button'
+		);
+		$test_settings_html .= '</div><div style="clear:both"></div>';
+		echo $test_settings_html;
+	}
+    
+    
+	/**
+	 * This returns the shortcode selector skeleton for a given context and field.
+	 *
+	 * @since 4.9.rc.000
+	 *
+	 * @param string $field           The name of the field retrieving shortcodes for.
+	 * @param string $linked_input_id The css id of the input that the shortcodes get added to.
+	 *
+	 * @return string
+	 */
+	protected function _get_shortcode_selector($field, $linked_input_id)
+	{
+		$template_args = array(
+			'shortcodes'      => $this->_get_shortcodes(array($field), true),
+			'fieldname'       => $field,
+			'linked_input_id' => $linked_input_id
+		);
+        
+		return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
+			$template_args, true);
+	}
+    
+    
+	/**
+	 * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
+	 * page)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function shortcode_meta_box()
+	{
+		$shortcodes = $this->_get_shortcodes(array(), false); //just make sure shortcodes property is set
+		//$messenger = $this->_message_template_group->messenger_obj();
+		//now let's set the content depending on the status of the shortcodes array
+		if (empty($shortcodes)) {
+			$content = '<p>' . __('There are no valid shortcodes available', 'event_espresso') . '</p>';
+			echo $content;
+		} else {
+			//$alt = 0;
+			?>
             <div
                 style="float:right; margin-top:10px"><?php echo $this->_get_help_tab_link('message_template_shortcodes'); ?></div>
             <p class="small-text"><?php printf(__('You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
-                    'event_espresso'), '<span class="dashicons dashicons-menu"></span>'); ?></p>
+					'event_espresso'), '<span class="dashicons dashicons-menu"></span>'); ?></p>
             <?php
-        }
-        
-        
-    }
-    
-    
-    /**
-     * used to set the $_shortcodes property for when its needed elsewhere.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_shortcodes()
-    {
-        
-        //no need to run this if the property is already set
-        if ( ! empty($this->_shortcodes)) {
-            return;
-        }
-        
-        $this->_shortcodes = $this->_get_shortcodes();
-    }
-    
-    
-    /**
-     * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
-     * property)
-     *
-     * @access  protected
-     *
-     * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
-     *                         for. Defaults to all (for the given context)
-     * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
-     *
-     * @return array          Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
-     *                        true just an array of shortcode/label pairs.
-     */
-    protected function _get_shortcodes($fields = array(), $merged = true)
-    {
-        $this->_set_message_template_group();
-        
-        //we need the messenger and message template to retrieve the valid shortcodes array.
-        $GRP_ID  = isset($this->_req_data['id']) && ! empty($this->_req_data['id']) ? absint($this->_req_data['id']) : false;
-        $context = isset($this->_req_data['context']) ? $this->_req_data['context'] : key($this->_message_template_group->contexts_config());
-        
-        return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
-    }
-    
-    
-    /**
-     * This sets the _message_template property (containing the called message_template object)
-     *
-     * @access protected
-     * @return  void
-     */
-    protected function _set_message_template_group()
-    {
-        
-        if ( ! empty($this->_message_template_group)) {
-            return;
-        } //get out if this is already set.
-        
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
-        
-        //let's get the message templates
-        $MTP = EEM_Message_Template_Group::instance();
-        
-        if (empty($GRP_ID)) {
-            $this->_message_template_group = $MTP->create_default_object();
-        } else {
-            $this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
-        }
-        
-        $this->_template_pack = $this->_message_template_group->get_template_pack();
-        $this->_variation     = $this->_message_template_group->get_template_pack_variation();
-        
-    }
-    
-    
-    /**
-     * sets up a context switcher for edit forms
-     *
-     * @access  protected
-     *
-     * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
-     * @param array                      $args                  various things the context switcher needs.
-     *
-     */
-    protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
-    {
-        $context_details = $template_group_object->contexts_config();
-        $context_label   = $template_group_object->context_label();
-        ob_start();
-        ?>
+		}
+        
+        
+	}
+    
+    
+	/**
+	 * used to set the $_shortcodes property for when its needed elsewhere.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_shortcodes()
+	{
+        
+		//no need to run this if the property is already set
+		if ( ! empty($this->_shortcodes)) {
+			return;
+		}
+        
+		$this->_shortcodes = $this->_get_shortcodes();
+	}
+    
+    
+	/**
+	 * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
+	 * property)
+	 *
+	 * @access  protected
+	 *
+	 * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
+	 *                         for. Defaults to all (for the given context)
+	 * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
+	 *
+	 * @return array          Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
+	 *                        true just an array of shortcode/label pairs.
+	 */
+	protected function _get_shortcodes($fields = array(), $merged = true)
+	{
+		$this->_set_message_template_group();
+        
+		//we need the messenger and message template to retrieve the valid shortcodes array.
+		$GRP_ID  = isset($this->_req_data['id']) && ! empty($this->_req_data['id']) ? absint($this->_req_data['id']) : false;
+		$context = isset($this->_req_data['context']) ? $this->_req_data['context'] : key($this->_message_template_group->contexts_config());
+        
+		return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
+	}
+    
+    
+	/**
+	 * This sets the _message_template property (containing the called message_template object)
+	 *
+	 * @access protected
+	 * @return  void
+	 */
+	protected function _set_message_template_group()
+	{
+        
+		if ( ! empty($this->_message_template_group)) {
+			return;
+		} //get out if this is already set.
+        
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
+        
+		//let's get the message templates
+		$MTP = EEM_Message_Template_Group::instance();
+        
+		if (empty($GRP_ID)) {
+			$this->_message_template_group = $MTP->create_default_object();
+		} else {
+			$this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
+		}
+        
+		$this->_template_pack = $this->_message_template_group->get_template_pack();
+		$this->_variation     = $this->_message_template_group->get_template_pack_variation();
+        
+	}
+    
+    
+	/**
+	 * sets up a context switcher for edit forms
+	 *
+	 * @access  protected
+	 *
+	 * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
+	 * @param array                      $args                  various things the context switcher needs.
+	 *
+	 */
+	protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
+	{
+		$context_details = $template_group_object->contexts_config();
+		$context_label   = $template_group_object->context_label();
+		ob_start();
+		?>
         <div class="ee-msg-switcher-container">
             <form method="get" action="<?php echo EE_MSG_ADMIN_URL; ?>" id="ee-msg-context-switcher-frm">
                 <?php
-                foreach ($args as $name => $value) {
-                    if ($name == 'context' || empty($value) || $name == 'extra') {
-                        continue;
-                    }
-                    ?>
+				foreach ($args as $name => $value) {
+					if ($name == 'context' || empty($value) || $name == 'extra') {
+						continue;
+					}
+					?>
                     <input type="hidden" name="<?php echo $name; ?>" value="<?php echo $value; ?>"/>
                     <?php
-                }
-                //setup nonce_url
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
-                ?>
+				}
+				//setup nonce_url
+				wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
+				?>
                 <select name="context">
                     <?php
-                    $context_templates = $template_group_object->context_templates();
-                    if (is_array($context_templates)) :
-                        foreach ($context_templates as $context => $template_fields) :
-                            $checked = ($context == $args['context']) ? 'selected="selected"' : '';
-                            ?>
+					$context_templates = $template_group_object->context_templates();
+					if (is_array($context_templates)) :
+						foreach ($context_templates as $context => $template_fields) :
+							$checked = ($context == $args['context']) ? 'selected="selected"' : '';
+							?>
                             <option value="<?php echo $context; ?>" <?php echo $checked; ?>>
                                 <?php echo $context_details[$context]['label']; ?>
                             </option>
@@ -2236,1560 +2236,1560 @@ 
             <?php echo $args['extra']; ?>
         </div> <!-- end .ee-msg-switcher-container -->
         <?php
-        $output = ob_get_contents();
-        ob_clean();
-        $this->_context_switcher = $output;
-    }
-    
-    
-    /**
-     * utility for sanitizing new values coming in.
-     * Note: this is only used when updating a context.
-     *
-     * @access protected
-     *
-     * @param int $index This helps us know which template field to select from the request array.
-     *
-     * @return array
-     */
-    protected function _set_message_template_column_values($index)
-    {
-        if (is_array($this->_req_data['MTP_template_fields'][$index]['content'])) {
-            foreach ($this->_req_data['MTP_template_fields'][$index]['content'] as $field => $value) {
-                $this->_req_data['MTP_template_fields'][$index]['content'][$field] = $value;
-            }
-        } /*else {
+		$output = ob_get_contents();
+		ob_clean();
+		$this->_context_switcher = $output;
+	}
+    
+    
+	/**
+	 * utility for sanitizing new values coming in.
+	 * Note: this is only used when updating a context.
+	 *
+	 * @access protected
+	 *
+	 * @param int $index This helps us know which template field to select from the request array.
+	 *
+	 * @return array
+	 */
+	protected function _set_message_template_column_values($index)
+	{
+		if (is_array($this->_req_data['MTP_template_fields'][$index]['content'])) {
+			foreach ($this->_req_data['MTP_template_fields'][$index]['content'] as $field => $value) {
+				$this->_req_data['MTP_template_fields'][$index]['content'][$field] = $value;
+			}
+		} /*else {
 			$this->_req_data['MTP_template_fields'][$index]['content'] = $this->_req_data['MTP_template_fields'][$index]['content'];
 		}*/
         
         
-        $set_column_values = array(
-            'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][$index]['MTP_ID']),
-            'GRP_ID'             => absint($this->_req_data['GRP_ID']),
-            'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
-            'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
-            'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
-            'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][$index]['name']),
-            'MTP_context'        => strtolower($this->_req_data['MTP_context']),
-            'MTP_content'        => $this->_req_data['MTP_template_fields'][$index]['content'],
-            'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
-                ? absint($this->_req_data['MTP_is_global'])
-                : 0,
-            'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
-                ? absint($this->_req_data['MTP_is_override'])
-                : 0,
-            'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
-            'MTP_is_active'      => absint($this->_req_data['MTP_is_active'])
-        );
-        
-        
-        return $set_column_values;
-    }
-    
-    
-    protected function _insert_or_update_message_template($new = false)
-    {
-        
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $success  = 0;
-        $override = false;
-        
-        //setup notices description
-        $messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
-        
-        //need the message type and messenger objects to be able to use the labels for the notices
-        $messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
-        $messenger_label  = $messenger_object instanceof EE_messenger ? ucwords($messenger_object->label['singular']) : '';
-        
-        $message_type_slug   = ! empty($this->_req_data['MTP_message_type']) ? $this->_req_data['MTP_message_type'] : '';
-        $message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
-        
-        $message_type_label = $message_type_object instanceof EE_message_type
-            ? ucwords($message_type_object->label['singular'])
-            : '';
-        
-        $context_slug = ! empty($this->_req_data['MTP_context'])
-            ? $this->_req_data['MTP_context']
-            : '';
-        $context      = ucwords(str_replace('_', ' ', $context_slug));
-        
-        $item_desc = $messenger_label && $message_type_label ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' ' : '';
-        $item_desc .= 'Message Template';
-        $query_args  = array();
-        $edit_array  = array();
-        $action_desc = '';
-        
-        //if this is "new" then we need to generate the default contexts for the selected messenger/message_type for user to edit.
-        if ($new) {
-            $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-            if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
-                if (empty($edit_array)) {
-                    $success = 0;
-                } else {
-                    $success    = 1;
-                    $edit_array = $edit_array[0];
-                    $query_args = array(
-                        'id'      => $edit_array['GRP_ID'],
-                        'context' => $edit_array['MTP_context'],
-                        'action'  => 'edit_message_template'
-                    );
-                }
-            }
-            $action_desc = 'created';
-        } else {
-            $MTPG = EEM_Message_Template_Group::instance();
-            $MTP  = EEM_Message_Template::instance();
+		$set_column_values = array(
+			'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][$index]['MTP_ID']),
+			'GRP_ID'             => absint($this->_req_data['GRP_ID']),
+			'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
+			'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
+			'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
+			'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][$index]['name']),
+			'MTP_context'        => strtolower($this->_req_data['MTP_context']),
+			'MTP_content'        => $this->_req_data['MTP_template_fields'][$index]['content'],
+			'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
+				? absint($this->_req_data['MTP_is_global'])
+				: 0,
+			'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
+				? absint($this->_req_data['MTP_is_override'])
+				: 0,
+			'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
+			'MTP_is_active'      => absint($this->_req_data['MTP_is_active'])
+		);
+        
+        
+		return $set_column_values;
+	}
+    
+    
+	protected function _insert_or_update_message_template($new = false)
+	{
+        
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$success  = 0;
+		$override = false;
+        
+		//setup notices description
+		$messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
+        
+		//need the message type and messenger objects to be able to use the labels for the notices
+		$messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
+		$messenger_label  = $messenger_object instanceof EE_messenger ? ucwords($messenger_object->label['singular']) : '';
+        
+		$message_type_slug   = ! empty($this->_req_data['MTP_message_type']) ? $this->_req_data['MTP_message_type'] : '';
+		$message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
+        
+		$message_type_label = $message_type_object instanceof EE_message_type
+			? ucwords($message_type_object->label['singular'])
+			: '';
+        
+		$context_slug = ! empty($this->_req_data['MTP_context'])
+			? $this->_req_data['MTP_context']
+			: '';
+		$context      = ucwords(str_replace('_', ' ', $context_slug));
+        
+		$item_desc = $messenger_label && $message_type_label ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' ' : '';
+		$item_desc .= 'Message Template';
+		$query_args  = array();
+		$edit_array  = array();
+		$action_desc = '';
+        
+		//if this is "new" then we need to generate the default contexts for the selected messenger/message_type for user to edit.
+		if ($new) {
+			$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+			if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
+				if (empty($edit_array)) {
+					$success = 0;
+				} else {
+					$success    = 1;
+					$edit_array = $edit_array[0];
+					$query_args = array(
+						'id'      => $edit_array['GRP_ID'],
+						'context' => $edit_array['MTP_context'],
+						'action'  => 'edit_message_template'
+					);
+				}
+			}
+			$action_desc = 'created';
+		} else {
+			$MTPG = EEM_Message_Template_Group::instance();
+			$MTP  = EEM_Message_Template::instance();
             
             
-            //run update for each template field in displayed context
-            if ( ! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
-                EE_Error::add_error(
-                    __('There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
-                        'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                $success = 0;
+			//run update for each template field in displayed context
+			if ( ! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
+				EE_Error::add_error(
+					__('There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
+						'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				$success = 0;
                 
-            } else {
-                //first validate all fields!
-                $validates = $MTPG->validate($this->_req_data['MTP_template_fields'], $context_slug, $messenger_slug,
-                    $message_type_slug);
+			} else {
+				//first validate all fields!
+				$validates = $MTPG->validate($this->_req_data['MTP_template_fields'], $context_slug, $messenger_slug,
+					$message_type_slug);
                 
-                //if $validate returned error messages (i.e. is_array()) then we need to process them and setup an appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.  WE need to make sure there is no actual error messages in validates.
-                if (is_array($validates) && ! empty($validates)) {
-                    //add the transient so when the form loads we know which fields to highlight
-                    $this->_add_transient('edit_message_template', $validates);
+				//if $validate returned error messages (i.e. is_array()) then we need to process them and setup an appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.  WE need to make sure there is no actual error messages in validates.
+				if (is_array($validates) && ! empty($validates)) {
+					//add the transient so when the form loads we know which fields to highlight
+					$this->_add_transient('edit_message_template', $validates);
                     
-                    $success = 0;
+					$success = 0;
                     
-                    //setup notices
-                    foreach ($validates as $field => $error) {
-                        if (isset($error['msg'])) {
-                            EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
-                        }
-                    }
+					//setup notices
+					foreach ($validates as $field => $error) {
+						if (isset($error['msg'])) {
+							EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
+						}
+					}
                     
-                } else {
-                    $set_column_values = array();
-                    foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
-                        $set_column_values = $this->_set_message_template_column_values($template_field);
+				} else {
+					$set_column_values = array();
+					foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
+						$set_column_values = $this->_set_message_template_column_values($template_field);
                         
-                        $where_cols_n_values = array(
-                            'MTP_ID' => $this->_req_data['MTP_template_fields'][$template_field]['MTP_ID']
-                        );
+						$where_cols_n_values = array(
+							'MTP_ID' => $this->_req_data['MTP_template_fields'][$template_field]['MTP_ID']
+						);
                         
-                        $message_template_fields = array(
-                            'GRP_ID'             => $set_column_values['GRP_ID'],
-                            'MTP_template_field' => $set_column_values['MTP_template_field'],
-                            'MTP_context'        => $set_column_values['MTP_context'],
-                            'MTP_content'        => $set_column_values['MTP_content']
-                        );
-                        if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
-                            if ($updated === false) {
-                                EE_Error::add_error(
-                                    sprintf(
-                                        __('%s field was NOT updated for some reason', 'event_espresso'),
-                                        $template_field
-                                    ),
-                                    __FILE__, __FUNCTION__, __LINE__
-                                );
-                            } else {
-                                $success = 1;
-                            }
-                        }
-                        $action_desc = 'updated';
-                    }
+						$message_template_fields = array(
+							'GRP_ID'             => $set_column_values['GRP_ID'],
+							'MTP_template_field' => $set_column_values['MTP_template_field'],
+							'MTP_context'        => $set_column_values['MTP_context'],
+							'MTP_content'        => $set_column_values['MTP_content']
+						);
+						if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
+							if ($updated === false) {
+								EE_Error::add_error(
+									sprintf(
+										__('%s field was NOT updated for some reason', 'event_espresso'),
+										$template_field
+									),
+									__FILE__, __FUNCTION__, __LINE__
+								);
+							} else {
+								$success = 1;
+							}
+						}
+						$action_desc = 'updated';
+					}
                     
-                    //we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
-                    $mtpg_fields = array(
-                        'MTP_user_id'      => $set_column_values['MTP_user_id'],
-                        'MTP_messenger'    => $set_column_values['MTP_messenger'],
-                        'MTP_message_type' => $set_column_values['MTP_message_type'],
-                        'MTP_is_global'    => $set_column_values['MTP_is_global'],
-                        'MTP_is_override'  => $set_column_values['MTP_is_override'],
-                        'MTP_deleted'      => $set_column_values['MTP_deleted'],
-                        'MTP_is_active'    => $set_column_values['MTP_is_active'],
-                        'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
-                            : '',
-                        'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
-                            : ''
-                    );
+					//we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
+					$mtpg_fields = array(
+						'MTP_user_id'      => $set_column_values['MTP_user_id'],
+						'MTP_messenger'    => $set_column_values['MTP_messenger'],
+						'MTP_message_type' => $set_column_values['MTP_message_type'],
+						'MTP_is_global'    => $set_column_values['MTP_is_global'],
+						'MTP_is_override'  => $set_column_values['MTP_is_override'],
+						'MTP_deleted'      => $set_column_values['MTP_deleted'],
+						'MTP_is_active'    => $set_column_values['MTP_is_active'],
+						'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
+							: '',
+						'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
+							: ''
+					);
                     
-                    $mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
-                    $updated    = $MTPG->update($mtpg_fields, array($mtpg_where));
+					$mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
+					$updated    = $MTPG->update($mtpg_fields, array($mtpg_where));
                     
-                    if ($updated === false) {
-                        EE_Error::add_error(
-                            sprintf(
-                                __('The Message Template Group (%d) was NOT updated for some reason', 'event_espresso'),
-                                $set_column_values['GRP_ID']
-                            ),
-                            __FILE__, __FUNCTION__, __LINE__
-                        );
-                    } else {
-                        //k now we need to ensure the template_pack and template_variation fields are set.
-                        $template_pack = ! empty($this->_req_data['MTP_template_pack'])
-                            ? $this->_req_data['MTP_template_pack']
-                            : 'default';
+					if ($updated === false) {
+						EE_Error::add_error(
+							sprintf(
+								__('The Message Template Group (%d) was NOT updated for some reason', 'event_espresso'),
+								$set_column_values['GRP_ID']
+							),
+							__FILE__, __FUNCTION__, __LINE__
+						);
+					} else {
+						//k now we need to ensure the template_pack and template_variation fields are set.
+						$template_pack = ! empty($this->_req_data['MTP_template_pack'])
+							? $this->_req_data['MTP_template_pack']
+							: 'default';
                         
-                        $template_variation = ! empty($this->_req_data['MTP_template_variation'])
-                            ? $this->_req_data['MTP_template_variation']
-                            : 'default';
+						$template_variation = ! empty($this->_req_data['MTP_template_variation'])
+							? $this->_req_data['MTP_template_variation']
+							: 'default';
                         
-                        $mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
-                        if ($mtpg_obj instanceof EE_Message_Template_Group) {
-                            $mtpg_obj->set_template_pack_name($template_pack);
-                            $mtpg_obj->set_template_pack_variation($template_variation);
-                        }
-                        $success = 1;
-                    }
-                }
-            }
+						$mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
+						if ($mtpg_obj instanceof EE_Message_Template_Group) {
+							$mtpg_obj->set_template_pack_name($template_pack);
+							$mtpg_obj->set_template_pack_variation($template_variation);
+						}
+						$success = 1;
+					}
+				}
+			}
             
-        }
-        
-        //we return things differently if doing ajax
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $this->_template_args['success'] = $success;
-            $this->_template_args['error']   = ! $success ? true : false;
-            $this->_template_args['content'] = '';
-            $this->_template_args['data']    = array(
-                'grpID'        => $edit_array['GRP_ID'],
-                'templateName' => $edit_array['template_name']
-            );
-            if ($success) {
-                EE_Error::overwrite_success();
-                EE_Error::add_success(__('The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
-                    'event_espresso'));
-            }
+		}
+        
+		//we return things differently if doing ajax
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$this->_template_args['success'] = $success;
+			$this->_template_args['error']   = ! $success ? true : false;
+			$this->_template_args['content'] = '';
+			$this->_template_args['data']    = array(
+				'grpID'        => $edit_array['GRP_ID'],
+				'templateName' => $edit_array['template_name']
+			);
+			if ($success) {
+				EE_Error::overwrite_success();
+				EE_Error::add_success(__('The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
+					'event_espresso'));
+			}
             
-            $this->_return_json();
-        }
-        
-        
-        //was a test send triggered?
-        if (isset($this->_req_data['test_button'])) {
-            EE_Error::overwrite_success();
-            $this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
-            $override = true;
-        }
-        
-        if (empty($query_args)) {
-            $query_args = array(
-                'id'      => $this->_req_data['GRP_ID'],
-                'context' => $context_slug,
-                'action'  => 'edit_message_template'
-            );
-        }
-        
-        $this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
-    }
-    
-    
-    /**
-     * processes a test send request to do an actual messenger delivery test for the given message template being tested
-     *
-     * @param  string $context      what context being tested
-     * @param  string $messenger    messenger being tested
-     * @param  string $message_type message type being tested
-     *
-     */
-    protected function _do_test_send($context, $messenger, $message_type)
-    {
-        //set things up for preview
-        $this->_req_data['messenger']    = $messenger;
-        $this->_req_data['message_type'] = $message_type;
-        $this->_req_data['context']      = $context;
-        $this->_req_data['GRP_ID']       = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
-        $active_messenger                = $this->_message_resource_manager->get_active_messenger($messenger);
-        
-        //let's save any existing fields that might be required by the messenger
-        if (
-            isset($this->_req_data['test_settings_fld'])
-            && $active_messenger instanceof EE_messenger
-            && apply_filters(
-                'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
-                true,
-                $this->_req_data['test_settings_fld'],
-                $active_messenger
-            )
-        ) {
-            $active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
-        }
-        
-        $success = $this->_preview_message(true);
-        
-        if ($success) {
-            EE_Error::add_success(__('Test message sent', 'event_espresso'));
-        } else {
-            EE_Error::add_error(__('The test message was not sent', 'event_espresso'), __FILE__, __FUNCTION__,
-                __LINE__);
-        }
-    }
-    
-    
-    /**
-     * _generate_new_templates
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
-     * automatically create the defaults for the event.  The user would then be redirected to edit the default context
-     * for the event.
-     *
-     *
-     * @param  string $messenger     the messenger we are generating templates for
-     * @param array   $message_types array of message types that the templates are generated for.
-     * @param int     $GRP_ID        If this is a custom template being generated then a GRP_ID needs to be included to
-     *                               indicate the message_template_group being used as the base.
-     *
-     * @param bool    $global
-     *
-     * @return array|bool array of data required for the redirect to the correct edit page or bool if
-     *                               encountering problems.
-     * @throws \EE_Error
-     */
-    protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
-    {
-        
-        //if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we just don't generate any templates.
-        if (empty($message_types)) {
-            return true;
-        }
-        
-        return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
-    }
-    
-    
-    /**
-     * [_trash_or_restore_message_template]
-     *
-     * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
-     * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
-     *                        an individual context (FALSE).
-     *
-     * @return void
-     */
-    protected function _trash_or_restore_message_template($trash = true, $all = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $MTP = EEM_Message_Template_Group::instance();
-        
-        $success = 1;
-        
-        //incoming GRP_IDs
-        if ($all) {
-            //Checkboxes
-            if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-                //if array has more than one element then success message should be plural.
-                //todo: what about nonce?
-                $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			$this->_return_json();
+		}
+        
+        
+		//was a test send triggered?
+		if (isset($this->_req_data['test_button'])) {
+			EE_Error::overwrite_success();
+			$this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
+			$override = true;
+		}
+        
+		if (empty($query_args)) {
+			$query_args = array(
+				'id'      => $this->_req_data['GRP_ID'],
+				'context' => $context_slug,
+				'action'  => 'edit_message_template'
+			);
+		}
+        
+		$this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
+	}
+    
+    
+	/**
+	 * processes a test send request to do an actual messenger delivery test for the given message template being tested
+	 *
+	 * @param  string $context      what context being tested
+	 * @param  string $messenger    messenger being tested
+	 * @param  string $message_type message type being tested
+	 *
+	 */
+	protected function _do_test_send($context, $messenger, $message_type)
+	{
+		//set things up for preview
+		$this->_req_data['messenger']    = $messenger;
+		$this->_req_data['message_type'] = $message_type;
+		$this->_req_data['context']      = $context;
+		$this->_req_data['GRP_ID']       = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
+		$active_messenger                = $this->_message_resource_manager->get_active_messenger($messenger);
+        
+		//let's save any existing fields that might be required by the messenger
+		if (
+			isset($this->_req_data['test_settings_fld'])
+			&& $active_messenger instanceof EE_messenger
+			&& apply_filters(
+				'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
+				true,
+				$this->_req_data['test_settings_fld'],
+				$active_messenger
+			)
+		) {
+			$active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
+		}
+        
+		$success = $this->_preview_message(true);
+        
+		if ($success) {
+			EE_Error::add_success(__('Test message sent', 'event_espresso'));
+		} else {
+			EE_Error::add_error(__('The test message was not sent', 'event_espresso'), __FILE__, __FUNCTION__,
+				__LINE__);
+		}
+	}
+    
+    
+	/**
+	 * _generate_new_templates
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
+	 * automatically create the defaults for the event.  The user would then be redirected to edit the default context
+	 * for the event.
+	 *
+	 *
+	 * @param  string $messenger     the messenger we are generating templates for
+	 * @param array   $message_types array of message types that the templates are generated for.
+	 * @param int     $GRP_ID        If this is a custom template being generated then a GRP_ID needs to be included to
+	 *                               indicate the message_template_group being used as the base.
+	 *
+	 * @param bool    $global
+	 *
+	 * @return array|bool array of data required for the redirect to the correct edit page or bool if
+	 *                               encountering problems.
+	 * @throws \EE_Error
+	 */
+	protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
+	{
+        
+		//if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we just don't generate any templates.
+		if (empty($message_types)) {
+			return true;
+		}
+        
+		return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
+	}
+    
+    
+	/**
+	 * [_trash_or_restore_message_template]
+	 *
+	 * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
+	 * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
+	 *                        an individual context (FALSE).
+	 *
+	 * @return void
+	 */
+	protected function _trash_or_restore_message_template($trash = true, $all = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$MTP = EEM_Message_Template_Group::instance();
+        
+		$success = 1;
+        
+		//incoming GRP_IDs
+		if ($all) {
+			//Checkboxes
+			if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+				//if array has more than one element then success message should be plural.
+				//todo: what about nonce?
+				$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
                 
-                //cycle through checkboxes
-                while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if ( ! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                }
-            } else {
-                //grab single GRP_ID and handle
-                $GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
-                if ( ! empty($GRP_ID)) {
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if ( ! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                } else {
-                    $success = 0;
-                }
-            }
+				//cycle through checkboxes
+				while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
+					if ( ! $trashed_or_restored) {
+						$success = 0;
+					}
+				}
+			} else {
+				//grab single GRP_ID and handle
+				$GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
+				if ( ! empty($GRP_ID)) {
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
+					if ( ! $trashed_or_restored) {
+						$success = 0;
+					}
+				} else {
+					$success = 0;
+				}
+			}
             
-        }
+		}
         
-        $action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso');
+		$action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso');
         
-        $action_desc = ! empty($this->_req_data['template_switch']) ? __('switched') : $action_desc;
+		$action_desc = ! empty($this->_req_data['template_switch']) ? __('switched') : $action_desc;
         
-        $item_desc = $all ? _n('Message Template Group', 'Message Template Groups', $success,
-            'event_espresso') : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
+		$item_desc = $all ? _n('Message Template Group', 'Message Template Groups', $success,
+			'event_espresso') : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
         
-        $item_desc = ! empty($this->_req_data['template_switch']) ? _n('template', 'templates', $success,
-            'event_espresso') : $item_desc;
+		$item_desc = ! empty($this->_req_data['template_switch']) ? _n('template', 'templates', $success,
+			'event_espresso') : $item_desc;
         
-        $this->_redirect_after_action($success, $item_desc, $action_desc, array());
+		$this->_redirect_after_action($success, $item_desc, $action_desc, array());
         
-    }
+	}
     
     
-    /**
-     * [_delete_message_template]
-     * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
-     * @return void
-     */
-    protected function _delete_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+	/**
+	 * [_delete_message_template]
+	 * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
+	 * @return void
+	 */
+	protected function _delete_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         
-        //checkboxes
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            //if array has more than one element then success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+		//checkboxes
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			//if array has more than one element then success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             
-            //cycle through bulk action checkboxes
-            while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
-                $success = $this->_delete_mtp_permanently($GRP_ID);
-            }
-        } else {
-            //grab single grp_id and delete
-            $GRP_ID  = absint($this->_req_data['id']);
-            $success = $this->_delete_mtp_permanently($GRP_ID);
-        }
-        
-        $this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
-        
-    }
-    
-    
-    /**
-     * helper for permanently deleting a mtP group and all related message_templates
-     *
-     * @param  int  $GRP_ID        The group being deleted
-     * @param  bool $include_group whether to delete the Message Template Group as well.
-     *
-     * @return bool        boolean to indicate the success of the deletes or not.
-     */
-    private function _delete_mtp_permanently($GRP_ID, $include_group = true)
-    {
-        $success = 1;
-        $MTPG    = EEM_Message_Template_Group::instance();
-        //first let's GET this group
-        $MTG = $MTPG->get_one_by_ID($GRP_ID);
-        //then delete permanently all the related Message Templates
-        $deleted = $MTG->delete_related_permanently('Message_Template');
-        
-        if ($deleted === 0) {
-            $success = 0;
-        }
-        
-        //now delete permanently this particular group
-        
-        if ($include_group && ! $MTG->delete_permanently()) {
-            $success = 0;
-        }
-        
-        return $success;
-    }
-    
-    
-    /**
-     *    _learn_more_about_message_templates_link
-     * @access protected
-     * @return string
-     */
-    protected function _learn_more_about_message_templates_link()
-    {
-        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >' . __('learn more about how message templates works',
-            'event_espresso') . '</a>';
-    }
-    
-    
-    /**
-     * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
-     * ajax and other routes.
-     * @return void
-     */
-    protected function _settings()
-    {
-        
-        
-        $this->_set_m_mt_settings();
-        
-        $selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
-        
-        //let's setup the messenger tabs
-        $this->_template_args['admin_page_header']         = EEH_Tabbed_Content::tab_text_links($this->_m_mt_settings['messenger_tabs'],
-            'messenger_links', '|', $selected_messenger);
-        $this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
-        $this->_template_args['after_admin_page_content']  = '</div><!-- end .ui-widget -->';
-        
-        $this->display_admin_page_with_sidebar();
-        
-    }
-    
-    
-    /**
-     * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_m_mt_settings()
-    {
-        //first if this is already set then lets get out no need to regenerate data.
-        if ( ! empty($this->_m_mt_settings)) {
-            return;
-        }
-        
-        //$selected_messenger = isset( $this->_req_data['selected_messenger'] ) ? $this->_req_data['selected_messenger'] : 'email';
-        
-        //get all installed messengers and message_types
-        /** @type EE_messenger[] $messengers */
-        $messengers = $this->_message_resource_manager->installed_messengers();
-        /** @type EE_message_type[] $message_types */
-        $message_types = $this->_message_resource_manager->installed_message_types();
-        
-        
-        //assemble the array for the _tab_text_links helper
-        
-        foreach ($messengers as $messenger) {
-            $this->_m_mt_settings['messenger_tabs'][$messenger->name] = array(
-                'label' => ucwords($messenger->label['singular']),
-                'class' => $this->_message_resource_manager->is_messenger_active($messenger->name) ? 'messenger-active' : '',
-                'href'  => $messenger->name,
-                'title' => __('Modify this Messenger', 'event_espresso'),
-                'slug'  => $messenger->name,
-                'obj'   => $messenger
-            );
+			//cycle through bulk action checkboxes
+			while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
+				$success = $this->_delete_mtp_permanently($GRP_ID);
+			}
+		} else {
+			//grab single grp_id and delete
+			$GRP_ID  = absint($this->_req_data['id']);
+			$success = $this->_delete_mtp_permanently($GRP_ID);
+		}
+        
+		$this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
+        
+	}
+    
+    
+	/**
+	 * helper for permanently deleting a mtP group and all related message_templates
+	 *
+	 * @param  int  $GRP_ID        The group being deleted
+	 * @param  bool $include_group whether to delete the Message Template Group as well.
+	 *
+	 * @return bool        boolean to indicate the success of the deletes or not.
+	 */
+	private function _delete_mtp_permanently($GRP_ID, $include_group = true)
+	{
+		$success = 1;
+		$MTPG    = EEM_Message_Template_Group::instance();
+		//first let's GET this group
+		$MTG = $MTPG->get_one_by_ID($GRP_ID);
+		//then delete permanently all the related Message Templates
+		$deleted = $MTG->delete_related_permanently('Message_Template');
+        
+		if ($deleted === 0) {
+			$success = 0;
+		}
+        
+		//now delete permanently this particular group
+        
+		if ($include_group && ! $MTG->delete_permanently()) {
+			$success = 0;
+		}
+        
+		return $success;
+	}
+    
+    
+	/**
+	 *    _learn_more_about_message_templates_link
+	 * @access protected
+	 * @return string
+	 */
+	protected function _learn_more_about_message_templates_link()
+	{
+		return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >' . __('learn more about how message templates works',
+			'event_espresso') . '</a>';
+	}
+    
+    
+	/**
+	 * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
+	 * ajax and other routes.
+	 * @return void
+	 */
+	protected function _settings()
+	{
+        
+        
+		$this->_set_m_mt_settings();
+        
+		$selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
+        
+		//let's setup the messenger tabs
+		$this->_template_args['admin_page_header']         = EEH_Tabbed_Content::tab_text_links($this->_m_mt_settings['messenger_tabs'],
+			'messenger_links', '|', $selected_messenger);
+		$this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
+		$this->_template_args['after_admin_page_content']  = '</div><!-- end .ui-widget -->';
+        
+		$this->display_admin_page_with_sidebar();
+        
+	}
+    
+    
+	/**
+	 * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_m_mt_settings()
+	{
+		//first if this is already set then lets get out no need to regenerate data.
+		if ( ! empty($this->_m_mt_settings)) {
+			return;
+		}
+        
+		//$selected_messenger = isset( $this->_req_data['selected_messenger'] ) ? $this->_req_data['selected_messenger'] : 'email';
+        
+		//get all installed messengers and message_types
+		/** @type EE_messenger[] $messengers */
+		$messengers = $this->_message_resource_manager->installed_messengers();
+		/** @type EE_message_type[] $message_types */
+		$message_types = $this->_message_resource_manager->installed_message_types();
+        
+        
+		//assemble the array for the _tab_text_links helper
+        
+		foreach ($messengers as $messenger) {
+			$this->_m_mt_settings['messenger_tabs'][$messenger->name] = array(
+				'label' => ucwords($messenger->label['singular']),
+				'class' => $this->_message_resource_manager->is_messenger_active($messenger->name) ? 'messenger-active' : '',
+				'href'  => $messenger->name,
+				'title' => __('Modify this Messenger', 'event_espresso'),
+				'slug'  => $messenger->name,
+				'obj'   => $messenger
+			);
             
             
-            $message_types_for_messenger = $messenger->get_valid_message_types();
+			$message_types_for_messenger = $messenger->get_valid_message_types();
             
-            foreach ($message_types as $message_type) {
-                //first we need to verify that this message type is valid with this messenger. Cause if it isn't then it shouldn't show in either the inactive OR active metabox.
-                if ( ! in_array($message_type->name, $message_types_for_messenger)) {
-                    continue;
-                }
+			foreach ($message_types as $message_type) {
+				//first we need to verify that this message type is valid with this messenger. Cause if it isn't then it shouldn't show in either the inactive OR active metabox.
+				if ( ! in_array($message_type->name, $message_types_for_messenger)) {
+					continue;
+				}
                 
-                $a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger($messenger->name,
-                    $message_type->name) ? 'active' : 'inactive';
+				$a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger($messenger->name,
+					$message_type->name) ? 'active' : 'inactive';
                 
-                $this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array(
-                    'label'    => ucwords($message_type->label['singular']),
-                    'class'    => 'message-type-' . $a_or_i,
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
-                    'title'    => $a_or_i == 'active'
-                        ? __('Drag this message type to the Inactive window to deactivate', 'event_espresso')
-                        : __('Drag this message type to the messenger to activate', 'event_espresso'),
-                    'content'  => $a_or_i == 'active'
-                        ? $this->_message_type_settings_content($message_type, $messenger, true)
-                        : $this->_message_type_settings_content($message_type, $messenger),
-                    'slug'     => $message_type->name,
-                    'active'   => $a_or_i == 'active' ? true : false,
-                    'obj'      => $message_type
-                );
-            }
-        }
-    }
-    
-    
-    /**
-     * This just prepares the content for the message type settings
-     *
-     * @param  object  $message_type The message type object
-     * @param  object  $messenger    The messenger object
-     * @param  boolean $active       Whether the message type is active or not
-     *
-     * @return string                html output for the content
-     */
-    protected function _message_type_settings_content($message_type, $messenger, $active = false)
-    {
-        //get message type fields
-        $fields                                         = $message_type->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-        
-        if ( ! empty($fields) && $active) {
+				$this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array(
+					'label'    => ucwords($message_type->label['singular']),
+					'class'    => 'message-type-' . $a_or_i,
+					'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
+					'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
+					'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
+					'title'    => $a_or_i == 'active'
+						? __('Drag this message type to the Inactive window to deactivate', 'event_espresso')
+						: __('Drag this message type to the messenger to activate', 'event_espresso'),
+					'content'  => $a_or_i == 'active'
+						? $this->_message_type_settings_content($message_type, $messenger, true)
+						: $this->_message_type_settings_content($message_type, $messenger),
+					'slug'     => $message_type->name,
+					'active'   => $a_or_i == 'active' ? true : false,
+					'obj'      => $message_type
+				);
+			}
+		}
+	}
+    
+    
+	/**
+	 * This just prepares the content for the message type settings
+	 *
+	 * @param  object  $message_type The message type object
+	 * @param  object  $messenger    The messenger object
+	 * @param  boolean $active       Whether the message type is active or not
+	 *
+	 * @return string                html output for the content
+	 */
+	protected function _message_type_settings_content($message_type, $messenger, $active = false)
+	{
+		//get message type fields
+		$fields                                         = $message_type->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+        
+		if ( ! empty($fields) && $active) {
             
-            $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
+			$existing_settings = $message_type->get_existing_admin_settings($messenger->name);
             
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id                       = $messenger->name . '-' . $message_type->name . '-' . $fldname;
-                $template_form_field[$field_id] = array(
-                    'name'       => 'message_type_settings[' . $fldname . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
-                    'options'    => isset($fldprops['options']) ? $fldprops['options'] : array(),
-                    'default'    => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
-                    'css_class'  => 'no-drag',
-                    'format'     => $fldprops['format']
-                );
-            }
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id                       = $messenger->name . '-' . $message_type->name . '-' . $fldname;
+				$template_form_field[$field_id] = array(
+					'name'       => 'message_type_settings[' . $fldname . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
+					'options'    => isset($fldprops['options']) ? $fldprops['options'] : array(),
+					'default'    => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
+					'css_class'  => 'no-drag',
+					'format'     => $fldprops['format']
+				);
+			}
             
             
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field) ? $this->_generate_admin_form_fields($template_form_field,
-                'string', 'ee_mt_activate_form') : '';
-        }
-        
-        $settings_template_args['description'] = $message_type->description;
-        //we also need some hidden fields
-        $settings_template_args['hidden_fields'] = array(
-            'message_type_settings[messenger]'    => array(
-                'type'  => 'hidden',
-                'value' => $messenger->name
-            ),
-            'message_type_settings[message_type]' => array(
-                'type'  => 'hidden',
-                'value' => $message_type->name
-            ),
-            'type'                                => array(
-                'type'  => 'hidden',
-                'value' => 'message_type'
-            )
-        );
-        
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields($settings_template_args['hidden_fields'],
-            'array');
-        $settings_template_args['show_form']     = empty($settings_template_args['template_form_fields']) ? ' hidden' : '';
-        
-        
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
-        $content  = EEH_Template::display_template($template, $settings_template_args, true);
-        
-        return $content;
-    }
-    
-    
-    /**
-     * Generate all the metaboxes for the message types and register them for the messages settings page.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _messages_settings_metaboxes()
-    {
-        $this->_set_m_mt_settings();
-        $m_boxes         = $mt_boxes = array();
-        $m_template_args = $mt_template_args = array();
-        
-        $selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
-        
-        if (isset($this->_m_mt_settings['messenger_tabs'])) {
-            foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
-                $hide_on_message  = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
-                $hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
-                //messenger meta boxes
-                $active                                 = $selected_messenger == $messenger ? true : false;
-                $active_mt_tabs                         = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active'])
-                    ? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
-                    : '';
-                $m_boxes[$messenger . '_a_box']         = sprintf(
-                    __('%s Settings', 'event_espresso'),
-                    $tab_array['label']
-                );
-                $m_template_args[$messenger . '_a_box'] = array(
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        : '',
-                    'content'                => $this->_get_messenger_box_content($tab_array['obj']),
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active
-                );
-                // message type meta boxes
-                // (which is really just the inactive container for each messenger
-                // showing inactive message types for that messenger)
-                $mt_boxes[$messenger . '_i_box']         = __('Inactive Message Types', 'event_espresso');
-                $mt_template_args[$messenger . '_i_box'] = array(
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        : '',
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'hide_off_message'       => $hide_off_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active
-                );
-            }
-        }
-        
-        
-        //register messenger metaboxes
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
-        foreach ($m_boxes as $box => $label) {
-            $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]);
-            $msgr          = str_replace('_a_box', '', $box);
-            add_meta_box(
-                'espresso_' . $msgr . '_settings',
-                $label,
-                function ($post, $metabox) {
-                    echo EEH_Template::display_template($metabox["args"]["template_path"],
-                        $metabox["args"]["template_args"], true);
-                },
-                $this->_current_screen->id,
-                'normal',
-                'high',
-                $callback_args
-            );
-        }
-        
-        //register message type metaboxes
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
-        foreach ($mt_boxes as $box => $label) {
-            $callback_args = array(
-                'template_path' => $mt_template_path,
-                'template_args' => $mt_template_args[$box]
-            );
-            $mt            = str_replace('_i_box', '', $box);
-            add_meta_box(
-                'espresso_' . $mt . '_inactive_mts',
-                $label,
-                function ($post, $metabox) {
-                    echo EEH_Template::display_template($metabox["args"]["template_path"],
-                        $metabox["args"]["template_args"], true);
-                },
-                $this->_current_screen->id,
-                'side',
-                'high',
-                $callback_args
-            );
-        }
-        
-        //register metabox for global messages settings but only when on the main site.  On single site installs this will
-        //always result in the metabox showing, on multisite installs the metabox will only show on the main site.
-        if (is_main_site()) {
-            add_meta_box(
-                'espresso_global_message_settings',
-                __('Global Message Settings', 'event_espresso'),
-                array($this, 'global_messages_settings_metabox_content'),
-                $this->_current_screen->id,
-                'normal',
-                'low',
-                array()
-            );
-        }
-        
-    }
-    
-    
-    /**
-     *  This generates the content for the global messages settings metabox.
-     * @return string
-     */
-    public function global_messages_settings_metabox_content()
-    {
-        $form = $this->_generate_global_settings_form();
-        echo $form->form_open(
-                $this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
-                'POST'
-            )
-             . $form->get_html()
-             . $form->form_close();
-    }
-    
-    
-    /**
-     * This generates and returns the form object for the global messages settings.
-     * @return EE_Form_Section_Proper
-     */
-    protected function _generate_global_settings_form()
-    {
-        EE_Registry::instance()->load_helper('HTML');
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config = EE_Registry::instance()->NET_CFG->core;
-        
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'global_messages_settings',
-                'html_id'         => 'global_messages_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
-                    array(
-                        'do_messages_on_same_request' => new EE_Select_Input(
-                            array(
-                                true  => __("On the same request", "event_espresso"),
-                                false => __("On a separate request", "event_espresso")
-                            ),
-                            array(
-                                'default'         => $network_config->do_messages_on_same_request,
-                                'html_label_text' => __('Generate and send all messages:', 'event_espresso'),
-                                'html_help_text'  => __('By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
-                                    'event_espresso'),
-                            )
-                        ),
-                        'update_settings'             => new EE_Submit_Input(
-                            array(
-                                'default'         => __('Update', 'event_espresso'),
-                                'html_label_text' => '&nbsp'
-                            )
-                        )
-                    )
-                )
-            )
-        );
-    }
-    
-    
-    /**
-     * This handles updating the global settings set on the admin page.
-     * @throws \EE_Error
-     */
-    protected function _update_global_settings()
-    {
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config = EE_Registry::instance()->NET_CFG->core;
-        $form           = $this->_generate_global_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $valid_data = $form->valid_data();
-                foreach ($valid_data as $property => $value) {
-                    $setter = 'set_' . $property;
-                    if (method_exists($network_config, $setter)) {
-                        $network_config->{$setter}($value);
-                    } else if (
-                        property_exists($network_config, $property)
-                        && $network_config->{$property} !== $value
-                    ) {
-                        $network_config->{$property} = $value;
-                    }
-                }
-                //only update if the form submission was valid!
-                EE_Registry::instance()->NET_CFG->update_config(true, false);
-                EE_Error::overwrite_success();
-                EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
-            }
-        }
-        $this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
-    }
-    
-    
-    /**
-     * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
-     *
-     * @param  array $tab_array This is an array of message type tab details used to generate the tabs
-     *
-     * @return string            html formatted tabs
-     */
-    protected function _get_mt_tabs($tab_array)
-    {
-        $tab_array = (array)$tab_array;
-        $template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
-        $tabs      = '';
-        
-        foreach ($tab_array as $tab) {
-            $tabs .= EEH_Template::display_template($template, $tab, true);
-        }
-        
-        return $tabs;
-    }
-    
-    
-    /**
-     * This prepares the content of the messenger meta box admin settings
-     *
-     * @param  EE_messenger $messenger The messenger we're setting up content for
-     *
-     * @return string            html formatted content
-     */
-    protected function _get_messenger_box_content(EE_messenger $messenger)
-    {
-        
-        $fields                                         = $messenger->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-        
-        //is $messenger active?
-        $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
-        
-        
-        if ( ! empty($fields)) {
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field) ? $this->_generate_admin_form_fields($template_form_field,
+				'string', 'ee_mt_activate_form') : '';
+		}
+        
+		$settings_template_args['description'] = $message_type->description;
+		//we also need some hidden fields
+		$settings_template_args['hidden_fields'] = array(
+			'message_type_settings[messenger]'    => array(
+				'type'  => 'hidden',
+				'value' => $messenger->name
+			),
+			'message_type_settings[message_type]' => array(
+				'type'  => 'hidden',
+				'value' => $message_type->name
+			),
+			'type'                                => array(
+				'type'  => 'hidden',
+				'value' => 'message_type'
+			)
+		);
+        
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields($settings_template_args['hidden_fields'],
+			'array');
+		$settings_template_args['show_form']     = empty($settings_template_args['template_form_fields']) ? ' hidden' : '';
+        
+        
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
+		$content  = EEH_Template::display_template($template, $settings_template_args, true);
+        
+		return $content;
+	}
+    
+    
+	/**
+	 * Generate all the metaboxes for the message types and register them for the messages settings page.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _messages_settings_metaboxes()
+	{
+		$this->_set_m_mt_settings();
+		$m_boxes         = $mt_boxes = array();
+		$m_template_args = $mt_template_args = array();
+        
+		$selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
+        
+		if (isset($this->_m_mt_settings['messenger_tabs'])) {
+			foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
+				$hide_on_message  = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
+				$hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
+				//messenger meta boxes
+				$active                                 = $selected_messenger == $messenger ? true : false;
+				$active_mt_tabs                         = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active'])
+					? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
+					: '';
+				$m_boxes[$messenger . '_a_box']         = sprintf(
+					__('%s Settings', 'event_espresso'),
+					$tab_array['label']
+				);
+				$m_template_args[$messenger . '_a_box'] = array(
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						: '',
+					'content'                => $this->_get_messenger_box_content($tab_array['obj']),
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'messenger'              => $messenger,
+					'active'                 => $active
+				);
+				// message type meta boxes
+				// (which is really just the inactive container for each messenger
+				// showing inactive message types for that messenger)
+				$mt_boxes[$messenger . '_i_box']         = __('Inactive Message Types', 'event_espresso');
+				$mt_template_args[$messenger . '_i_box'] = array(
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						: '',
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'hide_off_message'       => $hide_off_message,
+					'messenger'              => $messenger,
+					'active'                 => $active
+				);
+			}
+		}
+        
+        
+		//register messenger metaboxes
+		$m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
+		foreach ($m_boxes as $box => $label) {
+			$callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]);
+			$msgr          = str_replace('_a_box', '', $box);
+			add_meta_box(
+				'espresso_' . $msgr . '_settings',
+				$label,
+				function ($post, $metabox) {
+					echo EEH_Template::display_template($metabox["args"]["template_path"],
+						$metabox["args"]["template_args"], true);
+				},
+				$this->_current_screen->id,
+				'normal',
+				'high',
+				$callback_args
+			);
+		}
+        
+		//register message type metaboxes
+		$mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
+		foreach ($mt_boxes as $box => $label) {
+			$callback_args = array(
+				'template_path' => $mt_template_path,
+				'template_args' => $mt_template_args[$box]
+			);
+			$mt            = str_replace('_i_box', '', $box);
+			add_meta_box(
+				'espresso_' . $mt . '_inactive_mts',
+				$label,
+				function ($post, $metabox) {
+					echo EEH_Template::display_template($metabox["args"]["template_path"],
+						$metabox["args"]["template_args"], true);
+				},
+				$this->_current_screen->id,
+				'side',
+				'high',
+				$callback_args
+			);
+		}
+        
+		//register metabox for global messages settings but only when on the main site.  On single site installs this will
+		//always result in the metabox showing, on multisite installs the metabox will only show on the main site.
+		if (is_main_site()) {
+			add_meta_box(
+				'espresso_global_message_settings',
+				__('Global Message Settings', 'event_espresso'),
+				array($this, 'global_messages_settings_metabox_content'),
+				$this->_current_screen->id,
+				'normal',
+				'low',
+				array()
+			);
+		}
+        
+	}
+    
+    
+	/**
+	 *  This generates the content for the global messages settings metabox.
+	 * @return string
+	 */
+	public function global_messages_settings_metabox_content()
+	{
+		$form = $this->_generate_global_settings_form();
+		echo $form->form_open(
+				$this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
+				'POST'
+			)
+			 . $form->get_html()
+			 . $form->form_close();
+	}
+    
+    
+	/**
+	 * This generates and returns the form object for the global messages settings.
+	 * @return EE_Form_Section_Proper
+	 */
+	protected function _generate_global_settings_form()
+	{
+		EE_Registry::instance()->load_helper('HTML');
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config = EE_Registry::instance()->NET_CFG->core;
+        
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'global_messages_settings',
+				'html_id'         => 'global_messages_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
+					array(
+						'do_messages_on_same_request' => new EE_Select_Input(
+							array(
+								true  => __("On the same request", "event_espresso"),
+								false => __("On a separate request", "event_espresso")
+							),
+							array(
+								'default'         => $network_config->do_messages_on_same_request,
+								'html_label_text' => __('Generate and send all messages:', 'event_espresso'),
+								'html_help_text'  => __('By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
+									'event_espresso'),
+							)
+						),
+						'update_settings'             => new EE_Submit_Input(
+							array(
+								'default'         => __('Update', 'event_espresso'),
+								'html_label_text' => '&nbsp'
+							)
+						)
+					)
+				)
+			)
+		);
+	}
+    
+    
+	/**
+	 * This handles updating the global settings set on the admin page.
+	 * @throws \EE_Error
+	 */
+	protected function _update_global_settings()
+	{
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config = EE_Registry::instance()->NET_CFG->core;
+		$form           = $this->_generate_global_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$valid_data = $form->valid_data();
+				foreach ($valid_data as $property => $value) {
+					$setter = 'set_' . $property;
+					if (method_exists($network_config, $setter)) {
+						$network_config->{$setter}($value);
+					} else if (
+						property_exists($network_config, $property)
+						&& $network_config->{$property} !== $value
+					) {
+						$network_config->{$property} = $value;
+					}
+				}
+				//only update if the form submission was valid!
+				EE_Registry::instance()->NET_CFG->update_config(true, false);
+				EE_Error::overwrite_success();
+				EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
+			}
+		}
+		$this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
+	}
+    
+    
+	/**
+	 * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
+	 *
+	 * @param  array $tab_array This is an array of message type tab details used to generate the tabs
+	 *
+	 * @return string            html formatted tabs
+	 */
+	protected function _get_mt_tabs($tab_array)
+	{
+		$tab_array = (array)$tab_array;
+		$template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
+		$tabs      = '';
+        
+		foreach ($tab_array as $tab) {
+			$tabs .= EEH_Template::display_template($template, $tab, true);
+		}
+        
+		return $tabs;
+	}
+    
+    
+	/**
+	 * This prepares the content of the messenger meta box admin settings
+	 *
+	 * @param  EE_messenger $messenger The messenger we're setting up content for
+	 *
+	 * @return string            html formatted content
+	 */
+	protected function _get_messenger_box_content(EE_messenger $messenger)
+	{
+        
+		$fields                                         = $messenger->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+        
+		//is $messenger active?
+		$settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
+        
+        
+		if ( ! empty($fields)) {
             
-            $existing_settings = $messenger->get_existing_admin_settings();
+			$existing_settings = $messenger->get_existing_admin_settings();
             
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id                       = $messenger->name . '-' . $fldname;
-                $template_form_field[$field_id] = array(
-                    'name'       => 'messenger_settings[' . $field_id . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[$field_id])
-                        ? $existing_settings[$field_id]
-                        : $fldprops['default'],
-                    'css_class'  => '',
-                    'format'     => $fldprops['format']
-                );
-            }
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id                       = $messenger->name . '-' . $fldname;
+				$template_form_field[$field_id] = array(
+					'name'       => 'messenger_settings[' . $field_id . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[$field_id])
+						? $existing_settings[$field_id]
+						: $fldprops['default'],
+					'css_class'  => '',
+					'format'     => $fldprops['format']
+				);
+			}
             
             
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
-                ? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
-                : '';
-        }
-        
-        //we also need some hidden fields
-        $settings_template_args['hidden_fields'] = array(
-            'messenger_settings[messenger]' => array(
-                'type'  => 'hidden',
-                'value' => $messenger->name
-            ),
-            'type'                          => array(
-                'type'  => 'hidden',
-                'value' => 'messenger'
-            )
-        );
-        
-        //make sure any active message types that are existing are included in the hidden fields
-        if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
-            foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
-                $settings_template_args['hidden_fields']['messenger_settings[message_types][' . $mt . ']'] = array(
-                    'type'  => 'hidden',
-                    'value' => $mt
-                );
-            }
-        }
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
-            $settings_template_args['hidden_fields'],
-            'array'
-        );
-        $active                                  = $this->_message_resource_manager->is_messenger_active($messenger->name);
-        
-        $settings_template_args['messenger']           = $messenger->name;
-        $settings_template_args['description']         = $messenger->description;
-        $settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
-        
-        
-        $settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active($messenger->name)
-            ? $settings_template_args['show_hide_edit_form']
-            : ' hidden';
-        
-        $settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
-            ? ' hidden'
-            : $settings_template_args['show_hide_edit_form'];
-        
-        
-        $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
-        $settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
-        $settings_template_args['on_off_status'] = $active ? true : false;
-        $template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
-        $content                                 = EEH_Template::display_template($template, $settings_template_args,
-            true);
-        
-        return $content;
-    }
-    
-    
-    /**
-     * used by ajax on the messages settings page to activate|deactivate the messenger
-     */
-    public function activate_messenger_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-        //let's check that we have required data
-        if ( ! isset($this->_req_data['messenger'])) {
-            EE_Error::add_error(
-                __('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        
-        //do a nonce check here since we're not arriving via a normal route
-        $nonce     = isset($this->_req_data['activate_nonce']) ? sanitize_text_field($this->_req_data['activate_nonce']) : '';
-        $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
-        
-        $this->_verify_nonce($nonce, $nonce_ref);
-        
-        
-        if ( ! isset($this->_req_data['status'])) {
-            EE_Error::add_error(
-                __(
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        
-        //do check to verify we have a valid status.
-        $status = $this->_req_data['status'];
-        
-        if ($status != 'off' && $status != 'on') {
-            EE_Error::add_error(
-                sprintf(
-                    __('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
-                    $this->_req_data['status']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        
-        if ($success) {
-            //made it here?  Stop dawdling then!!
-            $success = $status == 'off'
-                ? $this->_deactivate_messenger($this->_req_data['messenger'])
-                : $this->_activate_messenger($this->_req_data['messenger']);
-        }
-        
-        $this->_template_args['success'] = $success;
-        
-        //no special instructions so let's just do the json return (which should automatically do all the special stuff).
-        $this->_return_json();
-        
-    }
-    
-    
-    /**
-     * used by ajax from the messages settings page to activate|deactivate a message type
-     *
-     */
-    public function activate_mt_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-        
-        //let's make sure we have the necessary data
-        if ( ! isset($this->_req_data['message_type'])) {
-            EE_Error::add_error(
-                __('Message Type name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        if ( ! isset($this->_req_data['messenger'])) {
-            EE_Error::add_error(
-                __('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        if ( ! isset($this->_req_data['status'])) {
-            EE_Error::add_error(
-                __('Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        
-        //do check to verify we have a valid status.
-        $status = $this->_req_data['status'];
-        
-        if ($status != 'activate' && $status != 'deactivate') {
-            EE_Error::add_error(
-                sprintf(
-                    __('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
-                    $this->_req_data['status']
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        
-        //do a nonce check here since we're not arriving via a normal route
-        $nonce     = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
-        $nonce_ref = $this->_req_data['message_type'] . '_nonce';
-        
-        $this->_verify_nonce($nonce, $nonce_ref);
-        
-        if ($success) {
-            //made it here? um, what are you waiting for then?
-            $success = $status == 'deactivate'
-                ? $this->_deactivate_message_type_for_messenger($this->_req_data['messenger'],
-                    $this->_req_data['message_type'])
-                : $this->_activate_message_type_for_messenger($this->_req_data['messenger'],
-                    $this->_req_data['message_type']);
-        }
-        
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-    
-    
-    /**
-     * Takes care of processing activating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     *
-     * @return bool
-     */
-    protected function _activate_messenger($messenger_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger          = $this->_message_resource_manager->get_messenger($messenger_name);
-        $message_types_to_activate = $active_messenger instanceof EE_Messenger ? $active_messenger->get_default_message_types() : array();
-        
-        //ensure is active
-        $this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate);
-        
-        //set response_data for reload
-        foreach ($message_types_to_activate as $message_type_name) {
-            /** @var EE_message_type $message_type */
-            $message_type = $this->_message_resource_manager->get_message_type($message_type_name);
-            if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
-                    $message_type_name)
-                && $message_type instanceof EE_message_type
-            ) {
-                $this->_template_args['data']['active_mts'][] = $message_type_name;
-                if ($message_type->get_admin_settings_fields()) {
-                    $this->_template_args['data']['mt_reload'][] = $message_type_name;
-                }
-            }
-        }
-        
-        //add success message for activating messenger
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
-        
-    }
-    
-    
-    /**
-     * Takes care of processing deactivating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     *
-     * @return bool
-     */
-    protected function _deactivate_messenger($messenger_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        $this->_message_resource_manager->deactivate_messenger($messenger_name);
-        
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
-    }
-    
-    
-    /**
-     * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being activated for.
-     * @param string $message_type_name The name of the message type being activated for the messenger
-     *
-     * @return bool
-     */
-    protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
-        $message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
-        
-        //ensure is active
-        $this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name);
-        
-        //set response for load
-        if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
-            $message_type_name)
-        ) {
-            $this->_template_args['data']['active_mts'][] = $message_type_name;
-            if ($message_type_to_activate->get_admin_settings_fields()) {
-                $this->_template_args['data']['mt_reload'][] = $message_type_name;
-            }
-        }
-        
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger,
-            $message_type_to_activate);
-    }
-    
-    
-    /**
-     * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
-     * @param string $message_type_name The name of the message type being deactivated for the messenger
-     *
-     * @return bool
-     */
-    protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
-        $message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
-        $this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
-        
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger,
-            $message_type_to_deactivate);
-    }
-    
-    
-    /**
-     * This just initializes the defaults for activating messenger and message type responses.
-     */
-    protected function _prep_default_response_for_messenger_or_message_type_toggle()
-    {
-        $this->_template_args['data']['active_mts'] = array();
-        $this->_template_args['data']['mt_reload']  = array();
-    }
-    
-    
-    /**
-     * Setup appropriate response for activating a messenger and/or message types
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _setup_response_message_for_activating_messenger_with_message_types(
-        $messenger,
-        EE_Message_Type $message_type = null
-    ) {
-        //if $messenger isn't a valid messenger object then get out.
-        if ( ! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                __('The messenger being activated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
+				? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
+				: '';
+		}
+        
+		//we also need some hidden fields
+		$settings_template_args['hidden_fields'] = array(
+			'messenger_settings[messenger]' => array(
+				'type'  => 'hidden',
+				'value' => $messenger->name
+			),
+			'type'                          => array(
+				'type'  => 'hidden',
+				'value' => 'messenger'
+			)
+		);
+        
+		//make sure any active message types that are existing are included in the hidden fields
+		if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
+			foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
+				$settings_template_args['hidden_fields']['messenger_settings[message_types][' . $mt . ']'] = array(
+					'type'  => 'hidden',
+					'value' => $mt
+				);
+			}
+		}
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
+			$settings_template_args['hidden_fields'],
+			'array'
+		);
+		$active                                  = $this->_message_resource_manager->is_messenger_active($messenger->name);
+        
+		$settings_template_args['messenger']           = $messenger->name;
+		$settings_template_args['description']         = $messenger->description;
+		$settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
+        
+        
+		$settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active($messenger->name)
+			? $settings_template_args['show_hide_edit_form']
+			: ' hidden';
+        
+		$settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
+			? ' hidden'
+			: $settings_template_args['show_hide_edit_form'];
+        
+        
+		$settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
+		$settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
+		$settings_template_args['on_off_status'] = $active ? true : false;
+		$template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
+		$content                                 = EEH_Template::display_template($template, $settings_template_args,
+			true);
+        
+		return $content;
+	}
+    
+    
+	/**
+	 * used by ajax on the messages settings page to activate|deactivate the messenger
+	 */
+	public function activate_messenger_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+		//let's check that we have required data
+		if ( ! isset($this->_req_data['messenger'])) {
+			EE_Error::add_error(
+				__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+        
+		//do a nonce check here since we're not arriving via a normal route
+		$nonce     = isset($this->_req_data['activate_nonce']) ? sanitize_text_field($this->_req_data['activate_nonce']) : '';
+		$nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
+        
+		$this->_verify_nonce($nonce, $nonce_ref);
+        
+        
+		if ( ! isset($this->_req_data['status'])) {
+			EE_Error::add_error(
+				__(
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+        
+		//do check to verify we have a valid status.
+		$status = $this->_req_data['status'];
+        
+		if ($status != 'off' && $status != 'on') {
+			EE_Error::add_error(
+				sprintf(
+					__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
+					$this->_req_data['status']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+        
+		if ($success) {
+			//made it here?  Stop dawdling then!!
+			$success = $status == 'off'
+				? $this->_deactivate_messenger($this->_req_data['messenger'])
+				: $this->_activate_messenger($this->_req_data['messenger']);
+		}
+        
+		$this->_template_args['success'] = $success;
+        
+		//no special instructions so let's just do the json return (which should automatically do all the special stuff).
+		$this->_return_json();
+        
+	}
+    
+    
+	/**
+	 * used by ajax from the messages settings page to activate|deactivate a message type
+	 *
+	 */
+	public function activate_mt_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+        
+		//let's make sure we have the necessary data
+		if ( ! isset($this->_req_data['message_type'])) {
+			EE_Error::add_error(
+				__('Message Type name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+		if ( ! isset($this->_req_data['messenger'])) {
+			EE_Error::add_error(
+				__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+		if ( ! isset($this->_req_data['status'])) {
+			EE_Error::add_error(
+				__('Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+        
+		//do check to verify we have a valid status.
+		$status = $this->_req_data['status'];
+        
+		if ($status != 'activate' && $status != 'deactivate') {
+			EE_Error::add_error(
+				sprintf(
+					__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
+					$this->_req_data['status']
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+        
+		//do a nonce check here since we're not arriving via a normal route
+		$nonce     = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
+		$nonce_ref = $this->_req_data['message_type'] . '_nonce';
+        
+		$this->_verify_nonce($nonce, $nonce_ref);
+        
+		if ($success) {
+			//made it here? um, what are you waiting for then?
+			$success = $status == 'deactivate'
+				? $this->_deactivate_message_type_for_messenger($this->_req_data['messenger'],
+					$this->_req_data['message_type'])
+				: $this->_activate_message_type_for_messenger($this->_req_data['messenger'],
+					$this->_req_data['message_type']);
+		}
+        
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+    
+    
+	/**
+	 * Takes care of processing activating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 *
+	 * @return bool
+	 */
+	protected function _activate_messenger($messenger_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger          = $this->_message_resource_manager->get_messenger($messenger_name);
+		$message_types_to_activate = $active_messenger instanceof EE_Messenger ? $active_messenger->get_default_message_types() : array();
+        
+		//ensure is active
+		$this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate);
+        
+		//set response_data for reload
+		foreach ($message_types_to_activate as $message_type_name) {
+			/** @var EE_message_type $message_type */
+			$message_type = $this->_message_resource_manager->get_message_type($message_type_name);
+			if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
+					$message_type_name)
+				&& $message_type instanceof EE_message_type
+			) {
+				$this->_template_args['data']['active_mts'][] = $message_type_name;
+				if ($message_type->get_admin_settings_fields()) {
+					$this->_template_args['data']['mt_reload'][] = $message_type_name;
+				}
+			}
+		}
+        
+		//add success message for activating messenger
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
+        
+	}
+    
+    
+	/**
+	 * Takes care of processing deactivating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 *
+	 * @return bool
+	 */
+	protected function _deactivate_messenger($messenger_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		$this->_message_resource_manager->deactivate_messenger($messenger_name);
+        
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
+	}
+    
+    
+	/**
+	 * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being activated for.
+	 * @param string $message_type_name The name of the message type being activated for the messenger
+	 *
+	 * @return bool
+	 */
+	protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
+		$message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
+        
+		//ensure is active
+		$this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name);
+        
+		//set response for load
+		if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
+			$message_type_name)
+		) {
+			$this->_template_args['data']['active_mts'][] = $message_type_name;
+			if ($message_type_to_activate->get_admin_settings_fields()) {
+				$this->_template_args['data']['mt_reload'][] = $message_type_name;
+			}
+		}
+        
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger,
+			$message_type_to_activate);
+	}
+    
+    
+	/**
+	 * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
+	 * @param string $message_type_name The name of the message type being deactivated for the messenger
+	 *
+	 * @return bool
+	 */
+	protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
+		$message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
+		$this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
+        
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger,
+			$message_type_to_deactivate);
+	}
+    
+    
+	/**
+	 * This just initializes the defaults for activating messenger and message type responses.
+	 */
+	protected function _prep_default_response_for_messenger_or_message_type_toggle()
+	{
+		$this->_template_args['data']['active_mts'] = array();
+		$this->_template_args['data']['mt_reload']  = array();
+	}
+    
+    
+	/**
+	 * Setup appropriate response for activating a messenger and/or message types
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _setup_response_message_for_activating_messenger_with_message_types(
+		$messenger,
+		EE_Message_Type $message_type = null
+	) {
+		//if $messenger isn't a valid messenger object then get out.
+		if ( ! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				__('The messenger being activated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
             
-            return false;
-        }
-        //activated
-        if ($this->_template_args['data']['active_mts']) {
-            EE_Error::overwrite_success();
-            //activated a message type with the messenger
-            if ($message_type instanceof EE_message_type) {
-                EE_Error::add_success(
-                    sprintf(
-                        __('%s message type has been successfully activated with the %s messenger', 'event_espresso'),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
+			return false;
+		}
+		//activated
+		if ($this->_template_args['data']['active_mts']) {
+			EE_Error::overwrite_success();
+			//activated a message type with the messenger
+			if ($message_type instanceof EE_message_type) {
+				EE_Error::add_success(
+					sprintf(
+						__('%s message type has been successfully activated with the %s messenger', 'event_espresso'),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+				);
                 
-                //if message type was invoice then let's make sure we activate the invoice payment method.
-                if ($message_type->name == 'invoice') {
-                    EE_Registry::instance()->load_lib('Payment_Method_Manager');
-                    $pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-                    if ($pm instanceof EE_Payment_Method) {
-                        EE_Error::add_attention(__('Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
-                            'event_espresso'));
-                    }
-                }
-                //just toggles the entire messenger
-            } else {
-                EE_Error::add_success(
-                    sprintf(
-                        __('%s messenger has been successfully activated', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-            }
+				//if message type was invoice then let's make sure we activate the invoice payment method.
+				if ($message_type->name == 'invoice') {
+					EE_Registry::instance()->load_lib('Payment_Method_Manager');
+					$pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+					if ($pm instanceof EE_Payment_Method) {
+						EE_Error::add_attention(__('Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
+							'event_espresso'));
+					}
+				}
+				//just toggles the entire messenger
+			} else {
+				EE_Error::add_success(
+					sprintf(
+						__('%s messenger has been successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
+			}
             
-            return true;
+			return true;
             
-            //possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
-            //message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
-            //in which case we just give a success message for the messenger being successfully activated.
-        } else {
-            if ( ! $messenger->get_default_message_types()) {
-                //messenger doesn't have any default message types so still a success.
-                EE_Error::add_success(
-                    sprintf(
-                        __('%s messenger was successfully activated.', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
+			//possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
+			//message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
+			//in which case we just give a success message for the messenger being successfully activated.
+		} else {
+			if ( ! $messenger->get_default_message_types()) {
+				//messenger doesn't have any default message types so still a success.
+				EE_Error::add_success(
+					sprintf(
+						__('%s messenger was successfully activated.', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
                 
-                return true;
-            } else {
-                EE_Error::add_error(
-                    $message_type instanceof EE_message_type
-                        ? sprintf(
-                        __('%s message type was not successfully activated with the %s messenger', 'event_espresso'),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                        : sprintf(
-                        __('%s messenger was not successfully activated', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
+				return true;
+			} else {
+				EE_Error::add_error(
+					$message_type instanceof EE_message_type
+						? sprintf(
+						__('%s message type was not successfully activated with the %s messenger', 'event_espresso'),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+						: sprintf(
+						__('%s messenger was not successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
                 
-                return false;
-            }
-        }
-    }
-    
-    
-    /**
-     * This sets up the appropriate response for deactivating a messenger and/or message type.
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     *
-     * @return bool
-     */
-    protected function _setup_response_message_for_deactivating_messenger_with_message_types(
-        $messenger,
-        EE_message_type $message_type = null
-    ) {
-        EE_Error::overwrite_success();
-        
-        //if $messenger isn't a valid messenger object then get out.
-        if ( ! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                __('The messenger being deactivated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
+				return false;
+			}
+		}
+	}
+    
+    
+	/**
+	 * This sets up the appropriate response for deactivating a messenger and/or message type.
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 *
+	 * @return bool
+	 */
+	protected function _setup_response_message_for_deactivating_messenger_with_message_types(
+		$messenger,
+		EE_message_type $message_type = null
+	) {
+		EE_Error::overwrite_success();
+        
+		//if $messenger isn't a valid messenger object then get out.
+		if ( ! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
             
-            return false;
-        }
-        
-        if ($message_type instanceof EE_message_type) {
-            $message_type_name = $message_type->name;
-            EE_Error::add_success(
-                sprintf(
-                    __('%s message type has been successfully deactivated for the %s messenger.', 'event_espresso'),
-                    ucwords($message_type->label['singular']),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        } else {
-            $message_type_name = '';
-            EE_Error::add_success(
-                sprintf(
-                    __('%s messenger has been successfully deactivated.', 'event_espresso'),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        }
-        
-        //if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
-        if ($messenger->name == 'html' || $message_type_name == 'invoice') {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
-            if ($count_updated > 0) {
-                $msg = $message_type_name == 'invoice'
-                    ? __('Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso')
-                    : __('Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso');
-                EE_Error::add_attention($msg);
-            }
-        }
-        
-        return true;
-    }
-    
-    
-    /**
-     * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
-     */
-    public function update_mt_form()
-    {
-        if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
-            EE_Error::add_error(__('Require message type or messenger to send an updated form'), __FILE__, __FUNCTION__,
-                __LINE__);
-            $this->_return_json();
-        }
-        
-        $message_types = $this->get_installed_message_types();
-        
-        $message_type = $message_types[$this->_req_data['message_type']];
-        $messenger    = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
-        
-        $content                         = $this->_message_type_settings_content($message_type, $messenger, true);
-        $this->_template_args['success'] = true;
-        $this->_template_args['content'] = $content;
-        $this->_return_json();
-    }
-    
-    
-    /**
-     * this handles saving the settings for a messenger or message type
-     *
-     */
-    public function save_settings()
-    {
-        if ( ! isset($this->_req_data['type'])) {
-            EE_Error::add_error(__('Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        
-        
-        if ($this->_req_data['type'] == 'messenger') {
-            $settings  = $this->_req_data['messenger_settings']; //this should be an array.
-            $messenger = $settings['messenger'];
-            //let's setup the settings data
-            foreach ($settings as $key => $value) {
-                switch ($key) {
-                    case 'messenger' :
-                        unset($settings['messenger']);
-                        break;
-                    case 'message_types' :
-                        unset($settings['message_types']);
-                        break;
-                    default :
-                        $settings[$key] = $value;
-                        break;
-                }
-            }
-            $this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
-        } else if ($this->_req_data['type'] == 'message_type') {
-            $settings     = $this->_req_data['message_type_settings'];
-            $messenger    = $settings['messenger'];
-            $message_type = $settings['message_type'];
+			return false;
+		}
+        
+		if ($message_type instanceof EE_message_type) {
+			$message_type_name = $message_type->name;
+			EE_Error::add_success(
+				sprintf(
+					__('%s message type has been successfully deactivated for the %s messenger.', 'event_espresso'),
+					ucwords($message_type->label['singular']),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		} else {
+			$message_type_name = '';
+			EE_Error::add_success(
+				sprintf(
+					__('%s messenger has been successfully deactivated.', 'event_espresso'),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		}
+        
+		//if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
+		if ($messenger->name == 'html' || $message_type_name == 'invoice') {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
+			if ($count_updated > 0) {
+				$msg = $message_type_name == 'invoice'
+					? __('Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso')
+					: __('Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso');
+				EE_Error::add_attention($msg);
+			}
+		}
+        
+		return true;
+	}
+    
+    
+	/**
+	 * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
+	 */
+	public function update_mt_form()
+	{
+		if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
+			EE_Error::add_error(__('Require message type or messenger to send an updated form'), __FILE__, __FUNCTION__,
+				__LINE__);
+			$this->_return_json();
+		}
+        
+		$message_types = $this->get_installed_message_types();
+        
+		$message_type = $message_types[$this->_req_data['message_type']];
+		$messenger    = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
+        
+		$content                         = $this->_message_type_settings_content($message_type, $messenger, true);
+		$this->_template_args['success'] = true;
+		$this->_template_args['content'] = $content;
+		$this->_return_json();
+	}
+    
+    
+	/**
+	 * this handles saving the settings for a messenger or message type
+	 *
+	 */
+	public function save_settings()
+	{
+		if ( ! isset($this->_req_data['type'])) {
+			EE_Error::add_error(__('Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+        
+        
+		if ($this->_req_data['type'] == 'messenger') {
+			$settings  = $this->_req_data['messenger_settings']; //this should be an array.
+			$messenger = $settings['messenger'];
+			//let's setup the settings data
+			foreach ($settings as $key => $value) {
+				switch ($key) {
+					case 'messenger' :
+						unset($settings['messenger']);
+						break;
+					case 'message_types' :
+						unset($settings['message_types']);
+						break;
+					default :
+						$settings[$key] = $value;
+						break;
+				}
+			}
+			$this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
+		} else if ($this->_req_data['type'] == 'message_type') {
+			$settings     = $this->_req_data['message_type_settings'];
+			$messenger    = $settings['messenger'];
+			$message_type = $settings['message_type'];
             
-            foreach ($settings as $key => $value) {
-                switch ($key) {
-                    case 'messenger' :
-                        unset($settings['messenger']);
-                        break;
-                    case 'message_type' :
-                        unset($settings['message_type']);
-                        break;
-                    default :
-                        $settings[$key] = $value;
-                        break;
-                }
-            }
+			foreach ($settings as $key => $value) {
+				switch ($key) {
+					case 'messenger' :
+						unset($settings['messenger']);
+						break;
+					case 'message_type' :
+						unset($settings['message_type']);
+						break;
+					default :
+						$settings[$key] = $value;
+						break;
+				}
+			}
             
-            $this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
-        }
-        
-        //okay we should have the data all setup.  Now we just update!
-        $success = $this->_message_resource_manager->update_active_messengers_option();
-        
-        if ($success) {
-            EE_Error::add_success(__('Settings updated', 'event_espresso'));
-        } else {
-            EE_Error::add_error(__('Settings did not get updated', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-        }
-        
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-    
-    
-    
-    
-    /**  EE MESSAGE PROCESSING ACTIONS **/
-    
-    
-    /**
-     * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
-     * However, this does not send immediately, it just queues for sending.
-     *
-     * @since 4.9.0
-     */
-    protected function _generate_now()
-    {
-        $msg_ids = $this->_get_msg_ids_from_request();
-        EED_Messages::generate_now($msg_ids);
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
-     * are EEM_Message::status_resend or EEM_Message::status_idle
-     *
-     * @since 4.9.0
-     *
-     */
-    protected function _generate_and_send_now()
-    {
-        $this->_generate_now();
-        $this->_send_now();
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
-     *
-     * @since 4.9.0
-     */
-    protected function _queue_for_resending()
-    {
-        $msg_ids = $this->_get_msg_ids_from_request();
-        EED_Messages::queue_for_resending($msg_ids);
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
-     *
-     * @since 4.9.0
-     */
-    protected function _send_now()
-    {
-        $msg_ids = $this->_get_msg_ids_from_request();
-        EED_Messages::send_now($msg_ids);
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     * Deletes EE_messages for IDs in the request.
-     *
-     * @since 4.9.0
-     */
-    protected function _delete_ee_messages()
-    {
-        $msg_ids       = $this->_get_msg_ids_from_request();
-        $deleted_count = 0;
-        foreach ($msg_ids as $msg_id) {
-            if (EEM_Message::instance()->delete_by_ID($msg_id)) {
-                $deleted_count++;
-            }
-        }
-        if ($deleted_count) {
-            $this->_redirect_after_action(
-                true,
-                _n('message', 'messages', $deleted_count, 'event_espresso'),
-                __('deleted', 'event_espresso')
-            );
-        } else {
-            EE_Error::add_error(
-                _n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-        }
-    }
-    
-    
-    /**
-     *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _get_msg_ids_from_request()
-    {
-        if ( ! isset($this->_req_data['MSG_ID'])) {
-            return array();
-        }
-        
-        return is_array($this->_req_data['MSG_ID']) ? array_keys($this->_req_data['MSG_ID']) : array($this->_req_data['MSG_ID']);
-    }
+			$this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
+		}
+        
+		//okay we should have the data all setup.  Now we just update!
+		$success = $this->_message_resource_manager->update_active_messengers_option();
+        
+		if ($success) {
+			EE_Error::add_success(__('Settings updated', 'event_espresso'));
+		} else {
+			EE_Error::add_error(__('Settings did not get updated', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+		}
+        
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+    
+    
+    
+    
+	/**  EE MESSAGE PROCESSING ACTIONS **/
+    
+    
+	/**
+	 * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
+	 * However, this does not send immediately, it just queues for sending.
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _generate_now()
+	{
+		$msg_ids = $this->_get_msg_ids_from_request();
+		EED_Messages::generate_now($msg_ids);
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
+	 * are EEM_Message::status_resend or EEM_Message::status_idle
+	 *
+	 * @since 4.9.0
+	 *
+	 */
+	protected function _generate_and_send_now()
+	{
+		$this->_generate_now();
+		$this->_send_now();
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _queue_for_resending()
+	{
+		$msg_ids = $this->_get_msg_ids_from_request();
+		EED_Messages::queue_for_resending($msg_ids);
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _send_now()
+	{
+		$msg_ids = $this->_get_msg_ids_from_request();
+		EED_Messages::send_now($msg_ids);
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 * Deletes EE_messages for IDs in the request.
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _delete_ee_messages()
+	{
+		$msg_ids       = $this->_get_msg_ids_from_request();
+		$deleted_count = 0;
+		foreach ($msg_ids as $msg_id) {
+			if (EEM_Message::instance()->delete_by_ID($msg_id)) {
+				$deleted_count++;
+			}
+		}
+		if ($deleted_count) {
+			$this->_redirect_after_action(
+				true,
+				_n('message', 'messages', $deleted_count, 'event_espresso'),
+				__('deleted', 'event_espresso')
+			);
+		} else {
+			EE_Error::add_error(
+				_n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+		}
+	}
+    
+    
+	/**
+	 *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _get_msg_ids_from_request()
+	{
+		if ( ! isset($this->_req_data['MSG_ID'])) {
+			return array();
+		}
+        
+		return is_array($this->_req_data['MSG_ID']) ? array_keys($this->_req_data['MSG_ID']) : array($this->_req_data['MSG_ID']);
+	}
     
     
 }

core/db_models/EEM_Payment_Method.model.php

Spacing +91 added lines, -91 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  *
@@ -37,33 +37,33 @@ 
 	 * @access   protected
 	 * @return EEM_Payment_Method
 	 */
-	protected function __construct( $timezone = NULL ) {
-		$this->singlular_item = __( 'Payment Method', 'event_espresso' );
-		$this->plural_item = __( 'Payment Methods', 'event_espresso' );
-		$this->_tables = array( 'Payment_Method' => new EE_Primary_Table( 'esp_payment_method', 'PMD_ID' ) );
+	protected function __construct($timezone = NULL) {
+		$this->singlular_item = __('Payment Method', 'event_espresso');
+		$this->plural_item = __('Payment Methods', 'event_espresso');
+		$this->_tables = array('Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'));
 		$this->_fields = array(
 			'Payment_Method' => array(
-				'PMD_ID' => new EE_Primary_Key_Int_Field( 'PMD_ID', __( "ID", 'event_espresso' ) ),
-				'PMD_type' => new EE_Plain_Text_Field( 'PMD_type', __( "Payment Method Type", 'event_espresso' ), FALSE, 'Admin_Only' ),
-				'PMD_name' => new EE_Plain_Text_Field( 'PMD_name', __( "Name", 'event_espresso' ), FALSE ),
-				'PMD_desc' => new EE_Post_Content_Field( 'PMD_desc', __( "Description", 'event_espresso' ), FALSE, '' ),
-				'PMD_admin_name' => new EE_Plain_Text_Field( 'PMD_admin_name', __( "Admin-Only Name", 'event_espresso' ), TRUE ),
-				'PMD_admin_desc' => new EE_Post_Content_Field( 'PMD_admin_desc', __( "Admin-Only Description", 'event_espresso' ), TRUE ),
-				'PMD_slug' => new EE_Slug_Field( 'PMD_slug', __( "Slug", 'event_espresso' ), FALSE ),
-				'PMD_order' => new EE_Integer_Field( 'PMD_order', __( "Order", 'event_espresso' ), FALSE, 0 ),
-				'PMD_debug_mode' => new EE_Boolean_Field( 'PMD_debug_mode', __( "Debug Mode On?", 'event_espresso' ), FALSE, FALSE ),
-				'PMD_wp_user' => new EE_WP_User_Field( 'PMD_wp_user', __( "Payment Method Creator ID", 'event_espresso' ), FALSE ),
-				'PMD_open_by_default' => new EE_Boolean_Field( 'PMD_open_by_default', __( "Open by Default?", 'event_espresso' ), FALSE, FALSE ), 'PMD_button_url' => new EE_Plain_Text_Field( 'PMD_button_url', __( "Button URL", 'event_espresso' ), TRUE, '' ),
-				'PMD_scope' => new EE_Serialized_Text_Field( 'PMD_scope', __( "Usable From?", 'event_espresso' ), FALSE, array() ), //possible values currently are 'CART','ADMIN','API'
+				'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
+				'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), FALSE, 'Admin_Only'),
+				'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), FALSE),
+				'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), FALSE, ''),
+				'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), TRUE),
+				'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), TRUE),
+				'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), FALSE),
+				'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), FALSE, 0),
+				'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), FALSE, FALSE),
+				'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), FALSE),
+				'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), FALSE, FALSE), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), TRUE, ''),
+				'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), FALSE, array()), //possible values currently are 'CART','ADMIN','API'
 		) );
 		$this->_model_relations = array(
  //			'Event'=>new EE_HABTM_Relation('Event_Payment_Method'),
 			'Payment' => new EE_Has_Many_Relation(),
-			'Currency' => new EE_HABTM_Relation( 'Currency_Payment_Method' ),
+			'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
 			'Transaction' => new EE_Has_Many_Relation(),
 			'WP_User' => new EE_Belongs_To_Relation(),
 		);
-		parent::__construct( $timezone );
+		parent::__construct($timezone);
 	}
 
 
@@ -73,8 +73,8 @@ 
 	 * @param string $slug
 	 * @return EE_Payment_Method
 	 */
-	public function get_one_by_slug( $slug ) {
-		return $this->get_one( array( array( 'PMD_slug' => $slug ) ) );
+	public function get_one_by_slug($slug) {
+		return $this->get_one(array(array('PMD_slug' => $slug)));
 	}
 
 
@@ -88,8 +88,8 @@ 
 		return apply_filters(
 			'FHEE__EEM_Payment_Method__scopes',
 			array(
-				self::scope_cart 		=> __( "Front-end Registration Page", 'event_espresso' ),
-				self::scope_admin 	=> __( "Admin Registration Page (no online processing)", 'event_espresso' )
+				self::scope_cart 		=> __("Front-end Registration Page", 'event_espresso'),
+				self::scope_admin 	=> __("Admin Registration Page (no online processing)", 'event_espresso')
 			)
 		);
 	}
@@ -101,9 +101,9 @@ 
 	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
 	 * @return boolean
 	 */
-	public function is_valid_scope( $scope ) {
+	public function is_valid_scope($scope) {
 		$scopes = $this->scopes();
-		if ( isset( $scopes[ $scope ] ) ) {
+		if (isset($scopes[$scope])) {
 			return TRUE;
 		} else {
 			return FALSE;
@@ -119,11 +119,11 @@ 
 	 * @throws EE_Error
 	 * @return EE_Payment_Method[]
 	 */
-	public function get_all_active( $scope = NULL, $query_params = array() ) {
-		if( ! isset( $query_params[ 'order_by' ] ) && ! isset( $query_params[ 'order' ] ) ) {
-			$query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
+	public function get_all_active($scope = NULL, $query_params = array()) {
+		if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = array('PMD_order' => 'ASC', 'PMD_ID' => 'ASC');
 		}
-		return $this->get_all( $this->_get_query_params_for_all_active( $scope, $query_params ) );
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
 	}
 
 	/**
@@ -132,8 +132,8 @@ 
 	 * @param array $query_params
 	 * @return int
 	 */
-	public function count_active( $scope = NULL, $query_params = array() ){
-		return $this->count( $this->_get_query_params_for_all_active( $scope, $query_params ) );
+	public function count_active($scope = NULL, $query_params = array()) {
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
 	}
 
 	/**
@@ -144,21 +144,21 @@ 
 	 * @return array like param of EEM_Base::get_all()
 	 * @throws EE_Error
 	 */
-	protected function _get_query_params_for_all_active( $scope = NULL, $query_params = array() ){
-		if ( $scope ) {
-			if ( $this->is_valid_scope( $scope ) ) {
-				return array_replace_recursive( array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params );
+	protected function _get_query_params_for_all_active($scope = NULL, $query_params = array()) {
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive(array(array('PMD_scope' => array('LIKE', "%$scope%"))), $query_params);
 			} else {
-				throw new EE_Error( sprintf( __( "'%s' is not a valid scope for a payment method", "event_espresso" ), $scope ) );
+				throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
 			}
 		} else {
 			$acceptable_scopes = array();
 			$count = 0;
-			foreach ( $this->scopes() as $scope_name => $desc ) {
+			foreach ($this->scopes() as $scope_name => $desc) {
 				$count++;
-				$acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+				$acceptable_scopes['PMD_scope*'.$count] = array('LIKE', '%'.$scope_name.'%');
 			}
-			return array_replace_recursive( array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params );
+			return array_replace_recursive(array(array('OR*active_scope' => $acceptable_scopes)), $query_params);
 		}
 	}
 
@@ -170,8 +170,8 @@ 
 	 * @return array like param of EEM_Base::get_all()
 	 * @throws EE_Error
 	 */
-	public function get_query_params_for_all_active( $scope = NULL, $query_params = array() ) {
-		return $this->_get_query_params_for_all_active( $scope, $query_params );
+	public function get_query_params_for_all_active($scope = NULL, $query_params = array()) {
+		return $this->_get_query_params_for_all_active($scope, $query_params);
 	}
 
 
@@ -181,8 +181,8 @@ 
 	 * @param array  $query_params
 	 * @return EE_Payment_Method
 	 */
-	public function get_one_active( $scope = NULL, $query_params = array() ) {
-		return $this->get_one( $this->_get_query_params_for_all_active( $scope, $query_params ) );
+	public function get_one_active($scope = NULL, $query_params = array()) {
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
 	}
 
 
@@ -192,8 +192,8 @@ 
 	 * @param string $type
 	 * @return EE_Payment_Method
 	 */
-	public function get_one_of_type( $type ) {
-		return $this->get_one( array( array( 'PMD_type' => $type ) ) );
+	public function get_one_of_type($type) {
+		return $this->get_one(array(array('PMD_type' => $type)));
 	}
 
 
@@ -206,22 +206,22 @@ 
 	 * @return EE_Payment_Method
 	 * @throws EE_Error
 	 */
-	public function ensure_is_obj( $base_class_obj_or_id, $ensure_is_in_db = FALSE ) {
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = FALSE) {
 		//first: check if it's a slug
-		if( is_string( $base_class_obj_or_id ) ) {
-			$obj = $this->get_one_by_slug( $base_class_obj_or_id );
-			if( $obj ) {
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
 				return $obj;
 			}
 		}
 		//ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
 		try {
-			return parent::ensure_is_obj( $base_class_obj_or_id, $ensure_is_in_db );
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
 		}
-		catch ( EE_Error $e ) {
+		catch (EE_Error $e) {
 			//handle it outside the catch
 		}
-		throw new EE_Error( sprintf( __( "'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso" ), $base_class_obj_or_id ) );
+		throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
 	}
 
 
@@ -232,12 +232,12 @@ 
 	 * @param mixed $base_obj_or_id_or_slug
 	 * @return int
 	 */
-	function ensure_is_ID( $base_obj_or_id_or_slug ) {
-		if ( is_string( $base_obj_or_id_or_slug ) ) {
+	function ensure_is_ID($base_obj_or_id_or_slug) {
+		if (is_string($base_obj_or_id_or_slug)) {
 			//assume it's a slug
-			$base_obj_or_id_or_slug = $this->get_one_by_slug( $base_obj_or_id_or_slug );
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
 		}
-		return parent::ensure_is_ID( $base_obj_or_id_or_slug );
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
 	}
 
 
@@ -246,36 +246,36 @@ 
 	 * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
 	 * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
 	 */
-	function verify_button_urls( $payment_methods = NULL ) {
-		$payment_methods = is_array( $payment_methods ) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
-		foreach ( $payment_methods as $payment_method ) {
+	function verify_button_urls($payment_methods = NULL) {
+		$payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
 			try {
 				$current_button_url = $payment_method->button_url();
-				$buttons_urls_to_try = apply_filters( 'FHEE__EEM_Payment_Method__verify_button_urls__button_urls_to_try', array(
-					'current_ssl' => str_replace( "http://", "https://", $current_button_url ),
-					'current' => str_replace( "https://", "http://", $current_button_url ),
-					'default_ssl' => str_replace( "http://", "https://", $payment_method->type_obj()->default_button_url() ),
-					'default' => str_replace( "https://", "http://", $payment_method->type_obj()->default_button_url() ),
-				) );
-				foreach( $buttons_urls_to_try as $button_url_to_try ) {
-					if(
+				$buttons_urls_to_try = apply_filters('FHEE__EEM_Payment_Method__verify_button_urls__button_urls_to_try', array(
+					'current_ssl' => str_replace("http://", "https://", $current_button_url),
+					'current' => str_replace("https://", "http://", $current_button_url),
+					'default_ssl' => str_replace("http://", "https://", $payment_method->type_obj()->default_button_url()),
+					'default' => str_replace("https://", "http://", $payment_method->type_obj()->default_button_url()),
+				));
+				foreach ($buttons_urls_to_try as $button_url_to_try) {
+					if (
 							(//this is the current url and it exists, regardless of SSL issues
 								$button_url_to_try == $current_button_url &&
 								EEH_URL::remote_file_exists(
 										$button_url_to_try,
 										array(
 											'sslverify' => false,
-											'limit_response_size' => 4095,//we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
+											'limit_response_size' => 4095, //we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
 											) )
 							)
 							||
 							(//this is NOT the current url and it exists with a working SSL cert
 								$button_url_to_try != $current_button_url &&
-								EEH_URL::remote_file_exists( $button_url_to_try )
+								EEH_URL::remote_file_exists($button_url_to_try)
 							) ) {
-						if( $current_button_url != $button_url_to_try ){
-							$payment_method->save( array( 'PMD_button_url' => $button_url_to_try ) );
-							EE_Error::add_attention( sprintf( __( "Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso" ), $payment_method->name(), $button_url_to_try ) );
+						if ($current_button_url != $button_url_to_try) {
+							$payment_method->save(array('PMD_button_url' => $button_url_to_try));
+							EE_Error::add_attention(sprintf(__("Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso"), $payment_method->name(), $button_url_to_try));
 						}
 						//this image exists. So if wasn't set before, now it is;
 						//or if it was already set, we have nothing to do
@@ -283,8 +283,8 @@ 
 					}
 				}
 			}
-			catch ( EE_Error $e ) {
-				$payment_method->set_active( FALSE );
+			catch (EE_Error $e) {
+				$payment_method->set_active(FALSE);
 			}
 		}
 	}
@@ -298,29 +298,29 @@ 
 	 * @param array $rows
 	 * @return EE_Payment_Method[]
 	 */
-	protected function _create_objects( $rows = array() ) {
-		EE_Registry::instance()->load_lib( 'Payment_Method_Manager' );
-		$payment_methods = parent::_create_objects( $rows );
+	protected function _create_objects($rows = array()) {
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
 		/* @var $payment_methods EE_Payment_Method[] */
 		$usable_payment_methods = array();
-		foreach ( $payment_methods as $key => $payment_method ) {
-			if ( EE_Payment_Method_Manager::instance()->payment_method_type_exists( $payment_method->type() ) ) {
-				$usable_payment_methods[ $key ] = $payment_method;
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[$key] = $payment_method;
 				//some payment methods enqueue their scripts in EE_PMT_*::__construct
 				//which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
 				//its scripts). but for backwards-compat we should continue to do that
 				$payment_method->type_obj();
-			} elseif( $payment_method->active() ) {				
+			} elseif ($payment_method->active()) {				
 				//only deactivate and notify the admin if the payment is active somewhere
 				$payment_method->deactivate();
 				$payment_method->save();
 				EE_Error::add_persistent_admin_notice(
-					'auto-deactivated-' . $payment_method->type(),
+					'auto-deactivated-'.$payment_method->type(),
 					sprintf(
-						__( 'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.', 'event_espresso' ),
+						__('The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.', 'event_espresso'),
 						$payment_method->admin_name(),
 						'<br />',
-						'<a href="' . admin_url('plugins.php') . '">',
+						'<a href="'.admin_url('plugins.php').'">',
 						'</a>'
 					),
 					true
@@ -340,11 +340,11 @@ 
 	 * @param string 	$scope @see EEM_Payment_Method::get_all_for_events
 	 * @return EE_Payment_Method[]
 	 */
-	public function get_all_for_transaction( $transaction, $scope ) {
+	public function get_all_for_transaction($transaction, $scope) {
 		//give addons a chance to override what payment methods are chosen based on the transaction
 		return apply_filters(
 			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-			$this->get_all_active( $scope ),
+			$this->get_all_active($scope),
 			$transaction,
 			$scope
 		);
@@ -360,16 +360,16 @@ 
 	 * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
 	 * @return EE_Payment|null
 	 */
-	public function get_last_used_for_registration( $registration_or_reg_id ) {
-		$registration_id = EEM_Registration::instance()->ensure_is_ID( $registration_or_reg_id );
+	public function get_last_used_for_registration($registration_or_reg_id) {
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
 
 		$query_params = array(
 			0 => array(
 				'Payment.Registration.REG_ID' => $registration_id,
 			),
-			'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+			'order_by' => array('Payment.PAY_ID' => 'DESC')
 		);
-		return $this->get_one( $query_params );
+		return $this->get_one($query_params);
 	}
 
 }

admin_pages/payments/Payments_Admin_Page.core.php

Spacing +173 added lines, -173 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -44,8 +44,8 @@ 
 	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
 	 * @return \Payments_Admin_Page
 	 */
-	public function __construct( $routing = TRUE ) {
-		parent::__construct( $routing );
+	public function __construct($routing = TRUE) {
+		parent::__construct($routing);
 	}
 
 
@@ -130,19 +130,19 @@ 
 	protected function _set_page_config() {
 		$payment_method_list_config = array(
 			'nav'           => array(
-				'label' => __( 'Payment Methods', 'event_espresso' ),
+				'label' => __('Payment Methods', 'event_espresso'),
 				'order' => 10
 			),
 			'metaboxes'     => $this->_default_espresso_metaboxes,
 			'help_tabs'     => array_merge(
 				array(
 					'payment_methods_overview_help_tab' => array(
-						'title'    => __( 'Payment Methods Overview', 'event_espresso' ),
+						'title'    => __('Payment Methods Overview', 'event_espresso'),
 						'filename' => 'payment_methods_overview'
 					)
 				),
 				$this->_add_payment_method_help_tabs() ),
-			'help_tour'     => array( 'Payment_Methods_Selection_Help_Tour' ),
+			'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
 			'require_nonce' => false
 		);
 
@@ -160,7 +160,7 @@ 
 					)
 				),
 				//'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
-				'metaboxes' => array_merge( $this->_default_espresso_metaboxes, array( '_publish_post_box' ) ),
+				'metaboxes' => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
 				'require_nonce' => FALSE
 			),
 			'payment_log'=>array(
@@ -179,17 +179,17 @@ 
 	/**
 	 * @return array
 	 */
-	protected function _add_payment_method_help_tabs(){
+	protected function _add_payment_method_help_tabs() {
 		EE_Registry::instance()->load_lib('Payment_Method_Manager');
 		$payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
 		$all_pmt_help_tabs_config = array();
-		foreach( $payment_method_types as $payment_method_type ){
-			if ( ! EE_Registry::instance()->CAP->current_user_can( $payment_method_type->cap_name(), 'specific_payment_method_type_access' ) ) {
+		foreach ($payment_method_types as $payment_method_type) {
+			if ( ! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(), 'specific_payment_method_type_access')) {
 				continue;
 			}
-			foreach( $payment_method_type->help_tabs_config() as $help_tab_name => $config ){
-				$template_args = isset( $config[ 'template_args' ] ) ? $config[ 'template_args' ] : array();
-				$template_args[ 'admin_page_obj' ] = $this;
+			foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
+				$template_args = isset($config['template_args']) ? $config['template_args'] : array();
+				$template_args['admin_page_obj'] = $this;
 				$all_pmt_help_tabs_config[$help_tab_name] = array(
 					'title'=>$config['title'],
 					'content'=>EEH_Template::display_template(
@@ -216,9 +216,9 @@ 
 
 
 	public function load_scripts_styles() {
-		wp_enqueue_script( 'ee_admin_js' );
-		wp_enqueue_script( 'ee-text-links' );
-		wp_enqueue_script( 'espresso_payments', EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js', array( 'espresso-ui-theme', 'ee-datepicker' ), EVENT_ESPRESSO_VERSION, TRUE );
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-text-links');
+		wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL.'espresso_payments_admin.js', array('espresso-ui-theme', 'ee-datepicker'), EVENT_ESPRESSO_VERSION, TRUE);
 	}
 
 
@@ -227,9 +227,9 @@ 
 
 	public function load_scripts_styles_default() {
 		//styles
-		wp_register_style( 'espresso_payments', EE_PAYMENTS_ASSETS_URL . 'ee-payments.css', array(), EVENT_ESPRESSO_VERSION );
-		wp_enqueue_style( 'espresso_payments' );
-		wp_enqueue_style( 'ee-text-links' );
+		wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL.'ee-payments.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_payments');
+		wp_enqueue_style('ee-text-links');
 		//scripts
 	}
 
@@ -243,44 +243,44 @@ 
 		 * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
 		 * recheck here.
 		 */
-		EE_Registry::instance()->load_lib( 'Payment_Method_Manager' );
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
 		EEM_Payment_Method::instance()->verify_button_urls();
 		//setup tabs, one for each payment method type
 		$tabs = array();
 		$payment_methods = array();
-		foreach( EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj ) {
+		foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
 			// we don't want to show admin-only PMTs for now
-			if ( $pmt_obj instanceof EE_PMT_Admin_Only ) {
+			if ($pmt_obj instanceof EE_PMT_Admin_Only) {
 				continue;
 			}
 			//check access
-			if ( ! EE_Registry::instance()->CAP->current_user_can( $pmt_obj->cap_name(), 'specific_payment_method_type_access' ) ) {
+			if ( ! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(), 'specific_payment_method_type_access')) {
 				continue;
 			}
 			//check for any active pms of that type
-			$payment_method = EEM_Payment_Method::instance()->get_one_of_type( $pmt_obj->system_name() );
-			if ( ! $payment_method instanceof EE_Payment_Method ) {
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
+			if ( ! $payment_method instanceof EE_Payment_Method) {
 				$payment_method = EE_Payment_Method::new_instance(
 					array(
-						'PMD_slug'					=>sanitize_key( $pmt_obj->system_name() ),
+						'PMD_slug'					=>sanitize_key($pmt_obj->system_name()),
 						'PMD_type'					=>$pmt_obj->system_name(),
 						'PMD_name'				=>$pmt_obj->pretty_name(),
 						'PMD_admin_name'	=>$pmt_obj->pretty_name()
 					)
 				);
 			}
-			$payment_methods[ $payment_method->slug() ] = $payment_method;
+			$payment_methods[$payment_method->slug()] = $payment_method;
 		}
-		$payment_methods = apply_filters( 'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods', $payment_methods );
-		foreach( $payment_methods as $payment_method ) {
-			if ( $payment_method instanceof EE_Payment_Method ) {
+		$payment_methods = apply_filters('FHEE__Payments_Admin_Page___payment_methods_list__payment_methods', $payment_methods);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
 				add_meta_box(
 					//html id
-					'espresso_' . $payment_method->slug() . '_payment_settings',
+					'espresso_'.$payment_method->slug().'_payment_settings',
 					//title
-					sprintf( __( '%s Settings', 'event_espresso' ), $payment_method->admin_name() ),
+					sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
 					//callback
-					array( $this, 'payment_method_settings_meta_box' ),
+					array($this, 'payment_method_settings_meta_box'),
 					//post type
 					null,
 					//context
@@ -288,19 +288,19 @@ 
 					//priority
 					'default',
 					//callback args
-					array( 'payment_method' => $payment_method )
+					array('payment_method' => $payment_method)
 				);
 				//setup for tabbed content
-				$tabs[ $payment_method->slug() ] = array(
+				$tabs[$payment_method->slug()] = array(
 					'label' => $payment_method->admin_name(),
 					'class' => $payment_method->active() ? 'gateway-active' : '',
-					'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
-					'title' => __( 'Modify this Payment Method', 'event_espresso' ),
+					'href'  => 'espresso_'.$payment_method->slug().'_payment_settings',
+					'title' => __('Modify this Payment Method', 'event_espresso'),
 					'slug'  => $payment_method->slug()
 				);
 			}
 		}
-		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links( $tabs, 'payment_method_links', '|', $this->_get_active_payment_method_slug() );
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links($tabs, 'payment_method_links', '|', $this->_get_active_payment_method_slug());
 		$this->display_admin_page_with_sidebar();
 
 	}
@@ -311,20 +311,20 @@ 
 	 *   _get_active_payment_method_slug
 	 * 	@return string
 	 */
-	protected function _get_active_payment_method_slug(){
+	protected function _get_active_payment_method_slug() {
 		$payment_method_slug = FALSE;
 		//decide which payment method tab to open first, as dictated by the request's 'payment_method'
-		if ( isset( $this->_req_data['payment_method'] )) {
+		if (isset($this->_req_data['payment_method'])) {
 			// if they provided the current payment method, use it
-			$payment_method_slug = sanitize_key( $this->_req_data['payment_method'] );
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
 		}
-		$payment_method = EEM_Payment_Method::instance()->get_one( array( array( 'PMD_slug' => $payment_method_slug )));
+		$payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
 		// if that didn't work or wasn't provided, find another way to select the current pm
-		if ( ! $this->_verify_payment_method( $payment_method )) {
+		if ( ! $this->_verify_payment_method($payment_method)) {
 			// like, looking for an active one
-			$payment_method = EEM_Payment_Method::instance()->get_one_active( 'CART' );
+			$payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
 			// test that one as well
-			if ( $this->_verify_payment_method( $payment_method )) {
+			if ($this->_verify_payment_method($payment_method)) {
 				$payment_method_slug = $payment_method->slug();
 			} else {
 				$payment_method_slug = 'paypal_standard';
@@ -342,11 +342,11 @@ 
 	 * @param \EE_Payment_Method $payment_method
 	 * @return boolean
 	 */
-	protected function _verify_payment_method( $payment_method ){
+	protected function _verify_payment_method($payment_method) {
 		if (
 			$payment_method instanceof EE_Payment_Method &&
 			$payment_method->type_obj() instanceof EE_PMT_Base &&
-			EE_Registry::instance()->CAP->current_user_can( $payment_method->type_obj()->cap_name(), 'specific_payment_method_type_access' )
+			EE_Registry::instance()->CAP->current_user_can($payment_method->type_obj()->cap_name(), 'specific_payment_method_type_access')
 		) {
 			return TRUE;
 		}
@@ -363,21 +363,21 @@ 
 	 * @return string
 	 * @throws EE_Error
 	 */
-	public function payment_method_settings_meta_box( $post_obj_which_is_null, $metabox ){
-		$payment_method = isset( $metabox['args'], $metabox['args']['payment_method'] ) ? $metabox['args']['payment_method'] : NULL;
-		if ( ! $payment_method instanceof EE_Payment_Method ){
-			throw new EE_Error( sprintf( __( 'Payment method metabox setup incorrectly. No Payment method object was supplied', 'event_espresso' )));
+	public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox) {
+		$payment_method = isset($metabox['args'], $metabox['args']['payment_method']) ? $metabox['args']['payment_method'] : NULL;
+		if ( ! $payment_method instanceof EE_Payment_Method) {
+			throw new EE_Error(sprintf(__('Payment method metabox setup incorrectly. No Payment method object was supplied', 'event_espresso')));
 		}
 		$payment_method_scopes = $payment_method->active();
 		// if the payment method really exists show its form, otherwise the activation template
-		if ( $payment_method->ID() && ! empty( $payment_method_scopes )) {
-				$form = $this->_generate_payment_method_settings_form( $payment_method );
-				if ( $form->form_data_present_in( $this->_req_data )) {
-					$form->receive_form_submission( $this->_req_data );
+		if ($payment_method->ID() && ! empty($payment_method_scopes)) {
+				$form = $this->_generate_payment_method_settings_form($payment_method);
+				if ($form->form_data_present_in($this->_req_data)) {
+					$form->receive_form_submission($this->_req_data);
 				}
-				echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
+				echo $form->form_open().$form->get_html_and_js().$form->form_close();
 		} else {
-			echo $this->_activate_payment_method_button( $payment_method )->get_html_and_js();
+			echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
 		}
 	}
 
@@ -390,14 +390,14 @@ 
 	 * @param \EE_Payment_Method $payment_method
 	 * @return \EE_Form_Section_Proper
 	 */
-	protected function _generate_payment_method_settings_form( EE_Payment_Method $payment_method ) {
-		if ( ! $payment_method instanceof EE_Payment_Method ){
+	protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method) {
+		if ( ! $payment_method instanceof EE_Payment_Method) {
 			return new EE_Form_Section_Proper();
 		}
 		return new EE_Form_Section_Proper(
 			array(
-				'name' 	=> $payment_method->slug() . '_settings_form',
-				'html_id' 	=> $payment_method->slug() . '_settings_form',
+				'name' 	=> $payment_method->slug().'_settings_form',
+				'html_id' 	=> $payment_method->slug().'_settings_form',
 				'action' 	=> EE_Admin_Page::add_query_args_and_nonce(
 					array(
 						'action' 						=> 'update_payment_method',
@@ -409,12 +409,12 @@ 
 				'subsections' 			=> apply_filters(
 					'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
 					array(
-						'pci_dss_compliance_' . $payment_method->slug() 				=> $this->_pci_dss_compliance( $payment_method ),
-						'currency_support_' . $payment_method->slug()					=> $this->_currency_support( $payment_method ),
-						'payment_method_settings_' . $payment_method->slug() 	=> $this->_payment_method_settings( $payment_method ),
-						'update_' . $payment_method->slug()										=> $this->_update_payment_method_button( $payment_method ),
-						'deactivate_' . $payment_method->slug()								=> $this->_deactivate_payment_method_button( $payment_method ),
-						'fine_print_' . $payment_method->slug()									=> $this->_fine_print()
+						'pci_dss_compliance_'.$payment_method->slug() 				=> $this->_pci_dss_compliance($payment_method),
+						'currency_support_'.$payment_method->slug()					=> $this->_currency_support($payment_method),
+						'payment_method_settings_'.$payment_method->slug() 	=> $this->_payment_method_settings($payment_method),
+						'update_'.$payment_method->slug()										=> $this->_update_payment_method_button($payment_method),
+						'deactivate_'.$payment_method->slug()								=> $this->_deactivate_payment_method_button($payment_method),
+						'fine_print_'.$payment_method->slug()									=> $this->_fine_print()
 					),
 					$payment_method
 				)
@@ -431,19 +431,19 @@ 
 	 * @param \EE_Payment_Method $payment_method
 	 * @return \EE_Form_Section_Proper
 	 */
-	protected function _pci_dss_compliance( EE_Payment_Method $payment_method ) {
-		if ( $payment_method->type_obj()->requires_https() ) {
+	protected function _pci_dss_compliance(EE_Payment_Method $payment_method) {
+		if ($payment_method->type_obj()->requires_https()) {
 			return new EE_Form_Section_HTML(
 				EEH_HTML::tr(
 					EEH_HTML::th(
 						EEH_HTML::label(
-							EEH_HTML::strong( __( 'IMPORTANT', 'event_espresso' ), '', 'important-notice' )
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
 						)
-					) .
+					).
 					EEH_HTML::td(
-						EEH_HTML::strong( __( 'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.', 'event_espresso' )) .
-						EEH_HTML::br() .
-						__( 'Learn more about ', 'event_espresso' ) . EEH_HTML::link( 'https://www.pcisecuritystandards.org/merchants/index.php', __( 'PCI DSS compliance', 'event_espresso' ))
+						EEH_HTML::strong(__('You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.', 'event_espresso')).
+						EEH_HTML::br().
+						__('Learn more about ', 'event_espresso').EEH_HTML::link('https://www.pcisecuritystandards.org/merchants/index.php', __('PCI DSS compliance', 'event_espresso'))
 					)
 				)
 			);
@@ -461,19 +461,19 @@ 
 	 * @param \EE_Payment_Method $payment_method
 	 * @return \EE_Form_Section_Proper
 	 */
-	protected function _currency_support( EE_Payment_Method $payment_method ) {
-		if ( ! $payment_method->usable_for_currency( EE_Config::instance()->currency->code )) {
+	protected function _currency_support(EE_Payment_Method $payment_method) {
+		if ( ! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
 			return new EE_Form_Section_HTML(
 				EEH_HTML::tr(
 					EEH_HTML::th(
 						EEH_HTML::label(
-							EEH_HTML::strong( __( 'IMPORTANT', 'event_espresso' ), '', 'important-notice' )
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
 						)
-					) .
+					).
 					EEH_HTML::td(
 						EEH_HTML::strong(
 							sprintf(
-								__( 'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.', 'event_espresso'),
+								__('This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.', 'event_espresso'),
 								EE_Config::instance()->currency->code
 							)
 						)
@@ -493,9 +493,9 @@ 
 	 * @param \EE_Payment_Method $payment_method
 	 * @return \EE_Form_Section_HTML
 	 */
-	protected function _payment_method_settings( EE_Payment_Method $payment_method ) {
+	protected function _payment_method_settings(EE_Payment_Method $payment_method) {
 		//modify the form so we only have/show fields that will be implemented for this version
-		return $this->_simplify_form( $payment_method->type_obj()->settings_form(), $payment_method->name() );
+		return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
 	}
 
 
@@ -508,8 +508,8 @@ 
 	 * @return \EE_Payment_Method_Form
 	 * @throws \EE_Error
 	 */
-	protected function _simplify_form( $form_section, $payment_method_name = '' ){
-		if ( $form_section instanceof EE_Payment_Method_Form ) {
+	protected function _simplify_form($form_section, $payment_method_name = '') {
+		if ($form_section instanceof EE_Payment_Method_Form) {
 			$form_section->exclude(
 				array(
 					'PMD_type', //dont want them changing the type
@@ -520,7 +520,7 @@ 
 			);
 			return $form_section;
 		} else {
-			throw new EE_Error( sprintf( __( 'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.', 'event_espresso' ), $payment_method_name ));
+			throw new EE_Error(sprintf(__('The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.', 'event_espresso'), $payment_method_name));
 		}
 	}
 
@@ -533,19 +533,19 @@ 
 	 * @param \EE_Payment_Method $payment_method
 	 * @return \EE_Form_Section_HTML
 	 */
-	protected function _update_payment_method_button( EE_Payment_Method $payment_method ) {
+	protected function _update_payment_method_button(EE_Payment_Method $payment_method) {
 		$update_button = new EE_Submit_Input(
 			array(
 				'name' => 'submit',
-				'html_id' 		=> 'save_' . $payment_method->slug() . '_settings',
-				'default' 		=> sprintf( __( 'Update %s Payment Settings', 'event_espresso' ), $payment_method->admin_name() ),
+				'html_id' 		=> 'save_'.$payment_method->slug().'_settings',
+				'default' 		=> sprintf(__('Update %s Payment Settings', 'event_espresso'), $payment_method->admin_name()),
 				'html_label' => EEH_HTML::nbsp()
 			)
 		);
 		return new EE_Form_Section_HTML(
-			EEH_HTML::no_row( EEH_HTML::br(2) ) .
+			EEH_HTML::no_row(EEH_HTML::br(2)).
 			EEH_HTML::tr(
-				EEH_HTML::th( __( 'Update Settings', 'event_espresso') ) .
+				EEH_HTML::th(__('Update Settings', 'event_espresso')).
 				EEH_HTML::td(
 					$update_button->get_html_for_input()
 				)
@@ -562,11 +562,11 @@ 
 	 * @param \EE_Payment_Method $payment_method
 	 * @return \EE_Form_Section_Proper
 	 */
-	protected function _deactivate_payment_method_button( EE_Payment_Method $payment_method ) {
-		$link_text_and_title = sprintf( __( 'Deactivate %1$s Payments?', 'event_espresso'), $payment_method->admin_name() );
+	protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method) {
+		$link_text_and_title = sprintf(__('Deactivate %1$s Payments?', 'event_espresso'), $payment_method->admin_name());
 		return new EE_Form_Section_HTML(
 			EEH_HTML::tr(
-				EEH_HTML::th( __( 'Deactivate Payment Method', 'event_espresso') ) .
+				EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')).
 				EEH_HTML::td(
 					EEH_HTML::link(
 						EE_Admin_Page::add_query_args_and_nonce(
@@ -578,7 +578,7 @@ 
 						),
 						$link_text_and_title,
 						$link_text_and_title,
-						'deactivate_' . $payment_method->slug(),
+						'deactivate_'.$payment_method->slug(),
 						'espresso-button button-secondary'
 					)
 				)
@@ -594,12 +594,12 @@ 
 	 * @param \EE_Payment_Method $payment_method
 	 * @return \EE_Form_Section_Proper
 	 */
-	protected function _activate_payment_method_button( EE_Payment_Method $payment_method ) {
-		$link_text_and_title = sprintf( __( 'Activate %1$s Payment Method?', 'event_espresso'), $payment_method->admin_name() );
+	protected function _activate_payment_method_button(EE_Payment_Method $payment_method) {
+		$link_text_and_title = sprintf(__('Activate %1$s Payment Method?', 'event_espresso'), $payment_method->admin_name());
 		return new EE_Form_Section_Proper(
 			array(
-				'name' 	=> 'activate_' . $payment_method->slug() . '_settings_form',
-				'html_id' 	=> 'activate_' . $payment_method->slug() . '_settings_form',
+				'name' 	=> 'activate_'.$payment_method->slug().'_settings_form',
+				'html_id' 	=> 'activate_'.$payment_method->slug().'_settings_form',
 				'action' 	=> '#',
 				'layout_strategy'		=> new EE_Admin_Two_Column_Layout(),
 				'subsections' 			=> apply_filters(
@@ -607,17 +607,17 @@ 
 					array(
 						new EE_Form_Section_HTML(
 							EEH_HTML::tr(
-								EEH_HTML::td( $payment_method->type_obj()->introductory_html(),
+								EEH_HTML::td($payment_method->type_obj()->introductory_html(),
 									'',
 									'',
 									'',
 									'colspan="2"' 
 								)
-							) . 
+							). 
 							EEH_HTML::tr(
 								EEH_HTML::th(
-									EEH_HTML::label( __( 'Click to Activate ', 'event_espresso' ))
-								) .
+									EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
+								).
 								EEH_HTML::td(
 									EEH_HTML::link(
 										EE_Admin_Page::add_query_args_and_nonce(
@@ -629,7 +629,7 @@ 
 										),
 										$link_text_and_title,
 										$link_text_and_title,
-										'activate_' . $payment_method->slug(),
+										'activate_'.$payment_method->slug(),
 										'espresso-button-green button-primary'
 									)
 								)
@@ -651,9 +651,9 @@ 
 	protected function _fine_print() {
 		return new EE_Form_Section_HTML(
 			EEH_HTML::tr(
-				EEH_HTML::th() .
+				EEH_HTML::th().
 				EEH_HTML::td(
-					EEH_HTML::p( __( 'All fields marked with a * are required fields', 'event_espresso' ), '', 'grey-text' )
+					EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
 				)
 			)
 		);
@@ -665,15 +665,15 @@ 
 	 * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
 	 * @global WP_User $current_user
 	 */
-	protected function _activate_payment_method(){
-		if(isset($this->_req_data['payment_method_type'])){
+	protected function _activate_payment_method() {
+		if (isset($this->_req_data['payment_method_type'])) {
 			$payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
 			//see if one exists
-			EE_Registry::instance()->load_lib( 'Payment_Method_Manager' );
-			$payment_method = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type( $payment_method_type );
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$payment_method = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type($payment_method_type);
 
-			$this->_redirect_after_action(1, 'Payment Method', 'activated', array('action' => 'default','payment_method'=>$payment_method->slug()));
-		}else{
+			$this->_redirect_after_action(1, 'Payment Method', 'activated', array('action' => 'default', 'payment_method'=>$payment_method->slug()));
+		} else {
 			$this->_redirect_after_action(FALSE, 'Payment Method', 'activated', array('action' => 'default'));
 		}
 	}
@@ -681,14 +681,14 @@ 
 	/**
 	 * Deactivates the payment method with the specified slug, and redirects.
 	 */
-	protected function _deactivate_payment_method(){
-		if(isset($this->_req_data['payment_method'])){
+	protected function _deactivate_payment_method() {
+		if (isset($this->_req_data['payment_method'])) {
 			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
 			//deactivate it
 			EE_Registry::instance()->load_lib('Payment_Method_Manager');
-			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method( $payment_method_slug );
-			$this->_redirect_after_action($count_updated, 'Payment Method', 'deactivated', array('action' => 'default','payment_method'=>$payment_method_slug));
-		}else{
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
+			$this->_redirect_after_action($count_updated, 'Payment Method', 'deactivated', array('action' => 'default', 'payment_method'=>$payment_method_slug));
+		} else {
 			$this->_redirect_after_action(FALSE, 'Payment Method', 'deactivated', array('action' => 'default'));
 		}
 	}
@@ -702,46 +702,46 @@ 
 	 * subsequently called 'headers_sent_func' which is _payment_methods_list)
 	 * @return void
 	 */
-	protected function _update_payment_method(){
-		if( $_SERVER['REQUEST_METHOD'] == 'POST'){
+	protected function _update_payment_method() {
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
 			//ok let's find which gateway form to use based on the form input
 			EE_Registry::instance()->load_lib('Payment_Method_Manager');
 			/** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
 			$correct_pmt_form_to_use = NULL;
 			$payment_method = NULL;
-			foreach( EEM_Payment_Method::instance()->get_all() as $payment_method){
+			foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
 				//get the form and simplify it, like what we do when we display it
-				$pmt_form = $this->_generate_payment_method_settings_form( $payment_method );
-				if($pmt_form->form_data_present_in($this->_req_data)){
+				$pmt_form = $this->_generate_payment_method_settings_form($payment_method);
+				if ($pmt_form->form_data_present_in($this->_req_data)) {
 					$correct_pmt_form_to_use = $pmt_form;
 					break;
 				}
 			}
 			//if we couldn't find the correct payment method type...
-			if( ! $correct_pmt_form_to_use ){
+			if ( ! $correct_pmt_form_to_use) {
 				EE_Error::add_error(__("We could not find which payment method type your form submission related to. Please contact support", 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 				$this->_redirect_after_action(FALSE, 'Payment Method', 'activated', array('action' => 'default'));
 			}
 			$correct_pmt_form_to_use->receive_form_submission($this->_req_data);
-			if($correct_pmt_form_to_use->is_valid()){
-				$subsection_name = 'payment_method_settings_' . $payment_method->slug();
-				$payment_settings_subform = $correct_pmt_form_to_use->get_subsection( $subsection_name );
-				if( ! $payment_settings_subform instanceof EE_Payment_Method_Form ) {
+			if ($correct_pmt_form_to_use->is_valid()) {
+				$subsection_name = 'payment_method_settings_'.$payment_method->slug();
+				$payment_settings_subform = $correct_pmt_form_to_use->get_subsection($subsection_name);
+				if ( ! $payment_settings_subform instanceof EE_Payment_Method_Form) {
 					throw new EE_Error( 
 						sprintf(
-							__( 'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.','event_espresso' ),
+							__('The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.', 'event_espresso'),
 							$subsection_name
 						)
 					);
 				}
 				$payment_settings_subform->save();
 				/** @var $pm EE_Payment_Method */
-				$this->_redirect_after_action(TRUE, 'Payment Method', 'updated', array('action' => 'default','payment_method'=>$payment_method->slug()));
-			}else{
+				$this->_redirect_after_action(TRUE, 'Payment Method', 'updated', array('action' => 'default', 'payment_method'=>$payment_method->slug()));
+			} else {
 				EE_Error::add_error(
 					sprintf(
 						__('Payment method of type %s was not saved because there were validation errors. They have been marked in the form', 'event_espresso'),
-						$payment_method instanceof EE_PMT_Base ? $payment_method->pretty_name() : __( '"(unknown)"', 'event_espresso' )
+						$payment_method instanceof EE_PMT_Base ? $payment_method->pretty_name() : __('"(unknown)"', 'event_espresso')
 					),
 					__FILE__,
 					__FUNCTION__,
@@ -758,11 +758,11 @@ 
 	protected function _payment_settings() {
 
 		$this->_template_args['values'] = $this->_yes_no_values;
-		$this->_template_args['show_pending_payment_options'] = isset( EE_Registry::instance()->CFG->registration->show_pending_payment_options ) ? absint( EE_Registry::instance()->CFG->registration->show_pending_payment_options ) : FALSE;
+		$this->_template_args['show_pending_payment_options'] = isset(EE_Registry::instance()->CFG->registration->show_pending_payment_options) ? absint(EE_Registry::instance()->CFG->registration->show_pending_payment_options) : FALSE;
 
-		$this->_set_add_edit_form_tags( 'update_payment_settings' );
-		$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
-		$this->_template_args['admin_page_content'] = EEH_Template::display_template( EE_PAYMENTS_TEMPLATE_PATH . 'payment_settings.template.php', $this->_template_args, TRUE );
+		$this->_set_add_edit_form_tags('update_payment_settings');
+		$this->_set_publish_post_box_vars(NULL, FALSE, FALSE, NULL, FALSE);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(EE_PAYMENTS_TEMPLATE_PATH.'payment_settings.template.php', $this->_template_args, TRUE);
 		$this->display_admin_page_with_sidebar();
 
 	}
@@ -776,8 +776,8 @@ 
 	*		@return array
 	*/
 	protected function _update_payment_settings() {
-		EE_Registry::instance()->CFG->registration->show_pending_payment_options = isset( $this->_req_data['show_pending_payment_options'] ) ? $this->_req_data['show_pending_payment_options'] : FALSE;
-		EE_Registry::instance()->CFG = apply_filters( 'FHEE__Payments_Admin_Page___update_payment_settings__CFG', EE_Registry::instance()->CFG );
+		EE_Registry::instance()->CFG->registration->show_pending_payment_options = isset($this->_req_data['show_pending_payment_options']) ? $this->_req_data['show_pending_payment_options'] : FALSE;
+		EE_Registry::instance()->CFG = apply_filters('FHEE__Payments_Admin_Page___update_payment_settings__CFG', EE_Registry::instance()->CFG);
 
 //		 $superform = new EE_Form_Section_Proper(
 //		 	array(
@@ -797,9 +797,9 @@ 
 //		 	$this->_redirect_after_action( 0, 'settings', 'updated', array( 'action' => 'payment_settings' ) );
 //		 }
 
-		$what = __('Payment Settings','event_espresso');
-		$success = $this->_update_espresso_configuration( $what, EE_Registry::instance()->CFG, __FILE__, __FUNCTION__, __LINE__ );
-		$this->_redirect_after_action( $success, $what, __('updated','event_espresso'), array( 'action' => 'payment_settings' ) );
+		$what = __('Payment Settings', 'event_espresso');
+		$success = $this->_update_espresso_configuration($what, EE_Registry::instance()->CFG, __FILE__, __FUNCTION__, __LINE__);
+		$this->_redirect_after_action($success, $what, __('updated', 'event_espresso'), array('action' => 'payment_settings'));
 
 	}
 	protected function _payment_log_overview_list_table() {
@@ -825,18 +825,18 @@ 
 	 * @param bool $count
 	 * @return array
 	 */
-	public function get_payment_logs($per_page = 50, $current_page = 0, $count = false){
-		EE_Registry::instance()->load_model( 'Change_Log' );
+	public function get_payment_logs($per_page = 50, $current_page = 0, $count = false) {
+		EE_Registry::instance()->load_model('Change_Log');
 		//we may need to do multiple queries (joining differently), so we actually wan tan array of query params
-		$query_params =  array(array('LOG_type'=>  EEM_Change_Log::type_gateway));
+		$query_params = array(array('LOG_type'=>  EEM_Change_Log::type_gateway));
 		//check if they've selected a specific payment method
-		if( isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all'){
+		if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
 			$query_params[0]['OR*pm_or_pay_pm'] = array('Payment.Payment_Method.PMD_ID'=>$this->_req_data['_payment_method'],
 				'Payment_Method.PMD_ID'=>$this->_req_data['_payment_method']);
 		}
 		//take into account search
-		if(isset($this->_req_data['s']) && $this->_req_data['s']){
-			$similarity_string = array('LIKE','%'.str_replace("","%",$this->_req_data['s']) .'%');
+		if (isset($this->_req_data['s']) && $this->_req_data['s']) {
+			$similarity_string = array('LIKE', '%'.str_replace("", "%", $this->_req_data['s']).'%');
 			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
 			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
 			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
@@ -851,48 +851,48 @@ 
 			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
 
 		}
-		if(isset( $this->_req_data['payment-filter-start-date'] ) && isset( $this->_req_data['payment-filter-end-date'] )){
+		if (isset($this->_req_data['payment-filter-start-date']) && isset($this->_req_data['payment-filter-end-date'])) {
 			//add date
-			$start_date =wp_strip_all_tags( $this->_req_data['payment-filter-start-date'] );
-			$end_date = wp_strip_all_tags( $this->_req_data['payment-filter-end-date'] );
+			$start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
+			$end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
 			//make sure our timestamps start and end right at the boundaries for each day
-			$start_date = date( 'Y-m-d', strtotime( $start_date ) ) . ' 00:00:00';
-			$end_date = date( 'Y-m-d', strtotime( $end_date ) ) . ' 23:59:59';
+			$start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00';
+			$end_date = date('Y-m-d', strtotime($end_date)).' 23:59:59';
 
 			//convert to timestamps
-			$start_date = strtotime( $start_date );
-			$end_date = strtotime( $end_date );
+			$start_date = strtotime($start_date);
+			$end_date = strtotime($end_date);
 
 			//makes sure start date is the lowest value and vice versa
-			$start_date = min( $start_date, $end_date );
-			$end_date = max( $start_date, $end_date );
+			$start_date = min($start_date, $end_date);
+			$end_date = max($start_date, $end_date);
 
 			//convert for query
-			$start_date = EEM_Change_Log::instance()->convert_datetime_for_query( 'LOG_time', date( 'Y-m-d H:i:s', $start_date ), 'Y-m-d H:i:s' );
-			$end_date = EEM_Change_Log::instance()->convert_datetime_for_query( 'LOG_time', date( 'Y-m-d H:i:s', $end_date ), 'Y-m-d H:i:s' );
+			$start_date = EEM_Change_Log::instance()->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $start_date), 'Y-m-d H:i:s');
+			$end_date = EEM_Change_Log::instance()->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $end_date), 'Y-m-d H:i:s');
 
-			$query_params[0]['LOG_time'] = array('BETWEEN',array($start_date,$end_date));
+			$query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
 
 		}
-		if($count){
+		if ($count) {
 			return EEM_Change_Log::instance()->count($query_params);
 		}
-		if(isset($this->_req_data['order'])){
-			$sort = ( isset( $this->_req_data['order'] ) && ! empty( $this->_req_data['order'] )) ? $this->_req_data['order'] : 'DESC';
+		if (isset($this->_req_data['order'])) {
+			$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'DESC';
 			$query_params['order_by'] = array('LOG_time' => $sort);
-		}else{
+		} else {
 				$query_params['order_by'] = array('LOG_time' => 'DESC');
 		}
-		$offset = ($current_page-1)*$per_page;
+		$offset = ($current_page - 1) * $per_page;
 
-		if( ! isset($this->_req_data['download_results'])){
-			$query_params['limit'] = array( $offset, $per_page );
+		if ( ! isset($this->_req_data['download_results'])) {
+			$query_params['limit'] = array($offset, $per_page);
 		}
 
 
 
 		//now they've requested to instead just download the file instead of viewing it.
-		if(isset($this->_req_data['download_results'])){
+		if (isset($this->_req_data['download_results'])) {
 			$wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
 			header('Content-Disposition: attachment');
 			header("Content-Disposition: attachment; filename=ee_payment_logs_for_".sanitize_key(site_url()));
@@ -914,36 +914,36 @@ 
 	 * @param EE_Change_Log $logB
 	 * @return int
 	 */
-	protected function _sort_logs_again($logA,$logB){
+	protected function _sort_logs_again($logA, $logB) {
 		$timeA = $logA->get_raw('LOG_time');
 		$timeB = $logB->get_raw('LOG_time');
-		if($timeA == $timeB){
+		if ($timeA == $timeB) {
 			return 0;
 		}
 		$comparison = $timeA < $timeB ? -1 : 1;
-		if(strtoupper($this->_sort_logs_again_direction) == 'DESC'){
+		if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
 			return $comparison * -1;
-		}else{
+		} else {
 			return $comparison;
 		}
 	}
 
 	protected function _payment_log_details() {
-		EE_Registry::instance()->load_model( 'Change_Log' );
+		EE_Registry::instance()->load_model('Change_Log');
 		/** @var $payment_log EE_Change_Log */
 		$payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
 		$payment_method = NULL;
 		$transaction = NULL;
-		if( $payment_log instanceof EE_Change_Log ){
-			if( $payment_log->object() instanceof EE_Payment ){
+		if ($payment_log instanceof EE_Change_Log) {
+			if ($payment_log->object() instanceof EE_Payment) {
 				$payment_method = $payment_log->object()->payment_method();
 				$transaction = $payment_log->object()->transaction();
-			}elseif($payment_log->object() instanceof EE_Payment_Method){
+			}elseif ($payment_log->object() instanceof EE_Payment_Method) {
 				$payment_method = $payment_log->object();
 			}
 		}
 		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
-			EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+			EE_PAYMENTS_TEMPLATE_PATH.'payment_log_details.template.php',
 			array(
 				'payment_log'=>$payment_log,
 				'payment_method'=>$payment_method,

core/db_classes/EE_Datetime.class.php

Indentation +36 added lines, -36 removed lines

@@ -358,13 +358,13 @@ 
 
 
 
-    /**
-     * get event start date.  Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
-     * @return        mixed        string on success, FALSE on fail
-     */
+	/**
+	 * get event start date.  Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
+	 * @return        mixed        string on success, FALSE on fail
+	 */
 	public function start_date( $dt_frmt = '' ) {
 		return $this->_show_datetime( 'D', 'start', $dt_frmt );
 	}
@@ -381,13 +381,13 @@ 
 
 
 
-    /**
-     * get end date. Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
-     * @return        mixed        string on success, FALSE on fail
-     */
+	/**
+	 * get end date. Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
+	 * @return        mixed        string on success, FALSE on fail
+	 */
 	public function end_date( $dt_frmt = '' ) {
 		return $this->_show_datetime( 'D', 'end', $dt_frmt );
 	}
@@ -509,23 +509,23 @@ 
 	/**
 	 * This returns a range representation of the date and times.
 	 * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end.
-     * Also, the return value is localized.
-     *
-     * @param string $dt_format
+	 * Also, the return value is localized.
+	 *
+	 * @param string $dt_format
 	 * @param string $tm_format
 	 * @param string $conjunction used between two different dates or times.
-     *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
-     * @param string $separator   used between the date and time formats.
-     *                            ex: Dec 1, 2016{$separator}2pm
+	 *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
+	 * @param string $separator   used between the date and time formats.
+	 *                            ex: Dec 1, 2016{$separator}2pm
 	 * @return string
 	 * @throws \EE_Error
 	 */
 	public function date_and_time_range(
-	    $dt_format = '',
-        $tm_format = '',
-        $conjunction = ' - ' ,
-        $separator = ' '
-    ) {
+		$dt_format = '',
+		$tm_format = '',
+		$conjunction = ' - ' ,
+		$separator = ' '
+	) {
 		$dt_format = ! empty( $dt_format ) ? $dt_format : $this->_dt_frmt;
 		$tm_format = ! empty( $tm_format ) ? $tm_format : $this->_tm_frmt;
 		$full_format = $dt_format . $separator . $tm_format;
@@ -539,14 +539,14 @@ 
 			//start and end date are the same but times are different
 			case ( $this->start_date() === $this->end_date() ) :
 				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
-				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $tm_format );
+						  . $conjunction
+						  . $this->get_i18n_datetime( 'DTT_EVT_end', $tm_format );
 				break;
 			//all other conditions
 			default :
 				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
-				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $full_format );
+						  . $conjunction
+						  . $this->get_i18n_datetime( 'DTT_EVT_end', $full_format );
 				break;
 		}
 		return $output;
@@ -630,13 +630,13 @@ 
 
 
 	/**
-     *        get end date and time
-     *
-     * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
-     * @param string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return    mixed                string on success, FALSE on fail
-     */
-    public function end_date_and_time($dt_frmt = '', $tm_format = '') {
+	 *        get end date and time
+	 *
+	 * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
+	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return    mixed                string on success, FALSE on fail
+	 */
+	public function end_date_and_time($dt_frmt = '', $tm_format = '') {
 		return $this->_show_datetime( '', 'end', $dt_frmt, $tm_format );
 	}
 

Spacing +150 added lines, -150 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -74,9 +74,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Datetime
 	 */
-	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 );
+	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);
 	}
 
 
@@ -87,8 +87,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Datetime
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -96,8 +96,8 @@ 
 	/**
 	 * @param $name
 	 */
-	public function set_name( $name ) {
-		$this->set( 'DTT_name', $name );
+	public function set_name($name) {
+		$this->set('DTT_name', $name);
 	}
 
 
@@ -105,8 +105,8 @@ 
 	/**
 	 * @param $description
 	 */
-	public function set_description( $description ) {
-		$this->set( 'DTT_description', $description );
+	public function set_description($description) {
+		$this->set('DTT_description', $description);
 	}
 
 
@@ -118,8 +118,8 @@ 
 	 *
 	 * @param        string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
 	 */
-	public function set_start_date( $date ) {
-		$this->_set_date_for( $date, 'DTT_EVT_start' );
+	public function set_start_date($date) {
+		$this->_set_date_for($date, 'DTT_EVT_start');
 	}
 
 
@@ -131,8 +131,8 @@ 
 	 *
 	 * @param        string $time a string representation of the event time ex:  9am  or  7:30 PM
 	 */
-	public function set_start_time( $time ) {
-		$this->_set_time_for( $time, 'DTT_EVT_start' );
+	public function set_start_time($time) {
+		$this->_set_time_for($time, 'DTT_EVT_start');
 	}
 
 
@@ -144,8 +144,8 @@ 
 	 *
 	 * @param        string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
 	 */
-	public function set_end_date( $date ) {
-		$this->_set_date_for( $date, 'DTT_EVT_end' );
+	public function set_end_date($date) {
+		$this->_set_date_for($date, 'DTT_EVT_end');
 	}
 
 
@@ -157,8 +157,8 @@ 
 	 *
 	 * @param        string $time a string representation of the event time ex:  9am  or  7:30 PM
 	 */
-	public function set_end_time( $time ) {
-		$this->_set_time_for( $time, 'DTT_EVT_end' );
+	public function set_end_time($time) {
+		$this->_set_time_for($time, 'DTT_EVT_end');
 	}
 
 
@@ -170,8 +170,8 @@ 
 	 *
 	 * @param        int $reg_limit
 	 */
-	public function set_reg_limit( $reg_limit ) {
-		$this->set( 'DTT_reg_limit', $reg_limit );
+	public function set_reg_limit($reg_limit) {
+		$this->set('DTT_reg_limit', $reg_limit);
 	}
 
 
@@ -183,7 +183,7 @@ 
 	 * @return        mixed        int on success, FALSE on fail
 	 */
 	public function sold() {
-		return $this->get_raw( 'DTT_sold' );
+		return $this->get_raw('DTT_sold');
 	}
 
 
@@ -193,10 +193,10 @@ 
 	 *
 	 * @param        int $sold
 	 */
-	public function set_sold( $sold ) {
+	public function set_sold($sold) {
 		// sold can not go below zero
-		$sold = max( 0, $sold );
-		$this->set( 'DTT_sold', $sold );
+		$sold = max(0, $sold);
+		$this->set('DTT_sold', $sold);
 	}
 
 
@@ -205,11 +205,11 @@ 
 	 * increments sold by amount passed by $qty
 	 * @param int $qty
 	 */
-	public function increase_sold( $qty = 1 ) {
+	public function increase_sold($qty = 1) {
 		$sold = $this->sold() + $qty;
 		// remove ticket reservation
-		$this->decrease_reserved( $qty );
-		$this->set_sold( $sold );
+		$this->decrease_reserved($qty);
+		$this->set_sold($sold);
 	}
 
 
@@ -218,9 +218,9 @@ 
 	 * decrements (subtracts) sold amount passed by $qty
 	 * @param int $qty
 	 */
-	public function decrease_sold( $qty = 1 ) {
+	public function decrease_sold($qty = 1) {
 		$sold = $this->sold() - $qty;
-		$this->set_sold( $sold );
+		$this->set_sold($sold);
 	}
 
 
@@ -231,7 +231,7 @@ 
 	 * @return int
 	 */
 	public function reserved() {
-		return $this->get_raw( 'DTT_reserved' );
+		return $this->get_raw('DTT_reserved');
 	}
 
 
@@ -241,10 +241,10 @@ 
 	 *
 	 * @param int $reserved
 	 */
-	public function set_reserved( $reserved ) {
+	public function set_reserved($reserved) {
 		// reserved can not go below zero
-		$reserved = max( 0, (int) $reserved );
-		$this->set( 'DTT_reserved', $reserved );
+		$reserved = max(0, (int) $reserved);
+		$this->set('DTT_reserved', $reserved);
 	}
 
 
@@ -255,9 +255,9 @@ 
 	 * @param int $qty
 	 * @return boolean
 	 */
-	public function increase_reserved( $qty = 1 ) {
-		$reserved = $this->reserved() + absint( $qty );
-		return $this->set_reserved( $reserved );
+	public function increase_reserved($qty = 1) {
+		$reserved = $this->reserved() + absint($qty);
+		return $this->set_reserved($reserved);
 	}
 
 
@@ -268,9 +268,9 @@ 
 	 * @param int $qty
 	 * @return boolean
 	 */
-	public function decrease_reserved( $qty = 1 ) {
-		$reserved = $this->reserved() - absint( $qty );
-		return $this->set_reserved( $reserved );
+	public function decrease_reserved($qty = 1) {
+		$reserved = $this->reserved() - absint($qty);
+		return $this->set_reserved($reserved);
 	}
 
 
@@ -291,7 +291,7 @@ 
 	 * @return string
 	 */
 	public function name() {
-		return $this->get( 'DTT_name' );
+		return $this->get('DTT_name');
 	}
 
 
@@ -301,7 +301,7 @@ 
 	 * @return string
 	 */
 	public function description() {
-		return $this->get( 'DTT_description' );
+		return $this->get('DTT_description');
 	}
 
 
@@ -311,7 +311,7 @@ 
 	 * @return boolean          TRUE if is primary, FALSE if not.
 	 */
 	public function is_primary() {
-		return $this->get( 'DTT_is_primary' );
+		return $this->get('DTT_is_primary');
 	}
 
 
@@ -321,7 +321,7 @@ 
 	 * @return int         The order of the datetime for this event.
 	 */
 	public function order() {
-		return $this->get( 'DTT_order' );
+		return $this->get('DTT_order');
 	}
 
 
@@ -331,7 +331,7 @@ 
 	 * @return int
 	 */
 	public function parent() {
-		return $this->get( 'DTT_parent' );
+		return $this->get('DTT_parent');
 	}
 
 
@@ -347,10 +347,10 @@ 
 	 * @param    bool   $echo         - whether we echo or return (note echoing uses "pretty" formats, otherwise we use the standard formats)
 	 * @return    string|bool  string on success, FALSE on fail
 	 */
-	private function _show_datetime( $date_or_time = NULL, $start_or_end = 'start', $dt_frmt = '', $tm_frmt = '', $echo = FALSE ) {
+	private function _show_datetime($date_or_time = NULL, $start_or_end = 'start', $dt_frmt = '', $tm_frmt = '', $echo = FALSE) {
 		$field_name = "DTT_EVT_{$start_or_end}";
-		$dtt = $this->_get_datetime( $field_name, $dt_frmt, $tm_frmt, $date_or_time, $echo );
-		if ( ! $echo ) {
+		$dtt = $this->_get_datetime($field_name, $dt_frmt, $tm_frmt, $date_or_time, $echo);
+		if ( ! $echo) {
 			return $dtt;
 		}
 		return '';
@@ -365,8 +365,8 @@ 
      * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
      * @return        mixed        string on success, FALSE on fail
      */
-	public function start_date( $dt_frmt = '' ) {
-		return $this->_show_datetime( 'D', 'start', $dt_frmt );
+	public function start_date($dt_frmt = '') {
+		return $this->_show_datetime('D', 'start', $dt_frmt);
 	}
 
 
@@ -375,8 +375,8 @@ 
 	 * Echoes start_date()
 	 * @param string $dt_frmt
 	 */
-	public function e_start_date( $dt_frmt = '' ) {
-		$this->_show_datetime( 'D', 'start', $dt_frmt, NULL, TRUE );
+	public function e_start_date($dt_frmt = '') {
+		$this->_show_datetime('D', 'start', $dt_frmt, NULL, TRUE);
 	}
 
 
@@ -388,8 +388,8 @@ 
      * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
      * @return        mixed        string on success, FALSE on fail
      */
-	public function end_date( $dt_frmt = '' ) {
-		return $this->_show_datetime( 'D', 'end', $dt_frmt );
+	public function end_date($dt_frmt = '') {
+		return $this->_show_datetime('D', 'end', $dt_frmt);
 	}
 
 
@@ -398,8 +398,8 @@ 
 	 * Echoes the end date. See end_date()
 	 * @param string $dt_frmt
 	 */
-	public function e_end_date( $dt_frmt = '' ) {
-		$this->_show_datetime( 'D', 'end', $dt_frmt, NULL, TRUE );
+	public function e_end_date($dt_frmt = '') {
+		$this->_show_datetime('D', 'end', $dt_frmt, NULL, TRUE);
 	}
 
 
@@ -414,11 +414,11 @@ 
 	 * @return mixed        string on success, FALSE on fail
 	 * @throws \EE_Error
 	 */
-	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
-		$dt_frmt = ! empty( $dt_frmt ) ? $dt_frmt : $this->_dt_frmt;
-		$start = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_start', $dt_frmt ) );
-		$end = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_end', $dt_frmt ) );
-		return $start !== $end ? $start . $conjunction . $end : $start;
+	public function date_range($dt_frmt = '', $conjunction = ' - ') {
+		$dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
+		$start = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt));
+		$end = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt));
+		return $start !== $end ? $start.$conjunction.$end : $start;
 	}
 
 
@@ -428,8 +428,8 @@ 
 	 * @param string $conjunction
 	 * @throws \EE_Error
 	 */
-	public function e_date_range( $dt_frmt = '', $conjunction = ' - ' ) {
-		echo $this->date_range( $dt_frmt, $conjunction );
+	public function e_date_range($dt_frmt = '', $conjunction = ' - ') {
+		echo $this->date_range($dt_frmt, $conjunction);
 	}
 
 
@@ -440,8 +440,8 @@ 
 	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
 	 * @return mixed        string on success, FALSE on fail
 	 */
-	public function start_time( $tm_format = '' ) {
-		return $this->_show_datetime( 'T', 'start', NULL, $tm_format );
+	public function start_time($tm_format = '') {
+		return $this->_show_datetime('T', 'start', NULL, $tm_format);
 	}
 
 
@@ -449,8 +449,8 @@ 
 	/**
 	 * @param string $tm_format
 	 */
-	public function e_start_time( $tm_format = '' ) {
-		$this->_show_datetime( 'T', 'start', NULL, $tm_format, TRUE );
+	public function e_start_time($tm_format = '') {
+		$this->_show_datetime('T', 'start', NULL, $tm_format, TRUE);
 	}
 
 
@@ -461,8 +461,8 @@ 
 	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
 	 * @return mixed        string on success, FALSE on fail
 	 */
-	public function end_time( $tm_format = '' ) {
-		return $this->_show_datetime( 'T', 'end', NULL, $tm_format );
+	public function end_time($tm_format = '') {
+		return $this->_show_datetime('T', 'end', NULL, $tm_format);
 	}
 
 
@@ -470,8 +470,8 @@ 
 	/**
 	 * @param string $tm_format
 	 */
-	public function e_end_time( $tm_format = '' ) {
-		$this->_show_datetime( 'T', 'end', NULL, $tm_format, TRUE );
+	public function e_end_time($tm_format = '') {
+		$this->_show_datetime('T', 'end', NULL, $tm_format, TRUE);
 	}
 
 
@@ -486,11 +486,11 @@ 
 	 * @return mixed              string on success, FALSE on fail
 	 * @throws \EE_Error
 	 */
-	public function time_range( $tm_format = '', $conjunction = ' - ' ) {
-		$tm_format = ! empty( $tm_format ) ? $tm_format : $this->_tm_frmt;
-		$start = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_start', $tm_format ) );
-		$end = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_end',  $tm_format ) );
-		return $start !== $end ? $start . $conjunction . $end : $start;
+	public function time_range($tm_format = '', $conjunction = ' - ') {
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$start = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_start', $tm_format));
+		$end = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_end', $tm_format));
+		return $start !== $end ? $start.$conjunction.$end : $start;
 	}
 
 
@@ -500,8 +500,8 @@ 
 	 * @param string $conjunction
 	 * @throws \EE_Error
 	 */
-	public function e_time_range( $tm_format = '', $conjunction = ' - ' ) {
-		echo $this->time_range( $tm_format, $conjunction );
+	public function e_time_range($tm_format = '', $conjunction = ' - ') {
+		echo $this->time_range($tm_format, $conjunction);
 	}
 
 
@@ -523,30 +523,30 @@ 
 	public function date_and_time_range(
 	    $dt_format = '',
         $tm_format = '',
-        $conjunction = ' - ' ,
+        $conjunction = ' - ',
         $separator = ' '
     ) {
-		$dt_format = ! empty( $dt_format ) ? $dt_format : $this->_dt_frmt;
-		$tm_format = ! empty( $tm_format ) ? $tm_format : $this->_tm_frmt;
-		$full_format = $dt_format . $separator . $tm_format;
+		$dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$full_format = $dt_format.$separator.$tm_format;
 
 		//the range output depends on various conditions
-		switch ( true ) {
+		switch (true) {
 			//start date timestamp and end date timestamp are the same.
-			case ( $this->get_raw( 'DTT_EVT_start' ) === $this->get_raw( 'DTT_EVT_end' ) ) :
-				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format );
+			case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')) :
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format);
 				break;
 			//start and end date are the same but times are different
-			case ( $this->start_date() === $this->end_date() ) :
-				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
+			case ($this->start_date() === $this->end_date()) :
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
 				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $tm_format );
+				          . $this->get_i18n_datetime('DTT_EVT_end', $tm_format);
 				break;
 			//all other conditions
 			default :
-				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
 				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $full_format );
+				          . $this->get_i18n_datetime('DTT_EVT_end', $full_format);
 				break;
 		}
 		return $output;
@@ -564,8 +564,8 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function e_date_and_time_range( $dt_format = '', $tm_format = '', $conjunction = ' - ' ) {
-		echo $this->date_and_time_range( $dt_format, $tm_format, $conjunction );
+	public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ') {
+		echo $this->date_and_time_range($dt_format, $tm_format, $conjunction);
 	}
 
 
@@ -577,8 +577,8 @@ 
 	 * @param 	string 	$tm_format - string representation of time format defaults to 'g:i a'
 	 * @return 	mixed 	string on success, FALSE on fail
 	 */
-	public function start_date_and_time( $dt_format = '', $tm_format = '' ) {
-		return $this->_show_datetime( '', 'start', $dt_format, $tm_format );
+	public function start_date_and_time($dt_format = '', $tm_format = '') {
+		return $this->_show_datetime('', 'start', $dt_format, $tm_format);
 	}
 
 
@@ -587,8 +587,8 @@ 
 	 * @param string $dt_frmt
 	 * @param string $tm_format
 	 */
-	public function e_start_date_and_time( $dt_frmt = '', $tm_format = '' ) {
-		$this->_show_datetime( '', 'start', $dt_frmt, $tm_format, TRUE );
+	public function e_start_date_and_time($dt_frmt = '', $tm_format = '') {
+		$this->_show_datetime('', 'start', $dt_frmt, $tm_format, TRUE);
 	}
 
 
@@ -602,11 +602,11 @@ 
 	 * @param bool   $round_up
 	 * @return float|int|mixed
 	 */
-	public function length( $units = 'seconds', $round_up = FALSE ) {
-		$start = $this->get_raw( 'DTT_EVT_start' );
-		$end = $this->get_raw( 'DTT_EVT_end' );
+	public function length($units = 'seconds', $round_up = FALSE) {
+		$start = $this->get_raw('DTT_EVT_start');
+		$end = $this->get_raw('DTT_EVT_end');
 		$length_in_units = $end - $start;
-		switch ( $units ) {
+		switch ($units) {
 			//NOTE: We purposefully don't use "break;" in order to chain the divisions
 			/** @noinspection PhpMissingBreakStatementInspection */
 			case 'days':
@@ -619,10 +619,10 @@ 
 				$length_in_units /= 60;
 			case 'seconds':
 			default:
-				$length_in_units = ceil( $length_in_units );
+				$length_in_units = ceil($length_in_units);
 		}
-		if ( $round_up ) {
-			$length_in_units = max( $length_in_units, 1 );
+		if ($round_up) {
+			$length_in_units = max($length_in_units, 1);
 		}
 		return $length_in_units;
 	}
@@ -637,7 +637,7 @@ 
      * @return    mixed                string on success, FALSE on fail
      */
     public function end_date_and_time($dt_frmt = '', $tm_format = '') {
-		return $this->_show_datetime( '', 'end', $dt_frmt, $tm_format );
+		return $this->_show_datetime('', 'end', $dt_frmt, $tm_format);
 	}
 
 
@@ -646,8 +646,8 @@ 
 	 * @param string $dt_frmt
 	 * @param string $tm_format
 	 */
-	public function e_end_date_and_time( $dt_frmt = '', $tm_format = '' ) {
-		$this->_show_datetime( '', 'end', $dt_frmt, $tm_format, TRUE );
+	public function e_end_date_and_time($dt_frmt = '', $tm_format = '') {
+		$this->_show_datetime('', 'end', $dt_frmt, $tm_format, TRUE);
 	}
 
 
@@ -658,7 +658,7 @@ 
 	 * @return        int
 	 */
 	public function start() {
-		return $this->get_raw( 'DTT_EVT_start' );
+		return $this->get_raw('DTT_EVT_start');
 	}
 
 
@@ -669,7 +669,7 @@ 
 	 * @return        int
 	 */
 	public function end() {
-		return $this->get_raw( 'DTT_EVT_end' );
+		return $this->get_raw('DTT_EVT_end');
 	}
 
 
@@ -680,7 +680,7 @@ 
 	 * @return        mixed        int on success, FALSE on fail
 	 */
 	public function reg_limit() {
-		return $this->get_raw( 'DTT_reg_limit' );
+		return $this->get_raw('DTT_reg_limit');
 	}
 
 
@@ -708,15 +708,15 @@ 
 	 * 																	the spaces remaining for this particular datetime, hence the flag.
 	 * @return 	int
 	 */
-	public function spaces_remaining( $consider_tickets = FALSE ) {
+	public function spaces_remaining($consider_tickets = FALSE) {
 		// tickets remaining available for purchase
 		//no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
 		$dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
-		if ( ! $consider_tickets ) {
+		if ( ! $consider_tickets) {
 			return $dtt_remaining;
 		}
 		$tickets_remaining = $this->tickets_remaining();
-		return min( $dtt_remaining, $tickets_remaining );
+		return min($dtt_remaining, $tickets_remaining);
 	}
 
 
@@ -727,19 +727,19 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return int
 	 */
-	public function tickets_remaining( $query_params = array() ) {
+	public function tickets_remaining($query_params = array()) {
 		$sum = 0;
-		$tickets = $this->tickets( $query_params );
-		if ( ! empty( $tickets ) ) {
-			foreach ( $tickets as $ticket ) {
-				if ( $ticket instanceof EE_Ticket ) {
+		$tickets = $this->tickets($query_params);
+		if ( ! empty($tickets)) {
+			foreach ($tickets as $ticket) {
+				if ($ticket instanceof EE_Ticket) {
 					// get the actual amount of tickets that can be sold
-					$qty = $ticket->qty( 'saleable' );
-					if ( $qty === EE_INF ) {
+					$qty = $ticket->qty('saleable');
+					if ($qty === EE_INF) {
 						return EE_INF;
 					}
 					// no negative ticket quantities plz
-					if ( $qty > 0 ) {
+					if ($qty > 0) {
 						$sum += $qty;
 					}
 				}
@@ -756,8 +756,8 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return int
 	 */
-	public function sum_tickets_initially_available( $query_params = array() ) {
-		return $this->sum_related( 'Ticket', $query_params, 'TKT_qty' );
+	public function sum_tickets_initially_available($query_params = array()) {
+		return $this->sum_related('Ticket', $query_params, 'TKT_qty');
 	}
 
 
@@ -769,7 +769,7 @@ 
 	 * @return int
 	 */
 	public function total_tickets_available_at_this_datetime() {
-		return $this->spaces_remaining( true );
+		return $this->spaces_remaining(true);
 	}
 
 
@@ -780,7 +780,7 @@ 
 	 * @return boolean
 	 */
 	public function is_upcoming() {
-		return ( $this->get_raw( 'DTT_EVT_start' ) > time() );
+		return ($this->get_raw('DTT_EVT_start') > time());
 	}
 
 
@@ -790,7 +790,7 @@ 
 	 * @return boolean
 	 */
 	public function is_active() {
-		return ( $this->get_raw( 'DTT_EVT_start' ) < time() && $this->get_raw( 'DTT_EVT_end' ) > time() );
+		return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time());
 	}
 
 
@@ -800,7 +800,7 @@ 
 	 * @return boolean
 	 */
 	public function is_expired() {
-		return ( $this->get_raw( 'DTT_EVT_end' ) < time() );
+		return ($this->get_raw('DTT_EVT_end') < time());
 	}
 
 
@@ -811,16 +811,16 @@ 
 	 */
 	public function get_active_status() {
 		$total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime();
-		if ( $total_tickets_for_this_dtt !== FALSE && $total_tickets_for_this_dtt < 1 ) {
+		if ($total_tickets_for_this_dtt !== FALSE && $total_tickets_for_this_dtt < 1) {
 			return EE_Datetime::sold_out;
 		}
-		if ( $this->is_expired() ) {
+		if ($this->is_expired()) {
 			return EE_Datetime::expired;
 		}
-		if ( $this->is_upcoming() ) {
+		if ($this->is_upcoming()) {
 			return EE_Datetime::upcoming;
 		}
-		if ( $this->is_active() ) {
+		if ($this->is_active()) {
 			return EE_Datetime::active;
 		}
 		return NULL;
@@ -834,24 +834,24 @@ 
 	 * @param  boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty.
 	 * @return string
 	 */
-	public function get_dtt_display_name( $use_dtt_name = FALSE ) {
-		if ( $use_dtt_name ) {
+	public function get_dtt_display_name($use_dtt_name = FALSE) {
+		if ($use_dtt_name) {
 			$dtt_name = $this->name();
-			if ( !empty( $dtt_name ) ) {
+			if ( ! empty($dtt_name)) {
 				return $dtt_name;
 			}
 		}
 		//first condition is to see if the months are different
-		if ( date( 'm', $this->get_raw( 'DTT_EVT_start' ) ) != date( 'm', $this->get_raw( 'DTT_EVT_end' ) ) ) {
-			$display_date = $this->start_date( 'M j\, Y g:i a' ) . ' - ' . $this->end_date( 'M j\, Y g:i a' );
+		if (date('m', $this->get_raw('DTT_EVT_start')) != date('m', $this->get_raw('DTT_EVT_end'))) {
+			$display_date = $this->start_date('M j\, Y g:i a').' - '.$this->end_date('M j\, Y g:i a');
 			//next condition is if its the same month but different day
 		}
 		else {
-			if ( date( 'm', $this->get_raw( 'DTT_EVT_start' ) ) == date( 'm', $this->get_raw( 'DTT_EVT_end' ) ) && date( 'd', $this->get_raw( 'DTT_EVT_start' ) ) != date( 'd', $this->get_raw( 'DTT_EVT_end' ) ) ) {
-				$display_date = $this->start_date( 'M j\, g:i a' ) . ' - ' . $this->end_date( 'M j\, g:i a Y' );
+			if (date('m', $this->get_raw('DTT_EVT_start')) == date('m', $this->get_raw('DTT_EVT_end')) && date('d', $this->get_raw('DTT_EVT_start')) != date('d', $this->get_raw('DTT_EVT_end'))) {
+				$display_date = $this->start_date('M j\, g:i a').' - '.$this->end_date('M j\, g:i a Y');
 			}
 			else {
-				$display_date = $this->start_date( 'F j\, Y' ) . ' @ ' . $this->start_date( 'g:i a' ) . ' - ' . $this->end_date( 'g:i a' );
+				$display_date = $this->start_date('F j\, Y').' @ '.$this->start_date('g:i a').' - '.$this->end_date('g:i a');
 			}
 		}
 		return $display_date;
@@ -865,8 +865,8 @@ 
 *@param array $query_params see EEM_Base::get_all()
 	 * @return EE_Ticket[]
 	 */
-	public function tickets( $query_params = array() ) {
-		return $this->get_many_related( 'Ticket', $query_params );
+	public function tickets($query_params = array()) {
+		return $this->get_many_related('Ticket', $query_params);
 	}
 
 
@@ -876,21 +876,21 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return EE_Ticket[]
 	 */
-	public function ticket_types_available_for_purchase( $query_params = array() ) {
+	public function ticket_types_available_for_purchase($query_params = array()) {
 		// first check if datetime is valid
-		if ( ! ( $this->is_upcoming() || $this->is_active() ) || $this->sold_out() ) {
+		if ( ! ($this->is_upcoming() || $this->is_active()) || $this->sold_out()) {
 			return array();
 		}
-		if ( empty( $query_params ) ) {
+		if (empty($query_params)) {
 			$query_params = array(
 				array(
-					'TKT_start_date' => array( '<=', EEM_Ticket::instance()->current_time_for_query( 'TKT_start_date' ) ),
-					'TKT_end_date'   => array( '>=', EEM_Ticket::instance()->current_time_for_query( 'TKT_end_date' ) ),
+					'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')),
+					'TKT_end_date'   => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
 					'TKT_deleted'    => false
 				)
 			);
 		}
-		return $this->tickets( $query_params );
+		return $this->tickets($query_params);
 	}
 
 
@@ -900,7 +900,7 @@ 
 	 * @return EE_Event
 	 */
 	public function event() {
-		return $this->get_first_related( 'Event' );
+		return $this->get_first_related('Event');
 	}
 
 
@@ -912,13 +912,13 @@ 
 	 */
 	public function update_sold() {
 		$count_regs_for_this_datetime = EEM_Registration::instance()->count(
-			array( array(
+			array(array(
 				'STS_ID' 					=> EEM_Registration::status_id_approved,
 				'REG_deleted' 				=> 0,
 				'Ticket.Datetime.DTT_ID' 	=> $this->ID(),
-			) )
+			))
 		);
-		$this->set( 'DTT_sold', $count_regs_for_this_datetime );
+		$this->set('DTT_sold', $count_regs_for_this_datetime);
 		$this->save();
 		return $count_regs_for_this_datetime;
 	}

core/db_classes/EE_Base_Class.class.php

Indentation +2647 added lines, -2647 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 do_action('AHEE_log', __FILE__, ' FILE LOADED', '');
 
@@ -25,2652 +25,2652 @@ 
 abstract class EE_Base_Class
 {
 
-    /**
-     * This is an array of the original properties and values provided during construction
-     * of this model object. (keys are model field names, values are their values).
-     * This list is important to remember so that when we are merging data from the db, we know
-     * which values to override and which to not override.
-     *
-     * @var array
-     */
-    protected $_props_n_values_provided_in_constructor;
-
-    /**
-     * Timezone
-     * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
-     * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
-     * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
-     * access to it.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-
-
-    /**
-     * date format
-     * pattern or format for displaying dates
-     *
-     * @var string $_dt_frmt
-     */
-    protected $_dt_frmt;
-
-
-
-    /**
-     * time format
-     * pattern or format for displaying time
-     *
-     * @var string $_tm_frmt
-     */
-    protected $_tm_frmt;
-
-
-
-    /**
-     * This property is for holding a cached array of object properties indexed by property name as the key.
-     * The purpose of this is for setting a cache on properties that may have calculated values after a
-     * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
-     * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
-     *
-     * @var array
-     */
-    protected $_cached_properties = array();
-
-    /**
-     * An array containing keys of the related model, and values are either an array of related mode objects or a
-     * single
-     * related model object. see the model's _model_relations. The keys should match those specified. And if the
-     * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
-     * all others have an array)
-     *
-     * @var array
-     */
-    protected $_model_relations = array();
-
-    /**
-     * Array where keys are field names (see the model's _fields property) and values are their values. To see what
-     * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
-     *
-     * @var array
-     */
-    protected $_fields = array();
-
-    /**
-     * @var boolean indicating whether or not this model object is intended to ever be saved
-     * For example, we might create model objects intended to only be used for the duration
-     * of this request and to be thrown away, and if they were accidentally saved
-     * it would be a bug.
-     */
-    protected $_allow_persist = true;
-
-
-
-    /**
-     * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
-     * play nice
-     *
-     * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
-     *                                                         layer of the model's _fields array, (eg, EVT_ID,
-     *                                                         TXN_amount, QST_name, etc) and values are their values
-     * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
-     *                                                         corresponding db model or not.
-     * @param string  $timezone                                indicate what timezone you want any datetime fields to
-     *                                                         be in when instantiating a EE_Base_Class object.
-     * @param array   $date_formats                            An array of date formats to set on construct where first
-     *                                                         value is the date_format and second value is the time
-     *                                                         format.
-     * @throws EE_Error
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
-    {
-        $className = get_class($this);
-        do_action("AHEE__{$className}__construct", $this, $fieldValues);
-        $model = $this->get_model();
-        $model_fields = $model->field_settings(false);
-        // ensure $fieldValues is an array
-        $fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
-        // EEH_Debug_Tools::printr( $fieldValues, '$fieldValues  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        // verify client code has not passed any invalid field names
-        foreach ($fieldValues as $field_name => $field_value) {
-            if ( ! isset($model_fields[$field_name])) {
-                throw new EE_Error(sprintf(__("Invalid field (%s) passed to constructor of %s. Allowed fields are :%s",
-                    "event_espresso"), $field_name, get_class($this), implode(", ", array_keys($model_fields))));
-            }
-        }
-        // EEH_Debug_Tools::printr( $model_fields, '$model_fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        if ( ! empty($date_formats) && is_array($date_formats)) {
-            list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
-        } else {
-            //set default formats for date and time
-            $this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
-            $this->_tm_frmt = (string)get_option('time_format', 'g:i a');
-        }
-        //if db model is instantiating
-        if ($bydb) {
-            //client code has indicated these field values are from the database
-            foreach ($model_fields as $fieldName => $field) {
-                $this->set_from_db($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null);
-            }
-        } else {
-            //we're constructing a brand
-            //new instance of the model object. Generally, this means we'll need to do more field validation
-            foreach ($model_fields as $fieldName => $field) {
-                $this->set($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true);
-            }
-        }
-        //remember what values were passed to this constructor
-        $this->_props_n_values_provided_in_constructor = $fieldValues;
-        //remember in entity mapper
-        if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
-            $model->add_to_entity_map($this);
-        }
-        //setup all the relations
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $this->_model_relations[$relation_name] = null;
-            } else {
-                $this->_model_relations[$relation_name] = array();
-            }
-        }
-        /**
-         * Action done at the end of each model object construction
-         *
-         * @param EE_Base_Class $this the model object just created
-         */
-        do_action('AHEE__EE_Base_Class__construct__finished', $this);
-    }
-
-
-
-    /**
-     * Gets whether or not this model object is allowed to persist/be saved to the database.
-     *
-     * @return boolean
-     */
-    public function allow_persist()
-    {
-        return $this->_allow_persist;
-    }
-
-
-
-    /**
-     * Sets whether or not this model object should be allowed to be saved to the DB.
-     * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
-     * you got new information that somehow made you change your mind.
-     *
-     * @param boolean $allow_persist
-     * @return boolean
-     */
-    public function set_allow_persist($allow_persist)
-    {
-        return $this->_allow_persist = $allow_persist;
-    }
-
-
-
-    /**
-     * Gets the field's original value when this object was constructed during this request.
-     * This can be helpful when determining if a model object has changed or not
-     *
-     * @param string $field_name
-     * @return mixed|null
-     * @throws \EE_Error
-     */
-    public function get_original($field_name)
-    {
-        if (isset($this->_props_n_values_provided_in_constructor[$field_name])
-            && $field_settings = $this->get_model()->field_settings_for($field_name)
-        ) {
-            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * @param EE_Base_Class $obj
-     * @return string
-     */
-    public function get_class($obj)
-    {
-        return get_class($obj);
-    }
-
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @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)
-    {
-        $field_obj = $this->get_model()->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            //			if ( method_exists( $field_obj, 'set_timezone' )) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                $field_obj->set_date_format($this->_dt_frmt);
-                $field_obj->set_time_format($this->_tm_frmt);
-            }
-            $holder_of_value = $field_obj->prepare_for_set($field_value);
-            //should the value be null?
-            if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
-                $this->_fields[$field_name] = $field_obj->get_default_value();
-                /**
-                 * To save having to refactor all the models, if a default value is used for a
-                 * EE_Datetime_Field, and that value is not null nor is it a DateTime
-                 * object.  Then let's do a set again to ensure that it becomes a DateTime
-                 * object.
-                 *
-                 * @since 4.6.10+
-                 */
-                if (
-                    $field_obj instanceof EE_Datetime_Field
-                    && $this->_fields[$field_name] !== null
-                    && ! $this->_fields[$field_name] instanceof DateTime
-                ) {
-                    empty($this->_fields[$field_name])
-                        ? $this->set($field_name, time())
-                        : $this->set($field_name, $this->_fields[$field_name]);
-                }
-            } else {
-                $this->_fields[$field_name] = $holder_of_value;
-            }
-            //if we're not in the constructor...
-            //now check if what we set was a primary key
-            if (
-                //note: props_n_values_provided_in_constructor is only set at the END of the constructor
-                $this->_props_n_values_provided_in_constructor
-                && $field_value
-                && $field_name === self::_get_primary_key_name(get_class($this))
-            ) {
-                //if so, we want all this object's fields to be filled either with
-                //what we've explicitly set on this model
-                //or what we have in the db
-                // echo "setting primary key!";
-                $fields_on_model = self::_get_model(get_class($this))->field_settings();
-                $obj_in_db = self::_get_model(get_class($this))->get_one_by_ID($field_value);
-                foreach ($fields_on_model as $field_obj) {
-                    if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
-                         && $field_obj->get_name() !== $field_name
-                    ) {
-                        $this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
-                    }
-                }
-                //oh this model object has an ID? well make sure its in the entity mapper
-                $this->get_model()->add_to_entity_map($this);
-            }
-            //let's unset any cache for this field_name from the $_cached_properties property.
-            $this->_clear_cached_property($field_name);
-        } else {
-            throw new EE_Error(sprintf(__("A valid EE_Model_Field_Base could not be found for the given field name: %s",
-                "event_espresso"), $field_name));
-        }
-    }
-
-
-
-    /**
-     * This sets the field value on the db column if it exists for the given $column_name or
-     * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
-     *
-     * @see EE_message::get_column_value for related documentation on the necessity of this method.
-     * @param string $field_name  Must be the exact column name.
-     * @param mixed  $field_value The value to set.
-     * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
-     * @throws \EE_Error
-     */
-    public function set_field_or_extra_meta($field_name, $field_value)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $this->set($field_name, $field_value);
-            return true;
-        } else {
-            //ensure this object is saved first so that extra meta can be properly related.
-            $this->save();
-            return $this->update_extra_meta($field_name, $field_value);
-        }
-    }
-
-
-
-    /**
-     * This retrieves the value of the db column set on this class or if that's not present
-     * it will attempt to retrieve from extra_meta if found.
-     * Example Usage:
-     * Via EE_Message child class:
-     * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
-     * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
-     * also have additional main fields specific to the messenger.  The system accommodates those extra
-     * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
-     * value for those extra fields dynamically via the EE_message object.
-     *
-     * @param  string $field_name expecting the fully qualified field name.
-     * @return mixed|null  value for the field if found.  null if not found.
-     * @throws \EE_Error
-     */
-    public function get_field_or_extra_meta($field_name)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $column_value = $this->get($field_name);
-        } else {
-            //This isn't a column in the main table, let's see if it is in the extra meta.
-            $column_value = $this->get_extra_meta($field_name, true, null);
-        }
-        return $column_value;
-    }
-
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
-     * available to all child classes that may be using the EE_Datetime_Field for a field data type.
-     *
-     * @access public
-     * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_timezone($timezone = '')
-    {
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        //make sure we clear all cached properties because they won't be relevant now
-        $this->_clear_cached_properties();
-        //make sure we update field settings and the date for all EE_Datetime_Fields
-        $model_fields = $this->get_model()->field_settings(false);
-        foreach ($model_fields as $field_name => $field_obj) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
-                    $this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone()
-    {
-        return $this->_timezone;
-    }
-
-
-
-    /**
-     * This sets the internal date format to what is sent in to be used as the new default for the class
-     * internally instead of wp set date format options
-     *
-     * @since 4.6
-     * @param string $format should be a format recognizable by PHP date() functions.
-     */
-    public function set_date_format($format)
-    {
-        $this->_dt_frmt = $format;
-        //clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-
-    /**
-     * This sets the internal time format string to what is sent in to be used as the new default for the
-     * class internally instead of wp set time format options.
-     *
-     * @since 4.6
-     * @param string $format should be a format recognizable by PHP date() functions.
-     */
-    public function set_time_format($format)
-    {
-        $this->_tm_frmt = $format;
-        //clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-
-    /**
-     * This returns the current internal set format for the date and time formats.
-     *
-     * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
-     *                             where the first value is the date format and the second value is the time format.
-     * @return mixed string|array
-     */
-    public function get_format($full = true)
-    {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
-    }
-
-
-
-    /**
-     * cache
-     * stores the passed model object on the current model object.
-     * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
-     *
-     * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
-     *                                       'Registration' associated with this model object
-     * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
-     *                                       that could be a payment or a registration)
-     * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
-     *                                       items which will be stored in an array on this object
-     * @throws EE_Error
-     * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
-     *                  related thing, no array)
-     */
-    public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
-    {
-        // its entirely possible that there IS no related object yet in which case there is nothing to cache.
-        if ( ! $object_to_cache instanceof EE_Base_Class) {
-            return false;
-        }
-        // also get "how" the object is related, or throw an error
-        if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
-            throw new EE_Error(sprintf(__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
-                $relationName, get_class($this)));
-        }
-        // how many things are related ?
-        if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            // if it's a "belongs to" relationship, then there's only one related model object  eg, if this is a registration, there's only 1 attendee for it
-            // so for these model objects just set it to be cached
-            $this->_model_relations[$relationName] = $object_to_cache;
-            $return = true;
-        } else {
-            // otherwise, this is the "many" side of a one to many relationship, so we'll add the object to the array of related objects for that type.
-            // eg: if this is an event, there are many registrations for that event, so we cache the registrations in an array
-            if ( ! is_array($this->_model_relations[$relationName])) {
-                // if for some reason, the cached item is a model object, then stick that in the array, otherwise start with an empty array
-                $this->_model_relations[$relationName] = $this->_model_relations[$relationName] instanceof EE_Base_Class
-                    ? array($this->_model_relations[$relationName]) : array();
-            }
-            // first check for a cache_id which is normally empty
-            if ( ! empty($cache_id)) {
-                // if the cache_id exists, then it means we are purposely trying to cache this with a known key that can then be used to retrieve the object later on
-                $this->_model_relations[$relationName][$cache_id] = $object_to_cache;
-                $return = $cache_id;
-            } elseif ($object_to_cache->ID()) {
-                // OR the cached object originally came from the db, so let's just use it's PK for an ID
-                $this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
-                $return = $object_to_cache->ID();
-            } else {
-                // OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
-                $this->_model_relations[$relationName][] = $object_to_cache;
-                // move the internal pointer to the end of the array
-                end($this->_model_relations[$relationName]);
-                // and grab the key so that we can return it
-                $return = key($this->_model_relations[$relationName]);
-            }
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * For adding an item to the cached_properties property.
-     *
-     * @access protected
-     * @param string      $fieldname the property item the corresponding value is for.
-     * @param mixed       $value     The value we are caching.
-     * @param string|null $cache_type
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _set_cached_property($fieldname, $value, $cache_type = null)
-    {
-        //first make sure this property exists
-        $this->get_model()->field_settings_for($fieldname);
-        $cache_type = empty($cache_type) ? 'standard' : $cache_type;
-        $this->_cached_properties[$fieldname][$cache_type] = $value;
-    }
-
-
-
-    /**
-     * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
-     * This also SETS the cache if we return the actual property!
-     *
-     * @param string $fieldname        the name of the property we're trying to retrieve
-     * @param bool   $pretty
-     * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
-     *                                 (in cases where the same property may be used for different outputs
-     *                                 - i.e. datetime, money etc.)
-     *                                 It can also accept certain pre-defined "schema" strings
-     *                                 to define how to output the property.
-     *                                 see the field's prepare_for_pretty_echoing for what strings can be used
-     * @return mixed                   whatever the value for the property is we're retrieving
-     * @throws \EE_Error
-     */
-    protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        //verify the field exists
-        $this->get_model()->field_settings_for($fieldname);
-        $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
-        if (isset($this->_cached_properties[$fieldname][$cache_type])) {
-            return $this->_cached_properties[$fieldname][$cache_type];
-        }
-        $field_obj = $this->get_model()->field_settings_for($fieldname);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            // If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
-            }
-            if ( ! isset($this->_fields[$fieldname])) {
-                $this->_fields[$fieldname] = null;
-            }
-            $value = $pretty
-                ? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
-                : $field_obj->prepare_for_get($this->_fields[$fieldname]);
-            $this->_set_cached_property($fieldname, $value, $cache_type);
-            return $value;
-        }
-        return null;
-    }
-
-
-
-    /**
-     * set timezone, formats, and output for EE_Datetime_Field objects
-     *
-     * @param \EE_Datetime_Field $datetime_field
-     * @param bool               $pretty
-     * @param null $date_or_time
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _prepare_datetime_field(
-        EE_Datetime_Field $datetime_field,
-        $pretty = false,
-        $date_or_time = null
-    ) {
-        $datetime_field->set_timezone($this->_timezone);
-        $datetime_field->set_date_format($this->_dt_frmt, $pretty);
-        $datetime_field->set_time_format($this->_tm_frmt, $pretty);
-        //set the output returned
-        switch ($date_or_time) {
-            case 'D' :
-                $datetime_field->set_date_time_output('date');
-                break;
-            case 'T' :
-                $datetime_field->set_date_time_output('time');
-                break;
-            default :
-                $datetime_field->set_date_time_output();
-        }
-    }
-
-
-
-    /**
-     * This just takes care of clearing out the cached_properties
-     *
-     * @return void
-     */
-    protected function _clear_cached_properties()
-    {
-        $this->_cached_properties = array();
-    }
-
-
-
-    /**
-     * This just clears out ONE property if it exists in the cache
-     *
-     * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
-     * @return void
-     */
-    protected function _clear_cached_property($property_name)
-    {
-        if (isset($this->_cached_properties[$property_name])) {
-            unset($this->_cached_properties[$property_name]);
-        }
-    }
-
-
-
-    /**
-     * Ensures that this related thing is a model object.
-     *
-     * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
-     * @param string $model_name   name of the related thing, eg 'Attendee',
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
-    {
-        $other_model_instance = self::_get_model_instance_with_name(
-            self::_get_model_classname($model_name),
-            $this->_timezone
-        );
-        return $other_model_instance->ensure_is_obj($object_or_id);
-    }
-
-
-
-    /**
-     * Forgets the cached model of the given relation Name. So the next time we request it,
-     * we will fetch it again from the database. (Handy if you know it's changed somehow).
-     * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
-     * then only remove that one object from our cached array. Otherwise, clear the entire list
-     *
-     * @param string $relationName                         one of the keys in the _model_relations array on the model.
-     *                                                     Eg 'Registration'
-     * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
-     *                                                     if you intend to use $clear_all = TRUE, or the relation only
-     *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
-     * @param bool   $clear_all                            This flags clearing the entire cache relation property if
-     *                                                     this is HasMany or HABTM.
-     * @throws EE_Error
-     * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
-     *                       relation from all
-     */
-    public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
-    {
-        $relationship_to_model = $this->get_model()->related_settings_for($relationName);
-        $index_in_cache = '';
-        if ( ! $relationship_to_model) {
-            throw new EE_Error(
-                sprintf(
-                    __("There is no relationship to %s on a %s. Cannot clear that cache", 'event_espresso'),
-                    $relationName,
-                    get_class($this)
-                )
-            );
-        }
-        if ($clear_all) {
-            $obj_removed = true;
-            $this->_model_relations[$relationName] = null;
-        } elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            $obj_removed = $this->_model_relations[$relationName];
-            $this->_model_relations[$relationName] = null;
-        } else {
-            if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
-                && $object_to_remove_or_index_into_array->ID()
-            ) {
-                $index_in_cache = $object_to_remove_or_index_into_array->ID();
-                if (is_array($this->_model_relations[$relationName])
-                    && ! isset($this->_model_relations[$relationName][$index_in_cache])
-                ) {
-                    $index_found_at = null;
-                    //find this object in the array even though it has a different key
-                    foreach ($this->_model_relations[$relationName] as $index => $obj) {
-                        if (
-                            $obj instanceof EE_Base_Class
-                            && (
-                                $obj == $object_to_remove_or_index_into_array
-                                || $obj->ID() === $object_to_remove_or_index_into_array->ID()
-                            )
-                        ) {
-                            $index_found_at = $index;
-                            break;
-                        }
-                    }
-                    if ($index_found_at) {
-                        $index_in_cache = $index_found_at;
-                    } else {
-                        //it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
-                        //if it wasn't in it to begin with. So we're done
-                        return $object_to_remove_or_index_into_array;
-                    }
-                }
-            } elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
-                //so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
-                foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
-                    if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
-                        $index_in_cache = $index;
-                    }
-                }
-            } else {
-                $index_in_cache = $object_to_remove_or_index_into_array;
-            }
-            //supposedly we've found it. But it could just be that the client code
-            //provided a bad index/object
-            if (
-            isset(
-                $this->_model_relations[$relationName],
-                $this->_model_relations[$relationName][$index_in_cache]
-            )
-            ) {
-                $obj_removed = $this->_model_relations[$relationName][$index_in_cache];
-                unset($this->_model_relations[$relationName][$index_in_cache]);
-            } else {
-                //that thing was never cached anyways.
-                $obj_removed = null;
-            }
-        }
-        return $obj_removed;
-    }
-
-
-
-    /**
-     * update_cache_after_object_save
-     * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
-     * obtained after being saved to the db
-     *
-     * @param string         $relationName       - the type of object that is cached
-     * @param \EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
-     * @param string         $current_cache_id   - the ID that was used when originally caching the object
-     * @return boolean TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function update_cache_after_object_save(
-        $relationName,
-        EE_Base_Class $newly_saved_object,
-        $current_cache_id = ''
-    ) {
-        // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relationName;
-        if ($newly_saved_object instanceof $obj_class) {
-            /* @type EE_Base_Class $newly_saved_object */
-            // now get the type of relation
-            $relationship_to_model = $this->get_model()->related_settings_for($relationName);
-            // if this is a 1:1 relationship
-            if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-                // then just replace the cached object with the newly saved object
-                $this->_model_relations[$relationName] = $newly_saved_object;
-                return true;
-                // or if it's some kind of sordid feral polyamorous relationship...
-            } elseif (is_array($this->_model_relations[$relationName])
-                      && isset($this->_model_relations[$relationName][$current_cache_id])
-            ) {
-                // then remove the current cached item
-                unset($this->_model_relations[$relationName][$current_cache_id]);
-                // and cache the newly saved object using it's new ID
-                $this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relationName
-     * @return EE_Base_Class
-     */
-    public function get_one_from_cache($relationName)
-    {
-        $cached_array_or_object = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName]
-            : null;
-        if (is_array($cached_array_or_object)) {
-            return array_shift($cached_array_or_object);
-        } else {
-            return $cached_array_or_object;
-        }
-    }
-
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relationName
-     * @throws \EE_Error
-     * @return EE_Base_Class[] NOT necessarily indexed by primary keys
-     */
-    public function get_all_from_cache($relationName)
-    {
-        $objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
-        // if the result is not an array, but exists, make it an array
-        $objects = is_array($objects) ? $objects : array($objects);
-        //bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
-        //basically, if this model object was stored in the session, and these cached model objects
-        //already have IDs, let's make sure they're in their model's entity mapper
-        //otherwise we will have duplicates next time we call
-        // EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
-        $model = EE_Registry::instance()->load_model($relationName);
-        foreach ($objects as $model_object) {
-            if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
-                //ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
-                if ($model_object->ID()) {
-                    $model->add_to_entity_map($model_object);
-                }
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
-                            'event_espresso'
-                        ),
-                        $relationName,
-                        gettype($model_object)
-                    )
-                );
-            }
-        }
-        return $objects;
-    }
-
-
-
-    /**
-     * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
-    {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function previous_x(
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = array(),
-        $columns_to_select = null
-    ) {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the next EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
-    {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->next($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Returns the previous EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
-     *                                  you can indicate just the column you want returned
-     * @return array|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
-    {
-        $field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
-            ? $this->get_model()->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $this->get_model()->previous($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @param string $field_name
-     * @param mixed  $field_value_from_db
-     * @throws \EE_Error
-     */
-    public function set_from_db($field_name, $field_value_from_db)
-    {
-        $field_obj = $this->get_model()->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            //you would think the DB has no NULLs for non-null label fields right? wrong!
-            //eg, a CPT model object could have an entry in the posts table, but no
-            //entry in the meta table. Meaning that all its columns in the meta table
-            //are null! yikes! so when we find one like that, use defaults for its meta columns
-            if ($field_value_from_db === null) {
-                if ($field_obj->is_nullable()) {
-                    //if the field allows nulls, then let it be null
-                    $field_value = null;
-                } else {
-                    $field_value = $field_obj->get_default_value();
-                }
-            } else {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
-            }
-            $this->_fields[$field_name] = $field_value;
-            $this->_clear_cached_property($field_name);
-        }
-    }
-
-
-
-    /**
-     * verifies that the specified field is of the correct type
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, false, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * This method simply returns the RAW unprocessed value for the given property in this class
-     *
-     * @param  string $field_name A valid fieldname
-     * @return mixed              Whatever the raw value stored on the property is.
-     * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
-     */
-    public function get_raw($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
-            ? $this->_fields[$field_name]->format('U')
-            : $this->_fields[$field_name];
-    }
-
-
-
-    /**
-     * This is used to return the internal DateTime object used for a field that is a
-     * EE_Datetime_Field.
-     *
-     * @param string $field_name               The field name retrieving the DateTime object.
-     * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
-     * @throws \EE_Error
-     *                                         an error is set and false returned.  If the field IS an
-     *                                         EE_Datetime_Field and but the field value is null, then
-     *                                         just null is returned (because that indicates that likely
-     *                                         this field is nullable).
-     */
-    public function get_DateTime_object($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        if ( ! $field_settings instanceof EE_Datetime_Field) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
-                        'event_espresso'
-                    ),
-                    $field_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $this->_fields[$field_name];
-    }
-
-
-
-    /**
-     * To be used in template to immediately echo out the value, and format it for output.
-     * Eg, should call stripslashes and whatnot before echoing
-     *
-     * @param string $field_name      the name of the field as it appears in the DB
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return void
-     * @throws \EE_Error
-     */
-    public function e($field_name, $extra_cache_ref = null)
-    {
-        echo $this->get_pretty($field_name, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
-     * can be easily used as the value of form input.
-     *
-     * @param string $field_name
-     * @return void
-     * @throws \EE_Error
-     */
-    public function f($field_name)
-    {
-        $this->e($field_name, 'form_input');
-    }
-
-
-
-    /**
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-
-    /**
-     * This simply returns the datetime for the given field name
-     * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
-     * (and the equivalent e_date, e_time, e_datetime).
-     *
-     * @access   protected
-     * @param string   $field_name   Field on the instantiated EE_Base_Class child object
-     * @param string   $dt_frmt      valid datetime format used for date
-     *                               (if '' then we just use the default on the field,
-     *                               if NULL we use the last-used format)
-     * @param string   $tm_frmt      Same as above except this is for time format
-     * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
-     * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
-     * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
-     *                               if field is not a valid dtt field, or void if echoing
-     * @throws \EE_Error
-     */
-    protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
-    {
-        // clear cached property
-        $this->_clear_cached_property($field_name);
-        //reset format properties because they are used in get()
-        $this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
-        $this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
-        if ($echo) {
-            $this->e($field_name, $date_or_time);
-            return '';
-        }
-        return $this->get($field_name, $date_or_time);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
-     * @return string            datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_date($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, $format, null, 'D');
-    }
-
-
-
-    /**
-     * @param      $field_name
-     * @param string $format
-     * @throws \EE_Error
-     */
-    public function e_date($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, $format, null, 'D', true);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_time($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, null, $format, 'T');
-    }
-
-
-
-    /**
-     * @param      $field_name
-     * @param string $format
-     * @throws \EE_Error
-     */
-    public function e_time($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, null, $format, 'T', true);
-    }
-
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
-     * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
-     * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws \EE_Error
-     */
-    public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
-    }
-
-
-
-    /**
-     * @param string $field_name
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @throws \EE_Error
-     */
-    public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
-    {
-        $this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
-    }
-
-
-
-    /**
-     * Get the i8ln value for a date using the WordPress @see date_i18n function.
-     *
-     * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
-     * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
-     *                           on the object will be used.
-     * @return string Date and time string in set locale or false if no field exists for the given
-     * @throws \EE_Error
-     *                           field name.
-     */
-    public function get_i18n_datetime($field_name, $format = '')
-    {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
-        return date_i18n(
-            $format,
-            EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
-        );
-    }
-
-
-
-    /**
-     * This method validates whether the given field name is a valid field on the model object as well as it is of a
-     * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
-     * thrown.
-     *
-     * @param  string $field_name The field name being checked
-     * @throws EE_Error
-     * @return EE_Datetime_Field
-     */
-    protected function _get_dtt_field_settings($field_name)
-    {
-        $field = $this->get_model()->field_settings_for($field_name);
-        //check if field is dtt
-        if ($field instanceof EE_Datetime_Field) {
-            return $field;
-        } else {
-            throw new EE_Error(sprintf(__('The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
-                'event_espresso'), $field_name, self::_get_model_classname(get_class($this))));
-        }
-    }
-
-
-
-
-    /**
-     * NOTE ABOUT BELOW:
-     * These convenience date and time setters are for setting date and time independently.  In other words you might
-     * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
-     * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
-     * method and make sure you send the entire datetime value for setting.
-     */
-    /**
-     * sets the time on a datetime property
-     *
-     * @access protected
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
-     * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
-     * @throws \EE_Error
-     */
-    protected function _set_time_for($time, $fieldname)
-    {
-        $this->_set_date_time('T', $time, $fieldname);
-    }
-
-
-
-    /**
-     * sets the date on a datetime property
-     *
-     * @access protected
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
-     * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
-     * @throws \EE_Error
-     */
-    protected function _set_date_for($date, $fieldname)
-    {
-        $this->_set_date_time('D', $date, $fieldname);
-    }
-
-
-
-    /**
-     * This takes care of setting a date or time independently on a given model object property. This method also
-     * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
-     *
-     * @access protected
-     * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
-     * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
-     * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
-     *                                        EE_Datetime_Field property)
-     * @throws \EE_Error
-     */
-    protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
-    {
-        $field = $this->_get_dtt_field_settings($fieldname);
-        $field->set_timezone($this->_timezone);
-        $field->set_date_format($this->_dt_frmt);
-        $field->set_time_format($this->_tm_frmt);
-        switch ($what) {
-            case 'T' :
-                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
-                    $datetime_value,
-                    $this->_fields[$fieldname]
-                );
-                break;
-            case 'D' :
-                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
-                    $datetime_value,
-                    $this->_fields[$fieldname]
-                );
-                break;
-            case 'B' :
-                $this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
-                break;
-        }
-        $this->_clear_cached_property($fieldname);
-    }
-
-
-
-    /**
-     * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
-     * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
-     * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
-     * that could lead to some unexpected results!
-     *
-     * @access public
-     * @param string               $field_name This is the name of the field on the object that contains the date/time
-     *                                         value being returned.
-     * @param string               $callback   must match a valid method in this class (defaults to get_datetime)
-     * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
-     * @param string               $prepend    You can include something to prepend on the timestamp
-     * @param string               $append     You can include something to append on the timestamp
-     * @throws EE_Error
-     * @return string timestamp
-     */
-    public function display_in_my_timezone(
-        $field_name,
-        $callback = 'get_datetime',
-        $args = null,
-        $prepend = '',
-        $append = ''
-    ) {
-        $timezone = EEH_DTT_Helper::get_timezone();
-        if ($timezone === $this->_timezone) {
-            return '';
-        }
-        $original_timezone = $this->_timezone;
-        $this->set_timezone($timezone);
-        $fn = (array)$field_name;
-        $args = array_merge($fn, (array)$args);
-        if ( ! method_exists($this, $callback)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
-                        'event_espresso'
-                    ),
-                    $callback
-                )
-            );
-        }
-        $args = (array)$args;
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
-        $this->set_timezone($original_timezone);
-        return $return;
-    }
-
-
-
-    /**
-     * Deletes this model object.
-     * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
-     * override
-     * `EE_Base_Class::_delete` NOT this class.
-     *
-     * @return boolean | int
-     * @throws \EE_Error
-     */
-    public function delete()
-    {
-        /**
-         * Called just before the `EE_Base_Class::_delete` method call.
-         * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.  For example, `EE_Soft_Delete_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete__before', $this);
-        $result = $this->_delete();
-        /**
-         * Called just after the `EE_Base_Class::_delete` method call.
-         * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.  For example `EE_Soft_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
-        return $result;
-    }
-
-
-
-    /**
-     * Calls the specific delete method for the instantiated class.
-     * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
-     * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
-     * `EE_Base_Class::delete`
-     *
-     * @return bool|int
-     * @throws \EE_Error
-     */
-    protected function _delete()
-    {
-        return $this->delete_permanently();
-    }
-
-
-
-    /**
-     * Deletes this model object permanently from db (but keep in mind related models my block the delete and return an
-     * error)
-     *
-     * @return bool | int
-     * @throws \EE_Error
-     */
-    public function delete_permanently()
-    {
-        /**
-         * Called just before HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
-        $model = $this->get_model();
-        $result = $model->delete_permanently_by_ID($this->ID());
-        $this->refresh_cache_of_related_objects();
-        /**
-         * Called just after HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
-        return $result;
-    }
-
-
-
-    /**
-     * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
-     * related model objects
-     *
-     * @throws \EE_Error
-     */
-    public function refresh_cache_of_related_objects()
-    {
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ( ! empty($this->_model_relations[$relation_name])) {
-                $related_objects = $this->_model_relations[$relation_name];
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    //this relation only stores a single model object, not an array
-                    //but let's make it consistent
-                    $related_objects = array($related_objects);
-                }
-                foreach ($related_objects as $related_object) {
-                    //only refresh their cache if they're in memory
-                    if ($related_object instanceof EE_Base_Class) {
-                        $related_object->clear_cache($this->get_model()->get_this_model_name(), $this);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *        Saves this object to the database. An array may be supplied to set some values on this
-     * object just before saving.
-     *
-     * @access public
-     * @param array $set_cols_n_values keys are field names, values are their new values,
-     *                                 if provided during the save() method (often client code will change the fields'
-     *                                 values before calling save)
-     * @throws \EE_Error
-     * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
-     *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
-     */
-    public function save($set_cols_n_values = array())
-    {
-        /**
-         * Filters the fields we're about to save on the model object
-         *
-         * @param array         $set_cols_n_values
-         * @param EE_Base_Class $model_object
-         */
-        $set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
-            $this);
-        //set attributes as provided in $set_cols_n_values
-        foreach ($set_cols_n_values as $column => $value) {
-            $this->set($column, $value);
-        }
-        /**
-         * Saving a model object.
-         * Before we perform a save, this action is fired.
-         *
-         * @param EE_Base_Class $model_object the model object about to be saved.
-         */
-        do_action('AHEE__EE_Base_Class__save__begin', $this);
-        if ( ! $this->allow_persist()) {
-            return 0;
-        }
-        //now get current attribute values
-        $save_cols_n_values = $this->_fields;
-        //if the object already has an ID, update it. Otherwise, insert it
-        //also: change the assumption about values passed to the model NOT being prepare dby the model object. They have been
-        $old_assumption_concerning_value_preparation = $this->get_model()
-                                                            ->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->get_model()->assume_values_already_prepared_by_model_object(true);
-        //does this model have an autoincrement PK?
-        if ($this->get_model()->has_primary_key_field()) {
-            if ($this->get_model()->get_primary_key_field()->is_auto_increment()) {
-                //ok check if it's set, if so: update; if not, insert
-                if ( ! empty($save_cols_n_values[self::_get_primary_key_name(get_class($this))])) {
-                    $results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    unset($save_cols_n_values[self::_get_primary_key_name(get_class($this))]);
-                    $results = $this->get_model()->insert($save_cols_n_values);
-                    if ($results) {
-                        //if successful, set the primary key
-                        //but don't use the normal SET method, because it will check if
-                        //an item with the same ID exists in the mapper & db, then
-                        //will find it in the db (because we just added it) and THAT object
-                        //will get added to the mapper before we can add this one!
-                        //but if we just avoid using the SET method, all that headache can be avoided
-                        $pk_field_name = self::_get_primary_key_name(get_class($this));
-                        $this->_fields[$pk_field_name] = $results;
-                        $this->_clear_cached_property($pk_field_name);
-                        $this->get_model()->add_to_entity_map($this);
-                        $this->_update_cached_related_model_objs_fks();
-                    }
-                }
-            } else {//PK is NOT auto-increment
-                //so check if one like it already exists in the db
-                if ($this->get_model()->exists_by_ID($this->ID())) {
-                    if (WP_DEBUG && ! $this->in_entity_map()) {
-                        throw new EE_Error(
-                            sprintf(
-                                __('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
-                                    'event_espresso'),
-                                get_class($this),
-                                get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                                get_class($this->get_model()) . '::instance()->get_one_by_ID()',
-                                '<br />'
-                            )
-                        );
-                    }
-                    $results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    $results = $this->get_model()->insert($save_cols_n_values);
-                    $this->_update_cached_related_model_objs_fks();
-                }
-            }
-        } else {//there is NO primary key
-            $already_in_db = false;
-            foreach ($this->get_model()->unique_indexes() as $index) {
-                $uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
-                if ($this->get_model()->exists(array($uniqueness_where_params))) {
-                    $already_in_db = true;
-                }
-            }
-            if ($already_in_db) {
-                $combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
-                    $this->get_model()->get_combined_primary_key_fields());
-                $results = $this->get_model()->update($save_cols_n_values, $combined_pk_fields_n_values);
-            } else {
-                $results = $this->get_model()->insert($save_cols_n_values);
-            }
-        }
-        //restore the old assumption about values being prepared by the model object
-        $this->get_model()
-             ->assume_values_already_prepared_by_model_object($old_assumption_concerning_value_preparation);
-        /**
-         * After saving the model object this action is called
-         *
-         * @param EE_Base_Class $model_object which was just saved
-         * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
-         *                                    the new ID (or 0 if an error occurred and it wasn't updated)
-         */
-        do_action('AHEE__EE_Base_Class__save__end', $this, $results);
-        return $results;
-    }
-
-
-
-    /**
-     * Updates the foreign key on related models objects pointing to this to have this model object's ID
-     * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
-     * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
-     * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
-     * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
-     * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
-     * or not they exist in the DB (if they do, their DB records will be automatically updated)
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _update_cached_related_model_objs_fks()
-    {
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Has_Many_Relation) {
-                foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
-                    $fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
-                        $this->get_model()->get_this_model_name()
-                    );
-                    $related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
-                    if ($related_model_obj_in_cache->ID()) {
-                        $related_model_obj_in_cache->save();
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Saves this model object and its NEW cached relations to the database.
-     * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
-     * In order for that to work, we would need to mark model objects as dirty/clean...
-     * because otherwise, there's a potential for infinite looping of saving
-     * Saves the cached related model objects, and ensures the relation between them
-     * and this object and properly setup
-     *
-     * @return int ID of new model object on save; 0 on failure+
-     * @throws \EE_Error
-     */
-    public function save_new_cached_related_model_objs()
-    {
-        //make sure this has been saved
-        if ( ! $this->ID()) {
-            $id = $this->save();
-        } else {
-            $id = $this->ID();
-        }
-        //now save all the NEW cached model objects  (ie they don't exist in the DB)
-        foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
-            if ($this->_model_relations[$relationName]) {
-                //is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
-                //or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
-                if ($relationObj instanceof EE_Belongs_To_Relation) {
-                    //add a relation to that relation type (which saves the appropriate thing in the process)
-                    //but ONLY if it DOES NOT exist in the DB
-                    /* @var $related_model_obj EE_Base_Class */
-                    $related_model_obj = $this->_model_relations[$relationName];
-                    //					if( ! $related_model_obj->ID()){
-                    $this->_add_relation_to($related_model_obj, $relationName);
-                    $related_model_obj->save_new_cached_related_model_objs();
-                    //					}
-                } else {
-                    foreach ($this->_model_relations[$relationName] as $related_model_obj) {
-                        //add a relation to that relation type (which saves the appropriate thing in the process)
-                        //but ONLY if it DOES NOT exist in the DB
-                        //						if( ! $related_model_obj->ID()){
-                        $this->_add_relation_to($related_model_obj, $relationName);
-                        $related_model_obj->save_new_cached_related_model_objs();
-                        //						}
-                    }
-                }
-            }
-        }
-        return $id;
-    }
-
-
-
-    /**
-     * for getting a model while instantiated.
-     *
-     * @return \EEM_Base | \EEM_CPT_Base
-     */
-    public function get_model()
-    {
-        $modelName = self::_get_model_classname(get_class($this));
-        return self::_get_model_instance_with_name($modelName, $this->_timezone);
-    }
-
-
-
-    /**
-     * @param $props_n_values
-     * @param $classname
-     * @return mixed bool|EE_Base_Class|EEM_CPT_Base
-     * @throws \EE_Error
-     */
-    protected static function _get_object_from_entity_mapper($props_n_values, $classname)
-    {
-        //TODO: will not work for Term_Relationships because they have no PK!
-        $primary_id_ref = self::_get_primary_key_name($classname);
-        if (array_key_exists($primary_id_ref, $props_n_values) && ! empty($props_n_values[$primary_id_ref])) {
-            $id = $props_n_values[$primary_id_ref];
-            return self::_get_model($classname)->get_from_entity_map($id);
-        }
-        return false;
-    }
-
-
-
-    /**
-     * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
-     * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
-     * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
-     * we return false.
-     *
-     * @param  array  $props_n_values   incoming array of properties and their values
-     * @param  string $classname        the classname of the child class
-     * @param null    $timezone
-     * @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 mixed (EE_Base_Class|bool)
-     * @throws \EE_Error
-     */
-    protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
-    {
-        $existing = null;
-        if (self::_get_model($classname)->has_primary_key_field()) {
-            $primary_id_ref = self::_get_primary_key_name($classname);
-            if (array_key_exists($primary_id_ref, $props_n_values)
-                && ! empty($props_n_values[$primary_id_ref])
-            ) {
-                $existing = self::_get_model($classname, $timezone)->get_one_by_ID(
-                    $props_n_values[$primary_id_ref]
-                );
-            }
-        } elseif (self::_get_model($classname, $timezone)->has_all_combined_primary_key_fields($props_n_values)) {
-            //no primary key on this model, but there's still a matching item in the DB
-            $existing = self::_get_model($classname, $timezone)->get_one_by_ID(
-                self::_get_model($classname, $timezone)->get_index_primary_key_string($props_n_values)
-            );
-        }
-        if ($existing) {
-            //set date formats if present before setting values
-            if ( ! empty($date_formats) && is_array($date_formats)) {
-                $existing->set_date_format($date_formats[0]);
-                $existing->set_time_format($date_formats[1]);
-            } else {
-                //set default formats for date and time
-                $existing->set_date_format(get_option('date_format'));
-                $existing->set_time_format(get_option('time_format'));
-            }
-            foreach ($props_n_values as $property => $field_value) {
-                $existing->set($property, $field_value);
-            }
-            return $existing;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Gets the EEM_*_Model for this class
-     *
-     * @access public now, as this is more convenient
-     * @param      $classname
-     * @param null $timezone
-     * @throws EE_Error
-     * @return EEM_Base
-     */
-    protected static function _get_model($classname, $timezone = null)
-    {
-        //find model for this class
-        if ( ! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "What were you thinking calling _get_model(%s)?? You need to specify the class name",
-                        "event_espresso"
-                    ),
-                    $classname
-                )
-            );
-        }
-        $modelName = self::_get_model_classname($classname);
-        return self::_get_model_instance_with_name($modelName, $timezone);
-    }
-
-
-
-    /**
-     * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
-     *
-     * @param string $model_classname
-     * @param null   $timezone
-     * @return EEM_Base
-     */
-    protected static function _get_model_instance_with_name($model_classname, $timezone = null)
-    {
-        $model_classname = str_replace('EEM_', '', $model_classname);
-        $model = EE_Registry::instance()->load_model($model_classname);
-        $model->set_timezone($timezone);
-        return $model;
-    }
-
-
-
-    /**
-     * If a model name is provided (eg Registration), gets the model classname for that model.
-     * Also works if a model class's classname is provided (eg EE_Registration).
-     *
-     * @param null $model_name
-     * @return string like EEM_Attendee
-     */
-    private static function _get_model_classname($model_name = null)
-    {
-        if (strpos($model_name, "EE_") === 0) {
-            $model_classname = str_replace("EE_", "EEM_", $model_name);
-        } else {
-            $model_classname = "EEM_" . $model_name;
-        }
-        return $model_classname;
-    }
-
-
-
-    /**
-     * returns the name of the primary key attribute
-     *
-     * @param null $classname
-     * @throws EE_Error
-     * @return string
-     */
-    protected static function _get_primary_key_name($classname = null)
-    {
-        if ( ! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    __("What were you thinking calling _get_primary_key_name(%s)", "event_espresso"),
-                    $classname
-                )
-            );
-        }
-        return self::_get_model($classname)->get_primary_key_field()->get_name();
-    }
-
-
-
-    /**
-     * Gets the value of the primary key.
-     * If the object hasn't yet been saved, it should be whatever the model field's default was
-     * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
-     * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
-     *
-     * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
-     * @throws \EE_Error
-     */
-    public function ID()
-    {
-        //now that we know the name of the variable, use a variable variable to get its value and return its
-        if ($this->get_model()->has_primary_key_field()) {
-            return $this->_fields[self::_get_primary_key_name(get_class($this))];
-        } else {
-            return $this->get_model()->get_index_primary_key_string($this->_fields);
-        }
-    }
-
-
-
-    /**
-     * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
-     * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
-     *
-     * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
-     * @param string $relationName                     eg 'Events','Question',etc.
-     *                                                 an attendee to a group, you also want to specify which role they
-     *                                                 will have in that group. So you would use this parameter to
-     *                                                 specify array('role-column-name'=>'role-id')
-     * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
-     *                                                 allow you to further constrict the relation to being added.
-     *                                                 However, keep in mind that the columns (keys) given must match a
-     *                                                 column on the JOIN table and currently only the HABTM models
-     *                                                 accept these additional conditions.  Also remember that if an
-     *                                                 exact match isn't found for these extra cols/val pairs, then a
-     *                                                 NEW row is created in the join table.
-     * @param null   $cache_id
-     * @throws EE_Error
-     * @return EE_Base_Class the object the relation was added to
-     */
-    public function _add_relation_to(
-        $otherObjectModelObjectOrID,
-        $relationName,
-        $extra_join_model_fields_n_values = array(),
-        $cache_id = null
-    ) {
-        //if this thing exists in the DB, save the relation to the DB
-        if ($this->ID()) {
-            $otherObject = $this->get_model()
-                                ->add_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
-                                    $extra_join_model_fields_n_values);
-            //clear cache so future get_many_related and get_first_related() return new results.
-            $this->clear_cache($relationName, $otherObject, true);
-            if ($otherObject instanceof EE_Base_Class) {
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-            }
-        } else {
-            //this thing doesn't exist in the DB,  so just cache it
-            if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
-                throw new EE_Error(sprintf(
-                    __('Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
-                        'event_espresso'),
-                    $otherObjectModelObjectOrID,
-                    get_class($this)
-                ));
-            } else {
-                $otherObject = $otherObjectModelObjectOrID;
-            }
-            $this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            //fix the reciprocal relation too
-            if ($otherObject->ID()) {
-                //its saved so assumed relations exist in the DB, so we can just
-                //clear the cache so future queries use the updated info in the DB
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), null, true);
-            } else {
-                //it's not saved, so it caches relations like this
-                $otherObject->cache($this->get_model()->get_this_model_name(), $this);
-            }
-        }
-        return $otherObject;
-    }
-
-
-
-    /**
-     * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
-     * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
-     * from the cache
-     *
-     * @param mixed  $otherObjectModelObjectOrID
-     *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
-     *                to the DB yet
-     * @param string $relationName
-     * @param array  $where_query
-     *                You can optionally include an array of key=>value pairs that allow you to further constrict the
-     *                relation to being added. However, keep in mind that the columns (keys) given must match a column
-     *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
-     *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
-     *                created in the join table.
-     * @return EE_Base_Class the relation was removed from
-     * @throws \EE_Error
-     */
-    public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
-    {
-        if ($this->ID()) {
-            //if this exists in the DB, save the relation change to the DB too
-            $otherObject = $this->get_model()
-                                ->remove_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
-                                    $where_query);
-            $this->clear_cache($relationName, $otherObject);
-        } else {
-            //this doesn't exist in the DB, just remove it from the cache
-            $otherObject = $this->clear_cache($relationName, $otherObjectModelObjectOrID);
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-        }
-        return $otherObject;
-    }
-
-
-
-    /**
-     * Removes ALL the related things for the $relationName.
-     *
-     * @param string $relationName
-     * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function _remove_relations($relationName, $where_query_params = array())
-    {
-        if ($this->ID()) {
-            //if this exists in the DB, save the relation change to the DB too
-            $otherObjects = $this->get_model()->remove_relations($this, $relationName, $where_query_params);
-            $this->clear_cache($relationName, null, true);
-        } else {
-            //this doesn't exist in the DB, just remove it from the cache
-            $otherObjects = $this->clear_cache($relationName, null, true);
-        }
-        if (is_array($otherObjects)) {
-            foreach ($otherObjects as $otherObject) {
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
-            }
-        }
-        return $otherObjects;
-    }
-
-
-
-    /**
-     * Gets all the related model objects of the specified type. Eg, if the current class if
-     * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
-     * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
-     * because we want to get even deleted items etc.
-     *
-     * @param string $relationName key in the model's _model_relations array
-     * @param array  $query_params like EEM_Base::get_all
-     * @return EE_Base_Class[] Results not necessarily indexed by IDs, because some results might not have primary keys
-     * @throws \EE_Error
-     *                             or might not be saved yet. Consider using EEM_Base::get_IDs() on these results if
-     *                             you want IDs
-     */
-    public function get_many_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            //this exists in the DB, so get the related things from either the cache or the DB
-            //if there are query parameters, forget about caching the related model objects.
-            if ($query_params) {
-                $related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
-            } else {
-                //did we already cache the result of this query?
-                $cached_results = $this->get_all_from_cache($relationName);
-                if ( ! $cached_results) {
-                    $related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
-                    //if no query parameters were passed, then we got all the related model objects
-                    //for that relation. We can cache them then.
-                    foreach ($related_model_objects as $related_model_object) {
-                        $this->cache($relationName, $related_model_object);
-                    }
-                } else {
-                    $related_model_objects = $cached_results;
-                }
-            }
-        } else {
-            //this doesn't exist in the DB, so just get the related things from the cache
-            $related_model_objects = $this->get_all_from_cache($relationName);
-        }
-        return $related_model_objects;
-    }
-
-
-
-    /**
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
-     * unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name  model_name like 'Event', or 'Registration'
-     * @param array  $query_params   like EEM_Base::get_all's
-     * @param string $field_to_count name of field to count by. By default, uses primary key
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
-     *                               that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
-    {
-        return $this->get_model()->count_related($this, $relation_name, $query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name model_name like 'Event', or 'Registration'
-     * @param array  $query_params  like EEM_Base::get_all's
-     * @param string $field_to_sum  name of field to count by.
-     *                              By default, uses primary key (which doesn't make much sense, so you should probably
-     *                              change it)
-     * @return int
-     */
-    public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
-    {
-        return $this->get_model()->sum_related($this, $relation_name, $query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Gets the first (ie, one) related model object of the specified type.
-     *
-     * @param string $relationName key in the model's _model_relations array
-     * @param array  $query_params like EEM_Base::get_all
-     * @return EE_Base_Class (not an array, a single object)
-     * @throws \EE_Error
-     */
-    public function get_first_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
-            //if they've provided some query parameters, don't bother trying to cache the result
-            //also make sure we're not caching the result of get_first_related
-            //on a relation which should have an array of objects (because the cache might have an array of objects)
-            if ($query_params
-                || ! $this->get_model()->related_settings_for($relationName)
-                     instanceof
-                     EE_Belongs_To_Relation
-            ) {
-                $related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
-            } else {
-                //first, check if we've already cached the result of this query
-                $cached_result = $this->get_one_from_cache($relationName);
-                if ( ! $cached_result) {
-                    $related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
-                    $this->cache($relationName, $related_model_object);
-                } else {
-                    $related_model_object = $cached_result;
-                }
-            }
-        } else {
-            $related_model_object = null;
-            //this doesn't exist in the Db, but maybe the relation is of type belongs to, and so the related thing might
-            if ($this->get_model()->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
-                $related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
-            }
-            //this doesn't exist in the DB and apparently the thing it belongs to doesn't either, just get what's cached on this object
-            if ( ! $related_model_object) {
-                $related_model_object = $this->get_one_from_cache($relationName);
-            }
-        }
-        return $related_model_object;
-    }
-
-
-
-    /**
-     * Does a delete on all related objects of type $relationName and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) does nothing. If the related model objects are
-     * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
-     * If this model object doesn't exist yet in the DB, just removes its related things
-     *
-     * @param string $relationName
-     * @param array  $query_params like EEM_Base::get_all's
-     * @return int how many deleted
-     * @throws \EE_Error
-     */
-    public function delete_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related($this, $relationName, $query_params);
-        } else {
-            $count = count($this->get_all_from_cache($relationName));
-            $this->clear_cache($relationName, null, true);
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) just does a soft delete on it instead, if possible.
-     * If the related thing isn't a soft-deletable model object, this function is identical
-     * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
-     *
-     * @param string $relationName
-     * @param array  $query_params like EEM_Base::get_all's
-     * @return int how many deleted (including those soft deleted)
-     * @throws \EE_Error
-     */
-    public function delete_related_permanently($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related_permanently($this, $relationName, $query_params);
-        } else {
-            $count = count($this->get_all_from_cache($relationName));
-        }
-        $this->clear_cache($relationName, null, true);
-        return $count;
-    }
-
-
-
-    /**
-     * is_set
-     * Just a simple utility function children can use for checking if property exists
-     *
-     * @access  public
-     * @param  string $field_name property to check
-     * @return bool                              TRUE if existing,FALSE if not.
-     */
-    public function is_set($field_name)
-    {
-        return isset($this->_fields[$field_name]);
-    }
-
-
-
-    /**
-     * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
-     * EE_Error exception if they don't
-     *
-     * @param  mixed (string|array) $properties properties to check
-     * @throws EE_Error
-     * @return bool                              TRUE if existing, throw EE_Error if not.
-     */
-    protected function _property_exists($properties)
-    {
-        foreach ((array)$properties as $property_name) {
-            //first make sure this property exists
-            if ( ! $this->_fields[$property_name]) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
-                            'event_espresso'
-                        ),
-                        $property_name
-                    )
-                );
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * This simply returns an array of model fields for this object
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function model_field_array()
-    {
-        $fields = $this->get_model()->field_settings(false);
-        $properties = array();
-        //remove prepended underscore
-        foreach ($fields as $field_name => $settings) {
-            $properties[$field_name] = $this->get($field_name);
-        }
-        return $properties;
-    }
-
-
-
-    /**
-     * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
-     * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
-     * requiring a plugin to extend the EE_Base_Class (which works fine is there's only 1 plugin, but when will that
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
-     * my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
-     *        return $previousReturnValue.$returnString;
-     * }
-     * require('EE_Answer.class.php');
-     * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
-     * echo $answer->my_callback('monkeys',100);
-     * //will output "you called my_callback! and passed args:monkeys,100"
-     *
-     * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
-     * @param array  $args       array of original arguments passed to the function
-     * @throws EE_Error
-     * @return mixed whatever the plugin which calls add_filter decides
-     */
-    public function __call($methodName, $args)
-    {
-        $className = get_class($this);
-        $tagName = "FHEE__{$className}__{$methodName}";
-        if ( ! has_filter($tagName)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
-                        "event_espresso"
-                    ),
-                    $methodName,
-                    $className,
-                    $tagName
-                )
-            );
-        }
-        return apply_filters($tagName, null, $this, $args);
-    }
-
-
-
-    /**
-     * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
-     * A $previous_value can be specified in case there are many meta rows with the same key
-     *
-     * @param string $meta_key
-     * @param string $meta_value
-     * @param string $previous_value
-     * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
-     * @throws \EE_Error
-     * NOTE: if the values haven't changed, returns 0
-     */
-    public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
-    {
-        $query_params = array(
-            array(
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ),
-        );
-        if ($previous_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        $existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
-        if ( ! $existing_rows_like_that) {
-            return $this->add_extra_meta($meta_key, $meta_value);
-        } else {
-            foreach ($existing_rows_like_that as $existing_row) {
-                $existing_row->save(array('EXM_value' => $meta_value));
-            }
-            return count($existing_rows_like_that);
-        }
-    }
-
-
-
-    /**
-     * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
-     * no other extra meta for this model object have the same key. Returns TRUE if the
-     * extra meta row was entered, false if not
-     *
-     * @param string  $meta_key
-     * @param string  $meta_value
-     * @param boolean $unique
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function add_extra_meta($meta_key, $meta_value, $unique = false)
-    {
-        if ($unique) {
-            $existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
-                array(
-                    array(
-                        'EXM_key'  => $meta_key,
-                        'OBJ_ID'   => $this->ID(),
-                        'EXM_type' => $this->get_model()->get_this_model_name(),
-                    ),
-                )
-            );
-            if ($existing_extra_meta) {
-                return false;
-            }
-        }
-        $new_extra_meta = EE_Extra_Meta::new_instance(
-            array(
-                'EXM_key'   => $meta_key,
-                'EXM_value' => $meta_value,
-                'OBJ_ID'    => $this->ID(),
-                'EXM_type'  => $this->get_model()->get_this_model_name(),
-            )
-        );
-        $new_extra_meta->save();
-        return true;
-    }
-
-
-
-    /**
-     * Deletes all the extra meta rows for this record as specified by key. If $meta_value
-     * is specified, only deletes extra meta records with that value.
-     *
-     * @param string $meta_key
-     * @param string $meta_value
-     * @return int number of extra meta rows deleted
-     * @throws \EE_Error
-     */
-    public function delete_extra_meta($meta_key, $meta_value = null)
-    {
-        $query_params = array(
-            array(
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ),
-        );
-        if ($meta_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        return EEM_Extra_Meta::instance()->delete($query_params);
-    }
-
-
-
-    /**
-     * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
-     * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
-     * You can specify $default is case you haven't found the extra meta
-     *
-     * @param string  $meta_key
-     * @param boolean $single
-     * @param mixed   $default if we don't find anything, what should we return?
-     * @return mixed single value if $single; array if ! $single
-     * @throws \EE_Error
-     */
-    public function get_extra_meta($meta_key, $single = false, $default = null)
-    {
-        if ($single) {
-            $result = $this->get_first_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
-            if ($result instanceof EE_Extra_Meta) {
-                return $result->value();
-            } else {
-                return $default;
-            }
-        } else {
-            $results = $this->get_many_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
-            if ($results) {
-                $values = array();
-                foreach ($results as $result) {
-                    if ($result instanceof EE_Extra_Meta) {
-                        $values[$result->ID()] = $result->value();
-                    }
-                }
-                return $values;
-            } else {
-                return $default;
-            }
-        }
-    }
-
-
-
-    /**
-     * Returns a simple array of all the extra meta associated with this model object.
-     * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
-     * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
-     * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
-     * If $one_of_each_key is false, it will return an array with the top-level keys being
-     * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
-     * finally the extra meta's value as each sub-value. (eg
-     * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
-     *
-     * @param boolean $one_of_each_key
-     * @return array
-     * @throws \EE_Error
-     */
-    public function all_extra_meta_array($one_of_each_key = true)
-    {
-        $return_array = array();
-        if ($one_of_each_key) {
-            $extra_meta_objs = $this->get_many_related('Extra_Meta', array('group_by' => 'EXM_key'));
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    $return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
-                }
-            }
-        } else {
-            $extra_meta_objs = $this->get_many_related('Extra_Meta');
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    if ( ! isset($return_array[$extra_meta_obj->key()])) {
-                        $return_array[$extra_meta_obj->key()] = array();
-                    }
-                    $return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
-                }
-            }
-        }
-        return $return_array;
-    }
-
-
-
-    /**
-     * Gets a pretty nice displayable nice for this model object. Often overridden
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function name()
-    {
-        //find a field that's not a text field
-        $field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
-        if ($field_we_can_use) {
-            return $this->get($field_we_can_use->get_name());
-        } else {
-            $first_few_properties = $this->model_field_array();
-            $first_few_properties = array_slice($first_few_properties, 0, 3);
-            $name_parts = array();
-            foreach ($first_few_properties as $name => $value) {
-                $name_parts[] = "$name:$value";
-            }
-            return implode(",", $name_parts);
-        }
-    }
-
-
-
-    /**
-     * in_entity_map
-     * Checks if this model object has been proven to already be in the entity map
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function in_entity_map()
-    {
-        if ($this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this) {
-            //well, if we looked, did we find it in the entity map?
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * refresh_from_db
-     * Makes sure the fields and values on this model object are in-sync with what's in the database.
-     *
-     * @throws EE_Error if this model object isn't in the entity mapper (because then you should
-     * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
-     */
-    public function refresh_from_db()
-    {
-        if ($this->ID() && $this->in_entity_map()) {
-            $this->get_model()->refresh_entity_map_from_db($this->ID());
-        } else {
-            //if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
-            //if it has an ID but it's not in the map, and you're asking me to refresh it
-            //that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
-            //absolutely nothing in it for this ID
-            if (WP_DEBUG) {
-                throw new EE_Error(
-                    sprintf(
-                        __('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
-                            'event_espresso'),
-                        $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
-                    )
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
-     * (probably a bad assumption they have made, oh well)
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        try {
-            return sprintf('%s (%s)', $this->name(), $this->ID());
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-    }
-
-
-
-    /**
-     * Clear related model objects if they're already in the DB, because otherwise when we
-     * UN-serialize this model object we'll need to be careful to add them to the entity map.
-     * This means if we have made changes to those related model objects, and want to unserialize
-     * the this model object on a subsequent request, changes to those related model objects will be lost.
-     * Instead, those related model objects should be directly serialized and stored.
-     * Eg, the following won't work:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $reg = get_option( 'my_option' );
-     * $reg->attendee()->save();
-     * And would need to be replace with:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $att = get_option( 'my_option' );
-     * $att->save();
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function __sleep()
-    {
-        foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $this->get_model()->get_this_model_name();
-                if (
-                    $this->get_one_from_cache($relation_name) instanceof $classname
-                    && $this->get_one_from_cache($relation_name)->ID()
-                ) {
-                    $this->clear_cache($relation_name, $this->get_one_from_cache($relation_name)->ID());
-                }
-            }
-        }
-        $this->_props_n_values_provided_in_constructor = array();
-        return array_keys(get_object_vars($this));
-    }
-
-
-
-    /**
-     * restore _props_n_values_provided_in_constructor
-     * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
-     * and therefore should NOT be used to determine if state change has occurred since initial construction.
-     * At best, you would only be able to detect if state change has occurred during THIS request.
-     */
-    public function __wakeup()
-    {
-        $this->_props_n_values_provided_in_constructor = $this->_fields;
-    }
+	/**
+	 * This is an array of the original properties and values provided during construction
+	 * of this model object. (keys are model field names, values are their values).
+	 * This list is important to remember so that when we are merging data from the db, we know
+	 * which values to override and which to not override.
+	 *
+	 * @var array
+	 */
+	protected $_props_n_values_provided_in_constructor;
+
+	/**
+	 * Timezone
+	 * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
+	 * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
+	 * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
+	 * access to it.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+
+
+	/**
+	 * date format
+	 * pattern or format for displaying dates
+	 *
+	 * @var string $_dt_frmt
+	 */
+	protected $_dt_frmt;
+
+
+
+	/**
+	 * time format
+	 * pattern or format for displaying time
+	 *
+	 * @var string $_tm_frmt
+	 */
+	protected $_tm_frmt;
+
+
+
+	/**
+	 * This property is for holding a cached array of object properties indexed by property name as the key.
+	 * The purpose of this is for setting a cache on properties that may have calculated values after a
+	 * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
+	 * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
+	 *
+	 * @var array
+	 */
+	protected $_cached_properties = array();
+
+	/**
+	 * An array containing keys of the related model, and values are either an array of related mode objects or a
+	 * single
+	 * related model object. see the model's _model_relations. The keys should match those specified. And if the
+	 * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
+	 * all others have an array)
+	 *
+	 * @var array
+	 */
+	protected $_model_relations = array();
+
+	/**
+	 * Array where keys are field names (see the model's _fields property) and values are their values. To see what
+	 * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
+	 *
+	 * @var array
+	 */
+	protected $_fields = array();
+
+	/**
+	 * @var boolean indicating whether or not this model object is intended to ever be saved
+	 * For example, we might create model objects intended to only be used for the duration
+	 * of this request and to be thrown away, and if they were accidentally saved
+	 * it would be a bug.
+	 */
+	protected $_allow_persist = true;
+
+
+
+	/**
+	 * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
+	 * play nice
+	 *
+	 * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
+	 *                                                         layer of the model's _fields array, (eg, EVT_ID,
+	 *                                                         TXN_amount, QST_name, etc) and values are their values
+	 * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
+	 *                                                         corresponding db model or not.
+	 * @param string  $timezone                                indicate what timezone you want any datetime fields to
+	 *                                                         be in when instantiating a EE_Base_Class object.
+	 * @param array   $date_formats                            An array of date formats to set on construct where first
+	 *                                                         value is the date_format and second value is the time
+	 *                                                         format.
+	 * @throws EE_Error
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
+	{
+		$className = get_class($this);
+		do_action("AHEE__{$className}__construct", $this, $fieldValues);
+		$model = $this->get_model();
+		$model_fields = $model->field_settings(false);
+		// ensure $fieldValues is an array
+		$fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
+		// EEH_Debug_Tools::printr( $fieldValues, '$fieldValues  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		// verify client code has not passed any invalid field names
+		foreach ($fieldValues as $field_name => $field_value) {
+			if ( ! isset($model_fields[$field_name])) {
+				throw new EE_Error(sprintf(__("Invalid field (%s) passed to constructor of %s. Allowed fields are :%s",
+					"event_espresso"), $field_name, get_class($this), implode(", ", array_keys($model_fields))));
+			}
+		}
+		// EEH_Debug_Tools::printr( $model_fields, '$model_fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		if ( ! empty($date_formats) && is_array($date_formats)) {
+			list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
+		} else {
+			//set default formats for date and time
+			$this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
+			$this->_tm_frmt = (string)get_option('time_format', 'g:i a');
+		}
+		//if db model is instantiating
+		if ($bydb) {
+			//client code has indicated these field values are from the database
+			foreach ($model_fields as $fieldName => $field) {
+				$this->set_from_db($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null);
+			}
+		} else {
+			//we're constructing a brand
+			//new instance of the model object. Generally, this means we'll need to do more field validation
+			foreach ($model_fields as $fieldName => $field) {
+				$this->set($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true);
+			}
+		}
+		//remember what values were passed to this constructor
+		$this->_props_n_values_provided_in_constructor = $fieldValues;
+		//remember in entity mapper
+		if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
+			$model->add_to_entity_map($this);
+		}
+		//setup all the relations
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$this->_model_relations[$relation_name] = null;
+			} else {
+				$this->_model_relations[$relation_name] = array();
+			}
+		}
+		/**
+		 * Action done at the end of each model object construction
+		 *
+		 * @param EE_Base_Class $this the model object just created
+		 */
+		do_action('AHEE__EE_Base_Class__construct__finished', $this);
+	}
+
+
+
+	/**
+	 * Gets whether or not this model object is allowed to persist/be saved to the database.
+	 *
+	 * @return boolean
+	 */
+	public function allow_persist()
+	{
+		return $this->_allow_persist;
+	}
+
+
+
+	/**
+	 * Sets whether or not this model object should be allowed to be saved to the DB.
+	 * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
+	 * you got new information that somehow made you change your mind.
+	 *
+	 * @param boolean $allow_persist
+	 * @return boolean
+	 */
+	public function set_allow_persist($allow_persist)
+	{
+		return $this->_allow_persist = $allow_persist;
+	}
+
+
+
+	/**
+	 * Gets the field's original value when this object was constructed during this request.
+	 * This can be helpful when determining if a model object has changed or not
+	 *
+	 * @param string $field_name
+	 * @return mixed|null
+	 * @throws \EE_Error
+	 */
+	public function get_original($field_name)
+	{
+		if (isset($this->_props_n_values_provided_in_constructor[$field_name])
+			&& $field_settings = $this->get_model()->field_settings_for($field_name)
+		) {
+			return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * @param EE_Base_Class $obj
+	 * @return string
+	 */
+	public function get_class($obj)
+	{
+		return get_class($obj);
+	}
+
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @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)
+	{
+		$field_obj = $this->get_model()->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			//			if ( method_exists( $field_obj, 'set_timezone' )) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				$field_obj->set_date_format($this->_dt_frmt);
+				$field_obj->set_time_format($this->_tm_frmt);
+			}
+			$holder_of_value = $field_obj->prepare_for_set($field_value);
+			//should the value be null?
+			if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
+				$this->_fields[$field_name] = $field_obj->get_default_value();
+				/**
+				 * To save having to refactor all the models, if a default value is used for a
+				 * EE_Datetime_Field, and that value is not null nor is it a DateTime
+				 * object.  Then let's do a set again to ensure that it becomes a DateTime
+				 * object.
+				 *
+				 * @since 4.6.10+
+				 */
+				if (
+					$field_obj instanceof EE_Datetime_Field
+					&& $this->_fields[$field_name] !== null
+					&& ! $this->_fields[$field_name] instanceof DateTime
+				) {
+					empty($this->_fields[$field_name])
+						? $this->set($field_name, time())
+						: $this->set($field_name, $this->_fields[$field_name]);
+				}
+			} else {
+				$this->_fields[$field_name] = $holder_of_value;
+			}
+			//if we're not in the constructor...
+			//now check if what we set was a primary key
+			if (
+				//note: props_n_values_provided_in_constructor is only set at the END of the constructor
+				$this->_props_n_values_provided_in_constructor
+				&& $field_value
+				&& $field_name === self::_get_primary_key_name(get_class($this))
+			) {
+				//if so, we want all this object's fields to be filled either with
+				//what we've explicitly set on this model
+				//or what we have in the db
+				// echo "setting primary key!";
+				$fields_on_model = self::_get_model(get_class($this))->field_settings();
+				$obj_in_db = self::_get_model(get_class($this))->get_one_by_ID($field_value);
+				foreach ($fields_on_model as $field_obj) {
+					if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
+						 && $field_obj->get_name() !== $field_name
+					) {
+						$this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
+					}
+				}
+				//oh this model object has an ID? well make sure its in the entity mapper
+				$this->get_model()->add_to_entity_map($this);
+			}
+			//let's unset any cache for this field_name from the $_cached_properties property.
+			$this->_clear_cached_property($field_name);
+		} else {
+			throw new EE_Error(sprintf(__("A valid EE_Model_Field_Base could not be found for the given field name: %s",
+				"event_espresso"), $field_name));
+		}
+	}
+
+
+
+	/**
+	 * This sets the field value on the db column if it exists for the given $column_name or
+	 * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
+	 *
+	 * @see EE_message::get_column_value for related documentation on the necessity of this method.
+	 * @param string $field_name  Must be the exact column name.
+	 * @param mixed  $field_value The value to set.
+	 * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
+	 * @throws \EE_Error
+	 */
+	public function set_field_or_extra_meta($field_name, $field_value)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$this->set($field_name, $field_value);
+			return true;
+		} else {
+			//ensure this object is saved first so that extra meta can be properly related.
+			$this->save();
+			return $this->update_extra_meta($field_name, $field_value);
+		}
+	}
+
+
+
+	/**
+	 * This retrieves the value of the db column set on this class or if that's not present
+	 * it will attempt to retrieve from extra_meta if found.
+	 * Example Usage:
+	 * Via EE_Message child class:
+	 * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
+	 * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
+	 * also have additional main fields specific to the messenger.  The system accommodates those extra
+	 * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
+	 * value for those extra fields dynamically via the EE_message object.
+	 *
+	 * @param  string $field_name expecting the fully qualified field name.
+	 * @return mixed|null  value for the field if found.  null if not found.
+	 * @throws \EE_Error
+	 */
+	public function get_field_or_extra_meta($field_name)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$column_value = $this->get($field_name);
+		} else {
+			//This isn't a column in the main table, let's see if it is in the extra meta.
+			$column_value = $this->get_extra_meta($field_name, true, null);
+		}
+		return $column_value;
+	}
+
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
+	 * available to all child classes that may be using the EE_Datetime_Field for a field data type.
+	 *
+	 * @access public
+	 * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_timezone($timezone = '')
+	{
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		//make sure we clear all cached properties because they won't be relevant now
+		$this->_clear_cached_properties();
+		//make sure we update field settings and the date for all EE_Datetime_Fields
+		$model_fields = $this->get_model()->field_settings(false);
+		foreach ($model_fields as $field_name => $field_obj) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
+					$this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone()
+	{
+		return $this->_timezone;
+	}
+
+
+
+	/**
+	 * This sets the internal date format to what is sent in to be used as the new default for the class
+	 * internally instead of wp set date format options
+	 *
+	 * @since 4.6
+	 * @param string $format should be a format recognizable by PHP date() functions.
+	 */
+	public function set_date_format($format)
+	{
+		$this->_dt_frmt = $format;
+		//clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+
+	/**
+	 * This sets the internal time format string to what is sent in to be used as the new default for the
+	 * class internally instead of wp set time format options.
+	 *
+	 * @since 4.6
+	 * @param string $format should be a format recognizable by PHP date() functions.
+	 */
+	public function set_time_format($format)
+	{
+		$this->_tm_frmt = $format;
+		//clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+
+	/**
+	 * This returns the current internal set format for the date and time formats.
+	 *
+	 * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
+	 *                             where the first value is the date format and the second value is the time format.
+	 * @return mixed string|array
+	 */
+	public function get_format($full = true)
+	{
+		return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
+	}
+
+
+
+	/**
+	 * cache
+	 * stores the passed model object on the current model object.
+	 * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
+	 *
+	 * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
+	 *                                       'Registration' associated with this model object
+	 * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
+	 *                                       that could be a payment or a registration)
+	 * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
+	 *                                       items which will be stored in an array on this object
+	 * @throws EE_Error
+	 * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
+	 *                  related thing, no array)
+	 */
+	public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
+	{
+		// its entirely possible that there IS no related object yet in which case there is nothing to cache.
+		if ( ! $object_to_cache instanceof EE_Base_Class) {
+			return false;
+		}
+		// also get "how" the object is related, or throw an error
+		if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
+			throw new EE_Error(sprintf(__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
+				$relationName, get_class($this)));
+		}
+		// how many things are related ?
+		if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			// if it's a "belongs to" relationship, then there's only one related model object  eg, if this is a registration, there's only 1 attendee for it
+			// so for these model objects just set it to be cached
+			$this->_model_relations[$relationName] = $object_to_cache;
+			$return = true;
+		} else {
+			// otherwise, this is the "many" side of a one to many relationship, so we'll add the object to the array of related objects for that type.
+			// eg: if this is an event, there are many registrations for that event, so we cache the registrations in an array
+			if ( ! is_array($this->_model_relations[$relationName])) {
+				// if for some reason, the cached item is a model object, then stick that in the array, otherwise start with an empty array
+				$this->_model_relations[$relationName] = $this->_model_relations[$relationName] instanceof EE_Base_Class
+					? array($this->_model_relations[$relationName]) : array();
+			}
+			// first check for a cache_id which is normally empty
+			if ( ! empty($cache_id)) {
+				// if the cache_id exists, then it means we are purposely trying to cache this with a known key that can then be used to retrieve the object later on
+				$this->_model_relations[$relationName][$cache_id] = $object_to_cache;
+				$return = $cache_id;
+			} elseif ($object_to_cache->ID()) {
+				// OR the cached object originally came from the db, so let's just use it's PK for an ID
+				$this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
+				$return = $object_to_cache->ID();
+			} else {
+				// OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
+				$this->_model_relations[$relationName][] = $object_to_cache;
+				// move the internal pointer to the end of the array
+				end($this->_model_relations[$relationName]);
+				// and grab the key so that we can return it
+				$return = key($this->_model_relations[$relationName]);
+			}
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * For adding an item to the cached_properties property.
+	 *
+	 * @access protected
+	 * @param string      $fieldname the property item the corresponding value is for.
+	 * @param mixed       $value     The value we are caching.
+	 * @param string|null $cache_type
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _set_cached_property($fieldname, $value, $cache_type = null)
+	{
+		//first make sure this property exists
+		$this->get_model()->field_settings_for($fieldname);
+		$cache_type = empty($cache_type) ? 'standard' : $cache_type;
+		$this->_cached_properties[$fieldname][$cache_type] = $value;
+	}
+
+
+
+	/**
+	 * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
+	 * This also SETS the cache if we return the actual property!
+	 *
+	 * @param string $fieldname        the name of the property we're trying to retrieve
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
+	 *                                 (in cases where the same property may be used for different outputs
+	 *                                 - i.e. datetime, money etc.)
+	 *                                 It can also accept certain pre-defined "schema" strings
+	 *                                 to define how to output the property.
+	 *                                 see the field's prepare_for_pretty_echoing for what strings can be used
+	 * @return mixed                   whatever the value for the property is we're retrieving
+	 * @throws \EE_Error
+	 */
+	protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		//verify the field exists
+		$this->get_model()->field_settings_for($fieldname);
+		$cache_type = $pretty ? 'pretty' : 'standard';
+		$cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
+		if (isset($this->_cached_properties[$fieldname][$cache_type])) {
+			return $this->_cached_properties[$fieldname][$cache_type];
+		}
+		$field_obj = $this->get_model()->field_settings_for($fieldname);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			// If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
+			}
+			if ( ! isset($this->_fields[$fieldname])) {
+				$this->_fields[$fieldname] = null;
+			}
+			$value = $pretty
+				? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
+				: $field_obj->prepare_for_get($this->_fields[$fieldname]);
+			$this->_set_cached_property($fieldname, $value, $cache_type);
+			return $value;
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * set timezone, formats, and output for EE_Datetime_Field objects
+	 *
+	 * @param \EE_Datetime_Field $datetime_field
+	 * @param bool               $pretty
+	 * @param null $date_or_time
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _prepare_datetime_field(
+		EE_Datetime_Field $datetime_field,
+		$pretty = false,
+		$date_or_time = null
+	) {
+		$datetime_field->set_timezone($this->_timezone);
+		$datetime_field->set_date_format($this->_dt_frmt, $pretty);
+		$datetime_field->set_time_format($this->_tm_frmt, $pretty);
+		//set the output returned
+		switch ($date_or_time) {
+			case 'D' :
+				$datetime_field->set_date_time_output('date');
+				break;
+			case 'T' :
+				$datetime_field->set_date_time_output('time');
+				break;
+			default :
+				$datetime_field->set_date_time_output();
+		}
+	}
+
+
+
+	/**
+	 * This just takes care of clearing out the cached_properties
+	 *
+	 * @return void
+	 */
+	protected function _clear_cached_properties()
+	{
+		$this->_cached_properties = array();
+	}
+
+
+
+	/**
+	 * This just clears out ONE property if it exists in the cache
+	 *
+	 * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
+	 * @return void
+	 */
+	protected function _clear_cached_property($property_name)
+	{
+		if (isset($this->_cached_properties[$property_name])) {
+			unset($this->_cached_properties[$property_name]);
+		}
+	}
+
+
+
+	/**
+	 * Ensures that this related thing is a model object.
+	 *
+	 * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
+	 * @param string $model_name   name of the related thing, eg 'Attendee',
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
+	{
+		$other_model_instance = self::_get_model_instance_with_name(
+			self::_get_model_classname($model_name),
+			$this->_timezone
+		);
+		return $other_model_instance->ensure_is_obj($object_or_id);
+	}
+
+
+
+	/**
+	 * Forgets the cached model of the given relation Name. So the next time we request it,
+	 * we will fetch it again from the database. (Handy if you know it's changed somehow).
+	 * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
+	 * then only remove that one object from our cached array. Otherwise, clear the entire list
+	 *
+	 * @param string $relationName                         one of the keys in the _model_relations array on the model.
+	 *                                                     Eg 'Registration'
+	 * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
+	 *                                                     if you intend to use $clear_all = TRUE, or the relation only
+	 *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
+	 * @param bool   $clear_all                            This flags clearing the entire cache relation property if
+	 *                                                     this is HasMany or HABTM.
+	 * @throws EE_Error
+	 * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
+	 *                       relation from all
+	 */
+	public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
+	{
+		$relationship_to_model = $this->get_model()->related_settings_for($relationName);
+		$index_in_cache = '';
+		if ( ! $relationship_to_model) {
+			throw new EE_Error(
+				sprintf(
+					__("There is no relationship to %s on a %s. Cannot clear that cache", 'event_espresso'),
+					$relationName,
+					get_class($this)
+				)
+			);
+		}
+		if ($clear_all) {
+			$obj_removed = true;
+			$this->_model_relations[$relationName] = null;
+		} elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			$obj_removed = $this->_model_relations[$relationName];
+			$this->_model_relations[$relationName] = null;
+		} else {
+			if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
+				&& $object_to_remove_or_index_into_array->ID()
+			) {
+				$index_in_cache = $object_to_remove_or_index_into_array->ID();
+				if (is_array($this->_model_relations[$relationName])
+					&& ! isset($this->_model_relations[$relationName][$index_in_cache])
+				) {
+					$index_found_at = null;
+					//find this object in the array even though it has a different key
+					foreach ($this->_model_relations[$relationName] as $index => $obj) {
+						if (
+							$obj instanceof EE_Base_Class
+							&& (
+								$obj == $object_to_remove_or_index_into_array
+								|| $obj->ID() === $object_to_remove_or_index_into_array->ID()
+							)
+						) {
+							$index_found_at = $index;
+							break;
+						}
+					}
+					if ($index_found_at) {
+						$index_in_cache = $index_found_at;
+					} else {
+						//it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
+						//if it wasn't in it to begin with. So we're done
+						return $object_to_remove_or_index_into_array;
+					}
+				}
+			} elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
+				//so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
+				foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
+					if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
+						$index_in_cache = $index;
+					}
+				}
+			} else {
+				$index_in_cache = $object_to_remove_or_index_into_array;
+			}
+			//supposedly we've found it. But it could just be that the client code
+			//provided a bad index/object
+			if (
+			isset(
+				$this->_model_relations[$relationName],
+				$this->_model_relations[$relationName][$index_in_cache]
+			)
+			) {
+				$obj_removed = $this->_model_relations[$relationName][$index_in_cache];
+				unset($this->_model_relations[$relationName][$index_in_cache]);
+			} else {
+				//that thing was never cached anyways.
+				$obj_removed = null;
+			}
+		}
+		return $obj_removed;
+	}
+
+
+
+	/**
+	 * update_cache_after_object_save
+	 * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
+	 * obtained after being saved to the db
+	 *
+	 * @param string         $relationName       - the type of object that is cached
+	 * @param \EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
+	 * @param string         $current_cache_id   - the ID that was used when originally caching the object
+	 * @return boolean TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function update_cache_after_object_save(
+		$relationName,
+		EE_Base_Class $newly_saved_object,
+		$current_cache_id = ''
+	) {
+		// verify that incoming object is of the correct type
+		$obj_class = 'EE_' . $relationName;
+		if ($newly_saved_object instanceof $obj_class) {
+			/* @type EE_Base_Class $newly_saved_object */
+			// now get the type of relation
+			$relationship_to_model = $this->get_model()->related_settings_for($relationName);
+			// if this is a 1:1 relationship
+			if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+				// then just replace the cached object with the newly saved object
+				$this->_model_relations[$relationName] = $newly_saved_object;
+				return true;
+				// or if it's some kind of sordid feral polyamorous relationship...
+			} elseif (is_array($this->_model_relations[$relationName])
+					  && isset($this->_model_relations[$relationName][$current_cache_id])
+			) {
+				// then remove the current cached item
+				unset($this->_model_relations[$relationName][$current_cache_id]);
+				// and cache the newly saved object using it's new ID
+				$this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relationName
+	 * @return EE_Base_Class
+	 */
+	public function get_one_from_cache($relationName)
+	{
+		$cached_array_or_object = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName]
+			: null;
+		if (is_array($cached_array_or_object)) {
+			return array_shift($cached_array_or_object);
+		} else {
+			return $cached_array_or_object;
+		}
+	}
+
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relationName
+	 * @throws \EE_Error
+	 * @return EE_Base_Class[] NOT necessarily indexed by primary keys
+	 */
+	public function get_all_from_cache($relationName)
+	{
+		$objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
+		// if the result is not an array, but exists, make it an array
+		$objects = is_array($objects) ? $objects : array($objects);
+		//bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
+		//basically, if this model object was stored in the session, and these cached model objects
+		//already have IDs, let's make sure they're in their model's entity mapper
+		//otherwise we will have duplicates next time we call
+		// EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
+		$model = EE_Registry::instance()->load_model($relationName);
+		foreach ($objects as $model_object) {
+			if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
+				//ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
+				if ($model_object->ID()) {
+					$model->add_to_entity_map($model_object);
+				}
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
+							'event_espresso'
+						),
+						$relationName,
+						gettype($model_object)
+					)
+				);
+			}
+		}
+		return $objects;
+	}
+
+
+
+	/**
+	 * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
+	{
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function previous_x(
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = array(),
+		$columns_to_select = null
+	) {
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the next EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
+	{
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->next($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Returns the previous EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
+	 *                                  you can indicate just the column you want returned
+	 * @return array|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
+	{
+		$field = empty($field_to_order_by) && $this->get_model()->has_primary_key_field()
+			? $this->get_model()->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $this->get_model()->previous($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value_from_db
+	 * @throws \EE_Error
+	 */
+	public function set_from_db($field_name, $field_value_from_db)
+	{
+		$field_obj = $this->get_model()->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			//you would think the DB has no NULLs for non-null label fields right? wrong!
+			//eg, a CPT model object could have an entry in the posts table, but no
+			//entry in the meta table. Meaning that all its columns in the meta table
+			//are null! yikes! so when we find one like that, use defaults for its meta columns
+			if ($field_value_from_db === null) {
+				if ($field_obj->is_nullable()) {
+					//if the field allows nulls, then let it be null
+					$field_value = null;
+				} else {
+					$field_value = $field_obj->get_default_value();
+				}
+			} else {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
+			}
+			$this->_fields[$field_name] = $field_value;
+			$this->_clear_cached_property($field_name);
+		}
+	}
+
+
+
+	/**
+	 * verifies that the specified field is of the correct type
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, false, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * This method simply returns the RAW unprocessed value for the given property in this class
+	 *
+	 * @param  string $field_name A valid fieldname
+	 * @return mixed              Whatever the raw value stored on the property is.
+	 * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
+	 */
+	public function get_raw($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
+			? $this->_fields[$field_name]->format('U')
+			: $this->_fields[$field_name];
+	}
+
+
+
+	/**
+	 * This is used to return the internal DateTime object used for a field that is a
+	 * EE_Datetime_Field.
+	 *
+	 * @param string $field_name               The field name retrieving the DateTime object.
+	 * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
+	 * @throws \EE_Error
+	 *                                         an error is set and false returned.  If the field IS an
+	 *                                         EE_Datetime_Field and but the field value is null, then
+	 *                                         just null is returned (because that indicates that likely
+	 *                                         this field is nullable).
+	 */
+	public function get_DateTime_object($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		if ( ! $field_settings instanceof EE_Datetime_Field) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
+						'event_espresso'
+					),
+					$field_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $this->_fields[$field_name];
+	}
+
+
+
+	/**
+	 * To be used in template to immediately echo out the value, and format it for output.
+	 * Eg, should call stripslashes and whatnot before echoing
+	 *
+	 * @param string $field_name      the name of the field as it appears in the DB
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function e($field_name, $extra_cache_ref = null)
+	{
+		echo $this->get_pretty($field_name, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
+	 * can be easily used as the value of form input.
+	 *
+	 * @param string $field_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function f($field_name)
+	{
+		$this->e($field_name, 'form_input');
+	}
+
+
+
+	/**
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+
+	/**
+	 * This simply returns the datetime for the given field name
+	 * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
+	 * (and the equivalent e_date, e_time, e_datetime).
+	 *
+	 * @access   protected
+	 * @param string   $field_name   Field on the instantiated EE_Base_Class child object
+	 * @param string   $dt_frmt      valid datetime format used for date
+	 *                               (if '' then we just use the default on the field,
+	 *                               if NULL we use the last-used format)
+	 * @param string   $tm_frmt      Same as above except this is for time format
+	 * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
+	 * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
+	 * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
+	 *                               if field is not a valid dtt field, or void if echoing
+	 * @throws \EE_Error
+	 */
+	protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
+	{
+		// clear cached property
+		$this->_clear_cached_property($field_name);
+		//reset format properties because they are used in get()
+		$this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
+		$this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
+		if ($echo) {
+			$this->e($field_name, $date_or_time);
+			return '';
+		}
+		return $this->get($field_name, $date_or_time);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
+	 * @return string            datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_date($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, $format, null, 'D');
+	}
+
+
+
+	/**
+	 * @param      $field_name
+	 * @param string $format
+	 * @throws \EE_Error
+	 */
+	public function e_date($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, $format, null, 'D', true);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_time($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, null, $format, 'T');
+	}
+
+
+
+	/**
+	 * @param      $field_name
+	 * @param string $format
+	 * @throws \EE_Error
+	 */
+	public function e_time($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, null, $format, 'T', true);
+	}
+
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
+	 * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
+	 * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws \EE_Error
+	 */
+	public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
+	}
+
+
+
+	/**
+	 * @param string $field_name
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @throws \EE_Error
+	 */
+	public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
+	{
+		$this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
+	}
+
+
+
+	/**
+	 * Get the i8ln value for a date using the WordPress @see date_i18n function.
+	 *
+	 * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
+	 * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
+	 *                           on the object will be used.
+	 * @return string Date and time string in set locale or false if no field exists for the given
+	 * @throws \EE_Error
+	 *                           field name.
+	 */
+	public function get_i18n_datetime($field_name, $format = '')
+	{
+		$format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+		return date_i18n(
+			$format,
+			EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
+		);
+	}
+
+
+
+	/**
+	 * This method validates whether the given field name is a valid field on the model object as well as it is of a
+	 * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
+	 * thrown.
+	 *
+	 * @param  string $field_name The field name being checked
+	 * @throws EE_Error
+	 * @return EE_Datetime_Field
+	 */
+	protected function _get_dtt_field_settings($field_name)
+	{
+		$field = $this->get_model()->field_settings_for($field_name);
+		//check if field is dtt
+		if ($field instanceof EE_Datetime_Field) {
+			return $field;
+		} else {
+			throw new EE_Error(sprintf(__('The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
+				'event_espresso'), $field_name, self::_get_model_classname(get_class($this))));
+		}
+	}
+
+
+
+
+	/**
+	 * NOTE ABOUT BELOW:
+	 * These convenience date and time setters are for setting date and time independently.  In other words you might
+	 * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
+	 * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
+	 * method and make sure you send the entire datetime value for setting.
+	 */
+	/**
+	 * sets the time on a datetime property
+	 *
+	 * @access protected
+	 * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
+	 * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
+	 * @throws \EE_Error
+	 */
+	protected function _set_time_for($time, $fieldname)
+	{
+		$this->_set_date_time('T', $time, $fieldname);
+	}
+
+
+
+	/**
+	 * sets the date on a datetime property
+	 *
+	 * @access protected
+	 * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
+	 * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
+	 * @throws \EE_Error
+	 */
+	protected function _set_date_for($date, $fieldname)
+	{
+		$this->_set_date_time('D', $date, $fieldname);
+	}
+
+
+
+	/**
+	 * This takes care of setting a date or time independently on a given model object property. This method also
+	 * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
+	 *
+	 * @access protected
+	 * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
+	 * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
+	 * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
+	 *                                        EE_Datetime_Field property)
+	 * @throws \EE_Error
+	 */
+	protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
+	{
+		$field = $this->_get_dtt_field_settings($fieldname);
+		$field->set_timezone($this->_timezone);
+		$field->set_date_format($this->_dt_frmt);
+		$field->set_time_format($this->_tm_frmt);
+		switch ($what) {
+			case 'T' :
+				$this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
+					$datetime_value,
+					$this->_fields[$fieldname]
+				);
+				break;
+			case 'D' :
+				$this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
+					$datetime_value,
+					$this->_fields[$fieldname]
+				);
+				break;
+			case 'B' :
+				$this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
+				break;
+		}
+		$this->_clear_cached_property($fieldname);
+	}
+
+
+
+	/**
+	 * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
+	 * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
+	 * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
+	 * that could lead to some unexpected results!
+	 *
+	 * @access public
+	 * @param string               $field_name This is the name of the field on the object that contains the date/time
+	 *                                         value being returned.
+	 * @param string               $callback   must match a valid method in this class (defaults to get_datetime)
+	 * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
+	 * @param string               $prepend    You can include something to prepend on the timestamp
+	 * @param string               $append     You can include something to append on the timestamp
+	 * @throws EE_Error
+	 * @return string timestamp
+	 */
+	public function display_in_my_timezone(
+		$field_name,
+		$callback = 'get_datetime',
+		$args = null,
+		$prepend = '',
+		$append = ''
+	) {
+		$timezone = EEH_DTT_Helper::get_timezone();
+		if ($timezone === $this->_timezone) {
+			return '';
+		}
+		$original_timezone = $this->_timezone;
+		$this->set_timezone($timezone);
+		$fn = (array)$field_name;
+		$args = array_merge($fn, (array)$args);
+		if ( ! method_exists($this, $callback)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
+						'event_espresso'
+					),
+					$callback
+				)
+			);
+		}
+		$args = (array)$args;
+		$return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
+		$this->set_timezone($original_timezone);
+		return $return;
+	}
+
+
+
+	/**
+	 * Deletes this model object.
+	 * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
+	 * override
+	 * `EE_Base_Class::_delete` NOT this class.
+	 *
+	 * @return boolean | int
+	 * @throws \EE_Error
+	 */
+	public function delete()
+	{
+		/**
+		 * Called just before the `EE_Base_Class::_delete` method call.
+		 * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.  For example, `EE_Soft_Delete_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete__before', $this);
+		$result = $this->_delete();
+		/**
+		 * Called just after the `EE_Base_Class::_delete` method call.
+		 * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.  For example `EE_Soft_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
+		return $result;
+	}
+
+
+
+	/**
+	 * Calls the specific delete method for the instantiated class.
+	 * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
+	 * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
+	 * `EE_Base_Class::delete`
+	 *
+	 * @return bool|int
+	 * @throws \EE_Error
+	 */
+	protected function _delete()
+	{
+		return $this->delete_permanently();
+	}
+
+
+
+	/**
+	 * Deletes this model object permanently from db (but keep in mind related models my block the delete and return an
+	 * error)
+	 *
+	 * @return bool | int
+	 * @throws \EE_Error
+	 */
+	public function delete_permanently()
+	{
+		/**
+		 * Called just before HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
+		$model = $this->get_model();
+		$result = $model->delete_permanently_by_ID($this->ID());
+		$this->refresh_cache_of_related_objects();
+		/**
+		 * Called just after HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
+		return $result;
+	}
+
+
+
+	/**
+	 * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
+	 * related model objects
+	 *
+	 * @throws \EE_Error
+	 */
+	public function refresh_cache_of_related_objects()
+	{
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ( ! empty($this->_model_relations[$relation_name])) {
+				$related_objects = $this->_model_relations[$relation_name];
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					//this relation only stores a single model object, not an array
+					//but let's make it consistent
+					$related_objects = array($related_objects);
+				}
+				foreach ($related_objects as $related_object) {
+					//only refresh their cache if they're in memory
+					if ($related_object instanceof EE_Base_Class) {
+						$related_object->clear_cache($this->get_model()->get_this_model_name(), $this);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *        Saves this object to the database. An array may be supplied to set some values on this
+	 * object just before saving.
+	 *
+	 * @access public
+	 * @param array $set_cols_n_values keys are field names, values are their new values,
+	 *                                 if provided during the save() method (often client code will change the fields'
+	 *                                 values before calling save)
+	 * @throws \EE_Error
+	 * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
+	 *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
+	 */
+	public function save($set_cols_n_values = array())
+	{
+		/**
+		 * Filters the fields we're about to save on the model object
+		 *
+		 * @param array         $set_cols_n_values
+		 * @param EE_Base_Class $model_object
+		 */
+		$set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
+			$this);
+		//set attributes as provided in $set_cols_n_values
+		foreach ($set_cols_n_values as $column => $value) {
+			$this->set($column, $value);
+		}
+		/**
+		 * Saving a model object.
+		 * Before we perform a save, this action is fired.
+		 *
+		 * @param EE_Base_Class $model_object the model object about to be saved.
+		 */
+		do_action('AHEE__EE_Base_Class__save__begin', $this);
+		if ( ! $this->allow_persist()) {
+			return 0;
+		}
+		//now get current attribute values
+		$save_cols_n_values = $this->_fields;
+		//if the object already has an ID, update it. Otherwise, insert it
+		//also: change the assumption about values passed to the model NOT being prepare dby the model object. They have been
+		$old_assumption_concerning_value_preparation = $this->get_model()
+															->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->get_model()->assume_values_already_prepared_by_model_object(true);
+		//does this model have an autoincrement PK?
+		if ($this->get_model()->has_primary_key_field()) {
+			if ($this->get_model()->get_primary_key_field()->is_auto_increment()) {
+				//ok check if it's set, if so: update; if not, insert
+				if ( ! empty($save_cols_n_values[self::_get_primary_key_name(get_class($this))])) {
+					$results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					unset($save_cols_n_values[self::_get_primary_key_name(get_class($this))]);
+					$results = $this->get_model()->insert($save_cols_n_values);
+					if ($results) {
+						//if successful, set the primary key
+						//but don't use the normal SET method, because it will check if
+						//an item with the same ID exists in the mapper & db, then
+						//will find it in the db (because we just added it) and THAT object
+						//will get added to the mapper before we can add this one!
+						//but if we just avoid using the SET method, all that headache can be avoided
+						$pk_field_name = self::_get_primary_key_name(get_class($this));
+						$this->_fields[$pk_field_name] = $results;
+						$this->_clear_cached_property($pk_field_name);
+						$this->get_model()->add_to_entity_map($this);
+						$this->_update_cached_related_model_objs_fks();
+					}
+				}
+			} else {//PK is NOT auto-increment
+				//so check if one like it already exists in the db
+				if ($this->get_model()->exists_by_ID($this->ID())) {
+					if (WP_DEBUG && ! $this->in_entity_map()) {
+						throw new EE_Error(
+							sprintf(
+								__('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
+									'event_espresso'),
+								get_class($this),
+								get_class($this->get_model()) . '::instance()->add_to_entity_map()',
+								get_class($this->get_model()) . '::instance()->get_one_by_ID()',
+								'<br />'
+							)
+						);
+					}
+					$results = $this->get_model()->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					$results = $this->get_model()->insert($save_cols_n_values);
+					$this->_update_cached_related_model_objs_fks();
+				}
+			}
+		} else {//there is NO primary key
+			$already_in_db = false;
+			foreach ($this->get_model()->unique_indexes() as $index) {
+				$uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
+				if ($this->get_model()->exists(array($uniqueness_where_params))) {
+					$already_in_db = true;
+				}
+			}
+			if ($already_in_db) {
+				$combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
+					$this->get_model()->get_combined_primary_key_fields());
+				$results = $this->get_model()->update($save_cols_n_values, $combined_pk_fields_n_values);
+			} else {
+				$results = $this->get_model()->insert($save_cols_n_values);
+			}
+		}
+		//restore the old assumption about values being prepared by the model object
+		$this->get_model()
+			 ->assume_values_already_prepared_by_model_object($old_assumption_concerning_value_preparation);
+		/**
+		 * After saving the model object this action is called
+		 *
+		 * @param EE_Base_Class $model_object which was just saved
+		 * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
+		 *                                    the new ID (or 0 if an error occurred and it wasn't updated)
+		 */
+		do_action('AHEE__EE_Base_Class__save__end', $this, $results);
+		return $results;
+	}
+
+
+
+	/**
+	 * Updates the foreign key on related models objects pointing to this to have this model object's ID
+	 * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
+	 * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
+	 * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
+	 * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
+	 * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
+	 * or not they exist in the DB (if they do, their DB records will be automatically updated)
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _update_cached_related_model_objs_fks()
+	{
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Has_Many_Relation) {
+				foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
+					$fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
+						$this->get_model()->get_this_model_name()
+					);
+					$related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
+					if ($related_model_obj_in_cache->ID()) {
+						$related_model_obj_in_cache->save();
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Saves this model object and its NEW cached relations to the database.
+	 * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
+	 * In order for that to work, we would need to mark model objects as dirty/clean...
+	 * because otherwise, there's a potential for infinite looping of saving
+	 * Saves the cached related model objects, and ensures the relation between them
+	 * and this object and properly setup
+	 *
+	 * @return int ID of new model object on save; 0 on failure+
+	 * @throws \EE_Error
+	 */
+	public function save_new_cached_related_model_objs()
+	{
+		//make sure this has been saved
+		if ( ! $this->ID()) {
+			$id = $this->save();
+		} else {
+			$id = $this->ID();
+		}
+		//now save all the NEW cached model objects  (ie they don't exist in the DB)
+		foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
+			if ($this->_model_relations[$relationName]) {
+				//is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
+				//or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
+				if ($relationObj instanceof EE_Belongs_To_Relation) {
+					//add a relation to that relation type (which saves the appropriate thing in the process)
+					//but ONLY if it DOES NOT exist in the DB
+					/* @var $related_model_obj EE_Base_Class */
+					$related_model_obj = $this->_model_relations[$relationName];
+					//					if( ! $related_model_obj->ID()){
+					$this->_add_relation_to($related_model_obj, $relationName);
+					$related_model_obj->save_new_cached_related_model_objs();
+					//					}
+				} else {
+					foreach ($this->_model_relations[$relationName] as $related_model_obj) {
+						//add a relation to that relation type (which saves the appropriate thing in the process)
+						//but ONLY if it DOES NOT exist in the DB
+						//						if( ! $related_model_obj->ID()){
+						$this->_add_relation_to($related_model_obj, $relationName);
+						$related_model_obj->save_new_cached_related_model_objs();
+						//						}
+					}
+				}
+			}
+		}
+		return $id;
+	}
+
+
+
+	/**
+	 * for getting a model while instantiated.
+	 *
+	 * @return \EEM_Base | \EEM_CPT_Base
+	 */
+	public function get_model()
+	{
+		$modelName = self::_get_model_classname(get_class($this));
+		return self::_get_model_instance_with_name($modelName, $this->_timezone);
+	}
+
+
+
+	/**
+	 * @param $props_n_values
+	 * @param $classname
+	 * @return mixed bool|EE_Base_Class|EEM_CPT_Base
+	 * @throws \EE_Error
+	 */
+	protected static function _get_object_from_entity_mapper($props_n_values, $classname)
+	{
+		//TODO: will not work for Term_Relationships because they have no PK!
+		$primary_id_ref = self::_get_primary_key_name($classname);
+		if (array_key_exists($primary_id_ref, $props_n_values) && ! empty($props_n_values[$primary_id_ref])) {
+			$id = $props_n_values[$primary_id_ref];
+			return self::_get_model($classname)->get_from_entity_map($id);
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
+	 * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
+	 * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
+	 * we return false.
+	 *
+	 * @param  array  $props_n_values   incoming array of properties and their values
+	 * @param  string $classname        the classname of the child class
+	 * @param null    $timezone
+	 * @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 mixed (EE_Base_Class|bool)
+	 * @throws \EE_Error
+	 */
+	protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
+	{
+		$existing = null;
+		if (self::_get_model($classname)->has_primary_key_field()) {
+			$primary_id_ref = self::_get_primary_key_name($classname);
+			if (array_key_exists($primary_id_ref, $props_n_values)
+				&& ! empty($props_n_values[$primary_id_ref])
+			) {
+				$existing = self::_get_model($classname, $timezone)->get_one_by_ID(
+					$props_n_values[$primary_id_ref]
+				);
+			}
+		} elseif (self::_get_model($classname, $timezone)->has_all_combined_primary_key_fields($props_n_values)) {
+			//no primary key on this model, but there's still a matching item in the DB
+			$existing = self::_get_model($classname, $timezone)->get_one_by_ID(
+				self::_get_model($classname, $timezone)->get_index_primary_key_string($props_n_values)
+			);
+		}
+		if ($existing) {
+			//set date formats if present before setting values
+			if ( ! empty($date_formats) && is_array($date_formats)) {
+				$existing->set_date_format($date_formats[0]);
+				$existing->set_time_format($date_formats[1]);
+			} else {
+				//set default formats for date and time
+				$existing->set_date_format(get_option('date_format'));
+				$existing->set_time_format(get_option('time_format'));
+			}
+			foreach ($props_n_values as $property => $field_value) {
+				$existing->set($property, $field_value);
+			}
+			return $existing;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Gets the EEM_*_Model for this class
+	 *
+	 * @access public now, as this is more convenient
+	 * @param      $classname
+	 * @param null $timezone
+	 * @throws EE_Error
+	 * @return EEM_Base
+	 */
+	protected static function _get_model($classname, $timezone = null)
+	{
+		//find model for this class
+		if ( ! $classname) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"What were you thinking calling _get_model(%s)?? You need to specify the class name",
+						"event_espresso"
+					),
+					$classname
+				)
+			);
+		}
+		$modelName = self::_get_model_classname($classname);
+		return self::_get_model_instance_with_name($modelName, $timezone);
+	}
+
+
+
+	/**
+	 * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
+	 *
+	 * @param string $model_classname
+	 * @param null   $timezone
+	 * @return EEM_Base
+	 */
+	protected static function _get_model_instance_with_name($model_classname, $timezone = null)
+	{
+		$model_classname = str_replace('EEM_', '', $model_classname);
+		$model = EE_Registry::instance()->load_model($model_classname);
+		$model->set_timezone($timezone);
+		return $model;
+	}
+
+
+
+	/**
+	 * If a model name is provided (eg Registration), gets the model classname for that model.
+	 * Also works if a model class's classname is provided (eg EE_Registration).
+	 *
+	 * @param null $model_name
+	 * @return string like EEM_Attendee
+	 */
+	private static function _get_model_classname($model_name = null)
+	{
+		if (strpos($model_name, "EE_") === 0) {
+			$model_classname = str_replace("EE_", "EEM_", $model_name);
+		} else {
+			$model_classname = "EEM_" . $model_name;
+		}
+		return $model_classname;
+	}
+
+
+
+	/**
+	 * returns the name of the primary key attribute
+	 *
+	 * @param null $classname
+	 * @throws EE_Error
+	 * @return string
+	 */
+	protected static function _get_primary_key_name($classname = null)
+	{
+		if ( ! $classname) {
+			throw new EE_Error(
+				sprintf(
+					__("What were you thinking calling _get_primary_key_name(%s)", "event_espresso"),
+					$classname
+				)
+			);
+		}
+		return self::_get_model($classname)->get_primary_key_field()->get_name();
+	}
+
+
+
+	/**
+	 * Gets the value of the primary key.
+	 * If the object hasn't yet been saved, it should be whatever the model field's default was
+	 * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
+	 * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
+	 *
+	 * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
+	 * @throws \EE_Error
+	 */
+	public function ID()
+	{
+		//now that we know the name of the variable, use a variable variable to get its value and return its
+		if ($this->get_model()->has_primary_key_field()) {
+			return $this->_fields[self::_get_primary_key_name(get_class($this))];
+		} else {
+			return $this->get_model()->get_index_primary_key_string($this->_fields);
+		}
+	}
+
+
+
+	/**
+	 * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
+	 * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
+	 * @param string $relationName                     eg 'Events','Question',etc.
+	 *                                                 an attendee to a group, you also want to specify which role they
+	 *                                                 will have in that group. So you would use this parameter to
+	 *                                                 specify array('role-column-name'=>'role-id')
+	 * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
+	 *                                                 allow you to further constrict the relation to being added.
+	 *                                                 However, keep in mind that the columns (keys) given must match a
+	 *                                                 column on the JOIN table and currently only the HABTM models
+	 *                                                 accept these additional conditions.  Also remember that if an
+	 *                                                 exact match isn't found for these extra cols/val pairs, then a
+	 *                                                 NEW row is created in the join table.
+	 * @param null   $cache_id
+	 * @throws EE_Error
+	 * @return EE_Base_Class the object the relation was added to
+	 */
+	public function _add_relation_to(
+		$otherObjectModelObjectOrID,
+		$relationName,
+		$extra_join_model_fields_n_values = array(),
+		$cache_id = null
+	) {
+		//if this thing exists in the DB, save the relation to the DB
+		if ($this->ID()) {
+			$otherObject = $this->get_model()
+								->add_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
+									$extra_join_model_fields_n_values);
+			//clear cache so future get_many_related and get_first_related() return new results.
+			$this->clear_cache($relationName, $otherObject, true);
+			if ($otherObject instanceof EE_Base_Class) {
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+			}
+		} else {
+			//this thing doesn't exist in the DB,  so just cache it
+			if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
+				throw new EE_Error(sprintf(
+					__('Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
+						'event_espresso'),
+					$otherObjectModelObjectOrID,
+					get_class($this)
+				));
+			} else {
+				$otherObject = $otherObjectModelObjectOrID;
+			}
+			$this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			//fix the reciprocal relation too
+			if ($otherObject->ID()) {
+				//its saved so assumed relations exist in the DB, so we can just
+				//clear the cache so future queries use the updated info in the DB
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), null, true);
+			} else {
+				//it's not saved, so it caches relations like this
+				$otherObject->cache($this->get_model()->get_this_model_name(), $this);
+			}
+		}
+		return $otherObject;
+	}
+
+
+
+	/**
+	 * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
+	 * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
+	 * from the cache
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID
+	 *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
+	 *                to the DB yet
+	 * @param string $relationName
+	 * @param array  $where_query
+	 *                You can optionally include an array of key=>value pairs that allow you to further constrict the
+	 *                relation to being added. However, keep in mind that the columns (keys) given must match a column
+	 *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
+	 *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
+	 *                created in the join table.
+	 * @return EE_Base_Class the relation was removed from
+	 * @throws \EE_Error
+	 */
+	public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
+	{
+		if ($this->ID()) {
+			//if this exists in the DB, save the relation change to the DB too
+			$otherObject = $this->get_model()
+								->remove_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
+									$where_query);
+			$this->clear_cache($relationName, $otherObject);
+		} else {
+			//this doesn't exist in the DB, just remove it from the cache
+			$otherObject = $this->clear_cache($relationName, $otherObjectModelObjectOrID);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+		}
+		return $otherObject;
+	}
+
+
+
+	/**
+	 * Removes ALL the related things for the $relationName.
+	 *
+	 * @param string $relationName
+	 * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function _remove_relations($relationName, $where_query_params = array())
+	{
+		if ($this->ID()) {
+			//if this exists in the DB, save the relation change to the DB too
+			$otherObjects = $this->get_model()->remove_relations($this, $relationName, $where_query_params);
+			$this->clear_cache($relationName, null, true);
+		} else {
+			//this doesn't exist in the DB, just remove it from the cache
+			$otherObjects = $this->clear_cache($relationName, null, true);
+		}
+		if (is_array($otherObjects)) {
+			foreach ($otherObjects as $otherObject) {
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
+			}
+		}
+		return $otherObjects;
+	}
+
+
+
+	/**
+	 * Gets all the related model objects of the specified type. Eg, if the current class if
+	 * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
+	 * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
+	 * because we want to get even deleted items etc.
+	 *
+	 * @param string $relationName key in the model's _model_relations array
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class[] Results not necessarily indexed by IDs, because some results might not have primary keys
+	 * @throws \EE_Error
+	 *                             or might not be saved yet. Consider using EEM_Base::get_IDs() on these results if
+	 *                             you want IDs
+	 */
+	public function get_many_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			//this exists in the DB, so get the related things from either the cache or the DB
+			//if there are query parameters, forget about caching the related model objects.
+			if ($query_params) {
+				$related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
+			} else {
+				//did we already cache the result of this query?
+				$cached_results = $this->get_all_from_cache($relationName);
+				if ( ! $cached_results) {
+					$related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
+					//if no query parameters were passed, then we got all the related model objects
+					//for that relation. We can cache them then.
+					foreach ($related_model_objects as $related_model_object) {
+						$this->cache($relationName, $related_model_object);
+					}
+				} else {
+					$related_model_objects = $cached_results;
+				}
+			}
+		} else {
+			//this doesn't exist in the DB, so just get the related things from the cache
+			$related_model_objects = $this->get_all_from_cache($relationName);
+		}
+		return $related_model_objects;
+	}
+
+
+
+	/**
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
+	 * unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name  model_name like 'Event', or 'Registration'
+	 * @param array  $query_params   like EEM_Base::get_all's
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
+	 *                               that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
+	{
+		return $this->get_model()->count_related($this, $relation_name, $query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name model_name like 'Event', or 'Registration'
+	 * @param array  $query_params  like EEM_Base::get_all's
+	 * @param string $field_to_sum  name of field to count by.
+	 *                              By default, uses primary key (which doesn't make much sense, so you should probably
+	 *                              change it)
+	 * @return int
+	 */
+	public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
+	{
+		return $this->get_model()->sum_related($this, $relation_name, $query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Gets the first (ie, one) related model object of the specified type.
+	 *
+	 * @param string $relationName key in the model's _model_relations array
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class (not an array, a single object)
+	 * @throws \EE_Error
+	 */
+	public function get_first_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
+			//if they've provided some query parameters, don't bother trying to cache the result
+			//also make sure we're not caching the result of get_first_related
+			//on a relation which should have an array of objects (because the cache might have an array of objects)
+			if ($query_params
+				|| ! $this->get_model()->related_settings_for($relationName)
+					 instanceof
+					 EE_Belongs_To_Relation
+			) {
+				$related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
+			} else {
+				//first, check if we've already cached the result of this query
+				$cached_result = $this->get_one_from_cache($relationName);
+				if ( ! $cached_result) {
+					$related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
+					$this->cache($relationName, $related_model_object);
+				} else {
+					$related_model_object = $cached_result;
+				}
+			}
+		} else {
+			$related_model_object = null;
+			//this doesn't exist in the Db, but maybe the relation is of type belongs to, and so the related thing might
+			if ($this->get_model()->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
+				$related_model_object = $this->get_model()->get_first_related($this, $relationName, $query_params);
+			}
+			//this doesn't exist in the DB and apparently the thing it belongs to doesn't either, just get what's cached on this object
+			if ( ! $related_model_object) {
+				$related_model_object = $this->get_one_from_cache($relationName);
+			}
+		}
+		return $related_model_object;
+	}
+
+
+
+	/**
+	 * Does a delete on all related objects of type $relationName and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) does nothing. If the related model objects are
+	 * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
+	 * If this model object doesn't exist yet in the DB, just removes its related things
+	 *
+	 * @param string $relationName
+	 * @param array  $query_params like EEM_Base::get_all's
+	 * @return int how many deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related($this, $relationName, $query_params);
+		} else {
+			$count = count($this->get_all_from_cache($relationName));
+			$this->clear_cache($relationName, null, true);
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) just does a soft delete on it instead, if possible.
+	 * If the related thing isn't a soft-deletable model object, this function is identical
+	 * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
+	 *
+	 * @param string $relationName
+	 * @param array  $query_params like EEM_Base::get_all's
+	 * @return int how many deleted (including those soft deleted)
+	 * @throws \EE_Error
+	 */
+	public function delete_related_permanently($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related_permanently($this, $relationName, $query_params);
+		} else {
+			$count = count($this->get_all_from_cache($relationName));
+		}
+		$this->clear_cache($relationName, null, true);
+		return $count;
+	}
+
+
+
+	/**
+	 * is_set
+	 * Just a simple utility function children can use for checking if property exists
+	 *
+	 * @access  public
+	 * @param  string $field_name property to check
+	 * @return bool                              TRUE if existing,FALSE if not.
+	 */
+	public function is_set($field_name)
+	{
+		return isset($this->_fields[$field_name]);
+	}
+
+
+
+	/**
+	 * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
+	 * EE_Error exception if they don't
+	 *
+	 * @param  mixed (string|array) $properties properties to check
+	 * @throws EE_Error
+	 * @return bool                              TRUE if existing, throw EE_Error if not.
+	 */
+	protected function _property_exists($properties)
+	{
+		foreach ((array)$properties as $property_name) {
+			//first make sure this property exists
+			if ( ! $this->_fields[$property_name]) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
+							'event_espresso'
+						),
+						$property_name
+					)
+				);
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * This simply returns an array of model fields for this object
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function model_field_array()
+	{
+		$fields = $this->get_model()->field_settings(false);
+		$properties = array();
+		//remove prepended underscore
+		foreach ($fields as $field_name => $settings) {
+			$properties[$field_name] = $this->get($field_name);
+		}
+		return $properties;
+	}
+
+
+
+	/**
+	 * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
+	 * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
+	 * requiring a plugin to extend the EE_Base_Class (which works fine is there's only 1 plugin, but when will that
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
+	 * my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
+	 *        return $previousReturnValue.$returnString;
+	 * }
+	 * require('EE_Answer.class.php');
+	 * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
+	 * echo $answer->my_callback('monkeys',100);
+	 * //will output "you called my_callback! and passed args:monkeys,100"
+	 *
+	 * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
+	 * @param array  $args       array of original arguments passed to the function
+	 * @throws EE_Error
+	 * @return mixed whatever the plugin which calls add_filter decides
+	 */
+	public function __call($methodName, $args)
+	{
+		$className = get_class($this);
+		$tagName = "FHEE__{$className}__{$methodName}";
+		if ( ! has_filter($tagName)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
+						"event_espresso"
+					),
+					$methodName,
+					$className,
+					$tagName
+				)
+			);
+		}
+		return apply_filters($tagName, null, $this, $args);
+	}
+
+
+
+	/**
+	 * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
+	 * A $previous_value can be specified in case there are many meta rows with the same key
+	 *
+	 * @param string $meta_key
+	 * @param string $meta_value
+	 * @param string $previous_value
+	 * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
+	 * @throws \EE_Error
+	 * NOTE: if the values haven't changed, returns 0
+	 */
+	public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
+	{
+		$query_params = array(
+			array(
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			),
+		);
+		if ($previous_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		$existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
+		if ( ! $existing_rows_like_that) {
+			return $this->add_extra_meta($meta_key, $meta_value);
+		} else {
+			foreach ($existing_rows_like_that as $existing_row) {
+				$existing_row->save(array('EXM_value' => $meta_value));
+			}
+			return count($existing_rows_like_that);
+		}
+	}
+
+
+
+	/**
+	 * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
+	 * no other extra meta for this model object have the same key. Returns TRUE if the
+	 * extra meta row was entered, false if not
+	 *
+	 * @param string  $meta_key
+	 * @param string  $meta_value
+	 * @param boolean $unique
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function add_extra_meta($meta_key, $meta_value, $unique = false)
+	{
+		if ($unique) {
+			$existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
+				array(
+					array(
+						'EXM_key'  => $meta_key,
+						'OBJ_ID'   => $this->ID(),
+						'EXM_type' => $this->get_model()->get_this_model_name(),
+					),
+				)
+			);
+			if ($existing_extra_meta) {
+				return false;
+			}
+		}
+		$new_extra_meta = EE_Extra_Meta::new_instance(
+			array(
+				'EXM_key'   => $meta_key,
+				'EXM_value' => $meta_value,
+				'OBJ_ID'    => $this->ID(),
+				'EXM_type'  => $this->get_model()->get_this_model_name(),
+			)
+		);
+		$new_extra_meta->save();
+		return true;
+	}
+
+
+
+	/**
+	 * Deletes all the extra meta rows for this record as specified by key. If $meta_value
+	 * is specified, only deletes extra meta records with that value.
+	 *
+	 * @param string $meta_key
+	 * @param string $meta_value
+	 * @return int number of extra meta rows deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_extra_meta($meta_key, $meta_value = null)
+	{
+		$query_params = array(
+			array(
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			),
+		);
+		if ($meta_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		return EEM_Extra_Meta::instance()->delete($query_params);
+	}
+
+
+
+	/**
+	 * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
+	 * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
+	 * You can specify $default is case you haven't found the extra meta
+	 *
+	 * @param string  $meta_key
+	 * @param boolean $single
+	 * @param mixed   $default if we don't find anything, what should we return?
+	 * @return mixed single value if $single; array if ! $single
+	 * @throws \EE_Error
+	 */
+	public function get_extra_meta($meta_key, $single = false, $default = null)
+	{
+		if ($single) {
+			$result = $this->get_first_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
+			if ($result instanceof EE_Extra_Meta) {
+				return $result->value();
+			} else {
+				return $default;
+			}
+		} else {
+			$results = $this->get_many_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
+			if ($results) {
+				$values = array();
+				foreach ($results as $result) {
+					if ($result instanceof EE_Extra_Meta) {
+						$values[$result->ID()] = $result->value();
+					}
+				}
+				return $values;
+			} else {
+				return $default;
+			}
+		}
+	}
+
+
+
+	/**
+	 * Returns a simple array of all the extra meta associated with this model object.
+	 * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
+	 * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
+	 * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
+	 * If $one_of_each_key is false, it will return an array with the top-level keys being
+	 * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
+	 * finally the extra meta's value as each sub-value. (eg
+	 * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
+	 *
+	 * @param boolean $one_of_each_key
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function all_extra_meta_array($one_of_each_key = true)
+	{
+		$return_array = array();
+		if ($one_of_each_key) {
+			$extra_meta_objs = $this->get_many_related('Extra_Meta', array('group_by' => 'EXM_key'));
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					$return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
+				}
+			}
+		} else {
+			$extra_meta_objs = $this->get_many_related('Extra_Meta');
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					if ( ! isset($return_array[$extra_meta_obj->key()])) {
+						$return_array[$extra_meta_obj->key()] = array();
+					}
+					$return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
+				}
+			}
+		}
+		return $return_array;
+	}
+
+
+
+	/**
+	 * Gets a pretty nice displayable nice for this model object. Often overridden
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function name()
+	{
+		//find a field that's not a text field
+		$field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
+		if ($field_we_can_use) {
+			return $this->get($field_we_can_use->get_name());
+		} else {
+			$first_few_properties = $this->model_field_array();
+			$first_few_properties = array_slice($first_few_properties, 0, 3);
+			$name_parts = array();
+			foreach ($first_few_properties as $name => $value) {
+				$name_parts[] = "$name:$value";
+			}
+			return implode(",", $name_parts);
+		}
+	}
+
+
+
+	/**
+	 * in_entity_map
+	 * Checks if this model object has been proven to already be in the entity map
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function in_entity_map()
+	{
+		if ($this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this) {
+			//well, if we looked, did we find it in the entity map?
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * refresh_from_db
+	 * Makes sure the fields and values on this model object are in-sync with what's in the database.
+	 *
+	 * @throws EE_Error if this model object isn't in the entity mapper (because then you should
+	 * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
+	 */
+	public function refresh_from_db()
+	{
+		if ($this->ID() && $this->in_entity_map()) {
+			$this->get_model()->refresh_entity_map_from_db($this->ID());
+		} else {
+			//if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
+			//if it has an ID but it's not in the map, and you're asking me to refresh it
+			//that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
+			//absolutely nothing in it for this ID
+			if (WP_DEBUG) {
+				throw new EE_Error(
+					sprintf(
+						__('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
+							'event_espresso'),
+						$this->ID(),
+						get_class($this->get_model()) . '::instance()->add_to_entity_map()',
+						get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+					)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
+	 * (probably a bad assumption they have made, oh well)
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		try {
+			return sprintf('%s (%s)', $this->name(), $this->ID());
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+	}
+
+
+
+	/**
+	 * Clear related model objects if they're already in the DB, because otherwise when we
+	 * UN-serialize this model object we'll need to be careful to add them to the entity map.
+	 * This means if we have made changes to those related model objects, and want to unserialize
+	 * the this model object on a subsequent request, changes to those related model objects will be lost.
+	 * Instead, those related model objects should be directly serialized and stored.
+	 * Eg, the following won't work:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $reg = get_option( 'my_option' );
+	 * $reg->attendee()->save();
+	 * And would need to be replace with:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $att = get_option( 'my_option' );
+	 * $att->save();
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function __sleep()
+	{
+		foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$classname = 'EE_' . $this->get_model()->get_this_model_name();
+				if (
+					$this->get_one_from_cache($relation_name) instanceof $classname
+					&& $this->get_one_from_cache($relation_name)->ID()
+				) {
+					$this->clear_cache($relation_name, $this->get_one_from_cache($relation_name)->ID());
+				}
+			}
+		}
+		$this->_props_n_values_provided_in_constructor = array();
+		return array_keys(get_object_vars($this));
+	}
+
+
+
+	/**
+	 * restore _props_n_values_provided_in_constructor
+	 * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
+	 * and therefore should NOT be used to determine if state change has occurred since initial construction.
+	 * At best, you would only be able to detect if state change has occurred during THIS request.
+	 */
+	public function __wakeup()
+	{
+		$this->_props_n_values_provided_in_constructor = $this->_fields;
+	}
 
 
 

Spacing +18 added lines, -18 removed lines

@@ -145,8 +145,8 @@ 
             list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
         } else {
             //set default formats for date and time
-            $this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
-            $this->_tm_frmt = (string)get_option('time_format', 'g:i a');
+            $this->_dt_frmt = (string) get_option('date_format', 'Y-m-d');
+            $this->_tm_frmt = (string) get_option('time_format', 'g:i a');
         }
         //if db model is instantiating
         if ($bydb) {
@@ -457,7 +457,7 @@ 
      */
     public function get_format($full = true)
     {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
+        return $full ? $this->_dt_frmt.' '.$this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
     }
 
 
@@ -565,7 +565,7 @@ 
         //verify the field exists
         $this->get_model()->field_settings_for($fieldname);
         $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
+        $cache_type .= ! empty($extra_cache_ref) ? '_'.$extra_cache_ref : '';
         if (isset($this->_cached_properties[$fieldname][$cache_type])) {
             return $this->_cached_properties[$fieldname][$cache_type];
         }
@@ -780,7 +780,7 @@ 
         $current_cache_id = ''
     ) {
         // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relationName;
+        $obj_class = 'EE_'.$relationName;
         if ($newly_saved_object instanceof $obj_class) {
             /* @type EE_Base_Class $newly_saved_object */
             // now get the type of relation
@@ -1259,7 +1259,7 @@ 
      */
     public function get_i18n_datetime($field_name, $format = '')
     {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+        $format = empty($format) ? $this->_dt_frmt.' '.$this->_tm_frmt : $format;
         return date_i18n(
             $format,
             EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
@@ -1397,8 +1397,8 @@ 
         }
         $original_timezone = $this->_timezone;
         $this->set_timezone($timezone);
-        $fn = (array)$field_name;
-        $args = array_merge($fn, (array)$args);
+        $fn = (array) $field_name;
+        $args = array_merge($fn, (array) $args);
         if ( ! method_exists($this, $callback)) {
             throw new EE_Error(
                 sprintf(
@@ -1410,8 +1410,8 @@ 
                 )
             );
         }
-        $args = (array)$args;
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
+        $args = (array) $args;
+        $return = $prepend.call_user_func_array(array($this, $callback), $args).$append;
         $this->set_timezone($original_timezone);
         return $return;
     }
@@ -1548,7 +1548,7 @@ 
          * @param array         $set_cols_n_values
          * @param EE_Base_Class $model_object
          */
-        $set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
+        $set_cols_n_values = (array) apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
             $this);
         //set attributes as provided in $set_cols_n_values
         foreach ($set_cols_n_values as $column => $value) {
@@ -1603,8 +1603,8 @@ 
                                 __('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
                                     'event_espresso'),
                                 get_class($this),
-                                get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                                get_class($this->get_model()) . '::instance()->get_one_by_ID()',
+                                get_class($this->get_model()).'::instance()->add_to_entity_map()',
+                                get_class($this->get_model()).'::instance()->get_one_by_ID()',
                                 '<br />'
                             )
                         );
@@ -1871,7 +1871,7 @@ 
         if (strpos($model_name, "EE_") === 0) {
             $model_classname = str_replace("EE_", "EEM_", $model_name);
         } else {
-            $model_classname = "EEM_" . $model_name;
+            $model_classname = "EEM_".$model_name;
         }
         return $model_classname;
     }
@@ -2255,7 +2255,7 @@ 
      */
     protected function _property_exists($properties)
     {
-        foreach ((array)$properties as $property_name) {
+        foreach ((array) $properties as $property_name) {
             //first make sure this property exists
             if ( ! $this->_fields[$property_name]) {
                 throw new EE_Error(
@@ -2586,8 +2586,8 @@ 
                         __('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
                             'event_espresso'),
                         $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+                        get_class($this->get_model()).'::instance()->add_to_entity_map()',
+                        get_class($this->get_model()).'::instance()->refresh_entity_map()'
                     )
                 );
             }
@@ -2646,7 +2646,7 @@ 
     {
         foreach ($this->get_model()->relation_settings() as $relation_name => $relation_obj) {
             if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $this->get_model()->get_this_model_name();
+                $classname = 'EE_'.$this->get_model()->get_this_model_name();
                 if (
                     $this->get_one_from_cache($relation_name) instanceof $classname
                     && $this->get_one_from_cache($relation_name)->ID()

modules/ticket_selector/DatetimeSelector.php

Indentation +169 added lines, -169 removed lines

@@ -16,175 +16,175 @@
 class DatetimeSelector
 {
 
-    /**
-     * @var \EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * @var \EE_Ticket[] $tickets
-     */
-    protected $tickets;
-
-    /**
-     * @var \EE_Datetime[] $datetimes
-     */
-    protected $datetimes;
-
-    /**
-     * @var \EE_Datetime[] $unique_dates
-     */
-    protected $unique_dates;
-
-    /**
-     * @var \EE_Ticket_Selector_Config $template_settings
-     */
-    protected $template_settings;
-
-    /**
-     * @var boolean $active
-     */
-    protected $active = false;
-
-
-
-    /**
-     * DatetimeSelector constructor.
-     *
-     * @param \EE_Event                  $event
-     * @param \EE_Ticket[]               $tickets
-     * @param \EE_Ticket_Selector_Config $template_settings
-     * @param string                     $date_format
-     * @param string                     $time_format
-     * @throws \EE_Error
-     */
-    public function __construct(
-        \EE_Event $event,
-        array $tickets,
-        \EE_Ticket_Selector_Config $template_settings,
-        $date_format = 'Y-m-d',
-        $time_format = 'g:i a'
-    ) {
-        $this->event = $event;
-        $this->tickets = $tickets;
-        $this->template_settings = $template_settings;
-        $this->datetimes = $this->getAllDatetimesForAllTicket($tickets);
-        $this->unique_dates = $this->getUniqueDatetimeOptions($date_format, $time_format);
-        $this->active = $this->template_settings->showDatetimeSelector($this->unique_dates);
-    }
-
-
-
-    /**
-     * @param \EE_Ticket[] $tickets
-     * @return array
-     * @throws \EE_Error
-     */
-    protected function getAllDatetimesForAllTicket($tickets = array())
-    {
-        $datetimes = array();
-        foreach ($tickets as $ticket) {
-            $datetimes = $this->getTicketDatetimes($ticket, $datetimes);
-        }
-        return $datetimes;
-    }
-
-
-
-    /**
-     * @param \EE_Ticket      $ticket
-     * @param  \EE_Datetime[] $datetimes
-     * @return \EE_Datetime[]
-     * @throws \EE_Error
-     */
-    protected function getTicketDatetimes(\EE_Ticket $ticket, $datetimes = array())
-    {
-        $ticket_datetimes = $ticket->datetimes(
-            array(
-                'order_by'                 => array(
-                    'DTT_order'     => 'ASC',
-                    'DTT_EVT_start' => 'ASC'
-                ),
-                'default_where_conditions' => 'none',
-            )
-        );
-        foreach ($ticket_datetimes as $ticket_datetime) {
-            if ( ! $ticket_datetime instanceof \EE_Datetime) {
-                continue;
-            }
-            $datetimes[ $ticket_datetime->ID() ] = $ticket_datetime;
-        }
-        return $datetimes;
-    }
-
-
-
-    /**
-     * @param \EE_Ticket                 $ticket
-     * @return string
-     * @throws \EE_Error
-     */
-    public function getTicketDatetimeClasses( \EE_Ticket $ticket ) {
-        if ( ! $this->active) {
-            return '';
-        }
-        $ticket_datetimes = $this->getTicketDatetimes($ticket);
-        $classes = '';
-        foreach ($this->datetimes as $datetime) {
-            if ( ! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
-                continue;
-            }
-            $classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
-        }
-        return $classes;
-    }
-
-
-
-    /**
-     * @param string $date_format
-     * @param string $time_format
-     * @return array
-     * @throws \EE_Error
-     */
-    public function getUniqueDatetimeOptions($date_format = 'Y-m-d', $time_format = 'g:i a') {
-        $datetime_options = array();
-        foreach ($this->datetimes as $datetime) {
-            if ( ! $datetime instanceof \EE_Datetime) {
-                continue;
-            }
-            $datetime_options[$datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_')] =
-                $datetime->date_and_time_range($date_format, $time_format, ' - ');
-        }
-        return $datetime_options;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public function getDatetimeSelector() {
-        if ( ! $this->active) {
-            return '';
-        }
-        $dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input(
-            $this->unique_dates,
-            array(
-                'html_id'               => 'datetime-selector-' . $this->event->ID(),
-                'html_name'             => 'datetime_selector_' . $this->event->ID(),
-                'html_class'            => 'datetime-selector',
-                'select_button_text'       => '<span class="dashicons dashicons-calendar-alt"></span> '
-                                            . esc_html__('Filter by Date', 'event_espresso'),
-                'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"',
-            )
-        );
-        return \EEH_HTML::div(
-            $dropdown_selector->get_html_for_input(),
-            '', 'datetime_selector-dv'
-        );
-    }
+	/**
+	 * @var \EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * @var \EE_Ticket[] $tickets
+	 */
+	protected $tickets;
+
+	/**
+	 * @var \EE_Datetime[] $datetimes
+	 */
+	protected $datetimes;
+
+	/**
+	 * @var \EE_Datetime[] $unique_dates
+	 */
+	protected $unique_dates;
+
+	/**
+	 * @var \EE_Ticket_Selector_Config $template_settings
+	 */
+	protected $template_settings;
+
+	/**
+	 * @var boolean $active
+	 */
+	protected $active = false;
+
+
+
+	/**
+	 * DatetimeSelector constructor.
+	 *
+	 * @param \EE_Event                  $event
+	 * @param \EE_Ticket[]               $tickets
+	 * @param \EE_Ticket_Selector_Config $template_settings
+	 * @param string                     $date_format
+	 * @param string                     $time_format
+	 * @throws \EE_Error
+	 */
+	public function __construct(
+		\EE_Event $event,
+		array $tickets,
+		\EE_Ticket_Selector_Config $template_settings,
+		$date_format = 'Y-m-d',
+		$time_format = 'g:i a'
+	) {
+		$this->event = $event;
+		$this->tickets = $tickets;
+		$this->template_settings = $template_settings;
+		$this->datetimes = $this->getAllDatetimesForAllTicket($tickets);
+		$this->unique_dates = $this->getUniqueDatetimeOptions($date_format, $time_format);
+		$this->active = $this->template_settings->showDatetimeSelector($this->unique_dates);
+	}
+
+
+
+	/**
+	 * @param \EE_Ticket[] $tickets
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	protected function getAllDatetimesForAllTicket($tickets = array())
+	{
+		$datetimes = array();
+		foreach ($tickets as $ticket) {
+			$datetimes = $this->getTicketDatetimes($ticket, $datetimes);
+		}
+		return $datetimes;
+	}
+
+
+
+	/**
+	 * @param \EE_Ticket      $ticket
+	 * @param  \EE_Datetime[] $datetimes
+	 * @return \EE_Datetime[]
+	 * @throws \EE_Error
+	 */
+	protected function getTicketDatetimes(\EE_Ticket $ticket, $datetimes = array())
+	{
+		$ticket_datetimes = $ticket->datetimes(
+			array(
+				'order_by'                 => array(
+					'DTT_order'     => 'ASC',
+					'DTT_EVT_start' => 'ASC'
+				),
+				'default_where_conditions' => 'none',
+			)
+		);
+		foreach ($ticket_datetimes as $ticket_datetime) {
+			if ( ! $ticket_datetime instanceof \EE_Datetime) {
+				continue;
+			}
+			$datetimes[ $ticket_datetime->ID() ] = $ticket_datetime;
+		}
+		return $datetimes;
+	}
+
+
+
+	/**
+	 * @param \EE_Ticket                 $ticket
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function getTicketDatetimeClasses( \EE_Ticket $ticket ) {
+		if ( ! $this->active) {
+			return '';
+		}
+		$ticket_datetimes = $this->getTicketDatetimes($ticket);
+		$classes = '';
+		foreach ($this->datetimes as $datetime) {
+			if ( ! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
+				continue;
+			}
+			$classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
+		}
+		return $classes;
+	}
+
+
+
+	/**
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function getUniqueDatetimeOptions($date_format = 'Y-m-d', $time_format = 'g:i a') {
+		$datetime_options = array();
+		foreach ($this->datetimes as $datetime) {
+			if ( ! $datetime instanceof \EE_Datetime) {
+				continue;
+			}
+			$datetime_options[$datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_')] =
+				$datetime->date_and_time_range($date_format, $time_format, ' - ');
+		}
+		return $datetime_options;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function getDatetimeSelector() {
+		if ( ! $this->active) {
+			return '';
+		}
+		$dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input(
+			$this->unique_dates,
+			array(
+				'html_id'               => 'datetime-selector-' . $this->event->ID(),
+				'html_name'             => 'datetime_selector_' . $this->event->ID(),
+				'html_class'            => 'datetime-selector',
+				'select_button_text'       => '<span class="dashicons dashicons-calendar-alt"></span> '
+											. esc_html__('Filter by Date', 'event_espresso'),
+				'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"',
+			)
+		);
+		return \EEH_HTML::div(
+			$dropdown_selector->get_html_for_input(),
+			'', 'datetime_selector-dv'
+		);
+	}
 
 
 

Spacing +6 added lines, -6 removed lines

@@ -112,7 +112,7 @@ 
             if ( ! $ticket_datetime instanceof \EE_Datetime) {
                 continue;
             }
-            $datetimes[ $ticket_datetime->ID() ] = $ticket_datetime;
+            $datetimes[$ticket_datetime->ID()] = $ticket_datetime;
         }
         return $datetimes;
     }
@@ -124,7 +124,7 @@ 
      * @return string
      * @throws \EE_Error
      */
-    public function getTicketDatetimeClasses( \EE_Ticket $ticket ) {
+    public function getTicketDatetimeClasses(\EE_Ticket $ticket) {
         if ( ! $this->active) {
             return '';
         }
@@ -134,7 +134,7 @@ 
             if ( ! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
                 continue;
             }
-            $classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
+            $classes .= ' ee-ticket-datetimes-'.$datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
         }
         return $classes;
     }
@@ -172,12 +172,12 @@ 
         $dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input(
             $this->unique_dates,
             array(
-                'html_id'               => 'datetime-selector-' . $this->event->ID(),
-                'html_name'             => 'datetime_selector_' . $this->event->ID(),
+                'html_id'               => 'datetime-selector-'.$this->event->ID(),
+                'html_name'             => 'datetime_selector_'.$this->event->ID(),
                 'html_class'            => 'datetime-selector',
                 'select_button_text'       => '<span class="dashicons dashicons-calendar-alt"></span> '
                                             . esc_html__('Filter by Date', 'event_espresso'),
-                'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"',
+                'other_html_attributes' => ' data-tkt_slctr_evt="'.$this->event->ID().'"',
             )
         );
         return \EEH_HTML::div(

modules/ticket_selector/TicketSelectorRow.php

Indentation +190 added lines, -190 removed lines

@@ -16,196 +16,196 @@
 abstract class TicketSelectorRow
 {
 
-    /**
-     * @var \EE_Ticket $ticket
-     */
-    protected $ticket;
-
-    /**
-     * @var int $max_atndz
-     */
-    protected $max_atndz;
-
-    /**
-     * @var string $date_format
-     */
-    protected $date_format;
-
-    /**
-     * @var int $EVT_ID
-     */
-    protected $EVT_ID;
-
-    /**
-     * @var string $ticket_status_display
-     */
-    protected $ticket_status_display;
-
-
-
-    /**
-     * TicketDetails constructor.
-     *
-     * @param \EE_Ticket                 $ticket
-     * @param int                        $max_atndz
-     * @param string                     $date_format
-     */
-    public function __construct(
-        \EE_Ticket $ticket,
-        $max_atndz,
-        $date_format
-    ) {
-        $this->ticket = $ticket;
-        $this->max_atndz = $max_atndz;
-        $this->date_format = $date_format;
-        $this->EVT_ID = $this->ticket->get_event_ID();
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function getTicketStatusDisplay()
-    {
-        return $this->ticket_status_display;
-    }
-
-
-
-    /**
-     * setTicketStatusDisplay
-     *
-     * @param string $tkt_status
-     * @param string $ticket_status
-     * @param int    $remaining
-     * @throws \EE_Error
-     */
-    protected function setTicketStatusDisplay($tkt_status, $ticket_status, $remaining) {
-        $this->ticket_status_display = '';
-        // now depending on the ticket and other circumstances...
-        if ($this->max_atndz === 0) {
-            // registration is CLOSED because admin set max attendees to ZERO
-            $this->ticket_status_display = $this->registrationClosed();
-        } else if ($tkt_status === \EE_Ticket::sold_out || $remaining === 0) {
-            // SOLD OUT - no tickets remaining
-            $this->ticket_status_display = $this->ticketsSoldOut();
-        } else if ($tkt_status === \EE_Ticket::expired || $tkt_status === \EE_Ticket::archived) {
-            // expired or archived ticket
-            $this->ticket_status_display = $ticket_status;
-        } else if ($tkt_status === \EE_Ticket::pending) {
-            // ticket not on sale yet
-            $this->ticket_status_display = $this->ticketsSalesPending();
-        } else if ($this->ticket->min() > $remaining) {
-            // min qty purchasable is less than tickets available
-            $this->ticket_status_display = $this->notEnoughTicketsAvailable();
-        }
-    }
-
-
-
-    /**
-     * registrationClosed
-     */
-    protected function registrationClosed()
-    {
-        return \EEH_HTML::span(
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__ticket_closed_msg',
-                __('Closed', 'event_espresso')
-            ),
-            '', 'sold-out'
-        );
-    }
-
-
-
-    /**
-     * ticketsSoldOut
-     */
-    protected function ticketsSoldOut()
-    {
-        return \EEH_HTML::span(
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__ticket_sold_out_msg',
-                __('Sold Out', 'event_espresso')
-            ),
-            '', 'sold-out'
-        );
-    }
-
-
-
-    /**
-     * ticketsSalesPending
-     *
-     * @throws \EE_Error
-     */
-    protected function ticketsSalesPending()
-    {
-        return \EEH_HTML::span(
-            \EEH_HTML::span(
-                apply_filters(
-                    'FHEE__ticket_selector_chart_template__ticket_goes_on_sale_msg',
-                    __('Goes On Sale', 'event_espresso')
-                ),
-                '', 'ticket-pending'
-            )
-            . \EEH_HTML::br()
-            . \EEH_HTML::span(
-                $this->ticket->get_i18n_datetime(
-                    'TKT_start_date',
-                    apply_filters(
-                        'FHEE__EED_Ticket_Selector__display_goes_on_sale__date_format',
-                        $this->date_format
-                    )
-                ),
-                '', 'small-text'
-            ),
-            '', 'ticket-pending-pg'
-        );
-    }
-
-
-
-    /**
-     * notEnoughTicketsAvailable
-     */
-    protected function notEnoughTicketsAvailable()
-    {
-        return \EEH_HTML::div(
-            \EEH_HTML::span(
-                apply_filters(
-                    'FHEE__ticket_selector_chart_template__ticket_not_available_msg',
-                    __('Not Available', 'event_espresso')
-                ),
-                '', 'archived-ticket small-text'
-            )
-            . \EEH_HTML::br(),
-            '', 'archived-ticket-pg'
-        );
-    }
-
-
-
-    /**
-     * getHiddenInputs
-     *
-     * @param string $anchor_id
-     * @param int    $row
-     * @param int    $max_atndz
-     * @return string
-     */
-    protected function getHiddenInputs($anchor_id, $row, $max_atndz)
-    {
-        $html = '<input type="hidden" name="noheader" value="true"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-return-url-' . $this->EVT_ID . '"';
-        $html .= ' value="' . \EEH_URL::current_url() . $anchor_id . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-rows-' . $this->EVT_ID . '" value="' . $row - 1 . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-max-atndz-' . $this->EVT_ID . '" value="' . $max_atndz . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-event-id" value="' . $this->EVT_ID . '"/>';
-        return $html;
-    }
+	/**
+	 * @var \EE_Ticket $ticket
+	 */
+	protected $ticket;
+
+	/**
+	 * @var int $max_atndz
+	 */
+	protected $max_atndz;
+
+	/**
+	 * @var string $date_format
+	 */
+	protected $date_format;
+
+	/**
+	 * @var int $EVT_ID
+	 */
+	protected $EVT_ID;
+
+	/**
+	 * @var string $ticket_status_display
+	 */
+	protected $ticket_status_display;
+
+
+
+	/**
+	 * TicketDetails constructor.
+	 *
+	 * @param \EE_Ticket                 $ticket
+	 * @param int                        $max_atndz
+	 * @param string                     $date_format
+	 */
+	public function __construct(
+		\EE_Ticket $ticket,
+		$max_atndz,
+		$date_format
+	) {
+		$this->ticket = $ticket;
+		$this->max_atndz = $max_atndz;
+		$this->date_format = $date_format;
+		$this->EVT_ID = $this->ticket->get_event_ID();
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function getTicketStatusDisplay()
+	{
+		return $this->ticket_status_display;
+	}
+
+
+
+	/**
+	 * setTicketStatusDisplay
+	 *
+	 * @param string $tkt_status
+	 * @param string $ticket_status
+	 * @param int    $remaining
+	 * @throws \EE_Error
+	 */
+	protected function setTicketStatusDisplay($tkt_status, $ticket_status, $remaining) {
+		$this->ticket_status_display = '';
+		// now depending on the ticket and other circumstances...
+		if ($this->max_atndz === 0) {
+			// registration is CLOSED because admin set max attendees to ZERO
+			$this->ticket_status_display = $this->registrationClosed();
+		} else if ($tkt_status === \EE_Ticket::sold_out || $remaining === 0) {
+			// SOLD OUT - no tickets remaining
+			$this->ticket_status_display = $this->ticketsSoldOut();
+		} else if ($tkt_status === \EE_Ticket::expired || $tkt_status === \EE_Ticket::archived) {
+			// expired or archived ticket
+			$this->ticket_status_display = $ticket_status;
+		} else if ($tkt_status === \EE_Ticket::pending) {
+			// ticket not on sale yet
+			$this->ticket_status_display = $this->ticketsSalesPending();
+		} else if ($this->ticket->min() > $remaining) {
+			// min qty purchasable is less than tickets available
+			$this->ticket_status_display = $this->notEnoughTicketsAvailable();
+		}
+	}
+
+
+
+	/**
+	 * registrationClosed
+	 */
+	protected function registrationClosed()
+	{
+		return \EEH_HTML::span(
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__ticket_closed_msg',
+				__('Closed', 'event_espresso')
+			),
+			'', 'sold-out'
+		);
+	}
+
+
+
+	/**
+	 * ticketsSoldOut
+	 */
+	protected function ticketsSoldOut()
+	{
+		return \EEH_HTML::span(
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__ticket_sold_out_msg',
+				__('Sold&nbsp;Out', 'event_espresso')
+			),
+			'', 'sold-out'
+		);
+	}
+
+
+
+	/**
+	 * ticketsSalesPending
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function ticketsSalesPending()
+	{
+		return \EEH_HTML::span(
+			\EEH_HTML::span(
+				apply_filters(
+					'FHEE__ticket_selector_chart_template__ticket_goes_on_sale_msg',
+					__('Goes&nbsp;On&nbsp;Sale', 'event_espresso')
+				),
+				'', 'ticket-pending'
+			)
+			. \EEH_HTML::br()
+			. \EEH_HTML::span(
+				$this->ticket->get_i18n_datetime(
+					'TKT_start_date',
+					apply_filters(
+						'FHEE__EED_Ticket_Selector__display_goes_on_sale__date_format',
+						$this->date_format
+					)
+				),
+				'', 'small-text'
+			),
+			'', 'ticket-pending-pg'
+		);
+	}
+
+
+
+	/**
+	 * notEnoughTicketsAvailable
+	 */
+	protected function notEnoughTicketsAvailable()
+	{
+		return \EEH_HTML::div(
+			\EEH_HTML::span(
+				apply_filters(
+					'FHEE__ticket_selector_chart_template__ticket_not_available_msg',
+					__('Not Available', 'event_espresso')
+				),
+				'', 'archived-ticket small-text'
+			)
+			. \EEH_HTML::br(),
+			'', 'archived-ticket-pg'
+		);
+	}
+
+
+
+	/**
+	 * getHiddenInputs
+	 *
+	 * @param string $anchor_id
+	 * @param int    $row
+	 * @param int    $max_atndz
+	 * @return string
+	 */
+	protected function getHiddenInputs($anchor_id, $row, $max_atndz)
+	{
+		$html = '<input type="hidden" name="noheader" value="true"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-return-url-' . $this->EVT_ID . '"';
+		$html .= ' value="' . \EEH_URL::current_url() . $anchor_id . '"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-rows-' . $this->EVT_ID . '" value="' . $row - 1 . '"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-max-atndz-' . $this->EVT_ID . '" value="' . $max_atndz . '"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-event-id" value="' . $this->EVT_ID . '"/>';
+		return $html;
+	}
 
 
 

Spacing +5 added lines, -5 removed lines

@@ -199,11 +199,11 @@
     protected function getHiddenInputs($anchor_id, $row, $max_atndz)
     {
         $html = '<input type="hidden" name="noheader" value="true"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-return-url-' . $this->EVT_ID . '"';
-        $html .= ' value="' . \EEH_URL::current_url() . $anchor_id . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-rows-' . $this->EVT_ID . '" value="' . $row - 1 . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-max-atndz-' . $this->EVT_ID . '" value="' . $max_atndz . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-event-id" value="' . $this->EVT_ID . '"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-return-url-'.$this->EVT_ID.'"';
+        $html .= ' value="'.\EEH_URL::current_url().$anchor_id.'"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-rows-'.$this->EVT_ID.'" value="'.$row - 1.'"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-max-atndz-'.$this->EVT_ID.'" value="'.$max_atndz.'"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-event-id" value="'.$this->EVT_ID.'"/>';
         return $html;
     }
 

modules/ticket_selector/templates/standard_ticket_selector.template.php

Indentation +22 added lines, -22 removed lines

@@ -28,12 +28,12 @@ 
 			<tr>
 				<th scope="col" class="ee-ticket-selector-ticket-details-th">
 					<?php
-                    echo apply_filters(
-                        'FHEE__ticket_selector_chart_template__table_header_available_tickets',
-                        esc_html(''),
-                        $EVT_ID
-                    );
-                    ?>
+					echo apply_filters(
+						'FHEE__ticket_selector_chart_template__table_header_available_tickets',
+						esc_html(''),
+						$EVT_ID
+					);
+					?>
 				</th>
 				<?php if ( apply_filters( 'FHEE__ticket_selector_chart_template__display_ticket_price_details', TRUE ) ) { ?>
 				<th scope="col" class="ee-ticket-selector-ticket-price-th cntr">
@@ -47,28 +47,28 @@ 
 						 * @param int $EVT_ID The Event ID
 						 */
 						echo apply_filters(
-                            'FHEE__ticket_selector_chart_template__table_header_price',
-                            esc_html__( 'Price', 'event_espresso' ),
-                            $EVT_ID
-                        );
+							'FHEE__ticket_selector_chart_template__table_header_price',
+							esc_html__( 'Price', 'event_espresso' ),
+							$EVT_ID
+						);
 					?>
 				</th>
 				<?php } ?>
 				<th scope="col" class="ee-ticket-selector-ticket-qty-th cntr">
 					<?php
 						/**
-						* Filters the text printed for the header of the quantity column in the ticket selector table
-						*
-						* @since 4.7.2
-						*
-						* @param string 'Qty' The translatable text to display in the table header for the Quantity of tickets
-						* @param int $EVT_ID The Event ID
-						*/
+						 * Filters the text printed for the header of the quantity column in the ticket selector table
+						 *
+						 * @since 4.7.2
+						 *
+						 * @param string 'Qty' The translatable text to display in the table header for the Quantity of tickets
+						 * @param int $EVT_ID The Event ID
+						 */
 						echo apply_filters(
-                            'FHEE__ticket_selector_chart_template__table_header_qty',
-                            esc_html__( 'Qty', 'event_espresso' ),
-                            $EVT_ID
-                        );
+							'FHEE__ticket_selector_chart_template__table_header_qty',
+							esc_html__( 'Qty', 'event_espresso' ),
+							$EVT_ID
+						);
 					?>
 				</th>
 			</tr>
@@ -98,7 +98,7 @@ 
 if ( $max_atndz > 0 ) {
 	echo apply_filters(
 		'FHEE__ticket_selector_chart_template__maximum_tickets_purchased_footnote',
-        esc_html('')
+		esc_html('')
 	);
 }
 if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {

Spacing +15 added lines, -15 removed lines

@@ -20,7 +20,7 @@ 
 ?>
 <div id="tkt-slctr-tbl-wrap-dv-<?php echo $EVT_ID; ?>" class="tkt-slctr-tbl-wrap-dv">
 
-	<?php do_action( 'AHEE__ticket_selector_chart__template__before_ticket_selector', $event ); ?>
+	<?php do_action('AHEE__ticket_selector_chart__template__before_ticket_selector', $event); ?>
 	<?php echo $datetime_selector; ?>
 
 	<table id="tkt-slctr-tbl-<?php echo $EVT_ID; ?>" class="tkt-slctr-tbl">
@@ -35,7 +35,7 @@ 
                     );
                     ?>
 				</th>
-				<?php if ( apply_filters( 'FHEE__ticket_selector_chart_template__display_ticket_price_details', TRUE ) ) { ?>
+				<?php if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', TRUE)) { ?>
 				<th scope="col" class="ee-ticket-selector-ticket-price-th cntr">
 					<?php
 						/**
@@ -48,7 +48,7 @@ 
 						 */
 						echo apply_filters(
                             'FHEE__ticket_selector_chart_template__table_header_price',
-                            esc_html__( 'Price', 'event_espresso' ),
+                            esc_html__('Price', 'event_espresso'),
                             $EVT_ID
                         );
 					?>
@@ -66,7 +66,7 @@ 
 						*/
 						echo apply_filters(
                             'FHEE__ticket_selector_chart_template__table_header_qty',
-                            esc_html__( 'Qty', 'event_espresso' ),
+                            esc_html__('Qty', 'event_espresso'),
                             $EVT_ID
                         );
 					?>
@@ -74,34 +74,34 @@ 
 			</tr>
 		</thead>
 		<tbody>
-			<?php echo $ticket_row_html;?>
+			<?php echo $ticket_row_html; ?>
 		</tbody>
 	</table>
 	<?php
-	if ( $taxable_tickets && apply_filters( 'FHEE__ticket_selector_chart_template__display_ticket_price_details', true ) ) {
-		if ( $prices_displayed_including_taxes ) {
-			$ticket_price_includes_taxes = esc_html__( '* price includes taxes', 'event_espresso' );
+	if ($taxable_tickets && apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
+		if ($prices_displayed_including_taxes) {
+			$ticket_price_includes_taxes = esc_html__('* price includes taxes', 'event_espresso');
 		} else {
-			$ticket_price_includes_taxes = esc_html__( '* price does not include taxes', 'event_espresso' );
+			$ticket_price_includes_taxes = esc_html__('* price does not include taxes', 'event_espresso');
 		}
-		echo '<p class="small-text lt-grey-text" style="text-align:right; margin: -1em 0 1em;">' . $ticket_price_includes_taxes . '</p>';
+		echo '<p class="small-text lt-grey-text" style="text-align:right; margin: -1em 0 1em;">'.$ticket_price_includes_taxes.'</p>';
 	}
 	?>
 
 	<input type="hidden" name="noheader" value="true" />
-	<input type="hidden" name="tkt-slctr-return-url-<?php echo $EVT_ID ?>" value="<?php echo EEH_URL::current_url() . $anchor_id; ?>" />
+	<input type="hidden" name="tkt-slctr-return-url-<?php echo $EVT_ID ?>" value="<?php echo EEH_URL::current_url().$anchor_id; ?>" />
 	<input type="hidden" name="tkt-slctr-rows-<?php echo $EVT_ID; ?>" value="<?php echo $row - 1; ?>" />
 	<input type="hidden" name="tkt-slctr-max-atndz-<?php echo $EVT_ID; ?>" value="<?php echo $max_atndz; ?>" />
 	<input type="hidden" name="tkt-slctr-event-id" value="<?php echo $EVT_ID; ?>" />
 
 <?php
-if ( $max_atndz > 0 ) {
+if ($max_atndz > 0) {
 	echo apply_filters(
 		'FHEE__ticket_selector_chart_template__maximum_tickets_purchased_footnote',
         esc_html('')
 	);
 }
-if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
-	add_filter( 'FHEE__EE_Ticket_Selector__no_ticket_selector_submit', '__return_true' );
+if ( ! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+	add_filter('FHEE__EE_Ticket_Selector__no_ticket_selector_submit', '__return_true');
 }
-do_action( 'AHEE__ticket_selector_chart__template__after_ticket_selector', $EVT_ID, $event );
\ No newline at end of file
+do_action('AHEE__ticket_selector_chart__template__after_ticket_selector', $EVT_ID, $event);
\ No newline at end of file