respect-validation/docs/rules/In.md
Henrique Moody 48405271c5
Replace placeholder "name" with "subject"
The `{{name}}` placeholder could represent different things depending on
the state of the Result, and referring to it as `{{name}}` seems
arbitrary. This commit changes it to `{{subject}}`, which is much more
generic and it describes well what that placeholder can mean.
2025-12-26 21:30:01 +01:00

61 lines
1.3 KiB
Markdown

# In
- `In(mixed $haystack)`
- `In(mixed $haystack, bool $identical)`
Validates if the input is contained in a specific haystack.
For strings:
```php
v::in('lorem ipsum')->isValid('ipsum'); // true
```
For arrays:
```php
v::in(['lorem', 'ipsum'])->isValid('lorem'); // true
```
A second parameter may be passed for identical comparison instead
of equal comparison.
Message template for this validator includes `{{haystack}}`.
## Templates
### `In::TEMPLATE_STANDARD`
| Mode | Template |
| ---------- | --------------------------------------- |
| `default` | {{subject}} must be in {{haystack}} |
| `inverted` | {{subject}} must not be in {{haystack}} |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `haystack` | |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- Arrays
- Comparisons
- Strings
## Changelog
| Version | Description |
| ------: | ----------- |
| 0.3.9 | Created |
---
See also:
- [Contains](Contains.md)
- [ContainsAny](ContainsAny.md)
- [EndsWith](EndsWith.md)
- [Roman](Roman.md)
- [StartsWith](StartsWith.md)