mirror of
https://github.com/Respect/Validation.git
synced 2026-03-18 08:09:51 +01:00
bd48bdcda4
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.
58 lines
1.4 KiB
Markdown
58 lines
1.4 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# 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)
|
|
- [PerfectSquare](PerfectSquare.md)
|
|
- [PrimeNumber](PrimeNumber.md)
|