class PHPUnit_Framework_Constraint_Exception in Zircon Profile 8

@since Class available since Release 3.6.6

Hierarchy

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

File

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

class PHPUnit_Framework_Constraint_Exception 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) {
    if ($other !== null) {
      $message = '';
      if ($other instanceof Exception) {
        $message = '. Message was: "' . $other
          ->getMessage() . '" at' . "\n" . $other
          ->getTraceAsString();
      }
      return sprintf('exception of type "%s" matches expected exception "%s"%s', get_class($other), $this->className, $message);
    }
    return sprintf('exception of type "%s" is thrown', $this->className);
  }

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

}

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