Spec-Zone.ru › CakePHP 4.4

Класс StatusCodeBase

StatusCodeBase

Абстрактный
Пространство имён: Cake\TestSuite\Constraint\Response

Краткое описание свойств

  • $code protected
    array<int, int>|int
  • $response protected
    Psr\Http\Message\ResponseInterface

Краткое описание методов

  • __construct() public

    Конструктор

  • _getBodyAsString() protected

    Получить тело ответа в виде строки

  • additionalFailureDescription() protected

    Возвращает дополнительное описание ошибки, если необходимо.

  • count() public

    Подсчитывает количество элементов ограничения.

  • evaluate() public

    Оценивает ограничение для параметра $other.

  • exporter() protected
  • fail() protected

    Выбрасывает исключение для заданного сравниваемого значения и описания теста.

  • failureDescription() protected

    Переопределяет описания, чтобы мы могли убрать автоматическое сообщение «ожидалось»

  • 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

Получить тело ответа в виде строки

Возвращает

string

additionalFailureDescription() protected

additionalFailureDescription(mixed $other): string

Возвратить дополнительное описание ошибки, если необходимо.

Функцию можно переопределить для предоставления дополнительной информации об ошибке, например, diff.

Параметры

mixed $other

оцениваемое значение или объект

Возвращает

string

count() public

count(): int

Подсчитывает количество элементов ограничения.

Возвращает

int

evaluate() public

evaluate(mixed $other, string $description = '', bool $returnResult = false): ?bool

Оценивает ограничение для параметра $other.

Если $returnResult задано false (по умолчанию), при возникновении ошибки выбрасывается исключение. В противном случае возвращается null.

Если $returnResult равно true, результат оценки возвращается как булево значение: true в случае успеха, false в случае ошибки.

Параметры

$other
string $description optional
bool $returnResult optional

Возвращает

?bool

Исключения

SebastianBergmann\RecursionContext\InvalidArgumentException

ExpectationFailedException

exporter() protected

exporter(): Exporter

Возвращает

Exporter

fail() protected

fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null): void

Выбрасывает исключение для заданного сравниваемого значения и описания теста.

Параметры

mixed $other

оцениваемое значение или объект

string $description

Дополнительная информация о тесте

ComparisonFailure $comparisonFailure optional

Возвращает

void

Исключения

SebastianBergmann\RecursionContext\InvalidArgumentException

ExpectationFailedException

failureDescription() protected

failureDescription(mixed $other): string

Переопределяет описания, чтобы удалить автоматическое сообщение «ожидаемое»

Начало сообщений об ошибках в большинстве случаев — «Не удалось утверждать, что». Этот метод должен возвращать вторую часть этого предложения.

Для предоставления дополнительной информации об ошибке можно использовать additionalFailureDescription.

Параметры

mixed $other

Значение

Возвращает

string

failureDescriptionInContext() protected

failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string

Возвращает описание ошибки, когда это ограничение появляется в контексте выражения $operator.

Цель этого метода — предоставить осмысленное описание ошибки в контексте операторов, таких как LogicalNot. Родные ограничения PHPUnit поддерживаются LogicalNot «из коробки», но внешние разработанные не имели способа предоставить правильные сообщения в этом контексте.

Метод должен возвращать пустую строку, если он сам не обрабатывает настройку.

Параметры

Operator $operator

оператор $operator выражения

mixed $role

роль ограничения $this в выражении $operator

mixed $other

оцениваемое значение или объект

Возвращает

string

matches() public

matches(mixed $other): bool

Проверка утверждения

Этот метод может быть переопределён для реализации алгоритма оценки.

Параметры

mixed $other

Массив кодов состояния min/max или один код

Возвращает

bool

reduce() 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
      • -

является вырожденным. Вызов reduce() для объекта LogicalOr выше, а также для LogicalAnd, должен вернуть экземпляр IsType('int').

Другие специфические упрощения могут быть реализованы, например, каскад операторов LogicalNot

  • LogicalNot
    • LogicalNot +LogicalNot
      • IsTrue

может быть упрощен до

LogicalNot

  • IsTrue

Возвращает

self

statusCodeBetween() protected

statusCodeBetween(int $min, int $max): bool

Вспомогательная функция для проверки кодов состояния

Параметры

int $min

Минимальный код состояния (включительно)

int $max

Максимальный код состояния (включительно)

Возвращает

bool

toString() public

toString(): string

Возвращает строковое представление объекта.

Возвращает

string

toStringInContext() protected

toStringInContext(Operator $operator, mixed $role): string

Возвращает настраиваемое строковое представление объекта ограничения, когда он появляется в контексте выражения $operator.

Цель этого метода — предоставить осмысленное описательное строковое представление в контексте операторов, таких как LogicalNot. Родные ограничения PHPUnit поддерживаются LogicalNot «из коробки», но внешние разработанные не имели способа предоставить правильные строки в этом контексте.

Метод должен возвращать пустую строку, если он сам не обрабатывает настройку.

Параметры

Operator $operator

оператор $operator выражения

mixed $role

роль ограничения $this в выражении $operator

Возвращает

string

Подробное описание свойств

$code protected

Тип

array<int, int>|int

$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.4/class-Cake.TestSuite.Constraint.Response.StatusCodeBase.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API