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

48 lines
1.2 KiB
Markdown

<!--
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-License-Identifier: MIT
-->
# Multiple
- `Multiple(int $multipleOf)`
Validates if the input is a multiple of the given parameter
```php
v::intVal()->multiple(3)->assert(9);
// Validation passes successfully
```
## Templates
### `Multiple::TEMPLATE_STANDARD`
| Mode | Template |
| ---------: | :--------------------------------------------------- |
| `default` | {{subject}} must be a multiple of {{multipleOf}} |
| `inverted` | {{subject}} must not be a multiple of {{multipleOf}} |
## Template placeholders
| Placeholder | Description |
| ------------ | ---------------------------------------------------------------- |
| `multipleOf` | |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- Math
- Numbers
## Changelog
| Version | Description |
| ------: | :---------- |
| 0.3.9 | Created |
## See Also
- [Even](Even.md)
- [Odd](Odd.md)
- [PrimeNumber](PrimeNumber.md)