mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 06:45:44 +01:00
7c681fec66I 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.
52 lines
1.4 KiB
Markdown
52 lines
1.4 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: Singwai Chan <singwai.chan@live.com>
|
|
-->
|
|
|
|
# Subset
|
|
|
|
- `Subset(mixed[] $superset)`
|
|
|
|
Validates whether the input is a subset of a given value.
|
|
|
|
```php
|
|
v::subset([1, 2, 3])->assert([1, 2]);
|
|
// Validation passes successfully
|
|
|
|
v::subset([1, 2])->assert([1, 2, 3]);
|
|
// → `[1, 2, 3]` must be subset of `[1, 2]`
|
|
```
|
|
|
|
## 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)
|