CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.10 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.10
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
      • Constraint
        • Console
        • Email
        • Response
        • Session
        • View
      • Fixture
      • Stub
    • Utility
    • Validation
    • View

Class MailConstraintBase

Base class for all mail assertion constraints

Abstract
Namespace: Cake\TestSuite\Constraint\Email

Property Summary

  • $at protected
    int|null
  • $exporter protected

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): void

Constructor

Parameters
int $at optional

At

Returns
void

additionalFailureDescription() ¶ protected

additionalFailureDescription(mixed $other): string

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.

Returns
string

count() ¶ public

count(): int

Counts the number of constraint elements.

Returns
int

evaluate() ¶ public

evaluate(mixed $other, string $description = '', bool $returnResult = false): mixed

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

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
mixed
Throws
ExpectationFailedException

fail() ¶ 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
ExpectationFailedException

failureDescription() ¶ protected

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.

Parameters
mixed $other

Evaluated value or object.

Returns
string

getEmails() ¶ public

getEmails(): Cake\Mailer\Email[]

Gets the email or emails to check

Returns
Cake\Mailer\Email[]

matches() ¶ protected

matches(mixed $other): bool

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.

Returns
bool

toString() ¶ public

toString(): string

Returns a string representation of the object.

Returns
string

Property Detail

$at ¶ protected

Type
int|null

$exporter ¶ protected

Type

OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs