Spec-Zone.ru › CakePHP 4.3

Класс HeaderContains

HeaderContains

Пространство имён: Cake\TestSuite\Constraint\Response

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

  • $headerName protected
    string
  • $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, пропуская вырожденные подвыражения, и возвращает первое дочернее ограничение, которое начинает не-упрощаемое подвыражение.

  • toString() public

    Сообщение об утверждении

  • toStringInContext() protected

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

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

__construct() public

__construct(Psr\Http\Message\ResponseInterface $response, string $headerName)

Конструктор.

Параметры

Psr\Http\Message\ResponseInterface $response

Экземпляр ответа.

string $headerName

Имя заголовка

_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

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

Начало сообщений об ошибках обычно "Failed asserting that". Этот метод должен возвращать вторую часть этого предложения.

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

Параметры

mixed $other

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

Возвращает

string

Исключения

SebastianBergmann\RecursionContext\InvalidArgumentException

failureDescriptionInContext() protected

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

Возвращает описание ошибки в контексте выражения $operator.

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

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

Параметры

Operator $operator

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

mixed $role

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

mixed $other

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

Возвращает

string

matches() public

matches(mixed $other): bool

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

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

Параметры

mixed $other

Ожидаемое содержимое

Возвращает

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

toString() public

toString(): string

Сообщения об утверждениях

Возвращает

string

toStringInContext() protected

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

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

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

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

Параметры

Operator $operator

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

mixed $role

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

Возвращает

string

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

$headerName protected

Тип

string

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

Spec-Zone.ru

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