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

1.3 KiB

Named

  • Named(Name|string $name, Validator $validator)

Validates the input with the given validator, and uses the custom name in the error message.

v::named('Your email', v::email())->assert('foo@example.com');
// Validation passes successfully

v::named('Your email', v::email())->assert('not an email');
// → Your email must be a valid email address

Here's an example of a similar code, but without using the Named validator:

v::email()->assert('not an email');
// → "not an email" must be a valid email address

The Named validator can be also useful when you're using Attributes and want a custom name for a specific property.

Templates

This validator does not have any templates, as it will use the template of the given validator.

Template placeholders

Placeholder Description
subject The value that you define as $name.

Categorization

  • Core
  • Structures
  • Miscellaneous

Changelog

Version Description
3.0.0 Created

See Also