Class ContentsEmpty

ContentsEmpty

Namespace: Cake\TestSuite\Constraint\Console

Properties summary

Method Summary

  • __construct() public

    Constructor

  • additionalFailureDescription() protected

    Return additional failure description where needed

  • count() public

    Counts the number of constraint elements.

  • evaluate() public

    Evaluates the constraint for parameter $other

  • fail() protected

    Throws an exception for the given compared value and test description

  • failureDescription() protected

    Overwrites the descriptions so we can remove the automatic "expected" message

  • matches() public

    Checks if contents are empty

  • toString() public

    Assertion message

Method Detail

__construct() public 

__construct(mixed $contents, mixed $output)

Constructor

Parameters

array $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.

Returns

string

count() public 

count()

Counts the number of constraint elements.

Returns

int

evaluate() public 

evaluate(mixed $other, mixed $description, mixed $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

Value or object to evaluate.

string $description optional

Additional information about the test

bool $returnResult optional

Whether to return a result or throw an exception

Returns

mixed

Throws

PHPUnit\Framework\ExpectationFailedException

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

failureDescription() protected 

failureDescription(mixed $other)

Overwrites the descriptions so we can remove the automatic "expected" message

Parameters

mixed $other

Value

Returns

string

matches() public 

matches(mixed $other)

Checks if contents are empty

Parameters

mixed $other

Expected

Returns

bool

toString() public 

toString()

Assertion message

Returns

string

Property Detail

$contents protected

Type

string

$exporter protected

Type

mixed

$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/3.9/class-Cake.TestSuite.Constraint.Console.ContentsEmpty.html