Class MailContainsAttachment

MailContainsAttachment

Namespace: Cake\TestSuite\Constraint\Email

Properties summary

  • $at protected
    int|null
  • $type protected
    string|null

    Mail type to check contents of

Method Summary

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)

Overwrites the descriptions so we can remove the automatic "expected" message

Parameters

mixed $other

Value

Returns

string

getAssertedMessages() protected 

getAssertedMessages()

Returns the type-dependent strings of all messages respects $this->at

Returns

string

getMessages() public 

getMessages()

Gets the email or emails to check

Returns

\Cake\Mailer\Message[]

getTypeMethod() protected 

getTypeMethod()

Returns

string

matches() public 

matches(mixed $other)

Checks constraint

Parameters

mixed $other

Constraint check

Returns

bool

toString() public 

toString()

Assertion message string

Returns

string

Property Detail

$at protected

Type

int|null

$type protected

Mail type to check contents of

Type

string|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.MailContainsAttachment.html