Completed
Branch yet-another-batch-of-ui-fixes (371f49)
by
unknown
30:27 queued 22:46
created
validation/EE_Model_Matching_Query_Validation_Strategy.strategy.php 2 patches
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -33,7 +33,7 @@  discard block
 block discarded – undo
33 33
      */
34 34
     public function __construct($validation_error_message = null, $model_name = '', $query_params = array(), $input_field_name = '')
35 35
     {
36
-        if (! EE_Registry::instance()->is_model_name($model_name)) {
36
+        if ( ! EE_Registry::instance()->is_model_name($model_name)) {
37 37
             throw new EE_Error(sprintf(esc_html__('You must provide a valid model object ', 'event_espresso'), $model_name));
38 38
         }
39 39
         $this->_model = EE_Registry::instance()->load_model($model_name);
@@ -59,8 +59,8 @@  discard block
 block discarded – undo
59 59
             return true;
60 60
         }
61 61
         $combined_query_params = $this->get_query_params();
62
-        $combined_query_params[0][ $this->treat_input_as_field() ] = $normalized_value;
63
-        if (! $this->get_model()->exists($combined_query_params)) {
62
+        $combined_query_params[0][$this->treat_input_as_field()] = $normalized_value;
63
+        if ( ! $this->get_model()->exists($combined_query_params)) {
64 64
             throw new EE_Validation_Error($this->get_validation_error_message(), 'no_matching_model_object');
65 65
         }
66 66
     }
Please login to merge, or discard this patch.
Indentation   +71 added lines, -71 removed lines patch added patch discarded remove patch
@@ -13,86 +13,86 @@
 block discarded – undo
13 13
  */
14 14
 class EE_Model_Matching_Query_Validation_Strategy extends EE_Validation_Strategy_Base
15 15
 {
16
-    /**
17
-     *
18
-     * @var EEM_Base
19
-     */
20
-    protected $_model;
21
-    protected $_query_params;
22
-    protected $_input_field_name;
16
+	/**
17
+	 *
18
+	 * @var EEM_Base
19
+	 */
20
+	protected $_model;
21
+	protected $_query_params;
22
+	protected $_input_field_name;
23 23
 
24 24
 
25 25
 
26
-    /**
27
-     * @param string $validation_error_message
28
-     * @param string $model_name  name of an EEM_Base model
29
-     * @param array  $query_params     @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
30
-     * @param string $input_field_name the input will be treated as this field's value
31
-     * @throws \EE_Error
32
-     */
33
-    public function __construct($validation_error_message = null, $model_name = '', $query_params = array(), $input_field_name = '')
34
-    {
35
-        if (! EE_Registry::instance()->is_model_name($model_name)) {
36
-            throw new EE_Error(sprintf(esc_html__('You must provide a valid model object ', 'event_espresso'), $model_name));
37
-        }
38
-        $this->_model = EE_Registry::instance()->load_model($model_name);
39
-        $this->_query_params = $query_params;
40
-        if (empty($input_field_name)) {
41
-            $input_field_name = $this->_model->primary_key_name();
42
-        }
43
-        $this->_input_field_name = $input_field_name;
44
-        parent::__construct($validation_error_message);
45
-    }
26
+	/**
27
+	 * @param string $validation_error_message
28
+	 * @param string $model_name  name of an EEM_Base model
29
+	 * @param array  $query_params     @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
30
+	 * @param string $input_field_name the input will be treated as this field's value
31
+	 * @throws \EE_Error
32
+	 */
33
+	public function __construct($validation_error_message = null, $model_name = '', $query_params = array(), $input_field_name = '')
34
+	{
35
+		if (! EE_Registry::instance()->is_model_name($model_name)) {
36
+			throw new EE_Error(sprintf(esc_html__('You must provide a valid model object ', 'event_espresso'), $model_name));
37
+		}
38
+		$this->_model = EE_Registry::instance()->load_model($model_name);
39
+		$this->_query_params = $query_params;
40
+		if (empty($input_field_name)) {
41
+			$input_field_name = $this->_model->primary_key_name();
42
+		}
43
+		$this->_input_field_name = $input_field_name;
44
+		parent::__construct($validation_error_message);
45
+	}
46 46
 
47 47
 
48 48
 
49
-    /**
50
-     * @param $normalized_value
51
-     * @return bool|void
52
-     * @throws \EE_Error
53
-     * @throws \EE_Validation_Error
54
-     */
55
-    public function validate($normalized_value)
56
-    {
57
-        if (empty($normalized_value)) {
58
-            return true;
59
-        }
60
-        $combined_query_params = $this->get_query_params();
61
-        $combined_query_params[0][ $this->treat_input_as_field() ] = $normalized_value;
62
-        if (! $this->get_model()->exists($combined_query_params)) {
63
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'no_matching_model_object');
64
-        }
65
-    }
49
+	/**
50
+	 * @param $normalized_value
51
+	 * @return bool|void
52
+	 * @throws \EE_Error
53
+	 * @throws \EE_Validation_Error
54
+	 */
55
+	public function validate($normalized_value)
56
+	{
57
+		if (empty($normalized_value)) {
58
+			return true;
59
+		}
60
+		$combined_query_params = $this->get_query_params();
61
+		$combined_query_params[0][ $this->treat_input_as_field() ] = $normalized_value;
62
+		if (! $this->get_model()->exists($combined_query_params)) {
63
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'no_matching_model_object');
64
+		}
65
+	}
66 66
 
67
-    /**
68
-     * Gets the model used for querying
69
-     * @return EEM_Base
70
-     */
71
-    public function get_model()
72
-    {
73
-        return $this->_model;
74
-    }
67
+	/**
68
+	 * Gets the model used for querying
69
+	 * @return EEM_Base
70
+	 */
71
+	public function get_model()
72
+	{
73
+		return $this->_model;
74
+	}
75 75
 
76
-    /**
77
-     * Returns query params used for model query
78
-     * @return array
79
-     */
80
-    public function get_query_params()
81
-    {
82
-        return (array) $this->_query_params;
83
-    }
76
+	/**
77
+	 * Returns query params used for model query
78
+	 * @return array
79
+	 */
80
+	public function get_query_params()
81
+	{
82
+		return (array) $this->_query_params;
83
+	}
84 84
 
85
-    /**
86
-     * Gets the name of the field that will be used for lookup.
87
-     * eg it could be "EVT_name", meaning that if there is a model object in
88
-     * the database that has that event name, and matching the other query parameters
89
-     * on this strategy, the input will pass validation server-side
90
-     * @return string
91
-     */
92
-    public function treat_input_as_field()
93
-    {
94
-        return $this->_input_field_name;
95
-    }
85
+	/**
86
+	 * Gets the name of the field that will be used for lookup.
87
+	 * eg it could be "EVT_name", meaning that if there is a model object in
88
+	 * the database that has that event name, and matching the other query parameters
89
+	 * on this strategy, the input will pass validation server-side
90
+	 * @return string
91
+	 */
92
+	public function treat_input_as_field()
93
+	{
94
+		return $this->_input_field_name;
95
+	}
96 96
 }
97 97
 
98 98
 // End of file EE_FUll_HTML_Validation_Strategy.strategy.php
Please login to merge, or discard this patch.
strategies/validation/EE_Plaintext_Validation_Strategy.strategy.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -19,7 +19,7 @@
 block discarded – undo
19 19
      */
20 20
     public function __construct($validation_error_message = null)
21 21
     {
22
-        if (! $validation_error_message) {
22
+        if ( ! $validation_error_message) {
23 23
             $validation_error_message = esc_html__("HTML tags are not permitted in this field", "event_espresso");
24 24
         }
25 25
         parent::__construct($validation_error_message);
Please login to merge, or discard this patch.
Indentation   +22 added lines, -22 removed lines patch added patch discarded remove patch
@@ -13,27 +13,27 @@
 block discarded – undo
13 13
  */
14 14
 class EE_Plaintext_Validation_Strategy extends EE_Validation_Strategy_Base
15 15
 {
16
-    /**
17
-     * @param null $validation_error_message
18
-     */
19
-    public function __construct($validation_error_message = null)
20
-    {
21
-        if (! $validation_error_message) {
22
-            $validation_error_message = esc_html__("HTML tags are not permitted in this field", "event_espresso");
23
-        }
24
-        parent::__construct($validation_error_message);
25
-    }
16
+	/**
17
+	 * @param null $validation_error_message
18
+	 */
19
+	public function __construct($validation_error_message = null)
20
+	{
21
+		if (! $validation_error_message) {
22
+			$validation_error_message = esc_html__("HTML tags are not permitted in this field", "event_espresso");
23
+		}
24
+		parent::__construct($validation_error_message);
25
+	}
26 26
 
27
-    /**
28
-     * @param $normalized_value
29
-     * @throws \EE_Validation_Error
30
-     */
31
-    public function validate($normalized_value)
32
-    {
33
-        $no_tags = wp_strip_all_tags($normalized_value);
34
-        if (strlen($no_tags) < strlen(trim($normalized_value))) {
35
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'no_html_tags');
36
-        }
37
-        parent::validate($normalized_value);
38
-    }
27
+	/**
28
+	 * @param $normalized_value
29
+	 * @throws \EE_Validation_Error
30
+	 */
31
+	public function validate($normalized_value)
32
+	{
33
+		$no_tags = wp_strip_all_tags($normalized_value);
34
+		if (strlen($no_tags) < strlen(trim($normalized_value))) {
35
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'no_html_tags');
36
+		}
37
+		parent::validate($normalized_value);
38
+	}
39 39
 }
Please login to merge, or discard this patch.
validation/EE_Conditionally_Required_Validation_Strategy.strategy.php 2 patches
Spacing   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -28,7 +28,7 @@  discard block
 block discarded – undo
28 28
      */
29 29
     public function __construct($validation_error_message = null, $requirement_conditions = array())
30 30
     {
31
-        if (! $validation_error_message) {
31
+        if ( ! $validation_error_message) {
32 32
             $validation_error_message = esc_html__("This field is required.", "event_espresso");
33 33
         }
34 34
         $this->set_requirement_conditions($requirement_conditions);
@@ -116,7 +116,7 @@  discard block
 block discarded – undo
116 116
     {
117 117
         $requirement_value = '';
118 118
         $conditions = $this->get_requirement_conditions();
119
-        if (! is_array($conditions)) {
119
+        if ( ! is_array($conditions)) {
120 120
             EE_Error::throw_exception_if_debugging(
121 121
                 sprintf(
122 122
                     esc_html__('Input requirement conditions must be an array. You provided %1$s', 'event_espresso'),
@@ -141,7 +141,7 @@  discard block
 block discarded – undo
141 141
         }
142 142
         foreach ($conditions as $input_path => $op_and_value) {
143 143
             $input = $this->_input->find_section_from_path($input_path);
144
-            if (! $input instanceof EE_Form_Input_Base) {
144
+            if ( ! $input instanceof EE_Form_Input_Base) {
145 145
                 EE_Error::throw_exception_if_debugging(
146 146
                     sprintf(
147 147
                         esc_html__('Error encountered while setting requirement condition for input %1$s. The path %2$s does not correspond to a valid input', 'event_espresso'),
@@ -154,9 +154,9 @@  discard block
 block discarded – undo
154 154
                 );
155 155
                 return false;
156 156
             }
157
-            list( $op, $value ) = $this->_validate_op_and_value($op_and_value);
157
+            list($op, $value) = $this->_validate_op_and_value($op_and_value);
158 158
             // ok now the jquery dependency expression depends on the input's display strategy.
159
-            if (! $input->get_display_strategy() instanceof EE_Select_Display_Strategy) {
159
+            if ( ! $input->get_display_strategy() instanceof EE_Select_Display_Strategy) {
160 160
                 EE_Error::throw_exception_if_debugging(
161 161
                     sprintf(
162 162
                         esc_html__('Required Validation Strategy can only depend on another input which uses the EE_Select_Display_Strategy, but you specified a field "%1$s" that uses display strategy "%2$s". If you need others, please add support for it! The related input is %3$s', 'event_espresso'),
@@ -169,7 +169,7 @@  discard block
 block discarded – undo
169 169
                     __LINE__
170 170
                 );
171 171
             }
172
-            $requirement_value = $input->html_id(true) . ' option[value="' . $value . '"]:selected';
172
+            $requirement_value = $input->html_id(true).' option[value="'.$value.'"]:selected';
173 173
         }
174 174
         return $requirement_value;
175 175
     }
@@ -190,7 +190,7 @@  discard block
 block discarded – undo
190 190
         $conditions = $this->get_requirement_conditions();
191 191
         foreach ($conditions as $input_path => $op_and_value) {
192 192
             $input = $this->_input->find_section_from_path($input_path);
193
-            if (! $input instanceof EE_Form_Input_Base) {
193
+            if ( ! $input instanceof EE_Form_Input_Base) {
194 194
                 EE_Error::throw_exception_if_debugging(
195 195
                     sprintf(
196 196
                         esc_html__('Error encountered while setting requirement condition for input %1$s. The path %2$s does not correspond to a valid input', 'event_espresso'),
@@ -203,13 +203,13 @@  discard block
 block discarded – undo
203 203
                 );
204 204
                 return false;
205 205
             }
206
-            list( $op, $value ) = $this->_validate_op_and_value($op_and_value);
206
+            list($op, $value) = $this->_validate_op_and_value($op_and_value);
207 207
             switch ($op) {
208 208
                 case '=':
209 209
                 default:
210 210
                     $meets_all_requirements = $input->normalized_value() === $value;
211 211
             }
212
-            if (! $meets_all_requirements) {
212
+            if ( ! $meets_all_requirements) {
213 213
                 break;
214 214
             }
215 215
         }
@@ -228,7 +228,7 @@  discard block
 block discarded – undo
228 228
      */
229 229
     protected function _validate_op_and_value($op_and_value)
230 230
     {
231
-        if (! isset($op_and_value[0], $op_and_value[1])) {
231
+        if ( ! isset($op_and_value[0], $op_and_value[1])) {
232 232
                 EE_Error::throw_exception_if_debugging(
233 233
                     sprintf(
234 234
                         esc_html__('Required Validation Strategy conditions array\'s value must be an array with two elements: an operator, and a value. It didn\'t. The related input is %1$s', 'event_espresso'),
@@ -252,6 +252,6 @@  discard block
 block discarded – undo
252 252
                 __LINE__
253 253
             );
254 254
         }
255
-            return array( $operator, $value );
255
+            return array($operator, $value);
256 256
     }
257 257
 }
Please login to merge, or discard this patch.
Indentation   +222 added lines, -222 removed lines patch added patch discarded remove patch
@@ -11,246 +11,246 @@
 block discarded – undo
11 11
  */
12 12
 class EE_Conditionally_Required_Validation_Strategy extends EE_Validation_Strategy_Base
13 13
 {
14
-    /**
15
-     * Array describing conditions necessary to make the input required.
16
-     * This is used to derive a jquery dependency expression (see http://jqueryvalidation.org/required-method)
17
-     * or jquery callback; and server-side logic to determine if the field is necessary.
18
-     * @var array
19
-     */
20
-    protected $requirement_conditions;
14
+	/**
15
+	 * Array describing conditions necessary to make the input required.
16
+	 * This is used to derive a jquery dependency expression (see http://jqueryvalidation.org/required-method)
17
+	 * or jquery callback; and server-side logic to determine if the field is necessary.
18
+	 * @var array
19
+	 */
20
+	protected $requirement_conditions;
21 21
 
22 22
 
23 23
 
24
-    /**
25
-     * @param string $validation_error_message
26
-     * @param array $requirement_conditions
27
-     */
28
-    public function __construct($validation_error_message = null, $requirement_conditions = array())
29
-    {
30
-        if (! $validation_error_message) {
31
-            $validation_error_message = esc_html__("This field is required.", "event_espresso");
32
-        }
33
-        $this->set_requirement_conditions($requirement_conditions);
34
-        parent::__construct($validation_error_message);
35
-    }
24
+	/**
25
+	 * @param string $validation_error_message
26
+	 * @param array $requirement_conditions
27
+	 */
28
+	public function __construct($validation_error_message = null, $requirement_conditions = array())
29
+	{
30
+		if (! $validation_error_message) {
31
+			$validation_error_message = esc_html__("This field is required.", "event_espresso");
32
+		}
33
+		$this->set_requirement_conditions($requirement_conditions);
34
+		parent::__construct($validation_error_message);
35
+	}
36 36
 
37 37
 
38 38
 
39
-    /**
40
-     * just checks the field isn't blank, provided the requirement conditions
41
-     * indicate this input is still required
42
-     *
43
-     * @param $normalized_value
44
-     * @return bool
45
-     * @throws \EE_Error
46
-     * @throws \EE_Validation_Error
47
-     */
48
-    public function validate($normalized_value)
49
-    {
50
-        if (
51
-            (
52
-                $normalized_value === ''
53
-                || $normalized_value === null
54
-                || $normalized_value === array()
55
-            )
56
-            && $this->_input_is_required_server_side()
57
-        ) {
58
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
59
-        } else {
60
-            return true;
61
-        }
62
-    }
39
+	/**
40
+	 * just checks the field isn't blank, provided the requirement conditions
41
+	 * indicate this input is still required
42
+	 *
43
+	 * @param $normalized_value
44
+	 * @return bool
45
+	 * @throws \EE_Error
46
+	 * @throws \EE_Validation_Error
47
+	 */
48
+	public function validate($normalized_value)
49
+	{
50
+		if (
51
+			(
52
+				$normalized_value === ''
53
+				|| $normalized_value === null
54
+				|| $normalized_value === array()
55
+			)
56
+			&& $this->_input_is_required_server_side()
57
+		) {
58
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
59
+		} else {
60
+			return true;
61
+		}
62
+	}
63 63
 
64 64
 
65 65
 
66
-    /**
67
-     * @return array
68
-     * @throws \EE_Error
69
-     */
70
-    public function get_jquery_validation_rule_array()
71
-    {
72
-        return array(
73
-            'required' => $this->_get_jquery_requirement_value(),
74
-            'messages' => array(
75
-                'required' => $this->get_validation_error_message()
76
-            )
77
-        );
78
-    }
66
+	/**
67
+	 * @return array
68
+	 * @throws \EE_Error
69
+	 */
70
+	public function get_jquery_validation_rule_array()
71
+	{
72
+		return array(
73
+			'required' => $this->_get_jquery_requirement_value(),
74
+			'messages' => array(
75
+				'required' => $this->get_validation_error_message()
76
+			)
77
+		);
78
+	}
79 79
 
80
-    /**
81
-     * Sets the "required conditions". This should be an array, its top-level key
82
-     * is the name of a field, its value is an array. This 2nd level array has two items:
83
-     * the first is the operator (for now only '=' is accepted), and teh 2nd argument is the
84
-     * the value the field should be in order to make the field required.
85
-     * Eg array( 'payment_type' => array( '=', 'credit_card' ).
86
-     *
87
-     * @param array $requirement_conditions
88
-     */
89
-    public function set_requirement_conditions($requirement_conditions)
90
-    {
91
-        $this->requirement_conditions = (array) $requirement_conditions;
92
-    }
80
+	/**
81
+	 * Sets the "required conditions". This should be an array, its top-level key
82
+	 * is the name of a field, its value is an array. This 2nd level array has two items:
83
+	 * the first is the operator (for now only '=' is accepted), and teh 2nd argument is the
84
+	 * the value the field should be in order to make the field required.
85
+	 * Eg array( 'payment_type' => array( '=', 'credit_card' ).
86
+	 *
87
+	 * @param array $requirement_conditions
88
+	 */
89
+	public function set_requirement_conditions($requirement_conditions)
90
+	{
91
+		$this->requirement_conditions = (array) $requirement_conditions;
92
+	}
93 93
 
94
-    /**
95
-     * Gets the array that describes when the related input should be required.
96
-     * see set_requirement_conditions for a description of how it should be formatted
97
-     * @return array
98
-     */
99
-    public function get_requirement_conditions()
100
-    {
101
-        return $this->requirement_conditions;
102
-    }
94
+	/**
95
+	 * Gets the array that describes when the related input should be required.
96
+	 * see set_requirement_conditions for a description of how it should be formatted
97
+	 * @return array
98
+	 */
99
+	public function get_requirement_conditions()
100
+	{
101
+		return $this->requirement_conditions;
102
+	}
103 103
 
104 104
 
105 105
 
106
-    /**
107
-     * gets jQuery dependency expression used for client-side validation
108
-     * Its possible this could also return a javascript callback used for determining
109
-     * if the input is required or not. That is not yet implemented, however.
110
-     *
111
-     * @return string see http://jqueryvalidation.org/required-method for format
112
-     * @throws \EE_Error
113
-     */
114
-    protected function _get_jquery_requirement_value()
115
-    {
116
-        $requirement_value = '';
117
-        $conditions = $this->get_requirement_conditions();
118
-        if (! is_array($conditions)) {
119
-            EE_Error::throw_exception_if_debugging(
120
-                sprintf(
121
-                    esc_html__('Input requirement conditions must be an array. You provided %1$s', 'event_espresso'),
122
-                    $this->_input->name()
123
-                ),
124
-                __FILE__,
125
-                __FUNCTION__,
126
-                __LINE__
127
-            );
128
-            return true;
129
-        }
130
-        if (count($conditions) > 1) {
131
-            EE_Error::throw_exception_if_debugging(
132
-                sprintf(
133
-                    esc_html__('Required Validation Strategy does not yet support multiple conditions. You should add it! The related input is %1$s', 'event_espresso'),
134
-                    $this->_input->name()
135
-                ),
136
-                __FILE__,
137
-                __FUNCTION__,
138
-                __LINE__
139
-            );
140
-        }
141
-        foreach ($conditions as $input_path => $op_and_value) {
142
-            $input = $this->_input->find_section_from_path($input_path);
143
-            if (! $input instanceof EE_Form_Input_Base) {
144
-                EE_Error::throw_exception_if_debugging(
145
-                    sprintf(
146
-                        esc_html__('Error encountered while setting requirement condition for input %1$s. The path %2$s does not correspond to a valid input', 'event_espresso'),
147
-                        $this->_input->name(),
148
-                        $input_path
149
-                    ),
150
-                    __FILE__,
151
-                    __FUNCTION__,
152
-                    __LINE__
153
-                );
154
-                return false;
155
-            }
156
-            list( $op, $value ) = $this->_validate_op_and_value($op_and_value);
157
-            // ok now the jquery dependency expression depends on the input's display strategy.
158
-            if (! $input->get_display_strategy() instanceof EE_Select_Display_Strategy) {
159
-                EE_Error::throw_exception_if_debugging(
160
-                    sprintf(
161
-                        esc_html__('Required Validation Strategy can only depend on another input which uses the EE_Select_Display_Strategy, but you specified a field "%1$s" that uses display strategy "%2$s". If you need others, please add support for it! The related input is %3$s', 'event_espresso'),
162
-                        $input->name(),
163
-                        get_class($input->get_display_strategy()),
164
-                        $this->_input->name()
165
-                    ),
166
-                    __FILE__,
167
-                    __FUNCTION__,
168
-                    __LINE__
169
-                );
170
-            }
171
-            $requirement_value = $input->html_id(true) . ' option[value="' . $value . '"]:selected';
172
-        }
173
-        return $requirement_value;
174
-    }
106
+	/**
107
+	 * gets jQuery dependency expression used for client-side validation
108
+	 * Its possible this could also return a javascript callback used for determining
109
+	 * if the input is required or not. That is not yet implemented, however.
110
+	 *
111
+	 * @return string see http://jqueryvalidation.org/required-method for format
112
+	 * @throws \EE_Error
113
+	 */
114
+	protected function _get_jquery_requirement_value()
115
+	{
116
+		$requirement_value = '';
117
+		$conditions = $this->get_requirement_conditions();
118
+		if (! is_array($conditions)) {
119
+			EE_Error::throw_exception_if_debugging(
120
+				sprintf(
121
+					esc_html__('Input requirement conditions must be an array. You provided %1$s', 'event_espresso'),
122
+					$this->_input->name()
123
+				),
124
+				__FILE__,
125
+				__FUNCTION__,
126
+				__LINE__
127
+			);
128
+			return true;
129
+		}
130
+		if (count($conditions) > 1) {
131
+			EE_Error::throw_exception_if_debugging(
132
+				sprintf(
133
+					esc_html__('Required Validation Strategy does not yet support multiple conditions. You should add it! The related input is %1$s', 'event_espresso'),
134
+					$this->_input->name()
135
+				),
136
+				__FILE__,
137
+				__FUNCTION__,
138
+				__LINE__
139
+			);
140
+		}
141
+		foreach ($conditions as $input_path => $op_and_value) {
142
+			$input = $this->_input->find_section_from_path($input_path);
143
+			if (! $input instanceof EE_Form_Input_Base) {
144
+				EE_Error::throw_exception_if_debugging(
145
+					sprintf(
146
+						esc_html__('Error encountered while setting requirement condition for input %1$s. The path %2$s does not correspond to a valid input', 'event_espresso'),
147
+						$this->_input->name(),
148
+						$input_path
149
+					),
150
+					__FILE__,
151
+					__FUNCTION__,
152
+					__LINE__
153
+				);
154
+				return false;
155
+			}
156
+			list( $op, $value ) = $this->_validate_op_and_value($op_and_value);
157
+			// ok now the jquery dependency expression depends on the input's display strategy.
158
+			if (! $input->get_display_strategy() instanceof EE_Select_Display_Strategy) {
159
+				EE_Error::throw_exception_if_debugging(
160
+					sprintf(
161
+						esc_html__('Required Validation Strategy can only depend on another input which uses the EE_Select_Display_Strategy, but you specified a field "%1$s" that uses display strategy "%2$s". If you need others, please add support for it! The related input is %3$s', 'event_espresso'),
162
+						$input->name(),
163
+						get_class($input->get_display_strategy()),
164
+						$this->_input->name()
165
+					),
166
+					__FILE__,
167
+					__FUNCTION__,
168
+					__LINE__
169
+				);
170
+			}
171
+			$requirement_value = $input->html_id(true) . ' option[value="' . $value . '"]:selected';
172
+		}
173
+		return $requirement_value;
174
+	}
175 175
 
176 176
 
177 177
 
178
-    /**
179
-     * Returns whether or not this input is required based on the _requirement_conditions
180
-     * (not whether or not the input passes validation. That's for the validate method
181
-     * to decide)
182
-     *
183
-     * @return boolean
184
-     * @throws \EE_Error
185
-     */
186
-    protected function _input_is_required_server_side()
187
-    {
188
-        $meets_all_requirements = true;
189
-        $conditions = $this->get_requirement_conditions();
190
-        foreach ($conditions as $input_path => $op_and_value) {
191
-            $input = $this->_input->find_section_from_path($input_path);
192
-            if (! $input instanceof EE_Form_Input_Base) {
193
-                EE_Error::throw_exception_if_debugging(
194
-                    sprintf(
195
-                        esc_html__('Error encountered while setting requirement condition for input %1$s. The path %2$s does not correspond to a valid input', 'event_espresso'),
196
-                        $this->_input->name(),
197
-                        $input_path
198
-                    ),
199
-                    __FILE__,
200
-                    __FUNCTION__,
201
-                    __LINE__
202
-                );
203
-                return false;
204
-            }
205
-            list( $op, $value ) = $this->_validate_op_and_value($op_and_value);
206
-            switch ($op) {
207
-                case '=':
208
-                default:
209
-                    $meets_all_requirements = $input->normalized_value() === $value;
210
-            }
211
-            if (! $meets_all_requirements) {
212
-                break;
213
-            }
214
-        }
215
-        return $meets_all_requirements;
216
-    }
178
+	/**
179
+	 * Returns whether or not this input is required based on the _requirement_conditions
180
+	 * (not whether or not the input passes validation. That's for the validate method
181
+	 * to decide)
182
+	 *
183
+	 * @return boolean
184
+	 * @throws \EE_Error
185
+	 */
186
+	protected function _input_is_required_server_side()
187
+	{
188
+		$meets_all_requirements = true;
189
+		$conditions = $this->get_requirement_conditions();
190
+		foreach ($conditions as $input_path => $op_and_value) {
191
+			$input = $this->_input->find_section_from_path($input_path);
192
+			if (! $input instanceof EE_Form_Input_Base) {
193
+				EE_Error::throw_exception_if_debugging(
194
+					sprintf(
195
+						esc_html__('Error encountered while setting requirement condition for input %1$s. The path %2$s does not correspond to a valid input', 'event_espresso'),
196
+						$this->_input->name(),
197
+						$input_path
198
+					),
199
+					__FILE__,
200
+					__FUNCTION__,
201
+					__LINE__
202
+				);
203
+				return false;
204
+			}
205
+			list( $op, $value ) = $this->_validate_op_and_value($op_and_value);
206
+			switch ($op) {
207
+				case '=':
208
+				default:
209
+					$meets_all_requirements = $input->normalized_value() === $value;
210
+			}
211
+			if (! $meets_all_requirements) {
212
+				break;
213
+			}
214
+		}
215
+		return $meets_all_requirements;
216
+	}
217 217
 
218 218
 
219 219
 
220
-    /**
221
-     * Verifies this is an array with keys 0 and 1, where key 0 is a usable
222
-     * operator (initially just '=') and key 1 is something that can be cast to a string
223
-     *
224
-     * @param array $op_and_value
225
-     * @return array
226
-     * @throws \EE_Error
227
-     */
228
-    protected function _validate_op_and_value($op_and_value)
229
-    {
230
-        if (! isset($op_and_value[0], $op_and_value[1])) {
231
-                EE_Error::throw_exception_if_debugging(
232
-                    sprintf(
233
-                        esc_html__('Required Validation Strategy conditions array\'s value must be an array with two elements: an operator, and a value. It didn\'t. The related input is %1$s', 'event_espresso'),
234
-                        $this->_input->name()
235
-                    ),
236
-                    __FILE__,
237
-                    __FUNCTION__,
238
-                    __LINE__
239
-                );
240
-        }
241
-            $operator = $op_and_value[0];
242
-            $value = (string) $op_and_value[1];
243
-        if ($operator !== '=') {
244
-            EE_Error::throw_exception_if_debugging(
245
-                sprintf(
246
-                    esc_html__('Required Validation Strategy conditions can currently only use the equals operator. If you need others, please add support for it! The related input is %1$s', 'event_espresso'),
247
-                    $this->_input->name()
248
-                ),
249
-                __FILE__,
250
-                __FUNCTION__,
251
-                __LINE__
252
-            );
253
-        }
254
-            return array( $operator, $value );
255
-    }
220
+	/**
221
+	 * Verifies this is an array with keys 0 and 1, where key 0 is a usable
222
+	 * operator (initially just '=') and key 1 is something that can be cast to a string
223
+	 *
224
+	 * @param array $op_and_value
225
+	 * @return array
226
+	 * @throws \EE_Error
227
+	 */
228
+	protected function _validate_op_and_value($op_and_value)
229
+	{
230
+		if (! isset($op_and_value[0], $op_and_value[1])) {
231
+				EE_Error::throw_exception_if_debugging(
232
+					sprintf(
233
+						esc_html__('Required Validation Strategy conditions array\'s value must be an array with two elements: an operator, and a value. It didn\'t. The related input is %1$s', 'event_espresso'),
234
+						$this->_input->name()
235
+					),
236
+					__FILE__,
237
+					__FUNCTION__,
238
+					__LINE__
239
+				);
240
+		}
241
+			$operator = $op_and_value[0];
242
+			$value = (string) $op_and_value[1];
243
+		if ($operator !== '=') {
244
+			EE_Error::throw_exception_if_debugging(
245
+				sprintf(
246
+					esc_html__('Required Validation Strategy conditions can currently only use the equals operator. If you need others, please add support for it! The related input is %1$s', 'event_espresso'),
247
+					$this->_input->name()
248
+				),
249
+				__FILE__,
250
+				__FUNCTION__,
251
+				__LINE__
252
+			);
253
+		}
254
+			return array( $operator, $value );
255
+	}
256 256
 }
Please login to merge, or discard this patch.
strategies/validation/EE_Float_Validation_Strategy.strategy.php 2 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -17,7 +17,7 @@  discard block
 block discarded – undo
17 17
      */
18 18
     public function __construct($validation_error_message = null)
19 19
     {
20
-        if (! $validation_error_message) {
20
+        if ( ! $validation_error_message) {
21 21
             $validation_error_message = sprintf(esc_html__("Only numeric characters, commas, periods, and spaces, please!", "event_espresso"));
22 22
         }
23 23
         parent::__construct($validation_error_message);
@@ -42,6 +42,6 @@  discard block
 block discarded – undo
42 42
      */
43 43
     public function get_jquery_validation_rule_array()
44 44
     {
45
-        return array('number' => true, 'messages' => array( 'number' => $this->get_validation_error_message() ) );
45
+        return array('number' => true, 'messages' => array('number' => $this->get_validation_error_message()));
46 46
     }
47 47
 }
Please login to merge, or discard this patch.
Indentation   +26 added lines, -26 removed lines patch added patch discarded remove patch
@@ -11,36 +11,36 @@
 block discarded – undo
11 11
  */
12 12
 class EE_Float_Validation_Strategy extends EE_Validation_Strategy_Base
13 13
 {
14
-    /**
15
-     * @param null $validation_error_message
16
-     */
17
-    public function __construct($validation_error_message = null)
18
-    {
19
-        if (! $validation_error_message) {
20
-            $validation_error_message = sprintf(esc_html__("Only numeric characters, commas, periods, and spaces, please!", "event_espresso"));
21
-        }
22
-        parent::__construct($validation_error_message);
23
-    }
14
+	/**
15
+	 * @param null $validation_error_message
16
+	 */
17
+	public function __construct($validation_error_message = null)
18
+	{
19
+		if (! $validation_error_message) {
20
+			$validation_error_message = sprintf(esc_html__("Only numeric characters, commas, periods, and spaces, please!", "event_espresso"));
21
+		}
22
+		parent::__construct($validation_error_message);
23
+	}
24 24
 
25 25
 
26 26
 
27
-    /**
28
-     *
29
-     * @param $normalized_value
30
-     * @return bool
31
-     */
32
-    public function validate($normalized_value)
33
-    {
34
-        // errors should have been detected by the normalization strategy
35
-    }
27
+	/**
28
+	 *
29
+	 * @param $normalized_value
30
+	 * @return bool
31
+	 */
32
+	public function validate($normalized_value)
33
+	{
34
+		// errors should have been detected by the normalization strategy
35
+	}
36 36
 
37 37
 
38 38
 
39
-    /**
40
-     * @return array
41
-     */
42
-    public function get_jquery_validation_rule_array()
43
-    {
44
-        return array('number' => true, 'messages' => array( 'number' => $this->get_validation_error_message() ) );
45
-    }
39
+	/**
40
+	 * @return array
41
+	 */
42
+	public function get_jquery_validation_rule_array()
43
+	{
44
+		return array('number' => true, 'messages' => array( 'number' => $this->get_validation_error_message() ) );
45
+	}
46 46
 }
Please login to merge, or discard this patch.
strategies/validation/EE_Simple_HTML_Validation_Strategy.strategy.php 2 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -19,7 +19,7 @@  discard block
 block discarded – undo
19 19
      */
20 20
     public function __construct($validation_error_message = null)
21 21
     {
22
-        if (! $validation_error_message) {
22
+        if ( ! $validation_error_message) {
23 23
             $allowedtags = $this->_get_allowed_tags();
24 24
             $validation_error_message = sprintf(esc_html__("Only simple HTML tags are allowed. Eg, %s", "event_espresso"), implode(",", array_keys($allowedtags)));
25 25
         }
@@ -62,7 +62,7 @@  discard block
 block discarded – undo
62 62
     {
63 63
         $allowedtags = $this->_get_allowed_tags();
64 64
         parent::validate($normalized_value);
65
-        $normalized_value_sans_tags =  wp_kses("$normalized_value", $allowedtags);
65
+        $normalized_value_sans_tags = wp_kses("$normalized_value", $allowedtags);
66 66
         if (strlen($normalized_value) > strlen($normalized_value_sans_tags)) {
67 67
             throw new EE_Validation_Error($this->get_validation_error_message(), 'complex_html_tags');
68 68
         }
Please login to merge, or discard this patch.
Indentation   +44 added lines, -44 removed lines patch added patch discarded remove patch
@@ -13,57 +13,57 @@
 block discarded – undo
13 13
  */
14 14
 class EE_Simple_HTML_Validation_Strategy extends EE_Validation_Strategy_Base
15 15
 {
16
-    /**
17
-     * @param null $validation_error_message
18
-     */
19
-    public function __construct($validation_error_message = null)
20
-    {
21
-        if (! $validation_error_message) {
22
-            $allowedtags = $this->_get_allowed_tags();
23
-            $validation_error_message = sprintf(esc_html__("Only simple HTML tags are allowed. Eg, %s", "event_espresso"), implode(",", array_keys($allowedtags)));
24
-        }
25
-        parent::__construct($validation_error_message);
26
-    }
16
+	/**
17
+	 * @param null $validation_error_message
18
+	 */
19
+	public function __construct($validation_error_message = null)
20
+	{
21
+		if (! $validation_error_message) {
22
+			$allowedtags = $this->_get_allowed_tags();
23
+			$validation_error_message = sprintf(esc_html__("Only simple HTML tags are allowed. Eg, %s", "event_espresso"), implode(",", array_keys($allowedtags)));
24
+		}
25
+		parent::__construct($validation_error_message);
26
+	}
27 27
 
28 28
 
29 29
 
30
-    /**
31
-     * get tags allowed
32
-     */
33
-    protected function _get_allowed_tags()
34
-    {
35
-        return EEH_HTML::get_simple_tags();
36
-    }
30
+	/**
31
+	 * get tags allowed
32
+	 */
33
+	protected function _get_allowed_tags()
34
+	{
35
+		return EEH_HTML::get_simple_tags();
36
+	}
37 37
 
38 38
 
39 39
 
40
-    /**
41
-     * add_more_tags
42
-     *
43
-     * generates and returns a string that lists the top-level HTML tags that are allowable for this input
44
-     *
45
-     * @return string
46
-     */
47
-    public function get_list_of_allowed_tags()
48
-    {
49
-        $allowed_tags = $this->_get_allowed_tags();
50
-        ksort($allowed_tags);
51
-        return implode(', ', array_keys($allowed_tags));
52
-    }
40
+	/**
41
+	 * add_more_tags
42
+	 *
43
+	 * generates and returns a string that lists the top-level HTML tags that are allowable for this input
44
+	 *
45
+	 * @return string
46
+	 */
47
+	public function get_list_of_allowed_tags()
48
+	{
49
+		$allowed_tags = $this->_get_allowed_tags();
50
+		ksort($allowed_tags);
51
+		return implode(', ', array_keys($allowed_tags));
52
+	}
53 53
 
54 54
 
55 55
 
56
-    /**
57
-     * @param $normalized_value
58
-     * @throws \EE_Validation_Error
59
-     */
60
-    public function validate($normalized_value)
61
-    {
62
-        $allowedtags = $this->_get_allowed_tags();
63
-        parent::validate($normalized_value);
64
-        $normalized_value_sans_tags =  wp_kses("$normalized_value", $allowedtags);
65
-        if (strlen($normalized_value) > strlen($normalized_value_sans_tags)) {
66
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'complex_html_tags');
67
-        }
68
-    }
56
+	/**
57
+	 * @param $normalized_value
58
+	 * @throws \EE_Validation_Error
59
+	 */
60
+	public function validate($normalized_value)
61
+	{
62
+		$allowedtags = $this->_get_allowed_tags();
63
+		parent::validate($normalized_value);
64
+		$normalized_value_sans_tags =  wp_kses("$normalized_value", $allowedtags);
65
+		if (strlen($normalized_value) > strlen($normalized_value_sans_tags)) {
66
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'complex_html_tags');
67
+		}
68
+	}
69 69
 }
Please login to merge, or discard this patch.
form_sections/strategies/normalization/EE_Float_Normalization.strategy.php 2 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -33,7 +33,7 @@  discard block
 block discarded – undo
33 33
         if (is_float($value_to_normalize) || is_int($value_to_normalize)) {
34 34
             return (float) $value_to_normalize;
35 35
         }
36
-        if (! is_string($value_to_normalize)) {
36
+        if ( ! is_string($value_to_normalize)) {
37 37
             throw new EE_Validation_Error(
38 38
                 sprintf(
39 39
                     esc_html__('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
@@ -69,7 +69,7 @@  discard block
 block discarded – undo
69 69
         }
70 70
         // this really shouldn't ever happen because fields with a float normalization strategy
71 71
         // should also have a float validation strategy, but in case it doesn't use the default
72
-        if (! $validation_error_message) {
72
+        if ( ! $validation_error_message) {
73 73
             $default_validation_strategy = new EE_Float_Validation_Strategy();
74 74
             $validation_error_message = $default_validation_strategy->get_validation_error_message();
75 75
         }
Please login to merge, or discard this patch.
Indentation   +70 added lines, -70 removed lines patch added patch discarded remove patch
@@ -10,84 +10,84 @@
 block discarded – undo
10 10
  */
11 11
 class EE_Float_Normalization extends EE_Normalization_Strategy_Base
12 12
 {
13
-    /*
13
+	/*
14 14
      * regex pattern that matches for the following:
15 15
      *      * optional negative sign
16 16
      *      * one or more digits or decimals
17 17
      */
18
-    const REGEX = '/^(-?)([\d.]+)$/';
18
+	const REGEX = '/^(-?)([\d.]+)$/';
19 19
 
20 20
 
21 21
 
22
-    /**
23
-     * @param string $value_to_normalize
24
-     * @return float
25
-     * @throws \EE_Validation_Error
26
-     */
27
-    public function normalize($value_to_normalize)
28
-    {
29
-        if ($value_to_normalize === null) {
30
-            return null;
31
-        }
32
-        if (is_float($value_to_normalize) || is_int($value_to_normalize)) {
33
-            return (float) $value_to_normalize;
34
-        }
35
-        if (! is_string($value_to_normalize)) {
36
-            throw new EE_Validation_Error(
37
-                sprintf(
38
-                    esc_html__('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
39
-                    print_r($value_to_normalize, true),
40
-                    gettype($value_to_normalize)
41
-                )
42
-            );
43
-        }
44
-        $normalized_value = filter_var(
45
-            $value_to_normalize,
46
-            FILTER_SANITIZE_NUMBER_FLOAT,
47
-            FILTER_FLAG_ALLOW_FRACTION
48
-        );
49
-        if ($normalized_value === '') {
50
-            return null;
51
-        }
52
-        if (preg_match(EE_Float_Normalization::REGEX, $normalized_value, $matches)) {
53
-            if (count($matches) === 3) {
54
-                // if first match is the negative sign,
55
-                // then the number needs to be multiplied by -1 to remain negative
56
-                return $matches[1] === '-'
57
-                    ? (float) $matches[2] * -1
58
-                    : (float) $matches[2];
59
-            }
60
-        }
61
-        // find if this input has a float validation strategy
62
-        // in which case, use its message
63
-        $validation_error_message = null;
64
-        foreach ($this->_input->get_validation_strategies() as $validation_strategy) {
65
-            if ($validation_strategy instanceof EE_Float_Validation_Strategy) {
66
-                $validation_error_message = $validation_strategy->get_validation_error_message();
67
-            }
68
-        }
69
-        // this really shouldn't ever happen because fields with a float normalization strategy
70
-        // should also have a float validation strategy, but in case it doesn't use the default
71
-        if (! $validation_error_message) {
72
-            $default_validation_strategy = new EE_Float_Validation_Strategy();
73
-            $validation_error_message = $default_validation_strategy->get_validation_error_message();
74
-        }
75
-        throw new EE_Validation_Error($validation_error_message, 'float_only');
76
-    }
22
+	/**
23
+	 * @param string $value_to_normalize
24
+	 * @return float
25
+	 * @throws \EE_Validation_Error
26
+	 */
27
+	public function normalize($value_to_normalize)
28
+	{
29
+		if ($value_to_normalize === null) {
30
+			return null;
31
+		}
32
+		if (is_float($value_to_normalize) || is_int($value_to_normalize)) {
33
+			return (float) $value_to_normalize;
34
+		}
35
+		if (! is_string($value_to_normalize)) {
36
+			throw new EE_Validation_Error(
37
+				sprintf(
38
+					esc_html__('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
39
+					print_r($value_to_normalize, true),
40
+					gettype($value_to_normalize)
41
+				)
42
+			);
43
+		}
44
+		$normalized_value = filter_var(
45
+			$value_to_normalize,
46
+			FILTER_SANITIZE_NUMBER_FLOAT,
47
+			FILTER_FLAG_ALLOW_FRACTION
48
+		);
49
+		if ($normalized_value === '') {
50
+			return null;
51
+		}
52
+		if (preg_match(EE_Float_Normalization::REGEX, $normalized_value, $matches)) {
53
+			if (count($matches) === 3) {
54
+				// if first match is the negative sign,
55
+				// then the number needs to be multiplied by -1 to remain negative
56
+				return $matches[1] === '-'
57
+					? (float) $matches[2] * -1
58
+					: (float) $matches[2];
59
+			}
60
+		}
61
+		// find if this input has a float validation strategy
62
+		// in which case, use its message
63
+		$validation_error_message = null;
64
+		foreach ($this->_input->get_validation_strategies() as $validation_strategy) {
65
+			if ($validation_strategy instanceof EE_Float_Validation_Strategy) {
66
+				$validation_error_message = $validation_strategy->get_validation_error_message();
67
+			}
68
+		}
69
+		// this really shouldn't ever happen because fields with a float normalization strategy
70
+		// should also have a float validation strategy, but in case it doesn't use the default
71
+		if (! $validation_error_message) {
72
+			$default_validation_strategy = new EE_Float_Validation_Strategy();
73
+			$validation_error_message = $default_validation_strategy->get_validation_error_message();
74
+		}
75
+		throw new EE_Validation_Error($validation_error_message, 'float_only');
76
+	}
77 77
 
78 78
 
79 79
 
80
-    /**
81
-     * Converts a float into a string
82
-     *
83
-     * @param float $normalized_value
84
-     * @return string
85
-     */
86
-    public function unnormalize($normalized_value)
87
-    {
88
-        if (empty($normalized_value)) {
89
-            return '0.00';
90
-        }
91
-        return "{$normalized_value}";
92
-    }
80
+	/**
81
+	 * Converts a float into a string
82
+	 *
83
+	 * @param float $normalized_value
84
+	 * @return string
85
+	 */
86
+	public function unnormalize($normalized_value)
87
+	{
88
+		if (empty($normalized_value)) {
89
+			return '0.00';
90
+		}
91
+		return "{$normalized_value}";
92
+	}
93 93
 }
Please login to merge, or discard this patch.
form_sections/strategies/normalization/EE_Int_Normalization.strategy.php 2 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -33,7 +33,7 @@  discard block
 block discarded – undo
33 33
         if (is_int($value_to_normalize) || is_float($value_to_normalize)) {
34 34
             return (int) $value_to_normalize;
35 35
         }
36
-        if (! is_string($value_to_normalize)) {
36
+        if ( ! is_string($value_to_normalize)) {
37 37
             throw new EE_Validation_Error(
38 38
                 sprintf(
39 39
                     esc_html__('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
@@ -70,7 +70,7 @@  discard block
 block discarded – undo
70 70
         }
71 71
         // this really shouldn't ever happen because fields with a int normalization strategy
72 72
         // should also have a int validation strategy, but in case it doesn't use the default
73
-        if (! $validation_error_message) {
73
+        if ( ! $validation_error_message) {
74 74
             $default_validation_strategy = new EE_Int_Validation_Strategy();
75 75
             $validation_error_message = $default_validation_strategy->get_validation_error_message();
76 76
         }
Please login to merge, or discard this patch.
Indentation   +74 added lines, -74 removed lines patch added patch discarded remove patch
@@ -10,88 +10,88 @@
 block discarded – undo
10 10
  */
11 11
 class EE_Int_Normalization extends EE_Normalization_Strategy_Base
12 12
 {
13
-    /*
13
+	/*
14 14
      * regex pattern that matches for the following:
15 15
      *      * optional negative sign
16 16
      *      * one or more digits
17 17
      */
18
-    const REGEX = '/^(-?)(\d+)(?:\.0+)?$/';
18
+	const REGEX = '/^(-?)(\d+)(?:\.0+)?$/';
19 19
 
20 20
 
21 21
 
22
-    /**
23
-     * @param string $value_to_normalize
24
-     * @return int|mixed|string
25
-     * @throws \EE_Validation_Error
26
-     */
27
-    public function normalize($value_to_normalize)
28
-    {
29
-        if ($value_to_normalize === null) {
30
-            return null;
31
-        }
32
-        if (is_int($value_to_normalize) || is_float($value_to_normalize)) {
33
-            return (int) $value_to_normalize;
34
-        }
35
-        if (! is_string($value_to_normalize)) {
36
-            throw new EE_Validation_Error(
37
-                sprintf(
38
-                    esc_html__('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
39
-                    print_r($value_to_normalize, true),
40
-                    gettype($value_to_normalize)
41
-                )
42
-            );
43
-        }
44
-        $value_to_normalize = filter_var(
45
-            $value_to_normalize,
46
-            FILTER_SANITIZE_NUMBER_FLOAT,
47
-            FILTER_FLAG_ALLOW_FRACTION
48
-        );
49
-        if ($value_to_normalize === '') {
50
-            return null;
51
-        }
52
-        $matches = array();
53
-        if (preg_match(EE_Int_Normalization::REGEX, $value_to_normalize, $matches)) {
54
-            if (count($matches) === 3) {
55
-                // if first match is the negative sign,
56
-                // then the number needs to be multiplied by -1 to remain negative
57
-                return $matches[1] === '-'
58
-                    ? (int) $matches[2] * -1
59
-                    : (int) $matches[2];
60
-            }
61
-        }
62
-        // find if this input has a int validation strategy
63
-        // in which case, use its message
64
-        $validation_error_message = null;
65
-        foreach ($this->_input->get_validation_strategies() as $validation_strategy) {
66
-            if ($validation_strategy instanceof EE_Int_Validation_Strategy) {
67
-                $validation_error_message = $validation_strategy->get_validation_error_message();
68
-            }
69
-        }
70
-        // this really shouldn't ever happen because fields with a int normalization strategy
71
-        // should also have a int validation strategy, but in case it doesn't use the default
72
-        if (! $validation_error_message) {
73
-            $default_validation_strategy = new EE_Int_Validation_Strategy();
74
-            $validation_error_message = $default_validation_strategy->get_validation_error_message();
75
-        }
76
-        throw new EE_Validation_Error($validation_error_message, 'numeric_only');
77
-    }
22
+	/**
23
+	 * @param string $value_to_normalize
24
+	 * @return int|mixed|string
25
+	 * @throws \EE_Validation_Error
26
+	 */
27
+	public function normalize($value_to_normalize)
28
+	{
29
+		if ($value_to_normalize === null) {
30
+			return null;
31
+		}
32
+		if (is_int($value_to_normalize) || is_float($value_to_normalize)) {
33
+			return (int) $value_to_normalize;
34
+		}
35
+		if (! is_string($value_to_normalize)) {
36
+			throw new EE_Validation_Error(
37
+				sprintf(
38
+					esc_html__('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
39
+					print_r($value_to_normalize, true),
40
+					gettype($value_to_normalize)
41
+				)
42
+			);
43
+		}
44
+		$value_to_normalize = filter_var(
45
+			$value_to_normalize,
46
+			FILTER_SANITIZE_NUMBER_FLOAT,
47
+			FILTER_FLAG_ALLOW_FRACTION
48
+		);
49
+		if ($value_to_normalize === '') {
50
+			return null;
51
+		}
52
+		$matches = array();
53
+		if (preg_match(EE_Int_Normalization::REGEX, $value_to_normalize, $matches)) {
54
+			if (count($matches) === 3) {
55
+				// if first match is the negative sign,
56
+				// then the number needs to be multiplied by -1 to remain negative
57
+				return $matches[1] === '-'
58
+					? (int) $matches[2] * -1
59
+					: (int) $matches[2];
60
+			}
61
+		}
62
+		// find if this input has a int validation strategy
63
+		// in which case, use its message
64
+		$validation_error_message = null;
65
+		foreach ($this->_input->get_validation_strategies() as $validation_strategy) {
66
+			if ($validation_strategy instanceof EE_Int_Validation_Strategy) {
67
+				$validation_error_message = $validation_strategy->get_validation_error_message();
68
+			}
69
+		}
70
+		// this really shouldn't ever happen because fields with a int normalization strategy
71
+		// should also have a int validation strategy, but in case it doesn't use the default
72
+		if (! $validation_error_message) {
73
+			$default_validation_strategy = new EE_Int_Validation_Strategy();
74
+			$validation_error_message = $default_validation_strategy->get_validation_error_message();
75
+		}
76
+		throw new EE_Validation_Error($validation_error_message, 'numeric_only');
77
+	}
78 78
 
79 79
 
80 80
 
81
-    /**
82
-     * Converts the int into a string for use in teh html form
83
-     *
84
-     * @param int $normalized_value
85
-     * @return string
86
-     */
87
-    public function unnormalize($normalized_value)
88
-    {
89
-        if ($normalized_value === null || $normalized_value === '') {
90
-            return '';
91
-        }
92
-        if (empty($normalized_value)) {
93
-            return '0';
94
-        }
95
-        return "$normalized_value";
96
-    }
81
+	/**
82
+	 * Converts the int into a string for use in teh html form
83
+	 *
84
+	 * @param int $normalized_value
85
+	 * @return string
86
+	 */
87
+	public function unnormalize($normalized_value)
88
+	{
89
+		if ($normalized_value === null || $normalized_value === '') {
90
+			return '';
91
+		}
92
+		if (empty($normalized_value)) {
93
+			return '0';
94
+		}
95
+		return "$normalized_value";
96
+	}
97 97
 }
Please login to merge, or discard this patch.
core/libraries/form_sections/inputs/EE_Form_Input_Base.input.php 2 patches
Spacing   +19 added lines, -19 removed lines patch added patch discarded remove patch
@@ -199,7 +199,7 @@  discard block
 block discarded – undo
199 199
         if (isset($input_args['validation_strategies'])) {
200 200
             foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
201 201
                 if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
202
-                    $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
202
+                    $this->_validation_strategies[get_class($validation_strategy)] = $validation_strategy;
203 203
                 }
204 204
             }
205 205
             unset($input_args['validation_strategies']);
@@ -210,7 +210,7 @@  discard block
 block discarded – undo
210 210
         // loop thru incoming options
211 211
         foreach ($input_args as $key => $value) {
212 212
             // add underscore to $key to match property names
213
-            $_key = '_' . $key;
213
+            $_key = '_'.$key;
214 214
             if (property_exists($this, $_key)) {
215 215
                 $this->{$_key} = $value;
216 216
             }
@@ -230,7 +230,7 @@  discard block
 block discarded – undo
230 230
         if (isset($input_args['ignore_input'])) {
231 231
             $this->_normalization_strategy = new EE_Null_Normalization();
232 232
         }
233
-        if (! $this->_normalization_strategy) {
233
+        if ( ! $this->_normalization_strategy) {
234 234
                 $this->_normalization_strategy = new EE_Text_Normalization();
235 235
         }
236 236
         $this->_normalization_strategy->_construct_finalize($this);
@@ -239,7 +239,7 @@  discard block
 block discarded – undo
239 239
             $this->set_default($input_args['default']);
240 240
             unset($input_args['default']);
241 241
         }
242
-        if (! $this->_sensitive_data_removal_strategy) {
242
+        if ( ! $this->_sensitive_data_removal_strategy) {
243 243
             $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
244 244
         }
245 245
         $this->_sensitive_data_removal_strategy->_construct_finalize($this);
@@ -256,10 +256,10 @@  discard block
 block discarded – undo
256 256
      */
257 257
     protected function _set_default_html_name_if_empty()
258 258
     {
259
-        if (! $this->_html_name) {
259
+        if ( ! $this->_html_name) {
260 260
             $this->_html_name = $this->name();
261 261
             if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
262
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
262
+                $this->_html_name = $this->_parent_section->html_name_prefix()."[{$this->name()}]";
263 263
             }
264 264
         }
265 265
     }
@@ -291,7 +291,7 @@  discard block
 block discarded – undo
291 291
     protected function _get_display_strategy()
292 292
     {
293 293
         $this->ensure_construct_finalized_called();
294
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
294
+        if ( ! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
295 295
             throw new EE_Error(
296 296
                 sprintf(
297 297
                     esc_html__(
@@ -459,7 +459,7 @@  discard block
 block discarded – undo
459 459
                 $validation_strategy instanceof $validation_strategy_classname
460 460
                 || is_subclass_of($validation_strategy, $validation_strategy_classname)
461 461
             ) {
462
-                unset($this->_validation_strategies[ $key ]);
462
+                unset($this->_validation_strategies[$key]);
463 463
             }
464 464
         }
465 465
     }
@@ -670,7 +670,7 @@  discard block
 block discarded – undo
670 670
             if (is_array($raw_input)) {
671 671
                 $raw_value = array();
672 672
                 foreach ($raw_input as $key => $value) {
673
-                    $raw_value[ $key ] = $this->_sanitize($value);
673
+                    $raw_value[$key] = $this->_sanitize($value);
674 674
                 }
675 675
                 $this->_set_raw_value($raw_value);
676 676
             } else {
@@ -703,7 +703,7 @@  discard block
 block discarded – undo
703 703
      */
704 704
     public function html_label_id()
705 705
     {
706
-        return ! empty($this->_html_label_id) ? $this->_html_label_id : $this->html_id() . '-lbl';
706
+        return ! empty($this->_html_label_id) ? $this->_html_label_id : $this->html_id().'-lbl';
707 707
     }
708 708
 
709 709
 
@@ -853,9 +853,9 @@  discard block
 block discarded – undo
853 853
                 $validation_strategy->get_jquery_validation_rule_array()
854 854
             );
855 855
         }
856
-        if (! empty($jquery_validation_rules)) {
856
+        if ( ! empty($jquery_validation_rules)) {
857 857
             foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
858
-                $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
858
+                $jquery_validation_js[$html_id_with_pound_sign] = $jquery_validation_rules;
859 859
             }
860 860
         }
861 861
         return $jquery_validation_js;
@@ -977,7 +977,7 @@  discard block
 block discarded – undo
977 977
     public function html_class($add_required = false)
978 978
     {
979 979
         return $add_required && $this->required()
980
-            ? $this->required_css_class() . ' ' . $this->_html_class
980
+            ? $this->required_css_class().' '.$this->_html_class
981 981
             : $this->_html_class;
982 982
     }
983 983
 
@@ -1052,7 +1052,7 @@  discard block
 block discarded – undo
1052 1052
                 $button_css_attributes .= '';
1053 1053
         }
1054 1054
         $this->_button_css_attributes .= ! empty($other_attributes)
1055
-            ? $button_css_attributes . ' ' . $other_attributes
1055
+            ? $button_css_attributes.' '.$other_attributes
1056 1056
             : $button_css_attributes;
1057 1057
     }
1058 1058
 
@@ -1090,8 +1090,8 @@  discard block
 block discarded – undo
1090 1090
         // now get the value for the input
1091 1091
         $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
1092 1092
         // check if this thing's name is at the TOP level of the request data
1093
-        if ($value === null && isset($req_data[ $this->name() ])) {
1094
-            $value = $req_data[ $this->name() ];
1093
+        if ($value === null && isset($req_data[$this->name()])) {
1094
+            $value = $req_data[$this->name()];
1095 1095
         }
1096 1096
         return $value;
1097 1097
     }
@@ -1133,13 +1133,13 @@  discard block
 block discarded – undo
1133 1133
     public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
1134 1134
     {
1135 1135
         $first_part_to_consider = array_shift($html_name_parts);
1136
-        if (isset($req_data[ $first_part_to_consider ])) {
1136
+        if (isset($req_data[$first_part_to_consider])) {
1137 1137
             if (empty($html_name_parts)) {
1138
-                return $req_data[ $first_part_to_consider ];
1138
+                return $req_data[$first_part_to_consider];
1139 1139
             } else {
1140 1140
                 return $this->findRequestForSectionUsingNameParts(
1141 1141
                     $html_name_parts,
1142
-                    $req_data[ $first_part_to_consider ]
1142
+                    $req_data[$first_part_to_consider]
1143 1143
                 );
1144 1144
             }
1145 1145
         } else {
Please login to merge, or discard this patch.
Indentation   +1255 added lines, -1255 removed lines patch added patch discarded remove patch
@@ -14,1259 +14,1259 @@
 block discarded – undo
14 14
  */
15 15
 abstract class EE_Form_Input_Base extends EE_Form_Section_Validatable
16 16
 {
17
-    /**
18
-     * the input's name attribute
19
-     *
20
-     * @var string
21
-     */
22
-    protected $_html_name;
23
-
24
-    /**
25
-     * id for the html label tag
26
-     *
27
-     * @var string
28
-     */
29
-    protected $_html_label_id;
30
-
31
-    /**
32
-     * class for teh html label tag
33
-     *
34
-     * @var string
35
-     */
36
-    protected $_html_label_class;
37
-
38
-    /**
39
-     * style for teh html label tag
40
-     *
41
-     * @var string
42
-     */
43
-    protected $_html_label_style;
44
-
45
-    /**
46
-     * text to be placed in the html label
47
-     *
48
-     * @var string
49
-     */
50
-    protected $_html_label_text;
51
-
52
-    /**
53
-     * the full html label. If used, all other html_label_* properties are invalid
54
-     *
55
-     * @var string
56
-     */
57
-    protected $_html_label;
58
-
59
-    /**
60
-     * HTML to use for help text (normally placed below form input), in a span which normally
61
-     * has a class of 'description'
62
-     *
63
-     * @var string
64
-     */
65
-    protected $_html_help_text;
66
-
67
-    /**
68
-     * CSS classes for displaying the help span
69
-     *
70
-     * @var string
71
-     */
72
-    protected $_html_help_class = 'description';
73
-
74
-    /**
75
-     * CSS to put in the style attribute on the help span
76
-     *
77
-     * @var string
78
-     */
79
-    protected $_html_help_style;
80
-
81
-    /**
82
-     * Stores whether or not this input's response is required.
83
-     * Because certain styling elements may also want to know that this
84
-     * input is required etc.
85
-     *
86
-     * @var boolean
87
-     */
88
-    protected $_required;
89
-
90
-    /**
91
-     * css class added to required inputs
92
-     *
93
-     * @var string
94
-     */
95
-    protected $_required_css_class = 'ee-required';
96
-
97
-    /**
98
-     * css styles applied to button type inputs
99
-     *
100
-     * @var string
101
-     */
102
-    protected $_button_css_attributes;
103
-
104
-    /**
105
-     * The raw post data submitted for this
106
-     * Generally unsafe for usage in client code
107
-     *
108
-     * @var mixed string or array
109
-     */
110
-    protected $_raw_value;
111
-
112
-    /**
113
-     * Value normalized according to the input's normalization strategy.
114
-     * The normalization strategy dictates whether this is a string, int, float,
115
-     * boolean, or array of any of those.
116
-     *
117
-     * @var mixed
118
-     */
119
-    protected $_normalized_value;
120
-
121
-
122
-    /**
123
-     * Normalized default value either initially set on the input, or provided by calling
124
-     * set_default().
125
-     * @var mixed
126
-     */
127
-    protected $_default;
128
-
129
-    /**
130
-     * Strategy used for displaying this field.
131
-     * Child classes must use _get_display_strategy to access it.
132
-     *
133
-     * @var EE_Display_Strategy_Base
134
-     */
135
-    private $_display_strategy;
136
-
137
-    /**
138
-     * Gets all the validation strategies used on this field
139
-     *
140
-     * @var EE_Validation_Strategy_Base[]
141
-     */
142
-    private $_validation_strategies = array();
143
-
144
-    /**
145
-     * The normalization strategy for this field
146
-     *
147
-     * @var EE_Normalization_Strategy_Base
148
-     */
149
-    private $_normalization_strategy;
150
-
151
-    /**
152
-     * Strategy for removing sensitive data after we're done with the form input
153
-     *
154
-     * @var EE_Sensitive_Data_Removal_Base
155
-     */
156
-    protected $_sensitive_data_removal_strategy;
157
-
158
-    /**
159
-     * Whether this input has been disabled or not.
160
-     * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled.
161
-     * (Client-side code that wants to dynamically disable it must also add this hidden input).
162
-     * When the form is submitted, if the input is disabled in the PHP form section, then input is ignored.
163
-     * If the input is missing from the request data but the hidden input indicating the input is disabled, then the input is again ignored.
164
-     *
165
-     * @var boolean
166
-     */
167
-    protected $disabled = false;
168
-
169
-
170
-
171
-    /**
172
-     * @param array                         $input_args       {
173
-     * @type string                         $html_name        the html name for the input
174
-     * @type string                         $html_label_id    the id attribute to give to the html label tag
175
-     * @type string                         $html_label_class the class attribute to give to the html label tag
176
-     * @type string                         $html_label_style the style attribute to give ot teh label tag
177
-     * @type string                         $html_label_text  the text to put in the label tag
178
-     * @type string                         $html_label       the full html label. If used,
179
-     *                                                        all other html_label_* args are invalid
180
-     * @type string                         $html_help_text   text to put in help element
181
-     * @type string                         $html_help_style  style attribute to give to teh help element
182
-     * @type string                         $html_help_class  class attribute to give to the help element
183
-     * @type string                         $default          default value NORMALIZED (eg, if providing the default
184
-     *       for a Yes_No_Input, you should provide TRUE or FALSE, not '1' or '0')
185
-     * @type EE_Display_Strategy_Base       $display          strategy
186
-     * @type EE_Normalization_Strategy_Base $normalization_strategy
187
-     * @type EE_Validation_Strategy_Base[]  $validation_strategies
188
-     * @type boolean                        $ignore_input special argument which can be used to avoid adding any validation strategies,
189
-     *                                                    and sets the normalization strategy to the Null normalization. This is good
190
-     *                                                    when you want the input to be totally ignored server-side (like when using
191
-     *                                                    React.js form inputs)
192
-     *                                                        }
193
-     */
194
-    public function __construct($input_args = array())
195
-    {
196
-        $input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
197
-        // the following properties must be cast as arrays
198
-        if (isset($input_args['validation_strategies'])) {
199
-            foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
200
-                if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
201
-                    $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
202
-                }
203
-            }
204
-            unset($input_args['validation_strategies']);
205
-        }
206
-        if (isset($input_args['ignore_input'])) {
207
-            $this->_validation_strategies = array();
208
-        }
209
-        // loop thru incoming options
210
-        foreach ($input_args as $key => $value) {
211
-            // add underscore to $key to match property names
212
-            $_key = '_' . $key;
213
-            if (property_exists($this, $_key)) {
214
-                $this->{$_key} = $value;
215
-            }
216
-        }
217
-        // ensure that "required" is set correctly
218
-        $this->set_required(
219
-            $this->_required,
220
-            $input_args['required_validation_error_message'] ?? null
221
-        );
222
-        // $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
223
-        $this->_display_strategy->_construct_finalize($this);
224
-        foreach ($this->_validation_strategies as $validation_strategy) {
225
-            $validation_strategy->_construct_finalize($this);
226
-        }
227
-        if (isset($input_args['ignore_input'])) {
228
-            $this->_normalization_strategy = new EE_Null_Normalization();
229
-        }
230
-        if (! $this->_normalization_strategy) {
231
-                $this->_normalization_strategy = new EE_Text_Normalization();
232
-        }
233
-        $this->_normalization_strategy->_construct_finalize($this);
234
-        // at least we can use the normalization strategy to populate the default
235
-        if (isset($input_args['default'])) {
236
-            $this->set_default($input_args['default']);
237
-            unset($input_args['default']);
238
-        }
239
-        if (! $this->_sensitive_data_removal_strategy) {
240
-            $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
241
-        }
242
-        $this->_sensitive_data_removal_strategy->_construct_finalize($this);
243
-        parent::__construct($input_args);
244
-    }
245
-
246
-
247
-
248
-    /**
249
-     * Sets the html_name to its default value, if none was specified in teh constructor.
250
-     * Calculation involves using the name and the parent's html_name
251
-     *
252
-     * @throws EE_Error
253
-     */
254
-    protected function _set_default_html_name_if_empty()
255
-    {
256
-        if (! $this->_html_name) {
257
-            $this->_html_name = $this->name();
258
-            if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
259
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
260
-            }
261
-        }
262
-    }
263
-
264
-
265
-
266
-    /**
267
-     * @param $parent_form_section
268
-     * @param $name
269
-     * @throws EE_Error
270
-     */
271
-    public function _construct_finalize($parent_form_section, $name)
272
-    {
273
-        parent::_construct_finalize($parent_form_section, $name);
274
-        if ($this->_html_label === null && $this->_html_label_text === null) {
275
-            $this->_html_label_text = ucwords(str_replace("_", " ", $name));
276
-        }
277
-        do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
278
-    }
279
-
280
-
281
-
282
-    /**
283
-     * Returns the strategy for displaying this form input. If none is set, throws an exception.
284
-     *
285
-     * @return EE_Display_Strategy_Base
286
-     * @throws EE_Error
287
-     */
288
-    protected function _get_display_strategy()
289
-    {
290
-        $this->ensure_construct_finalized_called();
291
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
292
-            throw new EE_Error(
293
-                sprintf(
294
-                    esc_html__(
295
-                        "Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
296
-                        "event_espresso"
297
-                    ),
298
-                    $this->html_name(),
299
-                    $this->html_id()
300
-                )
301
-            );
302
-        } else {
303
-            return $this->_display_strategy;
304
-        }
305
-    }
306
-
307
-
308
-
309
-    /**
310
-     * Sets the display strategy.
311
-     *
312
-     * @param EE_Display_Strategy_Base $strategy
313
-     */
314
-    protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
315
-    {
316
-        $this->_display_strategy = $strategy;
317
-    }
318
-
319
-
320
-
321
-    /**
322
-     * Sets the sanitization strategy
323
-     *
324
-     * @param EE_Normalization_Strategy_Base $strategy
325
-     */
326
-    protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
327
-    {
328
-        $this->_normalization_strategy = $strategy;
329
-    }
330
-
331
-
332
-
333
-    /**
334
-     * Gets sensitive_data_removal_strategy
335
-     *
336
-     * @return EE_Sensitive_Data_Removal_Base
337
-     */
338
-    public function get_sensitive_data_removal_strategy()
339
-    {
340
-        return $this->_sensitive_data_removal_strategy;
341
-    }
342
-
343
-
344
-
345
-    /**
346
-     * Sets sensitive_data_removal_strategy
347
-     *
348
-     * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
349
-     * @return void
350
-     */
351
-    public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
352
-    {
353
-        $this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
354
-    }
355
-
356
-
357
-
358
-    /**
359
-     * Gets the display strategy for this input
360
-     *
361
-     * @return EE_Display_Strategy_Base
362
-     */
363
-    public function get_display_strategy()
364
-    {
365
-        return $this->_display_strategy;
366
-    }
367
-
368
-
369
-
370
-    /**
371
-     * Overwrites the display strategy
372
-     *
373
-     * @param EE_Display_Strategy_Base $display_strategy
374
-     */
375
-    public function set_display_strategy($display_strategy)
376
-    {
377
-        $this->_display_strategy = $display_strategy;
378
-        $this->_display_strategy->_construct_finalize($this);
379
-    }
380
-
381
-
382
-
383
-    /**
384
-     * Gets the normalization strategy set on this input
385
-     *
386
-     * @return EE_Normalization_Strategy_Base
387
-     */
388
-    public function get_normalization_strategy()
389
-    {
390
-        return $this->_normalization_strategy;
391
-    }
392
-
393
-
394
-
395
-    /**
396
-     * Overwrites the normalization strategy
397
-     *
398
-     * @param EE_Normalization_Strategy_Base $normalization_strategy
399
-     */
400
-    public function set_normalization_strategy($normalization_strategy)
401
-    {
402
-        $this->_normalization_strategy = $normalization_strategy;
403
-        $this->_normalization_strategy->_construct_finalize($this);
404
-    }
405
-
406
-
407
-
408
-    /**
409
-     * Returns all teh validation strategies which apply to this field, numerically indexed
410
-     *
411
-     * @return EE_Validation_Strategy_Base[]
412
-     */
413
-    public function get_validation_strategies()
414
-    {
415
-        return $this->_validation_strategies;
416
-    }
417
-
418
-
419
-
420
-    /**
421
-     * Adds this strategy to the field so it will be used in both JS validation and server-side validation
422
-     *
423
-     * @param EE_Validation_Strategy_Base $validation_strategy
424
-     * @return void
425
-     */
426
-    protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
427
-    {
428
-        $validation_strategy->_construct_finalize($this);
429
-        $this->_validation_strategies[] = $validation_strategy;
430
-    }
431
-
432
-
433
-
434
-    /**
435
-     * Adds a new validation strategy onto the form input
436
-     *
437
-     * @param EE_Validation_Strategy_Base $validation_strategy
438
-     * @return void
439
-     */
440
-    public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
441
-    {
442
-        $this->_add_validation_strategy($validation_strategy);
443
-    }
444
-
445
-
446
-
447
-    /**
448
-     * The classname of the validation strategy to remove
449
-     *
450
-     * @param string $validation_strategy_classname
451
-     */
452
-    public function remove_validation_strategy($validation_strategy_classname)
453
-    {
454
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
455
-            if (
456
-                $validation_strategy instanceof $validation_strategy_classname
457
-                || is_subclass_of($validation_strategy, $validation_strategy_classname)
458
-            ) {
459
-                unset($this->_validation_strategies[ $key ]);
460
-            }
461
-        }
462
-    }
463
-
464
-
465
-
466
-    /**
467
-     * returns true if input employs any of the validation strategy defined by the supplied array of classnames
468
-     *
469
-     * @param array $validation_strategy_classnames
470
-     * @return bool
471
-     */
472
-    public function has_validation_strategy($validation_strategy_classnames)
473
-    {
474
-        $validation_strategy_classnames = is_array($validation_strategy_classnames)
475
-            ? $validation_strategy_classnames
476
-            : array($validation_strategy_classnames);
477
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
478
-            if (in_array($key, $validation_strategy_classnames)) {
479
-                return true;
480
-            }
481
-        }
482
-        return false;
483
-    }
484
-
485
-
486
-
487
-    /**
488
-     * Gets the HTML
489
-     *
490
-     * @return string
491
-     */
492
-    public function get_html()
493
-    {
494
-        return $this->_parent_section->get_html_for_input($this);
495
-    }
496
-
497
-
498
-
499
-    /**
500
-     * Gets the HTML for the input itself (no label or errors) according to the
501
-     * input's display strategy
502
-     * Makes sure the JS and CSS are enqueued for it
503
-     *
504
-     * @return string
505
-     * @throws EE_Error
506
-     */
507
-    public function get_html_for_input()
508
-    {
509
-        return $this->_form_html_filter
510
-            ? $this->_form_html_filter->filterHtml(
511
-                $this->_get_display_strategy()->display(),
512
-                $this
513
-            )
514
-            : $this->_get_display_strategy()->display();
515
-    }
516
-
517
-
518
-
519
-    /**
520
-     * @return string
521
-     */
522
-    public function html_other_attributes()
523
-    {
524
-        EE_Error::doing_it_wrong(
525
-            __METHOD__,
526
-            sprintf(
527
-                esc_html__(
528
-                    'This method is no longer in use. You should replace it by %s',
529
-                    'event_espresso'
530
-                ),
531
-                'EE_Form_Section_Base::other_html_attributes()'
532
-            ),
533
-            '4.10.2.p'
534
-        );
535
-
536
-        return $this->other_html_attributes();
537
-    }
538
-
539
-
540
-
541
-    /**
542
-     * @param string $html_other_attributes
543
-     */
544
-    public function set_html_other_attributes($html_other_attributes)
545
-    {
546
-        EE_Error::doing_it_wrong(
547
-            __METHOD__,
548
-            sprintf(
549
-                esc_html__(
550
-                    'This method is no longer in use. You should replace it by %s',
551
-                    'event_espresso'
552
-                ),
553
-                'EE_Form_Section_Base::set_other_html_attributes()'
554
-            ),
555
-            '4.10.2.p'
556
-        );
557
-
558
-        $this->set_other_html_attributes($html_other_attributes);
559
-    }
560
-
561
-
562
-
563
-    /**
564
-     * Gets the HTML for displaying the label for this form input
565
-     * according to the form section's layout strategy
566
-     *
567
-     * @return string
568
-     */
569
-    public function get_html_for_label()
570
-    {
571
-        return $this->_parent_section->get_layout_strategy()->display_label($this);
572
-    }
573
-
574
-
575
-
576
-    /**
577
-     * Gets the HTML for displaying the errors section for this form input
578
-     * according to the form section's layout strategy
579
-     *
580
-     * @return string
581
-     */
582
-    public function get_html_for_errors()
583
-    {
584
-        return $this->_parent_section->get_layout_strategy()->display_errors($this);
585
-    }
586
-
587
-
588
-
589
-    /**
590
-     * Gets the HTML for displaying the help text for this form input
591
-     * according to the form section's layout strategy
592
-     *
593
-     * @return string
594
-     */
595
-    public function get_html_for_help()
596
-    {
597
-        return $this->_parent_section->get_layout_strategy()->display_help_text($this);
598
-    }
599
-
600
-
601
-
602
-    /**
603
-     * Validates the input's sanitized value (assumes _sanitize() has already been called)
604
-     * and returns whether or not the form input's submitted value is value
605
-     *
606
-     * @return boolean
607
-     */
608
-    protected function _validate()
609
-    {
610
-        if ($this->isDisabled()) {
611
-            return true;
612
-        }
613
-        foreach ($this->_validation_strategies as $validation_strategy) {
614
-            if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
615
-                try {
616
-                    $validation_strategy->validate($this->normalized_value());
617
-                } catch (EE_Validation_Error $e) {
618
-                    $this->add_validation_error($e);
619
-                }
620
-            }
621
-        }
622
-        if ($this->get_validation_errors()) {
623
-            return false;
624
-        } else {
625
-            return true;
626
-        }
627
-    }
628
-
629
-
630
-
631
-    /**
632
-     * Performs basic sanitization on this value. But what sanitization can be performed anyways?
633
-     * This value MIGHT be allowed to have tags, so we can't really remove them.
634
-     *
635
-     * @param string $value
636
-     * @return null|string
637
-     */
638
-    protected function _sanitize($value)
639
-    {
640
-        return $value !== null ? stripslashes(html_entity_decode(trim($value))) : null;
641
-    }
642
-
643
-
644
-
645
-    /**
646
-     * Picks out the form value that relates to this form input,
647
-     * and stores it as the sanitized value on the form input, and sets the normalized value.
648
-     * Returns whether or not any validation errors occurred
649
-     *
650
-     * @param array $req_data
651
-     * @return boolean whether or not there was an error
652
-     * @throws EE_Error
653
-     */
654
-    protected function _normalize($req_data)
655
-    {
656
-        // any existing validation errors don't apply so clear them
657
-        $this->_validation_errors = array();
658
-        // if the input is disabled, ignore whatever input was sent in
659
-        if ($this->isDisabled()) {
660
-            $this->_set_raw_value(null);
661
-            $this->_set_normalized_value($this->get_default());
662
-            return false;
663
-        }
664
-        try {
665
-            $raw_input = $this->find_form_data_for_this_section($req_data);
666
-            // super simple sanitization for now
667
-            if (is_array($raw_input)) {
668
-                $raw_value = array();
669
-                foreach ($raw_input as $key => $value) {
670
-                    $raw_value[ $key ] = $this->_sanitize($value);
671
-                }
672
-                $this->_set_raw_value($raw_value);
673
-            } else {
674
-                $this->_set_raw_value($this->_sanitize($raw_input));
675
-            }
676
-            // we want to mostly leave the input alone in case we need to re-display it to the user
677
-            $this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
678
-            return false;
679
-        } catch (EE_Validation_Error $e) {
680
-            $this->add_validation_error($e);
681
-            return true;
682
-        }
683
-    }
684
-
685
-
686
-    /**
687
-     * @return string
688
-     * @throws EE_Error
689
-     */
690
-    public function html_name()
691
-    {
692
-        $this->_set_default_html_name_if_empty();
693
-        return $this->_html_name;
694
-    }
695
-
696
-
697
-    /**
698
-     * @return string
699
-     * @throws EE_Error
700
-     */
701
-    public function html_label_id()
702
-    {
703
-        return ! empty($this->_html_label_id) ? $this->_html_label_id : $this->html_id() . '-lbl';
704
-    }
705
-
706
-
707
-
708
-    /**
709
-     * @return string
710
-     */
711
-    public function html_label_class()
712
-    {
713
-        return $this->_html_label_class;
714
-    }
715
-
716
-
717
-
718
-    /**
719
-     * @return string
720
-     */
721
-    public function html_label_style()
722
-    {
723
-        return $this->_html_label_style;
724
-    }
725
-
726
-
727
-
728
-    /**
729
-     * @return string
730
-     */
731
-    public function html_label_text()
732
-    {
733
-        return $this->_html_label_text;
734
-    }
735
-
736
-
737
-
738
-    /**
739
-     * @return string
740
-     */
741
-    public function html_help_text()
742
-    {
743
-        return $this->_html_help_text;
744
-    }
745
-
746
-
747
-
748
-    /**
749
-     * @return string
750
-     */
751
-    public function html_help_class()
752
-    {
753
-        return $this->_html_help_class;
754
-    }
755
-
756
-
757
-
758
-    /**
759
-     * @return string
760
-     */
761
-    public function html_help_style()
762
-    {
763
-        return $this->_html_style;
764
-    }
765
-
766
-
767
-
768
-    /**
769
-     * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
770
-     * Please note that almost all client code should instead use the normalized_value;
771
-     * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
772
-     * mostly by escaping quotes)
773
-     * Note, we do not store the exact original value sent in the user's request because
774
-     * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
775
-     * in which case, we would have stored the malicious content to our database.
776
-     *
777
-     * @return string
778
-     */
779
-    public function raw_value()
780
-    {
781
-        return $this->_raw_value;
782
-    }
783
-
784
-
785
-
786
-    /**
787
-     * Returns a string safe to usage in form inputs when displaying, because
788
-     * it escapes all html entities
789
-     *
790
-     * @return string
791
-     */
792
-    public function raw_value_in_form()
793
-    {
794
-        return htmlentities($this->raw_value(), ENT_QUOTES, 'UTF-8');
795
-    }
796
-
797
-
798
-
799
-    /**
800
-     * returns the value after it's been sanitized, and then converted into it's proper type
801
-     * in PHP. Eg, a string, an int, an array,
802
-     *
803
-     * @return mixed
804
-     */
805
-    public function normalized_value()
806
-    {
807
-        return $this->_normalized_value;
808
-    }
809
-
810
-
811
-
812
-    /**
813
-     * Returns the normalized value is a presentable way. By default this is just
814
-     * the normalized value by itself, but it can be overridden for when that's not
815
-     * the best thing to display
816
-     *
817
-     * @return string
818
-     */
819
-    public function pretty_value()
820
-    {
821
-        return $this->_normalized_value;
822
-    }
823
-
824
-
825
-
826
-    /**
827
-     * When generating the JS for the jquery validation rules like<br>
828
-     * <code>$( "#myform" ).validate({
829
-     * rules: {
830
-     * password: "required",
831
-     * password_again: {
832
-     * equalTo: "#password"
833
-     * }
834
-     * }
835
-     * });</code>
836
-     * if this field had the name 'password_again', it should return
837
-     * <br><code>password_again: {
838
-     * equalTo: "#password"
839
-     * }</code>
840
-     *
841
-     * @return array
842
-     */
843
-    public function get_jquery_validation_rules()
844
-    {
845
-        $jquery_validation_js = array();
846
-        $jquery_validation_rules = array();
847
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
848
-            $jquery_validation_rules = array_replace_recursive(
849
-                $jquery_validation_rules,
850
-                $validation_strategy->get_jquery_validation_rule_array()
851
-            );
852
-        }
853
-        if (! empty($jquery_validation_rules)) {
854
-            foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
855
-                $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
856
-            }
857
-        }
858
-        return $jquery_validation_js;
859
-    }
860
-
861
-
862
-
863
-    /**
864
-     * Sets the input's default value for use in displaying in the form. Note: value should be
865
-     * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
866
-     *
867
-     * @param mixed $value
868
-     * @return void
869
-     */
870
-    public function set_default($value)
871
-    {
872
-        $this->_default = $value;
873
-        $this->_set_normalized_value($value);
874
-        $this->_set_raw_value($value);
875
-    }
876
-
877
-
878
-
879
-    /**
880
-     * Sets the normalized value on this input
881
-     *
882
-     * @param mixed $value
883
-     */
884
-    protected function _set_normalized_value($value)
885
-    {
886
-        $this->_normalized_value = $value;
887
-    }
888
-
889
-
890
-
891
-    /**
892
-     * Sets the raw value on this input (ie, exactly as the user submitted it)
893
-     *
894
-     * @param mixed $value
895
-     */
896
-    protected function _set_raw_value($value)
897
-    {
898
-        $this->_raw_value = $this->_normalization_strategy->unnormalize($value);
899
-    }
900
-
901
-
902
-
903
-    /**
904
-     * Sets the HTML label text after it has already been defined
905
-     *
906
-     * @param string $label
907
-     * @return void
908
-     */
909
-    public function set_html_label_text($label)
910
-    {
911
-        $this->_html_label_text = $label;
912
-    }
913
-
914
-
915
-
916
-    /**
917
-     * Sets whether or not this field is required, and adjusts the validation strategy.
918
-     * If you want to use the EE_Conditionally_Required_Validation_Strategy,
919
-     * please add it as a validation strategy using add_validation_strategy as normal
920
-     *
921
-     * @param boolean $required boolean
922
-     * @param null    $required_text
923
-     */
924
-    public function set_required($required = true, $required_text = null)
925
-    {
926
-        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
927
-        // whether $required is a string or a boolean, we want to add a required validation strategy
928
-        if ($required) {
929
-            $this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
930
-        } else {
931
-            $this->remove_validation_strategy('EE_Required_Validation_Strategy');
932
-        }
933
-        $this->_required = $required;
934
-    }
935
-
936
-
937
-
938
-    /**
939
-     * Returns whether or not this field is required
940
-     *
941
-     * @return boolean
942
-     */
943
-    public function required()
944
-    {
945
-        return $this->_required;
946
-    }
947
-
948
-
949
-
950
-    /**
951
-     * @param string $required_css_class
952
-     */
953
-    public function set_required_css_class($required_css_class)
954
-    {
955
-        $this->_required_css_class = $required_css_class;
956
-    }
957
-
958
-
959
-
960
-    /**
961
-     * @return string
962
-     */
963
-    public function required_css_class()
964
-    {
965
-        return $this->_required_css_class;
966
-    }
967
-
968
-
969
-
970
-    /**
971
-     * @param bool $add_required
972
-     * @return string
973
-     */
974
-    public function html_class($add_required = false)
975
-    {
976
-        return $add_required && $this->required()
977
-            ? $this->required_css_class() . ' ' . $this->_html_class
978
-            : $this->_html_class;
979
-    }
980
-
981
-
982
-    /**
983
-     * Sets the help text, in case
984
-     *
985
-     * @param string $text
986
-     */
987
-    public function set_html_help_text($text)
988
-    {
989
-        $this->_html_help_text = $text;
990
-    }
991
-
992
-
993
-
994
-    /**
995
-     * Uses the sensitive data removal strategy to remove the sensitive data from this
996
-     * input. If there is any kind of sensitive data removal on this input, we clear
997
-     * out the raw value completely
998
-     *
999
-     * @return void
1000
-     */
1001
-    public function clean_sensitive_data()
1002
-    {
1003
-        // if we do ANY kind of sensitive data removal on this, then just clear out the raw value
1004
-        // if we need more logic than this we'll make a strategy for it
1005
-        if (
1006
-            $this->_sensitive_data_removal_strategy
1007
-            && ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
1008
-        ) {
1009
-            $this->_set_raw_value(null);
1010
-        }
1011
-        // and clean the normalized value according to the appropriate strategy
1012
-        $this->_set_normalized_value(
1013
-            $this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
1014
-                $this->_normalized_value
1015
-            )
1016
-        );
1017
-    }
1018
-
1019
-
1020
-
1021
-    /**
1022
-     * @param bool   $primary
1023
-     * @param string $button_size
1024
-     * @param string $other_attributes
1025
-     */
1026
-    public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
1027
-    {
1028
-        $button_css_attributes = 'button';
1029
-        $button_css_attributes .= $primary === true ? ' button--primary' : ' button--secondary';
1030
-        switch ($button_size) {
1031
-            case 'xs':
1032
-            case 'extra-small':
1033
-                $button_css_attributes .= ' button-xs';
1034
-                break;
1035
-            case 'sm':
1036
-            case 'small':
1037
-                $button_css_attributes .= ' button-sm';
1038
-                break;
1039
-            case 'lg':
1040
-            case 'large':
1041
-                $button_css_attributes .= ' button-lg';
1042
-                break;
1043
-            case 'block':
1044
-                $button_css_attributes .= ' button-block';
1045
-                break;
1046
-            case 'md':
1047
-            case 'medium':
1048
-            default:
1049
-                $button_css_attributes .= '';
1050
-        }
1051
-        $this->_button_css_attributes .= ! empty($other_attributes)
1052
-            ? $button_css_attributes . ' ' . $other_attributes
1053
-            : $button_css_attributes;
1054
-    }
1055
-
1056
-
1057
-
1058
-    /**
1059
-     * @return string
1060
-     */
1061
-    public function button_css_attributes()
1062
-    {
1063
-        if (empty($this->_button_css_attributes)) {
1064
-            $this->set_button_css_attributes();
1065
-        }
1066
-        return $this->_button_css_attributes;
1067
-    }
1068
-
1069
-
1070
-
1071
-    /**
1072
-     * find_form_data_for_this_section
1073
-     * using this section's name and its parents, finds the value of the form data that corresponds to it.
1074
-     * For example, if this form section's HTML name is my_form[subform][form_input_1],
1075
-     * then it's value should be in request at request['my_form']['subform']['form_input_1'].
1076
-     * (If that doesn't exist, we also check for this subsection's name
1077
-     * at the TOP LEVEL of the request data. Eg request['form_input_1'].)
1078
-     * This function finds its value in the form.
1079
-     *
1080
-     * @param array $req_data
1081
-     * @return mixed whatever the raw value of this form section is in the request data
1082
-     * @throws EE_Error
1083
-     */
1084
-    public function find_form_data_for_this_section($req_data)
1085
-    {
1086
-        $name_parts = $this->getInputNameParts();
1087
-        // now get the value for the input
1088
-        $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
1089
-        // check if this thing's name is at the TOP level of the request data
1090
-        if ($value === null && isset($req_data[ $this->name() ])) {
1091
-            $value = $req_data[ $this->name() ];
1092
-        }
1093
-        return $value;
1094
-    }
1095
-
1096
-
1097
-    /**
1098
-     * If this input's name is something like "foo[bar][baz]"
1099
-     * returns an array like `array('foo','bar',baz')`
1100
-     *
1101
-     * @return array
1102
-     * @throws EE_Error
1103
-     */
1104
-    protected function getInputNameParts()
1105
-    {
1106
-        // break up the html name by "[]"
1107
-        if (strpos($this->html_name(), '[') !== false) {
1108
-            $before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
1109
-        } else {
1110
-            $before_any_brackets = $this->html_name();
1111
-        }
1112
-        // grab all of the segments
1113
-        preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
1114
-        if (isset($matches[1]) && is_array($matches[1])) {
1115
-            $name_parts = $matches[1];
1116
-            array_unshift($name_parts, $before_any_brackets);
1117
-        } else {
1118
-            $name_parts = array($before_any_brackets);
1119
-        }
1120
-        return $name_parts;
1121
-    }
1122
-
1123
-
1124
-
1125
-    /**
1126
-     * @param array $html_name_parts
1127
-     * @param array $req_data
1128
-     * @return array | NULL
1129
-     */
1130
-    public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
1131
-    {
1132
-        $first_part_to_consider = array_shift($html_name_parts);
1133
-        if (isset($req_data[ $first_part_to_consider ])) {
1134
-            if (empty($html_name_parts)) {
1135
-                return $req_data[ $first_part_to_consider ];
1136
-            } else {
1137
-                return $this->findRequestForSectionUsingNameParts(
1138
-                    $html_name_parts,
1139
-                    $req_data[ $first_part_to_consider ]
1140
-                );
1141
-            }
1142
-        } else {
1143
-            return null;
1144
-        }
1145
-    }
1146
-
1147
-
1148
-
1149
-    /**
1150
-     * Checks if this form input's data is in the request data
1151
-     *
1152
-     * @param array $req_data
1153
-     * @return boolean
1154
-     * @throws EE_Error
1155
-     */
1156
-    public function form_data_present_in($req_data = null)
1157
-    {
1158
-        if ($req_data === null) {
1159
-            /** @var RequestInterface $request */
1160
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
1161
-            $req_data = $request->postParams();
1162
-        }
1163
-        $checked_value = $this->find_form_data_for_this_section($req_data);
1164
-        if ($checked_value !== null) {
1165
-            return true;
1166
-        } else {
1167
-            return false;
1168
-        }
1169
-    }
1170
-
1171
-
1172
-
1173
-    /**
1174
-     * Overrides parent to add js data from validation and display strategies
1175
-     *
1176
-     * @param array $form_other_js_data
1177
-     * @return array
1178
-     */
1179
-    public function get_other_js_data($form_other_js_data = array())
1180
-    {
1181
-        return $this->get_other_js_data_from_strategies($form_other_js_data);
1182
-    }
1183
-
1184
-
1185
-
1186
-    /**
1187
-     * Gets other JS data for localization from this input's strategies, like
1188
-     * the validation strategies and the display strategy
1189
-     *
1190
-     * @param array $form_other_js_data
1191
-     * @return array
1192
-     */
1193
-    public function get_other_js_data_from_strategies($form_other_js_data = array())
1194
-    {
1195
-        $form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
1196
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
1197
-            $form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
1198
-        }
1199
-        return $form_other_js_data;
1200
-    }
1201
-
1202
-
1203
-
1204
-    /**
1205
-     * Override parent because we want to give our strategies an opportunity to enqueue some js and css
1206
-     *
1207
-     * @return void
1208
-     */
1209
-    public function enqueue_js()
1210
-    {
1211
-        // ask our display strategy and validation strategies if they have js to enqueue
1212
-        $this->enqueue_js_from_strategies();
1213
-    }
1214
-
1215
-
1216
-
1217
-    /**
1218
-     * Tells strategies when its ok to enqueue their js and css
1219
-     *
1220
-     * @return void
1221
-     */
1222
-    public function enqueue_js_from_strategies()
1223
-    {
1224
-        $this->get_display_strategy()->enqueue_js();
1225
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
1226
-            $validation_strategy->enqueue_js();
1227
-        }
1228
-    }
1229
-
1230
-
1231
-
1232
-    /**
1233
-     * Gets the default value set on the input (not the current value, which may have been
1234
-     * changed because of a form submission). If no default was set, this us null.
1235
-     * @return mixed
1236
-     */
1237
-    public function get_default()
1238
-    {
1239
-        return $this->_default;
1240
-    }
1241
-
1242
-
1243
-
1244
-    /**
1245
-     * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"',
1246
-     * and server-side if any input was received it will be ignored
1247
-     */
1248
-    public function disable($disable = true)
1249
-    {
1250
-        $disabled_attribute = ' disabled="disabled"';
1251
-        $this->disabled = filter_var($disable, FILTER_VALIDATE_BOOLEAN);
1252
-        if ($this->disabled) {
1253
-            if (strpos($this->_other_html_attributes, $disabled_attribute) === false) {
1254
-                $this->_other_html_attributes .= $disabled_attribute;
1255
-            }
1256
-            $this->_set_normalized_value($this->get_default());
1257
-        } else {
1258
-            $this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes);
1259
-        }
1260
-    }
1261
-
1262
-
1263
-
1264
-    /**
1265
-     * Returns whether or not this input is currently disabled.
1266
-     * @return bool
1267
-     */
1268
-    public function isDisabled()
1269
-    {
1270
-        return $this->disabled;
1271
-    }
17
+	/**
18
+	 * the input's name attribute
19
+	 *
20
+	 * @var string
21
+	 */
22
+	protected $_html_name;
23
+
24
+	/**
25
+	 * id for the html label tag
26
+	 *
27
+	 * @var string
28
+	 */
29
+	protected $_html_label_id;
30
+
31
+	/**
32
+	 * class for teh html label tag
33
+	 *
34
+	 * @var string
35
+	 */
36
+	protected $_html_label_class;
37
+
38
+	/**
39
+	 * style for teh html label tag
40
+	 *
41
+	 * @var string
42
+	 */
43
+	protected $_html_label_style;
44
+
45
+	/**
46
+	 * text to be placed in the html label
47
+	 *
48
+	 * @var string
49
+	 */
50
+	protected $_html_label_text;
51
+
52
+	/**
53
+	 * the full html label. If used, all other html_label_* properties are invalid
54
+	 *
55
+	 * @var string
56
+	 */
57
+	protected $_html_label;
58
+
59
+	/**
60
+	 * HTML to use for help text (normally placed below form input), in a span which normally
61
+	 * has a class of 'description'
62
+	 *
63
+	 * @var string
64
+	 */
65
+	protected $_html_help_text;
66
+
67
+	/**
68
+	 * CSS classes for displaying the help span
69
+	 *
70
+	 * @var string
71
+	 */
72
+	protected $_html_help_class = 'description';
73
+
74
+	/**
75
+	 * CSS to put in the style attribute on the help span
76
+	 *
77
+	 * @var string
78
+	 */
79
+	protected $_html_help_style;
80
+
81
+	/**
82
+	 * Stores whether or not this input's response is required.
83
+	 * Because certain styling elements may also want to know that this
84
+	 * input is required etc.
85
+	 *
86
+	 * @var boolean
87
+	 */
88
+	protected $_required;
89
+
90
+	/**
91
+	 * css class added to required inputs
92
+	 *
93
+	 * @var string
94
+	 */
95
+	protected $_required_css_class = 'ee-required';
96
+
97
+	/**
98
+	 * css styles applied to button type inputs
99
+	 *
100
+	 * @var string
101
+	 */
102
+	protected $_button_css_attributes;
103
+
104
+	/**
105
+	 * The raw post data submitted for this
106
+	 * Generally unsafe for usage in client code
107
+	 *
108
+	 * @var mixed string or array
109
+	 */
110
+	protected $_raw_value;
111
+
112
+	/**
113
+	 * Value normalized according to the input's normalization strategy.
114
+	 * The normalization strategy dictates whether this is a string, int, float,
115
+	 * boolean, or array of any of those.
116
+	 *
117
+	 * @var mixed
118
+	 */
119
+	protected $_normalized_value;
120
+
121
+
122
+	/**
123
+	 * Normalized default value either initially set on the input, or provided by calling
124
+	 * set_default().
125
+	 * @var mixed
126
+	 */
127
+	protected $_default;
128
+
129
+	/**
130
+	 * Strategy used for displaying this field.
131
+	 * Child classes must use _get_display_strategy to access it.
132
+	 *
133
+	 * @var EE_Display_Strategy_Base
134
+	 */
135
+	private $_display_strategy;
136
+
137
+	/**
138
+	 * Gets all the validation strategies used on this field
139
+	 *
140
+	 * @var EE_Validation_Strategy_Base[]
141
+	 */
142
+	private $_validation_strategies = array();
143
+
144
+	/**
145
+	 * The normalization strategy for this field
146
+	 *
147
+	 * @var EE_Normalization_Strategy_Base
148
+	 */
149
+	private $_normalization_strategy;
150
+
151
+	/**
152
+	 * Strategy for removing sensitive data after we're done with the form input
153
+	 *
154
+	 * @var EE_Sensitive_Data_Removal_Base
155
+	 */
156
+	protected $_sensitive_data_removal_strategy;
157
+
158
+	/**
159
+	 * Whether this input has been disabled or not.
160
+	 * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled.
161
+	 * (Client-side code that wants to dynamically disable it must also add this hidden input).
162
+	 * When the form is submitted, if the input is disabled in the PHP form section, then input is ignored.
163
+	 * If the input is missing from the request data but the hidden input indicating the input is disabled, then the input is again ignored.
164
+	 *
165
+	 * @var boolean
166
+	 */
167
+	protected $disabled = false;
168
+
169
+
170
+
171
+	/**
172
+	 * @param array                         $input_args       {
173
+	 * @type string                         $html_name        the html name for the input
174
+	 * @type string                         $html_label_id    the id attribute to give to the html label tag
175
+	 * @type string                         $html_label_class the class attribute to give to the html label tag
176
+	 * @type string                         $html_label_style the style attribute to give ot teh label tag
177
+	 * @type string                         $html_label_text  the text to put in the label tag
178
+	 * @type string                         $html_label       the full html label. If used,
179
+	 *                                                        all other html_label_* args are invalid
180
+	 * @type string                         $html_help_text   text to put in help element
181
+	 * @type string                         $html_help_style  style attribute to give to teh help element
182
+	 * @type string                         $html_help_class  class attribute to give to the help element
183
+	 * @type string                         $default          default value NORMALIZED (eg, if providing the default
184
+	 *       for a Yes_No_Input, you should provide TRUE or FALSE, not '1' or '0')
185
+	 * @type EE_Display_Strategy_Base       $display          strategy
186
+	 * @type EE_Normalization_Strategy_Base $normalization_strategy
187
+	 * @type EE_Validation_Strategy_Base[]  $validation_strategies
188
+	 * @type boolean                        $ignore_input special argument which can be used to avoid adding any validation strategies,
189
+	 *                                                    and sets the normalization strategy to the Null normalization. This is good
190
+	 *                                                    when you want the input to be totally ignored server-side (like when using
191
+	 *                                                    React.js form inputs)
192
+	 *                                                        }
193
+	 */
194
+	public function __construct($input_args = array())
195
+	{
196
+		$input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
197
+		// the following properties must be cast as arrays
198
+		if (isset($input_args['validation_strategies'])) {
199
+			foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
200
+				if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
201
+					$this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
202
+				}
203
+			}
204
+			unset($input_args['validation_strategies']);
205
+		}
206
+		if (isset($input_args['ignore_input'])) {
207
+			$this->_validation_strategies = array();
208
+		}
209
+		// loop thru incoming options
210
+		foreach ($input_args as $key => $value) {
211
+			// add underscore to $key to match property names
212
+			$_key = '_' . $key;
213
+			if (property_exists($this, $_key)) {
214
+				$this->{$_key} = $value;
215
+			}
216
+		}
217
+		// ensure that "required" is set correctly
218
+		$this->set_required(
219
+			$this->_required,
220
+			$input_args['required_validation_error_message'] ?? null
221
+		);
222
+		// $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
223
+		$this->_display_strategy->_construct_finalize($this);
224
+		foreach ($this->_validation_strategies as $validation_strategy) {
225
+			$validation_strategy->_construct_finalize($this);
226
+		}
227
+		if (isset($input_args['ignore_input'])) {
228
+			$this->_normalization_strategy = new EE_Null_Normalization();
229
+		}
230
+		if (! $this->_normalization_strategy) {
231
+				$this->_normalization_strategy = new EE_Text_Normalization();
232
+		}
233
+		$this->_normalization_strategy->_construct_finalize($this);
234
+		// at least we can use the normalization strategy to populate the default
235
+		if (isset($input_args['default'])) {
236
+			$this->set_default($input_args['default']);
237
+			unset($input_args['default']);
238
+		}
239
+		if (! $this->_sensitive_data_removal_strategy) {
240
+			$this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
241
+		}
242
+		$this->_sensitive_data_removal_strategy->_construct_finalize($this);
243
+		parent::__construct($input_args);
244
+	}
245
+
246
+
247
+
248
+	/**
249
+	 * Sets the html_name to its default value, if none was specified in teh constructor.
250
+	 * Calculation involves using the name and the parent's html_name
251
+	 *
252
+	 * @throws EE_Error
253
+	 */
254
+	protected function _set_default_html_name_if_empty()
255
+	{
256
+		if (! $this->_html_name) {
257
+			$this->_html_name = $this->name();
258
+			if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
259
+				$this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
260
+			}
261
+		}
262
+	}
263
+
264
+
265
+
266
+	/**
267
+	 * @param $parent_form_section
268
+	 * @param $name
269
+	 * @throws EE_Error
270
+	 */
271
+	public function _construct_finalize($parent_form_section, $name)
272
+	{
273
+		parent::_construct_finalize($parent_form_section, $name);
274
+		if ($this->_html_label === null && $this->_html_label_text === null) {
275
+			$this->_html_label_text = ucwords(str_replace("_", " ", $name));
276
+		}
277
+		do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
278
+	}
279
+
280
+
281
+
282
+	/**
283
+	 * Returns the strategy for displaying this form input. If none is set, throws an exception.
284
+	 *
285
+	 * @return EE_Display_Strategy_Base
286
+	 * @throws EE_Error
287
+	 */
288
+	protected function _get_display_strategy()
289
+	{
290
+		$this->ensure_construct_finalized_called();
291
+		if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
292
+			throw new EE_Error(
293
+				sprintf(
294
+					esc_html__(
295
+						"Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
296
+						"event_espresso"
297
+					),
298
+					$this->html_name(),
299
+					$this->html_id()
300
+				)
301
+			);
302
+		} else {
303
+			return $this->_display_strategy;
304
+		}
305
+	}
306
+
307
+
308
+
309
+	/**
310
+	 * Sets the display strategy.
311
+	 *
312
+	 * @param EE_Display_Strategy_Base $strategy
313
+	 */
314
+	protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
315
+	{
316
+		$this->_display_strategy = $strategy;
317
+	}
318
+
319
+
320
+
321
+	/**
322
+	 * Sets the sanitization strategy
323
+	 *
324
+	 * @param EE_Normalization_Strategy_Base $strategy
325
+	 */
326
+	protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
327
+	{
328
+		$this->_normalization_strategy = $strategy;
329
+	}
330
+
331
+
332
+
333
+	/**
334
+	 * Gets sensitive_data_removal_strategy
335
+	 *
336
+	 * @return EE_Sensitive_Data_Removal_Base
337
+	 */
338
+	public function get_sensitive_data_removal_strategy()
339
+	{
340
+		return $this->_sensitive_data_removal_strategy;
341
+	}
342
+
343
+
344
+
345
+	/**
346
+	 * Sets sensitive_data_removal_strategy
347
+	 *
348
+	 * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
349
+	 * @return void
350
+	 */
351
+	public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
352
+	{
353
+		$this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
354
+	}
355
+
356
+
357
+
358
+	/**
359
+	 * Gets the display strategy for this input
360
+	 *
361
+	 * @return EE_Display_Strategy_Base
362
+	 */
363
+	public function get_display_strategy()
364
+	{
365
+		return $this->_display_strategy;
366
+	}
367
+
368
+
369
+
370
+	/**
371
+	 * Overwrites the display strategy
372
+	 *
373
+	 * @param EE_Display_Strategy_Base $display_strategy
374
+	 */
375
+	public function set_display_strategy($display_strategy)
376
+	{
377
+		$this->_display_strategy = $display_strategy;
378
+		$this->_display_strategy->_construct_finalize($this);
379
+	}
380
+
381
+
382
+
383
+	/**
384
+	 * Gets the normalization strategy set on this input
385
+	 *
386
+	 * @return EE_Normalization_Strategy_Base
387
+	 */
388
+	public function get_normalization_strategy()
389
+	{
390
+		return $this->_normalization_strategy;
391
+	}
392
+
393
+
394
+
395
+	/**
396
+	 * Overwrites the normalization strategy
397
+	 *
398
+	 * @param EE_Normalization_Strategy_Base $normalization_strategy
399
+	 */
400
+	public function set_normalization_strategy($normalization_strategy)
401
+	{
402
+		$this->_normalization_strategy = $normalization_strategy;
403
+		$this->_normalization_strategy->_construct_finalize($this);
404
+	}
405
+
406
+
407
+
408
+	/**
409
+	 * Returns all teh validation strategies which apply to this field, numerically indexed
410
+	 *
411
+	 * @return EE_Validation_Strategy_Base[]
412
+	 */
413
+	public function get_validation_strategies()
414
+	{
415
+		return $this->_validation_strategies;
416
+	}
417
+
418
+
419
+
420
+	/**
421
+	 * Adds this strategy to the field so it will be used in both JS validation and server-side validation
422
+	 *
423
+	 * @param EE_Validation_Strategy_Base $validation_strategy
424
+	 * @return void
425
+	 */
426
+	protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
427
+	{
428
+		$validation_strategy->_construct_finalize($this);
429
+		$this->_validation_strategies[] = $validation_strategy;
430
+	}
431
+
432
+
433
+
434
+	/**
435
+	 * Adds a new validation strategy onto the form input
436
+	 *
437
+	 * @param EE_Validation_Strategy_Base $validation_strategy
438
+	 * @return void
439
+	 */
440
+	public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
441
+	{
442
+		$this->_add_validation_strategy($validation_strategy);
443
+	}
444
+
445
+
446
+
447
+	/**
448
+	 * The classname of the validation strategy to remove
449
+	 *
450
+	 * @param string $validation_strategy_classname
451
+	 */
452
+	public function remove_validation_strategy($validation_strategy_classname)
453
+	{
454
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
455
+			if (
456
+				$validation_strategy instanceof $validation_strategy_classname
457
+				|| is_subclass_of($validation_strategy, $validation_strategy_classname)
458
+			) {
459
+				unset($this->_validation_strategies[ $key ]);
460
+			}
461
+		}
462
+	}
463
+
464
+
465
+
466
+	/**
467
+	 * returns true if input employs any of the validation strategy defined by the supplied array of classnames
468
+	 *
469
+	 * @param array $validation_strategy_classnames
470
+	 * @return bool
471
+	 */
472
+	public function has_validation_strategy($validation_strategy_classnames)
473
+	{
474
+		$validation_strategy_classnames = is_array($validation_strategy_classnames)
475
+			? $validation_strategy_classnames
476
+			: array($validation_strategy_classnames);
477
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
478
+			if (in_array($key, $validation_strategy_classnames)) {
479
+				return true;
480
+			}
481
+		}
482
+		return false;
483
+	}
484
+
485
+
486
+
487
+	/**
488
+	 * Gets the HTML
489
+	 *
490
+	 * @return string
491
+	 */
492
+	public function get_html()
493
+	{
494
+		return $this->_parent_section->get_html_for_input($this);
495
+	}
496
+
497
+
498
+
499
+	/**
500
+	 * Gets the HTML for the input itself (no label or errors) according to the
501
+	 * input's display strategy
502
+	 * Makes sure the JS and CSS are enqueued for it
503
+	 *
504
+	 * @return string
505
+	 * @throws EE_Error
506
+	 */
507
+	public function get_html_for_input()
508
+	{
509
+		return $this->_form_html_filter
510
+			? $this->_form_html_filter->filterHtml(
511
+				$this->_get_display_strategy()->display(),
512
+				$this
513
+			)
514
+			: $this->_get_display_strategy()->display();
515
+	}
516
+
517
+
518
+
519
+	/**
520
+	 * @return string
521
+	 */
522
+	public function html_other_attributes()
523
+	{
524
+		EE_Error::doing_it_wrong(
525
+			__METHOD__,
526
+			sprintf(
527
+				esc_html__(
528
+					'This method is no longer in use. You should replace it by %s',
529
+					'event_espresso'
530
+				),
531
+				'EE_Form_Section_Base::other_html_attributes()'
532
+			),
533
+			'4.10.2.p'
534
+		);
535
+
536
+		return $this->other_html_attributes();
537
+	}
538
+
539
+
540
+
541
+	/**
542
+	 * @param string $html_other_attributes
543
+	 */
544
+	public function set_html_other_attributes($html_other_attributes)
545
+	{
546
+		EE_Error::doing_it_wrong(
547
+			__METHOD__,
548
+			sprintf(
549
+				esc_html__(
550
+					'This method is no longer in use. You should replace it by %s',
551
+					'event_espresso'
552
+				),
553
+				'EE_Form_Section_Base::set_other_html_attributes()'
554
+			),
555
+			'4.10.2.p'
556
+		);
557
+
558
+		$this->set_other_html_attributes($html_other_attributes);
559
+	}
560
+
561
+
562
+
563
+	/**
564
+	 * Gets the HTML for displaying the label for this form input
565
+	 * according to the form section's layout strategy
566
+	 *
567
+	 * @return string
568
+	 */
569
+	public function get_html_for_label()
570
+	{
571
+		return $this->_parent_section->get_layout_strategy()->display_label($this);
572
+	}
573
+
574
+
575
+
576
+	/**
577
+	 * Gets the HTML for displaying the errors section for this form input
578
+	 * according to the form section's layout strategy
579
+	 *
580
+	 * @return string
581
+	 */
582
+	public function get_html_for_errors()
583
+	{
584
+		return $this->_parent_section->get_layout_strategy()->display_errors($this);
585
+	}
586
+
587
+
588
+
589
+	/**
590
+	 * Gets the HTML for displaying the help text for this form input
591
+	 * according to the form section's layout strategy
592
+	 *
593
+	 * @return string
594
+	 */
595
+	public function get_html_for_help()
596
+	{
597
+		return $this->_parent_section->get_layout_strategy()->display_help_text($this);
598
+	}
599
+
600
+
601
+
602
+	/**
603
+	 * Validates the input's sanitized value (assumes _sanitize() has already been called)
604
+	 * and returns whether or not the form input's submitted value is value
605
+	 *
606
+	 * @return boolean
607
+	 */
608
+	protected function _validate()
609
+	{
610
+		if ($this->isDisabled()) {
611
+			return true;
612
+		}
613
+		foreach ($this->_validation_strategies as $validation_strategy) {
614
+			if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
615
+				try {
616
+					$validation_strategy->validate($this->normalized_value());
617
+				} catch (EE_Validation_Error $e) {
618
+					$this->add_validation_error($e);
619
+				}
620
+			}
621
+		}
622
+		if ($this->get_validation_errors()) {
623
+			return false;
624
+		} else {
625
+			return true;
626
+		}
627
+	}
628
+
629
+
630
+
631
+	/**
632
+	 * Performs basic sanitization on this value. But what sanitization can be performed anyways?
633
+	 * This value MIGHT be allowed to have tags, so we can't really remove them.
634
+	 *
635
+	 * @param string $value
636
+	 * @return null|string
637
+	 */
638
+	protected function _sanitize($value)
639
+	{
640
+		return $value !== null ? stripslashes(html_entity_decode(trim($value))) : null;
641
+	}
642
+
643
+
644
+
645
+	/**
646
+	 * Picks out the form value that relates to this form input,
647
+	 * and stores it as the sanitized value on the form input, and sets the normalized value.
648
+	 * Returns whether or not any validation errors occurred
649
+	 *
650
+	 * @param array $req_data
651
+	 * @return boolean whether or not there was an error
652
+	 * @throws EE_Error
653
+	 */
654
+	protected function _normalize($req_data)
655
+	{
656
+		// any existing validation errors don't apply so clear them
657
+		$this->_validation_errors = array();
658
+		// if the input is disabled, ignore whatever input was sent in
659
+		if ($this->isDisabled()) {
660
+			$this->_set_raw_value(null);
661
+			$this->_set_normalized_value($this->get_default());
662
+			return false;
663
+		}
664
+		try {
665
+			$raw_input = $this->find_form_data_for_this_section($req_data);
666
+			// super simple sanitization for now
667
+			if (is_array($raw_input)) {
668
+				$raw_value = array();
669
+				foreach ($raw_input as $key => $value) {
670
+					$raw_value[ $key ] = $this->_sanitize($value);
671
+				}
672
+				$this->_set_raw_value($raw_value);
673
+			} else {
674
+				$this->_set_raw_value($this->_sanitize($raw_input));
675
+			}
676
+			// we want to mostly leave the input alone in case we need to re-display it to the user
677
+			$this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
678
+			return false;
679
+		} catch (EE_Validation_Error $e) {
680
+			$this->add_validation_error($e);
681
+			return true;
682
+		}
683
+	}
684
+
685
+
686
+	/**
687
+	 * @return string
688
+	 * @throws EE_Error
689
+	 */
690
+	public function html_name()
691
+	{
692
+		$this->_set_default_html_name_if_empty();
693
+		return $this->_html_name;
694
+	}
695
+
696
+
697
+	/**
698
+	 * @return string
699
+	 * @throws EE_Error
700
+	 */
701
+	public function html_label_id()
702
+	{
703
+		return ! empty($this->_html_label_id) ? $this->_html_label_id : $this->html_id() . '-lbl';
704
+	}
705
+
706
+
707
+
708
+	/**
709
+	 * @return string
710
+	 */
711
+	public function html_label_class()
712
+	{
713
+		return $this->_html_label_class;
714
+	}
715
+
716
+
717
+
718
+	/**
719
+	 * @return string
720
+	 */
721
+	public function html_label_style()
722
+	{
723
+		return $this->_html_label_style;
724
+	}
725
+
726
+
727
+
728
+	/**
729
+	 * @return string
730
+	 */
731
+	public function html_label_text()
732
+	{
733
+		return $this->_html_label_text;
734
+	}
735
+
736
+
737
+
738
+	/**
739
+	 * @return string
740
+	 */
741
+	public function html_help_text()
742
+	{
743
+		return $this->_html_help_text;
744
+	}
745
+
746
+
747
+
748
+	/**
749
+	 * @return string
750
+	 */
751
+	public function html_help_class()
752
+	{
753
+		return $this->_html_help_class;
754
+	}
755
+
756
+
757
+
758
+	/**
759
+	 * @return string
760
+	 */
761
+	public function html_help_style()
762
+	{
763
+		return $this->_html_style;
764
+	}
765
+
766
+
767
+
768
+	/**
769
+	 * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
770
+	 * Please note that almost all client code should instead use the normalized_value;
771
+	 * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
772
+	 * mostly by escaping quotes)
773
+	 * Note, we do not store the exact original value sent in the user's request because
774
+	 * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
775
+	 * in which case, we would have stored the malicious content to our database.
776
+	 *
777
+	 * @return string
778
+	 */
779
+	public function raw_value()
780
+	{
781
+		return $this->_raw_value;
782
+	}
783
+
784
+
785
+
786
+	/**
787
+	 * Returns a string safe to usage in form inputs when displaying, because
788
+	 * it escapes all html entities
789
+	 *
790
+	 * @return string
791
+	 */
792
+	public function raw_value_in_form()
793
+	{
794
+		return htmlentities($this->raw_value(), ENT_QUOTES, 'UTF-8');
795
+	}
796
+
797
+
798
+
799
+	/**
800
+	 * returns the value after it's been sanitized, and then converted into it's proper type
801
+	 * in PHP. Eg, a string, an int, an array,
802
+	 *
803
+	 * @return mixed
804
+	 */
805
+	public function normalized_value()
806
+	{
807
+		return $this->_normalized_value;
808
+	}
809
+
810
+
811
+
812
+	/**
813
+	 * Returns the normalized value is a presentable way. By default this is just
814
+	 * the normalized value by itself, but it can be overridden for when that's not
815
+	 * the best thing to display
816
+	 *
817
+	 * @return string
818
+	 */
819
+	public function pretty_value()
820
+	{
821
+		return $this->_normalized_value;
822
+	}
823
+
824
+
825
+
826
+	/**
827
+	 * When generating the JS for the jquery validation rules like<br>
828
+	 * <code>$( "#myform" ).validate({
829
+	 * rules: {
830
+	 * password: "required",
831
+	 * password_again: {
832
+	 * equalTo: "#password"
833
+	 * }
834
+	 * }
835
+	 * });</code>
836
+	 * if this field had the name 'password_again', it should return
837
+	 * <br><code>password_again: {
838
+	 * equalTo: "#password"
839
+	 * }</code>
840
+	 *
841
+	 * @return array
842
+	 */
843
+	public function get_jquery_validation_rules()
844
+	{
845
+		$jquery_validation_js = array();
846
+		$jquery_validation_rules = array();
847
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
848
+			$jquery_validation_rules = array_replace_recursive(
849
+				$jquery_validation_rules,
850
+				$validation_strategy->get_jquery_validation_rule_array()
851
+			);
852
+		}
853
+		if (! empty($jquery_validation_rules)) {
854
+			foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
855
+				$jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
856
+			}
857
+		}
858
+		return $jquery_validation_js;
859
+	}
860
+
861
+
862
+
863
+	/**
864
+	 * Sets the input's default value for use in displaying in the form. Note: value should be
865
+	 * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
866
+	 *
867
+	 * @param mixed $value
868
+	 * @return void
869
+	 */
870
+	public function set_default($value)
871
+	{
872
+		$this->_default = $value;
873
+		$this->_set_normalized_value($value);
874
+		$this->_set_raw_value($value);
875
+	}
876
+
877
+
878
+
879
+	/**
880
+	 * Sets the normalized value on this input
881
+	 *
882
+	 * @param mixed $value
883
+	 */
884
+	protected function _set_normalized_value($value)
885
+	{
886
+		$this->_normalized_value = $value;
887
+	}
888
+
889
+
890
+
891
+	/**
892
+	 * Sets the raw value on this input (ie, exactly as the user submitted it)
893
+	 *
894
+	 * @param mixed $value
895
+	 */
896
+	protected function _set_raw_value($value)
897
+	{
898
+		$this->_raw_value = $this->_normalization_strategy->unnormalize($value);
899
+	}
900
+
901
+
902
+
903
+	/**
904
+	 * Sets the HTML label text after it has already been defined
905
+	 *
906
+	 * @param string $label
907
+	 * @return void
908
+	 */
909
+	public function set_html_label_text($label)
910
+	{
911
+		$this->_html_label_text = $label;
912
+	}
913
+
914
+
915
+
916
+	/**
917
+	 * Sets whether or not this field is required, and adjusts the validation strategy.
918
+	 * If you want to use the EE_Conditionally_Required_Validation_Strategy,
919
+	 * please add it as a validation strategy using add_validation_strategy as normal
920
+	 *
921
+	 * @param boolean $required boolean
922
+	 * @param null    $required_text
923
+	 */
924
+	public function set_required($required = true, $required_text = null)
925
+	{
926
+		$required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
927
+		// whether $required is a string or a boolean, we want to add a required validation strategy
928
+		if ($required) {
929
+			$this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
930
+		} else {
931
+			$this->remove_validation_strategy('EE_Required_Validation_Strategy');
932
+		}
933
+		$this->_required = $required;
934
+	}
935
+
936
+
937
+
938
+	/**
939
+	 * Returns whether or not this field is required
940
+	 *
941
+	 * @return boolean
942
+	 */
943
+	public function required()
944
+	{
945
+		return $this->_required;
946
+	}
947
+
948
+
949
+
950
+	/**
951
+	 * @param string $required_css_class
952
+	 */
953
+	public function set_required_css_class($required_css_class)
954
+	{
955
+		$this->_required_css_class = $required_css_class;
956
+	}
957
+
958
+
959
+
960
+	/**
961
+	 * @return string
962
+	 */
963
+	public function required_css_class()
964
+	{
965
+		return $this->_required_css_class;
966
+	}
967
+
968
+
969
+
970
+	/**
971
+	 * @param bool $add_required
972
+	 * @return string
973
+	 */
974
+	public function html_class($add_required = false)
975
+	{
976
+		return $add_required && $this->required()
977
+			? $this->required_css_class() . ' ' . $this->_html_class
978
+			: $this->_html_class;
979
+	}
980
+
981
+
982
+	/**
983
+	 * Sets the help text, in case
984
+	 *
985
+	 * @param string $text
986
+	 */
987
+	public function set_html_help_text($text)
988
+	{
989
+		$this->_html_help_text = $text;
990
+	}
991
+
992
+
993
+
994
+	/**
995
+	 * Uses the sensitive data removal strategy to remove the sensitive data from this
996
+	 * input. If there is any kind of sensitive data removal on this input, we clear
997
+	 * out the raw value completely
998
+	 *
999
+	 * @return void
1000
+	 */
1001
+	public function clean_sensitive_data()
1002
+	{
1003
+		// if we do ANY kind of sensitive data removal on this, then just clear out the raw value
1004
+		// if we need more logic than this we'll make a strategy for it
1005
+		if (
1006
+			$this->_sensitive_data_removal_strategy
1007
+			&& ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
1008
+		) {
1009
+			$this->_set_raw_value(null);
1010
+		}
1011
+		// and clean the normalized value according to the appropriate strategy
1012
+		$this->_set_normalized_value(
1013
+			$this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
1014
+				$this->_normalized_value
1015
+			)
1016
+		);
1017
+	}
1018
+
1019
+
1020
+
1021
+	/**
1022
+	 * @param bool   $primary
1023
+	 * @param string $button_size
1024
+	 * @param string $other_attributes
1025
+	 */
1026
+	public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
1027
+	{
1028
+		$button_css_attributes = 'button';
1029
+		$button_css_attributes .= $primary === true ? ' button--primary' : ' button--secondary';
1030
+		switch ($button_size) {
1031
+			case 'xs':
1032
+			case 'extra-small':
1033
+				$button_css_attributes .= ' button-xs';
1034
+				break;
1035
+			case 'sm':
1036
+			case 'small':
1037
+				$button_css_attributes .= ' button-sm';
1038
+				break;
1039
+			case 'lg':
1040
+			case 'large':
1041
+				$button_css_attributes .= ' button-lg';
1042
+				break;
1043
+			case 'block':
1044
+				$button_css_attributes .= ' button-block';
1045
+				break;
1046
+			case 'md':
1047
+			case 'medium':
1048
+			default:
1049
+				$button_css_attributes .= '';
1050
+		}
1051
+		$this->_button_css_attributes .= ! empty($other_attributes)
1052
+			? $button_css_attributes . ' ' . $other_attributes
1053
+			: $button_css_attributes;
1054
+	}
1055
+
1056
+
1057
+
1058
+	/**
1059
+	 * @return string
1060
+	 */
1061
+	public function button_css_attributes()
1062
+	{
1063
+		if (empty($this->_button_css_attributes)) {
1064
+			$this->set_button_css_attributes();
1065
+		}
1066
+		return $this->_button_css_attributes;
1067
+	}
1068
+
1069
+
1070
+
1071
+	/**
1072
+	 * find_form_data_for_this_section
1073
+	 * using this section's name and its parents, finds the value of the form data that corresponds to it.
1074
+	 * For example, if this form section's HTML name is my_form[subform][form_input_1],
1075
+	 * then it's value should be in request at request['my_form']['subform']['form_input_1'].
1076
+	 * (If that doesn't exist, we also check for this subsection's name
1077
+	 * at the TOP LEVEL of the request data. Eg request['form_input_1'].)
1078
+	 * This function finds its value in the form.
1079
+	 *
1080
+	 * @param array $req_data
1081
+	 * @return mixed whatever the raw value of this form section is in the request data
1082
+	 * @throws EE_Error
1083
+	 */
1084
+	public function find_form_data_for_this_section($req_data)
1085
+	{
1086
+		$name_parts = $this->getInputNameParts();
1087
+		// now get the value for the input
1088
+		$value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
1089
+		// check if this thing's name is at the TOP level of the request data
1090
+		if ($value === null && isset($req_data[ $this->name() ])) {
1091
+			$value = $req_data[ $this->name() ];
1092
+		}
1093
+		return $value;
1094
+	}
1095
+
1096
+
1097
+	/**
1098
+	 * If this input's name is something like "foo[bar][baz]"
1099
+	 * returns an array like `array('foo','bar',baz')`
1100
+	 *
1101
+	 * @return array
1102
+	 * @throws EE_Error
1103
+	 */
1104
+	protected function getInputNameParts()
1105
+	{
1106
+		// break up the html name by "[]"
1107
+		if (strpos($this->html_name(), '[') !== false) {
1108
+			$before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
1109
+		} else {
1110
+			$before_any_brackets = $this->html_name();
1111
+		}
1112
+		// grab all of the segments
1113
+		preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
1114
+		if (isset($matches[1]) && is_array($matches[1])) {
1115
+			$name_parts = $matches[1];
1116
+			array_unshift($name_parts, $before_any_brackets);
1117
+		} else {
1118
+			$name_parts = array($before_any_brackets);
1119
+		}
1120
+		return $name_parts;
1121
+	}
1122
+
1123
+
1124
+
1125
+	/**
1126
+	 * @param array $html_name_parts
1127
+	 * @param array $req_data
1128
+	 * @return array | NULL
1129
+	 */
1130
+	public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
1131
+	{
1132
+		$first_part_to_consider = array_shift($html_name_parts);
1133
+		if (isset($req_data[ $first_part_to_consider ])) {
1134
+			if (empty($html_name_parts)) {
1135
+				return $req_data[ $first_part_to_consider ];
1136
+			} else {
1137
+				return $this->findRequestForSectionUsingNameParts(
1138
+					$html_name_parts,
1139
+					$req_data[ $first_part_to_consider ]
1140
+				);
1141
+			}
1142
+		} else {
1143
+			return null;
1144
+		}
1145
+	}
1146
+
1147
+
1148
+
1149
+	/**
1150
+	 * Checks if this form input's data is in the request data
1151
+	 *
1152
+	 * @param array $req_data
1153
+	 * @return boolean
1154
+	 * @throws EE_Error
1155
+	 */
1156
+	public function form_data_present_in($req_data = null)
1157
+	{
1158
+		if ($req_data === null) {
1159
+			/** @var RequestInterface $request */
1160
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
1161
+			$req_data = $request->postParams();
1162
+		}
1163
+		$checked_value = $this->find_form_data_for_this_section($req_data);
1164
+		if ($checked_value !== null) {
1165
+			return true;
1166
+		} else {
1167
+			return false;
1168
+		}
1169
+	}
1170
+
1171
+
1172
+
1173
+	/**
1174
+	 * Overrides parent to add js data from validation and display strategies
1175
+	 *
1176
+	 * @param array $form_other_js_data
1177
+	 * @return array
1178
+	 */
1179
+	public function get_other_js_data($form_other_js_data = array())
1180
+	{
1181
+		return $this->get_other_js_data_from_strategies($form_other_js_data);
1182
+	}
1183
+
1184
+
1185
+
1186
+	/**
1187
+	 * Gets other JS data for localization from this input's strategies, like
1188
+	 * the validation strategies and the display strategy
1189
+	 *
1190
+	 * @param array $form_other_js_data
1191
+	 * @return array
1192
+	 */
1193
+	public function get_other_js_data_from_strategies($form_other_js_data = array())
1194
+	{
1195
+		$form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
1196
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
1197
+			$form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
1198
+		}
1199
+		return $form_other_js_data;
1200
+	}
1201
+
1202
+
1203
+
1204
+	/**
1205
+	 * Override parent because we want to give our strategies an opportunity to enqueue some js and css
1206
+	 *
1207
+	 * @return void
1208
+	 */
1209
+	public function enqueue_js()
1210
+	{
1211
+		// ask our display strategy and validation strategies if they have js to enqueue
1212
+		$this->enqueue_js_from_strategies();
1213
+	}
1214
+
1215
+
1216
+
1217
+	/**
1218
+	 * Tells strategies when its ok to enqueue their js and css
1219
+	 *
1220
+	 * @return void
1221
+	 */
1222
+	public function enqueue_js_from_strategies()
1223
+	{
1224
+		$this->get_display_strategy()->enqueue_js();
1225
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
1226
+			$validation_strategy->enqueue_js();
1227
+		}
1228
+	}
1229
+
1230
+
1231
+
1232
+	/**
1233
+	 * Gets the default value set on the input (not the current value, which may have been
1234
+	 * changed because of a form submission). If no default was set, this us null.
1235
+	 * @return mixed
1236
+	 */
1237
+	public function get_default()
1238
+	{
1239
+		return $this->_default;
1240
+	}
1241
+
1242
+
1243
+
1244
+	/**
1245
+	 * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"',
1246
+	 * and server-side if any input was received it will be ignored
1247
+	 */
1248
+	public function disable($disable = true)
1249
+	{
1250
+		$disabled_attribute = ' disabled="disabled"';
1251
+		$this->disabled = filter_var($disable, FILTER_VALIDATE_BOOLEAN);
1252
+		if ($this->disabled) {
1253
+			if (strpos($this->_other_html_attributes, $disabled_attribute) === false) {
1254
+				$this->_other_html_attributes .= $disabled_attribute;
1255
+			}
1256
+			$this->_set_normalized_value($this->get_default());
1257
+		} else {
1258
+			$this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes);
1259
+		}
1260
+	}
1261
+
1262
+
1263
+
1264
+	/**
1265
+	 * Returns whether or not this input is currently disabled.
1266
+	 * @return bool
1267
+	 */
1268
+	public function isDisabled()
1269
+	{
1270
+		return $this->disabled;
1271
+	}
1272 1272
 }
Please login to merge, or discard this patch.
core/libraries/form_sections/inputs/EE_Phone_Input.input.php 1 patch
Indentation   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -14,17 +14,17 @@
 block discarded – undo
14 14
  */
15 15
 class EE_Phone_Input extends EE_Text_Input
16 16
 {
17
-    /**
18
-     * @param array $options
19
-     */
20
-    public function __construct($options = array())
21
-    {
22
-        $this->_add_validation_strategy(
23
-            new EE_Text_Validation_Strategy(
24
-                esc_html__('Please enter a valid phone number. Eg 123-456-7890 or 1234567890', 'event_espresso'),
25
-                '~^(([\d]{10})|(^[\d]{3}-[\d]{3}-[\d]{4}))$~'
26
-            )
27
-        );
28
-        parent::__construct($options);
29
-    }
17
+	/**
18
+	 * @param array $options
19
+	 */
20
+	public function __construct($options = array())
21
+	{
22
+		$this->_add_validation_strategy(
23
+			new EE_Text_Validation_Strategy(
24
+				esc_html__('Please enter a valid phone number. Eg 123-456-7890 or 1234567890', 'event_espresso'),
25
+				'~^(([\d]{10})|(^[\d]{3}-[\d]{3}-[\d]{4}))$~'
26
+			)
27
+		);
28
+		parent::__construct($options);
29
+	}
30 30
 }
Please login to merge, or discard this patch.