Class MailContains
MailContains
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.
-
exporter() protected
-
fail() protected
Throws an exception for the given compared value and test description.
-
failureDescription() protected
Returns the description of the failure.
-
getAssertedMessages() protected
Returns the type-dependent strings of all messages respects $this->at
-
getMessages() public
Gets the email or emails to check
-
getTypeMethod() protected
-
matches() public
Checks constraint
-
toString() public
Assertion message string
Method Detail
__construct() ¶ public
__construct(int|null $at = null): voidConstructor
Parameters
-
int|null$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)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
-
$other -
string$description optional -
bool$returnResult optional
Throws
ExpectationFailedExceptionInvalidArgumentExceptionfail() ¶ protected
fail(mixed $other, string $description, ?ComparisonFailure $comparisonFailure = null): voidThrows 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
Returns
voidThrows
ExpectationFailedExceptionInvalidArgumentExceptionfailureDescription() ¶ 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
stringThrows
InvalidArgumentExceptiongetAssertedMessages() ¶ protected
getAssertedMessages(): stringReturns the type-dependent strings of all messages respects $this->at
Returns
stringgetMessages() ¶ public
getMessages(): Cake\Mailer\Message[]Gets the email or emails to check
Returns
Cake\Mailer\Message[]matches() ¶ public
matches(mixed $other): boolChecks constraint
This method can be overridden to implement the evaluation algorithm.
Parameters
-
mixed$other Constraint check
Returns
bool