MODELS.md

Creating models and controllers

Create two models:

1. The basic model
2. Translations

Let us consider a step-by-step creation of the module on the example of a simple pages.

Table page:

Field	Type	Description
id	integer	PrimaryKey
...	...	Other fields for which translation is not needed (date, status, etc)

Table page_content:

Field	Type	Description
id	integer	PrimaryKey
parent_id	integer	ForeignKey -> page.id
lang_id	smallint	Language ID
name	varchar(255)	Page name
text	text	Page text

1. Create model Page.php

---

class Page extends \yii\db\ActiveRecord {
    
    public static function tableName() {
        return 'page';
    }

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getContent() {
        return $this->hasOne(PageContent::className(), ['parent_id' => 'id']);
    }
    
    /**
     * Returns list af all language versions
     * @return \yii\db\ActiveQuery
     */
    public function getContentAll() {
        return $this->hasMany(PageContent::className(), ['parent_id' => 'id']);
    }
}

2. Create model PageContent.php

---

class PageContent extends \yii\db\ActiveRecord {

    public static function tableName() {
        return 'page_content';
    }

    /**
     * @return \yii\db\ActiveQuery
     */
    public function getPage() {
        return $this->hasOne(Page::className(), ['id' => 'parent_id']);
    }
}

3. Create PageController.php (backend)

---

class PageController extends Controller {

    public function actions() {
        return [
            'index' => 'pjhl\multilanguage\actions\ActionIndex',
            'create' => 'pjhl\multilanguage\actions\ActionCreate',
            'view' => 'pjhl\multilanguage\actions\ActionView',
            'update' => 'pjhl\multilanguage\actions\ActionUpdate',
            'delete' => 'pjhl\multilanguage\actions\ActionDelete',
            'deleteContent' => 'pjhl\multilanguage\actions\ActionDeleteContent',
        ];
    }

    /**
     * Get multilanguage configuration
     * @param string $key   Optional key
     * @return string|array
     */
    public static function mlConf($key = null) {
        $data = [
            // Main model class
            'model' => 'common\models\Page',
            // Content model classs
            'contentModel' => 'common\models\PageContent',
            // Search model
            'searchModel' => 'backend\models\PageSearch',
        ];
        return ($key!==null)
                ? $data[$key]
                : $data;
    }
    
    /**
     * Finds the Page model based on its primary key value [and langId]
     * If the model is not found, a 404 HTTP exception will be thrown.
     * @param integer $id
     * @param integer $langId
     * @return Page the loaded model
     * @throws NotFoundHttpException if the model cannot be found
     */
    public function findModel($id, $langId=null) {
        $query = Page::find($id)
                ->where(['id'=>$id]);
        if ($langId!==null) {
            $query->with([
                'content' => function (\yii\db\ActiveQuery $query) use ($langId) {
                    $query->andWhere(['lang_id' => $langId]);
                }
            ]);
        } else {
            $query->with('content');
        }
        $model = $query->one();
        if ($model !== null) {
            return $model;
        } else {
            throw new NotFoundHttpException('The requested row does not exist.');
        }
    }
}

4. Create views/page/* (backend)

---

_form.php:

<?php

use yii\helpers\Html;
use yii\helpers\ArrayHelper;
use yii\widgets\ActiveForm;
use pjhl\multilanguage\LangHelper;
/* @var $this yii\web\View */
/* @var $model backend\models\Page */
/* @var $form yii\widgets\ActiveForm */
?>

<div class="page-form">

    <?php $form = ActiveForm::begin(); ?>
    
    <div class="hidden">
        <?= $form->field($model->content, 'id')->hiddenInput() ?>
    </div>
    
    <div class="row">
        <div class="col-md-8">
            <?= $form->field($model, 'date')->textInput() ?>
        </div>
        <div class="col-md-offset-8 col-md-4">
            <?= $form->field($model->content, 'lang_id')
                    ->dropDownList(ArrayHelper::map(LangHelper::languages(), 'id', 'name')
                            , array('disabled'=>!$model->isNewRecord)) ?>
        </div>
    </div>
    
    <hr>

    <?= $form->field($model->content, 'name')->textInput() ?>

    <?= $form->field($model->content, 'text')->textarea(array('rows'=>15)) ?>

    <div class="form-group">
        <?= Html::submitButton($model->isNewRecord 
                ? Yii::t('page', 'Create') 
                : Yii::t('page', 'Update'), ['class' => $model->isNewRecord 
                        ? 'btn btn-success' 
                        : 'btn btn-primary']) ?>
    </div>
    <?php ActiveForm::end(); ?>

</div>

Changes to other views apply only to use $model->content->... instead of $model->... for translates.

P.S.

Implementation backend via views can be done in different ways. My realization can be found in the module pjhl/yii2-pages (TODO: create static pages module). There is a working demo.