You are here

class PHPUnit_Framework_Constraint_IsEmpty in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/phpunit/phpunit/src/Framework/Constraint/IsEmpty.php \PHPUnit_Framework_Constraint_IsEmpty

Constraint that checks whether a variable is empty().

@since Class available since Release 3.5.0

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Constraint_IsEmpty

File

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

View source
class PHPUnit_Framework_Constraint_IsEmpty extends PHPUnit_Framework_Constraint {

  /**
   * Evaluates the constraint for parameter $other. Returns true if the
   * constraint is met, false otherwise.
   *
   * @param  mixed $other Value or object to evaluate.
   * @return bool
   */
  protected function matches($other) {
    if ($other instanceof Countable) {
      return count($other) === 0;
    }
    return empty($other);
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return 'is empty';
  }

  /**
   * 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) {
    $type = gettype($other);
    return sprintf('%s %s %s', $type[0] == 'a' || $type[0] == 'o' ? 'an' : 'a', $type, $this
      ->toString());
  }

}

Members

Namesort descending 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::__construct public function 24
PHPUnit_Framework_Constraint_IsEmpty::failureDescription protected function Returns the description of the failure Overrides PHPUnit_Framework_Constraint::failureDescription
PHPUnit_Framework_Constraint_IsEmpty::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_IsEmpty::toString public function Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString