slm/locale

Automatic detection of locales for Zend Framework

Tuesday, December 12, 2017
by bushbaby
Repository
14 Watchers
64 Stars
35,388 Installations

PHP
1 Dependents
1 Suggesters
37 Forks
10 Open issues
18 Versions
4 % Grown

The README.md

SlmLocale

, _(*1)

Created by Jurian Sluiman, _(*2)

Introduction

SlmLocale is a Laminas module to automatically detect a locale for your application. It uses a variety of pluggable strategies to search for a valid locale. SlmLocale features a default locale, a set of supported locales and locale aliases., _(*3)

SlmLocale supports out of the box several strategies to search for a locale. Through interfaces, other strategies could be created. The set of default stragies is:, _(*4)

The HTTP Accept-Language header
A cookie to store the locale between several sessions of one visitor
A query parameter to easily switch from locale
The first segment of the path of an uri
A part of the domain name (either the TLD or a subdomain)

Furthermore, it provides a set of additional localisation features:, _(*5)

A default locale, used as fallback
A set of aliases, so you can map .com as "en-US" in the host name strategy
Redirect to the right domain/path when a locale is found
View helpers to create a localised uri or a list of language switches

Installation

Add "slm/locale" to your composer.json file and update your dependencies. Enable SlmLocale in your application.config.php., _(*6)

If you do not have a composer.json file in the root of your project, copy the contents below and put that into a file called composer.json and save it in the root of your project:, _(*7)

{
    "require": {
        "slm/locale": ">=0.1.0,<1.2.0-dev"
    }
}

Then execute the following commands in a CLI:, _(*8)

curl -s http://getcomposer.org/installer | php
php composer.phar install

Now you should have a vendor directory, including a slm/locale. In your bootstrap code, make sure you include the vendor/autoload.php file to properly load the SlmLocale module., _(*9)

Usage

Set your default locale in the configuration:, _(*10)

'slm_locale' => [
    'default' => 'nl-NL',
],

Set all your supported locales in the configuration:, _(*11)

'slm_locale' => [
    'supported' => ['en-US', 'en-GB'],
],

And enable some strategies. The naming is made via the following list:, _(*12)

cookie: SlmLocale\Strategy\CookieStrategy
host: SlmLocale\Strategy\HostStrategy
acceptlanguage: SlmLocale\Strategy\HttpAcceptLanguageStrategy
query: SlmLocale\Strategy\QueryStrategy
uripath: SlmLocale\Strategy\UriPathStrategy
asset: SlmLocale\Strategy\AssetStrategy

You can enable one or more of them in the strategies list. Mind the priority is important! You usually want the acceptlanguage as last for a fallback:, _(*13)

'slm_locale' => [
    'strategies' => ['uripath', 'acceptlanguage'],
],

At this moment, the locale should be detected. The locale is stored inside php's Locale object. Retrieve the locale with Locale::getDefault(). This is also automated inside Laminas translator objects and i18n view helpers (so you do not need to set the locale yourself there)., _(*14)

Set the locale's language in html

It is common to provide the html with the used locale. This can be set for example in the html tag:, _(*15)

<html lang="en">

Inject the detected language here with the following code:, _(*16)

<html lang="<?= $this->primaryLanguage()?>">

Disable UriPathStrategy in PHPUNIT

This is necessary (at the moment) if you want to use this->dispatch('my/uri'); in your AbstractHttpControllerTestCase unit tests. Otherwise, if you check for responseCode you will get 302 where it should be 200., _(*17)

Example:, _(*18)

$this->dispatch('/to/my/uri');
$this->assertResponseStatusCode(200); // this will be 302 instead of 200

$this->dispatch('/en/to/my/uri');
$this->assertResponseStatusCode(200); // this will be 302 instead of 200

To fix add the following to your phpunit config., _(*19)

phpunit.xml:, _(*20)

<phpunit...>
    ...
    <php>
        <server name="DISABLE_URIPATHSTRATEGY" value="true" />
    </php>
</phpunit>

Or set $_SERVER['DISABLE_URIPATHSTRATEGY'] = true; in your bootstrap file of phpunit., _(*21)

Create a list of available locales

T.B.D, _(*22)

Read more about usage and the configuration of all the strategies in the documentation., _(*23)

The Versions

12/12 2017

dev-develop

dev-develop https://github.com/juriansluiman/SlmLocale

Automatic detection of locales for Zend Framework

library locale

Automatic detection of locales for Zend Framework

slm/locale

The README.md

SlmLocale

Introduction

Installation

Usage

Set the locale's language in html

Disable UriPathStrategy in PHPUNIT

Create a list of available locales

The Versions

dev-develop

The Requires

The Development Requires

by Jurian Sluiman

dev-master

The Requires

The Development Requires

by Jurian Sluiman

v0.3.0

The Requires

The Development Requires

by Jurian Sluiman

v0.2.1

The Requires

The Development Requires

by Jurian Sluiman

dev-pr-90/master

The Requires

The Development Requires

by Jurian Sluiman

v0.2.0

The Requires

The Development Requires

by Jurian Sluiman

dev-coverage

The Requires

The Development Requires

by Jurian Sluiman

dev-use-class-notation

The Requires

The Development Requires

by Jurian Sluiman

dev-exception-in-to-string

The Requires

The Development Requires

by Jurian Sluiman

dev-php-cs-fixer

The Requires

The Development Requires

by Jurian Sluiman

dev-ServiceManager-v3-and-EventManager-v3-support

The Requires

The Development Requires

by Jurian Sluiman

v0.1.0

The Requires

The Development Requires

by Jurian Sluiman

v0.1.0-beta4

The Requires

The Development Requires

by Jurian Sluiman

v0.1.0-beta3

The Requires

The Development Requires

by Jurian Sluiman

v0.1.0-beta2

The Requires

The Development Requires

by Jurian Sluiman

v0.1.0-beta1

The Requires

The Development Requires

by Jurian Sluiman

v0.0.1

The Requires

by Jurian Sluiman

dev-feature/view-helpers