mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 23:05:45 +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.
59 lines
1.5 KiB
Markdown
59 lines
1.5 KiB
Markdown
<!--
|
|
SPDX-License-Identifier: MIT
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
|
|
SPDX-FileContributor: David Meister <thedavidmeister@gmail.com>
|
|
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
|
|
-->
|
|
|
|
# Factor
|
|
|
|
- `Factor(int $dividend)`
|
|
|
|
Validates if the input is a factor of the defined dividend.
|
|
|
|
```php
|
|
v::factor(0)->assert(5);
|
|
// Validation passes successfully
|
|
|
|
v::factor(4)->assert(2);
|
|
// Validation passes successfully
|
|
|
|
v::factor(4)->assert(3);
|
|
// → 3 must be a factor of 4
|
|
```
|
|
|
|
## Templates
|
|
|
|
### `Factor::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :-------------------------------------------------------- |
|
|
| `default` | {{subject}} must be a factor of {{dividend|raw}} |
|
|
| `inverted` | {{subject}} must not be a factor of {{dividend|raw}} |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `dividend` | |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- Math
|
|
- Numbers
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | :---------- |
|
|
| 1.0.0 | Created |
|
|
|
|
## See Also
|
|
|
|
- [Decimal](Decimal.md)
|
|
- [Digit](Digit.md)
|
|
- [Finite](Finite.md)
|
|
- [Infinite](Infinite.md)
|
|
- [NumericVal](NumericVal.md)
|