eventespresso / event-espresso-core

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

Doc Comments +1 added lines, -2 removed lines

@@ -459,7 +459,7 @@ 
      *                                                      with construction finalize being called later
      *                                                      (realizing that the subsections' html names
      *                                                      might not be set yet, etc.)
-     * @return EE_Form_Section_Base
+     * @return EE_Form_Section_Validatable|null
      * @throws EE_Error
      */
     public function get_subsection($name, $require_construction_to_be_finalized = true)
@@ -1289,7 +1289,6 @@ 
     /**
      * 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(

Spacing +38 added lines, -38 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);
@@ -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__(
@@ -586,7 +586,7 @@ 
     public function is_valid()
     {
         if ($this->is_valid === null) {
-            if (! $this->has_received_submission()) {
+            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]);
         }
     }
 
@@ -1245,7 +1245,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__(
@@ -1257,7 +1257,7 @@ 
                         $this->name()
                     )
                 );
-                unset($new_subsections[ $subsection_name ]);
+                unset($new_subsections[$subsection_name]);
             }
         }
         $this->_subsections = EEH_Array::insert_into_array(
@@ -1372,7 +1372,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();
     }
@@ -1412,7 +1412,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }

Indentation +1524 added lines, -1524 removed lines

@@ -14,1528 +14,1528 @@
 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
-     */
-    public static 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);
-        add_action('shutdown', array('EE_Form_Section_Proper', '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 4.9.59.p
-     */
-    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
+	 */
+	public static 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);
+		add_action('shutdown', array('EE_Form_Section_Proper', '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 4.9.59.p
+	 */
+	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;
+	}
 }

modules/ticket_sales_monitor/EED_Ticket_Sales_Monitor.module.php

Doc Comments +3 added lines, -2 removed lines

@@ -326,7 +326,7 @@ 
      *
      * @param    EE_Ticket $ticket
      * @param int          $quantity
-     * @return bool
+     * @return integer
      * @throws EE_Error
      */
     protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
@@ -343,7 +343,7 @@ 
     /**
      * @param  EE_Ticket $ticket
      * @param  int       $quantity
-     * @return bool
+     * @return integer
      * @throws EE_Error
      */
     protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
@@ -969,6 +969,7 @@ 
     /**
      * @param EE_Ticket[]    $tickets_with_reservations
      * @param EE_Line_Item[] $valid_reserved_ticket_line_items
+     * @param string $source
      * @return int
      * @throws UnexpectedEntityException
      * @throws DomainException

Indentation +1043 added lines, -1043 removed lines

@@ -20,1048 +20,1048 @@
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
 
-    const debug = false;
-
-    private static $nl = '';
-
-    /**
-     * an array of raw ticket data from EED_Ticket_Selector
-     *
-     * @var array $ticket_selections
-     */
-    protected $ticket_selections = array();
-
-    /**
-     * the raw ticket data from EED_Ticket_Selector is organized in rows
-     * according to how they are displayed in the actual Ticket_Selector
-     * this tracks the current row being processed
-     *
-     * @var int $current_row
-     */
-    protected $current_row = 0;
-
-    /**
-     * an array for tracking names of tickets that have sold out
-     *
-     * @var array $sold_out_tickets
-     */
-    protected $sold_out_tickets = array();
-
-    /**
-     * an array for tracking names of tickets that have had their quantities reduced
-     *
-     * @var array $decremented_tickets
-     */
-    protected $decremented_tickets = array();
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        self::$nl = defined('EE_TESTS_DIR') ? "\n" : '<br />';
-        // release tickets for expired carts
-        add_action(
-            'EED_Ticket_Selector__process_ticket_selections__before',
-            array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
-            1
-        );
-        // check ticket reserves AFTER MER does it's check (hence priority 20)
-        add_filter(
-            'FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
-            array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
-            20,
-            3
-        );
-        // add notices for sold out tickets
-        add_action(
-            'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            array('EED_Ticket_Sales_Monitor', 'post_notices'),
-            10
-        );
-
-        // handle tickets deleted from cart
-        add_action(
-            'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
-            array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
-            10,
-            2
-        );
-        // handle emptied carts
-        add_action(
-            'AHEE__EE_Session__reset_cart__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10,
-            1
-        );
-        // handle cancelled registrations
-        add_action(
-            'AHEE__EE_Session__reset_checkout__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
-            10,
-            1
-        );
-        // cron tasks
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
-            10,
-            1
-        );
-    }
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Ticket_Sales_Monitor::set_hooks();
-    }
-
-
-    /**
-     * @return EED_Ticket_Sales_Monitor|EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return    void
-     */
-    public function run($WP_Query)
-    {
-    }
-
-
-
-    /********************************** PRE_TICKET_SALES  **********************************/
-
-
-    /**
-     * Retrieves grand totals from the line items that have no TXN ID
-     * and timestamps less than the current time minus the session lifespan.
-     * These are carts that have been abandoned before the "registrant" even attempted to checkout.
-     * We're going to release the tickets for these line items before attempting to add more to the cart.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     */
-    public static function release_tickets_for_expired_carts()
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-        }
-        do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
-        $expired_ticket_IDs = array();
-        /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-        $session_lifespan = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\values\session\SessionLifespan'
-        );
-        $timestamp = $session_lifespan->expiration();
-        $expired_ticket_line_items = EEM_Line_Item::instance()->getTicketLineItemsForExpiredCarts($timestamp);
-        if (self::debug) {
-            echo self::$nl . ' . time(): ' . time();
-            echo self::$nl . ' . time() as date: ' . date('Y-m-d H:i a');
-            echo self::$nl . ' . session expiration: ' . $session_lifespan->expiration();
-            echo self::$nl . ' . session expiration as date: ' . date('Y-m-d H:i a', $session_lifespan->expiration());
-            echo self::$nl . ' . timestamp: ' . $timestamp;
-            echo self::$nl . ' . $expired_ticket_line_items: ' . count($expired_ticket_line_items);
-        }
-        if (! empty($expired_ticket_line_items)) {
-            foreach ($expired_ticket_line_items as $expired_ticket_line_item) {
-                if (! $expired_ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                $expired_ticket_IDs[ $expired_ticket_line_item->OBJ_ID() ] = $expired_ticket_line_item->OBJ_ID();
-                if (self::debug) {
-                    echo self::$nl . ' . $expired_ticket_line_item->OBJ_ID(): ' . $expired_ticket_line_item->OBJ_ID();
-                    echo self::$nl . ' . $expired_ticket_line_item->timestamp(): '
-                         . date(
-                             'Y-m-d h:i a',
-                             $expired_ticket_line_item->timestamp(true)
-                         );
-                }
-            }
-            if (! empty($expired_ticket_IDs)) {
-                EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-                    \EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
-                    array(),
-                    __FUNCTION__
-                );
-                // now  let's get rid of expired line items so that they can't interfere with tracking
-                EED_Ticket_Sales_Monitor::clear_expired_line_items_with_no_transaction($timestamp);
-            }
-        }
-        do_action(
-            'AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__end',
-            $expired_ticket_IDs,
-            $expired_ticket_line_items
-        );
-    }
-
-
-
-    /********************************** VALIDATE_TICKET_SALE  **********************************/
-
-
-    /**
-     * callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
-     *
-     * @param int       $qty
-     * @param EE_Ticket $ticket
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
-    {
-        $qty = absint($qty);
-        if ($qty > 0) {
-            $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
-        }
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-            echo self::$nl . self::$nl . '<b> RETURNED QTY: ' . $qty . '</b>';
-        }
-        return $qty;
-    }
-
-
-    /**
-     * checks whether an individual ticket is available for purchase based on datetime, and ticket details
-     *
-     * @param   EE_Ticket $ticket
-     * @param int         $qty
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        if (! $ticket instanceof EE_Ticket) {
-            return 0;
-        }
-        if (self::debug) {
-            echo self::$nl . '<b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo self::$nl . ' . original ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->refresh_from_db();
-        // first let's determine the ticket availability based on sales
-        $available = $ticket->qty('saleable');
-        if (self::debug) {
-            echo self::$nl . ' . . . ticket->qty: ' . $ticket->qty();
-            echo self::$nl . ' . . . ticket->sold: ' . $ticket->sold();
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
-            echo self::$nl . ' . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo self::$nl . ' . . . available: ' . $available;
-        }
-        if ($available < 1) {
-            $this->_ticket_sold_out($ticket);
-            return 0;
-        }
-        if (self::debug) {
-            echo self::$nl . ' . . . qty: ' . $qty;
-        }
-        if ($available < $qty) {
-            $qty = $available;
-            if (self::debug) {
-                echo self::$nl . ' . . . QTY ADJUSTED: ' . $qty;
-            }
-            $this->_ticket_quantity_decremented($ticket);
-        }
-        $this->_reserve_ticket($ticket, $qty);
-        return $qty;
-    }
-
-
-    /**
-     * increments ticket reserved based on quantity passed
-     *
-     * @param    EE_Ticket $ticket
-     * @param int          $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . ' . . . INCREASE RESERVED: ' . $quantity;
-        }
-        $ticket->increase_reserved($quantity, 'TicketSalesMonitor:' . __LINE__);
-        return $ticket->save();
-    }
-
-
-    /**
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo self::$nl . ' . . . ticket->ID: ' . $ticket->ID();
-            echo self::$nl . ' . . . ticket->reserved before: ' . $ticket->reserved();
-        }
-        $ticket->decrease_reserved($quantity, true, 'TicketSalesMonitor:' . __LINE__);
-        if (self::debug) {
-            echo self::$nl . ' . . . ticket->reserved after: ' . $ticket->reserved();
-        }
-        return $ticket->save() ? 1 : 0;
-    }
-
-
-    /**
-     * removes quantities within the ticket selector based on zero ticket availability
-     *
-     * @param    EE_Ticket $ticket
-     * @return    void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_sold_out(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-    /**
-     * adjusts quantities within the ticket selector based on decreased ticket availability
-     *
-     * @param    EE_Ticket $ticket
-     * @return void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_quantity_decremented(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-    /**
-     * builds string out of ticket and event name
-     *
-     * @param    EE_Ticket $ticket
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_and_event_name(EE_Ticket $ticket)
-    {
-        $event = $ticket->get_related_event();
-        if ($event instanceof EE_Event) {
-            $ticket_name = sprintf(
-                _x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
-                $ticket->name(),
-                $event->name()
-            );
-        } else {
-            $ticket_name = $ticket->name();
-        }
-        return $ticket_name;
-    }
-
-
-
-    /********************************** EVENT CART  **********************************/
-
-
-    /**
-     * releases or reserves ticket(s) based on quantity passed
-     *
-     * @param  EE_Line_Item $line_item
-     * @param  int          $quantity
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
-    {
-        $ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
-        if ($ticket instanceof EE_Ticket) {
-            $ticket->add_extra_meta(
-                EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                __LINE__ . ') ' . __METHOD__ . '()'
-            );
-            if ($quantity > 0) {
-                EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
-            } else {
-                EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-            }
-        }
-    }
-
-
-    /**
-     * releases reserved ticket(s) based on quantity passed
-     *
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
-    {
-        $ticket->add_extra_meta(
-            EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-            __LINE__ . ') ' . __METHOD__ . '()'
-        );
-        EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-    }
-
-
-
-    /********************************** POST_NOTICES  **********************************/
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function post_notices()
-    {
-        EED_Ticket_Sales_Monitor::instance()->_post_notices();
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _post_notices()
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $refresh_msg = '';
-        $none_added_msg = '';
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $refresh_msg = __(
-                'Please refresh the page to view updated ticket quantities.',
-                'event_espresso'
-            );
-            $none_added_msg = __('No tickets were added for the event.', 'event_espresso');
-        }
-        if (! empty($this->sold_out_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
-                        __(
-                            'We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso'
-                        )
-                    ),
-                    '<br />',
-                    implode('<br />', $this->sold_out_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            // alter code flow in the Ticket Selector for better UX
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
-            $this->sold_out_tickets = array();
-            // and reset the cart
-            EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
-        }
-        if (! empty($this->decremented_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
-                        __(
-                            'We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso'
-                        )
-                    ),
-                    '<br />',
-                    implode('<br />', $this->decremented_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            $this->decremented_tickets = array();
-        }
-    }
-
-
-
-    /********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
-
-
-    /**
-     * releases reserved tickets for all registrations of an EE_Transaction
-     * by default, will NOT release tickets for finalized transactions
-     *
-     * @param    EE_Transaction $transaction
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . transaction->ID: ' . $transaction->ID();
-            echo self::$nl . ' . TXN status_ID: ' . $transaction->status_ID();
-        }
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        if (self::debug) {
-            // DEBUG LOG
-            EEH_Debug_Tools::log(
-                __CLASS__,
-                __FUNCTION__,
-                __LINE__,
-                array('finalized' => $finalized),
-                false,
-                'EE_Transaction: ' . $transaction->ID()
-            );
-        }
-        // how many tickets were released
-        $count = 0;
-        if (self::debug) {
-            echo self::$nl . ' . . . TXN finalized: ' . $finalized;
-        }
-        $release_tickets_with_TXN_status = array(
-            EEM_Transaction::failed_status_code,
-            EEM_Transaction::abandoned_status_code,
-            EEM_Transaction::incomplete_status_code,
-        );
-        $events = array();
-        // if the session is getting cleared BEFORE the TXN has been finalized or the transaction is not completed
-        if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
-            // cancel any reserved tickets for registrations that were not approved
-            $registrations = $transaction->registrations();
-            if (self::debug) {
-                echo self::$nl . ' . . . # registrations: ' . count($registrations);
-                $reg = reset($registrations);
-                $ticket = $reg->ticket();
-                if ($ticket instanceof EE_Ticket) {
-                    $ticket->add_extra_meta(
-                        EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') Release All Tickets TXN:' . $transaction->ID()
-                    );
-                }
-            }
-            if (! empty($registrations)) {
-                foreach ($registrations as $registration) {
-                    if ($registration instanceof EE_Registration
-                        && $this->_release_reserved_ticket_for_registration($registration, $transaction)
-                    ) {
-                        $count++;
-                        $events[ $registration->event_ID() ] = $registration->event();
-                    }
-                }
-            }
-        }
-        if ($events !== array()) {
-            foreach ($events as $event) {
-                /** @var EE_Event $event */
-                $event->perform_sold_out_status_check();
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * releases reserved tickets for an EE_Registration
-     * by default, will NOT release tickets for APPROVED registrations
-     *
-     * @param EE_Registration $registration
-     * @param EE_Transaction  $transaction
-     * @return int
-     * @throws EE_Error
-     */
-    protected function _release_reserved_ticket_for_registration(
-        EE_Registration $registration,
-        EE_Transaction $transaction
-    ) {
-        $STS_ID = $transaction->status_ID();
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . registration->ID: ' . $registration->ID();
-            echo self::$nl . ' . . registration->status_ID: ' . $registration->status_ID();
-            echo self::$nl . ' . . transaction->status_ID(): ' . $STS_ID;
-        }
-        if (// release Tickets for Failed Transactions and Abandoned Transactions
-            $STS_ID === EEM_Transaction::failed_status_code
-            || $STS_ID === EEM_Transaction::abandoned_status_code
-            || (
-                // also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
-                $STS_ID === EEM_Transaction::incomplete_status_code
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-            )
-        ) {
-            if (self::debug) {
-                echo self::$nl . self::$nl . ' . . RELEASE RESERVED TICKET';
-                $rsrvd = $registration->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
-                echo self::$nl . ' . . . registration HAS_RESERVED_TICKET_KEY: ';
-                var_dump($rsrvd);
-            }
-            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:' . __LINE__);
-            return 1;
-        }
-        return 0;
-    }
-
-
-
-    /********************************** SESSION_CART_RESET  **********************************/
-
-
-    /**
-     * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
-     *
-     * @param EE_Session $session
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function session_cart_reset(EE_Session $session)
-    {
-        // don't release tickets if checkout was already reset
-        if (did_action('AHEE__EE_Session__reset_checkout__before_reset')) {
-            return;
-        }
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        // first check of the session has a valid Checkout object
-        $checkout = $session->checkout();
-        if ($checkout instanceof EE_Checkout) {
-            // and use that to clear ticket reservations because it will update the associated registration meta data
-            EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
-            return;
-        }
-        $cart = $session->cart();
-        if ($cart instanceof EE_Cart) {
-            if (self::debug) {
-                echo self::$nl . self::$nl . ' cart instance of EE_Cart: ';
-            }
-            EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart, $session);
-        } else {
-            if (self::debug) {
-                echo self::$nl . self::$nl . ' invalid EE_Cart: ';
-                var_export($cart, true);
-            }
-        }
-    }
-
-
-    /**
-     * releases reserved tickets in the EE_Cart
-     *
-     * @param EE_Cart $cart
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _session_cart_reset(EE_Cart $cart, EE_Session $session)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $ticket_line_items = $cart->get_tickets();
-        if (empty($ticket_line_items)) {
-            return;
-        }
-        if (self::debug) {
-            echo '<br /> . ticket_line_item count: ' . count($ticket_line_items);
-        }
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (self::debug) {
-                echo self::$nl . ' . ticket_line_item->ID(): ' . $ticket_line_item->ID();
-            }
-            if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
-                if (self::debug) {
-                    echo self::$nl . ' . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
-                }
-                $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
-                if ($ticket instanceof EE_Ticket) {
-                    if (self::debug) {
-                        echo self::$nl . ' . . ticket->ID(): ' . $ticket->ID();
-                        echo self::$nl . ' . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
-                    }
-                    $ticket->add_extra_meta(
-                        EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') ' . __METHOD__ . '() SID = ' . $session->id()
-                    );
-                    $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
-                }
-            }
-        }
-        if (self::debug) {
-            echo self::$nl . self::$nl . ' RESET COMPLETED ';
-        }
-    }
-
-
-
-    /********************************** SESSION_CHECKOUT_RESET  **********************************/
-
-
-    /**
-     * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
-     *
-     * @param EE_Session $session
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    public static function session_checkout_reset(EE_Session $session)
-    {
-        // don't release tickets if cart was already reset
-        if (did_action('AHEE__EE_Session__reset_cart__before_reset')) {
-            return;
-        }
-        $checkout = $session->checkout();
-        if ($checkout instanceof EE_Checkout) {
-            EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
-        }
-    }
-
-
-    /**
-     * releases reserved tickets for the EE_Checkout->transaction
-     *
-     * @param EE_Checkout $checkout
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    protected function _session_checkout_reset(EE_Checkout $checkout)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
-        if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
-            return;
-        }
-        $this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
-    }
-
-
-
-    /********************************** SESSION_EXPIRED_RESET  **********************************/
-
-
-    /**
-     * @param    EE_Session $session
-     * @return    void
-     */
-    public static function session_expired_reset(EE_Session $session)
-    {
-    }
-
-
-
-    /********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
-
-
-    /**
-     * releases reserved tickets for all registrations of an ABANDONED EE_Transaction
-     * by default, will NOT release tickets for free transactions, or any that have received a payment
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    public static function process_abandoned_transactions(EE_Transaction $transaction)
-    {
-        // is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
-        if ($transaction->is_free() || $transaction->paid() > 0) {
-            if (self::debug) {
-                // DEBUG LOG
-                EEH_Debug_Tools::log(
-                    __CLASS__,
-                    __FUNCTION__,
-                    __LINE__,
-                    array($transaction),
-                    false,
-                    'EE_Transaction: ' . $transaction->ID()
-                );
-            }
-            return;
-        }
-        // have their been any successful payments made ?
-        $payments = $transaction->payments();
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
-                if (self::debug) {
-                    // DEBUG LOG
-                    EEH_Debug_Tools::log(
-                        __CLASS__,
-                        __FUNCTION__,
-                        __LINE__,
-                        array($payment),
-                        false,
-                        'EE_Transaction: ' . $transaction->ID()
-                    );
-                }
-                return;
-            }
-        }
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
-
-
-    /**
-     * releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    public static function process_failed_transactions(EE_Transaction $transaction)
-    {
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** RESET RESERVATION COUNTS  *********************************/
-
-
-    /**
-     * Resets all ticket and datetime reserved counts to zero
-     * Tickets that are currently associated with a Transaction that is in progress
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws UnexpectedEntityException
-     */
-    public static function reset_reservation_counts()
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        /** @var EE_Transaction[] $transactions_not_in_progress */
-        $transactions_not_in_progress = EEM_Transaction::instance()->get_transactions_not_in_progress();
-        foreach ($transactions_not_in_progress as $transaction) {
-            // if this TXN has been fully completed, then skip it
-            if ($transaction->reg_step_completed('finalize_registration')) {
-                continue;
-            }
-            $total_line_item = $transaction->total_line_item();
-            // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
-                throw new DomainException(
-                    esc_html__(
-                        'Transaction does not have a valid Total Line Item associated with it.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        $total_line_items = EEM_Line_Item::instance()->get_total_line_items_for_active_carts();
-        foreach ($total_line_items as $total_line_item) {
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        $tickets_with_reservations = EEM_Ticket::instance()->get_tickets_with_reservations();
-        return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-            $tickets_with_reservations,
-            $valid_reserved_tickets,
-            __FUNCTION__
-        );
-    }
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @return EE_Line_Item[]
-     */
-    private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if ($ticket_line_item instanceof EE_Line_Item) {
-                $valid_reserved_tickets[] = $ticket_line_item;
-            }
-        }
-        return $valid_reserved_tickets;
-    }
-
-
-    /**
-     * @param EE_Ticket[]    $tickets_with_reservations
-     * @param EE_Line_Item[] $valid_reserved_ticket_line_items
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    private static function release_reservations_for_tickets(
-        array $tickets_with_reservations,
-        array $valid_reserved_ticket_line_items = array(),
-        $source
-    ) {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-        }
-        $total_tickets_released = 0;
-        $sold_out_events = array();
-        foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
-                continue;
-            }
-            $reserved_qty = $ticket_with_reservations->reserved();
-            if (self::debug) {
-                echo self::$nl . ' . $ticket_with_reservations->ID(): ' . $ticket_with_reservations->ID();
-                echo self::$nl . ' . $reserved_qty: ' . $reserved_qty;
-            }
-            foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
-                if ($valid_reserved_ticket_line_item instanceof EE_Line_Item
-                    && $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
-                ) {
-                    if (self::debug) {
-                        echo self::$nl . ' . $valid_reserved_ticket_line_item->quantity(): '
-                             . $valid_reserved_ticket_line_item->quantity();
-                    }
-                    $reserved_qty -= $valid_reserved_ticket_line_item->quantity();
-                }
-            }
-            if ($reserved_qty > 0) {
-                $ticket_with_reservations->add_extra_meta(
-                    EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                    __LINE__ . ') ' . $source . '()'
-                );
-                $ticket_with_reservations->decrease_reserved($reserved_qty, true, 'TicketSalesMonitor:' . __LINE__);
-                $ticket_with_reservations->save();
-                $total_tickets_released += $reserved_qty;
-                $event = $ticket_with_reservations->get_related_event();
-                // track sold out events
-                if ($event instanceof EE_Event && $event->is_sold_out()) {
-                    $sold_out_events[] = $event;
-                }
-            }
-        }
-        if (self::debug) {
-            echo self::$nl . ' . $total_tickets_released: ' . $total_tickets_released;
-        }
-        // double check whether sold out events should remain sold out after releasing tickets
-        if ($sold_out_events !== array()) {
-            foreach ($sold_out_events as $sold_out_event) {
-                /** @var EE_Event $sold_out_event */
-                $sold_out_event->perform_sold_out_status_check();
-            }
-        }
-        return $total_tickets_released;
-    }
-
-
-
-    /********************************** SHUTDOWN  **********************************/
-
-
-    /**
-     * @param int $timestamp
-     * @return false|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function clear_expired_line_items_with_no_transaction($timestamp = 0)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        if (! absint($timestamp)) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $timestamp = $session_lifespan->expiration();
-        }
-        return $wpdb->query(
-            $wpdb->prepare(
-                'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
+	const debug = false;
+
+	private static $nl = '';
+
+	/**
+	 * an array of raw ticket data from EED_Ticket_Selector
+	 *
+	 * @var array $ticket_selections
+	 */
+	protected $ticket_selections = array();
+
+	/**
+	 * the raw ticket data from EED_Ticket_Selector is organized in rows
+	 * according to how they are displayed in the actual Ticket_Selector
+	 * this tracks the current row being processed
+	 *
+	 * @var int $current_row
+	 */
+	protected $current_row = 0;
+
+	/**
+	 * an array for tracking names of tickets that have sold out
+	 *
+	 * @var array $sold_out_tickets
+	 */
+	protected $sold_out_tickets = array();
+
+	/**
+	 * an array for tracking names of tickets that have had their quantities reduced
+	 *
+	 * @var array $decremented_tickets
+	 */
+	protected $decremented_tickets = array();
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		self::$nl = defined('EE_TESTS_DIR') ? "\n" : '<br />';
+		// release tickets for expired carts
+		add_action(
+			'EED_Ticket_Selector__process_ticket_selections__before',
+			array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
+			1
+		);
+		// check ticket reserves AFTER MER does it's check (hence priority 20)
+		add_filter(
+			'FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
+			array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
+			20,
+			3
+		);
+		// add notices for sold out tickets
+		add_action(
+			'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			array('EED_Ticket_Sales_Monitor', 'post_notices'),
+			10
+		);
+
+		// handle tickets deleted from cart
+		add_action(
+			'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
+			array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
+			10,
+			2
+		);
+		// handle emptied carts
+		add_action(
+			'AHEE__EE_Session__reset_cart__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10,
+			1
+		);
+		// handle cancelled registrations
+		add_action(
+			'AHEE__EE_Session__reset_checkout__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
+			10,
+			1
+		);
+		// cron tasks
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
+			10,
+			1
+		);
+	}
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Ticket_Sales_Monitor::set_hooks();
+	}
+
+
+	/**
+	 * @return EED_Ticket_Sales_Monitor|EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 */
+	public function run($WP_Query)
+	{
+	}
+
+
+
+	/********************************** PRE_TICKET_SALES  **********************************/
+
+
+	/**
+	 * Retrieves grand totals from the line items that have no TXN ID
+	 * and timestamps less than the current time minus the session lifespan.
+	 * These are carts that have been abandoned before the "registrant" even attempted to checkout.
+	 * We're going to release the tickets for these line items before attempting to add more to the cart.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 */
+	public static function release_tickets_for_expired_carts()
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+		}
+		do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
+		$expired_ticket_IDs = array();
+		/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+		$session_lifespan = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\values\session\SessionLifespan'
+		);
+		$timestamp = $session_lifespan->expiration();
+		$expired_ticket_line_items = EEM_Line_Item::instance()->getTicketLineItemsForExpiredCarts($timestamp);
+		if (self::debug) {
+			echo self::$nl . ' . time(): ' . time();
+			echo self::$nl . ' . time() as date: ' . date('Y-m-d H:i a');
+			echo self::$nl . ' . session expiration: ' . $session_lifespan->expiration();
+			echo self::$nl . ' . session expiration as date: ' . date('Y-m-d H:i a', $session_lifespan->expiration());
+			echo self::$nl . ' . timestamp: ' . $timestamp;
+			echo self::$nl . ' . $expired_ticket_line_items: ' . count($expired_ticket_line_items);
+		}
+		if (! empty($expired_ticket_line_items)) {
+			foreach ($expired_ticket_line_items as $expired_ticket_line_item) {
+				if (! $expired_ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				$expired_ticket_IDs[ $expired_ticket_line_item->OBJ_ID() ] = $expired_ticket_line_item->OBJ_ID();
+				if (self::debug) {
+					echo self::$nl . ' . $expired_ticket_line_item->OBJ_ID(): ' . $expired_ticket_line_item->OBJ_ID();
+					echo self::$nl . ' . $expired_ticket_line_item->timestamp(): '
+						 . date(
+							 'Y-m-d h:i a',
+							 $expired_ticket_line_item->timestamp(true)
+						 );
+				}
+			}
+			if (! empty($expired_ticket_IDs)) {
+				EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+					\EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
+					array(),
+					__FUNCTION__
+				);
+				// now  let's get rid of expired line items so that they can't interfere with tracking
+				EED_Ticket_Sales_Monitor::clear_expired_line_items_with_no_transaction($timestamp);
+			}
+		}
+		do_action(
+			'AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__end',
+			$expired_ticket_IDs,
+			$expired_ticket_line_items
+		);
+	}
+
+
+
+	/********************************** VALIDATE_TICKET_SALE  **********************************/
+
+
+	/**
+	 * callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
+	 *
+	 * @param int       $qty
+	 * @param EE_Ticket $ticket
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
+	{
+		$qty = absint($qty);
+		if ($qty > 0) {
+			$qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
+		}
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+			echo self::$nl . self::$nl . '<b> RETURNED QTY: ' . $qty . '</b>';
+		}
+		return $qty;
+	}
+
+
+	/**
+	 * checks whether an individual ticket is available for purchase based on datetime, and ticket details
+	 *
+	 * @param   EE_Ticket $ticket
+	 * @param int         $qty
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		if (! $ticket instanceof EE_Ticket) {
+			return 0;
+		}
+		if (self::debug) {
+			echo self::$nl . '<b> . ticket->ID: ' . $ticket->ID() . '</b>';
+			echo self::$nl . ' . original ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->refresh_from_db();
+		// first let's determine the ticket availability based on sales
+		$available = $ticket->qty('saleable');
+		if (self::debug) {
+			echo self::$nl . ' . . . ticket->qty: ' . $ticket->qty();
+			echo self::$nl . ' . . . ticket->sold: ' . $ticket->sold();
+			echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
+			echo self::$nl . ' . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
+			echo self::$nl . ' . . . available: ' . $available;
+		}
+		if ($available < 1) {
+			$this->_ticket_sold_out($ticket);
+			return 0;
+		}
+		if (self::debug) {
+			echo self::$nl . ' . . . qty: ' . $qty;
+		}
+		if ($available < $qty) {
+			$qty = $available;
+			if (self::debug) {
+				echo self::$nl . ' . . . QTY ADJUSTED: ' . $qty;
+			}
+			$this->_ticket_quantity_decremented($ticket);
+		}
+		$this->_reserve_ticket($ticket, $qty);
+		return $qty;
+	}
+
+
+	/**
+	 * increments ticket reserved based on quantity passed
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @param int          $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . ' . . . INCREASE RESERVED: ' . $quantity;
+		}
+		$ticket->increase_reserved($quantity, 'TicketSalesMonitor:' . __LINE__);
+		return $ticket->save();
+	}
+
+
+	/**
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo self::$nl . ' . . . ticket->ID: ' . $ticket->ID();
+			echo self::$nl . ' . . . ticket->reserved before: ' . $ticket->reserved();
+		}
+		$ticket->decrease_reserved($quantity, true, 'TicketSalesMonitor:' . __LINE__);
+		if (self::debug) {
+			echo self::$nl . ' . . . ticket->reserved after: ' . $ticket->reserved();
+		}
+		return $ticket->save() ? 1 : 0;
+	}
+
+
+	/**
+	 * removes quantities within the ticket selector based on zero ticket availability
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return    void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_sold_out(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+	/**
+	 * adjusts quantities within the ticket selector based on decreased ticket availability
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_quantity_decremented(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+	/**
+	 * builds string out of ticket and event name
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_and_event_name(EE_Ticket $ticket)
+	{
+		$event = $ticket->get_related_event();
+		if ($event instanceof EE_Event) {
+			$ticket_name = sprintf(
+				_x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
+				$ticket->name(),
+				$event->name()
+			);
+		} else {
+			$ticket_name = $ticket->name();
+		}
+		return $ticket_name;
+	}
+
+
+
+	/********************************** EVENT CART  **********************************/
+
+
+	/**
+	 * releases or reserves ticket(s) based on quantity passed
+	 *
+	 * @param  EE_Line_Item $line_item
+	 * @param  int          $quantity
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
+	{
+		$ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
+		if ($ticket instanceof EE_Ticket) {
+			$ticket->add_extra_meta(
+				EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+				__LINE__ . ') ' . __METHOD__ . '()'
+			);
+			if ($quantity > 0) {
+				EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
+			} else {
+				EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+			}
+		}
+	}
+
+
+	/**
+	 * releases reserved ticket(s) based on quantity passed
+	 *
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
+	{
+		$ticket->add_extra_meta(
+			EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+			__LINE__ . ') ' . __METHOD__ . '()'
+		);
+		EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+	}
+
+
+
+	/********************************** POST_NOTICES  **********************************/
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function post_notices()
+	{
+		EED_Ticket_Sales_Monitor::instance()->_post_notices();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _post_notices()
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$refresh_msg = '';
+		$none_added_msg = '';
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$refresh_msg = __(
+				'Please refresh the page to view updated ticket quantities.',
+				'event_espresso'
+			);
+			$none_added_msg = __('No tickets were added for the event.', 'event_espresso');
+		}
+		if (! empty($this->sold_out_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
+						__(
+							'We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso'
+						)
+					),
+					'<br />',
+					implode('<br />', $this->sold_out_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			// alter code flow in the Ticket Selector for better UX
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
+			$this->sold_out_tickets = array();
+			// and reset the cart
+			EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
+		}
+		if (! empty($this->decremented_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
+						__(
+							'We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso'
+						)
+					),
+					'<br />',
+					implode('<br />', $this->decremented_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			$this->decremented_tickets = array();
+		}
+	}
+
+
+
+	/********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
+
+
+	/**
+	 * releases reserved tickets for all registrations of an EE_Transaction
+	 * by default, will NOT release tickets for finalized transactions
+	 *
+	 * @param    EE_Transaction $transaction
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . transaction->ID: ' . $transaction->ID();
+			echo self::$nl . ' . TXN status_ID: ' . $transaction->status_ID();
+		}
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		if (self::debug) {
+			// DEBUG LOG
+			EEH_Debug_Tools::log(
+				__CLASS__,
+				__FUNCTION__,
+				__LINE__,
+				array('finalized' => $finalized),
+				false,
+				'EE_Transaction: ' . $transaction->ID()
+			);
+		}
+		// how many tickets were released
+		$count = 0;
+		if (self::debug) {
+			echo self::$nl . ' . . . TXN finalized: ' . $finalized;
+		}
+		$release_tickets_with_TXN_status = array(
+			EEM_Transaction::failed_status_code,
+			EEM_Transaction::abandoned_status_code,
+			EEM_Transaction::incomplete_status_code,
+		);
+		$events = array();
+		// if the session is getting cleared BEFORE the TXN has been finalized or the transaction is not completed
+		if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+			// cancel any reserved tickets for registrations that were not approved
+			$registrations = $transaction->registrations();
+			if (self::debug) {
+				echo self::$nl . ' . . . # registrations: ' . count($registrations);
+				$reg = reset($registrations);
+				$ticket = $reg->ticket();
+				if ($ticket instanceof EE_Ticket) {
+					$ticket->add_extra_meta(
+						EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+						__LINE__ . ') Release All Tickets TXN:' . $transaction->ID()
+					);
+				}
+			}
+			if (! empty($registrations)) {
+				foreach ($registrations as $registration) {
+					if ($registration instanceof EE_Registration
+						&& $this->_release_reserved_ticket_for_registration($registration, $transaction)
+					) {
+						$count++;
+						$events[ $registration->event_ID() ] = $registration->event();
+					}
+				}
+			}
+		}
+		if ($events !== array()) {
+			foreach ($events as $event) {
+				/** @var EE_Event $event */
+				$event->perform_sold_out_status_check();
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * releases reserved tickets for an EE_Registration
+	 * by default, will NOT release tickets for APPROVED registrations
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Transaction  $transaction
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function _release_reserved_ticket_for_registration(
+		EE_Registration $registration,
+		EE_Transaction $transaction
+	) {
+		$STS_ID = $transaction->status_ID();
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . . registration->ID: ' . $registration->ID();
+			echo self::$nl . ' . . registration->status_ID: ' . $registration->status_ID();
+			echo self::$nl . ' . . transaction->status_ID(): ' . $STS_ID;
+		}
+		if (// release Tickets for Failed Transactions and Abandoned Transactions
+			$STS_ID === EEM_Transaction::failed_status_code
+			|| $STS_ID === EEM_Transaction::abandoned_status_code
+			|| (
+				// also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
+				$STS_ID === EEM_Transaction::incomplete_status_code
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+			)
+		) {
+			if (self::debug) {
+				echo self::$nl . self::$nl . ' . . RELEASE RESERVED TICKET';
+				$rsrvd = $registration->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
+				echo self::$nl . ' . . . registration HAS_RESERVED_TICKET_KEY: ';
+				var_dump($rsrvd);
+			}
+			$registration->release_reserved_ticket(true, 'TicketSalesMonitor:' . __LINE__);
+			return 1;
+		}
+		return 0;
+	}
+
+
+
+	/********************************** SESSION_CART_RESET  **********************************/
+
+
+	/**
+	 * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
+	 *
+	 * @param EE_Session $session
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function session_cart_reset(EE_Session $session)
+	{
+		// don't release tickets if checkout was already reset
+		if (did_action('AHEE__EE_Session__reset_checkout__before_reset')) {
+			return;
+		}
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		// first check of the session has a valid Checkout object
+		$checkout = $session->checkout();
+		if ($checkout instanceof EE_Checkout) {
+			// and use that to clear ticket reservations because it will update the associated registration meta data
+			EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
+			return;
+		}
+		$cart = $session->cart();
+		if ($cart instanceof EE_Cart) {
+			if (self::debug) {
+				echo self::$nl . self::$nl . ' cart instance of EE_Cart: ';
+			}
+			EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart, $session);
+		} else {
+			if (self::debug) {
+				echo self::$nl . self::$nl . ' invalid EE_Cart: ';
+				var_export($cart, true);
+			}
+		}
+	}
+
+
+	/**
+	 * releases reserved tickets in the EE_Cart
+	 *
+	 * @param EE_Cart $cart
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _session_cart_reset(EE_Cart $cart, EE_Session $session)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$ticket_line_items = $cart->get_tickets();
+		if (empty($ticket_line_items)) {
+			return;
+		}
+		if (self::debug) {
+			echo '<br /> . ticket_line_item count: ' . count($ticket_line_items);
+		}
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (self::debug) {
+				echo self::$nl . ' . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+			}
+			if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
+				if (self::debug) {
+					echo self::$nl . ' . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+				}
+				$ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
+				if ($ticket instanceof EE_Ticket) {
+					if (self::debug) {
+						echo self::$nl . ' . . ticket->ID(): ' . $ticket->ID();
+						echo self::$nl . ' . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+					}
+					$ticket->add_extra_meta(
+						EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+						__LINE__ . ') ' . __METHOD__ . '() SID = ' . $session->id()
+					);
+					$this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
+				}
+			}
+		}
+		if (self::debug) {
+			echo self::$nl . self::$nl . ' RESET COMPLETED ';
+		}
+	}
+
+
+
+	/********************************** SESSION_CHECKOUT_RESET  **********************************/
+
+
+	/**
+	 * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
+	 *
+	 * @param EE_Session $session
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	public static function session_checkout_reset(EE_Session $session)
+	{
+		// don't release tickets if cart was already reset
+		if (did_action('AHEE__EE_Session__reset_cart__before_reset')) {
+			return;
+		}
+		$checkout = $session->checkout();
+		if ($checkout instanceof EE_Checkout) {
+			EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
+		}
+	}
+
+
+	/**
+	 * releases reserved tickets for the EE_Checkout->transaction
+	 *
+	 * @param EE_Checkout $checkout
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	protected function _session_checkout_reset(EE_Checkout $checkout)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		// we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
+		if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
+			return;
+		}
+		$this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
+	}
+
+
+
+	/********************************** SESSION_EXPIRED_RESET  **********************************/
+
+
+	/**
+	 * @param    EE_Session $session
+	 * @return    void
+	 */
+	public static function session_expired_reset(EE_Session $session)
+	{
+	}
+
+
+
+	/********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
+
+
+	/**
+	 * releases reserved tickets for all registrations of an ABANDONED EE_Transaction
+	 * by default, will NOT release tickets for free transactions, or any that have received a payment
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	public static function process_abandoned_transactions(EE_Transaction $transaction)
+	{
+		// is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
+		if ($transaction->is_free() || $transaction->paid() > 0) {
+			if (self::debug) {
+				// DEBUG LOG
+				EEH_Debug_Tools::log(
+					__CLASS__,
+					__FUNCTION__,
+					__LINE__,
+					array($transaction),
+					false,
+					'EE_Transaction: ' . $transaction->ID()
+				);
+			}
+			return;
+		}
+		// have their been any successful payments made ?
+		$payments = $transaction->payments();
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
+				if (self::debug) {
+					// DEBUG LOG
+					EEH_Debug_Tools::log(
+						__CLASS__,
+						__FUNCTION__,
+						__LINE__,
+						array($payment),
+						false,
+						'EE_Transaction: ' . $transaction->ID()
+					);
+				}
+				return;
+			}
+		}
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
+
+
+	/**
+	 * releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	public static function process_failed_transactions(EE_Transaction $transaction)
+	{
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** RESET RESERVATION COUNTS  *********************************/
+
+
+	/**
+	 * Resets all ticket and datetime reserved counts to zero
+	 * Tickets that are currently associated with a Transaction that is in progress
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws UnexpectedEntityException
+	 */
+	public static function reset_reservation_counts()
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		/** @var EE_Transaction[] $transactions_not_in_progress */
+		$transactions_not_in_progress = EEM_Transaction::instance()->get_transactions_not_in_progress();
+		foreach ($transactions_not_in_progress as $transaction) {
+			// if this TXN has been fully completed, then skip it
+			if ($transaction->reg_step_completed('finalize_registration')) {
+				continue;
+			}
+			$total_line_item = $transaction->total_line_item();
+			// $transaction_in_progress->line
+			if (! $total_line_item instanceof EE_Line_Item) {
+				throw new DomainException(
+					esc_html__(
+						'Transaction does not have a valid Total Line Item associated with it.',
+						'event_espresso'
+					)
+				);
+			}
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		$total_line_items = EEM_Line_Item::instance()->get_total_line_items_for_active_carts();
+		foreach ($total_line_items as $total_line_item) {
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		$tickets_with_reservations = EEM_Ticket::instance()->get_tickets_with_reservations();
+		return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+			$tickets_with_reservations,
+			$valid_reserved_tickets,
+			__FUNCTION__
+		);
+	}
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @return EE_Line_Item[]
+	 */
+	private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		$ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if ($ticket_line_item instanceof EE_Line_Item) {
+				$valid_reserved_tickets[] = $ticket_line_item;
+			}
+		}
+		return $valid_reserved_tickets;
+	}
+
+
+	/**
+	 * @param EE_Ticket[]    $tickets_with_reservations
+	 * @param EE_Line_Item[] $valid_reserved_ticket_line_items
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	private static function release_reservations_for_tickets(
+		array $tickets_with_reservations,
+		array $valid_reserved_ticket_line_items = array(),
+		$source
+	) {
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+		}
+		$total_tickets_released = 0;
+		$sold_out_events = array();
+		foreach ($tickets_with_reservations as $ticket_with_reservations) {
+			if (! $ticket_with_reservations instanceof EE_Ticket) {
+				continue;
+			}
+			$reserved_qty = $ticket_with_reservations->reserved();
+			if (self::debug) {
+				echo self::$nl . ' . $ticket_with_reservations->ID(): ' . $ticket_with_reservations->ID();
+				echo self::$nl . ' . $reserved_qty: ' . $reserved_qty;
+			}
+			foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
+				if ($valid_reserved_ticket_line_item instanceof EE_Line_Item
+					&& $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
+				) {
+					if (self::debug) {
+						echo self::$nl . ' . $valid_reserved_ticket_line_item->quantity(): '
+							 . $valid_reserved_ticket_line_item->quantity();
+					}
+					$reserved_qty -= $valid_reserved_ticket_line_item->quantity();
+				}
+			}
+			if ($reserved_qty > 0) {
+				$ticket_with_reservations->add_extra_meta(
+					EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+					__LINE__ . ') ' . $source . '()'
+				);
+				$ticket_with_reservations->decrease_reserved($reserved_qty, true, 'TicketSalesMonitor:' . __LINE__);
+				$ticket_with_reservations->save();
+				$total_tickets_released += $reserved_qty;
+				$event = $ticket_with_reservations->get_related_event();
+				// track sold out events
+				if ($event instanceof EE_Event && $event->is_sold_out()) {
+					$sold_out_events[] = $event;
+				}
+			}
+		}
+		if (self::debug) {
+			echo self::$nl . ' . $total_tickets_released: ' . $total_tickets_released;
+		}
+		// double check whether sold out events should remain sold out after releasing tickets
+		if ($sold_out_events !== array()) {
+			foreach ($sold_out_events as $sold_out_event) {
+				/** @var EE_Event $sold_out_event */
+				$sold_out_event->perform_sold_out_status_check();
+			}
+		}
+		return $total_tickets_released;
+	}
+
+
+
+	/********************************** SHUTDOWN  **********************************/
+
+
+	/**
+	 * @param int $timestamp
+	 * @return false|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function clear_expired_line_items_with_no_transaction($timestamp = 0)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		if (! absint($timestamp)) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$timestamp = $session_lifespan->expiration();
+		}
+		return $wpdb->query(
+			$wpdb->prepare(
+				'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
                 WHERE TXN_ID = 0 AND LIN_timestamp <= %s',
-                // use GMT time because that's what LIN_timestamps are in
-                date('Y-m-d H:i:s', $timestamp)
-            )
-        );
-    }
+				// use GMT time because that's what LIN_timestamps are in
+				date('Y-m-d H:i:s', $timestamp)
+			)
+		);
+	}
 }

Spacing +83 added lines, -83 removed lines

@@ -182,7 +182,7 @@ 
     public static function release_tickets_for_expired_carts()
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'()';
         }
         do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
         $expired_ticket_IDs = array();
@@ -193,29 +193,29 @@ 
         $timestamp = $session_lifespan->expiration();
         $expired_ticket_line_items = EEM_Line_Item::instance()->getTicketLineItemsForExpiredCarts($timestamp);
         if (self::debug) {
-            echo self::$nl . ' . time(): ' . time();
-            echo self::$nl . ' . time() as date: ' . date('Y-m-d H:i a');
-            echo self::$nl . ' . session expiration: ' . $session_lifespan->expiration();
-            echo self::$nl . ' . session expiration as date: ' . date('Y-m-d H:i a', $session_lifespan->expiration());
-            echo self::$nl . ' . timestamp: ' . $timestamp;
-            echo self::$nl . ' . $expired_ticket_line_items: ' . count($expired_ticket_line_items);
+            echo self::$nl.' . time(): '.time();
+            echo self::$nl.' . time() as date: '.date('Y-m-d H:i a');
+            echo self::$nl.' . session expiration: '.$session_lifespan->expiration();
+            echo self::$nl.' . session expiration as date: '.date('Y-m-d H:i a', $session_lifespan->expiration());
+            echo self::$nl.' . timestamp: '.$timestamp;
+            echo self::$nl.' . $expired_ticket_line_items: '.count($expired_ticket_line_items);
         }
-        if (! empty($expired_ticket_line_items)) {
+        if ( ! empty($expired_ticket_line_items)) {
             foreach ($expired_ticket_line_items as $expired_ticket_line_item) {
-                if (! $expired_ticket_line_item instanceof EE_Line_Item) {
+                if ( ! $expired_ticket_line_item instanceof EE_Line_Item) {
                     continue;
                 }
-                $expired_ticket_IDs[ $expired_ticket_line_item->OBJ_ID() ] = $expired_ticket_line_item->OBJ_ID();
+                $expired_ticket_IDs[$expired_ticket_line_item->OBJ_ID()] = $expired_ticket_line_item->OBJ_ID();
                 if (self::debug) {
-                    echo self::$nl . ' . $expired_ticket_line_item->OBJ_ID(): ' . $expired_ticket_line_item->OBJ_ID();
-                    echo self::$nl . ' . $expired_ticket_line_item->timestamp(): '
+                    echo self::$nl.' . $expired_ticket_line_item->OBJ_ID(): '.$expired_ticket_line_item->OBJ_ID();
+                    echo self::$nl.' . $expired_ticket_line_item->timestamp(): '
                          . date(
                              'Y-m-d h:i a',
                              $expired_ticket_line_item->timestamp(true)
                          );
                 }
             }
-            if (! empty($expired_ticket_IDs)) {
+            if ( ! empty($expired_ticket_IDs)) {
                 EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
                     \EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
                     array(),
@@ -253,8 +253,8 @@ 
             $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
         }
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-            echo self::$nl . self::$nl . '<b> RETURNED QTY: ' . $qty . '</b>';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'()';
+            echo self::$nl.self::$nl.'<b> RETURNED QTY: '.$qty.'</b>';
         }
         return $qty;
     }
@@ -272,36 +272,36 @@ 
     protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             return 0;
         }
         if (self::debug) {
-            echo self::$nl . '<b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo self::$nl . ' . original ticket->reserved: ' . $ticket->reserved();
+            echo self::$nl.'<b> . ticket->ID: '.$ticket->ID().'</b>';
+            echo self::$nl.' . original ticket->reserved: '.$ticket->reserved();
         }
         $ticket->refresh_from_db();
         // first let's determine the ticket availability based on sales
         $available = $ticket->qty('saleable');
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->qty: ' . $ticket->qty();
-            echo self::$nl . ' . . . ticket->sold: ' . $ticket->sold();
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
-            echo self::$nl . ' . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo self::$nl . ' . . . available: ' . $available;
+            echo self::$nl.' . . . ticket->qty: '.$ticket->qty();
+            echo self::$nl.' . . . ticket->sold: '.$ticket->sold();
+            echo self::$nl.' . . . ticket->reserved: '.$ticket->reserved();
+            echo self::$nl.' . . . ticket->qty(saleable): '.$ticket->qty('saleable');
+            echo self::$nl.' . . . available: '.$available;
         }
         if ($available < 1) {
             $this->_ticket_sold_out($ticket);
             return 0;
         }
         if (self::debug) {
-            echo self::$nl . ' . . . qty: ' . $qty;
+            echo self::$nl.' . . . qty: '.$qty;
         }
         if ($available < $qty) {
             $qty = $available;
             if (self::debug) {
-                echo self::$nl . ' . . . QTY ADJUSTED: ' . $qty;
+                echo self::$nl.' . . . QTY ADJUSTED: '.$qty;
             }
             $this->_ticket_quantity_decremented($ticket);
         }
@@ -321,9 +321,9 @@ 
     protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . ' . . . INCREASE RESERVED: ' . $quantity;
+            echo self::$nl.self::$nl.' . . . INCREASE RESERVED: '.$quantity;
         }
-        $ticket->increase_reserved($quantity, 'TicketSalesMonitor:' . __LINE__);
+        $ticket->increase_reserved($quantity, 'TicketSalesMonitor:'.__LINE__);
         return $ticket->save();
     }
 
@@ -337,12 +337,12 @@ 
     protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
     {
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->ID: ' . $ticket->ID();
-            echo self::$nl . ' . . . ticket->reserved before: ' . $ticket->reserved();
+            echo self::$nl.' . . . ticket->ID: '.$ticket->ID();
+            echo self::$nl.' . . . ticket->reserved before: '.$ticket->reserved();
         }
-        $ticket->decrease_reserved($quantity, true, 'TicketSalesMonitor:' . __LINE__);
+        $ticket->decrease_reserved($quantity, true, 'TicketSalesMonitor:'.__LINE__);
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->reserved after: ' . $ticket->reserved();
+            echo self::$nl.' . . . ticket->reserved after: '.$ticket->reserved();
         }
         return $ticket->save() ? 1 : 0;
     }
@@ -359,8 +359,8 @@ 
     protected function _ticket_sold_out(EE_Ticket $ticket)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -377,8 +377,8 @@ 
     protected function _ticket_quantity_decremented(EE_Ticket $ticket)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -429,7 +429,7 @@ 
         if ($ticket instanceof EE_Ticket) {
             $ticket->add_extra_meta(
                 EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                __LINE__ . ') ' . __METHOD__ . '()'
+                __LINE__.') '.__METHOD__.'()'
             );
             if ($quantity > 0) {
                 EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
@@ -452,7 +452,7 @@ 
     {
         $ticket->add_extra_meta(
             EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-            __LINE__ . ') ' . __METHOD__ . '()'
+            __LINE__.') '.__METHOD__.'()'
         );
         EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
     }
@@ -487,7 +487,7 @@ 
     protected function _post_notices()
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         $refresh_msg = '';
         $none_added_msg = '';
@@ -498,7 +498,7 @@ 
             );
             $none_added_msg = __('No tickets were added for the event.', 'event_espresso');
         }
-        if (! empty($this->sold_out_tickets)) {
+        if ( ! empty($this->sold_out_tickets)) {
             EE_Error::add_attention(
                 sprintf(
                     apply_filters(
@@ -521,7 +521,7 @@ 
             // and reset the cart
             EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
         }
-        if (! empty($this->decremented_tickets)) {
+        if ( ! empty($this->decremented_tickets)) {
             EE_Error::add_attention(
                 sprintf(
                     apply_filters(
@@ -558,9 +558,9 @@ 
     protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . transaction->ID: ' . $transaction->ID();
-            echo self::$nl . ' . TXN status_ID: ' . $transaction->status_ID();
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . transaction->ID: '.$transaction->ID();
+            echo self::$nl.' . TXN status_ID: '.$transaction->status_ID();
         }
         // check if 'finalize_registration' step has been completed...
         $finalized = $transaction->reg_step_completed('finalize_registration');
@@ -572,13 +572,13 @@ 
                 __LINE__,
                 array('finalized' => $finalized),
                 false,
-                'EE_Transaction: ' . $transaction->ID()
+                'EE_Transaction: '.$transaction->ID()
             );
         }
         // how many tickets were released
         $count = 0;
         if (self::debug) {
-            echo self::$nl . ' . . . TXN finalized: ' . $finalized;
+            echo self::$nl.' . . . TXN finalized: '.$finalized;
         }
         $release_tickets_with_TXN_status = array(
             EEM_Transaction::failed_status_code,
@@ -587,27 +587,27 @@ 
         );
         $events = array();
         // if the session is getting cleared BEFORE the TXN has been finalized or the transaction is not completed
-        if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+        if ( ! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
             // cancel any reserved tickets for registrations that were not approved
             $registrations = $transaction->registrations();
             if (self::debug) {
-                echo self::$nl . ' . . . # registrations: ' . count($registrations);
+                echo self::$nl.' . . . # registrations: '.count($registrations);
                 $reg = reset($registrations);
                 $ticket = $reg->ticket();
                 if ($ticket instanceof EE_Ticket) {
                     $ticket->add_extra_meta(
                         EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') Release All Tickets TXN:' . $transaction->ID()
+                        __LINE__.') Release All Tickets TXN:'.$transaction->ID()
                     );
                 }
             }
-            if (! empty($registrations)) {
+            if ( ! empty($registrations)) {
                 foreach ($registrations as $registration) {
                     if ($registration instanceof EE_Registration
                         && $this->_release_reserved_ticket_for_registration($registration, $transaction)
                     ) {
                         $count++;
-                        $events[ $registration->event_ID() ] = $registration->event();
+                        $events[$registration->event_ID()] = $registration->event();
                     }
                 }
             }
@@ -637,10 +637,10 @@ 
     ) {
         $STS_ID = $transaction->status_ID();
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . registration->ID: ' . $registration->ID();
-            echo self::$nl . ' . . registration->status_ID: ' . $registration->status_ID();
-            echo self::$nl . ' . . transaction->status_ID(): ' . $STS_ID;
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . registration->ID: '.$registration->ID();
+            echo self::$nl.' . . registration->status_ID: '.$registration->status_ID();
+            echo self::$nl.' . . transaction->status_ID(): '.$STS_ID;
         }
         if (// release Tickets for Failed Transactions and Abandoned Transactions
             $STS_ID === EEM_Transaction::failed_status_code
@@ -652,12 +652,12 @@ 
             )
         ) {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' . . RELEASE RESERVED TICKET';
+                echo self::$nl.self::$nl.' . . RELEASE RESERVED TICKET';
                 $rsrvd = $registration->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
-                echo self::$nl . ' . . . registration HAS_RESERVED_TICKET_KEY: ';
+                echo self::$nl.' . . . registration HAS_RESERVED_TICKET_KEY: ';
                 var_dump($rsrvd);
             }
-            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:' . __LINE__);
+            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:'.__LINE__);
             return 1;
         }
         return 0;
@@ -686,7 +686,7 @@ 
             return;
         }
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         // first check of the session has a valid Checkout object
         $checkout = $session->checkout();
@@ -698,12 +698,12 @@ 
         $cart = $session->cart();
         if ($cart instanceof EE_Cart) {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' cart instance of EE_Cart: ';
+                echo self::$nl.self::$nl.' cart instance of EE_Cart: ';
             }
             EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart, $session);
         } else {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' invalid EE_Cart: ';
+                echo self::$nl.self::$nl.' invalid EE_Cart: ';
                 var_export($cart, true);
             }
         }
@@ -724,39 +724,39 @@ 
     protected function _session_cart_reset(EE_Cart $cart, EE_Session $session)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         $ticket_line_items = $cart->get_tickets();
         if (empty($ticket_line_items)) {
             return;
         }
         if (self::debug) {
-            echo '<br /> . ticket_line_item count: ' . count($ticket_line_items);
+            echo '<br /> . ticket_line_item count: '.count($ticket_line_items);
         }
         foreach ($ticket_line_items as $ticket_line_item) {
             if (self::debug) {
-                echo self::$nl . ' . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+                echo self::$nl.' . ticket_line_item->ID(): '.$ticket_line_item->ID();
             }
             if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
                 if (self::debug) {
-                    echo self::$nl . ' . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+                    echo self::$nl.' . . ticket_line_item->OBJ_ID(): '.$ticket_line_item->OBJ_ID();
                 }
                 $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
                 if ($ticket instanceof EE_Ticket) {
                     if (self::debug) {
-                        echo self::$nl . ' . . ticket->ID(): ' . $ticket->ID();
-                        echo self::$nl . ' . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+                        echo self::$nl.' . . ticket->ID(): '.$ticket->ID();
+                        echo self::$nl.' . . ticket_line_item->quantity(): '.$ticket_line_item->quantity();
                     }
                     $ticket->add_extra_meta(
                         EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') ' . __METHOD__ . '() SID = ' . $session->id()
+                        __LINE__.') '.__METHOD__.'() SID = '.$session->id()
                     );
                     $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
                 }
             }
         }
         if (self::debug) {
-            echo self::$nl . self::$nl . ' RESET COMPLETED ';
+            echo self::$nl.self::$nl.' RESET COMPLETED ';
         }
     }
 
@@ -797,7 +797,7 @@ 
     protected function _session_checkout_reset(EE_Checkout $checkout)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
         if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
@@ -845,7 +845,7 @@ 
                     __LINE__,
                     array($transaction),
                     false,
-                    'EE_Transaction: ' . $transaction->ID()
+                    'EE_Transaction: '.$transaction->ID()
                 );
             }
             return;
@@ -862,7 +862,7 @@ 
                         __LINE__,
                         array($payment),
                         false,
-                        'EE_Transaction: ' . $transaction->ID()
+                        'EE_Transaction: '.$transaction->ID()
                     );
                 }
                 return;
@@ -920,7 +920,7 @@ 
             }
             $total_line_item = $transaction->total_line_item();
             // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
+            if ( ! $total_line_item instanceof EE_Line_Item) {
                 throw new DomainException(
                     esc_html__(
                         'Transaction does not have a valid Total Line Item associated with it.',
@@ -979,25 +979,25 @@ 
         $source
     ) {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'()';
         }
         $total_tickets_released = 0;
         $sold_out_events = array();
         foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
+            if ( ! $ticket_with_reservations instanceof EE_Ticket) {
                 continue;
             }
             $reserved_qty = $ticket_with_reservations->reserved();
             if (self::debug) {
-                echo self::$nl . ' . $ticket_with_reservations->ID(): ' . $ticket_with_reservations->ID();
-                echo self::$nl . ' . $reserved_qty: ' . $reserved_qty;
+                echo self::$nl.' . $ticket_with_reservations->ID(): '.$ticket_with_reservations->ID();
+                echo self::$nl.' . $reserved_qty: '.$reserved_qty;
             }
             foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
                 if ($valid_reserved_ticket_line_item instanceof EE_Line_Item
                     && $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
                 ) {
                     if (self::debug) {
-                        echo self::$nl . ' . $valid_reserved_ticket_line_item->quantity(): '
+                        echo self::$nl.' . $valid_reserved_ticket_line_item->quantity(): '
                              . $valid_reserved_ticket_line_item->quantity();
                     }
                     $reserved_qty -= $valid_reserved_ticket_line_item->quantity();
@@ -1006,9 +1006,9 @@ 
             if ($reserved_qty > 0) {
                 $ticket_with_reservations->add_extra_meta(
                     EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                    __LINE__ . ') ' . $source . '()'
+                    __LINE__.') '.$source.'()'
                 );
-                $ticket_with_reservations->decrease_reserved($reserved_qty, true, 'TicketSalesMonitor:' . __LINE__);
+                $ticket_with_reservations->decrease_reserved($reserved_qty, true, 'TicketSalesMonitor:'.__LINE__);
                 $ticket_with_reservations->save();
                 $total_tickets_released += $reserved_qty;
                 $event = $ticket_with_reservations->get_related_event();
@@ -1019,7 +1019,7 @@ 
             }
         }
         if (self::debug) {
-            echo self::$nl . ' . $total_tickets_released: ' . $total_tickets_released;
+            echo self::$nl.' . $total_tickets_released: '.$total_tickets_released;
         }
         // double check whether sold out events should remain sold out after releasing tickets
         if ($sold_out_events !== array()) {
@@ -1048,7 +1048,7 @@ 
     {
         /** @type WPDB $wpdb */
         global $wpdb;
-        if (! absint($timestamp)) {
+        if ( ! absint($timestamp)) {
             /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
             $session_lifespan = LoaderFactory::getLoader()->getShared(
                 'EventEspresso\core\domain\values\session\SessionLifespan'
@@ -1057,7 +1057,7 @@ 
         }
         return $wpdb->query(
             $wpdb->prepare(
-                'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
+                'DELETE FROM '.EEM_Line_Item::instance()->table().'
                 WHERE TXN_ID = 0 AND LIN_timestamp <= %s',
                 // use GMT time because that's what LIN_timestamps are in
                 date('Y-m-d H:i:s', $timestamp)

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 +1328 added lines, -1328 removed lines

@@ -24,1326 +24,1326 @@ 
 class EE_Session implements SessionIdentifierInterface
 {
 
-    const session_id_prefix = 'ee_ssn_';
-
-    const hash_check_prefix = 'ee_shc_';
-
-    const OPTION_NAME_SETTINGS = 'ee_session_settings';
-
-    const STATUS_CLOSED = 0;
-
-    const STATUS_OPEN = 1;
-
-    const SAVE_STATE_CLEAN = 'clean';
-    const SAVE_STATE_DIRTY = 'dirty';
-
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @var EE_Session
-     */
-    private static $_instance;
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    protected $cache_storage;
-
-    /**
-     * @var EE_Encryption $encryption
-     */
-    protected $encryption;
-
-    /**
-     * @var SessionStartHandler $session_start_handler
-     */
-    protected $session_start_handler;
-
-    /**
-     * the session id
-     *
-     * @var string
-     */
-    private $_sid;
-
-    /**
-     * session id salt
-     *
-     * @var string
-     */
-    private $_sid_salt;
-
-    /**
-     * session data
-     *
-     * @var array
-     */
-    private $_session_data = array();
-
-    /**
-     * how long an EE session lasts
-     * default session lifespan of 1 hour (for not so instant IPNs)
-     *
-     * @var SessionLifespan $session_lifespan
-     */
-    private $session_lifespan;
-
-    /**
-     * session expiration time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_expiration;
-
-    /**
-     * whether or not session has expired at some point
-     *
-     * @var boolean
-     */
-    private $_expired = false;
-
-    /**
-     * current time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_time;
-
-    /**
-     * whether to encrypt session data
-     *
-     * @var bool
-     */
-    private $_use_encryption;
-
-    /**
-     * well... according to the server...
-     *
-     * @var null
-     */
-    private $_user_agent;
-
-    /**
-     * do you really trust the server ?
-     *
-     * @var null
-     */
-    private $_ip_address;
-
-    /**
-     * current WP user_id
-     *
-     * @var null
-     */
-    private $_wp_user_id;
-
-    /**
-     * array for defining default session vars
-     *
-     * @var array
-     */
-    private $_default_session_vars = array(
-        'id'            => null,
-        'user_id'       => null,
-        'ip_address'    => null,
-        'user_agent'    => null,
-        'init_access'   => null,
-        'last_access'   => null,
-        'expiration'    => null,
-        'pages_visited' => array(),
-    );
-
-    /**
-     * timestamp for when last garbage collection cycle was performed
-     *
-     * @var int $_last_gc
-     */
-    private $_last_gc;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * whether session is active or not
-     *
-     * @var int $status
-     */
-    private $status = EE_Session::STATUS_CLOSED;
-
-    /**
-     * whether session data has changed therefore requiring a session save
-     *
-     * @var string $save_state
-     */
-    private $save_state = EE_Session::SAVE_STATE_CLEAN;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan|null  $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param EE_Encryption         $encryption
-     * @return EE_Session
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instance(
-        CacheStorageInterface $cache_storage = null,
-        SessionLifespan $lifespan = null,
-        RequestInterface $request = null,
-        SessionStartHandler $session_start_handler = null,
-        EE_Encryption $encryption = null
-    ) {
-        // check if class object is instantiated
-        // session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
-        // add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! self::$_instance instanceof EE_Session
-            && $cache_storage instanceof CacheStorageInterface
-            && $lifespan instanceof SessionLifespan
-            && $request instanceof RequestInterface
-            && $session_start_handler instanceof SessionStartHandler
-            && apply_filters('FHEE_load_EE_Session', true)
-        ) {
-            self::$_instance = new self(
-                $cache_storage,
-                $lifespan,
-                $request,
-                $session_start_handler,
-                $encryption
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan       $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param EE_Encryption         $encryption
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function __construct(
-        CacheStorageInterface $cache_storage,
-        SessionLifespan $lifespan,
-        RequestInterface $request,
-        SessionStartHandler $session_start_handler,
-        EE_Encryption $encryption = null
-    ) {
-        // session loading is turned ON by default,
-        // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
-        // (which currently fires on the init hook at priority 9),
-        // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
-            return;
-        }
-        $this->session_start_handler = $session_start_handler;
-        $this->session_lifespan = $lifespan;
-        $this->request = $request;
-        if (! defined('ESPRESSO_SESSION')) {
-            define('ESPRESSO_SESSION', true);
-        }
-        // retrieve session options from db
-        $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
-            // cycle though existing session options
-            foreach ($session_settings as $var_name => $session_setting) {
-                // set values for class properties
-                $var_name = '_' . $var_name;
-                $this->{$var_name} = $session_setting;
-            }
-        }
-        $this->cache_storage = $cache_storage;
-        // are we using encryption?
-        $this->_use_encryption = $encryption instanceof EE_Encryption
-                                 && EE_Registry::instance()->CFG->admin->encode_session_data();
-        // encrypt data via: $this->encryption->encrypt();
-        $this->encryption = $encryption;
-        // filter hook allows outside functions/classes/plugins to change default empty cart
-        $extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
-        array_merge($this->_default_session_vars, $extra_default_session_vars);
-        // apply default session vars
-        $this->_set_defaults();
-        add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
-        // check request for 'clear_session' param
-        add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
-        // once everything is all said and done,
-        add_action('shutdown', array($this, 'update'), 100);
-        add_action('shutdown', array($this, 'garbageCollection'), 1000);
-        $this->configure_garbage_collection_filters();
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function isLoadedAndActive()
-    {
-        return did_action('AHEE__EE_System__core_loaded_and_ready')
-               && EE_Session::instance() instanceof EE_Session
-               && EE_Session::instance()->isActive();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActive()
-    {
-        return $this->status === EE_Session::STATUS_OPEN;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function open_session()
-    {
-        // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
-            // or just start a new one
-            $this->_create_espresso_session();
-        }
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function expired()
-    {
-        return $this->_expired;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function reset_expired()
-    {
-        $this->_expired = false;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function expiration()
-    {
-        return $this->_expiration;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function extension()
-    {
-        return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
-    }
-
-
-    /**
-     * @param int $time number of seconds to add to session expiration
-     */
-    public function extend_expiration($time = 0)
-    {
-        $time = $time ? $time : $this->extension();
-        $this->_expiration += absint($time);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function lifespan()
-    {
-        return $this->session_lifespan->inSeconds();
-    }
-
-
-    /**
-     * Marks whether the session data has been updated or not.
-     * Valid options are:
-     *      EE_Session::SAVE_STATE_CLEAN - session data remains unchanged and updating is not necessary
-     *      EE_Session::SAVE_STATE_DIRTY - session data has changed since last save and needs to be updated
-     * default value is EE_Session::SAVE_STATE_DIRTY
-     *
-     * @param string $save_state
-     */
-    public function setSaveState($save_state = EE_Session::SAVE_STATE_DIRTY)
-    {
-        $valid_save_states = [
-            EE_Session::SAVE_STATE_CLEAN,
-            EE_Session::SAVE_STATE_DIRTY,
-        ];
-        if (! in_array($save_state, $valid_save_states, true)) {
-            $save_state = EE_Session::SAVE_STATE_DIRTY;
-        }
-        $this->save_state = $save_state;
-    }
-
-
-
-    /**
-     * This just sets some defaults for the _session data property
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        // set some defaults
-        foreach ($this->_default_session_vars as $key => $default_var) {
-            if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
-            } else {
-                $this->_session_data[ $key ] = '';
-            }
-        }
-    }
-
-
-    /**
-     * @retrieve  session data
-     * @access    public
-     * @return    string
-     */
-    public function id()
-    {
-        return $this->_sid;
-    }
-
-
-    /**
-     * @param \EE_Cart $cart
-     * @return bool
-     */
-    public function set_cart(EE_Cart $cart)
-    {
-        $this->_session_data['cart'] = $cart;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_cart
-     */
-    public function reset_cart()
-    {
-        do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
-        $this->_session_data['cart'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return \EE_Cart
-     */
-    public function cart()
-    {
-        return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
-            ? $this->_session_data['cart']
-            : null;
-    }
-
-
-    /**
-     * @param \EE_Checkout $checkout
-     * @return bool
-     */
-    public function set_checkout(EE_Checkout $checkout)
-    {
-        $this->_session_data['checkout'] = $checkout;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_checkout
-     */
-    public function reset_checkout()
-    {
-        do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
-        $this->_session_data['checkout'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return \EE_Checkout
-     */
-    public function checkout()
-    {
-        return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
-            ? $this->_session_data['checkout']
-            : null;
-    }
-
-
-    /**
-     * @param \EE_Transaction $transaction
-     * @return bool
-     * @throws EE_Error
-     */
-    public function set_transaction(EE_Transaction $transaction)
-    {
-        // first remove the session from the transaction before we save the transaction in the session
-        $transaction->set_txn_session_data(null);
-        $this->_session_data['transaction'] = $transaction;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_transaction
-     */
-    public function reset_transaction()
-    {
-        do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
-        $this->_session_data['transaction'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return \EE_Transaction
-     */
-    public function transaction()
-    {
-        return isset($this->_session_data['transaction'])
-               && $this->_session_data['transaction'] instanceof EE_Transaction
-            ? $this->_session_data['transaction']
-            : null;
-    }
-
-
-    /**
-     * retrieve session data
-     *
-     * @param null $key
-     * @param bool $reset_cache
-     * @return array
-     */
-    public function get_session_data($key = null, $reset_cache = false)
-    {
-        if ($reset_cache) {
-            $this->reset_cart();
-            $this->reset_checkout();
-            $this->reset_transaction();
-        }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
-        }
-        return $this->_session_data;
-    }
-
-
-    /**
-     * Returns TRUE on success, FALSE on fail
-     *
-     * @param array $data
-     * @return bool
-     */
-    public function set_session_data($data)
-    {
-        // nothing ??? bad data ??? go home!
-        if (empty($data) || ! is_array($data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data or invalid session data was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Sorry! %s is a default session datum and can not be reset.',
-                            'event_espresso'
-                        ),
-                        $key
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $this->_session_data[ $key ] = $value;
-            $this->setSaveState();
-        }
-        return true;
-    }
-
-
-    /**
-     * @initiate session
-     * @access   private
-     * @return TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    private function _espresso_session()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->session_start_handler->startSession();
-        $this->status = EE_Session::STATUS_OPEN;
-        // get our modified session ID
-        $this->_sid = $this->_generate_session_id();
-        // and the visitors IP
-        $this->_ip_address = $this->request->ipAddress();
-        // set the "user agent"
-        $this->_user_agent = $this->request->userAgent();
-        // now let's retrieve what's in the db
-        $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
-            // get the current time in UTC
-            $this->_time = $this->_time !== null ? $this->_time : time();
-            // and reset the session expiration
-            $this->_expiration = isset($session_data['expiration'])
-                ? $session_data['expiration']
-                : $this->_time + $this->session_lifespan->inSeconds();
-        } else {
-            // set initial site access time and the session expiration
-            $this->_set_init_access_and_expiration();
-            // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = 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
-     * @throws RuntimeException
-     */
-    protected function _retrieve_session_data()
-    {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
-        try {
-            // we're using WP's Transient API to store session data using the PHP session ID as the option name
-            $session_data = $this->cache_storage->get($ssn_key, false);
-            if (empty($session_data)) {
-                return array();
-            }
-            if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-                $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
-                    false
-                );
-                if ($hash_check && $hash_check !== md5($session_data)) {
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                '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
-     * @throws ReflectionException
-     */
-    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
-     * @throws ReflectionException
-     */
-    private function _create_espresso_session()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
-        // use the update function for now with $new_session arg set to TRUE
-        return $this->update(true) ? true : false;
-    }
-
-    /**
-     * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
-     * too). This is used when determining if we want to save the session or not.
-     * @since 4.9.67.p
-     * @return bool
-     */
-    private function sessionHasStuffWorthSaving()
-    {
-        return $this->save_state === EE_Session::SAVE_STATE_DIRTY
-               // we may want to eventually remove the following
-               // on the assumption that the above check is enough
-               || $this->cart() instanceof EE_Cart
-               || (
-                   isset($this->_session_data['ee_notices'])
-                   && (
-                       ! empty($this->_session_data['ee_notices']['attention'])
-                       || ! empty($this->_session_data['ee_notices']['errors'])
-                       || ! empty($this->_session_data['ee_notices']['success'])
-                   )
-               );
-    }
-
-
-    /**
-     * _save_session_to_db
-     *
-     * @param bool $clear_session
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _save_session_to_db($clear_session = false)
-    {
-        // don't save sessions for crawlers
-        // and unless we're deleting the session data, don't save anything if there isn't a cart
-        if ($this->request->isBot()
-            || (
-                ! $clear_session
-                && ! $this->sessionHasStuffWorthSaving()
-                && apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
-            )
-        ) {
-            return false;
-        }
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
-                $transaction->save();
-            }
-            $this->_session_data['transaction'] = $transaction->ID();
-        }
-        // then serialize all of our session data
-        $session_data = serialize($this->_session_data);
-        // do we need to also encode it to avoid corrupted data when saved to the db?
-        $session_data = $this->_use_encryption
-            ? $this->encryption->base64_string_encode($session_data)
-            : $session_data;
-        // maybe save hash check
-        if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-            $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
-                md5($session_data),
-                $this->session_lifespan->inSeconds()
-            );
-        }
-        // we're using the Transient API for storing session data,
-        $saved = $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
-            $session_data,
-            $this->session_lifespan->inSeconds()
-        );
-        $this->setSaveState(EE_Session::SAVE_STATE_CLEAN);
-        return $saved;
-    }
-
-
-    /**
-     * @get    the full page request the visitor is accessing
-     * @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
-     * @throws ReflectionException
-     */
-    public function clear_session($class = '', $function = '')
-    {
+	const session_id_prefix = 'ee_ssn_';
+
+	const hash_check_prefix = 'ee_shc_';
+
+	const OPTION_NAME_SETTINGS = 'ee_session_settings';
+
+	const STATUS_CLOSED = 0;
+
+	const STATUS_OPEN = 1;
+
+	const SAVE_STATE_CLEAN = 'clean';
+	const SAVE_STATE_DIRTY = 'dirty';
+
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @var EE_Session
+	 */
+	private static $_instance;
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	protected $cache_storage;
+
+	/**
+	 * @var EE_Encryption $encryption
+	 */
+	protected $encryption;
+
+	/**
+	 * @var SessionStartHandler $session_start_handler
+	 */
+	protected $session_start_handler;
+
+	/**
+	 * the session id
+	 *
+	 * @var string
+	 */
+	private $_sid;
+
+	/**
+	 * session id salt
+	 *
+	 * @var string
+	 */
+	private $_sid_salt;
+
+	/**
+	 * session data
+	 *
+	 * @var array
+	 */
+	private $_session_data = array();
+
+	/**
+	 * how long an EE session lasts
+	 * default session lifespan of 1 hour (for not so instant IPNs)
+	 *
+	 * @var SessionLifespan $session_lifespan
+	 */
+	private $session_lifespan;
+
+	/**
+	 * session expiration time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_expiration;
+
+	/**
+	 * whether or not session has expired at some point
+	 *
+	 * @var boolean
+	 */
+	private $_expired = false;
+
+	/**
+	 * current time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_time;
+
+	/**
+	 * whether to encrypt session data
+	 *
+	 * @var bool
+	 */
+	private $_use_encryption;
+
+	/**
+	 * well... according to the server...
+	 *
+	 * @var null
+	 */
+	private $_user_agent;
+
+	/**
+	 * do you really trust the server ?
+	 *
+	 * @var null
+	 */
+	private $_ip_address;
+
+	/**
+	 * current WP user_id
+	 *
+	 * @var null
+	 */
+	private $_wp_user_id;
+
+	/**
+	 * array for defining default session vars
+	 *
+	 * @var array
+	 */
+	private $_default_session_vars = array(
+		'id'            => null,
+		'user_id'       => null,
+		'ip_address'    => null,
+		'user_agent'    => null,
+		'init_access'   => null,
+		'last_access'   => null,
+		'expiration'    => null,
+		'pages_visited' => array(),
+	);
+
+	/**
+	 * timestamp for when last garbage collection cycle was performed
+	 *
+	 * @var int $_last_gc
+	 */
+	private $_last_gc;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * whether session is active or not
+	 *
+	 * @var int $status
+	 */
+	private $status = EE_Session::STATUS_CLOSED;
+
+	/**
+	 * whether session data has changed therefore requiring a session save
+	 *
+	 * @var string $save_state
+	 */
+	private $save_state = EE_Session::SAVE_STATE_CLEAN;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan|null  $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param EE_Encryption         $encryption
+	 * @return EE_Session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function instance(
+		CacheStorageInterface $cache_storage = null,
+		SessionLifespan $lifespan = null,
+		RequestInterface $request = null,
+		SessionStartHandler $session_start_handler = null,
+		EE_Encryption $encryption = null
+	) {
+		// check if class object is instantiated
+		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
+		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! self::$_instance instanceof EE_Session
+			&& $cache_storage instanceof CacheStorageInterface
+			&& $lifespan instanceof SessionLifespan
+			&& $request instanceof RequestInterface
+			&& $session_start_handler instanceof SessionStartHandler
+			&& apply_filters('FHEE_load_EE_Session', true)
+		) {
+			self::$_instance = new self(
+				$cache_storage,
+				$lifespan,
+				$request,
+				$session_start_handler,
+				$encryption
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan       $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param EE_Encryption         $encryption
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function __construct(
+		CacheStorageInterface $cache_storage,
+		SessionLifespan $lifespan,
+		RequestInterface $request,
+		SessionStartHandler $session_start_handler,
+		EE_Encryption $encryption = null
+	) {
+		// session loading is turned ON by default,
+		// but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
+		// (which currently fires on the init hook at priority 9),
+		// can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! apply_filters('FHEE_load_EE_Session', true)) {
+			return;
+		}
+		$this->session_start_handler = $session_start_handler;
+		$this->session_lifespan = $lifespan;
+		$this->request = $request;
+		if (! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
+		}
+		// retrieve session options from db
+		$session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		if (! empty($session_settings)) {
+			// cycle though existing session options
+			foreach ($session_settings as $var_name => $session_setting) {
+				// set values for class properties
+				$var_name = '_' . $var_name;
+				$this->{$var_name} = $session_setting;
+			}
+		}
+		$this->cache_storage = $cache_storage;
+		// are we using encryption?
+		$this->_use_encryption = $encryption instanceof EE_Encryption
+								 && EE_Registry::instance()->CFG->admin->encode_session_data();
+		// encrypt data via: $this->encryption->encrypt();
+		$this->encryption = $encryption;
+		// filter hook allows outside functions/classes/plugins to change default empty cart
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
+		// apply default session vars
+		$this->_set_defaults();
+		add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
+		// check request for 'clear_session' param
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
+		// once everything is all said and done,
+		add_action('shutdown', array($this, 'update'), 100);
+		add_action('shutdown', array($this, 'garbageCollection'), 1000);
+		$this->configure_garbage_collection_filters();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function isLoadedAndActive()
+	{
+		return did_action('AHEE__EE_System__core_loaded_and_ready')
+			   && EE_Session::instance() instanceof EE_Session
+			   && EE_Session::instance()->isActive();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActive()
+	{
+		return $this->status === EE_Session::STATUS_OPEN;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function open_session()
+	{
+		// check for existing session and retrieve it from db
+		if (! $this->_espresso_session()) {
+			// or just start a new one
+			$this->_create_espresso_session();
+		}
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function expired()
+	{
+		return $this->_expired;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function reset_expired()
+	{
+		$this->_expired = false;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function expiration()
+	{
+		return $this->_expiration;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function extension()
+	{
+		return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
+	}
+
+
+	/**
+	 * @param int $time number of seconds to add to session expiration
+	 */
+	public function extend_expiration($time = 0)
+	{
+		$time = $time ? $time : $this->extension();
+		$this->_expiration += absint($time);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function lifespan()
+	{
+		return $this->session_lifespan->inSeconds();
+	}
+
+
+	/**
+	 * Marks whether the session data has been updated or not.
+	 * Valid options are:
+	 *      EE_Session::SAVE_STATE_CLEAN - session data remains unchanged and updating is not necessary
+	 *      EE_Session::SAVE_STATE_DIRTY - session data has changed since last save and needs to be updated
+	 * default value is EE_Session::SAVE_STATE_DIRTY
+	 *
+	 * @param string $save_state
+	 */
+	public function setSaveState($save_state = EE_Session::SAVE_STATE_DIRTY)
+	{
+		$valid_save_states = [
+			EE_Session::SAVE_STATE_CLEAN,
+			EE_Session::SAVE_STATE_DIRTY,
+		];
+		if (! in_array($save_state, $valid_save_states, true)) {
+			$save_state = EE_Session::SAVE_STATE_DIRTY;
+		}
+		$this->save_state = $save_state;
+	}
+
+
+
+	/**
+	 * This just sets some defaults for the _session data property
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		// set some defaults
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[ $key ] = array();
+			} else {
+				$this->_session_data[ $key ] = '';
+			}
+		}
+	}
+
+
+	/**
+	 * @retrieve  session data
+	 * @access    public
+	 * @return    string
+	 */
+	public function id()
+	{
+		return $this->_sid;
+	}
+
+
+	/**
+	 * @param \EE_Cart $cart
+	 * @return bool
+	 */
+	public function set_cart(EE_Cart $cart)
+	{
+		$this->_session_data['cart'] = $cart;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_cart
+	 */
+	public function reset_cart()
+	{
+		do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
+		$this->_session_data['cart'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return \EE_Cart
+	 */
+	public function cart()
+	{
+		return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
+			? $this->_session_data['cart']
+			: null;
+	}
+
+
+	/**
+	 * @param \EE_Checkout $checkout
+	 * @return bool
+	 */
+	public function set_checkout(EE_Checkout $checkout)
+	{
+		$this->_session_data['checkout'] = $checkout;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_checkout
+	 */
+	public function reset_checkout()
+	{
+		do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
+		$this->_session_data['checkout'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return \EE_Checkout
+	 */
+	public function checkout()
+	{
+		return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
+			? $this->_session_data['checkout']
+			: null;
+	}
+
+
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function set_transaction(EE_Transaction $transaction)
+	{
+		// first remove the session from the transaction before we save the transaction in the session
+		$transaction->set_txn_session_data(null);
+		$this->_session_data['transaction'] = $transaction;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_transaction
+	 */
+	public function reset_transaction()
+	{
+		do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
+		$this->_session_data['transaction'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return \EE_Transaction
+	 */
+	public function transaction()
+	{
+		return isset($this->_session_data['transaction'])
+			   && $this->_session_data['transaction'] instanceof EE_Transaction
+			? $this->_session_data['transaction']
+			: null;
+	}
+
+
+	/**
+	 * retrieve session data
+	 *
+	 * @param null $key
+	 * @param bool $reset_cache
+	 * @return array
+	 */
+	public function get_session_data($key = null, $reset_cache = false)
+	{
+		if ($reset_cache) {
+			$this->reset_cart();
+			$this->reset_checkout();
+			$this->reset_transaction();
+		}
+		if (! empty($key)) {
+			return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+		}
+		return $this->_session_data;
+	}
+
+
+	/**
+	 * Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array $data
+	 * @return bool
+	 */
+	public function set_session_data($data)
+	{
+		// nothing ??? bad data ??? go home!
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data or invalid session data was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		foreach ($data as $key => $value) {
+			if (isset($this->_default_session_vars[ $key ])) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Sorry! %s is a default session datum and can not be reset.',
+							'event_espresso'
+						),
+						$key
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$this->_session_data[ $key ] = $value;
+			$this->setSaveState();
+		}
+		return true;
+	}
+
+
+	/**
+	 * @initiate session
+	 * @access   private
+	 * @return TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	private function _espresso_session()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->session_start_handler->startSession();
+		$this->status = EE_Session::STATUS_OPEN;
+		// get our modified session ID
+		$this->_sid = $this->_generate_session_id();
+		// and the visitors IP
+		$this->_ip_address = $this->request->ipAddress();
+		// set the "user agent"
+		$this->_user_agent = $this->request->userAgent();
+		// now let's retrieve what's in the db
+		$session_data = $this->_retrieve_session_data();
+		if (! empty($session_data)) {
+			// get the current time in UTC
+			$this->_time = $this->_time !== null ? $this->_time : time();
+			// and reset the session expiration
+			$this->_expiration = isset($session_data['expiration'])
+				? $session_data['expiration']
+				: $this->_time + $this->session_lifespan->inSeconds();
+		} else {
+			// set initial site access time and the session expiration
+			$this->_set_init_access_and_expiration();
+			// set referer
+			$this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = 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
+	 * @throws RuntimeException
+	 */
+	protected function _retrieve_session_data()
+	{
+		$ssn_key = EE_Session::session_id_prefix . $this->_sid;
+		try {
+			// we're using WP's Transient API to store session data using the PHP session ID as the option name
+			$session_data = $this->cache_storage->get($ssn_key, false);
+			if (empty($session_data)) {
+				return array();
+			}
+			if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+				$hash_check = $this->cache_storage->get(
+					EE_Session::hash_check_prefix . $this->_sid,
+					false
+				);
+				if ($hash_check && $hash_check !== md5($session_data)) {
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'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
+	 * @throws ReflectionException
+	 */
+	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
+	 * @throws ReflectionException
+	 */
+	private function _create_espresso_session()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
+		// use the update function for now with $new_session arg set to TRUE
+		return $this->update(true) ? true : false;
+	}
+
+	/**
+	 * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
+	 * too). This is used when determining if we want to save the session or not.
+	 * @since 4.9.67.p
+	 * @return bool
+	 */
+	private function sessionHasStuffWorthSaving()
+	{
+		return $this->save_state === EE_Session::SAVE_STATE_DIRTY
+			   // we may want to eventually remove the following
+			   // on the assumption that the above check is enough
+			   || $this->cart() instanceof EE_Cart
+			   || (
+				   isset($this->_session_data['ee_notices'])
+				   && (
+					   ! empty($this->_session_data['ee_notices']['attention'])
+					   || ! empty($this->_session_data['ee_notices']['errors'])
+					   || ! empty($this->_session_data['ee_notices']['success'])
+				   )
+			   );
+	}
+
+
+	/**
+	 * _save_session_to_db
+	 *
+	 * @param bool $clear_session
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _save_session_to_db($clear_session = false)
+	{
+		// don't save sessions for crawlers
+		// and unless we're deleting the session data, don't save anything if there isn't a cart
+		if ($this->request->isBot()
+			|| (
+				! $clear_session
+				&& ! $this->sessionHasStuffWorthSaving()
+				&& apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
+			)
+		) {
+			return false;
+		}
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			if (! $transaction->ID()) {
+				$transaction->save();
+			}
+			$this->_session_data['transaction'] = $transaction->ID();
+		}
+		// then serialize all of our session data
+		$session_data = serialize($this->_session_data);
+		// do we need to also encode it to avoid corrupted data when saved to the db?
+		$session_data = $this->_use_encryption
+			? $this->encryption->base64_string_encode($session_data)
+			: $session_data;
+		// maybe save hash check
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+			$this->cache_storage->add(
+				EE_Session::hash_check_prefix . $this->_sid,
+				md5($session_data),
+				$this->session_lifespan->inSeconds()
+			);
+		}
+		// we're using the Transient API for storing session data,
+		$saved = $this->cache_storage->add(
+			EE_Session::session_id_prefix . $this->_sid,
+			$session_data,
+			$this->session_lifespan->inSeconds()
+		);
+		$this->setSaveState(EE_Session::SAVE_STATE_CLEAN);
+		return $saved;
+	}
+
+
+	/**
+	 * @get    the full page request the visitor is accessing
+	 * @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
+	 * @throws ReflectionException
+	 */
+	public function clear_session($class = '', $function = '')
+	{
 //         echo '
 // <h3 style="color:#999;line-height:.9em;">
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
-        $this->reset_cart();
-        $this->reset_checkout();
-        $this->reset_transaction();
-        // wipe out everything that isn't a default session datum
-        $this->reset_data(array_keys($this->_session_data));
-        // reset initial site access time and the session expiration
-        $this->_set_init_access_and_expiration();
-        $this->setSaveState();
-        $this->_save_session_to_db(true);
-    }
-
-
-    /**
-     * resets all non-default session vars. Returns TRUE on success, FALSE on fail
-     *
-     * @param array|mixed $data_to_reset
-     * @param bool        $show_all_notices
-     * @return bool
-     */
-    public function reset_data($data_to_reset = array(), $show_all_notices = false)
-    {
-        // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
-            $data_to_reset = array($data_to_reset);
-        }
-        // nothing ??? go home!
-        if (empty($data_to_reset)) {
-            EE_Error::add_error(
-                __(
-                    'No session data could be reset, because no session var name was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $return_value = true;
-        // since $data_to_reset is an array, cycle through the values
-        foreach ($data_to_reset as $reset) {
-            // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
-                // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
-                    // remove session var
-                    unset($this->_session_data[ $reset ]);
-                    $this->setSaveState();
-                    if ($show_all_notices) {
-                        EE_Error::add_success(
-                            sprintf(
-                                __('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
-     * @throws ReflectionException
-     */
-    public function wp_loaded()
-    {
-        if ($this->request->requestParamIsSet('clear_session')) {
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-    }
-
-
-    /**
-     * Used to reset the entire object (for tests).
-     *
-     * @since 4.3.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function reset_instance()
-    {
-        $this->clear_session();
-        self::$_instance = null;
-    }
-
-
-    public function configure_garbage_collection_filters()
-    {
-        // run old filter we had for controlling session cleanup
-        $expired_session_transient_delete_query_limit = absint(
-            apply_filters(
-                'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                50
-            )
-        );
-        // is there a value? or one that is different than the default 50 records?
-        if ($expired_session_transient_delete_query_limit === 0) {
-            // hook into TransientCacheStorage in case Session cleanup was turned off
-            add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
-        } elseif ($expired_session_transient_delete_query_limit !== 50) {
-            // or use that for the new transient cleanup query limit
-            add_filter(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
-                    return $expired_session_transient_delete_query_limit;
-                }
-            );
-        }
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
-     * @param $data1
-     * @return string
-     */
-    private function find_serialize_error($data1)
-    {
-        $error = '<pre>';
-        $data2 = preg_replace_callback(
-            '!s:(\d+):"(.*?)";!',
-            function ($match) {
-                return ($match[1] === strlen($match[2]))
-                    ? $match[0]
-                    : 's:'
-                      . strlen($match[2])
-                      . ':"'
-                      . $match[2]
-                      . '";';
-            },
-            $data1
-        );
-        $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
-        for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error .= "\t-> Line Number = $i" . PHP_EOL;
-                $start = ($i - 20);
-                $start = ($start < 0) ? 0 : $start;
-                $length = 40;
-                $point = $max - $i;
-                if ($point < 20) {
-                    $rlength = 1;
-                    $rpoint = -$point;
-                } else {
-                    $rpoint = $length - 20;
-                    $rlength = 1;
-                }
-                $error .= "\t-> Section Data1  = ";
-                $error .= substr_replace(
-                    substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-                $error .= "\t-> Section Data2  = ";
-                $error .= substr_replace(
-                    substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-            }
-        }
-        $error .= '</pre>';
-        return $error;
-    }
-
-
-    /**
-     * Saves an  array of settings used for configuring aspects of session behaviour
-     *
-     * @param array $updated_settings
-     */
-    private function updateSessionSettings(array $updated_settings = array())
-    {
-        // add existing settings, but only if not included in incoming $updated_settings array
-        $updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
-    }
-
-
-    /**
-     * garbage_collection
-     */
-    public function garbageCollection()
-    {
-        // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
-            $this->_last_gc = time();
-            $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
-            /** @type WPDB $wpdb */
-            global $wpdb;
-            // filter the query limit. Set to 0 to turn off garbage collection
-            $expired_session_transient_delete_query_limit = absint(
-                apply_filters(
-                    'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                    50
-                )
-            );
-            // non-zero LIMIT means take out the trash
-            if ($expired_session_transient_delete_query_limit) {
-                $session_key = str_replace('_', '\_', EE_Session::session_id_prefix);
-                $hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
-                // since transient expiration timestamps are set in the future, we can compare against NOW
-                // but we only want to pick up any trash that's been around for more than a day
-                $expiration = time() - DAY_IN_SECONDS;
-                $SQL = "
+		do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+		$this->reset_cart();
+		$this->reset_checkout();
+		$this->reset_transaction();
+		// wipe out everything that isn't a default session datum
+		$this->reset_data(array_keys($this->_session_data));
+		// reset initial site access time and the session expiration
+		$this->_set_init_access_and_expiration();
+		$this->setSaveState();
+		$this->_save_session_to_db(true);
+	}
+
+
+	/**
+	 * resets all non-default session vars. Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array|mixed $data_to_reset
+	 * @param bool        $show_all_notices
+	 * @return bool
+	 */
+	public function reset_data($data_to_reset = array(), $show_all_notices = false)
+	{
+		// if $data_to_reset is not in an array, then put it in one
+		if (! is_array($data_to_reset)) {
+			$data_to_reset = array($data_to_reset);
+		}
+		// nothing ??? go home!
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(
+				__(
+					'No session data could be reset, because no session var name was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$return_value = true;
+		// since $data_to_reset is an array, cycle through the values
+		foreach ($data_to_reset as $reset) {
+			// first check to make sure it is a valid session var
+			if (isset($this->_session_data[ $reset ])) {
+				// then check to make sure it is not a default var
+				if (! array_key_exists($reset, $this->_default_session_vars)) {
+					// remove session var
+					unset($this->_session_data[ $reset ]);
+					$this->setSaveState();
+					if ($show_all_notices) {
+						EE_Error::add_success(
+							sprintf(
+								__('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
+	 * @throws ReflectionException
+	 */
+	public function wp_loaded()
+	{
+		if ($this->request->requestParamIsSet('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+	}
+
+
+	/**
+	 * Used to reset the entire object (for tests).
+	 *
+	 * @since 4.3.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function reset_instance()
+	{
+		$this->clear_session();
+		self::$_instance = null;
+	}
+
+
+	public function configure_garbage_collection_filters()
+	{
+		// run old filter we had for controlling session cleanup
+		$expired_session_transient_delete_query_limit = absint(
+			apply_filters(
+				'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+				50
+			)
+		);
+		// is there a value? or one that is different than the default 50 records?
+		if ($expired_session_transient_delete_query_limit === 0) {
+			// hook into TransientCacheStorage in case Session cleanup was turned off
+			add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
+		} elseif ($expired_session_transient_delete_query_limit !== 50) {
+			// or use that for the new transient cleanup query limit
+			add_filter(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				function () use ($expired_session_transient_delete_query_limit) {
+					return $expired_session_transient_delete_query_limit;
+				}
+			);
+		}
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
+	 * @param $data1
+	 * @return string
+	 */
+	private function find_serialize_error($data1)
+	{
+		$error = '<pre>';
+		$data2 = preg_replace_callback(
+			'!s:(\d+):"(.*?)";!',
+			function ($match) {
+				return ($match[1] === strlen($match[2]))
+					? $match[0]
+					: 's:'
+					  . strlen($match[2])
+					  . ':"'
+					  . $match[2]
+					  . '";';
+			},
+			$data1
+		);
+		$max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+		$error .= $data1 . PHP_EOL;
+		$error .= $data2 . PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[ $i ] !== @$data2[ $i ]) {
+				$error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
+				$error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
+				$error .= "\t-> Line Number = $i" . PHP_EOL;
+				$start = ($i - 20);
+				$start = ($start < 0) ? 0 : $start;
+				$length = 40;
+				$point = $max - $i;
+				if ($point < 20) {
+					$rlength = 1;
+					$rpoint = -$point;
+				} else {
+					$rpoint = $length - 20;
+					$rlength = 1;
+				}
+				$error .= "\t-> Section Data1  = ";
+				$error .= substr_replace(
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+				$error .= "\t-> Section Data2  = ";
+				$error .= substr_replace(
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+			}
+		}
+		$error .= '</pre>';
+		return $error;
+	}
+
+
+	/**
+	 * Saves an  array of settings used for configuring aspects of session behaviour
+	 *
+	 * @param array $updated_settings
+	 */
+	private function updateSessionSettings(array $updated_settings = array())
+	{
+		// add existing settings, but only if not included in incoming $updated_settings array
+		$updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
+	}
+
+
+	/**
+	 * garbage_collection
+	 */
+	public function garbageCollection()
+	{
+		// only perform during regular requests if last garbage collection was over an hour ago
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+			$this->_last_gc = time();
+			$this->updateSessionSettings(array('last_gc' => $this->_last_gc));
+			/** @type WPDB $wpdb */
+			global $wpdb;
+			// filter the query limit. Set to 0 to turn off garbage collection
+			$expired_session_transient_delete_query_limit = absint(
+				apply_filters(
+					'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+					50
+				)
+			);
+			// non-zero LIMIT means take out the trash
+			if ($expired_session_transient_delete_query_limit) {
+				$session_key = str_replace('_', '\_', EE_Session::session_id_prefix);
+				$hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
+				// since transient expiration timestamps are set in the future, we can compare against NOW
+				// but we only want to pick up any trash that's been around for more than a day
+				$expiration = time() - DAY_IN_SECONDS;
+				$SQL = "
                     SELECT option_name
                     FROM {$wpdb->options}
                     WHERE
@@ -1352,17 +1352,17 @@ 
                     AND option_value < {$expiration}
                     LIMIT {$expired_session_transient_delete_query_limit}
                 ";
-                // produces something like:
-                // SELECT option_name FROM wp_options
-                // WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
-                // OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
-                // AND option_value < 1508368198 LIMIT 50
-                $expired_sessions = $wpdb->get_col($SQL);
-                // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
-                    $this->cache_storage->deleteMany($expired_sessions, true);
-                }
-            }
-        }
-    }
+				// produces something like:
+				// SELECT option_name FROM wp_options
+				// WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
+				// OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
+				// AND option_value < 1508368198 LIMIT 50
+				$expired_sessions = $wpdb->get_col($SQL);
+				// valid results?
+				if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+					$this->cache_storage->deleteMany($expired_sessions, true);
+				}
+			}
+		}
+	}
 }

Spacing +54 added lines, -54 removed lines

@@ -203,7 +203,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
+        if ( ! self::$_instance instanceof EE_Session
             && $cache_storage instanceof CacheStorageInterface
             && $lifespan instanceof SessionLifespan
             && $request instanceof RequestInterface
@@ -245,22 +245,22 @@ 
         // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
         // (which currently fires on the init hook at priority 9),
         // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! apply_filters('FHEE_load_EE_Session', true)) {
             return;
         }
         $this->session_start_handler = $session_start_handler;
         $this->session_lifespan = $lifespan;
         $this->request = $request;
-        if (! defined('ESPRESSO_SESSION')) {
+        if ( ! defined('ESPRESSO_SESSION')) {
             define('ESPRESSO_SESSION', true);
         }
         // retrieve session options from db
         $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
+        if ( ! empty($session_settings)) {
             // cycle though existing session options
             foreach ($session_settings as $var_name => $session_setting) {
                 // set values for class properties
-                $var_name = '_' . $var_name;
+                $var_name = '_'.$var_name;
                 $this->{$var_name} = $session_setting;
             }
         }
@@ -321,7 +321,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();
         }
@@ -398,7 +398,7 @@ 
             EE_Session::SAVE_STATE_CLEAN,
             EE_Session::SAVE_STATE_DIRTY,
         ];
-        if (! in_array($save_state, $valid_save_states, true)) {
+        if ( ! in_array($save_state, $valid_save_states, true)) {
             $save_state = EE_Session::SAVE_STATE_DIRTY;
         }
         $this->save_state = $save_state;
@@ -417,9 +417,9 @@ 
         // set some defaults
         foreach ($this->_default_session_vars as $key => $default_var) {
             if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
+                $this->_session_data[$key] = array();
             } else {
-                $this->_session_data[ $key ] = '';
+                $this->_session_data[$key] = '';
             }
         }
     }
@@ -556,8 +556,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;
     }
@@ -585,7 +585,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__(
@@ -600,7 +600,7 @@ 
                 );
                 return false;
             }
-            $this->_session_data[ $key ] = $value;
+            $this->_session_data[$key] = $value;
             $this->setSaveState();
         }
         return true;
@@ -632,7 +632,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
@@ -643,7 +643,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)
@@ -681,7 +681,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);
@@ -690,7 +690,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)) {
@@ -700,7 +700,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__,
@@ -714,17 +714,17 @@ 
             $row = $wpdb->get_row(
                 $wpdb->prepare(
                     "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
+                    '_transient_'.$ssn_key
                 )
             );
             $session_data = is_object($row) ? $row->option_value : null;
             if ($session_data) {
                 $session_data = preg_replace_callback(
                     '!s:(d+):"(.*?)";!',
-                    function ($match) {
+                    function($match) {
                         return $match[1] === strlen($match[2])
                             ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                            : 's:'.strlen($match[2]).':"'.$match[2].'";';
                     },
                     $session_data
                 );
@@ -735,7 +735,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) {
@@ -749,21 +749,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) {
@@ -790,7 +790,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);
     }
@@ -894,19 +894,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;
@@ -984,7 +984,7 @@ 
         }
         $transaction = $this->transaction();
         if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
+            if ( ! $transaction->ID()) {
                 $transaction->save();
             }
             $this->_session_data['transaction'] = $transaction->ID();
@@ -998,14 +998,14 @@ 
         // maybe save hash check
         if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
             $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
+                EE_Session::hash_check_prefix.$this->_sid,
                 md5($session_data),
                 $this->session_lifespan->inSeconds()
             );
         }
         // we're using the Transient API for storing session data,
         $saved = $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->session_lifespan->inSeconds()
         );
@@ -1021,7 +1021,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 = '';
@@ -1037,14 +1037,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 : '';
     }
@@ -1083,7 +1083,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();
@@ -1106,7 +1106,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!
@@ -1126,11 +1126,11 @@ 
         // since $data_to_reset is an array, cycle through the values
         foreach ($data_to_reset as $reset) {
             // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
+            if (isset($this->_session_data[$reset])) {
                 // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
+                if ( ! array_key_exists($reset, $this->_default_session_vars)) {
                     // remove session var
-                    unset($this->_session_data[ $reset ]);
+                    unset($this->_session_data[$reset]);
                     $this->setSaveState();
                     if ($show_all_notices) {
                         EE_Error::add_success(
@@ -1234,7 +1234,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;
                 }
             );
@@ -1252,7 +1252,7 @@ 
         $error = '<pre>';
         $data2 = preg_replace_callback(
             '!s:(\d+):"(.*?)";!',
-            function ($match) {
+            function($match) {
                 return ($match[1] === strlen($match[2]))
                     ? $match[0]
                     : 's:'
@@ -1264,13 +1264,13 @@ 
             $data1
         );
         $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
+        $error .= $data1.PHP_EOL;
+        $error .= $data2.PHP_EOL;
         for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error .= "\t-> Line Number = $i" . PHP_EOL;
+            if (@$data1[$i] !== @$data2[$i]) {
+                $error .= 'Difference '.@$data1[$i].' != '.@$data2[$i].PHP_EOL;
+                $error .= "\t-> ORD number ".ord(@$data1[$i]).' != '.ord(@$data2[$i]).PHP_EOL;
+                $error .= "\t-> Line Number = $i".PHP_EOL;
                 $start = ($i - 20);
                 $start = ($start < 0) ? 0 : $start;
                 $length = 40;
@@ -1285,7 +1285,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
                 );
@@ -1293,7 +1293,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
                 );
@@ -1324,7 +1324,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 */
@@ -1359,7 +1359,7 @@ 
                 // AND option_value < 1508368198 LIMIT 50
                 $expired_sessions = $wpdb->get_col($SQL);
                 // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+                if ( ! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
                     $this->cache_storage->deleteMany($expired_sessions, true);
                 }
             }

core/services/request/RequestInterface.php

Indentation +118 added lines, -118 removed lines

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

core/middleware/EE_Detect_File_Editor_Request.core.php

Indentation +23 added lines, -23 removed lines

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

core/domain/services/admin/PluginUpsells.php

Spacing +3 added lines, -3 removed lines

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

Indentation +57 added lines, -57 removed lines

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

core/domain/Domain.php

Spacing +2 added lines, -2 removed lines

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

Indentation +41 added lines, -41 removed lines

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

core/services/loaders/Loader.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +111 added lines, -111 removed lines

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

core/services/bootstrap/BootstrapDependencyInjectionContainer.php

Spacing +2 added lines, -2 removed lines

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

Indentation +119 added lines, -119 removed lines

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