Back to Validation

Named

docs/validators/Named.md

3.1.11.4 KB
Original Source
<!-- SPDX-License-Identifier: MIT SPDX-FileCopyrightText: (c) Respect Project Contributors SPDX-FileContributor: Alexandre Gomes Gaigalas <[email protected]> SPDX-FileContributor: Henrique Moody <[email protected]> -->

Named

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

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

php
v::named('Your email', v::email())->assert('[email protected]');
// Validation passes successfully

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

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

php
v::email()->assert('not an email');
// → "not an email" must be an 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

PlaceholderDescription
subjectThe value that you define as $name.

Categorization

  • Core
  • Display
  • Miscellaneous

Changelog

VersionDescription
3.0.0Created

See Also