This repository has been archived by the owner on Jan 8, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
ValidatorChain.php
248 lines (228 loc) · 6.47 KB
/
ValidatorChain.php
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
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @package Zend_Validator
*/
namespace Zend\Validator;
use Countable;
/**
* @category Zend
* @package Zend_Validator
*/
class ValidatorChain implements
Countable,
ValidatorInterface
{
/**
* @var ValidatorPluginManager
*/
protected $plugins;
/**
* Validator chain
*
* @var array
*/
protected $validators = array();
/**
* Array of validation failure messages
*
* @var array
*/
protected $messages = array();
/**
* Return the count of attached validators
*
* @return int
*/
public function count()
{
return count($this->validators);
}
/**
* Get plugin manager instance
*
* @return ValidatorPluginManager
*/
public function getPluginManager()
{
if (!$this->plugins) {
$this->setPluginManager(new ValidatorPluginManager());
}
return $this->plugins;
}
/**
* Set plugin manager instance
*
* @param ValidatorPluginManager $plugins Plugin manager
* @return ValidatorChain
*/
public function setPluginManager(ValidatorPluginManager $plugins)
{
$this->plugins = $plugins;
return $this;
}
/**
* Retrieve a validator by name
*
* @param string $name Name of validator to return
* @param null|array $options Options to pass to validator constructor (if not already instantiated)
* @return ValidatorInterface
*/
public function plugin($name, array $options = null)
{
$plugins = $this->getPluginManager();
return $plugins->get($name, $options);
}
/**
* Adds a validator to the end of the chain
*
* If $breakChainOnFailure is true, then if the validator fails, the next validator in the chain,
* if one exists, will not be executed.
*
* @param ValidatorInterface $validator
* @param boolean $breakChainOnFailure
* @return ValidatorChain Provides a fluent interface
*/
public function addValidator(ValidatorInterface $validator, $breakChainOnFailure = false)
{
$this->validators[] = array(
'instance' => $validator,
'breakChainOnFailure' => (boolean)$breakChainOnFailure
);
return $this;
}
/**
* Adds a validator to the beginning of the chain
*
* If $breakChainOnFailure is true, then if the validator fails, the next validator in the chain,
* if one exists, will not be executed.
*
* @param ValidatorInterface $validator
* @param boolean $breakChainOnFailure
* @return ValidatorChain Provides a fluent interface
*/
public function prependValidator(ValidatorInterface $validator, $breakChainOnFailure = false)
{
array_unshift($this->validators,
array(
'instance' => $validator,
'breakChainOnFailure' => (boolean)$breakChainOnFailure
)
);
return $this;
}
/**
* Use the plugin manager to add a validator by name
*
* @param string $name
* @param array $options
* @param bool $breakChainOnFailure
* @return ValidatorChain
*/
public function addByName($name, $options = array(), $breakChainOnFailure = false)
{
$validator = $this->plugin($name, $options);
$this->addValidator($validator, $breakChainOnFailure);
return $this;
}
/**
* Use the plugin manager to prepend a validator by name
*
* @param string $name
* @param array $options
* @param bool $breakChainOnFailure
* @return ValidatorChain
*/
public function prependByName($name, $options = array(), $breakChainOnFailure = false)
{
$validator = $this->plugin($name, $options);
$this->prependValidator($validator, $breakChainOnFailure);
return $this;
}
/**
* Returns true if and only if $value passes all validations in the chain
*
* Validators are run in the order in which they were added to the chain (FIFO).
*
* @param mixed $value
* @param mixed $context Extra "context" to provide the validator
* @return boolean
*/
public function isValid($value, $context = null)
{
$this->messages = array();
$result = true;
foreach ($this->validators as $element) {
$validator = $element['instance'];
if ($validator->isValid($value, $context)) {
continue;
}
$result = false;
$messages = $validator->getMessages();
$this->messages = array_replace_recursive($this->messages, $messages);
if ($element['breakChainOnFailure']) {
break;
}
}
return $result;
}
/**
* Merge the validator chain with the one given in parameter
*
* @param ValidatorChain $validatorChain
* @return ValidatorChain
*/
public function merge(ValidatorChain $validatorChain)
{
foreach ($validatorChain->validators as $validator) {
$this->validators[] = $validator;
}
return $this;
}
/**
* Returns array of validation failure messages
*
* @return array
*/
public function getMessages()
{
return $this->messages;
}
/**
* Get all the validators
*
* @return array
*/
public function getValidators()
{
return $this->validators;
}
/**
* Invoke chain as command
*
* @param mixed $value
* @return boolean
*/
public function __invoke($value)
{
return $this->isValid($value);
}
/**
* Prepare validator chain for serialization
*
* Plugin manager (property 'plugins') cannot
* be serialized. On wakeup the property remains unset
* and next invokation to getPluginManager() sets
* the default plugin manager instance (ValidatorPluginManager).
*
* @return array
*/
public function __sleep()
{
return array('validators','messages');
}
}