You are here

class PHPUnit_Framework_Constraint_ExceptionMessageRegExp in Zircon Profile 8

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

@since Class available since Release 4.3.0

Hierarchy

Expanded class hierarchy of PHPUnit_Framework_Constraint_ExceptionMessageRegExp

File

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

View source
class PHPUnit_Framework_Constraint_ExceptionMessageRegExp extends PHPUnit_Framework_Constraint {

  /**
   * @var int
   */
  protected $expectedMessageRegExp;

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

  /**
   * Evaluates the constraint for parameter $other. Returns true if the
   * constraint is met, false otherwise.
   *
   * @param  Exception $other
   * @return bool
   */
  protected function matches($other) {
    $match = PHPUnit_Util_Regex::pregMatchSafe($this->expectedMessageRegExp, $other
      ->getMessage());
    if (false === $match) {
      throw new PHPUnit_Framework_Exception("Invalid expected exception message regex given: '{$this->expectedMessageRegExp}'");
    }
    return 1 === $match;
  }

  /**
   * 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("exception message '%s' matches '%s'", $other
      ->getMessage(), $this->expectedMessageRegExp);
  }

  /**
   * @return string
   */
  public function toString() {
    return 'exception message matches ';
  }

}

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_ExceptionMessageRegExp::$expectedMessageRegExp protected property
PHPUnit_Framework_Constraint_ExceptionMessageRegExp::failureDescription protected function Returns the description of the failure Overrides PHPUnit_Framework_Constraint::failureDescription
PHPUnit_Framework_Constraint_ExceptionMessageRegExp::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_ExceptionMessageRegExp::toString public function Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_ExceptionMessageRegExp::__construct public function Overrides PHPUnit_Framework_Constraint::__construct