respect-validation/docs/validators/LanguageCode.md
Henrique Moody d2198dfd01
Replace isValid() calls with assert()
There's more value on showing how `assert()` displays the validation
messages than simply showing if `isValid()` returns `true` or `false`.

However, that increases the chances of having outdated documentation, so
I created a doc linter that updates the Markdown files with the
correct message.
2026-01-13 23:37:06 -07:00

67 lines
1.9 KiB
Markdown

# LanguageCode
- `LanguageCode()`
- `LanguageCode("alpha-2"|"alpha-3" $set)`
Validates whether the input is language code based on [ISO 639][].
**This validator requires [sokil/php-isocodes][] and [sokil/php-isocodes-db-only][] to be installed.**
```php
v::languageCode()->assert('pt');
// Validation passes successfully
v::languageCode()->assert('en');
// Validation passes successfully
v::languageCode()->assert('it');
// Validation passes successfully
v::languageCode('alpha-3')->assert('ita');
// Validation passes successfully
v::languageCode('alpha-3')->assert('eng');
// Validation passes successfully
```
This validator supports the two[ISO 639][] sets:
- `alpha-2`
- `alpha-3`
## Templates
### `LanguageCode::TEMPLATE_STANDARD`
| Mode | Template |
| ---------- | --------------------------------------------- |
| `default` | {{subject}} must be a valid language code |
| `inverted` | {{subject}} must not be a valid language code |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- ISO codes
- Localization
## Changelog
| Version | Description |
| ------: | ----------------------------------------------------------------- |
| 3.0.0 | Require [sokil/php-isocodes][] and [sokil/php-isocodes-db-only][] |
| 1.1.0 | Created |
---
See also:
- [CountryCode](CountryCode.md)
[ISO 639]: https://en.wikipedia.org/wiki/ISO_639-3
[sokil/php-isocodes]: https://github.com/sokil/php-isocodes
[sokil/php-isocodes-db-only]: https://github.com/sokil/php-isocodes-db-only