class ViewableDataContains extends Constraint implements TestOnly

Constraint for checking if a ViewableData (e.g. ArrayData or any DataObject) contains fields matching the given key-value pairs.

Methods

__construct(array $match)

ViewableDataContains constructor.

null|bool
evaluate(ViewableData $other, string $description = '', bool $returnResult = false)

Evaluates the constraint for parameter $other

string
toString()

Returns a string representation of the object.

Details

at line 30
__construct(array $match)

ViewableDataContains constructor.

Parameters

array $match

at line 62
null|bool evaluate(ViewableData $other, string $description = '', bool $returnResult = false)

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

ViewableData $other Value or object to evaluate.
string $description Additional information about the test
bool $returnResult Whether to return a result or throw an exception

Return Value

null|bool

Exceptions

ExpectationFailedException

at line 92
string toString()

Returns a string representation of the object.

Return Value

string