respect-validation/docs/rules/Subset.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

43 lines
1 KiB
Markdown

# Subset
- `Subset(array $superset)`
Validates whether the input is a subset of a given value.
```php
v::subset([1, 2, 3])->isValid([1, 2]); // true
v::subset([1, 2])->isValid([1, 2, 3]); // false
```
## Templates
### `Subset::TEMPLATE_STANDARD`
| Mode | Template |
| ---------- | ---------------------------------------------- |
| `default` | {{subject}} must be subset of {{superset}} |
| `inverted` | {{subject}} must not be subset of {{superset}} |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `subject` | The validated input or the custom validator name (if specified). |
| `superset` | |
## Categorization
- Arrays
## Changelog
| Version | Description |
| ------: | ----------- |
| 2.0.0 | Created |
---
See also:
- [ArrayType](ArrayType.md)
- [ArrayVal](ArrayVal.md)