respect-validation/docs/validators/Contains.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

70 lines
1.8 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>
SPDX-FileContributor: Kirill Dlussky <kirill@dlussky.ru>
-->
# Contains
- `Contains(mixed $containsValue)`
Validates if the input contains some value.
For strings:
```php
v::contains('ipsum')->assert('lorem ipsum');
// Validation passes successfully
```
For arrays:
```php
v::contains('ipsum')->assert(['ipsum', 'lorem']);
// Validation passes successfully
```
Message template for this validator includes `{{containsValue}}`.
## Templates
### `Contains::TEMPLATE_STANDARD`
| Mode | Template |
| ---------: | :--------------------------------------------- |
| `default` | {{subject}} must contain {{containsValue}} |
| `inverted` | {{subject}} must not contain {{containsValue}} |
## Template placeholders
| Placeholder | Description |
| --------------- | ---------------------------------------------------------------- |
| `containsValue` | |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- Arrays
- Strings
## Changelog
| Version | Description |
| ------: | :---------------------------------- |
| 3.0.0 | Case-insensitive comparison removed |
| 0.3.9 | Created |
## See Also
- [ContainsAny](ContainsAny.md)
- [ContainsCount](ContainsCount.md)
- [EndsWith](EndsWith.md)
- [Equals](Equals.md)
- [Equivalent](Equivalent.md)
- [Identical](Identical.md)
- [In](In.md)
- [Regex](Regex.md)
- [StartsWith](StartsWith.md)
- [Unique](Unique.md)