webmozart /
assert
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Assert often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Assert, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 209 | class Assert |
||
|
Coding Style
introduced
by
|
|||
| 210 | { |
||
| 211 | /** |
||
| 212 | * @psalm-assert string $value |
||
| 213 | * |
||
| 214 | * @param mixed $value |
||
| 215 | * @param string $message |
||
| 216 | * |
||
| 217 | * @throws InvalidArgumentException |
||
| 218 | */ |
||
| 219 | 241 | public static function string($value, $message = '') |
|
| 220 | { |
||
| 221 | 241 | if (!\is_string($value)) { |
|
| 222 | 45 | static::reportInvalidArgument(\sprintf( |
|
| 223 | 45 | $message ?: 'Expected a string. Got: %s', |
|
| 224 | 45 | static::typeToString($value) |
|
| 225 | )); |
||
| 226 | } |
||
| 227 | 196 | } |
|
| 228 | |||
| 229 | /** |
||
| 230 | * @param mixed $value |
||
| 231 | * @param string $message |
||
| 232 | * |
||
| 233 | * @throws InvalidArgumentException |
||
| 234 | */ |
||
| 235 | 16 | public static function stringNotEmpty($value, $message = '') |
|
| 236 | { |
||
| 237 | 16 | static::string($value, $message); |
|
| 238 | 12 | static::notEq($value, '', $message); |
|
| 239 | 8 | } |
|
| 240 | |||
| 241 | /** |
||
| 242 | * @psalm-assert int $value |
||
| 243 | * |
||
| 244 | * @param mixed $value |
||
| 245 | * @param string $message |
||
| 246 | * |
||
| 247 | * @throws InvalidArgumentException |
||
| 248 | */ |
||
| 249 | 17 | public static function integer($value, $message = '') |
|
| 250 | { |
||
| 251 | 17 | if (!\is_int($value)) { |
|
| 252 | 13 | static::reportInvalidArgument(\sprintf( |
|
| 253 | 13 | $message ?: 'Expected an integer. Got: %s', |
|
| 254 | 13 | static::typeToString($value) |
|
| 255 | )); |
||
| 256 | } |
||
| 257 | 4 | } |
|
| 258 | |||
| 259 | /** |
||
| 260 | * @psalm-assert numeric $value |
||
| 261 | * |
||
| 262 | * @param mixed $value |
||
| 263 | * @param string $message |
||
| 264 | * |
||
| 265 | * @throws InvalidArgumentException |
||
| 266 | */ |
||
| 267 | 16 | public static function integerish($value, $message = '') |
|
| 268 | { |
||
| 269 | 16 | if (!\is_numeric($value) || $value != (int) $value) { |
|
| 270 | 4 | static::reportInvalidArgument(\sprintf( |
|
| 271 | 4 | $message ?: 'Expected an integerish value. Got: %s', |
|
| 272 | 4 | static::typeToString($value) |
|
| 273 | )); |
||
| 274 | } |
||
| 275 | 12 | } |
|
| 276 | |||
| 277 | /** |
||
| 278 | * @psalm-assert float $value |
||
| 279 | * |
||
| 280 | * @param mixed $value |
||
| 281 | * @param string $message |
||
| 282 | * |
||
| 283 | * @throws InvalidArgumentException |
||
| 284 | */ |
||
| 285 | 16 | public static function float($value, $message = '') |
|
| 294 | |||
| 295 | /** |
||
| 296 | * @psalm-assert numeric $value |
||
| 297 | * |
||
| 298 | * @param mixed $value |
||
| 299 | * @param string $message |
||
| 300 | * |
||
| 301 | * @throws InvalidArgumentException |
||
| 302 | */ |
||
| 303 | 20 | public static function numeric($value, $message = '') |
|
| 312 | |||
| 313 | /** |
||
| 314 | * @psalm-assert int $value |
||
| 315 | * |
||
| 316 | * @param mixed $value |
||
| 317 | * @param string $message |
||
| 318 | * |
||
| 319 | * @throws InvalidArgumentException |
||
| 320 | */ |
||
| 321 | 24 | public static function natural($value, $message = '') |
|
| 330 | |||
| 331 | /** |
||
| 332 | * @psalm-assert bool $value |
||
| 333 | * |
||
| 334 | * @param mixed $value |
||
| 335 | * @param string $message |
||
| 336 | * |
||
| 337 | * @throws InvalidArgumentException |
||
| 338 | */ |
||
| 339 | 16 | public static function boolean($value, $message = '') |
|
| 348 | |||
| 349 | /** |
||
| 350 | * @psalm-assert scalar $value |
||
| 351 | * |
||
| 352 | * @param mixed $value |
||
| 353 | * @param string $message |
||
| 354 | * |
||
| 355 | * @throws InvalidArgumentException |
||
| 356 | */ |
||
| 357 | 23 | public static function scalar($value, $message = '') |
|
| 366 | |||
| 367 | /** |
||
| 368 | * @psalm-assert object $value |
||
| 369 | * |
||
| 370 | * @param mixed $value |
||
| 371 | * @param string $message |
||
| 372 | * |
||
| 373 | * @throws InvalidArgumentException |
||
| 374 | */ |
||
| 375 | 23 | public static function object($value, $message = '') |
|
| 384 | |||
| 385 | /** |
||
| 386 | * @psalm-assert resource $value |
||
| 387 | * |
||
| 388 | * @param mixed $value |
||
| 389 | * @param string|null $type type of resource this should be. @see https://www.php.net/manual/en/function.get-resource-type.php |
||
| 390 | * @param string $message |
||
| 391 | * |
||
| 392 | * @throws InvalidArgumentException |
||
| 393 | */ |
||
| 394 | 16 | public static function resource($value, $type = null, $message = '') |
|
| 411 | |||
| 412 | /** |
||
| 413 | * @psalm-assert callable $value |
||
| 414 | * |
||
| 415 | * @param mixed $value |
||
| 416 | * @param string $message |
||
| 417 | * |
||
| 418 | * @throws InvalidArgumentException |
||
| 419 | */ |
||
| 420 | 20 | public static function isCallable($value, $message = '') |
|
| 429 | |||
| 430 | /** |
||
| 431 | * @psalm-assert array $value |
||
| 432 | * |
||
| 433 | * @param mixed $value |
||
| 434 | * @param string $message |
||
| 435 | * |
||
| 436 | * @throws InvalidArgumentException |
||
| 437 | */ |
||
| 438 | 20 | public static function isArray($value, $message = '') |
|
| 447 | |||
| 448 | /** |
||
| 449 | * @psalm-assert iterable $value |
||
| 450 | * |
||
| 451 | * @deprecated use "isIterable" or "isInstanceOf" instead |
||
| 452 | * |
||
| 453 | * @param mixed $value |
||
| 454 | * @param string $message |
||
| 455 | * |
||
| 456 | * @throws InvalidArgumentException |
||
| 457 | */ |
||
| 458 | 20 | public static function isTraversable($value, $message = '') |
|
| 475 | |||
| 476 | /** |
||
| 477 | * @param mixed $value |
||
| 478 | * @param string $message |
||
| 479 | * |
||
| 480 | * @throws InvalidArgumentException |
||
| 481 | */ |
||
| 482 | 20 | View Code Duplication | public static function isArrayAccessible($value, $message = '') |
| 491 | |||
| 492 | /** |
||
| 493 | * @psalm-assert countable $value |
||
| 494 | * |
||
| 495 | * @param mixed $value |
||
| 496 | * @param string $message |
||
| 497 | * |
||
| 498 | * @throws InvalidArgumentException |
||
| 499 | */ |
||
| 500 | 28 | public static function isCountable($value, $message = '') |
|
| 514 | |||
| 515 | /** |
||
| 516 | * @psalm-assert iterable $value |
||
| 517 | * |
||
| 518 | * @param mixed $value |
||
| 519 | * @param string $message |
||
| 520 | * |
||
| 521 | * @throws InvalidArgumentException |
||
| 522 | */ |
||
| 523 | 992 | View Code Duplication | public static function isIterable($value, $message = '') |
| 532 | |||
| 533 | /** |
||
| 534 | * @psalm-template ExpectedType of object |
||
| 535 | * @psalm-param class-string<ExpectedType> $class |
||
| 536 | * @psalm-assert ExpectedType $value |
||
| 537 | * |
||
| 538 | * @param mixed $value |
||
| 539 | * @param string|object $class |
||
| 540 | * @param string $message |
||
| 541 | * |
||
| 542 | * @throws InvalidArgumentException |
||
| 543 | */ |
||
| 544 | 19 | public static function isInstanceOf($value, $class, $message = '') |
|
| 554 | |||
| 555 | /** |
||
| 556 | * @psalm-template ExpectedType of object |
||
| 557 | * @psalm-param class-string<ExpectedType> $class |
||
| 558 | * @psalm-assert !ExpectedType $value |
||
| 559 | * |
||
| 560 | * @param mixed $value |
||
| 561 | * @param string|object $class |
||
| 562 | * @param string $message |
||
| 563 | * |
||
| 564 | * @throws InvalidArgumentException |
||
| 565 | */ |
||
| 566 | 16 | public static function notInstanceOf($value, $class, $message = '') |
|
| 576 | |||
| 577 | /** |
||
| 578 | * @param mixed $value |
||
| 579 | * @param array<object|string> $classes |
||
| 580 | * @param string $message |
||
| 581 | * |
||
| 582 | * @throws InvalidArgumentException |
||
| 583 | */ |
||
| 584 | 20 | public static function isInstanceOfAny($value, array $classes, $message = '') |
|
| 598 | |||
| 599 | /** |
||
| 600 | * @param object|string $value |
||
| 601 | * @param string $class |
||
| 602 | * @param string $message |
||
| 603 | * |
||
| 604 | * @throws InvalidArgumentException |
||
| 605 | */ |
||
| 606 | 20 | View Code Duplication | public static function isAOf($value, $class, $message = '') |
| 618 | |||
| 619 | /** |
||
| 620 | * @param object|string $value |
||
| 621 | * @param string $class |
||
| 622 | * @param string $message |
||
| 623 | * |
||
| 624 | * @throws InvalidArgumentException |
||
| 625 | */ |
||
| 626 | 20 | View Code Duplication | public static function isNotA($value, $class, $message = '') |
| 638 | |||
| 639 | /** |
||
| 640 | * @param object|string $value |
||
| 641 | * @param string[] $classes |
||
| 642 | * @param string $message |
||
| 643 | * |
||
| 644 | * @throws InvalidArgumentException |
||
| 645 | */ |
||
| 646 | 24 | public static function isAnyOf($value, array $classes, $message = '') |
|
| 662 | |||
| 663 | /** |
||
| 664 | * @psalm-assert empty $value |
||
| 665 | * |
||
| 666 | * @param mixed $value |
||
| 667 | * @param string $message |
||
| 668 | * |
||
| 669 | * @throws InvalidArgumentException |
||
| 670 | */ |
||
| 671 | 23 | public static function isEmpty($value, $message = '') |
|
| 680 | |||
| 681 | /** |
||
| 682 | * @psalm-assert !empty $value |
||
| 683 | * |
||
| 684 | * @param mixed $value |
||
| 685 | * @param string $message |
||
| 686 | * |
||
| 687 | * @throws InvalidArgumentException |
||
| 688 | */ |
||
| 689 | 55 | public static function notEmpty($value, $message = '') |
|
| 698 | |||
| 699 | /** |
||
| 700 | * @psalm-assert null $value |
||
| 701 | * |
||
| 702 | * @param mixed $value |
||
| 703 | * @param string $message |
||
| 704 | * |
||
| 705 | * @throws InvalidArgumentException |
||
| 706 | */ |
||
| 707 | 11 | public static function null($value, $message = '') |
|
| 716 | |||
| 717 | /** |
||
| 718 | * @psalm-assert !null $value |
||
| 719 | * |
||
| 720 | * @param mixed $value |
||
| 721 | * @param string $message |
||
| 722 | * |
||
| 723 | * @throws InvalidArgumentException |
||
| 724 | */ |
||
| 725 | 11 | public static function notNull($value, $message = '') |
|
| 733 | |||
| 734 | /** |
||
| 735 | * @psalm-assert true $value |
||
| 736 | * |
||
| 737 | * @param mixed $value |
||
| 738 | * @param string $message |
||
| 739 | * |
||
| 740 | * @throws InvalidArgumentException |
||
| 741 | */ |
||
| 742 | 15 | public static function true($value, $message = '') |
|
| 751 | |||
| 752 | /** |
||
| 753 | * @psalm-assert false $value |
||
| 754 | * |
||
| 755 | * @param mixed $value |
||
| 756 | * @param string $message |
||
| 757 | * |
||
| 758 | * @throws InvalidArgumentException |
||
| 759 | */ |
||
| 760 | 19 | public static function false($value, $message = '') |
|
| 769 | |||
| 770 | /** |
||
| 771 | * @psalm-assert !false $value |
||
| 772 | * |
||
| 773 | * @param mixed $value |
||
| 774 | * @param string $message |
||
| 775 | * |
||
| 776 | * @throws InvalidArgumentException |
||
| 777 | */ |
||
| 778 | 19 | public static function notFalse($value, $message = '') |
|
| 786 | |||
| 787 | /** |
||
| 788 | * @param mixed $value |
||
| 789 | * @param string $message |
||
| 790 | * |
||
| 791 | * @throws InvalidArgumentException |
||
| 792 | */ |
||
| 793 | 51 | View Code Duplication | public static function ip($value, $message = '') |
| 802 | |||
| 803 | /** |
||
| 804 | * @param mixed $value |
||
| 805 | * @param string $message |
||
| 806 | * |
||
| 807 | * @throws InvalidArgumentException |
||
| 808 | */ |
||
| 809 | 51 | View Code Duplication | public static function ipv4($value, $message = '') |
| 818 | |||
| 819 | /** |
||
| 820 | * @param mixed $value |
||
| 821 | * @param string $message |
||
| 822 | * |
||
| 823 | * @throws InvalidArgumentException |
||
| 824 | */ |
||
| 825 | 51 | View Code Duplication | public static function ipv6($value, $message = '') |
| 834 | |||
| 835 | /** |
||
| 836 | * @param mixed $value |
||
| 837 | * @param string $message |
||
| 838 | * |
||
| 839 | * @throws InvalidArgumentException |
||
| 840 | */ |
||
| 841 | 20 | View Code Duplication | public static function email($value, $message = '') |
| 850 | |||
| 851 | /** |
||
| 852 | * Does non strict comparisons on the items, so ['3', 3] will not pass the assertion. |
||
| 853 | * |
||
| 854 | * @param array $values |
||
| 855 | * @param string $message |
||
| 856 | * |
||
| 857 | * @throws InvalidArgumentException |
||
| 858 | */ |
||
| 859 | 12 | public static function uniqueValues(array $values, $message = '') |
|
| 874 | |||
| 875 | /** |
||
| 876 | * @param mixed $value |
||
| 877 | * @param mixed $expect |
||
| 878 | * @param string $message |
||
| 879 | * |
||
| 880 | * @throws InvalidArgumentException |
||
| 881 | */ |
||
| 882 | 33 | public static function eq($value, $expect, $message = '') |
|
| 892 | |||
| 893 | /** |
||
| 894 | * @param mixed $value |
||
| 895 | * @param mixed $expect |
||
| 896 | * @param string $message |
||
| 897 | * |
||
| 898 | * @throws InvalidArgumentException |
||
| 899 | */ |
||
| 900 | 28 | public static function notEq($value, $expect, $message = '') |
|
| 909 | |||
| 910 | /** |
||
| 911 | * @param mixed $value |
||
| 912 | * @param mixed $expect |
||
| 913 | * @param string $message |
||
| 914 | * |
||
| 915 | * @throws InvalidArgumentException |
||
| 916 | */ |
||
| 917 | 16 | public static function same($value, $expect, $message = '') |
|
| 927 | |||
| 928 | /** |
||
| 929 | * @param mixed $value |
||
| 930 | * @param mixed $expect |
||
| 931 | * @param string $message |
||
| 932 | * |
||
| 933 | * @throws InvalidArgumentException |
||
| 934 | */ |
||
| 935 | 16 | public static function notSame($value, $expect, $message = '') |
|
| 944 | |||
| 945 | /** |
||
| 946 | * @param mixed $value |
||
| 947 | * @param mixed $limit |
||
| 948 | * @param string $message |
||
| 949 | * |
||
| 950 | * @throws InvalidArgumentException |
||
| 951 | */ |
||
| 952 | 8 | public static function greaterThan($value, $limit, $message = '') |
|
| 962 | |||
| 963 | /** |
||
| 964 | * @param mixed $value |
||
| 965 | * @param mixed $limit |
||
| 966 | * @param string $message |
||
| 967 | * |
||
| 968 | * @throws InvalidArgumentException |
||
| 969 | */ |
||
| 970 | 12 | public static function greaterThanEq($value, $limit, $message = '') |
|
| 980 | |||
| 981 | /** |
||
| 982 | * @param mixed $value |
||
| 983 | * @param mixed $limit |
||
| 984 | * @param string $message |
||
| 985 | * |
||
| 986 | * @throws InvalidArgumentException |
||
| 987 | */ |
||
| 988 | 8 | public static function lessThan($value, $limit, $message = '') |
|
| 998 | |||
| 999 | /** |
||
| 1000 | * @param mixed $value |
||
| 1001 | * @param mixed $limit |
||
| 1002 | * @param string $message |
||
| 1003 | * |
||
| 1004 | * @throws InvalidArgumentException |
||
| 1005 | */ |
||
| 1006 | 12 | public static function lessThanEq($value, $limit, $message = '') |
|
| 1016 | |||
| 1017 | /** |
||
| 1018 | * Inclusive range, so Assert::(3, 3, 5) passes. |
||
| 1019 | * |
||
| 1020 | * @param mixed $value |
||
| 1021 | * @param mixed $min |
||
| 1022 | * @param mixed $max |
||
| 1023 | * @param string $message |
||
| 1024 | * |
||
| 1025 | * @throws InvalidArgumentException |
||
| 1026 | */ |
||
| 1027 | 16 | View Code Duplication | public static function range($value, $min, $max, $message = '') |
| 1038 | |||
| 1039 | /** |
||
| 1040 | * Does strict comparison, so Assert::oneOf(3, ['3']) does not pass the assertion. |
||
| 1041 | * |
||
| 1042 | * @param mixed $value |
||
| 1043 | * @param array $values |
||
| 1044 | * @param string $message |
||
| 1045 | * |
||
| 1046 | * @throws InvalidArgumentException |
||
| 1047 | */ |
||
| 1048 | 8 | public static function oneOf($value, array $values, $message = '') |
|
| 1058 | |||
| 1059 | /** |
||
| 1060 | * @param mixed $value |
||
| 1061 | * @param string $subString |
||
| 1062 | * @param string $message |
||
| 1063 | * |
||
| 1064 | * @throws InvalidArgumentException |
||
| 1065 | */ |
||
| 1066 | 80 | View Code Duplication | public static function contains($value, $subString, $message = '') |
| 1076 | |||
| 1077 | /** |
||
| 1078 | * @param mixed $value |
||
| 1079 | * @param string $subString |
||
| 1080 | * @param string $message |
||
| 1081 | * |
||
| 1082 | * @throws InvalidArgumentException |
||
| 1083 | */ |
||
| 1084 | 80 | View Code Duplication | public static function notContains($value, $subString, $message = '') |
| 1094 | |||
| 1095 | /** |
||
| 1096 | * @param mixed $value |
||
| 1097 | * @param string $message |
||
| 1098 | * |
||
| 1099 | * @throws InvalidArgumentException |
||
| 1100 | */ |
||
| 1101 | 40 | public static function notWhitespaceOnly($value, $message = '') |
|
| 1110 | |||
| 1111 | /** |
||
| 1112 | * @param mixed $value |
||
| 1113 | * @param string $prefix |
||
| 1114 | * @param string $message |
||
| 1115 | * |
||
| 1116 | * @throws InvalidArgumentException |
||
| 1117 | */ |
||
| 1118 | 48 | View Code Duplication | public static function startsWith($value, $prefix, $message = '') |
| 1128 | |||
| 1129 | /** |
||
| 1130 | * @param mixed $value |
||
| 1131 | * @param string $message |
||
| 1132 | * |
||
| 1133 | * @throws InvalidArgumentException |
||
| 1134 | */ |
||
| 1135 | 35 | public static function startsWithLetter($value, $message = '') |
|
| 1155 | |||
| 1156 | /** |
||
| 1157 | * @param mixed $value |
||
| 1158 | * @param string $suffix |
||
| 1159 | * @param string $message |
||
| 1160 | * |
||
| 1161 | * @throws InvalidArgumentException |
||
| 1162 | */ |
||
| 1163 | 48 | View Code Duplication | public static function endsWith($value, $suffix, $message = '') |
| 1173 | |||
| 1174 | /** |
||
| 1175 | * @param mixed $value |
||
| 1176 | * @param mixed $pattern |
||
| 1177 | * @param string $message |
||
| 1178 | * |
||
| 1179 | * @throws InvalidArgumentException |
||
| 1180 | */ |
||
| 1181 | 12 | public static function regex($value, $pattern, $message = '') |
|
| 1190 | |||
| 1191 | /** |
||
| 1192 | * @param mixed $value |
||
| 1193 | * @param mixed $pattern |
||
| 1194 | * @param string $message |
||
| 1195 | * |
||
| 1196 | * @throws InvalidArgumentException |
||
| 1197 | */ |
||
| 1198 | 12 | public static function notRegex($value, $pattern, $message = '') |
|
| 1209 | |||
| 1210 | /** |
||
| 1211 | * @param mixed $value |
||
| 1212 | * @param string $message |
||
| 1213 | * |
||
| 1214 | * @throws InvalidArgumentException |
||
| 1215 | */ |
||
| 1216 | 28 | View Code Duplication | public static function unicodeLetters($value, $message = '') |
| 1227 | |||
| 1228 | /** |
||
| 1229 | * @param mixed $value |
||
| 1230 | * @param string $message |
||
| 1231 | * |
||
| 1232 | * @throws InvalidArgumentException |
||
| 1233 | */ |
||
| 1234 | 20 | View Code Duplication | public static function alpha($value, $message = '') |
| 1250 | |||
| 1251 | /** |
||
| 1252 | * @param mixed $value |
||
| 1253 | * @param string $message |
||
| 1254 | * |
||
| 1255 | * @throws InvalidArgumentException |
||
| 1256 | */ |
||
| 1257 | 12 | View Code Duplication | public static function digits($value, $message = '') |
| 1271 | |||
| 1272 | /** |
||
| 1273 | * @param mixed $value |
||
| 1274 | * @param string $message |
||
| 1275 | * |
||
| 1276 | * @throws InvalidArgumentException |
||
| 1277 | */ |
||
| 1278 | 12 | View Code Duplication | public static function alnum($value, $message = '') |
| 1292 | |||
| 1293 | /** |
||
| 1294 | * @param mixed $value |
||
| 1295 | * @param string $message |
||
| 1296 | * |
||
| 1297 | * @throws InvalidArgumentException |
||
| 1298 | */ |
||
| 1299 | 16 | View Code Duplication | public static function lower($value, $message = '') |
| 1313 | |||
| 1314 | /** |
||
| 1315 | * @param mixed $value |
||
| 1316 | * @param string $message |
||
| 1317 | * |
||
| 1318 | * @throws InvalidArgumentException |
||
| 1319 | */ |
||
| 1320 | 16 | View Code Duplication | public static function upper($value, $message = '') |
| 1334 | |||
| 1335 | /** |
||
| 1336 | * @param mixed $value |
||
| 1337 | * @param mixed $length |
||
| 1338 | * @param string $message |
||
| 1339 | * |
||
| 1340 | * @throws InvalidArgumentException |
||
| 1341 | */ |
||
| 1342 | 36 | public static function length($value, $length, $message = '') |
|
| 1352 | |||
| 1353 | /** |
||
| 1354 | * Inclusive min. |
||
| 1355 | * |
||
| 1356 | * @param mixed $value |
||
| 1357 | * @param mixed $min |
||
| 1358 | * @param string $message |
||
| 1359 | * |
||
| 1360 | * @throws InvalidArgumentException |
||
| 1361 | */ |
||
| 1362 | 36 | public static function minLength($value, $min, $message = '') |
|
| 1372 | |||
| 1373 | /** |
||
| 1374 | * Inclusive max. |
||
| 1375 | * |
||
| 1376 | * @param mixed $value |
||
| 1377 | * @param mixed $max |
||
| 1378 | * @param string $message |
||
| 1379 | * |
||
| 1380 | * @throws InvalidArgumentException |
||
| 1381 | */ |
||
| 1382 | 36 | public static function maxLength($value, $max, $message = '') |
|
| 1392 | |||
| 1393 | /** |
||
| 1394 | * Inclusive , so Assert::lengthBetween('asd', 3, 5); passes the assertion. |
||
| 1395 | * |
||
| 1396 | * @param mixed $value |
||
| 1397 | * @param mixed $min |
||
| 1398 | * @param mixed $max |
||
| 1399 | * @param string $message |
||
| 1400 | * |
||
| 1401 | * @throws InvalidArgumentException |
||
| 1402 | */ |
||
| 1403 | 60 | View Code Duplication | public static function lengthBetween($value, $min, $max, $message = '') |
| 1416 | |||
| 1417 | /** |
||
| 1418 | * Will also pass if $value is a directory, use Assert::file() instead if you need to be sure it is a file. |
||
| 1419 | * |
||
| 1420 | * @param mixed $value |
||
| 1421 | * @param string $message |
||
| 1422 | * |
||
| 1423 | * @throws InvalidArgumentException |
||
| 1424 | */ |
||
| 1425 | 36 | View Code Duplication | public static function fileExists($value, $message = '') |
| 1436 | |||
| 1437 | /** |
||
| 1438 | * @param mixed $value |
||
| 1439 | * @param string $message |
||
| 1440 | * |
||
| 1441 | * @throws InvalidArgumentException |
||
| 1442 | */ |
||
| 1443 | 12 | View Code Duplication | public static function file($value, $message = '') |
| 1454 | |||
| 1455 | /** |
||
| 1456 | * @param mixed $value |
||
| 1457 | * @param string $message |
||
| 1458 | * |
||
| 1459 | * @throws InvalidArgumentException |
||
| 1460 | */ |
||
| 1461 | 12 | View Code Duplication | public static function directory($value, $message = '') |
| 1472 | |||
| 1473 | /** |
||
| 1474 | * @param mixed $value |
||
| 1475 | * @param string $message |
||
| 1476 | * |
||
| 1477 | * @throws InvalidArgumentException |
||
| 1478 | */ |
||
| 1479 | public static function readable($value, $message = '') |
||
| 1488 | |||
| 1489 | /** |
||
| 1490 | * @param mixed $value |
||
| 1491 | * @param string $message |
||
| 1492 | * |
||
| 1493 | * @throws InvalidArgumentException |
||
| 1494 | */ |
||
| 1495 | public static function writable($value, $message = '') |
||
| 1504 | |||
| 1505 | /** |
||
| 1506 | * @psalm-assert class-string $value |
||
| 1507 | * |
||
| 1508 | * @param mixed $value |
||
| 1509 | * @param string $message |
||
| 1510 | * |
||
| 1511 | * @throws InvalidArgumentException |
||
| 1512 | */ |
||
| 1513 | 8 | public static function classExists($value, $message = '') |
|
| 1522 | |||
| 1523 | /** |
||
| 1524 | * @param mixed $value |
||
| 1525 | * @param string|object $class |
||
| 1526 | * @param string $message |
||
| 1527 | * |
||
| 1528 | * @throws InvalidArgumentException |
||
| 1529 | */ |
||
| 1530 | 8 | public static function subclassOf($value, $class, $message = '') |
|
| 1540 | |||
| 1541 | /** |
||
| 1542 | * @psalm-assert class-string $value |
||
| 1543 | * |
||
| 1544 | * @param mixed $value |
||
| 1545 | * @param string $message |
||
| 1546 | * |
||
| 1547 | * @throws InvalidArgumentException |
||
| 1548 | */ |
||
| 1549 | 8 | public static function interfaceExists($value, $message = '') |
|
| 1558 | |||
| 1559 | /** |
||
| 1560 | * @param mixed $value |
||
| 1561 | * @param mixed $interface |
||
| 1562 | * @param string $message |
||
| 1563 | * |
||
| 1564 | * @throws InvalidArgumentException |
||
| 1565 | */ |
||
| 1566 | 8 | View Code Duplication | public static function implementsInterface($value, $interface, $message = '') |
| 1576 | |||
| 1577 | /** |
||
| 1578 | * @param string|object $classOrObject |
||
| 1579 | * @param mixed $property |
||
| 1580 | * @param string $message |
||
| 1581 | * |
||
| 1582 | * @throws InvalidArgumentException |
||
| 1583 | */ |
||
| 1584 | 12 | View Code Duplication | public static function propertyExists($classOrObject, $property, $message = '') |
| 1593 | |||
| 1594 | /** |
||
| 1595 | * @param string|object $classOrObject |
||
| 1596 | * @param mixed $property |
||
| 1597 | * @param string $message |
||
| 1598 | * |
||
| 1599 | * @throws InvalidArgumentException |
||
| 1600 | */ |
||
| 1601 | 12 | View Code Duplication | public static function propertyNotExists($classOrObject, $property, $message = '') |
| 1610 | |||
| 1611 | /** |
||
| 1612 | * @param string|object $classOrObject |
||
| 1613 | * @param mixed $method |
||
| 1614 | * @param string $message |
||
| 1615 | * |
||
| 1616 | * @throws InvalidArgumentException |
||
| 1617 | */ |
||
| 1618 | 27 | View Code Duplication | public static function methodExists($classOrObject, $method, $message = '') |
| 1627 | |||
| 1628 | /** |
||
| 1629 | * @param string|object $classOrObject |
||
| 1630 | * @param mixed $method |
||
| 1631 | * @param string $message |
||
| 1632 | * |
||
| 1633 | * @throws InvalidArgumentException |
||
| 1634 | */ |
||
| 1635 | 27 | View Code Duplication | public static function methodNotExists($classOrObject, $method, $message = '') |
| 1644 | |||
| 1645 | /** |
||
| 1646 | * @param array $array |
||
| 1647 | * @param string|int $key |
||
| 1648 | * @param string $message |
||
| 1649 | * |
||
| 1650 | * @throws InvalidArgumentException |
||
| 1651 | */ |
||
| 1652 | 12 | View Code Duplication | public static function keyExists($array, $key, $message = '') |
| 1661 | |||
| 1662 | /** |
||
| 1663 | * @param array $array |
||
| 1664 | * @param string|int $key |
||
| 1665 | * @param string $message |
||
| 1666 | * |
||
| 1667 | * @throws InvalidArgumentException |
||
| 1668 | */ |
||
| 1669 | 12 | View Code Duplication | public static function keyNotExists($array, $key, $message = '') |
| 1678 | |||
| 1679 | /** |
||
| 1680 | * Checks if a value is a valid array key (int or string). |
||
| 1681 | * |
||
| 1682 | * @psalm-assert array-key $value |
||
| 1683 | * |
||
| 1684 | * @param mixed $value |
||
| 1685 | * @param string $message |
||
| 1686 | * |
||
| 1687 | * @throws InvalidArgumentException |
||
| 1688 | */ |
||
| 1689 | 28 | public static function validArrayKey($value, $message = '') |
|
| 1698 | |||
| 1699 | /** |
||
| 1700 | * Does not check if $array is countable, this can generate a warning on php versions after 7.2. |
||
| 1701 | * |
||
| 1702 | * @param mixed $array |
||
| 1703 | * @param mixed $number |
||
| 1704 | * @param string $message |
||
| 1705 | * |
||
| 1706 | * @throws InvalidArgumentException |
||
| 1707 | */ |
||
| 1708 | 8 | public static function count($array, $number, $message = '') |
|
| 1716 | |||
| 1717 | /** |
||
| 1718 | * Does not check if $array is countable, this can generate a warning on php versions after 7.2. |
||
| 1719 | * |
||
| 1720 | * @param mixed $array |
||
| 1721 | * @param mixed $min |
||
| 1722 | * @param string $message |
||
| 1723 | * |
||
| 1724 | * @throws InvalidArgumentException |
||
| 1725 | */ |
||
| 1726 | 12 | View Code Duplication | public static function minCount($array, $min, $message = '') |
| 1736 | |||
| 1737 | /** |
||
| 1738 | * Does not check if $array is countable, this can generate a warning on php versions after 7.2. |
||
| 1739 | * |
||
| 1740 | * @param mixed $array |
||
| 1741 | * @param mixed $max |
||
| 1742 | * @param string $message |
||
| 1743 | * |
||
| 1744 | * @throws InvalidArgumentException |
||
| 1745 | */ |
||
| 1746 | 12 | View Code Duplication | public static function maxCount($array, $max, $message = '') |
| 1756 | |||
| 1757 | /** |
||
| 1758 | * Does not check if $array is countable, this can generate a warning on php versions after 7.2. |
||
| 1759 | * |
||
| 1760 | * @param mixed $array |
||
| 1761 | * @param mixed $min |
||
| 1762 | * @param mixed $max |
||
| 1763 | * @param string $message |
||
| 1764 | * |
||
| 1765 | * @throws InvalidArgumentException |
||
| 1766 | */ |
||
| 1767 | 20 | public static function countBetween($array, $min, $max, $message = '') |
|
| 1780 | |||
| 1781 | /** |
||
| 1782 | * @psalm-assert list $array |
||
| 1783 | * |
||
| 1784 | * @param mixed $array |
||
| 1785 | * @param string $message |
||
| 1786 | * |
||
| 1787 | * @throws InvalidArgumentException |
||
| 1788 | */ |
||
| 1789 | 80 | View Code Duplication | public static function isList($array, $message = '') |
| 1797 | |||
| 1798 | /** |
||
| 1799 | * @psalm-assert non-empty-list $array |
||
| 1800 | * |
||
| 1801 | * @param mixed $array |
||
| 1802 | * @param string $message |
||
| 1803 | * |
||
| 1804 | * @throws InvalidArgumentException |
||
| 1805 | */ |
||
| 1806 | 40 | public static function isNonEmptyList($array, $message = '') |
|
| 1811 | |||
| 1812 | /** |
||
| 1813 | * @param mixed $array |
||
| 1814 | * @param string $message |
||
| 1815 | * |
||
| 1816 | * @throws InvalidArgumentException |
||
| 1817 | */ |
||
| 1818 | 32 | public static function isMap($array, $message = '') |
|
| 1829 | |||
| 1830 | /** |
||
| 1831 | * @param mixed $array |
||
| 1832 | * @param string $message |
||
| 1833 | * |
||
| 1834 | * @throws InvalidArgumentException |
||
| 1835 | */ |
||
| 1836 | 16 | public static function isNonEmptyMap($array, $message = '') |
|
| 1841 | |||
| 1842 | /** |
||
| 1843 | * @param mixed $value |
||
| 1844 | * @param string $message |
||
| 1845 | * |
||
| 1846 | * @throws InvalidArgumentException |
||
| 1847 | */ |
||
| 1848 | 56 | public static function uuid($value, $message = '') |
|
| 1865 | |||
| 1866 | /** |
||
| 1867 | * @param Closure $expression |
||
| 1868 | * @param string|object $class |
||
| 1869 | * @param string $message |
||
| 1870 | * |
||
| 1871 | * @throws InvalidArgumentException |
||
| 1872 | */ |
||
| 1873 | 24 | public static function throws(Closure $expression, $class = 'Exception', $message = '') |
|
| 1899 | |||
| 1900 | /** |
||
| 1901 | * @throws BadMethodCallException |
||
| 1902 | */ |
||
| 1903 | 1561 | public static function __callStatic($name, $arguments) |
|
| 1931 | |||
| 1932 | /** |
||
| 1933 | * @param mixed $value |
||
| 1934 | * |
||
| 1935 | * @return string |
||
| 1936 | */ |
||
| 1937 | 714 | protected static function valueToString($value) |
|
| 1973 | |||
| 1974 | /** |
||
| 1975 | * @param mixed $value |
||
| 1976 | * |
||
| 1977 | * @return string |
||
| 1978 | */ |
||
| 1979 | 251 | protected static function typeToString($value) |
|
| 1983 | |||
| 1984 | 168 | protected static function strlen($value) |
|
| 1996 | |||
| 1997 | /** |
||
| 1998 | * @param string $message |
||
| 1999 | * |
||
| 2000 | * @throws InvalidArgumentException |
||
| 2001 | */ |
||
| 2002 | 1028 | protected static function reportInvalidArgument($message) |
|
| 2006 | |||
| 2007 | private function __construct() |
||
| 2010 | } |
||
| 2011 |
Loading history...
