respect-validation/docs/rules/Digit.md

# Digit

- `Digit()`
- `Digit(string ...$additionalChars)`

Validates whether the input contains only digits.

```php
v::digit()->validate('020 612 1851'); // false
v::digit(' ')->validate('020 612 1851'); // true
v::digit()->validate('172.655.537-21'); // false
v::digit('.', '-')->validate('172.655.537-21'); // true
```

## 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)
- [Factor](Factor.md)
- [Finite](Finite.md)
- [Infinite](Infinite.md)
- [IntType](IntType.md)
- [IntVal](IntVal.md)
- [NotEmoji](NotEmoji.md)
- [NumericVal](NumericVal.md)
- [Regex](Regex.md)
- [Uuid](Uuid.md)
- [Vowel](Vowel.md)
- [Xdigit](Xdigit.md)
Update documentation 2015-01-30 09:40:06 +01:00			`# Digit`

Change how documentation of rules are presented Rules are not always used from the alias `v`, neither called staticaly. 2017-03-27 14:47:07 +02:00			- `Digit()`
Use variadics "AbstractFilterRule" rule Since the library doesn't need to give support to version 5.4 or less of PHP using variadics in the constructor of "AbstractFilterRule" seems better than doing the whole validation. This commit will also apply the contribution guidelines to "AbstractFilterRule" and use a better naming for it. Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2018-09-24 21:48:41 +02:00			- `Digit(string ...$additionalChars)`
Update documentation 2015-01-30 09:40:06 +01:00
Do not accept whitespace by default in "Digit" rule The "Digit" rule is meant to validate digits. However, by default, it also considers any whitespace character (spaces, new lines, tabs, etc) as valid. Since the rule also accepts a list of characters to ignore during the validation it seemed logical to me to leave the responsibility of allowing whitespace characters on the hands of the one who uses the rule. The messages of the exception are not really consistent, this commit will also fix that. It's also clear that the "AbstractCtypeRule" is an unnecessary overhead since it is only a proxy for "AbstractFilterRule". That one can and should even be removed after this commit is applied especially because this commit will also remove the method "filterWhiteSpaceOption" which is the only substantial difference between "AbstractCtypeRule" and "AbstractFilterRule". This commit will also apply our guidelines to the "Digit" rule since we want to do that to all the rules we have. Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2018-09-06 21:57:57 +02:00			`Validates whether the input contains only digits.`

			```php
			`v::digit()->validate('020 612 1851'); // false`
			`v::digit(' ')->validate('020 612 1851'); // true`
			`v::digit()->validate('172.655.537-21'); // false`
Use variadics "AbstractFilterRule" rule Since the library doesn't need to give support to version 5.4 or less of PHP using variadics in the constructor of "AbstractFilterRule" seems better than doing the whole validation. This commit will also apply the contribution guidelines to "AbstractFilterRule" and use a better naming for it. Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2018-09-24 21:48:41 +02:00			`v::digit('.', '-')->validate('172.655.537-21'); // true`
Do not accept whitespace by default in "Digit" rule The "Digit" rule is meant to validate digits. However, by default, it also considers any whitespace character (spaces, new lines, tabs, etc) as valid. Since the rule also accepts a list of characters to ignore during the validation it seemed logical to me to leave the responsibility of allowing whitespace characters on the hands of the one who uses the rule. The messages of the exception are not really consistent, this commit will also fix that. It's also clear that the "AbstractCtypeRule" is an unnecessary overhead since it is only a proxy for "AbstractFilterRule". That one can and should even be removed after this commit is applied especially because this commit will also remove the method "filterWhiteSpaceOption" which is the only substantial difference between "AbstractCtypeRule" and "AbstractFilterRule". This commit will also apply our guidelines to the "Digit" rule since we want to do that to all the rules we have. Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2018-09-06 21:57:57 +02:00			```
Update documentation 2015-01-30 09:40:06 +01:00
Add "Categorization" section to rule documentations Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2019-05-11 18:32:13 +02:00			`## Categorization`

			`- Numbers`
			`- Strings`

Add changelog to rules' documentation Also: - Create documentation for `Base` rule; - Increase number of rules 2017-03-27 22:04:13 +02:00			`## Changelog`

			`Version \| Description`
			`--------\|-------------`
Do not accept whitespace by default in "Digit" rule The "Digit" rule is meant to validate digits. However, by default, it also considers any whitespace character (spaces, new lines, tabs, etc) as valid. Since the rule also accepts a list of characters to ignore during the validation it seemed logical to me to leave the responsibility of allowing whitespace characters on the hands of the one who uses the rule. The messages of the exception are not really consistent, this commit will also fix that. It's also clear that the "AbstractCtypeRule" is an unnecessary overhead since it is only a proxy for "AbstractFilterRule". That one can and should even be removed after this commit is applied especially because this commit will also remove the method "filterWhiteSpaceOption" which is the only substantial difference between "AbstractCtypeRule" and "AbstractFilterRule". This commit will also apply our guidelines to the "Digit" rule since we want to do that to all the rules we have. Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2018-09-06 21:57:57 +02:00			`2.0.0 \| Removed support to whitespaces by default`
Add changelog to rules' documentation Also: - Create documentation for `Base` rule; - Increase number of rules 2017-03-27 22:04:13 +02:00			0.5.0 \| Renamed from `Digits` to `Digit`
			0.3.9 \| Created as `Digits`

Standard for "See also:" on documentation 2015-08-20 06:38:41 +02:00			`***`
Update documentation 2015-01-30 09:40:06 +01:00			`See also:`

Uniform Markdown lists on documentation 2017-03-28 11:53:14 +02:00			`- [Alnum](Alnum.md)`
			`- [Alpha](Alpha.md)`
			`- [Consonant](Consonant.md)`
Merge branch '1.1' 2018-12-11 13:31:50 +01:00			`- [CreditCard](CreditCard.md)`
			`- [Factor](Factor.md)`
			`- [Finite](Finite.md)`
			`- [Infinite](Infinite.md)`
			`- [IntType](IntType.md)`
			`- [IntVal](IntVal.md)`
Create "NotEmoji" rule The data in this commit has been gathered, scrapped, organized and treated based on the Emoji Unicode V11 specification [1]. [1]: https://unicode.org/Public/emoji/11.0/emoji-test.txt Co-authored-by: Henrique Moody <henriquemoody@gmail.com> 2019-01-27 01:14:47 +01:00			`- [NotEmoji](NotEmoji.md)`
Merge branch '1.1' 2018-12-11 13:31:50 +01:00			`- [NumericVal](NumericVal.md)`
			`- [Regex](Regex.md)`
			`- [Uuid](Uuid.md)`
			`- [Vowel](Vowel.md)`
			`- [Xdigit](Xdigit.md)`