Back to Validation

Templated

docs/validators/Templated.md

3.1.11.6 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]> -->

Templated

  • Templated(string $template, Validator $validator)
  • Templated(string $template, Validator $validator, array<string, mixed> $parameters)

Defines a validator with a custom message template.

php
v::templated('You must provide a valid email', v::email())->assert('[email protected]');
// Validation passes successfully

v::templated('You must provide a valid email', v::email())->assert('not an email');
// → You must provide a valid email

v::templated(
    'The author of the page {{title}} is empty, please fill it up.',
    v::notBlank(),
    ['title' => 'Feature Guide']
)->assert('');
// → The author of the page "Feature Guide" is empty, please fill it up.

This validator can be also useful when you're using Attributes and want a custom template for a specific property.

Templates

This validator does not have any templates, as you must define the templates yourself.

Template placeholders

PlaceholderDescription
subjectThe validated input or the custom validator name (if specified).

Categorization

  • Core
  • Display
  • Miscellaneous

Changelog

VersionDescription
3.0.0Created

See Also