twi/multi-domain-locale-bundle

Simple locale bundle for symfony2

dev-master / 1.0.x-dev 2014-02-03 12:35 UTC

Requires

• php: >=5.3.0
• symfony/framework-bundle: ~2.1

Requires (Dev)

• sensio/framework-extra-bundle: <2.1.5
• symfony/browser-kit: <2.1.5
• symfony/class-loader: <2.1.5
• symfony/css-selector: <2.1.5
• symfony/finder: <2.1.5
• symfony/form: <2.1.5
• symfony/framework-bundle: <2.1.5
• symfony/http-foundation: <2.1.5
• symfony/http-kernel: <2.1.5
• symfony/process: <2.1.5
• symfony/routing: <2.1.5
• symfony/twig-bundle: <2.1.5
• symfony/validator: <2.1.5
• symfony/yaml: <2.1.5

Apache

• Thomas Wiener

• locale

README

General

Why another locale bundle? Good question.

We used different approaches (jms i18n bundle, lunatics ...) to finally got our locale configuration up and running, but at the end we always had issues with requirements that were not included.

This bundle is for you if you ....

• are using locales that combine language and country: de_DE, fr_FR, de_CH
• have different domains (mycompany.de, mycompany.ch, mycompany.fr)
• want to allow only certain locales for certain domains (eg. .de => de_DE ; .ch => de_CH, fr_CH, it_CH ; .fr => fr_FR)
• don't want to use cookies to store the locale settings

Installation

The installation of MultiDomainLocaleBundle is pretty straight forward. Just add the following to your composer.json:

// composer.json
{
    // ...
    require: {
        // ...
        "twi/multi-domain-locale-bundle": "1.0.*@dev"
    }
}

Update your lib with composer update:

php composer.phar update

Add the bundle to your AppKernel:

<?php

// in AppKernel::registerBundles()
$bundles = array(
    // ...
    new TWI\MultiDomainLocaleBundle\TWIMultiDomainLocaleBundle(),
    // ...
);

Installation is done. But you will need to configure a few thing before it really works.

Configuration

Up front the whole configuration, explantion inline:

    # locale type select either long (like de_DE) or short (like de)
    locale_type: long

    # all allowed locales, new locales MUST be defined here!!!
    locales_allowed: de_DE|en_GB|de_CH|fr_FR     # mandatory, list all supported locales for your site

    # specify which locale is allowed in which country by top level domain
    localesByCountry:                            # mandatory
        ch:                                      # top level domain
            name: Switzerland                    # Name of Country
            locales: [de_CH, fr_FR, en_GB]       # Allowed locales for this domain
            default_locale: de_CH                # Fallback locale if none or unknown locale is given
        de:
            name: Germany
            locales: [de_DE, en_GB]
            default_locale: de_DE

        #add more countries here

        # default, is only for dev environments without a valid top level domain
        default:                                  # mandatory
            name: Germany
            locales: [de_DE, en_GB]
            default_locale: de_DE

    # Config data for locales, important for language dropdown menu
    locales_config:                               # mandatory
        de_DE:
            image: de.gif
            label: Deutsch
        de_CH:
            image: de_ch.gif
            label: Deutsch (Schweiz)
        fr_FR:
            image: fr.gif
            label: Français
        en_GB:
            image: en.gif
            label: English

    # Whitelist of routes, where locale validation is activated
    include_paths:                                  # mandatory
        - /demo
        - /user

    # Optional stuff, you can easily overwrite if necessary

    # Regular Expression to find a locale pattern like 'de_DE' or 'de' within a string (url)
    regex_locale_long:      |\/(?P<locale>[a-z]{2}_[A-Z]{2})\/|
    regex_locale_short:     |\/(?P<locale>[a-z]{2})\/|

    # Cookie name for user locale
    cookie_name:  tl                                    # optional

In routing, add /{_locale} in front of all necessary routes.

login_check:
    pattern:   /{_locale}/login_check
    requirements:
        _locale: %locales_allowed%

TWIG

If you need all available locales for a certain domain you can access the locale items service from any twig template by adding the following to your app/config/config.yml:

twig:
    globals:
        locales:            @parku.twig.locale

In TWIG you can access the result array by calling locales.getItems. Depending on your settings in your parameters (take a closer look at locales_config) you can change image filename and label of corresponding locale.

<ul>
    {% for item in locales.getItems %}
        <li>
            <a href="{{ path(app.request.attributes.get("_route"), (app.request.attributes.get('_route_params') ?: [])|merge({"_locale": item.key })) }}">
                <img src="/img/flags/{{ item.image }}"><span>{{ item.label }}</span>
            </a>
        </li>
    {% endfor %}
</ul>