class PHPUnit_Framework_Constraint_Or in Zircon Profile 8

Logical OR.

@since Class available since Release 3.0.0

Hierarchy

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

2 string references to 'PHPUnit_Framework_Constraint_Or'

PHPUnit_Framework_Constraint_Not::failureDescription in vendor/phpunit/phpunit/src/Framework/Constraint/Not.php

Returns the description of the failure

PHPUnit_Framework_Constraint_Not::toString in vendor/phpunit/phpunit/src/Framework/Constraint/Not.php

Returns a string representation of the constraint.

File

vendor/phpunit/phpunit/src/Framework/Constraint/Or.php, line 16

class PHPUnit_Framework_Constraint_Or extends PHPUnit_Framework_Constraint {

  /**
   * @var PHPUnit_Framework_Constraint[]
   */
  protected $constraints = array();

  /**
   * @param PHPUnit_Framework_Constraint[] $constraints
   */
  public function setConstraints(array $constraints) {
    $this->constraints = array();
    foreach ($constraints as $constraint) {
      if (!$constraint instanceof PHPUnit_Framework_Constraint) {
        $constraint = new PHPUnit_Framework_Constraint_IsEqual($constraint);
      }
      $this->constraints[] = $constraint;
    }
  }

  /**
   * 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) {
    $success = false;
    $constraint = null;
    foreach ($this->constraints as $constraint) {
      if ($constraint
        ->evaluate($other, $description, true)) {
        $success = true;
        break;
      }
    }
    if ($returnResult) {
      return $success;
    }
    if (!$success) {
      $this
        ->fail($other, $description);
    }
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    $text = '';
    foreach ($this->constraints as $key => $constraint) {
      if ($key > 0) {
        $text .= ' or ';
      }
      $text .= $constraint
        ->toString();
    }
    return $text;
  }

  /**
   * Counts the number of constraint elements.
   *
   * @return int
   * @since  Method available since Release 3.4.0
   */
  public function count() {
    $count = 0;
    foreach ($this->constraints as $constraint) {
      $count += count($constraint);
    }
    return $count;
  }

}

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::__construct	public	function		24
PHPUnit_Framework_Constraint_Or::$constraints	protected	property
PHPUnit_Framework_Constraint_Or::count	public	function	Counts the number of constraint elements. Overrides PHPUnit_Framework_Constraint::count
PHPUnit_Framework_Constraint_Or::evaluate	public	function	Evaluates the constraint for parameter $other Overrides PHPUnit_Framework_Constraint::evaluate
PHPUnit_Framework_Constraint_Or::setConstraints	public	function
PHPUnit_Framework_Constraint_Or::toString	public	function	Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString