mirror of
https://github.com/Respect/Validation.git
synced 2026-03-22 09:52:51 +01:00
d9cdc118b2
This commit introduces REUSE compliance by annotating all files with SPDX information and placing the reused licences in the LICENSES folder. We additionally removed the docheader tool which is made obsolete by this change. The main LICENSE and copyright text of the project is now not under my personal name anymore, and it belongs to "The Respect Project Contributors" instead. This change restores author names to several files, giving the appropriate attribution for contributions.
81 lines
2.2 KiB
Markdown
81 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');
|
|
// → "020 612 1851" must contain only digits (0-9)
|
|
|
|
v::digit(' ')->assert('020 612 1851');
|
|
// Validation passes successfully
|
|
|
|
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)
|