Класс StatusCode
StatusCode
Краткое описание свойств
Краткое описание методов
-
__construct() public
Конструктор
-
_getBodyAsString() protected
Получить тело ответа в виде строки
-
additionalFailureDescription() protected
Возвращает дополнительное описание ошибки, если необходимо.
-
count() public
Подсчитывает количество элементов ограничения.
-
evaluate() public
Оценивает ограничение для параметра $other.
-
exporter() protected
-
fail() protected
Выбрасывает исключение для заданного сравниваемого значения и описания теста.
-
failureDescription() public
Описание ошибки
-
failureDescriptionInContext() protected
Возвращает описание ошибки, когда это ограничение используется в контексте выражения $operator.
-
matches() public
Проверка утверждения
-
reduce() protected
Уменьшает подвыражение, начинающееся с $this, пропуская вырожденные подвыражения, и возвращает первое ограничение потомка, которое начинает несокращаемое подвыражение.
-
statusCodeBetween() protected
Вспомогательная функция для проверки кодов состояния
-
toString() public
Сообщение утверждения
-
toStringInContext() protected
Возвращает настраиваемое строковое представление объекта ограничения, когда он используется в контексте выражения $operator.
Подробное описание методов
__construct() public
__construct(Psr\Http\Message\ResponseInterface|null $response)
Конструктор
Параметры
-
Psr\Http\Message\ResponseInterface|null$response Ответ
_getBodyAsString() protected
_getBodyAsString(): string
Получить тело ответа в виде строки
Возвращает
stringadditionalFailureDescription() 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() public
failureDescription(mixed $other): string
Описание ошибки
Начало сообщений об ошибках в большинстве случаев — "Failed asserting that". Этот метод должен возвращать вторую часть этого предложения.
Для предоставления дополнительной информации об ошибке можно использовать additionalFailureDescription.
Параметры
-
mixed$other Ожидаемый код
Возвращает
stringfailureDescriptionInContext() 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 Массив кодов статуса min/max или одиночный код
Возвращает
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
Возвращает
selfstatusCodeBetween() protected
statusCodeBetween(int $min, int $max): bool
Вспомогательная функция для проверки кодов состояния
Параметры
-
int$min Минимальный код состояния (включительно)
-
int$max Максимальный код состояния (включительно)
Возвращает
booltoString() public
toString(): string
Сообщение утверждения
Возвращает
stringtoStringInContext() protected
toStringInContext(Operator $operator, mixed $role): string
Возвращает настраиваемое строковое представление объекта ограничения, когда он появляется в контексте выражения $operator.
Цель этого метода — предоставить осмысленную описательную строку в контексте операторов, таких как LogicalNot. Встроенные ограничения PHPUnit поддерживаются LogicalNot «из коробки», но внешние разработанные ограничения не имели возможности предоставлять правильные строки в этом контексте.
Метод должен возвращать пустую строку, если он не обрабатывает настройку самостоятельно.
Параметры
-
Operator$operator оператор $operator выражения
-
mixed$role роль ограничения $this в выражении $operator
Возвращает
stringПодробное описание свойств
$code protected
Тип
int|array$response protected
Тип
Psr\Http\Message\ResponseInterface
© 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.Response.StatusCode.html