ContextQMD
Back to Validation

Uuid

docs/validators/Uuid.md

3.1.12.4 KB
Original Source
<!-- SPDX-License-Identifier: MIT SPDX-FileCopyrightText: (c) Respect Project Contributors SPDX-FileContributor: Alexandre Gomes Gaigalas <[email protected]> SPDX-FileContributor: Dick van der Heiden <[email protected]> SPDX-FileContributor: Henrique Moody <[email protected]> SPDX-FileContributor: Michael Weimann <[email protected]> SPDX-FileContributor: steven.lewis <[email protected]> -->

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

ModeTemplate
default{{subject}} must be a UUID
inverted{{subject}} must not be a UUID

Uuid::TEMPLATE_VERSION

ModeTemplate
default{{subject}} must be a UUID v{{version|raw}}
inverted{{subject}} must not be a UUID v{{version|raw}}

Template placeholders

PlaceholderDescription
subjectThe validated input or the custom validator name (if specified).
versionThe version of the expected UUID.

Categorization

  • Strings

Changelog

VersionDescription
3.0.0Templates changed
3.0.0Requires ramsey/uuid
2.0.0Created

See Also