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 |
||
|
|
|||
| 210 | { |
||
| 211 | /** |
||
| 212 | * @psalm-pure |
||
| 213 | * @psalm-assert string $value |
||
| 214 | * |
||
| 215 | * @param mixed $value |
||
| 216 | * @param string $message |
||
| 217 | * |
||
| 218 | * @throws InvalidArgumentException |
||
| 219 | */ |
||
| 220 | 241 | public static function string($value, $message = '') |
|
| 229 | |||
| 230 | /** |
||
| 231 | * @psalm-pure |
||
| 232 | * @psalm-assert string $value |
||
| 233 | * @psalm-assert !empty $value |
||
| 234 | * |
||
| 235 | * @param mixed $value |
||
| 236 | * @param string $message |
||
| 237 | * |
||
| 238 | * @throws InvalidArgumentException |
||
| 239 | */ |
||
| 240 | 16 | public static function stringNotEmpty($value, $message = '') |
|
| 245 | |||
| 246 | /** |
||
| 247 | * @psalm-pure |
||
| 248 | * @psalm-assert int $value |
||
| 249 | * |
||
| 250 | * @param mixed $value |
||
| 251 | * @param string $message |
||
| 252 | * |
||
| 253 | * @throws InvalidArgumentException |
||
| 254 | */ |
||
| 255 | 17 | public static function integer($value, $message = '') |
|
| 264 | |||
| 265 | /** |
||
| 266 | * @psalm-pure |
||
| 267 | * @psalm-assert numeric $value |
||
| 268 | * |
||
| 269 | * @param mixed $value |
||
| 270 | * @param string $message |
||
| 271 | * |
||
| 272 | * @throws InvalidArgumentException |
||
| 273 | */ |
||
| 274 | 16 | public static function integerish($value, $message = '') |
|
| 283 | |||
| 284 | /** |
||
| 285 | * @psalm-pure |
||
| 286 | * @psalm-assert float $value |
||
| 287 | * |
||
| 288 | * @param mixed $value |
||
| 289 | * @param string $message |
||
| 290 | * |
||
| 291 | * @throws InvalidArgumentException |
||
| 292 | */ |
||
| 293 | 16 | public static function float($value, $message = '') |
|
| 302 | |||
| 303 | /** |
||
| 304 | * @psalm-pure |
||
| 305 | * @psalm-assert numeric $value |
||
| 306 | * |
||
| 307 | * @param mixed $value |
||
| 308 | * @param string $message |
||
| 309 | * |
||
| 310 | * @throws InvalidArgumentException |
||
| 311 | */ |
||
| 312 | 20 | public static function numeric($value, $message = '') |
|
| 321 | |||
| 322 | /** |
||
| 323 | * @psalm-pure |
||
| 324 | * @psalm-assert int $value |
||
| 325 | * |
||
| 326 | * @param mixed $value |
||
| 327 | * @param string $message |
||
| 328 | * |
||
| 329 | * @throws InvalidArgumentException |
||
| 330 | */ |
||
| 331 | 24 | public static function natural($value, $message = '') |
|
| 340 | |||
| 341 | /** |
||
| 342 | * @psalm-pure |
||
| 343 | * @psalm-assert bool $value |
||
| 344 | * |
||
| 345 | * @param mixed $value |
||
| 346 | * @param string $message |
||
| 347 | * |
||
| 348 | * @throws InvalidArgumentException |
||
| 349 | */ |
||
| 350 | 16 | public static function boolean($value, $message = '') |
|
| 359 | |||
| 360 | /** |
||
| 361 | * @psalm-pure |
||
| 362 | * @psalm-assert scalar $value |
||
| 363 | * |
||
| 364 | * @param mixed $value |
||
| 365 | * @param string $message |
||
| 366 | * |
||
| 367 | * @throws InvalidArgumentException |
||
| 368 | */ |
||
| 369 | 23 | public static function scalar($value, $message = '') |
|
| 378 | |||
| 379 | /** |
||
| 380 | * @psalm-pure |
||
| 381 | * @psalm-assert object $value |
||
| 382 | * |
||
| 383 | * @param mixed $value |
||
| 384 | * @param string $message |
||
| 385 | * |
||
| 386 | * @throws InvalidArgumentException |
||
| 387 | */ |
||
| 388 | 23 | public static function object($value, $message = '') |
|
| 397 | |||
| 398 | /** |
||
| 399 | * @psalm-pure |
||
| 400 | * @psalm-assert resource $value |
||
| 401 | * |
||
| 402 | * @param mixed $value |
||
| 403 | * @param string|null $type type of resource this should be. @see https://www.php.net/manual/en/function.get-resource-type.php |
||
| 404 | * @param string $message |
||
| 405 | * |
||
| 406 | * @throws InvalidArgumentException |
||
| 407 | */ |
||
| 408 | 16 | public static function resource($value, $type = null, $message = '') |
|
| 425 | |||
| 426 | /** |
||
| 427 | * @psalm-pure |
||
| 428 | * @psalm-assert callable $value |
||
| 429 | * |
||
| 430 | * @param mixed $value |
||
| 431 | * @param string $message |
||
| 432 | * |
||
| 433 | * @throws InvalidArgumentException |
||
| 434 | */ |
||
| 435 | 20 | public static function isCallable($value, $message = '') |
|
| 444 | |||
| 445 | /** |
||
| 446 | * @psalm-pure |
||
| 447 | * @psalm-assert array $value |
||
| 448 | * |
||
| 449 | * @param mixed $value |
||
| 450 | * @param string $message |
||
| 451 | * |
||
| 452 | * @throws InvalidArgumentException |
||
| 453 | */ |
||
| 454 | 20 | public static function isArray($value, $message = '') |
|
| 463 | |||
| 464 | /** |
||
| 465 | * @psalm-pure |
||
| 466 | * @psalm-assert iterable $value |
||
| 467 | * |
||
| 468 | * @deprecated use "isIterable" or "isInstanceOf" instead |
||
| 469 | * |
||
| 470 | * @param mixed $value |
||
| 471 | * @param string $message |
||
| 472 | * |
||
| 473 | * @throws InvalidArgumentException |
||
| 474 | */ |
||
| 475 | 20 | public static function isTraversable($value, $message = '') |
|
| 492 | |||
| 493 | /** |
||
| 494 | * @psalm-pure |
||
| 495 | * @psalm-assert array|ArrayAccess $value |
||
| 496 | * |
||
| 497 | * @param mixed $value |
||
| 498 | * @param string $message |
||
| 499 | * |
||
| 500 | * @throws InvalidArgumentException |
||
| 501 | */ |
||
| 502 | 20 | View Code Duplication | public static function isArrayAccessible($value, $message = '') |
| 511 | |||
| 512 | /** |
||
| 513 | * @psalm-pure |
||
| 514 | * @psalm-assert countable $value |
||
| 515 | * |
||
| 516 | * @param mixed $value |
||
| 517 | * @param string $message |
||
| 518 | * |
||
| 519 | * @throws InvalidArgumentException |
||
| 520 | */ |
||
| 521 | 28 | public static function isCountable($value, $message = '') |
|
| 535 | |||
| 536 | /** |
||
| 537 | * @psalm-pure |
||
| 538 | * @psalm-assert iterable $value |
||
| 539 | * |
||
| 540 | * @param mixed $value |
||
| 541 | * @param string $message |
||
| 542 | * |
||
| 543 | * @throws InvalidArgumentException |
||
| 544 | */ |
||
| 545 | 996 | View Code Duplication | public static function isIterable($value, $message = '') |
| 554 | |||
| 555 | /** |
||
| 556 | * @psalm-pure |
||
| 557 | * @psalm-template ExpectedType of object |
||
| 558 | * @psalm-param class-string<ExpectedType> $class |
||
| 559 | * @psalm-assert ExpectedType $value |
||
| 560 | * |
||
| 561 | * @param mixed $value |
||
| 562 | * @param string|object $class |
||
| 563 | * @param string $message |
||
| 564 | * |
||
| 565 | * @throws InvalidArgumentException |
||
| 566 | */ |
||
| 567 | 19 | public static function isInstanceOf($value, $class, $message = '') |
|
| 577 | |||
| 578 | /** |
||
| 579 | * @psalm-pure |
||
| 580 | * @psalm-template ExpectedType of object |
||
| 581 | * @psalm-param class-string<ExpectedType> $class |
||
| 582 | * @psalm-assert !ExpectedType $value |
||
| 583 | * |
||
| 584 | * @param mixed $value |
||
| 585 | * @param string|object $class |
||
| 586 | * @param string $message |
||
| 587 | * |
||
| 588 | * @throws InvalidArgumentException |
||
| 589 | */ |
||
| 590 | 16 | public static function notInstanceOf($value, $class, $message = '') |
|
| 600 | |||
| 601 | /** |
||
| 602 | * @psalm-pure |
||
| 603 | * @psalm-param array<class-string> $classes |
||
| 604 | * |
||
| 605 | * @param mixed $value |
||
| 606 | * @param array<object|string> $classes |
||
| 607 | * @param string $message |
||
| 608 | * |
||
| 609 | * @throws InvalidArgumentException |
||
| 610 | */ |
||
| 611 | 20 | public static function isInstanceOfAny($value, array $classes, $message = '') |
|
| 625 | |||
| 626 | /** |
||
| 627 | * @psalm-pure |
||
| 628 | * @psalm-template ExpectedType of object |
||
| 629 | * @psalm-param class-string<ExpectedType> $class |
||
| 630 | * @psalm-assert ExpectedType|class-string<ExpectedType> $value |
||
| 631 | * |
||
| 632 | * @param object|string $value |
||
| 633 | * @param string $class |
||
| 634 | * @param string $message |
||
| 635 | * |
||
| 636 | * @throws InvalidArgumentException |
||
| 637 | */ |
||
| 638 | 20 | View Code Duplication | public static function isAOf($value, $class, $message = '') |
| 650 | |||
| 651 | /** |
||
| 652 | * @psalm-pure |
||
| 653 | * @psalm-template UnexpectedType of object |
||
| 654 | * @psalm-param class-string<UnexpectedType> $class |
||
| 655 | * @psalm-assert !UnexpectedType $value |
||
| 656 | * @psalm-assert !class-string<UnexpectedType> $value |
||
| 657 | * |
||
| 658 | * @param object|string $value |
||
| 659 | * @param string $class |
||
| 660 | * @param string $message |
||
| 661 | * |
||
| 662 | * @throws InvalidArgumentException |
||
| 663 | */ |
||
| 664 | 20 | View Code Duplication | public static function isNotA($value, $class, $message = '') |
| 676 | |||
| 677 | /** |
||
| 678 | * @psalm-pure |
||
| 679 | * @psalm-param array<class-string> $classes |
||
| 680 | * |
||
| 681 | * @param object|string $value |
||
| 682 | * @param string[] $classes |
||
| 683 | * @param string $message |
||
| 684 | * |
||
| 685 | * @throws InvalidArgumentException |
||
| 686 | */ |
||
| 687 | 24 | public static function isAnyOf($value, array $classes, $message = '') |
|
| 703 | |||
| 704 | /** |
||
| 705 | * @psalm-pure |
||
| 706 | * @psalm-assert empty $value |
||
| 707 | * |
||
| 708 | * @param mixed $value |
||
| 709 | * @param string $message |
||
| 710 | * |
||
| 711 | * @throws InvalidArgumentException |
||
| 712 | */ |
||
| 713 | 23 | public static function isEmpty($value, $message = '') |
|
| 722 | |||
| 723 | /** |
||
| 724 | * @psalm-pure |
||
| 725 | * @psalm-assert !empty $value |
||
| 726 | * |
||
| 727 | * @param mixed $value |
||
| 728 | * @param string $message |
||
| 729 | * |
||
| 730 | * @throws InvalidArgumentException |
||
| 731 | */ |
||
| 732 | 55 | public static function notEmpty($value, $message = '') |
|
| 741 | |||
| 742 | /** |
||
| 743 | * @psalm-pure |
||
| 744 | * @psalm-assert null $value |
||
| 745 | * |
||
| 746 | * @param mixed $value |
||
| 747 | * @param string $message |
||
| 748 | * |
||
| 749 | * @throws InvalidArgumentException |
||
| 750 | */ |
||
| 751 | 11 | public static function null($value, $message = '') |
|
| 760 | |||
| 761 | /** |
||
| 762 | * @psalm-pure |
||
| 763 | * @psalm-assert !null $value |
||
| 764 | * |
||
| 765 | * @param mixed $value |
||
| 766 | * @param string $message |
||
| 767 | * |
||
| 768 | * @throws InvalidArgumentException |
||
| 769 | */ |
||
| 770 | 11 | public static function notNull($value, $message = '') |
|
| 778 | |||
| 779 | /** |
||
| 780 | * @psalm-pure |
||
| 781 | * @psalm-assert true $value |
||
| 782 | * |
||
| 783 | * @param mixed $value |
||
| 784 | * @param string $message |
||
| 785 | * |
||
| 786 | * @throws InvalidArgumentException |
||
| 787 | */ |
||
| 788 | 15 | public static function true($value, $message = '') |
|
| 797 | |||
| 798 | /** |
||
| 799 | * @psalm-pure |
||
| 800 | * @psalm-assert false $value |
||
| 801 | * |
||
| 802 | * @param mixed $value |
||
| 803 | * @param string $message |
||
| 804 | * |
||
| 805 | * @throws InvalidArgumentException |
||
| 806 | */ |
||
| 807 | 19 | public static function false($value, $message = '') |
|
| 816 | |||
| 817 | /** |
||
| 818 | * @psalm-assert !false $value |
||
| 819 | * |
||
| 820 | * @param mixed $value |
||
| 821 | * @param string $message |
||
| 822 | * |
||
| 823 | * @throws InvalidArgumentException |
||
| 824 | */ |
||
| 825 | 19 | public static function notFalse($value, $message = '') |
|
| 833 | |||
| 834 | /** |
||
| 835 | * @param mixed $value |
||
| 836 | * @param string $message |
||
| 837 | * |
||
| 838 | * @throws InvalidArgumentException |
||
| 839 | */ |
||
| 840 | 51 | View Code Duplication | public static function ip($value, $message = '') |
| 849 | |||
| 850 | /** |
||
| 851 | * @param mixed $value |
||
| 852 | * @param string $message |
||
| 853 | * |
||
| 854 | * @throws InvalidArgumentException |
||
| 855 | */ |
||
| 856 | 51 | View Code Duplication | public static function ipv4($value, $message = '') |
| 865 | |||
| 866 | /** |
||
| 867 | * @param mixed $value |
||
| 868 | * @param string $message |
||
| 869 | * |
||
| 870 | * @throws InvalidArgumentException |
||
| 871 | */ |
||
| 872 | 51 | View Code Duplication | public static function ipv6($value, $message = '') |
| 881 | |||
| 882 | /** |
||
| 883 | * @param mixed $value |
||
| 884 | * @param string $message |
||
| 885 | * |
||
| 886 | * @throws InvalidArgumentException |
||
| 887 | */ |
||
| 888 | 20 | View Code Duplication | public static function email($value, $message = '') |
| 897 | |||
| 898 | /** |
||
| 899 | * Does non strict comparisons on the items, so ['3', 3] will not pass the assertion. |
||
| 900 | * |
||
| 901 | * @param array $values |
||
| 902 | * @param string $message |
||
| 903 | * |
||
| 904 | * @throws InvalidArgumentException |
||
| 905 | */ |
||
| 906 | 12 | public static function uniqueValues(array $values, $message = '') |
|
| 921 | |||
| 922 | /** |
||
| 923 | * @param mixed $value |
||
| 924 | * @param mixed $expect |
||
| 925 | * @param string $message |
||
| 926 | * |
||
| 927 | * @throws InvalidArgumentException |
||
| 928 | */ |
||
| 929 | 33 | public static function eq($value, $expect, $message = '') |
|
| 939 | |||
| 940 | /** |
||
| 941 | * @param mixed $value |
||
| 942 | * @param mixed $expect |
||
| 943 | * @param string $message |
||
| 944 | * |
||
| 945 | * @throws InvalidArgumentException |
||
| 946 | */ |
||
| 947 | 28 | public static function notEq($value, $expect, $message = '') |
|
| 956 | |||
| 957 | /** |
||
| 958 | * @psalm-pure |
||
| 959 | * |
||
| 960 | * @param mixed $value |
||
| 961 | * @param mixed $expect |
||
| 962 | * @param string $message |
||
| 963 | * |
||
| 964 | * @throws InvalidArgumentException |
||
| 965 | */ |
||
| 966 | 16 | public static function same($value, $expect, $message = '') |
|
| 976 | |||
| 977 | /** |
||
| 978 | * @psalm-pure |
||
| 979 | * |
||
| 980 | * @param mixed $value |
||
| 981 | * @param mixed $expect |
||
| 982 | * @param string $message |
||
| 983 | * |
||
| 984 | * @throws InvalidArgumentException |
||
| 985 | */ |
||
| 986 | 16 | public static function notSame($value, $expect, $message = '') |
|
| 995 | |||
| 996 | /** |
||
| 997 | * @psalm-pure |
||
| 998 | * |
||
| 999 | * @param mixed $value |
||
| 1000 | * @param mixed $limit |
||
| 1001 | * @param string $message |
||
| 1002 | * |
||
| 1003 | * @throws InvalidArgumentException |
||
| 1004 | */ |
||
| 1005 | 8 | public static function greaterThan($value, $limit, $message = '') |
|
| 1015 | |||
| 1016 | /** |
||
| 1017 | * @psalm-pure |
||
| 1018 | * |
||
| 1019 | * @param mixed $value |
||
| 1020 | * @param mixed $limit |
||
| 1021 | * @param string $message |
||
| 1022 | * |
||
| 1023 | * @throws InvalidArgumentException |
||
| 1024 | */ |
||
| 1025 | 12 | public static function greaterThanEq($value, $limit, $message = '') |
|
| 1035 | |||
| 1036 | /** |
||
| 1037 | * @psalm-pure |
||
| 1038 | * |
||
| 1039 | * @param mixed $value |
||
| 1040 | * @param mixed $limit |
||
| 1041 | * @param string $message |
||
| 1042 | * |
||
| 1043 | * @throws InvalidArgumentException |
||
| 1044 | */ |
||
| 1045 | 8 | public static function lessThan($value, $limit, $message = '') |
|
| 1055 | |||
| 1056 | /** |
||
| 1057 | * @psalm-pure |
||
| 1058 | * |
||
| 1059 | * @param mixed $value |
||
| 1060 | * @param mixed $limit |
||
| 1061 | * @param string $message |
||
| 1062 | * |
||
| 1063 | * @throws InvalidArgumentException |
||
| 1064 | */ |
||
| 1065 | 12 | public static function lessThanEq($value, $limit, $message = '') |
|
| 1075 | |||
| 1076 | /** |
||
| 1077 | * Inclusive range, so Assert::(3, 3, 5) passes. |
||
| 1078 | * |
||
| 1079 | * @psalm-pure |
||
| 1080 | * |
||
| 1081 | * @param mixed $value |
||
| 1082 | * @param mixed $min |
||
| 1083 | * @param mixed $max |
||
| 1084 | * @param string $message |
||
| 1085 | * |
||
| 1086 | * @throws InvalidArgumentException |
||
| 1087 | */ |
||
| 1088 | 16 | View Code Duplication | public static function range($value, $min, $max, $message = '') |
| 1099 | |||
| 1100 | /** |
||
| 1101 | * A more human-readable alias of Assert::inArray(). |
||
| 1102 | * |
||
| 1103 | * @psalm-pure |
||
| 1104 | * |
||
| 1105 | * @param mixed $value |
||
| 1106 | * @param array $values |
||
| 1107 | * @param string $message |
||
| 1108 | * |
||
| 1109 | * @throws InvalidArgumentException |
||
| 1110 | */ |
||
| 1111 | 8 | public static function oneOf($value, array $values, $message = '') |
|
| 1115 | |||
| 1116 | /** |
||
| 1117 | * Does strict comparison, so Assert::inArray(3, ['3']) does not pass the assertion. |
||
| 1118 | * |
||
| 1119 | * @psalm-pure |
||
| 1120 | * |
||
| 1121 | * @param mixed $value |
||
| 1122 | * @param array $values |
||
| 1123 | * @param string $message |
||
| 1124 | * |
||
| 1125 | * @throws InvalidArgumentException |
||
| 1126 | */ |
||
| 1127 | 16 | public static function inArray($value, array $values, $message = '') |
|
| 1137 | |||
| 1138 | /** |
||
| 1139 | * @psalm-pure |
||
| 1140 | * |
||
| 1141 | * @param string $value |
||
| 1142 | * @param string $subString |
||
| 1143 | * @param string $message |
||
| 1144 | * |
||
| 1145 | * @throws InvalidArgumentException |
||
| 1146 | */ |
||
| 1147 | 80 | View Code Duplication | public static function contains($value, $subString, $message = '') |
| 1157 | |||
| 1158 | /** |
||
| 1159 | * @psalm-pure |
||
| 1160 | * |
||
| 1161 | * @param string $value |
||
| 1162 | * @param string $subString |
||
| 1163 | * @param string $message |
||
| 1164 | * |
||
| 1165 | * @throws InvalidArgumentException |
||
| 1166 | */ |
||
| 1167 | 80 | View Code Duplication | public static function notContains($value, $subString, $message = '') |
| 1177 | |||
| 1178 | /** |
||
| 1179 | * @psalm-pure |
||
| 1180 | * |
||
| 1181 | * @param string $value |
||
| 1182 | * @param string $message |
||
| 1183 | * |
||
| 1184 | * @throws InvalidArgumentException |
||
| 1185 | */ |
||
| 1186 | 40 | public static function notWhitespaceOnly($value, $message = '') |
|
| 1195 | |||
| 1196 | /** |
||
| 1197 | * @psalm-pure |
||
| 1198 | * |
||
| 1199 | * @param string $value |
||
| 1200 | * @param string $prefix |
||
| 1201 | * @param string $message |
||
| 1202 | * |
||
| 1203 | * @throws InvalidArgumentException |
||
| 1204 | */ |
||
| 1205 | 48 | View Code Duplication | public static function startsWith($value, $prefix, $message = '') |
| 1215 | |||
| 1216 | /** |
||
| 1217 | * @psalm-pure |
||
| 1218 | * |
||
| 1219 | * @param mixed $value |
||
| 1220 | * @param string $message |
||
| 1221 | * |
||
| 1222 | * @throws InvalidArgumentException |
||
| 1223 | */ |
||
| 1224 | 35 | public static function startsWithLetter($value, $message = '') |
|
| 1244 | |||
| 1245 | /** |
||
| 1246 | * @psalm-pure |
||
| 1247 | * |
||
| 1248 | * @param string $value |
||
| 1249 | * @param string $suffix |
||
| 1250 | * @param string $message |
||
| 1251 | * |
||
| 1252 | * @throws InvalidArgumentException |
||
| 1253 | */ |
||
| 1254 | 48 | View Code Duplication | public static function endsWith($value, $suffix, $message = '') |
| 1264 | |||
| 1265 | /** |
||
| 1266 | * @psalm-pure |
||
| 1267 | * |
||
| 1268 | * @param string $value |
||
| 1269 | * @param string $pattern |
||
| 1270 | * @param string $message |
||
| 1271 | * |
||
| 1272 | * @throws InvalidArgumentException |
||
| 1273 | */ |
||
| 1274 | 12 | public static function regex($value, $pattern, $message = '') |
|
| 1283 | |||
| 1284 | /** |
||
| 1285 | * @psalm-pure |
||
| 1286 | * |
||
| 1287 | * @param string $value |
||
| 1288 | * @param string $pattern |
||
| 1289 | * @param string $message |
||
| 1290 | * |
||
| 1291 | * @throws InvalidArgumentException |
||
| 1292 | */ |
||
| 1293 | 12 | public static function notRegex($value, $pattern, $message = '') |
|
| 1304 | |||
| 1305 | /** |
||
| 1306 | * @psalm-pure |
||
| 1307 | * |
||
| 1308 | * @param mixed $value |
||
| 1309 | * @param string $message |
||
| 1310 | * |
||
| 1311 | * @throws InvalidArgumentException |
||
| 1312 | */ |
||
| 1313 | 28 | View Code Duplication | public static function unicodeLetters($value, $message = '') |
| 1324 | |||
| 1325 | /** |
||
| 1326 | * @psalm-pure |
||
| 1327 | * |
||
| 1328 | * @param mixed $value |
||
| 1329 | * @param string $message |
||
| 1330 | * |
||
| 1331 | * @throws InvalidArgumentException |
||
| 1332 | */ |
||
| 1333 | 20 | View Code Duplication | public static function alpha($value, $message = '') |
| 1349 | |||
| 1350 | /** |
||
| 1351 | * @psalm-pure |
||
| 1352 | * |
||
| 1353 | * @param string $value |
||
| 1354 | * @param string $message |
||
| 1355 | * |
||
| 1356 | * @throws InvalidArgumentException |
||
| 1357 | */ |
||
| 1358 | 12 | View Code Duplication | public static function digits($value, $message = '') |
| 1372 | |||
| 1373 | /** |
||
| 1374 | * @psalm-pure |
||
| 1375 | * |
||
| 1376 | * @param string $value |
||
| 1377 | * @param string $message |
||
| 1378 | * |
||
| 1379 | * @throws InvalidArgumentException |
||
| 1380 | */ |
||
| 1381 | 12 | View Code Duplication | public static function alnum($value, $message = '') |
| 1395 | |||
| 1396 | /** |
||
| 1397 | * @psalm-pure |
||
| 1398 | * @psalm-assert lowercase-string $value |
||
| 1399 | * |
||
| 1400 | * @param string $value |
||
| 1401 | * @param string $message |
||
| 1402 | * |
||
| 1403 | * @throws InvalidArgumentException |
||
| 1404 | */ |
||
| 1405 | 16 | View Code Duplication | public static function lower($value, $message = '') |
| 1419 | |||
| 1420 | /** |
||
| 1421 | * @psalm-pure |
||
| 1422 | * @psalm-assert !lowercase-string $value |
||
| 1423 | * |
||
| 1424 | * @param string $value |
||
| 1425 | * @param string $message |
||
| 1426 | * |
||
| 1427 | * @throws InvalidArgumentException |
||
| 1428 | */ |
||
| 1429 | 16 | View Code Duplication | public static function upper($value, $message = '') |
| 1443 | |||
| 1444 | /** |
||
| 1445 | * @psalm-pure |
||
| 1446 | * |
||
| 1447 | * @param string $value |
||
| 1448 | * @param int $length |
||
| 1449 | * @param string $message |
||
| 1450 | * |
||
| 1451 | * @throws InvalidArgumentException |
||
| 1452 | */ |
||
| 1453 | 36 | public static function length($value, $length, $message = '') |
|
| 1463 | |||
| 1464 | /** |
||
| 1465 | * Inclusive min. |
||
| 1466 | * |
||
| 1467 | * @psalm-pure |
||
| 1468 | * |
||
| 1469 | * @param string $value |
||
| 1470 | * @param int|float $min |
||
| 1471 | * @param string $message |
||
| 1472 | * |
||
| 1473 | * @throws InvalidArgumentException |
||
| 1474 | */ |
||
| 1475 | 36 | public static function minLength($value, $min, $message = '') |
|
| 1485 | |||
| 1486 | /** |
||
| 1487 | * Inclusive max. |
||
| 1488 | * |
||
| 1489 | * @psalm-pure |
||
| 1490 | * |
||
| 1491 | * @param string $value |
||
| 1492 | * @param int|float $max |
||
| 1493 | * @param string $message |
||
| 1494 | * |
||
| 1495 | * @throws InvalidArgumentException |
||
| 1496 | */ |
||
| 1497 | 36 | public static function maxLength($value, $max, $message = '') |
|
| 1507 | |||
| 1508 | /** |
||
| 1509 | * Inclusive , so Assert::lengthBetween('asd', 3, 5); passes the assertion. |
||
| 1510 | * |
||
| 1511 | * @psalm-pure |
||
| 1512 | * |
||
| 1513 | * @param string $value |
||
| 1514 | * @param int|float $min |
||
| 1515 | * @param int|float $max |
||
| 1516 | * @param string $message |
||
| 1517 | * |
||
| 1518 | * @throws InvalidArgumentException |
||
| 1519 | */ |
||
| 1520 | 60 | View Code Duplication | public static function lengthBetween($value, $min, $max, $message = '') |
| 1533 | |||
| 1534 | /** |
||
| 1535 | * Will also pass if $value is a directory, use Assert::file() instead if you need to be sure it is a file. |
||
| 1536 | * |
||
| 1537 | * @param mixed $value |
||
| 1538 | * @param string $message |
||
| 1539 | * |
||
| 1540 | * @throws InvalidArgumentException |
||
| 1541 | */ |
||
| 1542 | 36 | View Code Duplication | public static function fileExists($value, $message = '') |
| 1553 | |||
| 1554 | /** |
||
| 1555 | * @param mixed $value |
||
| 1556 | * @param string $message |
||
| 1557 | * |
||
| 1558 | * @throws InvalidArgumentException |
||
| 1559 | */ |
||
| 1560 | 12 | View Code Duplication | public static function file($value, $message = '') |
| 1571 | |||
| 1572 | /** |
||
| 1573 | * @param mixed $value |
||
| 1574 | * @param string $message |
||
| 1575 | * |
||
| 1576 | * @throws InvalidArgumentException |
||
| 1577 | */ |
||
| 1578 | 12 | View Code Duplication | public static function directory($value, $message = '') |
| 1589 | |||
| 1590 | /** |
||
| 1591 | * @param string $value |
||
| 1592 | * @param string $message |
||
| 1593 | * |
||
| 1594 | * @throws InvalidArgumentException |
||
| 1595 | */ |
||
| 1596 | public static function readable($value, $message = '') |
||
| 1605 | |||
| 1606 | /** |
||
| 1607 | * @param string $value |
||
| 1608 | * @param string $message |
||
| 1609 | * |
||
| 1610 | * @throws InvalidArgumentException |
||
| 1611 | */ |
||
| 1612 | public static function writable($value, $message = '') |
||
| 1621 | |||
| 1622 | /** |
||
| 1623 | * @param mixed $value |
||
| 1624 | * @param string $message |
||
| 1625 | * |
||
| 1626 | * @throws InvalidArgumentException |
||
| 1627 | */ |
||
| 1628 | 8 | public static function classExists($value, $message = '') |
|
| 1637 | |||
| 1638 | /** |
||
| 1639 | * @psalm-pure |
||
| 1640 | * @psalm-template ExpectedType of object |
||
| 1641 | * @psalm-param class-string<ExpectedType> $class |
||
| 1642 | * @psalm-assert class-string<ExpectedType>|ExpectedType $value |
||
| 1643 | * |
||
| 1644 | * @param mixed $value |
||
| 1645 | * @param string|object $class |
||
| 1646 | * @param string $message |
||
| 1647 | * |
||
| 1648 | * @throws InvalidArgumentException |
||
| 1649 | */ |
||
| 1650 | 8 | public static function subclassOf($value, $class, $message = '') |
|
| 1660 | |||
| 1661 | /** |
||
| 1662 | * @param mixed $value |
||
| 1663 | * @param string $message |
||
| 1664 | * |
||
| 1665 | * @throws InvalidArgumentException |
||
| 1666 | */ |
||
| 1667 | 8 | public static function interfaceExists($value, $message = '') |
|
| 1676 | |||
| 1677 | /** |
||
| 1678 | * @psalm-pure |
||
| 1679 | * @psalm-template ExpectedType of object |
||
| 1680 | * @psalm-param class-string<ExpectedType> $interface |
||
| 1681 | * @psalm-assert class-string<ExpectedType> $value |
||
| 1682 | * |
||
| 1683 | * @param mixed $value |
||
| 1684 | * @param mixed $interface |
||
| 1685 | * @param string $message |
||
| 1686 | * |
||
| 1687 | * @throws InvalidArgumentException |
||
| 1688 | */ |
||
| 1689 | 8 | View Code Duplication | public static function implementsInterface($value, $interface, $message = '') |
| 1699 | |||
| 1700 | /** |
||
| 1701 | * @psalm-pure |
||
| 1702 | * @psalm-param class-string|object $classOrObject |
||
| 1703 | * |
||
| 1704 | * @param string|object $classOrObject |
||
| 1705 | * @param mixed $property |
||
| 1706 | * @param string $message |
||
| 1707 | * |
||
| 1708 | * @throws InvalidArgumentException |
||
| 1709 | */ |
||
| 1710 | 12 | View Code Duplication | public static function propertyExists($classOrObject, $property, $message = '') |
| 1719 | |||
| 1720 | /** |
||
| 1721 | * @psalm-pure |
||
| 1722 | * @psalm-param class-string|object $classOrObject |
||
| 1723 | * |
||
| 1724 | * @param string|object $classOrObject |
||
| 1725 | * @param mixed $property |
||
| 1726 | * @param string $message |
||
| 1727 | * |
||
| 1728 | * @throws InvalidArgumentException |
||
| 1729 | */ |
||
| 1730 | 12 | View Code Duplication | public static function propertyNotExists($classOrObject, $property, $message = '') |
| 1739 | |||
| 1740 | /** |
||
| 1741 | * @psalm-pure |
||
| 1742 | * @psalm-param class-string|object $classOrObject |
||
| 1743 | * |
||
| 1744 | * @param string|object $classOrObject |
||
| 1745 | * @param mixed $method |
||
| 1746 | * @param string $message |
||
| 1747 | * |
||
| 1748 | * @throws InvalidArgumentException |
||
| 1749 | */ |
||
| 1750 | 27 | View Code Duplication | public static function methodExists($classOrObject, $method, $message = '') |
| 1759 | |||
| 1760 | /** |
||
| 1761 | * @psalm-pure |
||
| 1762 | * @psalm-param class-string|object $classOrObject |
||
| 1763 | * |
||
| 1764 | * @param string|object $classOrObject |
||
| 1765 | * @param mixed $method |
||
| 1766 | * @param string $message |
||
| 1767 | * |
||
| 1768 | * @throws InvalidArgumentException |
||
| 1769 | */ |
||
| 1770 | 27 | View Code Duplication | public static function methodNotExists($classOrObject, $method, $message = '') |
| 1779 | |||
| 1780 | /** |
||
| 1781 | * @psalm-pure |
||
| 1782 | * |
||
| 1783 | * @param array $array |
||
| 1784 | * @param string|int $key |
||
| 1785 | * @param string $message |
||
| 1786 | * |
||
| 1787 | * @throws InvalidArgumentException |
||
| 1788 | */ |
||
| 1789 | 12 | View Code Duplication | public static function keyExists($array, $key, $message = '') |
| 1798 | |||
| 1799 | /** |
||
| 1800 | * @psalm-pure |
||
| 1801 | * |
||
| 1802 | * @param array $array |
||
| 1803 | * @param string|int $key |
||
| 1804 | * @param string $message |
||
| 1805 | * |
||
| 1806 | * @throws InvalidArgumentException |
||
| 1807 | */ |
||
| 1808 | 12 | View Code Duplication | public static function keyNotExists($array, $key, $message = '') |
| 1817 | |||
| 1818 | /** |
||
| 1819 | * Checks if a value is a valid array key (int or string). |
||
| 1820 | * |
||
| 1821 | * @psalm-pure |
||
| 1822 | * @psalm-assert array-key $value |
||
| 1823 | * |
||
| 1824 | * @param mixed $value |
||
| 1825 | * @param string $message |
||
| 1826 | * |
||
| 1827 | * @throws InvalidArgumentException |
||
| 1828 | */ |
||
| 1829 | 28 | public static function validArrayKey($value, $message = '') |
|
| 1838 | |||
| 1839 | /** |
||
| 1840 | * Does not check if $array is countable, this can generate a warning on php versions after 7.2. |
||
| 1841 | * |
||
| 1842 | * @param Countable|array $array |
||
| 1843 | * @param int $number |
||
| 1844 | * @param string $message |
||
| 1845 | * |
||
| 1846 | * @throws InvalidArgumentException |
||
| 1847 | */ |
||
| 1848 | 8 | public static function count($array, $number, $message = '') |
|
| 1856 | |||
| 1857 | /** |
||
| 1858 | * Does not check if $array is countable, this can generate a warning on php versions after 7.2. |
||
| 1859 | * |
||
| 1860 | * @param Countable|array $array |
||
| 1861 | * @param int|float $min |
||
| 1862 | * @param string $message |
||
| 1863 | * |
||
| 1864 | * @throws InvalidArgumentException |
||
| 1865 | */ |
||
| 1866 | 12 | View Code Duplication | public static function minCount($array, $min, $message = '') |
| 1876 | |||
| 1877 | /** |
||
| 1878 | * Does not check if $array is countable, this can generate a warning on php versions after 7.2. |
||
| 1879 | * |
||
| 1880 | * @param Countable|array $array |
||
| 1881 | * @param int|float $max |
||
| 1882 | * @param string $message |
||
| 1883 | * |
||
| 1884 | * @throws InvalidArgumentException |
||
| 1885 | */ |
||
| 1886 | 12 | View Code Duplication | public static function maxCount($array, $max, $message = '') |
| 1896 | |||
| 1897 | /** |
||
| 1898 | * Does not check if $array is countable, this can generate a warning on php versions after 7.2. |
||
| 1899 | * |
||
| 1900 | * @param Countable|array $array |
||
| 1901 | * @param int|float $min |
||
| 1902 | * @param int|float $max |
||
| 1903 | * @param string $message |
||
| 1904 | * |
||
| 1905 | * @throws InvalidArgumentException |
||
| 1906 | */ |
||
| 1907 | 20 | public static function countBetween($array, $min, $max, $message = '') |
|
| 1920 | |||
| 1921 | /** |
||
| 1922 | * @psalm-pure |
||
| 1923 | * @psalm-assert list $array |
||
| 1924 | * |
||
| 1925 | * @param mixed $array |
||
| 1926 | * @param string $message |
||
| 1927 | * |
||
| 1928 | * @throws InvalidArgumentException |
||
| 1929 | */ |
||
| 1930 | 80 | View Code Duplication | public static function isList($array, $message = '') |
| 1938 | |||
| 1939 | /** |
||
| 1940 | * @psalm-pure |
||
| 1941 | * @psalm-assert list $array |
||
| 1942 | * @psalm-assert !empty $array |
||
| 1943 | * |
||
| 1944 | * @param mixed $array |
||
| 1945 | * @param string $message |
||
| 1946 | * |
||
| 1947 | * @throws InvalidArgumentException |
||
| 1948 | */ |
||
| 1949 | 40 | public static function isNonEmptyList($array, $message = '') |
|
| 1954 | |||
| 1955 | /** |
||
| 1956 | * @psalm-pure |
||
| 1957 | * @psalm-template T |
||
| 1958 | * @psalm-param mixed|array<T> $array |
||
| 1959 | * @psalm-assert array<string, T> $array |
||
| 1960 | * |
||
| 1961 | * @param mixed $array |
||
| 1962 | * @param string $message |
||
| 1963 | * |
||
| 1964 | * @throws InvalidArgumentException |
||
| 1965 | */ |
||
| 1966 | 32 | public static function isMap($array, $message = '') |
|
| 1977 | |||
| 1978 | /** |
||
| 1979 | * @psalm-pure |
||
| 1980 | * @psalm-template T |
||
| 1981 | * @psalm-param mixed|array<T> $array |
||
| 1982 | * @psalm-assert array<string, T> $array |
||
| 1983 | * @psalm-assert !empty $array |
||
| 1984 | * |
||
| 1985 | * @param mixed $array |
||
| 1986 | * @param string $message |
||
| 1987 | * |
||
| 1988 | * @throws InvalidArgumentException |
||
| 1989 | */ |
||
| 1990 | 16 | public static function isNonEmptyMap($array, $message = '') |
|
| 1995 | |||
| 1996 | /** |
||
| 1997 | * @psalm-pure |
||
| 1998 | * |
||
| 1999 | * @param string $value |
||
| 2000 | * @param string $message |
||
| 2001 | * |
||
| 2002 | * @throws InvalidArgumentException |
||
| 2003 | */ |
||
| 2004 | 56 | public static function uuid($value, $message = '') |
|
| 2021 | |||
| 2022 | /** |
||
| 2023 | * @psalm-param class-string<Throwable> |
||
| 2024 | * |
||
| 2025 | * @param Closure $expression |
||
| 2026 | * @param string $class |
||
| 2027 | * @param string $message |
||
| 2028 | * |
||
| 2029 | * @throws InvalidArgumentException |
||
| 2030 | */ |
||
| 2031 | 24 | public static function throws(Closure $expression, $class = 'Exception', $message = '') |
|
| 2057 | |||
| 2058 | /** |
||
| 2059 | * @throws BadMethodCallException |
||
| 2060 | */ |
||
| 2061 | 1568 | public static function __callStatic($name, $arguments) |
|
| 2089 | |||
| 2090 | /** |
||
| 2091 | * @param mixed $value |
||
| 2092 | * |
||
| 2093 | * @return string |
||
| 2094 | */ |
||
| 2095 | 718 | protected static function valueToString($value) |
|
| 2131 | |||
| 2132 | /** |
||
| 2133 | * @param mixed $value |
||
| 2134 | * |
||
| 2135 | * @return string |
||
| 2136 | */ |
||
| 2137 | 251 | protected static function typeToString($value) |
|
| 2141 | |||
| 2142 | 168 | protected static function strlen($value) |
|
| 2154 | |||
| 2155 | /** |
||
| 2156 | * @param string $message |
||
| 2157 | * |
||
| 2158 | * @throws InvalidArgumentException |
||
| 2159 | * |
||
| 2160 | * @psalm-pure this method is not supposed to perform side-effects |
||
| 2161 | */ |
||
| 2162 | 1032 | protected static function reportInvalidArgument($message) |
|
| 2166 | |||
| 2167 | private function __construct() |
||
| 2170 | } |
||
| 2171 |