ContextQMD
Back to Validation

Alpha

docs/validators/Alpha.md

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

Alpha

  • Alpha()
  • Alpha(string ...$additionalChars)

Validates whether the input contains only alphabetic characters. This is similar to Alnum, but it does not allow numbers.

php
v::alpha(' ')->assert('some name');
// Validation passes successfully

v::alpha()->assert('some name');
// → "some name" must consist only of letters (a-z)

v::alpha()->assert('Cedric-Fabian');
// → "Cedric-Fabian" must consist only of letters (a-z)

v::alpha('-')->assert('Cedric-Fabian');
// Validation passes successfully

v::alpha('-', '\'')->assert('\'s-Gravenhage');
// Validation passes successfully

You can restrict case using the Lowercase and Uppercase validators.

php
v::alpha()->uppercase()->assert('example');
// → "example" must consist only of uppercase letters

Templates

Alpha::TEMPLATE_STANDARD

ModeTemplate
default{{subject}} must consist only of letters (a-z)
inverted{{subject}} must not consist only of letters (a-z)

Alpha::TEMPLATE_EXTRA

ModeTemplate
default{{subject}} must consist only of letters (a-z) or {{additionalChars}}
inverted{{subject}} must not consist only of letters (a-z) or {{additionalChars}}

Template placeholders

PlaceholderDescription
additionalCharsAdditional characters that are considered valid.
subjectThe validated input or the custom validator name (if specified).

Categorization

  • Strings

Changelog

VersionDescription
3.0.0Templates changed
2.0.0Removed support to whitespaces by default
0.3.9Created

See Also