Класс ContentsEmpty

__construct(array<string> $contents, string $output)

Конструктор

Параметры

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

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

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

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

Параметры

Возвращаемое значение

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

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

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

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

Параметры

Возвращаемое значение

matches(mixed $other): bool

Проверяет, пусто ли содержимое.

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

Параметры

Возвращаемое значение

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 «из коробки», но для разработанных самостоятельно ограничений не было способа предоставить правильные строки в этом контексте.

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

Параметры

Возвращаемое значение