List of 217 language codes: ISO 639-1.
- Requirements
- Installation
- Available Methods
- Quick Start
- Usage
- List in JSON format
- Tests
- TODO
- Contribute
- Repository
- License
- Copyright
This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.
The preferred way to install this extension is through Composer.
To install PHP LanguageCode library, simply:
$ composer require Josantonius/LanguageCode
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
$ composer require Josantonius/LanguageCode --prefer-source
You can also clone the complete repository with Git:
$ git clone https://github.com/Josantonius/PHP-LanguageCode.git
Or install it manually:
Download LanguageCode.php and LanguageCodeCollection.php:
$ wget https://raw.githubusercontent.com/Josantonius/PHP-LanguageCode/master/src/LanguageCode.php
$ wget https://raw.githubusercontent.com/Josantonius/PHP-LanguageCode/master/src/LanguageCodeCollection.php
Available methods in this library:
LanguageCode::get();
# Return (array) → language codes and language names
LanguageCode::getLanguageFromCode($languageCode);
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$languageCode | Language code, e.g. 'es'. | string | Yes |
# Return (tring|false) → country name
LanguageCode::getCodeFromLanguage($languageName);
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$languageName | Language name, e.g. 'Spanish'. | string | Yes |
# Return (tring|false) → language code
To use this library with Composer:
require __DIR__ . '/vendor/autoload.php';
use Josantonius\LanguageCode\LanguageCode;
Or If you installed it manually, use it:
require_once __DIR__ . '/LanguageCode.php';
require_once __DIR__ . '/LanguageCodeCollection.php';
use Josantonius\LanguageCode\LanguageCode;
Example of use for this library:
To run tests you just need composer and to execute the following:
$ git clone https://github.com/Josantonius/PHP-LanguageCode.git
$ cd PHP-LanguageCode
$ composer install
Run unit tests with PHPUnit:
$ composer phpunit
Run PSR2 code standard tests with PHPCS:
$ composer phpcs
Run PHP Mess Detector tests to detect inconsistencies in code style:
$ composer phpmd
Run all previous tests:
$ composer tests
- Add new feature.
- Improve tests.
- Improve documentation.
- Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.
If you would like to help, please take a look at the list of issues or the To Do checklist.
Pull requests
- Fork and clone.
- Run the command
composer install
to install the dependencies. This will also install the dev dependencies. - Run the command
composer fix
to excute code standard fixers. - Run the tests.
- Create a branch, commit, push and send me a pull request.
The file structure from this repository was created with PHP-Skeleton.
This project is licensed under MIT license. See the LICENSE file for more info.
2017 - 2018 Josantonius, josantonius.com
If you find it useful, let me know 😉