W3cubDocs

/CakePHP 4.1

Class MailConstraintBase

Base class for all mail assertion constraints

Abstract
Namespace: Cake\TestSuite\Constraint\Email

Properties summary

  • $at protected
    int|null

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

  • getMessages() 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)

Constructor

Parameters

int|null $at optional

At

additionalFailureDescription() protected 

additionalFailureDescription(mixed $other)

Return 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

count() public 

count()

Counts the number of constraint elements.

evaluate() public 

evaluate(mixed $other, string $description, bool $returnResult)

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

mixed $other
string $description optional
bool $returnResult optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

exporter() protected 

exporter()

fail() protected 

fail(mixed $other, mixed $description, \SebastianBergmann\Comparator\ComparisonFailure $comparisonFailure)

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

\SebastianBergmann\Comparator\ComparisonFailure $comparisonFailure optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

failureDescription() protected 

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.

Parameters

mixed $other

evaluated value or object

Throws

SebastianBergmann\RecursionContext\InvalidArgumentException

getMessages() public 

getMessages()

Gets the email or emails to check

Returns

\Cake\Mailer\Message[]

matches() protected 

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.

Parameters

mixed $other

value or object to evaluate

toString() public 

toString()

Returns a string representation of the object.

Property Detail

$at protected

Type

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.1/class-Cake.TestSuite.Constraint.Email.MailConstraintBase.html