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

Indentation +1226 added lines, -1226 removed lines

@@ -22,1229 +22,1229 @@ 
 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;
-
-    /**
-     * EE_Encryption object
-     *
-     * @var EE_Encryption
-     */
-    protected $encryption;
-
-    /**
-     * 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 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,
-        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,
-                $encryption
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan       $lifespan
-     * @param RequestInterface      $request
-     * @param EE_Encryption         $encryption
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function __construct(
-        CacheStorageInterface $cache_storage,
-        SessionLifespan $lifespan,
-        RequestInterface $request,
-        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_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 ] = '';
-            }
-        }
-    }
+	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;
+
+	/**
+	 * EE_Encryption object
+	 *
+	 * @var EE_Encryption
+	 */
+	protected $encryption;
+
+	/**
+	 * 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 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,
+		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,
+				$encryption
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan       $lifespan
+	 * @param RequestInterface      $request
+	 * @param EE_Encryption         $encryption
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function __construct(
+		CacheStorageInterface $cache_storage,
+		SessionLifespan $lifespan,
+		RequestInterface $request,
+		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_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;
-    }
+
+	/**
+	 * @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__, '');
-        // check that session has started
-        if (session_id() === '') {
-            //starts a new session if one doesn't already exist, or re-initiates an existing one
-            session_start();
-        }
-        $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;
-    }
-
-
-
-    /**
-     * _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->cart() instanceof EE_Cart)) {
-            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 = '')
-    {
+	/**
+	 * @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__, '');
+		// check that session has started
+		if (session_id() === '') {
+			//starts a new session if one doesn't already exist, or re-initiates an existing one
+			session_start();
+		}
+		$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;
+	}
+
+
+
+	/**
+	 * _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->cart() instanceof EE_Cart)) {
+			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
@@ -1253,19 +1253,19 @@ 
                     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 +57 added lines, -57 removed lines

@@ -186,7 +186,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,
@@ -219,21 +219,21 @@ 
         // 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_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;
             }
         }
@@ -293,7 +293,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();
         }
@@ -345,7 +345,7 @@ 
      */
     public function extend_expiration($time = 0)
     {
-        $time              = $time ? $time : $this->extension();
+        $time = $time ? $time : $this->extension();
         $this->_expiration += absint($time);
     }
 
@@ -372,9 +372,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] = '';
             }
         }
     }
@@ -515,8 +515,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;
     }
@@ -542,7 +542,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__(
@@ -555,7 +555,7 @@ 
                 );
                 return false;
             }
-            $this->_session_data[ $key ] = $value;
+            $this->_session_data[$key] = $value;
         }
         return true;
     }
@@ -589,7 +589,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
@@ -600,7 +600,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)
@@ -638,7 +638,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);
@@ -647,7 +647,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)) {
@@ -657,7 +657,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__, __LINE__
                     );
@@ -666,21 +666,21 @@ 
         } catch (Exception $e) {
             // let's just eat that error for now and attempt to correct any corrupted data
             global $wpdb;
-            $row          = $wpdb->get_row(
+            $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
                 );
@@ -691,7 +691,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) {
@@ -705,21 +705,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) {
@@ -747,7 +747,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);
     }
@@ -855,19 +855,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;
@@ -912,12 +912,12 @@ 
     {
         // 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->cart() instanceof EE_Cart)) {
+        if ($this->request->isBot() || ( ! $clear_session && ! $this->cart() instanceof EE_Cart)) {
             return false;
         }
         $transaction = $this->transaction();
         if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
+            if ( ! $transaction->ID()) {
                 $transaction->save();
             }
             $this->_session_data['transaction'] = $transaction->ID();
@@ -931,14 +931,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()
         );
@@ -952,7 +952,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   = '';
@@ -968,14 +968,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 : '';
     }
@@ -1015,7 +1015,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();
@@ -1037,7 +1037,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!
@@ -1051,11 +1051,11 @@ 
         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(__('The session variable %s was removed.', 'event_espresso'),
                             $reset), __FILE__, __FUNCTION__, __LINE__);
@@ -1132,7 +1132,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;
                 }
@@ -1152,7 +1152,7 @@ 
         $error = '<pre>';
         $data2 = preg_replace_callback(
             '!s:(\d+):"(.*?)";!',
-            function ($match)
+            function($match)
             {
                 return ($match[1] === strlen($match[2]))
                     ? $match[0]
@@ -1164,14 +1164,14 @@ 
             },
             $data1
         );
-        $max   = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
+        $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;
+            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;
@@ -1186,7 +1186,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
                 );
@@ -1194,7 +1194,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
                 );
@@ -1225,7 +1225,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 */
@@ -1260,7 +1260,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/Request.php

Doc Comments +2 added lines, -2 removed lines

@@ -231,7 +231,7 @@ 
      * returns true if a match is found or false if not
      *
      * @param string $pattern
-     * @return false|int
+     * @return boolean
      */
     public function matches($pattern)
     {
@@ -299,7 +299,7 @@ 
      * would return true if default parameters were set
      *
      * @param string $callback
-     * @param        $key
+     * @param        string $key
      * @param null   $default
      * @param array  $request_params
      * @return bool|mixed|null

Indentation +584 added lines, -584 removed lines

@@ -20,590 +20,590 @@
 class Request implements InterminableInterface, RequestInterface
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array $get
-     */
-    private $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array $post
-     */
-    private $post;
-
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array $cookie
-     */
-    private $cookie;
-
-    /**
-     * $_SERVER parameters
-     *
-     * @var array $server
-     */
-    private $server;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array $request
-     */
-    private $request;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    private $request_type;
-
-    /**
-     * IP address for request
-     *
-     * @var string $ip_address
-     */
-    private $ip_address;
-
-    /**
-     * @var string $user_agent
-     */
-    private $user_agent;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool $is_bot
-     */
-    private $is_bot;
-
-
-
-    /**
-     * @param array                              $get
-     * @param array                              $post
-     * @param array                              $cookie
-     * @param array                              $server
-     */
-    public function __construct(array $get, array $post, array $cookie, array $server)
-    {
-        // grab request vars
-        $this->get        = $get;
-        $this->post       = $post;
-        $this->cookie     = $cookie;
-        $this->server     = $server;
-        $this->request    = array_merge($this->get, $this->post);
-        $this->ip_address = $this->visitorIp();
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookie;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server;
-    }
-
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if (
-            $key !== 'ee'
-            || ($key === 'ee' && empty($this->request['ee']))
-            || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
-        ) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param       $key
-     * @param null  $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null)
-    {
-        return $this->requestParameterDrillDown($key, $default, 'get');
-    }
-
-
-
-    /**
-     * check if param exists
-     *
-     * @param       $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->requestParameterDrillDown($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)
-    {
-        return $this->requestParameterDrillDown($pattern, $default, 'match');
-    }
-
-
-    /**
-     * 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)
-    {
-        return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are:
-     *                                      'bool' will return true or false if match is found or not
-     *                                      'key' will return the first key found that matches the supplied pattern
-     *                                      'value' will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
-    {
-        $return = in_array($return, array('bool', 'key', 'value'), true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            array("\*", "\?"),
-            array('.*', '.'),
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === 'value') {
-                    return $request_params[ $key ];
-                }
-                // or actual key or true just to indicate it was found
-                return $return === 'key' ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === 'value' ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param array  $request_params
-     * @return bool|mixed|null
-     */
-    private function requestParameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        array $request_params = array()
-    ) {
-        $callback       = in_array($callback, array('is_set', 'get', 'match'), true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key  = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key  = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, 'key');
-                $key      = $real_key ? $real_key : $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->requestParameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        unset($this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function visitorIp()
-    {
-        $visitor_ip  = '0.0.0.0';
-        $server_keys = array(
-            'HTTP_CLIENT_IP',
-            'HTTP_X_FORWARDED_FOR',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_FORWARDED',
-            'REMOTE_ADDR',
-        );
-        foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function requestUri()
-    {
-        $request_uri = filter_input(
-            INPUT_SERVER,
-            'REQUEST_URI',
-            FILTER_SANITIZE_URL,
-            FILTER_NULL_ON_FAILURE
-        );
-        if (empty($request_uri)) {
-            // fallback sanitization if the above fails
-            $request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
-        }
-        return $request_uri;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->user_agent;
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        if ($user_agent === '' || ! is_string($user_agent)) {
-            $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
-        }
-        $this->user_agent = $user_agent;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBot()
-    {
-        return $this->is_bot;
-    }
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->isAdmin();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->isAdminAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->request_type->isAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->request_type->isEeAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->isOtherAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->isApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->isCli();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->isCron();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->isFeed();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->isFrontend();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->isFrontAjax();
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array $get
+	 */
+	private $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array $post
+	 */
+	private $post;
+
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array $cookie
+	 */
+	private $cookie;
+
+	/**
+	 * $_SERVER parameters
+	 *
+	 * @var array $server
+	 */
+	private $server;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array $request
+	 */
+	private $request;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	private $request_type;
+
+	/**
+	 * IP address for request
+	 *
+	 * @var string $ip_address
+	 */
+	private $ip_address;
+
+	/**
+	 * @var string $user_agent
+	 */
+	private $user_agent;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool $is_bot
+	 */
+	private $is_bot;
+
+
+
+	/**
+	 * @param array                              $get
+	 * @param array                              $post
+	 * @param array                              $cookie
+	 * @param array                              $server
+	 */
+	public function __construct(array $get, array $post, array $cookie, array $server)
+	{
+		// grab request vars
+		$this->get        = $get;
+		$this->post       = $post;
+		$this->cookie     = $cookie;
+		$this->server     = $server;
+		$this->request    = array_merge($this->get, $this->post);
+		$this->ip_address = $this->visitorIp();
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookie;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server;
+	}
+
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if (
+			$key !== 'ee'
+			|| ($key === 'ee' && empty($this->request['ee']))
+			|| ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
+		) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param       $key
+	 * @param null  $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null)
+	{
+		return $this->requestParameterDrillDown($key, $default, 'get');
+	}
+
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param       $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->requestParameterDrillDown($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)
+	{
+		return $this->requestParameterDrillDown($pattern, $default, 'match');
+	}
+
+
+	/**
+	 * 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)
+	{
+		return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are:
+	 *                                      'bool' will return true or false if match is found or not
+	 *                                      'key' will return the first key found that matches the supplied pattern
+	 *                                      'value' will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
+	{
+		$return = in_array($return, array('bool', 'key', 'value'), true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			array("\*", "\?"),
+			array('.*', '.'),
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === 'value') {
+					return $request_params[ $key ];
+				}
+				// or actual key or true just to indicate it was found
+				return $return === 'key' ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === 'value' ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param array  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function requestParameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		array $request_params = array()
+	) {
+		$callback       = in_array($callback, array('is_set', 'get', 'match'), true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key  = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key  = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, 'key');
+				$key      = $real_key ? $real_key : $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->requestParameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		unset($this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_REQUEST[ $key ]);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function visitorIp()
+	{
+		$visitor_ip  = '0.0.0.0';
+		$server_keys = array(
+			'HTTP_CLIENT_IP',
+			'HTTP_X_FORWARDED_FOR',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_FORWARDED',
+			'REMOTE_ADDR',
+		);
+		foreach ($server_keys as $key) {
+			if (isset($this->server[ $key ])) {
+				foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function requestUri()
+	{
+		$request_uri = filter_input(
+			INPUT_SERVER,
+			'REQUEST_URI',
+			FILTER_SANITIZE_URL,
+			FILTER_NULL_ON_FAILURE
+		);
+		if (empty($request_uri)) {
+			// fallback sanitization if the above fails
+			$request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
+		}
+		return $request_uri;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->user_agent;
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		if ($user_agent === '' || ! is_string($user_agent)) {
+			$user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
+		}
+		$this->user_agent = $user_agent;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot()
+	{
+		return $this->is_bot;
+	}
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->isAdmin();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->isAdminAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->request_type->isAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->request_type->isEeAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->isOtherAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->isApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->isCli();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->isCron();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->isFeed();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->isFrontend();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->isFrontAjax();
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
 
 
 }

Spacing +14 added lines, -14 removed lines

@@ -174,7 +174,7 @@ 
             || ($key === 'ee' && empty($this->request['ee']))
             || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
         ) {
-            $this->request[ $key ] = $value;
+            $this->request[$key] = $value;
         }
     }
 
@@ -267,10 +267,10 @@ 
             preg_quote($pattern, '/')
         );
         foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
                 // return value for request param
                 if ($return === 'value') {
-                    return $request_params[ $key ];
+                    return $request_params[$key];
                 }
                 // or actual key or true just to indicate it was found
                 return $return === 'key' ? $key : true;
@@ -327,29 +327,29 @@ 
                 $key      = $real_key ? $real_key : $key;
             }
             // check if top level key exists
-            if (isset($request_params[ $key ])) {
+            if (isset($request_params[$key])) {
                 // build a new key to pass along like: 'second[third]'
                 // or just 'second' depending on depth of keys
                 $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
+                if ( ! empty($keys)) {
+                    $key_string .= '['.implode('][', $keys).']';
                 }
                 return $this->requestParameterDrillDown(
                     $key_string,
                     $default,
                     $callback,
-                    $request_params[ $key ]
+                    $request_params[$key]
                 );
             }
         }
         if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
+            return isset($request_params[$key]);
         }
         if ($callback === 'match') {
             return $this->match($key, $request_params, $default);
         }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
+        return isset($request_params[$key])
+            ? $request_params[$key]
             : $default;
     }
 
@@ -362,9 +362,9 @@ 
      */
     public function unSetRequestParam($key, $unset_from_global_too = false)
     {
-        unset($this->request[ $key ]);
+        unset($this->request[$key]);
         if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
+            unset($_REQUEST[$key]);
         }
     }
 
@@ -399,8 +399,8 @@ 
             'REMOTE_ADDR',
         );
         foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+            if (isset($this->server[$key])) {
+                foreach (array_map('trim', explode(',', $this->server[$key])) as $ip) {
                     if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
                         $visitor_ip = $ip;
                     }

modules/single_page_checkout/inc/EE_SPCO_JSON_Response.php

Indentation +21 added lines, -21 removed lines

@@ -1,16 +1,16 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
  /**
- *
- * Class EE_SPCO_JSON_Response
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author				Brent Christensen
- *
- *
- */
+  *
+  * Class EE_SPCO_JSON_Response
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author				Brent Christensen
+  *
+  *
+  */
 class EE_SPCO_JSON_Response {
 
 	/**
@@ -84,7 +84,7 @@ 
 
 	/**
 	 *    class constructor
-   */
+	 */
 	public function __construct(  ) {
 	}
 
@@ -271,10 +271,10 @@ 
 	}
 
 
-    /**
-     * @param float $payment_amount
-     * @throws EE_Error
-     */
+	/**
+	 * @param float $payment_amount
+	 * @throws EE_Error
+	 */
 	public function set_payment_amount( $payment_amount ) {
 		$this->_payment_amount = (float)$payment_amount;
 	}
@@ -408,11 +408,11 @@ 
 	}
 
 
-    public function echoAndExit()
-    {
-        echo $this;
-        exit();
-    }
+	public function echoAndExit()
+	{
+		echo $this;
+		exit();
+	}
 
 }
 // End of file EE_SPCO_JSON_Response.php

Spacing +39 added lines, -39 removed lines

@@ -104,71 +104,71 @@ 
 	public function __toString() {
 		$JSON_response = array();
 		// grab notices
-		$notices = EE_Error::get_notices( FALSE );
-		$this->set_attention( isset( $notices['attention'] ) ? $notices['attention'] : '' );
-		$this->set_errors( isset( $notices['errors'] ) ? $notices['errors'] : '' );
-		$this->set_success( isset( $notices['success'] ) ? $notices['success'] : '' );
+		$notices = EE_Error::get_notices(FALSE);
+		$this->set_attention(isset($notices['attention']) ? $notices['attention'] : '');
+		$this->set_errors(isset($notices['errors']) ? $notices['errors'] : '');
+		$this->set_success(isset($notices['success']) ? $notices['success'] : '');
 		// add notices to JSON response, but only if they exist
-		if ( $this->attention() ) {
+		if ($this->attention()) {
 			$JSON_response['attention'] = $this->attention();
 		}
-		if ( $this->errors() ) {
+		if ($this->errors()) {
 			$JSON_response['errors'] = $this->errors();
 		}
-		if ( $this->unexpected_errors() ) {
+		if ($this->unexpected_errors()) {
 			$JSON_response['unexpected_errors'] = $this->unexpected_errors();
 		}
-		if ( $this->success() ) {
+		if ($this->success()) {
 			$JSON_response['success'] = $this->success();
 		}
 		// but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
-		if ( ! isset( $JSON_response[ 'attention' ] ) && ! isset( $JSON_response[ 'errors' ] ) && ! isset( $JSON_response[ 'success' ] ) ) {
+		if ( ! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
 			$JSON_response['success'] = null;
 		}
 		// set redirect_url, IF it exists
-		if ( $this->redirect_url() ) {
+		if ($this->redirect_url()) {
 			$JSON_response['redirect_url'] = $this->redirect_url();
 		}
 		// set registration_time_limit, IF it exists
-		if ( $this->registration_time_limit() ) {
+		if ($this->registration_time_limit()) {
 			$JSON_response['registration_time_limit'] = $this->registration_time_limit();
 		}
 		// set payment_amount, IF it exists
-		if ( $this->payment_amount() !== null ) {
-			$JSON_response[ 'payment_amount' ] = $this->payment_amount();
+		if ($this->payment_amount() !== null) {
+			$JSON_response['payment_amount'] = $this->payment_amount();
 		}
 		// grab generic return data
 		$return_data = $this->return_data();
 		// add billing form validation rules
-		if ( $this->validation_rules() ) {
+		if ($this->validation_rules()) {
 			$return_data['validation_rules'] = $this->validation_rules();
 		}
 		// set reg_step_html, IF it exists
-		if ( $this->reg_step_html() ) {
+		if ($this->reg_step_html()) {
 			$return_data['reg_step_html'] = $this->reg_step_html();
 		}
 		// set method of payment, IF it exists
-		if ( $this->method_of_payment() ) {
+		if ($this->method_of_payment()) {
 			$return_data['method_of_payment'] = $this->method_of_payment();
 		}
 		// set "plz_select_method_of_payment" message, IF it exists
-		if ( $this->plz_select_method_of_payment() ) {
+		if ($this->plz_select_method_of_payment()) {
 			$return_data['plz_select_method_of_payment'] = $this->plz_select_method_of_payment();
 		}
 		// set redirect_form, IF it exists
-		if ( $this->redirect_form() ) {
+		if ($this->redirect_form()) {
 			$return_data['redirect_form'] = $this->redirect_form();
 		}
 		// and finally, add return_data array to main JSON response array, IF it contains anything
 		// why did we add some of the above properties to the return data array?
 		// because it is easier and cleaner in the Javascript to deal with this way
-		if ( ! empty( $return_data )) {
+		if ( ! empty($return_data)) {
 			$JSON_response['return_data'] = $return_data;
 		}
 		// filter final array
-		$JSON_response = apply_filters( 'FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response );
+		$JSON_response = apply_filters('FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response);
 		// return encoded array
-		return (string) wp_json_encode( $JSON_response );
+		return (string) wp_json_encode($JSON_response);
 	}
 
 
@@ -176,7 +176,7 @@ 
 	/**
 	 * @param string $attention
 	 */
-	public function set_attention( $attention ) {
+	public function set_attention($attention) {
 		$this->_attention = $attention;
 	}
 
@@ -194,7 +194,7 @@ 
 	/**
 	 * @param string $errors
 	 */
-	public function set_errors( $errors ) {
+	public function set_errors($errors) {
 		$this->_errors = $errors;
 	}
 
@@ -221,7 +221,7 @@ 
 	/**
 	 * @param string $unexpected_errors
 	 */
-	public function set_unexpected_errors( $unexpected_errors ) {
+	public function set_unexpected_errors($unexpected_errors) {
 		$this->_unexpected_errors = $unexpected_errors;
 	}
 
@@ -230,7 +230,7 @@ 
 	/**
 	 * @param string $success
 	 */
-	public function set_success( $success ) {
+	public function set_success($success) {
 		$this->_success = $success;
 	}
 
@@ -248,7 +248,7 @@ 
 	/**
 	 * @param string $method_of_payment
 	 */
-	public function set_method_of_payment( $method_of_payment ) {
+	public function set_method_of_payment($method_of_payment) {
 		$this->_method_of_payment = $method_of_payment;
 	}
 
@@ -275,8 +275,8 @@ 
      * @param float $payment_amount
      * @throws EE_Error
      */
-	public function set_payment_amount( $payment_amount ) {
-		$this->_payment_amount = (float)$payment_amount;
+	public function set_payment_amount($payment_amount) {
+		$this->_payment_amount = (float) $payment_amount;
 	}
 
 
@@ -284,7 +284,7 @@ 
 	/**
 	 * @param string $next_step_html
 	 */
-	public function set_reg_step_html( $next_step_html ) {
+	public function set_reg_step_html($next_step_html) {
 		$this->_reg_step_html = $next_step_html;
 	}
 
@@ -302,7 +302,7 @@ 
 	/**
 	 * @param string $redirect_form
 	 */
-	public function set_redirect_form( $redirect_form ) {
+	public function set_redirect_form($redirect_form) {
 		$this->_redirect_form = $redirect_form;
 	}
 
@@ -312,7 +312,7 @@ 
 	 * @return string
 	 */
 	public function redirect_form() {
-		return ! empty( $this->_redirect_form ) ? $this->_redirect_form : FALSE;
+		return ! empty($this->_redirect_form) ? $this->_redirect_form : FALSE;
 	}
 
 
@@ -320,7 +320,7 @@ 
 	/**
 	 * @param string $plz_select_method_of_payment
 	 */
-	public function set_plz_select_method_of_payment( $plz_select_method_of_payment ) {
+	public function set_plz_select_method_of_payment($plz_select_method_of_payment) {
 		$this->_plz_select_method_of_payment = $plz_select_method_of_payment;
 	}
 
@@ -338,7 +338,7 @@ 
 	/**
 	 * @param string $redirect_url
 	 */
-	public function set_redirect_url( $redirect_url ) {
+	public function set_redirect_url($redirect_url) {
 		$this->_redirect_url = $redirect_url;
 	}
 
@@ -365,7 +365,7 @@ 
 	/**
 	 * @param string $registration_time_limit
 	 */
-	public function set_registration_time_limit( $registration_time_limit ) {
+	public function set_registration_time_limit($registration_time_limit) {
 		$this->_registration_time_limit = $registration_time_limit;
 	}
 
@@ -374,8 +374,8 @@ 
 	/**
 	 * @param array $return_data
 	 */
-	public function set_return_data( $return_data ) {
-		$this->_return_data = array_merge( $this->_return_data, $return_data );
+	public function set_return_data($return_data) {
+		$this->_return_data = array_merge($this->_return_data, $return_data);
 	}
 
 
@@ -393,8 +393,8 @@ 
 	 * @param array $validation_rules
 	 */
 	public function add_validation_rules(array $validation_rules = array()) {
-		if ( is_array( $validation_rules ) && ! empty( $validation_rules )) {
-			$this->_validation_rules = array_merge( $this->_validation_rules, $validation_rules );
+		if (is_array($validation_rules) && ! empty($validation_rules)) {
+			$this->_validation_rules = array_merge($this->_validation_rules, $validation_rules);
 		}
 	}
 
@@ -404,7 +404,7 @@ 
 	 * @return array | bool
 	 */
 	public function validation_rules() {
-		return ! empty( $this->_validation_rules ) ? $this->_validation_rules : FALSE;
+		return ! empty($this->_validation_rules) ? $this->_validation_rules : FALSE;
 	}
 
 

modules/ticket_selector/ProcessTicketSelector.php

Indentation +574 added lines, -574 removed lines

@@ -15,7 +15,7 @@ 
 use InvalidArgumentException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -32,597 +32,597 @@ 
 class ProcessTicketSelector
 {
 
-    /**
-     * array of datetimes and the spaces available for them
-     *
-     * @var array[][]
-     */
-    private static $_available_spaces = array();
+	/**
+	 * array of datetimes and the spaces available for them
+	 *
+	 * @var array[][]
+	 */
+	private static $_available_spaces = array();
 
 
-    /**
-     * cancelTicketSelections
-     *
-     * @return        string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function cancelTicketSelections()
-    {
-        // check nonce
-        if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
-            return false;
-        }
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        if (EE_Registry::instance()->REQ->is_set('event_id')) {
-            wp_safe_redirect(
-                EEH_Event_View::event_link_url(
-                    EE_Registry::instance()->REQ->get('event_id')
-                )
-            );
-        } else {
-            wp_safe_redirect(
-                site_url('/' . EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
-            );
-        }
-        exit();
-    }
+	/**
+	 * cancelTicketSelections
+	 *
+	 * @return        string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function cancelTicketSelections()
+	{
+		// check nonce
+		if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+			return false;
+		}
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		if (EE_Registry::instance()->REQ->is_set('event_id')) {
+			wp_safe_redirect(
+				EEH_Event_View::event_link_url(
+					EE_Registry::instance()->REQ->get('event_id')
+				)
+			);
+		} else {
+			wp_safe_redirect(
+				site_url('/' . EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
+			);
+		}
+		exit();
+	}
 
 
-    /**
-     * processTicketSelectorNonce
-     *
-     * @param  string $nonce_name
-     * @param string  $id
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    private function processTicketSelectorNonce($nonce_name, $id = '')
-    {
-        $nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
-        if (
-            ! is_admin()
-            && (
-                ! EE_Registry::instance()->REQ->is_set($nonce_name_with_id)
-                || ! wp_verify_nonce(
-                    EE_Registry::instance()->REQ->get($nonce_name_with_id),
-                    $nonce_name
-                )
-            )
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * processTicketSelectorNonce
+	 *
+	 * @param  string $nonce_name
+	 * @param string  $id
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	private function processTicketSelectorNonce($nonce_name, $id = '')
+	{
+		$nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
+		if (
+			! is_admin()
+			&& (
+				! EE_Registry::instance()->REQ->is_set($nonce_name_with_id)
+				|| ! wp_verify_nonce(
+					EE_Registry::instance()->REQ->get($nonce_name_with_id),
+					$nonce_name
+				)
+			)
+		) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * process_ticket_selections
-     *
-     * @return array|bool
-     * @throws \ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function processTicketSelections()
-    {
-        do_action('EED_Ticket_Selector__process_ticket_selections__before');
-        $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
-        if($request->isBot()) {
-            wp_safe_redirect(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
-                    site_url()
-                )
-            );
-            exit();
-        }
-        // do we have an event id?
-        if (! EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
-            // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        //if event id is valid
-        $id = absint(EE_Registry::instance()->REQ->get('tkt-slctr-event-id'));
-        //		d( \EE_Registry::instance()->REQ );
-        self::$_available_spaces = array(
-            'tickets'   => array(),
-            'datetimes' => array(),
-        );
-        //we should really only have 1 registration in the works now (ie, no MER) so clear any previous items in the cart.
-        // When MER happens this will probably need to be tweaked, possibly wrapped in a conditional checking for some constant defined in MER etc.
-        EE_Registry::instance()->load_core('Session');
-        // unless otherwise requested, clear the session
-        if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        //d( \EE_Registry::instance()->SSN );
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // validate/sanitize data
-        $valid = $this->validatePostData($id);
-        //EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid, '$valid', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid[ 'total_tickets' ], 'total_tickets', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid[ 'max_atndz' ], 'max_atndz', __FILE__, __LINE__ );
-        //check total tickets ordered vs max number of attendees that can register
-        if ($valid['total_tickets'] > $valid['max_atndz']) {
-            // ordering too many tickets !!!
-            $total_tickets_string = _n(
-                'You have attempted to purchase %s ticket.',
-                'You have attempted to purchase %s tickets.',
-                $valid['total_tickets'],
-                'event_espresso'
-            );
-            $limit_error_1        = sprintf($total_tickets_string, $valid['total_tickets']);
-            // dev only message
-            $max_atndz_string = _n(
-                'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                $valid['max_atndz'],
-                'event_espresso'
-            );
-            $limit_error_2    = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
-            EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            // all data appears to be valid
-            $tckts_slctd   = false;
-            $tickets_added = 0;
-            $valid         = apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
-                $valid);
-            if ($valid['total_tickets'] > 0) {
-                // load cart
-                EE_Registry::instance()->load_core('Cart');
-                // cycle thru the number of data rows sent from the event listing
-                for ($x = 0; $x < $valid['rows']; $x++) {
-                    // does this row actually contain a ticket quantity?
-                    if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
-                        // YES we have a ticket quantity
-                        $tckts_slctd = true;
-                        //						d( $valid['ticket_obj'][$x] );
-                        if ($valid['ticket_obj'][ $x ] instanceof EE_Ticket) {
-                            // then add ticket to cart
-                            $tickets_added += $this->addTicketToCart(
-                                $valid['ticket_obj'][ $x ],
-                                $valid['qty'][ $x ]
-                            );
-                            if (EE_Error::has_error()) {
-                                break;
-                            }
-                        } else {
-                            // nothing added to cart retrieved
-                            EE_Error::add_error(
-                                sprintf(
-                                    __(
-                                        'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
-                                        'event_espresso'
-                                    ),
-                                    '<br/>'
-                                ),
-                                __FILE__, __FUNCTION__, __LINE__
-                            );
-                        }
-                    }
-                }
-            }
-            do_action(
-                'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-                EE_Registry::instance()->CART,
-                $this
-            );
-            //d( \EE_Registry::instance()->CART );
-            //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
-            if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tckts_slctd)) {
-                if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
-                    do_action(
-                        'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
-                        EE_Registry::instance()->CART,
-                        $this
-                    );
-                    EE_Registry::instance()->CART->recalculate_all_cart_totals();
-                    EE_Registry::instance()->CART->save_cart(false);
-                    // exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
-                    // just return TRUE for registrations being made from admin
-                    if (is_admin()) {
-                        return true;
-                    }
-                    EE_Error::get_notices(false, true);
-                    EEH_URL::safeRedirectAndExit(
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
-                            EE_Registry::instance()->CFG->core->reg_page_url()
-                        )
-                    );
-                } else {
-                    if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
-                        // nothing added to cart
-                        EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'),
-                            __FILE__, __FUNCTION__, __LINE__);
-                    }
-                }
-            } else {
-                // no ticket quantities were selected
-                EE_Error::add_error(__('You need to select a ticket quantity before you can proceed.',
-                    'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
-        // at this point, just return if registration is being made from admin
-        if (is_admin()) {
-            return false;
-        }
-        if ($valid['return_url']) {
-            EEH_URL::safeRedirectAndExit($valid['return_url']);
-        }
-        if ($id) {
-            EEH_URL::safeRedirectAndExit(get_permalink($id));
-        }
-        echo EE_Error::get_notices();
-        return false;
-    }
+	/**
+	 * process_ticket_selections
+	 *
+	 * @return array|bool
+	 * @throws \ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function processTicketSelections()
+	{
+		do_action('EED_Ticket_Selector__process_ticket_selections__before');
+		$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
+		if($request->isBot()) {
+			wp_safe_redirect(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
+					site_url()
+				)
+			);
+			exit();
+		}
+		// do we have an event id?
+		if (! EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
+			// $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		//if event id is valid
+		$id = absint(EE_Registry::instance()->REQ->get('tkt-slctr-event-id'));
+		//		d( \EE_Registry::instance()->REQ );
+		self::$_available_spaces = array(
+			'tickets'   => array(),
+			'datetimes' => array(),
+		);
+		//we should really only have 1 registration in the works now (ie, no MER) so clear any previous items in the cart.
+		// When MER happens this will probably need to be tweaked, possibly wrapped in a conditional checking for some constant defined in MER etc.
+		EE_Registry::instance()->load_core('Session');
+		// unless otherwise requested, clear the session
+		if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		//d( \EE_Registry::instance()->SSN );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// validate/sanitize data
+		$valid = $this->validatePostData($id);
+		//EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid, '$valid', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid[ 'total_tickets' ], 'total_tickets', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid[ 'max_atndz' ], 'max_atndz', __FILE__, __LINE__ );
+		//check total tickets ordered vs max number of attendees that can register
+		if ($valid['total_tickets'] > $valid['max_atndz']) {
+			// ordering too many tickets !!!
+			$total_tickets_string = _n(
+				'You have attempted to purchase %s ticket.',
+				'You have attempted to purchase %s tickets.',
+				$valid['total_tickets'],
+				'event_espresso'
+			);
+			$limit_error_1        = sprintf($total_tickets_string, $valid['total_tickets']);
+			// dev only message
+			$max_atndz_string = _n(
+				'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				$valid['max_atndz'],
+				'event_espresso'
+			);
+			$limit_error_2    = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
+			EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			// all data appears to be valid
+			$tckts_slctd   = false;
+			$tickets_added = 0;
+			$valid         = apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
+				$valid);
+			if ($valid['total_tickets'] > 0) {
+				// load cart
+				EE_Registry::instance()->load_core('Cart');
+				// cycle thru the number of data rows sent from the event listing
+				for ($x = 0; $x < $valid['rows']; $x++) {
+					// does this row actually contain a ticket quantity?
+					if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
+						// YES we have a ticket quantity
+						$tckts_slctd = true;
+						//						d( $valid['ticket_obj'][$x] );
+						if ($valid['ticket_obj'][ $x ] instanceof EE_Ticket) {
+							// then add ticket to cart
+							$tickets_added += $this->addTicketToCart(
+								$valid['ticket_obj'][ $x ],
+								$valid['qty'][ $x ]
+							);
+							if (EE_Error::has_error()) {
+								break;
+							}
+						} else {
+							// nothing added to cart retrieved
+							EE_Error::add_error(
+								sprintf(
+									__(
+										'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
+										'event_espresso'
+									),
+									'<br/>'
+								),
+								__FILE__, __FUNCTION__, __LINE__
+							);
+						}
+					}
+				}
+			}
+			do_action(
+				'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+				EE_Registry::instance()->CART,
+				$this
+			);
+			//d( \EE_Registry::instance()->CART );
+			//die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
+			if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tckts_slctd)) {
+				if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
+					do_action(
+						'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
+						EE_Registry::instance()->CART,
+						$this
+					);
+					EE_Registry::instance()->CART->recalculate_all_cart_totals();
+					EE_Registry::instance()->CART->save_cart(false);
+					// exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
+					// just return TRUE for registrations being made from admin
+					if (is_admin()) {
+						return true;
+					}
+					EE_Error::get_notices(false, true);
+					EEH_URL::safeRedirectAndExit(
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
+							EE_Registry::instance()->CFG->core->reg_page_url()
+						)
+					);
+				} else {
+					if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+						// nothing added to cart
+						EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'),
+							__FILE__, __FUNCTION__, __LINE__);
+					}
+				}
+			} else {
+				// no ticket quantities were selected
+				EE_Error::add_error(__('You need to select a ticket quantity before you can proceed.',
+					'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		//die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
+		// at this point, just return if registration is being made from admin
+		if (is_admin()) {
+			return false;
+		}
+		if ($valid['return_url']) {
+			EEH_URL::safeRedirectAndExit($valid['return_url']);
+		}
+		if ($id) {
+			EEH_URL::safeRedirectAndExit(get_permalink($id));
+		}
+		echo EE_Error::get_notices();
+		return false;
+	}
 
 
-    /**
-     * validate_post_data
-     *
-     * @param int $id
-     * @return array|FALSE
-     * @throws \ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function validatePostData($id = 0)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! $id) {
-            EE_Error::add_error(
-                __('The event id provided was not valid.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // start with an empty array()
-        $valid_data = array();
-        // grab valid id
-        $valid_data['id'] = $id;
-        // array of other form names
-        $inputs_to_clean = array(
-            'event_id'   => 'tkt-slctr-event-id',
-            'max_atndz'  => 'tkt-slctr-max-atndz-',
-            'rows'       => 'tkt-slctr-rows-',
-            'qty'        => 'tkt-slctr-qty-',
-            'ticket_id'  => 'tkt-slctr-ticket-id-',
-            'return_url' => 'tkt-slctr-return-url-',
-        );
-        // let's track the total number of tickets ordered.'
-        $valid_data['total_tickets'] = 0;
-        // cycle through $inputs_to_clean array
-        foreach ($inputs_to_clean as $what => $input_to_clean) {
-            // check for POST data
-            if (EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
-                // grab value
-                $input_value = EE_Registry::instance()->REQ->get($input_to_clean . $id);
-                switch ($what) {
-                    // integers
-                    case 'event_id':
-                        $valid_data[ $what ] = absint($input_value);
-                        // get event via the event id we put in the form
-                        $valid_data['event'] = EE_Registry::instance()
-                                                           ->load_model('Event')
-                                                           ->get_one_by_ID($valid_data['event_id']);
-                        break;
-                    case 'rows':
-                    case 'max_atndz':
-                        $valid_data[ $what ] = absint($input_value);
-                        break;
-                    // arrays of integers
-                    case 'qty':
-                        /** @var array $row_qty */
-                        $row_qty = $input_value;
-                        // if qty is coming from a radio button input, then we need to assemble an array of rows
-                        if (! is_array($row_qty)) {
-                            // get number of rows
-                            $rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
-                                ? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
-                                : 1;
-                            // explode ints by the dash
-                            $row_qty = explode('-', $row_qty);
-                            $row     = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
-                            $qty     = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
-                            $row_qty = array($row => $qty);
-                            for ($x = 1; $x <= $rows; $x++) {
-                                if (! isset($row_qty[ $x ])) {
-                                    $row_qty[ $x ] = 0;
-                                }
-                            }
-                        }
-                        ksort($row_qty);
-                        // cycle thru values
-                        foreach ($row_qty as $qty) {
-                            $qty = absint($qty);
-                            // sanitize as integers
-                            $valid_data[ $what ][]       = $qty;
-                            $valid_data['total_tickets'] += $qty;
-                        }
-                        break;
-                    // array of integers
-                    case 'ticket_id':
-                        $value_array = array();
-                        // cycle thru values
-                        foreach ((array) $input_value as $key => $value) {
-                            // allow only numbers, letters,  spaces, commas and dashes
-                            $value_array[ $key ] = wp_strip_all_tags($value);
-                            // get ticket via the ticket id we put in the form
-                            $ticket_obj                       = EE_Registry::instance()
-                                                                            ->load_model('Ticket')
-                                                                            ->get_one_by_ID($value);
-                            $valid_data['ticket_obj'][ $key ] = $ticket_obj;
-                        }
-                        $valid_data[ $what ] = $value_array;
-                        break;
-                    case 'return_url' :
-                        // grab and sanitize return-url
-                        $input_value = esc_url_raw($input_value);
-                        // was the request coming from an iframe ? if so, then:
-                        if (strpos($input_value, 'event_list=iframe')) {
-                            // get anchor fragment
-                            $input_value = explode('#', $input_value);
-                            $input_value = end($input_value);
-                            // use event list url instead, but append anchor
-                            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
-                        }
-                        $valid_data[ $what ] = $input_value;
-                        break;
-                }    // end switch $what
-            }
-        }    // end foreach $inputs_to_clean
-        return $valid_data;
-    }
+	/**
+	 * validate_post_data
+	 *
+	 * @param int $id
+	 * @return array|FALSE
+	 * @throws \ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function validatePostData($id = 0)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (! $id) {
+			EE_Error::add_error(
+				__('The event id provided was not valid.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// start with an empty array()
+		$valid_data = array();
+		// grab valid id
+		$valid_data['id'] = $id;
+		// array of other form names
+		$inputs_to_clean = array(
+			'event_id'   => 'tkt-slctr-event-id',
+			'max_atndz'  => 'tkt-slctr-max-atndz-',
+			'rows'       => 'tkt-slctr-rows-',
+			'qty'        => 'tkt-slctr-qty-',
+			'ticket_id'  => 'tkt-slctr-ticket-id-',
+			'return_url' => 'tkt-slctr-return-url-',
+		);
+		// let's track the total number of tickets ordered.'
+		$valid_data['total_tickets'] = 0;
+		// cycle through $inputs_to_clean array
+		foreach ($inputs_to_clean as $what => $input_to_clean) {
+			// check for POST data
+			if (EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
+				// grab value
+				$input_value = EE_Registry::instance()->REQ->get($input_to_clean . $id);
+				switch ($what) {
+					// integers
+					case 'event_id':
+						$valid_data[ $what ] = absint($input_value);
+						// get event via the event id we put in the form
+						$valid_data['event'] = EE_Registry::instance()
+														   ->load_model('Event')
+														   ->get_one_by_ID($valid_data['event_id']);
+						break;
+					case 'rows':
+					case 'max_atndz':
+						$valid_data[ $what ] = absint($input_value);
+						break;
+					// arrays of integers
+					case 'qty':
+						/** @var array $row_qty */
+						$row_qty = $input_value;
+						// if qty is coming from a radio button input, then we need to assemble an array of rows
+						if (! is_array($row_qty)) {
+							// get number of rows
+							$rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
+								? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
+								: 1;
+							// explode ints by the dash
+							$row_qty = explode('-', $row_qty);
+							$row     = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
+							$qty     = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
+							$row_qty = array($row => $qty);
+							for ($x = 1; $x <= $rows; $x++) {
+								if (! isset($row_qty[ $x ])) {
+									$row_qty[ $x ] = 0;
+								}
+							}
+						}
+						ksort($row_qty);
+						// cycle thru values
+						foreach ($row_qty as $qty) {
+							$qty = absint($qty);
+							// sanitize as integers
+							$valid_data[ $what ][]       = $qty;
+							$valid_data['total_tickets'] += $qty;
+						}
+						break;
+					// array of integers
+					case 'ticket_id':
+						$value_array = array();
+						// cycle thru values
+						foreach ((array) $input_value as $key => $value) {
+							// allow only numbers, letters,  spaces, commas and dashes
+							$value_array[ $key ] = wp_strip_all_tags($value);
+							// get ticket via the ticket id we put in the form
+							$ticket_obj                       = EE_Registry::instance()
+																			->load_model('Ticket')
+																			->get_one_by_ID($value);
+							$valid_data['ticket_obj'][ $key ] = $ticket_obj;
+						}
+						$valid_data[ $what ] = $value_array;
+						break;
+					case 'return_url' :
+						// grab and sanitize return-url
+						$input_value = esc_url_raw($input_value);
+						// was the request coming from an iframe ? if so, then:
+						if (strpos($input_value, 'event_list=iframe')) {
+							// get anchor fragment
+							$input_value = explode('#', $input_value);
+							$input_value = end($input_value);
+							// use event list url instead, but append anchor
+							$input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+						}
+						$valid_data[ $what ] = $input_value;
+						break;
+				}    // end switch $what
+			}
+		}    // end foreach $inputs_to_clean
+		return $valid_data;
+	}
 
 
-    /**
-     * adds a ticket to the cart
-     *
-     * @param EE_Ticket $ticket
-     * @param int        $qty
-     * @return TRUE on success, FALSE on fail
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function addTicketToCart(EE_Ticket $ticket = null, $qty = 1)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // get the number of spaces left for this datetime ticket
-        $available_spaces = $this->ticketDatetimeAvailability($ticket);
-        // compare available spaces against the number of tickets being purchased
-        if ($available_spaces >= $qty) {
-            // allow addons to prevent a ticket from being added to cart
-            if (
-            ! apply_filters(
-                'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
-                true,
-                $ticket,
-                $qty,
-                $available_spaces
-            )
-            ) {
-                return false;
-            }
-            $qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
-            // add event to cart
-            if (EE_Registry::instance()->CART->add_ticket_to_cart($ticket, $qty)) {
-                $this->recalculateTicketDatetimeAvailability($ticket, $qty);
-                return true;
-            }
-            return false;
-        }
-        // tickets can not be purchased but let's find the exact number left
-        // for the last ticket selected PRIOR to subtracting tickets
-        $available_spaces = $this->ticketDatetimeAvailability($ticket, true);
-        // greedy greedy greedy eh?
-        if ($available_spaces > 0) {
-            if (
-            apply_filters(
-                'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
-                true,
-                $ticket,
-                $qty,
-                $available_spaces
-            )
-            ) {
-                $this->displayAvailabilityError($available_spaces);
-            }
-        } else {
-            EE_Error::add_error(
-                __(
-                    'We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        return false;
-    }
+	/**
+	 * adds a ticket to the cart
+	 *
+	 * @param EE_Ticket $ticket
+	 * @param int        $qty
+	 * @return TRUE on success, FALSE on fail
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function addTicketToCart(EE_Ticket $ticket = null, $qty = 1)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// get the number of spaces left for this datetime ticket
+		$available_spaces = $this->ticketDatetimeAvailability($ticket);
+		// compare available spaces against the number of tickets being purchased
+		if ($available_spaces >= $qty) {
+			// allow addons to prevent a ticket from being added to cart
+			if (
+			! apply_filters(
+				'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
+				true,
+				$ticket,
+				$qty,
+				$available_spaces
+			)
+			) {
+				return false;
+			}
+			$qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
+			// add event to cart
+			if (EE_Registry::instance()->CART->add_ticket_to_cart($ticket, $qty)) {
+				$this->recalculateTicketDatetimeAvailability($ticket, $qty);
+				return true;
+			}
+			return false;
+		}
+		// tickets can not be purchased but let's find the exact number left
+		// for the last ticket selected PRIOR to subtracting tickets
+		$available_spaces = $this->ticketDatetimeAvailability($ticket, true);
+		// greedy greedy greedy eh?
+		if ($available_spaces > 0) {
+			if (
+			apply_filters(
+				'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
+				true,
+				$ticket,
+				$qty,
+				$available_spaces
+			)
+			) {
+				$this->displayAvailabilityError($available_spaces);
+			}
+		} else {
+			EE_Error::add_error(
+				__(
+					'We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		return false;
+	}
 
 
-    /**
-     * @param int $available_spaces
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function displayAvailabilityError($available_spaces = 1)
-    {
-        // add error messaging - we're using the _n function that will generate
-        // the appropriate singular or plural message based on the number of $available_spaces
-        if (EE_Registry::instance()->CART->all_ticket_quantity_count()) {
-            $msg = sprintf(
-                _n(
-                    'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                    'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                    $available_spaces,
-                    'event_espresso'
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        } else {
-            $msg = sprintf(
-                _n(
-                    'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                    'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                    $available_spaces,
-                    'event_espresso'
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        }
-        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-    }
+	/**
+	 * @param int $available_spaces
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function displayAvailabilityError($available_spaces = 1)
+	{
+		// add error messaging - we're using the _n function that will generate
+		// the appropriate singular or plural message based on the number of $available_spaces
+		if (EE_Registry::instance()->CART->all_ticket_quantity_count()) {
+			$msg = sprintf(
+				_n(
+					'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+					'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+					$available_spaces,
+					'event_espresso'
+				),
+				$available_spaces,
+				'<br />'
+			);
+		} else {
+			$msg = sprintf(
+				_n(
+					'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+					'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+					$available_spaces,
+					'event_espresso'
+				),
+				$available_spaces,
+				'<br />'
+			);
+		}
+		EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+	}
 
 
-    /**
-     * ticketDatetimeAvailability
-     * creates an array of tickets plus all of the datetimes available to each ticket
-     * and tracks the spaces remaining for each of those datetimes
-     *
-     * @param EE_Ticket $ticket - selected ticket
-     * @param bool      $get_original_ticket_spaces
-     * @return int
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
-    {
-        // if the $_available_spaces array has not been set up yet...
-        if (! isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
-            $this->setInitialTicketDatetimeAvailability($ticket);
-        }
-        $available_spaces = $ticket->qty() - $ticket->sold();
-        if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
-                // if we want the original datetime availability BEFORE we started subtracting tickets ?
-                if ($get_original_ticket_spaces) {
-                    // then grab the available spaces from the "tickets" array
-                    // and compare with the above to get the lowest number
-                    $available_spaces = min(
-                        $available_spaces,
-                        self::$_available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
-                    );
-                } else {
-                    // we want the updated ticket availability as stored in the "datetimes" array
-                    $available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][ $DTD_ID ]);
-                }
-            }
-        }
-        return $available_spaces;
-    }
+	/**
+	 * ticketDatetimeAvailability
+	 * creates an array of tickets plus all of the datetimes available to each ticket
+	 * and tracks the spaces remaining for each of those datetimes
+	 *
+	 * @param EE_Ticket $ticket - selected ticket
+	 * @param bool      $get_original_ticket_spaces
+	 * @return int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
+	{
+		// if the $_available_spaces array has not been set up yet...
+		if (! isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+			$this->setInitialTicketDatetimeAvailability($ticket);
+		}
+		$available_spaces = $ticket->qty() - $ticket->sold();
+		if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+				// if we want the original datetime availability BEFORE we started subtracting tickets ?
+				if ($get_original_ticket_spaces) {
+					// then grab the available spaces from the "tickets" array
+					// and compare with the above to get the lowest number
+					$available_spaces = min(
+						$available_spaces,
+						self::$_available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
+					);
+				} else {
+					// we want the updated ticket availability as stored in the "datetimes" array
+					$available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][ $DTD_ID ]);
+				}
+			}
+		}
+		return $available_spaces;
+	}
 
 
-    /**
-     * @param EE_Ticket $ticket
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket)
-    {
-        // first, get all of the datetimes that are available to this ticket
-        $datetimes = $ticket->get_many_related(
-            'Datetime',
-            array(
-                array(
-                    'DTT_EVT_end' => array(
-                        '>=',
-                        EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-                    ),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-        if (! empty($datetimes)) {
-            // now loop thru all of the datetimes
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    // the number of spaces available for the datetime without considering individual ticket quantities
-                    $spaces_remaining = $datetime->spaces_remaining();
-                    // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
-                    // or the datetime spaces remaining) to this ticket using the datetime ID as the key
-                    self::$_available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
-                        $ticket->qty() - $ticket->sold(),
-                        $spaces_remaining
-                    );
-                    // if the remaining spaces for this datetime is already set,
-                    // then compare that against the datetime spaces remaining, and take the lowest number,
-                    // else just take the datetime spaces remaining, and assign to the datetimes array
-                    self::$_available_spaces['datetimes'][ $datetime->ID() ] = isset(
-                        self::$_available_spaces['datetimes'][ $datetime->ID() ]
-                    )
-                        ? min(self::$_available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
-                        : $spaces_remaining;
-                }
-            }
-        }
-    }
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket)
+	{
+		// first, get all of the datetimes that are available to this ticket
+		$datetimes = $ticket->get_many_related(
+			'Datetime',
+			array(
+				array(
+					'DTT_EVT_end' => array(
+						'>=',
+						EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+					),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+		if (! empty($datetimes)) {
+			// now loop thru all of the datetimes
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					// the number of spaces available for the datetime without considering individual ticket quantities
+					$spaces_remaining = $datetime->spaces_remaining();
+					// save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
+					// or the datetime spaces remaining) to this ticket using the datetime ID as the key
+					self::$_available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
+						$ticket->qty() - $ticket->sold(),
+						$spaces_remaining
+					);
+					// if the remaining spaces for this datetime is already set,
+					// then compare that against the datetime spaces remaining, and take the lowest number,
+					// else just take the datetime spaces remaining, and assign to the datetimes array
+					self::$_available_spaces['datetimes'][ $datetime->ID() ] = isset(
+						self::$_available_spaces['datetimes'][ $datetime->ID() ]
+					)
+						? min(self::$_available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
+						: $spaces_remaining;
+				}
+			}
+		}
+	}
 
 
-    /**
-     * @param    EE_Ticket $ticket
-     * @param    int        $qty
-     * @return    void
-     * @throws EE_Error
-     */
-    private function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
-    {
-        if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
-                // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
-                self::$_available_spaces['datetimes'][ $DTD_ID ] -= $qty;
-            }
-        }
-    }
+	/**
+	 * @param    EE_Ticket $ticket
+	 * @param    int        $qty
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	private function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
+	{
+		if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+				// subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
+				self::$_available_spaces['datetimes'][ $DTD_ID ] -= $qty;
+			}
+		}
+	}
 }
 // End of file ProcessTicketSelector.php
 // Location: /ProcessTicketSelector.php

Spacing +42 added lines, -42 removed lines

@@ -14,7 +14,7 @@ 
 use EventEspresso\core\services\loaders\LoaderFactory;
 use InvalidArgumentException;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -52,7 +52,7 @@ 
     public function cancelTicketSelections()
     {
         // check nonce
-        if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+        if ( ! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
             return false;
         }
         EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
@@ -64,7 +64,7 @@ 
             );
         } else {
             wp_safe_redirect(
-                site_url('/' . EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
+                site_url('/'.EE_Registry::instance()->CFG->core->event_cpt_slug.'/')
             );
         }
         exit();
@@ -126,7 +126,7 @@ 
     {
         do_action('EED_Ticket_Selector__process_ticket_selections__before');
         $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
-        if($request->isBot()) {
+        if ($request->isBot()) {
             wp_safe_redirect(
                 apply_filters(
                     'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
@@ -136,7 +136,7 @@ 
             exit();
         }
         // do we have an event id?
-        if (! EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
+        if ( ! EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
             // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
             EE_Error::add_error(
                 sprintf(
@@ -182,7 +182,7 @@ 
                 $valid['total_tickets'],
                 'event_espresso'
             );
-            $limit_error_1        = sprintf($total_tickets_string, $valid['total_tickets']);
+            $limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
             // dev only message
             $max_atndz_string = _n(
                 'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
@@ -190,8 +190,8 @@ 
                 $valid['max_atndz'],
                 'event_espresso'
             );
-            $limit_error_2    = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
-            EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+            $limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
+            EE_Error::add_error($limit_error_1.'<br/>'.$limit_error_2, __FILE__, __FUNCTION__, __LINE__);
         } else {
             // all data appears to be valid
             $tckts_slctd   = false;
@@ -204,15 +204,15 @@ 
                 // cycle thru the number of data rows sent from the event listing
                 for ($x = 0; $x < $valid['rows']; $x++) {
                     // does this row actually contain a ticket quantity?
-                    if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
+                    if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) {
                         // YES we have a ticket quantity
                         $tckts_slctd = true;
                         //						d( $valid['ticket_obj'][$x] );
-                        if ($valid['ticket_obj'][ $x ] instanceof EE_Ticket) {
+                        if ($valid['ticket_obj'][$x] instanceof EE_Ticket) {
                             // then add ticket to cart
                             $tickets_added += $this->addTicketToCart(
-                                $valid['ticket_obj'][ $x ],
-                                $valid['qty'][ $x ]
+                                $valid['ticket_obj'][$x],
+                                $valid['qty'][$x]
                             );
                             if (EE_Error::has_error()) {
                                 break;
@@ -262,7 +262,7 @@ 
                         )
                     );
                 } else {
-                    if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+                    if ( ! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
                         // nothing added to cart
                         EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'),
                             __FILE__, __FUNCTION__, __LINE__);
@@ -304,7 +304,7 @@ 
     private function validatePostData($id = 0)
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! $id) {
+        if ( ! $id) {
             EE_Error::add_error(
                 __('The event id provided was not valid.', 'event_espresso'),
                 __FILE__,
@@ -331,13 +331,13 @@ 
         // cycle through $inputs_to_clean array
         foreach ($inputs_to_clean as $what => $input_to_clean) {
             // check for POST data
-            if (EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
+            if (EE_Registry::instance()->REQ->is_set($input_to_clean.$id)) {
                 // grab value
-                $input_value = EE_Registry::instance()->REQ->get($input_to_clean . $id);
+                $input_value = EE_Registry::instance()->REQ->get($input_to_clean.$id);
                 switch ($what) {
                     // integers
                     case 'event_id':
-                        $valid_data[ $what ] = absint($input_value);
+                        $valid_data[$what] = absint($input_value);
                         // get event via the event id we put in the form
                         $valid_data['event'] = EE_Registry::instance()
                                                            ->load_model('Event')
@@ -345,17 +345,17 @@ 
                         break;
                     case 'rows':
                     case 'max_atndz':
-                        $valid_data[ $what ] = absint($input_value);
+                        $valid_data[$what] = absint($input_value);
                         break;
                     // arrays of integers
                     case 'qty':
                         /** @var array $row_qty */
                         $row_qty = $input_value;
                         // if qty is coming from a radio button input, then we need to assemble an array of rows
-                        if (! is_array($row_qty)) {
+                        if ( ! is_array($row_qty)) {
                             // get number of rows
-                            $rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
-                                ? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
+                            $rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-'.$id)
+                                ? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-'.$id))
                                 : 1;
                             // explode ints by the dash
                             $row_qty = explode('-', $row_qty);
@@ -363,8 +363,8 @@ 
                             $qty     = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
                             $row_qty = array($row => $qty);
                             for ($x = 1; $x <= $rows; $x++) {
-                                if (! isset($row_qty[ $x ])) {
-                                    $row_qty[ $x ] = 0;
+                                if ( ! isset($row_qty[$x])) {
+                                    $row_qty[$x] = 0;
                                 }
                             }
                         }
@@ -373,7 +373,7 @@ 
                         foreach ($row_qty as $qty) {
                             $qty = absint($qty);
                             // sanitize as integers
-                            $valid_data[ $what ][]       = $qty;
+                            $valid_data[$what][] = $qty;
                             $valid_data['total_tickets'] += $qty;
                         }
                         break;
@@ -383,14 +383,14 @@ 
                         // cycle thru values
                         foreach ((array) $input_value as $key => $value) {
                             // allow only numbers, letters,  spaces, commas and dashes
-                            $value_array[ $key ] = wp_strip_all_tags($value);
+                            $value_array[$key] = wp_strip_all_tags($value);
                             // get ticket via the ticket id we put in the form
                             $ticket_obj                       = EE_Registry::instance()
                                                                             ->load_model('Ticket')
                                                                             ->get_one_by_ID($value);
-                            $valid_data['ticket_obj'][ $key ] = $ticket_obj;
+                            $valid_data['ticket_obj'][$key] = $ticket_obj;
                         }
-                        $valid_data[ $what ] = $value_array;
+                        $valid_data[$what] = $value_array;
                         break;
                     case 'return_url' :
                         // grab and sanitize return-url
@@ -401,9 +401,9 @@ 
                             $input_value = explode('#', $input_value);
                             $input_value = end($input_value);
                             // use event list url instead, but append anchor
-                            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+                            $input_value = EEH_Event_View::event_archive_url().'#'.$input_value;
                         }
-                        $valid_data[ $what ] = $input_value;
+                        $valid_data[$what] = $input_value;
                         break;
                 }    // end switch $what
             }
@@ -533,24 +533,24 @@ 
     private function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
     {
         // if the $_available_spaces array has not been set up yet...
-        if (! isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+        if ( ! isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
             $this->setInitialTicketDatetimeAvailability($ticket);
         }
         $available_spaces = $ticket->qty() - $ticket->sold();
-        if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+        if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
             // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+            foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
                 // if we want the original datetime availability BEFORE we started subtracting tickets ?
                 if ($get_original_ticket_spaces) {
                     // then grab the available spaces from the "tickets" array
                     // and compare with the above to get the lowest number
                     $available_spaces = min(
                         $available_spaces,
-                        self::$_available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
+                        self::$_available_spaces['tickets'][$ticket->ID()][$DTD_ID]
                     );
                 } else {
                     // we want the updated ticket availability as stored in the "datetimes" array
-                    $available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][ $DTD_ID ]);
+                    $available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][$DTD_ID]);
                 }
             }
         }
@@ -581,7 +581,7 @@ 
                 'order_by' => array('DTT_EVT_start' => 'ASC'),
             )
         );
-        if (! empty($datetimes)) {
+        if ( ! empty($datetimes)) {
             // now loop thru all of the datetimes
             foreach ($datetimes as $datetime) {
                 if ($datetime instanceof EE_Datetime) {
@@ -589,17 +589,17 @@ 
                     $spaces_remaining = $datetime->spaces_remaining();
                     // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
                     // or the datetime spaces remaining) to this ticket using the datetime ID as the key
-                    self::$_available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
+                    self::$_available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min(
                         $ticket->qty() - $ticket->sold(),
                         $spaces_remaining
                     );
                     // if the remaining spaces for this datetime is already set,
                     // then compare that against the datetime spaces remaining, and take the lowest number,
                     // else just take the datetime spaces remaining, and assign to the datetimes array
-                    self::$_available_spaces['datetimes'][ $datetime->ID() ] = isset(
-                        self::$_available_spaces['datetimes'][ $datetime->ID() ]
+                    self::$_available_spaces['datetimes'][$datetime->ID()] = isset(
+                        self::$_available_spaces['datetimes'][$datetime->ID()]
                     )
-                        ? min(self::$_available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
+                        ? min(self::$_available_spaces['datetimes'][$datetime->ID()], $spaces_remaining)
                         : $spaces_remaining;
                 }
             }
@@ -615,11 +615,11 @@ 
      */
     private function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
     {
-        if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+        if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
             // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+            foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
                 // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
-                self::$_available_spaces['datetimes'][ $DTD_ID ] -= $qty;
+                self::$_available_spaces['datetimes'][$DTD_ID] -= $qty;
             }
         }
     }

core/libraries/form_sections/base/EE_Form_Section_Proper.form.php

Spacing +42 added lines, -42 removed lines

@@ -111,8 +111,8 @@ 
             //AND we are going to make sure they're in that specified order
             $reordered_subsections = array();
             foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[ $input_name ])) {
-                    $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
+                if (isset($this->_subsections[$input_name])) {
+                    $reordered_subsections[$input_name] = $this->_subsections[$input_name];
                 }
             }
             $this->_subsections = $reordered_subsections;
@@ -124,7 +124,7 @@ 
         if (isset($options_array['layout_strategy'])) {
             $this->_layout_strategy = $options_array['layout_strategy'];
         }
-        if (! $this->_layout_strategy) {
+        if ( ! $this->_layout_strategy) {
             $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
         }
         $this->_layout_strategy->_construct_finalize($this);
@@ -277,7 +277,7 @@ 
                 $req_data,
                 $this
             );
-            $this->cached_request_data = (array)$req_data;
+            $this->cached_request_data = (array) $req_data;
         }
         return $this->cached_request_data;
     }
@@ -313,7 +313,7 @@ 
         if ($validate) {
             $this->_validate();
             //if it's invalid, we're going to want to re-display so remember what they submitted
-            if (! $this->is_valid()) {
+            if ( ! $this->is_valid()) {
                 $this->store_submitted_form_data_in_session();
             }
         }
@@ -426,11 +426,11 @@ 
     public function populate_defaults($default_data)
     {
         foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[ $subsection_name ])) {
+            if (isset($default_data[$subsection_name])) {
                 if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[ $subsection_name ]);
+                    $subsection->set_default($default_data[$subsection_name]);
                 } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[ $subsection_name ]);
+                    $subsection->populate_defaults($default_data[$subsection_name]);
                 }
             }
         }
@@ -445,7 +445,7 @@ 
      */
     public function subsection_exists($name)
     {
-        return isset($this->_subsections[ $name ]) ? true : false;
+        return isset($this->_subsections[$name]) ? true : false;
     }
 
 
@@ -467,7 +467,7 @@ 
         if ($require_construction_to_be_finalized) {
             $this->ensure_construct_finalized_called();
         }
-        return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
+        return $this->subsection_exists($name) ? $this->_subsections[$name] : null;
     }
 
 
@@ -482,7 +482,7 @@ 
         $validatable_subsections = array();
         foreach ($this->subsections() as $name => $obj) {
             if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[ $name ] = $obj;
+                $validatable_subsections[$name] = $obj;
             }
         }
         return $validatable_subsections;
@@ -509,7 +509,7 @@ 
             $name,
             $require_construction_to_be_finalized
         );
-        if (! $subsection instanceof EE_Form_Input_Base) {
+        if ( ! $subsection instanceof EE_Form_Input_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -546,7 +546,7 @@ 
             $name,
             $require_construction_to_be_finalized
         );
-        if (! $subsection instanceof EE_Form_Section_Proper) {
+        if ( ! $subsection instanceof EE_Form_Section_Proper) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -585,8 +585,8 @@ 
      */
     public function is_valid()
     {
-        if($this->is_valid === null) {
-            if (! $this->has_received_submission()) {
+        if ($this->is_valid === null) {
+            if ( ! $this->has_received_submission()) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -596,14 +596,14 @@ 
                     )
                 );
             }
-            if (! parent::is_valid()) {
+            if ( ! parent::is_valid()) {
                 $this->is_valid = false;
             } else {
                 // ok so no general errors to this entire form section.
                 // so let's check the subsections, but only set errors if that hasn't been done yet
                 $this->is_valid = true;
                 foreach ($this->get_validatable_subsections() as $subsection) {
-                    if (! $subsection->is_valid()) {
+                    if ( ! $subsection->is_valid()) {
                         $this->is_valid = false;
                     }
                 }
@@ -620,7 +620,7 @@ 
      */
     protected function _set_default_name_if_empty()
     {
-        if (! $this->_name) {
+        if ( ! $this->_name) {
             $classname    = get_class($this);
             $default_name = str_replace('EE_', '', $classname);
             $this->_name  = $default_name;
@@ -710,7 +710,7 @@ 
     {
         wp_register_script(
             'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
+            EE_GLOBAL_ASSETS_URL.'scripts'.DS.'form_section_validation.js',
             array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -754,13 +754,13 @@ 
         // we only want to localize vars ONCE for the entire form,
         // so if the form section doesn't have a parent, then it must be the top dog
         if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
+            EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array(
                 'form_section_id'  => $this->html_id(true),
                 'validation_rules' => $this->get_jquery_validation_rules(),
                 'other_data'       => $this->get_other_js_data(),
                 'errors'           => $this->subsection_validation_errors_by_html_name(),
             );
-            EE_Form_Section_Proper::$_scripts_localized                                = true;
+            EE_Form_Section_Proper::$_scripts_localized = true;
         }
     }
 
@@ -795,7 +795,7 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection->html_name() ] = $subsection;
+                $inputs[$subsection->html_name()] = $subsection;
             } elseif ($subsection instanceof EE_Form_Section_Proper) {
                 $inputs += $subsection->inputs_in_subsections();
             }
@@ -818,7 +818,7 @@ 
         $errors = array();
         foreach ($inputs as $form_input) {
             if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+                $errors[$form_input->html_name()] = $form_input->get_validation_error_string();
             }
         }
         return $errors;
@@ -841,7 +841,7 @@ 
         $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
             ? EE_Registry::instance()->CFG->registration->email_validation_level
             : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
+        EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level;
         wp_enqueue_script('ee_form_section_validation');
         wp_localize_script(
             'ee_form_section_validation',
@@ -858,7 +858,7 @@ 
      */
     public function ensure_scripts_localized()
     {
-        if (! EE_Form_Section_Proper::$_scripts_localized) {
+        if ( ! EE_Form_Section_Proper::$_scripts_localized) {
             $this->_enqueue_and_localize_form_js();
         }
     }
@@ -954,8 +954,8 @@ 
         //reset the cache of whether this form is valid or not- we're re-validating it now
         $this->is_valid = null;
         foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+            if (method_exists($this, '_validate_'.$subsection_name)) {
+                call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection));
             }
             $subsection->_validate();
         }
@@ -973,9 +973,9 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[ $subsection_name ] = $subsection->valid_data();
+                $inputs[$subsection_name] = $subsection->valid_data();
             } elseif ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection->normalized_value();
+                $inputs[$subsection_name] = $subsection->normalized_value();
             }
         }
         return $inputs;
@@ -993,7 +993,7 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection;
+                $inputs[$subsection_name] = $subsection;
             }
         }
         return $inputs;
@@ -1011,7 +1011,7 @@ 
         $form_sections = array();
         foreach ($this->subsections() as $name => $obj) {
             if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[ $name ] = $obj;
+                $form_sections[$name] = $obj;
             }
         }
         return $form_sections;
@@ -1118,7 +1118,7 @@ 
         $input_values = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[ $subsection_name ] = $pretty
+                $input_values[$subsection_name] = $pretty
                     ? $subsection->pretty_value()
                     : $subsection->normalized_value();
             } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
@@ -1130,7 +1130,7 @@ 
                 if ($flatten) {
                     $input_values = array_merge($input_values, $subform_input_values);
                 } else {
-                    $input_values[ $subsection_name ] = $subform_input_values;
+                    $input_values[$subsection_name] = $subform_input_values;
                 }
             }
         }
@@ -1158,7 +1158,7 @@ 
             if ($subsection instanceof EE_Form_Input_Base) {
                 // is this input part of an array of inputs?
                 if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name  = EEH_Array::convert_array_values_to_keys(
+                    $full_input_name = EEH_Array::convert_array_values_to_keys(
                         explode(
                             '[',
                             str_replace(']', '', $subsection->html_name())
@@ -1167,7 +1167,7 @@ 
                     );
                     $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
                 } else {
-                    $submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
+                    $submitted_values[$subsection->html_name()] = $subsection->raw_value();
                 }
             } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
                 $subform_input_values = $subsection->submitted_values($include_subforms);
@@ -1202,7 +1202,7 @@ 
     public function exclude(array $inputs_to_exclude = array())
     {
         foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[ $input_to_exclude_name ]);
+            unset($this->_subsections[$input_to_exclude_name]);
         }
     }
 
@@ -1244,7 +1244,7 @@ 
     public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
     {
         foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
+            if ( ! $subsection instanceof EE_Form_Section_Base) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -1256,7 +1256,7 @@ 
                         $this->name()
                     )
                 );
-                unset($new_subsections[ $subsection_name ]);
+                unset($new_subsections[$subsection_name]);
             }
         }
         $this->_subsections = EEH_Array::insert_into_array(
@@ -1280,7 +1280,7 @@ 
      */
     public function has_subsection($subsection_name, $recursive = false)
     {
-        foreach ($this->_subsections as $name => $subsection) {if(
+        foreach ($this->_subsections as $name => $subsection) {if (
                 $name === $subsection_name
                 || (
                     $recursive
@@ -1371,7 +1371,7 @@ 
     public function html_name_prefix()
     {
         if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+            return $this->parent_section()->html_name_prefix().'['.$this->name().']';
         }
         return $this->name();
     }
@@ -1411,7 +1411,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }
@@ -1484,7 +1484,7 @@ 
                 $form_section = $validation_error->get_form_section();
                 if ($form_section instanceof EE_Form_Input_Base) {
                    $label = $validation_error->get_form_section()->html_label_text();
-                } elseif($form_section instanceof EE_Form_Section_Validatable) {
+                } elseif ($form_section instanceof EE_Form_Section_Validatable) {
                     $label = $validation_error->get_form_section()->name();
                 } else {
                     $label = esc_html__('Unknown', 'event_espresso');

Indentation +1524 added lines, -1524 removed lines

@@ -14,1529 +14,1529 @@
 class EE_Form_Section_Proper extends EE_Form_Section_Validatable
 {
 
-    const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
-
-    /**
-     * Subsections
-     *
-     * @var EE_Form_Section_Validatable[]
-     */
-    protected $_subsections = array();
-
-    /**
-     * Strategy for laying out the form
-     *
-     * @var EE_Form_Section_Layout_Base
-     */
-    protected $_layout_strategy;
-
-    /**
-     * Whether or not this form has received and validated a form submission yet
-     *
-     * @var boolean
-     */
-    protected $_received_submission = false;
-
-    /**
-     * message displayed to users upon successful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_success_message = '';
-
-    /**
-     * message displayed to users upon unsuccessful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_error_message = '';
-
-    /**
-     * @var array like $_REQUEST
-     */
-    protected $cached_request_data;
-
-    /**
-     * Stores whether this form (and its sub-sections) were found to be valid or not.
-     * Starts off as null, but once the form is validated, it set to either true or false
-     * @var boolean|null
-     */
-    protected $is_valid;
-
-    /**
-     * Stores all the data that will localized for form validation
-     *
-     * @var array
-     */
-    static protected $_js_localization = array();
-
-    /**
-     * whether or not the form's localized validation JS vars have been set
-     *
-     * @type boolean
-     */
-    static protected $_scripts_localized = false;
-
-
-    /**
-     * when constructing a proper form section, calls _construct_finalize on children
-     * so that they know who their parent is, and what name they've been given.
-     *
-     * @param array[] $options_array   {
-     * @type          $subsections     EE_Form_Section_Validatable[] where keys are the section's name
-     * @type          $include         string[] numerically-indexed where values are section names to be included,
-     *                                 and in that order. This is handy if you want
-     *                                 the subsections to be ordered differently than the default, and if you override
-     *                                 which fields are shown
-     * @type          $exclude         string[] values are subsections to be excluded. This is handy if you want
-     *                                 to remove certain default subsections (note: if you specify BOTH 'include' AND
-     *                                 'exclude', the inclusions will be applied first, and the exclusions will exclude
-     *                                 items from that list of inclusions)
-     * @type          $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
-     *                                 } @see EE_Form_Section_Validatable::__construct()
-     * @throws EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        $options_array = (array) apply_filters(
-            'FHEE__EE_Form_Section_Proper___construct__options_array',
-            $options_array,
-            $this
-        );
-        //call parent first, as it may be setting the name
-        parent::__construct($options_array);
-        //if they've included subsections in the constructor, add them now
-        if (isset($options_array['include'])) {
-            //we are going to make sure we ONLY have those subsections to include
-            //AND we are going to make sure they're in that specified order
-            $reordered_subsections = array();
-            foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[ $input_name ])) {
-                    $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
-                }
-            }
-            $this->_subsections = $reordered_subsections;
-        }
-        if (isset($options_array['exclude'])) {
-            $exclude            = $options_array['exclude'];
-            $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
-        }
-        if (isset($options_array['layout_strategy'])) {
-            $this->_layout_strategy = $options_array['layout_strategy'];
-        }
-        if (! $this->_layout_strategy) {
-            $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
-        }
-        $this->_layout_strategy->_construct_finalize($this);
-        //ok so we are definitely going to want the forms JS,
-        //so enqueue it or remember to enqueue it during wp_enqueue_scripts
-        if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
-            //ok so they've constructed this object after when they should have.
-            //just enqueue the generic form scripts and initialize the form immediately in the JS
-            EE_Form_Section_Proper::wp_enqueue_scripts(true);
-        } else {
-            add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-            add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-        }
-        add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
-        /**
-         * Gives other plugins a chance to hook in before construct finalize is called.
-         * The form probably doesn't yet have a parent form section.
-         * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form,
-         * assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
-         * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
-         *
-         * @since 4.9.32
-         * @param EE_Form_Section_Proper $this          before __construct is done, but all of its logic,
-         *                                              except maybe calling _construct_finalize has been done
-         * @param array                  $options_array options passed into the constructor
-         */
-        do_action(
-            'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called',
-            $this,
-            $options_array
-        );
-        if (isset($options_array['name'])) {
-            $this->_construct_finalize(null, $options_array['name']);
-        }
-    }
-
-
-    /**
-     * Finishes construction given the parent form section and this form section's name
-     *
-     * @param EE_Form_Section_Proper $parent_form_section
-     * @param string                 $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        $this->_set_default_name_if_empty();
-        $this->_set_default_html_id_if_empty();
-        foreach ($this->_subsections as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Base) {
-                $subsection->_construct_finalize($this, $subsection_name);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
-                            'event_espresso'
-                        ),
-                        $subsection_name,
-                        get_class($this),
-                        $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
-                    )
-                );
-            }
-        }
-        /**
-         * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
-         * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID
-         * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done.
-         * This might only happen just before displaying the form, or just before it receives form submission data.
-         * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
-         * ensured it has a name, HTML IDs, etc
-         *
-         * @param EE_Form_Section_Proper      $this
-         * @param EE_Form_Section_Proper|null $parent_form_section
-         * @param string                      $name
-         */
-        do_action(
-            'AHEE__EE_Form_Section_Proper___construct_finalize__end',
-            $this,
-            $parent_form_section,
-            $name
-        );
-    }
-
-
-    /**
-     * Gets the layout strategy for this form section
-     *
-     * @return EE_Form_Section_Layout_Base
-     */
-    public function get_layout_strategy()
-    {
-        return $this->_layout_strategy;
-    }
-
-
-    /**
-     * Gets the HTML for a single input for this form section according
-     * to the layout strategy
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function get_html_for_input($input)
-    {
-        return $this->_layout_strategy->layout_input($input);
-    }
-
-
-    /**
-     * was_submitted - checks if form inputs are present in request data
-     * Basically an alias for form_data_present_in() (which is used by both
-     * proper form sections and form inputs)
-     *
-     * @param null $form_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function was_submitted($form_data = null)
-    {
-        return $this->form_data_present_in($form_data);
-    }
-
-    /**
-     * Gets the cached request data; but if there is none, or $req_data was set with
-     * something different, refresh the cache, and then return it
-     * @param null $req_data
-     * @return array
-     */
-    protected function getCachedRequest($req_data = null)
-    {
-        if ($this->cached_request_data === null
-            || (
-                $req_data !== null &&
-                $req_data !== $this->cached_request_data
-            )
-        ) {
-            $req_data = apply_filters(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
-                $req_data,
-                $this
-            );
-            if ($req_data === null) {
-                $req_data = array_merge($_GET, $_POST);
-            }
-            $req_data = apply_filters(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
-                $req_data,
-                $this
-            );
-            $this->cached_request_data = (array)$req_data;
-        }
-        return $this->cached_request_data;
-    }
-
-
-    /**
-     * After the form section is initially created, call this to sanitize the data in the submission
-     * which relates to this form section, validate it, and set it as properties on the form.
-     *
-     * @param array|null $req_data should usually be $_POST (the default).
-     *                             However, you CAN supply a different array.
-     *                             Consider using set_defaults() instead however.
-     *                             (If you rendered the form in the page using echo $form_x->get_html()
-     *                             the inputs will have the correct name in the request data for this function
-     *                             to find them and populate the form with them.
-     *                             If you have a flat form (with only input subsections),
-     *                             you can supply a flat array where keys
-     *                             are the form input names and values are their values)
-     * @param boolean    $validate whether or not to perform validation on this data. Default is,
-     *                             of course, to validate that data, and set errors on the invalid values.
-     *                             But if the data has already been validated
-     *                             (eg you validated the data then stored it in the DB)
-     *                             you may want to skip this step.
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function receive_form_submission($req_data = null, $validate = true)
-    {
-        $req_data = $this->getCachedRequest($req_data);
-        $this->_normalize($req_data);
-        if ($validate) {
-            $this->_validate();
-            //if it's invalid, we're going to want to re-display so remember what they submitted
-            if (! $this->is_valid()) {
-                $this->store_submitted_form_data_in_session();
-            }
-        }
-        if ($this->submission_error_message() === '' && ! $this->is_valid()) {
-            $this->set_submission_error_message();
-        }
-        do_action(
-            'AHEE__EE_Form_Section_Proper__receive_form_submission__end',
-            $req_data,
-            $this,
-            $validate
-        );
-    }
-
-
-    /**
-     * caches the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return boolean whether or not the data was successfully stored in the session
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function store_submitted_form_data_in_session()
-    {
-        return EE_Registry::instance()->SSN->set_session_data(
-            array(
-                EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
-            )
-        );
-    }
-
-
-    /**
-     * retrieves the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function get_submitted_form_data_from_session()
-    {
-        $session = EE_Registry::instance()->SSN;
-        if ($session instanceof EE_Session) {
-            return $session->get_session_data(
-                EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
-            );
-        }
-        return array();
-    }
-
-
-    /**
-     * flushed the originally submitted input values from the session
-     *
-     * @return boolean whether or not the data was successfully removed from the session
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function flush_submitted_form_data_from_session()
-    {
-        return EE_Registry::instance()->SSN->reset_data(
-            array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
-        );
-    }
-
-
-    /**
-     * Populates this form and its subsections with data from the session.
-     * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
-     * validation errors when displaying too)
-     * Returns true if the form was populated from the session, false otherwise
-     *
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function populate_from_session()
-    {
-        $form_data_in_session = $this->get_submitted_form_data_from_session();
-        if (empty($form_data_in_session)) {
-            return false;
-        }
-        $this->receive_form_submission($form_data_in_session);
-        $this->flush_submitted_form_data_from_session();
-        if ($this->form_data_present_in($form_data_in_session)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Populates the default data for the form, given an array where keys are
-     * the input names, and values are their values (preferably normalized to be their
-     * proper PHP types, not all strings... although that should be ok too).
-     * Proper subsections are sub-arrays, the key being the subsection's name, and
-     * the value being an array formatted in teh same way
-     *
-     * @param array $default_data
-     * @throws EE_Error
-     */
-    public function populate_defaults($default_data)
-    {
-        foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[ $subsection_name ])) {
-                if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[ $subsection_name ]);
-                } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[ $subsection_name ]);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * returns true if subsection exists
-     *
-     * @param string $name
-     * @return boolean
-     */
-    public function subsection_exists($name)
-    {
-        return isset($this->_subsections[ $name ]) ? true : false;
-    }
-
-
-    /**
-     * Gets the subsection specified by its name
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
-     *                                                      so that the inputs will be properly configured.
-     *                                                      However, some client code may be ok
-     *                                                      with construction finalize being called later
-     *                                                      (realizing that the subsections' html names
-     *                                                      might not be set yet, etc.)
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     */
-    public function get_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
-    }
-
-
-    /**
-     * Gets all the validatable subsections of this form section
-     *
-     * @return EE_Form_Section_Validatable[]
-     * @throws EE_Error
-     */
-    public function get_validatable_subsections()
-    {
-        $validatable_subsections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[ $name ] = $obj;
-            }
-        }
-        return $validatable_subsections;
-    }
-
-
-    /**
-     * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
-     * throw an EE_Error.
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function get_input($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection(
-            $name,
-            $require_construction_to_be_finalized
-        );
-        if (! $subsection instanceof EE_Form_Input_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this),
-                    $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-    /**
-     * Like get_input(), gets the proper subsection of the form given the name,
-     * otherwise throws an EE_Error
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection(
-            $name,
-            $require_construction_to_be_finalized
-        );
-        if (! $subsection instanceof EE_Form_Section_Proper) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this)
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-    /**
-     * Gets the value of the specified input. Should be called after receive_form_submission()
-     * or populate_defaults() on the form, where the normalized value on the input is set.
-     *
-     * @param string $name
-     * @return mixed depending on the input's type and its normalization strategy
-     * @throws EE_Error
-     */
-    public function get_input_value($name)
-    {
-        $input = $this->get_input($name);
-        return $input->normalized_value();
-    }
-
-
-    /**
-     * Checks if this form section itself is valid, and then checks its subsections
-     *
-     * @throws EE_Error
-     * @return boolean
-     */
-    public function is_valid()
-    {
-        if($this->is_valid === null) {
-            if (! $this->has_received_submission()) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'You cannot check if a form is valid before receiving the form submission using receive_form_submission',
-                            'event_espresso'
-                        )
-                    )
-                );
-            }
-            if (! parent::is_valid()) {
-                $this->is_valid = false;
-            } else {
-                // ok so no general errors to this entire form section.
-                // so let's check the subsections, but only set errors if that hasn't been done yet
-                $this->is_valid = true;
-                foreach ($this->get_validatable_subsections() as $subsection) {
-                    if (! $subsection->is_valid()) {
-                        $this->is_valid = false;
-                    }
-                }
-            }
-        }
-        return $this->is_valid;
-    }
-
-
-    /**
-     * gets the default name of this form section if none is specified
-     *
-     * @return void
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $classname    = get_class($this);
-            $default_name = str_replace('EE_', '', $classname);
-            $this->_name  = $default_name;
-        }
-    }
-
-
-    /**
-     * Returns the HTML for the form, except for the form opening and closing tags
-     * (as the form section doesn't know where you necessarily want to send the information to),
-     * and except for a submit button. Enqueues JS and CSS; if called early enough we will
-     * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
-     * Not doing_it_wrong because theoretically this CAN be used properly,
-     * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
-     * any CSS.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_html_and_js()
-    {
-        $this->enqueue_js();
-        return $this->get_html();
-    }
-
-
-    /**
-     * returns HTML for displaying this form section. recursively calls display_section() on all subsections
-     *
-     * @param bool $display_previously_submitted_data
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function get_html($display_previously_submitted_data = true)
-    {
-        $this->ensure_construct_finalized_called();
-        if ($display_previously_submitted_data) {
-            $this->populate_from_session();
-        }
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
-            : $this->_layout_strategy->layout_form();
-    }
-
-
-    /**
-     * enqueues JS and CSS for the form.
-     * It is preferred to call this before wp_enqueue_scripts so the
-     * scripts and styles can be put in the header, but if called later
-     * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
-     * only be in the header; but in HTML5 its ok in the body.
-     * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
-     * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function enqueue_js()
-    {
-        $this->_enqueue_and_localize_form_js();
-        foreach ($this->subsections() as $subsection) {
-            $subsection->enqueue_js();
-        }
-    }
-
-
-    /**
-     * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
-     * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
-     * the wp_enqueue_scripts hook.
-     * However, registering the form js and localizing it can happen when we
-     * actually output the form (which is preferred, seeing how teh form's fields
-     * could change until it's actually outputted)
-     *
-     * @param boolean $init_form_validation_automatically whether or not we want the form validation
-     *                                                    to be triggered automatically or not
-     * @return void
-     */
-    public static function wp_enqueue_scripts($init_form_validation_automatically = true)
-    {
-        wp_register_script(
-            'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
-            array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_validation_init',
-            array('init' => $init_form_validation_automatically ? '1' : '0')
-        );
-    }
-
-
-    /**
-     * gets the variables used by form_section_validation.js.
-     * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
-     * but before the wordpress hook wp_loaded
-     *
-     * @throws EE_Error
-     */
-    public function _enqueue_and_localize_form_js()
-    {
-        $this->ensure_construct_finalized_called();
-        //actually, we don't want to localize just yet. There may be other forms on the page.
-        //so we need to add our form section data to a static variable accessible by all form sections
-        //and localize it just before the footer
-        $this->localize_validation_rules();
-        add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
-        add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
-    }
-
-
-    /**
-     * add our form section data to a static variable accessible by all form sections
-     *
-     * @param bool $return_for_subsection
-     * @return void
-     * @throws EE_Error
-     */
-    public function localize_validation_rules($return_for_subsection = false)
-    {
-        // we only want to localize vars ONCE for the entire form,
-        // so if the form section doesn't have a parent, then it must be the top dog
-        if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
-                'form_section_id'  => $this->html_id(true),
-                'validation_rules' => $this->get_jquery_validation_rules(),
-                'other_data'       => $this->get_other_js_data(),
-                'errors'           => $this->subsection_validation_errors_by_html_name(),
-            );
-            EE_Form_Section_Proper::$_scripts_localized                                = true;
-        }
-    }
-
-
-    /**
-     * Gets an array of extra data that will be useful for client-side javascript.
-     * This is primarily data added by inputs and forms in addition to any
-     * scripts they might enqueue
-     *
-     * @param array $form_other_js_data
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        foreach ($this->subsections() as $subsection) {
-            $form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-    /**
-     * Gets a flat array of inputs for this form section and its subsections.
-     * Keys are their form names, and values are the inputs themselves
-     *
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function inputs_in_subsections()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection->html_name() ] = $subsection;
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs += $subsection->inputs_in_subsections();
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets a flat array of all the validation errors.
-     * Keys are html names (because those should be unique)
-     * and values are a string of all their validation errors
-     *
-     * @return string[]
-     * @throws EE_Error
-     */
-    public function subsection_validation_errors_by_html_name()
-    {
-        $inputs = $this->inputs();
-        $errors = array();
-        foreach ($inputs as $form_input) {
-            if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
-            }
-        }
-        return $errors;
-    }
-
-
-    /**
-     * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
-     * Should be setup by each form during the _enqueues_and_localize_form_js
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function localize_script_for_all_forms()
-    {
-        //allow inputs and stuff to hook in their JS and stuff here
-        do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
-        EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
-        $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
-            ? EE_Registry::instance()->CFG->registration->email_validation_level
-            : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
-        wp_enqueue_script('ee_form_section_validation');
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_vars',
-            EE_Form_Section_Proper::$_js_localization
-        );
-    }
-
-
-    /**
-     * ensure_scripts_localized
-     *
-     * @throws EE_Error
-     */
-    public function ensure_scripts_localized()
-    {
-        if (! EE_Form_Section_Proper::$_scripts_localized) {
-            $this->_enqueue_and_localize_form_js();
-        }
-    }
-
-
-    /**
-     * Gets the hard-coded validation error messages to be used in the JS. The convention
-     * is that the key here should be the same as the custom validation rule put in the JS file
-     *
-     * @return array keys are custom validation rules, and values are internationalized strings
-     */
-    private static function _get_localized_error_messages()
-    {
-        return array(
-            'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'),
-            'regex'    => esc_html__('Please check your input', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function js_localization()
-    {
-        return self::$_js_localization;
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function reset_js_localization()
-    {
-        self::$_js_localization = array();
-    }
-
-
-    /**
-     * Gets the JS to put inside the jquery validation rules for subsection of this form section.
-     * See parent function for more...
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_jquery_validation_rules()
-    {
-        $jquery_validation_rules = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $jquery_validation_rules = array_merge(
-                $jquery_validation_rules,
-                $subsection->get_jquery_validation_rules()
-            );
-        }
-        return $jquery_validation_rules;
-    }
-
-
-    /**
-     * Sanitizes all the data and sets the sanitized value of each field
-     *
-     * @param array $req_data like $_POST
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _normalize($req_data)
-    {
-        $this->_received_submission = true;
-        $this->_validation_errors   = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            try {
-                $subsection->_normalize($req_data);
-            } catch (EE_Validation_Error $e) {
-                $subsection->add_validation_error($e);
-            }
-        }
-    }
-
-
-    /**
-     * Performs validation on this form section and its subsections.
-     * For each subsection,
-     * calls _validate_{subsection_name} on THIS form (if the function exists)
-     * and passes it the subsection, then calls _validate on that subsection.
-     * If you need to perform validation on the form as a whole (considering multiple)
-     * you would be best to override this _validate method,
-     * calling parent::_validate() first.
-     *
-     * @throws EE_Error
-     */
-    protected function _validate()
-    {
-        //reset the cache of whether this form is valid or not- we're re-validating it now
-        $this->is_valid = null;
-        foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
-            }
-            $subsection->_validate();
-        }
-    }
-
-
-    /**
-     * Gets all the validated inputs for the form section
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function valid_data()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[ $subsection_name ] = $subsection->valid_data();
-            } elseif ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection->normalized_value();
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets all the inputs on this form section
-     *
-     * @return EE_Form_Input_Base[]
-     * @throws EE_Error
-     */
-    public function inputs()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection;
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets all the subsections which are a proper form
-     *
-     * @return EE_Form_Section_Proper[]
-     * @throws EE_Error
-     */
-    public function subforms()
-    {
-        $form_sections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[ $name ] = $obj;
-            }
-        }
-        return $form_sections;
-    }
-
-
-    /**
-     * Gets all the subsections (inputs, proper subsections, or html-only sections).
-     * Consider using inputs() or subforms()
-     * if you only want form inputs or proper form sections.
-     *
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper[]
-     * @throws EE_Error
-     */
-    public function subsections($require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->_subsections;
-    }
-
-
-    /**
-     * Returns whether this form has any subforms or inputs
-     * @return bool
-     */
-    public function hasSubsections()
-    {
-        return ! empty($this->_subsections);
-    }
-
-
-    /**
-     * Returns a simple array where keys are input names, and values are their normalized
-     * values. (Similar to calling get_input_value on inputs)
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function input_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(false, $include_subform_inputs, $flatten);
-    }
-
-
-    /**
-     * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
-     * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
-     * is not necessarily the value we want to display to users. This creates an array
-     * where keys are the input names, and values are their display values
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function input_pretty_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(true, $include_subform_inputs, $flatten);
-    }
-
-
-    /**
-     * Gets the input values from the form
-     *
-     * @param boolean $pretty                 Whether to retrieve the pretty value,
-     *                                        or just the normalized value
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
-     *                                        input names (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
-    {
-        $input_values = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[ $subsection_name ] = $pretty
-                    ? $subsection->pretty_value()
-                    : $subsection->normalized_value();
-            } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
-                $subform_input_values = $subsection->_input_values(
-                    $pretty,
-                    $include_subform_inputs,
-                    $flatten
-                );
-                if ($flatten) {
-                    $input_values = array_merge($input_values, $subform_input_values);
-                } else {
-                    $input_values[ $subsection_name ] = $subform_input_values;
-                }
-            }
-        }
-        return $input_values;
-    }
-
-
-    /**
-     * Gets the originally submitted input values from the form
-     *
-     * @param boolean $include_subforms  Whether to include inputs from subforms,
-     *                                   or just this forms' direct children inputs
-     * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
-     *                                   with array keys being input names
-     *                                   (regardless of whether they are from a subsection or not),
-     *                                   and if $flatten is FALSE it can be a multidimensional array
-     *                                   where keys are always subsection names and values are either
-     *                                   the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function submitted_values($include_subforms = false)
-    {
-        $submitted_values = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                // is this input part of an array of inputs?
-                if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name  = EEH_Array::convert_array_values_to_keys(
-                        explode(
-                            '[',
-                            str_replace(']', '', $subsection->html_name())
-                        ),
-                        $subsection->raw_value()
-                    );
-                    $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
-                } else {
-                    $submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
-                $subform_input_values = $subsection->submitted_values($include_subforms);
-                $submitted_values     = array_replace_recursive($submitted_values, $subform_input_values);
-            }
-        }
-        return $submitted_values;
-    }
-
-
-    /**
-     * Indicates whether or not this form has received a submission yet
-     * (ie, had receive_form_submission called on it yet)
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function has_received_submission()
-    {
-        $this->ensure_construct_finalized_called();
-        return $this->_received_submission;
-    }
-
-
-    /**
-     * Equivalent to passing 'exclude' in the constructor's options array.
-     * Removes the listed inputs from the form
-     *
-     * @param array $inputs_to_exclude values are the input names
-     * @return void
-     */
-    public function exclude(array $inputs_to_exclude = array())
-    {
-        foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[ $input_to_exclude_name ]);
-        }
-    }
-
-
-    /**
-     * Changes these inputs' display strategy to be EE_Hidden_Display_Strategy.
-     * @param array $inputs_to_hide
-     * @throws EE_Error
-     */
-    public function hide(array $inputs_to_hide = array())
-    {
-        foreach ($inputs_to_hide as $input_to_hide) {
-            $input = $this->get_input($input_to_hide);
-            $input->set_display_strategy(new EE_Hidden_Display_Strategy());
-        }
-    }
-
-
-    /**
-     * add_subsections
-     * Adds the listed subsections to the form section.
-     * If $subsection_name_to_target is provided,
-     * then new subsections are added before or after that subsection,
-     * otherwise to the start or end of the entire subsections array.
-     *
-     * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
-     *                                                          where keys are their names
-     * @param string                 $subsection_name_to_target an existing for section that $new_subsections
-     *                                                          should be added before or after
-     *                                                          IF $subsection_name_to_target is null,
-     *                                                          then $new_subsections will be added to
-     *                                                          the beginning or end of the entire subsections array
-     * @param boolean                $add_before                whether to add $new_subsections, before or after
-     *                                                          $subsection_name_to_target,
-     *                                                          or if $subsection_name_to_target is null,
-     *                                                          before or after entire subsections array
-     * @return void
-     * @throws EE_Error
-     */
-    public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
-    {
-        foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
-                            'event_espresso'
-                        ),
-                        get_class($subsection),
-                        $subsection_name,
-                        $this->name()
-                    )
-                );
-                unset($new_subsections[ $subsection_name ]);
-            }
-        }
-        $this->_subsections = EEH_Array::insert_into_array(
-            $this->_subsections,
-            $new_subsections,
-            $subsection_name_to_target,
-            $add_before
-        );
-        if ($this->_construction_finalized) {
-            foreach ($this->_subsections as $name => $subsection) {
-                $subsection->_construct_finalize($this, $name);
-            }
-        }
-    }
-
-
-    /**
-     * @param string $subsection_name
-     * @param bool   $recursive
-     * @return bool
-     */
-    public function has_subsection($subsection_name, $recursive = false)
-    {
-        foreach ($this->_subsections as $name => $subsection) {if(
-                $name === $subsection_name
-                || (
-                    $recursive
-                    && $subsection instanceof EE_Form_Section_Proper
-                    && $subsection->has_subsection($subsection_name, $recursive)
-                )
-            ) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Just gets all validatable subsections to clean their sensitive data
-     *
-     * @throws EE_Error
-     */
-    public function clean_sensitive_data()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $subsection->clean_sensitive_data();
-        }
-    }
-
-
-    /**
-     * Sets the submission error message (aka validation error message for this form section and all sub-sections)
-     * @param string                           $form_submission_error_message
-     * @param EE_Form_Section_Validatable $form_section unused
-     * @throws EE_Error
-     */
-    public function set_submission_error_message(
-        $form_submission_error_message = ''
-    ) {
-        $this->_form_submission_error_message = ! empty($form_submission_error_message)
-            ? $form_submission_error_message
-            : $this->getAllValidationErrorsString();
-    }
-
-
-    /**
-     * Returns the cached error message. A default value is set for this during _validate(),
-     * (called during receive_form_submission) but it can be explicitly set using
-     * set_submission_error_message
-     *
-     * @return string
-     */
-    public function submission_error_message()
-    {
-        return $this->_form_submission_error_message;
-    }
-
-
-    /**
-     * Sets a message to display if the data submitted to the form was valid.
-     * @param string $form_submission_success_message
-     */
-    public function set_submission_success_message($form_submission_success_message = '')
-    {
-        $this->_form_submission_success_message = ! empty($form_submission_success_message)
-            ? $form_submission_success_message
-            : esc_html__('Form submitted successfully', 'event_espresso');
-    }
-
-
-    /**
-     * Gets a message appropriate for display when the form is correctly submitted
-     * @return string
-     */
-    public function submission_success_message()
-    {
-        return $this->_form_submission_success_message;
-    }
-
-
-    /**
-     * Returns the prefix that should be used on child of this form section for
-     * their html names. If this form section itself has a parent, prepends ITS
-     * prefix onto this form section's prefix. Used primarily by
-     * EE_Form_Input_Base::_set_default_html_name_if_empty
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_name_prefix()
-    {
-        if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
-        }
-        return $this->name();
-    }
-
-
-    /**
-     * Gets the name, but first checks _construct_finalize has been called. If not,
-     * calls it (assumes there is no parent and that we want the name to be whatever
-     * was set, which is probably nothing, or the classname)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::name();
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function parent_section()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::parent_section();
-    }
-
-
-    /**
-     * make sure construction finalized was called, otherwise children might not be ready
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function ensure_construct_finalized_called()
-    {
-        if (! $this->_construction_finalized) {
-            $this->_construct_finalize($this->_parent_section, $this->_name);
-        }
-    }
-
-
-    /**
-     * Checks if any of this form section's inputs, or any of its children's inputs,
-     * are in teh form data. If any are found, returns true. Else false
-     *
-     * @param array $req_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        $req_data = $this->getCachedRequest($req_data);
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets validation errors for this form section and subsections
-     * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
-     * gets the validation errors for ALL subsection
-     *
-     * @return EE_Validation_Error[]
-     * @throws EE_Error
-     */
-    public function get_validation_errors_accumulated()
-    {
-        $validation_errors = $this->get_validation_errors();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
-            } else {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors();
-            }
-            if ($validation_errors_on_this_subsection) {
-                $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
-            }
-        }
-        return $validation_errors;
-    }
-
-    /**
-     * Fetch validation errors from children and grandchildren and puts them in a single string.
-     * This traverses the form section tree to generate this, but you probably want to instead use
-     * get_form_submission_error_message() which is usually this message cached (or a custom validation error message)
-     *
-     * @return string
-     * @since $VID:$
-     */
-    protected function getAllValidationErrorsString()
-    {
-        $submission_error_messages = array();
-        // bad, bad, bad registrant
-        foreach ($this->get_validation_errors_accumulated() as $validation_error) {
-            if ($validation_error instanceof EE_Validation_Error) {
-                $form_section = $validation_error->get_form_section();
-                if ($form_section instanceof EE_Form_Input_Base) {
-                   $label = $validation_error->get_form_section()->html_label_text();
-                } elseif($form_section instanceof EE_Form_Section_Validatable) {
-                    $label = $validation_error->get_form_section()->name();
-                } else {
-                    $label = esc_html__('Unknown', 'event_espresso');
-                }
-                $submission_error_messages[] = sprintf(
-                    __('%s : %s', 'event_espresso'),
-                    $label,
-                    $validation_error->getMessage()
-                );
-            }
-        }
-        return implode('<br', $submission_error_messages);
-    }
-
-
-    /**
-     * This isn't just the name of an input, it's a path pointing to an input. The
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
-     * dot-dot-slash (../) means to ascend into the parent section.
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
-     * which will be returned.
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
-     * Etc
-     *
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     */
-    public function find_section_from_path($form_section_path)
-    {
-        //check if we can find the input from purely going straight up the tree
-        $input = parent::find_section_from_path($form_section_path);
-        if ($input instanceof EE_Form_Section_Base) {
-            return $input;
-        }
-        $next_slash_pos = strpos($form_section_path, '/');
-        if ($next_slash_pos !== false) {
-            $child_section_name = substr($form_section_path, 0, $next_slash_pos);
-            $subpath            = substr($form_section_path, $next_slash_pos + 1);
-        } else {
-            $child_section_name = $form_section_path;
-            $subpath            = '';
-        }
-        $child_section = $this->get_subsection($child_section_name);
-        if ($child_section instanceof EE_Form_Section_Base) {
-            return $child_section->find_section_from_path($subpath);
-        }
-        return null;
-    }
+	const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
+
+	/**
+	 * Subsections
+	 *
+	 * @var EE_Form_Section_Validatable[]
+	 */
+	protected $_subsections = array();
+
+	/**
+	 * Strategy for laying out the form
+	 *
+	 * @var EE_Form_Section_Layout_Base
+	 */
+	protected $_layout_strategy;
+
+	/**
+	 * Whether or not this form has received and validated a form submission yet
+	 *
+	 * @var boolean
+	 */
+	protected $_received_submission = false;
+
+	/**
+	 * message displayed to users upon successful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_success_message = '';
+
+	/**
+	 * message displayed to users upon unsuccessful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_error_message = '';
+
+	/**
+	 * @var array like $_REQUEST
+	 */
+	protected $cached_request_data;
+
+	/**
+	 * Stores whether this form (and its sub-sections) were found to be valid or not.
+	 * Starts off as null, but once the form is validated, it set to either true or false
+	 * @var boolean|null
+	 */
+	protected $is_valid;
+
+	/**
+	 * Stores all the data that will localized for form validation
+	 *
+	 * @var array
+	 */
+	static protected $_js_localization = array();
+
+	/**
+	 * whether or not the form's localized validation JS vars have been set
+	 *
+	 * @type boolean
+	 */
+	static protected $_scripts_localized = false;
+
+
+	/**
+	 * when constructing a proper form section, calls _construct_finalize on children
+	 * so that they know who their parent is, and what name they've been given.
+	 *
+	 * @param array[] $options_array   {
+	 * @type          $subsections     EE_Form_Section_Validatable[] where keys are the section's name
+	 * @type          $include         string[] numerically-indexed where values are section names to be included,
+	 *                                 and in that order. This is handy if you want
+	 *                                 the subsections to be ordered differently than the default, and if you override
+	 *                                 which fields are shown
+	 * @type          $exclude         string[] values are subsections to be excluded. This is handy if you want
+	 *                                 to remove certain default subsections (note: if you specify BOTH 'include' AND
+	 *                                 'exclude', the inclusions will be applied first, and the exclusions will exclude
+	 *                                 items from that list of inclusions)
+	 * @type          $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
+	 *                                 } @see EE_Form_Section_Validatable::__construct()
+	 * @throws EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		$options_array = (array) apply_filters(
+			'FHEE__EE_Form_Section_Proper___construct__options_array',
+			$options_array,
+			$this
+		);
+		//call parent first, as it may be setting the name
+		parent::__construct($options_array);
+		//if they've included subsections in the constructor, add them now
+		if (isset($options_array['include'])) {
+			//we are going to make sure we ONLY have those subsections to include
+			//AND we are going to make sure they're in that specified order
+			$reordered_subsections = array();
+			foreach ($options_array['include'] as $input_name) {
+				if (isset($this->_subsections[ $input_name ])) {
+					$reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
+				}
+			}
+			$this->_subsections = $reordered_subsections;
+		}
+		if (isset($options_array['exclude'])) {
+			$exclude            = $options_array['exclude'];
+			$this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
+		}
+		if (isset($options_array['layout_strategy'])) {
+			$this->_layout_strategy = $options_array['layout_strategy'];
+		}
+		if (! $this->_layout_strategy) {
+			$this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
+		}
+		$this->_layout_strategy->_construct_finalize($this);
+		//ok so we are definitely going to want the forms JS,
+		//so enqueue it or remember to enqueue it during wp_enqueue_scripts
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			//ok so they've constructed this object after when they should have.
+			//just enqueue the generic form scripts and initialize the form immediately in the JS
+			EE_Form_Section_Proper::wp_enqueue_scripts(true);
+		} else {
+			add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+			add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+		}
+		add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
+		/**
+		 * Gives other plugins a chance to hook in before construct finalize is called.
+		 * The form probably doesn't yet have a parent form section.
+		 * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form,
+		 * assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
+		 * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
+		 *
+		 * @since 4.9.32
+		 * @param EE_Form_Section_Proper $this          before __construct is done, but all of its logic,
+		 *                                              except maybe calling _construct_finalize has been done
+		 * @param array                  $options_array options passed into the constructor
+		 */
+		do_action(
+			'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called',
+			$this,
+			$options_array
+		);
+		if (isset($options_array['name'])) {
+			$this->_construct_finalize(null, $options_array['name']);
+		}
+	}
+
+
+	/**
+	 * Finishes construction given the parent form section and this form section's name
+	 *
+	 * @param EE_Form_Section_Proper $parent_form_section
+	 * @param string                 $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		$this->_set_default_name_if_empty();
+		$this->_set_default_html_id_if_empty();
+		foreach ($this->_subsections as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Base) {
+				$subsection->_construct_finalize($this, $subsection_name);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
+							'event_espresso'
+						),
+						$subsection_name,
+						get_class($this),
+						$subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
+					)
+				);
+			}
+		}
+		/**
+		 * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
+		 * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID
+		 * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done.
+		 * This might only happen just before displaying the form, or just before it receives form submission data.
+		 * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
+		 * ensured it has a name, HTML IDs, etc
+		 *
+		 * @param EE_Form_Section_Proper      $this
+		 * @param EE_Form_Section_Proper|null $parent_form_section
+		 * @param string                      $name
+		 */
+		do_action(
+			'AHEE__EE_Form_Section_Proper___construct_finalize__end',
+			$this,
+			$parent_form_section,
+			$name
+		);
+	}
+
+
+	/**
+	 * Gets the layout strategy for this form section
+	 *
+	 * @return EE_Form_Section_Layout_Base
+	 */
+	public function get_layout_strategy()
+	{
+		return $this->_layout_strategy;
+	}
+
+
+	/**
+	 * Gets the HTML for a single input for this form section according
+	 * to the layout strategy
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function get_html_for_input($input)
+	{
+		return $this->_layout_strategy->layout_input($input);
+	}
+
+
+	/**
+	 * was_submitted - checks if form inputs are present in request data
+	 * Basically an alias for form_data_present_in() (which is used by both
+	 * proper form sections and form inputs)
+	 *
+	 * @param null $form_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function was_submitted($form_data = null)
+	{
+		return $this->form_data_present_in($form_data);
+	}
+
+	/**
+	 * Gets the cached request data; but if there is none, or $req_data was set with
+	 * something different, refresh the cache, and then return it
+	 * @param null $req_data
+	 * @return array
+	 */
+	protected function getCachedRequest($req_data = null)
+	{
+		if ($this->cached_request_data === null
+			|| (
+				$req_data !== null &&
+				$req_data !== $this->cached_request_data
+			)
+		) {
+			$req_data = apply_filters(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
+				$req_data,
+				$this
+			);
+			if ($req_data === null) {
+				$req_data = array_merge($_GET, $_POST);
+			}
+			$req_data = apply_filters(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
+				$req_data,
+				$this
+			);
+			$this->cached_request_data = (array)$req_data;
+		}
+		return $this->cached_request_data;
+	}
+
+
+	/**
+	 * After the form section is initially created, call this to sanitize the data in the submission
+	 * which relates to this form section, validate it, and set it as properties on the form.
+	 *
+	 * @param array|null $req_data should usually be $_POST (the default).
+	 *                             However, you CAN supply a different array.
+	 *                             Consider using set_defaults() instead however.
+	 *                             (If you rendered the form in the page using echo $form_x->get_html()
+	 *                             the inputs will have the correct name in the request data for this function
+	 *                             to find them and populate the form with them.
+	 *                             If you have a flat form (with only input subsections),
+	 *                             you can supply a flat array where keys
+	 *                             are the form input names and values are their values)
+	 * @param boolean    $validate whether or not to perform validation on this data. Default is,
+	 *                             of course, to validate that data, and set errors on the invalid values.
+	 *                             But if the data has already been validated
+	 *                             (eg you validated the data then stored it in the DB)
+	 *                             you may want to skip this step.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function receive_form_submission($req_data = null, $validate = true)
+	{
+		$req_data = $this->getCachedRequest($req_data);
+		$this->_normalize($req_data);
+		if ($validate) {
+			$this->_validate();
+			//if it's invalid, we're going to want to re-display so remember what they submitted
+			if (! $this->is_valid()) {
+				$this->store_submitted_form_data_in_session();
+			}
+		}
+		if ($this->submission_error_message() === '' && ! $this->is_valid()) {
+			$this->set_submission_error_message();
+		}
+		do_action(
+			'AHEE__EE_Form_Section_Proper__receive_form_submission__end',
+			$req_data,
+			$this,
+			$validate
+		);
+	}
+
+
+	/**
+	 * caches the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return boolean whether or not the data was successfully stored in the session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function store_submitted_form_data_in_session()
+	{
+		return EE_Registry::instance()->SSN->set_session_data(
+			array(
+				EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
+			)
+		);
+	}
+
+
+	/**
+	 * retrieves the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function get_submitted_form_data_from_session()
+	{
+		$session = EE_Registry::instance()->SSN;
+		if ($session instanceof EE_Session) {
+			return $session->get_session_data(
+				EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
+			);
+		}
+		return array();
+	}
+
+
+	/**
+	 * flushed the originally submitted input values from the session
+	 *
+	 * @return boolean whether or not the data was successfully removed from the session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function flush_submitted_form_data_from_session()
+	{
+		return EE_Registry::instance()->SSN->reset_data(
+			array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
+		);
+	}
+
+
+	/**
+	 * Populates this form and its subsections with data from the session.
+	 * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
+	 * validation errors when displaying too)
+	 * Returns true if the form was populated from the session, false otherwise
+	 *
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function populate_from_session()
+	{
+		$form_data_in_session = $this->get_submitted_form_data_from_session();
+		if (empty($form_data_in_session)) {
+			return false;
+		}
+		$this->receive_form_submission($form_data_in_session);
+		$this->flush_submitted_form_data_from_session();
+		if ($this->form_data_present_in($form_data_in_session)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Populates the default data for the form, given an array where keys are
+	 * the input names, and values are their values (preferably normalized to be their
+	 * proper PHP types, not all strings... although that should be ok too).
+	 * Proper subsections are sub-arrays, the key being the subsection's name, and
+	 * the value being an array formatted in teh same way
+	 *
+	 * @param array $default_data
+	 * @throws EE_Error
+	 */
+	public function populate_defaults($default_data)
+	{
+		foreach ($this->subsections(false) as $subsection_name => $subsection) {
+			if (isset($default_data[ $subsection_name ])) {
+				if ($subsection instanceof EE_Form_Input_Base) {
+					$subsection->set_default($default_data[ $subsection_name ]);
+				} elseif ($subsection instanceof EE_Form_Section_Proper) {
+					$subsection->populate_defaults($default_data[ $subsection_name ]);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * returns true if subsection exists
+	 *
+	 * @param string $name
+	 * @return boolean
+	 */
+	public function subsection_exists($name)
+	{
+		return isset($this->_subsections[ $name ]) ? true : false;
+	}
+
+
+	/**
+	 * Gets the subsection specified by its name
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
+	 *                                                      so that the inputs will be properly configured.
+	 *                                                      However, some client code may be ok
+	 *                                                      with construction finalize being called later
+	 *                                                      (realizing that the subsections' html names
+	 *                                                      might not be set yet, etc.)
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 */
+	public function get_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
+	}
+
+
+	/**
+	 * Gets all the validatable subsections of this form section
+	 *
+	 * @return EE_Form_Section_Validatable[]
+	 * @throws EE_Error
+	 */
+	public function get_validatable_subsections()
+	{
+		$validatable_subsections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Validatable) {
+				$validatable_subsections[ $name ] = $obj;
+			}
+		}
+		return $validatable_subsections;
+	}
+
+
+	/**
+	 * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
+	 * throw an EE_Error.
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function get_input($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection(
+			$name,
+			$require_construction_to_be_finalized
+		);
+		if (! $subsection instanceof EE_Form_Input_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this),
+					$subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+	/**
+	 * Like get_input(), gets the proper subsection of the form given the name,
+	 * otherwise throws an EE_Error
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection(
+			$name,
+			$require_construction_to_be_finalized
+		);
+		if (! $subsection instanceof EE_Form_Section_Proper) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this)
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+	/**
+	 * Gets the value of the specified input. Should be called after receive_form_submission()
+	 * or populate_defaults() on the form, where the normalized value on the input is set.
+	 *
+	 * @param string $name
+	 * @return mixed depending on the input's type and its normalization strategy
+	 * @throws EE_Error
+	 */
+	public function get_input_value($name)
+	{
+		$input = $this->get_input($name);
+		return $input->normalized_value();
+	}
+
+
+	/**
+	 * Checks if this form section itself is valid, and then checks its subsections
+	 *
+	 * @throws EE_Error
+	 * @return boolean
+	 */
+	public function is_valid()
+	{
+		if($this->is_valid === null) {
+			if (! $this->has_received_submission()) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'You cannot check if a form is valid before receiving the form submission using receive_form_submission',
+							'event_espresso'
+						)
+					)
+				);
+			}
+			if (! parent::is_valid()) {
+				$this->is_valid = false;
+			} else {
+				// ok so no general errors to this entire form section.
+				// so let's check the subsections, but only set errors if that hasn't been done yet
+				$this->is_valid = true;
+				foreach ($this->get_validatable_subsections() as $subsection) {
+					if (! $subsection->is_valid()) {
+						$this->is_valid = false;
+					}
+				}
+			}
+		}
+		return $this->is_valid;
+	}
+
+
+	/**
+	 * gets the default name of this form section if none is specified
+	 *
+	 * @return void
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$classname    = get_class($this);
+			$default_name = str_replace('EE_', '', $classname);
+			$this->_name  = $default_name;
+		}
+	}
+
+
+	/**
+	 * Returns the HTML for the form, except for the form opening and closing tags
+	 * (as the form section doesn't know where you necessarily want to send the information to),
+	 * and except for a submit button. Enqueues JS and CSS; if called early enough we will
+	 * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
+	 * Not doing_it_wrong because theoretically this CAN be used properly,
+	 * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
+	 * any CSS.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_html_and_js()
+	{
+		$this->enqueue_js();
+		return $this->get_html();
+	}
+
+
+	/**
+	 * returns HTML for displaying this form section. recursively calls display_section() on all subsections
+	 *
+	 * @param bool $display_previously_submitted_data
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function get_html($display_previously_submitted_data = true)
+	{
+		$this->ensure_construct_finalized_called();
+		if ($display_previously_submitted_data) {
+			$this->populate_from_session();
+		}
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
+			: $this->_layout_strategy->layout_form();
+	}
+
+
+	/**
+	 * enqueues JS and CSS for the form.
+	 * It is preferred to call this before wp_enqueue_scripts so the
+	 * scripts and styles can be put in the header, but if called later
+	 * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
+	 * only be in the header; but in HTML5 its ok in the body.
+	 * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
+	 * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function enqueue_js()
+	{
+		$this->_enqueue_and_localize_form_js();
+		foreach ($this->subsections() as $subsection) {
+			$subsection->enqueue_js();
+		}
+	}
+
+
+	/**
+	 * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
+	 * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
+	 * the wp_enqueue_scripts hook.
+	 * However, registering the form js and localizing it can happen when we
+	 * actually output the form (which is preferred, seeing how teh form's fields
+	 * could change until it's actually outputted)
+	 *
+	 * @param boolean $init_form_validation_automatically whether or not we want the form validation
+	 *                                                    to be triggered automatically or not
+	 * @return void
+	 */
+	public static function wp_enqueue_scripts($init_form_validation_automatically = true)
+	{
+		wp_register_script(
+			'ee_form_section_validation',
+			EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
+			array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_validation_init',
+			array('init' => $init_form_validation_automatically ? '1' : '0')
+		);
+	}
+
+
+	/**
+	 * gets the variables used by form_section_validation.js.
+	 * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
+	 * but before the wordpress hook wp_loaded
+	 *
+	 * @throws EE_Error
+	 */
+	public function _enqueue_and_localize_form_js()
+	{
+		$this->ensure_construct_finalized_called();
+		//actually, we don't want to localize just yet. There may be other forms on the page.
+		//so we need to add our form section data to a static variable accessible by all form sections
+		//and localize it just before the footer
+		$this->localize_validation_rules();
+		add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
+		add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
+	}
+
+
+	/**
+	 * add our form section data to a static variable accessible by all form sections
+	 *
+	 * @param bool $return_for_subsection
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function localize_validation_rules($return_for_subsection = false)
+	{
+		// we only want to localize vars ONCE for the entire form,
+		// so if the form section doesn't have a parent, then it must be the top dog
+		if ($return_for_subsection || ! $this->parent_section()) {
+			EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
+				'form_section_id'  => $this->html_id(true),
+				'validation_rules' => $this->get_jquery_validation_rules(),
+				'other_data'       => $this->get_other_js_data(),
+				'errors'           => $this->subsection_validation_errors_by_html_name(),
+			);
+			EE_Form_Section_Proper::$_scripts_localized                                = true;
+		}
+	}
+
+
+	/**
+	 * Gets an array of extra data that will be useful for client-side javascript.
+	 * This is primarily data added by inputs and forms in addition to any
+	 * scripts they might enqueue
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		foreach ($this->subsections() as $subsection) {
+			$form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+	/**
+	 * Gets a flat array of inputs for this form section and its subsections.
+	 * Keys are their form names, and values are the inputs themselves
+	 *
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function inputs_in_subsections()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection->html_name() ] = $subsection;
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs += $subsection->inputs_in_subsections();
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets a flat array of all the validation errors.
+	 * Keys are html names (because those should be unique)
+	 * and values are a string of all their validation errors
+	 *
+	 * @return string[]
+	 * @throws EE_Error
+	 */
+	public function subsection_validation_errors_by_html_name()
+	{
+		$inputs = $this->inputs();
+		$errors = array();
+		foreach ($inputs as $form_input) {
+			if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
+				$errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+			}
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
+	 * Should be setup by each form during the _enqueues_and_localize_form_js
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function localize_script_for_all_forms()
+	{
+		//allow inputs and stuff to hook in their JS and stuff here
+		do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
+		EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
+		$email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
+			? EE_Registry::instance()->CFG->registration->email_validation_level
+			: 'wp_default';
+		EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
+		wp_enqueue_script('ee_form_section_validation');
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_vars',
+			EE_Form_Section_Proper::$_js_localization
+		);
+	}
+
+
+	/**
+	 * ensure_scripts_localized
+	 *
+	 * @throws EE_Error
+	 */
+	public function ensure_scripts_localized()
+	{
+		if (! EE_Form_Section_Proper::$_scripts_localized) {
+			$this->_enqueue_and_localize_form_js();
+		}
+	}
+
+
+	/**
+	 * Gets the hard-coded validation error messages to be used in the JS. The convention
+	 * is that the key here should be the same as the custom validation rule put in the JS file
+	 *
+	 * @return array keys are custom validation rules, and values are internationalized strings
+	 */
+	private static function _get_localized_error_messages()
+	{
+		return array(
+			'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'),
+			'regex'    => esc_html__('Please check your input', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function js_localization()
+	{
+		return self::$_js_localization;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset_js_localization()
+	{
+		self::$_js_localization = array();
+	}
+
+
+	/**
+	 * Gets the JS to put inside the jquery validation rules for subsection of this form section.
+	 * See parent function for more...
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_jquery_validation_rules()
+	{
+		$jquery_validation_rules = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$jquery_validation_rules = array_merge(
+				$jquery_validation_rules,
+				$subsection->get_jquery_validation_rules()
+			);
+		}
+		return $jquery_validation_rules;
+	}
+
+
+	/**
+	 * Sanitizes all the data and sets the sanitized value of each field
+	 *
+	 * @param array $req_data like $_POST
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _normalize($req_data)
+	{
+		$this->_received_submission = true;
+		$this->_validation_errors   = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			try {
+				$subsection->_normalize($req_data);
+			} catch (EE_Validation_Error $e) {
+				$subsection->add_validation_error($e);
+			}
+		}
+	}
+
+
+	/**
+	 * Performs validation on this form section and its subsections.
+	 * For each subsection,
+	 * calls _validate_{subsection_name} on THIS form (if the function exists)
+	 * and passes it the subsection, then calls _validate on that subsection.
+	 * If you need to perform validation on the form as a whole (considering multiple)
+	 * you would be best to override this _validate method,
+	 * calling parent::_validate() first.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _validate()
+	{
+		//reset the cache of whether this form is valid or not- we're re-validating it now
+		$this->is_valid = null;
+		foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
+			if (method_exists($this, '_validate_' . $subsection_name)) {
+				call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+			}
+			$subsection->_validate();
+		}
+	}
+
+
+	/**
+	 * Gets all the validated inputs for the form section
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function valid_data()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs[ $subsection_name ] = $subsection->valid_data();
+			} elseif ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection_name ] = $subsection->normalized_value();
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets all the inputs on this form section
+	 *
+	 * @return EE_Form_Input_Base[]
+	 * @throws EE_Error
+	 */
+	public function inputs()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection_name ] = $subsection;
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets all the subsections which are a proper form
+	 *
+	 * @return EE_Form_Section_Proper[]
+	 * @throws EE_Error
+	 */
+	public function subforms()
+	{
+		$form_sections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Proper) {
+				$form_sections[ $name ] = $obj;
+			}
+		}
+		return $form_sections;
+	}
+
+
+	/**
+	 * Gets all the subsections (inputs, proper subsections, or html-only sections).
+	 * Consider using inputs() or subforms()
+	 * if you only want form inputs or proper form sections.
+	 *
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper[]
+	 * @throws EE_Error
+	 */
+	public function subsections($require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->_subsections;
+	}
+
+
+	/**
+	 * Returns whether this form has any subforms or inputs
+	 * @return bool
+	 */
+	public function hasSubsections()
+	{
+		return ! empty($this->_subsections);
+	}
+
+
+	/**
+	 * Returns a simple array where keys are input names, and values are their normalized
+	 * values. (Similar to calling get_input_value on inputs)
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function input_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(false, $include_subform_inputs, $flatten);
+	}
+
+
+	/**
+	 * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
+	 * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
+	 * is not necessarily the value we want to display to users. This creates an array
+	 * where keys are the input names, and values are their display values
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function input_pretty_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(true, $include_subform_inputs, $flatten);
+	}
+
+
+	/**
+	 * Gets the input values from the form
+	 *
+	 * @param boolean $pretty                 Whether to retrieve the pretty value,
+	 *                                        or just the normalized value
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
+	 *                                        input names (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
+	{
+		$input_values = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$input_values[ $subsection_name ] = $pretty
+					? $subsection->pretty_value()
+					: $subsection->normalized_value();
+			} elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
+				$subform_input_values = $subsection->_input_values(
+					$pretty,
+					$include_subform_inputs,
+					$flatten
+				);
+				if ($flatten) {
+					$input_values = array_merge($input_values, $subform_input_values);
+				} else {
+					$input_values[ $subsection_name ] = $subform_input_values;
+				}
+			}
+		}
+		return $input_values;
+	}
+
+
+	/**
+	 * Gets the originally submitted input values from the form
+	 *
+	 * @param boolean $include_subforms  Whether to include inputs from subforms,
+	 *                                   or just this forms' direct children inputs
+	 * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                   with array keys being input names
+	 *                                   (regardless of whether they are from a subsection or not),
+	 *                                   and if $flatten is FALSE it can be a multidimensional array
+	 *                                   where keys are always subsection names and values are either
+	 *                                   the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function submitted_values($include_subforms = false)
+	{
+		$submitted_values = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				// is this input part of an array of inputs?
+				if (strpos($subsection->html_name(), '[') !== false) {
+					$full_input_name  = EEH_Array::convert_array_values_to_keys(
+						explode(
+							'[',
+							str_replace(']', '', $subsection->html_name())
+						),
+						$subsection->raw_value()
+					);
+					$submitted_values = array_replace_recursive($submitted_values, $full_input_name);
+				} else {
+					$submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
+				$subform_input_values = $subsection->submitted_values($include_subforms);
+				$submitted_values     = array_replace_recursive($submitted_values, $subform_input_values);
+			}
+		}
+		return $submitted_values;
+	}
+
+
+	/**
+	 * Indicates whether or not this form has received a submission yet
+	 * (ie, had receive_form_submission called on it yet)
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function has_received_submission()
+	{
+		$this->ensure_construct_finalized_called();
+		return $this->_received_submission;
+	}
+
+
+	/**
+	 * Equivalent to passing 'exclude' in the constructor's options array.
+	 * Removes the listed inputs from the form
+	 *
+	 * @param array $inputs_to_exclude values are the input names
+	 * @return void
+	 */
+	public function exclude(array $inputs_to_exclude = array())
+	{
+		foreach ($inputs_to_exclude as $input_to_exclude_name) {
+			unset($this->_subsections[ $input_to_exclude_name ]);
+		}
+	}
+
+
+	/**
+	 * Changes these inputs' display strategy to be EE_Hidden_Display_Strategy.
+	 * @param array $inputs_to_hide
+	 * @throws EE_Error
+	 */
+	public function hide(array $inputs_to_hide = array())
+	{
+		foreach ($inputs_to_hide as $input_to_hide) {
+			$input = $this->get_input($input_to_hide);
+			$input->set_display_strategy(new EE_Hidden_Display_Strategy());
+		}
+	}
+
+
+	/**
+	 * add_subsections
+	 * Adds the listed subsections to the form section.
+	 * If $subsection_name_to_target is provided,
+	 * then new subsections are added before or after that subsection,
+	 * otherwise to the start or end of the entire subsections array.
+	 *
+	 * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
+	 *                                                          where keys are their names
+	 * @param string                 $subsection_name_to_target an existing for section that $new_subsections
+	 *                                                          should be added before or after
+	 *                                                          IF $subsection_name_to_target is null,
+	 *                                                          then $new_subsections will be added to
+	 *                                                          the beginning or end of the entire subsections array
+	 * @param boolean                $add_before                whether to add $new_subsections, before or after
+	 *                                                          $subsection_name_to_target,
+	 *                                                          or if $subsection_name_to_target is null,
+	 *                                                          before or after entire subsections array
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
+	{
+		foreach ($new_subsections as $subsection_name => $subsection) {
+			if (! $subsection instanceof EE_Form_Section_Base) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							"Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
+							'event_espresso'
+						),
+						get_class($subsection),
+						$subsection_name,
+						$this->name()
+					)
+				);
+				unset($new_subsections[ $subsection_name ]);
+			}
+		}
+		$this->_subsections = EEH_Array::insert_into_array(
+			$this->_subsections,
+			$new_subsections,
+			$subsection_name_to_target,
+			$add_before
+		);
+		if ($this->_construction_finalized) {
+			foreach ($this->_subsections as $name => $subsection) {
+				$subsection->_construct_finalize($this, $name);
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $subsection_name
+	 * @param bool   $recursive
+	 * @return bool
+	 */
+	public function has_subsection($subsection_name, $recursive = false)
+	{
+		foreach ($this->_subsections as $name => $subsection) {if(
+				$name === $subsection_name
+				|| (
+					$recursive
+					&& $subsection instanceof EE_Form_Section_Proper
+					&& $subsection->has_subsection($subsection_name, $recursive)
+				)
+			) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Just gets all validatable subsections to clean their sensitive data
+	 *
+	 * @throws EE_Error
+	 */
+	public function clean_sensitive_data()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$subsection->clean_sensitive_data();
+		}
+	}
+
+
+	/**
+	 * Sets the submission error message (aka validation error message for this form section and all sub-sections)
+	 * @param string                           $form_submission_error_message
+	 * @param EE_Form_Section_Validatable $form_section unused
+	 * @throws EE_Error
+	 */
+	public function set_submission_error_message(
+		$form_submission_error_message = ''
+	) {
+		$this->_form_submission_error_message = ! empty($form_submission_error_message)
+			? $form_submission_error_message
+			: $this->getAllValidationErrorsString();
+	}
+
+
+	/**
+	 * Returns the cached error message. A default value is set for this during _validate(),
+	 * (called during receive_form_submission) but it can be explicitly set using
+	 * set_submission_error_message
+	 *
+	 * @return string
+	 */
+	public function submission_error_message()
+	{
+		return $this->_form_submission_error_message;
+	}
+
+
+	/**
+	 * Sets a message to display if the data submitted to the form was valid.
+	 * @param string $form_submission_success_message
+	 */
+	public function set_submission_success_message($form_submission_success_message = '')
+	{
+		$this->_form_submission_success_message = ! empty($form_submission_success_message)
+			? $form_submission_success_message
+			: esc_html__('Form submitted successfully', 'event_espresso');
+	}
+
+
+	/**
+	 * Gets a message appropriate for display when the form is correctly submitted
+	 * @return string
+	 */
+	public function submission_success_message()
+	{
+		return $this->_form_submission_success_message;
+	}
+
+
+	/**
+	 * Returns the prefix that should be used on child of this form section for
+	 * their html names. If this form section itself has a parent, prepends ITS
+	 * prefix onto this form section's prefix. Used primarily by
+	 * EE_Form_Input_Base::_set_default_html_name_if_empty
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_name_prefix()
+	{
+		if ($this->parent_section() instanceof EE_Form_Section_Proper) {
+			return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+		}
+		return $this->name();
+	}
+
+
+	/**
+	 * Gets the name, but first checks _construct_finalize has been called. If not,
+	 * calls it (assumes there is no parent and that we want the name to be whatever
+	 * was set, which is probably nothing, or the classname)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::name();
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function parent_section()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::parent_section();
+	}
+
+
+	/**
+	 * make sure construction finalized was called, otherwise children might not be ready
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function ensure_construct_finalized_called()
+	{
+		if (! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
+		}
+	}
+
+
+	/**
+	 * Checks if any of this form section's inputs, or any of its children's inputs,
+	 * are in teh form data. If any are found, returns true. Else false
+	 *
+	 * @param array $req_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		$req_data = $this->getCachedRequest($req_data);
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets validation errors for this form section and subsections
+	 * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
+	 * gets the validation errors for ALL subsection
+	 *
+	 * @return EE_Validation_Error[]
+	 * @throws EE_Error
+	 */
+	public function get_validation_errors_accumulated()
+	{
+		$validation_errors = $this->get_validation_errors();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
+			} else {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors();
+			}
+			if ($validation_errors_on_this_subsection) {
+				$validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
+			}
+		}
+		return $validation_errors;
+	}
+
+	/**
+	 * Fetch validation errors from children and grandchildren and puts them in a single string.
+	 * This traverses the form section tree to generate this, but you probably want to instead use
+	 * get_form_submission_error_message() which is usually this message cached (or a custom validation error message)
+	 *
+	 * @return string
+	 * @since $VID:$
+	 */
+	protected function getAllValidationErrorsString()
+	{
+		$submission_error_messages = array();
+		// bad, bad, bad registrant
+		foreach ($this->get_validation_errors_accumulated() as $validation_error) {
+			if ($validation_error instanceof EE_Validation_Error) {
+				$form_section = $validation_error->get_form_section();
+				if ($form_section instanceof EE_Form_Input_Base) {
+				   $label = $validation_error->get_form_section()->html_label_text();
+				} elseif($form_section instanceof EE_Form_Section_Validatable) {
+					$label = $validation_error->get_form_section()->name();
+				} else {
+					$label = esc_html__('Unknown', 'event_espresso');
+				}
+				$submission_error_messages[] = sprintf(
+					__('%s : %s', 'event_espresso'),
+					$label,
+					$validation_error->getMessage()
+				);
+			}
+		}
+		return implode('<br', $submission_error_messages);
+	}
+
+
+	/**
+	 * This isn't just the name of an input, it's a path pointing to an input. The
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
+	 * dot-dot-slash (../) means to ascend into the parent section.
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
+	 * which will be returned.
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
+	 * Etc
+	 *
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 */
+	public function find_section_from_path($form_section_path)
+	{
+		//check if we can find the input from purely going straight up the tree
+		$input = parent::find_section_from_path($form_section_path);
+		if ($input instanceof EE_Form_Section_Base) {
+			return $input;
+		}
+		$next_slash_pos = strpos($form_section_path, '/');
+		if ($next_slash_pos !== false) {
+			$child_section_name = substr($form_section_path, 0, $next_slash_pos);
+			$subpath            = substr($form_section_path, $next_slash_pos + 1);
+		} else {
+			$child_section_name = $form_section_path;
+			$subpath            = '';
+		}
+		$child_section = $this->get_subsection($child_section_name);
+		if ($child_section instanceof EE_Form_Section_Base) {
+			return $child_section->find_section_from_path($subpath);
+		}
+		return null;
+	}
 }
 

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/EE_Error.core.php

Spacing +55 added lines, -55 removed lines

@@ -102,14 +102,14 @@ 
             default :
                 $to = get_option('admin_email');
         }
-        $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
+        $subject = $type.' '.$message.' in '.EVENT_ESPRESSO_VERSION.' on '.site_url();
         $msg = EE_Error::_format_error($type, $message, $file, $line);
         if (function_exists('wp_mail')) {
             add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
             wp_mail($to, $subject, $msg);
         }
         echo '<div id="message" class="espresso-notices error"><p>';
-        echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
+        echo $type.': '.$message.'<br />'.$file.' line '.$line;
         echo '<br /></p></div>';
     }
 
@@ -334,7 +334,7 @@ 
 	}
 </style>
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	<p>';
         }
@@ -393,14 +393,14 @@ 
                     $class_dsply = ! empty($class) ? $class : '&nbsp;';
                     $type_dsply = ! empty($type) ? $type : '&nbsp;';
                     $function_dsply = ! empty($function) ? $function : '&nbsp;';
-                    $args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
+                    $args_dsply = ! empty($args) ? '( '.$args.' )' : '';
                     $trace_details .= '
 					<tr>
-						<td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td>
-						<td align="right" class="' . $zebra . '">' . $line_dsply . '</td>
-						<td align="left" class="' . $zebra . '">' . $file_dsply . '</td>
-						<td align="left" class="' . $zebra . '">' . $class_dsply . '</td>
-						<td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td>
+						<td align="right" class="' . $zebra.'">'.$nmbr_dsply.'</td>
+						<td align="right" class="' . $zebra.'">'.$line_dsply.'</td>
+						<td align="left" class="' . $zebra.'">'.$file_dsply.'</td>
+						<td align="left" class="' . $zebra.'">'.$class_dsply.'</td>
+						<td align="left" class="' . $zebra.'">'.$type_dsply.$function_dsply.$args_dsply.'</td>
 					</tr>';
                 }
                 $trace_details .= '
@@ -409,7 +409,7 @@ 
             }
             $ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
             // add generic non-identifying messages for non-privileged users
-            if (! WP_DEBUG) {
+            if ( ! WP_DEBUG) {
                 $output .= '<span class="ee-error-user-msg-spn">'
                            . trim($ex['msg'])
                            . '</span> &nbsp; <sup>'
@@ -451,14 +451,14 @@ 
                            . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
                            . $trace_details;
-                if (! empty($class)) {
+                if ( ! empty($class)) {
                     $output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
                     $a = new ReflectionClass($class);
                     $output .= '
-						<pre>' . $a . '</pre>
+						<pre>' . $a.'</pre>
 					</div>
 				</div>';
                 }
@@ -471,7 +471,7 @@ 
         }
         // remove last linebreak
         $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	</p>';
         }
@@ -498,20 +498,20 @@ 
     private function _convert_args_to_string($arguments = array(), $array = false)
     {
         $arg_string = '';
-        if (! empty($arguments)) {
+        if ( ! empty($arguments)) {
             $args = array();
             foreach ($arguments as $arg) {
-                if (! empty($arg)) {
+                if ( ! empty($arg)) {
                     if (is_string($arg)) {
-                        $args[] = " '" . $arg . "'";
+                        $args[] = " '".$arg."'";
                     } elseif (is_array($arg)) {
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
+                        $args[] = 'ARRAY('.$this->_convert_args_to_string($arg, true);
                     } elseif ($arg === null) {
                         $args[] = ' NULL';
                     } elseif (is_bool($arg)) {
                         $args[] = ($arg) ? ' TRUE' : ' FALSE';
                     } elseif (is_object($arg)) {
-                        $args[] = ' OBJECT ' . get_class($arg);
+                        $args[] = ' OBJECT '.get_class($arg);
                     } elseif (is_resource($arg)) {
                         $args[] = get_resource_type($arg);
                     } else {
@@ -614,7 +614,7 @@ 
     {
         if (empty($msg)) {
             EE_Error::doing_it_wrong(
-                'EE_Error::add_' . $type . '()',
+                'EE_Error::add_'.$type.'()',
                 sprintf(
                     __('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
                         'event_espresso'),
@@ -650,11 +650,11 @@ 
         do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
         $msg = WP_DEBUG ? $dev_msg : $user_msg;
         // add notice if message exists
-        if (! empty($msg)) {
+        if ( ! empty($msg)) {
             // get error code
             $notice_code = EE_Error::generate_error_code($file, $func, $line);
             if (WP_DEBUG && $type === 'errors') {
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+                $msg .= '<br/><span class="tiny-text">'.$notice_code.'</span>';
             }
             // add notice. Index by code if it's not blank
             if ($notice_code) {
@@ -868,13 +868,13 @@ 
         if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
             // combine messages
             $success_messages .= implode(self::$_espresso_notices['success'], '<br />');
-            $print_scripts    = true;
+            $print_scripts = true;
         }
         // check for attention messages
         if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
             // combine messages
             $attention_messages .= implode(self::$_espresso_notices['attention'], '<br />');
-            $print_scripts      = true;
+            $print_scripts = true;
         }
         // check for error messages
         if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
@@ -883,7 +883,7 @@ 
                 : __('An error has occurred:<br />', 'event_espresso');
             // combine messages
             $error_messages .= implode(self::$_espresso_notices['errors'], '<br />');
-            $print_scripts  = true;
+            $print_scripts = true;
         }
         if ($format_output) {
             $notices = EE_Error::formatNoticesOutput(
@@ -924,16 +924,16 @@ 
         $print_scripts = false;
         // grab any notices that have been previously saved
         $notices = EE_Error::getStoredNotices();
-        if (! empty($notices)) {
+        if ( ! empty($notices)) {
             foreach ($notices as $type => $notice) {
                 if (is_array($notice) && ! empty($notice)) {
                     // make sure that existing notice type is an array
-                    self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
-                                                        && ! empty(self::$_espresso_notices[ $type ])
-                        ? self::$_espresso_notices[ $type ]
+                    self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type])
+                                                        && ! empty(self::$_espresso_notices[$type])
+                        ? self::$_espresso_notices[$type]
                         : array();
                     // add newly created notices to existing ones
-                    self::$_espresso_notices[ $type ] += $notice;
+                    self::$_espresso_notices[$type] += $notice;
                     $print_scripts = true;
                 }
             }
@@ -960,10 +960,10 @@ 
             $css_id    = is_admin() ? 'message' : 'espresso-notices-success';
             $css_class = is_admin() ? 'updated fade' : 'success fade-away';
             //showMessage( $success_messages );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
+            $notices .= '<div id="'.$css_id.'" '
+                        . 'class="espresso-notices '.$css_class.'" '
                         . 'style="display:none;">'
-                        . '<p>' . $success_messages . '</p>'
+                        . '<p>'.$success_messages.'</p>'
                         . $close
                         . '</div>';
         }
@@ -971,10 +971,10 @@ 
             $css_id    = is_admin() ? 'message' : 'espresso-notices-attention';
             $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
             //showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
+            $notices .= '<div id="'.$css_id.'" '
+                        . 'class="espresso-notices '.$css_class.'" '
                         . 'style="display:none;">'
-                        . '<p>' . $attention_messages . '</p>'
+                        . '<p>'.$attention_messages.'</p>'
                         . $close
                         . '</div>';
         }
@@ -982,10 +982,10 @@ 
             $css_id    = is_admin() ? 'message' : 'espresso-notices-error';
             $css_class = is_admin() ? 'error' : 'error fade-away';
             //showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
+            $notices .= '<div id="'.$css_id.'" '
+                        . 'class="espresso-notices '.$css_class.'" '
                         . 'style="display:none;">'
-                        . '<p>' . $error_messages . '</p>'
+                        . '<p>'.$error_messages.'</p>'
                         . $close
                         . '</div>';
         }
@@ -1003,7 +1003,7 @@ 
      */
     private static function _print_scripts($force_print = false)
     {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+        if ( ! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
             if (wp_script_is('ee_error_js', 'enqueued')) {
                 return '';
             }
@@ -1017,12 +1017,12 @@ 
             return '
 <script>
 /* <![CDATA[ */
-var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
+var ee_settings = {"wp_debug":"' . WP_DEBUG.'"};
 /* ]]> */
 </script>
-<script src="' . includes_url() . 'js/jquery/jquery.js" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
+<script src="' . includes_url().'js/jquery/jquery.js" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
 ';
         }
         return '';
@@ -1053,8 +1053,8 @@ 
     {
         $file       = explode('.', basename($file));
         $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
+        $error_code .= ! empty($func) ? ' - '.$func : '';
+        $error_code .= ! empty($line) ? ' - '.$line : '';
         return $error_code;
     }
 
@@ -1074,18 +1074,18 @@ 
         if (empty($ex)) {
             return;
         }
-        if (! $time) {
+        if ( ! $time) {
             $time = time();
         }
         $exception_log = '----------------------------------------------------------------------------------------'
                          . PHP_EOL;
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
-        $exception_log .= $ex['string'] . PHP_EOL;
+        $exception_log .= '['.date('Y-m-d H:i:s', $time).']  Exception Details'.PHP_EOL;
+        $exception_log .= 'Message: '.$ex['msg'].PHP_EOL;
+        $exception_log .= 'Code: '.$ex['code'].PHP_EOL;
+        $exception_log .= 'File: '.$ex['file'].PHP_EOL;
+        $exception_log .= 'Line No: '.$ex['line'].PHP_EOL;
+        $exception_log .= 'Stack trace: '.PHP_EOL;
+        $exception_log .= $ex['string'].PHP_EOL;
         $exception_log .= '----------------------------------------------------------------------------------------'
                           . PHP_EOL;
         try {
@@ -1258,14 +1258,14 @@ 
     // js for error handling
     wp_register_script(
         'espresso_core',
-        EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+        EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
         array('jquery'),
         EVENT_ESPRESSO_VERSION,
         false
     );
     wp_register_script(
         'ee_error_js',
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+        EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js',
         array('espresso_core'),
         EVENT_ESPRESSO_VERSION,
         false

Indentation +1142 added lines, -1142 removed lines

@@ -11,8 +11,8 @@ 
 // if you're a dev and want to receive all errors via email
 // add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE );
 if (defined('WP_DEBUG') && WP_DEBUG === true && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === true) {
-    set_error_handler(array('EE_Error', 'error_handler'));
-    register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
+	set_error_handler(array('EE_Error', 'error_handler'));
+	register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
 }
 
 
@@ -27,258 +27,258 @@ 
 class EE_Error extends Exception
 {
 
-    const OPTIONS_KEY_NOTICES = 'ee_notices';
-
-
-    /**
-     * name of the file to log exceptions to
-     *
-     * @var string
-     */
-    private static $_exception_log_file = 'espresso_error_log.txt';
-
-    /**
-     *    stores details for all exception
-     *
-     * @var array
-     */
-    private static $_all_exceptions = array();
-
-    /**
-     *    tracks number of errors
-     *
-     * @var int
-     */
-    private static $_error_count = 0;
-
-    /**
-     * @var array $_espresso_notices
-     */
-    private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
-
-
-
-    /**
-     * @override default exception handling
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($message, $code = 0, Exception $previous = null)
-    {
-        if (version_compare(PHP_VERSION, '5.3.0', '<')) {
-            parent::__construct($message, $code);
-        } else {
-            parent::__construct($message, $code, $previous);
-        }
-    }
-
-
-    /**
-     *    error_handler
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return void
-     */
-    public static function error_handler($code, $message, $file, $line)
-    {
-        $type = EE_Error::error_type($code);
-        $site = site_url();
-        switch ($site) {
-            case 'http://ee4.eventespresso.com/' :
-            case 'http://ee4decaf.eventespresso.com/' :
-            case 'http://ee4hf.eventespresso.com/' :
-            case 'http://ee4a.eventespresso.com/' :
-            case 'http://ee4ad.eventespresso.com/' :
-            case 'http://ee4b.eventespresso.com/' :
-            case 'http://ee4bd.eventespresso.com/' :
-            case 'http://ee4d.eventespresso.com/' :
-            case 'http://ee4dd.eventespresso.com/' :
-                $to = 'developers@eventespresso.com';
-                break;
-            default :
-                $to = get_option('admin_email');
-        }
-        $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
-        $msg = EE_Error::_format_error($type, $message, $file, $line);
-        if (function_exists('wp_mail')) {
-            add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
-            wp_mail($to, $subject, $msg);
-        }
-        echo '<div id="message" class="espresso-notices error"><p>';
-        echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
-        echo '<br /></p></div>';
-    }
-
-
-
-    /**
-     * error_type
-     * http://www.php.net/manual/en/errorfunc.constants.php#109430
-     *
-     * @param $code
-     * @return string
-     */
-    public static function error_type($code)
-    {
-        switch ($code) {
-            case E_ERROR: // 1 //
-                return 'E_ERROR';
-            case E_WARNING: // 2 //
-                return 'E_WARNING';
-            case E_PARSE: // 4 //
-                return 'E_PARSE';
-            case E_NOTICE: // 8 //
-                return 'E_NOTICE';
-            case E_CORE_ERROR: // 16 //
-                return 'E_CORE_ERROR';
-            case E_CORE_WARNING: // 32 //
-                return 'E_CORE_WARNING';
-            case E_COMPILE_ERROR: // 64 //
-                return 'E_COMPILE_ERROR';
-            case E_COMPILE_WARNING: // 128 //
-                return 'E_COMPILE_WARNING';
-            case E_USER_ERROR: // 256 //
-                return 'E_USER_ERROR';
-            case E_USER_WARNING: // 512 //
-                return 'E_USER_WARNING';
-            case E_USER_NOTICE: // 1024 //
-                return 'E_USER_NOTICE';
-            case E_STRICT: // 2048 //
-                return 'E_STRICT';
-            case E_RECOVERABLE_ERROR: // 4096 //
-                return 'E_RECOVERABLE_ERROR';
-            case E_DEPRECATED: // 8192 //
-                return 'E_DEPRECATED';
-            case E_USER_DEPRECATED: // 16384 //
-                return 'E_USER_DEPRECATED';
-            case E_ALL: // 16384 //
-                return 'E_ALL';
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    fatal_error_handler
-     *
-     * @return void
-     */
-    public static function fatal_error_handler()
-    {
-        $last_error = error_get_last();
-        if ($last_error['type'] === E_ERROR) {
-            EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
-        }
-    }
-
-
-
-    /**
-     * _format_error
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return string
-     */
-    private static function _format_error($code, $message, $file, $line)
-    {
-        $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
-        $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
-        $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
-        $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
-        $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
-        $html .= '</tbody></table>';
-        return $html;
-    }
-
-
-
-    /**
-     * set_content_type
-     *
-     * @param $content_type
-     * @return string
-     */
-    public static function set_content_type($content_type)
-    {
-        return 'text/html';
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_error()
-    {
-        if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
-            throw $this;
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $this->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add details to _all_exceptions array
-        $x_time = time();
-        self::$_all_exceptions[$x_time]['name'] = get_class($this);
-        self::$_all_exceptions[$x_time]['file'] = $this->getFile();
-        self::$_all_exceptions[$x_time]['line'] = $this->getLine();
-        self::$_all_exceptions[$x_time]['msg'] = $msg;
-        self::$_all_exceptions[$x_time]['code'] = $this->getCode();
-        self::$_all_exceptions[$x_time]['trace'] = $this->getTrace();
-        self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
-        self::$_error_count++;
-        //add_action( 'shutdown', array( $this, 'display_errors' ));
-        $this->display_errors();
-    }
-
-
-    /**
-     * @param bool   $check_stored
-     * @param string $type_to_check
-     * @return bool
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function has_error($check_stored = false, $type_to_check = 'errors')
-    {
-        $has_error = isset(self::$_espresso_notices[$type_to_check])
-                     && ! empty(self::$_espresso_notices[$type_to_check])
-            ? true
-            : false;
-        if ($check_stored && ! $has_error) {
-            $notices = EE_Error::getStoredNotices();
-            foreach ($notices as $type => $notice) {
-                if ($type === $type_to_check && $notice) {
-                    return true;
-                }
-            }
-        }
-        return $has_error;
-    }
-
-
-
-    /**
-     * @echo string
-     * @throws \ReflectionException
-     */
-    public function display_errors()
-    {
-        $trace_details = '';
-        $output = '
+	const OPTIONS_KEY_NOTICES = 'ee_notices';
+
+
+	/**
+	 * name of the file to log exceptions to
+	 *
+	 * @var string
+	 */
+	private static $_exception_log_file = 'espresso_error_log.txt';
+
+	/**
+	 *    stores details for all exception
+	 *
+	 * @var array
+	 */
+	private static $_all_exceptions = array();
+
+	/**
+	 *    tracks number of errors
+	 *
+	 * @var int
+	 */
+	private static $_error_count = 0;
+
+	/**
+	 * @var array $_espresso_notices
+	 */
+	private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
+
+
+
+	/**
+	 * @override default exception handling
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($message, $code = 0, Exception $previous = null)
+	{
+		if (version_compare(PHP_VERSION, '5.3.0', '<')) {
+			parent::__construct($message, $code);
+		} else {
+			parent::__construct($message, $code, $previous);
+		}
+	}
+
+
+	/**
+	 *    error_handler
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return void
+	 */
+	public static function error_handler($code, $message, $file, $line)
+	{
+		$type = EE_Error::error_type($code);
+		$site = site_url();
+		switch ($site) {
+			case 'http://ee4.eventespresso.com/' :
+			case 'http://ee4decaf.eventespresso.com/' :
+			case 'http://ee4hf.eventespresso.com/' :
+			case 'http://ee4a.eventespresso.com/' :
+			case 'http://ee4ad.eventespresso.com/' :
+			case 'http://ee4b.eventespresso.com/' :
+			case 'http://ee4bd.eventespresso.com/' :
+			case 'http://ee4d.eventespresso.com/' :
+			case 'http://ee4dd.eventespresso.com/' :
+				$to = 'developers@eventespresso.com';
+				break;
+			default :
+				$to = get_option('admin_email');
+		}
+		$subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
+		$msg = EE_Error::_format_error($type, $message, $file, $line);
+		if (function_exists('wp_mail')) {
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+			wp_mail($to, $subject, $msg);
+		}
+		echo '<div id="message" class="espresso-notices error"><p>';
+		echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
+		echo '<br /></p></div>';
+	}
+
+
+
+	/**
+	 * error_type
+	 * http://www.php.net/manual/en/errorfunc.constants.php#109430
+	 *
+	 * @param $code
+	 * @return string
+	 */
+	public static function error_type($code)
+	{
+		switch ($code) {
+			case E_ERROR: // 1 //
+				return 'E_ERROR';
+			case E_WARNING: // 2 //
+				return 'E_WARNING';
+			case E_PARSE: // 4 //
+				return 'E_PARSE';
+			case E_NOTICE: // 8 //
+				return 'E_NOTICE';
+			case E_CORE_ERROR: // 16 //
+				return 'E_CORE_ERROR';
+			case E_CORE_WARNING: // 32 //
+				return 'E_CORE_WARNING';
+			case E_COMPILE_ERROR: // 64 //
+				return 'E_COMPILE_ERROR';
+			case E_COMPILE_WARNING: // 128 //
+				return 'E_COMPILE_WARNING';
+			case E_USER_ERROR: // 256 //
+				return 'E_USER_ERROR';
+			case E_USER_WARNING: // 512 //
+				return 'E_USER_WARNING';
+			case E_USER_NOTICE: // 1024 //
+				return 'E_USER_NOTICE';
+			case E_STRICT: // 2048 //
+				return 'E_STRICT';
+			case E_RECOVERABLE_ERROR: // 4096 //
+				return 'E_RECOVERABLE_ERROR';
+			case E_DEPRECATED: // 8192 //
+				return 'E_DEPRECATED';
+			case E_USER_DEPRECATED: // 16384 //
+				return 'E_USER_DEPRECATED';
+			case E_ALL: // 16384 //
+				return 'E_ALL';
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    fatal_error_handler
+	 *
+	 * @return void
+	 */
+	public static function fatal_error_handler()
+	{
+		$last_error = error_get_last();
+		if ($last_error['type'] === E_ERROR) {
+			EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
+		}
+	}
+
+
+
+	/**
+	 * _format_error
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return string
+	 */
+	private static function _format_error($code, $message, $file, $line)
+	{
+		$html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
+		$html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
+		$html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
+		$html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
+		$html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
+		$html .= '</tbody></table>';
+		return $html;
+	}
+
+
+
+	/**
+	 * set_content_type
+	 *
+	 * @param $content_type
+	 * @return string
+	 */
+	public static function set_content_type($content_type)
+	{
+		return 'text/html';
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_error()
+	{
+		if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
+			throw $this;
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $this->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add details to _all_exceptions array
+		$x_time = time();
+		self::$_all_exceptions[$x_time]['name'] = get_class($this);
+		self::$_all_exceptions[$x_time]['file'] = $this->getFile();
+		self::$_all_exceptions[$x_time]['line'] = $this->getLine();
+		self::$_all_exceptions[$x_time]['msg'] = $msg;
+		self::$_all_exceptions[$x_time]['code'] = $this->getCode();
+		self::$_all_exceptions[$x_time]['trace'] = $this->getTrace();
+		self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
+		self::$_error_count++;
+		//add_action( 'shutdown', array( $this, 'display_errors' ));
+		$this->display_errors();
+	}
+
+
+	/**
+	 * @param bool   $check_stored
+	 * @param string $type_to_check
+	 * @return bool
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function has_error($check_stored = false, $type_to_check = 'errors')
+	{
+		$has_error = isset(self::$_espresso_notices[$type_to_check])
+					 && ! empty(self::$_espresso_notices[$type_to_check])
+			? true
+			: false;
+		if ($check_stored && ! $has_error) {
+			$notices = EE_Error::getStoredNotices();
+			foreach ($notices as $type => $notice) {
+				if ($type === $type_to_check && $notice) {
+					return true;
+				}
+			}
+		}
+		return $has_error;
+	}
+
+
+
+	/**
+	 * @echo string
+	 * @throws \ReflectionException
+	 */
+	public function display_errors()
+	{
+		$trace_details = '';
+		$output = '
 <style type="text/css">
 	#ee-error-message {
 		max-width:90% !important;
@@ -334,21 +334,21 @@ 
 	}
 </style>
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
-            $output .= '
+		if (! WP_DEBUG) {
+			$output .= '
 	<p>';
-        }
-        // cycle thru errors
-        foreach (self::$_all_exceptions as $time => $ex) {
-            $error_code = '';
-            // process trace info
-            if (empty($ex['trace'])) {
-                $trace_details .= __(
-                    'Sorry, but no trace information was available for this exception.',
-                    'event_espresso'
-                );
-            } else {
-                $trace_details .= '
+		}
+		// cycle thru errors
+		foreach (self::$_all_exceptions as $time => $ex) {
+			$error_code = '';
+			// process trace info
+			if (empty($ex['trace'])) {
+				$trace_details .= __(
+					'Sorry, but no trace information was available for this exception.',
+					'event_espresso'
+				);
+			} else {
+				$trace_details .= '
 			<div id="ee-trace-details">
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
 				<tr>
@@ -358,43 +358,43 @@ 
 					<th scope="col" align="left">Class</th>
 					<th scope="col" align="left">Method( arguments )</th>
 				</tr>';
-                $last_on_stack = count($ex['trace']) - 1;
-                // reverse array so that stack is in proper chronological order
-                $sorted_trace = array_reverse($ex['trace']);
-                foreach ($sorted_trace as $nmbr => $trace) {
-                    $file = isset($trace['file']) ? $trace['file'] : '';
-                    $class = isset($trace['class']) ? $trace['class'] : '';
-                    $type = isset($trace['type']) ? $trace['type'] : '';
-                    $function = isset($trace['function']) ? $trace['function'] : '';
-                    $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                    $line = isset($trace['line']) ? $trace['line'] : '';
-                    $zebra = ($nmbr % 2) ? ' odd' : '';
-                    if (empty($file) && ! empty($class)) {
-                        $a = new ReflectionClass($class);
-                        $file = $a->getFileName();
-                        if (empty($line) && ! empty($function)) {
-                            try {
-                                //if $function is a closure, this throws an exception
-                                $b = new ReflectionMethod($class, $function);
-                                $line = $b->getStartLine();
-                            } catch (Exception $closure_exception) {
-                                $line = 'unknown';
-                            }
-                        }
-                    }
-                    if ($nmbr === $last_on_stack) {
-                        $file = $ex['file'] !== '' ? $ex['file'] : $file;
-                        $line = $ex['line'] !== '' ? $ex['line'] : $line;
-                        $error_code = self::generate_error_code($file, $trace['function'], $line);
-                    }
-                    $nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
-                    $line_dsply = ! empty($line) ? $line : '&nbsp;';
-                    $file_dsply = ! empty($file) ? $file : '&nbsp;';
-                    $class_dsply = ! empty($class) ? $class : '&nbsp;';
-                    $type_dsply = ! empty($type) ? $type : '&nbsp;';
-                    $function_dsply = ! empty($function) ? $function : '&nbsp;';
-                    $args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
-                    $trace_details .= '
+				$last_on_stack = count($ex['trace']) - 1;
+				// reverse array so that stack is in proper chronological order
+				$sorted_trace = array_reverse($ex['trace']);
+				foreach ($sorted_trace as $nmbr => $trace) {
+					$file = isset($trace['file']) ? $trace['file'] : '';
+					$class = isset($trace['class']) ? $trace['class'] : '';
+					$type = isset($trace['type']) ? $trace['type'] : '';
+					$function = isset($trace['function']) ? $trace['function'] : '';
+					$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+					$line = isset($trace['line']) ? $trace['line'] : '';
+					$zebra = ($nmbr % 2) ? ' odd' : '';
+					if (empty($file) && ! empty($class)) {
+						$a = new ReflectionClass($class);
+						$file = $a->getFileName();
+						if (empty($line) && ! empty($function)) {
+							try {
+								//if $function is a closure, this throws an exception
+								$b = new ReflectionMethod($class, $function);
+								$line = $b->getStartLine();
+							} catch (Exception $closure_exception) {
+								$line = 'unknown';
+							}
+						}
+					}
+					if ($nmbr === $last_on_stack) {
+						$file = $ex['file'] !== '' ? $ex['file'] : $file;
+						$line = $ex['line'] !== '' ? $ex['line'] : $line;
+						$error_code = self::generate_error_code($file, $trace['function'], $line);
+					}
+					$nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
+					$line_dsply = ! empty($line) ? $line : '&nbsp;';
+					$file_dsply = ! empty($file) ? $file : '&nbsp;';
+					$class_dsply = ! empty($class) ? $class : '&nbsp;';
+					$type_dsply = ! empty($type) ? $type : '&nbsp;';
+					$function_dsply = ! empty($function) ? $function : '&nbsp;';
+					$args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
+					$trace_details .= '
 					<tr>
 						<td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td>
 						<td align="right" class="' . $zebra . '">' . $line_dsply . '</td>
@@ -402,633 +402,633 @@ 
 						<td align="left" class="' . $zebra . '">' . $class_dsply . '</td>
 						<td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td>
 					</tr>';
-                }
-                $trace_details .= '
+				}
+				$trace_details .= '
 			 </table>
 			</div>';
-            }
-            $ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
-            // add generic non-identifying messages for non-privileged users
-            if (! WP_DEBUG) {
-                $output .= '<span class="ee-error-user-msg-spn">'
-                           . trim($ex['msg'])
-                           . '</span> &nbsp; <sup>'
-                           . $ex['code']
-                           . '</sup><br />';
-            } else {
-                // or helpful developer messages if debugging is on
-                $output .= '
+			}
+			$ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
+			// add generic non-identifying messages for non-privileged users
+			if (! WP_DEBUG) {
+				$output .= '<span class="ee-error-user-msg-spn">'
+						   . trim($ex['msg'])
+						   . '</span> &nbsp; <sup>'
+						   . $ex['code']
+						   . '</sup><br />';
+			} else {
+				// or helpful developer messages if debugging is on
+				$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
 				<strong class="ee-error-dev-msg-str">An '
-                           . $ex['name']
-                           . ' exception was thrown!</strong>  &nbsp; <span>code: '
-                           . $ex['code']
-                           . '</span><br />
+						   . $ex['name']
+						   . ' exception was thrown!</strong>  &nbsp; <span>code: '
+						   . $ex['code']
+						   . '</span><br />
 				<span class="big-text">"'
-                           . trim($ex['msg'])
-                           . '"</span><br/>
+						   . trim($ex['msg'])
+						   . '"</span><br/>
 				<a id="display-ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '">
+						   . self::$_error_count
+						   . $time
+						   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
+						   . self::$_error_count
+						   . $time
+						   . '">
 					'
-                           . __('click to view backtrace and class/method details', 'event_espresso')
-                           . '
+						   . __('click to view backtrace and class/method details', 'event_espresso')
+						   . '
 				</a><br />
 				<span class="small-text lt-grey-text">'
-                           . $ex['file']
-                           . ' &nbsp; ( line no: '
-                           . $ex['line']
-                           . ' )</span>
+						   . $ex['file']
+						   . ' &nbsp; ( line no: '
+						   . $ex['line']
+						   . ' )</span>
 			</p>
 			<div id="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '-dv" class="ee-error-trace-dv" style="display: none;">
+						   . self::$_error_count
+						   . $time
+						   . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
-                           . $trace_details;
-                if (! empty($class)) {
-                    $output .= '
+						   . $trace_details;
+				if (! empty($class)) {
+					$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
-                    $a = new ReflectionClass($class);
-                    $output .= '
+					$a = new ReflectionClass($class);
+					$output .= '
 						<pre>' . $a . '</pre>
 					</div>
 				</div>';
-                }
-                $output .= '
+				}
+				$output .= '
 			</div>
 		</div>
 		<br />';
-            }
-            $this->write_to_error_log($time, $ex);
-        }
-        // remove last linebreak
-        $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
-            $output .= '
+			}
+			$this->write_to_error_log($time, $ex);
+		}
+		// remove last linebreak
+		$output = substr($output, 0, -6);
+		if (! WP_DEBUG) {
+			$output .= '
 	</p>';
-        }
-        $output .= '
+		}
+		$output .= '
 </div>';
-        $output .= self::_print_scripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output));
-            exit();
-        }
-        echo $output;
-        die();
-    }
-
-
-
-    /**
-     *    generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $array = false)
-    {
-        $arg_string = '';
-        if (! empty($arguments)) {
-            $args = array();
-            foreach ($arguments as $arg) {
-                if (! empty($arg)) {
-                    if (is_string($arg)) {
-                        $args[] = " '" . $arg . "'";
-                    } elseif (is_array($arg)) {
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
-                    } elseif ($arg === null) {
-                        $args[] = ' NULL';
-                    } elseif (is_bool($arg)) {
-                        $args[] = ($arg) ? ' TRUE' : ' FALSE';
-                    } elseif (is_object($arg)) {
-                        $args[] = ' OBJECT ' . get_class($arg);
-                    } elseif (is_resource($arg)) {
-                        $args[] = get_resource_type($arg);
-                    } else {
-                        $args[] = $arg;
-                    }
-                }
-            }
-            $arg_string = implode(', ', $args);
-        }
-        if ($array) {
-            $arg_string .= ' )';
-        }
-        return $arg_string;
-    }
-
-
-
-    /**
-     *    add error message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_error($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('errors', $msg, $file, $func, $line);
-        self::$_error_count++;
-    }
-
-
-
-    /**
-     * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
-     * adds an error
-     *
-     * @param string $msg
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws EE_Error
-     */
-    public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
-    {
-        if (WP_DEBUG) {
-            throw new EE_Error($msg);
-        }
-        EE_Error::add_error($msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add success message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_success($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('success', $msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     *    add attention message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_attention($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('attention', $msg, $file, $func, $line);
-    }
-
-
-
-    /**
-     * @param string $type whether the message is for a success or error notification
-     * @param string $msg the message to display to users or developers
-     *                    - adding a double pipe || (OR) creates separate messages for user || dev
-     * @param string $file the file that the error occurred in - just use __FILE__
-     * @param string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param string $line the line number where the error occurred - just use __LINE__
-     * @return void
-     */
-    private static function _add_notice($type = 'success', $msg = '', $file = '', $func = '', $line = '')
-    {
-        if (empty($msg)) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_' . $type . '()',
-                sprintf(
-                    __('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
-                        'event_espresso'),
-                    $type,
-                    $file,
-                    $line
-                ),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_error()',
-                __('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
-                    'event_espresso'),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        // get separate user and developer messages if they exist
-        $msg      = explode('||', $msg);
-        $user_msg = $msg[0];
-        $dev_msg  = isset($msg[1]) ? $msg[1] : $msg[0];
-        /**
-         * Do an action so other code can be triggered when a notice is created
-         *
-         * @param string $type     can be 'errors', 'attention', or 'success'
-         * @param string $user_msg message displayed to user when WP_DEBUG is off
-         * @param string $user_msg message displayed to user when WP_DEBUG is on
-         * @param string $file     file where error was generated
-         * @param string $func     function where error was generated
-         * @param string $line     line where error was generated
-         */
-        do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add notice if message exists
-        if (! empty($msg)) {
-            // get error code
-            $notice_code = EE_Error::generate_error_code($file, $func, $line);
-            if (WP_DEBUG && $type === 'errors') {
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
-            }
-            // add notice. Index by code if it's not blank
-            if ($notice_code) {
-                self::$_espresso_notices[$type][$notice_code] = $msg;
-            } else {
-                self::$_espresso_notices[$type][] = $msg;
-            }
-            add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
-        }
-    }
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing success messages
-     *
-     * @return        void
-     */
-    public static function overwrite_success()
-    {
-        self::$_espresso_notices['success'] = false;
-    }
-
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing attention messages
-     *
-     * @return void
-     */
-    public static function overwrite_attention()
-    {
-        self::$_espresso_notices['attention'] = false;
-    }
-
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing error messages
-     *
-     * @return void
-     */
-    public static function overwrite_errors()
-    {
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function reset_notices()
-    {
-        self::$_espresso_notices['success']   = false;
-        self::$_espresso_notices['attention'] = false;
-        self::$_espresso_notices['errors']    = false;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public static function has_notices()
-    {
-        $has_notices = 0;
-        // check for success messages
-        $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])
-            ? 3
-            : $has_notices;
-        // check for attention messages
-        $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])
-            ? 2
-            : $has_notices;
-        // check for error messages
-        $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])
-            ? 1
-            : $has_notices;
-        return $has_notices;
-    }
-
-
-    /**
-     * This simply returns non formatted error notices as they were sent into the EE_Error object.
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function get_vanilla_notices()
-    {
-        return array(
-            'success'   => isset(self::$_espresso_notices['success'])
-                ? self::$_espresso_notices['success']
-                : array(),
-            'attention' => isset(self::$_espresso_notices['attention'])
-                ? self::$_espresso_notices['attention']
-                : array(),
-            'errors'    => isset(self::$_espresso_notices['errors'])
-                ? self::$_espresso_notices['errors']
-                : array(),
-        );
-    }
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getStoredNotices()
-    {
-        if ($user_id = get_current_user_id()) {
-            // get notices for logged in user
-            $notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id);
-            return is_array($notices) ? $notices : array();
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // get notices for user currently engaged in a session
-            $session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES);
-            return is_array($session_data) ? $session_data : array();
-        }
-        // get global notices and hope they apply to the current site visitor
-        $notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, array());
-        return is_array($notices) ? $notices : array();
-    }
-
-
-    /**
-     * @param array $notices
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function storeNotices(array $notices)
-    {
-        if ($user_id = get_current_user_id()) {
-            // store notices for logged in user
-            return (bool) update_user_option(
-                $user_id,
-                EE_Error::OPTIONS_KEY_NOTICES,
-                $notices
-            );
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // store notices for user currently engaged in a session
-            return EE_Session::instance()->set_session_data(
-                array(EE_Error::OPTIONS_KEY_NOTICES => $notices)
-            );
-        }
-        // store global notices and hope they apply to the same site visitor on the next request
-        return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices);
-    }
-
-
-    /**
-     * @return bool|TRUE
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function clearNotices()
-    {
-        if ($user_id = get_current_user_id()) {
-            // clear notices for logged in user
-            return (bool) update_user_option(
-                $user_id,
-                EE_Error::OPTIONS_KEY_NOTICES,
-                array()
-            );
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // clear notices for user currently engaged in a session
-            return EE_Session::instance()->reset_data(EE_Error::OPTIONS_KEY_NOTICES);
-        }
-        // clear global notices and hope none belonged to some for some other site visitor
-        return update_option(EE_Error::OPTIONS_KEY_NOTICES, array());
-    }
-
-
-    /**
-     * saves notices to the db for retrieval on next request
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function stashNoticesBeforeRedirect()
-    {
-        EE_Error::get_notices(false, true);
-    }
-
-
-    /**
-     * compile all error or success messages into one string
-     *
-     * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
-     * @param boolean $format_output            whether or not to format the messages for display in the WP admin
-     * @param boolean $save_to_transient        whether or not to save notices to the db for retrieval on next request
-     *                                          - ONLY do this just before redirecting
-     * @param boolean $remove_empty             whether or not to unset empty messages
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
-    {
-        $success_messages   = '';
-        $attention_messages = '';
-        $error_messages     = '';
-        // either save notices to the db
-        if ($save_to_transient || isset($_REQUEST['activate-selected'])) {
-            self::$_espresso_notices = array_merge(
-                EE_Error::getStoredNotices(),
-                self::$_espresso_notices
-            );
-            EE_Error::storeNotices(self::$_espresso_notices);
-            return array();
-        }
-        $print_scripts = EE_Error::combineExistingAndNewNotices();
-        // check for success messages
-        if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
-            // combine messages
-            $success_messages .= implode(self::$_espresso_notices['success'], '<br />');
-            $print_scripts    = true;
-        }
-        // check for attention messages
-        if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
-            // combine messages
-            $attention_messages .= implode(self::$_espresso_notices['attention'], '<br />');
-            $print_scripts      = true;
-        }
-        // check for error messages
-        if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
-            $error_messages .= count(self::$_espresso_notices['errors']) > 1
-                ? __('The following errors have occurred:<br />', 'event_espresso')
-                : __('An error has occurred:<br />', 'event_espresso');
-            // combine messages
-            $error_messages .= implode(self::$_espresso_notices['errors'], '<br />');
-            $print_scripts  = true;
-        }
-        if ($format_output) {
-            $notices = EE_Error::formatNoticesOutput(
-                $success_messages,
-                $attention_messages,
-                $error_messages
-            );
-        } else {
-            $notices = array(
-                'success'   => $success_messages,
-                'attention' => $attention_messages,
-                'errors'    => $error_messages,
-            );
-            if ($remove_empty) {
-                // remove empty notices
-                foreach ($notices as $type => $notice) {
-                    if (empty($notice)) {
-                        unset($notices[$type]);
-                    }
-                }
-            }
-        }
-        if ($print_scripts) {
-            self::_print_scripts();
-        }
-        return $notices;
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function combineExistingAndNewNotices()
-    {
-        $print_scripts = false;
-        // grab any notices that have been previously saved
-        $notices = EE_Error::getStoredNotices();
-        if (! empty($notices)) {
-            foreach ($notices as $type => $notice) {
-                if (is_array($notice) && ! empty($notice)) {
-                    // make sure that existing notice type is an array
-                    self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
-                                                        && ! empty(self::$_espresso_notices[ $type ])
-                        ? self::$_espresso_notices[ $type ]
-                        : array();
-                    // add newly created notices to existing ones
-                    self::$_espresso_notices[ $type ] += $notice;
-                    $print_scripts = true;
-                }
-            }
-            // now clear any stored notices
-            EE_Error::clearNotices();
-        }
-        return $print_scripts;
-    }
-
-
-    /**
-     * @param string $success_messages
-     * @param string $attention_messages
-     * @param string $error_messages
-     * @return string
-     */
-    private static function formatNoticesOutput($success_messages, $attention_messages, $error_messages)
-    {
-        $notices = '<div id="espresso-notices">';
-        $close   = is_admin()
-            ? ''
-            : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>';
-        if ($success_messages !== '') {
-            $css_id    = is_admin() ? 'message' : 'espresso-notices-success';
-            $css_class = is_admin() ? 'updated fade' : 'success fade-away';
-            //showMessage( $success_messages );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $success_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        if ($attention_messages !== '') {
-            $css_id    = is_admin() ? 'message' : 'espresso-notices-attention';
-            $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
-            //showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $attention_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        if ($error_messages !== '') {
-            $css_id    = is_admin() ? 'message' : 'espresso-notices-error';
-            $css_class = is_admin() ? 'error' : 'error fade-away';
-            //showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $error_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        $notices .= '</div>';
-        return $notices;
-    }
-
-
-
-    /**
-     * _print_scripts
-     *
-     * @param    bool $force_print
-     * @return    string
-     */
-    private static function _print_scripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            if (wp_script_is('ee_error_js', 'enqueued')) {
-                return '';
-            }
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script('ee_error_js');
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
-            }
-        } else {
-            return '
+		$output .= self::_print_scripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output));
+			exit();
+		}
+		echo $output;
+		die();
+	}
+
+
+
+	/**
+	 *    generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $array = false)
+	{
+		$arg_string = '';
+		if (! empty($arguments)) {
+			$args = array();
+			foreach ($arguments as $arg) {
+				if (! empty($arg)) {
+					if (is_string($arg)) {
+						$args[] = " '" . $arg . "'";
+					} elseif (is_array($arg)) {
+						$args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
+					} elseif ($arg === null) {
+						$args[] = ' NULL';
+					} elseif (is_bool($arg)) {
+						$args[] = ($arg) ? ' TRUE' : ' FALSE';
+					} elseif (is_object($arg)) {
+						$args[] = ' OBJECT ' . get_class($arg);
+					} elseif (is_resource($arg)) {
+						$args[] = get_resource_type($arg);
+					} else {
+						$args[] = $arg;
+					}
+				}
+			}
+			$arg_string = implode(', ', $args);
+		}
+		if ($array) {
+			$arg_string .= ' )';
+		}
+		return $arg_string;
+	}
+
+
+
+	/**
+	 *    add error message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_error($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('errors', $msg, $file, $func, $line);
+		self::$_error_count++;
+	}
+
+
+
+	/**
+	 * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
+	 * adds an error
+	 *
+	 * @param string $msg
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws EE_Error
+	 */
+	public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
+	{
+		if (WP_DEBUG) {
+			throw new EE_Error($msg);
+		}
+		EE_Error::add_error($msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add success message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_success($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('success', $msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 *    add attention message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_attention($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('attention', $msg, $file, $func, $line);
+	}
+
+
+
+	/**
+	 * @param string $type whether the message is for a success or error notification
+	 * @param string $msg the message to display to users or developers
+	 *                    - adding a double pipe || (OR) creates separate messages for user || dev
+	 * @param string $file the file that the error occurred in - just use __FILE__
+	 * @param string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param string $line the line number where the error occurred - just use __LINE__
+	 * @return void
+	 */
+	private static function _add_notice($type = 'success', $msg = '', $file = '', $func = '', $line = '')
+	{
+		if (empty($msg)) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_' . $type . '()',
+				sprintf(
+					__('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
+						'event_espresso'),
+					$type,
+					$file,
+					$line
+				),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_error()',
+				__('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
+					'event_espresso'),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		// get separate user and developer messages if they exist
+		$msg      = explode('||', $msg);
+		$user_msg = $msg[0];
+		$dev_msg  = isset($msg[1]) ? $msg[1] : $msg[0];
+		/**
+		 * Do an action so other code can be triggered when a notice is created
+		 *
+		 * @param string $type     can be 'errors', 'attention', or 'success'
+		 * @param string $user_msg message displayed to user when WP_DEBUG is off
+		 * @param string $user_msg message displayed to user when WP_DEBUG is on
+		 * @param string $file     file where error was generated
+		 * @param string $func     function where error was generated
+		 * @param string $line     line where error was generated
+		 */
+		do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add notice if message exists
+		if (! empty($msg)) {
+			// get error code
+			$notice_code = EE_Error::generate_error_code($file, $func, $line);
+			if (WP_DEBUG && $type === 'errors') {
+				$msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+			}
+			// add notice. Index by code if it's not blank
+			if ($notice_code) {
+				self::$_espresso_notices[$type][$notice_code] = $msg;
+			} else {
+				self::$_espresso_notices[$type][] = $msg;
+			}
+			add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
+		}
+	}
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing success messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_success()
+	{
+		self::$_espresso_notices['success'] = false;
+	}
+
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing attention messages
+	 *
+	 * @return void
+	 */
+	public static function overwrite_attention()
+	{
+		self::$_espresso_notices['attention'] = false;
+	}
+
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing error messages
+	 *
+	 * @return void
+	 */
+	public static function overwrite_errors()
+	{
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset_notices()
+	{
+		self::$_espresso_notices['success']   = false;
+		self::$_espresso_notices['attention'] = false;
+		self::$_espresso_notices['errors']    = false;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public static function has_notices()
+	{
+		$has_notices = 0;
+		// check for success messages
+		$has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])
+			? 3
+			: $has_notices;
+		// check for attention messages
+		$has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])
+			? 2
+			: $has_notices;
+		// check for error messages
+		$has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])
+			? 1
+			: $has_notices;
+		return $has_notices;
+	}
+
+
+	/**
+	 * This simply returns non formatted error notices as they were sent into the EE_Error object.
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function get_vanilla_notices()
+	{
+		return array(
+			'success'   => isset(self::$_espresso_notices['success'])
+				? self::$_espresso_notices['success']
+				: array(),
+			'attention' => isset(self::$_espresso_notices['attention'])
+				? self::$_espresso_notices['attention']
+				: array(),
+			'errors'    => isset(self::$_espresso_notices['errors'])
+				? self::$_espresso_notices['errors']
+				: array(),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getStoredNotices()
+	{
+		if ($user_id = get_current_user_id()) {
+			// get notices for logged in user
+			$notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id);
+			return is_array($notices) ? $notices : array();
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// get notices for user currently engaged in a session
+			$session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES);
+			return is_array($session_data) ? $session_data : array();
+		}
+		// get global notices and hope they apply to the current site visitor
+		$notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, array());
+		return is_array($notices) ? $notices : array();
+	}
+
+
+	/**
+	 * @param array $notices
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function storeNotices(array $notices)
+	{
+		if ($user_id = get_current_user_id()) {
+			// store notices for logged in user
+			return (bool) update_user_option(
+				$user_id,
+				EE_Error::OPTIONS_KEY_NOTICES,
+				$notices
+			);
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// store notices for user currently engaged in a session
+			return EE_Session::instance()->set_session_data(
+				array(EE_Error::OPTIONS_KEY_NOTICES => $notices)
+			);
+		}
+		// store global notices and hope they apply to the same site visitor on the next request
+		return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices);
+	}
+
+
+	/**
+	 * @return bool|TRUE
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function clearNotices()
+	{
+		if ($user_id = get_current_user_id()) {
+			// clear notices for logged in user
+			return (bool) update_user_option(
+				$user_id,
+				EE_Error::OPTIONS_KEY_NOTICES,
+				array()
+			);
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// clear notices for user currently engaged in a session
+			return EE_Session::instance()->reset_data(EE_Error::OPTIONS_KEY_NOTICES);
+		}
+		// clear global notices and hope none belonged to some for some other site visitor
+		return update_option(EE_Error::OPTIONS_KEY_NOTICES, array());
+	}
+
+
+	/**
+	 * saves notices to the db for retrieval on next request
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function stashNoticesBeforeRedirect()
+	{
+		EE_Error::get_notices(false, true);
+	}
+
+
+	/**
+	 * compile all error or success messages into one string
+	 *
+	 * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
+	 * @param boolean $format_output            whether or not to format the messages for display in the WP admin
+	 * @param boolean $save_to_transient        whether or not to save notices to the db for retrieval on next request
+	 *                                          - ONLY do this just before redirecting
+	 * @param boolean $remove_empty             whether or not to unset empty messages
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
+	{
+		$success_messages   = '';
+		$attention_messages = '';
+		$error_messages     = '';
+		// either save notices to the db
+		if ($save_to_transient || isset($_REQUEST['activate-selected'])) {
+			self::$_espresso_notices = array_merge(
+				EE_Error::getStoredNotices(),
+				self::$_espresso_notices
+			);
+			EE_Error::storeNotices(self::$_espresso_notices);
+			return array();
+		}
+		$print_scripts = EE_Error::combineExistingAndNewNotices();
+		// check for success messages
+		if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
+			// combine messages
+			$success_messages .= implode(self::$_espresso_notices['success'], '<br />');
+			$print_scripts    = true;
+		}
+		// check for attention messages
+		if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
+			// combine messages
+			$attention_messages .= implode(self::$_espresso_notices['attention'], '<br />');
+			$print_scripts      = true;
+		}
+		// check for error messages
+		if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
+			$error_messages .= count(self::$_espresso_notices['errors']) > 1
+				? __('The following errors have occurred:<br />', 'event_espresso')
+				: __('An error has occurred:<br />', 'event_espresso');
+			// combine messages
+			$error_messages .= implode(self::$_espresso_notices['errors'], '<br />');
+			$print_scripts  = true;
+		}
+		if ($format_output) {
+			$notices = EE_Error::formatNoticesOutput(
+				$success_messages,
+				$attention_messages,
+				$error_messages
+			);
+		} else {
+			$notices = array(
+				'success'   => $success_messages,
+				'attention' => $attention_messages,
+				'errors'    => $error_messages,
+			);
+			if ($remove_empty) {
+				// remove empty notices
+				foreach ($notices as $type => $notice) {
+					if (empty($notice)) {
+						unset($notices[$type]);
+					}
+				}
+			}
+		}
+		if ($print_scripts) {
+			self::_print_scripts();
+		}
+		return $notices;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function combineExistingAndNewNotices()
+	{
+		$print_scripts = false;
+		// grab any notices that have been previously saved
+		$notices = EE_Error::getStoredNotices();
+		if (! empty($notices)) {
+			foreach ($notices as $type => $notice) {
+				if (is_array($notice) && ! empty($notice)) {
+					// make sure that existing notice type is an array
+					self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
+														&& ! empty(self::$_espresso_notices[ $type ])
+						? self::$_espresso_notices[ $type ]
+						: array();
+					// add newly created notices to existing ones
+					self::$_espresso_notices[ $type ] += $notice;
+					$print_scripts = true;
+				}
+			}
+			// now clear any stored notices
+			EE_Error::clearNotices();
+		}
+		return $print_scripts;
+	}
+
+
+	/**
+	 * @param string $success_messages
+	 * @param string $attention_messages
+	 * @param string $error_messages
+	 * @return string
+	 */
+	private static function formatNoticesOutput($success_messages, $attention_messages, $error_messages)
+	{
+		$notices = '<div id="espresso-notices">';
+		$close   = is_admin()
+			? ''
+			: '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>';
+		if ($success_messages !== '') {
+			$css_id    = is_admin() ? 'message' : 'espresso-notices-success';
+			$css_class = is_admin() ? 'updated fade' : 'success fade-away';
+			//showMessage( $success_messages );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $success_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		if ($attention_messages !== '') {
+			$css_id    = is_admin() ? 'message' : 'espresso-notices-attention';
+			$css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
+			//showMessage( $error_messages, TRUE );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $attention_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		if ($error_messages !== '') {
+			$css_id    = is_admin() ? 'message' : 'espresso-notices-error';
+			$css_class = is_admin() ? 'error' : 'error fade-away';
+			//showMessage( $error_messages, TRUE );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $error_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		$notices .= '</div>';
+		return $notices;
+	}
+
+
+
+	/**
+	 * _print_scripts
+	 *
+	 * @param    bool $force_print
+	 * @return    string
+	 */
+	private static function _print_scripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			if (wp_script_is('ee_error_js', 'enqueued')) {
+				return '';
+			}
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script('ee_error_js');
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
+			}
+		} else {
+			return '
 <script>
 /* <![CDATA[ */
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -1038,223 +1038,223 @@ 
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 ';
-        }
-        return '';
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function enqueue_error_scripts()
-    {
-        self::_print_scripts();
-    }
-
-
-
-    /**
-     * create error code from filepath, function name,
-     * and line number where exception or error was thrown
-     *
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    public static function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file       = explode('.', basename($file));
-        $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
-
-
-
-    /**
-     * write exception details to log file
-     * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file
-     *
-     * @param int   $time
-     * @param array $ex
-     * @param bool  $clear
-     * @return void
-     */
-    public function write_to_error_log($time = 0, $ex = array(), $clear = false)
-    {
-        if (empty($ex)) {
-            return;
-        }
-        if (! $time) {
-            $time = time();
-        }
-        $exception_log = '----------------------------------------------------------------------------------------'
-                         . PHP_EOL;
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
-        $exception_log .= $ex['string'] . PHP_EOL;
-        $exception_log .= '----------------------------------------------------------------------------------------'
-                          . PHP_EOL;
-        try {
-            error_log($exception_log);
-        } catch (EE_Error $e) {
-            EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s',
-                'event_espresso'), $e->getMessage()));
-        }
-    }
-
-
-
-    /**
-     * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
-     * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
-     * but the code execution is done in a manner that could lead to unexpected results
-     * (i.e. running to early, or too late in WP or EE loading process).
-     * A good test for knowing whether to use this method is:
-     * 1. Is there going to be a PHP error if something isn't setup/used correctly?
-     * Yes -> use EE_Error::add_error() or throw new EE_Error()
-     * 2. If this is loaded before something else, it won't break anything,
-     * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
-     *
-     * @uses   constant WP_DEBUG test if wp_debug is on or not
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     */
-    public static function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        if (defined('WP_DEBUG') && WP_DEBUG) {
-            EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
-        }
-    }
-
-
-
-    /**
-     * Like get_notices, but returns an array of all the notices of the given type.
-     *
-     * @return array {
-     *  @type array $success   all the success messages
-     *  @type array $errors    all the error messages
-     *  @type array $attention all the attention messages
-     * }
-     */
-    public static function get_raw_notices()
-    {
-        return self::$_espresso_notices;
-    }
-
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param string $pan_name     the name, or key of the Persistent Admin Notice to be stored
-     * @param string $pan_message  the message to be stored persistently until dismissed
-     * @param bool   $force_update allows one to enforce the reappearance of a persistent message.
-     * @return void
-     * @throws InvalidDataTypeException
-     */
-    public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
-    {
-        new PersistentAdminNotice(
-            $pan_name,
-            $pan_message,
-            $force_update
-        );
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool   $purge
-     * @param bool   $return
-     * @throws DomainException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ServiceNotFoundException
-     * @throws InvalidArgumentException
-     */
-    public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return = false)
-    {
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return);
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
-     * @param  string $pan_message the message to be stored persistently until dismissed
-     * @param  string $return_url  URL to go back to after nag notice is dismissed
-     */
-    public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param string $return_url
-     */
-    public static function get_persistent_admin_notices($return_url = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function enqueue_error_scripts()
+	{
+		self::_print_scripts();
+	}
+
+
+
+	/**
+	 * create error code from filepath, function name,
+	 * and line number where exception or error was thrown
+	 *
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	public static function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file       = explode('.', basename($file));
+		$error_code = ! empty($file[0]) ? $file[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
+
+
+
+	/**
+	 * write exception details to log file
+	 * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file
+	 *
+	 * @param int   $time
+	 * @param array $ex
+	 * @param bool  $clear
+	 * @return void
+	 */
+	public function write_to_error_log($time = 0, $ex = array(), $clear = false)
+	{
+		if (empty($ex)) {
+			return;
+		}
+		if (! $time) {
+			$time = time();
+		}
+		$exception_log = '----------------------------------------------------------------------------------------'
+						 . PHP_EOL;
+		$exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
+		$exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
+		$exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
+		$exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
+		$exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
+		$exception_log .= 'Stack trace: ' . PHP_EOL;
+		$exception_log .= $ex['string'] . PHP_EOL;
+		$exception_log .= '----------------------------------------------------------------------------------------'
+						  . PHP_EOL;
+		try {
+			error_log($exception_log);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s',
+				'event_espresso'), $e->getMessage()));
+		}
+	}
+
+
+
+	/**
+	 * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
+	 * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
+	 * but the code execution is done in a manner that could lead to unexpected results
+	 * (i.e. running to early, or too late in WP or EE loading process).
+	 * A good test for knowing whether to use this method is:
+	 * 1. Is there going to be a PHP error if something isn't setup/used correctly?
+	 * Yes -> use EE_Error::add_error() or throw new EE_Error()
+	 * 2. If this is loaded before something else, it won't break anything,
+	 * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
+	 *
+	 * @uses   constant WP_DEBUG test if wp_debug is on or not
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 */
+	public static function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
+		}
+	}
+
+
+
+	/**
+	 * Like get_notices, but returns an array of all the notices of the given type.
+	 *
+	 * @return array {
+	 *  @type array $success   all the success messages
+	 *  @type array $errors    all the error messages
+	 *  @type array $attention all the attention messages
+	 * }
+	 */
+	public static function get_raw_notices()
+	{
+		return self::$_espresso_notices;
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param string $pan_name     the name, or key of the Persistent Admin Notice to be stored
+	 * @param string $pan_message  the message to be stored persistently until dismissed
+	 * @param bool   $force_update allows one to enforce the reappearance of a persistent message.
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 */
+	public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
+	{
+		new PersistentAdminNotice(
+			$pan_name,
+			$pan_message,
+			$force_update
+		);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
+			),
+			'4.9.27'
+		);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool   $purge
+	 * @param bool   $return
+	 * @throws DomainException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ServiceNotFoundException
+	 * @throws InvalidArgumentException
+	 */
+	public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return = false)
+	{
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
+	 * @param  string $pan_message the message to be stored persistently until dismissed
+	 * @param  string $return_url  URL to go back to after nag notice is dismissed
+	 */
+	public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param string $return_url
+	 */
+	public static function get_persistent_admin_notices($return_url = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
 
 
 
@@ -1269,27 +1269,27 @@ 
  */
 function espresso_error_enqueue_scripts()
 {
-    // js for error handling
-    wp_register_script(
-        'espresso_core',
-        EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-        array('jquery'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
-    wp_register_script(
-        'ee_error_js',
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-        array('espresso_core'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
+	// js for error handling
+	wp_register_script(
+		'espresso_core',
+		EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+		array('jquery'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
+	wp_register_script(
+		'ee_error_js',
+		EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+		array('espresso_core'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
 }
 
 if (is_admin()) {
-    add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
+	add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
 } else {
-    add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
+	add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
 }
 
 

core/libraries/messages/messenger/EE_Email_messenger.class.php

Indentation +645 added lines, -645 removed lines

@@ -8,649 +8,649 @@
 class EE_Email_messenger extends EE_messenger
 {
 
-    /**
-     * To field for email
-     * @var string
-     */
-    protected $_to = '';
-
-
-    /**
-     * CC field for email.
-     * @var string
-     */
-    protected $_cc = '';
-
-    /**
-     * From field for email
-     * @var string
-     */
-    protected $_from = '';
-
-
-    /**
-     * Subject field for email
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * Content field for email
-     * @var string
-     */
-    protected $_content = '';
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        //set name and description properties
-        $this->name                = 'email';
-        $this->description         = sprintf(
-            esc_html__(
-                'This messenger delivers messages via email using the built-in %s function included with WordPress',
-                'event_espresso'
-            ),
-            '<code>wp_mail</code>'
-        );
-        $this->label               = array(
-            'singular' => esc_html__('email', 'event_espresso'),
-            'plural'   => esc_html__('emails', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-
-        //we're using defaults so let's call parent constructor that will take care of setting up all the other
-        // properties
-        parent::__construct();
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true,
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     */
-    protected function _set_valid_shortcodes()
-    {
-        //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
-        // message type.
-        $this->_valid_shortcodes = array(
-            'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_validator_config()
-    {
-        $valid_shortcodes = $this->get_valid_shortcodes();
-
-        $this->_validator_config = array(
-            'to'            => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type'       => 'email',
-            ),
-            'cc' => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type' => 'email',
-            ),
-            'from'          => array(
-                'shortcodes' => $valid_shortcodes['from'],
-                'type'       => 'email',
-            ),
-            'subject'       => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_details',
-                    'event_author',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-            ),
-            'content'       => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket_list',
-                    'organization',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                    'transaction',
-                    'messenger',
-                ),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required'   => array('[ATTENDEE_LIST]'),
-            ),
-            'event_list'    => array(
-                'shortcodes' => array(
-                    'event',
-                    'attendee_list',
-                    'ticket_list',
-                    'venue',
-                    'datetime_list',
-                    'attendee',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                ),
-                'required'   => array('[EVENT_LIST]'),
-            ),
-            'ticket_list'   => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-                'required'   => array('[TICKET_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required'   => array('[DATETIME_LIST]'),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   parent EE_messenger class for docs
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name = 'html') {
-            add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        }
-    }
-
-
-    public function add_email_css(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        //prevent recursion on this callback.
-        remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
-        $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
-
-        add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        return $variation;
-    }
-
-
-    /**
-     * See parent for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html__('Send a test email to', 'event_espresso'),
-                'type'       => 'email',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-                'default'    => get_bloginfo('admin_email'),
-            ),
-            'subject' => array(
-                'input'      => 'hidden',
-                'label'      => '',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => false,
-                'format'     => '%s',
-                'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
-                'default'    => '',
-                'css_class'  => '',
-            ),
-        );
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for
-        // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
-        // they relate to.  This is important for the Messages_admin to know what fields to display to the user.
-        //  Also, notice that the "values" are equal to the field type that messages admin will use to know what
-        // kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
-        // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
-        // displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
-        // will not be displayed/parsed.
-        $this->_template_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'To',
-                    'Label for the "To" field for email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'cc'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'CC',
-                    'Label for the "Carbon Copy" field used for additional email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'from'    => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'From',
-                    'Label for the "From" field for email addresses.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'subject' => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'Subject',
-                    'Label for the "Subject" field (short description of contents) for emails.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'content' => '',
-            //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => array(
-                'content' => array(
-                    'main'          => array(
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => true,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ),
-                    'event_list'    => array(
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'ticket_list'   => array(
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * See definition of this class in parent
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array(
-            'payment',
-            'payment_refund',
-            'registration',
-            'not_approved_registration',
-            'pending_approval',
-        );
-    }
-
-
-    /**
-     * @see   definition of this class in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array(
-            'payment',
-            'registration',
-            'not_approved_registration',
-            'declined_registration',
-            'cancelled_registration',
-            'pending_approval',
-            'registration_summary',
-            'payment_reminder',
-            'payment_declined',
-            'payment_refund',
-        );
-    }
-
-
-    /**
-     * setting up admin_settings_fields for messenger.
-     */
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-    /**
-     * We just deliver the messages don't kill us!!
-     *
-     * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
-     *              present.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _send_message()
-    {
-        $success = wp_mail(
-            $this->_to,
-            //some old values for subject may be expecting HTML entities to be decoded in the subject
-            //and subjects aren't interpreted as HTML, so there should be no HTML in them
-            wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
-            $this->_body(),
-            $this->_headers()
-        );
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
-                        'event_espresso'
-                    ),
-                    $this->_to,
-                    $this->_from,
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * see parent for definition
-     *
-     * @return string html body of the message content and the related css.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _preview()
-    {
-        return $this->_body(true);
-    }
-
-
-    /**
-     * Setup headers for email
-     *
-     * @access protected
-     * @return string formatted header for email
-     */
-    protected function _headers()
-    {
-        $this->_ensure_has_from_email_address();
-        $from    = $this->_from;
-        $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
-            'Content-Type:text/html; charset=utf-8',
-        );
-
-        /**
-         * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
-         * cover back compat where there may be users who have saved cc values in their db for the newsletter message
-         * type which they are no longer able to change.
-         */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
-        }
-
-        //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
-        // header.
-        add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
-        add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
-        return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
-    }
-
-
-    /**
-     * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
-     * address for the from address to avoid problems with sending emails.
-     */
-    protected function _ensure_has_from_email_address()
-    {
-        if (empty($this->_from)) {
-            $this->_from = get_bloginfo('admin_email');
-        }
-    }
-
-
-    /**
-     * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
-     * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
-     * be empty
-     *
-     * @since 4.3.1
-     * @return array
-     */
-    private function _parse_from()
-    {
-        if (strpos($this->_from, '<') !== false) {
-            $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
-            $from_name = str_replace('"', '', $from_name);
-            $from_name = trim($from_name);
-
-            $from_email = substr($this->_from, strpos($this->_from, '<') + 1);
-            $from_email = str_replace('>', '', $from_email);
-            $from_email = trim($from_email);
-        } elseif (trim($this->_from) !== '') {
-            $from_name  = '';
-            $from_email = trim($this->_from);
-        } else {
-            $from_name = $from_email = '';
-        }
-        return array($from_name, $from_email);
-    }
-
-
-    /**
-     * Callback for the wp_mail_from filter.
-     *
-     * @since 4.3.1
-     * @param string $from_email What the original from_email is.
-     * @return string
-     */
-    public function set_from_address($from_email)
-    {
-        $parsed_from = $this->_parse_from();
-        //includes fallback if the parsing failed.
-        $from_email = is_array($parsed_from) && ! empty($parsed_from[1])
-            ? $parsed_from[1]
-            : get_bloginfo('admin_email');
-        return $from_email;
-    }
-
-
-    /**
-     * Callback fro the wp_mail_from_name filter.
-     *
-     * @since 4.3.1
-     * @param string $from_name The original from_name.
-     * @return string
-     */
-    public function set_from_name($from_name)
-    {
-        $parsed_from = $this->_parse_from();
-        if (is_array($parsed_from) && ! empty($parsed_from[0])) {
-            $from_name = $parsed_from[0];
-        }
-
-        //if from name is "WordPress" let's sub in the site name instead (more friendly!)
-        //but realize the default name is HTML entity-encoded
-        $from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
-
-        return $from_name;
-    }
-
-
-    /**
-     * setup body for email
-     *
-     * @param bool $preview will determine whether this is preview template or not.
-     * @return string formatted body for email.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _body($preview = false)
-    {
-        //setup template args!
-        $this->_template_args = array(
-            'subject'   => $this->_subject,
-            'from'      => $this->_from,
-            'main_body' => wpautop($this->_content),
-        );
-        $body                 = $this->_get_main_template($preview);
-
-        /**
-         * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
-         *
-         * @type    bool $preview Indicates whether a preview is being generated or not.
-         * @return  bool    true  indicates to use the inliner, false bypasses it.
-         */
-        if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
-            //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
-
-            //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
-                $style = file_get_contents(
-                    $this->get_variation(
-                        $this->_tmp_pack,
-                        $this->_incoming_message_type->name,
-                        false,
-                        'main',
-                        $this->_variation
-                    ),
-                    true
-                );
-                $CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
-                //for some reason the library has a bracket and new line at the beginning.  This takes care of that.
-                $body  = ltrim($CSS->convert(true), ">\n");
-                //see https://events.codebasehq.com/projects/event-espresso/tickets/8609
-                $body  = ltrim($body, "<?");
-            }
-
-        }
-        return $body;
-    }
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        $settings = parent::get_existing_test_settings();
-        //override subject if present because we always want it to be fresh.
-        if (is_array($settings) && ! empty($settings['subject'])) {
-            $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
-        }
-        return $settings;
-    }
+	/**
+	 * To field for email
+	 * @var string
+	 */
+	protected $_to = '';
+
+
+	/**
+	 * CC field for email.
+	 * @var string
+	 */
+	protected $_cc = '';
+
+	/**
+	 * From field for email
+	 * @var string
+	 */
+	protected $_from = '';
+
+
+	/**
+	 * Subject field for email
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * Content field for email
+	 * @var string
+	 */
+	protected $_content = '';
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		//set name and description properties
+		$this->name                = 'email';
+		$this->description         = sprintf(
+			esc_html__(
+				'This messenger delivers messages via email using the built-in %s function included with WordPress',
+				'event_espresso'
+			),
+			'<code>wp_mail</code>'
+		);
+		$this->label               = array(
+			'singular' => esc_html__('email', 'event_espresso'),
+			'plural'   => esc_html__('emails', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+
+		//we're using defaults so let's call parent constructor that will take care of setting up all the other
+		// properties
+		parent::__construct();
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true,
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		//remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
+		// message type.
+		$this->_valid_shortcodes = array(
+			'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_validator_config()
+	{
+		$valid_shortcodes = $this->get_valid_shortcodes();
+
+		$this->_validator_config = array(
+			'to'            => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type'       => 'email',
+			),
+			'cc' => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type' => 'email',
+			),
+			'from'          => array(
+				'shortcodes' => $valid_shortcodes['from'],
+				'type'       => 'email',
+			),
+			'subject'       => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_details',
+					'event_author',
+					'primary_registration_details',
+					'recipient_details',
+				),
+			),
+			'content'       => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket_list',
+					'organization',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+					'transaction',
+					'messenger',
+				),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required'   => array('[ATTENDEE_LIST]'),
+			),
+			'event_list'    => array(
+				'shortcodes' => array(
+					'event',
+					'attendee_list',
+					'ticket_list',
+					'venue',
+					'datetime_list',
+					'attendee',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+				),
+				'required'   => array('[EVENT_LIST]'),
+			),
+			'ticket_list'   => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'recipient_details',
+				),
+				'required'   => array('[TICKET_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required'   => array('[DATETIME_LIST]'),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   parent EE_messenger class for docs
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name = 'html') {
+			add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		}
+	}
+
+
+	public function add_email_css(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		//prevent recursion on this callback.
+		remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
+		$variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
+
+		add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		return $variation;
+	}
+
+
+	/**
+	 * See parent for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html__('Send a test email to', 'event_espresso'),
+				'type'       => 'email',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+				'default'    => get_bloginfo('admin_email'),
+			),
+			'subject' => array(
+				'input'      => 'hidden',
+				'label'      => '',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => false,
+				'format'     => '%s',
+				'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
+				'default'    => '',
+				'css_class'  => '',
+			),
+		);
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for
+		// shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
+		// they relate to.  This is important for the Messages_admin to know what fields to display to the user.
+		//  Also, notice that the "values" are equal to the field type that messages admin will use to know what
+		// kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
+		// indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
+		// displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
+		// will not be displayed/parsed.
+		$this->_template_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'To',
+					'Label for the "To" field for email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'cc'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'CC',
+					'Label for the "Carbon Copy" field used for additional email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'from'    => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'From',
+					'Label for the "From" field for email addresses.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'subject' => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'Subject',
+					'Label for the "Subject" field (short description of contents) for emails.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'content' => '',
+			//left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => array(
+				'content' => array(
+					'main'          => array(
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => true,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					),
+					'event_list'    => array(
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'attendee_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'ticket_list'   => array(
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'datetime_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * See definition of this class in parent
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array(
+			'payment',
+			'payment_refund',
+			'registration',
+			'not_approved_registration',
+			'pending_approval',
+		);
+	}
+
+
+	/**
+	 * @see   definition of this class in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array(
+			'payment',
+			'registration',
+			'not_approved_registration',
+			'declined_registration',
+			'cancelled_registration',
+			'pending_approval',
+			'registration_summary',
+			'payment_reminder',
+			'payment_declined',
+			'payment_refund',
+		);
+	}
+
+
+	/**
+	 * setting up admin_settings_fields for messenger.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+	/**
+	 * We just deliver the messages don't kill us!!
+	 *
+	 * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
+	 *              present.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _send_message()
+	{
+		$success = wp_mail(
+			$this->_to,
+			//some old values for subject may be expecting HTML entities to be decoded in the subject
+			//and subjects aren't interpreted as HTML, so there should be no HTML in them
+			wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
+			$this->_body(),
+			$this->_headers()
+		);
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
+						'event_espresso'
+					),
+					$this->_to,
+					$this->_from,
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * see parent for definition
+	 *
+	 * @return string html body of the message content and the related css.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _preview()
+	{
+		return $this->_body(true);
+	}
+
+
+	/**
+	 * Setup headers for email
+	 *
+	 * @access protected
+	 * @return string formatted header for email
+	 */
+	protected function _headers()
+	{
+		$this->_ensure_has_from_email_address();
+		$from    = $this->_from;
+		$headers = array(
+			'From:' . $from,
+			'Reply-To:' . $from,
+			'Content-Type:text/html; charset=utf-8',
+		);
+
+		/**
+		 * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
+		 * cover back compat where there may be users who have saved cc values in their db for the newsletter message
+		 * type which they are no longer able to change.
+		 */
+		if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+			$headers[] = 'cc: ' . $this->_cc;
+		}
+
+		//but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
+		// header.
+		add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
+		add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
+		return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
+	}
+
+
+	/**
+	 * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
+	 * address for the from address to avoid problems with sending emails.
+	 */
+	protected function _ensure_has_from_email_address()
+	{
+		if (empty($this->_from)) {
+			$this->_from = get_bloginfo('admin_email');
+		}
+	}
+
+
+	/**
+	 * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
+	 * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
+	 * be empty
+	 *
+	 * @since 4.3.1
+	 * @return array
+	 */
+	private function _parse_from()
+	{
+		if (strpos($this->_from, '<') !== false) {
+			$from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
+			$from_name = str_replace('"', '', $from_name);
+			$from_name = trim($from_name);
+
+			$from_email = substr($this->_from, strpos($this->_from, '<') + 1);
+			$from_email = str_replace('>', '', $from_email);
+			$from_email = trim($from_email);
+		} elseif (trim($this->_from) !== '') {
+			$from_name  = '';
+			$from_email = trim($this->_from);
+		} else {
+			$from_name = $from_email = '';
+		}
+		return array($from_name, $from_email);
+	}
+
+
+	/**
+	 * Callback for the wp_mail_from filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_email What the original from_email is.
+	 * @return string
+	 */
+	public function set_from_address($from_email)
+	{
+		$parsed_from = $this->_parse_from();
+		//includes fallback if the parsing failed.
+		$from_email = is_array($parsed_from) && ! empty($parsed_from[1])
+			? $parsed_from[1]
+			: get_bloginfo('admin_email');
+		return $from_email;
+	}
+
+
+	/**
+	 * Callback fro the wp_mail_from_name filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_name The original from_name.
+	 * @return string
+	 */
+	public function set_from_name($from_name)
+	{
+		$parsed_from = $this->_parse_from();
+		if (is_array($parsed_from) && ! empty($parsed_from[0])) {
+			$from_name = $parsed_from[0];
+		}
+
+		//if from name is "WordPress" let's sub in the site name instead (more friendly!)
+		//but realize the default name is HTML entity-encoded
+		$from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
+
+		return $from_name;
+	}
+
+
+	/**
+	 * setup body for email
+	 *
+	 * @param bool $preview will determine whether this is preview template or not.
+	 * @return string formatted body for email.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _body($preview = false)
+	{
+		//setup template args!
+		$this->_template_args = array(
+			'subject'   => $this->_subject,
+			'from'      => $this->_from,
+			'main_body' => wpautop($this->_content),
+		);
+		$body                 = $this->_get_main_template($preview);
+
+		/**
+		 * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
+		 *
+		 * @type    bool $preview Indicates whether a preview is being generated or not.
+		 * @return  bool    true  indicates to use the inliner, false bypasses it.
+		 */
+		if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
+			//require CssToInlineStyles library and its dependencies via composer autoloader
+			require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+
+			//now if this isn't a preview, let's setup the body so it has inline styles
+			if (! $preview || ($preview && defined('DOING_AJAX'))) {
+				$style = file_get_contents(
+					$this->get_variation(
+						$this->_tmp_pack,
+						$this->_incoming_message_type->name,
+						false,
+						'main',
+						$this->_variation
+					),
+					true
+				);
+				$CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
+				//for some reason the library has a bracket and new line at the beginning.  This takes care of that.
+				$body  = ltrim($CSS->convert(true), ">\n");
+				//see https://events.codebasehq.com/projects/event-espresso/tickets/8609
+				$body  = ltrim($body, "<?");
+			}
+
+		}
+		return $body;
+	}
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		$settings = parent::get_existing_test_settings();
+		//override subject if present because we always want it to be fresh.
+		if (is_array($settings) && ! empty($settings['subject'])) {
+			$settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
+		}
+		return $settings;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -58,7 +58,7 @@ 
             ),
             '<code>wp_mail</code>'
         );
-        $this->label               = array(
+        $this->label = array(
             'singular' => esc_html__('email', 'event_espresso'),
             'plural'   => esc_html__('emails', 'event_espresso'),
         );
@@ -440,7 +440,7 @@ 
             $this->_body(),
             $this->_headers()
         );
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -484,8 +484,8 @@ 
         $this->_ensure_has_from_email_address();
         $from    = $this->_from;
         $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
+            'From:'.$from,
+            'Reply-To:'.$from,
             'Content-Type:text/html; charset=utf-8',
         );
 
@@ -494,8 +494,8 @@ 
          * cover back compat where there may be users who have saved cc values in their db for the newsletter message
          * type which they are no longer able to change.
          */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
+        if ( ! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+            $headers[] = 'cc: '.$this->_cc;
         }
 
         //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
@@ -602,7 +602,7 @@ 
             'from'      => $this->_from,
             'main_body' => wpautop($this->_content),
         );
-        $body                 = $this->_get_main_template($preview);
+        $body = $this->_get_main_template($preview);
 
         /**
          * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
@@ -612,10 +612,10 @@ 
          */
         if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
             //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+            require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php';
 
             //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
+            if ( ! $preview || ($preview && defined('DOING_AJAX'))) {
                 $style = file_get_contents(
                     $this->get_variation(
                         $this->_tmp_pack,

core/libraries/messages/EE_Messages_Base.lib.php

Indentation +15 added lines, -15 removed lines

@@ -300,20 +300,20 @@
 	}
 
 
-    /**
-     * Allows a message type to specifically exclude template fields for the provided messenger.
-     * Filtered so this can be programmatically altered as well.
-     * @param string $messenger_name name of messenger
-     * @return array
-     */
+	/**
+	 * Allows a message type to specifically exclude template fields for the provided messenger.
+	 * Filtered so this can be programmatically altered as well.
+	 * @param string $messenger_name name of messenger
+	 * @return array
+	 */
 	public function excludedFieldsForMessenger($messenger_name)
-    {
-        return apply_filters(
-            'FHEE__EE_Messages_Base__excludedFieldForMessenger',
-            array(),
-            $messenger_name,
-            $this->name,
-            $this
-        );
-    }
+	{
+		return apply_filters(
+			'FHEE__EE_Messages_Base__excludedFieldForMessenger',
+			array(),
+			$messenger_name,
+			$this->name,
+			$this
+		);
+	}
 }