class SSListContains extends Constraint implements TestOnly (View source)

Constraint for checking if a SS_List contains items matching the given key-value pairs.

Properties

protected array $matches
protected SSListExporter $exporter
protected bool $hasLeftoverItems

Check if the list has left over items that don't match

Methods

public
__construct(array $matches)

No description

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

Evaluates the constraint for parameter $other

protected
bool
public
string
toString()

Returns a string representation of the object.

protected
string
getStubForToString()

No description

Details

__construct(array $matches)

No description

Parameters

array $matches

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

SS_List $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

bool|null

Exceptions

ExpectationFailedException

protected bool checkIfItemEvaluatesRemainingMatches(ViewableData $item)

No description

Parameters

ViewableData $item

Return Value

bool

string toString()

Returns a string representation of the object.

Return Value

string

protected string getStubForToString()

No description

Return Value

string