respect-validation/docs/validators/Xdigit.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

63 lines
1.7 KiB
Markdown

<!--
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-License-Identifier: MIT
-->
# Xdigit
- `Xdigit()`
- `Xdigit(string ...$additionalChars)`
Validates whether the input is an hexadecimal number or not.
```php
v::xdigit()->assert('abc123');
// Validation passes successfully
```
Notice, however, that it doesn't accept strings starting with 0x:
```php
v::xdigit()->assert('0x1f');
// → "0x1f" must only contain hexadecimal digits
```
## Templates
### `Xdigit::TEMPLATE_STANDARD`
| Mode | Template |
| ---------: | :--------------------------------------------------- |
| `default` | {{subject}} must only contain hexadecimal digits |
| `inverted` | {{subject}} must not only contain hexadecimal digits |
### `Xdigit::TEMPLATE_EXTRA`
| Mode | Template |
| ---------: | :--------------------------------------------------------------------- |
| `default` | {{subject}} must contain hexadecimal digits and {{additionalChars}} |
| `inverted` | {{subject}} must not contain hexadecimal digits or {{additionalChars}} |
## Template placeholders
| Placeholder | Description |
| ----------------- | ---------------------------------------------------------------- |
| `additionalChars` | Additional characters that are considered valid. |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- Strings
## Changelog
| Version | Description |
| ------: | :---------- |
| 0.5.0 | Created |
## See Also
- [Alnum](Alnum.md)
- [Decimal](Decimal.md)
- [Digit](Digit.md)
- [HexRgbColor](HexRgbColor.md)