class PHPUnit_Framework_Constraint_Callback in Zircon Profile 8

Constraint that evaluates against a specified closure.

Hierarchy

• class \PHPUnit_Framework_Constraint implements \Countable, PHPUnit_Framework_SelfDescribing
  • class \PHPUnit_Framework_Constraint_Callback

File

vendor/phpunit/phpunit/src/Framework/Constraint/Callback.php, line 14

class PHPUnit_Framework_Constraint_Callback extends PHPUnit_Framework_Constraint {
  private $callback;

  /**
   * @param  callable                    $callback
   * @throws PHPUnit_Framework_Exception
   */
  public function __construct($callback) {
    if (!is_callable($callback)) {
      throw PHPUnit_Util_InvalidArgumentHelper::factory(1, 'callable');
    }
    parent::__construct();
    $this->callback = $callback;
  }

  /**
   * Evaluates the constraint for parameter $value. Returns true if the
   * constraint is met, false otherwise.
   *
   * @param  mixed $other 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';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPUnit_Framework_Constraint::$exporter	protected	property
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	17
PHPUnit_Framework_Constraint_Callback::$callback	private	property
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	Overrides PHPUnit_Framework_Constraint::__construct