respect-validation/docs/rules/Equivalent.md
Henrique Moody 48405271c5
Replace placeholder "name" with "subject"
The `{{name}}` placeholder could represent different things depending on
the state of the Result, and referring to it as `{{name}}` seems
arbitrary. This commit changes it to `{{subject}}`, which is much more
generic and it describes well what that placeholder can mean.
2025-12-26 21:30:01 +01:00

1.4 KiB

Equivalent

  • Equivalent(mixed $compareTo)

Validates if the input is equivalent to some value.

v::equivalent(1)->isValid(true); // true
v::equivalent('Something')->isValid('someThing'); // true
v::equivalent(new ArrayObject([1, 2, 3, 4, 5]))->isValid(new ArrayObject([1, 2, 3, 4, 5])); // true

This rule 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: