PHPUnit\Framework\Constraint\StringMatchesFormatDescription Class Reference

Inheritance diagram for PHPUnit\Framework\Constraint\StringMatchesFormatDescription:

Collaboration diagram for PHPUnit\Framework\Constraint\StringMatchesFormatDescription:

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

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

Protected Attributes
	$string
Protected Attributes inherited from PHPUnit\Framework\Constraint\RegularExpression
	$pattern
Protected Attributes inherited from PHPUnit\Framework\Constraint\Constraint
	$exporter

Detailed Description

...

Constructor & Destructor Documentation

__construct()

PHPUnit\Framework\Constraint\StringMatchesFormatDescription::__construct

(

$string

)

Parameters

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.

Returns

string

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.

Returns

string

Reimplemented from PHPUnit\Framework\Constraint\Constraint.

---

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

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