Failed Conditions
Pull Request — master (#37)
by Baptiste
18:03 queued 16:12
created

Assert::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 3
ccs 0
cts 2
cp 0
rs 10
c 0
b 0
f 0
cc 1
eloc 1
nc 1
nop 0
crap 2
1
<?php
2
3
/*
4
 * This file is part of the webmozart/assert package.
5
 *
6
 * (c) Bernhard Schussek <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Webmozart\Assert;
13
14
use BadMethodCallException;
15
use InvalidArgumentException;
16
use Traversable;
17
use Exception;
18
use Throwable;
19
use Closure;
20
21
/**
22
 * Efficient assertions to validate the input/output of your methods.
23
 *
24
 * @method static void nullOrString($value, $message = '')
25
 * @method static void nullOrStringNotEmpty($value, $message = '')
26
 * @method static void nullOrInteger($value, $message = '')
27
 * @method static void nullOrIntegerish($value, $message = '')
28
 * @method static void nullOrFloat($value, $message = '')
29
 * @method static void nullOrNumeric($value, $message = '')
30
 * @method static void nullOrBoolean($value, $message = '')
31
 * @method static void nullOrScalar($value, $message = '')
32
 * @method static void nullOrObject($value, $message = '')
33
 * @method static void nullOrResource($value, $type = null, $message = '')
34
 * @method static void nullOrIsCallable($value, $message = '')
35
 * @method static void nullOrIsArray($value, $message = '')
36
 * @method static void nullOrIsTraversable($value, $message = '')
37
 * @method static void nullOrIsInstanceOf($value, $class, $message = '')
38
 * @method static void nullOrNotInstanceOf($value, $class, $message = '')
39
 * @method static void nullOrIsEmpty($value, $message = '')
40
 * @method static void nullOrNotEmpty($value, $message = '')
41
 * @method static void nullOrTrue($value, $message = '')
42
 * @method static void nullOrFalse($value, $message = '')
43
 * @method static void nullOrEq($value, $value2, $message = '')
44
 * @method static void nullOrNotEq($value,$value2,  $message = '')
45
 * @method static void nullOrSame($value, $value2, $message = '')
46
 * @method static void nullOrNotSame($value, $value2, $message = '')
47
 * @method static void nullOrGreaterThan($value, $value2, $message = '')
48
 * @method static void nullOrGreaterThanEq($value, $value2, $message = '')
49
 * @method static void nullOrLessThan($value, $value2, $message = '')
50
 * @method static void nullOrLessThanEq($value, $value2, $message = '')
51
 * @method static void nullOrRange($value, $min, $max, $message = '')
52
 * @method static void nullOrOneOf($value, $values, $message = '')
53
 * @method static void nullOrContains($value, $subString, $message = '')
54
 * @method static void nullOrNotContains($value, $subString, $message = '')
55
 * @method static void nullOrStartsWith($value, $prefix, $message = '')
56
 * @method static void nullOrStartsWithLetter($value, $message = '')
57
 * @method static void nullOrEndsWith($value, $suffix, $message = '')
58
 * @method static void nullOrRegex($value, $pattern, $message = '')
59
 * @method static void nullOrAlpha($value, $message = '')
60
 * @method static void nullOrDigits($value, $message = '')
61
 * @method static void nullOrAlnum($value, $message = '')
62
 * @method static void nullOrLower($value, $message = '')
63
 * @method static void nullOrUpper($value, $message = '')
64
 * @method static void nullOrLength($value, $length, $message = '')
65
 * @method static void nullOrMinLength($value, $min, $message = '')
66
 * @method static void nullOrMaxLength($value, $max, $message = '')
67
 * @method static void nullOrLengthBetween($value, $min, $max, $message = '')
68
 * @method static void nullOrFileExists($value, $message = '')
69
 * @method static void nullOrFile($value, $message = '')
70
 * @method static void nullOrDirectory($value, $message = '')
71
 * @method static void nullOrReadable($value, $message = '')
72
 * @method static void nullOrWritable($value, $message = '')
73
 * @method static void nullOrClassExists($value, $message = '')
74
 * @method static void nullOrSubclassOf($value, $class, $message = '')
75
 * @method static void nullOrImplementsInterface($value, $interface, $message = '')
76
 * @method static void nullOrPropertyExists($value, $property, $message = '')
77
 * @method static void nullOrPropertyNotExists($value, $property, $message = '')
78
 * @method static void nullOrMethodExists($value, $method, $message = '')
79
 * @method static void nullOrMethodNotExists($value, $method, $message = '')
80
 * @method static void nullOrKeyExists($value, $key, $message = '')
81
 * @method static void nullOrKeyNotExists($value, $key, $message = '')
82
 * @method static void nullOrCount($value, $key, $message = '')
83
 * @method static void nullOrUuid($values, $message = '')
84
 * @method static void allString($values, $message = '')
85
 * @method static void allStringNotEmpty($values, $message = '')
86
 * @method static void allInteger($values, $message = '')
87
 * @method static void allIntegerish($values, $message = '')
88
 * @method static void allFloat($values, $message = '')
89
 * @method static void allNumeric($values, $message = '')
90
 * @method static void allBoolean($values, $message = '')
91
 * @method static void allScalar($values, $message = '')
92
 * @method static void allObject($values, $message = '')
93
 * @method static void allResource($values, $type = null, $message = '')
94
 * @method static void allIsCallable($values, $message = '')
95
 * @method static void allIsArray($values, $message = '')
96
 * @method static void allIsTraversable($values, $message = '')
97
 * @method static void allIsInstanceOf($values, $class, $message = '')
98
 * @method static void allNotInstanceOf($values, $class, $message = '')
99
 * @method static void allNull($values, $message = '')
100
 * @method static void allNotNull($values, $message = '')
101
 * @method static void allIsEmpty($values, $message = '')
102
 * @method static void allNotEmpty($values, $message = '')
103
 * @method static void allTrue($values, $message = '')
104
 * @method static void allFalse($values, $message = '')
105
 * @method static void allEq($values, $value2, $message = '')
106
 * @method static void allNotEq($values,$value2,  $message = '')
107
 * @method static void allSame($values, $value2, $message = '')
108
 * @method static void allNotSame($values, $value2, $message = '')
109
 * @method static void allGreaterThan($values, $value2, $message = '')
110
 * @method static void allGreaterThanEq($values, $value2, $message = '')
111
 * @method static void allLessThan($values, $value2, $message = '')
112
 * @method static void allLessThanEq($values, $value2, $message = '')
113
 * @method static void allRange($values, $min, $max, $message = '')
114
 * @method static void allOneOf($values, $values, $message = '')
115
 * @method static void allContains($values, $subString, $message = '')
116
 * @method static void allNotContains($values, $subString, $message = '')
117
 * @method static void allStartsWith($values, $prefix, $message = '')
118
 * @method static void allStartsWithLetter($values, $message = '')
119
 * @method static void allEndsWith($values, $suffix, $message = '')
120
 * @method static void allRegex($values, $pattern, $message = '')
121
 * @method static void allAlpha($values, $message = '')
122
 * @method static void allDigits($values, $message = '')
123
 * @method static void allAlnum($values, $message = '')
124
 * @method static void allLower($values, $message = '')
125
 * @method static void allUpper($values, $message = '')
126
 * @method static void allLength($values, $length, $message = '')
127
 * @method static void allMinLength($values, $min, $message = '')
128
 * @method static void allMaxLength($values, $max, $message = '')
129
 * @method static void allLengthBetween($values, $min, $max, $message = '')
130
 * @method static void allFileExists($values, $message = '')
131
 * @method static void allFile($values, $message = '')
132
 * @method static void allDirectory($values, $message = '')
133
 * @method static void allReadable($values, $message = '')
134
 * @method static void allWritable($values, $message = '')
135
 * @method static void allClassExists($values, $message = '')
136
 * @method static void allSubclassOf($values, $class, $message = '')
137
 * @method static void allImplementsInterface($values, $interface, $message = '')
138
 * @method static void allPropertyExists($values, $property, $message = '')
139
 * @method static void allPropertyNotExists($values, $property, $message = '')
140
 * @method static void allMethodExists($values, $method, $message = '')
141
 * @method static void allMethodNotExists($values, $method, $message = '')
142
 * @method static void allKeyExists($values, $key, $message = '')
143
 * @method static void allKeyNotExists($values, $key, $message = '')
144
 * @method static void allCount($values, $key, $message = '')
145
 * @method static void allUuid($values, $message = '')
146
 *
147
 * @since  1.0
148
 *
149
 * @author Bernhard Schussek <[email protected]>
150
 */
151
class Assert
0 ignored issues
show
Coding Style introduced by
Since you have declared the constructor as private, maybe you should also declare the class as final.
Loading history...
152
{
153 90
    public static function string($value, $message = '')
154
    {
155 90
        if (!is_string($value)) {
156 14
            static::reportInvalidArgument(sprintf(
157 14
                $message ?: 'Expected a string. Got: %s',
158 14
                static::typeToString($value)
159
            ));
160
        }
161 76
    }
162
163 12
    public static function stringNotEmpty($value, $message = '')
164
    {
165 12
        static::string($value, $message);
166 8
        static::notEmpty($value, $message);
167 4
    }
168
169 17 View Code Duplication
    public static function integer($value, $message = '')
170
    {
171 17
        if (!is_int($value)) {
172 13
            static::reportInvalidArgument(sprintf(
173 13
                $message ?: 'Expected an integer. Got: %s',
174 13
                static::typeToString($value)
175
            ));
176
        }
177 4
    }
178
179 16 View Code Duplication
    public static function integerish($value, $message = '')
180
    {
181 16
        if (!is_numeric($value) || $value != (int) $value) {
182 4
            static::reportInvalidArgument(sprintf(
183 4
                $message ?: 'Expected an integerish value. Got: %s',
184 4
                static::typeToString($value)
185
            ));
186
        }
187 12
    }
188
189 16 View Code Duplication
    public static function float($value, $message = '')
190
    {
191 16
        if (!is_float($value)) {
192 8
            static::reportInvalidArgument(sprintf(
193 8
                $message ?: 'Expected a float. Got: %s',
194 8
                static::typeToString($value)
195
            ));
196
        }
197 8
    }
198
199 20 View Code Duplication
    public static function numeric($value, $message = '')
200
    {
201 20
        if (!is_numeric($value)) {
202 4
            static::reportInvalidArgument(sprintf(
203 4
                $message ?: 'Expected a numeric. Got: %s',
204 4
                static::typeToString($value)
205
            ));
206
        }
207 16
    }
208
209 16 View Code Duplication
    public static function boolean($value, $message = '')
210
    {
211 16
        if (!is_bool($value)) {
212 8
            static::reportInvalidArgument(sprintf(
213 8
                $message ?: 'Expected a boolean. Got: %s',
214 8
                static::typeToString($value)
215
            ));
216
        }
217 8
    }
218
219 23 View Code Duplication
    public static function scalar($value, $message = '')
220
    {
221 23
        if (!is_scalar($value)) {
222 11
            static::reportInvalidArgument(sprintf(
223 11
                $message ?: 'Expected a scalar. Got: %s',
224 11
                static::typeToString($value)
225
            ));
226
        }
227 12
    }
228
229 23 View Code Duplication
    public static function object($value, $message = '')
230
    {
231 23
        if (!is_object($value)) {
232 15
            static::reportInvalidArgument(sprintf(
233 15
                $message ?: 'Expected an object. Got: %s',
234 15
                static::typeToString($value)
235
            ));
236
        }
237 8
    }
238
239 16
    public static function resource($value, $type = null, $message = '')
240
    {
241 16
        if (!is_resource($value)) {
242 4
            static::reportInvalidArgument(sprintf(
243 4
                $message ?: 'Expected a resource. Got: %s',
244 4
                static::typeToString($value)
245
            ));
246
        }
247
248 12
        if ($type && $type !== get_resource_type($value)) {
249 4
            static::reportInvalidArgument(sprintf(
250 4
                $message ?: 'Expected a resource of type %2$s. Got: %s',
251 4
                static::typeToString($value),
252
                $type
253
            ));
254
        }
255 8
    }
256
257 20 View Code Duplication
    public static function isCallable($value, $message = '')
258
    {
259 20
        if (!is_callable($value)) {
260 8
            static::reportInvalidArgument(sprintf(
261 8
                $message ?: 'Expected a callable. Got: %s',
262 8
                static::typeToString($value)
263
            ));
264
        }
265 12
    }
266
267 20 View Code Duplication
    public static function isArray($value, $message = '')
268
    {
269 20
        if (!is_array($value)) {
270 12
            static::reportInvalidArgument(sprintf(
271 12
                $message ?: 'Expected an array. Got: %s',
272 12
                static::typeToString($value)
273
            ));
274
        }
275 8
    }
276
277 516
    public static function isTraversable($value, $message = '')
278
    {
279 516
        if (!is_array($value) && !($value instanceof Traversable)) {
280 8
            static::reportInvalidArgument(sprintf(
281 8
                $message ?: 'Expected a traversable. Got: %s',
282 8
                static::typeToString($value)
283
            ));
284
        }
285 512
    }
286
287 16 View Code Duplication
    public static function isInstanceOf($value, $class, $message = '')
288
    {
289 16
        if (!($value instanceof $class)) {
290 12
            static::reportInvalidArgument(sprintf(
291 12
                $message ?: 'Expected an instance of %2$s. Got: %s',
292 12
                static::typeToString($value),
293
                $class
294
            ));
295
        }
296 4
    }
297
298 16 View Code Duplication
    public static function notInstanceOf($value, $class, $message = '')
299
    {
300 16
        if ($value instanceof $class) {
301 4
            static::reportInvalidArgument(sprintf(
302 4
                $message ?: 'Expected an instance other than %2$s. Got: %s',
303 4
                static::typeToString($value),
304
                $class
305
            ));
306
        }
307 12
    }
308
309 23
    public static function isEmpty($value, $message = '')
310
    {
311 23
        if (!empty($value)) {
312 8
            static::reportInvalidArgument(sprintf(
313 8
                $message ?: 'Expected an empty value. Got: %s',
314 8
                static::valueToString($value)
315
            ));
316
        }
317 15
    }
318
319 31
    public static function notEmpty($value, $message = '')
320
    {
321 31
        if (empty($value)) {
322 19
            static::reportInvalidArgument(sprintf(
323 19
                $message ?: 'Expected a non-empty value. Got: %s',
324 19
                static::valueToString($value)
325
            ));
326
        }
327 12
    }
328
329 11
    public static function null($value, $message = '')
330
    {
331 11
        if (null !== $value) {
332 8
            static::reportInvalidArgument(sprintf(
333 8
                $message ?: 'Expected null. Got: %s',
334 8
                static::valueToString($value)
335
            ));
336
        }
337 3
    }
338
339 11
    public static function notNull($value, $message = '')
340
    {
341 11
        if (null === $value) {
342 3
            static::reportInvalidArgument(
343 3
                $message ?: 'Expected a value other than null.'
344
            );
345
        }
346 8
    }
347
348 15
    public static function true($value, $message = '')
349
    {
350 15
        if (true !== $value) {
351 11
            static::reportInvalidArgument(sprintf(
352 11
                $message ?: 'Expected a value to be true. Got: %s',
353 11
                static::valueToString($value)
354
            ));
355
        }
356 4
    }
357
358 19
    public static function false($value, $message = '')
359
    {
360 19
        if (false !== $value) {
361 15
            static::reportInvalidArgument(sprintf(
362 15
                $message ?: 'Expected a value to be false. Got: %s',
363 15
                static::valueToString($value)
364
            ));
365
        }
366 4
    }
367
368 32
    public static function eq($value, $value2, $message = '')
369
    {
370 32
        if ($value2 != $value) {
371 16
            static::reportInvalidArgument(sprintf(
372 16
                $message ?: 'Expected a value equal to %2$s. Got: %s',
373 16
                static::valueToString($value),
374 16
                static::valueToString($value2)
375
            ));
376
        }
377 16
    }
378
379 16
    public static function notEq($value, $value2, $message = '')
380
    {
381 16
        if ($value2 == $value) {
382 12
            static::reportInvalidArgument(sprintf(
383 12
                $message ?: 'Expected a different value than %s.',
384 12
                static::valueToString($value2)
385
            ));
386
        }
387 4
    }
388
389 16
    public static function same($value, $value2, $message = '')
390
    {
391 16
        if ($value2 !== $value) {
392 12
            static::reportInvalidArgument(sprintf(
393 12
                $message ?: 'Expected a value identical to %2$s. Got: %s',
394 12
                static::valueToString($value),
395 12
                static::valueToString($value2)
396
            ));
397
        }
398 4
    }
399
400 16
    public static function notSame($value, $value2, $message = '')
401
    {
402 16
        if ($value2 === $value) {
403 4
            static::reportInvalidArgument(sprintf(
404 4
                $message ?: 'Expected a value not identical to %s.',
405 4
                static::valueToString($value2)
406
            ));
407
        }
408 12
    }
409
410 8
    public static function greaterThan($value, $limit, $message = '')
411
    {
412 8
        if ($value <= $limit) {
413 4
            static::reportInvalidArgument(sprintf(
414 4
                $message ?: 'Expected a value greater than %2$s. Got: %s',
415 4
                static::valueToString($value),
416 4
                static::valueToString($limit)
417
            ));
418
        }
419 4
    }
420
421 12
    public static function greaterThanEq($value, $limit, $message = '')
422
    {
423 12
        if ($value < $limit) {
424 4
            static::reportInvalidArgument(sprintf(
425 4
                $message ?: 'Expected a value greater than or equal to %2$s. Got: %s',
426 4
                static::valueToString($value),
427 4
                static::valueToString($limit)
428
            ));
429
        }
430 8
    }
431
432 8
    public static function lessThan($value, $limit, $message = '')
433
    {
434 8
        if ($value >= $limit) {
435 4
            static::reportInvalidArgument(sprintf(
436 4
                $message ?: 'Expected a value less than %2$s. Got: %s',
437 4
                static::valueToString($value),
438 4
                static::valueToString($limit)
439
            ));
440
        }
441 4
    }
442
443 12
    public static function lessThanEq($value, $limit, $message = '')
444
    {
445 12
        if ($value > $limit) {
446 4
            static::reportInvalidArgument(sprintf(
447 4
                $message ?: 'Expected a value less than or equal to %2$s. Got: %s',
448 4
                static::valueToString($value),
449 4
                static::valueToString($limit)
450
            ));
451
        }
452 8
    }
453
454 16 View Code Duplication
    public static function range($value, $min, $max, $message = '')
455
    {
456 16
        if ($value < $min || $value > $max) {
457 8
            static::reportInvalidArgument(sprintf(
458 8
                $message ?: 'Expected a value between %2$s and %3$s. Got: %s',
459 8
                static::valueToString($value),
460 8
                static::valueToString($min),
461 8
                static::valueToString($max)
462
            ));
463
        }
464 8
    }
465
466 8
    public static function oneOf($value, array $values, $message = '')
467
    {
468 8
        if (!in_array($value, $values, true)) {
469 4
            static::reportInvalidArgument(sprintf(
470 4
                $message ?: 'Expected one of: %2$s. Got: %s',
471 4
                static::valueToString($value),
472 4
                implode(', ', array_map(array('static', 'valueToString'), $values))
473
            ));
474
        }
475 4
    }
476
477 20 View Code Duplication
    public static function contains($value, $subString, $message = '')
478
    {
479 20
        if (false === strpos($value, $subString)) {
480 8
            static::reportInvalidArgument(sprintf(
481 8
                $message ?: 'Expected a value to contain %2$s. Got: %s',
482 8
                static::valueToString($value),
483 8
                static::valueToString($subString)
484
            ));
485
        }
486 12
    }
487
488 20 View Code Duplication
    public static function notContains($value, $subString, $message = '')
489
    {
490 20
        if (false !== strpos($value, $subString)) {
491 12
            static::reportInvalidArgument(sprintf(
492 12
                $message ?: '%2$s was not expected to be contained in a value. Got: %s',
493 12
                static::valueToString($value),
494 12
                static::valueToString($subString)
495
            ));
496
        }
497 8
    }
498
499 12 View Code Duplication
    public static function startsWith($value, $prefix, $message = '')
500
    {
501 12
        if (0 !== strpos($value, $prefix)) {
502 8
            static::reportInvalidArgument(sprintf(
503 8
                $message ?: 'Expected a value to start with %2$s. Got: %s',
504 8
                static::valueToString($value),
505 8
                static::valueToString($prefix)
506
            ));
507
        }
508 4
    }
509
510 12
    public static function startsWithLetter($value, $message = '')
511
    {
512 12
        $valid = isset($value[0]);
513
514 12
        if ($valid) {
515 8
            $locale = setlocale(LC_CTYPE, 0);
516 8
            setlocale(LC_CTYPE, 'C');
517 8
            $valid = ctype_alpha($value[0]);
518 8
            setlocale(LC_CTYPE, $locale);
519
        }
520
521 12
        if (!$valid) {
522 8
            static::reportInvalidArgument(sprintf(
523 8
                $message ?: 'Expected a value to start with a letter. Got: %s',
524 8
                static::valueToString($value)
525
            ));
526
        }
527 4
    }
528
529 12 View Code Duplication
    public static function endsWith($value, $suffix, $message = '')
530
    {
531 12
        if ($suffix !== substr($value, -static::strlen($suffix))) {
532 8
            static::reportInvalidArgument(sprintf(
533 8
                $message ?: 'Expected a value to end with %2$s. Got: %s',
534 8
                static::valueToString($value),
535 8
                static::valueToString($suffix)
536
            ));
537
        }
538 4
    }
539
540 12
    public static function regex($value, $pattern, $message = '')
541
    {
542 12
        if (!preg_match($pattern, $value)) {
543 8
            static::reportInvalidArgument(sprintf(
544 8
                $message ?: 'The value %s does not match the expected pattern.',
545 8
                static::valueToString($value)
546
            ));
547
        }
548 4
    }
549
550 12 View Code Duplication
    public static function alpha($value, $message = '')
551
    {
552 12
        $locale = setlocale(LC_CTYPE, 0);
553 12
        setlocale(LC_CTYPE, 'C');
554 12
        $valid = !ctype_alpha($value);
555 12
        setlocale(LC_CTYPE, $locale);
556
557 12
        if ($valid) {
558 8
            static::reportInvalidArgument(sprintf(
559 8
                $message ?: 'Expected a value to contain only letters. Got: %s',
560 8
                static::valueToString($value)
561
            ));
562
        }
563 4
    }
564
565 12 View Code Duplication
    public static function digits($value, $message = '')
566
    {
567 12
        $locale = setlocale(LC_CTYPE, 0);
568 12
        setlocale(LC_CTYPE, 'C');
569 12
        $valid = !ctype_digit($value);
570 12
        setlocale(LC_CTYPE, $locale);
571
572 12
        if ($valid) {
573 8
            static::reportInvalidArgument(sprintf(
574 8
                $message ?: 'Expected a value to contain digits only. Got: %s',
575 8
                static::valueToString($value)
576
            ));
577
        }
578 4
    }
579
580 12 View Code Duplication
    public static function alnum($value, $message = '')
581
    {
582 12
        $locale = setlocale(LC_CTYPE, 0);
583 12
        setlocale(LC_CTYPE, 'C');
584 12
        $valid = !ctype_alnum($value);
585 12
        setlocale(LC_CTYPE, $locale);
586
587 12
        if ($valid) {
588 8
            static::reportInvalidArgument(sprintf(
589 8
                $message ?: 'Expected a value to contain letters and digits only. Got: %s',
590 8
                static::valueToString($value)
591
            ));
592
        }
593 4
    }
594
595 16 View Code Duplication
    public static function lower($value, $message = '')
596
    {
597 16
        $locale = setlocale(LC_CTYPE, 0);
598 16
        setlocale(LC_CTYPE, 'C');
599 16
        $valid = !ctype_lower($value);
600 16
        setlocale(LC_CTYPE, $locale);
601
602 16
        if ($valid) {
603 12
            static::reportInvalidArgument(sprintf(
604 12
                $message ?: 'Expected a value to contain lowercase characters only. Got: %s',
605 12
                static::valueToString($value)
606
            ));
607
        }
608 4
    }
609
610 16 View Code Duplication
    public static function upper($value, $message = '')
611
    {
612 16
        $locale = setlocale(LC_CTYPE, 0);
613 16
        setlocale(LC_CTYPE, 'C');
614 16
        $valid = !ctype_upper($value);
615 16
        setlocale(LC_CTYPE, $locale);
616
617 16
        if ($valid) {
618 12
            static::reportInvalidArgument(sprintf(
619 12
                $message ?: 'Expected a value to contain uppercase characters only. Got: %s',
620 12
                static::valueToString($value)
621
            ));
622
        }
623 4
    }
624
625 24
    public static function length($value, $length, $message = '')
626
    {
627 24
        if ($length !== static::strlen($value)) {
628 16
            static::reportInvalidArgument(sprintf(
629 16
                $message ?: 'Expected a value to contain %2$s characters. Got: %s',
630 16
                static::valueToString($value),
631
                $length
632
            ));
633
        }
634 8
    }
635
636 24
    public static function minLength($value, $min, $message = '')
637
    {
638 24
        if (static::strlen($value) < $min) {
639 8
            static::reportInvalidArgument(sprintf(
640 8
                $message ?: 'Expected a value to contain at least %2$s characters. Got: %s',
641 8
                static::valueToString($value),
642
                $min
643
            ));
644
        }
645 16
    }
646
647 24
    public static function maxLength($value, $max, $message = '')
648
    {
649 24
        if (static::strlen($value) > $max) {
650 8
            static::reportInvalidArgument(sprintf(
651 8
                $message ?: 'Expected a value to contain at most %2$s characters. Got: %s',
652 8
                static::valueToString($value),
653
                $max
654
            ));
655
        }
656 16
    }
657
658 40 View Code Duplication
    public static function lengthBetween($value, $min, $max, $message = '')
659
    {
660 40
        $length = static::strlen($value);
661
662 40
        if ($length < $min || $length > $max) {
663 16
            static::reportInvalidArgument(sprintf(
664 16
                $message ?: 'Expected a value to contain between %2$s and %3$s characters. Got: %s',
665 16
                static::valueToString($value),
666
                $min,
667
                $max
668
            ));
669
        }
670 24
    }
671
672 36
    public static function fileExists($value, $message = '')
673
    {
674 36
        static::string($value);
675
676 36
        if (!file_exists($value)) {
677 12
            static::reportInvalidArgument(sprintf(
678 12
                $message ?: 'The file %s does not exist.',
679 12
                static::valueToString($value)
680
            ));
681
        }
682 24
    }
683
684 12 View Code Duplication
    public static function file($value, $message = '')
685
    {
686 12
        static::fileExists($value, $message);
687
688 8
        if (!is_file($value)) {
689 4
            static::reportInvalidArgument(sprintf(
690 4
                $message ?: 'The path %s is not a file.',
691 4
                static::valueToString($value)
692
            ));
693
        }
694 4
    }
695
696 12 View Code Duplication
    public static function directory($value, $message = '')
697
    {
698 12
        static::fileExists($value, $message);
699
700 8
        if (!is_dir($value)) {
701 4
            static::reportInvalidArgument(sprintf(
702 4
                $message ?: 'The path %s is no directory.',
703 4
                static::valueToString($value)
704
            ));
705
        }
706 4
    }
707
708
    public static function readable($value, $message = '')
709
    {
710
        if (!is_readable($value)) {
711
            static::reportInvalidArgument(sprintf(
712
                $message ?: 'The path %s is not readable.',
713
                static::valueToString($value)
714
            ));
715
        }
716
    }
717
718
    public static function writable($value, $message = '')
719
    {
720
        if (!is_writable($value)) {
721
            static::reportInvalidArgument(sprintf(
722
                $message ?: 'The path %s is not writable.',
723
                static::valueToString($value)
724
            ));
725
        }
726
    }
727
728 8
    public static function classExists($value, $message = '')
729
    {
730 8
        if (!class_exists($value)) {
731 4
            static::reportInvalidArgument(sprintf(
732 4
                $message ?: 'Expected an existing class name. Got: %s',
733 4
                static::valueToString($value)
734
            ));
735
        }
736 4
    }
737
738 8
    public static function subclassOf($value, $class, $message = '')
739
    {
740 8
        if (!is_subclass_of($value, $class)) {
741 4
            static::reportInvalidArgument(sprintf(
742 4
                $message ?: 'Expected a sub-class of %2$s. Got: %s',
743 4
                static::valueToString($value),
744 4
                static::valueToString($class)
745
            ));
746
        }
747 4
    }
748
749 8 View Code Duplication
    public static function implementsInterface($value, $interface, $message = '')
750
    {
751 8
        if (!in_array($interface, class_implements($value))) {
752 4
            static::reportInvalidArgument(sprintf(
753 4
                $message ?: 'Expected an implementation of %2$s. Got: %s',
754 4
                static::valueToString($value),
755 4
                static::valueToString($interface)
756
            ));
757
        }
758 4
    }
759
760 12 View Code Duplication
    public static function propertyExists($classOrObject, $property, $message = '')
761
    {
762 12
        if (!property_exists($classOrObject, $property)) {
763 4
            static::reportInvalidArgument(sprintf(
764 4
                $message ?: 'Expected the property %s to exist.',
765 4
                static::valueToString($property)
766
            ));
767
        }
768 8
    }
769
770 12 View Code Duplication
    public static function propertyNotExists($classOrObject, $property, $message = '')
771
    {
772 12
        if (property_exists($classOrObject, $property)) {
773 8
            static::reportInvalidArgument(sprintf(
774 8
                $message ?: 'Expected the property %s to not exist.',
775 8
                static::valueToString($property)
776
            ));
777
        }
778 4
    }
779
780 27 View Code Duplication
    public static function methodExists($classOrObject, $method, $message = '')
781
    {
782 27
        if (!method_exists($classOrObject, $method)) {
783 19
            static::reportInvalidArgument(sprintf(
784 19
                $message ?: 'Expected the method %s to exist.',
785 19
                static::valueToString($method)
786
            ));
787
        }
788 8
    }
789
790 27 View Code Duplication
    public static function methodNotExists($classOrObject, $method, $message = '')
791
    {
792 27
        if (method_exists($classOrObject, $method)) {
793 8
            static::reportInvalidArgument(sprintf(
794 8
                $message ?: 'Expected the method %s to not exist.',
795 8
                static::valueToString($method)
796
            ));
797
        }
798 19
    }
799
800 12 View Code Duplication
    public static function keyExists($array, $key, $message = '')
801
    {
802 12
        if (!array_key_exists($key, $array)) {
803 4
            static::reportInvalidArgument(sprintf(
804 4
                $message ?: 'Expected the key %s to exist.',
805 4
                static::valueToString($key)
806
            ));
807
        }
808 8
    }
809
810 12 View Code Duplication
    public static function keyNotExists($array, $key, $message = '')
811
    {
812 12
        if (array_key_exists($key, $array)) {
813 8
            static::reportInvalidArgument(sprintf(
814 8
                $message ?: 'Expected the key %s to not exist.',
815 8
                static::valueToString($key)
816
            ));
817
        }
818 4
    }
819
820 8
    public static function count($array, $number, $message = '')
821
    {
822 8
        static::eq(
823
            count($array),
824
            $number,
825 8
            $message ?: sprintf('Expected an array to contain %d elements. Got: %d.', $number, count($array))
826
        );
827 4
    }
828
829 48
    public static function uuid($value, $message = '')
830
    {
831 48
        $value = str_replace(array('urn:', 'uuid:', '{', '}'), '', $value);
832
833
        // The nil UUID is special form of UUID that is specified to have all
834
        // 128 bits set to zero.
835 48
        if ('00000000-0000-0000-0000-000000000000' === $value) {
836 4
            return;
837
        }
838
839 44
        if (!preg_match('/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/', $value)) {
840 20
            static::reportInvalidArgument(sprintf(
841 20
                $message ?: 'Value %s is not a valid UUID.',
842 20
                static::valueToString($value)
843
            ));
844
        }
845 24
    }
846
847 24
    public static function throws(Closure $expression, $class = 'Exception', $message = '')
848
    {
849 24
        static::string($class);
850
851 24
        $actual = 'none';
852
        try {
853 24
            $expression();
854 24
        } catch (Exception $e) {
855 20
            $actual = get_class($e);
856 20
            if ($e instanceof $class) {
857 20
                return;
858
            }
859 4
        } catch (Throwable $e) {
0 ignored issues
show
Bug introduced by
The class Throwable does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json?
Loading history...
860 4
            $actual = get_class($e);
861 4
            if ($e instanceof $class) {
862 4
                return;
863
            }
864
        }
865
866 8
        static::reportInvalidArgument($message ?: sprintf(
867 8
            'Expected to throw "%s", got "%s"',
868
            $class,
869
            $actual
870
        ));
871
    }
872
873 820
    public static function __callStatic($name, $arguments)
874
    {
875 820
        if ('nullOr' === substr($name, 0, 6)) {
876 314
            if (null !== $arguments[0]) {
877 243
                $method = lcfirst(substr($name, 6));
878 243
                call_user_func_array(array('static', $method), $arguments);
879
            }
880
881 192
            return;
882
        }
883
884 506
        if ('all' === substr($name, 0, 3)) {
885 506
            static::isTraversable($arguments[0]);
886
887 506
            $method = lcfirst(substr($name, 3));
888 506
            $args = $arguments;
889
890 506
            foreach ($arguments[0] as $entry) {
891 506
                $args[0] = $entry;
892
893 506
                call_user_func_array(array('static', $method), $args);
894
            }
895
896 248
            return;
897
        }
898
899
        throw new BadMethodCallException('No such method: '.$name);
900
    }
901
902 384
    protected static function valueToString($value)
903
    {
904 384
        if (null === $value) {
905 11
            return 'null';
906
        }
907
908 375
        if (true === $value) {
909 15
            return 'true';
910
        }
911
912 365
        if (false === $value) {
913 13
            return 'false';
914
        }
915
916 352
        if (is_array($value)) {
917 1
            return 'array';
918
        }
919
920 351
        if (is_object($value)) {
921 1
            return get_class($value);
922
        }
923
924 350
        if (is_resource($value)) {
925 1
            return 'resource';
926
        }
927
928 350
        if (is_string($value)) {
929 276
            return '"'.$value.'"';
930
        }
931
932 82
        return (string) $value;
933
    }
934
935 129
    protected static function typeToString($value)
936
    {
937 129
        return is_object($value) ? get_class($value) : gettype($value);
938
    }
939
940 124
    protected static function strlen($value)
941
    {
942 124
        if (!function_exists('mb_detect_encoding')) {
943
            return strlen($value);
944
        }
945
946 124
        if (false === $encoding = mb_detect_encoding($value)) {
947
            return strlen($value);
948
        }
949
950 124
        return mb_strwidth($value, $encoding);
951
    }
952
953 524
    protected static function reportInvalidArgument($message)
954
    {
955 524
        throw new InvalidArgumentException($message);
956
    }
957
958
    private function __construct()
959
    {
960
    }
961
}
962