Yii2 Language Picker

Yii2 Language Picker Widget

Introduction

The widget provides an easy to use language selector which makes it possible to change the language of our website easily. The language change can take place synchronously or asynchronously (through Ajax). The default method is asynchronous (through an Ajax call), however when this method fails for any reason (e.g. JavaScript is blocked on the client side) the new language will actualise synchronously through an automatic page reload.

The language switcher is fully customisable. However, the pre-defined options provide a dropdown list (DropDownList), and a link-based list (ButtonList). Both versions can display the name of the chosen language and the corresponding flag (icon).

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist user1007017/yii2-language-picker "1.*"

or add

"user1007017/yii2-language-picker": "1.*"

to the require section of your composer.json file.

Config:

Identifier of the language element. e.g.: en, en-US

Minimal configuration (icons only)

'language' => 'en',
'bootstrap' => ['languagepicker'],
'components' => [
    'languagepicker' => [
        'class' => 'user1007017\languagepicker\Component',
        'languages' => ['en', 'de', 'fr']                   // List of available languages (icons only)
    ]
],

Minimal configuration (icons and text)

'language' => 'en',
'bootstrap' => ['languagepicker'],
'components' => [
    'languagepicker' => [
        'class' => 'user1007017\languagepicker\Component',        // List of available languages (icons and text)
        'languages' => ['en' => 'English', 'de' => 'Deutsch', 'fr' => 'Français']
    ]
],

Full configuration (icons only)

'language' => 'en-US',
'bootstrap' => ['languagepicker'],
'components' => [
    'languagepicker' => [
        'class' => 'user1007017\languagepicker\Component',
        'languages' => ['en-US', 'de-DE', 'fr-FR'],         // List of available languages (icons only)
        'cookieName' => 'language',                         // Name of the cookie.
        'cookieDomain' => 'example.com',                    // Domain of the cookie.
        'expireDays' => 64,                                 // The expiration time of the cookie is 64 days.
        'callback' => function() {
            if (!\Yii::$app->user->isGuest) {
                $user = \Yii::$app->user->identity;
                $user->language = \Yii::$app->language;
                $user->save();
            }
        }
    ]
],

Yii2-translate-manager integration

Minimal configuration (icons only)

'language' => 'en',
'bootstrap' => ['languagepicker'],
'components' => [
    'languagepicker' => [
        'class' => 'user1007017\languagepicker\Component',
        'languages' => function () {                        // List of available languages (icons only)
            return array_keys(\user1007017\translatemanager\models\Language::getLanguageNames(true));
        }
    ]
],

Full configuration (icons and text)

'language' => 'en-US',
'bootstrap' => ['languagepicker'],
'components' => [
    'languagepicker' => [
        'class' => 'user1007017\languagepicker\Component',
        'languages' => function () {                        // List of available languages (icons and text)
            return \user1007017\translatemanager\models\Language::getLanguageNames(true);
        },
        'cookieName' => 'language',                         // Name of the cookie.
        'cookieDomain' => 'example.com',                    // Domain of the cookie.
        'expireDays' => 64,                                 // The expiration time of the cookie is 64 days.
        'callback' => function() {
            if (!\Yii::$app->user->isGuest) {
                $user = \Yii::$app->user->identity;
                $user->language = \Yii::$app->language;
                $user->save();
            }
        }
    ]
],

IMPORTANT

To use the widget, the value of the enablePrettyUrl property in the urlManager configuration must be true, and the value of showScriptName false.

example:

'components' => [
    // ...
    'urlManager' => [
        'enablePrettyUrl' => true,
        'showScriptName' => false,
        'rules' => [
            // your rules go here
        ],
        // ...
    ],
    // ...
]

Using of urlManager.

Usage

Displaying language selector

Displaying pre-defined languate picker buttons (icons and text or icons only):

<?= \user1007017\languagepicker\widgets\LanguagePicker::widget([
    'skin' => \user1007017\languagepicker\widgets\LanguagePicker::SKIN_BUTTON,
    'size' => \user1007017\languagepicker\widgets\LanguagePicker::SIZE_SMALL
]); ?>

Displaying pre-defined languate picker dropdown list (icons and text or icons only):

<?= \user1007017\languagepicker\widgets\LanguagePicker::widget([
    'skin' => \user1007017\languagepicker\widgets\LanguagePicker::SKIN_DROPDOWN,
    'size' => \user1007017\languagepicker\widgets\LanguagePicker::SIZE_LARGE
]); ?>

Customising the language picker:

<?= \user1007017\languagepicker\widgets\LanguagePicker::widget([
    'itemTemplate' => '<li><a href="{link}" title="{language}"><i id="{language}"></i> {name}</a></li>',
    'activeItemTemplate' => '<a href="{link}" title="{language}"><i id="{language}"></i> {name}</a>',
    'parentTemplate' => '<div class="language-picker dropdown-list {size}"><div>{activeItem}<ul>{items}</ul></div></div>',
    'languageAsset' => 'user1007017\languagepicker\bundles\LanguageLargeIconsAsset',      // StyleSheets
    'languagePluginAsset' => 'user1007017\languagepicker\bundles\LanguagePluginAsset',    // JavaScripts
]); ?>

Other Example hiding active Language

NavBar::begin([
    'brandLabel' => Html::img('@web/css/images/logo.png', ['class' => 'img-responsive','alt' => Yii::$app->name]),
    'brandUrl' => Yii::$app->homeUrl,
    'options' => [
        'class' => 'navbar navbar-default navbar-fixed-top',
    ],
]);

$aNavOptionsTop = [
    'options' => ['class' => 'navbar-nav navbar-left'],
//        'options' => ['class' => 'nav nav-justified '],
    'items' => $items
];
echo Nav::widget($aNavOptionsTop);

//---------------------------LANGUAGE PICKER ---------------------------------------------
echo  \user1007017\languagepicker\widgets\LanguagePicker::widget([
    'skin' => \user1007017\languagepicker\widgets\LanguagePicker::SKIN_BUTTON,
    'size' => \user1007017\languagepicker\widgets\LanguagePicker::SIZE_SMALL,
    'itemTemplate' => '<a href="{link}" title="{language}"> {name}</a>',
    //hide active language (display:none):
    'activeItemTemplate' => '<a style="display:none" href="{link}" title="{language}" class="active"></a>',
    // parentTemplate without {size} !!!:
    'parentTemplate' => '<ul style="list-style: none;" class="navbar-nav navbar-right nav"><li>{items}</li></ul>',

]);
//-------------------------------------------------------------------------------
NavBar::end();