Класс SessionHasKey
SessionHasKey
Краткое описание свойств
- $path protected
string
Краткое описание методов
-
__construct() public
Конструктор
-
additionalFailureDescription() protected
Возвращает дополнительное описание ошибки, если необходимо.
-
count() public
Подсчитывает количество элементов ограничения.
-
evaluate() public
Оценивает ограничение для параметра $other.
-
exporter() protected
-
fail() protected
Выбрасывает исключение для заданного сравниваемого значения и описания теста.
-
failureDescription() protected
Возвращает описание ошибки.
-
failureDescriptionInContext() protected
Возвращает описание ошибки в контексте выражения $operator.
-
matches() public
Сравнение значения сессии
-
reduce() protected
Упрощает подвыражение, начиная с $this, пропуская вырожденные подвыражения, и возвращает первое подчиненное ограничение, которое начинает несокращаемое подвыражение.
-
toString() public
Сообщение проверки
-
toStringInContext() protected
Возвращает настраиваемое строковое представление объекта ограничения, когда он появляется в контексте выражения $operator.
Подробное описание методов
__construct() public
__construct(string $path)
Конструктор
Параметры
-
string$path Путь к сессии
additionalFailureDescription() 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 оцениваемое значение или объект
Возвращаемое значение
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, созданный с одним операндом или вложенными 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Подробное описание свойств
$path 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.4/class-Cake.TestSuite.Constraint.Session.SessionHasKey.html