mirror of https://github.com/Respect/Validation.git synced 2026-03-17 07:45:45 +01:00

Alexandre Gomes Gaigalas 2a7f345e32 Streamline validators.md index

Makes it so the index looks more like a cheatsheet, condensing
information instead of making long lists that require lots of
scrolling to explore.

Additionally, the happy path for each validator was also
added, providing a quick reference use for comparison.

The direct markdown links were replaced by titled markdown
references, offering mouse-over tooltips over links that
display the validator one-line description.

To ensure a proper source of truth for these new index
goodies, the AssertionMessageLinter was modified to
verify that the first assertion in each doc is a
single-line validator that passes (a happy path), further
making our documentation conventions more solid.

2026-01-28 12:47:08 +00:00

1.7 KiB

Raw Blame History

Charset

Charset(string $charset)
Charset(string $charset, string ...$charsets)

Validates if a string is in a specific charset.

v::charset('ASCII')->assert('sugar');
// Validation passes successfully

v::charset('ASCII')->assert('açúcar');
// → "açúcar" must only contain characters from the `["ASCII"]` charset

v::charset('ISO-8859-1', 'EUC-JP')->assert('日本国');
// Validation passes successfully

The array format is a logic OR, not AND.

Templates

`Charset::TEMPLATE_STANDARD`

Mode	Template
`default`	{{subject}} must only contain characters from the {{charset\|raw}} charset
`inverted`	{{subject}} must not contain any characters from the {{charset\|raw}} charset

Template placeholders

Placeholder	Description
`charset`
`subject`	The validated input or the custom validator name (if specified).

Categorization

Strings

Changelog

Version	Description
2.0.0	Charset supports multiple charsets on its constructor
0.5.0	Created

1.7 KiB Raw Blame History