eventespresso / event-espresso-core

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|EE_Cart|EE_Checkout|EE_Transaction
-     */
-    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|EE_Cart|EE_Checkout|EE_Transaction
+	 */
+	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

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;

Indentation +212 added lines, -212 removed lines

@@ -23,218 +23,218 @@
  */
 class ModelObjNode extends BaseNode
 {
-    /**
-     * @var int|string
-     */
-    protected $id;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $model;
-
-    /**
-     * @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;
-    }
-
-
-    /**
-     * Creates a relation node for each relation of this model's relations.
-     * Does NOT call `discover` on them yet though.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    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);
-    }
-
-    /**
-     * @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.
-     *
-     * @param $model_objects_to_identify
-     * @return int units of work done
-     * @since 4.10.12.p
-     */
-    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;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    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;
-    }
-
-
-    /**
-     * @return array|mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @since 4.10.12.p
-     */
-    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()
-        );
-    }
-
-
-    /**
-     * Use the dynamic properties to instantiate the models we use.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    public function __wakeup()
-    {
-        $this->model = EE_Registry::instance()->load_model($this->m);
-        parent::__wakeup();
-    }
+	/**
+	 * @var int|string
+	 */
+	protected $id;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $model;
+
+	/**
+	 * @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;
+	}
+
+
+	/**
+	 * Creates a relation node for each relation of this model's relations.
+	 * Does NOT call `discover` on them yet though.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	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);
+	}
+
+	/**
+	 * @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.
+	 *
+	 * @param $model_objects_to_identify
+	 * @return int units of work done
+	 * @since 4.10.12.p
+	 */
+	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;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	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;
+	}
+
+
+	/**
+	 * @return array|mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @since 4.10.12.p
+	 */
+	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()
+		);
+	}
+
+
+	/**
+	 * Use the dynamic properties to instantiate the models we use.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	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

core/EED_Module.module.php

Spacing +2 added lines, -2 removed lines

@@ -133,7 +133,7 @@ 
     protected static function getRequest()
     {
         static $request;
-        if (! $request instanceof RequestInterface) {
+        if ( ! $request instanceof RequestInterface) {
             $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
         }
         return $request;
@@ -147,7 +147,7 @@ 
     protected static function getResponse()
     {
         static $response;
-        if (! $response instanceof RequestInterface) {
+        if ( ! $response instanceof RequestInterface) {
             $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
         }
         return $response;

Indentation +137 added lines, -137 removed lines

@@ -14,141 +14,141 @@
  */
 abstract class EED_Module extends EE_Configurable implements ResettableInterface
 {
-    /**
-     * rendered output to be returned to WP
-     *
-     * @var    string $output
-     */
-    protected $output = '';
-
-    /**
-     * the current active espresso template theme
-     *
-     * @var    string $theme
-     */
-    protected $theme = '';
-
-
-    /**
-     * @return void
-     */
-    public static function reset()
-    {
-        $module_name = get_called_class();
-        new $module_name();
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     *    run - initial module setup
-     *    this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
-     *
-     * @access    public
-     * @var            WP $WP
-     * @return    void
-     */
-    abstract public function run($WP);
-
-
-    /**
-     * EED_Module constructor.
-     */
-    final public function __construct()
-    {
-        $this->theme = EE_Config::get_current_theme();
-        $module_name = $this->module_name();
-        EE_Registry::instance()->modules->{$module_name} = $this;
-    }
-
-
-    /**
-     * @param string $module_name
-     * @return EED_Module|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function get_instance($module_name = '')
-    {
-        $module_name = ! empty($module_name)
-            ? $module_name
-            : get_called_class();
-        if (
-            ! isset(EE_Registry::instance()->modules->{$module_name})
-            || ! EE_Registry::instance()->modules->{$module_name} instanceof EED_Module
-        ) {
-            EE_Registry::instance()->add_module($module_name);
-        }
-        return EE_Registry::instance()->get_module($module_name);
-    }
-
-
-    /**
-     *    module_name
-     *
-     * @access    public
-     * @return    string
-     */
-    public function module_name()
-    {
-        return get_class($this);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function theme()
-    {
-        return $this->theme;
-    }
-
-
-    /**
-     * @return RequestInterface
-     * @since   4.10.14.p
-     */
-    protected static function getRequest()
-    {
-        static $request;
-        if (! $request instanceof RequestInterface) {
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        }
-        return $request;
-    }
-
-
-    /**
-     * @return ResponseInterface
-     * @since   4.10.14.p
-     */
-    protected static function getResponse()
-    {
-        static $response;
-        if (! $response instanceof RequestInterface) {
-            $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
-        }
-        return $response;
-    }
+	/**
+	 * rendered output to be returned to WP
+	 *
+	 * @var    string $output
+	 */
+	protected $output = '';
+
+	/**
+	 * the current active espresso template theme
+	 *
+	 * @var    string $theme
+	 */
+	protected $theme = '';
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset()
+	{
+		$module_name = get_called_class();
+		new $module_name();
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *    this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
+	 *
+	 * @access    public
+	 * @var            WP $WP
+	 * @return    void
+	 */
+	abstract public function run($WP);
+
+
+	/**
+	 * EED_Module constructor.
+	 */
+	final public function __construct()
+	{
+		$this->theme = EE_Config::get_current_theme();
+		$module_name = $this->module_name();
+		EE_Registry::instance()->modules->{$module_name} = $this;
+	}
+
+
+	/**
+	 * @param string $module_name
+	 * @return EED_Module|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function get_instance($module_name = '')
+	{
+		$module_name = ! empty($module_name)
+			? $module_name
+			: get_called_class();
+		if (
+			! isset(EE_Registry::instance()->modules->{$module_name})
+			|| ! EE_Registry::instance()->modules->{$module_name} instanceof EED_Module
+		) {
+			EE_Registry::instance()->add_module($module_name);
+		}
+		return EE_Registry::instance()->get_module($module_name);
+	}
+
+
+	/**
+	 *    module_name
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function module_name()
+	{
+		return get_class($this);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function theme()
+	{
+		return $this->theme;
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 * @since   4.10.14.p
+	 */
+	protected static function getRequest()
+	{
+		static $request;
+		if (! $request instanceof RequestInterface) {
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		}
+		return $request;
+	}
+
+
+	/**
+	 * @return ResponseInterface
+	 * @since   4.10.14.p
+	 */
+	protected static function getResponse()
+	{
+		static $response;
+		if (! $response instanceof RequestInterface) {
+			$response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
+		}
+		return $response;
+	}
 }

caffeinated/core/libraries/shortcodes/EE_Question_List_Shortcodes.lib.php

Spacing +4 added lines, -4 removed lines

@@ -94,16 +94,16 @@
             ? $this->_extra_data['template']['question_list']
             : $template;
         $ans_result       = '';
-        $answers          = ! empty($this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs'])
-            ? $this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs']
+        $answers          = ! empty($this->_extra_data['data']->registrations[$reg_obj->ID()]['ans_objs'])
+            ? $this->_extra_data['data']->registrations[$reg_obj->ID()]['ans_objs']
             : [];
         $questions        = ! empty($this->_extra_data['data']->questions)
             ? $this->_extra_data['data']->questions
             : [];
         foreach ($answers as $answer) {
             // first see if the question is in our $questions array.  If not then try to get from answer object
-            $question = isset($questions[ $answer->ID() ])
-                ? $questions[ $answer->ID() ]
+            $question = isset($questions[$answer->ID()])
+                ? $questions[$answer->ID()]
                 : null;
             $question = ! $question instanceof EE_Question
                 ? $answer->question()

Indentation +98 added lines, -98 removed lines

@@ -15,113 +15,113 @@
  */
 class EE_Question_List_Shortcodes extends EE_Shortcodes
 {
-    public function __construct()
-    {
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
 
 
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Questions and Answers Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes related to custom questions and answers', 'event_espresso');
-        $this->_shortcodes = [
-            '[QUESTION_LIST]' => esc_html__(
-                'This is used to indicate where you want the list of questions and answers to show for the registrant.  You place this within the "[attendee_list]" field.',
-                'event_espresso'
-            ),
-        ];
-    }
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Questions and Answers Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes related to custom questions and answers', 'event_espresso');
+		$this->_shortcodes = [
+			'[QUESTION_LIST]' => esc_html__(
+				'This is used to indicate where you want the list of questions and answers to show for the registrant.  You place this within the "[attendee_list]" field.',
+				'event_espresso'
+			),
+		];
+	}
 
 
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[QUESTION_LIST]':
-                return $this->_get_question_list();
-        }
-        return '';
-    }
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[QUESTION_LIST]':
+				return $this->_get_question_list();
+		}
+		return '';
+	}
 
 
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_list()
-    {
-        $this->_validate_list_requirements();
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_question_list()
+	{
+		$this->_validate_list_requirements();
 
-        // for when [QUESTION_LIST] is used in the [attendee_list] field.
-        if ($this->_data['data'] instanceof EE_Registration) {
-            return $this->_get_question_answer_list_for_attendee();
-        }
+		// for when [QUESTION_LIST] is used in the [attendee_list] field.
+		if ($this->_data['data'] instanceof EE_Registration) {
+			return $this->_get_question_answer_list_for_attendee();
+		}
 
-        // for when [QUESTION_LIST] is used in the main content field.
-        if (
-            $this->_data['data'] instanceof EE_Messages_Addressee
-            && $this->_data['data']->reg_obj instanceof EE_Registration
-        ) {
-            return $this->_get_question_answer_list_for_attendee($this->_data['data']->reg_obj);
-        }
-        return '';
-    }
+		// for when [QUESTION_LIST] is used in the main content field.
+		if (
+			$this->_data['data'] instanceof EE_Messages_Addressee
+			&& $this->_data['data']->reg_obj instanceof EE_Registration
+		) {
+			return $this->_get_question_answer_list_for_attendee($this->_data['data']->reg_obj);
+		}
+		return '';
+	}
 
 
-    /**
-     * Note when we parse the "[question_list]" shortcode for attendees we're actually going to retrieve the list of
-     * answers for that attendee since that is what we really need (we can derive the questions from the answers);
-     *
-     * @param null $reg_obj
-     * @return string parsed template.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_question_answer_list_for_attendee($reg_obj = null)
-    {
-        $valid_shortcodes = ['question'];
-        $reg_obj          = $reg_obj instanceof EE_Registration
-            ? $reg_obj
-            : $this->_data['data'];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['question_list'])
-            ? $this->_data['template']['question_list']
-            : '';
-        $template         = empty($template) && isset($this->_extra_data['template']['question_list'])
-            ? $this->_extra_data['template']['question_list']
-            : $template;
-        $ans_result       = '';
-        $answers          = ! empty($this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs'])
-            ? $this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs']
-            : [];
-        $questions        = ! empty($this->_extra_data['data']->questions)
-            ? $this->_extra_data['data']->questions
-            : [];
-        foreach ($answers as $answer) {
-            // first see if the question is in our $questions array.  If not then try to get from answer object
-            $question = isset($questions[ $answer->ID() ])
-                ? $questions[ $answer->ID() ]
-                : null;
-            $question = ! $question instanceof EE_Question
-                ? $answer->question()
-                : $question;
-            if ($question instanceof EE_Question and $question->admin_only()) {
-                continue;
-            }
-            $ans_result .= $this->_shortcode_helper->parse_question_list_template(
-                $template,
-                $answer,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
+	/**
+	 * Note when we parse the "[question_list]" shortcode for attendees we're actually going to retrieve the list of
+	 * answers for that attendee since that is what we really need (we can derive the questions from the answers);
+	 *
+	 * @param null $reg_obj
+	 * @return string parsed template.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_question_answer_list_for_attendee($reg_obj = null)
+	{
+		$valid_shortcodes = ['question'];
+		$reg_obj          = $reg_obj instanceof EE_Registration
+			? $reg_obj
+			: $this->_data['data'];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['question_list'])
+			? $this->_data['template']['question_list']
+			: '';
+		$template         = empty($template) && isset($this->_extra_data['template']['question_list'])
+			? $this->_extra_data['template']['question_list']
+			: $template;
+		$ans_result       = '';
+		$answers          = ! empty($this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs'])
+			? $this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs']
+			: [];
+		$questions        = ! empty($this->_extra_data['data']->questions)
+			? $this->_extra_data['data']->questions
+			: [];
+		foreach ($answers as $answer) {
+			// first see if the question is in our $questions array.  If not then try to get from answer object
+			$question = isset($questions[ $answer->ID() ])
+				? $questions[ $answer->ID() ]
+				: null;
+			$question = ! $question instanceof EE_Question
+				? $answer->question()
+				: $question;
+			if ($question instanceof EE_Question and $question->admin_only()) {
+				continue;
+			}
+			$ans_result .= $this->_shortcode_helper->parse_question_list_template(
+				$template,
+				$answer,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
 
-        return $ans_result;
-    }
+		return $ans_result;
+	}
 }

core/libraries/rest_api/ModelDataTranslator.php

Spacing +16 added lines, -16 removed lines

@@ -69,7 +69,7 @@ 
         ) {
             $new_value_maybe_array = [];
             foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson(
+                $new_value_maybe_array[$array_key] = ModelDataTranslator::prepareFieldValueFromJson(
                     $field_obj,
                     $array_item,
                     $requested_version,
@@ -103,7 +103,7 @@ 
         if (is_array($original_value_maybe_array)) {
             $new_value = [];
             foreach ($original_value_maybe_array as $key => $value) {
-                $new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson(
+                $new_value[$key] = ModelDataTranslator::prepareFieldValuesForJson(
                     $field_obj,
                     $value,
                     $request_version
@@ -244,7 +244,7 @@ 
                 '0',
                 STR_PAD_LEFT
             );
-        return $original_timestamp . $offset_sign . $offset_string;
+        return $original_timestamp.$offset_sign.$offset_string;
     }
 
 
@@ -323,7 +323,7 @@ 
                     // first, check if its a MySQL timestamp in GMT
                     $datetime_obj = DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
                 }
-                if (! $datetime_obj instanceof DateTime) {
+                if ( ! $datetime_obj instanceof DateTime) {
                     // so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
                     $datetime_obj = $field_obj->prepare_for_set($original_value);
                 }
@@ -349,7 +349,7 @@ 
                         $original_value,
                         $field_obj->get_name(),
                         $field_obj->get_model_name(),
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
+                        $field_obj->get_time_format().' '.$field_obj->get_time_format()
                     )
                 );
             }
@@ -363,7 +363,7 @@ 
         }
         // are we about to send an object? just don't. We have no good way to represent it in JSON.
         // can't just check using is_object() because that missed PHP incomplete objects
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
+        if ( ! ModelDataTranslator::isRepresentableInJson($new_value)) {
             $new_value = [
                 'error_code'    => 'php_object_not_return',
                 'error_message' => esc_html__(
@@ -414,7 +414,7 @@ 
             if ($query_param_meta->getField() instanceof EE_Model_Field_Base) {
                 $translated_value = $query_param_meta->determineConditionsQueryParameterValue();
                 if (
-                    (isset($query_param_for_models[ $query_param_meta->getQueryParamKey() ])
+                    (isset($query_param_for_models[$query_param_meta->getQueryParamKey()])
                      && $query_param_meta->isGmtField())
                     || $translated_value === null
                 ) {
@@ -423,11 +423,11 @@ 
                     // OR we couldn't create a translated value from their input
                     continue;
                 }
-                $query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $translated_value;
+                $query_param_for_models[$query_param_meta->getQueryParamKey()] = $translated_value;
             } else {
                 $nested_query_params = $query_param_meta->determineNestedConditionQueryParameters();
                 if ($nested_query_params) {
-                    $query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $nested_query_params;
+                    $query_param_for_models[$query_param_meta->getQueryParamKey()] = $nested_query_params;
                 }
             }
         }
@@ -457,7 +457,7 @@ 
      */
     public static function removeGmtFromFieldName($field_name)
     {
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
+        if ( ! ModelDataTranslator::isGmtDateFieldName($field_name)) {
             return $field_name;
         }
         $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
@@ -500,7 +500,7 @@ 
     {
         $new_array = [];
         foreach ($field_names as $key => $field_name) {
-            $new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
+            $new_array[$key] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
         }
         return $new_array;
     }
@@ -517,7 +517,7 @@ 
     {
         $new_array = [];
         foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value;
+            $new_array[ModelDataTranslator::prepareFieldNameFromJson($field_name)] = $value;
         }
         return $new_array;
     }
@@ -613,10 +613,10 @@ 
                         $requested_version
                     );
                 }
-                $query_param_for_models[ $query_param_key ] = $translated_value;
+                $query_param_for_models[$query_param_key] = $translated_value;
             } else {
                 // so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[ $query_param_key ] =
+                $query_param_for_models[$query_param_key] =
                     ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
                         $query_param_value,
                         $model,
@@ -668,11 +668,11 @@ 
             );
         }
         $number_of_parts       = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
+        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
         $field_name            = $last_query_param_part;
         if ($number_of_parts !== 1) {
             // the last part is the column name, and there are only 2parts. therefore...
-            $model = EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]);
+            $model = EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
         }
         try {
             return $model->field_settings_for($field_name, false);

Indentation +654 added lines, -654 removed lines

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

core/libraries/shortcodes/EE_Attendee_Shortcodes.lib.php

Spacing +5 added lines, -5 removed lines

@@ -114,7 +114,7 @@ 
             ? null
             : $this->_data;
 
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             // let's attempt to get the txn_id for the error message.
             $txn_id  = isset($this->_extra->txn) && $this->_extra->txn instanceof EE_Transaction
                 ? $this->_extra->txn->ID()
@@ -131,12 +131,12 @@ 
         }
 
         // attendee obj for this registration
-        $attendee = isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
-            ? $this->_extra->registrations[ $registration->ID() ]['att_obj']
+        $attendee = isset($this->_extra->registrations[$registration->ID()]['att_obj'])
+            ? $this->_extra->registrations[$registration->ID()]['att_obj']
             : null;
 
-        if (! $attendee instanceof EE_Attendee) {
-            $msg     = esc_html__(
+        if ( ! $attendee instanceof EE_Attendee) {
+            $msg = esc_html__(
                 'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
                 'event_espresso'
             );

Indentation +188 added lines, -188 removed lines

@@ -15,192 +15,192 @@
  */
 class EE_Attendee_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * hold all extra data.
-     *
-     * @var array
-     */
-    protected $_extra;
-
-
-    /**
-     * EE_Attendee_Shortcodes constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Attendee Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to attendee related data', 'event_espresso');
-        $this->_shortcodes = [
-            '[FNAME]'                          => esc_html__('First Name of an attendee.', 'event_espresso'),
-            '[LNAME]'                          => esc_html__('Last Name of an attendee.', 'event_espresso'),
-            '[ATTENDEE_EMAIL]'                 => esc_html__('Email address for the attendee.', 'event_espresso'),
-            '[EDIT_ATTENDEE_LINK]'             => esc_html__(
-                'Edit Registration Link (typically you\'d only use this for messages going to event administrators)',
-                'event_espresso'
-            ),
-            '[REGISTRATION_ID]'                => esc_html__(
-                'Unique Registration ID for the registration',
-                'event_espresso'
-            ),
-            '[REGISTRATION_CODE]'              => esc_html__(
-                'Unique Registration Code for the registration',
-                'event_espresso'
-            ),
-            '[REGISTRATION_STATUS_ID]'         => esc_html__(
-                'Parses to the registration status for the attendee',
-                'event_espresso'
-            ),
-            '[REGISTRATION_STATUS_LABEL]'      => esc_html__(
-                'Parses to the status label for the registrant',
-                'event_espresso'
-            ),
-            '[REGISTRATION_TOTAL_AMOUNT_PAID]' => esc_html__(
-                'Parses to the total amount paid for this registration.',
-                'event_espresso'
-            ),
-            '[FRONTEND_EDIT_REG_LINK]'         => esc_html__(
-                'Generates a link for the given registration to edit this registration details on the frontend.',
-                'event_espresso'
-            ),
-            '[PHONE_NUMBER]'                   => esc_html__(
-                'The Phone Number for the Registration.',
-                'event_espresso'
-            ),
-            '[ADDRESS]'                        => esc_html__('The Address for the Registration', 'event_espresso'),
-            '[ADDRESS2]'                       => esc_html__(
-                'Whatever was in the address 2 field for the registration.',
-                'event_espresso'
-            ),
-            '[CITY]'                           => esc_html__('The city for the registration.', 'event_espresso'),
-            '[ZIP_PC]'                         => esc_html__(
-                'The ZIP (or Postal) Code for the Registration.',
-                'event_espresso'
-            ),
-            '[ADDRESS_STATE]'                  => esc_html__(
-                'The state/province for the registration.',
-                'event_espresso'
-            ),
-            '[COUNTRY]'                        => esc_html__('The country for the registration.', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * handles shortcode parsing
-     *
-     * @access protected
-     * @param string $shortcode the shortcode to be parsed.
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-
-
-        $this->_extra = ! empty($this->_extra_data) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data']
-            : null;
-
-        // incoming object should only be a registration object.
-        $registration = ! $this->_data instanceof EE_Registration
-            ? null
-            : $this->_data;
-
-        if (! $registration instanceof EE_Registration) {
-            // let's attempt to get the txn_id for the error message.
-            $txn_id  = isset($this->_extra->txn) && $this->_extra->txn instanceof EE_Transaction
-                ? $this->_extra->txn->ID()
-                : esc_html__('Unknown', 'event_espresso');
-            $msg     = esc_html__(
-                'There is no EE_Registration object in the data sent to the EE_Attendee Shortcode Parser for the messages system.',
-                'event_espresso'
-            );
-            $dev_msg = sprintf(
-                esc_html__('The transaction ID for this request is: %s', 'event_espresso'),
-                $txn_id
-            );
-            throw new EE_Error("{$msg}||{$msg} {$dev_msg}");
-        }
-
-        // attendee obj for this registration
-        $attendee = isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
-            ? $this->_extra->registrations[ $registration->ID() ]['att_obj']
-            : null;
-
-        if (! $attendee instanceof EE_Attendee) {
-            $msg     = esc_html__(
-                'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
-                'event_espresso'
-            );
-            $dev_msg = sprintf(
-                esc_html__('The registration ID for this request is: %s', 'event_espresso'),
-                $registration->ID()
-            );
-            throw new EE_Error("{$msg}||{$msg} {$dev_msg}");
-        }
-
-        switch ($shortcode) {
-            case '[FNAME]':
-                return $attendee->fname();
-
-            case '[LNAME]':
-                return $attendee->lname();
-
-            case '[ATTENDEE_EMAIL]':
-                return $attendee->email();
-
-            case '[EDIT_ATTENDEE_LINK]':
-                return $registration->get_admin_edit_url();
-
-            case '[REGISTRATION_CODE]':
-                return $registration->reg_code();
-
-            case '[REGISTRATION_ID]':
-                return $registration->ID();
-
-            case '[FRONTEND_EDIT_REG_LINK]':
-                return $registration->edit_attendee_information_url();
-
-            case '[PHONE_NUMBER]':
-                return $attendee->phone();
-
-            case '[ADDRESS]':
-                return $attendee->address();
-
-            case '[ADDRESS2]':
-                return $attendee->address2();
-
-            case '[CITY]':
-                return $attendee->city();
-
-            case '[ZIP_PC]':
-                return $attendee->zip();
-
-            case '[ADDRESS_STATE]':
-                $state_obj = $attendee->state_obj();
-                return $state_obj instanceof EE_State ? $state_obj->name() : '';
-
-            case '[COUNTRY]':
-                $country_obj = $attendee->country_obj();
-                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
-
-            case '[REGISTRATION_STATUS_ID]':
-                return $registration->status_ID();
-
-            case '[REGISTRATION_STATUS_LABEL]':
-                return $registration->pretty_status();
-
-            case '[REGISTRATION_TOTAL_AMOUNT_PAID]':
-                return $registration->pretty_paid();
-        }
-
-        return '';
-    }
+	/**
+	 * hold all extra data.
+	 *
+	 * @var array
+	 */
+	protected $_extra;
+
+
+	/**
+	 * EE_Attendee_Shortcodes constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Attendee Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to attendee related data', 'event_espresso');
+		$this->_shortcodes = [
+			'[FNAME]'                          => esc_html__('First Name of an attendee.', 'event_espresso'),
+			'[LNAME]'                          => esc_html__('Last Name of an attendee.', 'event_espresso'),
+			'[ATTENDEE_EMAIL]'                 => esc_html__('Email address for the attendee.', 'event_espresso'),
+			'[EDIT_ATTENDEE_LINK]'             => esc_html__(
+				'Edit Registration Link (typically you\'d only use this for messages going to event administrators)',
+				'event_espresso'
+			),
+			'[REGISTRATION_ID]'                => esc_html__(
+				'Unique Registration ID for the registration',
+				'event_espresso'
+			),
+			'[REGISTRATION_CODE]'              => esc_html__(
+				'Unique Registration Code for the registration',
+				'event_espresso'
+			),
+			'[REGISTRATION_STATUS_ID]'         => esc_html__(
+				'Parses to the registration status for the attendee',
+				'event_espresso'
+			),
+			'[REGISTRATION_STATUS_LABEL]'      => esc_html__(
+				'Parses to the status label for the registrant',
+				'event_espresso'
+			),
+			'[REGISTRATION_TOTAL_AMOUNT_PAID]' => esc_html__(
+				'Parses to the total amount paid for this registration.',
+				'event_espresso'
+			),
+			'[FRONTEND_EDIT_REG_LINK]'         => esc_html__(
+				'Generates a link for the given registration to edit this registration details on the frontend.',
+				'event_espresso'
+			),
+			'[PHONE_NUMBER]'                   => esc_html__(
+				'The Phone Number for the Registration.',
+				'event_espresso'
+			),
+			'[ADDRESS]'                        => esc_html__('The Address for the Registration', 'event_espresso'),
+			'[ADDRESS2]'                       => esc_html__(
+				'Whatever was in the address 2 field for the registration.',
+				'event_espresso'
+			),
+			'[CITY]'                           => esc_html__('The city for the registration.', 'event_espresso'),
+			'[ZIP_PC]'                         => esc_html__(
+				'The ZIP (or Postal) Code for the Registration.',
+				'event_espresso'
+			),
+			'[ADDRESS_STATE]'                  => esc_html__(
+				'The state/province for the registration.',
+				'event_espresso'
+			),
+			'[COUNTRY]'                        => esc_html__('The country for the registration.', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * handles shortcode parsing
+	 *
+	 * @access protected
+	 * @param string $shortcode the shortcode to be parsed.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+
+
+		$this->_extra = ! empty($this->_extra_data) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data']
+			: null;
+
+		// incoming object should only be a registration object.
+		$registration = ! $this->_data instanceof EE_Registration
+			? null
+			: $this->_data;
+
+		if (! $registration instanceof EE_Registration) {
+			// let's attempt to get the txn_id for the error message.
+			$txn_id  = isset($this->_extra->txn) && $this->_extra->txn instanceof EE_Transaction
+				? $this->_extra->txn->ID()
+				: esc_html__('Unknown', 'event_espresso');
+			$msg     = esc_html__(
+				'There is no EE_Registration object in the data sent to the EE_Attendee Shortcode Parser for the messages system.',
+				'event_espresso'
+			);
+			$dev_msg = sprintf(
+				esc_html__('The transaction ID for this request is: %s', 'event_espresso'),
+				$txn_id
+			);
+			throw new EE_Error("{$msg}||{$msg} {$dev_msg}");
+		}
+
+		// attendee obj for this registration
+		$attendee = isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
+			? $this->_extra->registrations[ $registration->ID() ]['att_obj']
+			: null;
+
+		if (! $attendee instanceof EE_Attendee) {
+			$msg     = esc_html__(
+				'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
+				'event_espresso'
+			);
+			$dev_msg = sprintf(
+				esc_html__('The registration ID for this request is: %s', 'event_espresso'),
+				$registration->ID()
+			);
+			throw new EE_Error("{$msg}||{$msg} {$dev_msg}");
+		}
+
+		switch ($shortcode) {
+			case '[FNAME]':
+				return $attendee->fname();
+
+			case '[LNAME]':
+				return $attendee->lname();
+
+			case '[ATTENDEE_EMAIL]':
+				return $attendee->email();
+
+			case '[EDIT_ATTENDEE_LINK]':
+				return $registration->get_admin_edit_url();
+
+			case '[REGISTRATION_CODE]':
+				return $registration->reg_code();
+
+			case '[REGISTRATION_ID]':
+				return $registration->ID();
+
+			case '[FRONTEND_EDIT_REG_LINK]':
+				return $registration->edit_attendee_information_url();
+
+			case '[PHONE_NUMBER]':
+				return $attendee->phone();
+
+			case '[ADDRESS]':
+				return $attendee->address();
+
+			case '[ADDRESS2]':
+				return $attendee->address2();
+
+			case '[CITY]':
+				return $attendee->city();
+
+			case '[ZIP_PC]':
+				return $attendee->zip();
+
+			case '[ADDRESS_STATE]':
+				$state_obj = $attendee->state_obj();
+				return $state_obj instanceof EE_State ? $state_obj->name() : '';
+
+			case '[COUNTRY]':
+				$country_obj = $attendee->country_obj();
+				return $country_obj instanceof EE_Country ? $country_obj->name() : '';
+
+			case '[REGISTRATION_STATUS_ID]':
+				return $registration->status_ID();
+
+			case '[REGISTRATION_STATUS_LABEL]':
+				return $registration->pretty_status();
+
+			case '[REGISTRATION_TOTAL_AMOUNT_PAID]':
+				return $registration->pretty_paid();
+		}
+
+		return '';
+	}
 }

core/libraries/shortcodes/EE_Attendee_List_Shortcodes.lib.php

Spacing +2 added lines, -2 removed lines

@@ -159,7 +159,7 @@ 
         $att_result    = '';
         $registrations =
             isset($this->_extra_data['data']->tickets)
-                ? $this->_extra_data['data']->tickets[ $ticket->ID() ]['reg_objs']
+                ? $this->_extra_data['data']->tickets[$ticket->ID()]['reg_objs']
                 : [];
 
         // each attendee in this case should be an attendee object.
@@ -185,7 +185,7 @@ 
     private function _get_registrations_from_event(EE_Event $event)
     {
         return isset($this->_extra_data['data']->events)
-            ? $this->_extra_data['data']->events[ $event->ID() ]['reg_objs']
+            ? $this->_extra_data['data']->events[$event->ID()]['reg_objs']
             : [];
     }
 }

Indentation +163 added lines, -163 removed lines

@@ -18,167 +18,167 @@
  */
 class EE_Attendee_List_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Attendee List Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to attendee lists', 'event_espresso');
-        $this->_shortcodes = [
-            '[ATTENDEE_LIST]' => esc_html__('Will output a list of attendees', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[ATTENDEE_LIST]':
-                return $this->_get_attendee_list();
-        }
-        return '';
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_attendee_list()
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_attendee_list_for_main();
-        }
-        if ($this->_data['data'] instanceof EE_Event) {
-            return $this->_get_attendee_list_for_event();
-        }
-        if ($this->_data['data'] instanceof EE_Ticket) {
-            return $this->_get_registration_list_for_ticket();
-        }
-        // prevent recursive loop
-        return '';
-    }
-
-
-    /**
-     * This returns the parsed attendee list for main template;
-     */
-    private function _get_attendee_list_for_main()
-    {
-        $valid_shortcodes = ['attendee', 'event_list', 'ticket_list', 'question_list', 'recipient_details'];
-        $template         = $this->_data['template'];
-        $data             = $this->_data['data'];
-        $attendees        = '';
-
-
-        // now we need to loop through the attendee list and send data to the EE_Parser helper.
-        foreach ($data->reg_objs as $registration) {
-            $attendees .= $this->_shortcode_helper->parse_attendee_list_template(
-                $template,
-                $registration,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $attendees;
-    }
-
-
-    /**
-     * return parsed list of attendees for an event
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_attendee_list_for_event()
-    {
-        $valid_shortcodes = ['attendee', 'ticket_list', 'question_list', 'recipient_details'];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list'])
-            ? $this->_data['template']['attendee_list']
-            : $this->_extra_data['template']['attendee_list'];
-        $event            = $this->_data['data'];
-
-        // let's remove any existing [EVENT_LIST] shortcode from the attendee list template so that we don't get recursion.
-        $template = str_replace('[EVENT_LIST]', '', $template);
-
-        // here we're setting up the attendees for the attendee_list template for THIS event.
-        $att_result    = '';
-        $registrations = $this->_get_registrations_from_event($event);
-
-        // each attendee in this case should be an attendee object.
-        foreach ($registrations as $registration) {
-            $att_result .= $this->_shortcode_helper->parse_attendee_list_template(
-                $template,
-                $registration,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $att_result;
-    }
-
-
-    /**
-     * return parsed list of attendees for a ticket
-     *
-     * @return string
-     */
-    private function _get_registration_list_for_ticket()
-    {
-        $valid_shortcodes = ['attendee', 'event_list', 'question_list', 'recipient_details'];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list'])
-            ? $this->_data['template']['attendee_list']
-            : $this->_extra_data['template']['attendee_list'];
-        $ticket           = $this->_data['data'];
-
-        // let's remove any existing [TICKET_LIST] (or related) shortcode from the attendee list template so that we don't get recursion.
-        $template = str_replace('[TICKET_LIST]', '', $template);
-        $template = str_replace('[RECIPIENT_TICKET_LIST]', '', $template);
-        $template = str_replace('[PRIMARY_REGISTRANT_TICKET_LIST]', '', $template);
-
-        // here we're setting up the attendees for the attendee_list template for THIS ticket.
-        $att_result    = '';
-        $registrations =
-            isset($this->_extra_data['data']->tickets)
-                ? $this->_extra_data['data']->tickets[ $ticket->ID() ]['reg_objs']
-                : [];
-
-        // each attendee in this case should be an attendee object.
-        foreach ($registrations as $registration) {
-            $att_result .= $this->_shortcode_helper->parse_attendee_list_template(
-                $template,
-                $registration,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-
-        return $att_result;
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_registrations_from_event(EE_Event $event)
-    {
-        return isset($this->_extra_data['data']->events)
-            ? $this->_extra_data['data']->events[ $event->ID() ]['reg_objs']
-            : [];
-    }
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Attendee List Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to attendee lists', 'event_espresso');
+		$this->_shortcodes = [
+			'[ATTENDEE_LIST]' => esc_html__('Will output a list of attendees', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[ATTENDEE_LIST]':
+				return $this->_get_attendee_list();
+		}
+		return '';
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_attendee_list()
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_attendee_list_for_main();
+		}
+		if ($this->_data['data'] instanceof EE_Event) {
+			return $this->_get_attendee_list_for_event();
+		}
+		if ($this->_data['data'] instanceof EE_Ticket) {
+			return $this->_get_registration_list_for_ticket();
+		}
+		// prevent recursive loop
+		return '';
+	}
+
+
+	/**
+	 * This returns the parsed attendee list for main template;
+	 */
+	private function _get_attendee_list_for_main()
+	{
+		$valid_shortcodes = ['attendee', 'event_list', 'ticket_list', 'question_list', 'recipient_details'];
+		$template         = $this->_data['template'];
+		$data             = $this->_data['data'];
+		$attendees        = '';
+
+
+		// now we need to loop through the attendee list and send data to the EE_Parser helper.
+		foreach ($data->reg_objs as $registration) {
+			$attendees .= $this->_shortcode_helper->parse_attendee_list_template(
+				$template,
+				$registration,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $attendees;
+	}
+
+
+	/**
+	 * return parsed list of attendees for an event
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_attendee_list_for_event()
+	{
+		$valid_shortcodes = ['attendee', 'ticket_list', 'question_list', 'recipient_details'];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list'])
+			? $this->_data['template']['attendee_list']
+			: $this->_extra_data['template']['attendee_list'];
+		$event            = $this->_data['data'];
+
+		// let's remove any existing [EVENT_LIST] shortcode from the attendee list template so that we don't get recursion.
+		$template = str_replace('[EVENT_LIST]', '', $template);
+
+		// here we're setting up the attendees for the attendee_list template for THIS event.
+		$att_result    = '';
+		$registrations = $this->_get_registrations_from_event($event);
+
+		// each attendee in this case should be an attendee object.
+		foreach ($registrations as $registration) {
+			$att_result .= $this->_shortcode_helper->parse_attendee_list_template(
+				$template,
+				$registration,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $att_result;
+	}
+
+
+	/**
+	 * return parsed list of attendees for a ticket
+	 *
+	 * @return string
+	 */
+	private function _get_registration_list_for_ticket()
+	{
+		$valid_shortcodes = ['attendee', 'event_list', 'question_list', 'recipient_details'];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['attendee_list'])
+			? $this->_data['template']['attendee_list']
+			: $this->_extra_data['template']['attendee_list'];
+		$ticket           = $this->_data['data'];
+
+		// let's remove any existing [TICKET_LIST] (or related) shortcode from the attendee list template so that we don't get recursion.
+		$template = str_replace('[TICKET_LIST]', '', $template);
+		$template = str_replace('[RECIPIENT_TICKET_LIST]', '', $template);
+		$template = str_replace('[PRIMARY_REGISTRANT_TICKET_LIST]', '', $template);
+
+		// here we're setting up the attendees for the attendee_list template for THIS ticket.
+		$att_result    = '';
+		$registrations =
+			isset($this->_extra_data['data']->tickets)
+				? $this->_extra_data['data']->tickets[ $ticket->ID() ]['reg_objs']
+				: [];
+
+		// each attendee in this case should be an attendee object.
+		foreach ($registrations as $registration) {
+			$att_result .= $this->_shortcode_helper->parse_attendee_list_template(
+				$template,
+				$registration,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+
+		return $att_result;
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_registrations_from_event(EE_Event $event)
+	{
+		return isset($this->_extra_data['data']->events)
+			? $this->_extra_data['data']->events[ $event->ID() ]['reg_objs']
+			: [];
+	}
 }

core/domain/services/admin/privacy/policy/privacy_policy.template.php

Indentation +80 added lines, -80 removed lines

@@ -7,10 +7,10 @@ 
 ?>
 <h2><?php esc_html_e('Event Registration Data', 'event_espresso'); ?></h2>
 <p><?php
-    esc_html_e(
-        'We collect information about you during event registration. This information may include but is not limited to:',
-        'event_espresso'
-    ); ?></p>
+	esc_html_e(
+		'We collect information about you during event registration. This information may include but is not limited to:',
+		'event_espresso'
+	); ?></p>
 <ul>
     <li><?php esc_html_e('Your names', 'event_espresso'); ?></li>
     <li><?php esc_html_e('Billing address', 'event_espresso'); ?></li>
@@ -18,16 +18,16 @@ 
     <li><?php esc_html_e('Email address', 'event_espresso'); ?></li>
     <li><?php esc_html_e('Phone number', 'event_espresso'); ?></li>
     <li><?php
-        esc_html_e(
-            'Location and traffic data (including partial IP address and browser type)',
-            'event_espresso'
-        ); ?>
+		esc_html_e(
+			'Location and traffic data (including partial IP address and browser type)',
+			'event_espresso'
+		); ?>
     </li>
     <li><?php
-        esc_html_e(
-            'Any other details that might be requested from you for the purpose of processing your registration or ticket purchase',
-            'event_espresso'
-        ); ?>
+		esc_html_e(
+			'Any other details that might be requested from you for the purpose of processing your registration or ticket purchase',
+			'event_espresso'
+		); ?>
     </li>
 </ul>
 
@@ -36,101 +36,101 @@ 
     <li><?php esc_html_e('Send you important account/purchase/service information.', 'event_espresso'); ?></li>
     <li><?php esc_html_e('Respond to your queries, refund requests, or complaints.', 'event_espresso'); ?></li>
     <li><?php
-        esc_html_e(
-            'Process payments and prevent fraudulent transactions. We do this on the basis of our legitimate business interests.',
-            'event_espresso'
-        ); ?></li>
+		esc_html_e(
+			'Process payments and prevent fraudulent transactions. We do this on the basis of our legitimate business interests.',
+			'event_espresso'
+		); ?></li>
     <li><?php
-        esc_html_e(
-            'Set up and administer your account, provide technical and customer support, and to verify your identity.',
-            'event_espresso'
-        ); ?></li>
+		esc_html_e(
+			'Set up and administer your account, provide technical and customer support, and to verify your identity.',
+			'event_espresso'
+		); ?></li>
 </ul>
 
 <?php if (! empty($active_onsite_payment_methods) || ! empty($active_offsite_payment_methods)) { ?>
     <h2><?php esc_html_e('Billing Information', 'event_espresso'); ?> </h2>
     <?php
-    // if onsite or offsite payment methods are active
-    if (! empty($active_onsite_payment_methods)) { ?>
+	// if onsite or offsite payment methods are active
+	if (! empty($active_onsite_payment_methods)) { ?>
         <p><?php
-            esc_html_e(
-                'In order to process payments, we collect billing information on-site. Sensitive billing information is not stored on our server, but may be handled while in-transit to the payment processing server.',
-                'event_espresso'
-            ); ?></p>
+			esc_html_e(
+				'In order to process payments, we collect billing information on-site. Sensitive billing information is not stored on our server, but may be handled while in-transit to the payment processing server.',
+				'event_espresso'
+			); ?></p>
         <p><?php
-            printf(
-                esc_html_x(
-                    'Please see the privacy policy of %1$s.',
-                    'Please see the privacy policy of PayPal Pro',
-                    'event_espresso'
-                ),
-                implode(
-                    ', ',
-                    array_merge(
-                        $active_onsite_payment_methods,
-                        $active_offsite_payment_methods
-                    )
-                )
-            ); ?></p>
+			printf(
+				esc_html_x(
+					'Please see the privacy policy of %1$s.',
+					'Please see the privacy policy of PayPal Pro',
+					'event_espresso'
+				),
+				implode(
+					', ',
+					array_merge(
+						$active_onsite_payment_methods,
+						$active_offsite_payment_methods
+					)
+				)
+			); ?></p>
         <p><?php
-            esc_html_e(
-                'Masked billing information may be stored on our servers (eg only the last 4 digits of credit card numbers are stored: **** **** **** 1234).',
-                'event_espresso'
-            ); ?></p>
+			esc_html_e(
+				'Masked billing information may be stored on our servers (eg only the last 4 digits of credit card numbers are stored: **** **** **** 1234).',
+				'event_espresso'
+			); ?></p>
     <?php } elseif (! empty($active_offsite_payment_methods)) { // IF OFFSITE PAYMENT METHOD ACTIVE ?>
         <p><?php
-            printf(
-                esc_html_x(
-                    'Billing information is sent directly to the payment processor, and is not handled by our servers. Please see the privacy policy of %1$s.',
-                    'Billing information is sent directly to the payment processor, and is not handled by our servers. Please see the privacy policy of PayPal Pro.',
-                    'event_espresso'
-                ),
-                implode(', ', $active_offsite_payment_methods)
-            ); ?></p>
+			printf(
+				esc_html_x(
+					'Billing information is sent directly to the payment processor, and is not handled by our servers. Please see the privacy policy of %1$s.',
+					'Billing information is sent directly to the payment processor, and is not handled by our servers. Please see the privacy policy of PayPal Pro.',
+					'event_espresso'
+				),
+				implode(', ', $active_offsite_payment_methods)
+			); ?></p>
     <?php } ?>
     <h2><?php esc_html_e('Payment Logging', 'event_espresso'); ?></h2>
     <p><?php
-        esc_html_e(
-            'Site administrators may keep a log of communications with the payment processors in order to verify payments are being processed correctly. These logs are automatically deleted after a week.',
-            'event_espresso'
-        ); ?></p>
+		esc_html_e(
+			'Site administrators may keep a log of communications with the payment processors in order to verify payments are being processed correctly. These logs are automatically deleted after a week.',
+			'event_espresso'
+		); ?></p>
 <?php } ?>
 
 <h2><?php esc_html_e('Event Registration Cookies', 'event_espresso'); ?></h2>
 <p><?php
-    printf(
-        esc_html_x(
-            'When you begin registering for an event and select a ticket quantity, a cookie will be used to track your registration. This cookie lasts %1$s.',
-            'When you begin registering for an event and select a ticket quantity, a cookie will be used to track your registration. This cookie lasts 2 hours.',
-            'event_espresso'
-        ),
-        $session_lifespan
-    ); ?></p>
+	printf(
+		esc_html_x(
+			'When you begin registering for an event and select a ticket quantity, a cookie will be used to track your registration. This cookie lasts %1$s.',
+			'When you begin registering for an event and select a ticket quantity, a cookie will be used to track your registration. This cookie lasts 2 hours.',
+			'event_espresso'
+		),
+		$session_lifespan
+	); ?></p>
 
 <h2><?php esc_html_e('Email History Data', 'event_espresso'); ?></h2>
 <p><?php
-    esc_html_e(
-        'We keep a record of the emails sent to you. This is to ensure communication is successfully sent and its information is accurate.',
-        'event_espresso'
-    ); ?></p>
+	esc_html_e(
+		'We keep a record of the emails sent to you. This is to ensure communication is successfully sent and its information is accurate.',
+		'event_espresso'
+	); ?></p>
 
 <h2><?php esc_html_e('Event Check-In Record', 'event_espresso'); ?></h2>
 <p><?php
-    esc_html_e(
-        'When you attend an event, an event manager may record the time you check in or out of the event.',
-        'event_espresso'
-    ); ?></p>
+	esc_html_e(
+		'When you attend an event, an event manager may record the time you check in or out of the event.',
+		'event_espresso'
+	); ?></p>
 
 <h2><?php esc_html_e('Event Registration Data Retention', 'event_espresso'); ?></h2>
 <p><?php
-    esc_html_e(
-        'Personal data is stored at least until the date of the event, and may be kept indefinitely in case of future registrations.',
-        'event_espresso'
-    ); ?></p>
+	esc_html_e(
+		'Personal data is stored at least until the date of the event, and may be kept indefinitely in case of future registrations.',
+		'event_espresso'
+	); ?></p>
 
 <h2><?php esc_html_e('Event Registration Data Erasure and Export', 'event_espresso'); ?></h2>
 <p><?php
-    esc_html_e(
-        'You have the right to request your personal data be sent to you electronically, and the right to request your registration data be erased after the event. To do so, please contact the event manager or site administrator.',
-        'event_espresso'
-    ); ?></p>
+	esc_html_e(
+		'You have the right to request your personal data be sent to you electronically, and the right to request your registration data be erased after the event. To do so, please contact the event manager or site administrator.',
+		'event_espresso'
+	); ?></p>

Spacing +3 added lines, -3 removed lines

@@ -47,11 +47,11 @@ 
         ); ?></li>
 </ul>
 
-<?php if (! empty($active_onsite_payment_methods) || ! empty($active_offsite_payment_methods)) { ?>
+<?php if ( ! empty($active_onsite_payment_methods) || ! empty($active_offsite_payment_methods)) { ?>
     <h2><?php esc_html_e('Billing Information', 'event_espresso'); ?> </h2>
     <?php
     // if onsite or offsite payment methods are active
-    if (! empty($active_onsite_payment_methods)) { ?>
+    if ( ! empty($active_onsite_payment_methods)) { ?>
         <p><?php
             esc_html_e(
                 'In order to process payments, we collect billing information on-site. Sensitive billing information is not stored on our server, but may be handled while in-transit to the payment processing server.',
@@ -77,7 +77,7 @@ 
                 'Masked billing information may be stored on our servers (eg only the last 4 digits of credit card numbers are stored: **** **** **** 1234).',
                 'event_espresso'
             ); ?></p>
-    <?php } elseif (! empty($active_offsite_payment_methods)) { // IF OFFSITE PAYMENT METHOD ACTIVE ?>
+    <?php } elseif ( ! empty($active_offsite_payment_methods)) { // IF OFFSITE PAYMENT METHOD ACTIVE ?>
         <p><?php
             printf(
                 esc_html_x(

public/Espresso_Arabica_2014/loop-espresso_events.php

Indentation +34 added lines, -34 removed lines

@@ -11,48 +11,48 @@
  * @version     4+
  */
 if (have_posts()) :
-    if (apply_filters('FHEE__archive_espresso_events_template__show_header', true)) : ?>
+	if (apply_filters('FHEE__archive_espresso_events_template__show_header', true)) : ?>
         <header class="page-header">
             <h1 class="page-title">
                 <?php
-                if (is_day()) :
-                    printf(esc_html__('Today\'s Events: %s', 'event_espresso'), get_the_date());
-                elseif (is_month()) :
-                    printf(
-                        esc_html__('Events This Month: %s', 'event_espresso'),
-                        get_the_date(_x('F Y', 'monthly archives date format', 'event_espresso'))
-                    );
-                elseif (is_year()) :
-                    printf(
-                        esc_html__('Events This Year: %s', 'event_espresso'),
-                        get_the_date(_x('Y', 'yearly archives date format', 'event_espresso'))
-                    );
-                else :
-                    echo apply_filters(
-                        'FHEE__archive_espresso_events_template__upcoming_events_h1',
-                        esc_html__('Upcoming Events', 'event_espresso')
-                    );
-                endif;
-                ?>
+				if (is_day()) :
+					printf(esc_html__('Today\'s Events: %s', 'event_espresso'), get_the_date());
+				elseif (is_month()) :
+					printf(
+						esc_html__('Events This Month: %s', 'event_espresso'),
+						get_the_date(_x('F Y', 'monthly archives date format', 'event_espresso'))
+					);
+				elseif (is_year()) :
+					printf(
+						esc_html__('Events This Year: %s', 'event_espresso'),
+						get_the_date(_x('Y', 'yearly archives date format', 'event_espresso'))
+					);
+				else :
+					echo apply_filters(
+						'FHEE__archive_espresso_events_template__upcoming_events_h1',
+						esc_html__('Upcoming Events', 'event_espresso')
+					);
+				endif;
+				?>
             </h1>
 
         </header><!-- .page-header -->
 
         <?php
-    endif;
-    // allow other stuff
-    do_action('AHEE__archive_espresso_events_template__before_loop');
-    // Start the Loop.
-    while (have_posts()) : the_post();
-        // Include the post TYPE-specific template for the content.
-        espresso_get_template_part('content', 'espresso_events-shortcode');
-    endwhile;
-    // Previous/next page navigation.
-    espresso_pagination();
-    // allow moar other stuff
-    do_action('AHEE__archive_espresso_events_template__after_loop');
+	endif;
+	// allow other stuff
+	do_action('AHEE__archive_espresso_events_template__before_loop');
+	// Start the Loop.
+	while (have_posts()) : the_post();
+		// Include the post TYPE-specific template for the content.
+		espresso_get_template_part('content', 'espresso_events-shortcode');
+	endwhile;
+	// Previous/next page navigation.
+	espresso_pagination();
+	// allow moar other stuff
+	do_action('AHEE__archive_espresso_events_template__after_loop');
 else :
-    // If no content, include the "No posts found" template.
-    espresso_get_template_part('content', 'none');
+	// If no content, include the "No posts found" template.
+	espresso_get_template_part('content', 'none');
 endif;
 

Braces +6 added lines, -2 removed lines

@@ -27,11 +27,13 @@ 
                         esc_html__('Events This Year: %s', 'event_espresso'),
                         get_the_date(_x('Y', 'yearly archives date format', 'event_espresso'))
                     );
-                else :
+                else {
+                	:
                     echo apply_filters(
                         'FHEE__archive_espresso_events_template__upcoming_events_h1',
                         esc_html__('Upcoming Events', 'event_espresso')
                     );
+                }
                 endif;
                 ?>
             </h1>
@@ -51,8 +53,10 @@ 
     espresso_pagination();
     // allow moar other stuff
     do_action('AHEE__archive_espresso_events_template__after_loop');
-else :
+else {
+	:
     // If no content, include the "No posts found" template.
     espresso_get_template_part('content', 'none');
+}
 endif;