BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
Webmozart Assert

![Build Status](https://travis-ci.org/webmozart/assert.svg?branch=1.2.0) ![Build status](https://ci.appveyor.com/api/projects/status/lyg83bcsisrr94se/branch/master?svg=true) ![Latest Stable Version](https://poser.pugx.org/webmozart/assert/v/stable.svg) ![Total Downloads](https://poser.pugx.org/webmozart/assert/downloads.svg) ![Dependency Status](https://www.versioneye.com/php/webmozart:assert/1.2.0/badge.svg)

Latest release: 1.2.0

PHP >= 5.3.9

This library contains efficient assertions to test the input and output of your methods. With these assertions, you can greatly reduce the amount of coding needed to write a safe implementation.

All assertions in the `Assert` class throw an \InvalidArgumentException if they fail.

FAQ

What's the difference to beberlei/assert?

This library is heavily inspired by Benjamin Eberlei's wonderful assert package, but fixes a usability issue with error messages that can't be fixed there without breaking backwards compatibility.

This package features usable error messages by default. However, you can also easily write custom error messages:

``` Assert::string($path, 'The path is expected to be a string. Got: s'); ```

In beberlei/assert, the ordering of the s placeholders is different for every assertion. This package, on the contrary, provides consistent placeholder ordering for all assertions:

  • s: The tested value as string, e.g. "/foo/bar".
  • %2$s, %3$s, ...: Additional assertion-specific values, e.g. the minimum/maximum length, allowed values, etc.

Check the source code of the assertions to find out details about the additional available placeholders.

Installation

Use Composer to install the package:

``` $ composer require webmozart/assert ```

Example

```php use Webmozart;

class Employee { public function __construct($id) { Assert::integer($id, 'The employee ID must be an integer. Got: s'); Assert::greaterThan($id, 0, 'The employee ID must be a positive integer. Got: s'); } } ```

If you create an employee with an invalid ID, an exception is thrown:

```php new Employee('foobar'); // => InvalidArgumentException: // The employee ID must be an integer. Got: string

new Employee(-10); // => InvalidArgumentException: // The employee ID must be a positive integer. Got: -10 ```

Assertions

The `Assert` class provides the following assertions:

Type Assertions

Method Description
`string($value, $message = '')<td> Check that a value is a string <tr><td>stringNotEmpty($value, $message = '')<td> Check that a value is a non-empty string <tr><td>integer($value, $message = '')<td> Check that a value is an integer <tr><td>integerish($value, $message = '')<td> Check that a value casts to an integer <tr><td>float($value, $message = '')<td> Check that a value is a float <tr><td>numeric($value, $message = '')<td> Check that a value is numeric <tr><td>boolean($value, $message = '')<td> Check that a value is a boolean <tr><td>scalar($value, $message = '')<td> Check that a value is a scalar <tr><td>object($value, $message = '')<td> Check that a value is an object <tr><td>resource($value, $type = null, $message = '')<td> Check that a value is a resource <tr><td>isCallable($value, $message = '')<td> Check that a value is a callable <tr><td>isArray($value, $message = '')<td> Check that a value is an array <tr><td>isTraversable($value, $message = '')<td> Check that a value is an array or a <tr><td>isInstanceOf($value, $class, $message = '')<td> Check that a value is aninstanceofa class <tr><td>notInstanceOf($value, $class, $message = '')<td> Check that a value is not aninstanceof` a class

Comparison Assertions

Method Description
`true($value, $message = '')<td> Check that a value istrue <tr><td>false($value, $message = '')<td> Check that a value isfalse <tr><td>null($value, $message = '')<td> Check that a value isnull <tr><td>notNull($value, $message = '')<td> Check that a value is notnull <tr><td>isEmpty($value, $message = '')<td> Check that a value isempty() <tr><td>notEmpty($value, $message = '')<td> Check that a value is notempty() <tr><td>eq($value, $value2, $message = '')<td> Check that a value equals another (==) <tr><td>notEq($value, $value2, $message = '')<td> Check that a value does not equal another (!=) <tr><td>same($value, $value2, $message = '')<td> Check that a value is identical to another (===) <tr><td>notSame($value, $value2, $message = '')<td> Check that a value is not identical to another (!==) <tr><td>greaterThan($value, $value2, $message = '')<td> Check that a value is greater than another <tr><td>greaterThanEq($value, $value2, $message = '')<td> Check that a value is greater than or equal to another <tr><td>lessThan($value, $value2, $message = '')<td> Check that a value is less than another <tr><td>lessThanEq($value, $value2, $message = '')<td> Check that a value is less than or equal to another <tr><td>range($value, $min, $max, $message = '')<td> Check that a value is within a range <tr><td>oneOf($value, array $values, $message = '')` Check that a value is one of a list of values

String Assertions

You should check that a value is a string with Assert::string() before making any of the following assertions.

Method Description
`contains($value, $subString, $message = '')<td> Check that a string contains a substring <tr><td>startsWith($value, $prefix, $message = '')<td> Check that a string has a prefix <tr><td>startsWithLetter($value, $message = '')<td> Check that a string starts with a letter <tr><td>endsWith($value, $suffix, $message = '')<td> Check that a string has a suffix <tr><td>regex($value, $pattern, $message = '')<td> Check that a string matches a regular expression <tr><td>alpha($value, $message = '')<td> Check that a string contains letters only <tr><td>digits($value, $message = '')<td> Check that a string contains digits only <tr><td>alnum($value, $message = '')<td> Check that a string contains letters and digits only <tr><td>lower($value, $message = '')<td> Check that a string contains lowercase characters only <tr><td>upper($value, $message = '')<td> Check that a string contains uppercase characters only <tr><td>length($value, $length, $message = '')<td> Check that a string has a certain number of characters <tr><td>minLength($value, $min, $message = '')<td> Check that a string has at least a certain number of characters <tr><td>maxLength($value, $max, $message = '')<td> Check that a string has at most a certain number of characters <tr><td>lengthBetween($value, $min, $max, $message = '')<td> Check that a string has a length in the given range <tr><td>uuid($value, $message = '')` Check that a string is a valid UUID

File Assertions

Method Description
`fileExists($value, $message = '')<td> Check that a value is an existing path <tr><td>file($value, $message = '')<td> Check that a value is an existing file <tr><td>directory($value, $message = '')<td> Check that a value is an existing directory <tr><td>readable($value, $message = '')<td> Check that a value is a readable path <tr><td>writable($value, $message = '')` Check that a value is a writable path

Object Assertions

Method Description
`classExists($value, $message = '')<td> Check that a value is an existing class name <tr><td>subclassOf($value, $class, $message = '')<td> Check that a class is a subclass of another <tr><td>implementsInterface($value, $class, $message = '')<td> Check that a class implements an interface <tr><td>propertyExists($value, $property, $message = '')<td> Check that a property exists in a class/object <tr><td>propertyNotExists($value, $property, $message = '')<td> Check that a property does not exist in a class/object <tr><td>methodExists($value, $method, $message = '')<td> Check that a method exists in a class/object <tr><td>methodNotExists($value, $method, $message = '')` Check that a method does not exist in a class/object

Array Assertions

Method Description
`keyExists($array, $key, $message = '')<td> Check that a key exists in an array <tr><td>keyNotExists($array, $key, $message = '')<td> Check that a key does not exist in an array <tr><td>count($array, $number, $message = '')` Check that an array contains a specific number of elements

Function Assertions

Method Description
`throws($closure, $class, $message = '')` Check that a function throws a certain exception. Subclasses of the exception class will be accepted.

Collection Assertions

All of the above assertions can be prefixed with all*() to test the contents of an array or a \Traversable:

```php Assert::allIsInstanceOf($employees, 'Acme'); ```

Nullable Assertions

All of the above assertions can be prefixed with nullOr*() to run the assertion only if it the value is not null:

```php Assert::nullOrString($middleName, 'The middle name must be a string or null. Got: s'); ```

Authors

Contribute

Contributions to the package are always welcome!

Support

If you are having problems, send a mail to bschu.nosp@m.ssek.nosp@m.@gmai.nosp@m.l.co.nosp@m.m or shout out to on Twitter.

License

All contents of this package are licensed under the [MIT license].