class PHPUnit_Framework_Constraint_TraversableContainsOnly

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

@package PHPUnit @subpackage Framework_Constraint @author Sebastian Bergmann <sebastian@phpunit.de> @author Bernhard Schussek <bschussek@2bepublished.at> @copyright 2001-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/ @since Class available since Release 3.1.4

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Constraint_TraversableContainsOnly

File

drupal/core/vendor/phpunit/phpunit/PHPUnit/Framework/Constraint/TraversableContainsOnly.php, line 60

View source
class PHPUnit_Framework_Constraint_TraversableContainsOnly extends PHPUnit_Framework_Constraint {

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

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

  /**
   * @param string  $type
   * @param boolean $isNativeType
   */
  public function __construct($type, $isNativeType = TRUE) {
    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;
    $constraint = NULL;
    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

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::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::matches protected function Evaluates the constraint for parameter $other. Returns TRUE if the constraint is met, FALSE otherwise. 23
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