class PHPUnit_Framework_Constraint_IsInstanceOf

Constraint that asserts that the object it is evaluated for is an instance of a given class.

The expected class name is passed in the constructor.

@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.0.0

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Constraint_IsInstanceOf

File

drupal/core/vendor/phpunit/phpunit/PHPUnit/Framework/Constraint/IsInstanceOf.php, line 62

View source
class PHPUnit_Framework_Constraint_IsInstanceOf extends PHPUnit_Framework_Constraint {

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

  /**
   * @param string $className
   */
  public function __construct($className) {
    $this->className = $className;
  }

  /**
   * 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) {
    return $other instanceof $this->className;
  }

  /**
   * 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('%s is an instance of class "%s"', PHPUnit_Util_Type::shortenedExport($other), $this->className);
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return sprintf('is instance of class "%s"', $this->className);
  }

}

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::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_IsInstanceOf::$className protected property
PHPUnit_Framework_Constraint_IsInstanceOf::failureDescription protected function Returns the description of the failure Overrides PHPUnit_Framework_Constraint::failureDescription
PHPUnit_Framework_Constraint_IsInstanceOf::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_IsInstanceOf::toString public function Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_IsInstanceOf::__construct public function