Spec-Zone.ru › CakePHP 4.2

Класс MailContainsAttachment

MailContainsAttachment

Пространство имён: Cake\TestSuite\Constraint\Email

Краткое описание свойств

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

    Тип почты для проверки содержимого

Краткое описание методов

  • __construct() public

    Конструктор

  • additionalFailureDescription() protected

    Возвращает дополнительное описание ошибки, если необходимо.

  • count() public

    Подсчитывает количество элементов ограничения.

  • evaluate() public

    Оценивает ограничение для параметра $other.

  • exporter() protected
  • fail() protected

    Выбрасывает исключение для заданного сравниваемого значения и описания теста.

  • failureDescription() protected

    Перезаписывает описания, чтобы мы могли удалить автоматическое сообщение "ожидаемое"

  • failureDescriptionInContext() protected

    Возвращает описание ошибки, когда это ограничение появляется в контексте выражения $operator.

  • getAssertedMessages() protected

    Возвращает строки сообщений, зависящие от типа, учитывая $this->at

  • getMessages() public

    Получает почту или почты для проверки

  • getTypeMethod() protected
  • matches() public

    Проверка ограничения

  • reduce() protected

    Уменьшает подвыражение, начиная с $this, пропуская вырожденные подвыражения, и возвращает первое дочернее ограничение, которое начинает нередуцируемое подвыражение.

  • toString() public

    Строка сообщения проверки

  • toStringInContext() protected

    Возвращает настраиваемую строковую форму объекта ограничения, когда он появляется в контексте выражения $operator.

Подробное описание методов

__construct() public

__construct(int|null $at = null): void

Конструктор

Параметры

int|null $at необязательно

At

Возвращает

void

additionalFailureDescription() protected

additionalFailureDescription(mixed $other): string

Возвращает дополнительное описание ошибки, если необходимо.

Функция может быть переопределена для предоставления дополнительной информации об ошибке, например, diff.

Параметры

mixed $other

оцениваемое значение или объект

Возвращает

string

count() public

count(): int

Подсчитывает количество элементов ограничения.

Возвращает

int

evaluate() public

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

Оценивает ограничение для параметра $other.

Если $returnResult установлен в false (по умолчанию), при ошибке выбрасывается исключение. В противном случае возвращается null.

Если $returnResult установлен в true, результатом оценки является булево значение: true в случае успеха, false в случае ошибки.

Параметры

$other
string $description необязательно
bool $returnResult необязательно

Возвращает

?bool

Выбрасывает

SebastianBergmann\RecursionContext\InvalidArgumentException

ExpectationFailedException

exporter() protected

exporter(): Exporter

Возвращает

Exporter

fail() protected

fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null): void

Выбрасывает исключение для заданного сравниваемого значения и описания теста.

Параметры

mixed $other

оцениваемое значение или объект

string $description

Дополнительная информация о тесте

ComparisonFailure $comparisonFailure необязательно

Возвращает

void

Выбрасывает

SebastianBergmann\RecursionContext\InvalidArgumentException

ExpectationFailedException

failureDescription() protected

failureDescription(mixed $other): string

Перезаписывает описания, чтобы можно было удалить автоматическое сообщение "ожидаемое"

Начало сообщений об ошибках в большинстве случаев — "Failed asserting that". Этот метод должен возвращать вторую часть этого предложения.

Для предоставления дополнительной информации об ошибке можно использовать additionalFailureDescription.

Параметры

mixed $other

Значение

Возвращает

string

failureDescriptionInContext() protected

failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string

Возвращает описание ошибки в контексте выражения $operator.

Целью этого метода является предоставление осмысленного описания ошибки в контексте операторов, таких как LogicalNot. Собственные ограничения PHPUnit поддерживаются по умолчанию LogicalNot, но внешние разработанные не имели возможности предоставлять корректные сообщения в этом контексте.

Метод должен возвращать пустую строку, если он сам не обрабатывает кастомизацию.

Параметры

Operator $operator

оператор $operator выражения

mixed $role

роль ограничения $this в выражении $operator

mixed $other

оцениваемое значение или объект

Возвращает

string

getAssertedMessages() protected

getAssertedMessages(): string

Возвращает строковые значения сообщений, зависящие от типа, соответствующие $this->at

Возвращает

string

getMessages() public

getMessages(): Cake\Mailer\Message[]

Получает электронную почту или электронные письма для проверки

Возвращает

Cake\Mailer\Message[]

getTypeMethod() protected

getTypeMethod(): string

Возвращает

string

matches() public

matches(mixed $other): bool

Проверка ограничения

Этот метод может быть переопределён для реализации алгоритма оценки.

Параметры

mixed $other

Проверка ограничения

Возвращает

bool

reduce() protected

reduce(): self

Сжимает подвыражение, начиная с $this, пропуская вырожденные подвыражения, и возвращает первое дочернее ограничение, которое начинает несокращаемое подвыражение.

Возвращает $this для терминальных ограничений и для операторов, которые начинают несокращаемое подвыражение, или ближайшее потомство $this, которое начинает несокращаемое подвыражение.

Выражение ограничения можно смоделировать как дерево с нетерминальными узлами (операторами) и терминальными узлами. Например:

LogicalOr (оператор, нетерминальный)

  • LogicalAnd (оператор, нетерминальный) | + IsType('int') (терминальный) | + GreaterThan(10) (терминальный)
  • LogicalNot (оператор, нетерминальный)
    • IsType('array') (терминальный)

Вырожденное подвыражение — это часть дерева, которая фактически не вносит вклад в оценку выражения, в котором она появляется. Пример вырожденного подвыражения — это BinaryOperator, построенный с одним операндом или вложенными BinaryOperators, каждый из которых имеет один операнд. Выражение, включающее вырожденное подвыражение, эквивалентно сокращённому выражению с удалённым вырожденным подвыражением, например

LogicalAnd (оператор)

  • LogicalOr (вырожденный оператор) | + LogicalAnd (вырожденный оператор) | + IsType('int') (терминальный)
  • GreaterThan(10) (терминальный)

эквивалентно

LogicalAnd (оператор)

  • IsType('int') (терминальный)
  • GreaterThan(10) (терминальный)

потому что подвыражение

  • LogicalOr
    • LogicalAnd
      • -

вырожденное. Вызов reduce() для объекта LogicalOr выше, а также для LogicalAnd, должен вернуть экземпляр IsType('int').

Можно реализовать другие специфические сокращения, например, каскад операторов LogicalNot

  • LogicalNot
    • LogicalNot +LogicalNot
      • IsTrue

может быть сокращено до

LogicalNot

  • IsTrue

Возвращает

self

toString() public

toString(): string

Строка сообщения утверждения

Возвращает

string

toStringInContext() protected

toStringInContext(Operator $operator, mixed $role): string

Возвращает пользовательское строковое представление объекта ограничения, когда он появляется в контексте выражения $operator.

Целью этого метода является предоставление осмысленной описательной строки в контексте операторов, таких как LogicalNot. Собственные ограничения PHPUnit поддерживаются по умолчанию LogicalNot, но внешние разработанные не имели возможности предоставлять корректные строки в этом контексте.

Метод должен возвращать пустую строку, если он сам не обрабатывает кастомизацию.

Параметры

Operator $operator

оператор $operator выражения

mixed $role

роль ограничения $this в выражении $operator

Возвращает

string

Подробное описание свойств

$at protected

Тип

int|null

$type protected

Тип почты для проверки содержимого

Тип

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API