@@ -39,11 +39,11 @@ discard block |
||
| 39 | 39 | $check_file_exists = false, |
| 40 | 40 | URLValidator $url_validator = null |
| 41 | 41 | ) { |
| 42 | - if (! $url_validator instanceof URLValidator) { |
|
| 42 | + if ( ! $url_validator instanceof URLValidator) { |
|
| 43 | 43 | $url_validator = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\validators\URLValidator'); |
| 44 | 44 | } |
| 45 | 45 | $this->url_validator = $url_validator; |
| 46 | - if (! $validation_error_message) { |
|
| 46 | + if ( ! $validation_error_message) { |
|
| 47 | 47 | $validation_error_message = esc_html__("Please enter a valid URL. Eg https://eventespresso.com", "event_espresso"); |
| 48 | 48 | } |
| 49 | 49 | $this->check_file_exists = $check_file_exists; |
@@ -62,7 +62,7 @@ discard block |
||
| 62 | 62 | public function validate($normalized_value) |
| 63 | 63 | { |
| 64 | 64 | if ($normalized_value) { |
| 65 | - if (! $this->url_validator->isValid($normalized_value)) { |
|
| 65 | + if ( ! $this->url_validator->isValid($normalized_value)) { |
|
| 66 | 66 | throw new EE_Validation_Error($this->get_validation_error_message(), 'invalid_url'); |
| 67 | 67 | } elseif (apply_filters('FHEE__EE_URL_Validation_Strategy__validate__check_remote_file_exists', $this->check_file_exists, $this->_input)) { |
| 68 | 68 | if ( |
@@ -70,7 +70,7 @@ discard block |
||
| 70 | 70 | $normalized_value, |
| 71 | 71 | array( |
| 72 | 72 | 'sslverify' => false, |
| 73 | - 'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block |
|
| 73 | + 'limit_response_size' => 4095, // we don't really care for a full response, but we do want headers at least. Lets just ask for a one block |
|
| 74 | 74 | ) |
| 75 | 75 | ) |
| 76 | 76 | ) { |
@@ -87,6 +87,6 @@ discard block |
||
| 87 | 87 | */ |
| 88 | 88 | public function get_jquery_validation_rule_array() |
| 89 | 89 | { |
| 90 | - return array( 'validUrl' => true, 'messages' => array( 'validUrl' => $this->get_validation_error_message() ) ); |
|
| 90 | + return array('validUrl' => true, 'messages' => array('validUrl' => $this->get_validation_error_message())); |
|
| 91 | 91 | } |
| 92 | 92 | } |
@@ -15,77 +15,77 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | class EE_URL_Validation_Strategy extends EE_Validation_Strategy_Base |
| 17 | 17 | { |
| 18 | - /** |
|
| 19 | - * @var @boolean whether we should check if the file exists or not |
|
| 20 | - */ |
|
| 21 | - protected $check_file_exists; |
|
| 18 | + /** |
|
| 19 | + * @var @boolean whether we should check if the file exists or not |
|
| 20 | + */ |
|
| 21 | + protected $check_file_exists; |
|
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * @var URLValidator |
|
| 25 | - */ |
|
| 26 | - protected $url_validator; |
|
| 23 | + /** |
|
| 24 | + * @var URLValidator |
|
| 25 | + */ |
|
| 26 | + protected $url_validator; |
|
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @param null $validation_error_message |
|
| 30 | - * @param boolean $check_file_exists |
|
| 31 | - * @param URLValidator $url_validator |
|
| 32 | - * @throws InvalidArgumentException |
|
| 33 | - * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 34 | - * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
| 35 | - */ |
|
| 36 | - public function __construct( |
|
| 37 | - $validation_error_message = null, |
|
| 38 | - $check_file_exists = false, |
|
| 39 | - URLValidator $url_validator = null |
|
| 40 | - ) { |
|
| 41 | - if (! $url_validator instanceof URLValidator) { |
|
| 42 | - $url_validator = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\validators\URLValidator'); |
|
| 43 | - } |
|
| 44 | - $this->url_validator = $url_validator; |
|
| 45 | - if (! $validation_error_message) { |
|
| 46 | - $validation_error_message = esc_html__("Please enter a valid URL. Eg https://eventespresso.com", "event_espresso"); |
|
| 47 | - } |
|
| 48 | - $this->check_file_exists = $check_file_exists; |
|
| 49 | - parent::__construct($validation_error_message); |
|
| 50 | - } |
|
| 28 | + /** |
|
| 29 | + * @param null $validation_error_message |
|
| 30 | + * @param boolean $check_file_exists |
|
| 31 | + * @param URLValidator $url_validator |
|
| 32 | + * @throws InvalidArgumentException |
|
| 33 | + * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 34 | + * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
| 35 | + */ |
|
| 36 | + public function __construct( |
|
| 37 | + $validation_error_message = null, |
|
| 38 | + $check_file_exists = false, |
|
| 39 | + URLValidator $url_validator = null |
|
| 40 | + ) { |
|
| 41 | + if (! $url_validator instanceof URLValidator) { |
|
| 42 | + $url_validator = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\validators\URLValidator'); |
|
| 43 | + } |
|
| 44 | + $this->url_validator = $url_validator; |
|
| 45 | + if (! $validation_error_message) { |
|
| 46 | + $validation_error_message = esc_html__("Please enter a valid URL. Eg https://eventespresso.com", "event_espresso"); |
|
| 47 | + } |
|
| 48 | + $this->check_file_exists = $check_file_exists; |
|
| 49 | + parent::__construct($validation_error_message); |
|
| 50 | + } |
|
| 51 | 51 | |
| 52 | 52 | |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * just checks the field isn't blank |
|
| 56 | - * |
|
| 57 | - * @param $normalized_value |
|
| 58 | - * @return bool |
|
| 59 | - * @throws \EE_Validation_Error |
|
| 60 | - */ |
|
| 61 | - public function validate($normalized_value) |
|
| 62 | - { |
|
| 63 | - if ($normalized_value) { |
|
| 64 | - if (! $this->url_validator->isValid($normalized_value)) { |
|
| 65 | - throw new EE_Validation_Error($this->get_validation_error_message(), 'invalid_url'); |
|
| 66 | - } elseif (apply_filters('FHEE__EE_URL_Validation_Strategy__validate__check_remote_file_exists', $this->check_file_exists, $this->_input)) { |
|
| 67 | - if ( |
|
| 68 | - ! EEH_URL::remote_file_exists( |
|
| 69 | - $normalized_value, |
|
| 70 | - array( |
|
| 71 | - 'sslverify' => false, |
|
| 72 | - 'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block |
|
| 73 | - ) |
|
| 74 | - ) |
|
| 75 | - ) { |
|
| 76 | - throw new EE_Validation_Error(sprintf(esc_html__("That URL seems to be broken. Please enter a valid URL", "event_espresso"))); |
|
| 77 | - } |
|
| 78 | - } |
|
| 79 | - } |
|
| 80 | - } |
|
| 54 | + /** |
|
| 55 | + * just checks the field isn't blank |
|
| 56 | + * |
|
| 57 | + * @param $normalized_value |
|
| 58 | + * @return bool |
|
| 59 | + * @throws \EE_Validation_Error |
|
| 60 | + */ |
|
| 61 | + public function validate($normalized_value) |
|
| 62 | + { |
|
| 63 | + if ($normalized_value) { |
|
| 64 | + if (! $this->url_validator->isValid($normalized_value)) { |
|
| 65 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'invalid_url'); |
|
| 66 | + } elseif (apply_filters('FHEE__EE_URL_Validation_Strategy__validate__check_remote_file_exists', $this->check_file_exists, $this->_input)) { |
|
| 67 | + if ( |
|
| 68 | + ! EEH_URL::remote_file_exists( |
|
| 69 | + $normalized_value, |
|
| 70 | + array( |
|
| 71 | + 'sslverify' => false, |
|
| 72 | + 'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block |
|
| 73 | + ) |
|
| 74 | + ) |
|
| 75 | + ) { |
|
| 76 | + throw new EE_Validation_Error(sprintf(esc_html__("That URL seems to be broken. Please enter a valid URL", "event_espresso"))); |
|
| 77 | + } |
|
| 78 | + } |
|
| 79 | + } |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | 82 | |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * @return array |
|
| 86 | - */ |
|
| 87 | - public function get_jquery_validation_rule_array() |
|
| 88 | - { |
|
| 89 | - return array( 'validUrl' => true, 'messages' => array( 'validUrl' => $this->get_validation_error_message() ) ); |
|
| 90 | - } |
|
| 84 | + /** |
|
| 85 | + * @return array |
|
| 86 | + */ |
|
| 87 | + public function get_jquery_validation_rule_array() |
|
| 88 | + { |
|
| 89 | + return array( 'validUrl' => true, 'messages' => array( 'validUrl' => $this->get_validation_error_message() ) ); |
|
| 90 | + } |
|
| 91 | 91 | } |
@@ -15,7 +15,7 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | public function __construct($validation_error_message = null) |
| 17 | 17 | { |
| 18 | - if (! $validation_error_message) { |
|
| 18 | + if ( ! $validation_error_message) { |
|
| 19 | 19 | $validation_error_message = esc_html__("Only digits are allowed.", "event_espresso"); |
| 20 | 20 | } |
| 21 | 21 | parent::__construct($validation_error_message); |
@@ -9,41 +9,41 @@ |
||
| 9 | 9 | */ |
| 10 | 10 | class EE_Int_Validation_Strategy extends EE_Validation_Strategy_Base |
| 11 | 11 | { |
| 12 | - /** |
|
| 13 | - * @param null $validation_error_message |
|
| 14 | - */ |
|
| 15 | - public function __construct($validation_error_message = null) |
|
| 16 | - { |
|
| 17 | - if (! $validation_error_message) { |
|
| 18 | - $validation_error_message = esc_html__("Only digits are allowed.", "event_espresso"); |
|
| 19 | - } |
|
| 20 | - parent::__construct($validation_error_message); |
|
| 21 | - } |
|
| 12 | + /** |
|
| 13 | + * @param null $validation_error_message |
|
| 14 | + */ |
|
| 15 | + public function __construct($validation_error_message = null) |
|
| 16 | + { |
|
| 17 | + if (! $validation_error_message) { |
|
| 18 | + $validation_error_message = esc_html__("Only digits are allowed.", "event_espresso"); |
|
| 19 | + } |
|
| 20 | + parent::__construct($validation_error_message); |
|
| 21 | + } |
|
| 22 | 22 | |
| 23 | 23 | |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @param $normalized_value |
|
| 27 | - */ |
|
| 28 | - public function validate($normalized_value) |
|
| 29 | - { |
|
| 30 | - // this should have already been detected by the normalization strategy |
|
| 31 | - } |
|
| 25 | + /** |
|
| 26 | + * @param $normalized_value |
|
| 27 | + */ |
|
| 28 | + public function validate($normalized_value) |
|
| 29 | + { |
|
| 30 | + // this should have already been detected by the normalization strategy |
|
| 31 | + } |
|
| 32 | 32 | |
| 33 | 33 | |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @return array |
|
| 37 | - */ |
|
| 38 | - public function get_jquery_validation_rule_array() |
|
| 39 | - { |
|
| 40 | - return array( |
|
| 41 | - 'number' => true, |
|
| 42 | - 'step' => 1, |
|
| 43 | - 'messages' => array( |
|
| 44 | - 'number' => $this->get_validation_error_message(), |
|
| 45 | - 'step' => $this->get_validation_error_message() |
|
| 46 | - ) |
|
| 47 | - ); |
|
| 48 | - } |
|
| 35 | + /** |
|
| 36 | + * @return array |
|
| 37 | + */ |
|
| 38 | + public function get_jquery_validation_rule_array() |
|
| 39 | + { |
|
| 40 | + return array( |
|
| 41 | + 'number' => true, |
|
| 42 | + 'step' => 1, |
|
| 43 | + 'messages' => array( |
|
| 44 | + 'number' => $this->get_validation_error_message(), |
|
| 45 | + 'step' => $this->get_validation_error_message() |
|
| 46 | + ) |
|
| 47 | + ); |
|
| 48 | + } |
|
| 49 | 49 | } |
@@ -19,7 +19,7 @@ |
||
| 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 = sprintf( |
| 24 | 24 | esc_html__('Only the following HTML tags are allowed:%1$s%2$s', "event_espresso"), |
| 25 | 25 | '<br />', |
@@ -13,62 +13,62 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | class EE_Full_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 | - $validation_error_message = sprintf( |
|
| 23 | - esc_html__('Only the following HTML tags are allowed:%1$s%2$s', "event_espresso"), |
|
| 24 | - '<br />', |
|
| 25 | - $this->get_list_of_allowed_tags() |
|
| 26 | - ); |
|
| 27 | - } |
|
| 28 | - parent::__construct($validation_error_message); |
|
| 29 | - } |
|
| 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 = sprintf( |
|
| 23 | + esc_html__('Only the following HTML tags are allowed:%1$s%2$s', "event_espresso"), |
|
| 24 | + '<br />', |
|
| 25 | + $this->get_list_of_allowed_tags() |
|
| 26 | + ); |
|
| 27 | + } |
|
| 28 | + parent::__construct($validation_error_message); |
|
| 29 | + } |
|
| 30 | 30 | |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * get_list_of_allowed_tags |
|
| 34 | - * |
|
| 35 | - * generates and returns a string that lists the top-level HTML tags that are allowable for this input |
|
| 36 | - * |
|
| 37 | - * @return string |
|
| 38 | - */ |
|
| 39 | - public function get_list_of_allowed_tags() |
|
| 40 | - { |
|
| 41 | - $tags_we_allow = $this->getAllowedTags(); |
|
| 42 | - ksort($tags_we_allow); |
|
| 43 | - return implode(', ', array_keys($tags_we_allow)); |
|
| 44 | - } |
|
| 32 | + /** |
|
| 33 | + * get_list_of_allowed_tags |
|
| 34 | + * |
|
| 35 | + * generates and returns a string that lists the top-level HTML tags that are allowable for this input |
|
| 36 | + * |
|
| 37 | + * @return string |
|
| 38 | + */ |
|
| 39 | + public function get_list_of_allowed_tags() |
|
| 40 | + { |
|
| 41 | + $tags_we_allow = $this->getAllowedTags(); |
|
| 42 | + ksort($tags_we_allow); |
|
| 43 | + return implode(', ', array_keys($tags_we_allow)); |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * Returns an array whose keys are allowed tags and values are an array of allowed attributes |
|
| 49 | - * |
|
| 50 | - * @return array |
|
| 51 | - */ |
|
| 52 | - protected function getAllowedTags() |
|
| 53 | - { |
|
| 54 | - global $allowedposttags; |
|
| 55 | - return array_merge_recursive( |
|
| 56 | - $allowedposttags, |
|
| 57 | - EEH_HTML::get_simple_tags() |
|
| 58 | - ); |
|
| 59 | - } |
|
| 47 | + /** |
|
| 48 | + * Returns an array whose keys are allowed tags and values are an array of allowed attributes |
|
| 49 | + * |
|
| 50 | + * @return array |
|
| 51 | + */ |
|
| 52 | + protected function getAllowedTags() |
|
| 53 | + { |
|
| 54 | + global $allowedposttags; |
|
| 55 | + return array_merge_recursive( |
|
| 56 | + $allowedposttags, |
|
| 57 | + EEH_HTML::get_simple_tags() |
|
| 58 | + ); |
|
| 59 | + } |
|
| 60 | 60 | |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * @param $normalized_value |
|
| 64 | - * @throws \EE_Validation_Error |
|
| 65 | - */ |
|
| 66 | - public function validate($normalized_value) |
|
| 67 | - { |
|
| 68 | - parent::validate($normalized_value); |
|
| 69 | - $normalized_value_sans_tags = wp_kses("$normalized_value", $this->getAllowedTags()); |
|
| 70 | - if (strlen($normalized_value) > strlen($normalized_value_sans_tags)) { |
|
| 71 | - throw new EE_Validation_Error($this->get_validation_error_message(), 'complex_html_tags'); |
|
| 72 | - } |
|
| 73 | - } |
|
| 62 | + /** |
|
| 63 | + * @param $normalized_value |
|
| 64 | + * @throws \EE_Validation_Error |
|
| 65 | + */ |
|
| 66 | + public function validate($normalized_value) |
|
| 67 | + { |
|
| 68 | + parent::validate($normalized_value); |
|
| 69 | + $normalized_value_sans_tags = wp_kses("$normalized_value", $this->getAllowedTags()); |
|
| 70 | + if (strlen($normalized_value) > strlen($normalized_value_sans_tags)) { |
|
| 71 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'complex_html_tags'); |
|
| 72 | + } |
|
| 73 | + } |
|
| 74 | 74 | } |
@@ -19,7 +19,7 @@ |
||
| 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__("Please enter a valid credit card number", "event_espresso"); |
| 24 | 24 | } |
| 25 | 25 | parent::__construct( |
@@ -13,19 +13,19 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | class EE_Credit_Card_Validation_Strategy extends EE_Text_Validation_Strategy |
| 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__("Please enter a valid credit card number", "event_espresso"); |
|
| 23 | - } |
|
| 24 | - parent::__construct( |
|
| 25 | - $validation_error_message, |
|
| 26 | - // @codingStandardsIgnoreStart |
|
| 27 | - '~^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|2[2-7][0-9]{14}|6011[0-9]{12}|3(?:0[0-5]|[68][0-9])[0-9]{11}|3[47][0-9]{13})$~' |
|
| 28 | - // @codingStandardsIgnoreEnd |
|
| 29 | - ); |
|
| 30 | - } |
|
| 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__("Please enter a valid credit card number", "event_espresso"); |
|
| 23 | + } |
|
| 24 | + parent::__construct( |
|
| 25 | + $validation_error_message, |
|
| 26 | + // @codingStandardsIgnoreStart |
|
| 27 | + '~^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|2[2-7][0-9]{14}|6011[0-9]{12}|3(?:0[0-5]|[68][0-9])[0-9]{11}|3[47][0-9]{13})$~' |
|
| 28 | + // @codingStandardsIgnoreEnd |
|
| 29 | + ); |
|
| 30 | + } |
|
| 31 | 31 | } |
@@ -22,7 +22,7 @@ discard block |
||
| 22 | 22 | public function validate($normalized_value) |
| 23 | 23 | { |
| 24 | 24 | parent::validate($normalized_value); |
| 25 | - if (! $this->_input instanceof EE_Form_Input_With_Options_Base) { |
|
| 25 | + if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) { |
|
| 26 | 26 | throw new EE_Error(sprintf(esc_html__("Cannot use Enum Validation Strategy with an input that doesn't have options", "event_espresso"))); |
| 27 | 27 | } |
| 28 | 28 | $enum_options = $this->_input->flat_options(); |
@@ -49,7 +49,7 @@ discard block |
||
| 49 | 49 | public function get_validation_error_message() |
| 50 | 50 | { |
| 51 | 51 | $parent_validation_error_message = parent::get_validation_error_message(); |
| 52 | - if (! $parent_validation_error_message) { |
|
| 52 | + if ( ! $parent_validation_error_message) { |
|
| 53 | 53 | $enum_options = $this->_input instanceof EE_Form_Input_With_Options_Base ? $this->_input->flat_options() : ''; |
| 54 | 54 | return sprintf( |
| 55 | 55 | esc_html__("This is not allowed option. Allowed options are %s.", "event_espresso"), |
@@ -11,51 +11,51 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class EE_Enum_Validation_Strategy extends EE_Validation_Strategy_Base |
| 13 | 13 | { |
| 14 | - /** |
|
| 15 | - * Check that the value is in the allowed list |
|
| 16 | - * @param $normalized_value |
|
| 17 | - * @throws EE_Error |
|
| 18 | - * @throws EE_Validation_Error |
|
| 19 | - * @return boolean |
|
| 20 | - */ |
|
| 21 | - public function validate($normalized_value) |
|
| 22 | - { |
|
| 23 | - parent::validate($normalized_value); |
|
| 24 | - if (! $this->_input instanceof EE_Form_Input_With_Options_Base) { |
|
| 25 | - throw new EE_Error(sprintf(esc_html__("Cannot use Enum Validation Strategy with an input that doesn't have options", "event_espresso"))); |
|
| 26 | - } |
|
| 27 | - $enum_options = $this->_input->flat_options(); |
|
| 28 | - if ($normalized_value === true) { |
|
| 29 | - $normalized_value = 1; |
|
| 30 | - } elseif ($normalized_value === false) { |
|
| 31 | - $normalized_value = 0; |
|
| 32 | - } |
|
| 33 | - if ($normalized_value !== null && ! array_key_exists($normalized_value, $enum_options)) { |
|
| 34 | - throw new EE_Validation_Error( |
|
| 35 | - $this->get_validation_error_message(), |
|
| 36 | - 'invalid_enum_value' |
|
| 37 | - ); |
|
| 38 | - } else { |
|
| 39 | - return true; |
|
| 40 | - } |
|
| 41 | - } |
|
| 14 | + /** |
|
| 15 | + * Check that the value is in the allowed list |
|
| 16 | + * @param $normalized_value |
|
| 17 | + * @throws EE_Error |
|
| 18 | + * @throws EE_Validation_Error |
|
| 19 | + * @return boolean |
|
| 20 | + */ |
|
| 21 | + public function validate($normalized_value) |
|
| 22 | + { |
|
| 23 | + parent::validate($normalized_value); |
|
| 24 | + if (! $this->_input instanceof EE_Form_Input_With_Options_Base) { |
|
| 25 | + throw new EE_Error(sprintf(esc_html__("Cannot use Enum Validation Strategy with an input that doesn't have options", "event_espresso"))); |
|
| 26 | + } |
|
| 27 | + $enum_options = $this->_input->flat_options(); |
|
| 28 | + if ($normalized_value === true) { |
|
| 29 | + $normalized_value = 1; |
|
| 30 | + } elseif ($normalized_value === false) { |
|
| 31 | + $normalized_value = 0; |
|
| 32 | + } |
|
| 33 | + if ($normalized_value !== null && ! array_key_exists($normalized_value, $enum_options)) { |
|
| 34 | + throw new EE_Validation_Error( |
|
| 35 | + $this->get_validation_error_message(), |
|
| 36 | + 'invalid_enum_value' |
|
| 37 | + ); |
|
| 38 | + } else { |
|
| 39 | + return true; |
|
| 40 | + } |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * If we are using the default validation error message, make it dynamic based |
|
| 45 | - * on the allowed options. |
|
| 46 | - * @return string |
|
| 47 | - */ |
|
| 48 | - public function get_validation_error_message() |
|
| 49 | - { |
|
| 50 | - $parent_validation_error_message = parent::get_validation_error_message(); |
|
| 51 | - if (! $parent_validation_error_message) { |
|
| 52 | - $enum_options = $this->_input instanceof EE_Form_Input_With_Options_Base ? $this->_input->flat_options() : ''; |
|
| 53 | - return sprintf( |
|
| 54 | - esc_html__("This is not allowed option. Allowed options are %s.", "event_espresso"), |
|
| 55 | - implode(', ', $enum_options) |
|
| 56 | - ); |
|
| 57 | - } else { |
|
| 58 | - return $parent_validation_error_message; |
|
| 59 | - } |
|
| 60 | - } |
|
| 43 | + /** |
|
| 44 | + * If we are using the default validation error message, make it dynamic based |
|
| 45 | + * on the allowed options. |
|
| 46 | + * @return string |
|
| 47 | + */ |
|
| 48 | + public function get_validation_error_message() |
|
| 49 | + { |
|
| 50 | + $parent_validation_error_message = parent::get_validation_error_message(); |
|
| 51 | + if (! $parent_validation_error_message) { |
|
| 52 | + $enum_options = $this->_input instanceof EE_Form_Input_With_Options_Base ? $this->_input->flat_options() : ''; |
|
| 53 | + return sprintf( |
|
| 54 | + esc_html__("This is not allowed option. Allowed options are %s.", "event_espresso"), |
|
| 55 | + implode(', ', $enum_options) |
|
| 56 | + ); |
|
| 57 | + } else { |
|
| 58 | + return $parent_validation_error_message; |
|
| 59 | + } |
|
| 60 | + } |
|
| 61 | 61 | } |
@@ -19,7 +19,7 @@ |
||
| 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__("This field is required.", "event_espresso"); |
| 24 | 24 | } |
| 25 | 25 | parent::__construct($validation_error_message); |
@@ -11,54 +11,54 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class EE_Required_Validation_Strategy extends EE_Validation_Strategy_Base |
| 13 | 13 | { |
| 14 | - /** |
|
| 15 | - * @param string $validation_error_message |
|
| 16 | - */ |
|
| 17 | - public function __construct($validation_error_message = null) |
|
| 18 | - { |
|
| 19 | - if (! $validation_error_message) { |
|
| 20 | - $validation_error_message = esc_html__("This field is required.", "event_espresso"); |
|
| 21 | - } |
|
| 22 | - parent::__construct($validation_error_message); |
|
| 23 | - } |
|
| 14 | + /** |
|
| 15 | + * @param string $validation_error_message |
|
| 16 | + */ |
|
| 17 | + public function __construct($validation_error_message = null) |
|
| 18 | + { |
|
| 19 | + if (! $validation_error_message) { |
|
| 20 | + $validation_error_message = esc_html__("This field is required.", "event_espresso"); |
|
| 21 | + } |
|
| 22 | + parent::__construct($validation_error_message); |
|
| 23 | + } |
|
| 24 | 24 | |
| 25 | 25 | |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * just checks the field isn't blank, provided the requirement conditions |
|
| 29 | - * indicate this input is still required |
|
| 30 | - * |
|
| 31 | - * @param $normalized_value |
|
| 32 | - * @return bool |
|
| 33 | - * @throws \EE_Error |
|
| 34 | - * @throws \EE_Validation_Error |
|
| 35 | - */ |
|
| 36 | - public function validate($normalized_value) |
|
| 37 | - { |
|
| 38 | - if ( |
|
| 39 | - $normalized_value === '' |
|
| 40 | - || $normalized_value === null |
|
| 41 | - || $normalized_value === array() |
|
| 42 | - ) { |
|
| 43 | - throw new EE_Validation_Error($this->get_validation_error_message(), 'required'); |
|
| 44 | - } else { |
|
| 45 | - return true; |
|
| 46 | - } |
|
| 47 | - } |
|
| 27 | + /** |
|
| 28 | + * just checks the field isn't blank, provided the requirement conditions |
|
| 29 | + * indicate this input is still required |
|
| 30 | + * |
|
| 31 | + * @param $normalized_value |
|
| 32 | + * @return bool |
|
| 33 | + * @throws \EE_Error |
|
| 34 | + * @throws \EE_Validation_Error |
|
| 35 | + */ |
|
| 36 | + public function validate($normalized_value) |
|
| 37 | + { |
|
| 38 | + if ( |
|
| 39 | + $normalized_value === '' |
|
| 40 | + || $normalized_value === null |
|
| 41 | + || $normalized_value === array() |
|
| 42 | + ) { |
|
| 43 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'required'); |
|
| 44 | + } else { |
|
| 45 | + return true; |
|
| 46 | + } |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | 49 | |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @return array |
|
| 53 | - * @throws \EE_Error |
|
| 54 | - */ |
|
| 55 | - public function get_jquery_validation_rule_array() |
|
| 56 | - { |
|
| 57 | - return array( |
|
| 58 | - 'required' => true, |
|
| 59 | - 'messages' => array( |
|
| 60 | - 'required' => $this->get_validation_error_message() |
|
| 61 | - ) |
|
| 62 | - ); |
|
| 63 | - } |
|
| 51 | + /** |
|
| 52 | + * @return array |
|
| 53 | + * @throws \EE_Error |
|
| 54 | + */ |
|
| 55 | + public function get_jquery_validation_rule_array() |
|
| 56 | + { |
|
| 57 | + return array( |
|
| 58 | + 'required' => true, |
|
| 59 | + 'messages' => array( |
|
| 60 | + 'required' => $this->get_validation_error_message() |
|
| 61 | + ) |
|
| 62 | + ); |
|
| 63 | + } |
|
| 64 | 64 | } |
@@ -33,7 +33,7 @@ discard block |
||
| 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 |
||
| 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 | } |
@@ -13,86 +13,86 @@ |
||
| 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 |
@@ -19,7 +19,7 @@ |
||
| 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); |
@@ -13,27 +13,27 @@ |
||
| 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 | } |
@@ -28,7 +28,7 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 252 | 252 | __LINE__ |
| 253 | 253 | ); |
| 254 | 254 | } |
| 255 | - return array( $operator, $value ); |
|
| 255 | + return array($operator, $value); |
|
| 256 | 256 | } |
| 257 | 257 | } |
@@ -11,246 +11,246 @@ |
||
| 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 | } |