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

SSListContainsOnlyMatchingItems

class SSListContainsOnlyMatchingItems extends Constraint implements TestOnly (View source)

Constraint for checking if every item in a SS_List matches a given match, e.g. every Member has isActive set to true

Properties

protected deprecated SSListExporter $exporter

Methods

public
__construct($match)

No description

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

Evaluates the constraint for parameter $other

public
string
toString()

Returns a string representation of the object.

Details

at line 32
__construct($match)

No description

Parameters

$match

at line 56
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 81
string toString()

Returns a string representation of the object.

Return Value

string