mirror of
https://github.com/Respect/Validation.git
synced 2026-03-18 08:09:51 +01:00
bd48bdcda4
Introduces a Markdown linter for checking the Changelog format. "See Also" was transformed into a section to make it easier to handle it with the `Content` class. The "Related" linter was simplified to reflect that change too. An additional "alignment" parameter was added to markdown table generators, allowing the padding and headers to be explicitly marked with a specific left (-1), middle (0) or right(1) alignment. Existing files were fixed using the `fix` option after the changes.
59 lines
1.5 KiB
Markdown
59 lines
1.5 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# 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](Equals.md) 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
|
|
|
|
- [Contains](Contains.md)
|
|
- [ContainsAny](ContainsAny.md)
|
|
- [Equals](Equals.md)
|
|
- [Identical](Identical.md)
|