1. class
  2. SilverStripe
  3. \
  4. Dev
  5. \
  6. Constraint
  7. \
  8. SSListContains

SSListContains

class SSListContains extends Constraint implements TestOnly (View source)

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

Methods

__construct($matches)

No description

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

Evaluates the constraint for parameter $other

string
toString()

Returns a string representation of the object.

Details

at line 40
__construct($matches)

Parameters

$matches

at line 72
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

at line 122
string toString()

Returns a string representation of the object.

Return Value

string