Back to Validation

Alnum

docs/validators/Alnum.md

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

Alnum

  • Alnum()
  • Alnum(string ...$additionalChars)

Validates whether the input is alphanumeric or not.

Alphanumeric is a combination of alphabetic (a-z and A-Z) and numeric (0-9) characters.

php
v::alnum(' ')->assert('foo 123');
// Validation passes successfully

v::alnum()->assert('foo 123');
// → "foo 123" must consist only of letters (a-z) and digits (0-9)

v::alnum()->assert('100%');
// → "100%" must consist only of letters (a-z) and digits (0-9)

v::alnum('%')->assert('100%');
// Validation passes successfully

v::alnum('%', ',')->assert('10,5%');
// Validation passes successfully

You can restrict case using the Lowercase and Uppercase validators.

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

Message template for this validator includes {{additionalChars}} as the string of extra chars passed as the parameter.

Templates

Alnum::TEMPLATE_STANDARD

ModeTemplate
default{{subject}} must consist only of letters (a-z) and digits (0-9)
inverted{{subject}} must not consist only of letters (a-z) or digits (0-9)

Alnum::TEMPLATE_EXTRA

ModeTemplate
default{{subject}} must consist only of letters (a-z), digits (0-9), or {{additionalChars}}
inverted{{subject}} must not consist only of letters (a-z), digits (0-9), 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