Класс MailConstraintBase
Базовый класс для всех ограничений проверки почтовых адресов
Краткое описание свойств
- $at protected
int|null
Краткое описание методов
-
__construct() public
Конструктор
-
additionalFailureDescription() protected
Возвращает дополнительное описание ошибки, если необходимо.
-
count() public
Подсчитывает количество элементов ограничения.
-
evaluate() public
Оценивает ограничение для параметра $other.
-
exporter() protected
-
fail() protected
Выбрасывает исключение для заданного сравниваемого значения и описания теста.
-
failureDescription() protected
Возвращает описание ошибки.
-
failureDescriptionInContext() protected
Возвращает описание ошибки в контексте выражения с оператором $operator.
-
getMessages() public
Получает электронные письма или список писем для проверки
-
matches() protected
Оценивает ограничение для параметра $other. Возвращает true, если ограничение выполняется, в противном случае — false.
-
reduce() protected
Уменьшает подвыражение, начиная с $this, пропуская вырожденные подвыражения и возвращает первое ограничение потомка, которое начинает не-редуцируемое подвыражение.
-
toString() public
Возвращает строковое представление объекта.
-
toStringInContext() protected
Возвращает пользовательское строковое представление объекта ограничения, когда он появляется в контексте выражения с оператором $operator.
Подробное описание методов
__construct() public
__construct(int|null $at = null): void
Конструктор
Параметры
-
int|null$at необязательно At
Возвращает
voidadditionalFailureDescription() protected
additionalFailureDescription(mixed $other): string
Возвращает дополнительное описание ошибки, если необходимо.
Функция может быть переопределена для предоставления дополнительной информации об ошибке, например, diff.
Параметры
-
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(): arrayCake\Mailer\Message>
Получает адрес электронной почты или адреса электронной почты для проверки
Возвращает
arrayCake\Mailer\Message>matches() protected
matches(mixed $other): bool
Оценивает ограничение для параметра $other. Возвращает true, если ограничение выполняется, иначе - false.
Этот метод может быть переопределен для реализации алгоритма оценки.
Параметры
-
mixed$other значение или объект для оценки
Возвращает
boolreduce() 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
- -
- 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
© 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.3/class-Cake.TestSuite.Constraint.Email.MailConstraintBase.html