eventespresso / event-espresso-core

core/libraries/shortcodes/EE_Datetime_Shortcodes.lib.php

Indentation +59 added lines, -59 removed lines

@@ -15,77 +15,77 @@
  */
 class EE_Datetime_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * @return void
-     */
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Datetime Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to datetime related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[DATETIME_START]' => esc_html__('The start date and time.', 'event_espresso'),
-            '[DATETIME_END]' => esc_html__('The end date and time.', 'event_espresso'),
-            '[DATETIME_TIMEZONE]' => esc_html__('The timezone for the date and time', 'event_espresso'),
-            '[DATE_START]' => esc_html__('The datetime start date.', 'event_espresso'),
-            '[DATE_END]' => esc_html__('The datetime end date.', 'event_espresso'),
-            '[TIME_START]' => esc_html__('The datetime start time.', 'event_espresso'),
-            '[TIME_END]' => esc_html__('The datetime end time.', 'event_espresso'),
-            '[ICAL_LINK_*]' => esc_html__(
-                'The datetime iCal link. The optional "link_text" attribute can be used to set custom text within the link (Default is "Add to iCal Calendar").',
-                'event_espresso'
-            ),
-        );
-    }
+	/**
+	 * @return void
+	 */
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Datetime Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to datetime related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[DATETIME_START]' => esc_html__('The start date and time.', 'event_espresso'),
+			'[DATETIME_END]' => esc_html__('The end date and time.', 'event_espresso'),
+			'[DATETIME_TIMEZONE]' => esc_html__('The timezone for the date and time', 'event_espresso'),
+			'[DATE_START]' => esc_html__('The datetime start date.', 'event_espresso'),
+			'[DATE_END]' => esc_html__('The datetime end date.', 'event_espresso'),
+			'[TIME_START]' => esc_html__('The datetime start time.', 'event_espresso'),
+			'[TIME_END]' => esc_html__('The datetime end time.', 'event_espresso'),
+			'[ICAL_LINK_*]' => esc_html__(
+				'The datetime iCal link. The optional "link_text" attribute can be used to set custom text within the link (Default is "Add to iCal Calendar").',
+				'event_espresso'
+			),
+		);
+	}
 
 
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        if (! $this->_data instanceof EE_Datetime) {
-            return ''; // get out cause we can only parse with the datetime object.
-        }
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		if (! $this->_data instanceof EE_Datetime) {
+			return ''; // get out cause we can only parse with the datetime object.
+		}
 
-        switch ($shortcode) {
-            case '[DATETIME_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start');
+		switch ($shortcode) {
+			case '[DATETIME_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start');
 
-            case '[DATETIME_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end');
+			case '[DATETIME_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end');
 
-            case '[DATETIME_TIMEZONE]':
-                return $this->_data->get_timezone();
+			case '[DATETIME_TIMEZONE]':
+				return $this->_data->get_timezone();
 
-            case '[DATE_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format'));
+			case '[DATE_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('date_format'));
 
-            case '[DATE_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format'));
+			case '[DATE_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('date_format'));
 
-            case '[TIME_START]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format'));
+			case '[TIME_START]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_start', get_option('time_format'));
 
-            case '[TIME_END]':
-                return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format'));
-        }
+			case '[TIME_END]':
+				return $this->_data->get_i18n_datetime('DTT_EVT_end', get_option('time_format'));
+		}
 
-        if (strpos($shortcode, '[ICAL_LINK_*') !== false) {
-            $attrs = $this->_get_shortcode_attrs($shortcode);
+		if (strpos($shortcode, '[ICAL_LINK_*') !== false) {
+			$attrs = $this->_get_shortcode_attrs($shortcode);
 
-            $link_text = empty($attrs['link_text'])
-                ? esc_html__('Add to iCal Calendar', 'event_espresso')
-                : $attrs['link_text'];
+			$link_text = empty($attrs['link_text'])
+				? esc_html__('Add to iCal Calendar', 'event_espresso')
+				: $attrs['link_text'];
 
-            $URL = add_query_arg(['ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()], site_url());
-            $URL = esc_url_raw(str_replace('http://', 'https://', $URL));
+			$URL = add_query_arg(['ee' => 'download_ics_file', 'ics_id' => $this->_data->ID()], site_url());
+			$URL = esc_url_raw(str_replace('http://', 'https://', $URL));
 
-            return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>';
-        }
+			return '<a class="ee-ical" href="' . $URL . '">' . $link_text . '</a>';
+		}
 
-        return '';
-    }
+		return '';
+	}
 }

core/libraries/line_item_display/EE_Receipt_Line_Item_Display_Strategy.strategy.php

Indentation +57 added lines, -58 removed lines

@@ -10,90 +10,89 @@
  * @copyright   (c) 2008-2014 Event Espresso  All Rights Reserved.
  * @license     https://eventespresso.com/support/terms-conditions/   * see Plugin Licensing *
  * @link        http://www.eventespresso.com
-
  */
  /**
- *
- * Class EE_Receipt_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author              Brent Christensen
- *
- *
- */
+  *
+  * Class EE_Receipt_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author              Brent Christensen
+  *
+  *
+  */
 
 class EE_Receipt_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
+	{
 
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'show_desc' => true,
-            'odd' => false
-        );
-        $options = array_merge($default_options, (array) $options);
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,
+			'odd' => false
+		);
+		$options = array_merge($default_options, (array) $options);
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_separator_row( $options );
 //              $html .= $this->_total_row( $line_item, esc_html__('Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+			case EEM_Line_Item::type_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_total_row( $line_item, esc_html__('Sub-Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_tax_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+			case EEM_Line_Item::type_tax_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_total_row( $line_item, esc_html__('Tax Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_line_item:
-                // item row
+			case EEM_Line_Item::type_line_item:
+				// item row
 //              $html .= $this->_item_row( $line_item, $options );
-                // got any kids?
-                foreach ($line_item->children() as $child_line_item) {
+				// got any kids?
+				foreach ($line_item->children() as $child_line_item) {
 //                  $this->display_line_item( $child_line_item, $options );
-                }
-                break;
+				}
+				break;
 
 
-            case EEM_Line_Item::type_sub_line_item:
+			case EEM_Line_Item::type_sub_line_item:
 //              $html .= $this->_sub_item_row( $line_item, $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_tax:
+			case EEM_Line_Item::type_tax:
 //              $html .= $this->_tax_row( $line_item, $options );
-                break;
-        }
+				break;
+		}
 
-        return $html;
-    }
+		return $html;
+	}
 }

core/libraries/rest_api/RestIncomingQueryParamMetadata.php

Indentation +788 added lines, -788 removed lines

@@ -30,794 +30,794 @@
  */
 class RestIncomingQueryParamMetadata
 {
-    private string $query_param_key;
-
-    private $query_param_value;
-
-    private RestIncomingQueryParamContext $context;
-
-    private ?EE_Model_Field_Base $field;
-
-    /**
-     * @var string same as $query_param_key but has the * and anything after it removed
-     */
-    private string $query_param_key_sans_stars;
-
-    /**
-     * @var string for timezone or timezone offset
-     */
-    private string $timezone;
-
-    /**
-     * @var bool if the field in $query_param_key is for a GMT field (eg `EVT_modified_gmt`)
-     */
-    private bool $is_gmt_field = false;
-
-
-    /**
-     * RestIncomingQueryParamMetadata constructor.
-     * You probably want to call
-     *
-     * @param string                        $query_param_key
-     * @param mixed                         $query_param_value
-     * @param RestIncomingQueryParamContext $context
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(string $query_param_key, $query_param_value, RestIncomingQueryParamContext $context)
-    {
-        $this->query_param_key   = $query_param_key;
-        $this->query_param_value = $query_param_value;
-        $this->context           = $context;
-        $this->determineFieldAndTimezone();
-    }
-
-
-    /**
-     * Gets the query parameter key. This may have been modified (see setQueryParamValue())
-     *
-     * @return string
-     */
-    public function getQueryParamKey(): string
-    {
-        return $this->query_param_key;
-    }
-
-
-    /**
-     * Modifies the query parameter key passed in (Eg this is done when rewriting the simplified specified operator REST
-     * query parameters into the legacy structure)
-     *
-     * @param string|array|int|float $query_param_value
-     */
-    private function setQueryParamValue($query_param_value)
-    {
-        $this->query_param_value = $query_param_value;
-    }
-
-
-    /**
-     * Gets the original query parameter value passed in.
-     *
-     * @return mixed
-     */
-    public function getQueryParamValue()
-    {
-        return $this->query_param_value;
-    }
-
-
-    /**
-     * Gets the context object.
-     *
-     * @return RestIncomingQueryParamContext
-     */
-    public function getContext(): RestIncomingQueryParamContext
-    {
-        return $this->context;
-    }
-
-
-    /**
-     * Sets the query parameter key. This may be used to rewrite a key into its non-GMT alternative.
-     *
-     * @param string $query_param_key
-     */
-    private function setQueryParamKey(string $query_param_key)
-    {
-        $this->query_param_key = $query_param_key;
-    }
-
-
-    /**
-     * Gets the field the query parameter key indicated. This may be null (in cases where the query parameter key
-     * did not indicate a field, eg if it were `OR`).
-     *
-     * @return EE_Model_Field_Base|null
-     */
-    public function getField(): ?EE_Model_Field_Base
-    {
-        return $this->field;
-    }
-
-
-    /**
-     * Gets the query parameter key (with the star and everything afterwards removed).
-     *
-     * @return string
-     */
-    public function getQueryParamKeySansStars(): string
-    {
-        return $this->query_param_key_sans_stars;
-    }
-
-
-    /**
-     * Gets the timezone associated with this model (the site timezone, except for GMT datetime fields).
-     *
-     * @return string
-     */
-    public function getTimezone(): string
-    {
-        return $this->timezone;
-    }
-
-
-    /**
-     * Returns whether this is a GMT field
-     *
-     * @return bool
-     */
-    public function isGmtField(): bool
-    {
-        return $this->is_gmt_field;
-    }
-
-
-    /**
-     * Sets the field indicated by the query parameter key (might be null).
-     *
-     * @param EE_Model_Field_Base|null $field
-     */
-    private function setField(EE_Model_Field_Base $field = null)
-    {
-        $this->field = $field;
-    }
-
-
-    /**
-     * Sets the query parameter key-with-stars-removed.
-     *
-     * @param string $query_param_key_sans_stars
-     */
-    private function setQueryParamKeySansStars(string $query_param_key_sans_stars)
-    {
-        $this->query_param_key_sans_stars = $query_param_key_sans_stars;
-    }
-
-
-    /**
-     * Sets the timezone (this could be a timezone offset string).
-     *
-     * @param string $timezone
-     */
-    private function setTimezone(string $timezone)
-    {
-        $this->timezone = $timezone;
-    }
-
-
-    /**
-     * @param bool|int|string|null $is_gmt_field
-     */
-    private function setIsGmtField($is_gmt_field)
-    {
-        $this->is_gmt_field = filter_var($is_gmt_field, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * Determines what field, query param name, and query param name without stars, and timezone to use.
-     *
-     * @return void {
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws Exception
-     * @since 4.9.72.p
-     * @type EE_Model_Field_Base $field
-     */
-    private function determineFieldAndTimezone()
-    {
-        $this->setQueryParamKeySansStars(
-            ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-                $this->getQueryParamKey()
-            )
-        );
-        $this->setField(
-            ModelDataTranslator::deduceFieldFromQueryParam(
-                $this->getQueryParamKeySansStars(),
-                $this->getContext()->getModel()
-            )
-        );
-        // double-check is it a *_gmt field?
-        if (
-            ! $this->getField() instanceof EE_Model_Field_Base
-            && ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
-        ) {
-            // yep, take off '_gmt', and find the field
-            $this->setQueryParamKey(ModelDataTranslator::removeGmtFromFieldName($this->getQueryParamKeySansStars()));
-            $this->setField(
-                ModelDataTranslator::deduceFieldFromQueryParam(
-                    $this->getQueryParamKey(),
-                    $this->context->getModel()
-                )
-            );
-            $this->setTimezone('UTC');
-            $this->setIsGmtField(true);
-        } elseif ($this->getField() instanceof EE_Datetime_Field) {
-            // so it's not a GMT field. Set the timezone on the model to the default
-            $this->setTimezone(EEH_DTT_Helper::get_valid_timezone_string());
-        } else {
-            // just keep using what's already set for the timezone
-            $this->setTimezone($this->context->getModel()->get_timezone());
-        }
-        $this->assertOnlyAdminCanReadPasswordFields();
-    }
-
-
-    /**
-     * Throws an exception if a non-admin is trying to query by password.
-     *
-     * @throws RestException
-     * @since 4.9.74.p
-     */
-    private function assertOnlyAdminCanReadPasswordFields()
-    {
-        if (
-            $this->getField() instanceof EE_Password_Field
-            && ! current_user_can(EE_Restriction_Generator_Base::get_default_restrictions_cap())
-        ) {
-            // only full admins can query by password. sorry bub!
-            throw new RestException(
-                'only_admins_can_query_by_password',
-                // @codingStandardsIgnoreStart
-                esc_html__(
-                    'You attempted to filter by a password field without the needed privileges. Only a full admin is allowed to do that.',
-                    'event_espresso'
-                ),
-                // @codingStandardsIgnoreEnd
-                [
-                    'status' => 403,
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Given a ton of input, determines the value to use for the models.
-     *
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RestException
-     * @throws DomainException
-     * @since 4.9.72.p
-     */
-    public function determineConditionsQueryParameterValue()
-    {
-        if ($this->valueIsArrayDuringRead()) {
-            return $this->determineModelValueGivenRestInputArray();
-        }
-        return ModelDataTranslator::prepareFieldValueFromJson(
-            $this->getField(),
-            $this->getQueryParamValue(),
-            $this->getContext()->getRequestedVersion(),
-            $this->getTimezone()
-        );
-    }
-
-
-    /**
-     * Given that the array value provided was itself an array, handles finding the correct value to pass to the model.
-     *
-     * @return array|null
-     * @throws RestException
-     * @throws EE_Error
-     * @since 4.9.72.p
-     * @noinspection PhpStatementHasEmptyBodyInspection
-     */
-    private function determineModelValueGivenRestInputArray(): ?array
-    {
-        $this->transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax();
-        // did they specify an operator?
-        if ($this->valueIsLegacySpecifiedOperator()) {
-            $query_param_value = $this->getQueryParamValue();
-            $sub_array_key     = $query_param_value[0];
-            $translated_value  = [$sub_array_key];
-            if ($this->operatorIsNAry($sub_array_key)) {
-                $translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
-            } elseif ($this->operatorIsTernary($sub_array_key)) {
-                $translated_value[] = [
-                    $this->prepareValuesFromJson($query_param_value[1][0]),
-                    $this->prepareValuesFromJson($query_param_value[1][1]),
-                ];
-            } elseif ($this->operatorIsLike($sub_array_key)) {
-                // we want to leave this value mostly-as-is (eg don't force it to be a float
-                // or a boolean or an enum value. Leave it as-is with wildcards etc)
-                // but do verify it at least doesn't have any serialized data
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
-                $translated_value[] = $query_param_value[1];
-            } elseif ($this->operatorIsUnary($sub_array_key)) {
-                // no arguments should have been provided, so don't look for any
-            } elseif ($this->operatorIsBinary($sub_array_key)) {
-                // it's a valid operator, but none of the exceptions. Treat it normally.
-                $translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
-            } else {
-                // so they provided a valid operator, but wrong number of arguments
-                $this->throwWrongNumberOfArgsExceptionIfDebugging($sub_array_key);
-                $translated_value = null;
-            }
-        } else {
-            // so they didn't provide a valid operator
-            // if we aren't in debug mode, then just try our best to fulfill the user's request
-            $this->throwInvalidOperatorExceptionIfDebugging();
-            $translated_value = null;
-        }
-        return $translated_value;
-    }
-
-
-    /**
-     * Returns if this request is a "read" request and the value provided was an array.
-     * This will indicate is such things as `array('<', 123)` and `array('IN', array(1,2,3))` are acceptable or not.
-     *
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function valueIsArrayDuringRead(): bool
-    {
-        return ! $this->getContext()->isWriting() && is_array($this->getQueryParamValue());
-    }
-
-
-    /**
-     * Returns if the value provided was an associative array (we should have already verified it's an array of some
-     * sort). If the value is an associative array, it had better be in the simplified specified operator structure.
-     *
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function valueIsAssociativeArray(): bool
-    {
-        return ! EEH_Array::is_array_numerically_and_sequentially_indexed((array) $this->getQueryParamValue());
-    }
-
-
-    /**
-     * Checks if the array value is itself an array that fits into the simplified specified operator structure
-     * (eg ["!=" => 123]).
-     *
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function valueIsSimplifiedSpecifiedOperator(): bool
-    {
-        return count($this->getQueryParamValue()) === 1
-            && array_key_exists(
-                key($this->getQueryParamValue()),
-                $this->getContext()->getModel()->valid_operators()
-            );
-    }
-
-
-    /**
-     * Throws an exception if the sub-value is an array (eg ["!=" => []). It needs to just be a string,
-     * of either comma-separated-values, or a JSON array.
-     *
-     * @param $sub_array_key
-     * @param $sub_array_value
-     * @throws RestException
-     * @since 4.9.72.p
-     */
-    private function assertSubValueIsntArray($sub_array_key, $sub_array_value)
-    {
-        if (is_array($sub_array_value) && EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'csv_or_json_string_only',
-                sprintf(
-                /* translators: 1: variable name*/
-                    esc_html__(
-                        'The value provided for the operator "%1$s" should be comma-separated value string or a JSON array.',
-                        'event_espresso'
-                    ),
-                    $sub_array_key
-                ),
-                [
-                    'status' => 400,
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Determines if the sub-array key is an operator taking 3 or more operators.
-     *
-     * @param $sub_array_key
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function subArrayKeyIsNonBinaryOperator($sub_array_key): bool
-    {
-        return array_key_exists(
-            $sub_array_key,
-            array_merge(
-                $this->getContext()->getModel()->valid_in_style_operators(),
-                $this->getContext()->getModel()->valid_between_style_operators()
-            )
-        );
-    }
-
-
-    /**
-     * Given that the $sub_array_key is a string, checks if it's an operator taking only 1 argument.
-     *
-     * @param string $sub_array_key
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function subArrayKeyIsUnaryOperator(string $sub_array_key): bool
-    {
-        return array_key_exists(
-            $sub_array_key,
-            $this->getContext()->getModel()->valid_null_style_operators()
-        );
-    }
-
-
-    /**
-     * Parses the $sub_array_value string into an array (given it could either be a comma-separated-list or a JSON
-     * array). eg `"1,2,3"` or `"[1,2,3]"` into `array(1,2,3)`.
-     *
-     * @param $sub_array_value
-     * @return array|mixed|object
-     * @since 4.9.72.p
-     */
-    private function extractQuickStyleSpecifiedOperatorValue($sub_array_value)
-    {
-        // the value should be JSON or CSV
-        $values = json_decode($sub_array_value);
-        if (! is_array($values)) {
-            $values = array_filter(
-                array_map(
-                    'trim',
-                    explode(
-                        ',',
-                        $sub_array_value
-                    )
-                )
-            );
-        }
-        return $values;
-    }
-
-
-    /**
-     * Throws an exception if the value isn't a simplified specified operator (only called when we expect that).
-     *
-     * @throws RestException
-     * @since 4.9.72.p
-     */
-    private function assertSimplifiedSpecifiedOperator()
-    {
-        if (! $this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'numerically_indexed_array_of_values_only',
-                sprintf(
-                /* translators: 1: variable name*/
-                    esc_html__(
-                        'The array provided for the parameter "%1$s" should be numerically indexed.',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey()
-                ),
-                [
-                    'status' => 400,
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * If query_param_value were in the simplified specific operator structure, change it into the legacy structure.
-     *
-     * @throws RestException
-     * @since 4.9.72.p
-     */
-    private function transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax()
-    {
-        if ($this->valueIsAssociativeArray()) {
-            $this->assertSimplifiedSpecifiedOperator();
-            $query_param_value = $this->getQueryParamValue();
-            $sub_array_value   = reset($query_param_value);
-            $sub_array_key     = key($query_param_value);
-            $this->assertSubValueIsntArray($sub_array_key, $sub_array_value);
-            // they're doing something like "&where[EVT_ID][IN]=1,2,3" or "&where[EVT_ID][>]=5"
-            if ($this->subArrayKeyIsNonBinaryOperator($sub_array_key)) {
-                $this->setQueryParamValue(
-                    [
-                        $sub_array_key,
-                        $this->extractQuickStyleSpecifiedOperatorValue($sub_array_value),
-                    ]
-                );
-            } elseif ($this->subArrayKeyIsUnaryOperator($sub_array_key)) {
-                $this->setQueryParamValue([$sub_array_key]);
-            } else {
-                $this->setQueryParamValue([$sub_array_key, $sub_array_value]);
-            }
-        }
-    }
-
-
-    /**
-     * Returns true is the value is an array using the legacy structure to specify the operator. Eg `array('!=',123)`.
-     *
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function valueIsLegacySpecifiedOperator(): bool
-    {
-        $valid_operators   = $this->getContext()->getModel()->valid_operators();
-        $query_param_value = $this->getQueryParamValue();
-        return isset($query_param_value[0])
-            && isset($valid_operators[ $query_param_value[0] ]);
-    }
-
-
-    /**
-     * Returns true if the value specified operator accepts arbitrary number of arguments, like "IN".
-     *
-     * @param $operator
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function operatorIsNAry($operator): bool
-    {
-        $valueArray = $this->getQueryParamValue();
-        return array_key_exists(
-            $operator,
-            $this->getContext()->getModel()->valid_in_style_operators()
-        )
-            && isset($valueArray[1])
-            && is_array($valueArray[1])
-            && ! isset($valueArray[2]);
-    }
-
-
-    /**
-     * Returns true if the operator accepts 3 arguments (eg "BETWEEN").
-     * So we're looking for a value that looks like
-     * `array('BETWEEN', array('2015-01-01T00:00:00', '2016-01-01T00:00:00'))`.
-     *
-     * @param $operator
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function operatorIsTernary($operator): bool
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_between_style_operators())
-            && isset($query_param_value[1])
-            && is_array($query_param_value[1])
-            && isset($query_param_value[1][0], $query_param_value[1][1])
-            && ! isset($query_param_value[1][2])
-            && ! isset($query_param_value[2]);
-    }
-
-
-    /**
-     * Returns true if the operator is a similar to LIKE, indicating the value may have wildcards we should leave alone.
-     *
-     * @param $operator
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function operatorIsLike($operator): bool
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_like_style_operators())
-            && isset($query_param_value[1])
-            && ! isset($query_param_value[2]);
-    }
-
-
-    /**
-     * Returns true if the operator only takes one argument (eg it's like `IS NULL`).
-     *
-     * @param $operator
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function operatorIsUnary($operator): bool
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
-            && ! isset($query_param_value[1]);
-    }
-
-
-    /**
-     * Returns true if the operator specified is a binary operator (eg `=`, `!=`)
-     *
-     * @param $operator
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function operatorIsBinary($operator): bool
-    {
-        $query_param_value = $this->getQueryParamValue();
-        $model             = $this->getContext()->getModel();
-        return isset($query_param_value[1])
-            && ! isset($query_param_value[2])
-            && ! array_key_exists(
-                $operator,
-                array_merge(
-                    $model->valid_in_style_operators(),
-                    $model->valid_null_style_operators(),
-                    $model->valid_like_style_operators(),
-                    $model->valid_between_style_operators()
-                )
-            );
-    }
-
-
-    /**
-     * If we're debugging, throws an exception saying that the wrong number of arguments was provided.
-     *
-     * @param $operator
-     * @throws RestException
-     * @since 4.9.72.p
-     */
-    private function throwWrongNumberOfArgsExceptionIfDebugging($operator)
-    {
-        if (EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'wrong_number_of_arguments',
-                sprintf(
-                    esc_html__(
-                        'The operator you provided, "%1$s" had the wrong number of arguments',
-                        'event_espresso'
-                    ),
-                    $operator
-                ),
-                [
-                    'status' => 400,
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Wrapper for ModelDataTranslator::prepareFieldValuesFromJson(), just a tad more DRY.
-     *
-     * @param $value
-     * @return mixed
-     * @throws RestException
-     * @throws EE_Error
-     * @since 4.9.72.p
-     */
-    private function prepareValuesFromJson($value)
-    {
-        return ModelDataTranslator::prepareFieldValuesFromJson(
-            $this->getField(),
-            $value,
-            $this->getContext()->getRequestedVersion(),
-            $this->getTimezone()
-        );
-    }
-
-
-    /**
-     * Throws an exception if an invalid operator was specified and we're debugging.
-     *
-     * @throws RestException
-     * @since 4.9.72.p
-     */
-    private function throwInvalidOperatorExceptionIfDebugging()
-    {
-        // so they didn't provide a valid operator
-        if (EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'invalid_operator',
-                sprintf(
-                    esc_html__(
-                        'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey(),
-                    $this->getQueryParamValue()
-                ),
-                [
-                    'status' => 400,
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Returns true if the query_param_key was a logic query parameter, eg `OR`, `AND`, `NOT`, `OR*`, etc.
-     *
-     * @return bool
-     * @since 4.9.72.p
-     */
-    private function isLogicQueryParam(): bool
-    {
-        return in_array($this->getQueryParamKeySansStars(), $this->getContext()->getModel()->logic_query_param_keys());
-    }
-
-
-    /**
-     * If the query param isn't for a field, it must be a nested query parameter which requires different logic.
-     *
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RestException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @since 4.9.72.p
-     */
-    public function determineNestedConditionQueryParameters(): array
-    {
-        // so this param doesn't correspond to a field eh?
-        if ($this->getContext()->isWriting()) {
-            // always tell API clients about invalid parameters when they're creating data. Otherwise,
-            // they are probably going to create invalid data
-            throw new RestException(
-                'invalid_field',
-                sprintf(
-                /* translators: 1: variable name */
-                    esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
-                    $this->getQueryParamKey()
-                )
-            );
-        }
-        // so it's not for a field, is it a logic query param key?
-        if ($this->isLogicQueryParam()) {
-            return ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $this->getQueryParamValue(),
-                $this->getContext()->getModel(),
-                $this->getContext()->getRequestedVersion()
-            );
-        }
-        if (EED_Core_Rest_Api::debugMode()) {
-            // only tell API clients they got it wrong if we're in debug mode
-            // otherwise try our best ot fulfill their request by ignoring this invalid data
-            throw new RestException(
-                'invalid_parameter',
-                sprintf(
-                /* translators: 1: variable name */
-                    esc_html__(
-                        'You provided an invalid parameter, with key "%1$s"',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-        return [];
-    }
+	private string $query_param_key;
+
+	private $query_param_value;
+
+	private RestIncomingQueryParamContext $context;
+
+	private ?EE_Model_Field_Base $field;
+
+	/**
+	 * @var string same as $query_param_key but has the * and anything after it removed
+	 */
+	private string $query_param_key_sans_stars;
+
+	/**
+	 * @var string for timezone or timezone offset
+	 */
+	private string $timezone;
+
+	/**
+	 * @var bool if the field in $query_param_key is for a GMT field (eg `EVT_modified_gmt`)
+	 */
+	private bool $is_gmt_field = false;
+
+
+	/**
+	 * RestIncomingQueryParamMetadata constructor.
+	 * You probably want to call
+	 *
+	 * @param string                        $query_param_key
+	 * @param mixed                         $query_param_value
+	 * @param RestIncomingQueryParamContext $context
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(string $query_param_key, $query_param_value, RestIncomingQueryParamContext $context)
+	{
+		$this->query_param_key   = $query_param_key;
+		$this->query_param_value = $query_param_value;
+		$this->context           = $context;
+		$this->determineFieldAndTimezone();
+	}
+
+
+	/**
+	 * Gets the query parameter key. This may have been modified (see setQueryParamValue())
+	 *
+	 * @return string
+	 */
+	public function getQueryParamKey(): string
+	{
+		return $this->query_param_key;
+	}
+
+
+	/**
+	 * Modifies the query parameter key passed in (Eg this is done when rewriting the simplified specified operator REST
+	 * query parameters into the legacy structure)
+	 *
+	 * @param string|array|int|float $query_param_value
+	 */
+	private function setQueryParamValue($query_param_value)
+	{
+		$this->query_param_value = $query_param_value;
+	}
+
+
+	/**
+	 * Gets the original query parameter value passed in.
+	 *
+	 * @return mixed
+	 */
+	public function getQueryParamValue()
+	{
+		return $this->query_param_value;
+	}
+
+
+	/**
+	 * Gets the context object.
+	 *
+	 * @return RestIncomingQueryParamContext
+	 */
+	public function getContext(): RestIncomingQueryParamContext
+	{
+		return $this->context;
+	}
+
+
+	/**
+	 * Sets the query parameter key. This may be used to rewrite a key into its non-GMT alternative.
+	 *
+	 * @param string $query_param_key
+	 */
+	private function setQueryParamKey(string $query_param_key)
+	{
+		$this->query_param_key = $query_param_key;
+	}
+
+
+	/**
+	 * Gets the field the query parameter key indicated. This may be null (in cases where the query parameter key
+	 * did not indicate a field, eg if it were `OR`).
+	 *
+	 * @return EE_Model_Field_Base|null
+	 */
+	public function getField(): ?EE_Model_Field_Base
+	{
+		return $this->field;
+	}
+
+
+	/**
+	 * Gets the query parameter key (with the star and everything afterwards removed).
+	 *
+	 * @return string
+	 */
+	public function getQueryParamKeySansStars(): string
+	{
+		return $this->query_param_key_sans_stars;
+	}
+
+
+	/**
+	 * Gets the timezone associated with this model (the site timezone, except for GMT datetime fields).
+	 *
+	 * @return string
+	 */
+	public function getTimezone(): string
+	{
+		return $this->timezone;
+	}
+
+
+	/**
+	 * Returns whether this is a GMT field
+	 *
+	 * @return bool
+	 */
+	public function isGmtField(): bool
+	{
+		return $this->is_gmt_field;
+	}
+
+
+	/**
+	 * Sets the field indicated by the query parameter key (might be null).
+	 *
+	 * @param EE_Model_Field_Base|null $field
+	 */
+	private function setField(EE_Model_Field_Base $field = null)
+	{
+		$this->field = $field;
+	}
+
+
+	/**
+	 * Sets the query parameter key-with-stars-removed.
+	 *
+	 * @param string $query_param_key_sans_stars
+	 */
+	private function setQueryParamKeySansStars(string $query_param_key_sans_stars)
+	{
+		$this->query_param_key_sans_stars = $query_param_key_sans_stars;
+	}
+
+
+	/**
+	 * Sets the timezone (this could be a timezone offset string).
+	 *
+	 * @param string $timezone
+	 */
+	private function setTimezone(string $timezone)
+	{
+		$this->timezone = $timezone;
+	}
+
+
+	/**
+	 * @param bool|int|string|null $is_gmt_field
+	 */
+	private function setIsGmtField($is_gmt_field)
+	{
+		$this->is_gmt_field = filter_var($is_gmt_field, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * Determines what field, query param name, and query param name without stars, and timezone to use.
+	 *
+	 * @return void {
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws Exception
+	 * @since 4.9.72.p
+	 * @type EE_Model_Field_Base $field
+	 */
+	private function determineFieldAndTimezone()
+	{
+		$this->setQueryParamKeySansStars(
+			ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+				$this->getQueryParamKey()
+			)
+		);
+		$this->setField(
+			ModelDataTranslator::deduceFieldFromQueryParam(
+				$this->getQueryParamKeySansStars(),
+				$this->getContext()->getModel()
+			)
+		);
+		// double-check is it a *_gmt field?
+		if (
+			! $this->getField() instanceof EE_Model_Field_Base
+			&& ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
+		) {
+			// yep, take off '_gmt', and find the field
+			$this->setQueryParamKey(ModelDataTranslator::removeGmtFromFieldName($this->getQueryParamKeySansStars()));
+			$this->setField(
+				ModelDataTranslator::deduceFieldFromQueryParam(
+					$this->getQueryParamKey(),
+					$this->context->getModel()
+				)
+			);
+			$this->setTimezone('UTC');
+			$this->setIsGmtField(true);
+		} elseif ($this->getField() instanceof EE_Datetime_Field) {
+			// so it's not a GMT field. Set the timezone on the model to the default
+			$this->setTimezone(EEH_DTT_Helper::get_valid_timezone_string());
+		} else {
+			// just keep using what's already set for the timezone
+			$this->setTimezone($this->context->getModel()->get_timezone());
+		}
+		$this->assertOnlyAdminCanReadPasswordFields();
+	}
+
+
+	/**
+	 * Throws an exception if a non-admin is trying to query by password.
+	 *
+	 * @throws RestException
+	 * @since 4.9.74.p
+	 */
+	private function assertOnlyAdminCanReadPasswordFields()
+	{
+		if (
+			$this->getField() instanceof EE_Password_Field
+			&& ! current_user_can(EE_Restriction_Generator_Base::get_default_restrictions_cap())
+		) {
+			// only full admins can query by password. sorry bub!
+			throw new RestException(
+				'only_admins_can_query_by_password',
+				// @codingStandardsIgnoreStart
+				esc_html__(
+					'You attempted to filter by a password field without the needed privileges. Only a full admin is allowed to do that.',
+					'event_espresso'
+				),
+				// @codingStandardsIgnoreEnd
+				[
+					'status' => 403,
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Given a ton of input, determines the value to use for the models.
+	 *
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws DomainException
+	 * @since 4.9.72.p
+	 */
+	public function determineConditionsQueryParameterValue()
+	{
+		if ($this->valueIsArrayDuringRead()) {
+			return $this->determineModelValueGivenRestInputArray();
+		}
+		return ModelDataTranslator::prepareFieldValueFromJson(
+			$this->getField(),
+			$this->getQueryParamValue(),
+			$this->getContext()->getRequestedVersion(),
+			$this->getTimezone()
+		);
+	}
+
+
+	/**
+	 * Given that the array value provided was itself an array, handles finding the correct value to pass to the model.
+	 *
+	 * @return array|null
+	 * @throws RestException
+	 * @throws EE_Error
+	 * @since 4.9.72.p
+	 * @noinspection PhpStatementHasEmptyBodyInspection
+	 */
+	private function determineModelValueGivenRestInputArray(): ?array
+	{
+		$this->transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax();
+		// did they specify an operator?
+		if ($this->valueIsLegacySpecifiedOperator()) {
+			$query_param_value = $this->getQueryParamValue();
+			$sub_array_key     = $query_param_value[0];
+			$translated_value  = [$sub_array_key];
+			if ($this->operatorIsNAry($sub_array_key)) {
+				$translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
+			} elseif ($this->operatorIsTernary($sub_array_key)) {
+				$translated_value[] = [
+					$this->prepareValuesFromJson($query_param_value[1][0]),
+					$this->prepareValuesFromJson($query_param_value[1][1]),
+				];
+			} elseif ($this->operatorIsLike($sub_array_key)) {
+				// we want to leave this value mostly-as-is (eg don't force it to be a float
+				// or a boolean or an enum value. Leave it as-is with wildcards etc)
+				// but do verify it at least doesn't have any serialized data
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
+				$translated_value[] = $query_param_value[1];
+			} elseif ($this->operatorIsUnary($sub_array_key)) {
+				// no arguments should have been provided, so don't look for any
+			} elseif ($this->operatorIsBinary($sub_array_key)) {
+				// it's a valid operator, but none of the exceptions. Treat it normally.
+				$translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
+			} else {
+				// so they provided a valid operator, but wrong number of arguments
+				$this->throwWrongNumberOfArgsExceptionIfDebugging($sub_array_key);
+				$translated_value = null;
+			}
+		} else {
+			// so they didn't provide a valid operator
+			// if we aren't in debug mode, then just try our best to fulfill the user's request
+			$this->throwInvalidOperatorExceptionIfDebugging();
+			$translated_value = null;
+		}
+		return $translated_value;
+	}
+
+
+	/**
+	 * Returns if this request is a "read" request and the value provided was an array.
+	 * This will indicate is such things as `array('<', 123)` and `array('IN', array(1,2,3))` are acceptable or not.
+	 *
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function valueIsArrayDuringRead(): bool
+	{
+		return ! $this->getContext()->isWriting() && is_array($this->getQueryParamValue());
+	}
+
+
+	/**
+	 * Returns if the value provided was an associative array (we should have already verified it's an array of some
+	 * sort). If the value is an associative array, it had better be in the simplified specified operator structure.
+	 *
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function valueIsAssociativeArray(): bool
+	{
+		return ! EEH_Array::is_array_numerically_and_sequentially_indexed((array) $this->getQueryParamValue());
+	}
+
+
+	/**
+	 * Checks if the array value is itself an array that fits into the simplified specified operator structure
+	 * (eg ["!=" => 123]).
+	 *
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function valueIsSimplifiedSpecifiedOperator(): bool
+	{
+		return count($this->getQueryParamValue()) === 1
+			&& array_key_exists(
+				key($this->getQueryParamValue()),
+				$this->getContext()->getModel()->valid_operators()
+			);
+	}
+
+
+	/**
+	 * Throws an exception if the sub-value is an array (eg ["!=" => []). It needs to just be a string,
+	 * of either comma-separated-values, or a JSON array.
+	 *
+	 * @param $sub_array_key
+	 * @param $sub_array_value
+	 * @throws RestException
+	 * @since 4.9.72.p
+	 */
+	private function assertSubValueIsntArray($sub_array_key, $sub_array_value)
+	{
+		if (is_array($sub_array_value) && EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'csv_or_json_string_only',
+				sprintf(
+				/* translators: 1: variable name*/
+					esc_html__(
+						'The value provided for the operator "%1$s" should be comma-separated value string or a JSON array.',
+						'event_espresso'
+					),
+					$sub_array_key
+				),
+				[
+					'status' => 400,
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Determines if the sub-array key is an operator taking 3 or more operators.
+	 *
+	 * @param $sub_array_key
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function subArrayKeyIsNonBinaryOperator($sub_array_key): bool
+	{
+		return array_key_exists(
+			$sub_array_key,
+			array_merge(
+				$this->getContext()->getModel()->valid_in_style_operators(),
+				$this->getContext()->getModel()->valid_between_style_operators()
+			)
+		);
+	}
+
+
+	/**
+	 * Given that the $sub_array_key is a string, checks if it's an operator taking only 1 argument.
+	 *
+	 * @param string $sub_array_key
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function subArrayKeyIsUnaryOperator(string $sub_array_key): bool
+	{
+		return array_key_exists(
+			$sub_array_key,
+			$this->getContext()->getModel()->valid_null_style_operators()
+		);
+	}
+
+
+	/**
+	 * Parses the $sub_array_value string into an array (given it could either be a comma-separated-list or a JSON
+	 * array). eg `"1,2,3"` or `"[1,2,3]"` into `array(1,2,3)`.
+	 *
+	 * @param $sub_array_value
+	 * @return array|mixed|object
+	 * @since 4.9.72.p
+	 */
+	private function extractQuickStyleSpecifiedOperatorValue($sub_array_value)
+	{
+		// the value should be JSON or CSV
+		$values = json_decode($sub_array_value);
+		if (! is_array($values)) {
+			$values = array_filter(
+				array_map(
+					'trim',
+					explode(
+						',',
+						$sub_array_value
+					)
+				)
+			);
+		}
+		return $values;
+	}
+
+
+	/**
+	 * Throws an exception if the value isn't a simplified specified operator (only called when we expect that).
+	 *
+	 * @throws RestException
+	 * @since 4.9.72.p
+	 */
+	private function assertSimplifiedSpecifiedOperator()
+	{
+		if (! $this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'numerically_indexed_array_of_values_only',
+				sprintf(
+				/* translators: 1: variable name*/
+					esc_html__(
+						'The array provided for the parameter "%1$s" should be numerically indexed.',
+						'event_espresso'
+					),
+					$this->getQueryParamKey()
+				),
+				[
+					'status' => 400,
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * If query_param_value were in the simplified specific operator structure, change it into the legacy structure.
+	 *
+	 * @throws RestException
+	 * @since 4.9.72.p
+	 */
+	private function transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax()
+	{
+		if ($this->valueIsAssociativeArray()) {
+			$this->assertSimplifiedSpecifiedOperator();
+			$query_param_value = $this->getQueryParamValue();
+			$sub_array_value   = reset($query_param_value);
+			$sub_array_key     = key($query_param_value);
+			$this->assertSubValueIsntArray($sub_array_key, $sub_array_value);
+			// they're doing something like "&where[EVT_ID][IN]=1,2,3" or "&where[EVT_ID][>]=5"
+			if ($this->subArrayKeyIsNonBinaryOperator($sub_array_key)) {
+				$this->setQueryParamValue(
+					[
+						$sub_array_key,
+						$this->extractQuickStyleSpecifiedOperatorValue($sub_array_value),
+					]
+				);
+			} elseif ($this->subArrayKeyIsUnaryOperator($sub_array_key)) {
+				$this->setQueryParamValue([$sub_array_key]);
+			} else {
+				$this->setQueryParamValue([$sub_array_key, $sub_array_value]);
+			}
+		}
+	}
+
+
+	/**
+	 * Returns true is the value is an array using the legacy structure to specify the operator. Eg `array('!=',123)`.
+	 *
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function valueIsLegacySpecifiedOperator(): bool
+	{
+		$valid_operators   = $this->getContext()->getModel()->valid_operators();
+		$query_param_value = $this->getQueryParamValue();
+		return isset($query_param_value[0])
+			&& isset($valid_operators[ $query_param_value[0] ]);
+	}
+
+
+	/**
+	 * Returns true if the value specified operator accepts arbitrary number of arguments, like "IN".
+	 *
+	 * @param $operator
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function operatorIsNAry($operator): bool
+	{
+		$valueArray = $this->getQueryParamValue();
+		return array_key_exists(
+			$operator,
+			$this->getContext()->getModel()->valid_in_style_operators()
+		)
+			&& isset($valueArray[1])
+			&& is_array($valueArray[1])
+			&& ! isset($valueArray[2]);
+	}
+
+
+	/**
+	 * Returns true if the operator accepts 3 arguments (eg "BETWEEN").
+	 * So we're looking for a value that looks like
+	 * `array('BETWEEN', array('2015-01-01T00:00:00', '2016-01-01T00:00:00'))`.
+	 *
+	 * @param $operator
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function operatorIsTernary($operator): bool
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_between_style_operators())
+			&& isset($query_param_value[1])
+			&& is_array($query_param_value[1])
+			&& isset($query_param_value[1][0], $query_param_value[1][1])
+			&& ! isset($query_param_value[1][2])
+			&& ! isset($query_param_value[2]);
+	}
+
+
+	/**
+	 * Returns true if the operator is a similar to LIKE, indicating the value may have wildcards we should leave alone.
+	 *
+	 * @param $operator
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function operatorIsLike($operator): bool
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_like_style_operators())
+			&& isset($query_param_value[1])
+			&& ! isset($query_param_value[2]);
+	}
+
+
+	/**
+	 * Returns true if the operator only takes one argument (eg it's like `IS NULL`).
+	 *
+	 * @param $operator
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function operatorIsUnary($operator): bool
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
+			&& ! isset($query_param_value[1]);
+	}
+
+
+	/**
+	 * Returns true if the operator specified is a binary operator (eg `=`, `!=`)
+	 *
+	 * @param $operator
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function operatorIsBinary($operator): bool
+	{
+		$query_param_value = $this->getQueryParamValue();
+		$model             = $this->getContext()->getModel();
+		return isset($query_param_value[1])
+			&& ! isset($query_param_value[2])
+			&& ! array_key_exists(
+				$operator,
+				array_merge(
+					$model->valid_in_style_operators(),
+					$model->valid_null_style_operators(),
+					$model->valid_like_style_operators(),
+					$model->valid_between_style_operators()
+				)
+			);
+	}
+
+
+	/**
+	 * If we're debugging, throws an exception saying that the wrong number of arguments was provided.
+	 *
+	 * @param $operator
+	 * @throws RestException
+	 * @since 4.9.72.p
+	 */
+	private function throwWrongNumberOfArgsExceptionIfDebugging($operator)
+	{
+		if (EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'wrong_number_of_arguments',
+				sprintf(
+					esc_html__(
+						'The operator you provided, "%1$s" had the wrong number of arguments',
+						'event_espresso'
+					),
+					$operator
+				),
+				[
+					'status' => 400,
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Wrapper for ModelDataTranslator::prepareFieldValuesFromJson(), just a tad more DRY.
+	 *
+	 * @param $value
+	 * @return mixed
+	 * @throws RestException
+	 * @throws EE_Error
+	 * @since 4.9.72.p
+	 */
+	private function prepareValuesFromJson($value)
+	{
+		return ModelDataTranslator::prepareFieldValuesFromJson(
+			$this->getField(),
+			$value,
+			$this->getContext()->getRequestedVersion(),
+			$this->getTimezone()
+		);
+	}
+
+
+	/**
+	 * Throws an exception if an invalid operator was specified and we're debugging.
+	 *
+	 * @throws RestException
+	 * @since 4.9.72.p
+	 */
+	private function throwInvalidOperatorExceptionIfDebugging()
+	{
+		// so they didn't provide a valid operator
+		if (EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'invalid_operator',
+				sprintf(
+					esc_html__(
+						'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
+						'event_espresso'
+					),
+					$this->getQueryParamKey(),
+					$this->getQueryParamValue()
+				),
+				[
+					'status' => 400,
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Returns true if the query_param_key was a logic query parameter, eg `OR`, `AND`, `NOT`, `OR*`, etc.
+	 *
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	private function isLogicQueryParam(): bool
+	{
+		return in_array($this->getQueryParamKeySansStars(), $this->getContext()->getModel()->logic_query_param_keys());
+	}
+
+
+	/**
+	 * If the query param isn't for a field, it must be a nested query parameter which requires different logic.
+	 *
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @since 4.9.72.p
+	 */
+	public function determineNestedConditionQueryParameters(): array
+	{
+		// so this param doesn't correspond to a field eh?
+		if ($this->getContext()->isWriting()) {
+			// always tell API clients about invalid parameters when they're creating data. Otherwise,
+			// they are probably going to create invalid data
+			throw new RestException(
+				'invalid_field',
+				sprintf(
+				/* translators: 1: variable name */
+					esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
+					$this->getQueryParamKey()
+				)
+			);
+		}
+		// so it's not for a field, is it a logic query param key?
+		if ($this->isLogicQueryParam()) {
+			return ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$this->getQueryParamValue(),
+				$this->getContext()->getModel(),
+				$this->getContext()->getRequestedVersion()
+			);
+		}
+		if (EED_Core_Rest_Api::debugMode()) {
+			// only tell API clients they got it wrong if we're in debug mode
+			// otherwise try our best ot fulfill their request by ignoring this invalid data
+			throw new RestException(
+				'invalid_parameter',
+				sprintf(
+				/* translators: 1: variable name */
+					esc_html__(
+						'You provided an invalid parameter, with key "%1$s"',
+						'event_espresso'
+					),
+					$this->getQueryParamKey()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+		return [];
+	}
 }
 // End of file RestQueryParamMetadata.php
 // Location: EventEspresso\core\libraries\rest_api/RestQueryParamMetadata.php

core/libraries/form_sections/inputs/EE_CVV_Input.input.php

Indentation +34 added lines, -34 removed lines

@@ -11,38 +11,38 @@
  */
 class EE_CVV_Input extends EE_Text_Input
 {
-    /**
-     * @param array  $input_settings          {
-     * @type boolean $include_whats_this_link defaults to true
-     *                                        }
-     */
-    public function __construct($input_settings = [])
-    {
-        $this->set_sensitive_data_removal_strategy(new EE_CCV_Sensitive_Data_Removal());
-        $this->_add_validation_strategy(
-            new EE_Text_Validation_Strategy(
-                $input_settings['validation_error_message'] ?? esc_html__(
-                    'The CVV is either a 3 digit number on the back of your card, or 4 digit number on the front',
-                    'event_espresso'
-                ),
-                '~^\d{3,4}$~'
-            )
-        );
-        parent::__construct($input_settings);
-        if (
-            ! isset($input_settings['include_whats_this_link'])
-            || $input_settings['include_whats_this_link'] === true
-        ) {
-            $this->_html_label_text = sprintf(
-                esc_html_x(
-                    '%1$s %2$s(What\'s this?)%3$s',
-                    'CVV (What\'s this?)',
-                    'event_espresso'
-                ),
-                $this->_html_label_text,
-                '<a href="https://www.cvvnumber.com/" target="_blank" rel="noopener noreferrer">',
-                '</a>'
-            );
-        }
-    }
+	/**
+	 * @param array  $input_settings          {
+	 * @type boolean $include_whats_this_link defaults to true
+	 *                                        }
+	 */
+	public function __construct($input_settings = [])
+	{
+		$this->set_sensitive_data_removal_strategy(new EE_CCV_Sensitive_Data_Removal());
+		$this->_add_validation_strategy(
+			new EE_Text_Validation_Strategy(
+				$input_settings['validation_error_message'] ?? esc_html__(
+					'The CVV is either a 3 digit number on the back of your card, or 4 digit number on the front',
+					'event_espresso'
+				),
+				'~^\d{3,4}$~'
+			)
+		);
+		parent::__construct($input_settings);
+		if (
+			! isset($input_settings['include_whats_this_link'])
+			|| $input_settings['include_whats_this_link'] === true
+		) {
+			$this->_html_label_text = sprintf(
+				esc_html_x(
+					'%1$s %2$s(What\'s this?)%3$s',
+					'CVV (What\'s this?)',
+					'event_espresso'
+				),
+				$this->_html_label_text,
+				'<a href="https://www.cvvnumber.com/" target="_blank" rel="noopener noreferrer">',
+				'</a>'
+			);
+		}
+	}
 }

core/libraries/form_sections/inputs/EE_Form_Input_Base.input.php

Indentation +1262 added lines, -1262 removed lines

@@ -14,1266 +14,1266 @@
  */
 abstract class EE_Form_Input_Base extends EE_Form_Section_Validatable
 {
-    /**
-     * the input's name attribute
-     *
-     * @var string|null
-     */
-    protected ?string $_html_name = null;
-
-    /**
-     * id for the html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_id;
-
-    /**
-     * class for teh html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_class;
-
-    /**
-     * style for teh html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_style;
-
-    /**
-     * text to be placed in the html label
-     *
-     * @var string
-     */
-    protected $_html_label_text;
-
-    /**
-     * the full html label. If used, all other html_label_* properties are invalid
-     *
-     * @var string
-     */
-    protected $_html_label;
-
-    /**
-     * HTML to use for help text (normally placed below form input), in a span which normally
-     * has a class of 'description'
-     *
-     * @var string
-     */
-    protected $_html_help_text;
-
-    /**
-     * CSS classes for displaying the help span
-     *
-     * @var string
-     */
-    protected $_html_help_class = 'description';
-
-    /**
-     * CSS to put in the style attribute on the help span
-     *
-     * @var string
-     */
-    protected $_html_help_style;
-
-    /**
-     * Stores whether or not this input's response is required.
-     * Because certain styling elements may also want to know that this
-     * input is required etc.
-     *
-     * @var boolean
-     */
-    protected $_required;
-
-    /**
-     * css class added to required inputs
-     *
-     * @var string
-     */
-    protected $_required_css_class = 'ee-required';
-
-    /**
-     * css styles applied to button type inputs
-     *
-     * @var string
-     */
-    protected $_button_css_attributes;
-
-    /**
-     * The raw post data submitted for this
-     * Generally unsafe for usage in client code
-     *
-     * @var mixed string or array
-     */
-    protected $_raw_value;
-
-    /**
-     * Value normalized according to the input's normalization strategy.
-     * The normalization strategy dictates whether this is a string, int, float,
-     * boolean, or array of any of those.
-     *
-     * @var mixed
-     */
-    protected $_normalized_value;
-
-
-    /**
-     * Normalized default value either initially set on the input, or provided by calling
-     * set_default().
-     *
-     * @var mixed
-     */
-    protected $_default;
-
-    /**
-     * Strategy used for displaying this field.
-     * Child classes must use _get_display_strategy to access it.
-     *
-     * @var EE_Display_Strategy_Base
-     */
-    private $_display_strategy;
-
-    /**
-     * Gets all the validation strategies used on this field
-     *
-     * @var EE_Validation_Strategy_Base[]
-     */
-    private $_validation_strategies = [];
-
-    /**
-     * The normalization strategy for this field
-     *
-     * @var EE_Normalization_Strategy_Base
-     */
-    private $_normalization_strategy;
-
-    /**
-     * Strategy for removing sensitive data after we're done with the form input
-     *
-     * @var EE_Sensitive_Data_Removal_Base
-     */
-    protected $_sensitive_data_removal_strategy;
-
-    /**
-     * Whether this input has been disabled or not.
-     * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled.
-     * (Client-side code that wants to dynamically disable it must also add this hidden input).
-     * When the form is submitted, if the input is disabled in the PHP form section, then input is ignored.
-     * If the input is missing from the request data but the hidden input indicating the input is disabled, then the
-     * input is again ignored.
-     *
-     * @var boolean
-     */
-    protected $disabled = false;
-
-    protected array $_data_attributes = [];
-
-    protected bool $_no_label = false; // if true, then no hrml label will be displayed for this input
-
-    /**
-     * adds a class to the input's container
-     *
-     * @var string
-     */
-    protected string $_layout_container_class = '';
-
-    /**
-     * additional HTML to inject into the input's container
-     *
-     * @var string
-     */
-    protected string $_extra_container_html = '';
-
-
-    /**
-     * @param array                         $input_args       {
-     * @type string                         $html_name        the html name for the input
-     * @type string                         $html_label_id    the id attribute to give to the html label tag
-     * @type string                         $html_label_class the class attribute to give to the html label tag
-     * @type string                         $html_label_style the style attribute to give ot teh label tag
-     * @type string                         $html_label_text  the text to put in the label tag
-     * @type string                         $html_label       the full html label. If used,
-     *                                                        all other html_label_* args are invalid
-     * @type string                         $html_help_text   text to put in help element
-     * @type string                         $html_help_style  style attribute to give to teh help element
-     * @type string                         $html_help_class  class attribute to give to the help element
-     * @type string                         $default          default value NORMALIZED (eg, if providing the default
-     *                                                        for a Yes_No_Input, you should provide TRUE or FALSE, not
-     *                                                        '1' or '0')
-     * @type EE_Display_Strategy_Base       $display          strategy
-     * @type EE_Normalization_Strategy_Base $normalization_strategy
-     * @type EE_Validation_Strategy_Base[]  $validation_strategies
-     * @type boolean                        $ignore_input     special argument which can be used to avoid adding any
-     *                                                        validation strategies, and sets the normalization
-     *                                                        strategy to the Null normalization. This is good when you
-     *                                                        want the input to be totally ignored server-side (like
-     *                                                        when using React.js form inputs)
-     *                                                        }
-     */
-    public function __construct($input_args = [])
-    {
-        $input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
-        // the following properties must be cast as arrays
-        if (isset($input_args['validation_strategies'])) {
-            foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
-                if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
-                    $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
-                }
-            }
-            unset($input_args['validation_strategies']);
-        }
-        if (isset($input_args['ignore_input'])) {
-            $this->_validation_strategies = [];
-        }
-        // loop thru incoming options
-        foreach ($input_args as $key => $value) {
-            if ($key === 'disabled') {
-                $this->disable($value);
-                continue;
-            }
-            $setter = 'set_' . $key;
-            if (method_exists($this, $setter)) {
-                $this->$setter($value);
-                unset($input_args[ $key ]);
-                continue;
-            }
-            // add underscore to $key to match property names
-            $_key = "_$key";
-            if (property_exists($this, $_key)) {
-                $this->{$_key} = $value;
-                unset($input_args[ $key ]);
-            }
-        }
-        // ensure that "required" is set correctly
-        $this->set_required(
-            $this->_required,
-            $input_args['required_validation_error_message'] ?? null
-        );
-        // $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
-        $this->_display_strategy->_construct_finalize($this);
-        foreach ($this->_validation_strategies as $validation_strategy) {
-            $validation_strategy->_construct_finalize($this);
-        }
-        if (isset($input_args['ignore_input'])) {
-            $this->_normalization_strategy = new EE_Null_Normalization();
-        }
-        if (! $this->_normalization_strategy) {
-            $this->_normalization_strategy = new EE_Text_Normalization();
-        }
-        $this->_normalization_strategy->_construct_finalize($this);
-        // at least we can use the normalization strategy to populate the default
-        if (isset($input_args['default'])) {
-            $this->set_default($input_args['default']);
-            unset($input_args['default']);
-        }
-        if (! $this->_sensitive_data_removal_strategy) {
-            $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
-        }
-        $this->_sensitive_data_removal_strategy->_construct_finalize($this);
-        parent::__construct($input_args);
-    }
-
-
-    /**
-     * Sets the html_name to its default value, if none was specified in teh constructor.
-     * Calculation involves using the name and the parent's html_name
-     *
-     * @throws EE_Error
-     */
-    protected function _set_default_html_name_if_empty()
-    {
-        if (! $this->_html_name) {
-            $this->_html_name = $this->name();
-            if ($this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
-            }
-        }
-    }
-
-
-    /**
-     * @param $parent_form_section
-     * @param $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        if ($this->_html_label === null && $this->_html_label_text === null && ! $this->_no_label) {
-            $this->_html_label_text = ucwords(str_replace("_", " ", $name));
-        }
-        do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
-    }
-
-
-    /**
-     * Returns the strategy for displaying this form input. If none is set, throws an exception.
-     *
-     * @return EE_Display_Strategy_Base
-     * @throws EE_Error
-     */
-    protected function _get_display_strategy()
-    {
-        $this->ensure_construct_finalized_called();
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
-                        "event_espresso"
-                    ),
-                    $this->html_name(),
-                    $this->html_id()
-                )
-            );
-        } else {
-            return $this->_display_strategy;
-        }
-    }
-
-
-    /**
-     * Sets the display strategy.
-     *
-     * @param EE_Display_Strategy_Base $strategy
-     */
-    protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
-    {
-        $this->_display_strategy = $strategy;
-    }
-
-
-    /**
-     * Sets the sanitization strategy
-     *
-     * @param EE_Normalization_Strategy_Base $strategy
-     */
-    protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
-    {
-        $this->_normalization_strategy = $strategy;
-    }
-
-
-    /**
-     * Gets sensitive_data_removal_strategy
-     *
-     * @return EE_Sensitive_Data_Removal_Base
-     */
-    public function get_sensitive_data_removal_strategy()
-    {
-        return $this->_sensitive_data_removal_strategy;
-    }
-
-
-    /**
-     * Sets sensitive_data_removal_strategy
-     *
-     * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
-     * @return void
-     */
-    public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
-    {
-        $this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
-    }
-
-
-    /**
-     * Gets the display strategy for this input
-     *
-     * @return EE_Display_Strategy_Base
-     */
-    public function get_display_strategy()
-    {
-        return $this->_display_strategy;
-    }
-
-
-    /**
-     * Overwrites the display strategy
-     *
-     * @param EE_Display_Strategy_Base $display_strategy
-     */
-    public function set_display_strategy($display_strategy)
-    {
-        $this->_display_strategy = $display_strategy;
-        $this->_display_strategy->_construct_finalize($this);
-    }
-
-
-    /**
-     * Gets the normalization strategy set on this input
-     *
-     * @return EE_Normalization_Strategy_Base
-     */
-    public function get_normalization_strategy()
-    {
-        return $this->_normalization_strategy;
-    }
-
-
-    /**
-     * Overwrites the normalization strategy
-     *
-     * @param EE_Normalization_Strategy_Base $normalization_strategy
-     */
-    public function set_normalization_strategy($normalization_strategy)
-    {
-        $this->_normalization_strategy = $normalization_strategy;
-        $this->_normalization_strategy->_construct_finalize($this);
-    }
-
-
-    /**
-     * Returns all teh validation strategies which apply to this field, numerically indexed
-     *
-     * @return EE_Validation_Strategy_Base[]
-     */
-    public function get_validation_strategies()
-    {
-        return $this->_validation_strategies;
-    }
-
-
-    /**
-     * Adds this strategy to the field so it will be used in both JS validation and server-side validation
-     *
-     * @param EE_Validation_Strategy_Base $validation_strategy
-     * @return void
-     */
-    protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
-    {
-        $validation_strategy->_construct_finalize($this);
-        $this->_validation_strategies[] = $validation_strategy;
-    }
-
-
-    /**
-     * Adds a new validation strategy onto the form input
-     *
-     * @param EE_Validation_Strategy_Base $validation_strategy
-     * @return void
-     */
-    public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
-    {
-        $this->_add_validation_strategy($validation_strategy);
-    }
-
-
-    /**
-     * The classname of the validation strategy to remove
-     *
-     * @param string $validation_strategy_classname
-     */
-    public function remove_validation_strategy($validation_strategy_classname)
-    {
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
-            if (
-                $validation_strategy instanceof $validation_strategy_classname
-                || is_subclass_of($validation_strategy, $validation_strategy_classname)
-            ) {
-                unset($this->_validation_strategies[ $key ]);
-            }
-        }
-    }
-
-
-    /**
-     * returns true if input employs any of the validation strategy defined by the supplied array of classnames
-     *
-     * @param array $validation_strategy_classnames
-     * @return bool
-     */
-    public function has_validation_strategy($validation_strategy_classnames)
-    {
-        $validation_strategy_classnames = is_array($validation_strategy_classnames)
-            ? $validation_strategy_classnames
-            : [$validation_strategy_classnames];
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
-            if (in_array($key, $validation_strategy_classnames)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets the HTML
-     *
-     * @return string
-     */
-    public function get_html()
-    {
-        return $this->_parent_section->get_html_for_input($this);
-    }
-
-
-    /**
-     * Gets the HTML for the input itself (no label or errors) according to the
-     * input's display strategy
-     * Makes sure the JS and CSS are enqueued for it
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_html_for_input()
-    {
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml(
-                $this->_get_display_strategy()->display(),
-                $this
-            )
-            : $this->_get_display_strategy()->display();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_other_attributes()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use. You should replace it by %s',
-                    'event_espresso'
-                ),
-                'EE_Form_Section_Base::other_html_attributes()'
-            ),
-            '4.10.2.p'
-        );
-
-        return $this->other_html_attributes();
-    }
-
-
-    /**
-     * @param string $html_other_attributes
-     */
-    public function set_html_other_attributes($html_other_attributes)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use. You should replace it by %s',
-                    'event_espresso'
-                ),
-                'EE_Form_Section_Base::set_other_html_attributes()'
-            ),
-            '4.10.2.p'
-        );
-
-        $this->set_other_html_attributes($html_other_attributes);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the label for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_html_for_label()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_label($this);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the errors section for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_html_for_errors()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_errors($this);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the help text for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_html_for_help()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_help_text($this);
-    }
-
-
-    /**
-     * Validates the input's sanitized value (assumes _sanitize() has already been called)
-     * and returns whether or not the form input's submitted value is value
-     *
-     * @return boolean
-     */
-    protected function _validate()
-    {
-        if ($this->isDisabled()) {
-            return true;
-        }
-        foreach ($this->_validation_strategies as $validation_strategy) {
-            if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
-                try {
-                    $validation_strategy->validate($this->normalized_value());
-                } catch (EE_Validation_Error $e) {
-                    $this->add_validation_error($e);
-                }
-            }
-        }
-        if ($this->get_validation_errors()) {
-            return false;
-        } else {
-            return true;
-        }
-    }
-
-
-    /**
-     * Performs basic sanitization on this value. But what sanitization can be performed anyways?
-     * This value MIGHT be allowed to have tags, so we can't really remove them.
-     *
-     * @param string $value
-     * @return null|string
-     */
-    protected function _sanitize($value)
-    {
-        return $value !== null
-            ? stripslashes(html_entity_decode(trim((string) $value)))
-            : null;
-    }
-
-
-    /**
-     * Picks out the form value that relates to this form input,
-     * and stores it as the sanitized value on the form input, and sets the normalized value.
-     * Returns whether or not any validation errors occurred
-     *
-     * @param array $req_data
-     * @return boolean whether or not there was an error
-     * @throws EE_Error
-     */
-    protected function _normalize($req_data)
-    {
-        // any existing validation errors don't apply so clear them
-        $this->_validation_errors = [];
-        // if the input is disabled, ignore whatever input was sent in
-        if ($this->isDisabled()) {
-            $this->_set_raw_value(null);
-            $this->_set_normalized_value($this->get_default());
-            return false;
-        }
-        try {
-            $raw_input = $this->find_form_data_for_this_section($req_data);
-            // super simple sanitization for now
-            if (is_array($raw_input)) {
-                $raw_value = [];
-                foreach ($raw_input as $key => $value) {
-                    $raw_value[ $key ] = $this->_sanitize($value);
-                }
-                $this->_set_raw_value($raw_value);
-            } else {
-                $this->_set_raw_value($this->_sanitize($raw_input));
-            }
-            // we want to mostly leave the input alone in case we need to re-display it to the user
-            $this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
-            return false;
-        } catch (EE_Validation_Error $e) {
-            $this->add_validation_error($e);
-            return true;
-        }
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_name()
-    {
-        $this->_set_default_html_name_if_empty();
-        return $this->_html_name ?? '';
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_label_id()
-    {
-        return ! empty($this->_html_label_id)
-            ? $this->_html_label_id
-            : $this->html_id() . '-lbl';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_class()
-    {
-        return $this->_html_label_class ?? '';
-    }
-
-
-    /**
-     * @param string $html_class
-     */
-    public function add_html_label_class(string $html_class)
-    {
-        $this->_html_label_class .= ' ' . trim($html_class);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_style()
-    {
-        return $this->_html_label_style ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_text()
-    {
-        return $this->_html_label_text ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_text()
-    {
-        return $this->_html_help_text ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_class()
-    {
-        return $this->_html_help_class ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_style()
-    {
-        return $this->_html_style ?? '';
-    }
-
-
-    /**
-     * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
-     * Please note that almost all client code should instead use the normalized_value;
-     * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
-     * mostly by escaping quotes)
-     * Note, we do not store the exact original value sent in the user's request because
-     * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
-     * in which case, we would have stored the malicious content to our database.
-     *
-     * @return mixed
-     */
-    public function raw_value()
-    {
-        return $this->_raw_value;
-    }
-
-
-    /**
-     * Returns a string safe to usage in form inputs when displaying, because
-     * it escapes all html entities
-     *
-     * @return string
-     */
-    public function raw_value_in_form(): string
-    {
-        return htmlentities((string) $this->raw_value(), ENT_QUOTES, 'UTF-8');
-    }
-
-
-    /**
-     * returns the value after it's been sanitized, and then converted into it's proper type
-     * in PHP. Eg, a string, an int, an array,
-     *
-     * @return mixed
-     */
-    public function normalized_value()
-    {
-        return $this->_normalized_value;
-    }
-
-
-    /**
-     * Returns the normalized value is a presentable way. By default this is just
-     * the normalized value by itself, but it can be overridden for when that's not
-     * the best thing to display
-     *
-     * @return mixed
-     */
-    public function pretty_value()
-    {
-        return $this->_normalized_value;
-    }
-
-
-    /**
-     * When generating the JS for the jquery validation rules like<br>
-     * <code>$( "#myform" ).validate({
-     * rules: {
-     * password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }
-     * }
-     * });</code>
-     * if this field had the name 'password_again', it should return
-     * <br><code>password_again: {
-     * equalTo: "#password"
-     * }</code>
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_jquery_validation_rules(): array
-    {
-        $jquery_validation_js    = [];
-        $jquery_validation_rules = [];
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $jquery_validation_rules = array_replace_recursive(
-                $jquery_validation_rules,
-                $validation_strategy->get_jquery_validation_rule_array()
-            );
-        }
-        if (! empty($jquery_validation_rules)) {
-            foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
-                $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
-            }
-        }
-        return $jquery_validation_js;
-    }
-
-
-    /**
-     * Sets the input's default value for use in displaying in the form. Note: value should be
-     * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
-     *
-     * @param mixed $value
-     * @return void
-     */
-    public function set_default($value)
-    {
-        $this->_default = $value;
-        $this->_set_normalized_value($value);
-        $this->_set_raw_value($value);
-    }
-
-
-    /**
-     * Sets the normalized value on this input
-     *
-     * @param mixed $value
-     */
-    protected function _set_normalized_value($value)
-    {
-        $this->_normalized_value = $value;
-    }
-
-
-    /**
-     * Sets the raw value on this input (ie, exactly as the user submitted it)
-     *
-     * @param mixed $value
-     */
-    protected function _set_raw_value($value)
-    {
-        $this->_raw_value = $this->_normalization_strategy->unnormalize($value);
-    }
-
-
-    /**
-     * Sets the HTML label text after it has already been defined
-     *
-     * @param string $label
-     * @return void
-     */
-    public function set_html_label_text($label)
-    {
-        $this->_html_label_text = $label;
-    }
-
-
-    /**
-     * Sets whether or not this field is required, and adjusts the validation strategy.
-     * If you want to use the EE_Conditionally_Required_Validation_Strategy,
-     * please add it as a validation strategy using add_validation_strategy as normal
-     *
-     * @param boolean $required boolean
-     * @param null    $required_text
-     */
-    public function set_required($required = true, $required_text = null)
-    {
-        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
-        // whether $required is a string or a boolean, we want to add a required validation strategy
-        if ($required) {
-            $this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
-        } else {
-            $this->remove_validation_strategy('EE_Required_Validation_Strategy');
-        }
-        $this->_required = $required;
-    }
-
-
-    /**
-     * Returns whether or not this field is required
-     *
-     * @return boolean
-     */
-    public function required()
-    {
-        return $this->_required;
-    }
-
-
-    /**
-     * @param string $required_css_class
-     */
-    public function set_required_css_class($required_css_class)
-    {
-        $this->_required_css_class = $required_css_class;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function required_css_class()
-    {
-        return $this->_required_css_class;
-    }
-
-
-    /**
-     * @param bool $add_required
-     * @return string
-     */
-    public function html_class($add_required = false)
-    {
-        return $add_required && $this->required()
-            ? $this->required_css_class() . ' ' . $this->_html_class
-            : $this->_html_class;
-    }
-
-
-    /**
-     * Sets the help text, in case
-     *
-     * @param string $text
-     */
-    public function set_html_help_text($text)
-    {
-        $this->_html_help_text = $text;
-    }
-
-
-    /**
-     * Uses the sensitive data removal strategy to remove the sensitive data from this
-     * input. If there is any kind of sensitive data removal on this input, we clear
-     * out the raw value completely
-     *
-     * @return void
-     */
-    public function clean_sensitive_data()
-    {
-        // if we do ANY kind of sensitive data removal on this, then just clear out the raw value
-        // if we need more logic than this we'll make a strategy for it
-        if (
-            $this->_sensitive_data_removal_strategy
-            && ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
-        ) {
-            $this->_set_raw_value(null);
-        }
-        // and clean the normalized value according to the appropriate strategy
-        $this->_set_normalized_value(
-            $this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
-                $this->_normalized_value
-            )
-        );
-    }
-
-
-    /**
-     * @param bool   $primary
-     * @param string $button_size
-     * @param string $other_attributes
-     */
-    public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
-    {
-        $button_css_attributes = 'button';
-        $button_css_attributes .= $primary === true
-            ? ' button--primary'
-            : ' button--secondary';
-        switch ($button_size) {
-            case 'xs':
-            case 'extra-small':
-                $button_css_attributes .= ' button-xs';
-                break;
-            case 'sm':
-            case 'small':
-                $button_css_attributes .= ' button-sm';
-                break;
-            case 'lg':
-            case 'large':
-                $button_css_attributes .= ' button-lg';
-                break;
-            case 'block':
-                $button_css_attributes .= ' button-block';
-                break;
-            case 'md':
-            case 'medium':
-            default:
-                $button_css_attributes .= '';
-        }
-        $this->_button_css_attributes .= ! empty($other_attributes)
-            ? $button_css_attributes . ' ' . $other_attributes
-            : $button_css_attributes;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function button_css_attributes()
-    {
-        if (empty($this->_button_css_attributes)) {
-            $this->set_button_css_attributes();
-        }
-        return $this->_button_css_attributes;
-    }
-
-
-    /**
-     * find_form_data_for_this_section
-     * using this section's name and its parents, finds the value of the form data that corresponds to it.
-     * For example, if this form section's HTML name is my_form[subform][form_input_1],
-     * then it's value should be in request at request['my_form']['subform']['form_input_1'].
-     * (If that doesn't exist, we also check for this subsection's name
-     * at the TOP LEVEL of the request data. Eg request['form_input_1'].)
-     * This function finds its value in the form.
-     *
-     * @param array $req_data
-     * @return mixed whatever the raw value of this form section is in the request data
-     * @throws EE_Error
-     */
-    public function find_form_data_for_this_section($req_data)
-    {
-        $name_parts = $this->getInputNameParts();
-        // now get the value for the input
-        $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
-        // check if this thing's name is at the TOP level of the request data
-        if ($value === null && isset($req_data[ $this->name() ])) {
-            $value = $req_data[ $this->name() ];
-        }
-        return $value;
-    }
-
-
-    /**
-     * If this input's name is something like "foo[bar][baz]"
-     * returns an array like `array('foo','bar',baz')`
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    protected function getInputNameParts()
-    {
-        // break up the html name by "[]"
-        if (strpos($this->html_name(), '[') !== false) {
-            $before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
-        } else {
-            $before_any_brackets = $this->html_name();
-        }
-        // grab all of the segments
-        preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
-        if (isset($matches[1]) && is_array($matches[1])) {
-            $name_parts = $matches[1];
-            array_unshift($name_parts, $before_any_brackets);
-        } else {
-            $name_parts = [$before_any_brackets];
-        }
-        return $name_parts;
-    }
-
-
-    /**
-     * @param array $html_name_parts
-     * @param array $req_data
-     * @return array | NULL
-     */
-    public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
-    {
-        $first_part_to_consider = array_shift($html_name_parts);
-        if (isset($req_data[ $first_part_to_consider ])) {
-            if (empty($html_name_parts)) {
-                return $req_data[ $first_part_to_consider ];
-            } else {
-                return $this->findRequestForSectionUsingNameParts(
-                    $html_name_parts,
-                    $req_data[ $first_part_to_consider ]
-                );
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Checks if this form input's data is in the request data
-     *
-     * @param array $req_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        if ($req_data === null) {
-            /** @var RequestInterface $request */
-            $request  = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $req_data = $request->postParams();
-        }
-
-        return $this->find_form_data_for_this_section($req_data) !== null;
-    }
-
-
-    /**
-     * Overrides parent to add js data from validation and display strategies
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = [])
-    {
-        return $this->get_other_js_data_from_strategies($form_other_js_data);
-    }
-
-
-    /**
-     * Gets other JS data for localization from this input's strategies, like
-     * the validation strategies and the display strategy
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data_from_strategies($form_other_js_data = [])
-    {
-        $form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-    /**
-     * Override parent because we want to give our strategies an opportunity to enqueue some js and css
-     *
-     * @return void
-     */
-    public function enqueue_js()
-    {
-        // ask our display strategy and validation strategies if they have js to enqueue
-        $this->enqueue_js_from_strategies();
-    }
-
-
-    /**
-     * Tells strategies when its ok to enqueue their js and css
-     *
-     * @return void
-     */
-    public function enqueue_js_from_strategies()
-    {
-        $this->get_display_strategy()->enqueue_js();
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $validation_strategy->enqueue_js();
-        }
-    }
-
-
-    /**
-     * Gets the default value set on the input (not the current value, which may have been
-     * changed because of a form submission). If no default was set, this us null.
-     *
-     * @return mixed
-     */
-    public function get_default()
-    {
-        return $this->_default;
-    }
-
-
-    /**
-     * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"',
-     * and server-side if any input was received it will be ignored
-     */
-    public function disable($disable = true)
-    {
-        $disabled_attribute = ' disabled="disabled"';
-        $this->disabled     = filter_var($disable, FILTER_VALIDATE_BOOLEAN);
-        if ($this->disabled) {
-            if (strpos($this->_other_html_attributes, $disabled_attribute) === false) {
-                $this->_other_html_attributes .= $disabled_attribute;
-            }
-            $this->_set_normalized_value($this->get_default());
-        } else {
-            $this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes);
-        }
-    }
-
-
-    /**
-     * Returns whether this input is currently disabled.
-     *
-     * @return bool
-     */
-    public function isDisabled(): bool
-    {
-        return $this->disabled;
-    }
-
-
-    public function dataAttributes(): array
-    {
-        return $this->_data_attributes;
-    }
-
-
-    public function layoutContainerClass(): string
-    {
-        return $this->_layout_container_class;
-    }
-
-
-    public function extraContainerHtml(): string
-    {
-        return $this->_extra_container_html;
-    }
+	/**
+	 * the input's name attribute
+	 *
+	 * @var string|null
+	 */
+	protected ?string $_html_name = null;
+
+	/**
+	 * id for the html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_id;
+
+	/**
+	 * class for teh html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_class;
+
+	/**
+	 * style for teh html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_style;
+
+	/**
+	 * text to be placed in the html label
+	 *
+	 * @var string
+	 */
+	protected $_html_label_text;
+
+	/**
+	 * the full html label. If used, all other html_label_* properties are invalid
+	 *
+	 * @var string
+	 */
+	protected $_html_label;
+
+	/**
+	 * HTML to use for help text (normally placed below form input), in a span which normally
+	 * has a class of 'description'
+	 *
+	 * @var string
+	 */
+	protected $_html_help_text;
+
+	/**
+	 * CSS classes for displaying the help span
+	 *
+	 * @var string
+	 */
+	protected $_html_help_class = 'description';
+
+	/**
+	 * CSS to put in the style attribute on the help span
+	 *
+	 * @var string
+	 */
+	protected $_html_help_style;
+
+	/**
+	 * Stores whether or not this input's response is required.
+	 * Because certain styling elements may also want to know that this
+	 * input is required etc.
+	 *
+	 * @var boolean
+	 */
+	protected $_required;
+
+	/**
+	 * css class added to required inputs
+	 *
+	 * @var string
+	 */
+	protected $_required_css_class = 'ee-required';
+
+	/**
+	 * css styles applied to button type inputs
+	 *
+	 * @var string
+	 */
+	protected $_button_css_attributes;
+
+	/**
+	 * The raw post data submitted for this
+	 * Generally unsafe for usage in client code
+	 *
+	 * @var mixed string or array
+	 */
+	protected $_raw_value;
+
+	/**
+	 * Value normalized according to the input's normalization strategy.
+	 * The normalization strategy dictates whether this is a string, int, float,
+	 * boolean, or array of any of those.
+	 *
+	 * @var mixed
+	 */
+	protected $_normalized_value;
+
+
+	/**
+	 * Normalized default value either initially set on the input, or provided by calling
+	 * set_default().
+	 *
+	 * @var mixed
+	 */
+	protected $_default;
+
+	/**
+	 * Strategy used for displaying this field.
+	 * Child classes must use _get_display_strategy to access it.
+	 *
+	 * @var EE_Display_Strategy_Base
+	 */
+	private $_display_strategy;
+
+	/**
+	 * Gets all the validation strategies used on this field
+	 *
+	 * @var EE_Validation_Strategy_Base[]
+	 */
+	private $_validation_strategies = [];
+
+	/**
+	 * The normalization strategy for this field
+	 *
+	 * @var EE_Normalization_Strategy_Base
+	 */
+	private $_normalization_strategy;
+
+	/**
+	 * Strategy for removing sensitive data after we're done with the form input
+	 *
+	 * @var EE_Sensitive_Data_Removal_Base
+	 */
+	protected $_sensitive_data_removal_strategy;
+
+	/**
+	 * Whether this input has been disabled or not.
+	 * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled.
+	 * (Client-side code that wants to dynamically disable it must also add this hidden input).
+	 * When the form is submitted, if the input is disabled in the PHP form section, then input is ignored.
+	 * If the input is missing from the request data but the hidden input indicating the input is disabled, then the
+	 * input is again ignored.
+	 *
+	 * @var boolean
+	 */
+	protected $disabled = false;
+
+	protected array $_data_attributes = [];
+
+	protected bool $_no_label = false; // if true, then no hrml label will be displayed for this input
+
+	/**
+	 * adds a class to the input's container
+	 *
+	 * @var string
+	 */
+	protected string $_layout_container_class = '';
+
+	/**
+	 * additional HTML to inject into the input's container
+	 *
+	 * @var string
+	 */
+	protected string $_extra_container_html = '';
+
+
+	/**
+	 * @param array                         $input_args       {
+	 * @type string                         $html_name        the html name for the input
+	 * @type string                         $html_label_id    the id attribute to give to the html label tag
+	 * @type string                         $html_label_class the class attribute to give to the html label tag
+	 * @type string                         $html_label_style the style attribute to give ot teh label tag
+	 * @type string                         $html_label_text  the text to put in the label tag
+	 * @type string                         $html_label       the full html label. If used,
+	 *                                                        all other html_label_* args are invalid
+	 * @type string                         $html_help_text   text to put in help element
+	 * @type string                         $html_help_style  style attribute to give to teh help element
+	 * @type string                         $html_help_class  class attribute to give to the help element
+	 * @type string                         $default          default value NORMALIZED (eg, if providing the default
+	 *                                                        for a Yes_No_Input, you should provide TRUE or FALSE, not
+	 *                                                        '1' or '0')
+	 * @type EE_Display_Strategy_Base       $display          strategy
+	 * @type EE_Normalization_Strategy_Base $normalization_strategy
+	 * @type EE_Validation_Strategy_Base[]  $validation_strategies
+	 * @type boolean                        $ignore_input     special argument which can be used to avoid adding any
+	 *                                                        validation strategies, and sets the normalization
+	 *                                                        strategy to the Null normalization. This is good when you
+	 *                                                        want the input to be totally ignored server-side (like
+	 *                                                        when using React.js form inputs)
+	 *                                                        }
+	 */
+	public function __construct($input_args = [])
+	{
+		$input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
+		// the following properties must be cast as arrays
+		if (isset($input_args['validation_strategies'])) {
+			foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
+				if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
+					$this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
+				}
+			}
+			unset($input_args['validation_strategies']);
+		}
+		if (isset($input_args['ignore_input'])) {
+			$this->_validation_strategies = [];
+		}
+		// loop thru incoming options
+		foreach ($input_args as $key => $value) {
+			if ($key === 'disabled') {
+				$this->disable($value);
+				continue;
+			}
+			$setter = 'set_' . $key;
+			if (method_exists($this, $setter)) {
+				$this->$setter($value);
+				unset($input_args[ $key ]);
+				continue;
+			}
+			// add underscore to $key to match property names
+			$_key = "_$key";
+			if (property_exists($this, $_key)) {
+				$this->{$_key} = $value;
+				unset($input_args[ $key ]);
+			}
+		}
+		// ensure that "required" is set correctly
+		$this->set_required(
+			$this->_required,
+			$input_args['required_validation_error_message'] ?? null
+		);
+		// $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
+		$this->_display_strategy->_construct_finalize($this);
+		foreach ($this->_validation_strategies as $validation_strategy) {
+			$validation_strategy->_construct_finalize($this);
+		}
+		if (isset($input_args['ignore_input'])) {
+			$this->_normalization_strategy = new EE_Null_Normalization();
+		}
+		if (! $this->_normalization_strategy) {
+			$this->_normalization_strategy = new EE_Text_Normalization();
+		}
+		$this->_normalization_strategy->_construct_finalize($this);
+		// at least we can use the normalization strategy to populate the default
+		if (isset($input_args['default'])) {
+			$this->set_default($input_args['default']);
+			unset($input_args['default']);
+		}
+		if (! $this->_sensitive_data_removal_strategy) {
+			$this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
+		}
+		$this->_sensitive_data_removal_strategy->_construct_finalize($this);
+		parent::__construct($input_args);
+	}
+
+
+	/**
+	 * Sets the html_name to its default value, if none was specified in teh constructor.
+	 * Calculation involves using the name and the parent's html_name
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _set_default_html_name_if_empty()
+	{
+		if (! $this->_html_name) {
+			$this->_html_name = $this->name();
+			if ($this->_parent_section instanceof EE_Form_Section_Proper) {
+				$this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
+			}
+		}
+	}
+
+
+	/**
+	 * @param $parent_form_section
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		if ($this->_html_label === null && $this->_html_label_text === null && ! $this->_no_label) {
+			$this->_html_label_text = ucwords(str_replace("_", " ", $name));
+		}
+		do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
+	}
+
+
+	/**
+	 * Returns the strategy for displaying this form input. If none is set, throws an exception.
+	 *
+	 * @return EE_Display_Strategy_Base
+	 * @throws EE_Error
+	 */
+	protected function _get_display_strategy()
+	{
+		$this->ensure_construct_finalized_called();
+		if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
+						"event_espresso"
+					),
+					$this->html_name(),
+					$this->html_id()
+				)
+			);
+		} else {
+			return $this->_display_strategy;
+		}
+	}
+
+
+	/**
+	 * Sets the display strategy.
+	 *
+	 * @param EE_Display_Strategy_Base $strategy
+	 */
+	protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
+	{
+		$this->_display_strategy = $strategy;
+	}
+
+
+	/**
+	 * Sets the sanitization strategy
+	 *
+	 * @param EE_Normalization_Strategy_Base $strategy
+	 */
+	protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
+	{
+		$this->_normalization_strategy = $strategy;
+	}
+
+
+	/**
+	 * Gets sensitive_data_removal_strategy
+	 *
+	 * @return EE_Sensitive_Data_Removal_Base
+	 */
+	public function get_sensitive_data_removal_strategy()
+	{
+		return $this->_sensitive_data_removal_strategy;
+	}
+
+
+	/**
+	 * Sets sensitive_data_removal_strategy
+	 *
+	 * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
+	 * @return void
+	 */
+	public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
+	{
+		$this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
+	}
+
+
+	/**
+	 * Gets the display strategy for this input
+	 *
+	 * @return EE_Display_Strategy_Base
+	 */
+	public function get_display_strategy()
+	{
+		return $this->_display_strategy;
+	}
+
+
+	/**
+	 * Overwrites the display strategy
+	 *
+	 * @param EE_Display_Strategy_Base $display_strategy
+	 */
+	public function set_display_strategy($display_strategy)
+	{
+		$this->_display_strategy = $display_strategy;
+		$this->_display_strategy->_construct_finalize($this);
+	}
+
+
+	/**
+	 * Gets the normalization strategy set on this input
+	 *
+	 * @return EE_Normalization_Strategy_Base
+	 */
+	public function get_normalization_strategy()
+	{
+		return $this->_normalization_strategy;
+	}
+
+
+	/**
+	 * Overwrites the normalization strategy
+	 *
+	 * @param EE_Normalization_Strategy_Base $normalization_strategy
+	 */
+	public function set_normalization_strategy($normalization_strategy)
+	{
+		$this->_normalization_strategy = $normalization_strategy;
+		$this->_normalization_strategy->_construct_finalize($this);
+	}
+
+
+	/**
+	 * Returns all teh validation strategies which apply to this field, numerically indexed
+	 *
+	 * @return EE_Validation_Strategy_Base[]
+	 */
+	public function get_validation_strategies()
+	{
+		return $this->_validation_strategies;
+	}
+
+
+	/**
+	 * Adds this strategy to the field so it will be used in both JS validation and server-side validation
+	 *
+	 * @param EE_Validation_Strategy_Base $validation_strategy
+	 * @return void
+	 */
+	protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
+	{
+		$validation_strategy->_construct_finalize($this);
+		$this->_validation_strategies[] = $validation_strategy;
+	}
+
+
+	/**
+	 * Adds a new validation strategy onto the form input
+	 *
+	 * @param EE_Validation_Strategy_Base $validation_strategy
+	 * @return void
+	 */
+	public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
+	{
+		$this->_add_validation_strategy($validation_strategy);
+	}
+
+
+	/**
+	 * The classname of the validation strategy to remove
+	 *
+	 * @param string $validation_strategy_classname
+	 */
+	public function remove_validation_strategy($validation_strategy_classname)
+	{
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
+			if (
+				$validation_strategy instanceof $validation_strategy_classname
+				|| is_subclass_of($validation_strategy, $validation_strategy_classname)
+			) {
+				unset($this->_validation_strategies[ $key ]);
+			}
+		}
+	}
+
+
+	/**
+	 * returns true if input employs any of the validation strategy defined by the supplied array of classnames
+	 *
+	 * @param array $validation_strategy_classnames
+	 * @return bool
+	 */
+	public function has_validation_strategy($validation_strategy_classnames)
+	{
+		$validation_strategy_classnames = is_array($validation_strategy_classnames)
+			? $validation_strategy_classnames
+			: [$validation_strategy_classnames];
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
+			if (in_array($key, $validation_strategy_classnames)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets the HTML
+	 *
+	 * @return string
+	 */
+	public function get_html()
+	{
+		return $this->_parent_section->get_html_for_input($this);
+	}
+
+
+	/**
+	 * Gets the HTML for the input itself (no label or errors) according to the
+	 * input's display strategy
+	 * Makes sure the JS and CSS are enqueued for it
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_html_for_input()
+	{
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml(
+				$this->_get_display_strategy()->display(),
+				$this
+			)
+			: $this->_get_display_strategy()->display();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_other_attributes()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use. You should replace it by %s',
+					'event_espresso'
+				),
+				'EE_Form_Section_Base::other_html_attributes()'
+			),
+			'4.10.2.p'
+		);
+
+		return $this->other_html_attributes();
+	}
+
+
+	/**
+	 * @param string $html_other_attributes
+	 */
+	public function set_html_other_attributes($html_other_attributes)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use. You should replace it by %s',
+					'event_espresso'
+				),
+				'EE_Form_Section_Base::set_other_html_attributes()'
+			),
+			'4.10.2.p'
+		);
+
+		$this->set_other_html_attributes($html_other_attributes);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the label for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_html_for_label()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_label($this);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the errors section for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_html_for_errors()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_errors($this);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the help text for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_html_for_help()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_help_text($this);
+	}
+
+
+	/**
+	 * Validates the input's sanitized value (assumes _sanitize() has already been called)
+	 * and returns whether or not the form input's submitted value is value
+	 *
+	 * @return boolean
+	 */
+	protected function _validate()
+	{
+		if ($this->isDisabled()) {
+			return true;
+		}
+		foreach ($this->_validation_strategies as $validation_strategy) {
+			if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
+				try {
+					$validation_strategy->validate($this->normalized_value());
+				} catch (EE_Validation_Error $e) {
+					$this->add_validation_error($e);
+				}
+			}
+		}
+		if ($this->get_validation_errors()) {
+			return false;
+		} else {
+			return true;
+		}
+	}
+
+
+	/**
+	 * Performs basic sanitization on this value. But what sanitization can be performed anyways?
+	 * This value MIGHT be allowed to have tags, so we can't really remove them.
+	 *
+	 * @param string $value
+	 * @return null|string
+	 */
+	protected function _sanitize($value)
+	{
+		return $value !== null
+			? stripslashes(html_entity_decode(trim((string) $value)))
+			: null;
+	}
+
+
+	/**
+	 * Picks out the form value that relates to this form input,
+	 * and stores it as the sanitized value on the form input, and sets the normalized value.
+	 * Returns whether or not any validation errors occurred
+	 *
+	 * @param array $req_data
+	 * @return boolean whether or not there was an error
+	 * @throws EE_Error
+	 */
+	protected function _normalize($req_data)
+	{
+		// any existing validation errors don't apply so clear them
+		$this->_validation_errors = [];
+		// if the input is disabled, ignore whatever input was sent in
+		if ($this->isDisabled()) {
+			$this->_set_raw_value(null);
+			$this->_set_normalized_value($this->get_default());
+			return false;
+		}
+		try {
+			$raw_input = $this->find_form_data_for_this_section($req_data);
+			// super simple sanitization for now
+			if (is_array($raw_input)) {
+				$raw_value = [];
+				foreach ($raw_input as $key => $value) {
+					$raw_value[ $key ] = $this->_sanitize($value);
+				}
+				$this->_set_raw_value($raw_value);
+			} else {
+				$this->_set_raw_value($this->_sanitize($raw_input));
+			}
+			// we want to mostly leave the input alone in case we need to re-display it to the user
+			$this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
+			return false;
+		} catch (EE_Validation_Error $e) {
+			$this->add_validation_error($e);
+			return true;
+		}
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_name()
+	{
+		$this->_set_default_html_name_if_empty();
+		return $this->_html_name ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_label_id()
+	{
+		return ! empty($this->_html_label_id)
+			? $this->_html_label_id
+			: $this->html_id() . '-lbl';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_class()
+	{
+		return $this->_html_label_class ?? '';
+	}
+
+
+	/**
+	 * @param string $html_class
+	 */
+	public function add_html_label_class(string $html_class)
+	{
+		$this->_html_label_class .= ' ' . trim($html_class);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_style()
+	{
+		return $this->_html_label_style ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_text()
+	{
+		return $this->_html_label_text ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_text()
+	{
+		return $this->_html_help_text ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_class()
+	{
+		return $this->_html_help_class ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_style()
+	{
+		return $this->_html_style ?? '';
+	}
+
+
+	/**
+	 * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
+	 * Please note that almost all client code should instead use the normalized_value;
+	 * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
+	 * mostly by escaping quotes)
+	 * Note, we do not store the exact original value sent in the user's request because
+	 * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
+	 * in which case, we would have stored the malicious content to our database.
+	 *
+	 * @return mixed
+	 */
+	public function raw_value()
+	{
+		return $this->_raw_value;
+	}
+
+
+	/**
+	 * Returns a string safe to usage in form inputs when displaying, because
+	 * it escapes all html entities
+	 *
+	 * @return string
+	 */
+	public function raw_value_in_form(): string
+	{
+		return htmlentities((string) $this->raw_value(), ENT_QUOTES, 'UTF-8');
+	}
+
+
+	/**
+	 * returns the value after it's been sanitized, and then converted into it's proper type
+	 * in PHP. Eg, a string, an int, an array,
+	 *
+	 * @return mixed
+	 */
+	public function normalized_value()
+	{
+		return $this->_normalized_value;
+	}
+
+
+	/**
+	 * Returns the normalized value is a presentable way. By default this is just
+	 * the normalized value by itself, but it can be overridden for when that's not
+	 * the best thing to display
+	 *
+	 * @return mixed
+	 */
+	public function pretty_value()
+	{
+		return $this->_normalized_value;
+	}
+
+
+	/**
+	 * When generating the JS for the jquery validation rules like<br>
+	 * <code>$( "#myform" ).validate({
+	 * rules: {
+	 * password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }
+	 * }
+	 * });</code>
+	 * if this field had the name 'password_again', it should return
+	 * <br><code>password_again: {
+	 * equalTo: "#password"
+	 * }</code>
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_jquery_validation_rules(): array
+	{
+		$jquery_validation_js    = [];
+		$jquery_validation_rules = [];
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$jquery_validation_rules = array_replace_recursive(
+				$jquery_validation_rules,
+				$validation_strategy->get_jquery_validation_rule_array()
+			);
+		}
+		if (! empty($jquery_validation_rules)) {
+			foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
+				$jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
+			}
+		}
+		return $jquery_validation_js;
+	}
+
+
+	/**
+	 * Sets the input's default value for use in displaying in the form. Note: value should be
+	 * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
+	 *
+	 * @param mixed $value
+	 * @return void
+	 */
+	public function set_default($value)
+	{
+		$this->_default = $value;
+		$this->_set_normalized_value($value);
+		$this->_set_raw_value($value);
+	}
+
+
+	/**
+	 * Sets the normalized value on this input
+	 *
+	 * @param mixed $value
+	 */
+	protected function _set_normalized_value($value)
+	{
+		$this->_normalized_value = $value;
+	}
+
+
+	/**
+	 * Sets the raw value on this input (ie, exactly as the user submitted it)
+	 *
+	 * @param mixed $value
+	 */
+	protected function _set_raw_value($value)
+	{
+		$this->_raw_value = $this->_normalization_strategy->unnormalize($value);
+	}
+
+
+	/**
+	 * Sets the HTML label text after it has already been defined
+	 *
+	 * @param string $label
+	 * @return void
+	 */
+	public function set_html_label_text($label)
+	{
+		$this->_html_label_text = $label;
+	}
+
+
+	/**
+	 * Sets whether or not this field is required, and adjusts the validation strategy.
+	 * If you want to use the EE_Conditionally_Required_Validation_Strategy,
+	 * please add it as a validation strategy using add_validation_strategy as normal
+	 *
+	 * @param boolean $required boolean
+	 * @param null    $required_text
+	 */
+	public function set_required($required = true, $required_text = null)
+	{
+		$required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
+		// whether $required is a string or a boolean, we want to add a required validation strategy
+		if ($required) {
+			$this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
+		} else {
+			$this->remove_validation_strategy('EE_Required_Validation_Strategy');
+		}
+		$this->_required = $required;
+	}
+
+
+	/**
+	 * Returns whether or not this field is required
+	 *
+	 * @return boolean
+	 */
+	public function required()
+	{
+		return $this->_required;
+	}
+
+
+	/**
+	 * @param string $required_css_class
+	 */
+	public function set_required_css_class($required_css_class)
+	{
+		$this->_required_css_class = $required_css_class;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function required_css_class()
+	{
+		return $this->_required_css_class;
+	}
+
+
+	/**
+	 * @param bool $add_required
+	 * @return string
+	 */
+	public function html_class($add_required = false)
+	{
+		return $add_required && $this->required()
+			? $this->required_css_class() . ' ' . $this->_html_class
+			: $this->_html_class;
+	}
+
+
+	/**
+	 * Sets the help text, in case
+	 *
+	 * @param string $text
+	 */
+	public function set_html_help_text($text)
+	{
+		$this->_html_help_text = $text;
+	}
+
+
+	/**
+	 * Uses the sensitive data removal strategy to remove the sensitive data from this
+	 * input. If there is any kind of sensitive data removal on this input, we clear
+	 * out the raw value completely
+	 *
+	 * @return void
+	 */
+	public function clean_sensitive_data()
+	{
+		// if we do ANY kind of sensitive data removal on this, then just clear out the raw value
+		// if we need more logic than this we'll make a strategy for it
+		if (
+			$this->_sensitive_data_removal_strategy
+			&& ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
+		) {
+			$this->_set_raw_value(null);
+		}
+		// and clean the normalized value according to the appropriate strategy
+		$this->_set_normalized_value(
+			$this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
+				$this->_normalized_value
+			)
+		);
+	}
+
+
+	/**
+	 * @param bool   $primary
+	 * @param string $button_size
+	 * @param string $other_attributes
+	 */
+	public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
+	{
+		$button_css_attributes = 'button';
+		$button_css_attributes .= $primary === true
+			? ' button--primary'
+			: ' button--secondary';
+		switch ($button_size) {
+			case 'xs':
+			case 'extra-small':
+				$button_css_attributes .= ' button-xs';
+				break;
+			case 'sm':
+			case 'small':
+				$button_css_attributes .= ' button-sm';
+				break;
+			case 'lg':
+			case 'large':
+				$button_css_attributes .= ' button-lg';
+				break;
+			case 'block':
+				$button_css_attributes .= ' button-block';
+				break;
+			case 'md':
+			case 'medium':
+			default:
+				$button_css_attributes .= '';
+		}
+		$this->_button_css_attributes .= ! empty($other_attributes)
+			? $button_css_attributes . ' ' . $other_attributes
+			: $button_css_attributes;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function button_css_attributes()
+	{
+		if (empty($this->_button_css_attributes)) {
+			$this->set_button_css_attributes();
+		}
+		return $this->_button_css_attributes;
+	}
+
+
+	/**
+	 * find_form_data_for_this_section
+	 * using this section's name and its parents, finds the value of the form data that corresponds to it.
+	 * For example, if this form section's HTML name is my_form[subform][form_input_1],
+	 * then it's value should be in request at request['my_form']['subform']['form_input_1'].
+	 * (If that doesn't exist, we also check for this subsection's name
+	 * at the TOP LEVEL of the request data. Eg request['form_input_1'].)
+	 * This function finds its value in the form.
+	 *
+	 * @param array $req_data
+	 * @return mixed whatever the raw value of this form section is in the request data
+	 * @throws EE_Error
+	 */
+	public function find_form_data_for_this_section($req_data)
+	{
+		$name_parts = $this->getInputNameParts();
+		// now get the value for the input
+		$value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
+		// check if this thing's name is at the TOP level of the request data
+		if ($value === null && isset($req_data[ $this->name() ])) {
+			$value = $req_data[ $this->name() ];
+		}
+		return $value;
+	}
+
+
+	/**
+	 * If this input's name is something like "foo[bar][baz]"
+	 * returns an array like `array('foo','bar',baz')`
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function getInputNameParts()
+	{
+		// break up the html name by "[]"
+		if (strpos($this->html_name(), '[') !== false) {
+			$before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
+		} else {
+			$before_any_brackets = $this->html_name();
+		}
+		// grab all of the segments
+		preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
+		if (isset($matches[1]) && is_array($matches[1])) {
+			$name_parts = $matches[1];
+			array_unshift($name_parts, $before_any_brackets);
+		} else {
+			$name_parts = [$before_any_brackets];
+		}
+		return $name_parts;
+	}
+
+
+	/**
+	 * @param array $html_name_parts
+	 * @param array $req_data
+	 * @return array | NULL
+	 */
+	public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
+	{
+		$first_part_to_consider = array_shift($html_name_parts);
+		if (isset($req_data[ $first_part_to_consider ])) {
+			if (empty($html_name_parts)) {
+				return $req_data[ $first_part_to_consider ];
+			} else {
+				return $this->findRequestForSectionUsingNameParts(
+					$html_name_parts,
+					$req_data[ $first_part_to_consider ]
+				);
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Checks if this form input's data is in the request data
+	 *
+	 * @param array $req_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		if ($req_data === null) {
+			/** @var RequestInterface $request */
+			$request  = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$req_data = $request->postParams();
+		}
+
+		return $this->find_form_data_for_this_section($req_data) !== null;
+	}
+
+
+	/**
+	 * Overrides parent to add js data from validation and display strategies
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = [])
+	{
+		return $this->get_other_js_data_from_strategies($form_other_js_data);
+	}
+
+
+	/**
+	 * Gets other JS data for localization from this input's strategies, like
+	 * the validation strategies and the display strategy
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data_from_strategies($form_other_js_data = [])
+	{
+		$form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+	/**
+	 * Override parent because we want to give our strategies an opportunity to enqueue some js and css
+	 *
+	 * @return void
+	 */
+	public function enqueue_js()
+	{
+		// ask our display strategy and validation strategies if they have js to enqueue
+		$this->enqueue_js_from_strategies();
+	}
+
+
+	/**
+	 * Tells strategies when its ok to enqueue their js and css
+	 *
+	 * @return void
+	 */
+	public function enqueue_js_from_strategies()
+	{
+		$this->get_display_strategy()->enqueue_js();
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$validation_strategy->enqueue_js();
+		}
+	}
+
+
+	/**
+	 * Gets the default value set on the input (not the current value, which may have been
+	 * changed because of a form submission). If no default was set, this us null.
+	 *
+	 * @return mixed
+	 */
+	public function get_default()
+	{
+		return $this->_default;
+	}
+
+
+	/**
+	 * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"',
+	 * and server-side if any input was received it will be ignored
+	 */
+	public function disable($disable = true)
+	{
+		$disabled_attribute = ' disabled="disabled"';
+		$this->disabled     = filter_var($disable, FILTER_VALIDATE_BOOLEAN);
+		if ($this->disabled) {
+			if (strpos($this->_other_html_attributes, $disabled_attribute) === false) {
+				$this->_other_html_attributes .= $disabled_attribute;
+			}
+			$this->_set_normalized_value($this->get_default());
+		} else {
+			$this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes);
+		}
+	}
+
+
+	/**
+	 * Returns whether this input is currently disabled.
+	 *
+	 * @return bool
+	 */
+	public function isDisabled(): bool
+	{
+		return $this->disabled;
+	}
+
+
+	public function dataAttributes(): array
+	{
+		return $this->_data_attributes;
+	}
+
+
+	public function layoutContainerClass(): string
+	{
+		return $this->_layout_container_class;
+	}
+
+
+	public function extraContainerHtml(): string
+	{
+		return $this->_extra_container_html;
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -219,7 +219,7 @@ 
         if (isset($input_args['validation_strategies'])) {
             foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
                 if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
-                    $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
+                    $this->_validation_strategies[get_class($validation_strategy)] = $validation_strategy;
                 }
             }
             unset($input_args['validation_strategies']);
@@ -233,17 +233,17 @@ 
                 $this->disable($value);
                 continue;
             }
-            $setter = 'set_' . $key;
+            $setter = 'set_'.$key;
             if (method_exists($this, $setter)) {
                 $this->$setter($value);
-                unset($input_args[ $key ]);
+                unset($input_args[$key]);
                 continue;
             }
             // add underscore to $key to match property names
             $_key = "_$key";
             if (property_exists($this, $_key)) {
                 $this->{$_key} = $value;
-                unset($input_args[ $key ]);
+                unset($input_args[$key]);
             }
         }
         // ensure that "required" is set correctly
@@ -259,7 +259,7 @@ 
         if (isset($input_args['ignore_input'])) {
             $this->_normalization_strategy = new EE_Null_Normalization();
         }
-        if (! $this->_normalization_strategy) {
+        if ( ! $this->_normalization_strategy) {
             $this->_normalization_strategy = new EE_Text_Normalization();
         }
         $this->_normalization_strategy->_construct_finalize($this);
@@ -268,7 +268,7 @@ 
             $this->set_default($input_args['default']);
             unset($input_args['default']);
         }
-        if (! $this->_sensitive_data_removal_strategy) {
+        if ( ! $this->_sensitive_data_removal_strategy) {
             $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
         }
         $this->_sensitive_data_removal_strategy->_construct_finalize($this);
@@ -284,10 +284,10 @@ 
      */
     protected function _set_default_html_name_if_empty()
     {
-        if (! $this->_html_name) {
+        if ( ! $this->_html_name) {
             $this->_html_name = $this->name();
             if ($this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
+                $this->_html_name = $this->_parent_section->html_name_prefix()."[{$this->name()}]";
             }
         }
     }
@@ -317,7 +317,7 @@ 
     protected function _get_display_strategy()
     {
         $this->ensure_construct_finalized_called();
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
+        if ( ! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -473,7 +473,7 @@ 
                 $validation_strategy instanceof $validation_strategy_classname
                 || is_subclass_of($validation_strategy, $validation_strategy_classname)
             ) {
-                unset($this->_validation_strategies[ $key ]);
+                unset($this->_validation_strategies[$key]);
             }
         }
     }
@@ -678,7 +678,7 @@ 
             if (is_array($raw_input)) {
                 $raw_value = [];
                 foreach ($raw_input as $key => $value) {
-                    $raw_value[ $key ] = $this->_sanitize($value);
+                    $raw_value[$key] = $this->_sanitize($value);
                 }
                 $this->_set_raw_value($raw_value);
             } else {
@@ -713,7 +713,7 @@ 
     {
         return ! empty($this->_html_label_id)
             ? $this->_html_label_id
-            : $this->html_id() . '-lbl';
+            : $this->html_id().'-lbl';
     }
 
 
@@ -731,7 +731,7 @@ 
      */
     public function add_html_label_class(string $html_class)
     {
-        $this->_html_label_class .= ' ' . trim($html_class);
+        $this->_html_label_class .= ' '.trim($html_class);
     }
 
 
@@ -862,9 +862,9 @@ 
                 $validation_strategy->get_jquery_validation_rule_array()
             );
         }
-        if (! empty($jquery_validation_rules)) {
+        if ( ! empty($jquery_validation_rules)) {
             foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
-                $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
+                $jquery_validation_js[$html_id_with_pound_sign] = $jquery_validation_rules;
             }
         }
         return $jquery_validation_js;
@@ -977,7 +977,7 @@ 
     public function html_class($add_required = false)
     {
         return $add_required && $this->required()
-            ? $this->required_css_class() . ' ' . $this->_html_class
+            ? $this->required_css_class().' '.$this->_html_class
             : $this->_html_class;
     }
 
@@ -1052,7 +1052,7 @@ 
                 $button_css_attributes .= '';
         }
         $this->_button_css_attributes .= ! empty($other_attributes)
-            ? $button_css_attributes . ' ' . $other_attributes
+            ? $button_css_attributes.' '.$other_attributes
             : $button_css_attributes;
     }
 
@@ -1088,8 +1088,8 @@ 
         // now get the value for the input
         $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
         // check if this thing's name is at the TOP level of the request data
-        if ($value === null && isset($req_data[ $this->name() ])) {
-            $value = $req_data[ $this->name() ];
+        if ($value === null && isset($req_data[$this->name()])) {
+            $value = $req_data[$this->name()];
         }
         return $value;
     }
@@ -1130,13 +1130,13 @@ 
     public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
     {
         $first_part_to_consider = array_shift($html_name_parts);
-        if (isset($req_data[ $first_part_to_consider ])) {
+        if (isset($req_data[$first_part_to_consider])) {
             if (empty($html_name_parts)) {
-                return $req_data[ $first_part_to_consider ];
+                return $req_data[$first_part_to_consider];
             } else {
                 return $this->findRequestForSectionUsingNameParts(
                     $html_name_parts,
-                    $req_data[ $first_part_to_consider ]
+                    $req_data[$first_part_to_consider]
                 );
             }
         }

core/libraries/form_sections/strategies/display/EE_Admin_File_Uploader_Display_Strategy.strategy.php

Indentation +89 added lines, -89 removed lines

@@ -10,100 +10,100 @@
  */
 class EE_Admin_File_Uploader_Display_Strategy extends EE_Display_Strategy_Base
 {
-    /**
-     * Its important this media only get enqueued AFTER init, but before the footer... where the
-     * rest of our forms JS gets enqueued. Otherwise the JS gets enqueued fine, and loaded on the page fine,
-     * but when you upload an image it gets uploaded fine to the server, but it doesn't display and reports an error
-     * (also it doesn't show any of the currently existing media in the modal window that pops up when you click the
-     * button to select media). Besides that, no special consideration should be required to make the media uploader
-     * appear, besides having this input displayed.
-     *
-     * @deprecated enqueue_js should be called automatically now
-     */
-    public static function enqueue_scripts()
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'EE_Admin_File_Uploader_Display_Strategy::enqueue_scripts() no longer needs to be called in order to display the admin uploader input correctly. This is handled now by EE_Admin_File_Uploader_Display_Strategy::enqueue_js() which is called automatically when enqueueing JS and CSS for the form',
-                'event_espresso'
-            ),
-            '4.9.8.rc.015'
-        );
-        wp_enqueue_media();
-        wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
-    }
+	/**
+	 * Its important this media only get enqueued AFTER init, but before the footer... where the
+	 * rest of our forms JS gets enqueued. Otherwise the JS gets enqueued fine, and loaded on the page fine,
+	 * but when you upload an image it gets uploaded fine to the server, but it doesn't display and reports an error
+	 * (also it doesn't show any of the currently existing media in the modal window that pops up when you click the
+	 * button to select media). Besides that, no special consideration should be required to make the media uploader
+	 * appear, besides having this input displayed.
+	 *
+	 * @deprecated enqueue_js should be called automatically now
+	 */
+	public static function enqueue_scripts()
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'EE_Admin_File_Uploader_Display_Strategy::enqueue_scripts() no longer needs to be called in order to display the admin uploader input correctly. This is handled now by EE_Admin_File_Uploader_Display_Strategy::enqueue_js() which is called automatically when enqueueing JS and CSS for the form',
+				'event_espresso'
+			),
+			'4.9.8.rc.015'
+		);
+		wp_enqueue_media();
+		wp_enqueue_script('media-upload');
+		wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
+	}
 
 
-    /**
-     * Enqueues the JS and CSS needed to display this input
-     */
-    public function enqueue_js()
-    {
-        wp_enqueue_media();
-        wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
-        parent::enqueue_js();
-    }
+	/**
+	 * Enqueues the JS and CSS needed to display this input
+	 */
+	public function enqueue_js()
+	{
+		wp_enqueue_media();
+		wp_enqueue_script('media-upload');
+		wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
+		parent::enqueue_js();
+	}
 
 
-    /**
-     * @return string of html to display the field
-     * @throws EE_Error
-     */
+	/**
+	 * @return string of html to display the field
+	 * @throws EE_Error
+	 */
 
-    public function display(): string
-    {
-        // the actual input
-        $input = '<input type="text" size="34" ';
-        $input .= 'name="' . $this->_input->html_name() . '" ';
-        $input .= $this->_input->html_class() !== ''
-            ? 'class="large-text ee_media_url ' . $this->_input->html_class() . '" '
-            : 'class="large-text ee_media_url" ';
-        $input .= 'value="' . $this->_input->raw_value_in_form() . '" ';
-        $input .= $this->_input->other_html_attributes();
-        $input .= $this->dataAttributesString($this->_input->dataAttributes());
-        $input .= '>';
-        // image uploader
-        $uploader = EEH_HTML::link(
-            '#',
-            '<span class="dashicons dashicons-format-image"></span>',
-            esc_html__('click to add an image', 'event_espresso'),
-            '',
-            'ee_media_upload button button--secondary button--icon-only'
-        );
-        // only attempt to show the image if it at least exists
-        $image = $this->_input->raw_value() && $this->src_exists($this->_input->raw_value())
-            ? EEH_HTML::br() . EEH_HTML::img(
-                $this->_input->raw_value(),
-                esc_html__('logo', 'event_espresso'),
-                '',
-                'ee_media_image'
-            )
-            : '';
-        // html string
-        return EEH_HTML::div(
-            $input . $uploader,
-            '',
-            'ee_media_uploader_area'
-        ) . $image;
-    }
+	public function display(): string
+	{
+		// the actual input
+		$input = '<input type="text" size="34" ';
+		$input .= 'name="' . $this->_input->html_name() . '" ';
+		$input .= $this->_input->html_class() !== ''
+			? 'class="large-text ee_media_url ' . $this->_input->html_class() . '" '
+			: 'class="large-text ee_media_url" ';
+		$input .= 'value="' . $this->_input->raw_value_in_form() . '" ';
+		$input .= $this->_input->other_html_attributes();
+		$input .= $this->dataAttributesString($this->_input->dataAttributes());
+		$input .= '>';
+		// image uploader
+		$uploader = EEH_HTML::link(
+			'#',
+			'<span class="dashicons dashicons-format-image"></span>',
+			esc_html__('click to add an image', 'event_espresso'),
+			'',
+			'ee_media_upload button button--secondary button--icon-only'
+		);
+		// only attempt to show the image if it at least exists
+		$image = $this->_input->raw_value() && $this->src_exists($this->_input->raw_value())
+			? EEH_HTML::br() . EEH_HTML::img(
+				$this->_input->raw_value(),
+				esc_html__('logo', 'event_espresso'),
+				'',
+				'ee_media_image'
+			)
+			: '';
+		// html string
+		return EEH_HTML::div(
+			$input . $uploader,
+			'',
+			'ee_media_uploader_area'
+		) . $image;
+	}
 
 
-    /**
-     * Asserts an image actually exists as quickly as possible by sending a HEAD
-     * request
-     *
-     * @param string $src
-     * @return boolean
-     */
-    protected function src_exists(string $src): bool
-    {
-        $results = wp_remote_head($src);
-        if (is_array($results) && ! $results instanceof WP_Error) {
-            return strpos($results['headers']['content-type'], "image") !== false;
-        }
-        return false;
-    }
+	/**
+	 * Asserts an image actually exists as quickly as possible by sending a HEAD
+	 * request
+	 *
+	 * @param string $src
+	 * @return boolean
+	 */
+	protected function src_exists(string $src): bool
+	{
+		$results = wp_remote_head($src);
+		if (is_array($results) && ! $results instanceof WP_Error) {
+			return strpos($results['headers']['content-type'], "image") !== false;
+		}
+		return false;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -32,7 +32,7 @@ 
         );
         wp_enqueue_media();
         wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
+        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL.'scripts/ee-media-uploader.js');
     }
 
 
@@ -43,7 +43,7 @@ 
     {
         wp_enqueue_media();
         wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL . 'scripts/ee-media-uploader.js');
+        wp_enqueue_script('ee-payments', EE_GLOBAL_ASSETS_URL.'scripts/ee-media-uploader.js');
         parent::enqueue_js();
     }
 
@@ -57,11 +57,11 @@ 
     {
         // the actual input
         $input = '<input type="text" size="34" ';
-        $input .= 'name="' . $this->_input->html_name() . '" ';
+        $input .= 'name="'.$this->_input->html_name().'" ';
         $input .= $this->_input->html_class() !== ''
-            ? 'class="large-text ee_media_url ' . $this->_input->html_class() . '" '
+            ? 'class="large-text ee_media_url '.$this->_input->html_class().'" '
             : 'class="large-text ee_media_url" ';
-        $input .= 'value="' . $this->_input->raw_value_in_form() . '" ';
+        $input .= 'value="'.$this->_input->raw_value_in_form().'" ';
         $input .= $this->_input->other_html_attributes();
         $input .= $this->dataAttributesString($this->_input->dataAttributes());
         $input .= '>';
@@ -75,7 +75,7 @@ 
         );
         // only attempt to show the image if it at least exists
         $image = $this->_input->raw_value() && $this->src_exists($this->_input->raw_value())
-            ? EEH_HTML::br() . EEH_HTML::img(
+            ? EEH_HTML::br().EEH_HTML::img(
                 $this->_input->raw_value(),
                 esc_html__('logo', 'event_espresso'),
                 '',
@@ -84,10 +84,10 @@ 
             : '';
         // html string
         return EEH_HTML::div(
-            $input . $uploader,
+            $input.$uploader,
             '',
             'ee_media_uploader_area'
-        ) . $image;
+        ).$image;
     }
 
 

core/libraries/form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php

Indentation +168 added lines, -168 removed lines

@@ -10,182 +10,182 @@
  */
 class EE_Checkbox_Dropdown_Selector_Display_Strategy extends EE_Compound_Input_Display_Strategy
 {
-    /**
-     * enqueues css and js, so that this can be called statically
-     */
-    public static function enqueue_styles_and_scripts()
-    {
-        wp_register_style(
-            'checkbox_dropdown_selector',
-            EE_GLOBAL_ASSETS_URL . 'css/checkbox_dropdown_selector.css',
-            ['espresso_default'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style(
-            'espresso_default',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-            ['dashicons'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('checkbox_dropdown_selector');
-        wp_register_script(
-            'checkbox_dropdown_selector',
-            EE_GLOBAL_ASSETS_URL . 'scripts/checkbox_dropdown_selector.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ticket_selector',
-            'eeDTS',
-            [
-                'maxChecked' => EE_Registry::instance()
-                    ->CFG
-                    ->template_settings
-                    ->EED_Ticket_Selector
-                    ->getDatetimeSelectorMaxChecked(),
-            ]
-        );
-        wp_enqueue_script('checkbox_dropdown_selector');
-    }
+	/**
+	 * enqueues css and js, so that this can be called statically
+	 */
+	public static function enqueue_styles_and_scripts()
+	{
+		wp_register_style(
+			'checkbox_dropdown_selector',
+			EE_GLOBAL_ASSETS_URL . 'css/checkbox_dropdown_selector.css',
+			['espresso_default'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style(
+			'espresso_default',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+			['dashicons'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('checkbox_dropdown_selector');
+		wp_register_script(
+			'checkbox_dropdown_selector',
+			EE_GLOBAL_ASSETS_URL . 'scripts/checkbox_dropdown_selector.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ticket_selector',
+			'eeDTS',
+			[
+				'maxChecked' => EE_Registry::instance()
+					->CFG
+					->template_settings
+					->EED_Ticket_Selector
+					->getDatetimeSelectorMaxChecked(),
+			]
+		);
+		wp_enqueue_script('checkbox_dropdown_selector');
+	}
 
 
-    /**
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
-     */
-    public function enqueue_js()
-    {
-        EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
-    }
+	/**
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
+	 */
+	public function enqueue_js()
+	{
+		EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
+	}
 
 
-    /**
-     * callback for Iframe::addStylesheets() child class methods
-     *
-     * @param array $iframe_css
-     * @return array
-     */
-    public function iframe_css(array $iframe_css): array
-    {
-        $iframe_css['checkbox_dropdown_selector'] = EE_GLOBAL_ASSETS_URL . 'css/checkbox_dropdown_selector.css';
-        return $iframe_css;
-    }
+	/**
+	 * callback for Iframe::addStylesheets() child class methods
+	 *
+	 * @param array $iframe_css
+	 * @return array
+	 */
+	public function iframe_css(array $iframe_css): array
+	{
+		$iframe_css['checkbox_dropdown_selector'] = EE_GLOBAL_ASSETS_URL . 'css/checkbox_dropdown_selector.css';
+		return $iframe_css;
+	}
 
 
-    /**
-     * callback for Iframe::addScripts() child class methods
-     *
-     * @param array $iframe_js
-     * @return array
-     */
-    public function iframe_js(array $iframe_js): array
-    {
-        $iframe_js['checkbox_dropdown_selector'] = EE_GLOBAL_ASSETS_URL . 'scripts/checkbox_dropdown_selector.js';
-        return $iframe_js;
-    }
+	/**
+	 * callback for Iframe::addScripts() child class methods
+	 *
+	 * @param array $iframe_js
+	 * @return array
+	 */
+	public function iframe_js(array $iframe_js): array
+	{
+		$iframe_js['checkbox_dropdown_selector'] = EE_GLOBAL_ASSETS_URL . 'scripts/checkbox_dropdown_selector.js';
+		return $iframe_js;
+	}
 
 
-    /**
-     * @return string of html to display the field
-     * @throws EE_Error
-     */
-    public function display(): string
-    {
-        $input              = $this->get_input();
-        $select_button_text = $input instanceof EE_Checkbox_Dropdown_Selector_Input
-            ? $input->select_button_text()
-            : '';
-        // $multi = count( $input->options() ) > 1 ? TRUE : FALSE;
-        $input->set_label_sizes();
-        $label_size_class = $input->get_label_size_class();
-        if (! is_array($input->raw_value()) && $input->raw_value() !== null) {
-            EE_Error::doing_it_wrong(
-                'EE_Checkbox_Display_Strategy::display()',
-                sprintf(
-                    esc_html__(
-                        'Input values for checkboxes should be an array of values, but the value for input "%1$s" is "%2$s". Please verify that the input name is exactly "%3$s"',
-                        'event_espresso'
-                    ),
-                    $input->html_id(),
-                    var_export($input->raw_value(), true),
-                    $input->html_name() . '[]'
-                ),
-                '4.8.1'
-            );
-        }
+	/**
+	 * @return string of html to display the field
+	 * @throws EE_Error
+	 */
+	public function display(): string
+	{
+		$input              = $this->get_input();
+		$select_button_text = $input instanceof EE_Checkbox_Dropdown_Selector_Input
+			? $input->select_button_text()
+			: '';
+		// $multi = count( $input->options() ) > 1 ? TRUE : FALSE;
+		$input->set_label_sizes();
+		$label_size_class = $input->get_label_size_class();
+		if (! is_array($input->raw_value()) && $input->raw_value() !== null) {
+			EE_Error::doing_it_wrong(
+				'EE_Checkbox_Display_Strategy::display()',
+				sprintf(
+					esc_html__(
+						'Input values for checkboxes should be an array of values, but the value for input "%1$s" is "%2$s". Please verify that the input name is exactly "%3$s"',
+						'event_espresso'
+					),
+					$input->html_id(),
+					var_export($input->raw_value(), true),
+					$input->html_name() . '[]'
+				),
+				'4.8.1'
+			);
+		}
 
 
-        $html = EEH_HTML::div('', '', 'checkbox-dropdown-selector-wrap-dv');
-        $html .= '<button id="' . $input->html_id() . '-btn"';
-        // $html .= ' name="' . $input->html_name() . '"';
-        $html            .= ' class="' . $input->html_class(
-        ) . ' checkbox-dropdown-selector-btn button--secondary button"';
-        $html            .= ' style="' . $input->html_style() . '"';
-        $html            .= ' data-target="' . $input->html_id() . '-options-dv"';
-        $html            .= ' ' . $input->other_html_attributes() . '>';
-        $html            .= '<span class="checkbox-dropdown-selector-selected-spn">';
-        $html            .= $select_button_text;
-        $html            .= '</span> <span class="dashicons dashicons-arrow-down"></span>';
-        $html            .= '</button>';
-        $html            .= EEH_HTML::div(
-            '',
-            $input->html_id() . '-options-dv',
-            'checkbox-dropdown-selector'
-        );
-        $html            .= EEH_HTML::link(
-            '',
-            '<span class="dashicons dashicons-no"></span>',
-            esc_html__('close datetime selector', 'event_espresso'),
-            '',
-            'close-espresso-notice'
-        );
-        $html            .= EEH_HTML::ul();
-        $input_raw_value = (array) $input->raw_value();
-        foreach ($input->options() as $value => $display_text) {
-            $html    .= EEH_HTML::li();
-            $value   = $input->get_normalization_strategy()->unnormalize_one($value);
-            $html_id = $this->get_sub_input_id($value);
-            $html    .= EEH_HTML::nl(0, 'checkbox');
-            $html    .= '<label for="'
-                        . $html_id
-                        . '" id="'
-                        . $html_id
-                        . '-lbl" class="ee-checkbox-label-after'
-                        . $label_size_class
-                        . '">';
-            $html    .= EEH_HTML::nl(1, 'checkbox');
-            $html    .= '<input type="checkbox"';
-            $html    .= ' name="' . $input->html_name() . '[]"';
-            $html    .= ' id="' . $html_id . '"';
-            $html    .= ' class="' . $input->html_class() . '-option"';
-            $html    .= $input->html_style()
-                ? ' style="' . $input->html_style() . '"'
-                : '';
-            $html    .= ' value="' . esc_attr($value) . '"';
-            $html    .= ! empty($input_raw_value) && in_array($value, $input_raw_value, true)
-                ? ' checked'
-                : '';
-            $html    .= ' ' . $this->_input->other_html_attributes();
-            $html    .= '>';
-            $html    .= '<span class="datetime-selector-option-text-spn">' . $display_text . '</span>';
-            $html    .= EEH_HTML::nl(-1, 'checkbox') . '</label>';
-            $html    .= EEH_HTML::lix();
-        }
-        $html .= EEH_HTML::ulx();
-        $html .= EEH_HTML::divx();
-        $html .= EEH_HTML::divx();
-        $html .= EEH_HTML::p(
-            apply_filters(
-                'FHEE__EE_Checkbox_Dropdown_Selector_Display_Strategy__display__html',
-                esc_html__(
-                    'To view additional ticket options, click the "Filter by Date" button and select more dates.',
-                    'event_espresso'
-                )
-            ),
-            $input->html_id() . '-date-time-filter-notice-pg',
-            'date-time-filter-notice-pg small-text lt-grey-text'
-        );
-        $html .= EEH_HTML::br();
-        return $html;
-    }
+		$html = EEH_HTML::div('', '', 'checkbox-dropdown-selector-wrap-dv');
+		$html .= '<button id="' . $input->html_id() . '-btn"';
+		// $html .= ' name="' . $input->html_name() . '"';
+		$html            .= ' class="' . $input->html_class(
+		) . ' checkbox-dropdown-selector-btn button--secondary button"';
+		$html            .= ' style="' . $input->html_style() . '"';
+		$html            .= ' data-target="' . $input->html_id() . '-options-dv"';
+		$html            .= ' ' . $input->other_html_attributes() . '>';
+		$html            .= '<span class="checkbox-dropdown-selector-selected-spn">';
+		$html            .= $select_button_text;
+		$html            .= '</span> <span class="dashicons dashicons-arrow-down"></span>';
+		$html            .= '</button>';
+		$html            .= EEH_HTML::div(
+			'',
+			$input->html_id() . '-options-dv',
+			'checkbox-dropdown-selector'
+		);
+		$html            .= EEH_HTML::link(
+			'',
+			'<span class="dashicons dashicons-no"></span>',
+			esc_html__('close datetime selector', 'event_espresso'),
+			'',
+			'close-espresso-notice'
+		);
+		$html            .= EEH_HTML::ul();
+		$input_raw_value = (array) $input->raw_value();
+		foreach ($input->options() as $value => $display_text) {
+			$html    .= EEH_HTML::li();
+			$value   = $input->get_normalization_strategy()->unnormalize_one($value);
+			$html_id = $this->get_sub_input_id($value);
+			$html    .= EEH_HTML::nl(0, 'checkbox');
+			$html    .= '<label for="'
+						. $html_id
+						. '" id="'
+						. $html_id
+						. '-lbl" class="ee-checkbox-label-after'
+						. $label_size_class
+						. '">';
+			$html    .= EEH_HTML::nl(1, 'checkbox');
+			$html    .= '<input type="checkbox"';
+			$html    .= ' name="' . $input->html_name() . '[]"';
+			$html    .= ' id="' . $html_id . '"';
+			$html    .= ' class="' . $input->html_class() . '-option"';
+			$html    .= $input->html_style()
+				? ' style="' . $input->html_style() . '"'
+				: '';
+			$html    .= ' value="' . esc_attr($value) . '"';
+			$html    .= ! empty($input_raw_value) && in_array($value, $input_raw_value, true)
+				? ' checked'
+				: '';
+			$html    .= ' ' . $this->_input->other_html_attributes();
+			$html    .= '>';
+			$html    .= '<span class="datetime-selector-option-text-spn">' . $display_text . '</span>';
+			$html    .= EEH_HTML::nl(-1, 'checkbox') . '</label>';
+			$html    .= EEH_HTML::lix();
+		}
+		$html .= EEH_HTML::ulx();
+		$html .= EEH_HTML::divx();
+		$html .= EEH_HTML::divx();
+		$html .= EEH_HTML::p(
+			apply_filters(
+				'FHEE__EE_Checkbox_Dropdown_Selector_Display_Strategy__display__html',
+				esc_html__(
+					'To view additional ticket options, click the "Filter by Date" button and select more dates.',
+					'event_espresso'
+				)
+			),
+			$input->html_id() . '-date-time-filter-notice-pg',
+			'date-time-filter-notice-pg small-text lt-grey-text'
+		);
+		$html .= EEH_HTML::br();
+		return $html;
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -17,20 +17,20 @@ 
     {
         wp_register_style(
             'checkbox_dropdown_selector',
-            EE_GLOBAL_ASSETS_URL . 'css/checkbox_dropdown_selector.css',
+            EE_GLOBAL_ASSETS_URL.'css/checkbox_dropdown_selector.css',
             ['espresso_default'],
             EVENT_ESPRESSO_VERSION
         );
         wp_register_style(
             'espresso_default',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso_default.css',
             ['dashicons'],
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_style('checkbox_dropdown_selector');
         wp_register_script(
             'checkbox_dropdown_selector',
-            EE_GLOBAL_ASSETS_URL . 'scripts/checkbox_dropdown_selector.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/checkbox_dropdown_selector.js',
             ['jquery'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -67,7 +67,7 @@ 
      */
     public function iframe_css(array $iframe_css): array
     {
-        $iframe_css['checkbox_dropdown_selector'] = EE_GLOBAL_ASSETS_URL . 'css/checkbox_dropdown_selector.css';
+        $iframe_css['checkbox_dropdown_selector'] = EE_GLOBAL_ASSETS_URL.'css/checkbox_dropdown_selector.css';
         return $iframe_css;
     }
 
@@ -80,7 +80,7 @@ 
      */
     public function iframe_js(array $iframe_js): array
     {
-        $iframe_js['checkbox_dropdown_selector'] = EE_GLOBAL_ASSETS_URL . 'scripts/checkbox_dropdown_selector.js';
+        $iframe_js['checkbox_dropdown_selector'] = EE_GLOBAL_ASSETS_URL.'scripts/checkbox_dropdown_selector.js';
         return $iframe_js;
     }
 
@@ -98,7 +98,7 @@ 
         // $multi = count( $input->options() ) > 1 ? TRUE : FALSE;
         $input->set_label_sizes();
         $label_size_class = $input->get_label_size_class();
-        if (! is_array($input->raw_value()) && $input->raw_value() !== null) {
+        if ( ! is_array($input->raw_value()) && $input->raw_value() !== null) {
             EE_Error::doing_it_wrong(
                 'EE_Checkbox_Display_Strategy::display()',
                 sprintf(
@@ -108,7 +108,7 @@ 
                     ),
                     $input->html_id(),
                     var_export($input->raw_value(), true),
-                    $input->html_name() . '[]'
+                    $input->html_name().'[]'
                 ),
                 '4.8.1'
             );
@@ -116,30 +116,30 @@ 
 
 
         $html = EEH_HTML::div('', '', 'checkbox-dropdown-selector-wrap-dv');
-        $html .= '<button id="' . $input->html_id() . '-btn"';
+        $html .= '<button id="'.$input->html_id().'-btn"';
         // $html .= ' name="' . $input->html_name() . '"';
-        $html            .= ' class="' . $input->html_class(
-        ) . ' checkbox-dropdown-selector-btn button--secondary button"';
-        $html            .= ' style="' . $input->html_style() . '"';
-        $html            .= ' data-target="' . $input->html_id() . '-options-dv"';
-        $html            .= ' ' . $input->other_html_attributes() . '>';
+        $html            .= ' class="'.$input->html_class(
+        ).' checkbox-dropdown-selector-btn button--secondary button"';
+        $html            .= ' style="'.$input->html_style().'"';
+        $html            .= ' data-target="'.$input->html_id().'-options-dv"';
+        $html            .= ' '.$input->other_html_attributes().'>';
         $html            .= '<span class="checkbox-dropdown-selector-selected-spn">';
         $html            .= $select_button_text;
         $html            .= '</span> <span class="dashicons dashicons-arrow-down"></span>';
         $html            .= '</button>';
         $html            .= EEH_HTML::div(
             '',
-            $input->html_id() . '-options-dv',
+            $input->html_id().'-options-dv',
             'checkbox-dropdown-selector'
         );
-        $html            .= EEH_HTML::link(
+        $html .= EEH_HTML::link(
             '',
             '<span class="dashicons dashicons-no"></span>',
             esc_html__('close datetime selector', 'event_espresso'),
             '',
             'close-espresso-notice'
         );
-        $html            .= EEH_HTML::ul();
+        $html .= EEH_HTML::ul();
         $input_raw_value = (array) $input->raw_value();
         foreach ($input->options() as $value => $display_text) {
             $html    .= EEH_HTML::li();
@@ -155,20 +155,20 @@ 
                         . '">';
             $html    .= EEH_HTML::nl(1, 'checkbox');
             $html    .= '<input type="checkbox"';
-            $html    .= ' name="' . $input->html_name() . '[]"';
-            $html    .= ' id="' . $html_id . '"';
-            $html    .= ' class="' . $input->html_class() . '-option"';
+            $html    .= ' name="'.$input->html_name().'[]"';
+            $html    .= ' id="'.$html_id.'"';
+            $html    .= ' class="'.$input->html_class().'-option"';
             $html    .= $input->html_style()
-                ? ' style="' . $input->html_style() . '"'
+                ? ' style="'.$input->html_style().'"'
                 : '';
-            $html    .= ' value="' . esc_attr($value) . '"';
+            $html    .= ' value="'.esc_attr($value).'"';
             $html    .= ! empty($input_raw_value) && in_array($value, $input_raw_value, true)
                 ? ' checked'
                 : '';
-            $html    .= ' ' . $this->_input->other_html_attributes();
+            $html    .= ' '.$this->_input->other_html_attributes();
             $html    .= '>';
-            $html    .= '<span class="datetime-selector-option-text-spn">' . $display_text . '</span>';
-            $html    .= EEH_HTML::nl(-1, 'checkbox') . '</label>';
+            $html    .= '<span class="datetime-selector-option-text-spn">'.$display_text.'</span>';
+            $html    .= EEH_HTML::nl(-1, 'checkbox').'</label>';
             $html    .= EEH_HTML::lix();
         }
         $html .= EEH_HTML::ulx();
@@ -182,7 +182,7 @@ 
                     'event_espresso'
                 )
             ),
-            $input->html_id() . '-date-time-filter-notice-pg',
+            $input->html_id().'-date-time-filter-notice-pg',
             'date-time-filter-notice-pg small-text lt-grey-text'
         );
         $html .= EEH_HTML::br();

core/libraries/form_sections/payment_methods/EE_Billing_Attendee_Info_Form.form.php

Indentation +214 added lines, -214 removed lines

@@ -13,229 +13,229 @@
  */
 class EE_Billing_Attendee_Info_Form extends EE_Billing_Info_Form
 {
-    /**
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param array             $options_array @see EE_Form_Section_Proper::__construct()
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Payment_Method $payment_method, $options_array = [])
-    {
-        $options_array['subsections'] = array_merge(
-            [
-                'first_name' => new EE_Text_Input(
-                    [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-fname',
-                        'html_label_text' => esc_html__('First Name', 'event_espresso'),
-                    ]
-                ),
-                'last_name'  => new EE_Text_Input(
-                    [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-lname',
-                        'html_label_text' => esc_html__('Last Name', 'event_espresso'),
-                    ]
-                ),
-                'email'      => new EE_Email_Input(
-                    [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-email',
-                        'html_label_text' => esc_html__('Email', 'event_espresso'),
-                    ]
-                ),
-                'address'    => new EE_Text_Input(
-                    [
-                        'html_label_text' => esc_html__('Address', 'event_espresso'),
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-address',
-                    ]
-                ),
-                'address2'   => new EE_Text_Input(
-                    [
-                        'html_label_text' => esc_html__('Address 2', 'event_espresso'),
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-address2',
-                    ]
-                ),
-                'city'       => new EE_Text_Input(
-                    [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-city',
-                        'html_label_text' => esc_html__('City', 'event_espresso'),
-                    ]
-                ),
-                'state'      => apply_filters(
-                    'FHEE__EE_Billing_Attendee_Info_Form__state_field',
-                    new EE_State_Select_Input(
-                        null,
-                        [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-state',
-                        'html_label_text' => esc_html__('State', 'event_espresso'),
-                        ]
-                    )
-                ),
-                'country'    => apply_filters(
-                    'FHEE__EE_Billing_Attendee_Info_Form__country_field',
-                    new EE_Country_Select_Input(
-                        null,
-                        [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-country',
-                        'html_label_text' => esc_html__('Country', 'event_espresso'),
-                        ]
-                    )
-                ),
-                'zip'        => new EE_Text_Input(
-                    [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-zip',
-                        'html_label_text' => esc_html__('Zip', 'event_espresso'),
-                    ]
-                ),
-                'phone'      => new EE_Text_Input(
-                    [
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-phone',
-                        'html_label_text' => esc_html__('Phone', 'event_espresso'),
-                    ]
-                ),
-            ],
-            $options_array['subsections'] ?? []
-        );
+	/**
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param array             $options_array @see EE_Form_Section_Proper::__construct()
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Payment_Method $payment_method, $options_array = [])
+	{
+		$options_array['subsections'] = array_merge(
+			[
+				'first_name' => new EE_Text_Input(
+					[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-fname',
+						'html_label_text' => esc_html__('First Name', 'event_espresso'),
+					]
+				),
+				'last_name'  => new EE_Text_Input(
+					[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-lname',
+						'html_label_text' => esc_html__('Last Name', 'event_espresso'),
+					]
+				),
+				'email'      => new EE_Email_Input(
+					[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-email',
+						'html_label_text' => esc_html__('Email', 'event_espresso'),
+					]
+				),
+				'address'    => new EE_Text_Input(
+					[
+						'html_label_text' => esc_html__('Address', 'event_espresso'),
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-address',
+					]
+				),
+				'address2'   => new EE_Text_Input(
+					[
+						'html_label_text' => esc_html__('Address 2', 'event_espresso'),
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-address2',
+					]
+				),
+				'city'       => new EE_Text_Input(
+					[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-city',
+						'html_label_text' => esc_html__('City', 'event_espresso'),
+					]
+				),
+				'state'      => apply_filters(
+					'FHEE__EE_Billing_Attendee_Info_Form__state_field',
+					new EE_State_Select_Input(
+						null,
+						[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-state',
+						'html_label_text' => esc_html__('State', 'event_espresso'),
+						]
+					)
+				),
+				'country'    => apply_filters(
+					'FHEE__EE_Billing_Attendee_Info_Form__country_field',
+					new EE_Country_Select_Input(
+						null,
+						[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-country',
+						'html_label_text' => esc_html__('Country', 'event_espresso'),
+						]
+					)
+				),
+				'zip'        => new EE_Text_Input(
+					[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-zip',
+						'html_label_text' => esc_html__('Zip', 'event_espresso'),
+					]
+				),
+				'phone'      => new EE_Text_Input(
+					[
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-phone',
+						'html_label_text' => esc_html__('Phone', 'event_espresso'),
+					]
+				),
+			],
+			$options_array['subsections'] ?? []
+		);
 
-        parent::__construct($payment_method, $options_array);
-    }
+		parent::__construct($payment_method, $options_array);
+	}
 
 
-    /**
-     * Sets the defaults for the billing form according to the attendee's details
-     *
-     * @param EE_Attendee $attendee
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function populate_from_attendee(EE_Attendee $attendee)
-    {
-        /** @var $attendee EE_Attendee */
-        $attendee = EEM_Attendee::instance()->ensure_is_obj($attendee);
-        $this->populate_defaults(
-            apply_filters(
-                'FHEE__EE_Billing_Attendee_Info_Form__populate_from_attendee',
-                [
-                    'first_name' => $attendee->fname(),
-                    'last_name'  => $attendee->lname(),
-                    'email'      => $attendee->email(),
-                    'address'    => $attendee->address(),
-                    'address2'   => $attendee->address2(),
-                    'city'       => $attendee->city(),
-                    'state'      => $this->getAttendeeStateValueForForm($attendee),
-                    'country'    => $attendee->country_ID(),
-                    'zip'        => $attendee->zip(),
-                    'phone'      => $attendee->phone(),
-                ],
-                $attendee,
-                $this
-            )
-        );
-    }
+	/**
+	 * Sets the defaults for the billing form according to the attendee's details
+	 *
+	 * @param EE_Attendee $attendee
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function populate_from_attendee(EE_Attendee $attendee)
+	{
+		/** @var $attendee EE_Attendee */
+		$attendee = EEM_Attendee::instance()->ensure_is_obj($attendee);
+		$this->populate_defaults(
+			apply_filters(
+				'FHEE__EE_Billing_Attendee_Info_Form__populate_from_attendee',
+				[
+					'first_name' => $attendee->fname(),
+					'last_name'  => $attendee->lname(),
+					'email'      => $attendee->email(),
+					'address'    => $attendee->address(),
+					'address2'   => $attendee->address2(),
+					'city'       => $attendee->city(),
+					'state'      => $this->getAttendeeStateValueForForm($attendee),
+					'country'    => $attendee->country_ID(),
+					'zip'        => $attendee->zip(),
+					'phone'      => $attendee->phone(),
+				],
+				$attendee,
+				$this
+			)
+		);
+	}
 
 
-    /**
-     * Gets the default value to use for the billing form's state value.
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.10.0.p
-     */
-    protected function getAttendeeStateValueForForm(EE_Attendee $attendee): string
-    {
-        // If the state input was removed, just return a blank string.
-        if (! $this->has_subsection('state')) {
-            return '';
-        }
-        $state_input = $this->get_input('state', false);
-        if ($state_input instanceof EE_State_Select_Input) {
-            $state_field_to_use = $state_input->valueFieldName();
-        } else {
-            $state_field_to_use = 'STA_ID';
-        }
-        switch ($state_field_to_use) {
-            case 'STA_abbrev':
-                $state_value = $attendee->state_abbrev();
-                break;
-            case 'STA_name':
-                $state_value = $attendee->state_name();
-                break;
-            default:
-                $state_value = $attendee->state_ID();
-        }
-        return $state_value;
-    }
+	/**
+	 * Gets the default value to use for the billing form's state value.
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.10.0.p
+	 */
+	protected function getAttendeeStateValueForForm(EE_Attendee $attendee): string
+	{
+		// If the state input was removed, just return a blank string.
+		if (! $this->has_subsection('state')) {
+			return '';
+		}
+		$state_input = $this->get_input('state', false);
+		if ($state_input instanceof EE_State_Select_Input) {
+			$state_field_to_use = $state_input->valueFieldName();
+		} else {
+			$state_field_to_use = 'STA_ID';
+		}
+		switch ($state_field_to_use) {
+			case 'STA_abbrev':
+				$state_value = $attendee->state_abbrev();
+				break;
+			case 'STA_name':
+				$state_value = $attendee->state_name();
+				break;
+			default:
+				$state_value = $attendee->state_ID();
+		}
+		return $state_value;
+	}
 
 
-    /**
-     * copy_billing_form_data_to_attendee
-     * copies info from the billing form to the attendee's details
-     *
-     * @param EE_Attendee $attendee the attendee object to copy details to
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    public function copy_billing_form_data_to_attendee(EE_Attendee $attendee): EE_Attendee
-    {
-        // grab billing form data
-        $data = $this->valid_data();
+	/**
+	 * copy_billing_form_data_to_attendee
+	 * copies info from the billing form to the attendee's details
+	 *
+	 * @param EE_Attendee $attendee the attendee object to copy details to
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	public function copy_billing_form_data_to_attendee(EE_Attendee $attendee): EE_Attendee
+	{
+		// grab billing form data
+		$data = $this->valid_data();
 
-        $fields_and_setters = [
-            'first_name' => 'set_fname',
-            'last_name'  => 'set_lname',
-            'email'      => 'set_email',
-            'address'    => 'set_address',
-            'address2'   => 'set_address2',
-            'city'       => 'set_city',
-            'state'      => 'set_state',
-            'country'    => 'set_country',
-            'zip'        => 'set_zip',
-            'phone'      => 'set_phone',
-        ];
-        foreach ($fields_and_setters as $field => $setter) {
-            if (! empty($data[ $field ]) && method_exists($attendee, $setter)) {
-                $attendee->{$setter}($data[ $field ]);
-            }
-        }
-        return $attendee;
-    }
+		$fields_and_setters = [
+			'first_name' => 'set_fname',
+			'last_name'  => 'set_lname',
+			'email'      => 'set_email',
+			'address'    => 'set_address',
+			'address2'   => 'set_address2',
+			'city'       => 'set_city',
+			'state'      => 'set_state',
+			'country'    => 'set_country',
+			'zip'        => 'set_zip',
+			'phone'      => 'set_phone',
+		];
+		foreach ($fields_and_setters as $field => $setter) {
+			if (! empty($data[ $field ]) && method_exists($attendee, $setter)) {
+				$attendee->{$setter}($data[ $field ]);
+			}
+		}
+		return $attendee;
+	}
 
 
-    /**
-     * create_attendee_from_billing_form_data
-     * uses info from the billing form to create a new attendee
-     *
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_attendee_from_billing_form_data()
-    {
-        // grab billing form data
-        $data = $this->valid_data();
-        return EE_Attendee::new_instance(
-            [
-                'ATT_fname'    => ! empty($data['first_name']) ? $data['first_name'] : '',
-                'ATT_lname'    => ! empty($data['last_name']) ? $data['last_name'] : '',
-                'ATT_email'    => ! empty($data['email']) ? $data['email'] : '',
-                'ATT_address'  => ! empty($data['address']) ? $data['address'] : '',
-                'ATT_address2' => ! empty($data['address2']) ? $data['address2'] : '',
-                'ATT_city'     => ! empty($data['city']) ? $data['city'] : '',
-                'STA_ID'       => ! empty($data['state']) ? $data['state'] : '',
-                'CNT_ISO'      => ! empty($data['country']) ? $data['country'] : '',
-                'ATT_zip'      => ! empty($data['zip']) ? $data['zip'] : '',
-                'ATT_phone'    => ! empty($data['phone']) ? $data['phone'] : '',
-            ]
-        );
-    }
+	/**
+	 * create_attendee_from_billing_form_data
+	 * uses info from the billing form to create a new attendee
+	 *
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_attendee_from_billing_form_data()
+	{
+		// grab billing form data
+		$data = $this->valid_data();
+		return EE_Attendee::new_instance(
+			[
+				'ATT_fname'    => ! empty($data['first_name']) ? $data['first_name'] : '',
+				'ATT_lname'    => ! empty($data['last_name']) ? $data['last_name'] : '',
+				'ATT_email'    => ! empty($data['email']) ? $data['email'] : '',
+				'ATT_address'  => ! empty($data['address']) ? $data['address'] : '',
+				'ATT_address2' => ! empty($data['address2']) ? $data['address2'] : '',
+				'ATT_city'     => ! empty($data['city']) ? $data['city'] : '',
+				'STA_ID'       => ! empty($data['state']) ? $data['state'] : '',
+				'CNT_ISO'      => ! empty($data['country']) ? $data['country'] : '',
+				'ATT_zip'      => ! empty($data['zip']) ? $data['zip'] : '',
+				'ATT_phone'    => ! empty($data['phone']) ? $data['phone'] : '',
+			]
+		);
+	}
 }
 // End of file EE_Billing_Attendee_Info_Form.form.php

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

Indentation +1535 added lines, -1535 removed lines

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

Spacing +38 added lines, -38 removed lines

@@ -112,8 +112,8 @@ 
             // AND we are going to make sure they're in that specified order
             $reordered_subsections = array();
             foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[ $input_name ])) {
-                    $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
+                if (isset($this->_subsections[$input_name])) {
+                    $reordered_subsections[$input_name] = $this->_subsections[$input_name];
                 }
             }
             $this->_subsections = $reordered_subsections;
@@ -125,7 +125,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);
@@ -317,7 +317,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();
             }
         }
@@ -434,11 +434,11 @@ 
     public function populate_defaults($default_data)
     {
         foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[ $subsection_name ])) {
+            if (isset($default_data[$subsection_name])) {
                 if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[ $subsection_name ]);
+                    $subsection->set_default($default_data[$subsection_name]);
                 } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[ $subsection_name ]);
+                    $subsection->populate_defaults($default_data[$subsection_name]);
                 }
             }
         }
@@ -453,7 +453,7 @@ 
      */
     public function subsection_exists($name)
     {
-        return isset($this->_subsections[ $name ]) ? true : false;
+        return isset($this->_subsections[$name]) ? true : false;
     }
 
 
@@ -475,7 +475,7 @@ 
         if ($require_construction_to_be_finalized) {
             $this->ensure_construct_finalized_called();
         }
-        return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
+        return $this->subsection_exists($name) ? $this->_subsections[$name] : null;
     }
 
 
@@ -490,7 +490,7 @@ 
         $validatable_subsections = array();
         foreach ($this->subsections() as $name => $obj) {
             if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[ $name ] = $obj;
+                $validatable_subsections[$name] = $obj;
             }
         }
         return $validatable_subsections;
@@ -517,7 +517,7 @@ 
             $name,
             $require_construction_to_be_finalized
         );
-        if (! $subsection instanceof EE_Form_Input_Base) {
+        if ( ! $subsection instanceof EE_Form_Input_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -554,7 +554,7 @@ 
             $name,
             $require_construction_to_be_finalized
         );
-        if (! $subsection instanceof EE_Form_Section_Proper) {
+        if ( ! $subsection instanceof EE_Form_Section_Proper) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -594,7 +594,7 @@ 
     public function is_valid()
     {
         if ($this->is_valid === null) {
-            if (! $this->has_received_submission()) {
+            if ( ! $this->has_received_submission()) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -604,14 +604,14 @@ 
                     )
                 );
             }
-            if (! parent::is_valid()) {
+            if ( ! parent::is_valid()) {
                 $this->is_valid = false;
             } else {
                 // ok so no general errors to this entire form section.
                 // so let's check the subsections, but only set errors if that hasn't been done yet
                 $this->is_valid = true;
                 foreach ($this->get_validatable_subsections() as $subsection) {
-                    if (! $subsection->is_valid()) {
+                    if ( ! $subsection->is_valid()) {
                         $this->is_valid = false;
                     }
                 }
@@ -628,7 +628,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;
@@ -718,7 +718,7 @@ 
     {
         wp_register_script(
             'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . '/form_section_validation.js',
+            EE_GLOBAL_ASSETS_URL.'scripts'.'/form_section_validation.js',
             array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -762,13 +762,13 @@ 
         // we only want to localize vars ONCE for the entire form,
         // so if the form section doesn't have a parent, then it must be the top dog
         if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
+            EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array(
                 'form_section_id'  => $this->html_id(true),
                 'validation_rules' => $this->get_jquery_validation_rules(),
                 'other_data'       => $this->get_other_js_data(),
                 'errors'           => $this->subsection_validation_errors_by_html_name(),
             );
-            EE_Form_Section_Proper::$_scripts_localized                                = true;
+            EE_Form_Section_Proper::$_scripts_localized = true;
         }
     }
 
@@ -803,7 +803,7 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection->html_name() ] = $subsection;
+                $inputs[$subsection->html_name()] = $subsection;
             } elseif ($subsection instanceof EE_Form_Section_Proper) {
                 $inputs += $subsection->inputs_in_subsections();
             }
@@ -826,7 +826,7 @@ 
         $errors = array();
         foreach ($inputs as $form_input) {
             if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+                $errors[$form_input->html_name()] = $form_input->get_validation_error_string();
             }
         }
         return $errors;
@@ -849,7 +849,7 @@ 
         $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
             ? EE_Registry::instance()->CFG->registration->email_validation_level
             : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
+        EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level;
         wp_enqueue_script('ee_form_section_validation');
         wp_localize_script(
             'ee_form_section_validation',
@@ -866,7 +866,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();
         }
     }
@@ -962,8 +962,8 @@ 
         // reset the cache of whether this form is valid or not- we're re-validating it now
         $this->is_valid = null;
         foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+            if (method_exists($this, '_validate_'.$subsection_name)) {
+                call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection));
             }
             $subsection->_validate();
         }
@@ -981,9 +981,9 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[ $subsection_name ] = $subsection->valid_data();
+                $inputs[$subsection_name] = $subsection->valid_data();
             } elseif ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection->normalized_value();
+                $inputs[$subsection_name] = $subsection->normalized_value();
             }
         }
         return $inputs;
@@ -1001,7 +1001,7 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection;
+                $inputs[$subsection_name] = $subsection;
             }
         }
         return $inputs;
@@ -1019,7 +1019,7 @@ 
         $form_sections = array();
         foreach ($this->subsections() as $name => $obj) {
             if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[ $name ] = $obj;
+                $form_sections[$name] = $obj;
             }
         }
         return $form_sections;
@@ -1126,7 +1126,7 @@ 
         $input_values = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[ $subsection_name ] = $pretty
+                $input_values[$subsection_name] = $pretty
                     ? $subsection->pretty_value()
                     : $subsection->normalized_value();
             } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
@@ -1138,7 +1138,7 @@ 
                 if ($flatten) {
                     $input_values = array_merge($input_values, $subform_input_values);
                 } else {
-                    $input_values[ $subsection_name ] = $subform_input_values;
+                    $input_values[$subsection_name] = $subform_input_values;
                 }
             }
         }
@@ -1166,7 +1166,7 @@ 
             if ($subsection instanceof EE_Form_Input_Base) {
                 // is this input part of an array of inputs?
                 if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name  = EEH_Array::convert_array_values_to_keys(
+                    $full_input_name = EEH_Array::convert_array_values_to_keys(
                         explode(
                             '[',
                             str_replace(']', '', $subsection->html_name())
@@ -1175,7 +1175,7 @@ 
                     );
                     $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
                 } else {
-                    $submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
+                    $submitted_values[$subsection->html_name()] = $subsection->raw_value();
                 }
             } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
                 $subform_input_values = $subsection->submitted_values($include_subforms);
@@ -1210,7 +1210,7 @@ 
     public function exclude(array $inputs_to_exclude = array())
     {
         foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[ $input_to_exclude_name ]);
+            unset($this->_subsections[$input_to_exclude_name]);
         }
     }
 
@@ -1253,7 +1253,7 @@ 
     public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
     {
         foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
+            if ( ! $subsection instanceof EE_Form_Section_Base) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -1268,7 +1268,7 @@ 
                     __FUNCTION__,
                     __LINE__
                 );
-                unset($new_subsections[ $subsection_name ]);
+                unset($new_subsections[$subsection_name]);
             }
         }
         $this->_subsections = EEH_Array::insert_into_array(
@@ -1384,7 +1384,7 @@ 
     public function html_name_prefix()
     {
         if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+            return $this->parent_section()->html_name_prefix().'['.$this->name().']';
         }
         return $this->name();
     }
@@ -1424,7 +1424,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }