mirror of https://github.com/Respect/Validation.git synced 2026-03-15 06:45:44 +01:00

Alexandre Gomes Gaigalas 2a7f345e32 Streamline validators.md index

Makes it so the index looks more like a cheatsheet, condensing
information instead of making long lists that require lots of
scrolling to explore.

Additionally, the happy path for each validator was also
added, providing a quick reference use for comparison.

The direct markdown links were replaced by titled markdown
references, offering mouse-over tooltips over links that
display the validator one-line description.

To ensure a proper source of truth for these new index
goodies, the AssertionMessageLinter was modified to
verify that the first assertion in each doc is a
single-line validator that passes (a happy path), further
making our documentation conventions more solid.

2026-01-28 12:47:08 +00:00

2.2 KiB

Raw Blame History

Uuid

Uuid()
Uuid(int $version)

Validates whether the input is a valid UUID. It also supports validation of specific versions 1 to 8.

v::uuid()->assert('eb3115e5-bd16-4939-ab12-2b95745a30f3');
// Validation passes successfully

v::uuid()->assert('Hello World!');
// → "Hello World!" must be a valid 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 valid UUID version 1

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 valid UUID
`inverted`	{{subject}} must not be a valid UUID

`Uuid::TEMPLATE_VERSION`

Mode	Template
`default`	{{subject}} must be a valid UUID version {{version\|raw}}
`inverted`	{{subject}} must not be a valid UUID version {{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	Requires `ramsey/uuid`
2.0.0	Created

2.2 KiB Raw Blame History