eventespresso / event-espresso-core

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

Spacing +16 added lines, -16 removed lines

@@ -86,7 +86,7 @@ 
      */
     public function __construct($options_array = array())
     {
-        $options_array = (array)apply_filters('FHEE__EE_Form_Section_Proper___construct__options_array', $options_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);
@@ -109,7 +109,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);
@@ -238,7 +238,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();
             }
         }
@@ -418,7 +418,7 @@ 
     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) {
+        if ( ! $subsection instanceof EE_Form_Input_Base) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -453,7 +453,7 @@ 
     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) {
+        if ( ! $subsection instanceof EE_Form_Section_Proper) {
             throw new EE_Error(
                 sprintf(
                     __("Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", 'event_espresso'),
@@ -491,7 +491,7 @@ 
      */
     public function is_valid()
     {
-        if (! $this->has_received_submission()) {
+        if ( ! $this->has_received_submission()) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -501,14 +501,14 @@ 
                 )
             );
         }
-        if (! parent::is_valid()) {
+        if ( ! parent::is_valid()) {
             return false;
         }
         // 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
         $set_submission_errors = $this->submission_error_message() === '' ? true : false;
         foreach ($this->get_validatable_subsections() as $subsection) {
-            if (! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
+            if ( ! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
                 if ($set_submission_errors) {
                     $this->set_submission_error_message($subsection->get_validation_error_string());
                 }
@@ -527,7 +527,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;
@@ -611,7 +611,7 @@ 
         add_filter('FHEE_load_jquery_validate', '__return_true');
         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
@@ -757,7 +757,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();
         }
     }
@@ -853,8 +853,8 @@ 
     protected function _validate()
     {
         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();
         }
@@ -1130,7 +1130,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(
                         __(
@@ -1228,7 +1228,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().']';
         } else {
             return $this->name();
         }
@@ -1272,7 +1272,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }

Indentation +1380 added lines, -1380 removed lines

@@ -11,1386 +11,1386 @@
 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 = '';
-
-    /**
-     * 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(
-                        __('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) : __('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
-     */
-    public function was_submitted($form_data = null)
-    {
-        return $this->form_data_present_in($form_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.
-     */
-    public function receive_form_submission($req_data = null, $validate = true)
-    {
-        $req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', $req_data, $this,
-            $validate);
-        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->_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();
-            }
-        }
-        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
-     */
-    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
-     */
-    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
-            );
-        } else {
-            return array();
-        }
-    }
-
-
-
-    /**
-     * flushed the originally submitted input values from the session
-     *
-     * @return boolean whether or not the data was successfully removed from the session
-     */
-    protected function flush_submitted_form_data_from_session()
-    {
-        return EE_Registry::instance()->SSN->reset_data(
-            array(\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
-        );
-    }
-
-
-
-    /**
-     * Populates this form and its subsections with data from the session.
-     * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
-     * validation errors when displaying too)
-     * Returns true if the form was populated from the session, false otherwise
-     *
-     * @return boolean
-     */
-    public function populate_from_session()
-    {
-        $form_data_in_session = $this->get_submitted_form_data_from_session();
-        if (empty($form_data_in_session)) {
-            return false;
-        }
-        $this->receive_form_submission($form_data_in_session);
-        $this->flush_submitted_form_data_from_session();
-        if ($this->form_data_present_in($form_data_in_session)) {
-            return true;
-        } else {
-            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
-     */
-    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[]
-     */
-    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(
-                    __(
-                        "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) : __("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(
-                    __("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->has_received_submission()) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "You cannot check if a form is valid before receiving the form submission using receive_form_submission",
-                        "event_espresso"
-                    )
-                )
-            );
-        }
-        if (! parent::is_valid()) {
-            return false;
-        }
-        // 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
-        $set_submission_errors = $this->submission_error_message() === '' ? true : false;
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if (! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
-                if ($set_submission_errors) {
-                    $this->set_submission_error_message($subsection->get_validation_error_string());
-                }
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * gets teh default name of this form section if none is specified
-     *
-     * @return string
-     */
-    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. Enqueus 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 \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
-     */
-    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 string
-     * @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)
-    {
-        add_filter('FHEE_load_jquery_validate', '__return_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
-     */
-    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
-     */
-    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[]
-     */
-    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
-     */
-    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
-     */
-    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' => __("This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg", "event_espresso"),
-            'regex'    => __('Please check your input', 'event_espresso'),
-        );
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public static function js_localization()
-    {
-        return self::$_js_localization;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    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
-     */
-    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
-     */
-    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.
-     */
-    protected function _validate()
-    {
-        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
-     */
-    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();
-            } else if ($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[]
-     */
-    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[]
-     */
-    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[]
-     */
-    public function subsections($require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $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
-     */
-    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
-     */
-    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
-     */
-    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();
-            } else if ($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
-     */
-    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();
-                }
-            } else if ($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]);
-        }
-    }
-
-
-
-    /**
-     * @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(
-                        __(
-                            "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);
-            }
-        }
-    }
-
-
-
-    /**
-     * Just gets all validatable subsections to clean their sensitive data
-     */
-    public function clean_sensitive_data()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $subsection->clean_sensitive_data();
-        }
-    }
-
-
-
-    /**
-     * @param string $form_submission_error_message
-     */
-    public function set_submission_error_message($form_submission_error_message = '')
-    {
-        $this->_form_submission_error_message .= ! empty($form_submission_error_message)
-            ? $form_submission_error_message
-            : __('Form submission failed due to errors', 'event_espresso');
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function submission_error_message()
-    {
-        return $this->_form_submission_error_message;
-    }
-
-
-
-    /**
-     * @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
-            : __('Form submitted successfully', 'event_espresso');
-    }
-
-
-
-    /**
-     * @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() . ']';
-        } else {
-            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
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        if ($req_data === null) {
-            $req_data = $_POST;
-        }
-        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[]
-     */
-    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;
-    }
-
-
-
-    /**
-     * 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
-     */
-    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);
-        } else {
-            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 = '';
+
+	/**
+	 * 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(
+						__('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) : __('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
+	 */
+	public function was_submitted($form_data = null)
+	{
+		return $this->form_data_present_in($form_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.
+	 */
+	public function receive_form_submission($req_data = null, $validate = true)
+	{
+		$req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', $req_data, $this,
+			$validate);
+		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->_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();
+			}
+		}
+		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
+	 */
+	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
+	 */
+	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
+			);
+		} else {
+			return array();
+		}
+	}
+
+
+
+	/**
+	 * flushed the originally submitted input values from the session
+	 *
+	 * @return boolean whether or not the data was successfully removed from the session
+	 */
+	protected function flush_submitted_form_data_from_session()
+	{
+		return EE_Registry::instance()->SSN->reset_data(
+			array(\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
+		);
+	}
+
+
+
+	/**
+	 * Populates this form and its subsections with data from the session.
+	 * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
+	 * validation errors when displaying too)
+	 * Returns true if the form was populated from the session, false otherwise
+	 *
+	 * @return boolean
+	 */
+	public function populate_from_session()
+	{
+		$form_data_in_session = $this->get_submitted_form_data_from_session();
+		if (empty($form_data_in_session)) {
+			return false;
+		}
+		$this->receive_form_submission($form_data_in_session);
+		$this->flush_submitted_form_data_from_session();
+		if ($this->form_data_present_in($form_data_in_session)) {
+			return true;
+		} else {
+			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
+	 */
+	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[]
+	 */
+	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(
+					__(
+						"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) : __("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(
+					__("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->has_received_submission()) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"You cannot check if a form is valid before receiving the form submission using receive_form_submission",
+						"event_espresso"
+					)
+				)
+			);
+		}
+		if (! parent::is_valid()) {
+			return false;
+		}
+		// 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
+		$set_submission_errors = $this->submission_error_message() === '' ? true : false;
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if (! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
+				if ($set_submission_errors) {
+					$this->set_submission_error_message($subsection->get_validation_error_string());
+				}
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * gets teh default name of this form section if none is specified
+	 *
+	 * @return string
+	 */
+	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. Enqueus 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 \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
+	 */
+	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 string
+	 * @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)
+	{
+		add_filter('FHEE_load_jquery_validate', '__return_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
+	 */
+	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
+	 */
+	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[]
+	 */
+	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
+	 */
+	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
+	 */
+	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' => __("This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg", "event_espresso"),
+			'regex'    => __('Please check your input', 'event_espresso'),
+		);
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public static function js_localization()
+	{
+		return self::$_js_localization;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	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
+	 */
+	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
+	 */
+	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.
+	 */
+	protected function _validate()
+	{
+		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
+	 */
+	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();
+			} else if ($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[]
+	 */
+	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[]
+	 */
+	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[]
+	 */
+	public function subsections($require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $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
+	 */
+	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
+	 */
+	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
+	 */
+	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();
+			} else if ($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
+	 */
+	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();
+				}
+			} else if ($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]);
+		}
+	}
+
+
+
+	/**
+	 * @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(
+						__(
+							"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);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Just gets all validatable subsections to clean their sensitive data
+	 */
+	public function clean_sensitive_data()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$subsection->clean_sensitive_data();
+		}
+	}
+
+
+
+	/**
+	 * @param string $form_submission_error_message
+	 */
+	public function set_submission_error_message($form_submission_error_message = '')
+	{
+		$this->_form_submission_error_message .= ! empty($form_submission_error_message)
+			? $form_submission_error_message
+			: __('Form submission failed due to errors', 'event_espresso');
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function submission_error_message()
+	{
+		return $this->_form_submission_error_message;
+	}
+
+
+
+	/**
+	 * @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
+			: __('Form submitted successfully', 'event_espresso');
+	}
+
+
+
+	/**
+	 * @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() . ']';
+		} else {
+			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
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		if ($req_data === null) {
+			$req_data = $_POST;
+		}
+		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[]
+	 */
+	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;
+	}
+
+
+
+	/**
+	 * 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
+	 */
+	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);
+		} else {
+			return null;
+		}
+	}
 
 }
 

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

Indentation +147 added lines, -147 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -35,150 +35,150 @@ 
 abstract class EE_Form_Section_Validatable extends EE_Form_Section_Base
 {
 
-    /**
-     * Array of validation errors in this section. Does not contain validation errors in subsections, however.
-     * Those are stored individually on each subsection.
-     *
-     * @var EE_Validation_Error[]
-     */
-    protected $_validation_errors = array();
-
-
-
-    /**
-     * Errors on this form section. Note: EE_Form_Section_Proper
-     * has another function for getting all errors in this form section and subsections
-     * called get_validation_errors_accumulated
-     *
-     * @return EE_Validation_Error[]
-     */
-    public function get_validation_errors()
-    {
-        return $this->_validation_errors;
-    }
-
-
-
-    /**
-     * returns a ul html element with all the validation errors in it.
-     * If we want this to be customizable, we may decide to create a strategy for displaying it.
-     *
-     * @return string
-     */
-    public function get_validation_error_string()
-    {
-        $validation_error_messages = array();
-        if ($this->get_validation_errors()) {
-            foreach ($this->get_validation_errors() as $validation_error) {
-                if ($validation_error instanceof EE_Validation_Error) {
-                    $validation_error_messages[] = $validation_error->getMessage();
-                }
-            }
-        }
-        return implode(", ", $validation_error_messages);
-    }
-
-
-
-    /**
-     * Performs validation on this form section (and subsections). Should be called after _normalize()
-     *
-     * @return boolean of whether or not the form section is valid
-     */
-    abstract protected function _validate();
-
-
-
-    /**
-     * Checks if this field has any validation errors
-     *
-     * @return boolean
-     */
-    public function is_valid()
-    {
-        if (count($this->_validation_errors)) {
-            return false;
-        } else {
-            return true;
-        }
-    }
-
-
-
-    /**
-     * Sanitizes input for this form section
-     *
-     * @param array $req_data is the full request data like $_POST
-     * @return boolean of whether a normalization error occurred
-     */
-    abstract protected function _normalize($req_data);
-
-
-
-    /**
-     * Creates a validation error from the arguments provided, and adds it to the form section's list.
-     * If such an EE_Validation_Error object is passed in as the first arg, simply sets this as its form section, and
-     * adds it to the list of validation errors of errors
-     *
-     * @param mixed     $message_or_object  internationalized string describing the validation error; or it could be a
-     *                                      proper EE_Validation_Error object
-     * @param string    $error_code         a short key which can be used to uniquely identify the error
-     * @param Exception $previous_exception if there was an exception that caused the error, that exception
-     * @return void
-     */
-    public function add_validation_error($message_or_object, $error_code = null, $previous_exception = null)
-    {
-        if ($message_or_object instanceof EE_Validation_Error) {
-            $validation_error = $message_or_object;
-            $validation_error->set_form_section($this);
-        } else {
-            $validation_error = new EE_Validation_Error($message_or_object, $error_code, $this, $previous_exception);
-        }
-        $this->_validation_errors[] = $validation_error;
-    }
-
-
-
-    /**
-     * When generating the JS for the jquery validation rules like<br>
-     * <code>$( "#myform" ).validate({
-     * rules: {
-     * password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }
-     * }
-     * });</code>
-     * gets the sections like
-     * <br><code>password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }</code>
-     * except we leave it as a PHP object, and leave wp_localize_script to
-     * turn it into a JSON object which can be used by the js
-     *
-     * @return array
-     */
-    abstract public function get_jquery_validation_rules();
-
-
-
-    /**
-     * Checks if this form section's data is present in the req data specified
-     *
-     * @param array $req_data usually $_POST, if null that's what's used
-     * @return boolean
-     */
-    abstract public function form_data_present_in($req_data = null);
-
-
-
-    /**
-     * Removes teh sensitive data from this form section (usually done after
-     * utilizing the data business function, but before saving it somewhere. Eg,
-     * may remove a password from the form after verifying it was correct)
-     *
-     * @return void
-     */
-    abstract public function clean_sensitive_data();
+	/**
+	 * Array of validation errors in this section. Does not contain validation errors in subsections, however.
+	 * Those are stored individually on each subsection.
+	 *
+	 * @var EE_Validation_Error[]
+	 */
+	protected $_validation_errors = array();
+
+
+
+	/**
+	 * Errors on this form section. Note: EE_Form_Section_Proper
+	 * has another function for getting all errors in this form section and subsections
+	 * called get_validation_errors_accumulated
+	 *
+	 * @return EE_Validation_Error[]
+	 */
+	public function get_validation_errors()
+	{
+		return $this->_validation_errors;
+	}
+
+
+
+	/**
+	 * returns a ul html element with all the validation errors in it.
+	 * If we want this to be customizable, we may decide to create a strategy for displaying it.
+	 *
+	 * @return string
+	 */
+	public function get_validation_error_string()
+	{
+		$validation_error_messages = array();
+		if ($this->get_validation_errors()) {
+			foreach ($this->get_validation_errors() as $validation_error) {
+				if ($validation_error instanceof EE_Validation_Error) {
+					$validation_error_messages[] = $validation_error->getMessage();
+				}
+			}
+		}
+		return implode(", ", $validation_error_messages);
+	}
+
+
+
+	/**
+	 * Performs validation on this form section (and subsections). Should be called after _normalize()
+	 *
+	 * @return boolean of whether or not the form section is valid
+	 */
+	abstract protected function _validate();
+
+
+
+	/**
+	 * Checks if this field has any validation errors
+	 *
+	 * @return boolean
+	 */
+	public function is_valid()
+	{
+		if (count($this->_validation_errors)) {
+			return false;
+		} else {
+			return true;
+		}
+	}
+
+
+
+	/**
+	 * Sanitizes input for this form section
+	 *
+	 * @param array $req_data is the full request data like $_POST
+	 * @return boolean of whether a normalization error occurred
+	 */
+	abstract protected function _normalize($req_data);
+
+
+
+	/**
+	 * Creates a validation error from the arguments provided, and adds it to the form section's list.
+	 * If such an EE_Validation_Error object is passed in as the first arg, simply sets this as its form section, and
+	 * adds it to the list of validation errors of errors
+	 *
+	 * @param mixed     $message_or_object  internationalized string describing the validation error; or it could be a
+	 *                                      proper EE_Validation_Error object
+	 * @param string    $error_code         a short key which can be used to uniquely identify the error
+	 * @param Exception $previous_exception if there was an exception that caused the error, that exception
+	 * @return void
+	 */
+	public function add_validation_error($message_or_object, $error_code = null, $previous_exception = null)
+	{
+		if ($message_or_object instanceof EE_Validation_Error) {
+			$validation_error = $message_or_object;
+			$validation_error->set_form_section($this);
+		} else {
+			$validation_error = new EE_Validation_Error($message_or_object, $error_code, $this, $previous_exception);
+		}
+		$this->_validation_errors[] = $validation_error;
+	}
+
+
+
+	/**
+	 * When generating the JS for the jquery validation rules like<br>
+	 * <code>$( "#myform" ).validate({
+	 * rules: {
+	 * password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }
+	 * }
+	 * });</code>
+	 * gets the sections like
+	 * <br><code>password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }</code>
+	 * except we leave it as a PHP object, and leave wp_localize_script to
+	 * turn it into a JSON object which can be used by the js
+	 *
+	 * @return array
+	 */
+	abstract public function get_jquery_validation_rules();
+
+
+
+	/**
+	 * Checks if this form section's data is present in the req data specified
+	 *
+	 * @param array $req_data usually $_POST, if null that's what's used
+	 * @return boolean
+	 */
+	abstract public function form_data_present_in($req_data = null);
+
+
+
+	/**
+	 * Removes teh sensitive data from this form section (usually done after
+	 * utilizing the data business function, but before saving it somewhere. Eg,
+	 * may remove a password from the form after verifying it was correct)
+	 *
+	 * @return void
+	 */
+	abstract public function clean_sensitive_data();
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -1,5 +1,5 @@
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

modules/events_archive/EED_Events_Archive.module.php

Doc Comments +2 added lines, -2 removed lines

@@ -249,7 +249,7 @@ 
 
     /**
      * @access public
-     * @return string
+     * @return boolean
      */
 	public static function is_iframe() {
         return \EED_Events_Archive::$iframe;
@@ -722,7 +722,7 @@ 
 	 *    display_description
 	 *
 	 * @access    public
-	 * @param $value
+	 * @param integer $value
 	 * @return    bool
 	 */
 	public static function display_description( $value ) {

Indentation +172 added lines, -172 removed lines

@@ -14,13 +14,13 @@ 
  */
 class EED_Events_Archive  extends EED_Module {
 
-    const EVENT_DETAILS_PRIORITY = 100;
-    const EVENT_DATETIMES_PRIORITY = 110;
-    const EVENT_TICKETS_PRIORITY = 120;
-    const EVENT_VENUES_PRIORITY = 130;
+	const EVENT_DETAILS_PRIORITY = 100;
+	const EVENT_DATETIMES_PRIORITY = 110;
+	const EVENT_TICKETS_PRIORITY = 120;
+	const EVENT_VENUES_PRIORITY = 130;
 
 
-    public static $espresso_event_list_ID = 0;
+	public static $espresso_event_list_ID = 0;
 	public static $espresso_grid_event_lists = array();
 
 	/**
@@ -28,19 +28,19 @@ 
 	 */
 	protected static $using_get_the_excerpt = false;
 
-    /**
-     * Used to flag when the event list is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected static $iframe = false;
+	/**
+	 * Used to flag when the event list is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected static $iframe = false;
 
-    /**
+	/**
 	 * @var \EventEspresso\core\libraries\iframe_display\EventListIframeEmbedButton $_iframe_embed_button
 	 */
 	private static $_iframe_embed_button;
 
-    /**
+	/**
 	 * @type EE_Template_Part_Manager $template_parts
 	 */
 	protected $template_parts;
@@ -210,9 +210,9 @@ 
 
 
 	/**
-     * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
-     *
-     * @return    void
+	 * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
+	 *
+	 * @return    void
 	 */
 	public function event_list() {
 		// ensure valid EE_Events_Archive_Config() object exists
@@ -223,36 +223,36 @@ 
 
 
 
-    /**
-     * @access    public
-     * @return    void
-     * @throws \EE_Error
-     * @throws \DomainException
-     */
+	/**
+	 * @access    public
+	 * @return    void
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 */
 	public function event_list_iframe() {
-        \EED_Events_Archive::$iframe = true;
+		\EED_Events_Archive::$iframe = true;
 		$event_list_iframe = new EventsArchiveIframe( $this );
 		$event_list_iframe->display();
 	}
 
 
 
-    /**
-     * @access public
-     * @return string
-     */
+	/**
+	 * @access public
+	 * @return string
+	 */
 	public static function is_iframe() {
-        return \EED_Events_Archive::$iframe;
+		return \EED_Events_Archive::$iframe;
 	}
 
 
 
-    /**
-     * @access public
-     * @return string
-     */
+	/**
+	 * @access public
+	 * @return string
+	 */
 	public static function link_target() {
-        return \EED_Events_Archive::$iframe ? ' target="_blank"' : '';
+		return \EED_Events_Archive::$iframe ? ' target="_blank"' : '';
 	}
 
 
@@ -280,10 +280,10 @@ 
 			}
 			// if NOT a custom template
 			if (
-                apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
+				apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
 				|| EE_Registry::instance()
-                    ->load_core( 'Front_Controller' )
-                    ->get_selected_template() !== 'archive-espresso_events.php'
+					->load_core( 'Front_Controller' )
+					->get_selected_template() !== 'archive-espresso_events.php'
 			) {
 				// don't display entry meta because the existing theme will take care of that
 				add_filter( 'FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true' );
@@ -291,16 +291,16 @@ 
 				EEH_Template::load_espresso_theme_functions();
 				// because we don't know if the theme is using the_excerpt()
 				add_filter(
-				    'the_excerpt',
-                    array( 'EED_Events_Archive', 'event_details' ),
-                    EED_Events_Archive::EVENT_DETAILS_PRIORITY
-                );
+					'the_excerpt',
+					array( 'EED_Events_Archive', 'event_details' ),
+					EED_Events_Archive::EVENT_DETAILS_PRIORITY
+				);
 				// or the_content
 				add_filter(
-				    'the_content',
-                    array( 'EED_Events_Archive', 'event_details' ),
-                    EED_Events_Archive::EVENT_DETAILS_PRIORITY
-                );
+					'the_content',
+					array( 'EED_Events_Archive', 'event_details' ),
+					EED_Events_Archive::EVENT_DETAILS_PRIORITY
+				);
 				// and just in case they are running get_the_excerpt() which DESTROYS things
 				add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 );
 				// don't display entry meta because the existing theme will take care of that
@@ -325,15 +325,15 @@ 
 		}
 		if ( apply_filters( 'FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false ) ) {
 			remove_filter(
-			    'the_excerpt',
-                array( 'EED_Events_Archive', 'event_details' ),
-                EED_Events_Archive::EVENT_DETAILS_PRIORITY
-            );
+				'the_excerpt',
+				array( 'EED_Events_Archive', 'event_details' ),
+				EED_Events_Archive::EVENT_DETAILS_PRIORITY
+			);
 			remove_filter(
-			    'the_content',
-                array( 'EED_Events_Archive', 'event_details' ),
-                EED_Events_Archive::EVENT_DETAILS_PRIORITY
-            );
+				'the_content',
+				array( 'EED_Events_Archive', 'event_details' ),
+				EED_Events_Archive::EVENT_DETAILS_PRIORITY
+			);
 			$excerpt = EED_Events_Archive::event_details( $excerpt );
 		} else {
 			EED_Events_Archive::$using_get_the_excerpt = true;
@@ -424,17 +424,17 @@ 
 		// no further password checks required atm
 		add_filter( 'FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true' );
 		// we need to first remove this callback from being applied to the_content() or the_excerpt()
-        // (otherwise it will recurse and blow up the interweb)
+		// (otherwise it will recurse and blow up the interweb)
 		remove_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_details' ),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_details' ),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
 		remove_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_details' ),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_details' ),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
 		remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
 		// now add additional content depending on whether event is using the_excerpt() or the_content()
 		EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
@@ -442,20 +442,20 @@ 
 		$content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters( $content );
 		// re-add our main filters (or else the next event won't have them)
 		add_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_details' ),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_details' ),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
 		add_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_details' ),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_details' ),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
 		add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 );
 		remove_filter(
-		    'FHEE__EED_Events_Archive__event_details__no_post_password_required',
-            '__return_true'
-        );
+			'FHEE__EED_Events_Archive__event_details__no_post_password_required',
+			'__return_true'
+		);
 		return $content;
 	}
 
@@ -471,15 +471,15 @@ 
 		// we need to first remove this callback from being applied to the_content()
 		// (otherwise it will recurse and blow up the interweb)
 		remove_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_details' ),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_details' ),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
 		remove_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_details' ),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_details' ),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
 		remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
 		//now add additional content depending on whether event is using the_excerpt() or the_content()
 		EED_Events_Archive::_add_additional_excerpt_filters();
@@ -489,15 +489,15 @@ 
 		$content = EEH_Template::locate_template( 'content-espresso_events-details.php' );
 		// re-add our main filters (or else the next event won't have them)
 		add_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_details' ),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_details' ),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
 		add_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_details' ),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_details' ),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
 		add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 );
 		// but remove the other filters so that they don't get applied to the next post
 		EED_Events_Archive::_remove_additional_events_archive_filters();
@@ -574,20 +574,20 @@ 
 	 */
 	private static function _add_additional_excerpt_filters() {
 		add_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_datetimes' ),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
 		add_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_tickets' ),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_tickets' ),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
 		add_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_venues' ),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_venues' ),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
 	}
 
 
@@ -600,20 +600,20 @@ 
 	 */
 	private static function _add_additional_content_filters() {
 		add_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_datetimes' ),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
 		add_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_tickets' ),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_tickets' ),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
 		add_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_venues' ),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_venues' ),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
 	}
 
 
@@ -626,35 +626,35 @@ 
 	 */
 	private static function _remove_additional_events_archive_filters() {
 		remove_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_datetimes' ),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
 		remove_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_tickets' ),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_tickets' ),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
 		remove_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_venues' ),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_venues' ),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
 		remove_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_datetimes' ),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
 		remove_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_tickets' ),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_tickets' ),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
 		remove_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_venues' ),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_venues' ),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
 	}
 
 
@@ -669,50 +669,50 @@ 
 		//remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
 		remove_filter( 'the_title', array( 'EED_Events_Archive', 'the_title' ), 1 );
 		remove_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_details' ),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_details' ),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
 		remove_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_datetimes' ),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
 		remove_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_tickets' ),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_tickets' ),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
 		remove_filter(
-		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_venues' ),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
+			'the_excerpt',
+			array( 'EED_Events_Archive', 'event_venues' ),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
 		remove_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_details' ),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_details' ),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
 		remove_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_datetimes' ),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
 		remove_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_tickets' ),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_tickets' ),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
 		remove_filter(
-		    'the_content',
-            array( 'EED_Events_Archive', 'event_venues' ),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
+			'the_content',
+			array( 'EED_Events_Archive', 'event_venues' ),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
 		// don't display entry meta because the existing theme will take care of that
 		remove_filter(
-		    'FHEE__content_espresso_events_details_template__display_entry_meta',
-            '__return_false'
-        );
+			'FHEE__content_espresso_events_details_template__display_entry_meta',
+			'__return_false'
+		);
 	}
 
 
@@ -727,7 +727,7 @@ 
 	 *  @return 	void
 	 */
 	public function load_event_list_assets() {
-        do_action( 'AHEE__EED_Events_Archive__before_load_assets' );
+		do_action( 'AHEE__EED_Events_Archive__before_load_assets' );
 		add_filter( 'FHEE_load_EE_Session', '__return_true' );
 		add_filter( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true' );
 		add_action('wp_enqueue_scripts', array( $this, 'wp_enqueue_scripts' ), 10 );

Spacing +175 added lines, -175 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\core\libraries\iframe_display\EventListIframeEmbedButton;
 use EventEspresso\modules\events_archive\EventsArchiveIframe;
 
-defined( 'EVENT_ESPRESSO_VERSION') || exit('No direct script access allowed');
+defined('EVENT_ESPRESSO_VERSION') || exit('No direct script access allowed');
 
 /**
  * Event List
@@ -51,7 +51,7 @@ 
 	 * @return EED_Events_Archive
 	 */
 	public static function instance() {
-		return parent::get_instance( __CLASS__ );
+		return parent::get_instance(__CLASS__);
 	}
 
 
@@ -63,10 +63,10 @@ 
 	 *  @return 	void
 	 */
 	public static function set_hooks() {
-		EE_Config::register_route( EE_Registry::instance()->CFG->core->event_cpt_slug, 'Events_Archive', 'run' );
-		EE_Config::register_route( 'event_list', 'Events_Archive', 'event_list' );
-		EE_Config::register_route( 'iframe', 'Events_Archive', 'event_list_iframe', 'event_list' );
-		add_action( 'wp_loaded', array( 'EED_Events_Archive', 'set_definitions' ), 2 );
+		EE_Config::register_route(EE_Registry::instance()->CFG->core->event_cpt_slug, 'Events_Archive', 'run');
+		EE_Config::register_route('event_list', 'Events_Archive', 'event_list');
+		EE_Config::register_route('iframe', 'Events_Archive', 'event_list_iframe', 'event_list');
+		add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
 	}
 
 	/**
@@ -76,12 +76,12 @@ 
 	 *  @return 	void
 	 */
 	public static function set_hooks_admin() {
-		add_action( 'wp_loaded', array( 'EED_Events_Archive', 'set_definitions' ), 2 );
+		add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
 		// hook into the end of the \EE_Admin_Page::_load_page_dependencies()
 		// to load assets for "espresso_events" page on the "default" route (action)
 		add_action(
 			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
-			array( 'EED_Events_Archive', 'event_list_iframe_embed_button' ),
+			array('EED_Events_Archive', 'event_list_iframe_embed_button'),
 			10
 		);
 	}
@@ -96,8 +96,8 @@ 
 	 *  @return 	void
 	 */
 	public static function set_definitions() {
-		define( 'EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url( __FILE__ ) . 'assets' . DS );
-		define( 'EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace( '\\', DS, plugin_dir_path( __FILE__ )) . 'templates' . DS );
+		define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS);
+		define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates'.DS);
 	}
 
 
@@ -105,10 +105,10 @@ 
 	/**
 	 * set up EE_Events_Archive_Config
 	 */
-	protected function set_config(){
-		$this->set_config_section( 'template_settings' );
-		$this->set_config_class( 'EE_Events_Archive_Config' );
-		$this->set_config_name( 'EED_Events_Archive' );
+	protected function set_config() {
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Events_Archive_Config');
+		$this->set_config_name('EED_Events_Archive');
 	}
 
 
@@ -117,7 +117,7 @@ 
 	 * @return EventListIframeEmbedButton
 	 */
 	public static function get_iframe_embed_button() {
-		if ( ! self::$_iframe_embed_button instanceof EventListIframeEmbedButton ) {
+		if ( ! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
 			self::$_iframe_embed_button = new EventListIframeEmbedButton();
 		}
 		return self::$_iframe_embed_button;
@@ -143,35 +143,35 @@ 
 	 * @param \EE_Events_Archive_Config $config
 	 * @return \EE_Template_Part_Manager
 	 */
-	public function initialize_template_parts( EE_Events_Archive_Config $config = null ) {
+	public function initialize_template_parts(EE_Events_Archive_Config $config = null) {
 		$config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
 		EEH_Autoloader::instance()->register_template_part_autoloaders();
 		$template_parts = new EE_Template_Part_Manager();
 		$template_parts->add_template_part(
 			'tickets',
-			__( 'Ticket Selector', 'event_espresso' ),
+			__('Ticket Selector', 'event_espresso'),
 			'content-espresso_events-tickets.php',
 			$config->display_order_tickets
 		);
 		$template_parts->add_template_part(
 			'datetimes',
-			__( 'Dates and Times', 'event_espresso' ),
+			__('Dates and Times', 'event_espresso'),
 			'content-espresso_events-datetimes.php',
 			$config->display_order_datetimes
 		);
 		$template_parts->add_template_part(
 			'event',
-			__( 'Event Description', 'event_espresso' ),
+			__('Event Description', 'event_espresso'),
 			'content-espresso_events-details.php',
 			$config->display_order_event
 		);
 		$template_parts->add_template_part(
 			'venue',
-			__( 'Venue Information', 'event_espresso' ),
+			__('Venue Information', 'event_espresso'),
 			'content-espresso_events-venues.php',
 			$config->display_order_venue
 		);
-		do_action( 'AHEE__EED_Event_Archive__initialize_template_parts', $template_parts );
+		do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
 		return $template_parts;
 	}
 
@@ -184,8 +184,8 @@ 
 	 * @param WP $WP
 	 * @return    void
 	 */
-	public function run( $WP ) {
-		do_action( 'AHEE__EED_Events_Archive__before_run' );
+	public function run($WP) {
+		do_action('AHEE__EED_Events_Archive__before_run');
 		// ensure valid EE_Events_Archive_Config() object exists
 		$this->set_config();
 		/** @type EE_Events_Archive_Config $config */
@@ -197,14 +197,14 @@ 
 		EEH_Event_Query::add_query_filters();
 		// set params that will get used by the filters
 		EEH_Event_Query::set_query_params(
-			'', 	// month
-			'', 	// category
-			$config->display_expired_events, 	// show_expired
-			'start_date', 	// orderby
+			'', // month
+			'', // category
+			$config->display_expired_events, // show_expired
+			'start_date', // orderby
 			'ASC' 	// sort
 		);
 		// check what template is loaded
-		add_filter( 'template_include',  array( $this, 'template_include' ), 999, 1 );
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
 	}
 
 
@@ -231,7 +231,7 @@ 
      */
 	public function event_list_iframe() {
         \EED_Events_Archive::$iframe = true;
-		$event_list_iframe = new EventsArchiveIframe( $this );
+		$event_list_iframe = new EventsArchiveIframe($this);
 		$event_list_iframe->display();
 	}
 
@@ -269,42 +269,42 @@ 
 	 * @param string $template
 	 * @return    string
 	 */
-	public function template_include( $template = '' ) {
+	public function template_include($template = '') {
 		// don't add content filter for dedicated EE child themes or private posts
-		if ( ! EEH_Template::is_espresso_theme() ) {
+		if ( ! EEH_Template::is_espresso_theme()) {
 			/** @type EE_Events_Archive_Config $config */
 			$config = $this->config();
 			// add status banner ?
-			if ( $config->display_status_banner ) {
-				add_filter( 'the_title', array( 'EED_Events_Archive', 'the_title' ), 100, 2 );
+			if ($config->display_status_banner) {
+				add_filter('the_title', array('EED_Events_Archive', 'the_title'), 100, 2);
 			}
 			// if NOT a custom template
 			if (
                 apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
 				|| EE_Registry::instance()
-                    ->load_core( 'Front_Controller' )
+                    ->load_core('Front_Controller')
                     ->get_selected_template() !== 'archive-espresso_events.php'
 			) {
 				// don't display entry meta because the existing theme will take care of that
-				add_filter( 'FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true' );
+				add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
 			// load functions.php file for the theme (loaded by WP if using child theme)
 				EEH_Template::load_espresso_theme_functions();
 				// because we don't know if the theme is using the_excerpt()
 				add_filter(
 				    'the_excerpt',
-                    array( 'EED_Events_Archive', 'event_details' ),
+                    array('EED_Events_Archive', 'event_details'),
                     EED_Events_Archive::EVENT_DETAILS_PRIORITY
                 );
 				// or the_content
 				add_filter(
 				    'the_content',
-                    array( 'EED_Events_Archive', 'event_details' ),
+                    array('EED_Events_Archive', 'event_details'),
                     EED_Events_Archive::EVENT_DETAILS_PRIORITY
                 );
 				// and just in case they are running get_the_excerpt() which DESTROYS things
-				add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 );
+				add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
 				// don't display entry meta because the existing theme will take care of that
-				add_filter( 'FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false' );
+				add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
 			}
 		}
 		return $template;
@@ -319,25 +319,25 @@ 
 	 * 	@param		string 	$excerpt
 	 * 	@return 		string
 	 */
-	public static function get_the_excerpt( $excerpt = '' ) {
-		if ( post_password_required() ) {
+	public static function get_the_excerpt($excerpt = '') {
+		if (post_password_required()) {
 			return $excerpt;
 		}
-		if ( apply_filters( 'FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false ) ) {
+		if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
 			remove_filter(
 			    'the_excerpt',
-                array( 'EED_Events_Archive', 'event_details' ),
+                array('EED_Events_Archive', 'event_details'),
                 EED_Events_Archive::EVENT_DETAILS_PRIORITY
             );
 			remove_filter(
 			    'the_content',
-                array( 'EED_Events_Archive', 'event_details' ),
+                array('EED_Events_Archive', 'event_details'),
                 EED_Events_Archive::EVENT_DETAILS_PRIORITY
             );
-			$excerpt = EED_Events_Archive::event_details( $excerpt );
+			$excerpt = EED_Events_Archive::event_details($excerpt);
 		} else {
 			EED_Events_Archive::$using_get_the_excerpt = true;
-			add_filter( 'wp_trim_excerpt', array( 'EED_Events_Archive', 'end_get_the_excerpt' ), 999, 1 );
+			add_filter('wp_trim_excerpt', array('EED_Events_Archive', 'end_get_the_excerpt'), 999, 1);
 		}
 		return $excerpt;
 	}
@@ -351,7 +351,7 @@ 
 	 * @param  string $text
 	 * @return string
 	 */
-	public static function end_get_the_excerpt( $text = '' ) {
+	public static function end_get_the_excerpt($text = '') {
 		EED_Events_Archive::$using_get_the_excerpt = false;
 		return $text;
 	}
@@ -366,10 +366,10 @@ 
 	 * @param 		string 		$id
 	 * @return 		string
 	 */
-	public static function the_title( $title = '', $id = '' ) {
+	public static function the_title($title = '', $id = '') {
 	global $post;
-	if ( $post instanceof WP_Post ) {
-		return in_the_loop() && $post->ID == $id ? espresso_event_status_banner( $post->ID  ) . $title :  $title;
+	if ($post instanceof WP_Post) {
+		return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID).$title : $title;
 	}
 	return $title;
 }
@@ -383,7 +383,7 @@ 
 	 * 	@param		string 	$content
 	 * 	@return 		string
 	 */
-	public static function event_details( $content ) {
+	public static function event_details($content) {
 		global $post;
 		static $current_post_ID = 0;
 		if (
@@ -392,8 +392,8 @@ 
 			&& ! EED_Events_Archive::$using_get_the_excerpt
 			&& ! post_password_required()
 			&& (
-				apply_filters( 'FHEE__EES_Espresso_Events__process_shortcode__true', false )
-				|| ! apply_filters( 'FHEE__content_espresso_events__template_loaded', false )
+				apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
+				|| ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
 			)
 		) {
 			// Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
@@ -402,8 +402,8 @@ 
 			// We want to allow those plugins to still do their thing and have access to our content, but depending on
 			// how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
 			// so the following allows this filter to be applied multiple times, but only once for real
-			$current_post_ID = did_action( 'loop_start' ) ? $post->ID : 0;
-			if ( EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order ) {
+			$current_post_ID = did_action('loop_start') ? $post->ID : 0;
+			if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
 				$content = \EED_Events_Archive::use_sortable_display_order();
 			} else {
 				$content = \EED_Events_Archive::use_filterable_display_order();
@@ -422,36 +422,36 @@ 
 	 */
 	protected static function use_sortable_display_order() {
 		// no further password checks required atm
-		add_filter( 'FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true' );
+		add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
 		// we need to first remove this callback from being applied to the_content() or the_excerpt()
         // (otherwise it will recurse and blow up the interweb)
 		remove_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_details' ),
+            array('EED_Events_Archive', 'event_details'),
             EED_Events_Archive::EVENT_DETAILS_PRIORITY
         );
 		remove_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_details' ),
+            array('EED_Events_Archive', 'event_details'),
             EED_Events_Archive::EVENT_DETAILS_PRIORITY
         );
-		remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
+		remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
 		// now add additional content depending on whether event is using the_excerpt() or the_content()
 		EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
-		$content = EEH_Template::locate_template( 'content-espresso_events-details.php' );
-		$content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters( $content );
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		$content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
 		// re-add our main filters (or else the next event won't have them)
 		add_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_details' ),
+            array('EED_Events_Archive', 'event_details'),
             EED_Events_Archive::EVENT_DETAILS_PRIORITY
         );
 		add_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_details' ),
+            array('EED_Events_Archive', 'event_details'),
             EED_Events_Archive::EVENT_DETAILS_PRIORITY
         );
-		add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 );
+		add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
 		remove_filter(
 		    'FHEE__EED_Events_Archive__event_details__no_post_password_required',
             '__return_true'
@@ -472,36 +472,36 @@ 
 		// (otherwise it will recurse and blow up the interweb)
 		remove_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_details' ),
+            array('EED_Events_Archive', 'event_details'),
             EED_Events_Archive::EVENT_DETAILS_PRIORITY
         );
 		remove_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_details' ),
+            array('EED_Events_Archive', 'event_details'),
             EED_Events_Archive::EVENT_DETAILS_PRIORITY
         );
-		remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
+		remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
 		//now add additional content depending on whether event is using the_excerpt() or the_content()
 		EED_Events_Archive::_add_additional_excerpt_filters();
 		EED_Events_Archive::_add_additional_content_filters();
-		do_action( 'AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters' );
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
 		// now load our template
-		$content = EEH_Template::locate_template( 'content-espresso_events-details.php' );
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
 		// re-add our main filters (or else the next event won't have them)
 		add_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_details' ),
+            array('EED_Events_Archive', 'event_details'),
             EED_Events_Archive::EVENT_DETAILS_PRIORITY
         );
 		add_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_details' ),
+            array('EED_Events_Archive', 'event_details'),
             EED_Events_Archive::EVENT_DETAILS_PRIORITY
         );
-		add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 );
+		add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
 		// but remove the other filters so that they don't get applied to the next post
 		EED_Events_Archive::_remove_additional_events_archive_filters();
-		do_action( 'AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters' );
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
 		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
 		//return ! empty( $template ) ? $template : $content;
 		return $content;
@@ -516,11 +516,11 @@ 
 	 * 	@param		string 	$content
 	 *  	@return 		string
 	 */
-	public static function event_datetimes( $content ) {
-		if ( post_password_required() ) {
+	public static function event_datetimes($content) {
+		if (post_password_required()) {
 			return $content;
 		}
-		return EEH_Template::locate_template( 'content-espresso_events-datetimes.php' ) . $content;
+		return EEH_Template::locate_template('content-espresso_events-datetimes.php').$content;
 	}
 
 	/**
@@ -530,11 +530,11 @@ 
 	 * 	@param		string 	$content
 	 *  	@return 		string
 	 */
-	public static function event_tickets( $content ) {
-		if ( post_password_required() ) {
+	public static function event_tickets($content) {
+		if (post_password_required()) {
 			return $content;
 		}
-		return EEH_Template::locate_template( 'content-espresso_events-tickets.php' ) . $content;
+		return EEH_Template::locate_template('content-espresso_events-tickets.php').$content;
 	}
 
 
@@ -546,8 +546,8 @@ 
 	 * @param    string $content
 	 * @return    string
 	 */
-	public static function event_venue( $content ) {
-		return EED_Events_Archive::event_venues( $content );
+	public static function event_venue($content) {
+		return EED_Events_Archive::event_venues($content);
 	}
 
 	/**
@@ -557,11 +557,11 @@ 
 	 * 	@param		string 	$content
 	 *  	@return 		string
 	 */
-	public static function event_venues( $content ) {
-		if ( post_password_required() ) {
+	public static function event_venues($content) {
+		if (post_password_required()) {
 			return $content;
 		}
-		return $content . EEH_Template::locate_template( 'content-espresso_events-venues.php' );
+		return $content.EEH_Template::locate_template('content-espresso_events-venues.php');
 	}
 
 
@@ -575,17 +575,17 @@ 
 	private static function _add_additional_excerpt_filters() {
 		add_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
+            array('EED_Events_Archive', 'event_datetimes'),
             EED_Events_Archive::EVENT_DATETIMES_PRIORITY
         );
 		add_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_tickets' ),
+            array('EED_Events_Archive', 'event_tickets'),
             EED_Events_Archive::EVENT_TICKETS_PRIORITY
         );
 		add_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_venues' ),
+            array('EED_Events_Archive', 'event_venues'),
             EED_Events_Archive::EVENT_VENUES_PRIORITY
         );
 	}
@@ -601,17 +601,17 @@ 
 	private static function _add_additional_content_filters() {
 		add_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
+            array('EED_Events_Archive', 'event_datetimes'),
             EED_Events_Archive::EVENT_DATETIMES_PRIORITY
         );
 		add_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_tickets' ),
+            array('EED_Events_Archive', 'event_tickets'),
             EED_Events_Archive::EVENT_TICKETS_PRIORITY
         );
 		add_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_venues' ),
+            array('EED_Events_Archive', 'event_venues'),
             EED_Events_Archive::EVENT_VENUES_PRIORITY
         );
 	}
@@ -627,32 +627,32 @@ 
 	private static function _remove_additional_events_archive_filters() {
 		remove_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
+            array('EED_Events_Archive', 'event_datetimes'),
             EED_Events_Archive::EVENT_DATETIMES_PRIORITY
         );
 		remove_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_tickets' ),
+            array('EED_Events_Archive', 'event_tickets'),
             EED_Events_Archive::EVENT_TICKETS_PRIORITY
         );
 		remove_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_venues' ),
+            array('EED_Events_Archive', 'event_venues'),
             EED_Events_Archive::EVENT_VENUES_PRIORITY
         );
 		remove_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
+            array('EED_Events_Archive', 'event_datetimes'),
             EED_Events_Archive::EVENT_DATETIMES_PRIORITY
         );
 		remove_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_tickets' ),
+            array('EED_Events_Archive', 'event_tickets'),
             EED_Events_Archive::EVENT_TICKETS_PRIORITY
         );
 		remove_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_venues' ),
+            array('EED_Events_Archive', 'event_venues'),
             EED_Events_Archive::EVENT_VENUES_PRIORITY
         );
 	}
@@ -667,45 +667,45 @@ 
 	 */
 	public static function remove_all_events_archive_filters() {
 		//remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
-		remove_filter( 'the_title', array( 'EED_Events_Archive', 'the_title' ), 1 );
+		remove_filter('the_title', array('EED_Events_Archive', 'the_title'), 1);
 		remove_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_details' ),
+            array('EED_Events_Archive', 'event_details'),
             EED_Events_Archive::EVENT_DETAILS_PRIORITY
         );
 		remove_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
+            array('EED_Events_Archive', 'event_datetimes'),
             EED_Events_Archive::EVENT_DATETIMES_PRIORITY
         );
 		remove_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_tickets' ),
+            array('EED_Events_Archive', 'event_tickets'),
             EED_Events_Archive::EVENT_TICKETS_PRIORITY
         );
 		remove_filter(
 		    'the_excerpt',
-            array( 'EED_Events_Archive', 'event_venues' ),
+            array('EED_Events_Archive', 'event_venues'),
             EED_Events_Archive::EVENT_VENUES_PRIORITY
         );
 		remove_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_details' ),
+            array('EED_Events_Archive', 'event_details'),
             EED_Events_Archive::EVENT_DETAILS_PRIORITY
         );
 		remove_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_datetimes' ),
+            array('EED_Events_Archive', 'event_datetimes'),
             EED_Events_Archive::EVENT_DATETIMES_PRIORITY
         );
 		remove_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_tickets' ),
+            array('EED_Events_Archive', 'event_tickets'),
             EED_Events_Archive::EVENT_TICKETS_PRIORITY
         );
 		remove_filter(
 		    'the_content',
-            array( 'EED_Events_Archive', 'event_venues' ),
+            array('EED_Events_Archive', 'event_venues'),
             EED_Events_Archive::EVENT_VENUES_PRIORITY
         );
 		// don't display entry meta because the existing theme will take care of that
@@ -727,12 +727,12 @@ 
 	 *  @return 	void
 	 */
 	public function load_event_list_assets() {
-        do_action( 'AHEE__EED_Events_Archive__before_load_assets' );
-		add_filter( 'FHEE_load_EE_Session', '__return_true' );
-		add_filter( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true' );
-		add_action('wp_enqueue_scripts', array( $this, 'wp_enqueue_scripts' ), 10 );
-		if ( EE_Registry::instance()->CFG->map_settings->use_google_maps ) {
-			add_action('wp_enqueue_scripts', array( 'EEH_Maps', 'espresso_google_map_js' ), 11 );
+        do_action('AHEE__EED_Events_Archive__before_load_assets');
+		add_filter('FHEE_load_EE_Session', '__return_true');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+		if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+			add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
 		}
 	}
 
@@ -749,13 +749,13 @@ 
 	 */
 	public function wp_enqueue_scripts() {
 		// get some style
-		if ( apply_filters( 'FHEE_enable_default_espresso_css', FALSE ) ) {
+		if (apply_filters('FHEE_enable_default_espresso_css', FALSE)) {
 			// first check uploads folder
-			if ( EEH_File::is_readable( get_stylesheet_directory() . $this->theme . DS . 'style.css' )) {
-				wp_register_style( $this->theme, get_stylesheet_directory_uri() . $this->theme . DS . 'style.css', array( 'dashicons', 'espresso_default' ));
+			if (EEH_File::is_readable(get_stylesheet_directory().$this->theme.DS.'style.css')) {
+				wp_register_style($this->theme, get_stylesheet_directory_uri().$this->theme.DS.'style.css', array('dashicons', 'espresso_default'));
 			} else {
 		}
-		wp_enqueue_style( $this->theme );
+		wp_enqueue_style($this->theme);
 
 	}
 }
@@ -773,8 +773,8 @@ 
 	 */
 	public static function template_settings_form() {
 	$template_settings = EE_Registry::instance()->CFG->template_settings;
-	$template_settings->EED_Events_Archive = isset( $template_settings->EED_Events_Archive ) ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
-	$template_settings->EED_Events_Archive = apply_filters( 'FHEE__EED_Events_Archive__template_settings_form__event_list_config', $template_settings->EED_Events_Archive );
+	$template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive) ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
+	$template_settings->EED_Events_Archive = apply_filters('FHEE__EED_Events_Archive__template_settings_form__event_list_config', $template_settings->EED_Events_Archive);
 	$events_archive_settings = array(
 		'display_status_banner' => 0,
 		'display_description' => 1,
@@ -783,8 +783,8 @@ 
 		'display_venue' => 0,
 		'display_expired_events' => 0
 	);
-	$events_archive_settings = array_merge( $events_archive_settings, (array)$template_settings->EED_Events_Archive );
-	EEH_Template::display_template( EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php', $events_archive_settings );
+	$events_archive_settings = array_merge($events_archive_settings, (array) $template_settings->EED_Events_Archive);
+	EEH_Template::display_template(EVENTS_ARCHIVE_TEMPLATES_PATH.'admin-event-list-settings.template.php', $events_archive_settings);
 }
 
 
@@ -800,16 +800,16 @@ 
 	 *  @param 	EE_Request_Handler $REQ
 	 *  @return 	EE_Template_Config
 	 */
-	public static function update_template_settings( $CFG, $REQ ) {
+	public static function update_template_settings($CFG, $REQ) {
 		$CFG->EED_Events_Archive = new EE_Events_Archive_Config();
 		// unless we are resetting the config...
-		if ( ! isset( $REQ['EED_Events_Archive_reset_event_list_settings'] ) || absint( $REQ['EED_Events_Archive_reset_event_list_settings'] ) !== 1 ) {
-			$CFG->EED_Events_Archive->display_status_banner = isset( $REQ['EED_Events_Archive_display_status_banner'] ) ? absint( $REQ['EED_Events_Archive_display_status_banner'] ) : 0;
-			$CFG->EED_Events_Archive->display_description = isset( $REQ['EED_Events_Archive_display_description'] ) ? absint( $REQ['EED_Events_Archive_display_description'] ) : 1;
-			$CFG->EED_Events_Archive->display_ticket_selector = isset( $REQ['EED_Events_Archive_display_ticket_selector'] ) ? absint( $REQ['EED_Events_Archive_display_ticket_selector'] ) : 0;
-			$CFG->EED_Events_Archive->display_datetimes = isset( $REQ['EED_Events_Archive_display_datetimes'] ) ? absint( $REQ['EED_Events_Archive_display_datetimes'] ) : 1;
-			$CFG->EED_Events_Archive->display_venue = isset( $REQ['EED_Events_Archive_display_venue'] ) ? absint( $REQ['EED_Events_Archive_display_venue'] ) : 0;
-			$CFG->EED_Events_Archive->display_expired_events = isset( $REQ['EED_Events_Archive_display_expired_events'] ) ? absint( $REQ['EED_Events_Archive_display_expired_events'] ) : 0;			}
+		if ( ! isset($REQ['EED_Events_Archive_reset_event_list_settings']) || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1) {
+			$CFG->EED_Events_Archive->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner']) ? absint($REQ['EED_Events_Archive_display_status_banner']) : 0;
+			$CFG->EED_Events_Archive->display_description = isset($REQ['EED_Events_Archive_display_description']) ? absint($REQ['EED_Events_Archive_display_description']) : 1;
+			$CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector']) ? absint($REQ['EED_Events_Archive_display_ticket_selector']) : 0;
+			$CFG->EED_Events_Archive->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes']) ? absint($REQ['EED_Events_Archive_display_datetimes']) : 1;
+			$CFG->EED_Events_Archive->display_venue = isset($REQ['EED_Events_Archive_display_venue']) ? absint($REQ['EED_Events_Archive_display_venue']) : 0;
+			$CFG->EED_Events_Archive->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events']) ? absint($REQ['EED_Events_Archive_display_expired_events']) : 0; }
 		return $CFG;
 	}
 
@@ -822,10 +822,10 @@ 
 	 * @param string $extra_class
 	 * @return    string
 	 */
-	public static function event_list_css( $extra_class = '' ) {
-		$event_list_css = ! empty( $extra_class ) ? array( $extra_class ) : array();
+	public static function event_list_css($extra_class = '') {
+		$event_list_css = ! empty($extra_class) ? array($extra_class) : array();
 		$event_list_css[] = 'espresso-event-list-event';
-		return implode( ' ', $event_list_css );
+		return implode(' ', $event_list_css);
 	}
 
 
@@ -852,9 +852,9 @@ 
 	 * @param $value
 	 * @return    bool
 	 */
-	public static function display_description( $value ) {
+	public static function display_description($value) {
 		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-		$display_description= isset( $config->display_description ) ? $config->display_description : 1;
+		$display_description = isset($config->display_description) ? $config->display_description : 1;
 		return $display_description === $value ? TRUE : FALSE;
 	}
 
@@ -867,7 +867,7 @@ 
 	 */
 	public static function display_ticket_selector() {
 		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-		return isset( $config->display_ticket_selector ) && $config->display_ticket_selector ? TRUE : FALSE;
+		return isset($config->display_ticket_selector) && $config->display_ticket_selector ? TRUE : FALSE;
 	}
 
 
@@ -880,7 +880,7 @@ 
 	 */
 	public static function display_venue() {
 		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-		return isset( $config->display_venue ) && $config->display_venue && EEH_Venue_View::venue_name() ? TRUE : FALSE;
+		return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name() ? TRUE : FALSE;
 	}
 
 
@@ -892,7 +892,7 @@ 
 	 */
 	public static function display_datetimes() {
 		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-		return isset( $config->display_datetimes ) && $config->display_datetimes ? TRUE : FALSE;
+		return isset($config->display_datetimes) && $config->display_datetimes ? TRUE : FALSE;
 }
 
 
@@ -907,7 +907,7 @@ 
 	 *  @return 	string
 	 */
 	public static function event_list_title() {
-		return apply_filters( 'FHEE__archive_espresso_events_template__upcoming_events_h1', __( 'Upcoming Events', 'event_espresso' ));
+		return apply_filters('FHEE__archive_espresso_events_template__upcoming_events_h1', __('Upcoming Events', 'event_espresso'));
 	}
 
 
@@ -916,11 +916,11 @@ 
 	/**
 	 * 	@since 4.4.0
 	 */
-	public static function _doing_it_wrong_notice( $function = '' ) {
+	public static function _doing_it_wrong_notice($function = '') {
 		EE_Error::doing_it_wrong(
 			__FUNCTION__,
 			sprintf(
-				__( 'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s', 'event_espresso' ),
+				__('EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s', 'event_espresso'),
 				$function,
 				'<br />',
 				'4.6.0'
@@ -942,89 +942,89 @@ 
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public function posts_fields( $SQL, WP_Query $wp_query ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_fields( $SQL, $wp_query );
+	public function posts_fields($SQL, WP_Query $wp_query) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields($SQL, $wp_query);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_fields_sql_for_orderby( $orderby_params = array() ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_fields_sql_for_orderby( $orderby_params );
+	public static function posts_fields_sql_for_orderby($orderby_params = array()) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public function posts_join( $SQL, WP_Query $wp_query ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_join( $SQL, $wp_query );
+	public function posts_join($SQL, WP_Query $wp_query) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join($SQL, $wp_query);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_join_sql_for_terms( $join_terms = NULL ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_join_sql_for_terms( $join_terms );
+	public static function posts_join_sql_for_terms($join_terms = NULL) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_join_for_orderby( $orderby_params = array() ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_join_for_orderby( $orderby_params );
+	public static function posts_join_for_orderby($orderby_params = array()) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_for_orderby($orderby_params);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public function posts_where( $SQL, WP_Query $wp_query ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_where( $SQL, $wp_query );
+	public function posts_where($SQL, WP_Query $wp_query) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where($SQL, $wp_query);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_where_sql_for_show_expired( $show_expired = FALSE ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_where_sql_for_show_expired( $show_expired );
+	public static function posts_where_sql_for_show_expired($show_expired = FALSE) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_where_sql_for_event_category_slug( $event_category_slug = NULL ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_where_sql_for_event_category_slug( $event_category_slug );
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = NULL) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_where_sql_for_event_list_month( $month = NULL ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_where_sql_for_event_list_month( $month );
+	public static function posts_where_sql_for_event_list_month($month = NULL) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public function posts_orderby( $SQL, WP_Query $wp_query ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_orderby( $SQL, $wp_query );
+	public function posts_orderby($SQL, WP_Query $wp_query) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby($SQL, $wp_query);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_orderby_sql( $orderby_params = array(), $sort = 'ASC' ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_orderby_sql( $orderby_params, $sort );
+	public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC') {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
 	}
 
 
@@ -1055,8 +1055,8 @@ 
  * @param string $extra_class
  * @return string
  */
-function espresso_event_list_css( $extra_class = '' ) {
-	return EED_Events_Archive::event_list_css( $extra_class );
+function espresso_event_list_css($extra_class = '') {
+	return EED_Events_Archive::event_list_css($extra_class);
 }
 
 /**
@@ -1070,14 +1070,14 @@ 
  * @return bool
  */
 function espresso_display_full_description_in_event_list() {
-	return EED_Events_Archive::display_description( 2 );
+	return EED_Events_Archive::display_description(2);
 }
 
 /**
  * @return bool
  */
 function espresso_display_excerpt_in_event_list() {
-	return EED_Events_Archive::display_description( 1 );
+	return EED_Events_Archive::display_description(1);
 }
 
 /**

modules/events_archive/EventsArchiveIframe.php

Indentation +52 added lines, -52 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\libraries\iframe_display\Iframe;
 
 if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+	exit( 'No direct script access allowed' );
 }
 
 
@@ -21,57 +21,57 @@ 
 
 
 
-    /**
-     * EventsArchiveIframe constructor.
-     *
-     * @param \EED_Events_Archive $EED_Events_Archive
-     * @throws \DomainException
-     */
-    public function __construct( $EED_Events_Archive )
-    {
-        \EE_Registry::instance()->REQ->set_espresso_page( true );
-        add_filter('FHEE__EED_Events_Archive__event_list_iframe', '__return_true');
-        $EED_Events_Archive->event_list();
-        /** @var \EventEspresso\core\domain\entities\shortcodes\EspressoEvents $event_list */
-        $event_list = \EE_Registry::instance()->create('EventEspresso\core\domain\entities\shortcodes\EspressoEvents');
-        parent::__construct(
-            esc_html__( 'Event List', 'event_espresso' ),
-            $event_list->processShortcode()
-        );
-        $this->addStylesheets(
-            apply_filters(
-                'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-                array(
-                    'espresso_default'           => is_readable( EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css' )
-                        ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
-                        : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
-                ),
-                $this
-            )
-        );
-        $this->addScripts(
-            apply_filters(
-                'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-                array(
-                    'gmap_api' => sprintf(
-                        'https://maps.googleapis.com/maps/api/js?key=%s',
-                        apply_filters(
-                            'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
-                            \EE_Registry::instance()->CFG->map_settings->google_map_api_key
-                        )
-                    ),
-                    'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
-                ),
-                $this
-            )
-        );
-        $this->addLocalizedVars(
-            array(
-                'ee_gmap' => \EEH_Maps::$gmap_vars,
-            ),
-            'ee_gmap_vars'
-        );
-    }
+	/**
+	 * EventsArchiveIframe constructor.
+	 *
+	 * @param \EED_Events_Archive $EED_Events_Archive
+	 * @throws \DomainException
+	 */
+	public function __construct( $EED_Events_Archive )
+	{
+		\EE_Registry::instance()->REQ->set_espresso_page( true );
+		add_filter('FHEE__EED_Events_Archive__event_list_iframe', '__return_true');
+		$EED_Events_Archive->event_list();
+		/** @var \EventEspresso\core\domain\entities\shortcodes\EspressoEvents $event_list */
+		$event_list = \EE_Registry::instance()->create('EventEspresso\core\domain\entities\shortcodes\EspressoEvents');
+		parent::__construct(
+			esc_html__( 'Event List', 'event_espresso' ),
+			$event_list->processShortcode()
+		);
+		$this->addStylesheets(
+			apply_filters(
+				'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+				array(
+					'espresso_default'           => is_readable( EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css' )
+						? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
+						: EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+				),
+				$this
+			)
+		);
+		$this->addScripts(
+			apply_filters(
+				'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+				array(
+					'gmap_api' => sprintf(
+						'https://maps.googleapis.com/maps/api/js?key=%s',
+						apply_filters(
+							'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
+							\EE_Registry::instance()->CFG->map_settings->google_map_api_key
+						)
+					),
+					'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
+				),
+				$this
+			)
+		);
+		$this->addLocalizedVars(
+			array(
+				'ee_gmap' => \EEH_Maps::$gmap_vars,
+			),
+			'ee_gmap_vars'
+		);
+	}
 
 
 

Spacing +9 added lines, -9 removed lines

@@ -3,8 +3,8 @@ 
 
 use EventEspresso\core\libraries\iframe_display\Iframe;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+    exit('No direct script access allowed');
 }
 
 
@@ -27,24 +27,24 @@ 
      * @param \EED_Events_Archive $EED_Events_Archive
      * @throws \DomainException
      */
-    public function __construct( $EED_Events_Archive )
+    public function __construct($EED_Events_Archive)
     {
-        \EE_Registry::instance()->REQ->set_espresso_page( true );
+        \EE_Registry::instance()->REQ->set_espresso_page(true);
         add_filter('FHEE__EED_Events_Archive__event_list_iframe', '__return_true');
         $EED_Events_Archive->event_list();
         /** @var \EventEspresso\core\domain\entities\shortcodes\EspressoEvents $event_list */
         $event_list = \EE_Registry::instance()->create('EventEspresso\core\domain\entities\shortcodes\EspressoEvents');
         parent::__construct(
-            esc_html__( 'Event List', 'event_espresso' ),
+            esc_html__('Event List', 'event_espresso'),
             $event_list->processShortcode()
         );
         $this->addStylesheets(
             apply_filters(
                 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
                 array(
-                    'espresso_default'           => is_readable( EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css' )
-                        ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
-                        : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+                    'espresso_default'           => is_readable(EVENT_ESPRESSO_UPLOAD_DIR.'css/style.css')
+                        ? EVENT_ESPRESSO_UPLOAD_DIR.'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION
+                        : EE_GLOBAL_ASSETS_URL.'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION,
                 ),
                 $this
             )
@@ -60,7 +60,7 @@ 
                             \EE_Registry::instance()->CFG->map_settings->google_map_api_key
                         )
                     ),
-                    'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
+                    'ee_gmap'  => EE_HELPERS_ASSETS.'ee_gmap.js?ver=1.0',
                 ),
                 $this
             )

core/EE_Registry.core.php

Indentation +1338 added lines, -1338 removed lines

@@ -16,1374 +16,1374 @@
 class EE_Registry
 {
 
-    /**
-     *    EE_Registry Object
-     *
-     * @var EE_Registry $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     * @access    protected
-     */
-    protected $_dependency_map = null;
-
-    /**
-     * @var array $_class_abbreviations
-     * @access    protected
-     */
-    protected $_class_abbreviations = array();
-
-    /**
-     * @access public
-     * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     *    EE_Cart Object
-     *
-     * @access    public
-     * @var    EE_Cart $CART
-     */
-    public $CART = null;
-
-    /**
-     *    EE_Config Object
-     *
-     * @access    public
-     * @var    EE_Config $CFG
-     */
-    public $CFG = null;
-
-    /**
-     * EE_Network_Config Object
-     *
-     * @access public
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG = null;
-
-    /**
-     *    StdClass object for storing library classes in
-     *
-     * @public LIB
-     * @var StdClass $LIB
-     */
-    public $LIB = null;
-
-    /**
-     *    EE_Request_Handler Object
-     *
-     * @access    public
-     * @var    EE_Request_Handler $REQ
-     */
-    public $REQ = null;
-
-    /**
-     *    EE_Session Object
-     *
-     * @access    public
-     * @var    EE_Session $SSN
-     */
-    public $SSN = null;
-
-    /**
-     * holds the ee capabilities object.
-     *
-     * @since 4.5.0
-     * @var EE_Capabilities
-     */
-    public $CAP = null;
-
-    /**
-     * holds the EE_Message_Resource_Manager object.
-     *
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager
-     */
-    public $MRM = null;
-
-
-    /**
-     * Holds the Assets Registry instance
-     * @var Registry
-     */
-    public $AssetsRegistry = null;
-
-    /**
-     *    $addons - StdClass object for holding addons which have registered themselves to work with EE core
-     *
-     * @access    public
-     * @var    EE_Addon[]
-     */
-    public $addons = null;
-
-    /**
-     *    $models
-     * @access    public
-     * @var    EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     */
-    public $models = array();
-
-    /**
-     *    $modules
-     * @access    public
-     * @var    EED_Module[] $modules
-     */
-    public $modules = null;
-
-    /**
-     *    $shortcodes
-     * @access    public
-     * @var    EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes = null;
-
-    /**
-     *    $widgets
-     * @access    public
-     * @var    WP_Widget[] $widgets
-     */
-    public $widgets = null;
-
-    /**
-     * $non_abstract_db_models
-     * @access public
-     * @var array this is an array of all implemented model names (i.e. not the parent abstract models, or models
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
-     * classnames (eg "EEM_Event")
-     */
-    public $non_abstract_db_models = array();
-
-
-    /**
-     *    $i18n_js_strings - internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @access    public
-     * @var    array
-     */
-    public static $i18n_js_strings = array();
-
-
-    /**
-     *    $main_file - path to espresso.php
-     *
-     * @access    public
-     * @var    array
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @access    public
-     * @var ReflectionClass[]
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @access    protected
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param  \EE_Dependency_Map $dependency_map
-     * @return \EE_Registry instance
-     */
-    public static function instance(\EE_Dependency_Map $dependency_map = null)
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_Registry) {
-            self::$_instance = new EE_Registry($dependency_map);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     * @param  \EE_Dependency_Map $dependency_map
-     * @return \EE_Registry
-     */
-    protected function __construct(\EE_Dependency_Map $dependency_map)
-    {
-        $this->_dependency_map = $dependency_map;
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-    }
-
-
-
-    /**
-     * initialize
-     */
-    public function initialize()
-    {
-        $this->_class_abbreviations = apply_filters(
-            'FHEE__EE_Registry____construct___class_abbreviations',
-            array(
-                'EE_Config'                                       => 'CFG',
-                'EE_Session'                                      => 'SSN',
-                'EE_Capabilities'                                 => 'CAP',
-                'EE_Cart'                                         => 'CART',
-                'EE_Network_Config'                               => 'NET_CFG',
-                'EE_Request_Handler'                              => 'REQ',
-                'EE_Message_Resource_Manager'                     => 'MRM',
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
-            )
-        );
-        // class library
-        $this->LIB = new stdClass();
-        $this->addons = new stdClass();
-        $this->modules = new stdClass();
-        $this->shortcodes = new stdClass();
-        $this->widgets = new stdClass();
-        $this->load_core('Base', array(), true);
-        // add our request and response objects to the cache
-        $request_loader = $this->_dependency_map->class_loader('EE_Request');
-        $this->_set_cached_class(
-            $request_loader(),
-            'EE_Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader('EE_Response');
-        $this->_set_cached_class(
-            $response_loader(),
-            'EE_Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
-    }
-
-
-
-    /**
-     *    init
-     *
-     * @access    public
-     * @return    void
-     */
-    public function init()
-    {
-        $this->AssetsRegistry = new Registry();
-        // Get current page protocol
-        $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
-        // Output admin-ajax.php URL with same protocol as current page
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
-    }
-
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings()
-    {
-        $i18n_js_strings = (array)EE_Registry::$i18n_js_strings;
-        foreach ($i18n_js_strings as $key => $value) {
-            if (is_scalar($value)) {
-                $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8');
-            }
-        }
-        return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
-    }
-
-
-
-    /**
-     * @param mixed string | EED_Module $module
-     */
-    public function add_module($module)
-    {
-        if ($module instanceof EED_Module) {
-            $module_class = get_class($module);
-            $this->modules->{$module_class} = $module;
-        } else {
-            if ( ! class_exists('EE_Module_Request_Router')) {
-                $this->load_core('Module_Request_Router');
-            }
-            $this->modules->{$module} = EE_Module_Request_Router::module_factory($module);
-        }
-    }
-
-
-
-    /**
-     * @param string $module_name
-     * @return mixed EED_Module | NULL
-     */
-    public function get_module($module_name = '')
-    {
-        return isset($this->modules->{$module_name}) ? $this->modules->{$module_name} : null;
-    }
-
-
-
-    /**
-     *    loads core classes - must be singletons
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    public function load_core($class_name, $arguments = array(), $load_only = false)
-    {
-        $core_paths = apply_filters(
-            'FHEE__EE_Registry__load_core__core_paths',
-            array(
-                EE_CORE,
-                EE_ADMIN,
-                EE_CPTS,
-                EE_CORE . 'data_migration_scripts' . DS,
-                EE_CORE . 'request_stack' . DS,
-                EE_CORE . 'middleware' . DS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load($core_paths, 'EE_', $class_name, 'core', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads service classes
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    public function load_service($class_name, $arguments = array(), $load_only = false)
-    {
-        $service_paths = apply_filters(
-            'FHEE__EE_Registry__load_service__service_paths',
-            array(
-                EE_CORE . 'services' . DS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load($service_paths, 'EE_', $class_name, 'class', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads data_migration_scripts
-     *
-     * @access    public
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
-     * @param mixed  $arguments
-     * @return EE_Data_Migration_Script_Base|mixed
-     */
-    public function load_dms($class_name, $arguments = array())
-    {
-        // retrieve instantiated class
-        return $this->_load(EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), 'EE_DMS_', $class_name, 'dms', $arguments, false, false, false);
-    }
-
-
-
-    /**
-     *    loads object creating classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: attendee
-     * @param mixed  $arguments  - an array of arguments to pass to the class
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to instantiate
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then set this to FALSE (ie. when instantiating model objects from client in a loop)
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate (default)
-     * @return EE_Base_Class | bool
-     */
-    public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
-    {
-        $paths = apply_filters('FHEE__EE_Registry__load_class__paths', array(
-            EE_CORE,
-            EE_CLASSES,
-            EE_BUSINESS,
-        ));
-        // retrieve instantiated class
-        return $this->_load($paths, 'EE_', $class_name, 'class', $arguments, $from_db, $cache, $load_only);
-    }
-
-
-
-    /**
-     *    loads helper classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEH_Base | bool
-     */
-    public function load_helper($class_name, $arguments = array(), $load_only = true)
-    {
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
-        $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
-        // retrieve instantiated class
-        return $this->_load($helper_paths, 'EEH_', $class_name, 'helper', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads core classes - must be singletons
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @param bool   $cache      whether to cache the object or not.
-     * @return mixed
-     */
-    public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
-    {
-        $paths = array(
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages' . DS,
-            EE_LIBRARIES . 'shortcodes' . DS,
-            EE_LIBRARIES . 'qtips' . DS,
-            EE_LIBRARIES . 'payment_methods' . DS,
-        );
-        // retrieve instantiated class
-        return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only);
-    }
-
-
-
-    /**
-     *    loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEM_Base | bool
-     */
-    public function load_model($class_name, $arguments = array(), $load_only = false)
-    {
-        $paths = apply_filters('FHEE__EE_Registry__load_model__paths', array(
-            EE_MODELS,
-            EE_CORE,
-        ));
-        // retrieve instantiated class
-        return $this->_load($paths, 'EEM_', $class_name, 'model', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed | bool
-     */
-    public function load_model_class($class_name, $arguments = array(), $load_only = true)
-    {
-        $paths = array(
-            EE_MODELS . 'fields' . DS,
-            EE_MODELS . 'helpers' . DS,
-            EE_MODELS . 'relations' . DS,
-            EE_MODELS . 'strategies' . DS,
-        );
-        // retrieve instantiated class
-        return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     * Determines if $model_name is the name of an actual EE model.
-     *
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
-     * @return boolean
-     */
-    public function is_model_name($model_name)
-    {
-        return isset($this->models[$model_name]) ? true : false;
-    }
-
-
-
-    /**
-     *    generic class loader
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
-    {
-        // retrieve instantiated class
-        return $this->_load($path_to_file, '', $file_name, $type, $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     *    load_addon
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $class_name   - full class name  ie:  My_Class
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EE_Addon
-     */
-    public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
-    {
-        // retrieve instantiated class
-        return $this->_load($path_to_file, 'addon', $class_name, $type, $arguments, false, true, $load_only);
-    }
-
-
-
-    /**
-     * instantiates, caches, and automatically resolves dependencies
-     * for classes that use a Fully Qualified Class Name.
-     * if the class is not capable of being loaded using PSR-4 autoloading,
-     * then you need to use one of the existing load_*() methods
-     * which can resolve the classname and filepath from the passed arguments
-     *
-     * @param bool|string $class_name   Fully Qualified Class Name
-     * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
-     * @return mixed                    null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     */
-    public function create(
-        $class_name = false,
-        $arguments = array(),
-        $cache = false,
-        $from_db = false,
-        $load_only = false,
-        $addon = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        $class_name = $this->_dependency_map->get_alias($class_name);
-        if ( ! class_exists($class_name)) {
-            // maybe the class is registered with a preceding \
-            $class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name;
-            // still doesn't exist ?
-            if ( ! class_exists($class_name)) {
-                return null;
-            }
-        }
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only) {
-            return true;
-        }
-        $addon = $addon ? 'addon' : '';
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $addon);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class($class_obj, $class_name, $addon, $from_db);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-    /**
-     * instantiates, caches, and injects dependencies for classes
-     *
-     * @param array       $file_paths   an array of paths to folders to look in
-     * @param string      $class_prefix EE  or EEM or... ???
-     * @param bool|string $class_name   $class name
-     * @param string      $type         file type - core? class? helper? model?
-     * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @return null|object|bool         null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     */
-    protected function _load(
-        $file_paths = array(),
-        $class_prefix = 'EE_',
-        $class_name = false,
-        $type = 'class',
-        $arguments = array(),
-        $from_db = false,
-        $cache = true,
-        $load_only = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if ( ! empty($class_prefix) && $class_prefix != 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name = $this->_dependency_map->get_alias($class_name);
-        $class_exists = class_exists($class_name);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if ( ! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if loading failed, or we are only loading a file but NOT instantiating an object
-            if ( ! $loaded || $load_only) {
-                // return boolean if only loading, or null if an object was expected
-                return $load_only ? $loaded : null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-    /**
-     * _get_cached_class
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @access protected
-     * @param string $class_name
-     * @param string $class_prefix
-     * @return mixed
-     */
-    protected function _get_cached_class($class_name, $class_prefix = '')
-    {
-        if (isset($this->_class_abbreviations[$class_name])) {
-            $class_abbreviation = $this->_class_abbreviations[$class_name];
-        } else {
-            // have to specify something, but not anything that will conflict
-            $class_abbreviation = 'FANCY_BATMAN_PANTS';
-        }
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        } else if (isset ($this->{$class_name})) {
-            return $this->{$class_name};
-        } else if (isset ($this->LIB->{$class_name})) {
-            return $this->LIB->{$class_name};
-        } else if ($class_prefix == 'addon' && isset ($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        }
-        return null;
-    }
-
-
-
-    /**
-     * _resolve_path
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @access protected
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path($class_name, $type = '', $file_paths = array())
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths) ? $file_paths : array($file_paths);
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper DS, if no filepath, then use EE_CLASSES
-            $file_path = $file_path ? str_replace(array('/', '\\'), DS, $file_path) : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type) ? trim($type, '.') . '.' : '';
-            // build full file path
-            $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
-            //does the file exist and can be read ?
-            if (is_readable($file_paths[$key])) {
-                return $file_paths[$key];
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * _require_file
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @access protected
-     * @param  string $path
-     * @param  string $class_name
-     * @param  string $type
-     * @param  array  $file_paths
-     * @return boolean
-     * @throws \EE_Error
-     */
-    protected function _require_file($path, $class_name, $type = '', $file_paths = array())
-    {
-        // don't give up! you gotta...
-        try {
-            //does the file exist and can it be read ?
-            if ( ! $path) {
-                // so sorry, can't find the file
-                throw new EE_Error (
-                    sprintf(
-                        __('The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', 'event_espresso'),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        __('The %s file %s does not appear to contain the %s Class.', 'event_espresso'),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @access protected
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null | object
-     * @throws \EE_Error
-     */
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
-    {
-        $class_obj = null;
-        $instantiation_mode = '0) none';
-        // don't give up! you gotta...
-        try {
-            // create reflection
-            $reflector = $this->get_ReflectionClass($class_name);
-            // make sure arguments are an array
-            $arguments = is_array($arguments) ? $arguments : array($arguments);
-            // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-            // else wrap it in an additional array so that it doesn't get split into multiple parameters
-            $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-                ? $arguments
-                : array($arguments);
-            // attempt to inject dependencies ?
-            if ($this->_dependency_map->has($class_name)) {
-                $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-            }
-            // instantiate the class if possible
-            if ($reflector->isAbstract()) {
-                // nothing to instantiate, loading file was enough
-                // does not throw an exception so $instantiation_mode is unused
-                // $instantiation_mode = "1) no constructor abstract class";
-                $class_obj = true;
-            } else if ($reflector->getConstructor() === null && $reflector->isInstantiable() && empty($arguments)) {
-                // no constructor = static methods only... nothing to instantiate, loading file was enough
-                $instantiation_mode = "2) no constructor but instantiable";
-                $class_obj = $reflector->newInstance();
-            } else if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-                $instantiation_mode = "3) new_instance_from_db()";
-                $class_obj = call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
-            } else if (method_exists($class_name, 'new_instance')) {
-                $instantiation_mode = "4) new_instance()";
-                $class_obj = call_user_func_array(array($class_name, 'new_instance'), $arguments);
-            } else if (method_exists($class_name, 'instance')) {
-                $instantiation_mode = "5) instance()";
-                $class_obj = call_user_func_array(array($class_name, 'instance'), $arguments);
-            } else if ($reflector->isInstantiable()) {
-                $instantiation_mode = "6) constructor";
-                $class_obj = $reflector->newInstanceArgs($arguments);
-            } else {
-                // heh ? something's not right !
-                throw new EE_Error(
-                    sprintf(
-                        __('The %s file %s could not be instantiated.', 'event_espresso'),
-                        $type,
-                        $class_name
-                    )
-                );
-            }
-        } catch (Exception $e) {
-            if ( ! $e instanceof EE_Error) {
-                $e = new EE_Error(
-                    sprintf(
-                        __('The following error occurred while attempting to instantiate "%1$s": %2$s %3$s %2$s instantiation mode : %4$s', 'event_espresso'),
-                        $class_name,
-                        '<br />',
-                        $e->getMessage(),
-                        $instantiation_mode
-                    )
-                );
-            }
-            $e->get_error();
-        }
-        return $class_obj;
-    }
-
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    protected function _array_is_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
-    }
-
-
-
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @access public
-     * @param string $class_name
-     * @return ReflectionClass
-     */
-    public function get_ReflectionClass($class_name)
-    {
-        if (
-            ! isset($this->_reflectors[$class_name])
-            || ! $this->_reflectors[$class_name] instanceof ReflectionClass
-        ) {
-            $this->_reflectors[$class_name] = new ReflectionClass($class_name);
-        }
-        return $this->_reflectors[$class_name];
-    }
-
-
-
-    /**
-     * _resolve_dependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @access protected
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws \ReflectionException
-     */
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
-    {
-        // let's examine the constructor
-        $constructor = $reflector->getConstructor();
-        // whu? huh? nothing?
-        if ( ! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $constructor->getParameters();
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            // is this a dependency for a specific class ?
-            $param_class = $param->getClass() ? $param->getClass()->name : null;
-            if (
-                // param is not even a class
-                empty($param_class)
-                // and something already exists in the incoming arguments for this param
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            } else if (
-                // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                ! empty($param_class)
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-                && $arguments[$argument_keys[$index]] instanceof $param_class
-            ) {
-                // skip this argument and move on to the next
-                continue;
-            } else if (
-                // parameter is type hinted as a class, and should be injected
-                ! empty($param_class)
-                && $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
-            ) {
-                $arguments = $this->_resolve_dependency($class_name, $param_class, $arguments, $index);
-            } else {
-                try {
-                    $arguments[$index] = $param->getDefaultValue();
-                } catch (ReflectionException $e) {
-                    throw new ReflectionException(
-                        sprintf(
-                            __('%1$s for parameter "$%2$s"', 'event_espresso'),
-                            $e->getMessage(),
-                            $param->getName()
-                        )
-                    );
-                }
-            }
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     */
-    protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency($class_name, $param_class)
-                    !== EE_Dependency_Map::load_new_object
-            ? true
-            : false;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on ? $this->_get_cached_class($param_class) : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } else if ($param_class != $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader();
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if (method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = $this->create($param_class, array(), $cache_on);
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            if (isset($argument_keys[$index])) {
-                $arguments[$argument_keys[$index]] = $dependency;
-            } else {
-                $arguments[$index] = $dependency;
-            }
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @access protected
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @return void
-     */
-    protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
-    {
-        if (empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        if (isset($this->_class_abbreviations[$class_name])) {
-            $class_abbreviation = $this->_class_abbreviations[$class_name];
-            $this->{$class_abbreviation} = $class_obj;
-        } else if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-        } else if ($class_prefix == 'addon') {
-            $this->addons->{$class_name} = $class_obj;
-        } else if ( ! $from_db) {
-            $this->LIB->{$class_name} = $class_obj;
-        }
-    }
-
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory($classname, $arguments = array())
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        } else if (method_exists(EE_Registry::instance(), $loader)) {
-            return EE_Registry::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the classname as the property name on EE_Config::instance()->addons)
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name($name)
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() == $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their name() function) They're already available on EE_Config::instance()->addons as properties, where each property's name is
-     * the addon's classname. So if you just want to get the addon by classname, use EE_Config::instance()->addons->{classname}
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name()
-    {
-        $addons = array();
-        foreach ($this->addons as $addon) {
-            $addons[$addon->name()] = $addon;
-        }
-        return $addons;
-    }
-
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function reset_model($model_name)
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0 ? "EEM_{$model_name}" : $model_name;
-        if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
-            return null;
-        }
-        //get that model reset it and make sure we nuke the old reference to it
-        if ($this->LIB->{$model_class_name} instanceof $model_class_name && is_callable(array($model_class_name, 'reset'))) {
-            $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
-        } else {
-            throw new EE_Error(sprintf(__('Model %s does not have a method "reset"', 'event_espresso'), $model_name));
-        }
-        return $this->LIB->{$model_class_name};
-    }
-
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when switch_to_blog
-     * is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only one Session
-     *         can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             whether to reset data in the database too, or just refresh
-     *                                  the Registry to its state at the beginning of the request
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not sure if you CAN
-     *                                  currently reinstantiate the singletons at the moment)
-     * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so client
-     *                                  code instead can just change the model context to a different blog id if necessary
-     * @return EE_Registry
-     */
-    public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
-    {
-        $instance = self::instance();
-        EEH_Activation::reset();
-        //properties that get reset
-        $instance->_cache_on = true;
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        $instance->AssetsRegistry = new Registry();
-        //messages reset
-        EED_Messages::reset();
-        if ($reset_models) {
-            foreach (array_keys($instance->non_abstract_db_models) as $model_name) {
-                $instance->reset_model($model_name);
-            }
-        }
-        $instance->LIB = new stdClass();
-        return $instance;
-    }
-
-
-
-    /**
-     * @override magic methods
-     * @return void
-     */
-    final function __destruct()
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     * @param $b
-     */
-    final function __call($a, $b)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     */
-    final function __get($a)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     * @param $b
-     */
-    final function __set($a, $b)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     */
-    final function __isset($a)
-    {
-    }
+	/**
+	 *    EE_Registry Object
+	 *
+	 * @var EE_Registry $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 * @access    protected
+	 */
+	protected $_dependency_map = null;
+
+	/**
+	 * @var array $_class_abbreviations
+	 * @access    protected
+	 */
+	protected $_class_abbreviations = array();
+
+	/**
+	 * @access public
+	 * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 *    EE_Cart Object
+	 *
+	 * @access    public
+	 * @var    EE_Cart $CART
+	 */
+	public $CART = null;
+
+	/**
+	 *    EE_Config Object
+	 *
+	 * @access    public
+	 * @var    EE_Config $CFG
+	 */
+	public $CFG = null;
+
+	/**
+	 * EE_Network_Config Object
+	 *
+	 * @access public
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG = null;
+
+	/**
+	 *    StdClass object for storing library classes in
+	 *
+	 * @public LIB
+	 * @var StdClass $LIB
+	 */
+	public $LIB = null;
+
+	/**
+	 *    EE_Request_Handler Object
+	 *
+	 * @access    public
+	 * @var    EE_Request_Handler $REQ
+	 */
+	public $REQ = null;
+
+	/**
+	 *    EE_Session Object
+	 *
+	 * @access    public
+	 * @var    EE_Session $SSN
+	 */
+	public $SSN = null;
+
+	/**
+	 * holds the ee capabilities object.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Capabilities
+	 */
+	public $CAP = null;
+
+	/**
+	 * holds the EE_Message_Resource_Manager object.
+	 *
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager
+	 */
+	public $MRM = null;
+
+
+	/**
+	 * Holds the Assets Registry instance
+	 * @var Registry
+	 */
+	public $AssetsRegistry = null;
+
+	/**
+	 *    $addons - StdClass object for holding addons which have registered themselves to work with EE core
+	 *
+	 * @access    public
+	 * @var    EE_Addon[]
+	 */
+	public $addons = null;
+
+	/**
+	 *    $models
+	 * @access    public
+	 * @var    EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 */
+	public $models = array();
+
+	/**
+	 *    $modules
+	 * @access    public
+	 * @var    EED_Module[] $modules
+	 */
+	public $modules = null;
+
+	/**
+	 *    $shortcodes
+	 * @access    public
+	 * @var    EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes = null;
+
+	/**
+	 *    $widgets
+	 * @access    public
+	 * @var    WP_Widget[] $widgets
+	 */
+	public $widgets = null;
+
+	/**
+	 * $non_abstract_db_models
+	 * @access public
+	 * @var array this is an array of all implemented model names (i.e. not the parent abstract models, or models
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
+	 * classnames (eg "EEM_Event")
+	 */
+	public $non_abstract_db_models = array();
+
+
+	/**
+	 *    $i18n_js_strings - internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @access    public
+	 * @var    array
+	 */
+	public static $i18n_js_strings = array();
+
+
+	/**
+	 *    $main_file - path to espresso.php
+	 *
+	 * @access    public
+	 * @var    array
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @access    public
+	 * @var ReflectionClass[]
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @access    protected
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param  \EE_Dependency_Map $dependency_map
+	 * @return \EE_Registry instance
+	 */
+	public static function instance(\EE_Dependency_Map $dependency_map = null)
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_Registry) {
+			self::$_instance = new EE_Registry($dependency_map);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 * @param  \EE_Dependency_Map $dependency_map
+	 * @return \EE_Registry
+	 */
+	protected function __construct(\EE_Dependency_Map $dependency_map)
+	{
+		$this->_dependency_map = $dependency_map;
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+	}
+
+
+
+	/**
+	 * initialize
+	 */
+	public function initialize()
+	{
+		$this->_class_abbreviations = apply_filters(
+			'FHEE__EE_Registry____construct___class_abbreviations',
+			array(
+				'EE_Config'                                       => 'CFG',
+				'EE_Session'                                      => 'SSN',
+				'EE_Capabilities'                                 => 'CAP',
+				'EE_Cart'                                         => 'CART',
+				'EE_Network_Config'                               => 'NET_CFG',
+				'EE_Request_Handler'                              => 'REQ',
+				'EE_Message_Resource_Manager'                     => 'MRM',
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
+			)
+		);
+		// class library
+		$this->LIB = new stdClass();
+		$this->addons = new stdClass();
+		$this->modules = new stdClass();
+		$this->shortcodes = new stdClass();
+		$this->widgets = new stdClass();
+		$this->load_core('Base', array(), true);
+		// add our request and response objects to the cache
+		$request_loader = $this->_dependency_map->class_loader('EE_Request');
+		$this->_set_cached_class(
+			$request_loader(),
+			'EE_Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader('EE_Response');
+		$this->_set_cached_class(
+			$response_loader(),
+			'EE_Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
+	}
+
+
+
+	/**
+	 *    init
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function init()
+	{
+		$this->AssetsRegistry = new Registry();
+		// Get current page protocol
+		$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
+		// Output admin-ajax.php URL with same protocol as current page
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
+	}
+
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings()
+	{
+		$i18n_js_strings = (array)EE_Registry::$i18n_js_strings;
+		foreach ($i18n_js_strings as $key => $value) {
+			if (is_scalar($value)) {
+				$i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8');
+			}
+		}
+		return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+	}
+
+
+
+	/**
+	 * @param mixed string | EED_Module $module
+	 */
+	public function add_module($module)
+	{
+		if ($module instanceof EED_Module) {
+			$module_class = get_class($module);
+			$this->modules->{$module_class} = $module;
+		} else {
+			if ( ! class_exists('EE_Module_Request_Router')) {
+				$this->load_core('Module_Request_Router');
+			}
+			$this->modules->{$module} = EE_Module_Request_Router::module_factory($module);
+		}
+	}
+
+
+
+	/**
+	 * @param string $module_name
+	 * @return mixed EED_Module | NULL
+	 */
+	public function get_module($module_name = '')
+	{
+		return isset($this->modules->{$module_name}) ? $this->modules->{$module_name} : null;
+	}
+
+
+
+	/**
+	 *    loads core classes - must be singletons
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	public function load_core($class_name, $arguments = array(), $load_only = false)
+	{
+		$core_paths = apply_filters(
+			'FHEE__EE_Registry__load_core__core_paths',
+			array(
+				EE_CORE,
+				EE_ADMIN,
+				EE_CPTS,
+				EE_CORE . 'data_migration_scripts' . DS,
+				EE_CORE . 'request_stack' . DS,
+				EE_CORE . 'middleware' . DS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load($core_paths, 'EE_', $class_name, 'core', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads service classes
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	public function load_service($class_name, $arguments = array(), $load_only = false)
+	{
+		$service_paths = apply_filters(
+			'FHEE__EE_Registry__load_service__service_paths',
+			array(
+				EE_CORE . 'services' . DS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load($service_paths, 'EE_', $class_name, 'class', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads data_migration_scripts
+	 *
+	 * @access    public
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
+	 * @param mixed  $arguments
+	 * @return EE_Data_Migration_Script_Base|mixed
+	 */
+	public function load_dms($class_name, $arguments = array())
+	{
+		// retrieve instantiated class
+		return $this->_load(EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), 'EE_DMS_', $class_name, 'dms', $arguments, false, false, false);
+	}
+
+
+
+	/**
+	 *    loads object creating classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: attendee
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to instantiate
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then set this to FALSE (ie. when instantiating model objects from client in a loop)
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate (default)
+	 * @return EE_Base_Class | bool
+	 */
+	public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
+	{
+		$paths = apply_filters('FHEE__EE_Registry__load_class__paths', array(
+			EE_CORE,
+			EE_CLASSES,
+			EE_BUSINESS,
+		));
+		// retrieve instantiated class
+		return $this->_load($paths, 'EE_', $class_name, 'class', $arguments, $from_db, $cache, $load_only);
+	}
+
+
+
+	/**
+	 *    loads helper classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEH_Base | bool
+	 */
+	public function load_helper($class_name, $arguments = array(), $load_only = true)
+	{
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
+		$helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
+		// retrieve instantiated class
+		return $this->_load($helper_paths, 'EEH_', $class_name, 'helper', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads core classes - must be singletons
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @param bool   $cache      whether to cache the object or not.
+	 * @return mixed
+	 */
+	public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
+	{
+		$paths = array(
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages' . DS,
+			EE_LIBRARIES . 'shortcodes' . DS,
+			EE_LIBRARIES . 'qtips' . DS,
+			EE_LIBRARIES . 'payment_methods' . DS,
+		);
+		// retrieve instantiated class
+		return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only);
+	}
+
+
+
+	/**
+	 *    loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEM_Base | bool
+	 */
+	public function load_model($class_name, $arguments = array(), $load_only = false)
+	{
+		$paths = apply_filters('FHEE__EE_Registry__load_model__paths', array(
+			EE_MODELS,
+			EE_CORE,
+		));
+		// retrieve instantiated class
+		return $this->_load($paths, 'EEM_', $class_name, 'model', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed | bool
+	 */
+	public function load_model_class($class_name, $arguments = array(), $load_only = true)
+	{
+		$paths = array(
+			EE_MODELS . 'fields' . DS,
+			EE_MODELS . 'helpers' . DS,
+			EE_MODELS . 'relations' . DS,
+			EE_MODELS . 'strategies' . DS,
+		);
+		// retrieve instantiated class
+		return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 * Determines if $model_name is the name of an actual EE model.
+	 *
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
+	 * @return boolean
+	 */
+	public function is_model_name($model_name)
+	{
+		return isset($this->models[$model_name]) ? true : false;
+	}
+
+
+
+	/**
+	 *    generic class loader
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
+	{
+		// retrieve instantiated class
+		return $this->_load($path_to_file, '', $file_name, $type, $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 *    load_addon
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $class_name   - full class name  ie:  My_Class
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EE_Addon
+	 */
+	public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
+	{
+		// retrieve instantiated class
+		return $this->_load($path_to_file, 'addon', $class_name, $type, $arguments, false, true, $load_only);
+	}
+
+
+
+	/**
+	 * instantiates, caches, and automatically resolves dependencies
+	 * for classes that use a Fully Qualified Class Name.
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
+	 * then you need to use one of the existing load_*() methods
+	 * which can resolve the classname and filepath from the passed arguments
+	 *
+	 * @param bool|string $class_name   Fully Qualified Class Name
+	 * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
+	 * @return mixed                    null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 */
+	public function create(
+		$class_name = false,
+		$arguments = array(),
+		$cache = false,
+		$from_db = false,
+		$load_only = false,
+		$addon = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		$class_name = $this->_dependency_map->get_alias($class_name);
+		if ( ! class_exists($class_name)) {
+			// maybe the class is registered with a preceding \
+			$class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name;
+			// still doesn't exist ?
+			if ( ! class_exists($class_name)) {
+				return null;
+			}
+		}
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only) {
+			return true;
+		}
+		$addon = $addon ? 'addon' : '';
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $addon);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class($class_obj, $class_name, $addon, $from_db);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * instantiates, caches, and injects dependencies for classes
+	 *
+	 * @param array       $file_paths   an array of paths to folders to look in
+	 * @param string      $class_prefix EE  or EEM or... ???
+	 * @param bool|string $class_name   $class name
+	 * @param string      $type         file type - core? class? helper? model?
+	 * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @return null|object|bool         null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 */
+	protected function _load(
+		$file_paths = array(),
+		$class_prefix = 'EE_',
+		$class_name = false,
+		$type = 'class',
+		$arguments = array(),
+		$from_db = false,
+		$cache = true,
+		$load_only = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if ( ! empty($class_prefix) && $class_prefix != 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name = $this->_dependency_map->get_alias($class_name);
+		$class_exists = class_exists($class_name);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if ( ! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if loading failed, or we are only loading a file but NOT instantiating an object
+			if ( ! $loaded || $load_only) {
+				// return boolean if only loading, or null if an object was expected
+				return $load_only ? $loaded : null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * _get_cached_class
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @return mixed
+	 */
+	protected function _get_cached_class($class_name, $class_prefix = '')
+	{
+		if (isset($this->_class_abbreviations[$class_name])) {
+			$class_abbreviation = $this->_class_abbreviations[$class_name];
+		} else {
+			// have to specify something, but not anything that will conflict
+			$class_abbreviation = 'FANCY_BATMAN_PANTS';
+		}
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		} else if (isset ($this->{$class_name})) {
+			return $this->{$class_name};
+		} else if (isset ($this->LIB->{$class_name})) {
+			return $this->LIB->{$class_name};
+		} else if ($class_prefix == 'addon' && isset ($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * _resolve_path
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path($class_name, $type = '', $file_paths = array())
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths) ? $file_paths : array($file_paths);
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper DS, if no filepath, then use EE_CLASSES
+			$file_path = $file_path ? str_replace(array('/', '\\'), DS, $file_path) : EE_CLASSES;
+			// prep file type
+			$type = ! empty($type) ? trim($type, '.') . '.' : '';
+			// build full file path
+			$file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
+			//does the file exist and can be read ?
+			if (is_readable($file_paths[$key])) {
+				return $file_paths[$key];
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * _require_file
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @access protected
+	 * @param  string $path
+	 * @param  string $class_name
+	 * @param  string $type
+	 * @param  array  $file_paths
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	protected function _require_file($path, $class_name, $type = '', $file_paths = array())
+	{
+		// don't give up! you gotta...
+		try {
+			//does the file exist and can it be read ?
+			if ( ! $path) {
+				// so sorry, can't find the file
+				throw new EE_Error (
+					sprintf(
+						__('The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', 'event_espresso'),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						__('The %s file %s does not appear to contain the %s Class.', 'event_espresso'),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null | object
+	 * @throws \EE_Error
+	 */
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
+	{
+		$class_obj = null;
+		$instantiation_mode = '0) none';
+		// don't give up! you gotta...
+		try {
+			// create reflection
+			$reflector = $this->get_ReflectionClass($class_name);
+			// make sure arguments are an array
+			$arguments = is_array($arguments) ? $arguments : array($arguments);
+			// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+			// else wrap it in an additional array so that it doesn't get split into multiple parameters
+			$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+				? $arguments
+				: array($arguments);
+			// attempt to inject dependencies ?
+			if ($this->_dependency_map->has($class_name)) {
+				$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+			}
+			// instantiate the class if possible
+			if ($reflector->isAbstract()) {
+				// nothing to instantiate, loading file was enough
+				// does not throw an exception so $instantiation_mode is unused
+				// $instantiation_mode = "1) no constructor abstract class";
+				$class_obj = true;
+			} else if ($reflector->getConstructor() === null && $reflector->isInstantiable() && empty($arguments)) {
+				// no constructor = static methods only... nothing to instantiate, loading file was enough
+				$instantiation_mode = "2) no constructor but instantiable";
+				$class_obj = $reflector->newInstance();
+			} else if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+				$instantiation_mode = "3) new_instance_from_db()";
+				$class_obj = call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
+			} else if (method_exists($class_name, 'new_instance')) {
+				$instantiation_mode = "4) new_instance()";
+				$class_obj = call_user_func_array(array($class_name, 'new_instance'), $arguments);
+			} else if (method_exists($class_name, 'instance')) {
+				$instantiation_mode = "5) instance()";
+				$class_obj = call_user_func_array(array($class_name, 'instance'), $arguments);
+			} else if ($reflector->isInstantiable()) {
+				$instantiation_mode = "6) constructor";
+				$class_obj = $reflector->newInstanceArgs($arguments);
+			} else {
+				// heh ? something's not right !
+				throw new EE_Error(
+					sprintf(
+						__('The %s file %s could not be instantiated.', 'event_espresso'),
+						$type,
+						$class_name
+					)
+				);
+			}
+		} catch (Exception $e) {
+			if ( ! $e instanceof EE_Error) {
+				$e = new EE_Error(
+					sprintf(
+						__('The following error occurred while attempting to instantiate "%1$s": %2$s %3$s %2$s instantiation mode : %4$s', 'event_espresso'),
+						$class_name,
+						'<br />',
+						$e->getMessage(),
+						$instantiation_mode
+					)
+				);
+			}
+			$e->get_error();
+		}
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	protected function _array_is_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
+	}
+
+
+
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @access public
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 */
+	public function get_ReflectionClass($class_name)
+	{
+		if (
+			! isset($this->_reflectors[$class_name])
+			|| ! $this->_reflectors[$class_name] instanceof ReflectionClass
+		) {
+			$this->_reflectors[$class_name] = new ReflectionClass($class_name);
+		}
+		return $this->_reflectors[$class_name];
+	}
+
+
+
+	/**
+	 * _resolve_dependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @access protected
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws \ReflectionException
+	 */
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
+	{
+		// let's examine the constructor
+		$constructor = $reflector->getConstructor();
+		// whu? huh? nothing?
+		if ( ! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $constructor->getParameters();
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			// is this a dependency for a specific class ?
+			$param_class = $param->getClass() ? $param->getClass()->name : null;
+			if (
+				// param is not even a class
+				empty($param_class)
+				// and something already exists in the incoming arguments for this param
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			} else if (
+				// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
+				! empty($param_class)
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+				&& $arguments[$argument_keys[$index]] instanceof $param_class
+			) {
+				// skip this argument and move on to the next
+				continue;
+			} else if (
+				// parameter is type hinted as a class, and should be injected
+				! empty($param_class)
+				&& $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
+			) {
+				$arguments = $this->_resolve_dependency($class_name, $param_class, $arguments, $index);
+			} else {
+				try {
+					$arguments[$index] = $param->getDefaultValue();
+				} catch (ReflectionException $e) {
+					throw new ReflectionException(
+						sprintf(
+							__('%1$s for parameter "$%2$s"', 'event_espresso'),
+							$e->getMessage(),
+							$param->getName()
+						)
+					);
+				}
+			}
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 */
+	protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency($class_name, $param_class)
+					!== EE_Dependency_Map::load_new_object
+			? true
+			: false;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on ? $this->_get_cached_class($param_class) : null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} else if ($param_class != $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader();
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if (method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = $this->create($param_class, array(), $cache_on);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			if (isset($argument_keys[$index])) {
+				$arguments[$argument_keys[$index]] = $dependency;
+			} else {
+				$arguments[$index] = $dependency;
+			}
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @access protected
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @return void
+	 */
+	protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
+	{
+		if (empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		if (isset($this->_class_abbreviations[$class_name])) {
+			$class_abbreviation = $this->_class_abbreviations[$class_name];
+			$this->{$class_abbreviation} = $class_obj;
+		} else if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+		} else if ($class_prefix == 'addon') {
+			$this->addons->{$class_name} = $class_obj;
+		} else if ( ! $from_db) {
+			$this->LIB->{$class_name} = $class_obj;
+		}
+	}
+
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory($classname, $arguments = array())
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		} else if (method_exists(EE_Registry::instance(), $loader)) {
+			return EE_Registry::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the classname as the property name on EE_Config::instance()->addons)
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name($name)
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() == $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their name() function) They're already available on EE_Config::instance()->addons as properties, where each property's name is
+	 * the addon's classname. So if you just want to get the addon by classname, use EE_Config::instance()->addons->{classname}
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name()
+	{
+		$addons = array();
+		foreach ($this->addons as $addon) {
+			$addons[$addon->name()] = $addon;
+		}
+		return $addons;
+	}
+
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function reset_model($model_name)
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0 ? "EEM_{$model_name}" : $model_name;
+		if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
+			return null;
+		}
+		//get that model reset it and make sure we nuke the old reference to it
+		if ($this->LIB->{$model_class_name} instanceof $model_class_name && is_callable(array($model_class_name, 'reset'))) {
+			$this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
+		} else {
+			throw new EE_Error(sprintf(__('Model %s does not have a method "reset"', 'event_espresso'), $model_name));
+		}
+		return $this->LIB->{$model_class_name};
+	}
+
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when switch_to_blog
+	 * is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only one Session
+	 *         can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             whether to reset data in the database too, or just refresh
+	 *                                  the Registry to its state at the beginning of the request
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not sure if you CAN
+	 *                                  currently reinstantiate the singletons at the moment)
+	 * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so client
+	 *                                  code instead can just change the model context to a different blog id if necessary
+	 * @return EE_Registry
+	 */
+	public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
+	{
+		$instance = self::instance();
+		EEH_Activation::reset();
+		//properties that get reset
+		$instance->_cache_on = true;
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		$instance->AssetsRegistry = new Registry();
+		//messages reset
+		EED_Messages::reset();
+		if ($reset_models) {
+			foreach (array_keys($instance->non_abstract_db_models) as $model_name) {
+				$instance->reset_model($model_name);
+			}
+		}
+		$instance->LIB = new stdClass();
+		return $instance;
+	}
+
+
+
+	/**
+	 * @override magic methods
+	 * @return void
+	 */
+	final function __destruct()
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	final function __call($a, $b)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 */
+	final function __get($a)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	final function __set($a, $b)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 */
+	final function __isset($a)
+	{
+	}
 
 
 
-    /**
-     * @param $a
-     */
-    final function __unset($a)
-    {
-    }
+	/**
+	 * @param $a
+	 */
+	final function __unset($a)
+	{
+	}
 
 
 
-    /**
-     * @return array
-     */
-    final function __sleep()
-    {
-        return array();
-    }
+	/**
+	 * @return array
+	 */
+	final function __sleep()
+	{
+		return array();
+	}
 
 
 
-    final function __wakeup()
-    {
-    }
+	final function __wakeup()
+	{
+	}
 
 
 
-    /**
-     * @return string
-     */
-    final function __toString()
-    {
-        return '';
-    }
+	/**
+	 * @return string
+	 */
+	final function __toString()
+	{
+		return '';
+	}
 
 
 
-    final function __invoke()
-    {
-    }
+	final function __invoke()
+	{
+	}
 
 
 
-    final static function __set_state()
-    {
-    }
+	final static function __set_state()
+	{
+	}
 
 
 
-    final function __clone()
-    {
-    }
+	final function __clone()
+	{
+	}
 
 
 
-    /**
-     * @param $a
-     * @param $b
-     */
-    final static function __callStatic($a, $b)
-    {
-    }
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	final static function __callStatic($a, $b)
+	{
+	}
 
 
 
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models()
-    {
-        $cpt_models = array();
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[$short_name] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models()
+	{
+		$cpt_models = array();
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[$short_name] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
 
 
 
-    /**
-     * @return \EE_Config
-     */
-    public static function CFG()
-    {
-        return self::instance()->CFG;
-    }
+	/**
+	 * @return \EE_Config
+	 */
+	public static function CFG()
+	{
+		return self::instance()->CFG;
+	}
 
 
 }

core/services/shortcodes/EspressoShortcode.php

Spacing +2 added lines, -2 removed lines

@@ -63,7 +63,7 @@ 
             }
         }
         return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
+            $this->sanitizeAttributes((array) $attributes)
         );
     }
 
@@ -91,7 +91,7 @@ 
             // serialized attributes
             wp_json_encode($attributes),
             // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
+            function() use ($shortcode, $attributes) {
                 return $shortcode->processShortcode($attributes);
             },
             // filterable cache expiration set by each shortcode

Indentation +192 added lines, -192 removed lines

@@ -20,198 +20,198 @@
 abstract class EspressoShortcode implements ShortcodeInterface
 {
 
-    /**
-     * transient prefix
-     *
-     * @type string
-     */
-    const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
-
-    /**
-     * @var PostRelatedCacheManager $cache_manager
-     */
-    private $cache_manager;
-
-
-
-    /**
-     * EspressoShortcode constructor
-     *
-     * @param PostRelatedCacheManager $cache_manager
-     */
-    public function __construct(PostRelatedCacheManager $cache_manager)
-    {
-        $this->cache_manager = $cache_manager;
-    }
-
-
-
-    /**
-     * enqueues scripts then processes the shortcode
-     *
-     * @param array $attributes
-     * @return string
-     * @throws \EE_Error
-     */
-    final public function processShortcodeCallback($attributes = array())
-    {
-        if ($this instanceof EnqueueAssetsInterface) {
-            if (is_admin()) {
-                $this->enqueueAdminScripts();
-            } else {
-                $this->enqueueScripts();
-            }
-        }
-        return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
-        );
-    }
-
-
-
-    /**
-     * If shortcode caching is enabled for the shortcode,
-     * and cached results exist, then that will be returned
-     * else new content will be generated.
-     * If caching is enabled, then the new content will be cached for later.
-     *
-     * @param array $attributes
-     * @return mixed|string
-     * @throws \EE_Error
-     */
-    private function shortcodeContent(array $attributes)
-    {
-        $shortcode = $this;
-        $post_ID = $this->currentPostID();
-        // something like "SC_EVENTS-123"
-        $cache_ID = $this->shortcodeCacheID($post_ID);
-        $this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
-        return $this->cache_manager->get(
-            $cache_ID,
-            // serialized attributes
-            wp_json_encode($attributes),
-            // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                return $shortcode->processShortcode($attributes);
-            },
-            // filterable cache expiration set by each shortcode
-            apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
-                $this->cacheExpiration(),
-                $this->getTag(),
-                $this
-            )
-        );
-    }
-
-
-
-    /**
-     * @return int
-     * @throws \EE_Error
-     */
-    private function currentPostID()
-    {
-        // try to get EE_Event any way we can
-        $event = EEH_Event_View::get_event();
-        // then get some kind of ID
-        if ($event instanceof \EE_Event) {
-            $post_ID = $event->ID();
-        } else {
-            global $post;
-            $post_ID = $post->ID;
-        }
-        return $post_ID;
-    }
-
-
-
-    /**
-     * @param int $post_ID
-     * @return string
-     * @throws \EE_Error
-     */
-    private function shortcodeCacheID($post_ID)
-    {
-        $tag = str_replace('ESPRESSO_', '', $this->getTag());
-        return "SC_{$tag}-{$post_ID}";
-    }
-
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would return the following:
-     *      array('event_id' => 'absint')
-     * Entering 'skip_sanitization' for the callback value
-     * means that no sanitization will be applied
-     * on the assumption that the attribute
-     * will be sanitized at some point... right?
-     * You wouldn't pass around unsanitized attributes would you?
-     * That would be very Tom Foolery of you!!!
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden using the customAttributeSanitizationMap() method (see above),
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $custom_sanitization = $this->customAttributeSanitizationMap();
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[$key])) {
-                $callback = $custom_sanitization[$key];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[$key] = $value;
-                    continue;
-                }
-                if (function_exists($callback)) {
-                    $attributes[$key] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null :
-                case is_int($value) :
-                case is_float($value) :
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
-                    $attributes[$key] = $value;
-                    break;
-                case is_string($value) :
-                    $attributes[$key] = sanitize_text_field($value);
-                    break;
-                case is_array($value) :
-                    $attributes[$key] = $this->sanitizeAttributes($value);
-                    break;
-                default :
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[$key] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * transient prefix
+	 *
+	 * @type string
+	 */
+	const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
+
+	/**
+	 * @var PostRelatedCacheManager $cache_manager
+	 */
+	private $cache_manager;
+
+
+
+	/**
+	 * EspressoShortcode constructor
+	 *
+	 * @param PostRelatedCacheManager $cache_manager
+	 */
+	public function __construct(PostRelatedCacheManager $cache_manager)
+	{
+		$this->cache_manager = $cache_manager;
+	}
+
+
+
+	/**
+	 * enqueues scripts then processes the shortcode
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	final public function processShortcodeCallback($attributes = array())
+	{
+		if ($this instanceof EnqueueAssetsInterface) {
+			if (is_admin()) {
+				$this->enqueueAdminScripts();
+			} else {
+				$this->enqueueScripts();
+			}
+		}
+		return $this->shortcodeContent(
+			$this->sanitizeAttributes((array)$attributes)
+		);
+	}
+
+
+
+	/**
+	 * If shortcode caching is enabled for the shortcode,
+	 * and cached results exist, then that will be returned
+	 * else new content will be generated.
+	 * If caching is enabled, then the new content will be cached for later.
+	 *
+	 * @param array $attributes
+	 * @return mixed|string
+	 * @throws \EE_Error
+	 */
+	private function shortcodeContent(array $attributes)
+	{
+		$shortcode = $this;
+		$post_ID = $this->currentPostID();
+		// something like "SC_EVENTS-123"
+		$cache_ID = $this->shortcodeCacheID($post_ID);
+		$this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
+		return $this->cache_manager->get(
+			$cache_ID,
+			// serialized attributes
+			wp_json_encode($attributes),
+			// Closure for generating content if cache is expired
+			function () use ($shortcode, $attributes) {
+				return $shortcode->processShortcode($attributes);
+			},
+			// filterable cache expiration set by each shortcode
+			apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
+				$this->cacheExpiration(),
+				$this->getTag(),
+				$this
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	private function currentPostID()
+	{
+		// try to get EE_Event any way we can
+		$event = EEH_Event_View::get_event();
+		// then get some kind of ID
+		if ($event instanceof \EE_Event) {
+			$post_ID = $event->ID();
+		} else {
+			global $post;
+			$post_ID = $post->ID;
+		}
+		return $post_ID;
+	}
+
+
+
+	/**
+	 * @param int $post_ID
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	private function shortcodeCacheID($post_ID)
+	{
+		$tag = str_replace('ESPRESSO_', '', $this->getTag());
+		return "SC_{$tag}-{$post_ID}";
+	}
+
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would return the following:
+	 *      array('event_id' => 'absint')
+	 * Entering 'skip_sanitization' for the callback value
+	 * means that no sanitization will be applied
+	 * on the assumption that the attribute
+	 * will be sanitized at some point... right?
+	 * You wouldn't pass around unsanitized attributes would you?
+	 * That would be very Tom Foolery of you!!!
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden using the customAttributeSanitizationMap() method (see above),
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$custom_sanitization = $this->customAttributeSanitizationMap();
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[$key])) {
+				$callback = $custom_sanitization[$key];
+				if ($callback === 'skip_sanitization') {
+					$attributes[$key] = $value;
+					continue;
+				}
+				if (function_exists($callback)) {
+					$attributes[$key] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null :
+				case is_int($value) :
+				case is_float($value) :
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
+					$attributes[$key] = $value;
+					break;
+				case is_string($value) :
+					$attributes[$key] = sanitize_text_field($value);
+					break;
+				case is_array($value) :
+					$attributes[$key] = $this->sanitizeAttributes($value);
+					break;
+				default :
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[$key] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
 
 
 

core/services/cache/BasicCacheManager.php

Spacing +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
                 $cache_id
             )
         );
-        $cache_id = substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+        $cache_id = substr($this->cachePrefix().$id_prefix.'-'.md5($cache_id), 0, 182);
         // is caching enabled for this content ?
         if ($expiration) {
             $content = $this->cache_storage->get($cache_id);

Indentation +112 added lines, -112 removed lines

@@ -19,118 +19,118 @@
 class BasicCacheManager implements CacheManagerInterface
 {
 
-    /**
-     * @type string
-     */
-    const CACHE_PREFIX = 'ee_cache_';
-
-    /**
-     * set to true to monitor when content is being served from cache or not
-     *
-     * @type boolean
-     */
-    const DEBUG = false;
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    private $cache_storage;
-
-
-
-    /**
-     * BasicCacheManager constructor.
-     *
-     * @param CacheStorageInterface $cache_storage [required]
-     */
-    public function __construct(CacheStorageInterface $cache_storage)
-    {
-        $this->cache_storage = $cache_storage;
-    }
-
-
-
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix()
-    {
-        return BasicCacheManager::CACHE_PREFIX;
-    }
-
-
-
-    /**
-     * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
-     *                           It is advisable to use some of the actual data
-     *                           that is used to generate the content being cached,
-     *                           in order to guarantee that the cache id is unique for that content.
-     *                           The cache id will be md5'd before usage to make it more db friendly,
-     *                           and the entire cache id string will be truncated to 190 characters.
-     * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
-     *                           necessary,
-     *                           we wrap our content creation in a Closure so that it is not executed until needed.
-     * @param int     $expiration
-     * @return Closure|mixed
-     */
-    public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
-    {
-        $content = '';
-        // how long should we cache this content for? 0 means no caching.
-        $expiration = ! WP_DEBUG ? $expiration : 0;
-        $expiration = absint(
-            apply_filters(
-                'FHEE__CacheManager__get__cache_expiration',
-                $expiration,
-                $id_prefix,
-                $cache_id
-            )
-        );
-        $cache_id = substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
-        // is caching enabled for this content ?
-        if ($expiration) {
-            $content = $this->cache_storage->get($cache_id);
-        }
-        // any existing content ?
-        if (empty($content)) {
-            // nope! let's generate some new stuff
-            $content = $callback();
-            // save the new content if caching is enabled
-            if ($expiration) {
-                if (BasicCacheManager::DEBUG) {
-                    EEH_Debug_Tools::printr($cache_id, 'REFRESH CACHE', __FILE__, __LINE__);
-                }
-                $this->cache_storage->add($cache_id, $content, $expiration);
-            }
-        } else {
-            if (BasicCacheManager::DEBUG) {
-                EEH_Debug_Tools::printr($cache_id, 'CACHED CONTENT', __FILE__, __LINE__);
-            }
-        }
-        return $content;
-    }
-
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @return void
-     */
-    public function clear($cache_id)
-    {
-        // ensure incoming arg is in an array
-        $cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
-        // delete corresponding transients for the supplied id prefix
-        $this->cache_storage->deleteMany($cache_id);
-    }
+	/**
+	 * @type string
+	 */
+	const CACHE_PREFIX = 'ee_cache_';
+
+	/**
+	 * set to true to monitor when content is being served from cache or not
+	 *
+	 * @type boolean
+	 */
+	const DEBUG = false;
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	private $cache_storage;
+
+
+
+	/**
+	 * BasicCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface $cache_storage [required]
+	 */
+	public function __construct(CacheStorageInterface $cache_storage)
+	{
+		$this->cache_storage = $cache_storage;
+	}
+
+
+
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix()
+	{
+		return BasicCacheManager::CACHE_PREFIX;
+	}
+
+
+
+	/**
+	 * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
+	 *                           It is advisable to use some of the actual data
+	 *                           that is used to generate the content being cached,
+	 *                           in order to guarantee that the cache id is unique for that content.
+	 *                           The cache id will be md5'd before usage to make it more db friendly,
+	 *                           and the entire cache id string will be truncated to 190 characters.
+	 * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
+	 *                           necessary,
+	 *                           we wrap our content creation in a Closure so that it is not executed until needed.
+	 * @param int     $expiration
+	 * @return Closure|mixed
+	 */
+	public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
+	{
+		$content = '';
+		// how long should we cache this content for? 0 means no caching.
+		$expiration = ! WP_DEBUG ? $expiration : 0;
+		$expiration = absint(
+			apply_filters(
+				'FHEE__CacheManager__get__cache_expiration',
+				$expiration,
+				$id_prefix,
+				$cache_id
+			)
+		);
+		$cache_id = substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+		// is caching enabled for this content ?
+		if ($expiration) {
+			$content = $this->cache_storage->get($cache_id);
+		}
+		// any existing content ?
+		if (empty($content)) {
+			// nope! let's generate some new stuff
+			$content = $callback();
+			// save the new content if caching is enabled
+			if ($expiration) {
+				if (BasicCacheManager::DEBUG) {
+					EEH_Debug_Tools::printr($cache_id, 'REFRESH CACHE', __FILE__, __LINE__);
+				}
+				$this->cache_storage->add($cache_id, $content, $expiration);
+			}
+		} else {
+			if (BasicCacheManager::DEBUG) {
+				EEH_Debug_Tools::printr($cache_id, 'CACHED CONTENT', __FILE__, __LINE__);
+			}
+		}
+		return $content;
+	}
+
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @return void
+	 */
+	public function clear($cache_id)
+	{
+		// ensure incoming arg is in an array
+		$cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
+		// delete corresponding transients for the supplied id prefix
+		$this->cache_storage->deleteMany($cache_id);
+	}
 
 
 

core/services/cache/PostRelatedCacheManager.php

Indentation +86 added lines, -86 removed lines

@@ -16,92 +16,92 @@
 class PostRelatedCacheManager extends BasicCacheManager
 {
 
-    /**
-     * @type string
-     */
-    const POST_CACHE_PREFIX = 'ee_cache_post_';
-
-    /**
-     * wp-option option_name for tracking post related cache
-     *
-     * @type string
-     */
-    const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
-
-
-
-    /**
-     * PostRelatedCacheManager constructor.
-     *
-     * @param CacheStorageInterface $cache_storage
-     */
-    public function __construct(CacheStorageInterface $cache_storage)
-    {
-        parent::__construct($cache_storage);
-        add_action('save_post', array($this, 'clearPostRelatedCache'));
-    }
-
-
-
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix()
-    {
-        return PostRelatedCacheManager::POST_CACHE_PREFIX;
-    }
-
-
-
-    /**
-     * If you are caching content that pertains to a Post of any type,
-     * then it is recommended to pass the post id and cache id prefix to this method
-     * so that it can be added to the post related cache tracking.
-     * Then, whenever that post is updated, the cache will automatically be deleted,
-     * which helps to ensure that outdated cache content will not be served
-     *
-     * @param int    $post_ID    [required]
-     * @param string $id_prefix  [required] Appended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     */
-    public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
-    {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
-        // if post is not already being tracked
-        if ( ! isset($post_related_cache[$post_ID])) {
-            // add array to add cache ids to
-            $post_related_cache[$post_ID] = array();
-        }
-        // add cache id to be tracked
-        $post_related_cache[$post_ID][] = $id_prefix;
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
-    }
-
-
-
-    /**
-     * callback hooked into the WordPress "save_post" action
-     * deletes any cache content associated with the post
-     *
-     * @param int $post_ID [required]
-     */
-    public function clearPostRelatedCache($post_ID)
-    {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
-        // if post is not being tracked
-        if ( ! isset($post_related_cache[$post_ID])) {
-            return;
-        }
-        // get cache id prefixes for post, and delete their corresponding transients
-        $this->clear($post_related_cache[$post_ID]);
-        unset($post_related_cache[$post_ID]);
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
-    }
+	/**
+	 * @type string
+	 */
+	const POST_CACHE_PREFIX = 'ee_cache_post_';
+
+	/**
+	 * wp-option option_name for tracking post related cache
+	 *
+	 * @type string
+	 */
+	const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
+
+
+
+	/**
+	 * PostRelatedCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface $cache_storage
+	 */
+	public function __construct(CacheStorageInterface $cache_storage)
+	{
+		parent::__construct($cache_storage);
+		add_action('save_post', array($this, 'clearPostRelatedCache'));
+	}
+
+
+
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix()
+	{
+		return PostRelatedCacheManager::POST_CACHE_PREFIX;
+	}
+
+
+
+	/**
+	 * If you are caching content that pertains to a Post of any type,
+	 * then it is recommended to pass the post id and cache id prefix to this method
+	 * so that it can be added to the post related cache tracking.
+	 * Then, whenever that post is updated, the cache will automatically be deleted,
+	 * which helps to ensure that outdated cache content will not be served
+	 *
+	 * @param int    $post_ID    [required]
+	 * @param string $id_prefix  [required] Appended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 */
+	public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
+	{
+		$post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+		// if post is not already being tracked
+		if ( ! isset($post_related_cache[$post_ID])) {
+			// add array to add cache ids to
+			$post_related_cache[$post_ID] = array();
+		}
+		// add cache id to be tracked
+		$post_related_cache[$post_ID][] = $id_prefix;
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
+	}
+
+
+
+	/**
+	 * callback hooked into the WordPress "save_post" action
+	 * deletes any cache content associated with the post
+	 *
+	 * @param int $post_ID [required]
+	 */
+	public function clearPostRelatedCache($post_ID)
+	{
+		$post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+		// if post is not being tracked
+		if ( ! isset($post_related_cache[$post_ID])) {
+			return;
+		}
+		// get cache id prefixes for post, and delete their corresponding transients
+		$this->clear($post_related_cache[$post_ID]);
+		unset($post_related_cache[$post_ID]);
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
+	}
 
 
 }

Spacing +2 added lines, -2 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
     {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+        $post_related_cache = (array) get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
         // if post is not already being tracked
         if ( ! isset($post_related_cache[$post_ID])) {
             // add array to add cache ids to
@@ -92,7 +92,7 @@ 
      */
     public function clearPostRelatedCache($post_ID)
     {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+        $post_related_cache = (array) get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
         // if post is not being tracked
         if ( ! isset($post_related_cache[$post_ID])) {
             return;

core/services/cache/CacheManagerInterface.php

Indentation +37 added lines, -37 removed lines

@@ -18,43 +18,43 @@
 interface CacheManagerInterface
 {
 
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix();
-
-
-
-    /**
-     * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
-     *                           It is advisable to use some of the actual data
-     *                           that is used to generate the content being cached,
-     *                           in order to guarantee that the cache id is unique for that content.
-     *                           The cache id will be md5'd before usage to make it more db friendly,
-     *                           and the entire cache id string will be truncated to 190 characters.
-     * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
-     *                           necessary,
-     *                           we wrap our content creation in a Closure so that it is not executed until needed.
-     * @param int     $expiration
-     * @return Closure|mixed
-     */
-    public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS);
-
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @return void
-     */
-    public function clear($cache_id);
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix();
+
+
+
+	/**
+	 * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
+	 *                           It is advisable to use some of the actual data
+	 *                           that is used to generate the content being cached,
+	 *                           in order to guarantee that the cache id is unique for that content.
+	 *                           The cache id will be md5'd before usage to make it more db friendly,
+	 *                           and the entire cache id string will be truncated to 190 characters.
+	 * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
+	 *                           necessary,
+	 *                           we wrap our content creation in a Closure so that it is not executed until needed.
+	 * @param int     $expiration
+	 * @return Closure|mixed
+	 */
+	public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS);
+
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @return void
+	 */
+	public function clear($cache_id);
 
 }
 // End of file CacheManagerInterface.php