PHPUnit\Framework\Constraint\StringMatchesFormatDescription Class Reference

Inheritance diagram for PHPUnit\Framework\Constraint\StringMatchesFormatDescription:

Detailed Description

...

Public Member Functions
	__construct (string $string)
Public Member Functions inherited from PHPUnit\Framework\Constraint\RegularExpression
	toString ()
Public Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
	evaluate ($other, string $description='', bool $returnResult=false)
	count ()

Protected Member Functions
	matches ($other)
	failureDescription ($other)
	additionalFailureDescription ($other)
Protected Member Functions inherited from PHPUnit\Framework\Constraint\Constraint
	exporter ()
	fail ($other, $description, ComparisonFailure $comparisonFailure=null)

Constructor & Destructor Documentation

__construct()

PHPUnit\Framework\Constraint\StringMatchesFormatDescription::__construct

(

string

$string

)

Reimplemented from PHPUnit\Framework\Constraint\RegularExpression.

Member Function Documentation

additionalFailureDescription()

PHPUnit\Framework\Constraint\StringMatchesFormatDescription::additionalFailureDescription (   $other )

protected

Return additional failure description where needed

The function can be overridden to provide additional failure information like a diff

Parameters

mixed

$other

evaluated value or object

Reimplemented from PHPUnit\Framework\Constraint\Constraint.

failureDescription()

PHPUnit\Framework\Constraint\StringMatchesFormatDescription::failureDescription (   $other )

protected

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.

To provide additional failure information additionalFailureDescription can be used.

Parameters

mixed

$other

evaluated value or object

Exceptions

Reimplemented from PHPUnit\Framework\Constraint\Constraint.

matches()

PHPUnit\Framework\Constraint\StringMatchesFormatDescription::matches (   $other )

protected

Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.

Parameters

mixed

$other

value or object to evaluate

Reimplemented from PHPUnit\Framework\Constraint\RegularExpression.

---

The documentation for this class was generated from the following file:

• vendor/phpunit/phpunit/src/Framework/Constraint/StringMatchesFormatDescription.php