ContextQMD
Back to Validation

Equivalent

docs/validators/Equivalent.md

3.1.11.7 KB
Original Source
<!-- SPDX-License-Identifier: MIT SPDX-FileCopyrightText: (c) Respect Project Contributors SPDX-FileContributor: Alexandre Gomes Gaigalas <[email protected]> SPDX-FileContributor: Henrique Moody <[email protected]> SPDX-FileContributor: Kirill Dlussky <[email protected]> -->

Equivalent

  • Equivalent(mixed $compareTo)

Validates if the input is equivalent to some value.

php
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

ModeTemplate
default{{subject}} must be equivalent to {{compareTo}}
inverted{{subject}} must not be equivalent to {{compareTo}}

Template placeholders

PlaceholderDescription
compareToValue to be compared against the input.
subjectThe validated input or the custom validator name (if specified).

Categorization

  • Comparisons

Changelog

VersionDescription
2.0.0Created

See Also