Commands
2 years ago
Concerns
2 years ago
Contracts
2 years ago
Exceptions
2 years ago
Rules
2 years ago
Config.php
2 years ago
ServiceProvider.php
2 years ago
ValidationRuleSet.php
2 years ago
ValidationRulesRegistrar.php
2 years ago
Validator.php
2 years ago
Validator.php
173 lines
| 1 | <?php |
| 2 | /** |
| 3 | * @license GPL-2.0-or-later |
| 4 | * |
| 5 | * Modified by impress-org on 21-October-2023 using Strauss. |
| 6 | * @see https://github.com/BrianHenryIE/strauss |
| 7 | */ |
| 8 | |
| 9 | declare(strict_types=1); |
| 10 | |
| 11 | namespace Give\Vendors\StellarWP\Validation; |
| 12 | |
| 13 | use Give\Vendors\StellarWP\Validation\Commands\ExcludeValue; |
| 14 | use Give\Vendors\StellarWP\Validation\Commands\SkipValidationRules; |
| 15 | use Give\Vendors\StellarWP\Validation\Contracts\Sanitizer; |
| 16 | |
| 17 | /** |
| 18 | * A tool for taking in a set of values and corresponding validation rules, and then validating the values. |
| 19 | * |
| 20 | * @since 1.0.0 |
| 21 | */ |
| 22 | class Validator |
| 23 | { |
| 24 | /** |
| 25 | * @var array<string, ValidationRuleSet> |
| 26 | */ |
| 27 | private $ruleSets; |
| 28 | |
| 29 | /** |
| 30 | * @var array<string, mixed> |
| 31 | */ |
| 32 | private $values; |
| 33 | |
| 34 | /** |
| 35 | * @var array<string, string> |
| 36 | */ |
| 37 | private $labels; |
| 38 | |
| 39 | /** |
| 40 | * @var array<string, string> |
| 41 | */ |
| 42 | private $errors = []; |
| 43 | |
| 44 | /** |
| 45 | * @var array<string, mixed> |
| 46 | */ |
| 47 | private $validatedValues = []; |
| 48 | |
| 49 | /** |
| 50 | * @var bool |
| 51 | */ |
| 52 | private $ranValidationRules = false; |
| 53 | |
| 54 | /** |
| 55 | * @since 1.0.0 |
| 56 | * |
| 57 | * @param array<string, ValidationRuleSet|array> $ruleSets |
| 58 | * @param array<string, mixed> $values |
| 59 | */ |
| 60 | public function __construct(array $ruleSets, array $values, array $labels = []) |
| 61 | { |
| 62 | $validatedRules = []; |
| 63 | foreach ($ruleSets as $key => $rule) { |
| 64 | if (is_array($rule)) { |
| 65 | $validatedRules[$key] = Config::getServiceContainer()->get(ValidationRuleSet::class)->rules(...$rule); |
| 66 | } elseif ($rule instanceof ValidationRuleSet) { |
| 67 | $validatedRules[$key] = $rule; |
| 68 | } else { |
| 69 | Config::throwInvalidArgumentException( |
| 70 | 'Validation rules must be an instance of ValidationRuleSet or a compatible array' |
| 71 | ); |
| 72 | } |
| 73 | } |
| 74 | |
| 75 | $this->ruleSets = $validatedRules; |
| 76 | $this->values = $values; |
| 77 | $this->labels = $labels; |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * Returns whether the values failed validation or not. |
| 82 | * |
| 83 | * @since 1.0.0 |
| 84 | */ |
| 85 | public function fails(): bool |
| 86 | { |
| 87 | return !$this->passes(); |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * Returns whether the values passed validation or not. |
| 92 | * |
| 93 | * @since 1.0.0 |
| 94 | */ |
| 95 | public function passes(): bool |
| 96 | { |
| 97 | $this->runValidationRules(); |
| 98 | |
| 99 | return empty($this->errors); |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Runs the validation rules on the values, and stores any resulting errors. |
| 104 | * Will run only once, and then store the results for subsequent calls. |
| 105 | * |
| 106 | * @since 1.0.0 |
| 107 | * |
| 108 | * @return void |
| 109 | */ |
| 110 | private function runValidationRules() |
| 111 | { |
| 112 | if ($this->ranValidationRules) { |
| 113 | return; |
| 114 | } |
| 115 | |
| 116 | foreach ($this->ruleSets as $key => $ruleSet) { |
| 117 | $label = $this->labels[$key] ?? $key; |
| 118 | $value = $this->values[$key] ?? null; |
| 119 | |
| 120 | $fail = function (string $message) use ($key, $label) { |
| 121 | $this->errors[$key] = str_ireplace('{field}', $label, $message); |
| 122 | }; |
| 123 | |
| 124 | foreach ($ruleSet as $rule) { |
| 125 | $command = $rule($value, $fail, $key, $this->values); |
| 126 | |
| 127 | if ($command instanceof SkipValidationRules) { |
| 128 | break; |
| 129 | } |
| 130 | |
| 131 | if ($command instanceof ExcludeValue) { |
| 132 | // Skip the rest of the rule and do not store the value |
| 133 | continue 2; |
| 134 | } |
| 135 | |
| 136 | if ($rule instanceof Sanitizer) { |
| 137 | $value = $rule->sanitize($value); |
| 138 | } |
| 139 | } |
| 140 | |
| 141 | $this->validatedValues[$key] = $value; |
| 142 | } |
| 143 | |
| 144 | $this->ranValidationRules = true; |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Returns the errors that were found during validation. |
| 149 | * |
| 150 | * @since 1.0.0 |
| 151 | * |
| 152 | * @return array<string, string> |
| 153 | */ |
| 154 | public function errors(): array |
| 155 | { |
| 156 | $this->runValidationRules(); |
| 157 | |
| 158 | return $this->errors; |
| 159 | } |
| 160 | |
| 161 | /** |
| 162 | * Returns the validated values, with any sanitization rules applied. |
| 163 | * |
| 164 | * @since 1.0.0 |
| 165 | */ |
| 166 | public function validated(): array |
| 167 | { |
| 168 | $this->runValidationRules(); |
| 169 | |
| 170 | return $this->validatedValues; |
| 171 | } |
| 172 | } |
| 173 |