Класс MailSentTo
MailSentTo
Краткое описание методов
-
__construct() public
Конструктор
-
additionalFailureDescription() protected
Возвращает дополнительное описание ошибки, если необходимо.
-
count() public
Подсчитывает количество элементов ограничения.
-
evaluate() public
Оценивает ограничение для параметра $other.
-
exporter() protected
-
fail() protected
Выбрасывает исключение для данного сравниваемого значения и описания теста.
-
failureDescription() protected
Возвращает описание ошибки.
-
failureDescriptionInContext() protected
Возвращает описание ошибки, когда данное ограничение появляется в контексте выражения $operator.
-
getMessages() public
Получает электронные письма или письма для проверки
-
matches() public
Проверка ограничения
-
reduce() protected
Уменьшает подвыражение, начинающееся с $this, пропуская вырожденные подвыражения, и возвращает первое дочернее ограничение, которое начинает несокращаемое подвыражение.
-
toString() public
Строка сообщения проверки
-
toStringInContext() protected
Возвращает пользовательское строковое представление объекта ограничения, когда он появляется в контексте выражения $operator.
Подробное описание методов
__construct() public
__construct(int|null $at = null, string|null $method = null): void
Конструктор
Параметры
-
int|null$at необязательный At
-
string|null$method необязательный Метод
Возвращаемое значение
voidadditionalFailureDescription() protected
additionalFailureDescription(mixed $other): string
Возвращает дополнительное описание ошибки, если необходимо.
Функция может быть переопределена для предоставления дополнительной информации об ошибке, например, разницу.
Параметры
-
mixed$other оцениваемое значение или объект
Возвращаемое значение
stringcount() public
count(): int
Подсчитывает количество элементов ограничения.
Возвращаемое значение
intevaluate() 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\InvalidArgumentExceptionExpectationFailedExceptionexporter() protected
exporter(): Exporter
Возвращаемое значение
Exporterfail() protected
fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null): void
Генерирует исключение для данного сравниваемого значения и описания теста.
Параметры
-
mixed$other оцениваемое значение или объект
-
string$description Дополнительная информация о тесте
-
ComparisonFailure$comparisonFailure необязательный
Возвращаемое значение
voidИсключения
SebastianBergmann\RecursionContext\InvalidArgumentExceptionExpectationFailedExceptionfailureDescription() protected
failureDescription(mixed $other): string
Возвращает описание ошибки.
Начало сообщений об ошибках, как правило, «Failed asserting that». Этот метод должен возвращать вторую часть этого предложения.
Для предоставления дополнительной информации об ошибке можно использовать additionalFailureDescription.
Параметры
-
mixed$other оцениваемое значение или объект
Возвращаемое значение
stringИсключения
SebastianBergmann\RecursionContext\InvalidArgumentExceptionfailureDescriptionInContext() protected
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string
Возвращает описание ошибки в контексте выражения $operator.
Цель этого метода — предоставить осмысленное описание ошибки в контексте операторов, таких как LogicalNot. Собственные ограничения PHPUnit поддерживаются LogicalNot по умолчанию, но внешние ограничения не имели возможности предоставлять правильные сообщения в этом контексте.
Метод должен возвращать пустую строку, если он не обрабатывает кастомизацию самостоятельно.
Параметры
-
Operator$operator оператор выражения $operator
-
mixed$role роль ограничения $this в выражении $operator
-
mixed$other оцениваемое значение или объект
Возвращаемое значение
stringgetMessages() public
getMessages(): Cake\Mailer\Message[]
Получает электронный адрес или адреса для проверки
Возвращаемое значение
Cake\Mailer\Message[]matches() public
matches(mixed $other): bool
Проверка ограничения
Этот метод может быть переопределён для реализации алгоритма оценки.
Параметры
-
mixed$other Проверка ограничения
Возвращаемое значение
boolreduce() protected
reduce(): self
Упрощает подвыражение, начинающееся с $this, пропуская вырожденные подвыражения, и возвращает первое дочернее ограничение, которое начинает невырожденное подвыражение.
Возвращает $this для конечных ограничений и для операторов, которые начинают невырожденное подвыражение, или ближайшее потомство $this, которое начинает невырожденное подвыражение.
Выражение ограничения можно смоделировать как дерево с нетерминальными узлами (операторами) и терминальными узлами. Например:
LogicalOr (оператор, нетерминал)
- LogicalAnd (оператор, нетерминал) | + IsType('int') (терминал) | + GreaterThan(10) (терминал)
- LogicalNot (оператор, нетерминал)
- IsType('array') (терминал)
Вырожденное подвыражение — это часть дерева, которая фактически не вносит вклад в оценку выражения, в котором она появляется. Примером вырожденного подвыражения является BinaryOperator, построенный с одним операндом или вложенными BinaryOperator, каждый с одним операндом. Выражение, включающее вырожденное подвыражение, эквивалентно упрощённому выражению с удалённым вырожденным подвыражением, например
LogicalAnd (оператор)
- LogicalOr (вырожденный оператор) | + LogicalAnd (вырожденный оператор) | + IsType('int') (терминал)
- GreaterThan(10) (терминал)
эквивалентно
LogicalAnd (оператор)
- IsType('int') (терминал)
- GreaterThan(10) (терминал)
потому что подвыражение
- LogicalOr
- LogicalAnd
- -
- LogicalAnd
вырожденное. Вызов reduce() для объекта LogicalOr выше, а также для LogicalAnd, должен возвращать экземпляр IsType('int').
Можно реализовать другие специфические упрощения, например, каскад операторов LogicalNot
- LogicalNot
- LogicalNot +LogicalNot
- IsTrue
- LogicalNot +LogicalNot
можно упростить до
LogicalNot
- IsTrue
Возвращаемое значение
selftoString() public
toString(): string
Строка сообщения утверждения
Возвращаемое значение
stringtoStringInContext() protected
toStringInContext(Operator $operator, mixed $role): string
Возвращает настраиваемую строку представления объекта ограничения, когда он появляется в контексте выражения $operator.
Цель этого метода — предоставить осмысленную описательную строку в контексте операторов, таких как LogicalNot. Собственные ограничения PHPUnit поддерживаются LogicalNot по умолчанию, но внешние ограничения не имели возможности предоставлять правильные строки в этом контексте.
Метод должен возвращать пустую строку, если он не обрабатывает кастомизацию самостоятельно.
Параметры
-
Operator$operator оператор выражения $operator
-
mixed$role роль ограничения $this в выражении $operator
Возвращаемое значение
stringПодробное описание свойств
$at protected
Тип
int|null$method protected
Тип
string
© 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.MailSentTo.html