hoa / locale
The Hoa\Locale library.
Installs: 33 963
Dependents: 1
Suggesters: 0
Security: 0
Stars: 11
Watchers: 11
Forks: 7
Open Issues: 2
Requires
- hoa/consistency: ~1.0
- hoa/exception: ~1.0
- hoa/http: ~1.0
Requires (Dev)
- hoa/test: ~2.0
This package is auto-updated.
Last update: 2021-09-20 08:31:21 UTC
README
Hoa is a modular, extensible and
structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.
Hoa\Locale
This library allows to get the informations of the locale from the system, the HTTP client or something else.
Installation
With Composer, to include this library into
your dependencies, you need to
require hoa/locale
:
$ composer require hoa/locale '~2.0'
For more installation procedures, please read the Source page.
Testing
Before running the test suites, the development dependencies must be installed:
$ composer install
Then, to run all the test suites:
$ vendor/bin/hoa test:run
For more information, please read the contributor guide.
Quick usage
We propose a quick overview to get the locale and related informations about an HTTP client. Next, we will see the other localizers.
Locale from an HTTP client
To get the locale from an HTTP client, we will use the
Hoa\Locale\Localizer\Http
localizer. Then, we will print the result of the
following interesting methods:
getLanguage
to get the language,getScript
to get the script,getRegion
to get the region,getVariants
to get variants of the locale.
Thus:
$locale = new Hoa\Locale(new Hoa\Locale\Localizer\Http()); echo 'language : ', $locale->getLanguage(), "\n", 'script : ', $locale->getScript(), "\n", 'region : ', $locale->getRegion(), "\n", 'variant : ', implode(', ', $locale->getVariants()), "\n";
For example, with the Accept-Language
HTTP header set to
zh-Hant-TW-xy-ab-123
, we will have:
language : zh
script : Hant
region : TW
variant : xy, ab, 123
Other localizers
So far, we also have the Hoa\Locale\Localizer\System
to get the locale
informations from the system and Hoa\Locale\Localizer\Coerce
to get them from
an arbitrary locale representation.
Documentation
The
hack book of Hoa\Locale
contains detailed information about how to use this library and how it works.
To generate the documentation locally, execute the following commands:
$ composer require --dev hoa/devtools $ vendor/bin/hoa devtools:documentation --open
More documentation can be found on the project's website: hoa-project.net.
Getting help
There are mainly two ways to get help:
- On the
#hoaproject
IRC channel, - On the forum at users.hoa-project.net.
Contribution
Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.
License
Hoa is under the New BSD License (BSD-3-Clause). Please, see
LICENSE
for details.