class PHPUnit_Framework_Constraint_Count in Zircon Profile 8

@since Class available since Release 3.6.0

Hierarchy

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

File

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

class PHPUnit_Framework_Constraint_Count extends PHPUnit_Framework_Constraint {

  /**
   * @var int
   */
  protected $expectedCount = 0;

  /**
   * @param int $expected
   */
  public function __construct($expected) {
    parent::__construct();
    $this->expectedCount = $expected;
  }

  /**
   * Evaluates the constraint for parameter $other. Returns true if the
   * constraint is met, false otherwise.
   *
   * @param  mixed $other
   * @return bool
   */
  protected function matches($other) {
    return $this->expectedCount === $this
      ->getCountOf($other);
  }

  /**
   * @param  mixed $other
   * @return bool
   */
  protected function getCountOf($other) {
    if ($other instanceof Countable || is_array($other)) {
      return count($other);
    }
    elseif ($other instanceof Traversable) {
      if ($other instanceof IteratorAggregate) {
        $iterator = $other
          ->getIterator();
      }
      else {
        $iterator = $other;
      }
      $key = $iterator
        ->key();
      $count = iterator_count($iterator);

      // manually rewind $iterator to previous key, since iterator_count
      // moves pointer
      if ($key !== null) {
        $iterator
          ->rewind();
        while ($iterator
          ->valid() && $key !== $iterator
          ->key()) {
          $iterator
            ->next();
        }
      }
      return $count;
    }
  }

  /**
   * Returns the description of the failure
   *
   * The beginning of failure messages is "Failed asserting that" in most
   * cases. This method should return the second part of that sentence.
   *
   * @param  mixed  $other Evaluated value or object.
   * @return string
   */
  protected function failureDescription($other) {
    return sprintf('actual size %d matches expected size %d', $this
      ->getCountOf($other), $this->expectedCount);
  }

  /**
   * @return string
   */
  public function toString() {
    return sprintf('count matches %d', $this->expectedCount);
  }

}

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_Count::$expectedCount	protected	property		1
PHPUnit_Framework_Constraint_Count::failureDescription	protected	function	Returns the description of the failure Overrides PHPUnit_Framework_Constraint::failureDescription
PHPUnit_Framework_Constraint_Count::getCountOf	protected	function
PHPUnit_Framework_Constraint_Count::matches	protected	function	Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise. Overrides PHPUnit_Framework_Constraint::matches
PHPUnit_Framework_Constraint_Count::toString	public	function	Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_Count::__construct	public	function	Overrides PHPUnit_Framework_Constraint::__construct	1