give / vendor / vendor-prefixed / stellarwp / validation / src / Validator.php

Validator.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.0, at vendor/vendor-prefixed/stellarwp/validation/src/Validator.php

170 lines 4.2 KB

Raw Download Zip

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