respect-validation/docs/validators/Subset.md
Alexandre Gomes Gaigalas bd48bdcda4 Lint Changelog format in validator docs
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.
2026-01-26 19:11:00 +00:00

49 lines
1.2 KiB
Markdown

<!--
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-License-Identifier: MIT
-->
# 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)