respect-validation/docs/validators/Equivalent.md
Alexandre Gomes Gaigalas d9cdc118b2 Introduce REUSE compliance
This commit introduces REUSE compliance by annotating all files
with SPDX information and placing the reused licences in the
LICENSES folder.

We additionally removed the docheader tool which is made obsolete
by this change.

The main LICENSE and copyright text of the project is now not under
my personal name anymore, and it belongs to "The Respect Project
Contributors" instead.

This change restores author names to several files, giving the
appropriate attribution for contributions.
2026-01-21 06:28:11 +00:00

1.6 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: