mirror of
https://github.com/Respect/Validation.git
synced 2026-03-16 15:25:45 +01:00
2a7f345e32
Makes it so the index looks more like a cheatsheet, condensing information instead of making long lists that require lots of scrolling to explore. Additionally, the happy path for each validator was also added, providing a quick reference use for comparison. The direct markdown links were replaced by titled markdown references, offering mouse-over tooltips over links that display the validator one-line description. To ensure a proper source of truth for these new index goodies, the AssertionMessageLinter was modified to verify that the first assertion in each doc is a single-line validator that passes (a happy path), further making our documentation conventions more solid.
79 lines
2.2 KiB
Markdown
79 lines
2.2 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# Digit
|
|
|
|
- `Digit()`
|
|
- `Digit(string ...$additionalChars)`
|
|
|
|
Validates whether the input contains only digits.
|
|
|
|
```php
|
|
v::digit(' ')->assert('020 612 1851');
|
|
// Validation passes successfully
|
|
|
|
v::digit()->assert('020 612 1851');
|
|
// → "020 612 1851" must contain only digits (0-9)
|
|
|
|
v::digit()->assert('172.655.537-21');
|
|
// → "172.655.537-21" must contain only digits (0-9)
|
|
|
|
v::digit('.', '-')->assert('172.655.537-21');
|
|
// Validation passes successfully
|
|
```
|
|
|
|
## Templates
|
|
|
|
### `Digit::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :----------------------------------------- |
|
|
| `default` | {{subject}} must contain only digits (0-9) |
|
|
| `inverted` | {{subject}} must not contain digits (0-9) |
|
|
|
|
### `Digit::TEMPLATE_EXTRA`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :----------------------------------------------------------------- |
|
|
| `default` | {{subject}} must contain only digits (0-9) and {{additionalChars}} |
|
|
| `inverted` | {{subject}} must not contain digits (0-9) and {{additionalChars}} |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------------- | ---------------------------------------------------------------- |
|
|
| `additionalChars` | Additional characters that are considered valid. |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- Numbers
|
|
- Strings
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | :---------------------------------------- |
|
|
| 2.0.0 | Removed support to whitespaces by default |
|
|
| 0.5.0 | Renamed from `Digits` to `Digit` |
|
|
| 0.3.9 | Created as `Digits` |
|
|
|
|
## See Also
|
|
|
|
- [Alnum](Alnum.md)
|
|
- [Alpha](Alpha.md)
|
|
- [Consonant](Consonant.md)
|
|
- [CreditCard](CreditCard.md)
|
|
- [Emoji](Emoji.md)
|
|
- [Factor](Factor.md)
|
|
- [Finite](Finite.md)
|
|
- [Infinite](Infinite.md)
|
|
- [IntType](IntType.md)
|
|
- [IntVal](IntVal.md)
|
|
- [NumericVal](NumericVal.md)
|
|
- [Regex](Regex.md)
|
|
- [Uuid](Uuid.md)
|
|
- [Vowel](Vowel.md)
|
|
- [Xdigit](Xdigit.md)
|