class PHPUnit_Framework_Constraint_Callback

Constraint that evaluates against a specified closure.

@package PHPUnit @subpackage Framework_Constraint @author Sebastian Bergmann <sebastian@phpunit.de> @author Timon Rapp <timon@zaeda.net> @copyright 2002-2013 Sebastian Bergmann <sebastian@phpunit.de> @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License @link http://www.phpunit.de/

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Constraint_Callback

File

drupal/core/vendor/phpunit/phpunit/PHPUnit/Framework/Constraint/Callback.php, line 56

View source
class PHPUnit_Framework_Constraint_Callback extends PHPUnit_Framework_Constraint {
  private $callback;

  /**
   * @param callable $callback
   * @throws InvalidArgumentException
   */
  public function __construct($callback) {
    if (!is_callable($callback)) {
      throw new InvalidArgumentException(sprintf('Specified callback <%s> is not callable.', $this
        ->callbackToString($callback)));
    }
    $this->callback = $callback;
  }

  /**
   * Evaluates the constraint for parameter $value. Returns TRUE if the
   * constraint is met, FALSE otherwise.
   *
   * @param mixed $value Value or object to evaluate.
   * @return bool
   */
  protected function matches($other) {
    return call_user_func($this->callback, $other);
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return 'is accepted by specified callback';
  }
  private function callbackToString($callback) {
    if (!is_array($callback)) {
      return $callback;
    }
    if (empty($callback)) {
      return "empty array";
    }
    if (!isset($callback[0]) || !isset($callback[1])) {
      return "array without indexes 0 and 1 set";
    }
    if (is_object($callback[0])) {
      $callback[0] = get_class($callback[0]);
    }
    return $callback[0] . '::' . $callback[1];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PHPUnit_Framework_Constraint::additionalFailureDescription protected function Return additional failure description where needed 1
PHPUnit_Framework_Constraint::count public function Counts the number of constraint elements. 6
PHPUnit_Framework_Constraint::evaluate public function Evaluates the constraint for parameter $other 9
PHPUnit_Framework_Constraint::fail protected function Throws an exception for the given compared value and test description
PHPUnit_Framework_Constraint::failureDescription protected function Returns the description of the failure 15
PHPUnit_Framework_Constraint_Callback::$callback private property
PHPUnit_Framework_Constraint_Callback::callbackToString private function
PHPUnit_Framework_Constraint_Callback::matches protected function Evaluates the constraint for parameter $value. Returns TRUE if the constraint is met, FALSE otherwise. Overrides PHPUnit_Framework_Constraint::matches
PHPUnit_Framework_Constraint_Callback::toString public function Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_Callback::__construct public function