class PHPUnit_Framework_Constraint_IsInstanceOf in Zircon Profile 8

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.

@since Class available since Release 3.0.0

Hierarchy

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

File

vendor/phpunit/phpunit/src/Framework/Constraint/IsInstanceOf.php, line 19

class PHPUnit_Framework_Constraint_IsInstanceOf extends PHPUnit_Framework_Constraint {

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

  /**
   * @param string $className
   */
  public function __construct($className) {
    parent::__construct();
    $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 %s "%s"', $this->exporter
      ->shortenedExport($other), $this
      ->getType(), $this->className);
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return sprintf('is instance of %s "%s"', $this
      ->getType(), $this->className);
  }
  private function getType() {
    try {
      $reflection = new ReflectionClass($this->className);
      if ($reflection
        ->isInterface()) {
        return 'interface';
      }
    } catch (ReflectionException $e) {
    }
    return 'class';
  }

}

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_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::getType	private	function
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	Overrides PHPUnit_Framework_Constraint::__construct