websafe/zf-mod-language

A ZF2 module which takes care of detecting an optimal and/or the requested locale for Your application's translator. The locale is computed/detected basing on values found in: Accept-Language header, cookie, session, query parameter and route parameter. Each detection method can be disabled/enabled via configuration.

WebsafeZfModLanguage

A ZF2 module which takes care of detecting an optimal and|or the requested locale for Your application's translator. The locale is computed/detected basing on values found in: Accept-Language headers, cookie, session, query parameter and route parameter. Each detection method can be disabled/enabled via configuration., _(*1)

Provides:, _(*2)

• The language service accessible via ServiceManager. See: WebsafeZfModLanguageService and WebsafeZfModLanguageServiceFactory., _(*3)

• A Controller for handling client requests (switching locale/language). See: WebsafeZfModLanguageController., _(*4)

• View Helpers for showing language selecting menus/dropdowns etc., _(*5)

Using WebsafeZfModLanguage in Your application

In project's root run:, _(*6)

~~~~ bash vendor/bin/composer.phar require "websafe/zf-mod-language:*", _(*7)

In `config/application.config.php` add `WebsafeZfModLanguage`:

~~~~ php
    // ...
    'modules' => array(
        // ...
        'Application',
        'WebsafeZfModLanguage',
        // ...
    ),

That's all. The module should work now - transparently. Test it on the official ZendSkeletonApplication and try to modify browsers Accept-Language headers or just add ?language=ja_JP (or any other locale available in supported_locales) in the url., _(*8)

You should notice a language change, because the default configuration tells the language service to detect the locale in the query too, see options detect_in_query and query_param., _(*9)

There's already a basic view helper included, so after enabling the module in config/application.config.php You can try to add the following code somewhere in layout.phtml or in other view scripts:, _(*10)

~~~~ php languageSelect();?> ~~~~, _(*11)

The view helper is currently the only reason for the Controller to exist., _(*12)

Configuration

How locale/language detection is handled.

1. The module attaches the DetectLanguagesListener to the event manager., _(*13)

2. The DetectLanguagesListener is now waiting for a dispatch event (MvcEvent::EVENT_DISPATCH)..., _(*14)

   1. When the dispatch event occurs, DetectLanguagesListener forwards the event to the language service WebsafeZfModLanguageService., _(*15)

   2. The language service collects data for locale detection:, _(*16)

   • Retrieve languages requested by the client/browser via [Accept-Language] headers. Add all results ordered by priority to the detectedLanguages array., _(*17)

   • Retrieve locale stored in cookie (name of cookie is configurable). Prepend the retrieved locale to the front of detectedLanguages., _(*18)

   • Retrieve locale stored in session (container name and session variable name are configurable). Prepend the retrieved locale to the front of detectedLanguages., _(*19)

   • Retrieve locale provided in query parameter (parameter name is configurable). Prepend the retrieved locale to the front of detectedLanguages., _(*20)

   • Retrieve locale provided in route parameter (parameter name is configurable). Prepend the retrieved locale to the front of detectedLanguages., _(*21)

   1. The language service iterates through detectedLanguages and stops iterating after the first detected locale that exists in [supported_locales]. The matched locale is now accessible via $sm->get('WebsafeZfModLanguageService')->getCurrentLocale()., _(*22)

   2. The language service applies the current locale to the translator service., _(*23)