respect-validation/docs/validators/Multiple.md
Henrique Moody 7c681fec66
Fix SPDX headers in all files
I 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.
2026-02-03 15:23:23 +01:00

49 lines
1.3 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>
-->
# 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)