Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sokil/php-isocodes
:star: PHP library providing ISO codes with localization: country (ISO 3166-1), subdivision (ISO 3166-2), language (ISO 639-3), currency (ISO 4217) and scripts (ISO 15924)
https://github.com/sokil/php-isocodes
countries country-codes currencies currencies-database currency gettext iso-codes iso15924 iso3166 iso3166-1 iso3166-2 iso4217 iso639 iso639-3 l10n language php translation
Last synced: 8 days ago
JSON representation
:star: PHP library providing ISO codes with localization: country (ISO 3166-1), subdivision (ISO 3166-2), language (ISO 639-3), currency (ISO 4217) and scripts (ISO 15924)
- Host: GitHub
- URL: https://github.com/sokil/php-isocodes
- Owner: sokil
- License: mit
- Created: 2014-05-24T09:28:17.000Z (over 10 years ago)
- Default Branch: 4.0
- Last Pushed: 2024-10-28T15:59:43.000Z (23 days ago)
- Last Synced: 2024-10-30T04:34:35.632Z (21 days ago)
- Topics: countries, country-codes, currencies, currencies-database, currency, gettext, iso-codes, iso15924, iso3166, iso3166-1, iso3166-2, iso4217, iso639, iso639-3, l10n, language, php, translation
- Language: PHP
- Homepage: http://sokil.github.io/php-isocodes/
- Size: 69 MB
- Stars: 168
- Watchers: 3
- Forks: 13
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Stand With Ukraine 🇺🇦
[](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
----
# PHP ISO Codes
[](https://github.com/sokil/php-isocodes/actions?query=workflow%3A%22Continuous+integration%22)
[](https://packagist.org/packages/sokil/php-isocodes)
[](https://coveralls.io/r/sokil/php-isocodes)
[](https://packagist.org/packages/sokil/php-isocodes)
[](https://packagist.org/packages/sokil/php-isocodes/stats)
:star: This library used to get localized names of countries, currencies, languages and scripts.
:package: Based on Python's [pycountry](https://pypi.python.org/pypi/pycountry) and Debian's [iso-codes](https://salsa.debian.org/iso-codes-team/iso-codes.git).
:tongue: Current translation status: https://salsa.debian.org/iso-codes-team/iso-codes#status-of-translations
## Table of contents
* [ISO Standards](#iso-standards)
* [Installation](#installation)
* [Translation drivers](#translation-drivers)
* [Gettext extension driver](#gettext-extension-driver)
* [Locale configuration](#locale-configuration)
* [Symfony Translation driver](#symfony-translation-driver)
* [Dummy driver](#dummy-driver)
* [Usage](#usage)
* [Locale configuration](#locale-configuration)
* [Countries database (ISO 3166-1)](#countries-database-iso-3166-1)
* [Subdivisions database (ISO 3166-2)](#subdivisions-database-iso-3166-2)
* [Historic countries database (ISO 3166-3)](#historic-countries-database-iso-3166-3)
* [Scripts database (ISO 15924)](#scripts-database-iso-15924)
* [Currencies database (ISO 4217)](#currencies-database-iso-4217)
* [Languages database (ISO 639-3)](#languages-database-iso-639-3)
* [Tests](#tests)
## ISO Standards
* **ISO 3166-1**: Country codes (alpha-2, alpha-3, numeric)
* **ISO 3166-2**: Principal subdivisions (e.g., provinces or states) of all countries coded in ISO 3166-1
* **ISO 3166-3**: Historic countries (alpha-2, alpha-3, alpha-4, numeric)
* **ISO 15924**: Scripts
* **ISO 4217**: Currencies
* **ISO 639-3**: Languages
## Installation
You may use this library in different modes:
* `sokil/php-isocodes` (this library) - install library without database and messages and setup
periodic updates of database and messages by yourself with cron or inside CI/CD pipeline with `./bin/update_iso_codes_db.sh`
* [sokil/php-isocodes-db-only](https://github.com/sokil/php-isocodes-db-only) - if you do not need internationalisation, use
this library. Database already inside. To update database just periodically update this library.
* [sokil/php-isocodes-db-i18n](https://github.com/sokil/php-isocodes-db-i18n) - if you need internationalisation, use
this library. Database and messages already inside. To update database
just periodically update this library.
#### 💾 Library with included database and localization
To install [library with database and i18n](https://github.com/sokil/php-isocodes-db-i18n):
[](https://packagist.org/packages/sokil/php-isocodes-db-i18n)
[](https://packagist.org/packages/sokil/php-isocodes-db-i18n)
[](https://packagist.org/packages/sokil/php-isocodes-db-i18n/stats)
```
composer require sokil/php-isocodes-db-i18n
```
#### 💾 Library with included database and without localization
You may also install [library with only database](https://github.com/sokil/php-isocodes-db-only) (no i18n will be available):
[](https://packagist.org/packages/sokil/php-isocodes-db-only)
[](https://packagist.org/packages/sokil/php-isocodes-db-only)
[](https://packagist.org/packages/sokil/php-isocodes-db-only/stats)
```
composer require sokil/php-isocodes-db-only
```
#### 💾 Library without database and localization, requires manual database installation and updates
You can install library through Composer:
```
composer require sokil/php-isocodes
```
Database and gettext files located in related packages inside `databases` and `messages` directories.
This packages periodically updated with package version increment.
If you want to update database, use script `./bin/update_iso_codes_db.sh`.
Call this script by cron, during deploy process or when build your docker image.
```
./bin/update_iso_codes_db.sh {mode} {base_dir} {build_dir}
```
| Argument | Required | Description |
| -------- | -------- | ----------- |
| mode | Required | May be "all" or "db_only". In "all" mode update database (json files) and locallisation (po and mo files), in "db_only" only database will update |
| base_dir| Required | Dir where to place database and messages |\
| build_dir | Optional. Default: "/tmp/iso-codes-build" | Dir where source directory cloned and files original files processed. |
Now you need to configure factory to use this directory:
```php
setLocale('uk_UA');
$isoCodes = new IsoCodesFactory(
null,
$driver
);
// dummy driver
$isoCodes = new IsoCodesFactory(
null,
new DummyDriver()
);
```
### Gettext extension driver
This is default translation driver. It requires `ext-gettext`.
```php
getLanguages();
// get local name of language
echo $languages->getByAlpha2('uk')->getLocalName(); // will print 'українська'
```
To get list of available locales, execute under console:
```sh
$ locale -a
```
```
uk_UA
uk_UA.koi8u
uk_UA.utf8
```
If you don't see required locales in list, you may install them manually (for Ubuntu):
```sh
$ locale-gen uk_UA.utf8
```
```
Generating locales...
uk_UA.utf-8... done
Generation complete.
```
### Symfony Translation driver
```php
setLocale('uk_UA');
$isoCodes = new IsoCodesFactory(
null,
$driver
);
```
### Dummy driver
This driver may be used, when localisation of names does not require, and only database of codes is required.
```php
getLanguages();
```
There are large databases: subdivisions and languages.
Loading of entire database into memory may require lot of RAM and time to create all entries in memory.
So there are scenarios of usage: with optimisations of memory and with optimisation of time.
#### Memory optimisation
Database splits into partition files.
Fetching some entry will load only little part of database.
Loaded entries not stored statically.
This scenario may be useful when just few entries need
to be loaded, for example on web request when one entry fetched.
This may require a lot of file read operations.
#### Input-output optimisations
Entire database loaded into memory from single JSON file once.
All entries created and stored into RAM. Next read of save
entry will just return it without io operations with files and building objects.
This scenario may be useful for daemons to decrease file operations,
or when most entries will be fetched from database.
This may require a lot of RAM for storing all entries.
### Countries database (ISO 3166-1)
Country contains next names:
| Name | Description | Example |
|----------------|-------------|----------------------|
| Name | Required | Moldova, Republic of |
| Official Name | Optional | Republic of Moldova |
| Common Name | Optional | Moldova |
| Localised Name | Optional | Молдова |
This names may be get from country entity:
```php
$isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
$country = $isoCodes->getCountries()->getByAlpha2('UA');
echo $country->getName();
echo $country->getLocalName();
echo $country->getOfficialName();
echo $country->getCommonName();
```
Also you may get flag of country:
```php
$isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
$country = $isoCodes->getCountries()->getByAlpha2('UA');
echo $country->getFlag();
```
Get localized name of country by it's alpha2 code:
```php
$isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
$isoCodes->getCountries()->getByAlpha2('UA')->getLocalName();
```
Get localized name of country by it's alpha3 code:
```php
$isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
$isoCodes->getCountries()->getByAlpha3('UKR')->getLocalName();
```
Get localized name of country by it's numeric code:
```php
$isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
$isoCodes->getCountries()->getByNumericCode('804')->getLocalName();
```
Get localised list of countries
```php
$isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
foreach($isoCodes->getCountries() as $country) {
echo $country->getLocalName();
}
```
### Subdivisions database (ISO 3166-2)
```php
getSubdivisions();
// get subdivision by code
$subDivision = $subDivisions->getByCode('UA-43');
// get subdivision code
$subDivision->getCode(); // UA-43
// get subdivision name
$subDivision->getName(); // Respublika Krym
// get localised subdivision name
$subDivision->getLocalName(); // Автономна Республіка Крим
// get subdivision type
$subDivision->getType(); // 'Autonomous republic'
```
### Historic countries database (ISO 3166-3)
```php
getHistoricCountries();
$country = $countries->getByAlpha4('ZRCD');
$country->getName(); //'Zaire, Republic of'
$country->getAlpha4(); // 'ZRCD'
$country->getAlpha3(); // 'ZAR'
$country->getAlpha2(); // 'ZR'
$country->getWithdrawalDate(); // '1997-07-14'
$country->getNumericCode(); // 180
```
### Scripts database (ISO 15924)
```php
getScripts();
$script = $scripts->getByAlpha4('Aghb');
$script->getName(); // Caucasian Albanian
$script->getLocalName(); // кавказька албанська
$script->getAlpha4(); // Aghb
$script->getNumericCode(); 239
```
### Currencies database (ISO 4217)
```php
getCurrencies();
$currency = $currencies->getByLetterCode('CZK');
$currency->getName(); // Czech Koruna
$currency->getLocalName(); // Чеська крона
$currency->getLetterCode(); // CZK
$currency->getNumericCode(); // 203
```
### Languages database (ISO 639-3)
```php
getLanguages();
$language = $languages->getByAlpha2('uk');
$language->getAlpha2(); // uk
$language->getName(); // Ukrainian
$language->getLocalName(); // українська
$language->getAlpha3(); // ukr
// Scope of denotation, see mote at https://iso639-3.sil.org/about/scope
$language->getScope(); // I
// Type of language, see https://iso639-3.sil.org/about/types
$language->getType(); // L
$language->getInvertedName(); // null
```
## Tests
To start docker tests run following command:
```
./tests/docker/run-test.sh [PHP_VERSION]
```
For example for PHP 7.1 run following command:
```
./tests/docker/run-test.sh 7.1
```
## See also
* [State Classifier of objects of administrative and territorial structure of Ukraine](https://github.com/sokil/koatuu) - generates database of detailed list of cities and settlements of Ukraine
* [A Symfony's PHP replacement layer for the C intl extension that also provides access to the localization data of the ICU library](http://symfony.com/doc/current/components/intl.html)
* [FamFacFam icon pack with flags](http://www.famfamfam.com/lab/icons/flags/)