https://github.com/sylvaincombes/php-lcid
Library to find iso language code from a microsoft LCID
https://github.com/sylvaincombes/php-lcid
icu icu-locale intl language lcid locale microsoft-lcid php php-lcid
Last synced: 30 days ago
JSON representation
Library to find iso language code from a microsoft LCID
- Host: GitHub
- URL: https://github.com/sylvaincombes/php-lcid
- Owner: sylvaincombes
- License: mit
- Created: 2018-03-06T13:44:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-24T23:02:19.000Z (over 5 years ago)
- Last Synced: 2025-07-22T09:50:10.712Z (3 months ago)
- Topics: icu, icu-locale, intl, language, lcid, locale, microsoft-lcid, php, php-lcid
- Language: PHP
- Size: 16.6 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# php-lcid
Php library trying to get a valid Unicode Locale for a given Microsoft LCID.
## Installation
```
composer require sylvaincombes/php-lcid
```
## Usage
### Basic usage
```php
findByLcidWithFallback(8201);
// Should give you $locale == 'en'
// You can avoid searching in fallbacks if you really want to
$locale = $finder->findByLcid(1036);
// Should give you $locale == 'fr_FR'
// 2. Finding lcid(s) by locale
$localeLcid = $finder->findOneByLocale('fr');
// Should give you $localeLcid == 1036
// NB : this method is limited as it will return only 'perfect match'
$localeLcid = $finder->findByLocale('fr');
/**
* Get an array or null in response (search everywhere)
* First result in array should be the 'best' match
*
* Return example :
* array(8) {
* [0] => int(1036)
* [1] => int(11276)
* [2] => int(9228)
* [3] => int(12300)
* [4] => int(13324)
* [5] => int(14348)
* [6] => int(10252)
* [7] => int(7180)
* }
*
*/
```
### "Advanced" usage
#### Using custom datas
```php
LCIDs were deprecated with Windows Vista and Microsoft recommends that developers use [BCP47](https://tools.ietf.org/html/bcp47) style tags instead (uloc_toLanguageTag).
## Contributing
All contributions are very welcome.
### Updating datas list
There is a command who build the datas, what it does is :
1. Fetching a json from [sindresorhus/lcid](https://raw.githubusercontent.com/sindresorhus/lcid/master/lcid.json) - **this is our starting non editable datas point**
1. Check if locales are found in symfony/intl locales list
- If yes keep them
- If no trying to find if a locale or language is matching
- If yes adding to the fallback list
- If no remove this entry
1. Load the php array in file [src/SylvainCombes/Lcid/Resources/datas-manual.php](src/SylvainCombes/Lcid/Resources/datas-manual.php) if some lcid codes are not in the datas do it's best with lcid, language, locale fields to add them in the list or in the fallback entries.
So to edit / delete / add some datas not present in the base json, you should edit [src/SylvainCombes/Lcid/Resources/datas-manual.php](src/SylvainCombes/Lcid/Resources/datas-manual.php) and re-launch the command :
```
php bin/console lcid:generate-datas -v
```
And the [datas.json](src/SylvainCombes/Lcid/Resources/datas.json) will be updated.
> NB : It also mean you can't override datas provided by the base json grabbed from [sindresorhus/lcid](https://raw.githubusercontent.com/sindresorhus/lcid/master/lcid.json)
### Testing
Launching the project tests :
```
composer run test
```
### Lint php
```
composer run lint
```
You can also "autofix" :
```
composer run fix
```
## References
### ICU Locale
- [ICU Locale](http://userguide.icu-project.org/locale#TOC-Language-code)
### LCID
- [sindresorhus/lcid](https://github.com/sindresorhus/lcid) - Based on the [mapping](https://github.com/python/cpython/blob/be2a1a76fa43bb1ea1b3577bb5bdd506a2e90e37/Lib/locale.py#L1395-L1604) used in the Python standard library.
- [Locale codes](https://www.science.co.il/language/Locale-codes.php)
- [Microsoft Locale ID Values](https://msdn.microsoft.com/en-us/library/ms912047(WinEmbedded.10).aspx)
### BCP 47
- [IANA Registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry)
- [IANA RFC](http://www.rfc-editor.org/rfc/bcp/bcp47.txt)
### Formats
- [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
- [ISO15924](http://unicode.org/iso15924/iso15924-codes.html)
- [ISO_3166-1](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes)
### Libraries used
#### Required
- [thephpleague/json-guard](http://json-guard.thephpleague.com) - *used to validate custom user json datas against a json schema*
#### Used in dev
- [phpunit](https://phpunit.de/) - *used for ... testing*
- [symfony/intl]() - *used in dev to check if locales in datas sources matches the locales list provided (I found that this locales list was different than using the one provided by the php-intl extension and I tend to think the one in this package is more robust and widely used instead of depending on local installation / configuration of a php extension)*
- [symfony/console](https://symfony.com/doc/current/components/console.html) - *used in dev for console command building datas*
- [phpcs + coke + symfony2-coding-standard](https://github.com/M6Web/Symfony2-coding-standard) - *pimp my ride*
- [json schema lint](https://jsonschemalint.com) - *used to check / test writing the json schema*
- [regex101](https://regex101.com/r/MouP4d/1) - *used to writing / testing the locale regexp*