Class EventFiredWith

EventFiredWith constraint

Namespace: Cake\TestSuite\Constraint

Properties summary

Method Summary

Method Detail

__construct() public 

__construct(mixed $eventManager, mixed $dataKey, mixed $dataValue)

Constructor

Parameters

\Cake\Event\EventManager $eventManager

Event manager to check

string $dataKey

Data key

string $dataValue

Data value

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)

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

matches() public 

matches(mixed $other)

Checks if event is in fired array

Parameters

mixed $other

Constraint check

Returns

bool

toString() public 

toString()

Assertion message string

Returns

string

Property Detail

$_dataKey protected

Event data key

Type

string

$_dataValue protected

Event data value

Type

string

$_eventManager protected

Array of fired events

Type

\Cake\Event\EventManager

$exporter protected

Type

mixed

© 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.EventFiredWith.html