[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Assert
   5   *
   6   * LICENSE
   7   *
   8   * This source file is subject to the MIT license that is bundled
   9   * with this package in the file LICENSE.txt.
  10   * If you did not receive a copy of the license and are unable to
  11   * obtain it through the world-wide-web, please send an email
  12   * to [email protected] so I can send you a copy immediately.
  13   */
  14  
  15  namespace Assert;
  16  
  17  /**
  18   * Start validation on a value, returns {@link AssertionChain}.
  19   *
  20   * The invocation of this method starts an assertion chain
  21   * that is happening on the passed value.
  22   *
  23   * @param mixed $value
  24   * @param string|callable|null $defaultMessage
  25   * @param string $defaultPropertyPath
  26   *
  27   * @example
  28   *
  29   *  \Assert\that($value)->notEmpty()->integer();
  30   *  \Assert\that($value)->nullOr()->string()->startsWith("Foo");
  31   *
  32   * The assertion chain can be stateful, that means be careful when you reuse
  33   * it. You should never pass around the chain.
  34   */
  35  function that($value, $defaultMessage = null, string $defaultPropertyPath = null): AssertionChain
  36  {
  37      return Assert::that($value, $defaultMessage, $defaultPropertyPath);
  38  }
  39  
  40  /**
  41   * Start validation on a set of values, returns {@link AssertionChain}.
  42   *
  43   * @param mixed $values
  44   * @param string|callable|null $defaultMessage
  45   * @param string $defaultPropertyPath
  46   */
  47  function thatAll($values, $defaultMessage = null, string $defaultPropertyPath = null): AssertionChain
  48  {
  49      return Assert::thatAll($values, $defaultMessage, $defaultPropertyPath);
  50  }
  51  
  52  /**
  53   * Start validation and allow NULL, returns {@link AssertionChain}.
  54   *
  55   * @param mixed $value
  56   * @param string|callable|null $defaultMessage
  57   * @param string $defaultPropertyPath
  58   *
  59   * @deprecated In favour of Assert::thatNullOr($value, $defaultMessage = null, $defaultPropertyPath = null)
  60   */
  61  function thatNullOr($value, $defaultMessage = null, string $defaultPropertyPath = null): AssertionChain
  62  {
  63      return Assert::thatNullOr($value, $defaultMessage, $defaultPropertyPath);
  64  }
  65  
  66  /**
  67   * Create a lazy assertion object.
  68   */
  69  function lazy(): LazyAssertion
  70  {
  71      return Assert::lazy();
  72  }