annotate vendor/webmozart/assert/src/Assert.php @ 0:4c8ae668cc8c

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