Constraint
class Constraint implements Countable, SelfDescribing (View source)
Abstract base class for constraints which can be applied to any value.
Properties
| protected | $exporter |
Methods
No description
Evaluates the constraint for parameter $other
Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
Counts the number of constraint elements.
Throws an exception for the given compared value and test description
Return additional failure description where needed
Returns the description of the failure
Details
at line 26
__construct()
at line 49
mixed
evaluate(mixed $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.
at line 76
protected bool
matches(mixed $other)
Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
This method can be overridden to implement the evaluation algorithm.
at line 86
int
count()
Counts the number of constraint elements.
at line 100
protected
fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null)
Throws an exception for the given compared value and test description
at line 133
protected string
additionalFailureDescription(mixed $other)
Return additional failure description where needed
The function can be overridden to provide additional failure information like a diff
at line 151
protected string
failureDescription(mixed $other)
Returns the description of the failure
The beginning of failure messages is "Failed asserting that" in most cases. This method should return the second part of that sentence.
To provide additional failure information additionalFailureDescription can be used.