|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* This file is part of slick/validator package |
|
5
|
|
|
* |
|
6
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
7
|
|
|
* file that was distributed with this source code. |
|
8
|
|
|
*/ |
|
9
|
|
|
|
|
10
|
|
|
namespace Slick\Validator; |
|
11
|
|
|
|
|
12
|
|
|
use Slick\Common\Utils\Collection\AbstractCollection; |
|
13
|
|
|
use Slick\Common\Utils\CollectionInterface; |
|
14
|
|
|
|
|
15
|
|
|
/** |
|
16
|
|
|
* Validation Chain |
|
17
|
|
|
* |
|
18
|
|
|
* @package Slick\Validator |
|
19
|
|
|
* @author Filipe Silva <[email protected]> |
|
20
|
|
|
*/ |
|
21
|
|
|
class ValidationChain extends AbstractCollection implements |
|
22
|
|
|
ValidationChainInterface, |
|
23
|
|
|
CollectionInterface |
|
24
|
|
|
{ |
|
25
|
|
|
|
|
26
|
|
|
/** |
|
27
|
|
|
* @var array List of validation messages |
|
28
|
|
|
*/ |
|
29
|
|
|
protected $messages = []; |
|
30
|
|
|
|
|
31
|
|
|
/** |
|
32
|
|
|
* @var string Custom message for all chain |
|
33
|
|
|
*/ |
|
34
|
|
|
protected $message; |
|
35
|
|
|
|
|
36
|
|
|
/** |
|
37
|
|
|
* @var string |
|
38
|
|
|
*/ |
|
39
|
|
|
protected $messageTemplate; |
|
40
|
|
|
|
|
41
|
|
|
/** |
|
42
|
|
|
* Returns an array of messages that explain why the most recent |
|
43
|
|
|
* validates() call returned false. |
|
44
|
|
|
* |
|
45
|
|
|
* @return array |
|
46
|
|
|
*/ |
|
47
|
4 |
|
public function getMessages() |
|
48
|
|
|
{ |
|
49
|
4 |
|
return $this->messages; |
|
50
|
|
|
} |
|
51
|
|
|
|
|
52
|
|
|
/** |
|
53
|
|
|
* Adds a validator to the chain |
|
54
|
|
|
* |
|
55
|
|
|
* @param ValidatorInterface $validator |
|
56
|
|
|
* |
|
57
|
|
|
* @return ValidatorChain |
|
58
|
|
|
*/ |
|
59
|
10 |
|
public function add(ValidatorInterface $validator) |
|
60
|
|
|
{ |
|
61
|
10 |
|
$this->data[] = $validator; |
|
62
|
10 |
|
return $this; |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
|
|
/** |
|
66
|
|
|
* Returns true if and only if $value meets the validation requirements |
|
67
|
|
|
* |
|
68
|
|
|
* The context specified can be used in the validation process so that |
|
69
|
|
|
* the same value can be valid or invalid depending on that data. |
|
70
|
|
|
* |
|
71
|
|
|
* @param mixed $value |
|
72
|
|
|
* @param array|mixed $context |
|
73
|
|
|
* |
|
74
|
|
|
* @return bool |
|
75
|
|
|
*/ |
|
76
|
10 |
|
public function validates($value, $context = []) |
|
77
|
|
|
{ |
|
78
|
10 |
|
$valid = true; |
|
79
|
10 |
View Code Duplication |
foreach ($this->getIterator() as $validator) { |
|
|
|
|
|
|
80
|
10 |
|
if (!$validator->validates($value, $context)) { |
|
81
|
8 |
|
$valid = false; |
|
82
|
8 |
|
$this->messages[] = $validator->getMessage(); |
|
83
|
8 |
|
} |
|
84
|
10 |
|
} |
|
85
|
10 |
|
$this->message = $valid ? '' : $this->messageTemplate; |
|
86
|
10 |
|
return $valid; |
|
87
|
|
|
} |
|
88
|
|
|
|
|
89
|
|
|
/** |
|
90
|
|
|
* Returns a message that explain why the most recent |
|
91
|
|
|
* isValid() call returned false. |
|
92
|
|
|
* |
|
93
|
|
|
* @return array |
|
94
|
|
|
*/ |
|
95
|
4 |
|
public function getMessage() |
|
96
|
|
|
{ |
|
97
|
4 |
|
$last = (null === $this->message) |
|
98
|
4 |
|
? end($this->messages) |
|
99
|
4 |
|
: $this->message; |
|
100
|
4 |
|
return $last; |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
/** |
|
104
|
|
|
* Sets a custom message for the chain in case of fail |
|
105
|
|
|
* |
|
106
|
|
|
* @param string $message |
|
107
|
|
|
* |
|
108
|
|
|
* @return ValidatorInterface |
|
109
|
|
|
*/ |
|
110
|
2 |
|
public function setMessage($message) |
|
111
|
|
|
{ |
|
112
|
2 |
|
$this->messageTemplate = $message; |
|
113
|
2 |
|
} |
|
114
|
|
|
|
|
115
|
|
|
/** |
|
116
|
|
|
* Retrieve an external iterator |
|
117
|
|
|
* |
|
118
|
|
|
* @return \Traversable|ValidatorInterface[] |
|
119
|
|
|
* A list of ValidatorInterface objects |
|
120
|
|
|
*/ |
|
121
|
10 |
|
public function getIterator() |
|
122
|
|
|
{ |
|
123
|
10 |
|
return parent::getIterator(); |
|
124
|
|
|
} |
|
125
|
|
|
|
|
126
|
|
|
/** |
|
127
|
|
|
* Offset to set |
|
128
|
|
|
* |
|
129
|
|
|
* @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
130
|
|
|
* |
|
131
|
|
|
* @param mixed $offset The offset to assign the value to. |
|
132
|
|
|
* @param mixed $value The value to set. |
|
133
|
|
|
*/ |
|
134
|
10 |
|
public function offsetSet($offset, $value) |
|
135
|
|
|
{ |
|
136
|
10 |
|
$this->add($value); |
|
137
|
|
|
} |
|
138
|
|
|
} |
slickframework /
validator
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.