final class ArraySubset extends Constraint (View source)

Constraint that asserts that the array it is evaluated for has a specified subset.

Uses array_replace_recursive() to check if a key value subset is part of the subject array.

Methods

__construct(iterable $subset, bool $strict = false)

No description

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

Evaluates the constraint for parameter $other

string
toString()

Returns a string representation of the constraint.

Details

__construct(iterable $subset, bool $strict = false)

Parameters

iterable $subset
bool $strict

bool|null evaluate($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

$other
string $description
bool $returnResult

Return Value

bool|null

Exceptions

ExpectationFailedException
InvalidArgumentException

string toString()

Returns a string representation of the constraint.

Return Value

string

Exceptions

InvalidArgumentException