respect-validation/docs/validators/Xdigit.md
Alexandre Gomes Gaigalas d9cdc118b2 Introduce REUSE compliance
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.
2026-01-21 06:28:11 +00:00

65 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)