123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010 |
- <?php
- /*
- * This file is part of the webmozart/assert package.
- *
- * (c) Bernhard Schussek <bschussek@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Webmozart\Assert;
- use ArrayAccess;
- use BadMethodCallException;
- use Closure;
- use Countable;
- use Exception;
- use InvalidArgumentException;
- use ResourceBundle;
- use SimpleXMLElement;
- use Throwable;
- use Traversable;
- /**
- * Efficient assertions to validate the input/output of your methods.
- *
- * @method static void nullOrString($value, $message = '')
- * @method static void nullOrStringNotEmpty($value, $message = '')
- * @method static void nullOrInteger($value, $message = '')
- * @method static void nullOrIntegerish($value, $message = '')
- * @method static void nullOrFloat($value, $message = '')
- * @method static void nullOrNumeric($value, $message = '')
- * @method static void nullOrNatural($value, $message = '')
- * @method static void nullOrBoolean($value, $message = '')
- * @method static void nullOrScalar($value, $message = '')
- * @method static void nullOrObject($value, $message = '')
- * @method static void nullOrResource($value, $type = null, $message = '')
- * @method static void nullOrIsCallable($value, $message = '')
- * @method static void nullOrIsArray($value, $message = '')
- * @method static void nullOrIsTraversable($value, $message = '')
- * @method static void nullOrIsArrayAccessible($value, $message = '')
- * @method static void nullOrIsCountable($value, $message = '')
- * @method static void nullOrIsIterable($value, $message = '')
- * @method static void nullOrIsInstanceOf($value, $class, $message = '')
- * @method static void nullOrNotInstanceOf($value, $class, $message = '')
- * @method static void nullOrIsInstanceOfAny($value, $classes, $message = '')
- * @method static void nullOrIsAOf($value, $classes, $message = '')
- * @method static void nullOrIsAnyOf($value, $classes, $message = '')
- * @method static void nullOrIsNotA($value, $classes, $message = '')
- * @method static void nullOrIsEmpty($value, $message = '')
- * @method static void nullOrNotEmpty($value, $message = '')
- * @method static void nullOrTrue($value, $message = '')
- * @method static void nullOrFalse($value, $message = '')
- * @method static void nullOrNotFalse($value, $message = '')
- * @method static void nullOrIp($value, $message = '')
- * @method static void nullOrIpv4($value, $message = '')
- * @method static void nullOrIpv6($value, $message = '')
- * @method static void nullOrEmail($value, $message = '')
- * @method static void nullOrUniqueValues($values, $message = '')
- * @method static void nullOrEq($value, $expect, $message = '')
- * @method static void nullOrNotEq($value, $expect, $message = '')
- * @method static void nullOrSame($value, $expect, $message = '')
- * @method static void nullOrNotSame($value, $expect, $message = '')
- * @method static void nullOrGreaterThan($value, $limit, $message = '')
- * @method static void nullOrGreaterThanEq($value, $limit, $message = '')
- * @method static void nullOrLessThan($value, $limit, $message = '')
- * @method static void nullOrLessThanEq($value, $limit, $message = '')
- * @method static void nullOrRange($value, $min, $max, $message = '')
- * @method static void nullOrOneOf($value, $values, $message = '')
- * @method static void nullOrContains($value, $subString, $message = '')
- * @method static void nullOrNotContains($value, $subString, $message = '')
- * @method static void nullOrNotWhitespaceOnly($value, $message = '')
- * @method static void nullOrStartsWith($value, $prefix, $message = '')
- * @method static void nullOrStartsWithLetter($value, $message = '')
- * @method static void nullOrEndsWith($value, $suffix, $message = '')
- * @method static void nullOrRegex($value, $pattern, $message = '')
- * @method static void nullOrNotRegex($value, $pattern, $message = '')
- * @method static void nullOrUnicodeLetters($value, $message = '')
- * @method static void nullOrAlpha($value, $message = '')
- * @method static void nullOrDigits($value, $message = '')
- * @method static void nullOrAlnum($value, $message = '')
- * @method static void nullOrLower($value, $message = '')
- * @method static void nullOrUpper($value, $message = '')
- * @method static void nullOrLength($value, $length, $message = '')
- * @method static void nullOrMinLength($value, $min, $message = '')
- * @method static void nullOrMaxLength($value, $max, $message = '')
- * @method static void nullOrLengthBetween($value, $min, $max, $message = '')
- * @method static void nullOrFileExists($value, $message = '')
- * @method static void nullOrFile($value, $message = '')
- * @method static void nullOrDirectory($value, $message = '')
- * @method static void nullOrReadable($value, $message = '')
- * @method static void nullOrWritable($value, $message = '')
- * @method static void nullOrClassExists($value, $message = '')
- * @method static void nullOrSubclassOf($value, $class, $message = '')
- * @method static void nullOrInterfaceExists($value, $message = '')
- * @method static void nullOrImplementsInterface($value, $interface, $message = '')
- * @method static void nullOrPropertyExists($value, $property, $message = '')
- * @method static void nullOrPropertyNotExists($value, $property, $message = '')
- * @method static void nullOrMethodExists($value, $method, $message = '')
- * @method static void nullOrMethodNotExists($value, $method, $message = '')
- * @method static void nullOrKeyExists($value, $key, $message = '')
- * @method static void nullOrKeyNotExists($value, $key, $message = '')
- * @method static void nullOrValidArrayKey($value, $message = '')
- * @method static void nullOrCount($value, $key, $message = '')
- * @method static void nullOrMinCount($value, $min, $message = '')
- * @method static void nullOrMaxCount($value, $max, $message = '')
- * @method static void nullOrIsList($value, $message = '')
- * @method static void nullOrIsNonEmptyList($value, $message = '')
- * @method static void nullOrIsMap($value, $message = '')
- * @method static void nullOrIsNonEmptyMap($value, $message = '')
- * @method static void nullOrCountBetween($value, $min, $max, $message = '')
- * @method static void nullOrUuid($values, $message = '')
- * @method static void nullOrThrows($expression, $class = 'Exception', $message = '')
- * @method static void allString($values, $message = '')
- * @method static void allStringNotEmpty($values, $message = '')
- * @method static void allInteger($values, $message = '')
- * @method static void allIntegerish($values, $message = '')
- * @method static void allFloat($values, $message = '')
- * @method static void allNumeric($values, $message = '')
- * @method static void allNatural($values, $message = '')
- * @method static void allBoolean($values, $message = '')
- * @method static void allScalar($values, $message = '')
- * @method static void allObject($values, $message = '')
- * @method static void allResource($values, $type = null, $message = '')
- * @method static void allIsCallable($values, $message = '')
- * @method static void allIsArray($values, $message = '')
- * @method static void allIsTraversable($values, $message = '')
- * @method static void allIsArrayAccessible($values, $message = '')
- * @method static void allIsCountable($values, $message = '')
- * @method static void allIsIterable($values, $message = '')
- * @method static void allIsInstanceOf($values, $class, $message = '')
- * @method static void allNotInstanceOf($values, $class, $message = '')
- * @method static void allIsInstanceOfAny($values, $classes, $message = '')
- * @method static void allIsAOf($values, $class, $message = '')
- * @method static void allIsAnyOf($values, $class, $message = '')
- * @method static void allIsNotA($values, $class, $message = '')
- * @method static void allNull($values, $message = '')
- * @method static void allNotNull($values, $message = '')
- * @method static void allIsEmpty($values, $message = '')
- * @method static void allNotEmpty($values, $message = '')
- * @method static void allTrue($values, $message = '')
- * @method static void allFalse($values, $message = '')
- * @method static void allNotFalse($values, $message = '')
- * @method static void allIp($values, $message = '')
- * @method static void allIpv4($values, $message = '')
- * @method static void allIpv6($values, $message = '')
- * @method static void allEmail($values, $message = '')
- * @method static void allUniqueValues($values, $message = '')
- * @method static void allEq($values, $expect, $message = '')
- * @method static void allNotEq($values, $expect, $message = '')
- * @method static void allSame($values, $expect, $message = '')
- * @method static void allNotSame($values, $expect, $message = '')
- * @method static void allGreaterThan($values, $limit, $message = '')
- * @method static void allGreaterThanEq($values, $limit, $message = '')
- * @method static void allLessThan($values, $limit, $message = '')
- * @method static void allLessThanEq($values, $limit, $message = '')
- * @method static void allRange($values, $min, $max, $message = '')
- * @method static void allOneOf($values, $values, $message = '')
- * @method static void allContains($values, $subString, $message = '')
- * @method static void allNotContains($values, $subString, $message = '')
- * @method static void allNotWhitespaceOnly($values, $message = '')
- * @method static void allStartsWith($values, $prefix, $message = '')
- * @method static void allStartsWithLetter($values, $message = '')
- * @method static void allEndsWith($values, $suffix, $message = '')
- * @method static void allRegex($values, $pattern, $message = '')
- * @method static void allNotRegex($values, $pattern, $message = '')
- * @method static void allUnicodeLetters($values, $message = '')
- * @method static void allAlpha($values, $message = '')
- * @method static void allDigits($values, $message = '')
- * @method static void allAlnum($values, $message = '')
- * @method static void allLower($values, $message = '')
- * @method static void allUpper($values, $message = '')
- * @method static void allLength($values, $length, $message = '')
- * @method static void allMinLength($values, $min, $message = '')
- * @method static void allMaxLength($values, $max, $message = '')
- * @method static void allLengthBetween($values, $min, $max, $message = '')
- * @method static void allFileExists($values, $message = '')
- * @method static void allFile($values, $message = '')
- * @method static void allDirectory($values, $message = '')
- * @method static void allReadable($values, $message = '')
- * @method static void allWritable($values, $message = '')
- * @method static void allClassExists($values, $message = '')
- * @method static void allSubclassOf($values, $class, $message = '')
- * @method static void allInterfaceExists($values, $message = '')
- * @method static void allImplementsInterface($values, $interface, $message = '')
- * @method static void allPropertyExists($values, $property, $message = '')
- * @method static void allPropertyNotExists($values, $property, $message = '')
- * @method static void allMethodExists($values, $method, $message = '')
- * @method static void allMethodNotExists($values, $method, $message = '')
- * @method static void allKeyExists($values, $key, $message = '')
- * @method static void allKeyNotExists($values, $key, $message = '')
- * @method static void allValidArrayKey($values, $message = '')
- * @method static void allCount($values, $key, $message = '')
- * @method static void allMinCount($values, $min, $message = '')
- * @method static void allMaxCount($values, $max, $message = '')
- * @method static void allCountBetween($values, $min, $max, $message = '')
- * @method static void allIsList($values, $message = '')
- * @method static void allIsNonEmptyList($values, $message = '')
- * @method static void allIsMap($values, $message = '')
- * @method static void allIsNonEmptyMap($values, $message = '')
- * @method static void allUuid($values, $message = '')
- * @method static void allThrows($expressions, $class = 'Exception', $message = '')
- *
- * @since 1.0
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
- class Assert
- {
- /**
- * @psalm-assert string $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function string($value, $message = '')
- {
- if (!\is_string($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a string. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function stringNotEmpty($value, $message = '')
- {
- static::string($value, $message);
- static::notEq($value, '', $message);
- }
- /**
- * @psalm-assert int $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function integer($value, $message = '')
- {
- if (!\is_int($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an integer. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert numeric $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function integerish($value, $message = '')
- {
- if (!\is_numeric($value) || $value != (int) $value) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an integerish value. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert float $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function float($value, $message = '')
- {
- if (!\is_float($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a float. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert numeric $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function numeric($value, $message = '')
- {
- if (!\is_numeric($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a numeric. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert int $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function natural($value, $message = '')
- {
- if (!\is_int($value) || $value < 0) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a non-negative integer. Got %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @psalm-assert bool $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function boolean($value, $message = '')
- {
- if (!\is_bool($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a boolean. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert scalar $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function scalar($value, $message = '')
- {
- if (!\is_scalar($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a scalar. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert object $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function object($value, $message = '')
- {
- if (!\is_object($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an object. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert resource $value
- *
- * @param mixed $value
- * @param string|null $type type of resource this should be. @see https://www.php.net/manual/en/function.get-resource-type.php
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function resource($value, $type = null, $message = '')
- {
- if (!\is_resource($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a resource. Got: %s',
- static::typeToString($value)
- ));
- }
- if ($type && $type !== \get_resource_type($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a resource of type %2$s. Got: %s',
- static::typeToString($value),
- $type
- ));
- }
- }
- /**
- * @psalm-assert callable $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isCallable($value, $message = '')
- {
- if (!\is_callable($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a callable. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert array $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isArray($value, $message = '')
- {
- if (!\is_array($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an array. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert iterable $value
- *
- * @deprecated use "isIterable" or "isInstanceOf" instead
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isTraversable($value, $message = '')
- {
- @\trigger_error(
- \sprintf(
- 'The "%s" assertion is deprecated. You should stop using it, as it will soon be removed in 2.0 version. Use "isIterable" or "isInstanceOf" instead.',
- __METHOD__
- ),
- \E_USER_DEPRECATED
- );
- if (!\is_array($value) && !($value instanceof Traversable)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a traversable. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isArrayAccessible($value, $message = '')
- {
- if (!\is_array($value) && !($value instanceof ArrayAccess)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an array accessible. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert countable $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isCountable($value, $message = '')
- {
- if (
- !\is_array($value)
- && !($value instanceof Countable)
- && !($value instanceof ResourceBundle)
- && !($value instanceof SimpleXMLElement)
- ) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a countable. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-assert iterable $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isIterable($value, $message = '')
- {
- if (!\is_array($value) && !($value instanceof Traversable)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an iterable. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * @psalm-template ExpectedType of object
- * @psalm-param class-string<ExpectedType> $class
- * @psalm-assert ExpectedType $value
- *
- * @param mixed $value
- * @param string|object $class
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isInstanceOf($value, $class, $message = '')
- {
- if (!($value instanceof $class)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an instance of %2$s. Got: %s',
- static::typeToString($value),
- $class
- ));
- }
- }
- /**
- * @psalm-template ExpectedType of object
- * @psalm-param class-string<ExpectedType> $class
- * @psalm-assert !ExpectedType $value
- *
- * @param mixed $value
- * @param string|object $class
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function notInstanceOf($value, $class, $message = '')
- {
- if ($value instanceof $class) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an instance other than %2$s. Got: %s',
- static::typeToString($value),
- $class
- ));
- }
- }
- /**
- * @param mixed $value
- * @param array<object|string> $classes
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isInstanceOfAny($value, array $classes, $message = '')
- {
- foreach ($classes as $class) {
- if ($value instanceof $class) {
- return;
- }
- }
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an instance of any of %2$s. Got: %s',
- static::typeToString($value),
- \implode(', ', \array_map(array('static', 'valueToString'), $classes))
- ));
- }
- /**
- * @param object|string $value
- * @param string $class
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isAOf($value, $class, $message = '')
- {
- static::string($class, 'Expected class as a string. Got: %s');
- if (!\is_a($value, $class, \is_string($value))) {
- static::reportInvalidArgument(sprintf(
- $message ?: 'Expected an instance of this class or to this class among his parents %2$s. Got: %s',
- static::typeToString($value),
- $class
- ));
- }
- }
- /**
- * @param object|string $value
- * @param string $class
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isNotA($value, $class, $message = '')
- {
- static::string($class, 'Expected class as a string. Got: %s');
- if (\is_a($value, $class, \is_string($value))) {
- static::reportInvalidArgument(sprintf(
- $message ?: 'Expected an instance of this class or to this class among his parents other than %2$s. Got: %s',
- static::typeToString($value),
- $class
- ));
- }
- }
- /**
- * @param object|string $value
- * @param string[] $classes
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isAnyOf($value, array $classes, $message = '')
- {
- foreach ($classes as $class) {
- static::string($class, 'Expected class as a string. Got: %s');
- if (\is_a($value, $class, \is_string($value))) {
- return;
- }
- }
- static::reportInvalidArgument(sprintf(
- $message ?: 'Expected an any of instance of this class or to this class among his parents other than %2$s. Got: %s',
- static::typeToString($value),
- \implode(', ', \array_map(array('static', 'valueToString'), $classes))
- ));
- }
- /**
- * @psalm-assert empty $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isEmpty($value, $message = '')
- {
- if (!empty($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an empty value. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @psalm-assert !empty $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function notEmpty($value, $message = '')
- {
- if (empty($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a non-empty value. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @psalm-assert null $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function null($value, $message = '')
- {
- if (null !== $value) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected null. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @psalm-assert !null $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function notNull($value, $message = '')
- {
- if (null === $value) {
- static::reportInvalidArgument(
- $message ?: 'Expected a value other than null.'
- );
- }
- }
- /**
- * @psalm-assert true $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function true($value, $message = '')
- {
- if (true !== $value) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to be true. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @psalm-assert false $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function false($value, $message = '')
- {
- if (false !== $value) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to be false. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @psalm-assert !false $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function notFalse($value, $message = '')
- {
- if (false === $value) {
- static::reportInvalidArgument(
- $message ?: 'Expected a value other than false.'
- );
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function ip($value, $message = '')
- {
- if (false === \filter_var($value, \FILTER_VALIDATE_IP)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to be an IP. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function ipv4($value, $message = '')
- {
- if (false === \filter_var($value, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to be an IPv4. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function ipv6($value, $message = '')
- {
- if (false === \filter_var($value, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV6)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to be an IPv6. Got %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function email($value, $message = '')
- {
- if (false === \filter_var($value, FILTER_VALIDATE_EMAIL)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to be a valid e-mail address. Got %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * Does non strict comparisons on the items, so ['3', 3] will not pass the assertion.
- *
- * @param array $values
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function uniqueValues(array $values, $message = '')
- {
- $allValues = \count($values);
- $uniqueValues = \count(\array_unique($values));
- if ($allValues !== $uniqueValues) {
- $difference = $allValues - $uniqueValues;
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an array of unique values, but %s of them %s duplicated',
- $difference,
- (1 === $difference ? 'is' : 'are')
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $expect
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function eq($value, $expect, $message = '')
- {
- if ($expect != $value) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value equal to %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($expect)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $expect
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function notEq($value, $expect, $message = '')
- {
- if ($expect == $value) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a different value than %s.',
- static::valueToString($expect)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $expect
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function same($value, $expect, $message = '')
- {
- if ($expect !== $value) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value identical to %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($expect)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $expect
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function notSame($value, $expect, $message = '')
- {
- if ($expect === $value) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value not identical to %s.',
- static::valueToString($expect)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $limit
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function greaterThan($value, $limit, $message = '')
- {
- if ($value <= $limit) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value greater than %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($limit)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $limit
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function greaterThanEq($value, $limit, $message = '')
- {
- if ($value < $limit) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value greater than or equal to %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($limit)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $limit
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function lessThan($value, $limit, $message = '')
- {
- if ($value >= $limit) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value less than %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($limit)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $limit
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function lessThanEq($value, $limit, $message = '')
- {
- if ($value > $limit) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value less than or equal to %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($limit)
- ));
- }
- }
- /**
- * Inclusive range, so Assert::(3, 3, 5) passes.
- *
- * @param mixed $value
- * @param mixed $min
- * @param mixed $max
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function range($value, $min, $max, $message = '')
- {
- if ($value < $min || $value > $max) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value between %2$s and %3$s. Got: %s',
- static::valueToString($value),
- static::valueToString($min),
- static::valueToString($max)
- ));
- }
- }
- /**
- * Does strict comparison, so Assert::oneOf(3, ['3']) does not pass the assertion.
- *
- * @param mixed $value
- * @param array $values
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function oneOf($value, array $values, $message = '')
- {
- if (!\in_array($value, $values, true)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected one of: %2$s. Got: %s',
- static::valueToString($value),
- \implode(', ', \array_map(array('static', 'valueToString'), $values))
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $subString
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function contains($value, $subString, $message = '')
- {
- if (false === \strpos($value, $subString)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($subString)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $subString
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function notContains($value, $subString, $message = '')
- {
- if (false !== \strpos($value, $subString)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: '%2$s was not expected to be contained in a value. Got: %s',
- static::valueToString($value),
- static::valueToString($subString)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function notWhitespaceOnly($value, $message = '')
- {
- if (\preg_match('/^\s*$/', $value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a non-whitespace string. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $prefix
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function startsWith($value, $prefix, $message = '')
- {
- if (0 !== \strpos($value, $prefix)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to start with %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($prefix)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function startsWithLetter($value, $message = '')
- {
- static::string($value);
- $valid = isset($value[0]);
- if ($valid) {
- $locale = \setlocale(LC_CTYPE, 0);
- \setlocale(LC_CTYPE, 'C');
- $valid = \ctype_alpha($value[0]);
- \setlocale(LC_CTYPE, $locale);
- }
- if (!$valid) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to start with a letter. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $suffix
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function endsWith($value, $suffix, $message = '')
- {
- if ($suffix !== \substr($value, -\strlen($suffix))) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to end with %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($suffix)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $pattern
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function regex($value, $pattern, $message = '')
- {
- if (!\preg_match($pattern, $value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'The value %s does not match the expected pattern.',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $pattern
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function notRegex($value, $pattern, $message = '')
- {
- if (\preg_match($pattern, $value, $matches, PREG_OFFSET_CAPTURE)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'The value %s matches the pattern %s (at offset %d).',
- static::valueToString($value),
- static::valueToString($pattern),
- $matches[0][1]
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function unicodeLetters($value, $message = '')
- {
- static::string($value);
- if (!\preg_match('/^\p{L}+$/u', $value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain only Unicode letters. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function alpha($value, $message = '')
- {
- static::string($value);
- $locale = \setlocale(LC_CTYPE, 0);
- \setlocale(LC_CTYPE, 'C');
- $valid = !\ctype_alpha($value);
- \setlocale(LC_CTYPE, $locale);
- if ($valid) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain only letters. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function digits($value, $message = '')
- {
- $locale = \setlocale(LC_CTYPE, 0);
- \setlocale(LC_CTYPE, 'C');
- $valid = !\ctype_digit($value);
- \setlocale(LC_CTYPE, $locale);
- if ($valid) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain digits only. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function alnum($value, $message = '')
- {
- $locale = \setlocale(LC_CTYPE, 0);
- \setlocale(LC_CTYPE, 'C');
- $valid = !\ctype_alnum($value);
- \setlocale(LC_CTYPE, $locale);
- if ($valid) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain letters and digits only. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function lower($value, $message = '')
- {
- $locale = \setlocale(LC_CTYPE, 0);
- \setlocale(LC_CTYPE, 'C');
- $valid = !\ctype_lower($value);
- \setlocale(LC_CTYPE, $locale);
- if ($valid) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain lowercase characters only. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function upper($value, $message = '')
- {
- $locale = \setlocale(LC_CTYPE, 0);
- \setlocale(LC_CTYPE, 'C');
- $valid = !\ctype_upper($value);
- \setlocale(LC_CTYPE, $locale);
- if ($valid) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain uppercase characters only. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $length
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function length($value, $length, $message = '')
- {
- if ($length !== static::strlen($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain %2$s characters. Got: %s',
- static::valueToString($value),
- $length
- ));
- }
- }
- /**
- * Inclusive min.
- *
- * @param mixed $value
- * @param mixed $min
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function minLength($value, $min, $message = '')
- {
- if (static::strlen($value) < $min) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain at least %2$s characters. Got: %s',
- static::valueToString($value),
- $min
- ));
- }
- }
- /**
- * Inclusive max.
- *
- * @param mixed $value
- * @param mixed $max
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function maxLength($value, $max, $message = '')
- {
- if (static::strlen($value) > $max) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain at most %2$s characters. Got: %s',
- static::valueToString($value),
- $max
- ));
- }
- }
- /**
- * Inclusive , so Assert::lengthBetween('asd', 3, 5); passes the assertion.
- *
- * @param mixed $value
- * @param mixed $min
- * @param mixed $max
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function lengthBetween($value, $min, $max, $message = '')
- {
- $length = static::strlen($value);
- if ($length < $min || $length > $max) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a value to contain between %2$s and %3$s characters. Got: %s',
- static::valueToString($value),
- $min,
- $max
- ));
- }
- }
- /**
- * Will also pass if $value is a directory, use Assert::file() instead if you need to be sure it is a file.
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function fileExists($value, $message = '')
- {
- static::string($value);
- if (!\file_exists($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'The file %s does not exist.',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function file($value, $message = '')
- {
- static::fileExists($value, $message);
- if (!\is_file($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'The path %s is not a file.',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function directory($value, $message = '')
- {
- static::fileExists($value, $message);
- if (!\is_dir($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'The path %s is no directory.',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function readable($value, $message = '')
- {
- if (!\is_readable($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'The path %s is not readable.',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function writable($value, $message = '')
- {
- if (!\is_writable($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'The path %s is not writable.',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @psalm-assert class-string $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function classExists($value, $message = '')
- {
- if (!\class_exists($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an existing class name. Got: %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param string|object $class
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function subclassOf($value, $class, $message = '')
- {
- if (!\is_subclass_of($value, $class)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected a sub-class of %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($class)
- ));
- }
- }
- /**
- * @psalm-assert class-string $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function interfaceExists($value, $message = '')
- {
- if (!\interface_exists($value)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an existing interface name. got %s',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param mixed $value
- * @param mixed $interface
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function implementsInterface($value, $interface, $message = '')
- {
- if (!\in_array($interface, \class_implements($value))) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an implementation of %2$s. Got: %s',
- static::valueToString($value),
- static::valueToString($interface)
- ));
- }
- }
- /**
- * @param string|object $classOrObject
- * @param mixed $property
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function propertyExists($classOrObject, $property, $message = '')
- {
- if (!\property_exists($classOrObject, $property)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected the property %s to exist.',
- static::valueToString($property)
- ));
- }
- }
- /**
- * @param string|object $classOrObject
- * @param mixed $property
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function propertyNotExists($classOrObject, $property, $message = '')
- {
- if (\property_exists($classOrObject, $property)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected the property %s to not exist.',
- static::valueToString($property)
- ));
- }
- }
- /**
- * @param string|object $classOrObject
- * @param mixed $method
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function methodExists($classOrObject, $method, $message = '')
- {
- if (!\method_exists($classOrObject, $method)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected the method %s to exist.',
- static::valueToString($method)
- ));
- }
- }
- /**
- * @param string|object $classOrObject
- * @param mixed $method
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function methodNotExists($classOrObject, $method, $message = '')
- {
- if (\method_exists($classOrObject, $method)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected the method %s to not exist.',
- static::valueToString($method)
- ));
- }
- }
- /**
- * @param array $array
- * @param string|int $key
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function keyExists($array, $key, $message = '')
- {
- if (!(isset($array[$key]) || \array_key_exists($key, $array))) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected the key %s to exist.',
- static::valueToString($key)
- ));
- }
- }
- /**
- * @param array $array
- * @param string|int $key
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function keyNotExists($array, $key, $message = '')
- {
- if (isset($array[$key]) || \array_key_exists($key, $array)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected the key %s to not exist.',
- static::valueToString($key)
- ));
- }
- }
- /**
- * Checks if a value is a valid array key (int or string).
- *
- * @psalm-assert array-key $value
- *
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function validArrayKey($value, $message = '')
- {
- if (!(\is_int($value) || \is_string($value))) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected string or integer. Got: %s',
- static::typeToString($value)
- ));
- }
- }
- /**
- * Does not check if $array is countable, this can generate a warning on php versions after 7.2.
- *
- * @param mixed $array
- * @param mixed $number
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function count($array, $number, $message = '')
- {
- static::eq(
- \count($array),
- $number,
- $message ?: \sprintf('Expected an array to contain %d elements. Got: %d.', $number, \count($array))
- );
- }
- /**
- * Does not check if $array is countable, this can generate a warning on php versions after 7.2.
- *
- * @param mixed $array
- * @param mixed $min
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function minCount($array, $min, $message = '')
- {
- if (\count($array) < $min) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an array to contain at least %2$d elements. Got: %d',
- \count($array),
- $min
- ));
- }
- }
- /**
- * Does not check if $array is countable, this can generate a warning on php versions after 7.2.
- *
- * @param mixed $array
- * @param mixed $max
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function maxCount($array, $max, $message = '')
- {
- if (\count($array) > $max) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an array to contain at most %2$d elements. Got: %d',
- \count($array),
- $max
- ));
- }
- }
- /**
- * Does not check if $array is countable, this can generate a warning on php versions after 7.2.
- *
- * @param mixed $array
- * @param mixed $min
- * @param mixed $max
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function countBetween($array, $min, $max, $message = '')
- {
- $count = \count($array);
- if ($count < $min || $count > $max) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Expected an array to contain between %2$d and %3$d elements. Got: %d',
- $count,
- $min,
- $max
- ));
- }
- }
- /**
- * @psalm-assert list $array
- *
- * @param mixed $array
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isList($array, $message = '')
- {
- if (!\is_array($array) || $array !== \array_values($array)) {
- static::reportInvalidArgument(
- $message ?: 'Expected list - non-associative array.'
- );
- }
- }
- /**
- * @psalm-assert non-empty-list $array
- *
- * @param mixed $array
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isNonEmptyList($array, $message = '')
- {
- static::isList($array, $message);
- static::notEmpty($array, $message);
- }
- /**
- * @param mixed $array
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isMap($array, $message = '')
- {
- if (
- !\is_array($array) ||
- \array_keys($array) !== \array_filter(\array_keys($array), '\is_string')
- ) {
- static::reportInvalidArgument(
- $message ?: 'Expected map - associative array with string keys.'
- );
- }
- }
- /**
- * @param mixed $array
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function isNonEmptyMap($array, $message = '')
- {
- static::isMap($array, $message);
- static::notEmpty($array, $message);
- }
- /**
- * @param mixed $value
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function uuid($value, $message = '')
- {
- $value = \str_replace(array('urn:', 'uuid:', '{', '}'), '', $value);
- // The nil UUID is special form of UUID that is specified to have all
- // 128 bits set to zero.
- if ('00000000-0000-0000-0000-000000000000' === $value) {
- return;
- }
- 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)) {
- static::reportInvalidArgument(\sprintf(
- $message ?: 'Value %s is not a valid UUID.',
- static::valueToString($value)
- ));
- }
- }
- /**
- * @param Closure $expression
- * @param string|object $class
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- public static function throws(Closure $expression, $class = 'Exception', $message = '')
- {
- static::string($class);
- $actual = 'none';
- try {
- $expression();
- } catch (Exception $e) {
- $actual = \get_class($e);
- if ($e instanceof $class) {
- return;
- }
- } catch (Throwable $e) {
- $actual = \get_class($e);
- if ($e instanceof $class) {
- return;
- }
- }
- static::reportInvalidArgument($message ?: \sprintf(
- 'Expected to throw "%s", got "%s"',
- $class,
- $actual
- ));
- }
- /**
- * @throws BadMethodCallException
- */
- public static function __callStatic($name, $arguments)
- {
- if ('nullOr' === \substr($name, 0, 6)) {
- if (null !== $arguments[0]) {
- $method = \lcfirst(\substr($name, 6));
- \call_user_func_array(array('static', $method), $arguments);
- }
- return;
- }
- if ('all' === \substr($name, 0, 3)) {
- static::isIterable($arguments[0]);
- $method = \lcfirst(\substr($name, 3));
- $args = $arguments;
- foreach ($arguments[0] as $entry) {
- $args[0] = $entry;
- \call_user_func_array(array('static', $method), $args);
- }
- return;
- }
- throw new BadMethodCallException('No such method: '.$name);
- }
- /**
- * @param mixed $value
- *
- * @return string
- */
- protected static function valueToString($value)
- {
- if (null === $value) {
- return 'null';
- }
- if (true === $value) {
- return 'true';
- }
- if (false === $value) {
- return 'false';
- }
- if (\is_array($value)) {
- return 'array';
- }
- if (\is_object($value)) {
- if (\method_exists($value, '__toString')) {
- return \get_class($value).': '.self::valueToString($value->__toString());
- }
- return \get_class($value);
- }
- if (\is_resource($value)) {
- return 'resource';
- }
- if (\is_string($value)) {
- return '"'.$value.'"';
- }
- return (string) $value;
- }
- /**
- * @param mixed $value
- *
- * @return string
- */
- protected static function typeToString($value)
- {
- return \is_object($value) ? \get_class($value) : \gettype($value);
- }
- protected static function strlen($value)
- {
- if (!\function_exists('mb_detect_encoding')) {
- return \strlen($value);
- }
- if (false === $encoding = \mb_detect_encoding($value)) {
- return \strlen($value);
- }
- return \mb_strlen($value, $encoding);
- }
- /**
- * @param string $message
- *
- * @throws InvalidArgumentException
- */
- protected static function reportInvalidArgument($message)
- {
- throw new InvalidArgumentException($message);
- }
- private function __construct()
- {
- }
- }
|