Класс ExitCode

__construct(int|null $exitCode)

Конструктор

Параметры

additionalFailureDescription(mixed $other): string

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

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

Параметры

Возвращает

count(): int

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

Возвращает

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

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

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

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

Параметры

Возвращает

Исключения

exporter(): Exporter

Возвращает

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

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

Параметры

Возвращает

Исключения

failureDescription(mixed $other): string

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

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

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

Параметры

Возвращает

Исключения

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

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

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

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

Параметры

Возвращает

matches(mixed $other): bool

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

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

Параметры

Возвращает

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

Возвращает

toString(): string

Строка сообщения проверки

Возвращает

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

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

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

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

Параметры

Возвращает