Class MailConstraintBase
Base class for all mail assertion constraints
Method Summary
-
__construct() public
Constructor
-
additionalFailureDescription() protected
Return additional failure description where needed
-
count() public
Counts the number of constraint elements.
-
evaluate() public
Evaluates the constraint for parameter $other
-
fail() protected
Throws an exception for the given compared value and test description
-
failureDescription() protected
Returns the description of the failure
-
getEmails() public
Gets the email or emails to check
-
matches() protected
Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
-
toString() public
Returns a string representation of the object.
Method Detail
__construct() ¶ public
__construct(int $at = null): voidConstructor
Parameters
-
int$at optional At
Returns
voidadditionalFailureDescription() ¶ protected
additionalFailureDescription(mixed $other): stringReturn additional failure description where needed
The function can be overridden to provide additional failure information like a diff
Parameters
-
mixed$other Evaluated value or object.
Returns
stringevaluate() ¶ public
evaluate(mixed $other, string $description = '', bool $returnResult = false): mixedEvaluates 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
-
mixed$other Value or object to evaluate.
-
string$description optional Additional information about the test
-
bool$returnResult optional Whether to return a result or throw an exception
Returns
mixedThrows
ExpectationFailedExceptionfail() ¶ protected
fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null)Throws an exception for the given compared value and test description
Parameters
-
mixed$other Evaluated value or object.
-
string$description Additional information about the test
-
ComparisonFailure$comparisonFailure optional
Throws
ExpectationFailedExceptionfailureDescription() ¶ protected
failureDescription(mixed $other): stringReturns 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.
Parameters
-
mixed$other Evaluated value or object.
Returns
stringgetEmails() ¶ public
getEmails(): Cake\Mailer\Email[]Gets the email or emails to check
Returns
Cake\Mailer\Email[]matches() ¶ protected
matches(mixed $other): boolEvaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
This method can be overridden to implement the evaluation algorithm.
Parameters
-
mixed$other Value or object to evaluate.
Returns
booltoString() ¶ public
toString(): stringReturns a string representation of the object.
Returns
string