yidas/yii2-language

Language extension component for Yii 2 framework

, _(*1)

Yii 2 Language Extension

Yii 2 Framework Language extension with Status Keep and Mapping, _(*2)

, _(*3)

FEATURES

• language Mapping integrated with Yii2 Language, _(*4)

• Session & Cookie storage support, _(*5)

• Yii2 i18n support, _(*6)

OUTLINE

• Requirements
• Installation
• Configuration
• Usage
  • get()
  • set()
  • getbymap()
  • setbymap()
  • isFirstCome()
• Implementation
  • Controller for Changing Language
  • BeforeAction for globally changing language

REQUIREMENTS

This library requires the following:, _(*7)

• PHP 5.4.0+
• Yii 2.0.0+

INSTALLATION

Install via Composer in your Yii2 project:, _(*8)

composer require yidas/yii2-language

CONFIGURATION

Add a component using yidas\components\Language with configurations:, _(*9)

return [
    'bootstrap' => ['log', 'lang'],
    'language' => 'en-US',
    'components' => [
        'lang' => [
            'class' => 'yidas\components\Language',
            'languages' => [
                0 => 'en-US',
                1 => 'zh-TW',
                2 => 'zh-CN',
            ],
            'maps' => [
                'html' => [
                    0 => 'en',
                    1 => 'zh-Hant',
                    2 => 'zh-Hans',
                ],
            ],
            // 'storage' => 'session',
            // 'storageKey' => 'language',
        ],
        ...

Bootstrap

You could add the language component into bootstrap for keeping the language storage work such as Seesion and Cookie., _(*10)

// `lang` component for example
return [
    'bootstrap' => ['lang'], 
    ...

USAGE

get()

Get Current Language, _(*11)

public string get($map=null)

Example:, _(*12)

echo \Yii::$app->lang->get();  // en-US

You could get from map by giving map key as first argument:, _(*13)

echo \Yii::$app->lang->get('html');  // en

set()

Set Current Language synchronised to \Yii::$app->language, _(*14)

public boolean set($language)

Example:, _(*15)

\Yii::$app->lang->set('zh-TW');

getByMap()

Get customized language value from $map, _(*16)

public string getByMap($mapKey)

Example:, _(*17)

If you have to echo HTML language value by current language:, _(*18)

echo \Yii::$app->lang->getByMap('html');  // en

setByMap()

Set by using customized language value from $map, _(*19)

public boolean setByMap($mapKey, $mapValue)

Example:, _(*20)

If you have to set current language by inputting a HTML language value:, _(*21)

$this->setByMap('html', 'zh-Hant');

isFirstCome()

First time coming check, which has no StorageRecord, _(*22)

Inverse alias with hasStorageRecord(), _(*23)

public boolean isFirstCome()

Example:, _(*24)

if (Yii::$app->lang->isFirstCome()) {
    // Detetmine user ip to set current language
} 
else if (Yii::$app->lang->hasStorageRecord()) {
    // Means !(Yii::$app->lang->isFirstCome())
}

IMPLEMENTATION

Controller for Changing Language

You could add a controller or action for changing language like /language?language=zh-TW:, _(*25)

<?php

namespace app\controllers;

use Yii;
use yii\web\Controller;

/**
 * The Controller for Language converting
 */
class LanguageController extends Controller
{
    public function actionIndex($language='')
    {
        $result = Yii::$app->lang->set($language);

        return $this->redirect(Yii::$app->request->referrer ?: Yii::$app->homeUrl);
    }
}

BeforeAction for globally changing language

You could globally set language by handling language setting in the bootstrap of application., _(*26)

For example, get GET parameter to set language in on beforeAction function:, _(*27)

return [
    'on beforeAction' => function ($event) {
        // Always fetch language from get-parameter
        $lang = \Yii::$app->request->get('lang');
        // Set to given language with get-parameter
        if ($lang) {
            $result = \Yii::$app->lang->set($lang);
        }
    },
    ...
]

After that, by giving lang param from any url like /post/my-article?lang=zh-TW would change language., _(*28)