respect-validation/docs/validators/LanguageCode.md
Henrique Moody 7c681fec66
Fix SPDX headers in all files
I ran the `bin/console spdx --fix` with different strategies for
different files. For most of the core classes, since they've been
drastically rebuilt, I've run it with the `git-blame` strategy, for for
the `src/Validators`, in which the API changed completely but the logic
remains the same, I use the `git-log` strategy.
2026-02-03 15:23:23 +01:00

73 lines
2.1 KiB
Markdown

<!--
SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
SPDX-FileContributor: Emmerson Siqueira <emmersonsiqueira@gmail.com>
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
-->
# 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