PHPackages nilportugues/assert - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Testing & Quality](/categories/testing) 4. / 5. nilportugues/assert ActiveLibrary[Testing & Quality](/categories/testing) nilportugues/assert =================== A simple and elegant assertion and guard methods library for input validation. 1.0.2(9y ago)1066.0k—0%37MITPHP Since Feb 6Pushed 9y agoCompare [ Source](https://github.com/nilportugues/php-assert)[ Packagist](https://packagist.org/packages/nilportugues/assert)[ Docs](http://nilportugues.com)[ RSS](/packages/nilportugues-assert/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (3)Dependencies (3)Versions (4)Used By (7) Assert ====== [](#assert) [![Build Status](https://camo.githubusercontent.com/ad7763b81f74b121718cdc31e2d6d2f03947c511d01d8c5d64907a657818cf5c/68747470733a2f2f7472617669732d63692e6f72672f6e696c706f727475677565732f7068702d6173736572742e737667)](https://travis-ci.org/nilportugues/php-assert) [![Coverage Status](https://camo.githubusercontent.com/adf1f7581c60e70b9fe192b5c9d2240d19ad1d97c64aa8b48cfd4402a8c7964f/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6e696c706f727475677565732f7068702d6173736572742f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/r/nilportugues/php-assert?branch=master) [![SensioLabsInsight](https://camo.githubusercontent.com/de7a1ac955fffd77fd99ccf4d4738605aa8bd23ed1f24528f003bb645d475269/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f63333733363063342d373238302d346530382d626666312d3066303035333130333030332f6d696e692e706e673f)](https://insight.sensiolabs.com/projects/c37360c4-7280-4e08-bff1-0f0053103003) [![Latest Stable Version](https://camo.githubusercontent.com/a8342f5e3c474a1f85e8f5f075bbddd7232b6097b8a6c7cacece4e986ce038cd/68747470733a2f2f706f7365722e707567782e6f72672f6e696c706f727475677565732f6173736572742f762f737461626c65)](https://packagist.org/packages/nilportugues/assert) [![Total Downloads](https://camo.githubusercontent.com/74d2f7f183f5d092ad06c3d89b4e9d1e836b3c93bd54fa225b3492d413dd0844/68747470733a2f2f706f7365722e707567782e6f72672f6e696c706f727475677565732f6173736572742f646f776e6c6f616473)](https://packagist.org/packages/nilportugues/assert) [![License](https://camo.githubusercontent.com/ba1be4bf2b34328ca24a17a0f1a519fb2f2856000f5b9ab696a56f1a67fcb9fa/68747470733a2f2f706f7365722e707567782e6f72672f6e696c706f727475677565732f6173736572742f6c6963656e7365)](https://packagist.org/packages/nilportugues/assert)[![Donate](https://camo.githubusercontent.com/7b6de155df30b37b25eb5fec52f9213680c3dbf067dfb7d7e2850ac4096c7d05/68747470733a2f2f7777772e70617970616c6f626a656374732e636f6d2f656e5f55532f692f62746e2f62746e5f646f6e6174655f534d2e676966)](https://paypal.me/nilportugues) While I know there are out there other assertion libraries I was unhappy with them, so I wrote my own. Usage ----- [](#usage) Assertion library is really straight forward. Pass input to the method call and it will just run or throw an `\Exception` if it doesn't meet the requirements. ``` use NilPortugues\Assert\Assert; try { Assert::nullOrIsLowercase(null); Assert::isUppercase('THIS IS GREAT'); Assert::isNight(new \DateTime('now')); } catch (Exception $e) { echo 'Did not meet the requirements, too bad!'; } ``` Assertion Methods ----------------- [](#assertion-methods) All assertion methods can be used against different data types (integer, double, objects..). If you try to validate data for an unexpected data type, an Exception will be thrown making your assertion fail as expected. Most methods can be called using the "nullOr" prefix instead of the "is" prefix. For instance: ``` Assert::nullOrIsLowercase('lowercase'); //OK Assert::isLowercase(null); //raises Exception ``` Assertion List -------------- [](#assertion-list) All methods allow specifying a custom `$message` value. If not passed in, a library-defined default will be used. Those accepting a `callable` as an argument, expect an Assert statement to be used inside the callable. #### Generic Assertions [](#generic-assertions) ``` Assert::isRequired($value, $message = ''); Assert::isNotNull($value, $message = ''); Assert::notEquals($property, $value, $message = ''); Assert::greaterThanOrEqual($property, $value, $message = ''); Assert::greaterThan($property, $value, $message = ''); Assert::lessThanOrEqual($property, $value, $message = ''); Assert::lessThan($property, $value, $message = ''); Assert::isScalar($value, $message = ''); // nullOr assertions Assert::nullOrNotEquals($property, $value, $message = ''); Assert::nullOrGreaterThanOrEqual($property, $value, $message = ''); Assert::nullOrGreaterThan($property, $value, $message = ''); Assert::nullOrLessThanOrEqual($property, $value, $message = ''); Assert::nullOrLessThan($property, $value, $message = ''); Assert::nullOrIsScalar($value, $message = ''); ``` #### String Assertions [](#string-assertions) ``` Assert::isString($value, $message = '') Assert::isAlphanumeric($value, $message = '') Assert::isAlpha($value, $message = '') Assert::isBetween($value, $min, $max, $inclusive = false, $message = '') Assert::isCharset($value, $charset, $message = '') Assert::isAllConsonants($value, $message = '') Assert::contains($value, $contains, $identical = false, $message = '') Assert::isControlCharacters($value, $message = '') Assert::isDigit($value, $message = '') Assert::endsWith($value, $contains, $identical = false, $message = '') Assert::equals($value, $comparedValue, $identical = false, $message = '') Assert::in($value, $haystack, $identical = false, $message = '') Assert::hasGraphicalCharsOnly($value, $message = '') Assert::hasLength($value, $length, $message = '') Assert::isLowercase($value, $message = '') Assert::notEmpty($value, $message = '') Assert::noWhitespace($value, $message = '') Assert::hasPrintableCharsOnly($value, $message = '') Assert::isPunctuation($value, $message = '') Assert::matchesRegex($value, $regex, $message = '') Assert::isSlug($value, $message = '') Assert::isSpace($value, $message = '') Assert::startsWith($value, $contains, $identical = false, $message = '') Assert::isUppercase($value, $message = '') Assert::isVersion($value, $message = '') Assert::isVowel($value, $message = '') Assert::isHexDigit($value, $message = '') Assert::hasLowercase($value, $amount = null, $message = '') Assert::hasUppercase($value, $amount = null, $message = '') Assert::hasNumeric($value, $amount = null, $message = '') Assert::hasSpecialCharacters($value, $amount = null, $message = '') Assert::isEmail($value, $message = '') Assert::isUrl($value, $message = '') Assert::isUUID($value, $strict = true, $message = '') Assert::isLatitude($latitude, $message = '') Assert::isLongitude($lontitude, $message = '') Assert::isTimeString($value, $message = '') Assert::isDateString($value, $message = '') Assert::isHexColor($value, $message = '') Assert::isIpAddress($value, $message = '') Assert::isIpv4Address($value, $message = '') Assert::isIpv6Address($value, $message = '') Assert::isJson($value, $message = '') Assert::isCreditCard($value, $message = '') Assert::isPalindrome($value, $message = '') Assert::isUnderScore($value, $message = '') Assert::isTitleCase($value, $message = '') // nullOr assertions Assert::nullOrIsString($value, $message = '') Assert::nullOrIsAlphanumeric($value, $message = '') Assert::nullOrIsAlpha($value, $message = '') Assert::nullOrIsBetween($value, $min, $max, $inclusive = false, $message = '') Assert::nullOrIsCharset($value, $charset, $message = '') Assert::nullOrIsAllConsonants($value, $message = '') Assert::nullOrContains($value, $contains, $identical = false, $message = '') Assert::nullOrIsControlCharacters($value, $message = '') Assert::nullOrIsDigit($value, $message = '') Assert::nullOrEndsWith($value, $contains, $identical = false, $message = '') Assert::nullOrEquals($value, $comparedValue, $identical = false, $message = '') Assert::nullOrIn($value, $haystack, $identical = false, $message = '') Assert::nullOrHasGraphicalCharsOnly($value, $message = '') Assert::nullOrHasLength($value, $length, $message = '') Assert::nullOrIsLowercase($value, $message = '') Assert::nullOrNotEmpty($value, $message = '') Assert::nullOrNoWhitespace($value, $message = '') Assert::nullOrHasPrintableCharsOnly($value, $message = '') Assert::nullOrIsPunctuation($value, $message = '') Assert::nullOrMatchesRegex($value, $regex, $message = '') Assert::nullOrIsSlug($value, $message = '') Assert::nullOrIsSpace($value, $message = '') Assert::nullOrStartsWith($value, $contains, $identical = false, $message = '') Assert::nullOrIsUppercase($value, $message = '') Assert::nullOrIsVersion($value, $message = '') Assert::nullOrIsVowel($value, $message = '') Assert::nullOrIsHexDigit($value, $message = '') Assert::nullOrHasLowercase($value, $amount = null, $message = '') Assert::nullOrHasUppercase($value, $amount = null, $message = '') Assert::nullOrHasNumeric($value, $amount = null, $message = '') Assert::nullOrHasSpecialCharacters($value, $amount = null, $message = '') Assert::nullOrIsEmail($value, $message = '') Assert::nullOrIsUrl($value, $message = '') Assert::nullOrIsUUID($value, $strict = true, $message = '') Assert::nullOrIsLatitude($latitude, $message = '') Assert::nullOrIsLongitude($lontitude, $message = '') Assert::nullOrIsTimeString($value, $message = '') Assert::nullOrIsDateString($value, $message = '') Assert::nullOrIsHexColor($value, $message = '') Assert::nullOrIsIpAddress($value, $message = '') Assert::nullOrIsIpv4Address($value, $message = '') Assert::nullOrIsIpv6Address($value, $message = '') Assert::nullOrIsJson($value, $message = '') Assert::nullOrIsCreditCard($value, $message = '') Assert::nullOrIsPalindrome($value, $message = '') Assert::nullOrIsUnderScore($value, $message = '') Assert::nullOrIsTitleCase($value, $message = '') ``` #### Integer Assertions [](#integer-assertions) ``` Assert::isInteger($value, $message = '') Assert::isNotZero($value, $message = '') Assert::isPositiveOrZero($value, $message = '') Assert::isPositive($value, $message = '') Assert::isNegativeOrZero($value, $message = '') Assert::isNegative($value, $message = '') Assert::isBetween($value, $min, $max, $inclusive = false, $message = '') Assert::isOdd($value, $message = '') Assert::isEven($value, $message = '') Assert::isMultiple($value, $multiple, $message = '') // nullOr assertions Assert::nullOrIsInteger($value, $message = '') Assert::nullOrIsNotZero($value, $message = '') Assert::nullOrIsPositiveOrZero($value, $message = '') Assert::nullOrIsPositive($value, $message = '') Assert::nullOrIsNegativeOrZero($value, $message = '') Assert::nullOrIsNegative($value, $message = '') Assert::nullOrIsBetween($value, $min, $max, $inclusive = false, $message = '') Assert::nullOrIsOdd($value, $message = '') Assert::nullOrIsEven($value, $message = '') Assert::nullOrIsMultiple($value, $multiple, $message = '') ``` #### Float & Double Assertions [](#float--double-assertions) ``` Assert::isFloat($value, $message = '') Assert::isNotZero($value, $message = '') Assert::isPositiveOrZero($value, $message = '') Assert::isPositive($value, $message = '') Assert::isNegativeOrZero($value, $message = '') Assert::isNegative($value, $message = '') Assert::isBetween($value, $min, $max, $inclusive = false, $message = '') Assert::isOdd($value, $message = '') Assert::isEven($value, $message = '') Assert::isMultiple($value, $multiple, $message = '') // nullOr assertions Assert::nullOrIsFloat($value, $message = '') Assert::nullOrIsNotZero($value, $message = '') Assert::nullOrIsPositiveOrZero($value, $message = '') Assert::nullOrIsPositive($value, $message = '') Assert::nullOrIsNegativeOrZero($value, $message = '') Assert::nullOrIsNegative($value, $message = '') Assert::nullOrIsBetween($value, $min, $max, $inclusive = false, $message = '') Assert::nullOrIsOdd($value, $message = '') Assert::nullOrIsEven($value, $message = '') Assert::nullOrIsMultiple($value, $multiple, $message = '') ``` #### Array & Collection Assertions [](#array--collection-assertions) ``` Assert::isArray($value, $message = '') Assert::each($value, callable $valueValidator, callable $keyValidator = null, $message = '') Assert::hasKeyFormat($value, callable $keyValidator, $message = '') Assert::endsWith($haystack, $needle, $strict = false, $message = '') Assert::contains($haystack, $needle, $strict = false, $message = '') Assert::hasKey($value, $keyName, $message = '') Assert::hasLength($value, $length, $message = '') Assert::isNotEmpty($value, $message = '') Assert::startsWith($haystack, $needle, $strict = false, $message = '') // nullOr assertions Assert::nullOrIsArray($value, $message = '') Assert::nullOrEach($value, callable $valueValidator, callable $keyValidator = null, $message = '') Assert::nullOrHasKeyFormat($value, callable $keyValidator, $message = '') Assert::nullOrEndsWith($haystack, $needle, $strict = false, $message = '') Assert::nullOrContains($haystack, $needle, $strict = false, $message = '') Assert::nullOrHasKey($value, $keyName, $message = '') Assert::nullOrHasLength($value, $length, $message = '') Assert::nullOrIsNotEmpty($value, $message = '') Assert::nullOrStartsWith($haystack, $needle, $strict = false, $message = '') ``` #### DateTime Assertions [](#datetime-assertions) ``` Assert::isDateTime($value, $message = '') Assert::isAfter($value, $limit, $inclusive = false, $message = '') Assert::isBefore($value, $limit, $inclusive = false, $message = '') Assert::isDateRange($value, $minDate, $maxDate, $inclusive = false, $message = '') Assert::isWeekend($value, $message = '') Assert::isWeekday($value, $message = '') Assert::isMonday($value, $message = '') Assert::isTuesday($value, $message = '') Assert::isWednesday($value, $message = '') Assert::isThursday($value, $message = '') Assert::isFriday($value, $message = '') Assert::isSaturday($value, $message = '') Assert::isSunday($value, $message = '') Assert::isToday($value, $message = '') Assert::isYesterday($value, $message = '') Assert::isTomorrow($value, $message = '') Assert::isLeapYear($value, $message = '') Assert::isMorning($value, $message = '') Assert::isAfternoon($value, $message = '') Assert::isEvening($value, $message = '') Assert::isNight($value, $message = '') Assert::isFutureDate($value, $message = '') Assert::isPastDate($value, $message = '') Assert::isInNextWeek($value, $message = '') Assert::isInWeek($value, $weekNumber, $message) Assert::isInLastWeek($value, $message = '') Assert::isInLastMonth($value, $message = '') Assert::isInMonth($value, $monthNumber, $message) Assert::isInNextMonth($value, $message = '') Assert::isInLastYear($value, $message = '') Assert::isInYear($value, $yearNumber, $message) Assert::isInNextYear($value, $message = '') Assert::isFirstHalfOfYear($value, $message = '') Assert::isSecondHalfOfYear($value, $message = '') Assert::isTrimesterOfYear($value, $trimester, $message = '') Assert::isQuarterOfYear($value, $quarter, $message = '') Assert::isDayLightSavingTime($value, \DateTimeZone $timezone, $message = '') // nullOr assertions Assert::nullOrIsDateTime($value, $message = '') Assert::nullOrIsAfter($value, $limit, $inclusive = false, $message = '') Assert::nullOrIsBefore($value, $limit, $inclusive = false, $message = '') Assert::nullOrIsDateRange($value, $minDate, $maxDate, $inclusive = false, $message = '') Assert::nullOrIsWeekend($value, $message = '') Assert::nullOrIsWeekday($value, $message = '') Assert::nullOrIsMonday($value, $message = '') Assert::nullOrIsTuesday($value, $message = '') Assert::nullOrIsWednesday($value, $message = '') Assert::nullOrIsThursday($value, $message = '') Assert::nullOrIsFriday($value, $message = '') Assert::nullOrIsSaturday($value, $message = '') Assert::nullOrIsSunday($value, $message = '') Assert::nullOrIsToday($value, $message = '') Assert::nullOrIsYesterday($value, $message = '') Assert::nullOrIsTomorrow($value, $message = '') Assert::nullOrIsLeapYear($value, $message = '') Assert::nullOrIsMorning($value, $message = '') Assert::nullOrIsAfternoon($value, $message = '') Assert::nullOrIsEvening($value, $message = '') Assert::nullOrIsNight($value, $message = '') Assert::nullOrIsFutureDate($value, $message = '') Assert::nullOrIsPastDate($value, $message = '') Assert::nullOrIsInNextWeek($value, $message = '') Assert::nullOrIsInWeek($value, $weekNumber, $message) Assert::nullOrIsInLastWeek($value, $message = '') Assert::nullOrIsInLastMonth($value, $message = '') Assert::nullOrIsInMonth($value, $monthNumber, $message) Assert::nullOrIsInNextMonth($value, $message = '') Assert::nullOrIsInLastYear($value, $message = '') Assert::nullOrIsInYear($value, $yearNumber, $message) Assert::nullOrIsInNextYear($value, $message = '') Assert::nullOrIsFirstHalfOfYear($value, $message = '') Assert::nullOrIsSecondHalfOfYear($value, $message = '') Assert::nullOrIsTrimesterOfYear($value, $trimester, $message = '') Assert::nullOrIsQuarterOfYear($value, $quarter, $message = '') Assert::nullOrIsDayLightSavingTime($value, \DateTimeZone $timezone, $message = '') ``` #### Object Assertions [](#object-assertions) ``` Assert::isObject($value, $message = '') Assert::isInstanceOf($value, $instanceOf, $message = '') Assert::hasProperty($value, $property, $message = '') Assert::hasMethod($value, $method, $message = '') Assert::hasParentClass($value, $message = '') Assert::isChildOf($value, $parentClass, $message = '') Assert::inheritsFrom($value, $inheritsClass, $message = '') Assert::hasInterface($value, $interface, $message = '') // nullOr assertions Assert::nullOrIsObject($value, $message = '') Assert::nullOrIsInstanceOf($value, $instanceOf, $message = '') Assert::nullOrHasProperty($value, $property, $message = '') Assert::nullOrHasMethod($value, $method, $message = '') Assert::nullOrHasParentClass($value, $message = '') Assert::nullOrIsChildOf($value, $parentClass, $message = '') Assert::nullOrInheritsFrom($value, $inheritsClass, $message = '') Assert::nullOrHasInterface($value, $interface, $message = '') ``` #### FileUpload Assertions [](#fileupload-assertions) FileUpload Assertions look into the `$_FILES` global variable. ``` Assert::isFileUploaded($uploadName, $message = '') Assert::isFileUploadedBetweenFileSize($uploadName, $minSize, $maxSize, $format='B', $inclusive = false, $message = '') Assert::hasFileUploadedFileNameFormat($uploadName, callable $assertion, $message = '') Assert::hasFileUploadedValidUploadDirectory($uploadName, $uploadDir, $message = '') Assert::isFileUploadedNotOverwritingExistingFile($uploadName, $uploadDir, $message = '') Assert::hasFileUploadedFileNameLength($uploadName, $size, $message = '') Assert::isFileUploadedImage($uploadName, $message = '') Assert::isFileUploadedMimeType($uploadName, array $allowedTypes, $message = '') // nullOr assertions Assert::nullOrIsFileUploaded($uploadName, $message = '') Assert::nullOrIsFileUploadedBetweenFileSize($uploadName, $minSize, $maxSize, $format='B', $inclusive=false, $message='') Assert::nullOrHasFileUploadedFileNameFormat($uploadName, callable $assertion, $message = '') Assert::nullOrHasFileUploadedValidUploadDirectory($uploadName, $uploadDir, $message = '') Assert::nullOrIsFileUploadedNotOverwritingExistingFile($uploadName, $uploadDir, $message = '') Assert::nullOrHasFileUploadedFileNameLength($uploadName, $size, $message = '') Assert::nullOrIsFileUploadedImage($uploadName, $message = '') Assert::nullOrIsFileUploadedMimeType($uploadName, array $allowedTypes, $message = '') ``` Contribute ---------- [](#contribute) Contributions to the package are always welcome! - Report any bugs or issues you find on the [issue tracker](https://github.com/nilportugues/php-assert/issues/new). - You can grab the source code at the package's [Git repository](https://github.com/nilportugues/php-assert). Support ------- [](#support) Get in touch with me using one of the following means: - Emailing me at - Opening an [Issue](https://github.com/nilportugues/php-assert/issues/new) Authors ------- [](#authors) - [Nil Portugués Calderó](http://nilportugues.com) - [The Community Contributors](https://github.com/nilportugues/php-assert/graphs/contributors) License ------- [](#license) The code base is licensed under the [MIT license](LICENSE). ### Health Score 37 — LowBetter than 83% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity35 Limited adoption so far Community15 Small or concentrated contributor base Maturity65 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~90 days Total 3 Last Release 3574d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/beba5d66ff48128da92c91850e69b9294768718bcdc12e61cc9ee8453d0d6b69?d=identicon)[nilportugues](/maintainers/nilportugues) --- Top Contributors [![nilportugues](https://avatars.githubusercontent.com/u/550948?v=4)](https://github.com/nilportugues "nilportugues (43 commits)") --- Tags assertion-libraryassertionserror-handlingerrorsexceptionsphpphp7qualityvalidationvalue-objectvalidatorvalidationdataassertassertioninputnil portuguesnilportugues ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/nilportugues-assert/health.svg) ``` [![Health](https://phpackages.com/badges/nilportugues-assert/health.svg)](https://phpackages.com/packages/nilportugues-assert) ``` ### Alternatives [beberlei/assert Thin assertion library for input validation in business models. 2.4k96.9M570](/packages/beberlei-assert)[nilportugues/validator An efficient data validator for PHP 131.5k](/packages/nilportugues-validator)[elliotchance/concise Concise is test framework for using plain English and minimal code, built on PHPUnit. 45223.8k4](/packages/elliotchance-concise)[respect/assertion The power of Respect\\Validation into an assertion library 2828.0k](/packages/respect-assertion) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)