josantonius / language-code
PHP library to get language name from code.
Fund package maintenance!
Josantonius
Installs: 4 063
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 3
Open Issues: 0
Requires
- php: ^8.0
Requires (Dev)
- phpmd/phpmd: ^2.6
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: ^3.7
README
Translations: Español
PHP library to get language name from code.
- Requirements
- Installation
- Available Classes
- Usage
- List in JSON format
- Tests
- TODO
- Changelog
- Contribution
- Sponsor
- License
Requirements
Operating System: Linux | Windows.
PHP versions: 8.0 | 8.1 | 8.2.
Installation
The preferred way to install this extension is through Composer.
To install PHP LanguageCode library, simply:
composer require josantonius/language-code
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
composer require josantonius/language-code --prefer-source
You can also clone the complete repository with Git:
clone https://github.com/josantonius/php-language-code.git
Available Classes
LanguageCode Class
Josantonius\LanguageCode\LanguageCode
Get all language codes as array:
public static function all(): array;
Get language code from language name:
public static function getCode(string $languageName): string|null;
Get language name from language code:
public static function getName(string $languageCode): string|null;
LanguageCodeCollection Class
Josantonius\LanguageCode\LanguageCodeCollection
Get all language codes as array:
public static function all(): array
Get language code from language name:
public static function getCode(string $languageName): string|null
Get language name from language code:
public static function getName(string $languageCode): string|null
Usage
Example of use for this library:
Get all language codes as array
use Josantonius\LanguageCode\LanguageCode; $languageCode = new LanguageCode(); $languageCode->all();
use Josantonius\LanguageCode\LanguageCodeCollection; LanguageCodeCollection::all();
Result:
[ 'aa' => 'Afar', 'ab' => 'Abkhazian', 'af' => 'Afrikaans', 'am' => 'Amharic', 'ar' => 'Arabic', 'ar-ae' => 'Arabic (U.A.E.)', 'ar-bh' => 'Arabic (Bahrain)', 'ar-dz' => 'Arabic (Algeria)', 'ar-eg' => 'Arabic (Egypt)', 'ar-iq' => 'Arabic (Iraq)', (...) ]
Get language code from language name
use Josantonius\LanguageCode\LanguageCode; $languageCode = new LanguageCode(); $languageCode->getCode('Spanish'); // es
use Josantonius\LanguageCode\LanguageCodeCollection; LanguageCodeCollection::getCode('Turkish'); // tr
Get language name from language code
use Josantonius\LanguageCode\LanguageCode; $languageCode = new LanguageCode(); $languageCode->getName('eo'); // Esperanto
use Josantonius\LanguageCode\LanguageCodeCollection; LanguageCodeCollection::getName('de'); // German
List in JSON format
Tests
To run tests you just need composer and to execute the following:
git clone https://github.com/josantonius/php-language-code.git
cd php-language-code
composer install
Run unit tests with PHPUnit:
composer phpunit
Run 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
TODO
- Add new feature
- Improve tests
- Improve documentation
- Improve English translation in the README file
- Refactor code for disabled code style rules (see phpmd.xml and phpcs.xml)
Changelog
Detailed changes for each release are documented in the release notes.
Contribution
Please make sure to read the Contributing Guide, before making a pull request, start a discussion or report a issue.
Thanks to all contributors! ❤️
Sponsor
If this project helps you to reduce your development time, you can sponsor me to support my open source work 😊
License
This repository is licensed under the MIT License.
Copyright © 2017-present, Josantonius