Spec-Zone.ru › CakePHP 4.2

Класс EventFiredWith

Ограничение EventFiredWith

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

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

  • $_dataKey protected
    string

    Ключ данных события

  • $_dataValue protected
    mixed

    Значение данных события

  • $_eventManager protected
    Cake\Event\EventManager

    Массив сгенерированных событий

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

  • __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(Cake\Event\EventManager $eventManager, string $dataKey, mixed $dataValue)

Конструктор

Параметры

Cake\Event\EventManager $eventManager

Менеджер событий для проверки

string $dataKey

Ключ данных

mixed $dataValue

Значение данных

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

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

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

Для предоставления дополнительной информации об ошибке можно использовать 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() public

matches(mixed $other): bool

Проверяет, есть ли событие в массиве fired

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

Параметры

mixed $other

Проверка ограничения

Возвращает

bool

Выбрасывает

PHPUnit\Framework\AssertionFailedError

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

вырожденное. Вызов 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

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

$_dataKey protected

Ключ данных события

Тип

string

$_dataValue protected

Значение данных события

Тип

mixed

$_eventManager protected

Массив срабатывающих событий

Тип

Cake\Event\EventManager

© 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.EventFiredWith.html

Spec-Zone.ru

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