Assert\Assert

Complexity

Total Complexity

4

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Dependencies

2

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	thatAll()	0	4	1
A	thatNullOr()	0	4	1
A	lazy()	0	6	1
A	that()	0	6	1

<?php
/**
 * Assert
 *
 * LICENSE
 *
 * This source file is subject to the MIT license that is bundled
 * with this package in the file LICENSE.txt.
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to kontakt@beberlei.de so I can send you a copy immediately.
 */

namespace Assert;

/**
 * AssertionChain factory
 */
abstract class Assert
{
    /** @var string */
    protected static $lazyAssertionExceptionClass = LazyAssertionException::class;

    /** @var string */
    protected static $assertionClass = Assertion::class;

    /**
     * Start validation on a value, returns {@link AssertionChain}
     *
     * The invocation of this method starts an assertion chain
     * that is happening on the passed value.
     *
     * @example
     *
     *  Assert::that($value)->notEmpty()->integer();
     *  Assert::that($value)->nullOr()->string()->startsWith("Foo");
     *
     * The assertion chain can be stateful, that means be careful when you reuse
     * it. You should never pass around the chain.
     *
     * @param mixed $value
     * @param string $defaultMessage

Should the type for parameter $defaultMessage not be string|null?

     * @param string $defaultPropertyPath

Should the type for parameter $defaultPropertyPath not be string|null?

     *
     * @return \Assert\AssertionChain
     */
    public static function that($value, $defaultMessage = null, $defaultPropertyPath = null)
    {
        return (new AssertionChain($value, $defaultMessage, $defaultPropertyPath))
            ->setAssertionClassName(static::$assertionClass)
        ;
    }

    /**
     * Start validation on a set of values, returns {@link AssertionChain}
     *
     * @param mixed $values
     * @param string $defaultMessage

Should the type for parameter $defaultMessage not be string|null?

     * @param string $defaultPropertyPath

Should the type for parameter $defaultPropertyPath not be string|null?

     *
     * @return \Assert\AssertionChain
     */
    public static function thatAll($values, $defaultMessage = null, $defaultPropertyPath = null)
    {
        return static::that($values, $defaultMessage, $defaultPropertyPath)->all();
    }

    /**
     * Start validation and allow NULL, returns {@link AssertionChain}
     *
     * @param mixed $value
     * @param string $defaultMessage

Should the type for parameter $defaultMessage not be string|null?

     * @param string $defaultPropertyPath

Should the type for parameter $defaultPropertyPath not be string|null?

     *
     * @return \Assert\AssertionChain
     */
    public static function thatNullOr($value, $defaultMessage = null, $defaultPropertyPath = null)
    {
        return static::that($value, $defaultMessage, $defaultPropertyPath)->nullOr();
    }

    /**
     * Create a lazy assertion object.
     *
     * @return \Assert\LazyAssertion
     */
    public static function lazy()
    {
        return (new LazyAssertion())
            ->setExceptionClass(static::$lazyAssertionExceptionClass)
        ;
    }
}