respect-validation/docs/validators/Number.md
Alexandre Gomes Gaigalas bd48bdcda4 Lint Changelog format in validator docs
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.
2026-01-26 19:11:00 +00:00

62 lines
1.5 KiB
Markdown

<!--
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-License-Identifier: MIT
-->
# Number
- `Number()`
Validates if the input is a number.
```php
v::number()->assert(42);
// Validation passes successfully
v::number()->assert(acos(8));
// → `NaN` must be a valid number
```
> "In computing, NaN, standing for not a number, is a numeric data type value
> representing an undefined or unrepresentable value, especially in
> floating-point calculations." [Wikipedia](https://en.wikipedia.org/wiki/NaN)
## Templates
### `Number::TEMPLATE_STANDARD`
| Mode | Template |
| ---------: | :--------------------------------- |
| `default` | {{subject}} must be a valid number |
| `inverted` | {{subject}} must not be a number |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- Numbers
## Changelog
| Version | Description |
| ------: | :---------- |
| 2.0.0 | Created |
## See Also
- [Blank](Blank.md)
- [BoolType](BoolType.md)
- [CallableType](CallableType.md)
- [Falsy](Falsy.md)
- [FloatType](FloatType.md)
- [IntType](IntType.md)
- [NullType](NullType.md)
- [NumericVal](NumericVal.md)
- [ObjectType](ObjectType.md)
- [ResourceType](ResourceType.md)
- [StringType](StringType.md)
- [Undef](Undef.md)