Yii2 - Translate Manager
Online Translations
Introduction
This module provides a simple translating interface for the multilingual elements of your project. It can auto-detect new language elements (project scan). Duplications are filtered out automatically during the project scanning. Unused language elements can be removed from the database with a single click (database optimisation). It is possible to translate client side messages too (those stored in JavaScript files) as the project scan collects language elements to be translated from JavaScript files as well.
On the server side it can handle database or one-dimensional array elements and Yii::t functions. You can exclude files, folders or categories to prevent them from being translated.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist lajax/yii2-translate-manager "1.*"
or add
"lajax/yii2-translate-manager": "1.*"
to the require section of your composer.json file.
Usage
Config
A simple exmple of turning on Yii database multilingual.
'language' => 'en-US',
'components' => [
'i18n' => [
'translations' => [
'*' => [
'class' => 'yii\i18n\DbMessageSource',
'db' => 'db',
'sourceLanguage' => 'xx-XX', // Developer language
'sourceMessageTable' => 'language_source',
'messageTable' => 'language_translate',
'cachingDuration' => 86400,
'enableCaching' => true,
],
],
],
],
Turning on the TranslateManager Module:
Simple example:
'modules' => [
'translatemanager' => [
'class' => 'lajax\translatemanager\Module',
],
],
A more complex example including database table with multilingual support is below:
'modules' => [
'translatemanager' => [
'class' => 'lajax\translatemanager\Module',
'root' => '@app', // The root directory of the project scan.
'layout' => 'language', // Name of the used layout. If using own layout use ‘null’.
'allowedIPs' => ['127.0.0.1'] // IP addresses from which the translation interface is accessible.
'roles' => ['@'] // For setting access levels to the translating interface.
'tmpDir' => '@runtime', // Writable directory for the client-side temporary language files.
// IMPORTANT: must be identical for all applications (the AssetsManager serves the JavaScript files containing language elements from this directory).
'ignoredCategories' => ['yii'], // these categories won’t be included in the language database.
'ignoredItems' => ['config'], // these files will not be processed.
'tables' => [ // Properties of individual tables
[
'connection' => 'db', // connection identifier
'table' => 'language', // table name
'fields' => ['name', 'name_ascii'] //names of multilingual fields
]
]
],
],
Migration
Run the following command in Terminal for database migration:
Linux/Unix:
yii migrate/up --migrationPath=@vendor/lajax/yii2-translate-manager/migrations
Windows:
yii.bat migrate/up --migrationPath=@vendor/lajax/yii2-translate-manager/migrations
To translate static messages in JavaScript files it is necessary to register the files.
To register your scripts, call the following method in each action:
\lajax\translatemanager\helpers\Language::registerAssets();
A simple example for calling the above method at each page load:
namespace common\controllers;
use lajax\translatemanager\helpers\Language;
// IMPORTANT: all Controllers must originate from this Controller!
class Controller extends \yii\web\Controller {
public function init() {
Language::registerAssets();
parent::init();
}
}
Placing multilingual elements in the source code.
JavaScript:
lajax.t('Apple');
lajax.t('Hello {name}!', {name:'World'});
lajax.t("Don't be so upset.");
PHP methods:
Yii::t('category', 'Apple');
Yii::t('category', 'Hello {name}!', ['name' => 'World']);
Yii::t('category', "Don't be so upset.");
PHP arrays:
/**
* @translate
*/
private $_STATUSES = [
self::STATUS_INACTIVE => 'Inactive',
self::STATUS_ACTIVE => 'Active',
self::STATUS_DELETED => 'Deleted'
];
/**
* Returning the ‘status’ array on the site’s own language.
* return array
*/
public function getStatuses() {
return \lajax\translatemanager\helpers\Language::a($this->_STATUSES);
}
/**
* @translate
*/
private $_GENDERS = ['Male', 'Female'];
/**
* Returning the ‘genders’ array in German
* return array
*/
public function getGenders() {
return \lajax\translatemanager\helpers\Language::a($this->_GENDERS, [], 'de-DE');
}
URLs for the translating tool:
/translatemanager/language/list // List of languages and modifying their status
/translatemanager/language/scann // Scan the project for new multilingual elements
/translatemanager/language/optimizer // Optimise the database
Example implementation of the Yii2 menu into your own menu.
$menuItems[] = [
'label' => Yii::t('language', 'Language'), 'items' => [
['label' => Yii::t('language', 'Languages'), 'url' => ['/translatemanager/language/list']],
['label' => Yii::t('language', 'Scann'), 'url' => ['/translatemanager/language/scann']],
['label' => Yii::t('language', 'Optimize'), 'url' => ['/translatemanager/language/optimizer']],
]
];