/
AssertionChain.php
196 lines (176 loc) · 12 KB
/
AssertionChain.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
<?php
/**
* Assert
*
* LICENSE
*
* This source file is subject to the MIT license that is bundled
* with this package in the file LICENSE.txt.
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
*
* to kontakt@beberlei.de so I can send you a copy immediately.
*/
namespace Assert;
use ReflectionClass;
/**
* Chaining builder for assertions
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
*
* @method AssertionChain alnum($message = null, $propertyPath = null) Assert that value is alphanumeric.
* @method AssertionChain between($lowerLimit, $upperLimit, $message = null, $propertyPath = null) Assert that a value is greater or equal than a lower limit, and less than or equal to an upper limit.
* @method AssertionChain betweenExclusive($lowerLimit, $upperLimit, $message = null, $propertyPath = null) Assert that a value is greater than a lower limit, and less than an upper limit.
* @method AssertionChain betweenLength($minLength, $maxLength, $message = null, $propertyPath = null, $encoding = "utf8") Assert that string length is between min,max lengths.
* @method AssertionChain boolean($message = null, $propertyPath = null) Assert that value is php boolean.
* @method AssertionChain choice($choices, $message = null, $propertyPath = null) Assert that value is in array of choices.
* @method AssertionChain choicesNotEmpty($choices, $message = null, $propertyPath = null) Determines if the values array has every choice as key and that this choice has content.
* @method AssertionChain classExists($message = null, $propertyPath = null) Assert that the class exists.
* @method AssertionChain contains($needle, $message = null, $propertyPath = null, $encoding = "utf8") Assert that string contains a sequence of chars.
* @method AssertionChain count($count, $message = null, $propertyPath = null) Assert that the count of countable is equal to count.
* @method AssertionChain date($format, $message = null, $propertyPath = null) Assert that date is valid and corresponds to the given format.
* @method AssertionChain digit($message = null, $propertyPath = null) Validates if an integer or integerish is a digit.
* @method AssertionChain directory($message = null, $propertyPath = null) Assert that a directory exists.
* @method AssertionChain e164($message = null, $propertyPath = null) Assert that the given string is a valid E164 Phone Number.
* @method AssertionChain email($message = null, $propertyPath = null) Assert that value is an email adress (using input_filter/FILTER_VALIDATE_EMAIL).
* @method AssertionChain endsWith($needle, $message = null, $propertyPath = null, $encoding = "utf8") Assert that string ends with a sequence of chars.
* @method AssertionChain eq($value2, $message = null, $propertyPath = null) Assert that two values are equal (using == ).
* @method AssertionChain false($message = null, $propertyPath = null) Assert that the value is boolean False.
* @method AssertionChain file($message = null, $propertyPath = null) Assert that a file exists.
* @method AssertionChain float($message = null, $propertyPath = null) Assert that value is a php float.
* @method AssertionChain greaterOrEqualThan($limit, $message = null, $propertyPath = null) Determines if the value is greater or equal than given limit.
* @method AssertionChain greaterThan($limit, $message = null, $propertyPath = null) Determines if the value is greater than given limit.
* @method AssertionChain implementsInterface($interfaceName, $message = null, $propertyPath = null) Assert that the class implements the interface.
* @method AssertionChain inArray($choices, $message = null, $propertyPath = null) Alias of {@see choice()}.
* @method AssertionChain integer($message = null, $propertyPath = null) Assert that value is a php integer.
* @method AssertionChain integerish($message = null, $propertyPath = null) Assert that value is a php integer'ish.
* @method AssertionChain interfaceExists($message = null, $propertyPath = null) Assert that the interface exists.
* @method AssertionChain ip($flag = null, $message = null, $propertyPath = null) Assert that value is an IPv4 or IPv6 address.
* @method AssertionChain ipv4($flag = null, $message = null, $propertyPath = null) Assert that value is an IPv4 address.
* @method AssertionChain ipv6($flag = null, $message = null, $propertyPath = null) Assert that value is an IPv6 address.
* @method AssertionChain isArray($message = null, $propertyPath = null) Assert that value is an array.
* @method AssertionChain isArrayAccessible($message = null, $propertyPath = null) Assert that value is an array or an array-accessible object.
* @method AssertionChain isCallable($message = null, $propertyPath = null) Determines that the provided value is callable.
* @method AssertionChain isInstanceOf($className, $message = null, $propertyPath = null) Assert that value is instance of given class-name.
* @method AssertionChain isJsonString($message = null, $propertyPath = null) Assert that the given string is a valid json string.
* @method AssertionChain isObject($message = null, $propertyPath = null) Determines that the provided value is an object.
* @method AssertionChain isTraversable($message = null, $propertyPath = null) Assert that value is an array or a traversable object.
* @method AssertionChain keyExists($key, $message = null, $propertyPath = null) Assert that key exists in an array.
* @method AssertionChain keyIsset($key, $message = null, $propertyPath = null) Assert that key exists in an array/array-accessible object using isset().
* @method AssertionChain keyNotExists($key, $message = null, $propertyPath = null) Assert that key does not exist in an array.
* @method AssertionChain length($length, $message = null, $propertyPath = null, $encoding = "utf8") Assert that string has a given length.
* @method AssertionChain lessOrEqualThan($limit, $message = null, $propertyPath = null) Determines if the value is less or than given limit.
* @method AssertionChain lessThan($limit, $message = null, $propertyPath = null) Determines if the value is less than given limit.
* @method AssertionChain max($maxValue, $message = null, $propertyPath = null) Assert that a number is smaller as a given limit.
* @method AssertionChain maxLength($maxLength, $message = null, $propertyPath = null, $encoding = "utf8") Assert that string value is not longer than $maxLength chars.
* @method AssertionChain methodExists($object, $message = null, $propertyPath = null) Determines that the named method is defined in the provided object.
* @method AssertionChain min($minValue, $message = null, $propertyPath = null) Assert that a value is at least as big as a given limit.
* @method AssertionChain minLength($minLength, $message = null, $propertyPath = null, $encoding = "utf8") Assert that a string is at least $minLength chars long.
* @method AssertionChain noContent($message = null, $propertyPath = null) Assert that value is empty.
* @method AssertionChain notBlank($message = null, $propertyPath = null) Assert that value is not blank.
* @method AssertionChain notEmpty($message = null, $propertyPath = null) Assert that value is not empty.
* @method AssertionChain notEmptyKey($key, $message = null, $propertyPath = null) Assert that key exists in an array/array-accessible object and it's value is not empty.
* @method AssertionChain notEq($value2, $message = null, $propertyPath = null) Assert that two values are not equal (using == ).
* @method AssertionChain notInArray($choices, $message = null, $propertyPath = null) Assert that value is not in array of choices.
* @method AssertionChain notIsInstanceOf($className, $message = null, $propertyPath = null) Assert that value is not instance of given class-name.
* @method AssertionChain notNull($message = null, $propertyPath = null) Assert that value is not null.
* @method AssertionChain notSame($value2, $message = null, $propertyPath = null) Assert that two values are not the same (using === ).
* @method AssertionChain null($message = null, $propertyPath = null) Assert that value is null.
* @method AssertionChain numeric($message = null, $propertyPath = null) Assert that value is numeric.
* @method AssertionChain range($minValue, $maxValue, $message = null, $propertyPath = null) Assert that value is in range of numbers.
* @method AssertionChain readable($message = null, $propertyPath = null) Assert that the value is something readable.
* @method AssertionChain regex($pattern, $message = null, $propertyPath = null) Assert that value matches a regex.
* @method AssertionChain same($value2, $message = null, $propertyPath = null) Assert that two values are the same (using ===).
* @method AssertionChain satisfy($callback, $message = null, $propertyPath = null) Assert that the provided value is valid according to a callback.
* @method AssertionChain scalar($message = null, $propertyPath = null) Assert that value is a PHP scalar.
* @method AssertionChain startsWith($needle, $message = null, $propertyPath = null, $encoding = "utf8") Assert that string starts with a sequence of chars.
* @method AssertionChain string($message = null, $propertyPath = null) Assert that value is a string.
* @method AssertionChain subclassOf($className, $message = null, $propertyPath = null) Assert that value is subclass of given class-name.
* @method AssertionChain true($message = null, $propertyPath = null) Assert that the value is boolean True.
* @method AssertionChain url($message = null, $propertyPath = null) Assert that value is an URL.
* @method AssertionChain uuid($message = null, $propertyPath = null) Assert that the given string is a valid UUID.
* @method AssertionChain writeable($message = null, $propertyPath = null) Assert that the value is something writeable.
*/
class AssertionChain
{
private $value;
private $defaultMessage;
private $defaultPropertyPath;
/**
* Return each assertion as always valid.
*
* @var bool
*/
private $alwaysValid = false;
/**
* Perform assertion on every element of array or traversable.
*
* @var bool
*/
private $all = false;
public function __construct($value, $defaultMessage = null, $defaultPropertyPath = null)
{
$this->value = $value;
$this->defaultMessage = $defaultMessage;
$this->defaultPropertyPath = $defaultPropertyPath;
}
/**
* Call assertion on the current value in the chain.
*
* @param string $methodName
* @param array $args
*
* @return \Assert\AssertionChain
*/
public function __call($methodName, $args)
{
if ($this->alwaysValid === true) {
return $this;
}
if (!method_exists('Assert\Assertion', $methodName)) {
throw new \RuntimeException("Assertion '" . $methodName . "' does not exist.");
}
$reflClass = new ReflectionClass('Assert\Assertion');
$method = $reflClass->getMethod($methodName);
array_unshift($args, $this->value);
$params = $method->getParameters();
foreach ($params as $idx => $param) {
if (isset($args[$idx])) {
continue;
}
if ($param->getName() == 'message') {
$args[$idx] = $this->defaultMessage;
}
if ($param->getName() == 'propertyPath') {
$args[$idx] = $this->defaultPropertyPath;
}
}
if ($this->all) {
$methodName = 'all' . $methodName;
}
call_user_func_array(array('Assert\Assertion', $methodName), $args);
return $this;
}
/**
* Switch chain into validation mode for an array of values.
*
* @return \Assert\AssertionChain
*/
public function all()
{
$this->all = true;
return $this;
}
/**
* Switch chain into mode allowing nulls, ignoring further assertions.
*
* @return \Assert\AssertionChain
*/
public function nullOr()
{
if ($this->value === null) {
$this->alwaysValid = true;
}
return $this;
}
}