respect-validation/docs/validators/Equals.md
Henrique Moody 7c681fec66
Fix SPDX headers in all files
I ran the `bin/console spdx --fix` with different strategies for
different files. For most of the core classes, since they've been
drastically rebuilt, I've run it with the `git-blame` strategy, for for
the `src/Validators`, in which the API changed completely but the logic
remains the same, I use the `git-log` strategy.
2026-02-03 15:23:23 +01:00

53 lines
1.6 KiB
Markdown

<!--
SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
-->
# Equals
- `Equals(mixed $compareTo)`
Validates if the input is equal to some value.
```php
v::equals('alganet')->assert('alganet');
// Validation passes successfully
```
Message template for this validator includes `{{compareTo}}`.
## Templates
### `Equals::TEMPLATE_STANDARD`
| Mode | Template |
| ---------: | :--------------------------------------------- |
| `default` | {{subject}} must be equal to {{compareTo}} |
| `inverted` | {{subject}} must not be equal 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 |
| ------: | :--------------------------------------------------------- |
| 1.0.0 | Removed identical checking (see [Identical](Identical.md)) |
| 0.3.9 | Created |
## See Also
- [Contains](Contains.md)
- [Equivalent](Equivalent.md)
- [Identical](Identical.md)
- [Version](Version.md)