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
Requires
- php: >=5.4
- zendframework/zendframework: 2.2.*
Requires (Dev)
This package is not auto-updated.
Last update: 2024-12-17 02:59:16 UTC
README
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.
Provides:
-
The language service accessible via ServiceManager. See: WebsafeZfModLanguageService and WebsafeZfModLanguageServiceFactory.
-
A Controller for handling client requests (switching locale/language). See: WebsafeZfModLanguageController.
-
View Helpers for showing language selecting menus/dropdowns etc.
Using WebsafeZfModLanguage in Your application
In project's root run:
vendor/bin/composer.phar require "websafe/zf-mod-language:*"
In config/application.config.php
add WebsafeZfModLanguage
:
// ... '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.
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
.
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:
<?php echo $this->languageSelect();?>
The view helper is currently the only reason for the Controller to exist.
Configuration
How locale/language detection is handled.
-
The module attaches the DetectLanguagesListener to the event manager.
-
The DetectLanguagesListener is now waiting for a dispatch event (
MvcEvent::EVENT_DISPATCH
)... -
When the dispatch event occurs, DetectLanguagesListener forwards the event to the language service WebsafeZfModLanguageService.
1. The language service collects data for locale detection:
+ Retrieve languages requested by the client/browser via
[Accept-Language] headers. Add all results ordered by priority
to the `detectedLanguages` array.
+ Retrieve locale stored in cookie (name of cookie is configurable).
Prepend the retrieved locale to the front of `detectedLanguages`.
+ Retrieve locale stored in session (container name and session
variable name are configurable).
Prepend the retrieved locale to the front of `detectedLanguages`.
+ Retrieve locale provided in query parameter (parameter name is
configurable).
Prepend the retrieved locale to the front of `detectedLanguages`.
+ Retrieve locale provided in route parameter (parameter name is
configurable).
Prepend the retrieved locale to the front of `detectedLanguages`.
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()`.
1. The language service applies the current locale to the `translator`
service.