eventespresso / event-espresso-core

core/EE_Session.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -542,7 +542,7 @@ 
     /**
      * @initiate session
      * @access   private
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException
@@ -778,7 +778,7 @@ 
      * @update session data  prior to saving to the db
      * @access public
      * @param bool $new_session
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException
@@ -879,7 +879,7 @@ 
      * _save_session_to_db
      *
      * @param bool $clear_session
-     * @return string
+     * @return boolean
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException

Unused Use Statements -1 removed lines

@@ -6,7 +6,6 @@
 use EventEspresso\core\exceptions\InvalidInterfaceException;
 use EventEspresso\core\exceptions\InvalidSessionDataException;
 use EventEspresso\core\services\cache\CacheStorageInterface;
-use EventEspresso\core\services\loaders\LoaderFactory;
 use EventEspresso\core\services\request\RequestInterface;
 use EventEspresso\core\services\session\SessionStartHandler;
 

Indentation +1261 added lines, -1261 removed lines

@@ -25,1259 +25,1259 @@ 
 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;
-
-    /**
-     * 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;
-
-
-    /**
-     * @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 && 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
-     */
-    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();
-    }
-
-
-    /**
-     * This just sets some defaults for the _session data property
-     *
-     * @access private
-     * @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
-     * @access    public
-     * @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;
-        return true;
-    }
-
-
-    /**
-     * reset_cart
-     */
-    public function reset_cart()
-    {
-        do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
-        $this->_session_data['cart'] = null;
-    }
-
-
-    /**
-     * @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;
-        return true;
-    }
-
-
-    /**
-     * reset_checkout
-     */
-    public function reset_checkout()
-    {
-        do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
-        $this->_session_data['checkout'] = null;
-    }
-
-
-    /**
-     * @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;
-        return true;
-    }
-
-
-    /**
-     * reset_transaction
-     */
-    public function reset_transaction()
-    {
-        do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
-        $this->_session_data['transaction'] = null;
-    }
-
-
-    /**
-     * @return \EE_Transaction
-     */
-    public function transaction()
-    {
-        return isset($this->_session_data['transaction'])
-               && $this->_session_data['transaction'] instanceof EE_Transaction
-            ? $this->_session_data['transaction']
-            : null;
-    }
-
-
-    /**
-     * retrieve session data
-     *
-     * @param null $key
-     * @param bool $reset_cache
-     * @return array
-     */
-    public function get_session_data($key = null, $reset_cache = false)
-    {
-        if ($reset_cache) {
-            $this->reset_cart();
-            $this->reset_checkout();
-            $this->reset_transaction();
-        }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
-        }
-        return $this->_session_data;
-    }
-
-
-    /**
-     * Returns TRUE on success, FALSE on fail
-     *
-     * @param array $data
-     * @return bool
-     */
-    public function set_session_data($data)
-    {
-        // nothing ??? bad data ??? go home!
-        if (empty($data) || ! is_array($data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data or invalid session data was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Sorry! %s is a default session datum and can not be reset.',
-                            'event_espresso'
-                        ),
-                        $key
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $this->_session_data[ $key ] = $value;
-        }
-        return true;
-    }
-
-
-    /**
-     * @initiate session
-     * @access   private
-     * @return TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     */
-    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'] ] = isset($_SERVER['HTTP_REFERER'])
-                ? esc_attr($_SERVER['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
-     */
-    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(
-                            __(
-                                '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
-        if (isset($_REQUEST['EESID'])) {
-            $session_id = sanitize_text_field($_REQUEST['EESID']);
-        } else {
-            $session_id = 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
-     * @access public
-     * @param bool $new_session
-     * @return TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update($new_session = false)
-    {
-        $this->_session_data = $this->_session_data !== null
-                               && 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
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _create_espresso_session()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
-        // use the update function for now with $new_session arg set to TRUE
-        return $this->update(true) ? true : false;
-    }
-
-    /**
-     * 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->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 string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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,
-        return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
-            $session_data,
-            $this->session_lifespan->inSeconds()
-        );
-    }
-
-
-    /**
-     * @get    the full page request the visitor is accessing
-     * @access public
-     * @return string
-     */
-    public function _get_page_visit()
-    {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
-        // check for request url
-        if (isset($_SERVER['REQUEST_URI'])) {
-            $http_host = '';
-            $page_id = '?';
-            $e_reg = '';
-            $request_uri = esc_url($_SERVER['REQUEST_URI']);
-            $ru_bits = explode('?', $request_uri);
-            $request_uri = $ru_bits[0];
-            // check for and grab host as well
-            if (isset($_SERVER['HTTP_HOST'])) {
-                $http_host = esc_url($_SERVER['HTTP_HOST']);
-            }
-            // check for page_id in SERVER REQUEST
-            if (isset($_REQUEST['page_id'])) {
-                // rebuild $e_reg without any of the extra parameters
-                $page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
-            }
-            // check for $e_reg in SERVER REQUEST
-            if (isset($_REQUEST['ee'])) {
-                // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
-            }
-            $page_visit = 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
-     * @access public
-     * @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
-     *
-     * @access public
-     * @param string $class
-     * @param string $function
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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;
+
+	/**
+	 * 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;
+
+
+	/**
+	 * @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 && 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
+	 */
+	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();
+	}
+
+
+	/**
+	 * This just sets some defaults for the _session data property
+	 *
+	 * @access private
+	 * @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
+	 * @access    public
+	 * @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;
+		return true;
+	}
+
+
+	/**
+	 * reset_cart
+	 */
+	public function reset_cart()
+	{
+		do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
+		$this->_session_data['cart'] = null;
+	}
+
+
+	/**
+	 * @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;
+		return true;
+	}
+
+
+	/**
+	 * reset_checkout
+	 */
+	public function reset_checkout()
+	{
+		do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
+		$this->_session_data['checkout'] = null;
+	}
+
+
+	/**
+	 * @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;
+		return true;
+	}
+
+
+	/**
+	 * reset_transaction
+	 */
+	public function reset_transaction()
+	{
+		do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
+		$this->_session_data['transaction'] = null;
+	}
+
+
+	/**
+	 * @return \EE_Transaction
+	 */
+	public function transaction()
+	{
+		return isset($this->_session_data['transaction'])
+			   && $this->_session_data['transaction'] instanceof EE_Transaction
+			? $this->_session_data['transaction']
+			: null;
+	}
+
+
+	/**
+	 * retrieve session data
+	 *
+	 * @param null $key
+	 * @param bool $reset_cache
+	 * @return array
+	 */
+	public function get_session_data($key = null, $reset_cache = false)
+	{
+		if ($reset_cache) {
+			$this->reset_cart();
+			$this->reset_checkout();
+			$this->reset_transaction();
+		}
+		if (! empty($key)) {
+			return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+		}
+		return $this->_session_data;
+	}
+
+
+	/**
+	 * Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array $data
+	 * @return bool
+	 */
+	public function set_session_data($data)
+	{
+		// nothing ??? bad data ??? go home!
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data or invalid session data was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		foreach ($data as $key => $value) {
+			if (isset($this->_default_session_vars[ $key ])) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Sorry! %s is a default session datum and can not be reset.',
+							'event_espresso'
+						),
+						$key
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$this->_session_data[ $key ] = $value;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @initiate session
+	 * @access   private
+	 * @return TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 */
+	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'] ] = isset($_SERVER['HTTP_REFERER'])
+				? esc_attr($_SERVER['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
+	 */
+	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(
+							__(
+								'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
+		if (isset($_REQUEST['EESID'])) {
+			$session_id = sanitize_text_field($_REQUEST['EESID']);
+		} else {
+			$session_id = 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
+	 * @access public
+	 * @param bool $new_session
+	 * @return TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update($new_session = false)
+	{
+		$this->_session_data = $this->_session_data !== null
+							   && 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
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _create_espresso_session()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
+		// use the update function for now with $new_session arg set to TRUE
+		return $this->update(true) ? true : false;
+	}
+
+	/**
+	 * 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->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 string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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,
+		return $this->cache_storage->add(
+			EE_Session::session_id_prefix . $this->_sid,
+			$session_data,
+			$this->session_lifespan->inSeconds()
+		);
+	}
+
+
+	/**
+	 * @get    the full page request the visitor is accessing
+	 * @access public
+	 * @return string
+	 */
+	public function _get_page_visit()
+	{
+		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		// check for request url
+		if (isset($_SERVER['REQUEST_URI'])) {
+			$http_host = '';
+			$page_id = '?';
+			$e_reg = '';
+			$request_uri = esc_url($_SERVER['REQUEST_URI']);
+			$ru_bits = explode('?', $request_uri);
+			$request_uri = $ru_bits[0];
+			// check for and grab host as well
+			if (isset($_SERVER['HTTP_HOST'])) {
+				$http_host = esc_url($_SERVER['HTTP_HOST']);
+			}
+			// check for page_id in SERVER REQUEST
+			if (isset($_REQUEST['page_id'])) {
+				// rebuild $e_reg without any of the extra parameters
+				$page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
+			}
+			// check for $e_reg in SERVER REQUEST
+			if (isset($_REQUEST['ee'])) {
+				// rebuild $e_reg without any of the extra parameters
+				$e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
+			}
+			$page_visit = 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
+	 * @access public
+	 * @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
+	 *
+	 * @access public
+	 * @param string $class
+	 * @param string $function
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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->_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(
-                __(
-                    '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 ]);
-                    if ($show_all_notices) {
-                        EE_Error::add_success(
-                            sprintf(
-                                __('The session variable %s was removed.', 'event_espresso'),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                } else {
-                    // yeeeeeeeeerrrrrrrrrrr OUT !!!!
-                    if ($show_all_notices) {
-                        EE_Error::add_error(
-                            sprintf(
-                                __(
-                                    '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(
-                        __(
-                            '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
-     *
-     * @access public
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    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
-     */
-    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->_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(
+				__(
+					'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 ]);
+					if ($show_all_notices) {
+						EE_Error::add_success(
+							sprintf(
+								__('The session variable %s was removed.', 'event_espresso'),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				} else {
+					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
+					if ($show_all_notices) {
+						EE_Error::add_error(
+							sprintf(
+								__(
+									'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(
+						__(
+							'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
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	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
+	 */
+	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
@@ -1286,17 +1286,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);
+				}
+			}
+		}
+	}
 }

Spacing +55 added lines, -55 removed lines

@@ -193,7 +193,7 @@ 
         // 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 && apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
             self::$_instance = new self(
                 $cache_storage,
                 $lifespan,
@@ -229,22 +229,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;
             }
         }
@@ -303,7 +303,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();
         }
@@ -376,9 +376,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] = '';
             }
         }
     }
@@ -509,8 +509,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;
     }
@@ -538,7 +538,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__(
@@ -553,7 +553,7 @@ 
                 );
                 return false;
             }
-            $this->_session_data[ $key ] = $value;
+            $this->_session_data[$key] = $value;
         }
         return true;
     }
@@ -582,7 +582,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
@@ -593,7 +593,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'] ] = isset($_SERVER['HTTP_REFERER'])
+            $this->_session_data['pages_visited'][$this->_session_data['init_access']] = isset($_SERVER['HTTP_REFERER'])
                 ? esc_attr($_SERVER['HTTP_REFERER'])
                 : '';
             // no previous session = go back and create one (on top of the data above)
@@ -630,7 +630,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);
@@ -639,7 +639,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)) {
@@ -649,7 +649,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__,
@@ -663,17 +663,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
                 );
@@ -684,7 +684,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) {
@@ -698,21 +698,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) {
@@ -739,7 +739,7 @@ 
         if (isset($_REQUEST['EESID'])) {
             $session_id = sanitize_text_field($_REQUEST['EESID']);
         } else {
-            $session_id = md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+            $session_id = md5(session_id().get_current_blog_id().$this->_get_sid_salt());
         }
         return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
     }
@@ -842,19 +842,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;
@@ -895,8 +895,8 @@ 
                 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'])
+                    || ! empty($this->_session_data['ee_notices']['errors'])
+                    || ! empty($this->_session_data['ee_notices']['success'])
                 )
             );
     }
@@ -925,7 +925,7 @@ 
         }
         $transaction = $this->transaction();
         if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
+            if ( ! $transaction->ID()) {
                 $transaction->save();
             }
             $this->_session_data['transaction'] = $transaction->ID();
@@ -939,14 +939,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,
         return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->session_lifespan->inSeconds()
         );
@@ -960,7 +960,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 (isset($_SERVER['REQUEST_URI'])) {
             $http_host = '';
@@ -976,14 +976,14 @@ 
             // check for page_id in SERVER REQUEST
             if (isset($_REQUEST['page_id'])) {
                 // rebuild $e_reg without any of the extra parameters
-                $page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
+                $page_id = '?page_id='.esc_attr($_REQUEST['page_id']).'&amp;';
             }
             // check for $e_reg in SERVER REQUEST
             if (isset($_REQUEST['ee'])) {
                 // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
+                $e_reg = 'ee='.esc_attr($_REQUEST['ee']);
             }
-            $page_visit = rtrim($http_host . $request_uri . $page_id . $e_reg, '?');
+            $page_visit = rtrim($http_host.$request_uri.$page_id.$e_reg, '?');
         }
         return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
     }
@@ -1021,7 +1021,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();
@@ -1043,7 +1043,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!
@@ -1063,11 +1063,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]);
                     if ($show_all_notices) {
                         EE_Error::add_success(
                             sprintf(
@@ -1168,7 +1168,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;
                 }
             );
@@ -1186,7 +1186,7 @@ 
         $error = '<pre>';
         $data2 = preg_replace_callback(
             '!s:(\d+):"(.*?)";!',
-            function ($match) {
+            function($match) {
                 return ($match[1] === strlen($match[2]))
                     ? $match[0]
                     : 's:'
@@ -1198,13 +1198,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;
@@ -1219,7 +1219,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
                 );
@@ -1227,7 +1227,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
                 );
@@ -1258,7 +1258,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 */
@@ -1293,7 +1293,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);
                 }
             }

core/services/request/RequestInterface.php

Indentation +118 added lines, -118 removed lines

@@ -20,139 +20,139 @@
 interface RequestInterface extends RequestTypeContextCheckerInterface
 {
 
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
-
-    /**
-     * @return array
-     */
-    public function getParams();
-
-
-    /**
-     * @return array
-     */
-    public function postParams();
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams();
-
-
-    /**
-     * @return array
-     */
-    public function serverParams();
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams();
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
+
+	/**
+	 * @return array
+	 */
+	public function getParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams();
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams();
 
 
-    /**
-     * @param string $key
-     * @param string $value
-     * @param bool   $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false);
+	/**
+	 * @param string $key
+	 * @param string $value
+	 * @param bool   $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false);
 
 
-    /**
-     * returns the value for a request param if the given key exists
-     *
-     * @param string $key
-     * @param null   $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null);
+	/**
+	 * returns the value for a request param if the given key exists
+	 *
+	 * @param string $key
+	 * @param null   $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null);
 
 
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key);
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key);
 
 
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param null|mixed $default
-     * @return false|int
-     */
-    public function getMatch($pattern, $default = null);
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param null|mixed $default
+	 * @return false|int
+	 */
+	public function getMatch($pattern, $default = null);
 
 
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     */
-    public function matches($pattern);
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 */
+	public function matches($pattern);
 
 
-    /**
-     * remove param
-     *
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false);
+	/**
+	 * remove param
+	 *
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false);
 
 
-    /**
-     * @return string
-     */
-    public function ipAddress();
+	/**
+	 * @return string
+	 */
+	public function ipAddress();
 
 
-    /**
-     * @return string
-     */
-    public function requestUri();
-
+	/**
+	 * @return string
+	 */
+	public function requestUri();
+
 
-    /**
-     * @return string
-     */
-    public function userAgent();
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '');
-
-
-    /**
-     * @return bool
-     */
-    public function isBot();
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot);
+	/**
+	 * @return string
+	 */
+	public function userAgent();
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '');
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot();
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot);
 }

core/middleware/EE_Detect_File_Editor_Request.core.php

Indentation +23 added lines, -23 removed lines

@@ -14,28 +14,28 @@
 class EE_Detect_File_Editor_Request extends EE_Middleware
 {
 
-    /**
-     * @deprecated
-     * @param EE_Request  $request
-     * @param EE_Response $response
-     * @return EE_Response
-     */
-    public function handle_request(EE_Request $request, EE_Response $response)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\middleware\DetectFileEditorRequest',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.52'
-        );
-        return $response;
-    }
+	/**
+	 * @deprecated
+	 * @param EE_Request  $request
+	 * @param EE_Response $response
+	 * @return EE_Response
+	 */
+	public function handle_request(EE_Request $request, EE_Response $response)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\middleware\DetectFileEditorRequest',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.52'
+		);
+		return $response;
+	}
 
 }

core/domain/services/admin/PluginUpsells.php

Spacing +3 added lines, -3 removed lines

@@ -83,12 +83,12 @@
                     <div class="notice inline notice-alt">
                         <div class="ee-upsell-container">
                             <div class="ee-upsell-inner-container">
-                                <a href="' . $button_url . '">
-                                    ' . $button_text . '
+                                <a href="' . $button_url.'">
+                                    ' . $button_text.'
                                 </a>
                             </div>
                             <div class="ee-upsell-inner-container">
-                                <p>' . $upsell_text . '</p>
+                                <p>' . $upsell_text.'</p>
                             </div>
                             <div style="clear:both"></div>
                         </div>

Indentation +57 added lines, -57 removed lines

@@ -17,47 +17,47 @@ 
 class PluginUpsells
 {
 
-    /**
-     * @var DomainInterface
-     */
-    private $domain;
+	/**
+	 * @var DomainInterface
+	 */
+	private $domain;
 
 
-    /**
-     * PluginUpsells constructor.
-     *
-     * @param DomainInterface $domain
-     */
-    public function __construct(DomainInterface $domain)
-    {
-        $this->domain = $domain;
-    }
+	/**
+	 * PluginUpsells constructor.
+	 *
+	 * @param DomainInterface $domain
+	 */
+	public function __construct(DomainInterface $domain)
+	{
+		$this->domain = $domain;
+	}
 
 
-    /**
-     * Hook in various upsells for the decaf version of EE.
-     */
-    public function decafUpsells()
-    {
-        if ($this->domain instanceof CaffeinatedInterface && ! $this->domain->isCaffeinated()) {
-            add_action('after_plugin_row', array($this, 'doPremiumUpsell'), 10, 3);
-        }
-    }
+	/**
+	 * Hook in various upsells for the decaf version of EE.
+	 */
+	public function decafUpsells()
+	{
+		if ($this->domain instanceof CaffeinatedInterface && ! $this->domain->isCaffeinated()) {
+			add_action('after_plugin_row', array($this, 'doPremiumUpsell'), 10, 3);
+		}
+	}
 
 
-    /**
-     * Callback for `after_plugin_row` to add upsell info
-     *
-     * @param string $plugin_file
-     * @param array  $plugin_data
-     * @param string $status
-     * @throws DomainException
-     */
-    public function doPremiumUpsell($plugin_file, $plugin_data, $status)
-    {
-        if ($plugin_file === $this->domain->pluginBasename()) {
-            list($button_text, $button_url, $upsell_text) = $this->getAfterPluginRowDetails();
-            echo '<tr class="plugin-update-tr ee-upsell-plugin-list-table active">
+	/**
+	 * Callback for `after_plugin_row` to add upsell info
+	 *
+	 * @param string $plugin_file
+	 * @param array  $plugin_data
+	 * @param string $status
+	 * @throws DomainException
+	 */
+	public function doPremiumUpsell($plugin_file, $plugin_data, $status)
+	{
+		if ($plugin_file === $this->domain->pluginBasename()) {
+			list($button_text, $button_url, $upsell_text) = $this->getAfterPluginRowDetails();
+			echo '<tr class="plugin-update-tr ee-upsell-plugin-list-table active">
                 <td colspan="3" class="plugin-update colspanchange">
                     <div class="notice inline notice-alt">
                         <div class="ee-upsell-container">
@@ -74,27 +74,27 @@ 
                     </div>
                 </td>
               </tr>';
-        }
-    }
+		}
+	}
 
-    /**
-     * Provide the details used for the upsell container.
-     *
-     * @return array
-     */
-    protected function getAfterPluginRowDetails()
-    {
-        return array(
-            esc_html__('Upgrade for Support', 'event_espresso'),
-            'https://eventespresso.com/purchase/?slug=ee4-license-personal&utm_source=wp_admin_plugins_screen&utm_medium=link&utm_campaign=plugins_screen_upgrade_link" class="button button-primary',
-            sprintf(
-                esc_html__(
-                    'You\'re missing out on %1$sexpert support%2$s and %1$sone-click updates%2$s! Don\'t have an Event Espresso support license key? Support the project and buy one today!',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            ),
-        );
-    }
+	/**
+	 * Provide the details used for the upsell container.
+	 *
+	 * @return array
+	 */
+	protected function getAfterPluginRowDetails()
+	{
+		return array(
+			esc_html__('Upgrade for Support', 'event_espresso'),
+			'https://eventespresso.com/purchase/?slug=ee4-license-personal&utm_source=wp_admin_plugins_screen&utm_medium=link&utm_campaign=plugins_screen_upgrade_link" class="button button-primary',
+			sprintf(
+				esc_html__(
+					'You\'re missing out on %1$sexpert support%2$s and %1$sone-click updates%2$s! Don\'t have an Event Espresso support license key? Support the project and buy one today!',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			),
+		);
+	}
 }

core/domain/Domain.php

Spacing +2 added lines, -2 removed lines

@@ -66,7 +66,7 @@
      */
     private function setCaffeinated()
     {
-        $this->caffeinated = (! defined('EE_DECAF') || EE_DECAF !== true)
-            && is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php');
+        $this->caffeinated = ( ! defined('EE_DECAF') || EE_DECAF !== true)
+            && is_readable($this->pluginPath().'caffeinated/brewing_regular.php');
     }
 }

Indentation +41 added lines, -41 removed lines

@@ -19,54 +19,54 @@
 class Domain extends DomainBase implements CaffeinatedInterface
 {
 
-    /**
-     * URL path component used to denote an API request
-     */
-    const API_NAMESPACE = 'ee/v';
+	/**
+	 * URL path component used to denote an API request
+	 */
+	const API_NAMESPACE = 'ee/v';
 
-    /**
-     * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
-     * Page ui.
-     */
-    const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN
-        = 'manual_registration_status_change_from_registration_admin';
+	/**
+	 * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
+	 * Page ui.
+	 */
+	const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN
+		= 'manual_registration_status_change_from_registration_admin';
 
-    const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
-        = 'manual_registration_status_change_from_registration_admin_and_notify';
+	const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
+		= 'manual_registration_status_change_from_registration_admin_and_notify';
 
 
-    /**
-     * Whether or not EE core is the full premium version.
-     * @since 4.9.59.p
-     * @var bool
-     */
-    private $caffeinated;
+	/**
+	 * Whether or not EE core is the full premium version.
+	 * @since 4.9.59.p
+	 * @var bool
+	 */
+	private $caffeinated;
 
 
-    public function __construct(FilePath $plugin_file, Version $version)
-    {
-        parent::__construct($plugin_file, $version);
-        $this->setCaffeinated();
-    }
+	public function __construct(FilePath $plugin_file, Version $version)
+	{
+		parent::__construct($plugin_file, $version);
+		$this->setCaffeinated();
+	}
 
-    /**
-     * Whether or not EE core is the full premium version.
-     * @since 4.9.59.p
-     * @return bool
-     */
-    public function isCaffeinated()
-    {
-        return $this->caffeinated;
-    }
+	/**
+	 * Whether or not EE core is the full premium version.
+	 * @since 4.9.59.p
+	 * @return bool
+	 */
+	public function isCaffeinated()
+	{
+		return $this->caffeinated;
+	}
 
 
-    /**
-     * Setter for $is_caffeinated property.
-     * @since 4.9.59.p
-     */
-    private function setCaffeinated()
-    {
-        $this->caffeinated = (! defined('EE_DECAF') || EE_DECAF !== true)
-            && is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php');
-    }
+	/**
+	 * Setter for $is_caffeinated property.
+	 * @since 4.9.59.p
+	 */
+	private function setCaffeinated()
+	{
+		$this->caffeinated = (! defined('EE_DECAF') || EE_DECAF !== true)
+			&& is_readable($this->pluginPath() . 'caffeinated/brewing_regular.php');
+	}
 }

core/services/loaders/Loader.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
 
 
     /**
-     * @param FullyQualifiedName|string $fqcn
+     * @param string $fqcn
      * @param array                     $arguments
      * @return mixed
      */

Indentation +111 added lines, -111 removed lines

@@ -15,115 +15,115 @@
 class Loader implements LoaderInterface
 {
 
-    /**
-     * @var LoaderDecoratorInterface $new_loader
-     */
-    private $new_loader;
-
-    /**
-     * @var LoaderDecoratorInterface $shared_loader
-     */
-    private $shared_loader;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * Loader constructor.
-     *
-     * @param LoaderDecoratorInterface        $new_loader
-     * @param CachingLoaderDecoratorInterface $shared_loader
-     * @param ClassInterfaceCache             $class_cache
-     */
-    public function __construct(
-        LoaderDecoratorInterface $new_loader,
-        CachingLoaderDecoratorInterface $shared_loader,
-        ClassInterfaceCache $class_cache
-    ) {
-        $this->new_loader    = $new_loader;
-        $this->shared_loader = $shared_loader;
-        $this->class_cache   = $class_cache;
-    }
-
-
-    /**
-     * @return LoaderDecoratorInterface
-     */
-    public function getNewLoader()
-    {
-        return $this->new_loader;
-    }
-
-
-    /**
-     * @return CachingLoaderDecoratorInterface
-     */
-    public function getSharedLoader()
-    {
-        return $this->shared_loader;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @return mixed
-     */
-    public function load($fqcn, array $arguments = array(), $shared = true)
-    {
-        $fqcn = $this->class_cache->getFqn($fqcn);
-        if ($this->class_cache->hasInterface($fqcn, 'EventEspresso\core\interfaces\ReservedInstanceInterface')) {
-            $shared = true;
-        }
-        return $shared
-            ? $this->getSharedLoader()->load($fqcn, $arguments, $shared)
-            : $this->getNewLoader()->load($fqcn, $arguments, $shared);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getNew($fqcn, array $arguments = array())
-    {
-        return $this->load($fqcn, $arguments, false);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getShared($fqcn, array $arguments = array())
-    {
-        return $this->load($fqcn, $arguments);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object)
-    {
-        $fqcn = $this->class_cache->getFqn($fqcn);
-        return $this->getSharedLoader()->share($fqcn, $object);
-    }
-
-
-    /**
-     * calls reset() on loaders if that method exists
-     */
-    public function reset()
-    {
-        $this->shared_loader->reset();
-    }
+	/**
+	 * @var LoaderDecoratorInterface $new_loader
+	 */
+	private $new_loader;
+
+	/**
+	 * @var LoaderDecoratorInterface $shared_loader
+	 */
+	private $shared_loader;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * Loader constructor.
+	 *
+	 * @param LoaderDecoratorInterface        $new_loader
+	 * @param CachingLoaderDecoratorInterface $shared_loader
+	 * @param ClassInterfaceCache             $class_cache
+	 */
+	public function __construct(
+		LoaderDecoratorInterface $new_loader,
+		CachingLoaderDecoratorInterface $shared_loader,
+		ClassInterfaceCache $class_cache
+	) {
+		$this->new_loader    = $new_loader;
+		$this->shared_loader = $shared_loader;
+		$this->class_cache   = $class_cache;
+	}
+
+
+	/**
+	 * @return LoaderDecoratorInterface
+	 */
+	public function getNewLoader()
+	{
+		return $this->new_loader;
+	}
+
+
+	/**
+	 * @return CachingLoaderDecoratorInterface
+	 */
+	public function getSharedLoader()
+	{
+		return $this->shared_loader;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, array $arguments = array(), $shared = true)
+	{
+		$fqcn = $this->class_cache->getFqn($fqcn);
+		if ($this->class_cache->hasInterface($fqcn, 'EventEspresso\core\interfaces\ReservedInstanceInterface')) {
+			$shared = true;
+		}
+		return $shared
+			? $this->getSharedLoader()->load($fqcn, $arguments, $shared)
+			: $this->getNewLoader()->load($fqcn, $arguments, $shared);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getNew($fqcn, array $arguments = array())
+	{
+		return $this->load($fqcn, $arguments, false);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getShared($fqcn, array $arguments = array())
+	{
+		return $this->load($fqcn, $arguments);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object)
+	{
+		$fqcn = $this->class_cache->getFqn($fqcn);
+		return $this->getSharedLoader()->share($fqcn, $object);
+	}
+
+
+	/**
+	 * calls reset() on loaders if that method exists
+	 */
+	public function reset()
+	{
+		$this->shared_loader->reset();
+	}
 }

core/services/bootstrap/BootstrapDependencyInjectionContainer.php

Spacing +2 added lines, -2 removed lines

@@ -78,13 +78,13 @@
         // EE_Dependency_Map: info about how to load classes required by other classes
         espresso_load_required(
             'EE_Dependency_Map',
-            EE_CORE . 'EE_Dependency_Map.core.php'
+            EE_CORE.'EE_Dependency_Map.core.php'
         );
         $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
         // EE_Registry: central repository for classes (legacy)
         espresso_load_required(
             'EE_Registry',
-            EE_CORE . 'EE_Registry.core.php'
+            EE_CORE.'EE_Registry.core.php'
         );
         $this->registry = EE_Registry::instance(
             $this->dependency_map,

Indentation +119 added lines, -119 removed lines

@@ -25,123 +25,123 @@
 class BootstrapDependencyInjectionContainer
 {
 
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    protected $dependency_map;
-
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @var Mirror
-     */
-    private $mirror;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * Can't use this just yet until we exorcise some more of our singleton usage from core
-     */
-    public function buildDependencyInjectionContainer()
-    {
-        // build DI container
-        // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
-        // $OpenCoffeeShop->addRecipes();
-        // $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
-    }
-
-
-    /**
-     * Setups  EE_Registry and EE_Dependency_Map
-     *
-     * @throws EE_Error
-     */
-    public function buildLegacyDependencyInjectionContainer()
-    {
-        $this->class_cache = new ClassInterfaceCache();
-        $this->object_identifier = new ObjectIdentifier($this->class_cache);
-        $this->mirror = new Mirror();
-        // EE_Dependency_Map: info about how to load classes required by other classes
-        espresso_load_required(
-            'EE_Dependency_Map',
-            EE_CORE . 'EE_Dependency_Map.core.php'
-        );
-        $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
-        // EE_Registry: central repository for classes (legacy)
-        espresso_load_required(
-            'EE_Registry',
-            EE_CORE . 'EE_Registry.core.php'
-        );
-        $this->registry = EE_Registry::instance(
-            $this->dependency_map,
-            $this->mirror,
-            $this->class_cache,
-            $this->object_identifier
-        );
-    }
-
-
-    /**
-     * Performs initial setup for the generic Loader
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function buildLoader()
-    {
-        $this->loader = LoaderFactory::getLoader(
-            $this->registry,
-            $this->class_cache,
-            $this->object_identifier
-        );
-        $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
-        $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
-        $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
-        $this->dependency_map->setLoader($this->loader);
-    }
-
-
-    /**
-     * @return EE_Dependency_Map
-     */
-    public function getDependencyMap()
-    {
-        return $this->dependency_map;
-    }
-
-
-    /**
-     * @return EE_Registry
-     */
-    public function getRegistry()
-    {
-        return $this->registry;
-    }
-
-
-    /**
-     * @return LoaderInterface
-     */
-    public function getLoader()
-    {
-        return $this->loader;
-    }
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	protected $dependency_map;
+
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @var Mirror
+	 */
+	private $mirror;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * Can't use this just yet until we exorcise some more of our singleton usage from core
+	 */
+	public function buildDependencyInjectionContainer()
+	{
+		// build DI container
+		// $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
+		// $OpenCoffeeShop->addRecipes();
+		// $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
+	}
+
+
+	/**
+	 * Setups  EE_Registry and EE_Dependency_Map
+	 *
+	 * @throws EE_Error
+	 */
+	public function buildLegacyDependencyInjectionContainer()
+	{
+		$this->class_cache = new ClassInterfaceCache();
+		$this->object_identifier = new ObjectIdentifier($this->class_cache);
+		$this->mirror = new Mirror();
+		// EE_Dependency_Map: info about how to load classes required by other classes
+		espresso_load_required(
+			'EE_Dependency_Map',
+			EE_CORE . 'EE_Dependency_Map.core.php'
+		);
+		$this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
+		// EE_Registry: central repository for classes (legacy)
+		espresso_load_required(
+			'EE_Registry',
+			EE_CORE . 'EE_Registry.core.php'
+		);
+		$this->registry = EE_Registry::instance(
+			$this->dependency_map,
+			$this->mirror,
+			$this->class_cache,
+			$this->object_identifier
+		);
+	}
+
+
+	/**
+	 * Performs initial setup for the generic Loader
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function buildLoader()
+	{
+		$this->loader = LoaderFactory::getLoader(
+			$this->registry,
+			$this->class_cache,
+			$this->object_identifier
+		);
+		$this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
+		$this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
+		$this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
+		$this->dependency_map->setLoader($this->loader);
+	}
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 */
+	public function getDependencyMap()
+	{
+		return $this->dependency_map;
+	}
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	public function getRegistry()
+	{
+		return $this->registry;
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 */
+	public function getLoader()
+	{
+		return $this->loader;
+	}
 }

core/services/container/Mirror.php

Indentation +222 added lines, -222 removed lines

@@ -25,226 +25,226 @@
 class Mirror
 {
 
-    /**
-     * @var ReflectionClass[] $classes
-     */
-    private $classes = array();
-
-    /**
-     * @var ReflectionMethod[] $constructors
-     */
-    private $constructors = array();
-
-    /**
-     * @var ReflectionParameter[][] $parameters
-     */
-    private $parameters = array();
-
-    /**
-     * @var ReflectionParameter[][] $parameters
-     */
-    private $parameter_classes = array();
-
-    /**
-     * @var ReflectionProperty[][] $properties
-     */
-    private $properties = array();
-
-    /**
-     * @var ReflectionMethod[][] $methods
-     */
-    private $methods = array();
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    public function getReflectionClass($class_name)
-    {
-        if (! is_string($class_name)) {
-            throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
-        }
-        if (! isset($this->classes[ $class_name ])) {
-            $this->classes[ $class_name ] = new ReflectionClass($class_name);
-        }
-        return $this->classes[ $class_name ];
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionMethod
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getConstructor($class_name)
-    {
-        if (! is_string($class_name)) {
-            throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
-        }
-        if (! isset($this->constructors[ $class_name ])) {
-            $reflection_class                  = $this->getReflectionClass($class_name);
-            $this->constructors[ $class_name ] = $reflection_class->getConstructor();
-        }
-        return $this->constructors[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class
-     * @return ReflectionMethod
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getConstructorFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getConstructor($reflection_class->getName());
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionParameter[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getParameters($class_name)
-    {
-        if (! isset($this->parameters[ $class_name ])) {
-            $constructor                     = $this->getConstructor($class_name);
-            $this->parameters[ $class_name ] = $constructor->getParameters();
-        }
-        return $this->parameters[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class
-     * @return ReflectionParameter[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getParametersFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getParameters($reflection_class->getName());
-    }
-
-
-    /**
-     * @param ReflectionMethod $constructor
-     * @return ReflectionParameter[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getParametersFromReflectionConstructor(ReflectionMethod $constructor)
-    {
-        return $this->getParameters($constructor->getDeclaringClass());
-    }
-
-
-    /**
-     * @param ReflectionParameter $param
-     * @param string              $class_name
-     * @param string              $index
-     * @return string|null
-     */
-    public function getParameterClassName(ReflectionParameter $param, $class_name, $index)
-    {
-        if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) {
-            return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
-        }
-        if (! isset($this->parameter_classes[ $class_name ])) {
-            $this->parameter_classes[ $class_name ] = array();
-        }
-        if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
-            $this->parameter_classes[ $class_name ][ $index ] = array();
-        }
-        $this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = $param->getClass()
-            ? $param->getClass()->name
-            : null;
-        return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
-    }
-
-
-    /**
-     * @param ReflectionParameter $param
-     * @param string              $class_name
-     * @param string              $index
-     * @return string|null
-     */
-    public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index)
-    {
-        if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) {
-            return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
-        }
-        if (! isset($this->parameter_classes[ $class_name ])) {
-            $this->parameter_classes[ $class_name ] = array();
-        }
-        if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
-            $this->parameter_classes[ $class_name ][ $index ] = array();
-        }
-        $this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable()
-            ? $param->getDefaultValue()
-            : null;
-        return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionProperty[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getProperties($class_name)
-    {
-        if (! isset($this->properties[ $class_name ])) {
-            $reflection_class                = $this->getReflectionClass($class_name);
-            $this->properties[ $class_name ] = $reflection_class->getProperties();
-        }
-        return $this->properties[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class
-     * @return ReflectionProperty[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getPropertiesFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getProperties($reflection_class->getName());
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionMethod[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getMethods($class_name)
-    {
-        if (! isset($this->methods[ $class_name ])) {
-            $reflection_class             = $this->getReflectionClass($class_name);
-            $this->methods[ $class_name ] = $reflection_class->getMethods();
-        }
-        return $this->methods[ $class_name ];
-    }
-
-
-    /**
-     * @param ReflectionClass $reflection_class )
-     * @return ReflectionMethod[]
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function getMethodsFromReflection(ReflectionClass $reflection_class)
-    {
-        return $this->getMethods($reflection_class->getName());
-    }
+	/**
+	 * @var ReflectionClass[] $classes
+	 */
+	private $classes = array();
+
+	/**
+	 * @var ReflectionMethod[] $constructors
+	 */
+	private $constructors = array();
+
+	/**
+	 * @var ReflectionParameter[][] $parameters
+	 */
+	private $parameters = array();
+
+	/**
+	 * @var ReflectionParameter[][] $parameters
+	 */
+	private $parameter_classes = array();
+
+	/**
+	 * @var ReflectionProperty[][] $properties
+	 */
+	private $properties = array();
+
+	/**
+	 * @var ReflectionMethod[][] $methods
+	 */
+	private $methods = array();
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	public function getReflectionClass($class_name)
+	{
+		if (! is_string($class_name)) {
+			throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
+		}
+		if (! isset($this->classes[ $class_name ])) {
+			$this->classes[ $class_name ] = new ReflectionClass($class_name);
+		}
+		return $this->classes[ $class_name ];
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionMethod
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getConstructor($class_name)
+	{
+		if (! is_string($class_name)) {
+			throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
+		}
+		if (! isset($this->constructors[ $class_name ])) {
+			$reflection_class                  = $this->getReflectionClass($class_name);
+			$this->constructors[ $class_name ] = $reflection_class->getConstructor();
+		}
+		return $this->constructors[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class
+	 * @return ReflectionMethod
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getConstructorFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getConstructor($reflection_class->getName());
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionParameter[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getParameters($class_name)
+	{
+		if (! isset($this->parameters[ $class_name ])) {
+			$constructor                     = $this->getConstructor($class_name);
+			$this->parameters[ $class_name ] = $constructor->getParameters();
+		}
+		return $this->parameters[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class
+	 * @return ReflectionParameter[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getParametersFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getParameters($reflection_class->getName());
+	}
+
+
+	/**
+	 * @param ReflectionMethod $constructor
+	 * @return ReflectionParameter[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getParametersFromReflectionConstructor(ReflectionMethod $constructor)
+	{
+		return $this->getParameters($constructor->getDeclaringClass());
+	}
+
+
+	/**
+	 * @param ReflectionParameter $param
+	 * @param string              $class_name
+	 * @param string              $index
+	 * @return string|null
+	 */
+	public function getParameterClassName(ReflectionParameter $param, $class_name, $index)
+	{
+		if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) {
+			return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
+		}
+		if (! isset($this->parameter_classes[ $class_name ])) {
+			$this->parameter_classes[ $class_name ] = array();
+		}
+		if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
+			$this->parameter_classes[ $class_name ][ $index ] = array();
+		}
+		$this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = $param->getClass()
+			? $param->getClass()->name
+			: null;
+		return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
+	}
+
+
+	/**
+	 * @param ReflectionParameter $param
+	 * @param string              $class_name
+	 * @param string              $index
+	 * @return string|null
+	 */
+	public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index)
+	{
+		if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) {
+			return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
+		}
+		if (! isset($this->parameter_classes[ $class_name ])) {
+			$this->parameter_classes[ $class_name ] = array();
+		}
+		if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
+			$this->parameter_classes[ $class_name ][ $index ] = array();
+		}
+		$this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable()
+			? $param->getDefaultValue()
+			: null;
+		return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionProperty[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getProperties($class_name)
+	{
+		if (! isset($this->properties[ $class_name ])) {
+			$reflection_class                = $this->getReflectionClass($class_name);
+			$this->properties[ $class_name ] = $reflection_class->getProperties();
+		}
+		return $this->properties[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class
+	 * @return ReflectionProperty[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getPropertiesFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getProperties($reflection_class->getName());
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionMethod[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getMethods($class_name)
+	{
+		if (! isset($this->methods[ $class_name ])) {
+			$reflection_class             = $this->getReflectionClass($class_name);
+			$this->methods[ $class_name ] = $reflection_class->getMethods();
+		}
+		return $this->methods[ $class_name ];
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflection_class )
+	 * @return ReflectionMethod[]
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function getMethodsFromReflection(ReflectionClass $reflection_class)
+	{
+		return $this->getMethods($reflection_class->getName());
+	}
 }

Spacing +33 added lines, -33 removed lines

@@ -64,13 +64,13 @@ 
      */
     public function getReflectionClass($class_name)
     {
-        if (! is_string($class_name)) {
+        if ( ! is_string($class_name)) {
             throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
         }
-        if (! isset($this->classes[ $class_name ])) {
-            $this->classes[ $class_name ] = new ReflectionClass($class_name);
+        if ( ! isset($this->classes[$class_name])) {
+            $this->classes[$class_name] = new ReflectionClass($class_name);
         }
-        return $this->classes[ $class_name ];
+        return $this->classes[$class_name];
     }
 
 
@@ -82,14 +82,14 @@ 
      */
     public function getConstructor($class_name)
     {
-        if (! is_string($class_name)) {
+        if ( ! is_string($class_name)) {
             throw new InvalidDataTypeException($class_name, '$class_name', 'string (fully qualified class name)');
         }
-        if (! isset($this->constructors[ $class_name ])) {
+        if ( ! isset($this->constructors[$class_name])) {
             $reflection_class                  = $this->getReflectionClass($class_name);
-            $this->constructors[ $class_name ] = $reflection_class->getConstructor();
+            $this->constructors[$class_name] = $reflection_class->getConstructor();
         }
-        return $this->constructors[ $class_name ];
+        return $this->constructors[$class_name];
     }
 
 
@@ -113,11 +113,11 @@ 
      */
     public function getParameters($class_name)
     {
-        if (! isset($this->parameters[ $class_name ])) {
+        if ( ! isset($this->parameters[$class_name])) {
             $constructor                     = $this->getConstructor($class_name);
-            $this->parameters[ $class_name ] = $constructor->getParameters();
+            $this->parameters[$class_name] = $constructor->getParameters();
         }
-        return $this->parameters[ $class_name ];
+        return $this->parameters[$class_name];
     }
 
 
@@ -153,19 +153,19 @@ 
      */
     public function getParameterClassName(ReflectionParameter $param, $class_name, $index)
     {
-        if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_name'])) {
-            return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
+        if (isset($this->parameter_classes[$class_name][$index]['param_class_name'])) {
+            return $this->parameter_classes[$class_name][$index]['param_class_name'];
         }
-        if (! isset($this->parameter_classes[ $class_name ])) {
-            $this->parameter_classes[ $class_name ] = array();
+        if ( ! isset($this->parameter_classes[$class_name])) {
+            $this->parameter_classes[$class_name] = array();
         }
-        if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
-            $this->parameter_classes[ $class_name ][ $index ] = array();
+        if ( ! isset($this->parameter_classes[$class_name][$index])) {
+            $this->parameter_classes[$class_name][$index] = array();
         }
-        $this->parameter_classes[ $class_name ][ $index ]['param_class_name'] = $param->getClass()
+        $this->parameter_classes[$class_name][$index]['param_class_name'] = $param->getClass()
             ? $param->getClass()->name
             : null;
-        return $this->parameter_classes[ $class_name ][ $index ]['param_class_name'];
+        return $this->parameter_classes[$class_name][$index]['param_class_name'];
     }
 
 
@@ -177,19 +177,19 @@ 
      */
     public function getParameterDefaultValue(ReflectionParameter $param, $class_name, $index)
     {
-        if (isset($this->parameter_classes[ $class_name ][ $index ]['param_class_default'])) {
-            return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
+        if (isset($this->parameter_classes[$class_name][$index]['param_class_default'])) {
+            return $this->parameter_classes[$class_name][$index]['param_class_default'];
         }
-        if (! isset($this->parameter_classes[ $class_name ])) {
-            $this->parameter_classes[ $class_name ] = array();
+        if ( ! isset($this->parameter_classes[$class_name])) {
+            $this->parameter_classes[$class_name] = array();
         }
-        if (! isset($this->parameter_classes[ $class_name ][ $index ])) {
-            $this->parameter_classes[ $class_name ][ $index ] = array();
+        if ( ! isset($this->parameter_classes[$class_name][$index])) {
+            $this->parameter_classes[$class_name][$index] = array();
         }
-        $this->parameter_classes[ $class_name ][ $index ]['param_class_default'] = $param->isDefaultValueAvailable()
+        $this->parameter_classes[$class_name][$index]['param_class_default'] = $param->isDefaultValueAvailable()
             ? $param->getDefaultValue()
             : null;
-        return $this->parameter_classes[ $class_name ][ $index ]['param_class_default'];
+        return $this->parameter_classes[$class_name][$index]['param_class_default'];
     }
 
 
@@ -201,11 +201,11 @@ 
      */
     public function getProperties($class_name)
     {
-        if (! isset($this->properties[ $class_name ])) {
+        if ( ! isset($this->properties[$class_name])) {
             $reflection_class                = $this->getReflectionClass($class_name);
-            $this->properties[ $class_name ] = $reflection_class->getProperties();
+            $this->properties[$class_name] = $reflection_class->getProperties();
         }
-        return $this->properties[ $class_name ];
+        return $this->properties[$class_name];
     }
 
 
@@ -229,11 +229,11 @@ 
      */
     public function getMethods($class_name)
     {
-        if (! isset($this->methods[ $class_name ])) {
+        if ( ! isset($this->methods[$class_name])) {
             $reflection_class             = $this->getReflectionClass($class_name);
-            $this->methods[ $class_name ] = $reflection_class->getMethods();
+            $this->methods[$class_name] = $reflection_class->getMethods();
         }
-        return $this->methods[ $class_name ];
+        return $this->methods[$class_name];
     }
 
 

core/db_models/EEM_Line_Item.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -416,7 +416,7 @@
      * If $expired is set to true, then only line items for expired sessions will be returned.
      * If $expired is set to false, then only line items for active sessions will be returned.
      *
-     * @param null $expired
+     * @param boolean $expired
      * @return EE_Base_Class[]|EE_Line_Item[]
      * @throws EE_Error
      * @throws InvalidArgumentException

Indentation +436 added lines, -436 removed lines

@@ -32,443 +32,443 @@
 class EEM_Line_Item extends EEM_Base
 {
 
-    /**
-     * Tax sub-total is just the total of all the taxes, which should be children
-     * of this line item. There should only ever be one tax sub-total, and it should
-     * be a direct child of. Its quantity and LIN_unit_price = 1.
-     */
-    const type_tax_sub_total = 'tax-sub-total';
-
-    /**
-     * Tax line items indicate a tax applied to all the taxable line items.
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
-     */
-    const type_tax = 'tax';
-
-    /**
-     * Indicating individual items purchased, or discounts or surcharges.
-     * The sum of all the regular line items  plus the tax items should equal
-     * the grand total.
-     * Possible children are sub-line-items and cancellations.
-     * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
-     * LIN_totals. Its LIN_percent = 0.
-     * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
-     * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
-     */
-    const type_line_item = 'line-item';
-
-    /**
-     * Line item indicating all the factors that make a single line item.
-     * Sub-line items should have NO children line items.
-     * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
-     * contribution towards the price of ONE of their parent items, and its LIN_total should be
-     *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
-     * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
-     * = LIN_percent / 100 * sum of lower-priority sibling line items..
-     */
-    const type_sub_line_item = 'sub-item';
-
-    /**
-     * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
-     * Direct children should be event subtotals.
-     * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
-     *
-     */
-    const type_sub_total = 'sub-total';
-
-    /**
-     * Line item for the grand total of an order. Its direct children
-     * should be tax subtotals and (pre-tax) subtotals, and possibly a regular line item
-     * indicating a transaction-wide discount/surcharge. Should have a quantity of 1, a LIN_total and LIN_unit_price of
-     * the entire order's mount.
-     */
-    const type_total = 'total';
-
-    /**
-     * When a line item is cancelled, a sub-line-item of type 'cancellation'
-     * should be created, indicating the quantity that were cancelled
-     * (because a line item could have a quantity of 1, and its cancellation item
-     * could be for 3, indicating that originally 4 were purchased, but 3 have been
-     * cancelled, and only one remains).
-     * When items are refunded, a cancellation line item should be made, which points
-     * to teh payment model object which actually refunded the payment.
-     * Cancellations should NOT have any children line items; the should NOT affect
-     * any calculations, and are only meant as a record that cancellations have occurred.
-     * Their LIN_percent should be 0.
-     */
-    const type_cancellation = 'cancellation';
-
-    // private instance of the EEM_Line_Item object
-    protected static $_instance = null;
-
-
-    /**
-     *        private constructor to prevent direct creation
-     * @Constructor
-     * @access protected
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @return \EEM_Line_Item
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Line Item', 'event_espresso');
-        $this->plural_item = __('Line Items', 'event_espresso');
-
-        $this->_tables = array(
-            'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID')
-        );
-        $line_items_can_be_for = apply_filters('FHEE__EEM_Line_Item__line_items_can_be_for', array('Ticket', 'Price', 'Event'));
-        $this->_fields = array(
-            'Line_Item' => array(
-                'LIN_ID' => new EE_Primary_Key_Int_Field('LIN_ID', __("ID", "event_espresso")),
-                'LIN_code' => new EE_Slug_Field('LIN_code', __("Code for index into Cart", "event_espresso"), true),
-                'TXN_ID' => new EE_Foreign_Key_Int_Field('TXN_ID', __("Transaction ID", "event_espresso"), true, null, 'Transaction'),
-                'LIN_name' => new EE_Full_HTML_Field('LIN_name', __("Line Item Name", "event_espresso"), false, ''),
-                'LIN_desc' => new EE_Full_HTML_Field('LIN_desc', __("Line Item Description", "event_espresso"), true),
-                'LIN_unit_price' => new EE_Money_Field('LIN_unit_price', __("Unit Price", "event_espresso"), false, 0),
-                'LIN_percent' => new EE_Float_Field('LIN_percent', __("Percent", "event_espresso"), false, 0),
-                'LIN_is_taxable' => new EE_Boolean_Field('LIN_is_taxable', __("Taxable", "event_espresso"), false, false),
-                'LIN_order' => new EE_Integer_Field('LIN_order', __("Order of Application towards total of parent", "event_espresso"), false, 1),
-                'LIN_total' => new EE_Money_Field('LIN_total', __("Total (unit price x quantity)", "event_espresso"), false, 0),
-                'LIN_quantity' => new EE_Integer_Field('LIN_quantity', __("Quantity", "event_espresso"), true, 1),
-                'LIN_parent' => new EE_Integer_Field('LIN_parent', __("Parent ID (this item goes towards that Line Item's total)", "event_espresso"), true, null),
-                'LIN_type' => new EE_Enum_Text_Field('LIN_type', __("Type", "event_espresso"), false, 'line-item', array(
-                        self::type_line_item => __("Line Item", "event_espresso"),
-                        self::type_sub_line_item => __("Sub-Item", "event_espresso"),
-                        self::type_sub_total => __("Subtotal", "event_espresso"),
-                        self::type_tax_sub_total => __("Tax Subtotal", "event_espresso"),
-                        self::type_tax => __("Tax", "event_espresso"),
-                        self::type_total => __("Total", "event_espresso"),
-                        self::type_cancellation => __('Cancellation', 'event_espresso')
-                    )),
-                'OBJ_ID' => new EE_Foreign_Key_Int_Field('OBJ_ID', __('ID of Item purchased.', 'event_espresso'), true, null, $line_items_can_be_for),
-                'OBJ_type' => new EE_Any_Foreign_Model_Name_Field('OBJ_type', __("Model Name this Line Item is for", "event_espresso"), true, null, $line_items_can_be_for),
-                'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('When the line item was created', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
-            )
-        );
-        $this->_model_relations = array(
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Ticket' => new EE_Belongs_To_Any_Relation(),
-            'Price' => new EE_Belongs_To_Any_Relation(),
-            'Event' => new EE_Belongs_To_Any_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
-        $this->_caps_slug = 'transactions';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets all the line items for this transaction of the given type
-     * @param string $line_item_type like one of EEM_Line_Item::type_*
-     * @param EE_Transaction|int $transaction
-     * @return EE_Line_Item[]
-     */
-    public function get_all_of_type_for_transaction($line_item_type, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(array(array(
-            'LIN_type' => $line_item_type,
-            'TXN_ID' => $transaction
-        )));
-    }
-
-
-    /**
-     * Gets all line items unrelated to tickets that are normal line items
-     * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
-     * @param EE_Transaction|int $transaction
-     * @return EE_Line_Item[]
-     */
-    public function get_all_non_ticket_line_items_for_transaction($transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(array(array(
-            'LIN_type' => self::type_line_item,
-            'TXN_ID' => $transaction,
-            'OR' => array(
-                'OBJ_type*notticket' => array('!=', 'Ticket'),
-                'OBJ_type*null' => array('IS_NULL'))
-        )));
-    }
-
-    /**
-     * Deletes line items with no transaction who have passed the transaction cutoff time.
-     * This needs to be very efficient
-     * because if there are spam bots afoot there will be LOTS of line items
-     * @return int count of how many deleted
-     */
-    public function delete_line_items_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
-            WEEK_IN_SECONDS
-        );
-        $query = $wpdb->prepare(
-            'DELETE li
+	/**
+	 * Tax sub-total is just the total of all the taxes, which should be children
+	 * of this line item. There should only ever be one tax sub-total, and it should
+	 * be a direct child of. Its quantity and LIN_unit_price = 1.
+	 */
+	const type_tax_sub_total = 'tax-sub-total';
+
+	/**
+	 * Tax line items indicate a tax applied to all the taxable line items.
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
+	 */
+	const type_tax = 'tax';
+
+	/**
+	 * Indicating individual items purchased, or discounts or surcharges.
+	 * The sum of all the regular line items  plus the tax items should equal
+	 * the grand total.
+	 * Possible children are sub-line-items and cancellations.
+	 * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
+	 * LIN_totals. Its LIN_percent = 0.
+	 * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
+	 * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
+	 */
+	const type_line_item = 'line-item';
+
+	/**
+	 * Line item indicating all the factors that make a single line item.
+	 * Sub-line items should have NO children line items.
+	 * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
+	 * contribution towards the price of ONE of their parent items, and its LIN_total should be
+	 *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
+	 * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
+	 * = LIN_percent / 100 * sum of lower-priority sibling line items..
+	 */
+	const type_sub_line_item = 'sub-item';
+
+	/**
+	 * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
+	 * Direct children should be event subtotals.
+	 * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
+	 *
+	 */
+	const type_sub_total = 'sub-total';
+
+	/**
+	 * Line item for the grand total of an order. Its direct children
+	 * should be tax subtotals and (pre-tax) subtotals, and possibly a regular line item
+	 * indicating a transaction-wide discount/surcharge. Should have a quantity of 1, a LIN_total and LIN_unit_price of
+	 * the entire order's mount.
+	 */
+	const type_total = 'total';
+
+	/**
+	 * When a line item is cancelled, a sub-line-item of type 'cancellation'
+	 * should be created, indicating the quantity that were cancelled
+	 * (because a line item could have a quantity of 1, and its cancellation item
+	 * could be for 3, indicating that originally 4 were purchased, but 3 have been
+	 * cancelled, and only one remains).
+	 * When items are refunded, a cancellation line item should be made, which points
+	 * to teh payment model object which actually refunded the payment.
+	 * Cancellations should NOT have any children line items; the should NOT affect
+	 * any calculations, and are only meant as a record that cancellations have occurred.
+	 * Their LIN_percent should be 0.
+	 */
+	const type_cancellation = 'cancellation';
+
+	// private instance of the EEM_Line_Item object
+	protected static $_instance = null;
+
+
+	/**
+	 *        private constructor to prevent direct creation
+	 * @Constructor
+	 * @access protected
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @return \EEM_Line_Item
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Line Item', 'event_espresso');
+		$this->plural_item = __('Line Items', 'event_espresso');
+
+		$this->_tables = array(
+			'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID')
+		);
+		$line_items_can_be_for = apply_filters('FHEE__EEM_Line_Item__line_items_can_be_for', array('Ticket', 'Price', 'Event'));
+		$this->_fields = array(
+			'Line_Item' => array(
+				'LIN_ID' => new EE_Primary_Key_Int_Field('LIN_ID', __("ID", "event_espresso")),
+				'LIN_code' => new EE_Slug_Field('LIN_code', __("Code for index into Cart", "event_espresso"), true),
+				'TXN_ID' => new EE_Foreign_Key_Int_Field('TXN_ID', __("Transaction ID", "event_espresso"), true, null, 'Transaction'),
+				'LIN_name' => new EE_Full_HTML_Field('LIN_name', __("Line Item Name", "event_espresso"), false, ''),
+				'LIN_desc' => new EE_Full_HTML_Field('LIN_desc', __("Line Item Description", "event_espresso"), true),
+				'LIN_unit_price' => new EE_Money_Field('LIN_unit_price', __("Unit Price", "event_espresso"), false, 0),
+				'LIN_percent' => new EE_Float_Field('LIN_percent', __("Percent", "event_espresso"), false, 0),
+				'LIN_is_taxable' => new EE_Boolean_Field('LIN_is_taxable', __("Taxable", "event_espresso"), false, false),
+				'LIN_order' => new EE_Integer_Field('LIN_order', __("Order of Application towards total of parent", "event_espresso"), false, 1),
+				'LIN_total' => new EE_Money_Field('LIN_total', __("Total (unit price x quantity)", "event_espresso"), false, 0),
+				'LIN_quantity' => new EE_Integer_Field('LIN_quantity', __("Quantity", "event_espresso"), true, 1),
+				'LIN_parent' => new EE_Integer_Field('LIN_parent', __("Parent ID (this item goes towards that Line Item's total)", "event_espresso"), true, null),
+				'LIN_type' => new EE_Enum_Text_Field('LIN_type', __("Type", "event_espresso"), false, 'line-item', array(
+						self::type_line_item => __("Line Item", "event_espresso"),
+						self::type_sub_line_item => __("Sub-Item", "event_espresso"),
+						self::type_sub_total => __("Subtotal", "event_espresso"),
+						self::type_tax_sub_total => __("Tax Subtotal", "event_espresso"),
+						self::type_tax => __("Tax", "event_espresso"),
+						self::type_total => __("Total", "event_espresso"),
+						self::type_cancellation => __('Cancellation', 'event_espresso')
+					)),
+				'OBJ_ID' => new EE_Foreign_Key_Int_Field('OBJ_ID', __('ID of Item purchased.', 'event_espresso'), true, null, $line_items_can_be_for),
+				'OBJ_type' => new EE_Any_Foreign_Model_Name_Field('OBJ_type', __("Model Name this Line Item is for", "event_espresso"), true, null, $line_items_can_be_for),
+				'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('When the line item was created', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
+			)
+		);
+		$this->_model_relations = array(
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Ticket' => new EE_Belongs_To_Any_Relation(),
+			'Price' => new EE_Belongs_To_Any_Relation(),
+			'Event' => new EE_Belongs_To_Any_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
+		$this->_caps_slug = 'transactions';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets all the line items for this transaction of the given type
+	 * @param string $line_item_type like one of EEM_Line_Item::type_*
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Line_Item[]
+	 */
+	public function get_all_of_type_for_transaction($line_item_type, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(array(
+			'LIN_type' => $line_item_type,
+			'TXN_ID' => $transaction
+		)));
+	}
+
+
+	/**
+	 * Gets all line items unrelated to tickets that are normal line items
+	 * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Line_Item[]
+	 */
+	public function get_all_non_ticket_line_items_for_transaction($transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(array(
+			'LIN_type' => self::type_line_item,
+			'TXN_ID' => $transaction,
+			'OR' => array(
+				'OBJ_type*notticket' => array('!=', 'Ticket'),
+				'OBJ_type*null' => array('IS_NULL'))
+		)));
+	}
+
+	/**
+	 * Deletes line items with no transaction who have passed the transaction cutoff time.
+	 * This needs to be very efficient
+	 * because if there are spam bots afoot there will be LOTS of line items
+	 * @return int count of how many deleted
+	 */
+	public function delete_line_items_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
+			WEEK_IN_SECONDS
+		);
+		$query = $wpdb->prepare(
+			'DELETE li
 				FROM ' . $this->table() . ' li
 				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
-            // use GMT time because that's what TXN_timestamps are in
-            date('Y-m-d H:i:s', time() - $time_to_leave_alone)
-        );
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * get_line_item_for_transaction_object
-     * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
-     *
-     * @param int $TXN_ID
-     * @param \EE_Base_Class $object
-     * @return EE_Line_Item[]
-     */
-    public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
-    {
-        return $this->get_all(array(array(
-            'TXN_ID' => $TXN_ID,
-            'OBJ_type' => str_replace('EE_', '', get_class($object)),
-            'OBJ_ID' => $object->ID()
-        )));
-    }
-
-
-    /**
-     * get_object_line_items_for_transaction
-     * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
-     *
-     * @param int $TXN_ID
-     * @param string $OBJ_type
-     * @param array $OBJ_IDs
-     * @return EE_Line_Item[]
-     */
-    public function get_object_line_items_for_transaction($TXN_ID, $OBJ_type = 'Event', $OBJ_IDs = array())
-    {
-        $query_params = array(
-            'OBJ_type' => $OBJ_type,
-            // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-            'OBJ_ID' => is_array($OBJ_IDs) && !isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
-        );
-        if ($TXN_ID) {
-            $query_params['TXN_ID'] = $TXN_ID;
-        }
-        return $this->get_all(array($query_params));
-    }
-
-
-    /**
-     * get_all_ticket_line_items_for_transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item[]
-     */
-    public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->get_all(array(
-            array(
-                'TXN_ID' => $transaction->ID(),
-                'OBJ_type' => 'Ticket',
-            )
-        ));
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction
-     *
-     * @param int $TXN_ID
-     * @param int $TKT_ID
-     * @return \EE_Line_Item
-     */
-    public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
-    {
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
-                'OBJ_ID' => $TKT_ID,
-                'OBJ_type' => 'Ticket',
-            )
-        ));
-    }
-
-
-    /**
-     * get_existing_promotion_line_item
-     * searches the cart for existing line items for the specified promotion
-     *
-     * @since   1.0.0
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param EE_Promotion $promotion
-     * @return EE_Line_Item
-     */
-    public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
-    {
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => $parent_line_item->TXN_ID(),
-                'LIN_parent' => $parent_line_item->ID(),
-                'OBJ_type' => 'Promotion',
-                'OBJ_ID' => $promotion->ID()
-            )
-        ));
-    }
-
-
-    /**
-     * get_all_promotion_line_items
-     * searches the cart for any and all existing promotion line items
-     *
-     * @since   1.0.0
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @return EE_Line_Item[]
-     */
-    public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
-    {
-        return $this->get_all(array(
-            array(
-                'TXN_ID' => $parent_line_item->TXN_ID(),
-                'LIN_parent' => $parent_line_item->ID(),
-                'OBJ_type' => 'Promotion'
-            )
-        ));
-    }
-
-    /**
-     * Gets the registration's corresponding line item.
-     * Note: basically does NOT support having multiple line items for a single ticket,
-     * which would happen if some of the registrations had a price modifier while others didn't.
-     * In order to support that, we'd probably need a LIN_ID on registrations or something.
-     * @param EE_Registration $registration
-     * @return EE_Line_ITem
-     */
-    public function get_line_item_for_registration(EE_Registration $registration)
-    {
-        return $this->get_one($this->line_item_for_registration_query_params($registration));
-    }
-
-    /**
-     * Gets the query params used to retrieve a specific line item for the given registration
-     * @param EE_Registration $registration
-     * @param array $original_query_params any extra query params you'd like to be merged with
-     * @return array like EEM_Base::get_all()'s $query_params
-     */
-    public function line_item_for_registration_query_params(EE_Registration $registration, $original_query_params = array())
-    {
-        return array_replace_recursive($original_query_params, array(
-            array(
-                'OBJ_ID' => $registration->ticket_ID(),
-                'OBJ_type' => 'Ticket',
-                'TXN_ID' => $registration->transaction_ID()
-            )
-        ));
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_with_no_transaction()
-    {
-        return $this->get_total_line_items_for_carts();
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_active_carts()
-    {
-        return $this->get_total_line_items_for_carts(false);
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_expired_carts()
-    {
-        return $this->get_total_line_items_for_carts(true);
-    }
-
-
-    /**
-     * Returns an array of grand total line items where the TXN_ID is 0.
-     * If $expired is set to true, then only line items for expired sessions will be returned.
-     * If $expired is set to false, then only line items for active sessions will be returned.
-     *
-     * @param null $expired
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function get_total_line_items_for_carts($expired = null)
-    {
-        $where_params = array(
-            'TXN_ID' => 0,
-            'LIN_type' => 'total',
-        );
-        if ($expired !== null) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $where_params['LIN_timestamp'] = array(
-                $expired ? '<=' : '>',
-                $session_lifespan->expiration(),
-            );
-        }
-        return $this->get_all(array($where_params));
-    }
-
-
-    /**
-     * Returns an array of ticket total line items where the TXN_ID is 0
-     * AND the timestamp is older than the session lifespan.
-     *
-     * @param int $timestamp
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getTicketLineItemsForExpiredCarts($timestamp = 0)
-    {
-        if (! absint($timestamp)) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $timestamp = $session_lifespan->expiration();
-        }
-        return $this->get_all(
-            array(
-                array(
-                    'TXN_ID'        => 0,
-                    'OBJ_type'      => 'Ticket',
-                    'LIN_timestamp' => array('<=', $timestamp),
-                )
-            )
-        );
-    }
+			// use GMT time because that's what TXN_timestamps are in
+			date('Y-m-d H:i:s', time() - $time_to_leave_alone)
+		);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * get_line_item_for_transaction_object
+	 * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
+	 *
+	 * @param int $TXN_ID
+	 * @param \EE_Base_Class $object
+	 * @return EE_Line_Item[]
+	 */
+	public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
+	{
+		return $this->get_all(array(array(
+			'TXN_ID' => $TXN_ID,
+			'OBJ_type' => str_replace('EE_', '', get_class($object)),
+			'OBJ_ID' => $object->ID()
+		)));
+	}
+
+
+	/**
+	 * get_object_line_items_for_transaction
+	 * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
+	 *
+	 * @param int $TXN_ID
+	 * @param string $OBJ_type
+	 * @param array $OBJ_IDs
+	 * @return EE_Line_Item[]
+	 */
+	public function get_object_line_items_for_transaction($TXN_ID, $OBJ_type = 'Event', $OBJ_IDs = array())
+	{
+		$query_params = array(
+			'OBJ_type' => $OBJ_type,
+			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
+			'OBJ_ID' => is_array($OBJ_IDs) && !isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
+		);
+		if ($TXN_ID) {
+			$query_params['TXN_ID'] = $TXN_ID;
+		}
+		return $this->get_all(array($query_params));
+	}
+
+
+	/**
+	 * get_all_ticket_line_items_for_transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item[]
+	 */
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->get_all(array(
+			array(
+				'TXN_ID' => $transaction->ID(),
+				'OBJ_type' => 'Ticket',
+			)
+		));
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction
+	 *
+	 * @param int $TXN_ID
+	 * @param int $TKT_ID
+	 * @return \EE_Line_Item
+	 */
+	public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
+	{
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
+				'OBJ_ID' => $TKT_ID,
+				'OBJ_type' => 'Ticket',
+			)
+		));
+	}
+
+
+	/**
+	 * get_existing_promotion_line_item
+	 * searches the cart for existing line items for the specified promotion
+	 *
+	 * @since   1.0.0
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param EE_Promotion $promotion
+	 * @return EE_Line_Item
+	 */
+	public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
+	{
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => $parent_line_item->TXN_ID(),
+				'LIN_parent' => $parent_line_item->ID(),
+				'OBJ_type' => 'Promotion',
+				'OBJ_ID' => $promotion->ID()
+			)
+		));
+	}
+
+
+	/**
+	 * get_all_promotion_line_items
+	 * searches the cart for any and all existing promotion line items
+	 *
+	 * @since   1.0.0
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @return EE_Line_Item[]
+	 */
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
+	{
+		return $this->get_all(array(
+			array(
+				'TXN_ID' => $parent_line_item->TXN_ID(),
+				'LIN_parent' => $parent_line_item->ID(),
+				'OBJ_type' => 'Promotion'
+			)
+		));
+	}
+
+	/**
+	 * Gets the registration's corresponding line item.
+	 * Note: basically does NOT support having multiple line items for a single ticket,
+	 * which would happen if some of the registrations had a price modifier while others didn't.
+	 * In order to support that, we'd probably need a LIN_ID on registrations or something.
+	 * @param EE_Registration $registration
+	 * @return EE_Line_ITem
+	 */
+	public function get_line_item_for_registration(EE_Registration $registration)
+	{
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
+	}
+
+	/**
+	 * Gets the query params used to retrieve a specific line item for the given registration
+	 * @param EE_Registration $registration
+	 * @param array $original_query_params any extra query params you'd like to be merged with
+	 * @return array like EEM_Base::get_all()'s $query_params
+	 */
+	public function line_item_for_registration_query_params(EE_Registration $registration, $original_query_params = array())
+	{
+		return array_replace_recursive($original_query_params, array(
+			array(
+				'OBJ_ID' => $registration->ticket_ID(),
+				'OBJ_type' => 'Ticket',
+				'TXN_ID' => $registration->transaction_ID()
+			)
+		));
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_with_no_transaction()
+	{
+		return $this->get_total_line_items_for_carts();
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_active_carts()
+	{
+		return $this->get_total_line_items_for_carts(false);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_expired_carts()
+	{
+		return $this->get_total_line_items_for_carts(true);
+	}
+
+
+	/**
+	 * Returns an array of grand total line items where the TXN_ID is 0.
+	 * If $expired is set to true, then only line items for expired sessions will be returned.
+	 * If $expired is set to false, then only line items for active sessions will be returned.
+	 *
+	 * @param null $expired
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function get_total_line_items_for_carts($expired = null)
+	{
+		$where_params = array(
+			'TXN_ID' => 0,
+			'LIN_type' => 'total',
+		);
+		if ($expired !== null) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$where_params['LIN_timestamp'] = array(
+				$expired ? '<=' : '>',
+				$session_lifespan->expiration(),
+			);
+		}
+		return $this->get_all(array($where_params));
+	}
+
+
+	/**
+	 * Returns an array of ticket total line items where the TXN_ID is 0
+	 * AND the timestamp is older than the session lifespan.
+	 *
+	 * @param int $timestamp
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getTicketLineItemsForExpiredCarts($timestamp = 0)
+	{
+		if (! absint($timestamp)) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$timestamp = $session_lifespan->expiration();
+		}
+		return $this->get_all(
+			array(
+				array(
+					'TXN_ID'        => 0,
+					'OBJ_type'      => 'Ticket',
+					'LIN_timestamp' => array('<=', $timestamp),
+				)
+			)
+		);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -209,8 +209,8 @@ 
         );
         $query = $wpdb->prepare(
             'DELETE li
-				FROM ' . $this->table() . ' li
-				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
+				FROM ' . $this->table().' li
+				LEFT JOIN ' . EEM_Transaction::instance()->table().' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
             // use GMT time because that's what TXN_timestamps are in
             date('Y-m-d H:i:s', time() - $time_to_leave_alone)
@@ -251,7 +251,7 @@ 
         $query_params = array(
             'OBJ_type' => $OBJ_type,
             // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-            'OBJ_ID' => is_array($OBJ_IDs) && !isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
+            'OBJ_ID' => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
         );
         if ($TXN_ID) {
             $query_params['TXN_ID'] = $TXN_ID;
@@ -454,7 +454,7 @@ 
      */
     public function getTicketLineItemsForExpiredCarts($timestamp = 0)
     {
-        if (! absint($timestamp)) {
+        if ( ! absint($timestamp)) {
             /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
             $session_lifespan = LoaderFactory::getLoader()->getShared(
                 'EventEspresso\core\domain\values\session\SessionLifespan'