lav45 / yii2-translated-behavior
This extension allows you to quickly and simple enough to add translations for any ActiveRecord models.
Installs: 40 573
Dependents: 1
Suggesters: 0
Security: 0
Stars: 37
Watchers: 9
Forks: 7
Type:yii2-extension
Requires
- yiisoft/yii2: dev-master as 2.0.x-dev
Requires (Dev)
- phpunit/dbunit: *
- phpunit/phpunit: 4.* | 5.*
README
The Translated Behavior is a Yii2 extension for ActiveRecord models, that will help you add the possibility of transferring any entity.
You can see DEMO
Installation
The preferred way to install this extension through composer.
You can set the console
$ composer require "lav45/yii2-translated-behavior:1.4.*"
or add
"lav45/yii2-translated-behavior": "1.4.*"
in require
section in composer.json
file.
Settings
First you have to move all the attributes that are required for translation in a separate table. For example, imagine that we want to save the translation of the title and description of your post being. Your table schema should be brought to the following form:
+--------------+ +--------------+ +-------------------+
| post | | post | | post_lang |
+--------------+ +--------------+ +-------------------+
| id | | id | | post_id |
| title | ---> | created_at | + | lang_id |
| description | | updated_at | | title |
| updated_at | +--------------+ | description |
| created_at | +-------------------+
+--------------+
After you change the table schema, we now need to determine the ratio of our ActiveRecord
objects and adding behavior:
Post
use yii\db\ActiveRecord; use lav45\translate\TranslatedTrait; use lav45\translate\TranslatedBehavior; /** * ... * @property string $title * @property string $description */ class Post extends ActiveRecord { use TranslatedTrait; public function rules() { return [ // ... [['title'], 'required'], [['title'], 'string', 'max' => 128], [['description'], 'required'], [['description'], 'string'], ]; } public function behaviors() { return [ [ 'class' => TranslatedBehavior::className(), 'translateRelation' => 'postLangs', // Specify the name of the connection that will store transfers // 'languageAttribute' => 'lang_id' // post_lang field from the table that will store the target language 'translateAttributes' => [ 'title', 'description', ] ] ]; } public function attributeLabels() { return [ // ... 'title' => 'Title', 'description' => 'Description', ]; } public function getPostLangs() { return $this->hasMany(PostLang::className(), ['post_id' => 'id']); } }
Language model
migrate
migrate/m151220_112320_lang.php
Apply with the console command:
~$ yii migrate/up --migrationPath=vendor/lav45/yii2-translated-behavior/migrate
Lang ActiveRecord model cite completely
Using
Backend
backend/config/bootstrap.php
Yii::$container->set('lav45\translate\TranslatedBehavior', [ 'language' => isset($_GET['lang_id']) ? $_GET['lang_id'] : null ]);
backend/controllers/PostController.php
namespace backend\controllers; use yii\web\Controller; use yii\data\ActiveDataProvider; use common\models\Post; use common\models\Lang; class PostController extends Controller { public function actionIndex() { $dataProvider = new ActiveDataProvider([ 'query' => Post::find() ->with([ 'currentTranslate', // loadabing data associated with the current translation 'hasTranslate' // need to display the status was translated page ]), ]); return $this->render('index', [ 'dataProvider' => $dataProvider, 'langList' => Lang::getList(), ]); } // ... }
backend/view/post/index.php
<?= GridView::widget([ 'dataProvider' => $dataProvider, 'columns' => [ [ 'class' => 'lav45\translate\grid\ActionColumn', 'languages' => $langList, ], [ 'class' => 'yii\grid\ActionColumn', 'template' => '{delete}' ], ], ]); ?>
As a result, after the creation of a new page will get a few buttons to edit the content in different languages
So you can get the current language of the model
/** * @var $this yii\web\View * @var $model common\models\Page */ $this->title = 'Create Post ( ' . $model->language . ' )';
Frontend
frontend/config/main.php
use lav45\translate\models\Lang; return [ 'components' => [ 'urlManager' => [ 'class' => 'lav45\translate\web\UrlManager', 'enablePrettyUrl' => true, 'showScriptName' => false, 'rules' => [ [ 'class' => 'yii\web\UrlRule', // If there is no need to substitute the language, you can use the base class 'pattern' => '', 'route' => 'post/index', ], [ 'pattern' => '<_lang:' . Lang::PATTERN . '>/<id:\d+>', 'route' => 'post/view', ], [ 'pattern' => '<_lang:' . Lang::PATTERN . '>', 'route' => 'post/index', ] ], ], ], ];
frontend/controllers/PostController.php
namespace frontend\controllers; use yii\web\Controller; use common\models\Post; use lav45\translate\models\Lang; class PostController extends Controller { public function behaviors() { return [ [ // ContentNegotiator will be determined from a URL or browser language settings and install it in // Yii::$app->language, which uses the class TranslatedBehavior as language translation 'class' => 'yii\filters\ContentNegotiator', 'languages' => Lang::getLocaleList() ], ]; }
or you can add for all controllers, for this you need to add in frontend/config/bootstrap.php
\yii\base\Event::on('yii\base\Controller', 'beforeAction', function($event) { /** @var yii\filters\ContentNegotiator $negotiator */ $negotiator = Yii::createObject([ 'class' => 'yii\filters\ContentNegotiator', 'languages' => \common\models\Lang::getLocaleList(), ]); /** @var yii\base\ActionEvent $event */ $negotiator->attach($event->action); $negotiator->negotiate(); });
License
yii2-translated-behavior it is available under a BSD 3-Clause License. Detailed information can be found in the LICENSE.md
.