respect-validation/docs/rules/Alnum.md
Henrique Moody 52614d600d
Organize documentation for "Read the Docs"
The current documentation is hosted via GitHub pages rendered by
"Couscous". Every time we need a new version of the documentation
published we need to manually execute the "couscous".

This commit reorganize the documentation to be published to
"Read the Docs" because it will also allow us to have documentations per
version of the library most importantly provider a search field for the
documentation.

The documentation will be then published on:
https://respect-validation.readthedocs.io/

Signed-off-by: Henrique Moody <henriquemoody@gmail.com>
2018-08-23 01:59:39 +02:00

982 B

Alnum

  • v::alnum()
  • v::alnum(string $additionalChars)

Validates alphanumeric characters from a-Z and 0-9.

v::alnum()->validate('foo 123'); // true
v::alnum()->validate('number 100%'); // false
v::alnum('%')->validate('number 100%'); // true

Because this rule allows whitespaces by default, you can separate additional characters with a whitespace:

v::alnum('- ! :')->validate('foo :- 123 !'); // true

This validator allows whitespace, if you want to remove them add ->noWhitespace() to the chain:

v::alnum()->noWhitespace()->validate('foo 123'); // false

You can restrict case using the ->lowercase() and ->uppercase() validators:

v::alnum()->uppercase()->validate('aaa'); // false

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


See also: