class PHPUnit_Framework_Constraint_TraversableContainsOnly in Zircon Profile 8

Constraint that asserts that the Traversable it is applied to contains only values of a given type.

@since Class available since Release 3.1.4

Hierarchy

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

File

vendor/phpunit/phpunit/src/Framework/Constraint/TraversableContainsOnly.php, line 17

class PHPUnit_Framework_Constraint_TraversableContainsOnly extends PHPUnit_Framework_Constraint {

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

  /**
   * @var string
   */
  protected $type;

  /**
   * @param string $type
   * @param bool   $isNativeType
   */
  public function __construct($type, $isNativeType = true) {
    parent::__construct();
    if ($isNativeType) {
      $this->constraint = new PHPUnit_Framework_Constraint_IsType($type);
    }
    else {
      $this->constraint = new PHPUnit_Framework_Constraint_IsInstanceOf($type);
    }
    $this->type = $type;
  }

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

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return 'contains only values of type "' . $this->type . '"';
  }

}

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::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_TraversableContainsOnly::$constraint	protected	property
PHPUnit_Framework_Constraint_TraversableContainsOnly::$type	protected	property
PHPUnit_Framework_Constraint_TraversableContainsOnly::evaluate	public	function	Evaluates the constraint for parameter $other Overrides PHPUnit_Framework_Constraint::evaluate
PHPUnit_Framework_Constraint_TraversableContainsOnly::toString	public	function	Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_TraversableContainsOnly::__construct	public	function	Overrides PHPUnit_Framework_Constraint::__construct