Spec-Zone.ru › CakePHP 4.3

Класс ResponseBase

Базовая ограничение для ограничений ответа

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

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

  • $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() protected

    Оценивает ограничение для параметра $other. Возвращает true, если ограничение выполняется, иначе false.

  • reduce() protected

    Сводит подвыражение, начиная с $this, пропуская вырожденные подвыражения, и возвращает первое подчиненное ограничение, которое начинает не сводимое подвыражение.

  • 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

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

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

Параметры

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 необязательно
bool $returnResult необязательно

Возвращает

?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 необязательно

Возвращает

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

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

mixed $role

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

mixed $other

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

Возвращает

string

matches() protected

matches(mixed $other): bool

Оценивает ограничение для параметра $other. Возвращает true, если ограничение выполняется, и false в противном случае.

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

Параметры

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

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

mixed $role

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

Возвращает

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.ResponseBase.html

Spec-Zone.ru

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