eventespresso / event-espresso-core

core/helpers/EEH_Event_Query.helper.php

Spacing +40 added lines, -40 removed lines

@@ -216,7 +216,7 @@ 
     {
         if (EEH_Event_Query::apply_query_filters($wp_query)) {
             global $wpdb;
-            $clauses['groupby'] = $wpdb->posts . '.ID ';
+            $clauses['groupby'] = $wpdb->posts.'.ID ';
         }
         return $clauses;
     }
@@ -251,23 +251,23 @@ 
      */
     public static function posts_fields_sql_for_orderby(array $orderby_params = [])
     {
-        $SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+        $SQL = ', MIN( '.EEM_Datetime::instance()->table().'.DTT_EVT_start ) as event_start_date ';
         foreach ($orderby_params as $orderby) {
             switch ($orderby) {
                 case 'ticket_start':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
+                    $SQL .= ', '.EEM_Ticket::instance()->table().'.TKT_start_date';
                     break;
                 case 'ticket_end':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
+                    $SQL .= ', '.EEM_Ticket::instance()->table().'.TKT_end_date';
                     break;
                 case 'venue_title':
                     $SQL .= ', Venue.post_title AS venue_title';
                     break;
                 case 'city':
-                    $SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
+                    $SQL .= ', '.EEM_Venue::instance()->second_table().'.VNU_city';
                     break;
                 case 'state':
-                    $SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
+                    $SQL .= ', '.EEM_State::instance()->table().'.STA_name';
                     break;
             }
         }
@@ -307,12 +307,12 @@ 
      */
     public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
     {
-        if (! $show_expired) {
-            $join = EEM_Event::instance()->table() . '.ID = ';
-            $join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+        if ( ! $show_expired) {
+            $join = EEM_Event::instance()->table().'.ID = ';
+            $join .= EEM_Datetime::instance()->table().'.'.EEM_Event::instance()->primary_key_name();
             // don't add if this is already in the SQL
             if (strpos($SQL, $join) === false) {
-                $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
+                $SQL .= ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.$join.' ) ';
             }
         }
         return $SQL;
@@ -327,7 +327,7 @@ 
      */
     public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
     {
-        if (! empty($join_terms)) {
+        if ( ! empty($join_terms)) {
             global $wpdb;
             $SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
             $SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
@@ -356,13 +356,13 @@ 
                 case 'ticket_end':
                     $SQL .= EEH_Event_Query::_posts_join_for_datetime(
                         $SQL,
-                        EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
+                        EEM_Datetime_Ticket::instance()->table().'.'.EEM_Datetime::instance()->primary_key_name()
                     );
-                    $SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
+                    $SQL .= ' LEFT JOIN '.EEM_Ticket::instance()->table();
                     $SQL .= ' ON (';
-                    $SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+                    $SQL .= EEM_Datetime_Ticket::instance()->table().'.'.EEM_Ticket::instance()->primary_key_name();
                     $SQL .= ' = ';
-                    $SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+                    $SQL .= EEM_Ticket::instance()->table().'.'.EEM_Ticket::instance()->primary_key_name();
                     $SQL .= ' )';
                     break;
                 case 'venue_title':
@@ -375,7 +375,7 @@ 
                     break;
                 case 'start_date':
                 default:
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
+                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table().'.ID');
                     break;
             }
         }
@@ -394,10 +394,10 @@ 
      */
     protected static function _posts_join_for_datetime($SQL = '', $join = '')
     {
-        if (! empty($join)) {
-            $join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+        if ( ! empty($join)) {
+            $join .= ' = '.EEM_Datetime::instance()->table().'.'.EEM_Event::instance()->primary_key_name();
             if (strpos($SQL, $join) === false) {
-                return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
+                return ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.$join.' )';
             }
         }
         return '';
@@ -417,8 +417,8 @@ 
         // Event Venue table name
         $event_venue_table = EEM_Event_Venue::instance()->table();
         // generate conditions for:  Event <=> Event Venue  JOIN clause
-        $event_to_event_venue_join = EEM_Event::instance()->table() . '.ID = ';
-        $event_to_event_venue_join .= $event_venue_table . '.' . EEM_Event::instance()->primary_key_name();
+        $event_to_event_venue_join = EEM_Event::instance()->table().'.ID = ';
+        $event_to_event_venue_join .= $event_venue_table.'.'.EEM_Event::instance()->primary_key_name();
         // don't add joins if they have already been added
         if (strpos($SQL, $event_to_event_venue_join) === false) {
             // Venue table name
@@ -506,7 +506,7 @@ 
     public static function posts_where_sql_for_show_expired($show_expired = false)
     {
         return ! $show_expired
-            ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
+            ? ' AND '.EEM_Datetime::instance()->table().'.DTT_EVT_end > \''.current_time('mysql', true).'\' '
             : '';
     }
 
@@ -518,7 +518,7 @@ 
     public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
     {
         global $wpdb;
-        if (! empty($event_category_slug)) {
+        if ( ! empty($event_category_slug)) {
             $event_category_slugs_array   = array_map('trim', explode(',', $event_category_slug));
             $event_category_slugs_prepare = implode(', ', array_fill(0, count($event_category_slugs_array), '%s'));
             return $wpdb->prepare(
@@ -541,14 +541,14 @@ 
     public static function posts_where_sql_for_event_list_month($month = null)
     {
         $SQL = '';
-        if (! empty($month)) {
+        if ( ! empty($month)) {
             $datetime_table = EEM_Datetime::instance()->table();
             // event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
             $SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
-            $SQL .= date('Y-m-t 23:59:59', EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
+            $SQL .= date('Y-m-t 23:59:59', EEH_DTT_Helper::first_of_month_timestamp($month))."'";
             // event end date is GREATER than the start of the month ( so nothing that ended before this month )
             $SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
-            $SQL .= date('Y-m-01 0:0:00', EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
+            $SQL .= date('Y-m-01 0:0:00', EEH_DTT_Helper::first_of_month_timestamp($month))."' ";
         }
         return $SQL;
     }
@@ -609,15 +609,15 @@ 
             ? strtoupper($sort)
             : 'ASC';
         // make sure 'orderby' is set in query params
-        if (! isset(self::$_query_params['orderby'])) {
+        if ( ! isset(self::$_query_params['orderby'])) {
             self::$_query_params['orderby'] = [];
         }
         // loop thru $orderby_params (type cast as array)
         foreach ($orderby_params as $orderby) {
             // check if we have already added this param
-            if (isset(self::$_query_params['orderby'][ $orderby ])) {
+            if (isset(self::$_query_params['orderby'][$orderby])) {
                 // if so then remove from the $orderby_params so that the count() method below is accurate
-                unset($orderby_params[ $orderby ]);
+                unset($orderby_params[$orderby]);
                 // then bump ahead to the next param
                 continue;
             }
@@ -627,39 +627,39 @@ 
             switch ($orderby) {
                 case 'id':
                 case 'ID':
-                    $SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+                    $SQL .= $glue.$wpdb->posts.'.ID '.$sort;
                     break;
                 case 'end_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+                    $SQL .= $glue.EEM_Datetime::instance()->table().'.DTT_EVT_end '.$sort;
                     break;
                 case 'event_name':
-                    $SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+                    $SQL .= $glue.$wpdb->posts.'.post_title '.$sort;
                     break;
                 case 'category_slug':
-                    $SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+                    $SQL .= $glue.$wpdb->terms.'.slug '.$sort;
                     break;
                 case 'ticket_start':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+                    $SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_start_date '.$sort;
                     break;
                 case 'ticket_end':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+                    $SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_end_date '.$sort;
                     break;
                 case 'venue_title':
-                    $SQL .= $glue . 'venue_title ' . $sort;
+                    $SQL .= $glue.'venue_title '.$sort;
                     break;
                 case 'city':
-                    $SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+                    $SQL .= $glue.EEM_Venue::instance()->second_table().'.VNU_city '.$sort;
                     break;
                 case 'state':
-                    $SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+                    $SQL .= $glue.EEM_State::instance()->table().'.STA_name '.$sort;
                     break;
                 case 'start_date':
                 default:
-                    $SQL .= $glue . ' event_start_date ' . $sort;
+                    $SQL .= $glue.' event_start_date '.$sort;
                     break;
             }
             // add to array of orderby params that have been added
-            self::$_query_params['orderby'][ $orderby ] = true;
+            self::$_query_params['orderby'][$orderby] = true;
             $counter++;
         }
         return $SQL;

Indentation +662 added lines, -662 removed lines

@@ -17,666 +17,666 @@
  */
 class EEH_Event_Query
 {
-    /**
-     * Start Date
-     *
-     * @var $_event_query_month
-     */
-    protected static $_event_query_month;
-
-    /**
-     * Category
-     *
-     * @var $_event_query_category
-     */
-    protected static $_event_query_category;
-
-    /**
-     * whether to display expired events in the event list
-     *
-     * @var bool $_show_expired
-     */
-    protected static $_event_query_show_expired = false;
-
-    /**
-     * list of params for controlling how the query results are ordered
-     *
-     * @var array $_event_query_orderby
-     */
-    protected static $_event_query_orderby = [];
-
-    /**
-     * direction list is sorted
-     *
-     * @var string $_event_query_sort
-     */
-    protected static $_event_query_sort;
-
-    /**
-     * list of params used to build the query's various clauses
-     *
-     * @var $_query_params
-     */
-    protected static $_query_params = [];
-
-
-    /**
-     * @return void
-     */
-    public static function add_query_filters()
-    {
-        // add query filters
-        add_action('pre_get_posts', ['EEH_Event_Query', 'filter_query_parts'], 10, 1);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return bool
-     */
-    public static function apply_query_filters(WP_Query $WP_Query)
-    {
-        return (
-                   isset($WP_Query->query['post_type'])
-                   && $WP_Query->query['post_type'] === 'espresso_events'
-               )
-               || apply_filters('FHEE__EEH_Event_Query__apply_query_filters', false);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     */
-    public static function filter_query_parts(WP_Query $WP_Query)
-    {
-        // ONLY add our filters if this isn't the main wp_query,
-        // because if this is the main wp_query we already have
-        // our cpt strategies take care of adding things in.
-        if ($WP_Query instanceof WP_Query && ! $WP_Query->is_main_query()) {
-            // build event list query
-            add_filter('posts_fields', ['EEH_Event_Query', 'posts_fields'], 10, 2);
-            add_filter('posts_join', ['EEH_Event_Query', 'posts_join'], 10, 2);
-            add_filter('posts_where', ['EEH_Event_Query', 'posts_where'], 10, 2);
-            add_filter('posts_orderby', ['EEH_Event_Query', 'posts_orderby'], 10, 2);
-            add_filter('posts_clauses_request', ['EEH_Event_Query', 'posts_clauses'], 10, 2);
-        }
-    }
-
-
-    /**
-     * @param string $month
-     * @param string $category
-     * @param bool   $show_expired
-     * @param array|string $orderby
-     * @param string $sort
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_query_params(
-        $month = '',
-        $category = '',
-        $show_expired = false,
-        $orderby = 'start_date',
-        $sort = 'ASC'
-    ) {
-        self::$_query_params                        = [];
-        EEH_Event_Query::$_event_query_month        = EEH_Event_Query::_display_month($month);
-        EEH_Event_Query::$_event_query_category     = EEH_Event_Query::_event_category_slug($category);
-        EEH_Event_Query::$_event_query_show_expired = EEH_Event_Query::_show_expired($show_expired);
-        EEH_Event_Query::$_event_query_orderby      = EEH_Event_Query::_orderby($orderby);
-        EEH_Event_Query::$_event_query_sort         = EEH_Event_Query::_sort($sort);
-    }
-
-
-    /**
-     * what month should the event list display events for?
-     *
-     * @param string $month
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _display_month($month = '')
-    {
-        return self::getRequest()->getRequestParam('event_query_month', $month);
-    }
-
-
-    /**
-     * @param string $category
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _event_category_slug($category = '')
-    {
-        return self::getRequest()->getRequestParam('event_query_category', $category);
-    }
-
-
-    /**
-     * @param bool $show_expired
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _show_expired($show_expired = false)
-    {
-        // override default expired option if set via filter
-        return self::getRequest()->getRequestParam('event_query_show_expired', $show_expired, 'bool');
-    }
-
-
-    /**
-     * @param array|string $orderby
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _orderby($orderby = 'start_date')
-    {
-        $event_query_orderby = self::getRequest()->getRequestParam(
-            'event_query_orderby',
-            (array) $orderby,
-            DataType::STRING,
-            true
-        );
-        $event_query_orderby = is_array($event_query_orderby)
-            ? $event_query_orderby
-            : explode(',', $event_query_orderby);
-        $event_query_orderby = array_map('trim', $event_query_orderby);
-        return array_map('sanitize_text_field', $event_query_orderby);
-    }
-
-
-    /**
-     * @param string $sort
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _sort($sort = 'ASC')
-    {
-        $sort = self::getRequest()->getRequestParam('event_query_sort', $sort);
-        return in_array($sort, ['ASC', 'asc', 'DESC', 'desc'], true)
-            ? strtoupper($sort)
-            : 'ASC';
-    }
-
-
-    /**
-     * Filters the clauses for the WP_Query object
-     *
-     * @param array    $clauses array of clauses
-     * @param WP_Query $wp_query
-     * @return array   array of clauses
-     */
-    public static function posts_clauses($clauses, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            global $wpdb;
-            $clauses['groupby'] = $wpdb->posts . '.ID ';
-        }
-        return $clauses;
-    }
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_fields($SQL, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= EEH_Event_Query::posts_fields_sql_for_orderby(EEH_Event_Query::$_event_query_orderby);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param array $orderby_params
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_fields_sql_for_orderby(array $orderby_params = [])
-    {
-        $SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
-        foreach ($orderby_params as $orderby) {
-            switch ($orderby) {
-                case 'ticket_start':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
-                    break;
-                case 'ticket_end':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
-                    break;
-                case 'venue_title':
-                    $SQL .= ', Venue.post_title AS venue_title';
-                    break;
-                case 'city':
-                    $SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
-                    break;
-                case 'state':
-                    $SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
-                    break;
-            }
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join($SQL, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // Category
-            $SQL = EEH_Event_Query::posts_join_sql_for_show_expired($SQL, EEH_Event_Query::$_event_query_show_expired);
-            $SQL = EEH_Event_Query::posts_join_sql_for_terms($SQL, EEH_Event_Query::$_event_query_category);
-            $SQL = EEH_Event_Query::posts_join_for_orderby($SQL, EEH_Event_Query::$_event_query_orderby);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param string  $SQL
-     * @param boolean $show_expired if TRUE, then displayed past events
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
-    {
-        if (! $show_expired) {
-            $join = EEM_Event::instance()->table() . '.ID = ';
-            $join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
-            // don't add if this is already in the SQL
-            if (strpos($SQL, $join) === false) {
-                $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
-            }
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param string $SQL
-     * @param string $join_terms    pass TRUE or term string, doesn't really matter since this value doesn't really get
-     *                              used for anything yet
-     * @return string
-     */
-    public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
-    {
-        if (! empty($join_terms)) {
-            global $wpdb;
-            $SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
-            $SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
-            $SQL .= " LEFT JOIN $wpdb->terms ON ($wpdb->terms.term_id = $wpdb->term_taxonomy.term_id) ";
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * usage:  $SQL .= EEH_Event_Query::posts_join_for_orderby( $orderby_params );
-     *
-     * @param string $SQL
-     * @param array  $orderby_params
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join_for_orderby($SQL = '', array $orderby_params = [])
-    {
-        foreach ($orderby_params as $orderby) {
-            switch ($orderby) {
-                case 'ticket_start':
-                case 'ticket_end':
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime(
-                        $SQL,
-                        EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
-                    );
-                    $SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
-                    $SQL .= ' ON (';
-                    $SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
-                    $SQL .= ' = ';
-                    $SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
-                    $SQL .= ' )';
-                    break;
-                case 'venue_title':
-                case 'city':
-                    $SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
-                    break;
-                case 'state':
-                    $SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
-                    $SQL .= EEH_Event_Query::_posts_join_for_venue_state($SQL);
-                    break;
-                case 'start_date':
-                default:
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
-                    break;
-            }
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param string $SQL
-     * @param string $join
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_datetime($SQL = '', $join = '')
-    {
-        if (! empty($join)) {
-            $join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
-            if (strpos($SQL, $join) === false) {
-                return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * @param string $SQL
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_event_venue($SQL = '')
-    {
-        // Event Venue table name
-        $event_venue_table = EEM_Event_Venue::instance()->table();
-        // generate conditions for:  Event <=> Event Venue  JOIN clause
-        $event_to_event_venue_join = EEM_Event::instance()->table() . '.ID = ';
-        $event_to_event_venue_join .= $event_venue_table . '.' . EEM_Event::instance()->primary_key_name();
-        // don't add joins if they have already been added
-        if (strpos($SQL, $event_to_event_venue_join) === false) {
-            // Venue table name
-            $venue_table = EEM_Venue::instance()->table();
-            // Venue table pk
-            $venue_table_pk = EEM_Venue::instance()->primary_key_name();
-            // Venue Meta table name
-            $venue_meta_table = EEM_Venue::instance()->second_table();
-            // generate JOIN clause for: Event <=> Event Venue
-            $venue_SQL = " LEFT JOIN $event_venue_table ON ( $event_to_event_venue_join )";
-            // generate JOIN clause for: Event Venue <=> Venue
-            $venue_SQL .= " LEFT JOIN $venue_table as Venue ON ( $event_venue_table.$venue_table_pk = Venue.ID )";
-            // generate JOIN clause for: Venue <=> Venue Meta
-            $venue_SQL .= " LEFT JOIN $venue_meta_table ON ( Venue.ID = $venue_meta_table.$venue_table_pk )";
-            unset($event_venue_table, $event_to_event_venue_join, $venue_table, $venue_table_pk, $venue_meta_table);
-            return $venue_SQL;
-        }
-        unset($event_venue_table, $event_to_event_venue_join);
-        return '';
-    }
-
-
-    /**
-     * @param string $SQL
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_venue_state($SQL = '')
-    {
-        // Venue Meta table name
-        $venue_meta_table = EEM_Venue::instance()->second_table();
-        // State table name
-        $state_table = EEM_State::instance()->table();
-        // State table pk
-        $state_table_pk = EEM_State::instance()->primary_key_name();
-        // verify vars
-        if ($venue_meta_table && $state_table && $state_table_pk) {
-            // like: wp_esp_venue_meta.STA_ID = wp_esp_state.STA_ID
-            $join = "$venue_meta_table.$state_table_pk = $state_table.$state_table_pk";
-            // don't add join if it has already been added
-            if (strpos($SQL, $join) === false) {
-                unset($state_table_pk, $venue_meta_table, $venue_table_pk);
-                return " LEFT JOIN $state_table ON ( $join )";
-            }
-        }
-        unset($join, $state_table, $state_table_pk, $venue_meta_table, $venue_table_pk);
-        return '';
-    }
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where($SQL, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // Show Expired ?
-            $SQL .= EEH_Event_Query::posts_where_sql_for_show_expired(EEH_Event_Query::$_event_query_show_expired);
-            // Category
-            $SQL .= EEH_Event_Query::posts_where_sql_for_event_category_slug(EEH_Event_Query::$_event_query_category);
-            // Start Date
-            $SQL .= EEH_Event_Query::posts_where_sql_for_event_list_month(EEH_Event_Query::$_event_query_month);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param boolean $show_expired if TRUE, then displayed past events
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where_sql_for_show_expired($show_expired = false)
-    {
-        return ! $show_expired
-            ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
-            : '';
-    }
-
-
-    /**
-     * @param boolean $event_category_slug
-     * @return string
-     */
-    public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
-    {
-        global $wpdb;
-        if (! empty($event_category_slug)) {
-            $event_category_slugs_array   = array_map('trim', explode(',', $event_category_slug));
-            $event_category_slugs_prepare = implode(', ', array_fill(0, count($event_category_slugs_array), '%s'));
-            return $wpdb->prepare(
-                " AND {$wpdb->terms}.slug IN ({$event_category_slugs_prepare}) ",
-                $event_category_slugs_array
-            );
-        }
-        return '';
-    }
-
-
-    /**
-     * @param boolean $month
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where_sql_for_event_list_month($month = null)
-    {
-        $SQL = '';
-        if (! empty($month)) {
-            $datetime_table = EEM_Datetime::instance()->table();
-            // event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
-            $SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
-            $SQL .= date('Y-m-t 23:59:59', EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
-            // event end date is GREATER than the start of the month ( so nothing that ended before this month )
-            $SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
-            $SQL .= date('Y-m-01 0:0:00', EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            $SQL = EEH_Event_Query::posts_orderby_sql(
-                EEH_Event_Query::$_event_query_orderby,
-                EEH_Event_Query::$_event_query_sort
-            );
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    posts_orderby_sql
-     *    possible parameters:
-     *    ID
-     *    start_date
-     *    end_date
-     *    event_name
-     *    category_slug
-     *    ticket_start
-     *    ticket_end
-     *    venue_title
-     *    city
-     *    state
-     *    **IMPORTANT**
-     *    make sure to also send the $orderby_params array to the posts_join_for_orderby() method
-     *    or else some of the table references below will result in MySQL errors
-     *
-     * @param array  $orderby_params
-     * @param string $sort
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_orderby_sql(array $orderby_params = [], $sort = 'ASC')
-    {
-        global $wpdb;
-        $SQL     = '';
-        $counter = 0;
-        $sort    = in_array($sort, ['ASC', 'asc', 'DESC', 'desc'], true)
-            ? strtoupper($sort)
-            : 'ASC';
-        // make sure 'orderby' is set in query params
-        if (! isset(self::$_query_params['orderby'])) {
-            self::$_query_params['orderby'] = [];
-        }
-        // loop thru $orderby_params (type cast as array)
-        foreach ($orderby_params as $orderby) {
-            // check if we have already added this param
-            if (isset(self::$_query_params['orderby'][ $orderby ])) {
-                // if so then remove from the $orderby_params so that the count() method below is accurate
-                unset($orderby_params[ $orderby ]);
-                // then bump ahead to the next param
-                continue;
-            }
-            // this will ad a comma depending on whether this is the first or last param
-            $glue = $counter === 0 || $counter === count($orderby_params) ? ' ' : ', ';
-            // ok what's we dealing with?
-            switch ($orderby) {
-                case 'id':
-                case 'ID':
-                    $SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
-                    break;
-                case 'end_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
-                    break;
-                case 'event_name':
-                    $SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
-                    break;
-                case 'category_slug':
-                    $SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
-                    break;
-                case 'ticket_start':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
-                    break;
-                case 'ticket_end':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
-                    break;
-                case 'venue_title':
-                    $SQL .= $glue . 'venue_title ' . $sort;
-                    break;
-                case 'city':
-                    $SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
-                    break;
-                case 'state':
-                    $SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
-                    break;
-                case 'start_date':
-                default:
-                    $SQL .= $glue . ' event_start_date ' . $sort;
-                    break;
-            }
-            // add to array of orderby params that have been added
-            self::$_query_params['orderby'][ $orderby ] = true;
-            $counter++;
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @return RequestInterface
-     * @since   4.10.14.p
-     */
-    private static function getRequest()
-    {
-        return LoaderFactory::getLoader()->getShared(RequestInterface::class);
-    }
+	/**
+	 * Start Date
+	 *
+	 * @var $_event_query_month
+	 */
+	protected static $_event_query_month;
+
+	/**
+	 * Category
+	 *
+	 * @var $_event_query_category
+	 */
+	protected static $_event_query_category;
+
+	/**
+	 * whether to display expired events in the event list
+	 *
+	 * @var bool $_show_expired
+	 */
+	protected static $_event_query_show_expired = false;
+
+	/**
+	 * list of params for controlling how the query results are ordered
+	 *
+	 * @var array $_event_query_orderby
+	 */
+	protected static $_event_query_orderby = [];
+
+	/**
+	 * direction list is sorted
+	 *
+	 * @var string $_event_query_sort
+	 */
+	protected static $_event_query_sort;
+
+	/**
+	 * list of params used to build the query's various clauses
+	 *
+	 * @var $_query_params
+	 */
+	protected static $_query_params = [];
+
+
+	/**
+	 * @return void
+	 */
+	public static function add_query_filters()
+	{
+		// add query filters
+		add_action('pre_get_posts', ['EEH_Event_Query', 'filter_query_parts'], 10, 1);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return bool
+	 */
+	public static function apply_query_filters(WP_Query $WP_Query)
+	{
+		return (
+				   isset($WP_Query->query['post_type'])
+				   && $WP_Query->query['post_type'] === 'espresso_events'
+			   )
+			   || apply_filters('FHEE__EEH_Event_Query__apply_query_filters', false);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 */
+	public static function filter_query_parts(WP_Query $WP_Query)
+	{
+		// ONLY add our filters if this isn't the main wp_query,
+		// because if this is the main wp_query we already have
+		// our cpt strategies take care of adding things in.
+		if ($WP_Query instanceof WP_Query && ! $WP_Query->is_main_query()) {
+			// build event list query
+			add_filter('posts_fields', ['EEH_Event_Query', 'posts_fields'], 10, 2);
+			add_filter('posts_join', ['EEH_Event_Query', 'posts_join'], 10, 2);
+			add_filter('posts_where', ['EEH_Event_Query', 'posts_where'], 10, 2);
+			add_filter('posts_orderby', ['EEH_Event_Query', 'posts_orderby'], 10, 2);
+			add_filter('posts_clauses_request', ['EEH_Event_Query', 'posts_clauses'], 10, 2);
+		}
+	}
+
+
+	/**
+	 * @param string $month
+	 * @param string $category
+	 * @param bool   $show_expired
+	 * @param array|string $orderby
+	 * @param string $sort
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_query_params(
+		$month = '',
+		$category = '',
+		$show_expired = false,
+		$orderby = 'start_date',
+		$sort = 'ASC'
+	) {
+		self::$_query_params                        = [];
+		EEH_Event_Query::$_event_query_month        = EEH_Event_Query::_display_month($month);
+		EEH_Event_Query::$_event_query_category     = EEH_Event_Query::_event_category_slug($category);
+		EEH_Event_Query::$_event_query_show_expired = EEH_Event_Query::_show_expired($show_expired);
+		EEH_Event_Query::$_event_query_orderby      = EEH_Event_Query::_orderby($orderby);
+		EEH_Event_Query::$_event_query_sort         = EEH_Event_Query::_sort($sort);
+	}
+
+
+	/**
+	 * what month should the event list display events for?
+	 *
+	 * @param string $month
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _display_month($month = '')
+	{
+		return self::getRequest()->getRequestParam('event_query_month', $month);
+	}
+
+
+	/**
+	 * @param string $category
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _event_category_slug($category = '')
+	{
+		return self::getRequest()->getRequestParam('event_query_category', $category);
+	}
+
+
+	/**
+	 * @param bool $show_expired
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _show_expired($show_expired = false)
+	{
+		// override default expired option if set via filter
+		return self::getRequest()->getRequestParam('event_query_show_expired', $show_expired, 'bool');
+	}
+
+
+	/**
+	 * @param array|string $orderby
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _orderby($orderby = 'start_date')
+	{
+		$event_query_orderby = self::getRequest()->getRequestParam(
+			'event_query_orderby',
+			(array) $orderby,
+			DataType::STRING,
+			true
+		);
+		$event_query_orderby = is_array($event_query_orderby)
+			? $event_query_orderby
+			: explode(',', $event_query_orderby);
+		$event_query_orderby = array_map('trim', $event_query_orderby);
+		return array_map('sanitize_text_field', $event_query_orderby);
+	}
+
+
+	/**
+	 * @param string $sort
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _sort($sort = 'ASC')
+	{
+		$sort = self::getRequest()->getRequestParam('event_query_sort', $sort);
+		return in_array($sort, ['ASC', 'asc', 'DESC', 'desc'], true)
+			? strtoupper($sort)
+			: 'ASC';
+	}
+
+
+	/**
+	 * Filters the clauses for the WP_Query object
+	 *
+	 * @param array    $clauses array of clauses
+	 * @param WP_Query $wp_query
+	 * @return array   array of clauses
+	 */
+	public static function posts_clauses($clauses, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			global $wpdb;
+			$clauses['groupby'] = $wpdb->posts . '.ID ';
+		}
+		return $clauses;
+	}
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_fields($SQL, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
+			$SQL .= EEH_Event_Query::posts_fields_sql_for_orderby(EEH_Event_Query::$_event_query_orderby);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param array $orderby_params
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_fields_sql_for_orderby(array $orderby_params = [])
+	{
+		$SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+		foreach ($orderby_params as $orderby) {
+			switch ($orderby) {
+				case 'ticket_start':
+					$SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
+					break;
+				case 'ticket_end':
+					$SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
+					break;
+				case 'venue_title':
+					$SQL .= ', Venue.post_title AS venue_title';
+					break;
+				case 'city':
+					$SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
+					break;
+				case 'state':
+					$SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
+					break;
+			}
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join($SQL, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// Category
+			$SQL = EEH_Event_Query::posts_join_sql_for_show_expired($SQL, EEH_Event_Query::$_event_query_show_expired);
+			$SQL = EEH_Event_Query::posts_join_sql_for_terms($SQL, EEH_Event_Query::$_event_query_category);
+			$SQL = EEH_Event_Query::posts_join_for_orderby($SQL, EEH_Event_Query::$_event_query_orderby);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string  $SQL
+	 * @param boolean $show_expired if TRUE, then displayed past events
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
+	{
+		if (! $show_expired) {
+			$join = EEM_Event::instance()->table() . '.ID = ';
+			$join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+			// don't add if this is already in the SQL
+			if (strpos($SQL, $join) === false) {
+				$SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
+			}
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string $SQL
+	 * @param string $join_terms    pass TRUE or term string, doesn't really matter since this value doesn't really get
+	 *                              used for anything yet
+	 * @return string
+	 */
+	public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
+	{
+		if (! empty($join_terms)) {
+			global $wpdb;
+			$SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
+			$SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
+			$SQL .= " LEFT JOIN $wpdb->terms ON ($wpdb->terms.term_id = $wpdb->term_taxonomy.term_id) ";
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * usage:  $SQL .= EEH_Event_Query::posts_join_for_orderby( $orderby_params );
+	 *
+	 * @param string $SQL
+	 * @param array  $orderby_params
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join_for_orderby($SQL = '', array $orderby_params = [])
+	{
+		foreach ($orderby_params as $orderby) {
+			switch ($orderby) {
+				case 'ticket_start':
+				case 'ticket_end':
+					$SQL .= EEH_Event_Query::_posts_join_for_datetime(
+						$SQL,
+						EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
+					);
+					$SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
+					$SQL .= ' ON (';
+					$SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+					$SQL .= ' = ';
+					$SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+					$SQL .= ' )';
+					break;
+				case 'venue_title':
+				case 'city':
+					$SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
+					break;
+				case 'state':
+					$SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
+					$SQL .= EEH_Event_Query::_posts_join_for_venue_state($SQL);
+					break;
+				case 'start_date':
+				default:
+					$SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
+					break;
+			}
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string $SQL
+	 * @param string $join
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_datetime($SQL = '', $join = '')
+	{
+		if (! empty($join)) {
+			$join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+			if (strpos($SQL, $join) === false) {
+				return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * @param string $SQL
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_event_venue($SQL = '')
+	{
+		// Event Venue table name
+		$event_venue_table = EEM_Event_Venue::instance()->table();
+		// generate conditions for:  Event <=> Event Venue  JOIN clause
+		$event_to_event_venue_join = EEM_Event::instance()->table() . '.ID = ';
+		$event_to_event_venue_join .= $event_venue_table . '.' . EEM_Event::instance()->primary_key_name();
+		// don't add joins if they have already been added
+		if (strpos($SQL, $event_to_event_venue_join) === false) {
+			// Venue table name
+			$venue_table = EEM_Venue::instance()->table();
+			// Venue table pk
+			$venue_table_pk = EEM_Venue::instance()->primary_key_name();
+			// Venue Meta table name
+			$venue_meta_table = EEM_Venue::instance()->second_table();
+			// generate JOIN clause for: Event <=> Event Venue
+			$venue_SQL = " LEFT JOIN $event_venue_table ON ( $event_to_event_venue_join )";
+			// generate JOIN clause for: Event Venue <=> Venue
+			$venue_SQL .= " LEFT JOIN $venue_table as Venue ON ( $event_venue_table.$venue_table_pk = Venue.ID )";
+			// generate JOIN clause for: Venue <=> Venue Meta
+			$venue_SQL .= " LEFT JOIN $venue_meta_table ON ( Venue.ID = $venue_meta_table.$venue_table_pk )";
+			unset($event_venue_table, $event_to_event_venue_join, $venue_table, $venue_table_pk, $venue_meta_table);
+			return $venue_SQL;
+		}
+		unset($event_venue_table, $event_to_event_venue_join);
+		return '';
+	}
+
+
+	/**
+	 * @param string $SQL
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_venue_state($SQL = '')
+	{
+		// Venue Meta table name
+		$venue_meta_table = EEM_Venue::instance()->second_table();
+		// State table name
+		$state_table = EEM_State::instance()->table();
+		// State table pk
+		$state_table_pk = EEM_State::instance()->primary_key_name();
+		// verify vars
+		if ($venue_meta_table && $state_table && $state_table_pk) {
+			// like: wp_esp_venue_meta.STA_ID = wp_esp_state.STA_ID
+			$join = "$venue_meta_table.$state_table_pk = $state_table.$state_table_pk";
+			// don't add join if it has already been added
+			if (strpos($SQL, $join) === false) {
+				unset($state_table_pk, $venue_meta_table, $venue_table_pk);
+				return " LEFT JOIN $state_table ON ( $join )";
+			}
+		}
+		unset($join, $state_table, $state_table_pk, $venue_meta_table, $venue_table_pk);
+		return '';
+	}
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where($SQL, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// Show Expired ?
+			$SQL .= EEH_Event_Query::posts_where_sql_for_show_expired(EEH_Event_Query::$_event_query_show_expired);
+			// Category
+			$SQL .= EEH_Event_Query::posts_where_sql_for_event_category_slug(EEH_Event_Query::$_event_query_category);
+			// Start Date
+			$SQL .= EEH_Event_Query::posts_where_sql_for_event_list_month(EEH_Event_Query::$_event_query_month);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param boolean $show_expired if TRUE, then displayed past events
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where_sql_for_show_expired($show_expired = false)
+	{
+		return ! $show_expired
+			? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
+			: '';
+	}
+
+
+	/**
+	 * @param boolean $event_category_slug
+	 * @return string
+	 */
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
+	{
+		global $wpdb;
+		if (! empty($event_category_slug)) {
+			$event_category_slugs_array   = array_map('trim', explode(',', $event_category_slug));
+			$event_category_slugs_prepare = implode(', ', array_fill(0, count($event_category_slugs_array), '%s'));
+			return $wpdb->prepare(
+				" AND {$wpdb->terms}.slug IN ({$event_category_slugs_prepare}) ",
+				$event_category_slugs_array
+			);
+		}
+		return '';
+	}
+
+
+	/**
+	 * @param boolean $month
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where_sql_for_event_list_month($month = null)
+	{
+		$SQL = '';
+		if (! empty($month)) {
+			$datetime_table = EEM_Datetime::instance()->table();
+			// event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
+			$SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
+			$SQL .= date('Y-m-t 23:59:59', EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
+			// event end date is GREATER than the start of the month ( so nothing that ended before this month )
+			$SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
+			$SQL .= date('Y-m-01 0:0:00', EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			$SQL = EEH_Event_Query::posts_orderby_sql(
+				EEH_Event_Query::$_event_query_orderby,
+				EEH_Event_Query::$_event_query_sort
+			);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    posts_orderby_sql
+	 *    possible parameters:
+	 *    ID
+	 *    start_date
+	 *    end_date
+	 *    event_name
+	 *    category_slug
+	 *    ticket_start
+	 *    ticket_end
+	 *    venue_title
+	 *    city
+	 *    state
+	 *    **IMPORTANT**
+	 *    make sure to also send the $orderby_params array to the posts_join_for_orderby() method
+	 *    or else some of the table references below will result in MySQL errors
+	 *
+	 * @param array  $orderby_params
+	 * @param string $sort
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_orderby_sql(array $orderby_params = [], $sort = 'ASC')
+	{
+		global $wpdb;
+		$SQL     = '';
+		$counter = 0;
+		$sort    = in_array($sort, ['ASC', 'asc', 'DESC', 'desc'], true)
+			? strtoupper($sort)
+			: 'ASC';
+		// make sure 'orderby' is set in query params
+		if (! isset(self::$_query_params['orderby'])) {
+			self::$_query_params['orderby'] = [];
+		}
+		// loop thru $orderby_params (type cast as array)
+		foreach ($orderby_params as $orderby) {
+			// check if we have already added this param
+			if (isset(self::$_query_params['orderby'][ $orderby ])) {
+				// if so then remove from the $orderby_params so that the count() method below is accurate
+				unset($orderby_params[ $orderby ]);
+				// then bump ahead to the next param
+				continue;
+			}
+			// this will ad a comma depending on whether this is the first or last param
+			$glue = $counter === 0 || $counter === count($orderby_params) ? ' ' : ', ';
+			// ok what's we dealing with?
+			switch ($orderby) {
+				case 'id':
+				case 'ID':
+					$SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+					break;
+				case 'end_date':
+					$SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+					break;
+				case 'event_name':
+					$SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+					break;
+				case 'category_slug':
+					$SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+					break;
+				case 'ticket_start':
+					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+					break;
+				case 'ticket_end':
+					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+					break;
+				case 'venue_title':
+					$SQL .= $glue . 'venue_title ' . $sort;
+					break;
+				case 'city':
+					$SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+					break;
+				case 'state':
+					$SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+					break;
+				case 'start_date':
+				default:
+					$SQL .= $glue . ' event_start_date ' . $sort;
+					break;
+			}
+			// add to array of orderby params that have been added
+			self::$_query_params['orderby'][ $orderby ] = true;
+			$counter++;
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 * @since   4.10.14.p
+	 */
+	private static function getRequest()
+	{
+		return LoaderFactory::getLoader()->getShared(RequestInterface::class);
+	}
 }

core/EE_Session.core.php

Spacing +53 added lines, -53 removed lines

@@ -246,22 +246,22 @@ 
         // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
         // (which currently fires on the init hook at priority 9),
         // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! apply_filters('FHEE_load_EE_Session', true)) {
             return;
         }
         $this->session_start_handler = $session_start_handler;
         $this->session_lifespan = $lifespan;
         $this->request = $request;
-        if (! defined('ESPRESSO_SESSION')) {
+        if ( ! defined('ESPRESSO_SESSION')) {
             define('ESPRESSO_SESSION', true);
         }
         // retrieve session options from db
         $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
+        if ( ! empty($session_settings)) {
             // cycle though existing session options
             foreach ($session_settings as $var_name => $session_setting) {
                 // set values for class properties
-                $var_name = '_' . $var_name;
+                $var_name = '_'.$var_name;
                 $this->{$var_name} = $session_setting;
             }
         }
@@ -322,7 +322,7 @@ 
     public function open_session()
     {
         // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
+        if ( ! $this->_espresso_session()) {
             // or just start a new one
             $this->_create_espresso_session();
         }
@@ -399,7 +399,7 @@ 
             EE_Session::SAVE_STATE_CLEAN,
             EE_Session::SAVE_STATE_DIRTY,
         ];
-        if (! in_array($save_state, $valid_save_states, true)) {
+        if ( ! in_array($save_state, $valid_save_states, true)) {
             $save_state = EE_Session::SAVE_STATE_DIRTY;
         }
         $this->save_state = $save_state;
@@ -417,9 +417,9 @@ 
         // set some defaults
         foreach ($this->_default_session_vars as $key => $default_var) {
             if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
+                $this->_session_data[$key] = array();
             } else {
-                $this->_session_data[ $key ] = '';
+                $this->_session_data[$key] = '';
             }
         }
     }
@@ -555,8 +555,8 @@ 
             $this->reset_checkout();
             $this->reset_transaction();
         }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+        if ( ! empty($key)) {
+            return isset($this->_session_data[$key]) ? $this->_session_data[$key] : null;
         }
         return $this->_session_data;
     }
@@ -584,7 +584,7 @@ 
             return false;
         }
         foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
+            if (isset($this->_default_session_vars[$key])) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -599,7 +599,7 @@ 
                 );
                 return false;
             }
-            $this->_session_data[ $key ] = $value;
+            $this->_session_data[$key] = $value;
             $this->setSaveState();
         }
         return true;
@@ -630,7 +630,7 @@ 
         $this->_user_agent = $this->request->userAgent();
         // now let's retrieve what's in the db
         $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
+        if ( ! empty($session_data)) {
             // get the current time in UTC
             $this->_time = $this->_time !== null ? $this->_time : time();
             // and reset the session expiration
@@ -641,7 +641,7 @@ 
             // set initial site access time and the session expiration
             $this->_set_init_access_and_expiration();
             // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = esc_attr(
+            $this->_session_data['pages_visited'][$this->_session_data['init_access']] = esc_attr(
                 $this->request->getServerParam('HTTP_REFERER')
             );
             // no previous session = go back and create one (on top of the data above)
@@ -679,7 +679,7 @@ 
      */
     protected function _retrieve_session_data()
     {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+        $ssn_key = EE_Session::session_id_prefix.$this->_sid;
         try {
             // we're using WP's Transient API to store session data using the PHP session ID as the option name
             $session_data = $this->cache_storage->get($ssn_key, false);
@@ -688,7 +688,7 @@ 
             }
             if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
                 $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
+                    EE_Session::hash_check_prefix.$this->_sid,
                     false
                 );
                 if ($hash_check && $hash_check !== md5($session_data)) {
@@ -698,7 +698,7 @@ 
                                 'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
                                 'event_espresso'
                             ),
-                            EE_Session::session_id_prefix . $this->_sid
+                            EE_Session::session_id_prefix.$this->_sid
                         ),
                         __FILE__,
                         __FUNCTION__,
@@ -712,17 +712,17 @@ 
             $row = $wpdb->get_row(
                 $wpdb->prepare(
                     "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
+                    '_transient_'.$ssn_key
                 )
             );
             $session_data = is_object($row) ? $row->option_value : null;
             if ($session_data) {
                 $session_data = preg_replace_callback(
                     '!s:(d+):"(.*?)";!',
-                    function ($match) {
+                    function($match) {
                         return $match[1] === strlen($match[2])
                             ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                            : 's:'.strlen($match[2]).':"'.$match[2].'";';
                     },
                     $session_data
                 );
@@ -733,7 +733,7 @@ 
         $session_data = $this->encryption instanceof EE_Encryption
             ? $this->encryption->base64_string_decode($session_data)
             : $session_data;
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             try {
                 $session_data = maybe_unserialize($session_data);
             } catch (Exception $e) {
@@ -747,21 +747,21 @@ 
                       . '</pre><br>'
                       . $this->find_serialize_error($session_data)
                     : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+                $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
                 throw new InvalidSessionDataException($msg, 0, $e);
             }
         }
         // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             // no?!?! then something is wrong
             $msg = esc_html__(
                 'The session data is missing, invalid, or corrupted.',
                 'event_espresso'
             );
             $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                 : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+            $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
             throw new InvalidSessionDataException($msg);
         }
         if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
@@ -787,7 +787,7 @@ 
         // check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
         $session_id = $this->request->requestParamIsSet('EESID')
             ? $this->request->getRequestParam('EESID')
-            : md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+            : md5(session_id().get_current_blog_id().$this->_get_sid_salt());
         return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
     }
 
@@ -889,19 +889,19 @@ 
                     $page_visit = $this->_get_page_visit();
                     if ($page_visit) {
                         // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+                        $this->_session_data['pages_visited'][$this->_time] = $page_visit;
                         // we'll only save the last 10 page visits.
                         $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
                     }
                     break;
                 default:
                     // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
+                    $session_data[$key] = $this->_session_data[$key];
             }
         }
         $this->_session_data = $session_data;
         // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
+        if ( ! $new_session) {
             // ready? let's save
             if ($this->_save_session_to_db()) {
                 return true;
@@ -979,7 +979,7 @@ 
         }
         $transaction = $this->transaction();
         if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
+            if ( ! $transaction->ID()) {
                 $transaction->save();
             }
             $this->_session_data['transaction'] = $transaction->ID();
@@ -993,14 +993,14 @@ 
         // maybe save hash check
         if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
             $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
+                EE_Session::hash_check_prefix.$this->_sid,
                 md5($session_data),
                 $this->session_lifespan->inSeconds()
             );
         }
         // we're using the Transient API for storing session data,
         $saved = $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->session_lifespan->inSeconds()
         );
@@ -1015,7 +1015,7 @@ 
      */
     public function _get_page_visit()
     {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+        $page_visit = home_url('/').'wp-admin/admin-ajax.php';
         // check for request url
         if ($this->request->serverParamIsSet('REQUEST_URI')) {
             $page_id = '?';
@@ -1027,14 +1027,14 @@ 
             // check for page_id in SERVER REQUEST
             if ($this->request->requestParamIsSet('page_id')) {
                 // rebuild $e_reg without any of the extra parameters
-                $page_id .= 'page_id=' . $this->request->getRequestParam('page_id', 0, 'int') . '&amp;';
+                $page_id .= 'page_id='.$this->request->getRequestParam('page_id', 0, 'int').'&amp;';
             }
             // check for $e_reg in SERVER REQUEST
             if ($this->request->requestParamIsSet('ee')) {
                 // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . $this->request->getRequestParam('ee');
+                $e_reg = 'ee='.$this->request->getRequestParam('ee');
             }
-            $page_visit = esc_url(rtrim($http_host . $request_uri . $page_id . $e_reg, '?'));
+            $page_visit = esc_url(rtrim($http_host.$request_uri.$page_id.$e_reg, '?'));
         }
         return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
     }
@@ -1071,7 +1071,7 @@ 
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
         $this->reset_cart();
         $this->reset_checkout();
         $this->reset_transaction();
@@ -1094,7 +1094,7 @@ 
     public function reset_data($data_to_reset = array(), $show_all_notices = false)
     {
         // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
+        if ( ! is_array($data_to_reset)) {
             $data_to_reset = array($data_to_reset);
         }
         // nothing ??? go home!
@@ -1114,11 +1114,11 @@ 
         // since $data_to_reset is an array, cycle through the values
         foreach ($data_to_reset as $reset) {
             // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
+            if (isset($this->_session_data[$reset])) {
                 // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
+                if ( ! array_key_exists($reset, $this->_default_session_vars)) {
                     // remove session var
-                    unset($this->_session_data[ $reset ]);
+                    unset($this->_session_data[$reset]);
                     $this->setSaveState();
                     if ($show_all_notices) {
                         EE_Error::add_success(
@@ -1221,7 +1221,7 @@ 
             // or use that for the new transient cleanup query limit
             add_filter(
                 'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
+                function() use ($expired_session_transient_delete_query_limit) {
                     return $expired_session_transient_delete_query_limit;
                 }
             );
@@ -1239,7 +1239,7 @@ 
         $error = '<pre>';
         $data2 = preg_replace_callback(
             '!s:(\d+):"(.*?)";!',
-            function ($match) {
+            function($match) {
                 return ($match[1] === strlen($match[2]))
                     ? $match[0]
                     : 's:'
@@ -1251,13 +1251,13 @@ 
             $data1
         );
         $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
+        $error .= $data1.PHP_EOL;
+        $error .= $data2.PHP_EOL;
         for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error .= "\t-> Line Number = $i" . PHP_EOL;
+            if (@$data1[$i] !== @$data2[$i]) {
+                $error .= 'Difference '.@$data1[$i].' != '.@$data2[$i].PHP_EOL;
+                $error .= "\t-> ORD number ".ord(@$data1[$i]).' != '.ord(@$data2[$i]).PHP_EOL;
+                $error .= "\t-> Line Number = $i".PHP_EOL;
                 $start = ($i - 20);
                 $start = ($start < 0) ? 0 : $start;
                 $length = 40;
@@ -1272,7 +1272,7 @@ 
                 $error .= "\t-> Section Data1  = ";
                 $error .= substr_replace(
                     substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
+                    "<b style=\"color:green\">{$data1[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1280,7 +1280,7 @@ 
                 $error .= "\t-> Section Data2  = ";
                 $error .= substr_replace(
                     substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
+                    "<b style=\"color:red\">{$data2[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1311,7 +1311,7 @@ 
     public function garbageCollection()
     {
         // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
             $this->_last_gc = time();
             $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
             /** @type WPDB $wpdb */
@@ -1346,7 +1346,7 @@ 
                 // AND option_value < 1508368198 LIMIT 50
                 $expired_sessions = $wpdb->get_col($SQL);
                 // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+                if ( ! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
                     $this->cache_storage->deleteMany($expired_sessions, true);
                 }
             }

Indentation +1312 added lines, -1312 removed lines

@@ -23,1310 +23,1310 @@ 
  */
 class EE_Session implements SessionIdentifierInterface
 {
-    const session_id_prefix = 'ee_ssn_';
-
-    const hash_check_prefix = 'ee_shc_';
-
-    const OPTION_NAME_SETTINGS = 'ee_session_settings';
-
-    const STATUS_CLOSED = 0;
-
-    const STATUS_OPEN = 1;
-
-    const SAVE_STATE_CLEAN = 'clean';
-    const SAVE_STATE_DIRTY = 'dirty';
-
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @var EE_Session
-     */
-    private static $_instance;
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    protected $cache_storage;
-
-    /**
-     * @var EE_Encryption $encryption
-     */
-    protected $encryption;
-
-    /**
-     * @var SessionStartHandler $session_start_handler
-     */
-    protected $session_start_handler;
-
-    /**
-     * the session id
-     *
-     * @var string
-     */
-    private $_sid;
-
-    /**
-     * session id salt
-     *
-     * @var string
-     */
-    private $_sid_salt;
-
-    /**
-     * session data
-     *
-     * @var array
-     */
-    private $_session_data = array();
-
-    /**
-     * how long an EE session lasts
-     * default session lifespan of 1 hour (for not so instant IPNs)
-     *
-     * @var SessionLifespan $session_lifespan
-     */
-    private $session_lifespan;
-
-    /**
-     * session expiration time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_expiration;
-
-    /**
-     * whether or not session has expired at some point
-     *
-     * @var boolean
-     */
-    private $_expired = false;
-
-    /**
-     * current time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_time;
-
-    /**
-     * whether to encrypt session data
-     *
-     * @var bool
-     */
-    private $_use_encryption;
-
-    /**
-     * well... according to the server...
-     *
-     * @var null
-     */
-    private $_user_agent;
-
-    /**
-     * do you really trust the server ?
-     *
-     * @var null
-     */
-    private $_ip_address;
-
-    /**
-     * current WP user_id
-     *
-     * @var null
-     */
-    private $_wp_user_id;
-
-    /**
-     * array for defining default session vars
-     *
-     * @var array
-     */
-    private $_default_session_vars = array(
-        'id'            => null,
-        'user_id'       => null,
-        'ip_address'    => null,
-        'user_agent'    => null,
-        'init_access'   => null,
-        'last_access'   => null,
-        'expiration'    => null,
-        'pages_visited' => array(),
-    );
-
-    /**
-     * timestamp for when last garbage collection cycle was performed
-     *
-     * @var int $_last_gc
-     */
-    private $_last_gc;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * whether session is active or not
-     *
-     * @var int $status
-     */
-    private $status = EE_Session::STATUS_CLOSED;
-
-    /**
-     * whether session data has changed therefore requiring a session save
-     *
-     * @var string $save_state
-     */
-    private $save_state = EE_Session::SAVE_STATE_CLEAN;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan|null  $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param EE_Encryption         $encryption
-     * @return EE_Session
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instance(
-        CacheStorageInterface $cache_storage = null,
-        SessionLifespan $lifespan = null,
-        RequestInterface $request = null,
-        SessionStartHandler $session_start_handler = null,
-        EE_Encryption $encryption = null
-    ) {
-        // check if class object is instantiated
-        // session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
-        // add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (
-            ! self::$_instance instanceof EE_Session
-            && $cache_storage instanceof CacheStorageInterface
-            && $lifespan instanceof SessionLifespan
-            && $request instanceof RequestInterface
-            && $session_start_handler instanceof SessionStartHandler
-            && apply_filters('FHEE_load_EE_Session', true)
-        ) {
-            self::$_instance = new self(
-                $cache_storage,
-                $lifespan,
-                $request,
-                $session_start_handler,
-                $encryption
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan       $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param EE_Encryption         $encryption
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function __construct(
-        CacheStorageInterface $cache_storage,
-        SessionLifespan $lifespan,
-        RequestInterface $request,
-        SessionStartHandler $session_start_handler,
-        EE_Encryption $encryption = null
-    ) {
-        // session loading is turned ON by default,
-        // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
-        // (which currently fires on the init hook at priority 9),
-        // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
-            return;
-        }
-        $this->session_start_handler = $session_start_handler;
-        $this->session_lifespan = $lifespan;
-        $this->request = $request;
-        if (! defined('ESPRESSO_SESSION')) {
-            define('ESPRESSO_SESSION', true);
-        }
-        // retrieve session options from db
-        $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
-            // cycle though existing session options
-            foreach ($session_settings as $var_name => $session_setting) {
-                // set values for class properties
-                $var_name = '_' . $var_name;
-                $this->{$var_name} = $session_setting;
-            }
-        }
-        $this->cache_storage = $cache_storage;
-        // are we using encryption?
-        $this->_use_encryption = $encryption instanceof EE_Encryption
-                                 && EE_Registry::instance()->CFG->admin->encode_session_data();
-        // encrypt data via: $this->encryption->encrypt();
-        $this->encryption = $encryption;
-        // filter hook allows outside functions/classes/plugins to change default empty cart
-        $extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
-        array_merge($this->_default_session_vars, $extra_default_session_vars);
-        // apply default session vars
-        $this->_set_defaults();
-        add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
-        // check request for 'clear_session' param
-        add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
-        // once everything is all said and done,
-        add_action('shutdown', array($this, 'update'), 100);
-        add_action('shutdown', array($this, 'garbageCollection'), 1000);
-        $this->configure_garbage_collection_filters();
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function isLoadedAndActive()
-    {
-        return did_action('AHEE__EE_System__core_loaded_and_ready')
-               && EE_Session::instance() instanceof EE_Session
-               && EE_Session::instance()->isActive();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActive()
-    {
-        return $this->status === EE_Session::STATUS_OPEN;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function open_session()
-    {
-        // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
-            // or just start a new one
-            $this->_create_espresso_session();
-        }
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function expired()
-    {
-        return $this->_expired;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function reset_expired()
-    {
-        $this->_expired = false;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function expiration()
-    {
-        return $this->_expiration;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function extension()
-    {
-        return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
-    }
-
-
-    /**
-     * @param int $time number of seconds to add to session expiration
-     */
-    public function extend_expiration($time = 0)
-    {
-        $time = $time ? $time : $this->extension();
-        $this->_expiration += absint($time);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function lifespan()
-    {
-        return $this->session_lifespan->inSeconds();
-    }
-
-
-    /**
-     * Marks whether the session data has been updated or not.
-     * Valid options are:
-     *      EE_Session::SAVE_STATE_CLEAN - session data remains unchanged and updating is not necessary
-     *      EE_Session::SAVE_STATE_DIRTY - session data has changed since last save and needs to be updated
-     * default value is EE_Session::SAVE_STATE_DIRTY
-     *
-     * @param string $save_state
-     */
-    public function setSaveState($save_state = EE_Session::SAVE_STATE_DIRTY)
-    {
-        $valid_save_states = [
-            EE_Session::SAVE_STATE_CLEAN,
-            EE_Session::SAVE_STATE_DIRTY,
-        ];
-        if (! in_array($save_state, $valid_save_states, true)) {
-            $save_state = EE_Session::SAVE_STATE_DIRTY;
-        }
-        $this->save_state = $save_state;
-    }
-
-
-
-    /**
-     * This just sets some defaults for the _session data property
-     *
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        // set some defaults
-        foreach ($this->_default_session_vars as $key => $default_var) {
-            if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
-            } else {
-                $this->_session_data[ $key ] = '';
-            }
-        }
-    }
-
-
-    /**
-     * @retrieve  session data
-     * @return    string
-     */
-    public function id()
-    {
-        return $this->_sid;
-    }
-
-
-    /**
-     * @param \EE_Cart $cart
-     * @return bool
-     */
-    public function set_cart(EE_Cart $cart)
-    {
-        $this->_session_data['cart'] = $cart;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_cart
-     */
-    public function reset_cart()
-    {
-        do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
-        $this->_session_data['cart'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return \EE_Cart
-     */
-    public function cart()
-    {
-        return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
-            ? $this->_session_data['cart']
-            : null;
-    }
-
-
-    /**
-     * @param \EE_Checkout $checkout
-     * @return bool
-     */
-    public function set_checkout(EE_Checkout $checkout)
-    {
-        $this->_session_data['checkout'] = $checkout;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_checkout
-     */
-    public function reset_checkout()
-    {
-        do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
-        $this->_session_data['checkout'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return \EE_Checkout
-     */
-    public function checkout()
-    {
-        return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
-            ? $this->_session_data['checkout']
-            : null;
-    }
-
-
-    /**
-     * @param \EE_Transaction $transaction
-     * @return bool
-     * @throws EE_Error
-     */
-    public function set_transaction(EE_Transaction $transaction)
-    {
-        // first remove the session from the transaction before we save the transaction in the session
-        $transaction->set_txn_session_data(null);
-        $this->_session_data['transaction'] = $transaction;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_transaction
-     */
-    public function reset_transaction()
-    {
-        do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
-        $this->_session_data['transaction'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return \EE_Transaction
-     */
-    public function transaction()
-    {
-        return isset($this->_session_data['transaction'])
-               && $this->_session_data['transaction'] instanceof EE_Transaction
-            ? $this->_session_data['transaction']
-            : null;
-    }
-
-
-    /**
-     * retrieve session data
-     *
-     * @param null $key
-     * @param bool $reset_cache
-     * @return array
-     */
-    public function get_session_data($key = null, $reset_cache = false)
-    {
-        if ($reset_cache) {
-            $this->reset_cart();
-            $this->reset_checkout();
-            $this->reset_transaction();
-        }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
-        }
-        return $this->_session_data;
-    }
-
-
-    /**
-     * Returns TRUE on success, FALSE on fail
-     *
-     * @param array $data
-     * @return bool
-     */
-    public function set_session_data($data)
-    {
-        // nothing ??? bad data ??? go home!
-        if (empty($data) || ! is_array($data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data or invalid session data was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Sorry! %s is a default session datum and can not be reset.',
-                            'event_espresso'
-                        ),
-                        $key
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $this->_session_data[ $key ] = $value;
-            $this->setSaveState();
-        }
-        return true;
-    }
-
-
-    /**
-     * @initiate session
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    private function _espresso_session()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->session_start_handler->startSession();
-        $this->status = EE_Session::STATUS_OPEN;
-        // get our modified session ID
-        $this->_sid = $this->_generate_session_id();
-        // and the visitors IP
-        $this->_ip_address = $this->request->ipAddress();
-        // set the "user agent"
-        $this->_user_agent = $this->request->userAgent();
-        // now let's retrieve what's in the db
-        $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
-            // get the current time in UTC
-            $this->_time = $this->_time !== null ? $this->_time : time();
-            // and reset the session expiration
-            $this->_expiration = isset($session_data['expiration'])
-                ? $session_data['expiration']
-                : $this->_time + $this->session_lifespan->inSeconds();
-        } else {
-            // set initial site access time and the session expiration
-            $this->_set_init_access_and_expiration();
-            // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = esc_attr(
-                $this->request->getServerParam('HTTP_REFERER')
-            );
-            // no previous session = go back and create one (on top of the data above)
-            return false;
-        }
-        // now the user agent
-        if ($session_data['user_agent'] !== $this->_user_agent) {
-            return false;
-        }
-        // wait a minute... how old are you?
-        if ($this->_time > $this->_expiration) {
-            // yer too old fer me!
-            $this->_expired = true;
-            // wipe out everything that isn't a default session datum
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // make event espresso session data available to plugin
-        $this->_session_data = array_merge($this->_session_data, $session_data);
-        return true;
-    }
-
-
-    /**
-     * _get_session_data
-     * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
-     * databases
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidSessionDataException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    protected function _retrieve_session_data()
-    {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
-        try {
-            // we're using WP's Transient API to store session data using the PHP session ID as the option name
-            $session_data = $this->cache_storage->get($ssn_key, false);
-            if (empty($session_data)) {
-                return array();
-            }
-            if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-                $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
-                    false
-                );
-                if ($hash_check && $hash_check !== md5($session_data)) {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
-                                'event_espresso'
-                            ),
-                            EE_Session::session_id_prefix . $this->_sid
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        } catch (Exception $e) {
-            // let's just eat that error for now and attempt to correct any corrupted data
-            global $wpdb;
-            $row = $wpdb->get_row(
-                $wpdb->prepare(
-                    "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
-                )
-            );
-            $session_data = is_object($row) ? $row->option_value : null;
-            if ($session_data) {
-                $session_data = preg_replace_callback(
-                    '!s:(d+):"(.*?)";!',
-                    function ($match) {
-                        return $match[1] === strlen($match[2])
-                            ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
-                    },
-                    $session_data
-                );
-            }
-            $session_data = maybe_unserialize($session_data);
-        }
-        // in case the data is encoded... try to decode it
-        $session_data = $this->encryption instanceof EE_Encryption
-            ? $this->encryption->base64_string_decode($session_data)
-            : $session_data;
-        if (! is_array($session_data)) {
-            try {
-                $session_data = maybe_unserialize($session_data);
-            } catch (Exception $e) {
-                $msg = esc_html__(
-                    'An error occurred while attempting to unserialize the session data.',
-                    'event_espresso'
-                );
-                $msg .= WP_DEBUG
-                    ? '<br><pre>'
-                      . print_r($session_data, true)
-                      . '</pre><br>'
-                      . $this->find_serialize_error($session_data)
-                    : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-                throw new InvalidSessionDataException($msg, 0, $e);
-            }
-        }
-        // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
-            // no?!?! then something is wrong
-            $msg = esc_html__(
-                'The session data is missing, invalid, or corrupted.',
-                'event_espresso'
-            );
-            $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
-                : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-            throw new InvalidSessionDataException($msg);
-        }
-        if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
-            $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
-                $session_data['transaction']
-            );
-        }
-        return $session_data;
-    }
-
-
-    /**
-     * _generate_session_id
-     * Retrieves the PHP session id either directly from the PHP session,
-     * or from the request array if it was passed in from an AJAX request.
-     * The session id is then salted and hashed (mmm sounds tasty)
-     * so that it can be safely used as a request param
-     *
-     * @return string
-     */
-    protected function _generate_session_id()
-    {
-        // check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
-        $session_id = $this->request->requestParamIsSet('EESID')
-            ? $this->request->getRequestParam('EESID')
-            : md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
-        return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
-    }
-
-
-    /**
-     * _get_sid_salt
-     *
-     * @return string
-     */
-    protected function _get_sid_salt()
-    {
-        // was session id salt already saved to db ?
-        if (empty($this->_sid_salt)) {
-            // no?  then maybe use WP defined constant
-            if (defined('AUTH_SALT')) {
-                $this->_sid_salt = AUTH_SALT;
-            }
-            // if salt doesn't exist or is too short
-            if (strlen($this->_sid_salt) < 32) {
-                // create a new one
-                $this->_sid_salt = wp_generate_password(64);
-            }
-            // and save it as a permanent session setting
-            $this->updateSessionSettings(array('sid_salt' => $this->_sid_salt));
-        }
-        return $this->_sid_salt;
-    }
-
-
-    /**
-     * _set_init_access_and_expiration
-     *
-     * @return void
-     */
-    protected function _set_init_access_and_expiration()
-    {
-        $this->_time = time();
-        $this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
-        // set initial site access time
-        $this->_session_data['init_access'] = $this->_time;
-        // and the session expiration
-        $this->_session_data['expiration'] = $this->_expiration;
-    }
-
-
-    /**
-     * @update session data  prior to saving to the db
-     * @param bool $new_session
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function update($new_session = false)
-    {
-        $this->_session_data = is_array($this->_session_data) && isset($this->_session_data['id'])
-            ? $this->_session_data
-            : array();
-        if (empty($this->_session_data)) {
-            $this->_set_defaults();
-        }
-        $session_data = array();
-        foreach ($this->_session_data as $key => $value) {
-            switch ($key) {
-                case 'id':
-                    // session ID
-                    $session_data['id'] = $this->_sid;
-                    break;
-                case 'ip_address':
-                    // visitor ip address
-                    $session_data['ip_address'] = $this->request->ipAddress();
-                    break;
-                case 'user_agent':
-                    // visitor user_agent
-                    $session_data['user_agent'] = $this->_user_agent;
-                    break;
-                case 'init_access':
-                    $session_data['init_access'] = absint($value);
-                    break;
-                case 'last_access':
-                    // current access time
-                    $session_data['last_access'] = $this->_time;
-                    break;
-                case 'expiration':
-                    // when the session expires
-                    $session_data['expiration'] = ! empty($this->_expiration)
-                        ? $this->_expiration
-                        : $session_data['init_access'] + $this->session_lifespan->inSeconds();
-                    break;
-                case 'user_id':
-                    // current user if logged in
-                    $session_data['user_id'] = $this->_wp_user_id();
-                    break;
-                case 'pages_visited':
-                    $page_visit = $this->_get_page_visit();
-                    if ($page_visit) {
-                        // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
-                        // we'll only save the last 10 page visits.
-                        $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
-                    }
-                    break;
-                default:
-                    // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
-            }
-        }
-        $this->_session_data = $session_data;
-        // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
-            // ready? let's save
-            if ($this->_save_session_to_db()) {
-                return true;
-            }
-            return false;
-        }
-        // meh, why not?
-        return true;
-    }
-
-
-    /**
-     * @create session data array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _create_espresso_session()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
-        // use the update function for now with $new_session arg set to TRUE
-        $this->update(true);
-    }
-
-    /**
-     * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
-     * too). This is used when determining if we want to save the session or not.
-     * @since 4.9.67.p
-     * @return bool
-     */
-    private function sessionHasStuffWorthSaving()
-    {
-        return $this->save_state === EE_Session::SAVE_STATE_DIRTY
-               // we may want to eventually remove the following
-               // on the assumption that the above check is enough
-               || $this->cart() instanceof EE_Cart
-               || (
-                   isset($this->_session_data['ee_notices'])
-                   && (
-                       ! empty($this->_session_data['ee_notices']['attention'])
-                       || ! empty($this->_session_data['ee_notices']['errors'])
-                       || ! empty($this->_session_data['ee_notices']['success'])
-                   )
-               );
-    }
-
-
-    /**
-     * _save_session_to_db
-     *
-     * @param bool $clear_session
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _save_session_to_db($clear_session = false)
-    {
-        // don't save sessions for crawlers
-        // and unless we're deleting the session data, don't save anything if there isn't a cart
-        if (
-            $this->request->isBot()
-            || (
-                ! $clear_session
-                && ! $this->sessionHasStuffWorthSaving()
-                && apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
-            )
-        ) {
-            return false;
-        }
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
-                $transaction->save();
-            }
-            $this->_session_data['transaction'] = $transaction->ID();
-        }
-        // then serialize all of our session data
-        $session_data = serialize($this->_session_data);
-        // do we need to also encode it to avoid corrupted data when saved to the db?
-        $session_data = $this->_use_encryption
-            ? $this->encryption->base64_string_encode($session_data)
-            : $session_data;
-        // maybe save hash check
-        if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-            $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
-                md5($session_data),
-                $this->session_lifespan->inSeconds()
-            );
-        }
-        // we're using the Transient API for storing session data,
-        $saved = $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
-            $session_data,
-            $this->session_lifespan->inSeconds()
-        );
-        $this->setSaveState(EE_Session::SAVE_STATE_CLEAN);
-        return $saved;
-    }
-
-
-    /**
-     * @get    the full page request the visitor is accessing
-     * @return string
-     */
-    public function _get_page_visit()
-    {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
-        // check for request url
-        if ($this->request->serverParamIsSet('REQUEST_URI')) {
-            $page_id = '?';
-            $e_reg = '';
-            $request_uri = $this->request->getServerParam('REQUEST_URI');
-            $ru_bits = explode('?', $request_uri);
-            $request_uri = $ru_bits[0];
-            $http_host = $this->request->getServerParam('HTTP_HOST');
-            // check for page_id in SERVER REQUEST
-            if ($this->request->requestParamIsSet('page_id')) {
-                // rebuild $e_reg without any of the extra parameters
-                $page_id .= 'page_id=' . $this->request->getRequestParam('page_id', 0, 'int') . '&amp;';
-            }
-            // check for $e_reg in SERVER REQUEST
-            if ($this->request->requestParamIsSet('ee')) {
-                // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . $this->request->getRequestParam('ee');
-            }
-            $page_visit = esc_url(rtrim($http_host . $request_uri . $page_id . $e_reg, '?'));
-        }
-        return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
-    }
-
-
-    /**
-     * @the    current wp user id
-     * @return int
-     */
-    public function _wp_user_id()
-    {
-        // if I need to explain the following lines of code, then you shouldn't be looking at this!
-        $this->_wp_user_id = get_current_user_id();
-        return $this->_wp_user_id;
-    }
-
-
-    /**
-     * Clear EE_Session data
-     *
-     * @param string $class
-     * @param string $function
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function clear_session($class = '', $function = '')
-    {
+	const session_id_prefix = 'ee_ssn_';
+
+	const hash_check_prefix = 'ee_shc_';
+
+	const OPTION_NAME_SETTINGS = 'ee_session_settings';
+
+	const STATUS_CLOSED = 0;
+
+	const STATUS_OPEN = 1;
+
+	const SAVE_STATE_CLEAN = 'clean';
+	const SAVE_STATE_DIRTY = 'dirty';
+
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @var EE_Session
+	 */
+	private static $_instance;
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	protected $cache_storage;
+
+	/**
+	 * @var EE_Encryption $encryption
+	 */
+	protected $encryption;
+
+	/**
+	 * @var SessionStartHandler $session_start_handler
+	 */
+	protected $session_start_handler;
+
+	/**
+	 * the session id
+	 *
+	 * @var string
+	 */
+	private $_sid;
+
+	/**
+	 * session id salt
+	 *
+	 * @var string
+	 */
+	private $_sid_salt;
+
+	/**
+	 * session data
+	 *
+	 * @var array
+	 */
+	private $_session_data = array();
+
+	/**
+	 * how long an EE session lasts
+	 * default session lifespan of 1 hour (for not so instant IPNs)
+	 *
+	 * @var SessionLifespan $session_lifespan
+	 */
+	private $session_lifespan;
+
+	/**
+	 * session expiration time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_expiration;
+
+	/**
+	 * whether or not session has expired at some point
+	 *
+	 * @var boolean
+	 */
+	private $_expired = false;
+
+	/**
+	 * current time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_time;
+
+	/**
+	 * whether to encrypt session data
+	 *
+	 * @var bool
+	 */
+	private $_use_encryption;
+
+	/**
+	 * well... according to the server...
+	 *
+	 * @var null
+	 */
+	private $_user_agent;
+
+	/**
+	 * do you really trust the server ?
+	 *
+	 * @var null
+	 */
+	private $_ip_address;
+
+	/**
+	 * current WP user_id
+	 *
+	 * @var null
+	 */
+	private $_wp_user_id;
+
+	/**
+	 * array for defining default session vars
+	 *
+	 * @var array
+	 */
+	private $_default_session_vars = array(
+		'id'            => null,
+		'user_id'       => null,
+		'ip_address'    => null,
+		'user_agent'    => null,
+		'init_access'   => null,
+		'last_access'   => null,
+		'expiration'    => null,
+		'pages_visited' => array(),
+	);
+
+	/**
+	 * timestamp for when last garbage collection cycle was performed
+	 *
+	 * @var int $_last_gc
+	 */
+	private $_last_gc;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * whether session is active or not
+	 *
+	 * @var int $status
+	 */
+	private $status = EE_Session::STATUS_CLOSED;
+
+	/**
+	 * whether session data has changed therefore requiring a session save
+	 *
+	 * @var string $save_state
+	 */
+	private $save_state = EE_Session::SAVE_STATE_CLEAN;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan|null  $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param EE_Encryption         $encryption
+	 * @return EE_Session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function instance(
+		CacheStorageInterface $cache_storage = null,
+		SessionLifespan $lifespan = null,
+		RequestInterface $request = null,
+		SessionStartHandler $session_start_handler = null,
+		EE_Encryption $encryption = null
+	) {
+		// check if class object is instantiated
+		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
+		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (
+			! self::$_instance instanceof EE_Session
+			&& $cache_storage instanceof CacheStorageInterface
+			&& $lifespan instanceof SessionLifespan
+			&& $request instanceof RequestInterface
+			&& $session_start_handler instanceof SessionStartHandler
+			&& apply_filters('FHEE_load_EE_Session', true)
+		) {
+			self::$_instance = new self(
+				$cache_storage,
+				$lifespan,
+				$request,
+				$session_start_handler,
+				$encryption
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan       $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param EE_Encryption         $encryption
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function __construct(
+		CacheStorageInterface $cache_storage,
+		SessionLifespan $lifespan,
+		RequestInterface $request,
+		SessionStartHandler $session_start_handler,
+		EE_Encryption $encryption = null
+	) {
+		// session loading is turned ON by default,
+		// but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
+		// (which currently fires on the init hook at priority 9),
+		// can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! apply_filters('FHEE_load_EE_Session', true)) {
+			return;
+		}
+		$this->session_start_handler = $session_start_handler;
+		$this->session_lifespan = $lifespan;
+		$this->request = $request;
+		if (! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
+		}
+		// retrieve session options from db
+		$session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		if (! empty($session_settings)) {
+			// cycle though existing session options
+			foreach ($session_settings as $var_name => $session_setting) {
+				// set values for class properties
+				$var_name = '_' . $var_name;
+				$this->{$var_name} = $session_setting;
+			}
+		}
+		$this->cache_storage = $cache_storage;
+		// are we using encryption?
+		$this->_use_encryption = $encryption instanceof EE_Encryption
+								 && EE_Registry::instance()->CFG->admin->encode_session_data();
+		// encrypt data via: $this->encryption->encrypt();
+		$this->encryption = $encryption;
+		// filter hook allows outside functions/classes/plugins to change default empty cart
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
+		// apply default session vars
+		$this->_set_defaults();
+		add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
+		// check request for 'clear_session' param
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
+		// once everything is all said and done,
+		add_action('shutdown', array($this, 'update'), 100);
+		add_action('shutdown', array($this, 'garbageCollection'), 1000);
+		$this->configure_garbage_collection_filters();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function isLoadedAndActive()
+	{
+		return did_action('AHEE__EE_System__core_loaded_and_ready')
+			   && EE_Session::instance() instanceof EE_Session
+			   && EE_Session::instance()->isActive();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActive()
+	{
+		return $this->status === EE_Session::STATUS_OPEN;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function open_session()
+	{
+		// check for existing session and retrieve it from db
+		if (! $this->_espresso_session()) {
+			// or just start a new one
+			$this->_create_espresso_session();
+		}
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function expired()
+	{
+		return $this->_expired;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function reset_expired()
+	{
+		$this->_expired = false;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function expiration()
+	{
+		return $this->_expiration;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function extension()
+	{
+		return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
+	}
+
+
+	/**
+	 * @param int $time number of seconds to add to session expiration
+	 */
+	public function extend_expiration($time = 0)
+	{
+		$time = $time ? $time : $this->extension();
+		$this->_expiration += absint($time);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function lifespan()
+	{
+		return $this->session_lifespan->inSeconds();
+	}
+
+
+	/**
+	 * Marks whether the session data has been updated or not.
+	 * Valid options are:
+	 *      EE_Session::SAVE_STATE_CLEAN - session data remains unchanged and updating is not necessary
+	 *      EE_Session::SAVE_STATE_DIRTY - session data has changed since last save and needs to be updated
+	 * default value is EE_Session::SAVE_STATE_DIRTY
+	 *
+	 * @param string $save_state
+	 */
+	public function setSaveState($save_state = EE_Session::SAVE_STATE_DIRTY)
+	{
+		$valid_save_states = [
+			EE_Session::SAVE_STATE_CLEAN,
+			EE_Session::SAVE_STATE_DIRTY,
+		];
+		if (! in_array($save_state, $valid_save_states, true)) {
+			$save_state = EE_Session::SAVE_STATE_DIRTY;
+		}
+		$this->save_state = $save_state;
+	}
+
+
+
+	/**
+	 * This just sets some defaults for the _session data property
+	 *
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		// set some defaults
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[ $key ] = array();
+			} else {
+				$this->_session_data[ $key ] = '';
+			}
+		}
+	}
+
+
+	/**
+	 * @retrieve  session data
+	 * @return    string
+	 */
+	public function id()
+	{
+		return $this->_sid;
+	}
+
+
+	/**
+	 * @param \EE_Cart $cart
+	 * @return bool
+	 */
+	public function set_cart(EE_Cart $cart)
+	{
+		$this->_session_data['cart'] = $cart;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_cart
+	 */
+	public function reset_cart()
+	{
+		do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
+		$this->_session_data['cart'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return \EE_Cart
+	 */
+	public function cart()
+	{
+		return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
+			? $this->_session_data['cart']
+			: null;
+	}
+
+
+	/**
+	 * @param \EE_Checkout $checkout
+	 * @return bool
+	 */
+	public function set_checkout(EE_Checkout $checkout)
+	{
+		$this->_session_data['checkout'] = $checkout;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_checkout
+	 */
+	public function reset_checkout()
+	{
+		do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
+		$this->_session_data['checkout'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return \EE_Checkout
+	 */
+	public function checkout()
+	{
+		return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
+			? $this->_session_data['checkout']
+			: null;
+	}
+
+
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function set_transaction(EE_Transaction $transaction)
+	{
+		// first remove the session from the transaction before we save the transaction in the session
+		$transaction->set_txn_session_data(null);
+		$this->_session_data['transaction'] = $transaction;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_transaction
+	 */
+	public function reset_transaction()
+	{
+		do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
+		$this->_session_data['transaction'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return \EE_Transaction
+	 */
+	public function transaction()
+	{
+		return isset($this->_session_data['transaction'])
+			   && $this->_session_data['transaction'] instanceof EE_Transaction
+			? $this->_session_data['transaction']
+			: null;
+	}
+
+
+	/**
+	 * retrieve session data
+	 *
+	 * @param null $key
+	 * @param bool $reset_cache
+	 * @return array
+	 */
+	public function get_session_data($key = null, $reset_cache = false)
+	{
+		if ($reset_cache) {
+			$this->reset_cart();
+			$this->reset_checkout();
+			$this->reset_transaction();
+		}
+		if (! empty($key)) {
+			return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+		}
+		return $this->_session_data;
+	}
+
+
+	/**
+	 * Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array $data
+	 * @return bool
+	 */
+	public function set_session_data($data)
+	{
+		// nothing ??? bad data ??? go home!
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data or invalid session data was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		foreach ($data as $key => $value) {
+			if (isset($this->_default_session_vars[ $key ])) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Sorry! %s is a default session datum and can not be reset.',
+							'event_espresso'
+						),
+						$key
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$this->_session_data[ $key ] = $value;
+			$this->setSaveState();
+		}
+		return true;
+	}
+
+
+	/**
+	 * @initiate session
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	private function _espresso_session()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->session_start_handler->startSession();
+		$this->status = EE_Session::STATUS_OPEN;
+		// get our modified session ID
+		$this->_sid = $this->_generate_session_id();
+		// and the visitors IP
+		$this->_ip_address = $this->request->ipAddress();
+		// set the "user agent"
+		$this->_user_agent = $this->request->userAgent();
+		// now let's retrieve what's in the db
+		$session_data = $this->_retrieve_session_data();
+		if (! empty($session_data)) {
+			// get the current time in UTC
+			$this->_time = $this->_time !== null ? $this->_time : time();
+			// and reset the session expiration
+			$this->_expiration = isset($session_data['expiration'])
+				? $session_data['expiration']
+				: $this->_time + $this->session_lifespan->inSeconds();
+		} else {
+			// set initial site access time and the session expiration
+			$this->_set_init_access_and_expiration();
+			// set referer
+			$this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = esc_attr(
+				$this->request->getServerParam('HTTP_REFERER')
+			);
+			// no previous session = go back and create one (on top of the data above)
+			return false;
+		}
+		// now the user agent
+		if ($session_data['user_agent'] !== $this->_user_agent) {
+			return false;
+		}
+		// wait a minute... how old are you?
+		if ($this->_time > $this->_expiration) {
+			// yer too old fer me!
+			$this->_expired = true;
+			// wipe out everything that isn't a default session datum
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// make event espresso session data available to plugin
+		$this->_session_data = array_merge($this->_session_data, $session_data);
+		return true;
+	}
+
+
+	/**
+	 * _get_session_data
+	 * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
+	 * databases
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidSessionDataException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	protected function _retrieve_session_data()
+	{
+		$ssn_key = EE_Session::session_id_prefix . $this->_sid;
+		try {
+			// we're using WP's Transient API to store session data using the PHP session ID as the option name
+			$session_data = $this->cache_storage->get($ssn_key, false);
+			if (empty($session_data)) {
+				return array();
+			}
+			if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+				$hash_check = $this->cache_storage->get(
+					EE_Session::hash_check_prefix . $this->_sid,
+					false
+				);
+				if ($hash_check && $hash_check !== md5($session_data)) {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
+								'event_espresso'
+							),
+							EE_Session::session_id_prefix . $this->_sid
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		} catch (Exception $e) {
+			// let's just eat that error for now and attempt to correct any corrupted data
+			global $wpdb;
+			$row = $wpdb->get_row(
+				$wpdb->prepare(
+					"SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
+					'_transient_' . $ssn_key
+				)
+			);
+			$session_data = is_object($row) ? $row->option_value : null;
+			if ($session_data) {
+				$session_data = preg_replace_callback(
+					'!s:(d+):"(.*?)";!',
+					function ($match) {
+						return $match[1] === strlen($match[2])
+							? $match[0]
+							: 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+					},
+					$session_data
+				);
+			}
+			$session_data = maybe_unserialize($session_data);
+		}
+		// in case the data is encoded... try to decode it
+		$session_data = $this->encryption instanceof EE_Encryption
+			? $this->encryption->base64_string_decode($session_data)
+			: $session_data;
+		if (! is_array($session_data)) {
+			try {
+				$session_data = maybe_unserialize($session_data);
+			} catch (Exception $e) {
+				$msg = esc_html__(
+					'An error occurred while attempting to unserialize the session data.',
+					'event_espresso'
+				);
+				$msg .= WP_DEBUG
+					? '<br><pre>'
+					  . print_r($session_data, true)
+					  . '</pre><br>'
+					  . $this->find_serialize_error($session_data)
+					: '';
+				$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+				throw new InvalidSessionDataException($msg, 0, $e);
+			}
+		}
+		// just a check to make sure the session array is indeed an array
+		if (! is_array($session_data)) {
+			// no?!?! then something is wrong
+			$msg = esc_html__(
+				'The session data is missing, invalid, or corrupted.',
+				'event_espresso'
+			);
+			$msg .= WP_DEBUG
+				? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+				: '';
+			$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+			throw new InvalidSessionDataException($msg);
+		}
+		if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
+			$session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
+				$session_data['transaction']
+			);
+		}
+		return $session_data;
+	}
+
+
+	/**
+	 * _generate_session_id
+	 * Retrieves the PHP session id either directly from the PHP session,
+	 * or from the request array if it was passed in from an AJAX request.
+	 * The session id is then salted and hashed (mmm sounds tasty)
+	 * so that it can be safely used as a request param
+	 *
+	 * @return string
+	 */
+	protected function _generate_session_id()
+	{
+		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
+		$session_id = $this->request->requestParamIsSet('EESID')
+			? $this->request->getRequestParam('EESID')
+			: md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
+	}
+
+
+	/**
+	 * _get_sid_salt
+	 *
+	 * @return string
+	 */
+	protected function _get_sid_salt()
+	{
+		// was session id salt already saved to db ?
+		if (empty($this->_sid_salt)) {
+			// no?  then maybe use WP defined constant
+			if (defined('AUTH_SALT')) {
+				$this->_sid_salt = AUTH_SALT;
+			}
+			// if salt doesn't exist or is too short
+			if (strlen($this->_sid_salt) < 32) {
+				// create a new one
+				$this->_sid_salt = wp_generate_password(64);
+			}
+			// and save it as a permanent session setting
+			$this->updateSessionSettings(array('sid_salt' => $this->_sid_salt));
+		}
+		return $this->_sid_salt;
+	}
+
+
+	/**
+	 * _set_init_access_and_expiration
+	 *
+	 * @return void
+	 */
+	protected function _set_init_access_and_expiration()
+	{
+		$this->_time = time();
+		$this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
+		// set initial site access time
+		$this->_session_data['init_access'] = $this->_time;
+		// and the session expiration
+		$this->_session_data['expiration'] = $this->_expiration;
+	}
+
+
+	/**
+	 * @update session data  prior to saving to the db
+	 * @param bool $new_session
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function update($new_session = false)
+	{
+		$this->_session_data = is_array($this->_session_data) && isset($this->_session_data['id'])
+			? $this->_session_data
+			: array();
+		if (empty($this->_session_data)) {
+			$this->_set_defaults();
+		}
+		$session_data = array();
+		foreach ($this->_session_data as $key => $value) {
+			switch ($key) {
+				case 'id':
+					// session ID
+					$session_data['id'] = $this->_sid;
+					break;
+				case 'ip_address':
+					// visitor ip address
+					$session_data['ip_address'] = $this->request->ipAddress();
+					break;
+				case 'user_agent':
+					// visitor user_agent
+					$session_data['user_agent'] = $this->_user_agent;
+					break;
+				case 'init_access':
+					$session_data['init_access'] = absint($value);
+					break;
+				case 'last_access':
+					// current access time
+					$session_data['last_access'] = $this->_time;
+					break;
+				case 'expiration':
+					// when the session expires
+					$session_data['expiration'] = ! empty($this->_expiration)
+						? $this->_expiration
+						: $session_data['init_access'] + $this->session_lifespan->inSeconds();
+					break;
+				case 'user_id':
+					// current user if logged in
+					$session_data['user_id'] = $this->_wp_user_id();
+					break;
+				case 'pages_visited':
+					$page_visit = $this->_get_page_visit();
+					if ($page_visit) {
+						// set pages visited where the first will be the http referrer
+						$this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+						// we'll only save the last 10 page visits.
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
+					}
+					break;
+				default:
+					// carry any other data over
+					$session_data[ $key ] = $this->_session_data[ $key ];
+			}
+		}
+		$this->_session_data = $session_data;
+		// creating a new session does not require saving to the db just yet
+		if (! $new_session) {
+			// ready? let's save
+			if ($this->_save_session_to_db()) {
+				return true;
+			}
+			return false;
+		}
+		// meh, why not?
+		return true;
+	}
+
+
+	/**
+	 * @create session data array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _create_espresso_session()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
+		// use the update function for now with $new_session arg set to TRUE
+		$this->update(true);
+	}
+
+	/**
+	 * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
+	 * too). This is used when determining if we want to save the session or not.
+	 * @since 4.9.67.p
+	 * @return bool
+	 */
+	private function sessionHasStuffWorthSaving()
+	{
+		return $this->save_state === EE_Session::SAVE_STATE_DIRTY
+			   // we may want to eventually remove the following
+			   // on the assumption that the above check is enough
+			   || $this->cart() instanceof EE_Cart
+			   || (
+				   isset($this->_session_data['ee_notices'])
+				   && (
+					   ! empty($this->_session_data['ee_notices']['attention'])
+					   || ! empty($this->_session_data['ee_notices']['errors'])
+					   || ! empty($this->_session_data['ee_notices']['success'])
+				   )
+			   );
+	}
+
+
+	/**
+	 * _save_session_to_db
+	 *
+	 * @param bool $clear_session
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _save_session_to_db($clear_session = false)
+	{
+		// don't save sessions for crawlers
+		// and unless we're deleting the session data, don't save anything if there isn't a cart
+		if (
+			$this->request->isBot()
+			|| (
+				! $clear_session
+				&& ! $this->sessionHasStuffWorthSaving()
+				&& apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
+			)
+		) {
+			return false;
+		}
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			if (! $transaction->ID()) {
+				$transaction->save();
+			}
+			$this->_session_data['transaction'] = $transaction->ID();
+		}
+		// then serialize all of our session data
+		$session_data = serialize($this->_session_data);
+		// do we need to also encode it to avoid corrupted data when saved to the db?
+		$session_data = $this->_use_encryption
+			? $this->encryption->base64_string_encode($session_data)
+			: $session_data;
+		// maybe save hash check
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+			$this->cache_storage->add(
+				EE_Session::hash_check_prefix . $this->_sid,
+				md5($session_data),
+				$this->session_lifespan->inSeconds()
+			);
+		}
+		// we're using the Transient API for storing session data,
+		$saved = $this->cache_storage->add(
+			EE_Session::session_id_prefix . $this->_sid,
+			$session_data,
+			$this->session_lifespan->inSeconds()
+		);
+		$this->setSaveState(EE_Session::SAVE_STATE_CLEAN);
+		return $saved;
+	}
+
+
+	/**
+	 * @get    the full page request the visitor is accessing
+	 * @return string
+	 */
+	public function _get_page_visit()
+	{
+		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		// check for request url
+		if ($this->request->serverParamIsSet('REQUEST_URI')) {
+			$page_id = '?';
+			$e_reg = '';
+			$request_uri = $this->request->getServerParam('REQUEST_URI');
+			$ru_bits = explode('?', $request_uri);
+			$request_uri = $ru_bits[0];
+			$http_host = $this->request->getServerParam('HTTP_HOST');
+			// check for page_id in SERVER REQUEST
+			if ($this->request->requestParamIsSet('page_id')) {
+				// rebuild $e_reg without any of the extra parameters
+				$page_id .= 'page_id=' . $this->request->getRequestParam('page_id', 0, 'int') . '&amp;';
+			}
+			// check for $e_reg in SERVER REQUEST
+			if ($this->request->requestParamIsSet('ee')) {
+				// rebuild $e_reg without any of the extra parameters
+				$e_reg = 'ee=' . $this->request->getRequestParam('ee');
+			}
+			$page_visit = esc_url(rtrim($http_host . $request_uri . $page_id . $e_reg, '?'));
+		}
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
+	}
+
+
+	/**
+	 * @the    current wp user id
+	 * @return int
+	 */
+	public function _wp_user_id()
+	{
+		// if I need to explain the following lines of code, then you shouldn't be looking at this!
+		$this->_wp_user_id = get_current_user_id();
+		return $this->_wp_user_id;
+	}
+
+
+	/**
+	 * Clear EE_Session data
+	 *
+	 * @param string $class
+	 * @param string $function
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function clear_session($class = '', $function = '')
+	{
 //         echo '
 // <h3 style="color:#999;line-height:.9em;">
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
-        $this->reset_cart();
-        $this->reset_checkout();
-        $this->reset_transaction();
-        // wipe out everything that isn't a default session datum
-        $this->reset_data(array_keys($this->_session_data));
-        // reset initial site access time and the session expiration
-        $this->_set_init_access_and_expiration();
-        $this->setSaveState();
-        $this->_save_session_to_db(true);
-    }
-
-
-    /**
-     * resets all non-default session vars. Returns TRUE on success, FALSE on fail
-     *
-     * @param array|mixed $data_to_reset
-     * @param bool        $show_all_notices
-     * @return bool
-     */
-    public function reset_data($data_to_reset = array(), $show_all_notices = false)
-    {
-        // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
-            $data_to_reset = array($data_to_reset);
-        }
-        // nothing ??? go home!
-        if (empty($data_to_reset)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data could be reset, because no session var name was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $return_value = true;
-        // since $data_to_reset is an array, cycle through the values
-        foreach ($data_to_reset as $reset) {
-            // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
-                // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
-                    // remove session var
-                    unset($this->_session_data[ $reset ]);
-                    $this->setSaveState();
-                    if ($show_all_notices) {
-                        EE_Error::add_success(
-                            sprintf(
-                                esc_html__('The session variable %s was removed.', 'event_espresso'),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                } else {
-                    // yeeeeeeeeerrrrrrrrrrr OUT !!!!
-                    if ($show_all_notices) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'Sorry! %s is a default session datum and can not be reset.',
-                                    'event_espresso'
-                                ),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                    $return_value = false;
-                }
-            } elseif ($show_all_notices) {
-                // oops! that session var does not exist!
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The session item provided, %s, is invalid or does not exist.',
-                            'event_espresso'
-                        ),
-                        $reset
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $return_value = false;
-            }
-        } // end of foreach
-        return $return_value;
-    }
-
-
-    /**
-     *   wp_loaded
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function wp_loaded()
-    {
-        if ($this->request->requestParamIsSet('clear_session')) {
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-    }
-
-
-    /**
-     * Used to reset the entire object (for tests).
-     *
-     * @since 4.3.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function reset_instance()
-    {
-        $this->clear_session();
-        self::$_instance = null;
-    }
-
-
-    public function configure_garbage_collection_filters()
-    {
-        // run old filter we had for controlling session cleanup
-        $expired_session_transient_delete_query_limit = absint(
-            apply_filters(
-                'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                50
-            )
-        );
-        // is there a value? or one that is different than the default 50 records?
-        if ($expired_session_transient_delete_query_limit === 0) {
-            // hook into TransientCacheStorage in case Session cleanup was turned off
-            add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
-        } elseif ($expired_session_transient_delete_query_limit !== 50) {
-            // or use that for the new transient cleanup query limit
-            add_filter(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
-                    return $expired_session_transient_delete_query_limit;
-                }
-            );
-        }
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
-     * @param $data1
-     * @return string
-     */
-    private function find_serialize_error($data1)
-    {
-        $error = '<pre>';
-        $data2 = preg_replace_callback(
-            '!s:(\d+):"(.*?)";!',
-            function ($match) {
-                return ($match[1] === strlen($match[2]))
-                    ? $match[0]
-                    : 's:'
-                      . strlen($match[2])
-                      . ':"'
-                      . $match[2]
-                      . '";';
-            },
-            $data1
-        );
-        $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
-        for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error .= "\t-> Line Number = $i" . PHP_EOL;
-                $start = ($i - 20);
-                $start = ($start < 0) ? 0 : $start;
-                $length = 40;
-                $point = $max - $i;
-                if ($point < 20) {
-                    $rlength = 1;
-                    $rpoint = -$point;
-                } else {
-                    $rpoint = $length - 20;
-                    $rlength = 1;
-                }
-                $error .= "\t-> Section Data1  = ";
-                $error .= substr_replace(
-                    substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-                $error .= "\t-> Section Data2  = ";
-                $error .= substr_replace(
-                    substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-            }
-        }
-        $error .= '</pre>';
-        return $error;
-    }
-
-
-    /**
-     * Saves an  array of settings used for configuring aspects of session behaviour
-     *
-     * @param array $updated_settings
-     */
-    private function updateSessionSettings(array $updated_settings = array())
-    {
-        // add existing settings, but only if not included in incoming $updated_settings array
-        $updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
-    }
-
-
-    /**
-     * garbage_collection
-     */
-    public function garbageCollection()
-    {
-        // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
-            $this->_last_gc = time();
-            $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
-            /** @type WPDB $wpdb */
-            global $wpdb;
-            // filter the query limit. Set to 0 to turn off garbage collection
-            $expired_session_transient_delete_query_limit = absint(
-                apply_filters(
-                    'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                    50
-                )
-            );
-            // non-zero LIMIT means take out the trash
-            if ($expired_session_transient_delete_query_limit) {
-                $session_key = str_replace('_', '\_', EE_Session::session_id_prefix);
-                $hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
-                // since transient expiration timestamps are set in the future, we can compare against NOW
-                // but we only want to pick up any trash that's been around for more than a day
-                $expiration = time() - DAY_IN_SECONDS;
-                $SQL = "
+		do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+		$this->reset_cart();
+		$this->reset_checkout();
+		$this->reset_transaction();
+		// wipe out everything that isn't a default session datum
+		$this->reset_data(array_keys($this->_session_data));
+		// reset initial site access time and the session expiration
+		$this->_set_init_access_and_expiration();
+		$this->setSaveState();
+		$this->_save_session_to_db(true);
+	}
+
+
+	/**
+	 * resets all non-default session vars. Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array|mixed $data_to_reset
+	 * @param bool        $show_all_notices
+	 * @return bool
+	 */
+	public function reset_data($data_to_reset = array(), $show_all_notices = false)
+	{
+		// if $data_to_reset is not in an array, then put it in one
+		if (! is_array($data_to_reset)) {
+			$data_to_reset = array($data_to_reset);
+		}
+		// nothing ??? go home!
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data could be reset, because no session var name was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$return_value = true;
+		// since $data_to_reset is an array, cycle through the values
+		foreach ($data_to_reset as $reset) {
+			// first check to make sure it is a valid session var
+			if (isset($this->_session_data[ $reset ])) {
+				// then check to make sure it is not a default var
+				if (! array_key_exists($reset, $this->_default_session_vars)) {
+					// remove session var
+					unset($this->_session_data[ $reset ]);
+					$this->setSaveState();
+					if ($show_all_notices) {
+						EE_Error::add_success(
+							sprintf(
+								esc_html__('The session variable %s was removed.', 'event_espresso'),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				} else {
+					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
+					if ($show_all_notices) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'Sorry! %s is a default session datum and can not be reset.',
+									'event_espresso'
+								),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+					$return_value = false;
+				}
+			} elseif ($show_all_notices) {
+				// oops! that session var does not exist!
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The session item provided, %s, is invalid or does not exist.',
+							'event_espresso'
+						),
+						$reset
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$return_value = false;
+			}
+		} // end of foreach
+		return $return_value;
+	}
+
+
+	/**
+	 *   wp_loaded
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function wp_loaded()
+	{
+		if ($this->request->requestParamIsSet('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+	}
+
+
+	/**
+	 * Used to reset the entire object (for tests).
+	 *
+	 * @since 4.3.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function reset_instance()
+	{
+		$this->clear_session();
+		self::$_instance = null;
+	}
+
+
+	public function configure_garbage_collection_filters()
+	{
+		// run old filter we had for controlling session cleanup
+		$expired_session_transient_delete_query_limit = absint(
+			apply_filters(
+				'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+				50
+			)
+		);
+		// is there a value? or one that is different than the default 50 records?
+		if ($expired_session_transient_delete_query_limit === 0) {
+			// hook into TransientCacheStorage in case Session cleanup was turned off
+			add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
+		} elseif ($expired_session_transient_delete_query_limit !== 50) {
+			// or use that for the new transient cleanup query limit
+			add_filter(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				function () use ($expired_session_transient_delete_query_limit) {
+					return $expired_session_transient_delete_query_limit;
+				}
+			);
+		}
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
+	 * @param $data1
+	 * @return string
+	 */
+	private function find_serialize_error($data1)
+	{
+		$error = '<pre>';
+		$data2 = preg_replace_callback(
+			'!s:(\d+):"(.*?)";!',
+			function ($match) {
+				return ($match[1] === strlen($match[2]))
+					? $match[0]
+					: 's:'
+					  . strlen($match[2])
+					  . ':"'
+					  . $match[2]
+					  . '";';
+			},
+			$data1
+		);
+		$max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+		$error .= $data1 . PHP_EOL;
+		$error .= $data2 . PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[ $i ] !== @$data2[ $i ]) {
+				$error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
+				$error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
+				$error .= "\t-> Line Number = $i" . PHP_EOL;
+				$start = ($i - 20);
+				$start = ($start < 0) ? 0 : $start;
+				$length = 40;
+				$point = $max - $i;
+				if ($point < 20) {
+					$rlength = 1;
+					$rpoint = -$point;
+				} else {
+					$rpoint = $length - 20;
+					$rlength = 1;
+				}
+				$error .= "\t-> Section Data1  = ";
+				$error .= substr_replace(
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+				$error .= "\t-> Section Data2  = ";
+				$error .= substr_replace(
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+			}
+		}
+		$error .= '</pre>';
+		return $error;
+	}
+
+
+	/**
+	 * Saves an  array of settings used for configuring aspects of session behaviour
+	 *
+	 * @param array $updated_settings
+	 */
+	private function updateSessionSettings(array $updated_settings = array())
+	{
+		// add existing settings, but only if not included in incoming $updated_settings array
+		$updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
+	}
+
+
+	/**
+	 * garbage_collection
+	 */
+	public function garbageCollection()
+	{
+		// only perform during regular requests if last garbage collection was over an hour ago
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+			$this->_last_gc = time();
+			$this->updateSessionSettings(array('last_gc' => $this->_last_gc));
+			/** @type WPDB $wpdb */
+			global $wpdb;
+			// filter the query limit. Set to 0 to turn off garbage collection
+			$expired_session_transient_delete_query_limit = absint(
+				apply_filters(
+					'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+					50
+				)
+			);
+			// non-zero LIMIT means take out the trash
+			if ($expired_session_transient_delete_query_limit) {
+				$session_key = str_replace('_', '\_', EE_Session::session_id_prefix);
+				$hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
+				// since transient expiration timestamps are set in the future, we can compare against NOW
+				// but we only want to pick up any trash that's been around for more than a day
+				$expiration = time() - DAY_IN_SECONDS;
+				$SQL = "
                     SELECT option_name
                     FROM {$wpdb->options}
                     WHERE
@@ -1335,17 +1335,17 @@ 
                     AND option_value < {$expiration}
                     LIMIT {$expired_session_transient_delete_query_limit}
                 ";
-                // produces something like:
-                // SELECT option_name FROM wp_options
-                // WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
-                // OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
-                // AND option_value < 1508368198 LIMIT 50
-                $expired_sessions = $wpdb->get_col($SQL);
-                // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
-                    $this->cache_storage->deleteMany($expired_sessions, true);
-                }
-            }
-        }
-    }
+				// produces something like:
+				// SELECT option_name FROM wp_options
+				// WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
+				// OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
+				// AND option_value < 1508368198 LIMIT 50
+				$expired_sessions = $wpdb->get_col($SQL);
+				// valid results?
+				if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+					$this->cache_storage->deleteMany($expired_sessions, true);
+				}
+			}
+		}
+	}
 }

core/services/orm/tree_traversal/ModelObjNode.php

Indentation +188 added lines, -188 removed lines

@@ -22,206 +22,206 @@
  */
 class ModelObjNode extends BaseNode
 {
-    /**
-     * @var int|string
-     */
-    protected $id;
+	/**
+	 * @var int|string
+	 */
+	protected $id;
 
-    /**
-     * @var EEM_Base
-     */
-    protected $model;
+	/**
+	 * @var EEM_Base
+	 */
+	protected $model;
 
-    /**
-     * @var RelationNode[]
-     */
-    protected $nodes;
+	/**
+	 * @var RelationNode[]
+	 */
+	protected $nodes;
 
-    /**
-     * We don't pass the model objects because this needs to serialize to something tiny for effiency.
-     * @param $model_obj_id
-     * @param EEM_Base $model
-     * @param array $dont_traverse_models array of model names we DON'T want to traverse.
-     */
-    public function __construct($model_obj_id, EEM_Base $model, array $dont_traverse_models = [])
-    {
-        $this->id = $model_obj_id;
-        $this->model = $model;
-        $this->dont_traverse_models = $dont_traverse_models;
-    }
+	/**
+	 * We don't pass the model objects because this needs to serialize to something tiny for effiency.
+	 * @param $model_obj_id
+	 * @param EEM_Base $model
+	 * @param array $dont_traverse_models array of model names we DON'T want to traverse.
+	 */
+	public function __construct($model_obj_id, EEM_Base $model, array $dont_traverse_models = [])
+	{
+		$this->id = $model_obj_id;
+		$this->model = $model;
+		$this->dont_traverse_models = $dont_traverse_models;
+	}
 
-    /**
-     * Creates a relation node for each relation of this model's relations.
-     * Does NOT call `discover` on them yet though.
-     * @since 4.10.12.p
-     * @throws \EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function discover()
-    {
-        $this->nodes = [];
-        foreach ($this->model->relation_settings() as $relationName => $relation) {
-            // Make sure this isn't one of the models we were told to not traverse into.
-            if (in_array($relationName, $this->dont_traverse_models)) {
-                continue;
-            }
-            if ($relation instanceof EE_Has_Many_Relation) {
-                $this->nodes[ $relationName ] = new RelationNode(
-                    $this->id,
-                    $this->model,
-                    $relation->get_other_model(),
-                    $this->dont_traverse_models
-                );
-            } elseif (
-                $relation instanceof EE_HABTM_Relation &&
-                ! in_array(
-                    $relation->get_join_model()->get_this_model_name(),
-                    $this->dont_traverse_models
-                )
-            ) {
-                $this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
-                    $this->id,
-                    $this->model,
-                    $relation->get_join_model(),
-                    $this->dont_traverse_models
-                );
-            }
-        }
-        ksort($this->nodes);
-    }
+	/**
+	 * Creates a relation node for each relation of this model's relations.
+	 * Does NOT call `discover` on them yet though.
+	 * @since 4.10.12.p
+	 * @throws \EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function discover()
+	{
+		$this->nodes = [];
+		foreach ($this->model->relation_settings() as $relationName => $relation) {
+			// Make sure this isn't one of the models we were told to not traverse into.
+			if (in_array($relationName, $this->dont_traverse_models)) {
+				continue;
+			}
+			if ($relation instanceof EE_Has_Many_Relation) {
+				$this->nodes[ $relationName ] = new RelationNode(
+					$this->id,
+					$this->model,
+					$relation->get_other_model(),
+					$this->dont_traverse_models
+				);
+			} elseif (
+				$relation instanceof EE_HABTM_Relation &&
+				! in_array(
+					$relation->get_join_model()->get_this_model_name(),
+					$this->dont_traverse_models
+				)
+			) {
+				$this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
+					$this->id,
+					$this->model,
+					$relation->get_join_model(),
+					$this->dont_traverse_models
+				);
+			}
+		}
+		ksort($this->nodes);
+	}
 
 
-    /**
-     * Whether this item has already been initialized
-     */
-    protected function isDiscovered()
-    {
-        return $this->nodes !== null && is_array($this->nodes);
-    }
+	/**
+	 * Whether this item has already been initialized
+	 */
+	protected function isDiscovered()
+	{
+		return $this->nodes !== null && is_array($this->nodes);
+	}
 
-    /**
-     * @since 4.10.12.p
-     * @return boolean
-     */
-    public function isComplete()
-    {
-        if ($this->complete === null) {
-            $this->complete = false;
-        }
-        return $this->complete;
-    }
+	/**
+	 * @since 4.10.12.p
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		if ($this->complete === null) {
+			$this->complete = false;
+		}
+		return $this->complete;
+	}
 
-    /**
-     * Triggers working on each child relation node that has work to do.
-     * @since 4.10.12.p
-     * @param $model_objects_to_identify
-     * @return int units of work done
-     */
-    protected function work($model_objects_to_identify)
-    {
-        $num_identified = 0;
-        // Begin assuming we'll finish all the work on this node and its children...
-        $this->complete = true;
-        foreach ($this->nodes as $model_name => $relation_node) {
-            $num_identified += $relation_node->visit($model_objects_to_identify - $num_identified);
-            // To save on space when serializing, only bother keeping a record of relation nodes that actually found
-            // related model objects.
-            if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
-                unset($this->nodes[ $model_name ]);
-            }
-            if ($num_identified >= $model_objects_to_identify) {
-                // ...but admit we're wrong if the work exceeded the budget.
-                $this->complete = false;
-                break;
-            }
-        }
-        return $num_identified;
-    }
+	/**
+	 * Triggers working on each child relation node that has work to do.
+	 * @since 4.10.12.p
+	 * @param $model_objects_to_identify
+	 * @return int units of work done
+	 */
+	protected function work($model_objects_to_identify)
+	{
+		$num_identified = 0;
+		// Begin assuming we'll finish all the work on this node and its children...
+		$this->complete = true;
+		foreach ($this->nodes as $model_name => $relation_node) {
+			$num_identified += $relation_node->visit($model_objects_to_identify - $num_identified);
+			// To save on space when serializing, only bother keeping a record of relation nodes that actually found
+			// related model objects.
+			if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
+				unset($this->nodes[ $model_name ]);
+			}
+			if ($num_identified >= $model_objects_to_identify) {
+				// ...but admit we're wrong if the work exceeded the budget.
+				$this->complete = false;
+				break;
+			}
+		}
+		return $num_identified;
+	}
 
-    /**
-     * @since 4.10.12.p
-     * @return array
-     * @throws \EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function toArray()
-    {
-        $tree = [
-            'id' => $this->id,
-            'complete' => $this->isComplete(),
-            'rels' => []
-        ];
-        if ($this->nodes === null) {
-            $tree['rels'] = null;
-        } else {
-            foreach ($this->nodes as $relation_name => $relation_node) {
-                $tree['rels'][ $relation_name ] = $relation_node->toArray();
-            }
-        }
-        return $tree;
-    }
+	/**
+	 * @since 4.10.12.p
+	 * @return array
+	 * @throws \EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function toArray()
+	{
+		$tree = [
+			'id' => $this->id,
+			'complete' => $this->isComplete(),
+			'rels' => []
+		];
+		if ($this->nodes === null) {
+			$tree['rels'] = null;
+		} else {
+			foreach ($this->nodes as $relation_name => $relation_node) {
+				$tree['rels'][ $relation_name ] = $relation_node->toArray();
+			}
+		}
+		return $tree;
+	}
 
-    /**
-     * @since 4.10.12.p
-     * @return array|mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws \EE_Error
-     */
-    public function getIds()
-    {
-        $ids = [
-            $this->model->get_this_model_name() => [
-                $this->id => $this->id
-            ]
-        ];
-        if ($this->nodes && is_array($this->nodes)) {
-            foreach ($this->nodes as $relation_node) {
-                $ids = array_replace_recursive($ids, $relation_node->getIds());
-            }
-        }
-        return $ids;
-    }
+	/**
+	 * @since 4.10.12.p
+	 * @return array|mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws \EE_Error
+	 */
+	public function getIds()
+	{
+		$ids = [
+			$this->model->get_this_model_name() => [
+				$this->id => $this->id
+			]
+		];
+		if ($this->nodes && is_array($this->nodes)) {
+			foreach ($this->nodes as $relation_node) {
+				$ids = array_replace_recursive($ids, $relation_node->getIds());
+			}
+		}
+		return $ids;
+	}
 
-    /**
-     * Don't serialize the models. Just record their names on some dynamic properties.
-     * @since 4.10.12.p
-     */
-    public function __sleep()
-    {
-        $this->m = $this->model->get_this_model_name();
-        return array_merge(
-            [
-                'm',
-                'id',
-                'nodes',
-            ],
-            parent::__sleep()
-        );
-    }
+	/**
+	 * Don't serialize the models. Just record their names on some dynamic properties.
+	 * @since 4.10.12.p
+	 */
+	public function __sleep()
+	{
+		$this->m = $this->model->get_this_model_name();
+		return array_merge(
+			[
+				'm',
+				'id',
+				'nodes',
+			],
+			parent::__sleep()
+		);
+	}
 
-    /**
-     * Use the dynamic properties to instantiate the models we use.
-     * @since 4.10.12.p
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __wakeup()
-    {
-        $this->model = EE_Registry::instance()->load_model($this->m);
-        parent::__wakeup();
-    }
+	/**
+	 * Use the dynamic properties to instantiate the models we use.
+	 * @since 4.10.12.p
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __wakeup()
+	{
+		$this->model = EE_Registry::instance()->load_model($this->m);
+		parent::__wakeup();
+	}
 }
 // End of file Visitor.php
 // Location: EventEspresso\core\services\orm\tree_traversal/Visitor.php

Spacing +4 added lines, -4 removed lines

@@ -69,7 +69,7 @@ 
                 continue;
             }
             if ($relation instanceof EE_Has_Many_Relation) {
-                $this->nodes[ $relationName ] = new RelationNode(
+                $this->nodes[$relationName] = new RelationNode(
                     $this->id,
                     $this->model,
                     $relation->get_other_model(),
@@ -82,7 +82,7 @@ 
                     $this->dont_traverse_models
                 )
             ) {
-                $this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
+                $this->nodes[$relation->get_join_model()->get_this_model_name()] = new RelationNode(
                     $this->id,
                     $this->model,
                     $relation->get_join_model(),
@@ -130,7 +130,7 @@ 
             // To save on space when serializing, only bother keeping a record of relation nodes that actually found
             // related model objects.
             if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
-                unset($this->nodes[ $model_name ]);
+                unset($this->nodes[$model_name]);
             }
             if ($num_identified >= $model_objects_to_identify) {
                 // ...but admit we're wrong if the work exceeded the budget.
@@ -161,7 +161,7 @@ 
             $tree['rels'] = null;
         } else {
             foreach ($this->nodes as $relation_name => $relation_node) {
-                $tree['rels'][ $relation_name ] = $relation_node->toArray();
+                $tree['rels'][$relation_name] = $relation_node->toArray();
             }
         }
         return $tree;

core/libraries/plugin_api/EE_Register_Model_Extensions.lib.php

Spacing +12 added lines, -12 removed lines

@@ -68,11 +68,11 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
+        if (isset(self::$_registry[$identifier])) {
             return;
         }
         // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
             EE_Error::doing_it_wrong(
                 __METHOD__,
                 sprintf(
@@ -89,30 +89,30 @@ 
             );
         }
 
-        self::$_registry[ $identifier ]   = $setup_args;
-        self::$_extensions[ $identifier ] = [];
+        self::$_registry[$identifier]   = $setup_args;
+        self::$_extensions[$identifier] = [];
 
         if (isset($setup_args['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+            require_once(EE_LIBRARIES.'plugin_api/db/EEME_Base.lib.php');
             $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
             // remove all files that are not PHP
             foreach ($class_to_filepath_map as $class => $path) {
                 if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
+                    unset($class_to_filepath_map[$class]);
                 }
             }
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $identifier ]['models'][ $classname ] = new $classname();
+                self::$_extensions[$identifier]['models'][$classname] = new $classname();
             }
             unset($setup_args['model_extension_paths']);
         }
         if (isset($setup_args['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+            require_once(EE_LIBRARIES.'plugin_api/db/EEE_Base_Class.lib.php');
             $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $identifier ]['classes'][ $classname ] = new $classname();
+                self::$_extensions[$identifier]['classes'][$classname] = new $classname();
             }
             unset($setup_args['class_extension_paths']);
         }
@@ -131,9 +131,9 @@ 
      */
     public static function deregister($identifier = '')
     {
-        if (isset(self::$_registry[ $identifier ])) {
-            unset(self::$_registry[ $identifier ]);
-            foreach (self::$_extensions[ $identifier ] as $extension_of_type) {
+        if (isset(self::$_registry[$identifier])) {
+            unset(self::$_registry[$identifier]);
+            foreach (self::$_extensions[$identifier] as $extension_of_type) {
                 foreach ($extension_of_type as $extension) {
                     $extension->deregister();
                 }

Indentation +120 added lines, -120 removed lines

@@ -11,132 +11,132 @@
  */
 class EE_Register_Model_Extensions implements EEI_Plugin_API
 {
-    protected static $_registry;
+	protected static $_registry;
 
-    protected static $_extensions = [];
+	protected static $_extensions = [];
 
 
-    /**
-     * register method for setting up model extensions
-     *
-     * @param string $identifier            unique id for the extensions being setup
-     * @param array  $setup_args            {
-     * @return void
-     * @throws EE_Error
-     * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
-     *                                      the models naming convention, which is:
-     *                                      EEME_{your_plugin_slug}_model_name_extended}.model_ext.php.
-     *                                      Where {your_plugin_slug} is really anything you want (but something having
-     *                                      to do with your addon, like 'Calendar' or '3D_View') and
-     *                                      model_name_extended} is the model extended.
-     *                                      The class contained in teh file should extend
-     *                                      EEME_Base_{model_name_extended}.model_ext.php.
-     *                                      Where {your_plugin_slug} is really anything you want (but something
-     *                                      having to do with your addon, like 'Calendar' or '3D_View') and
-     *                                      {model_name_extended} is the model extended. The class contained in teh
-     *                                      file should extend EEME_Base
-     * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
-     *                                      the model class extension naming convention, which is:
-     *                                      EEE_{your_plugin_slug}_model_name_extended}.class_ext.php.
-     *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
-     *                                      and model_name_extended} is the name of the model extended, eg
-     *                                      'Attendee','Event',etc.
-     *                                      The class contained in the file should extend EEE_Base_Class
-     *                                      ._{model_name_extended}.class_ext.php.
-     *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
-     *                                      and {model_name_extended} is the name of the model extended, eg
-     *                                      'Attendee','Event',etc. The class contained in the file should extend
-     *                                      EEE_Base_Class.
-     *                                      }
-     *
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (
-            empty($identifier)
-            || ! is_array($setup_args)
-            || (empty($setup_args['model_extension_paths']) && empty($setup_args['class_extension_paths']))
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * register method for setting up model extensions
+	 *
+	 * @param string $identifier            unique id for the extensions being setup
+	 * @param array  $setup_args            {
+	 * @return void
+	 * @throws EE_Error
+	 * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
+	 *                                      the models naming convention, which is:
+	 *                                      EEME_{your_plugin_slug}_model_name_extended}.model_ext.php.
+	 *                                      Where {your_plugin_slug} is really anything you want (but something having
+	 *                                      to do with your addon, like 'Calendar' or '3D_View') and
+	 *                                      model_name_extended} is the model extended.
+	 *                                      The class contained in teh file should extend
+	 *                                      EEME_Base_{model_name_extended}.model_ext.php.
+	 *                                      Where {your_plugin_slug} is really anything you want (but something
+	 *                                      having to do with your addon, like 'Calendar' or '3D_View') and
+	 *                                      {model_name_extended} is the model extended. The class contained in teh
+	 *                                      file should extend EEME_Base
+	 * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
+	 *                                      the model class extension naming convention, which is:
+	 *                                      EEE_{your_plugin_slug}_model_name_extended}.class_ext.php.
+	 *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
+	 *                                      and model_name_extended} is the name of the model extended, eg
+	 *                                      'Attendee','Event',etc.
+	 *                                      The class contained in the file should extend EEE_Base_Class
+	 *                                      ._{model_name_extended}.class_ext.php.
+	 *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
+	 *                                      and {model_name_extended} is the name of the model extended, eg
+	 *                                      'Attendee','Event',etc. The class contained in the file should extend
+	 *                                      EEE_Base_Class.
+	 *                                      }
+	 *
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (
+			empty($identifier)
+			|| ! is_array($setup_args)
+			|| (empty($setup_args['model_extension_paths']) && empty($setup_args['class_extension_paths']))
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
-            return;
-        }
-        // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
-                        'event_espresso'
-                    ),
-                    $identifier,
-                    '<br />',
-                    did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
-                    did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
-                ),
-                '4.3'
-            );
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $identifier ])) {
+			return;
+		}
+		// check correct loading
+		if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
+						'event_espresso'
+					),
+					$identifier,
+					'<br />',
+					did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
+					did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
+				),
+				'4.3'
+			);
+		}
 
-        self::$_registry[ $identifier ]   = $setup_args;
-        self::$_extensions[ $identifier ] = [];
+		self::$_registry[ $identifier ]   = $setup_args;
+		self::$_extensions[ $identifier ] = [];
 
-        if (isset($setup_args['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
-            // remove all files that are not PHP
-            foreach ($class_to_filepath_map as $class => $path) {
-                if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
-                }
-            }
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $identifier ]['models'][ $classname ] = new $classname();
-            }
-            unset($setup_args['model_extension_paths']);
-        }
-        if (isset($setup_args['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $identifier ]['classes'][ $classname ] = new $classname();
-            }
-            unset($setup_args['class_extension_paths']);
-        }
-        foreach ($setup_args as $unknown_key => $unknown_config) {
-            throw new EE_Error(
-                sprintf(esc_html__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
-            );
-        }
-    }
+		if (isset($setup_args['model_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
+			// remove all files that are not PHP
+			foreach ($class_to_filepath_map as $class => $path) {
+				if (substr($path, strlen($path) - 3) !== 'php') {
+					unset($class_to_filepath_map[ $class ]);
+				}
+			}
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $identifier ]['models'][ $classname ] = new $classname();
+			}
+			unset($setup_args['model_extension_paths']);
+		}
+		if (isset($setup_args['class_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $identifier ]['classes'][ $classname ] = new $classname();
+			}
+			unset($setup_args['class_extension_paths']);
+		}
+		foreach ($setup_args as $unknown_key => $unknown_config) {
+			throw new EE_Error(
+				sprintf(esc_html__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
+			);
+		}
+	}
 
 
-    /**
-     * deregister
-     *
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        if (isset(self::$_registry[ $identifier ])) {
-            unset(self::$_registry[ $identifier ]);
-            foreach (self::$_extensions[ $identifier ] as $extension_of_type) {
-                foreach ($extension_of_type as $extension) {
-                    $extension->deregister();
-                }
-            }
-        }
-    }
+	/**
+	 * deregister
+	 *
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		if (isset(self::$_registry[ $identifier ])) {
+			unset(self::$_registry[ $identifier ]);
+			foreach (self::$_extensions[ $identifier ] as $extension_of_type) {
+				foreach ($extension_of_type as $extension) {
+					$extension->deregister();
+				}
+			}
+		}
+	}
 }

core/libraries/plugin_api/EE_Register_Payment_Method.lib.php

Spacing +8 added lines, -8 removed lines

@@ -59,7 +59,7 @@ 
             );
         }
         // make sure we don't register twice
-        if (isset(self::$_settings[ $identifier ])) {
+        if (isset(self::$_settings[$identifier])) {
             return;
         }
         // make sure this was called in the right place!
@@ -77,7 +77,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $identifier ] = [
+        self::$_settings[$identifier] = [
             // array of full server paths to any EE_PMT_Base children used
             'payment_method_paths' => isset($setup_args['payment_method_paths'])
                 ? (array) $setup_args['payment_method_paths']
@@ -93,12 +93,12 @@ 
         if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
             $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
             // register payment methods directly
-            foreach (self::$_settings[ $identifier ]['payment_method_paths'] as $payment_method_path) {
+            foreach (self::$_settings[$identifier]['payment_method_paths'] as $payment_method_path) {
                 $payment_method_manager->register_payment_method($payment_method_path);
             }
             $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
             $capabilities->addCaps(
-                self::getPaymentMethodCapabilities(self::$_settings[ $identifier ])
+                self::getPaymentMethodCapabilities(self::$_settings[$identifier])
             );
         }
     }
@@ -135,13 +135,13 @@ 
      */
     public static function deregister($identifier = '')
     {
-        if (isset(self::$_settings[ $identifier ])) {
+        if (isset(self::$_settings[$identifier])) {
             // set action for just this module id to delay deregistration until core is loaded and ready.
-            $module_settings = self::$_settings[ $identifier ];
-            unset(self::$_settings[ $identifier ]);
+            $module_settings = self::$_settings[$identifier];
+            unset(self::$_settings[$identifier]);
             add_action(
                 'AHEE__EE_System__core_loaded_and_ready',
-                function () use ($module_settings) {
+                function() use ($module_settings) {
                     $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                     $capabilities->removeCaps(
                         EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)

Indentation +151 added lines, -151 removed lines

@@ -18,163 +18,163 @@
  */
 class EE_Register_Payment_Method implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered payment methods
-     *
-     * @var array
-     */
-    protected static $_settings = [];
+	/**
+	 * Holds values for registered payment methods
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
 
 
-    /**
-     * Method for registering new EE_PMT_Base children
-     *
-     * @param string  $identifier           a unique identifier for this set of modules Required.
-     * @param array   $setup_args           an array of arguments provided for registering modules Required.{
-     * @type string[] $payment_method_paths each element is the folder containing the EE_PMT_Base child class
-     *                                      (eg, 'public_html/wp-content/plugins/my_plugin/Payomatic/' which contains
-     *                                      the files EE_PMT_Payomatic.pm.php)
-     *                                      }
-     * @return void
-     * @throws EE_Error
-     * @type array payment_method_paths    an array of full server paths to folders containing any EE_PMT_Base
-     *                                      children, or to the EED_Module files themselves
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @since    4.5.0
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($identifier) || ! is_array($setup_args) || empty($setup_args['payment_method_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Payment Methods with EE_Register_Payment_Method::register(), you must include a "payment_method_id" (a unique identifier for this set of modules), and an array containing the following keys: "payment_method_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $identifier ])) {
-            return;
-        }
-        // make sure this was called in the right place!
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $identifier ] = [
-            // array of full server paths to any EE_PMT_Base children used
-            'payment_method_paths' => isset($setup_args['payment_method_paths'])
-                ? (array) $setup_args['payment_method_paths']
-                : [],
-        ];
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            ['EE_Register_Payment_Method', 'add_payment_methods']
-        );
-        // If EE_Payment_Method_Manager::register_payment_methods has already been called,
-        // then we need to add our caps for this payment method manually
-        if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
-            $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            // register payment methods directly
-            foreach (self::$_settings[ $identifier ]['payment_method_paths'] as $payment_method_path) {
-                $payment_method_manager->register_payment_method($payment_method_path);
-            }
-            $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-            $capabilities->addCaps(
-                self::getPaymentMethodCapabilities(self::$_settings[ $identifier ])
-            );
-        }
-    }
+	/**
+	 * Method for registering new EE_PMT_Base children
+	 *
+	 * @param string  $identifier           a unique identifier for this set of modules Required.
+	 * @param array   $setup_args           an array of arguments provided for registering modules Required.{
+	 * @type string[] $payment_method_paths each element is the folder containing the EE_PMT_Base child class
+	 *                                      (eg, 'public_html/wp-content/plugins/my_plugin/Payomatic/' which contains
+	 *                                      the files EE_PMT_Payomatic.pm.php)
+	 *                                      }
+	 * @return void
+	 * @throws EE_Error
+	 * @type array payment_method_paths    an array of full server paths to folders containing any EE_PMT_Base
+	 *                                      children, or to the EED_Module files themselves
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @since    4.5.0
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($identifier) || ! is_array($setup_args) || empty($setup_args['payment_method_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Payment Methods with EE_Register_Payment_Method::register(), you must include a "payment_method_id" (a unique identifier for this set of modules), and an array containing the following keys: "payment_method_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
+					'event_espresso'
+				)
+			);
+		}
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $identifier ])) {
+			return;
+		}
+		// make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $identifier ] = [
+			// array of full server paths to any EE_PMT_Base children used
+			'payment_method_paths' => isset($setup_args['payment_method_paths'])
+				? (array) $setup_args['payment_method_paths']
+				: [],
+		];
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			['EE_Register_Payment_Method', 'add_payment_methods']
+		);
+		// If EE_Payment_Method_Manager::register_payment_methods has already been called,
+		// then we need to add our caps for this payment method manually
+		if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
+			$payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			// register payment methods directly
+			foreach (self::$_settings[ $identifier ]['payment_method_paths'] as $payment_method_path) {
+				$payment_method_manager->register_payment_method($payment_method_path);
+			}
+			$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+			$capabilities->addCaps(
+				self::getPaymentMethodCapabilities(self::$_settings[ $identifier ])
+			);
+		}
+	}
 
 
-    /**
-     * Filters the list of payment methods to add ours.
-     * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
-     *
-     * @param array $payment_method_folders array of paths to all payment methods that require registering
-     * @return array
-     */
-    public static function add_payment_methods(array $payment_method_folders)
-    {
-        foreach (self::$_settings as $settings) {
-            foreach ($settings['payment_method_paths'] as $payment_method_path) {
-                $payment_method_folders[] = $payment_method_path;
-            }
-        }
-        return $payment_method_folders;
-    }
+	/**
+	 * Filters the list of payment methods to add ours.
+	 * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
+	 *
+	 * @param array $payment_method_folders array of paths to all payment methods that require registering
+	 * @return array
+	 */
+	public static function add_payment_methods(array $payment_method_folders)
+	{
+		foreach (self::$_settings as $settings) {
+			foreach ($settings['payment_method_paths'] as $payment_method_path) {
+				$payment_method_folders[] = $payment_method_path;
+			}
+		}
+		return $payment_method_folders;
+	}
 
 
-    /**
-     * This deregisters a module that was previously registered with a specific $identifier.
-     *
-     * @param string $identifier the name for the module that was previously registered
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @since    4.3.0
-     */
-    public static function deregister($identifier = '')
-    {
-        if (isset(self::$_settings[ $identifier ])) {
-            // set action for just this module id to delay deregistration until core is loaded and ready.
-            $module_settings = self::$_settings[ $identifier ];
-            unset(self::$_settings[ $identifier ]);
-            add_action(
-                'AHEE__EE_System__core_loaded_and_ready',
-                function () use ($module_settings) {
-                    $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-                    $capabilities->removeCaps(
-                        EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)
-                    );
-                }
-            );
-        }
-    }
+	/**
+	 * This deregisters a module that was previously registered with a specific $identifier.
+	 *
+	 * @param string $identifier the name for the module that was previously registered
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @since    4.3.0
+	 */
+	public static function deregister($identifier = '')
+	{
+		if (isset(self::$_settings[ $identifier ])) {
+			// set action for just this module id to delay deregistration until core is loaded and ready.
+			$module_settings = self::$_settings[ $identifier ];
+			unset(self::$_settings[ $identifier ]);
+			add_action(
+				'AHEE__EE_System__core_loaded_and_ready',
+				function () use ($module_settings) {
+					$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+					$capabilities->removeCaps(
+						EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)
+					);
+				}
+			);
+		}
+	}
 
 
-    /**
-     * returns an array of the caps that get added when a Payment Method is registered
-     *
-     * @param array $settings
-     * @return array
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @access private  Developers do NOT use this method.  It's only public for PHP5.3 closure support (see deregister)
-     *                  When we drop support for PHP5.3 this will be made private again.  You have been warned.
-     */
-    public static function getPaymentMethodCapabilities(array $settings)
-    {
-        $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-        $payment_method_caps    = ['administrator' => []];
-        if (isset($settings['payment_method_paths'])) {
-            foreach ($settings['payment_method_paths'] as $payment_method_path) {
-                $payment_method_caps = $payment_method_manager->addPaymentMethodCap(
-                    strtolower(basename($payment_method_path)),
-                    $payment_method_caps
-                );
-            }
-        }
-        return $payment_method_caps;
-    }
+	/**
+	 * returns an array of the caps that get added when a Payment Method is registered
+	 *
+	 * @param array $settings
+	 * @return array
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @access private  Developers do NOT use this method.  It's only public for PHP5.3 closure support (see deregister)
+	 *                  When we drop support for PHP5.3 this will be made private again.  You have been warned.
+	 */
+	public static function getPaymentMethodCapabilities(array $settings)
+	{
+		$payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+		$payment_method_caps    = ['administrator' => []];
+		if (isset($settings['payment_method_paths'])) {
+			foreach ($settings['payment_method_paths'] as $payment_method_path) {
+				$payment_method_caps = $payment_method_manager->addPaymentMethodCap(
+					strtolower(basename($payment_method_path)),
+					$payment_method_caps
+				);
+			}
+		}
+		return $payment_method_caps;
+	}
 }

core/libraries/plugin_api/EE_Register_Messages_Template_Pack.lib.php

Spacing +8 added lines, -8 removed lines

@@ -70,13 +70,13 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
+        if (isset(self::$_registry[$identifier])) {
             return;
         }
 
         // check that incoming $identifier doesn't already exist. If it does then we'll create a unique reference for this template pack.
-        if (isset(self::$_registry[ $identifier ])) {
-            $identifier = uniqid() . '_' . $identifier;
+        if (isset(self::$_registry[$identifier])) {
+            $identifier = uniqid().'_'.$identifier;
         }
 
 
@@ -99,7 +99,7 @@ 
         }
 
         if (self::_verify_class_not_exist($setup_args['classname'])) {
-            self::$_registry[ $identifier ] = [
+            self::$_registry[$identifier] = [
                 'path'      => (string) $setup_args['path'],
                 'classname' => (string) $setup_args['classname'],
             ];
@@ -151,14 +151,14 @@ 
     {
         foreach (self::$_registry as $args) {
             // verify class_exists
-            if (! class_exists($args['classname'])) {
-                require_once($args['path'] . '/' . $args['classname'] . '.class.php');
+            if ( ! class_exists($args['classname'])) {
+                require_once($args['path'].'/'.$args['classname'].'.class.php');
             }
 
             // check again!
             if (class_exists($args['classname'])) {
                 $template_pack                           = new $args['classname']();
-                $template_packs[ $template_pack->dbref ] = $template_pack;
+                $template_packs[$template_pack->dbref] = $template_pack;
             }
         }
 
@@ -208,6 +208,6 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$_registry[ $identifier ]);
+        unset(self::$_registry[$identifier]);
     }
 }

Indentation +198 added lines, -198 removed lines

@@ -10,202 +10,202 @@
  */
 class EE_Register_Messages_Template_Pack implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered template pack
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    protected static $_registry = [];
-
-
-    /**
-     * Used to register a new template pack with the messages system.
-     *
-     * Template packs are primarily defined via class extending EE_Messages_Template_Pack and are typically used to
-     * change entire layouts for a set of message templates.  This method is used to register the new template pack and
-     * automatically have it loaded in the appropriate places.
-     *
-     * This registry also verifies that there isn't already a template pack registered with the same name and if there
-     * is then it will add an EE_Error notice.
-     *
-     * Note that this only handles registering the your Template Pack class with the message template pack system.
-     * However, there is also a naming schema you must follow for templates you are providing with your template pack.
-     *
-     * @param string $identifier The internal reference used to refer to this template pack.  Note, this is first come,
-     *                           first serve.  If there is already a template pack registered with this name then the
-     *                           registry will assign a unique reference for it so it can still be activated (but this
-     *                           makes it harder to deregister as it will be unique per load - so its best to try to
-     *                           make this a unique string!)
-     * @param array  $setup_args array {
-     *                           An array of required values for registering the template pack.
-     * @type string  $path       The path for the new template pack class.
-     * @type string  $classname  The name of the new Template Pack Class.
-     *                           }
-     *
-     * @return void
-     * @throws EE_Error
-     *
-     * @see    core/libraries/messages/defaults/default/* for all the example templates the default template pack
-     *         supports.
-     *
-     *
-     * @since  4.5.0
-     * @see    EE_Messages_Template_Pack_Default for an example class
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-
-        // check for required params
-        if (empty($identifier) || empty($setup_args['path']) || empty($setup_args['classname'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register a new template pack for the EE Messages system, you must include a value to reference the template pack being registered and the setup_args must have the path for the new template pack class as well as the classname for the new Template Pack Class. ',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
-            return;
-        }
-
-        // check that incoming $identifier doesn't already exist. If it does then we'll create a unique reference for this template pack.
-        if (isset(self::$_registry[ $identifier ])) {
-            $identifier = uniqid() . '_' . $identifier;
-        }
-
-
-        // make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'A EE Messages Template Pack given the reference "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
-                        'event_espresso'
-                    ),
-                    $identifier
-                ),
-                '4.5.0'
-            );
-        }
-
-        if (self::_verify_class_not_exist($setup_args['classname'])) {
-            self::$_registry[ $identifier ] = [
-                'path'      => (string) $setup_args['path'],
-                'classname' => (string) $setup_args['classname'],
-            ];
-        }
-
-        // hook into the system
-        add_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            ['EE_Register_Messages_Template_Pack', 'set_template_pack_path'],
-            10
-        );
-        add_filter(
-            'FHEE__EED_Messages__get_template_packs__template_packs',
-            ['EE_Register_Messages_Template_Pack', 'set_template_pack'],
-            10
-        );
-    }
-
-
-    /**
-     * Callback for the FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.  This adds this template packs path
-     * to the messages autoloader paths.
-     *
-     * @param array $paths Array of paths already registered with the messages autoloader
-     *
-     * @return array
-     * @since  4.5.0
-     *
-     */
-    public static function set_template_pack_path(array $paths)
-    {
-        foreach (self::$_registry as $args) {
-            $paths[] = $args['path'];
-        }
-        return $paths;
-    }
-
-
-    /**
-     * Callback for the FHEE__EED_Messages__get_template_packs__template_packs filter. This adds the instantiated,
-     * registered template pack to the template packs array when requested by client code.
-     *
-     * @param EE_Messages_Template_Pack[] $template_packs
-     * @return EE_Messages_Template_Pack[]
-     * @since 4.5.0
-     *
-     */
-    public static function set_template_pack(array $template_packs)
-    {
-        foreach (self::$_registry as $args) {
-            // verify class_exists
-            if (! class_exists($args['classname'])) {
-                require_once($args['path'] . '/' . $args['classname'] . '.class.php');
-            }
-
-            // check again!
-            if (class_exists($args['classname'])) {
-                $template_pack                           = new $args['classname']();
-                $template_packs[ $template_pack->dbref ] = $template_pack;
-            }
-        }
-
-        return $template_packs;
-    }
-
-
-    /**
-     * This verifies that the classes for each registered template pack are unique  names.
-     *
-     * @param string $classname The classname being checked
-     *
-     * @return bool
-     */
-    private static function _verify_class_not_exist($classname)
-    {
-        // loop through the existing registry and see if the classname is already present.
-        foreach (self::$_registry as $args) {
-            if ($args['classname'] == $classname) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The %s template pack that you just activated cannot be registered with the messages system because there is already a template pack active using the same classname.  Contact the author of this template pack to let them know of the conflict.  To stop seeing this message you will need to deactivate this template pack.',
-                            'event_espresso'
-                        ),
-                        $classname
-                    ),
-                    __FILE__,
-                    __LINE__,
-                    __FUNCTION__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This deregisters a variation set that was previously registered with the given slug.
-     *
-     * @param string $identifier The name for the variation set that was previously registered.
-     *
-     * @return void
-     * @since 4.5.0
-     *
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$_registry[ $identifier ]);
-    }
+	/**
+	 * Holds values for registered template pack
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	protected static $_registry = [];
+
+
+	/**
+	 * Used to register a new template pack with the messages system.
+	 *
+	 * Template packs are primarily defined via class extending EE_Messages_Template_Pack and are typically used to
+	 * change entire layouts for a set of message templates.  This method is used to register the new template pack and
+	 * automatically have it loaded in the appropriate places.
+	 *
+	 * This registry also verifies that there isn't already a template pack registered with the same name and if there
+	 * is then it will add an EE_Error notice.
+	 *
+	 * Note that this only handles registering the your Template Pack class with the message template pack system.
+	 * However, there is also a naming schema you must follow for templates you are providing with your template pack.
+	 *
+	 * @param string $identifier The internal reference used to refer to this template pack.  Note, this is first come,
+	 *                           first serve.  If there is already a template pack registered with this name then the
+	 *                           registry will assign a unique reference for it so it can still be activated (but this
+	 *                           makes it harder to deregister as it will be unique per load - so its best to try to
+	 *                           make this a unique string!)
+	 * @param array  $setup_args array {
+	 *                           An array of required values for registering the template pack.
+	 * @type string  $path       The path for the new template pack class.
+	 * @type string  $classname  The name of the new Template Pack Class.
+	 *                           }
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 *
+	 * @see    core/libraries/messages/defaults/default/* for all the example templates the default template pack
+	 *         supports.
+	 *
+	 *
+	 * @since  4.5.0
+	 * @see    EE_Messages_Template_Pack_Default for an example class
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+
+		// check for required params
+		if (empty($identifier) || empty($setup_args['path']) || empty($setup_args['classname'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register a new template pack for the EE Messages system, you must include a value to reference the template pack being registered and the setup_args must have the path for the new template pack class as well as the classname for the new Template Pack Class. ',
+					'event_espresso'
+				)
+			);
+		}
+
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $identifier ])) {
+			return;
+		}
+
+		// check that incoming $identifier doesn't already exist. If it does then we'll create a unique reference for this template pack.
+		if (isset(self::$_registry[ $identifier ])) {
+			$identifier = uniqid() . '_' . $identifier;
+		}
+
+
+		// make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'A EE Messages Template Pack given the reference "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
+						'event_espresso'
+					),
+					$identifier
+				),
+				'4.5.0'
+			);
+		}
+
+		if (self::_verify_class_not_exist($setup_args['classname'])) {
+			self::$_registry[ $identifier ] = [
+				'path'      => (string) $setup_args['path'],
+				'classname' => (string) $setup_args['classname'],
+			];
+		}
+
+		// hook into the system
+		add_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			['EE_Register_Messages_Template_Pack', 'set_template_pack_path'],
+			10
+		);
+		add_filter(
+			'FHEE__EED_Messages__get_template_packs__template_packs',
+			['EE_Register_Messages_Template_Pack', 'set_template_pack'],
+			10
+		);
+	}
+
+
+	/**
+	 * Callback for the FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.  This adds this template packs path
+	 * to the messages autoloader paths.
+	 *
+	 * @param array $paths Array of paths already registered with the messages autoloader
+	 *
+	 * @return array
+	 * @since  4.5.0
+	 *
+	 */
+	public static function set_template_pack_path(array $paths)
+	{
+		foreach (self::$_registry as $args) {
+			$paths[] = $args['path'];
+		}
+		return $paths;
+	}
+
+
+	/**
+	 * Callback for the FHEE__EED_Messages__get_template_packs__template_packs filter. This adds the instantiated,
+	 * registered template pack to the template packs array when requested by client code.
+	 *
+	 * @param EE_Messages_Template_Pack[] $template_packs
+	 * @return EE_Messages_Template_Pack[]
+	 * @since 4.5.0
+	 *
+	 */
+	public static function set_template_pack(array $template_packs)
+	{
+		foreach (self::$_registry as $args) {
+			// verify class_exists
+			if (! class_exists($args['classname'])) {
+				require_once($args['path'] . '/' . $args['classname'] . '.class.php');
+			}
+
+			// check again!
+			if (class_exists($args['classname'])) {
+				$template_pack                           = new $args['classname']();
+				$template_packs[ $template_pack->dbref ] = $template_pack;
+			}
+		}
+
+		return $template_packs;
+	}
+
+
+	/**
+	 * This verifies that the classes for each registered template pack are unique  names.
+	 *
+	 * @param string $classname The classname being checked
+	 *
+	 * @return bool
+	 */
+	private static function _verify_class_not_exist($classname)
+	{
+		// loop through the existing registry and see if the classname is already present.
+		foreach (self::$_registry as $args) {
+			if ($args['classname'] == $classname) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The %s template pack that you just activated cannot be registered with the messages system because there is already a template pack active using the same classname.  Contact the author of this template pack to let them know of the conflict.  To stop seeing this message you will need to deactivate this template pack.',
+							'event_espresso'
+						),
+						$classname
+					),
+					__FILE__,
+					__LINE__,
+					__FUNCTION__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This deregisters a variation set that was previously registered with the given slug.
+	 *
+	 * @param string $identifier The name for the variation set that was previously registered.
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 *
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$_registry[ $identifier ]);
+	}
 }

core/libraries/plugin_api/EE_Register_Message_Type.lib.php

Spacing +7 added lines, -7 removed lines

@@ -60,7 +60,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_message_type_registry[ $identifier ])) {
+        if (isset(self::$_ee_message_type_registry[$identifier])) {
             return;
         }
 
@@ -82,7 +82,7 @@ 
             );
         }
         // setup $__ee_message_type_registry array from incoming values.
-        self::$_ee_message_type_registry[ $identifier ] = [
+        self::$_ee_message_type_registry[$identifier] = [
             /**
              * The file name for the message type being registered.
              * Required.
@@ -265,7 +265,7 @@ 
      */
     public static function deregister($identifier = '')
     {
-        if (! empty(self::$_ee_message_type_registry[ $identifier ])) {
+        if ( ! empty(self::$_ee_message_type_registry[$identifier])) {
             // let's make sure that we remove any place this message type was made active
             /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
             $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
@@ -277,7 +277,7 @@ 
             );
             $Message_Resource_Manager->deactivate_message_type($identifier, false);
         }
-        unset(self::$_ee_message_type_registry[ $identifier ]);
+        unset(self::$_ee_message_type_registry[$identifier]);
     }
 
 
@@ -312,7 +312,7 @@ 
      */
     public static function register_msgs_autoload_paths(array $paths)
     {
-        if (! empty(self::$_ee_message_type_registry)) {
+        if ( ! empty(self::$_ee_message_type_registry)) {
             foreach (self::$_ee_message_type_registry as $mt_reg) {
                 if (empty($mt_reg['autoloadpaths'])) {
                     continue;
@@ -401,7 +401,7 @@ 
                 continue;
             }
             foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
-                $supports[ $messenger_slug ][] = $identifier;
+                $supports[$messenger_slug][] = $identifier;
             }
         }
         return $supports;
@@ -473,7 +473,7 @@ 
         $file_extension,
         EE_Messages_Template_Pack $template_pack
     ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
             return $base_path_or_url;
         }
         foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {

Indentation +457 added lines, -457 removed lines

@@ -10,487 +10,487 @@
  */
 class EE_Register_Message_Type implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered message types
-     *
-     * @var array
-     */
-    protected static $_ee_message_type_registry = [];
+	/**
+	 * Holds values for registered message types
+	 *
+	 * @var array
+	 */
+	protected static $_ee_message_type_registry = [];
 
 
-    /**
-     * Method for registering new message types in the EE_messages system.
-     * Note:  All message types must have the following files in order to work:
-     * Template files for default templates getting setup.
-     * See /core/libraries/messages/defaults/default/ for examples
-     * (note that template files match a specific naming schema).
-     * These templates will need to be registered with the default template pack.
-     * - EE_Messages_Validator extended class(es).  See /core/libraries/messages/validators/email/
-     *      for examples.  Note for any new message types, there will need to be a validator for each
-     *      messenger combo this message type can activate with.
-     * - And of course the main EE_{Message_Type_Name}_message_type class that defines the new
-     *      message type and its properties.
-     *
-     * @param string $identifier    Whatever is defined for the $name property of
-     *                              the message type you are registering (eg.
-     *                              declined_registration). Required.
-     * @param array  $setup_args    An array of arguments provided for registering the message type.
-     * @throws EE_Error
-     *                              }
-     * @see      inline docs in the register method for what can be passed in as arguments.
-     * @since    4.3.0
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (
-            ! isset($identifier)
-            || ! is_array($setup_args)
-            || empty($setup_args['mtfilename'])
-            || empty($setup_args['autoloadpaths'])
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * Method for registering new message types in the EE_messages system.
+	 * Note:  All message types must have the following files in order to work:
+	 * Template files for default templates getting setup.
+	 * See /core/libraries/messages/defaults/default/ for examples
+	 * (note that template files match a specific naming schema).
+	 * These templates will need to be registered with the default template pack.
+	 * - EE_Messages_Validator extended class(es).  See /core/libraries/messages/validators/email/
+	 *      for examples.  Note for any new message types, there will need to be a validator for each
+	 *      messenger combo this message type can activate with.
+	 * - And of course the main EE_{Message_Type_Name}_message_type class that defines the new
+	 *      message type and its properties.
+	 *
+	 * @param string $identifier    Whatever is defined for the $name property of
+	 *                              the message type you are registering (eg.
+	 *                              declined_registration). Required.
+	 * @param array  $setup_args    An array of arguments provided for registering the message type.
+	 * @throws EE_Error
+	 *                              }
+	 * @see      inline docs in the register method for what can be passed in as arguments.
+	 * @since    4.3.0
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (
+			! isset($identifier)
+			|| ! is_array($setup_args)
+			|| empty($setup_args['mtfilename'])
+			|| empty($setup_args['autoloadpaths'])
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_ee_message_type_registry[ $identifier ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_ee_message_type_registry[ $identifier ])) {
+			return;
+		}
 
-        // make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'A message type named "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.',
-                        'event_espresso'
-                    ),
-                    $identifier
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $__ee_message_type_registry array from incoming values.
-        self::$_ee_message_type_registry[ $identifier ] = [
-            /**
-             * The file name for the message type being registered.
-             * Required.
-             *
-             * @type string
-             */
-            'mtfilename'                                       => (string) $setup_args['mtfilename'],
-            /**
-             * Autoload paths for classes used by the message type.
-             * Required.
-             *
-             * @type array
-             */
-            'autoloadpaths'                                    => (array) $setup_args['autoloadpaths'],
-            /**
-             * Messengers that the message type should be able to activate with.
-             * Use messenger slugs.
-             *
-             * @type array
-             */
-            'messengers_to_activate_with'                      => ! empty($setup_args['messengers_to_activate_with'])
-                ? (array) $setup_args['messengers_to_activate_with']
-                : [],
-            /**
-             * Messengers that the message type should validate with.
-             * Use messenger slugs.
-             *
-             * @type array
-             */
-            'messengers_to_validate_with'                      => ! empty($setup_args['messengers_to_validate_with'])
-                ? (array) $setup_args['messengers_to_validate_with']
-                : [],
-            /**
-             * Whether to force activate this message type the first time it is registered.
-             *
-             * @type bool   False means its not activated by default and left up to the end user to activate.
-             */
-            'force_activation'                                 => ! empty($setup_args['force_activation'])
-                                                                  && $setup_args['force_activation'],
-            /**
-             * What messengers this message type supports the default template pack for.
-             * Note: If you do not set this (or any of the following template pack/variation related arguments) to true,
-             * then it is expected that the message type being registered is doing its own custom default template
-             * pack/variation registration.
-             *
-             * If this is set and has values, then it is expected that the following arguments are also set in the incoming options
-             * $setup_arguments array as well:
-             * - 'base_path_for_default_templates'
-             *
-             * @type array   Expect an array of messengers this supports default template packs for.
-             */
-            'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
-                ? (array) $setup_args['messengers_supporting_default_template_pack_with']
-                : [],
-            /**
-             * The base path where the default templates for this message type can be found.
-             *
-             * @type string
-             */
-            'base_path_for_default_templates'                  => isset($setup_args['base_path_for_default_templates'])
-                ? $setup_args['base_path_for_default_templates'] : '',
-            /**
-             * The base path where the default variations for this message type can be found.
-             *
-             * @type string
-             */
-            'base_path_for_default_variation'                  => isset($setup_args['base_path_for_default_variation'])
-                ? $setup_args['base_path_for_default_variation'] : '',
-            /**
-             * The base url for the default variations for this message type.
-             *
-             * @type string
-             */
-            'base_url_for_default_variation'                   => isset($setup_args['base_url_for_default_variation'])
-                ? $setup_args['base_url_for_default_variation'] : '',
-        ];
-        // add filters but only if they haven't already been set (these filters only need to be registered ONCE because
-        // the callback handles all registered message types.
-        if (
-            false === has_filter(
-                'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-                ['EE_Register_Message_Type', 'register_msgs_autoload_paths']
-            )
-        ) {
-            add_filter(
-                'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-                ['EE_Register_Message_Type', 'register_msgs_autoload_paths'],
-                10
-            );
-            add_filter(
-                'FHEE__EE_messages__get_installed__messagetype_files',
-                ['EE_Register_Message_Type', 'register_messagetype_files'],
-                10,
-                1
-            );
-            add_filter(
-                'FHEE__EE_messenger__get_default_message_types__default_types',
-                ['EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'],
-                10,
-                2
-            );
-            add_filter(
-                'FHEE__EE_messenger__get_valid_message_types__valid_types',
-                ['EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'],
-                10,
-                2
-            );
-            // actions
-            add_action(
-                'AHEE__EE_Addon__initialize_default_data__begin',
-                ['EE_Register_Message_Type', 'set_defaults']
-            );
+		// make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'A message type named "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.',
+						'event_espresso'
+					),
+					$identifier
+				),
+				'4.3.0'
+			);
+		}
+		// setup $__ee_message_type_registry array from incoming values.
+		self::$_ee_message_type_registry[ $identifier ] = [
+			/**
+			 * The file name for the message type being registered.
+			 * Required.
+			 *
+			 * @type string
+			 */
+			'mtfilename'                                       => (string) $setup_args['mtfilename'],
+			/**
+			 * Autoload paths for classes used by the message type.
+			 * Required.
+			 *
+			 * @type array
+			 */
+			'autoloadpaths'                                    => (array) $setup_args['autoloadpaths'],
+			/**
+			 * Messengers that the message type should be able to activate with.
+			 * Use messenger slugs.
+			 *
+			 * @type array
+			 */
+			'messengers_to_activate_with'                      => ! empty($setup_args['messengers_to_activate_with'])
+				? (array) $setup_args['messengers_to_activate_with']
+				: [],
+			/**
+			 * Messengers that the message type should validate with.
+			 * Use messenger slugs.
+			 *
+			 * @type array
+			 */
+			'messengers_to_validate_with'                      => ! empty($setup_args['messengers_to_validate_with'])
+				? (array) $setup_args['messengers_to_validate_with']
+				: [],
+			/**
+			 * Whether to force activate this message type the first time it is registered.
+			 *
+			 * @type bool   False means its not activated by default and left up to the end user to activate.
+			 */
+			'force_activation'                                 => ! empty($setup_args['force_activation'])
+																  && $setup_args['force_activation'],
+			/**
+			 * What messengers this message type supports the default template pack for.
+			 * Note: If you do not set this (or any of the following template pack/variation related arguments) to true,
+			 * then it is expected that the message type being registered is doing its own custom default template
+			 * pack/variation registration.
+			 *
+			 * If this is set and has values, then it is expected that the following arguments are also set in the incoming options
+			 * $setup_arguments array as well:
+			 * - 'base_path_for_default_templates'
+			 *
+			 * @type array   Expect an array of messengers this supports default template packs for.
+			 */
+			'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
+				? (array) $setup_args['messengers_supporting_default_template_pack_with']
+				: [],
+			/**
+			 * The base path where the default templates for this message type can be found.
+			 *
+			 * @type string
+			 */
+			'base_path_for_default_templates'                  => isset($setup_args['base_path_for_default_templates'])
+				? $setup_args['base_path_for_default_templates'] : '',
+			/**
+			 * The base path where the default variations for this message type can be found.
+			 *
+			 * @type string
+			 */
+			'base_path_for_default_variation'                  => isset($setup_args['base_path_for_default_variation'])
+				? $setup_args['base_path_for_default_variation'] : '',
+			/**
+			 * The base url for the default variations for this message type.
+			 *
+			 * @type string
+			 */
+			'base_url_for_default_variation'                   => isset($setup_args['base_url_for_default_variation'])
+				? $setup_args['base_url_for_default_variation'] : '',
+		];
+		// add filters but only if they haven't already been set (these filters only need to be registered ONCE because
+		// the callback handles all registered message types.
+		if (
+			false === has_filter(
+				'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+				['EE_Register_Message_Type', 'register_msgs_autoload_paths']
+			)
+		) {
+			add_filter(
+				'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+				['EE_Register_Message_Type', 'register_msgs_autoload_paths'],
+				10
+			);
+			add_filter(
+				'FHEE__EE_messages__get_installed__messagetype_files',
+				['EE_Register_Message_Type', 'register_messagetype_files'],
+				10,
+				1
+			);
+			add_filter(
+				'FHEE__EE_messenger__get_default_message_types__default_types',
+				['EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'],
+				10,
+				2
+			);
+			add_filter(
+				'FHEE__EE_messenger__get_valid_message_types__valid_types',
+				['EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'],
+				10,
+				2
+			);
+			// actions
+			add_action(
+				'AHEE__EE_Addon__initialize_default_data__begin',
+				['EE_Register_Message_Type', 'set_defaults']
+			);
 
-            // default template packs and variations related
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack_Default__get_supports',
-                ['EE_Register_Message_Type', 'register_default_template_pack_supports']
-            );
-            add_filter(
-                'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path',
-                ['EE_Register_Message_Type', 'register_base_template_path'],
-                10,
-                6
-            );
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url',
-                ['EE_Register_Message_Type', 'register_variation_base_path_or_url'],
-                10,
-                8
-            );
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack__get_variation__base_path',
-                ['EE_Register_Message_Type', 'register_variation_base_path_or_url'],
-                10,
-                8
-            );
-        }
-    }
+			// default template packs and variations related
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack_Default__get_supports',
+				['EE_Register_Message_Type', 'register_default_template_pack_supports']
+			);
+			add_filter(
+				'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path',
+				['EE_Register_Message_Type', 'register_base_template_path'],
+				10,
+				6
+			);
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url',
+				['EE_Register_Message_Type', 'register_variation_base_path_or_url'],
+				10,
+				8
+			);
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack__get_variation__base_path',
+				['EE_Register_Message_Type', 'register_variation_base_path_or_url'],
+				10,
+				8
+			);
+		}
+	}
 
 
-    /**
-     * This just ensures that when an addon registers a message type that on initial activation/reactivation the
-     * defaults the addon sets are taken care of.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_defaults()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	/**
+	 * This just ensures that when an addon registers a message type that on initial activation/reactivation the
+	 * defaults the addon sets are taken care of.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_defaults()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 
-        // for any message types with force activation, let's ensure they are activated
-        foreach (self::$_ee_message_type_registry as $identifier => $settings) {
-            if ($settings['force_activation']) {
-                foreach ($settings['messengers_to_activate_with'] as $messenger) {
-                    // DO not force activation if this message type has already been activated in the system
-                    if (
-                        ! $message_resource_manager->has_message_type_been_activated_for_messenger(
-                            $identifier,
-                            $messenger
-                        )
-                    ) {
-                        $message_resource_manager->ensure_message_type_is_active($identifier, $messenger);
-                    }
-                }
-            }
-        }
-    }
+		// for any message types with force activation, let's ensure they are activated
+		foreach (self::$_ee_message_type_registry as $identifier => $settings) {
+			if ($settings['force_activation']) {
+				foreach ($settings['messengers_to_activate_with'] as $messenger) {
+					// DO not force activation if this message type has already been activated in the system
+					if (
+						! $message_resource_manager->has_message_type_been_activated_for_messenger(
+							$identifier,
+							$messenger
+						)
+					) {
+						$message_resource_manager->ensure_message_type_is_active($identifier, $messenger);
+					}
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters a message type that was previously registered with a specific message_type_name.
-     *
-     * @param string $identifier the name for the message type that was previously registered
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since    4.3.0
-     */
-    public static function deregister($identifier = '')
-    {
-        if (! empty(self::$_ee_message_type_registry[ $identifier ])) {
-            // let's make sure that we remove any place this message type was made active
-            /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-            $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            // ensures that if this message type is registered again that it retains its previous active state vs
-            // remaining inactive.
-            $Message_Resource_Manager->remove_message_type_has_been_activated_from_all_messengers(
-                $identifier,
-                true
-            );
-            $Message_Resource_Manager->deactivate_message_type($identifier, false);
-        }
-        unset(self::$_ee_message_type_registry[ $identifier ]);
-    }
+	/**
+	 * This deregisters a message type that was previously registered with a specific message_type_name.
+	 *
+	 * @param string $identifier the name for the message type that was previously registered
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since    4.3.0
+	 */
+	public static function deregister($identifier = '')
+	{
+		if (! empty(self::$_ee_message_type_registry[ $identifier ])) {
+			// let's make sure that we remove any place this message type was made active
+			/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+			$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			// ensures that if this message type is registered again that it retains its previous active state vs
+			// remaining inactive.
+			$Message_Resource_Manager->remove_message_type_has_been_activated_from_all_messengers(
+				$identifier,
+				true
+			);
+			$Message_Resource_Manager->deactivate_message_type($identifier, false);
+		}
+		unset(self::$_ee_message_type_registry[ $identifier ]);
+	}
 
 
-    /**
-     * callback for FHEE__EE_messages__get_installed__messagetype_files filter.
-     *
-     * @param array $messagetype_files The current array of message type file names
-     * @return  array                                 Array of message type file names
-     * @since   4.3.0
-     */
-    public static function register_messagetype_files(array $messagetype_files)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $messagetype_files;
-        }
-        foreach (self::$_ee_message_type_registry as $mt_reg) {
-            if (empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            $messagetype_files[] = $mt_reg['mtfilename'];
-        }
-        return $messagetype_files;
-    }
+	/**
+	 * callback for FHEE__EE_messages__get_installed__messagetype_files filter.
+	 *
+	 * @param array $messagetype_files The current array of message type file names
+	 * @return  array                                 Array of message type file names
+	 * @since   4.3.0
+	 */
+	public static function register_messagetype_files(array $messagetype_files)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $messagetype_files;
+		}
+		foreach (self::$_ee_message_type_registry as $mt_reg) {
+			if (empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			$messagetype_files[] = $mt_reg['mtfilename'];
+		}
+		return $messagetype_files;
+	}
 
 
-    /**
-     * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
-     *
-     * @param array $paths array of paths to be checked by EE_messages autoloader.
-     * @return array
-     * @since    4.3.0
-     */
-    public static function register_msgs_autoload_paths(array $paths)
-    {
-        if (! empty(self::$_ee_message_type_registry)) {
-            foreach (self::$_ee_message_type_registry as $mt_reg) {
-                if (empty($mt_reg['autoloadpaths'])) {
-                    continue;
-                }
-                $paths = array_merge($paths, $mt_reg['autoloadpaths']);
-            }
-        }
-        return $paths;
-    }
+	/**
+	 * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
+	 *
+	 * @param array $paths array of paths to be checked by EE_messages autoloader.
+	 * @return array
+	 * @since    4.3.0
+	 */
+	public static function register_msgs_autoload_paths(array $paths)
+	{
+		if (! empty(self::$_ee_message_type_registry)) {
+			foreach (self::$_ee_message_type_registry as $mt_reg) {
+				if (empty($mt_reg['autoloadpaths'])) {
+					continue;
+				}
+				$paths = array_merge($paths, $mt_reg['autoloadpaths']);
+			}
+		}
+		return $paths;
+	}
 
 
-    /**
-     * callback for FHEE__EE_messenger__get_default_message_types__default_types filter.
-     *
-     * @param array        $default_types   array of message types activated with messenger (
-     *                                      corresponds to the $name property of message type)
-     * @param EE_messenger $messenger       The EE_messenger the filter is called from.
-     * @return array
-     * @since  4.3.0
-     */
-    public static function register_messengers_to_activate_mt_with(array $default_types, EE_messenger $messenger)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $default_types;
-        }
-        foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {
-            if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            // loop through each of the messengers and if it matches the loaded class
-            // then we add this message type to the
-            foreach ($mt_reg['messengers_to_activate_with'] as $msgr) {
-                if ($messenger->name == $msgr) {
-                    $default_types[] = $identifier;
-                }
-            }
-        }
+	/**
+	 * callback for FHEE__EE_messenger__get_default_message_types__default_types filter.
+	 *
+	 * @param array        $default_types   array of message types activated with messenger (
+	 *                                      corresponds to the $name property of message type)
+	 * @param EE_messenger $messenger       The EE_messenger the filter is called from.
+	 * @return array
+	 * @since  4.3.0
+	 */
+	public static function register_messengers_to_activate_mt_with(array $default_types, EE_messenger $messenger)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $default_types;
+		}
+		foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {
+			if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			// loop through each of the messengers and if it matches the loaded class
+			// then we add this message type to the
+			foreach ($mt_reg['messengers_to_activate_with'] as $msgr) {
+				if ($messenger->name == $msgr) {
+					$default_types[] = $identifier;
+				}
+			}
+		}
 
-        return $default_types;
-    }
+		return $default_types;
+	}
 
 
-    /**
-     * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter.
-     *
-     * @param array        $valid_types     array of message types valid with messenger (
-     *                                      corresponds to the $name property of message type)
-     * @param EE_messenger $messenger       The EE_messenger the filter is called from.
-     * @return  array
-     * @since   4.3.0
-     */
-    public static function register_messengers_to_validate_mt_with(array $valid_types, EE_messenger $messenger)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $valid_types;
-        }
-        foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {
-            if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            // loop through each of the messengers and if it matches the loaded class
-            // then we add this message type to the
-            foreach ($mt_reg['messengers_to_validate_with'] as $msgr) {
-                if ($messenger->name == $msgr) {
-                    $valid_types[] = $identifier;
-                }
-            }
-        }
+	/**
+	 * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter.
+	 *
+	 * @param array        $valid_types     array of message types valid with messenger (
+	 *                                      corresponds to the $name property of message type)
+	 * @param EE_messenger $messenger       The EE_messenger the filter is called from.
+	 * @return  array
+	 * @since   4.3.0
+	 */
+	public static function register_messengers_to_validate_mt_with(array $valid_types, EE_messenger $messenger)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $valid_types;
+		}
+		foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {
+			if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			// loop through each of the messengers and if it matches the loaded class
+			// then we add this message type to the
+			foreach ($mt_reg['messengers_to_validate_with'] as $msgr) {
+				if ($messenger->name == $msgr) {
+					$valid_types[] = $identifier;
+				}
+			}
+		}
 
-        return $valid_types;
-    }
+		return $valid_types;
+	}
 
 
-    /**
-     * Callback for `FHEE__EE_Messages_Template_Pack_Default__get_supports` filter to register this message type as
-     * supporting the default template pack
-     *
-     * @param array $supports
-     *
-     * @return array
-     */
-    public static function register_default_template_pack_supports(array $supports)
-    {
-        foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {
-            if (empty($mt_reg['messengers_supporting_default_template_pack_with'])) {
-                continue;
-            }
-            foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
-                $supports[ $messenger_slug ][] = $identifier;
-            }
-        }
-        return $supports;
-    }
+	/**
+	 * Callback for `FHEE__EE_Messages_Template_Pack_Default__get_supports` filter to register this message type as
+	 * supporting the default template pack
+	 *
+	 * @param array $supports
+	 *
+	 * @return array
+	 */
+	public static function register_default_template_pack_supports(array $supports)
+	{
+		foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {
+			if (empty($mt_reg['messengers_supporting_default_template_pack_with'])) {
+				continue;
+			}
+			foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
+				$supports[ $messenger_slug ][] = $identifier;
+			}
+		}
+		return $supports;
+	}
 
 
-    /**
-     * Callback for FHEE__EE_Template_Pack___get_specific_template__filtered_base_path
-     *
-     * @param string                    $base_path The original base path for message templates
-     * @param EE_messenger              $messenger
-     * @param EE_message_type           $message_type
-     * @param string                    $field     The field requesting a template
-     * @param string                    $context   The context requesting a template
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string
-     */
-    public static function register_base_template_path(
-        $base_path,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $field,
-        $context,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        if (
-            ! $template_pack instanceof EE_Messages_Template_Pack_Default
-            || ! $message_type instanceof EE_message_type
-        ) {
-            return $base_path;
-        }
-        foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {
-            if (
-                $message_type->name === $identifier
-                && ! empty($mt_reg['base_path_for_default_templates'])
-            ) {
-                return $mt_reg['base_path_for_default_templates'];
-            }
-        }
-        return $base_path;
-    }
+	/**
+	 * Callback for FHEE__EE_Template_Pack___get_specific_template__filtered_base_path
+	 *
+	 * @param string                    $base_path The original base path for message templates
+	 * @param EE_messenger              $messenger
+	 * @param EE_message_type           $message_type
+	 * @param string                    $field     The field requesting a template
+	 * @param string                    $context   The context requesting a template
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string
+	 */
+	public static function register_base_template_path(
+		$base_path,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$field,
+		$context,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		if (
+			! $template_pack instanceof EE_Messages_Template_Pack_Default
+			|| ! $message_type instanceof EE_message_type
+		) {
+			return $base_path;
+		}
+		foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {
+			if (
+				$message_type->name === $identifier
+				&& ! empty($mt_reg['base_path_for_default_templates'])
+			) {
+				return $mt_reg['base_path_for_default_templates'];
+			}
+		}
+		return $base_path;
+	}
 
 
-    /**
-     * Callback for FHEE__EE_Messages_Template_Pack__get_variation__base_path and
-     * FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url hooks
-     *
-     * @param string                    $base_path_or_url  The original incoming base url or path
-     * @param string                    $messenger_slug    The slug of the messenger the template is being generated
-     *                                                     for.
-     * @param string                    $message_type_slug The slug of the message type the template is being generated
-     *                                                     for.
-     * @param string                    $type              The "type" of css being requested.
-     * @param string                    $variation         The variation being requested.
-     * @param bool                      $url               whether a url or path is being requested.
-     * @param string                    $file_extension    What file extension is expected for the variation file.
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string
-     */
-    public static function register_variation_base_path_or_url(
-        $base_path_or_url,
-        $messenger_slug,
-        $message_type_slug,
-        $type,
-        $variation,
-        $url,
-        $file_extension,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $base_path_or_url;
-        }
-        foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {
-            if (
-                $identifier === $message_type_slug
-            ) {
-                if (
-                    $url
-                    && ! empty($mt_reg['base_url_for_default_variation'])
-                ) {
-                    return $mt_reg['base_url_for_default_variation'];
-                } elseif (
-                    ! $url
-                          && ! empty($mt_reg['base_path_for_default_variation'])
-                ) {
-                    return $mt_reg['base_path_for_default_variation'];
-                }
-            }
-        }
-        return $base_path_or_url;
-    }
+	/**
+	 * Callback for FHEE__EE_Messages_Template_Pack__get_variation__base_path and
+	 * FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url hooks
+	 *
+	 * @param string                    $base_path_or_url  The original incoming base url or path
+	 * @param string                    $messenger_slug    The slug of the messenger the template is being generated
+	 *                                                     for.
+	 * @param string                    $message_type_slug The slug of the message type the template is being generated
+	 *                                                     for.
+	 * @param string                    $type              The "type" of css being requested.
+	 * @param string                    $variation         The variation being requested.
+	 * @param bool                      $url               whether a url or path is being requested.
+	 * @param string                    $file_extension    What file extension is expected for the variation file.
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string
+	 */
+	public static function register_variation_base_path_or_url(
+		$base_path_or_url,
+		$messenger_slug,
+		$message_type_slug,
+		$type,
+		$variation,
+		$url,
+		$file_extension,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $base_path_or_url;
+		}
+		foreach (self::$_ee_message_type_registry as $identifier => $mt_reg) {
+			if (
+				$identifier === $message_type_slug
+			) {
+				if (
+					$url
+					&& ! empty($mt_reg['base_url_for_default_variation'])
+				) {
+					return $mt_reg['base_url_for_default_variation'];
+				} elseif (
+					! $url
+						  && ! empty($mt_reg['base_path_for_default_variation'])
+				) {
+					return $mt_reg['base_path_for_default_variation'];
+				}
+			}
+		}
+		return $base_path_or_url;
+	}
 }

core/libraries/plugin_api/EE_Register_Module.lib.php

Spacing +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $identifier ])) {
+        if (isset(self::$_settings[$identifier])) {
             return;
         }
 
@@ -67,7 +67,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $identifier ] = [
+        self::$_settings[$identifier] = [
             // array of full server paths to any EED_Modules used by the module
             'module_paths' => isset($setup_args['module_paths']) ? (array) $setup_args['module_paths'] : [],
         ];
@@ -105,6 +105,6 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$_settings[ $identifier ]);
+        unset(self::$_settings[$identifier]);
     }
 }

Indentation +84 added lines, -84 removed lines

@@ -14,96 +14,96 @@
  */
 class EE_Register_Module implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered modules
-     *
-     * @var array
-     */
-    protected static $_settings = [];
+	/**
+	 * Holds values for registered modules
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
 
 
-    /**
-     *    Method for registering new EED_Modules
-     *
-     * @param string $identifier a unique identifier for this set of modules Required.
-     * @param array  $setup_args an array of full server paths to folders containing any EED_Modules, or to the
-     *                           EED_Module files themselves Required.
-     * @type    array module_paths    an array of full server paths to folders containing any EED_Modules, or to the
-     *                           EED_Module files themselves
-     * @return void
-     * @throws EE_Error
-     * @since    4.3.0
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($identifier) || ! is_array($setup_args) || empty($setup_args['module_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Modules with EE_Register_Module::register(), you must include a "module_id" (a unique identifier for this set of modules), and an array containing the following keys: "module_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 *    Method for registering new EED_Modules
+	 *
+	 * @param string $identifier a unique identifier for this set of modules Required.
+	 * @param array  $setup_args an array of full server paths to folders containing any EED_Modules, or to the
+	 *                           EED_Module files themselves Required.
+	 * @type    array module_paths    an array of full server paths to folders containing any EED_Modules, or to the
+	 *                           EED_Module files themselves
+	 * @return void
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($identifier) || ! is_array($setup_args) || empty($setup_args['module_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Modules with EE_Register_Module::register(), you must include a "module_id" (a unique identifier for this set of modules), and an array containing the following keys: "module_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $identifier ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $identifier ])) {
+			return;
+		}
 
-        // make sure this was called in the right place!
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $identifier ] = [
-            // array of full server paths to any EED_Modules used by the module
-            'module_paths' => isset($setup_args['module_paths']) ? (array) $setup_args['module_paths'] : [],
-        ];
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            ['EE_Register_Module', 'add_modules']
-        );
-    }
+		// make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $identifier ] = [
+			// array of full server paths to any EED_Modules used by the module
+			'module_paths' => isset($setup_args['module_paths']) ? (array) $setup_args['module_paths'] : [],
+		];
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			['EE_Register_Module', 'add_modules']
+		);
+	}
 
 
-    /**
-     * Filters the list of modules to add ours.
-     * and they're just full filepaths to FOLDERS containing a module class file. Eg.
-     * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey'...)
-     *
-     * @param array $modules_to_register array of paths to all modules that require registering
-     * @return array
-     */
-    public static function add_modules(array $modules_to_register)
-    {
-        foreach (self::$_settings as $settings) {
-            $modules_to_register = array_merge($modules_to_register, $settings['module_paths']);
-        }
-        return $modules_to_register;
-    }
+	/**
+	 * Filters the list of modules to add ours.
+	 * and they're just full filepaths to FOLDERS containing a module class file. Eg.
+	 * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey'...)
+	 *
+	 * @param array $modules_to_register array of paths to all modules that require registering
+	 * @return array
+	 */
+	public static function add_modules(array $modules_to_register)
+	{
+		foreach (self::$_settings as $settings) {
+			$modules_to_register = array_merge($modules_to_register, $settings['module_paths']);
+		}
+		return $modules_to_register;
+	}
 
 
-    /**
-     * This deregisters a module that was previously registered with a specific $identifier.
-     *
-     * @param string $identifier the name for the module that was previously registered
-     * @return void
-     * @since    4.3.0
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$_settings[ $identifier ]);
-    }
+	/**
+	 * This deregisters a module that was previously registered with a specific $identifier.
+	 *
+	 * @param string $identifier the name for the module that was previously registered
+	 * @return void
+	 * @since    4.3.0
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$_settings[ $identifier ]);
+	}
 }

core/libraries/plugin_api/EE_Register_Model.lib.php

Spacing +8 added lines, -8 removed lines

@@ -58,7 +58,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_model_registry[ $identifier ])) {
+        if (isset(self::$_model_registry[$identifier])) {
             return;
         }
 
@@ -79,11 +79,11 @@ 
                 '4.5'
             );
         }
-        self::$_model_registry[ $identifier ] = $setup_args;
+        self::$_model_registry[$identifier] = $setup_args;
 
         if (
             (isset($setup_args['model_paths']) && ! isset($setup_args['class_paths']))
-            || (! isset($setup_args['model_paths']) && isset($setup_args['class_paths']))
+            || ( ! isset($setup_args['model_paths']) && isset($setup_args['class_paths']))
         ) {
             throw new EE_Error(
                 sprintf(
@@ -97,7 +97,7 @@ 
         }
         if (isset($setup_args['model_paths'])) {
             // make sure they passed in an array
-            if (! is_array($setup_args['model_paths'])) {
+            if ( ! is_array($setup_args['model_paths'])) {
                 $setup_args['model_paths'] = [$setup_args['model_paths']];
             }
             // we want to add this as a model folder
@@ -106,9 +106,9 @@ 
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             $model_name_to_classname_map = [];
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                $model_name_to_classname_map[ str_replace("EEM_", "", $classname) ] = $classname;
+                $model_name_to_classname_map[str_replace("EEM_", "", $classname)] = $classname;
             }
-            self::$_model_name_to_classname_map[ $identifier ] = $model_name_to_classname_map;
+            self::$_model_name_to_classname_map[$identifier] = $model_name_to_classname_map;
             add_filter('FHEE__EE_System__parse_model_names', ['EE_Register_Model', 'add_addon_models']);
             add_filter(
                 'FHEE__EE_System__parse_implemented_model_names',
@@ -119,7 +119,7 @@ 
         }
         if (isset($setup_args['class_paths'])) {
             // make sure they passed in an array
-            if (! is_array($setup_args['class_paths'])) {
+            if ( ! is_array($setup_args['class_paths'])) {
                 $setup_args['class_paths'] = [$setup_args['class_paths']];
             }
             $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_paths']);
@@ -192,6 +192,6 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$_model_registry[ $identifier ], self::$_model_name_to_classname_map[ $identifier ]);
+        unset(self::$_model_registry[$identifier], self::$_model_name_to_classname_map[$identifier]);
     }
 }

Indentation +169 added lines, -169 removed lines

@@ -11,187 +11,187 @@
  */
 class EE_Register_Model implements EEI_Plugin_API
 {
-    /**
-     *
-     * @var array keys are the model_id used to register with, values are the array provided to register them, exactly
-     *      like EE_Register_Model::register()'s 2nd arg
-     */
-    protected static $_model_registry;
+	/**
+	 *
+	 * @var array keys are the model_id used to register with, values are the array provided to register them, exactly
+	 *      like EE_Register_Model::register()'s 2nd arg
+	 */
+	protected static $_model_registry;
 
-    /**
-     *
-     * @var array keys are model names, values are their class names. Stored on registration and used
-     * on a hook
-     */
-    protected static $_model_name_to_classname_map;
+	/**
+	 *
+	 * @var array keys are model names, values are their class names. Stored on registration and used
+	 * on a hook
+	 */
+	protected static $_model_name_to_classname_map;
 
 
-    /**
-     * @param string $identifier  unique id for it
-     * @param array  $setup_args  {
-     * @type array   $model_paths array of folders containing DB models, where each file follows the models naming
-     *                            convention, which is: EEM_{model_name}.model.php which contains a single class called
-     *                            EEM_{model_name}. Eg. you could pass
-     *                            "public_html/wp-content/plugins/my_addon/db_models" (with or without trailing slash)
-     *                            and in that folder put each of your model files, like "EEM_Food.model.php" which
-     *                            contains the class "EEM_Food" and
-     *                            "EEM_Monkey.model.php" which contains the class "EEM_Monkey". These will be
-     *                            autoloaded and added to the EE registry so they can be used like ordinary models. The
-     *                            class contained in each file should extend EEM_Base.
-     * @type array   $class_paths array of folders containing DB classes, where each file follows the model class
-     *                            naming convention, which is EE_{model_name}.class.php. The class contained in each
-     *                            file should extend EE_Base_Class
-     *
-     * }
-     * @throws EE_Error
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($identifier) || ! is_array($setup_args) || empty($setup_args['model_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Models with EE_Register_Model::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_paths" (an array of full server paths to folders that contain models)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * @param string $identifier  unique id for it
+	 * @param array  $setup_args  {
+	 * @type array   $model_paths array of folders containing DB models, where each file follows the models naming
+	 *                            convention, which is: EEM_{model_name}.model.php which contains a single class called
+	 *                            EEM_{model_name}. Eg. you could pass
+	 *                            "public_html/wp-content/plugins/my_addon/db_models" (with or without trailing slash)
+	 *                            and in that folder put each of your model files, like "EEM_Food.model.php" which
+	 *                            contains the class "EEM_Food" and
+	 *                            "EEM_Monkey.model.php" which contains the class "EEM_Monkey". These will be
+	 *                            autoloaded and added to the EE registry so they can be used like ordinary models. The
+	 *                            class contained in each file should extend EEM_Base.
+	 * @type array   $class_paths array of folders containing DB classes, where each file follows the model class
+	 *                            naming convention, which is EE_{model_name}.class.php. The class contained in each
+	 *                            file should extend EE_Base_Class
+	 *
+	 * }
+	 * @throws EE_Error
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($identifier) || ! is_array($setup_args) || empty($setup_args['model_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Models with EE_Register_Model::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_paths" (an array of full server paths to folders that contain models)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_model_registry[ $identifier ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_model_registry[ $identifier ])) {
+			return;
+		}
 
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('FHEE__EE_System__parse_model_names')
-            || did_action('FHEE__EE_System__parse_implemented_model_names')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'An attempt was made to register "%s" as a group models has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.',
-                        'event_espresso'
-                    ),
-                    $identifier
-                ),
-                '4.5'
-            );
-        }
-        self::$_model_registry[ $identifier ] = $setup_args;
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('FHEE__EE_System__parse_model_names')
+			|| did_action('FHEE__EE_System__parse_implemented_model_names')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'An attempt was made to register "%s" as a group models has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.',
+						'event_espresso'
+					),
+					$identifier
+				),
+				'4.5'
+			);
+		}
+		self::$_model_registry[ $identifier ] = $setup_args;
 
-        if (
-            (isset($setup_args['model_paths']) && ! isset($setup_args['class_paths']))
-            || (! isset($setup_args['model_paths']) && isset($setup_args['class_paths']))
-        ) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'You must register both "model_paths" AND "class_paths", not just one or the other You provided %s',
-                        'event_espresso'
-                    ),
-                    implode(", ", array_keys($setup_args))
-                )
-            );
-        }
-        if (isset($setup_args['model_paths'])) {
-            // make sure they passed in an array
-            if (! is_array($setup_args['model_paths'])) {
-                $setup_args['model_paths'] = [$setup_args['model_paths']];
-            }
-            // we want to add this as a model folder
-            // and autoload them all
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_paths']);
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            $model_name_to_classname_map = [];
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                $model_name_to_classname_map[ str_replace("EEM_", "", $classname) ] = $classname;
-            }
-            self::$_model_name_to_classname_map[ $identifier ] = $model_name_to_classname_map;
-            add_filter('FHEE__EE_System__parse_model_names', ['EE_Register_Model', 'add_addon_models']);
-            add_filter(
-                'FHEE__EE_System__parse_implemented_model_names',
-                ['EE_Register_Model', 'add_addon_models']
-            );
-            add_filter('FHEE__EE_Registry__load_model__paths', ['EE_Register_Model', 'add_model_folders']);
-            unset($setup_args['model_paths']);
-        }
-        if (isset($setup_args['class_paths'])) {
-            // make sure they passed in an array
-            if (! is_array($setup_args['class_paths'])) {
-                $setup_args['class_paths'] = [$setup_args['class_paths']];
-            }
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_paths']);
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            add_filter('FHEE__EE_Registry__load_class__paths', ['EE_Register_Model', 'add_class_folders']);
-            unset($setup_args['class_paths']);
-        }
-        foreach ($setup_args as $unknown_key => $unknown_config) {
-            self::deregister($identifier);
-            throw new EE_Error(
-                sprintf(esc_html__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
-            );
-        }
-    }
+		if (
+			(isset($setup_args['model_paths']) && ! isset($setup_args['class_paths']))
+			|| (! isset($setup_args['model_paths']) && isset($setup_args['class_paths']))
+		) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'You must register both "model_paths" AND "class_paths", not just one or the other You provided %s',
+						'event_espresso'
+					),
+					implode(", ", array_keys($setup_args))
+				)
+			);
+		}
+		if (isset($setup_args['model_paths'])) {
+			// make sure they passed in an array
+			if (! is_array($setup_args['model_paths'])) {
+				$setup_args['model_paths'] = [$setup_args['model_paths']];
+			}
+			// we want to add this as a model folder
+			// and autoload them all
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_paths']);
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			$model_name_to_classname_map = [];
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				$model_name_to_classname_map[ str_replace("EEM_", "", $classname) ] = $classname;
+			}
+			self::$_model_name_to_classname_map[ $identifier ] = $model_name_to_classname_map;
+			add_filter('FHEE__EE_System__parse_model_names', ['EE_Register_Model', 'add_addon_models']);
+			add_filter(
+				'FHEE__EE_System__parse_implemented_model_names',
+				['EE_Register_Model', 'add_addon_models']
+			);
+			add_filter('FHEE__EE_Registry__load_model__paths', ['EE_Register_Model', 'add_model_folders']);
+			unset($setup_args['model_paths']);
+		}
+		if (isset($setup_args['class_paths'])) {
+			// make sure they passed in an array
+			if (! is_array($setup_args['class_paths'])) {
+				$setup_args['class_paths'] = [$setup_args['class_paths']];
+			}
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_paths']);
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			add_filter('FHEE__EE_Registry__load_class__paths', ['EE_Register_Model', 'add_class_folders']);
+			unset($setup_args['class_paths']);
+		}
+		foreach ($setup_args as $unknown_key => $unknown_config) {
+			self::deregister($identifier);
+			throw new EE_Error(
+				sprintf(esc_html__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
+			);
+		}
+	}
 
 
-    /**
-     * Filters the core list of models
-     *
-     * @param array $core_models
-     * @return array keys are model names (eg 'Event') and values are their classes (eg 'EE_Event')
-     */
-    public static function add_addon_models(array $core_models = [])
-    {
-        foreach (self::$_model_name_to_classname_map as $model_name_to_class_map) {
-            $core_models = array_merge($core_models, $model_name_to_class_map);
-        }
-        return $core_models;
-    }
+	/**
+	 * Filters the core list of models
+	 *
+	 * @param array $core_models
+	 * @return array keys are model names (eg 'Event') and values are their classes (eg 'EE_Event')
+	 */
+	public static function add_addon_models(array $core_models = [])
+	{
+		foreach (self::$_model_name_to_classname_map as $model_name_to_class_map) {
+			$core_models = array_merge($core_models, $model_name_to_class_map);
+		}
+		return $core_models;
+	}
 
 
-    /**
-     * Filters the list of model folders
-     *
-     * @param array $folders
-     * @return array of folder paths
-     */
-    public static function add_model_folders(array $folders = [])
-    {
-        foreach (self::$_model_registry as $setup_args) {
-            if (isset($setup_args['model_paths'])) {
-                $folders = array_merge($folders, $setup_args['model_paths']);
-            }
-        }
-        return $folders;
-    }
+	/**
+	 * Filters the list of model folders
+	 *
+	 * @param array $folders
+	 * @return array of folder paths
+	 */
+	public static function add_model_folders(array $folders = [])
+	{
+		foreach (self::$_model_registry as $setup_args) {
+			if (isset($setup_args['model_paths'])) {
+				$folders = array_merge($folders, $setup_args['model_paths']);
+			}
+		}
+		return $folders;
+	}
 
 
-    /**
-     * Filters the array of model class paths
-     *
-     * @param array $folders
-     * @return array of folder paths
-     */
-    public static function add_class_folders(array $folders = [])
-    {
-        foreach (self::$_model_registry as $setup_args) {
-            if (isset($setup_args['class_paths'])) {
-                $folders = array_merge($folders, $setup_args['class_paths']);
-            }
-        }
-        return $folders;
-    }
+	/**
+	 * Filters the array of model class paths
+	 *
+	 * @param array $folders
+	 * @return array of folder paths
+	 */
+	public static function add_class_folders(array $folders = [])
+	{
+		foreach (self::$_model_registry as $setup_args) {
+			if (isset($setup_args['class_paths'])) {
+				$folders = array_merge($folders, $setup_args['class_paths']);
+			}
+		}
+		return $folders;
+	}
 
 
-    /**
-     * deregister
-     *
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$_model_registry[ $identifier ], self::$_model_name_to_classname_map[ $identifier ]);
-    }
+	/**
+	 * deregister
+	 *
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$_model_registry[ $identifier ], self::$_model_name_to_classname_map[ $identifier ]);
+	}
 }