mirror of
https://github.com/Respect/Validation.git
synced 2026-03-17 07:45:45 +01:00
16148e9593
- Remove redundant "valid" prefix: Date, DateTime, DateTimeDiff, Domain, Email, Iban, Imei, Ip, Isbn, Json, LanguageCode, LeapDate, LeapYear, Luhn, MacAddress, NfeAccessKey, Nif, Nip, Pesel, Phone, Pis, PolishIdCard, PostalCode, Roman, Slug, Tld, Url, Uuid, Version. - Remove redundant "value" suffix ArrayVal, BoolVal, Countable, FloatVal, IntVal, IterableVal, NumericVal, ScalarVal, StringVal. - Standardize "consist only of" phrasing Alnum, Alpha, Cntrl, Consonant, Digit, Graph, Lowercase, Printable, Punct, Space, Spaced, Uppercase, Vowel, Xdigit. - Improve file accessibility messages Directory, Executable, File, Image, Readable, SymbolicLink, Writable. - Improve grammar and article usage CreditCard, Extension, Mimetype, Regex, Size.
81 lines
2.4 KiB
Markdown
81 lines
2.4 KiB
Markdown
<!--
|
|
SPDX-License-Identifier: MIT
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
|
|
SPDX-FileContributor: Dick van der Heiden <d.vanderheiden@inthere.nl>
|
|
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
|
|
SPDX-FileContributor: Michael Weimann <mail@michael-weimann.eu>
|
|
SPDX-FileContributor: steven.lewis <stevenlewis@gowebprint.com>
|
|
-->
|
|
|
|
# Uuid
|
|
|
|
- `Uuid()`
|
|
- `Uuid(int $version)`
|
|
|
|
Validates whether the input is a valid UUID. It also supports validation of
|
|
specific versions 1 to 8.
|
|
|
|
```php
|
|
v::uuid()->assert('eb3115e5-bd16-4939-ab12-2b95745a30f3');
|
|
// Validation passes successfully
|
|
|
|
v::uuid()->assert('Hello World!');
|
|
// → "Hello World!" must be a UUID
|
|
|
|
v::uuid()->assert('eb3115e5bd164939ab122b95745a30f3');
|
|
// Validation passes successfully
|
|
|
|
v::uuid(1)->assert('eb3115e5-bd16-4939-ab12-2b95745a30f3');
|
|
// → "eb3115e5-bd16-4939-ab12-2b95745a30f3" must be a UUID v1
|
|
|
|
v::uuid(4)->assert('eb3115e5-bd16-4939-ab12-2b95745a30f3');
|
|
// Validation passes successfully
|
|
|
|
v::uuid(8)->assert('00112233-4455-8677-8899-aabbccddeeff');
|
|
// Validation passes successfully
|
|
|
|
v::uuid(4)->assert(\Ramsey\Uuid\Uuid::fromString('eb3115e5-bd16-4939-ab12-2b95745a30f3'));
|
|
// Validation passes successfully
|
|
```
|
|
|
|
## Templates
|
|
|
|
### `Uuid::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :----------------------------- |
|
|
| `default` | {{subject}} must be a UUID |
|
|
| `inverted` | {{subject}} must not be a UUID |
|
|
|
|
### `Uuid::TEMPLATE_VERSION`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :--------------------------------------------------- |
|
|
| `default` | {{subject}} must be a UUID v{{version|raw}} |
|
|
| `inverted` | {{subject}} must not be a UUID v{{version|raw}} |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
| `version` | The version of the expected UUID. |
|
|
|
|
## Categorization
|
|
|
|
- Strings
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | :--------------------- |
|
|
| 3.0.0 | Templates changed |
|
|
| 3.0.0 | Requires `ramsey/uuid` |
|
|
| 2.0.0 | Created |
|
|
|
|
## See Also
|
|
|
|
- [Base](Base.md)
|
|
- [Decimal](Decimal.md)
|
|
- [Digit](Digit.md)
|