abstract class PHPUnit_Framework_Constraint_Composite in Zircon Profile 8

@since Class available since Release 3.1.0

Hierarchy

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

File

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

abstract class PHPUnit_Framework_Constraint_Composite extends PHPUnit_Framework_Constraint {

  /**
   * @var PHPUnit_Framework_Constraint
   */
  protected $innerConstraint;

  /**
   * @param PHPUnit_Framework_Constraint $innerConstraint
   */
  public function __construct(PHPUnit_Framework_Constraint $innerConstraint) {
    parent::__construct();
    $this->innerConstraint = $innerConstraint;
  }

  /**
   * Evaluates the constraint for parameter $other
   *
   * If $returnResult is set to false (the default), an exception is thrown
   * in case of a failure. null is returned otherwise.
   *
   * If $returnResult is true, the result of the evaluation is returned as
   * a boolean value instead: true in case of success, false in case of a
   * failure.
   *
   * @param  mixed                                        $other        Value or object to evaluate.
   * @param  string                                       $description  Additional information about the test
   * @param  bool                                         $returnResult Whether to return a result or throw an exception
   * @return mixed
   * @throws PHPUnit_Framework_ExpectationFailedException
   */
  public function evaluate($other, $description = '', $returnResult = false) {
    try {
      return $this->innerConstraint
        ->evaluate($other, $description, $returnResult);
    } catch (PHPUnit_Framework_ExpectationFailedException $e) {
      $this
        ->fail($other, $description);
    }
  }

  /**
   * Counts the number of constraint elements.
   *
   * @return int
   */
  public function count() {
    return count($this->innerConstraint);
  }

}

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::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::matches	protected	function	Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.	25
PHPUnit_Framework_Constraint_Composite::$innerConstraint	protected	property
PHPUnit_Framework_Constraint_Composite::count	public	function	Counts the number of constraint elements. Overrides PHPUnit_Framework_Constraint::count
PHPUnit_Framework_Constraint_Composite::evaluate	public	function	Evaluates the constraint for parameter $other Overrides PHPUnit_Framework_Constraint::evaluate	1
PHPUnit_Framework_Constraint_Composite::__construct	public	function	Overrides PHPUnit_Framework_Constraint::__construct	1
PHPUnit_Framework_SelfDescribing::toString	public	function	Returns a string representation of the object.	57