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

44 lines
1 KiB
Markdown

# Multiple
- `Multiple(int $multipleOf)`
Validates if the input is a multiple of the given parameter
```php
v::intVal()->multiple(3)->isValid(9); // true
```
## 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)