respect-validation/docs/validators/Equivalent.md
Henrique Moody d2198dfd01
Replace isValid() calls with assert()
There's more value on showing how `assert()` displays the validation
messages than simply showing if `isValid()` returns `true` or `false`.

However, that increases the chances of having outdated documentation, so
I created a doc linter that updates the Markdown files with the
correct message.
2026-01-13 23:37:06 -07:00

1.5 KiB

Equivalent

  • Equivalent(mixed $compareTo)

Validates if the input is equivalent to some value.

v::equivalent(1)->assert(true);
// Validation passes successfully

v::equivalent('Something')->assert('someThing');
// Validation passes successfully

v::equivalent(new ArrayObject([1, 2, 3, 4, 5]))->assert(new ArrayObject([1, 2, 3, 4, 5]));
// Validation passes successfully

This validator is very similar to Equals but it does not make case-sensitive comparisons.

Message template for this validator includes {{compareTo}}.

Templates

Equivalent::TEMPLATE_STANDARD

Mode Template
default {{subject}} must be equivalent to {{compareTo}}
inverted {{subject}} must not be equivalent to {{compareTo}}

Template placeholders

Placeholder Description
compareTo Value to be compared against the input.
subject The validated input or the custom validator name (if specified).

Categorization

  • Comparisons

Changelog

Version Description
2.0.0 Created

See also: