Class ContentsRegExp

__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 по умолчанию, но внешние ограничения не имели возможности предоставлять правильные строки в этом контексте.

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

Параметры

Возвращает