-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathValidationSet.php
More file actions
253 lines (228 loc) · 6.39 KB
/
Copy pathValidationSet.php
File metadata and controls
253 lines (228 loc) · 6.39 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 2.2.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Validation;
use ArrayAccess;
use ArrayIterator;
use Cake\Core\Exception\CakeException;
use Countable;
use IteratorAggregate;
use Traversable;
/**
* ValidationSet object. Holds all validation rules for a field and exposes
* methods to dynamically add or remove validation rules
*
* @template-implements \ArrayAccess<string, \Cake\Validation\ValidationRule>
* @template-implements \IteratorAggregate<string, \Cake\Validation\ValidationRule>
*/
class ValidationSet implements ArrayAccess, IteratorAggregate, Countable
{
/**
* Holds the ValidationRule objects
*
* @var array<\Cake\Validation\ValidationRule>
*/
protected array $_rules = [];
/**
* Denotes whether the field name key must be present in data array
*
* @var callable|string|bool
*/
protected $_validatePresent = false;
/**
* Denotes if a field is allowed to be empty
*
* @var callable|string|bool
*/
protected $_allowEmpty = false;
/**
* Returns whether a field can be left out.
*
* @return callable|string|bool
*/
public function isPresenceRequired(): callable|string|bool
{
return $this->_validatePresent;
}
/**
* Sets whether a field is required to be present in data array.
*
* @param callable|string|bool $validatePresent Valid values are true, false, 'create', 'update' or a callable.
* @return $this
*/
public function requirePresence(callable|string|bool $validatePresent)
{
$this->_validatePresent = $validatePresent;
return $this;
}
/**
* Returns whether a field can be left empty.
*
* @return callable|string|bool
*/
public function isEmptyAllowed(): callable|string|bool
{
return $this->_allowEmpty;
}
/**
* Sets whether a field value is allowed to be empty.
*
* @param callable|string|bool $allowEmpty Valid values are true, false,
* 'create', 'update' or a callable.
* @return $this
*/
public function allowEmpty(callable|string|bool $allowEmpty)
{
$this->_allowEmpty = $allowEmpty;
return $this;
}
/**
* Gets a rule for a given name if exists
*
* @param string $name The name under which the rule is set.
* @return \Cake\Validation\ValidationRule|null
*/
public function rule(string $name): ?ValidationRule
{
if (empty($this->_rules[$name])) {
return null;
}
return $this->_rules[$name];
}
/**
* Returns all rules for this validation set
*
* @return array<\Cake\Validation\ValidationRule>
*/
public function rules(): array
{
return $this->_rules;
}
/**
* Returns whether a validation rule with the given name exists in this set.
*
* @param string $name The name to check
* @return bool
*/
public function has(string $name): bool
{
return array_key_exists($name, $this->_rules);
}
/**
* Sets a ValidationRule $rule with a $name
*
* ### Example:
*
* ```
* $set
* ->add('notBlank', ['rule' => 'notBlank'])
* ->add('inRange', ['rule' => ['between', 4, 10])
* ```
*
* @param string $name The name under which the rule should be set
* @param \Cake\Validation\ValidationRule|array $rule The validation rule to be set
* @return $this
* @throws \Cake\Core\Exception\CakeException If a rule with the same name already exists
*/
public function add(string $name, ValidationRule|array $rule)
{
if (!($rule instanceof ValidationRule)) {
$rule = new ValidationRule($rule);
}
if (array_key_exists($name, $this->_rules)) {
throw new CakeException("A validation rule with the name `{$name}` already exists");
}
$this->_rules[$name] = $rule;
return $this;
}
/**
* Removes a validation rule from the set
*
* ### Example:
*
* ```
* $set
* ->remove('notBlank')
* ->remove('inRange')
* ```
*
* @param string $name The name under which the rule should be unset
* @return $this
*/
public function remove(string $name)
{
unset($this->_rules[$name]);
return $this;
}
/**
* Returns whether an index exists in the rule set
*
* @param string $index name of the rule
* @return bool
*/
public function offsetExists(mixed $index): bool
{
return isset($this->_rules[$index]);
}
/**
* Returns a rule object by its index
*
* @param string $index name of the rule
* @return \Cake\Validation\ValidationRule
*/
public function offsetGet(mixed $index): ValidationRule
{
return $this->_rules[$index];
}
/**
* Sets or replace a validation rule
*
* @param string $offset name of the rule
* @param \Cake\Validation\ValidationRule|array $value Rule to add to $index
* @return void
*/
public function offsetSet(mixed $offset, mixed $value): void
{
$this->add($offset, $value);
}
/**
* Unsets a validation rule
*
* @param string $index name of the rule
* @return void
*/
public function offsetUnset(mixed $index): void
{
unset($this->_rules[$index]);
}
/**
* Returns an iterator for each of the rules to be applied
*
* @return \Traversable<string, \Cake\Validation\ValidationRule>
*/
public function getIterator(): Traversable
{
return new ArrayIterator($this->_rules);
}
/**
* Returns the number of rules in this set
*
* @return int
*/
public function count(): int
{
return count($this->_rules);
}
}