Class ContentsRegExp

ContentsRegExp

Namespace: Cake\TestSuite\Constraint\Console

Properties summary

Method Summary

Method Detail

__construct() public 

__construct(array $contents, string $output)

Constructor

Parameters

string[] $contents

Contents

string $output

Output type

additionalFailureDescription() protected 

additionalFailureDescription(mixed $other)

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

count() public 

count()

Counts the number of constraint elements.

evaluate() public 

evaluate(mixed $other, string $description, bool $returnResult)

Evaluates the constraint for parameter $other

If $returnResult is set to false (the default), an exception is thrown in case of a failure. null is returned otherwise.

If $returnResult is true, the result of the evaluation is returned as a boolean value instead: true in case of success, false in case of a failure.

Parameters

mixed $other
string $description optional
bool $returnResult optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

exporter() protected 

exporter()

fail() protected 

fail(mixed $other, mixed $description, \SebastianBergmann\Comparator\ComparisonFailure $comparisonFailure)

Throws an exception for the given compared value and test description

Parameters

mixed $other

evaluated value or object

string $description

Additional information about the test

\SebastianBergmann\Comparator\ComparisonFailure $comparisonFailure optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

failureDescription() public 

failureDescription(mixed $other)

Parameters

mixed $other

Expected

Returns

string

matches() public 

matches(mixed $other)

Checks if contents contain expected

Parameters

mixed $other

Expected

Returns

bool

toString() public 

toString()

Assertion message

Returns

string

Property Detail

$contents protected

Type

string

$output protected

Type

string

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.TestSuite.Constraint.Console.ContentsRegExp.html