MailSubjectContains
int|null
Constructor
Return additional failure description where needed.
Counts the number of constraint elements.
Evaluates the constraint for parameter $other.
Throws an exception for the given compared value and test description.
Returns the description of the failure.
Returns the description of the failure when this constraint appears in context of an $operator expression.
Returns the subjects of all messages respects $this->at
Gets the email or emails to check
Checks constraint
Reduces the sub-expression starting at $this by skipping degenerate sub-expression and returns first descendant constraint that starts a non-reducible sub-expression.
Assertion message string
Returns a custom string representation of the constraint object when it appears in context of an $operator expression.
__construct(int|null $at = null): void
Constructor
int|null
$at optional At
void
additionalFailureDescription(mixed $other): string
Return additional failure description where needed.
The function can be overridden to provide additional failure information like a diff
mixed
$other evaluated value or object
string
count(): int
Counts the number of constraint elements.
int
evaluate(mixed $other, string $description = '', bool $returnResult = false): ?bool
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.
string
$description optional bool
$returnResult optional ?bool
SebastianBergmann\RecursionContext\InvalidArgumentException
ExpectationFailedException
exporter(): Exporter
Exporter
fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null): void
Throws an exception for the given compared value and test description.
mixed
$other evaluated value or object
string
$description Additional information about the test
ComparisonFailure
$comparisonFailure optional void
SebastianBergmann\RecursionContext\InvalidArgumentException
ExpectationFailedException
failureDescription(mixed $other): string
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.
mixed
$other evaluated value or object
string
SebastianBergmann\RecursionContext\InvalidArgumentException
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string
Returns the description of the failure when this constraint appears in context of an $operator expression.
The purpose of this method is to provide meaningful failure description in context of operators such as LogicalNot. Native PHPUnit constraints are supported out of the box by LogicalNot, but externally developed ones had no way to provide correct messages in this context.
The method shall return empty string, when it does not handle customization by itself.
Operator
$operator the $operator of the expression
mixed
$role role of $this constraint in the $operator expression
mixed
$other evaluated value or object
string
getAssertedMessages(): string
Returns the subjects of all messages respects $this->at
string
getMessages(): arrayCake\Mailer\Message>
Gets the email or emails to check
arrayCake\Mailer\Message>
matches(mixed $other): bool
Checks constraint
This method can be overridden to implement the evaluation algorithm.
mixed
$other Constraint check
bool
reduce(): self
Reduces the sub-expression starting at $this by skipping degenerate sub-expression and returns first descendant constraint that starts a non-reducible sub-expression.
Returns $this for terminal constraints and for operators that start non-reducible sub-expression, or the nearest descendant of $this that starts a non-reducible sub-expression.
A constraint expression may be modelled as a tree with non-terminal nodes (operators) and terminal nodes. For example:
LogicalOr (operator, non-terminal)
A degenerate sub-expression is a part of the tree, that effectively does not contribute to the evaluation of the expression it appears in. An example of degenerate sub-expression is a BinaryOperator constructed with single operand or nested BinaryOperators, each with single operand. An expression involving a degenerate sub-expression is equivalent to a reduced expression with the degenerate sub-expression removed, for example
LogicalAnd (operator)
is equivalent to
LogicalAnd (operator)
because the subexpression
is degenerate. Calling reduce() on the LogicalOr object above, as well as on LogicalAnd, shall return the IsType('int') instance.
Other specific reductions can be implemented, for example cascade of LogicalNot operators
can be reduced to
LogicalNot
self
toString(): string
Assertion message string
string
toStringInContext(Operator $operator, mixed $role): string
Returns a custom string representation of the constraint object when it appears in context of an $operator expression.
The purpose of this method is to provide meaningful descriptive string in context of operators such as LogicalNot. Native PHPUnit constraints are supported out of the box by LogicalNot, but externally developed ones had no way to provide correct strings in this context.
The method shall return empty string, when it does not handle customization by itself.
Operator
$operator the $operator of the expression
mixed
$role role of $this constraint in the $operator expression
string
int|null
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.TestSuite.Constraint.Email.MailSubjectContains.html