Created
September 4, 2019 09:52
-
-
Save zerkms/37c88a4a6df4ac12e964dfe70853aa39 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/* | |
* This file is part of the webmozart/assert package. | |
* | |
* (c) Bernhard Schussek <[email protected]> | |
* | |
* 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 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 nullOrIsEmpty($value, $message = '') | |
* @method static void nullOrNotEmpty($value, $message = '') | |
* @method static void nullOrTrue($value, $message = '') | |
* @method static void nullOrFalse($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 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 nullOrIsMap($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 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 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 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 allIsMap($values, $message = '') | |
* @method static void allUuid($values, $message = '') | |
* @method static void allThrows($expressions, $class = 'Exception', $message = '') | |
* | |
* @since 1.0 | |
* | |
* @author Bernhard Schussek <[email protected]> | |
*/ | |
class Assert | |
{ | |
/** | |
* @psalm-assert string $value | |
* | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function string($value, $message = '') | |
{ | |
if (!\is_string($value)) { | |
static::reportInvalidArgument(\sprintf( | |
$message ?: 'Expected a string. Got: %s', | |
static::typeToString($value) | |
)); | |
} | |
} | |
/** | |
* @psalm-assert string $value | |
* | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function stringNotEmpty($value, $message = '') | |
{ | |
static::string($value, $message); | |
static::notEq($value, '', $message); | |
} | |
/** | |
* @psalm-assert int $value | |
* | |
* @param mixed $value | |
* @param string $message | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
public static function isCountable($value, $message = '') | |
{ | |
if (!\is_array($value) && !($value instanceof Countable)) { | |
static::reportInvalidArgument(\sprintf( | |
$message ?: 'Expected a countable. Got: %s', | |
static::typeToString($value) | |
)); | |
} | |
} | |
/** | |
* @psalm-assert iterable $value | |
* | |
* @param mixed $value | |
* @param string $message | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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)) | |
)); | |
} | |
/** | |
* @psalm-assert empty $value | |
* | |
* @param mixed $value | |
* @param string $message | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
public static function false($value, $message = '') | |
{ | |
if (false !== $value) { | |
static::reportInvalidArgument(\sprintf( | |
$message ?: 'Expected a value to be false. Got: %s', | |
static::valueToString($value) | |
)); | |
} | |
} | |
/** | |
* @param mixed $value | |
* @param string $message | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
public static function notEq($value, $expect, $message = '') | |
{ | |
if ($expect == $value) { | |
static::reportInvalidArgument(\sprintf( | |
$message ?: 'Expected a different value than %s.', | |
static::valueToString($expect) | |
)); | |
} | |
} | |
/** | |
* @psalm-template ExpectedType | |
* @psalm-param ExpectedType $expect | |
* @psalm-assert =ExpectedType $value | |
* | |
* @param mixed $value | |
* @param mixed $expect | |
* @param string $message | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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. | |
* | |
* @psalm-template ExpectedType | |
* @psalm-param array<ExpectedType> $values | |
* @psalm-assert ExpectedType $value | |
* | |
* @param mixed $value | |
* @param array $values | |
* @param string $message | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
public static function startsWithLetter($value, $message = '') | |
{ | |
$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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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] | |
)); | |
} | |
} | |
/** | |
* @psalm-assert !numeric $value | |
* | |
* @param mixed $value | |
* @param string $message | |
*/ | |
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 | |
*/ | |
public static function alpha($value, $message = '') | |
{ | |
$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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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) | |
)); | |
} | |
} | |
/** | |
* 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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
*/ | |
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 | |
)); | |
} | |
} | |
/** | |
* @param mixed $array | |
* @param string $message | |
*/ | |
public static function isList($array, $message = '') | |
{ | |
if (!\is_array($array) || !$array || \array_keys($array) !== \range(0, \count($array) - 1)) { | |
static::reportInvalidArgument( | |
$message ?: 'Expected list - non-associative array.' | |
); | |
} | |
} | |
/** | |
* @param mixed $array | |
* @param string $message | |
*/ | |
public static function isMap($array, $message = '') | |
{ | |
if ( | |
!\is_array($array) || | |
!$array || | |
\array_keys($array) !== \array_filter(\array_keys($array), function ($key) { | |
return \is_string($key); | |
}) | |
) { | |
static::reportInvalidArgument( | |
$message ?: 'Expected map - associative array with string keys.' | |
); | |
} | |
} | |
/** | |
* @param mixed $value | |
* @param string $message | |
*/ | |
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 | |
*/ | |
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 | |
)); | |
} | |
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 | |
*/ | |
protected static function reportInvalidArgument($message) | |
{ | |
throw new InvalidArgumentException($message); | |
} | |
private function __construct() | |
{ | |
} | |
/** generated begin */ | |
/** | |
* @psalm-assert null|string $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrString($value, $message = '') | |
{ | |
self::__callStatic('nullOrString', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,string> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allString($value, $message = '') | |
{ | |
self::__callStatic('allString', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|string $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrStringNotEmpty($value, $message = '') | |
{ | |
self::__callStatic('nullOrStringNotEmpty', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,string> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allStringNotEmpty($value, $message = '') | |
{ | |
self::__callStatic('allStringNotEmpty', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|int $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrInteger($value, $message = '') | |
{ | |
self::__callStatic('nullOrInteger', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,int> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allInteger($value, $message = '') | |
{ | |
self::__callStatic('allInteger', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|numeric $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrIntegerish($value, $message = '') | |
{ | |
self::__callStatic('nullOrIntegerish', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,numeric> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allIntegerish($value, $message = '') | |
{ | |
self::__callStatic('allIntegerish', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|float $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrFloat($value, $message = '') | |
{ | |
self::__callStatic('nullOrFloat', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,float> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allFloat($value, $message = '') | |
{ | |
self::__callStatic('allFloat', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|numeric $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrNumeric($value, $message = '') | |
{ | |
self::__callStatic('nullOrNumeric', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,numeric> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allNumeric($value, $message = '') | |
{ | |
self::__callStatic('allNumeric', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|int $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrNatural($value, $message = '') | |
{ | |
self::__callStatic('nullOrNatural', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,int> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allNatural($value, $message = '') | |
{ | |
self::__callStatic('allNatural', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|bool $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrBoolean($value, $message = '') | |
{ | |
self::__callStatic('nullOrBoolean', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,bool> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allBoolean($value, $message = '') | |
{ | |
self::__callStatic('allBoolean', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|scalar $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrScalar($value, $message = '') | |
{ | |
self::__callStatic('nullOrScalar', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,scalar> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allScalar($value, $message = '') | |
{ | |
self::__callStatic('allScalar', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|object $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrObject($value, $message = '') | |
{ | |
self::__callStatic('nullOrObject', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,object> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allObject($value, $message = '') | |
{ | |
self::__callStatic('allObject', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|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 | |
*/ | |
public static function nullOrResource($value, $type = null, $message = '') | |
{ | |
self::__callStatic('nullOrResource', [$value, $type, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,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 | |
*/ | |
public static function allResource($value, $type = null, $message = '') | |
{ | |
self::__callStatic('allResource', [$value, $type, $message]); | |
} | |
/** | |
* @psalm-assert null|callable $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrIsCallable($value, $message = '') | |
{ | |
self::__callStatic('nullOrIsCallable', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,callable> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allIsCallable($value, $message = '') | |
{ | |
self::__callStatic('allIsCallable', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|array $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrIsArray($value, $message = '') | |
{ | |
self::__callStatic('nullOrIsArray', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,array> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allIsArray($value, $message = '') | |
{ | |
self::__callStatic('allIsArray', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|iterable $value | |
* @deprecated use "isIterable" or "isInstanceOf" instead | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrIsTraversable($value, $message = '') | |
{ | |
self::__callStatic('nullOrIsTraversable', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,iterable> $value | |
* @deprecated use "isIterable" or "isInstanceOf" instead | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allIsTraversable($value, $message = '') | |
{ | |
self::__callStatic('allIsTraversable', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|countable $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrIsCountable($value, $message = '') | |
{ | |
self::__callStatic('nullOrIsCountable', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,countable> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allIsCountable($value, $message = '') | |
{ | |
self::__callStatic('allIsCountable', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|iterable $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrIsIterable($value, $message = '') | |
{ | |
self::__callStatic('nullOrIsIterable', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,iterable> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allIsIterable($value, $message = '') | |
{ | |
self::__callStatic('allIsIterable', [$value, $message]); | |
} | |
/** | |
* @psalm-template ExpectedType of object | |
* @psalm-param class-string<ExpectedType> $class | |
* @psalm-assert null|ExpectedType $value | |
* @param mixed $value | |
* @param string|object $class | |
* @param string $message | |
*/ | |
public static function nullOrIsInstanceOf($value, $class, $message = '') | |
{ | |
self::__callStatic('nullOrIsInstanceOf', [$value, $class, $message]); | |
} | |
/** | |
* @psalm-template ExpectedType of object | |
* @psalm-param class-string<ExpectedType> $class | |
* @psalm-assert array<array-key,ExpectedType> $value | |
* @param mixed $value | |
* @param string|object $class | |
* @param string $message | |
*/ | |
public static function allIsInstanceOf($value, $class, $message = '') | |
{ | |
self::__callStatic('allIsInstanceOf', [$value, $class, $message]); | |
} | |
/** | |
* @psalm-assert null|empty $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrIsEmpty($value, $message = '') | |
{ | |
self::__callStatic('nullOrIsEmpty', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,empty> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allIsEmpty($value, $message = '') | |
{ | |
self::__callStatic('allIsEmpty', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,null> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allNull($value, $message = '') | |
{ | |
self::__callStatic('allNull', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|true $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrTrue($value, $message = '') | |
{ | |
self::__callStatic('nullOrTrue', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,true> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allTrue($value, $message = '') | |
{ | |
self::__callStatic('allTrue', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|false $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrFalse($value, $message = '') | |
{ | |
self::__callStatic('nullOrFalse', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,false> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allFalse($value, $message = '') | |
{ | |
self::__callStatic('allFalse', [$value, $message]); | |
} | |
/** | |
* @psalm-template ExpectedType | |
* @psalm-param array<ExpectedType> $values | |
* @psalm-assert null|ExpectedType $value | |
* @param mixed $value | |
* @param array $values | |
* @param string $message | |
*/ | |
public static function nullOrOneOf($value, $values, $message = '') | |
{ | |
self::__callStatic('nullOrOneOf', [$value, $values, $message]); | |
} | |
/** | |
* @psalm-template ExpectedType | |
* @psalm-param array<ExpectedType> $values | |
* @psalm-assert array<array-key,ExpectedType> $value | |
* @param mixed $value | |
* @param array $values | |
* @param string $message | |
*/ | |
public static function allOneOf($value, $values, $message = '') | |
{ | |
self::__callStatic('allOneOf', [$value, $values, $message]); | |
} | |
/** | |
* @psalm-assert null|class-string $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrClassExists($value, $message = '') | |
{ | |
self::__callStatic('nullOrClassExists', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,class-string> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allClassExists($value, $message = '') | |
{ | |
self::__callStatic('allClassExists', [$value, $message]); | |
} | |
/** | |
* @psalm-assert null|class-string $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function nullOrInterfaceExists($value, $message = '') | |
{ | |
self::__callStatic('nullOrInterfaceExists', [$value, $message]); | |
} | |
/** | |
* @psalm-assert array<array-key,class-string> $value | |
* @param mixed $value | |
* @param string $message | |
*/ | |
public static function allInterfaceExists($value, $message = '') | |
{ | |
self::__callStatic('allInterfaceExists', [$value, $message]); | |
} | |
/** generated end */ | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment