Класс MailContainsText
MailContainsText
Краткое описание свойств
Краткое описание методов
-
__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
Возвращает
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 оцениваемое значение или объект
Возвращает
stringgetAssertedMessages() protected
getAssertedMessages(): string
Возвращает строки сообщений, зависящие от типа, соответствующие $this->at
Возвращает
stringgetMessages() public
getMessages(): arrayCake\Mailer\Message>
Получает электронную почту или электронные письма для проверки
Возвращает
arrayCake\Mailer\Message>getTypeMethod() protected
getTypeMethod(): string
Возвращает
stringmatches() 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$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.3/class-Cake.TestSuite.Constraint.Email.MailContainsText.html