respect-validation/docs/validators/LanguageCode.md
Alexandre Gomes Gaigalas d9cdc118b2 Introduce REUSE compliance
This commit introduces REUSE compliance by annotating all files
with SPDX information and placing the reused licences in the
LICENSES folder.

We additionally removed the docheader tool which is made obsolete
by this change.

The main LICENSE and copyright text of the project is now not under
my personal name anymore, and it belongs to "The Respect Project
Contributors" instead.

This change restores author names to several files, giving the
appropriate attribution for contributions.
2026-01-21 06:28:11 +00:00

72 lines
1.9 KiB
Markdown

<!--
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-License-Identifier: MIT
-->
# 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