codezero/browser-locale

Get the most preferred locales from your visitor's browser.

BrowserLocale

, _(*1)

, _(*2)

Get the most preferred locales from your visitor's browser., _(*3)

Every browser has a setting for preferred website locales., _(*4)

This can be read by PHP, usually with the $_SERVER["HTTP_ACCEPT_LANGUAGE"] variable., _(*5)

$_SERVER["HTTP_ACCEPT_LANGUAGE"] will return a comma separated list of language codes. Each language code MAY have a "relative quality factor" attached ("nl;q=0.8") which determines the order of preference. For example: nl-NL,nl;q=0.8,en-US;q=0.6,en;q=0.4. If no relative quality factor is present, the value is by default 1.0., _(*6)

BrowserLocale parses this string and lets you access the preferred locales quickly and easily., _(*7)

Requirements

• PHP >= 7.0

Install

composer require codezero/browser-locale

Instantiate

For vanilla PHP:, _(*8)

$browser = new \CodeZero\BrowserLocale\BrowserLocale($_SERVER["HTTP_ACCEPT_LANGUAGE"]);

For Laravel:, _(*9)

Laravel >= 5.5 will automatically register the ServiceProvider so you can get BrowserLocale from the IOC container., _(*10)

$browser = \App::make(\CodeZero\BrowserLocale\BrowserLocale::class);

Get Primary Locale

$locale = $browser->getLocale();

This will return an instance of \CodeZero\BrowserLocale\Locale or null if no locale exists., _(*11)

if ($locale !== null) {
    $full     = $locale->locale;   // Example: "en-US"
    $language = $locale->language; // Example: "en"
    $country  = $locale->country;  // Example: "US"
    $weight   = $locale->weight;   // Example: 1.0
}

Get All Locales

$locales = $browser->getLocales();

This will return an array of \CodeZero\BrowserLocale\Locale instances, sorted by weight in descending order. So the first array item is the most preferred locale., _(*12)

If no locales exist, an empty array will be returned., _(*13)

foreach ($locales as $locale) {
    $full     = $locale->locale;   // Example: "en-US"
    $language = $locale->language; // Example: "en"
    $country  = $locale->country;  // Example: "US"
    $weight   = $locale->weight;   // Example: 1.0  
}

Filter Locale Info

You can get a flattened array with only specific Locale information. These arrays will always be sorted by weight in descending order. There will be no duplicate values! (e.g. en and en-US are both the language en), _(*14)

LocaleFilter

Returns an array of every locale found in the input string., _(*15)

$browser = new \CodeZero\BrowserLocale\BrowserLocale('en-US,en;q=0.8,nl-NL;q=0.6');
$filter = new \CodeZero\BrowserLocale\Filters\LocaleFilter;
$locales = $browser->filter($filter);
//=> Result: ['en-US', 'en', 'nl-BE']

CombinedFilter

Returns an array of every locale found in the input string, while making sure the 2-letter language version of the locale is always present., _(*16)

$browser = new \CodeZero\BrowserLocale\BrowserLocale('en-US,nl;q=0.8');
$filter = new \CodeZero\BrowserLocale\Filters\CombinedFilter;
$locales = $browser->filter($filter);
//=> Result: ['en-US', 'en', 'nl']

LanguageFilter

Returns an array of only the 2-letter language codes found in the input string. Language codes are also extracted from full locales and added to the results array., _(*17)

$browser = new \CodeZero\BrowserLocale\BrowserLocale('en-US,en;q=0.8,nl-NL;q=0.6');
$filter = new \CodeZero\BrowserLocale\Filters\LanguageFilter;
$languages = $browser->filter($filter);
//=> Result: ['en', 'nl']

CountryFilter

Returns an array of only the 2-letter country codes found in the input string. Locales that only contain a 2-letter language code will be skipped., _(*18)

$browser = new \CodeZero\BrowserLocale\BrowserLocale('en-US,en;q=0.8,nl-NL;q=0.6,nl;q=0.4');
$filter = new \CodeZero\BrowserLocale\Filters\CountryFilter;
$countries = $browser->filter($filter);
//=> Result: ['US', 'NL']

WeightFilter

Returns an array of all relative quality factors found in the input string. The default of 1.0 is also included., _(*19)

$browser = new \CodeZero\BrowserLocale\BrowserLocale('en-US,en;q=0.8,nl-NL;q=0.6,nl;q=0.4');
$filter = new \CodeZero\BrowserLocale\Filters\WeightFilter;
$weights = $browser->filter($filter);
//=> Result: [1.0, 0.8, 0.6, 0.4]

You can create your own filters by implementing the \CodeZero\BrowserLocale\Filters\Filter interface., _(*20)

Testing

composer test

Security

If you discover any security related issues, please e-mail me instead of using the issue tracker., _(*21)

Changelog

A complete list of all notable changes to this package can be found on the releases page., _(*22)

License

The MIT License (MIT). Please see License File for more information., _(*23)