Merge pull request #2822 from lucianobaraglia/gii-translatable-strings

extensions/gii/Generator.php

@@ -47,6 +47,15 @@ abstract class Generator extends Model
      * The value of this property is internally managed by this class.
      */
     public $template;
+    /**
+     * @var boolean whether the strings will be generated using `Yii::t()` or normal strings.
+     */
+    public $enableI18N = false;
+    /**
+     * @var string the message category used by `Yii::t()` when `$enableI18N` is `true`.
+     * Defaults to `app`.
+     */
+    public $messageCategory = 'app';
 
     /**
      * @return string name of the code generator
@@ -76,6 +85,17 @@ abstract class Generator extends Model
     }
 
     /**
+     * @inheritdoc
+     */
+    public function attributeLabels()
+    {
+        return [
+            'enableI18N' => 'Enable I18N',
+            'messageCategory' => 'Message Category',
+        ];
+    }
+
+    /**
      * Returns a list of code template files that are required.
      * Derived classes usually should override this method if they require the existence of
      * certain template files.
@@ -95,7 +115,7 @@ abstract class Generator extends Model
      */
     public function stickyAttributes()
     {
-        return ['template'];
+        return ['template', 'enableI18N', 'messageCategory'];
     }
 
     /**
@@ -106,7 +126,11 @@ abstract class Generator extends Model
      */
     public function hints()
     {
-        return [];
+        return [
+            'enableI18N' => 'This indicates whether the generator should generate strings using <code>Yii::t()</code> method.
+                Set this to <code>true</code> if you are planning to make your application translatable.',
+            'messageCategory' => 'This is the category used by <code>Yii::t()</code> in case you enable I18N.',
+        ];
     }
 
     /**
@@ -359,6 +383,16 @@ abstract class Generator extends Model
     }
 
     /**
+     * Checks if message category is not empty when I18N is enabled.
+     */
+    public function validateMessageCategory()
+    {
+        if ($this->enableI18N && empty($this->messageCategory)) {
+            $this->addError('messageCategory', "Message Category cannot be blank.");
+        }
+    }
+
+    /**
      * @param  string  $value the attribute to be validated
      * @return boolean whether the value is a reserved PHP keyword.
      */
@@ -448,4 +482,38 @@ abstract class Generator extends Model
 
         return in_array(strtolower($value), $keywords, true);
     }
+
+    /**
+     * Generates a string depending on enableI18N property
+     * @param string $string       the text be generated
+     * @param array  $placeholders the placeholders to use by `Yii::t()`
+     */
+    public function generateString($string = '', $placeholders = [])
+    {
+        $string = addslashes($string);
+        if ($this->enableI18N) {
+            // If there are placeholders, use them
+            if (!empty($placeholders)) {
+                $search = ['array (', ')'];
+                $replace = ['[', ']'];
+                $ph = ', ' . str_replace($search, $replace, var_export($placeholders, true));
+            } else {
+                $ph = '';
+            }
+            $str = "Yii::t('" . $this->messageCategory . "', '" . $string . "'" . $ph . ")";
+        } else {
+            // No I18N, replace placeholders by real words, if any
+            if (!empty($placeholders)) {
+                $phKeys = array_map(function($word) {
+                    return '{' . $word . '}';
+                }, array_keys($placeholders));
+                $phValues = array_values($placeholders);
+                $str = "'" . str_replace($phKeys, $phValues, $string) . "'";
+            } else {
+                // No placeholders, just the given string
+                $str = "'" . $string . "'";
+            }
+        }
+        return $str;
+    }
 }

extensions/gii/assets/gii.js

@@ -111,10 +111,15 @@ yii.gii = (function ($) {
             initConfirmationCheckboxes();
 
             // model generator: hide class name input when table name input contains *
-            $('#model-generator #generator-tablename').on('change',function () {
+            $('#model-generator #generator-tablename').change(function () {
                 $('#model-generator .field-generator-modelclass').toggle($(this).val().indexOf('*') == -1);
             }).change();
 
+            // CRUD generator: hide messageCategory when I18N is disabled
+            $('#crud-generator #generator-enablei18n').change(function () {
+                $('#crud-generator .field-generator-messagecategory').toggle($(this).is(':checked'));
+            }).change();
+
             // hide Generate button if any input is changed
             $('.default-view .form-group input,select,textarea').change(function () {
                 $('.default-view-results,.default-view-files').hide();

extensions/gii/generators/crud/Generator.php

@@ -71,6 +71,8 @@ class Generator extends \yii\gii\Generator
             [['indexWidgetType'], 'in', 'range' => ['grid', 'list']],
             [['modelClass'], 'validateModelClass'],
             [['moduleID'], 'validateModuleID'],
+            [['enableI18N'], 'boolean'],
+            [['messageCategory'], 'validateMessageCategory', 'skipOnEmpty' => false],
         ]);
     }
 
@@ -94,7 +96,7 @@ class Generator extends \yii\gii\Generator
      */
     public function hints()
     {
-        return [
+        return array_merge(parent::hints(), [
             'modelClass' => 'This is the ActiveRecord class associated with the table that CRUD will be built upon.
                 You should provide a fully qualified class name, e.g., <code>app\models\Post</code>.',
             'controllerClass' => 'This is the name of the controller class to be generated. You should
@@ -107,7 +109,7 @@ class Generator extends \yii\gii\Generator
                 You may choose either <code>GridView</code> or <code>ListView</code>',
             'searchModelClass' => 'This is the name of the search model class to be generated. You should provide a fully
                 qualified namespaced class name, e.g., <code>app\models\search\PostSearch</code>.',
-        ];
+        ]);
     }
 
     /**
@@ -123,7 +125,7 @@ class Generator extends \yii\gii\Generator
      */
     public function stickyAttributes()
     {
-        return ['baseControllerClass', 'moduleID', 'indexWidgetType'];
+        return array_merge(parent::stickyAttributes(), ['baseControllerClass', 'moduleID', 'indexWidgetType']);
     }
 
     /**

extensions/gii/generators/crud/default/search.php

@@ -3,7 +3,7 @@
 use yii\helpers\StringHelper;
 
 /**
- * This is the template for generating a CRUD controller class file.
+ * This is the template for generating CRUD search class of the specified model.
  *
  * @var yii\web\View $this
  * @var yii\gii\generators\crud\Generator $generator
@@ -49,7 +49,7 @@ class <?= $searchModelClass ?> extends Model
     {
         return [
 <?php foreach ($labels as $name => $label): ?>
-            <?= "'$name' => '" . addslashes($label) . "',\n" ?>
+            <?= "'$name' => " . $generator->generateString($label) . ",\n" ?>
 <?php endforeach; ?>
         ];
     }

extensions/gii/generators/crud/default/views/_form.php

@@ -36,7 +36,7 @@ use yii\widgets\ActiveForm;
     echo "    <?= " . $generator->generateActiveField($attribute) . " ?>\n\n";
 } ?>
     <div class="form-group">
-        <?= "<?= " ?>Html::submitButton($model->isNewRecord ? 'Create' : 'Update', ['class' => $model->isNewRecord ? 'btn btn-success' : 'btn btn-primary']) ?>
+        <?= "<?= " ?>Html::submitButton($model->isNewRecord ? <?= $generator->generateString('Create') ?> : <?= $generator->generateString('Update') ?>, ['class' => $model->isNewRecord ? 'btn btn-success' : 'btn btn-primary']) ?>
     </div>
 
     <?= "<?php " ?>ActiveForm::end(); ?>

extensions/gii/generators/crud/default/views/_search.php

@@ -39,8 +39,8 @@ foreach ($generator->getColumnNames() as $attribute) {
 }
 ?>
     <div class="form-group">
-        <?= "<?= " ?>Html::submitButton('Search', ['class' => 'btn btn-primary']) ?>
-        <?= "<?= " ?>Html::resetButton('Reset', ['class' => 'btn btn-default']) ?>
+        <?= "<?= " ?>Html::submitButton(<?= $generator->generateString('Search') ?>, ['class' => 'btn btn-primary']) ?>
+        <?= "<?= " ?>Html::resetButton(<?= $generator->generateString('Reset') ?>, ['class' => 'btn btn-default']) ?>
     </div>
 
     <?= "<?php " ?>ActiveForm::end(); ?>

extensions/gii/generators/crud/default/views/create.php

@@ -18,8 +18,8 @@ use yii\helpers\Html;
  * @var <?= ltrim($generator->modelClass, '\\') ?> $model
  */
 
-$this->title = 'Create <?= Inflector::camel2words(StringHelper::basename($generator->modelClass)) ?>';
-$this->params['breadcrumbs'][] = ['label' => '<?= Inflector::pluralize(Inflector::camel2words(StringHelper::basename($generator->modelClass))) ?>', 'url' => ['index']];
+$this->title = <?= $generator->generateString('Create {modelClass}', ['modelClass' => Inflector::camel2words(StringHelper::basename($generator->modelClass))]) ?>;
+$this->params['breadcrumbs'][] = ['label' => <?= $generator->generateString(Inflector::pluralize(Inflector::camel2words(StringHelper::basename($generator->modelClass)))) ?>, 'url' => ['index']];
 $this->params['breadcrumbs'][] = $this->title;
 ?>
 <div class="<?= Inflector::camel2id(StringHelper::basename($generator->modelClass)) ?>-create">

extensions/gii/generators/crud/default/views/index.php

@@ -23,7 +23,7 @@ use <?= $generator->indexWidgetType === 'grid' ? "yii\\grid\\GridView" : "yii\\w
  * @var <?= ltrim($generator->searchModelClass, '\\') ?> $searchModel
  */
 
-$this->title = '<?= Inflector::pluralize(Inflector::camel2words(StringHelper::basename($generator->modelClass))) ?>';
+$this->title = <?= $generator->generateString(Inflector::pluralize(Inflector::camel2words(StringHelper::basename($generator->modelClass)))) ?>;
 $this->params['breadcrumbs'][] = $this->title;
 ?>
 <div class="<?= Inflector::camel2id(StringHelper::basename($generator->modelClass)) ?>-index">
@@ -33,7 +33,7 @@ $this->params['breadcrumbs'][] = $this->title;
     <?= "<?php " . ($generator->indexWidgetType === 'grid' ? "// " : "") ?>echo $this->render('_search', ['model' => $searchModel]); ?>
 
     <p>
-        <?= "<?= " ?>Html::a('Create <?= Inflector::camel2words(StringHelper::basename($generator->modelClass)) ?>', ['create'], ['class' => 'btn btn-success']) ?>
+        <?= "<?= " ?>Html::a(<?= $generator->generateString('Create {modelClass}', ['modelClass' => Inflector::camel2words(StringHelper::basename($generator->modelClass))]) ?>, ['create'], ['class' => 'btn btn-success']) ?>
     </p>
 
 <?php if ($generator->indexWidgetType === 'grid'): ?>

extensions/gii/generators/crud/default/views/update.php

@@ -20,10 +20,10 @@ use yii\helpers\Html;
  * @var <?= ltrim($generator->modelClass, '\\') ?> $model
  */
 
-$this->title = 'Update <?= Inflector::camel2words(StringHelper::basename($generator->modelClass)) ?>: ' . $model-><?= $generator->getNameAttribute() ?>;
-$this->params['breadcrumbs'][] = ['label' => '<?= Inflector::pluralize(Inflector::camel2words(StringHelper::basename($generator->modelClass))) ?>', 'url' => ['index']];
+$this->title = <?= $generator->generateString('Update {modelClass}: ', ['modelClass' => Inflector::camel2words(StringHelper::basename($generator->modelClass))]) ?> . $model-><?= $generator->getNameAttribute() ?>;
+$this->params['breadcrumbs'][] = ['label' => <?= $generator->generateString(Inflector::pluralize(Inflector::camel2words(StringHelper::basename($generator->modelClass)))) ?>, 'url' => ['index']];
 $this->params['breadcrumbs'][] = ['label' => $model-><?= $generator->getNameAttribute() ?>, 'url' => ['view', <?= $urlParams ?>]];
-$this->params['breadcrumbs'][] = 'Update';
+$this->params['breadcrumbs'][] = <?= $generator->generateString('Update') ?>;
 ?>
 <div class="<?= Inflector::camel2id(StringHelper::basename($generator->modelClass)) ?>-update">
 

extensions/gii/generators/crud/default/views/view.php

@@ -22,7 +22,7 @@ use yii\widgets\DetailView;
  */
 
 $this->title = $model-><?= $generator->getNameAttribute() ?>;
-$this->params['breadcrumbs'][] = ['label' => '<?= Inflector::pluralize(Inflector::camel2words(StringHelper::basename($generator->modelClass))) ?>', 'url' => ['index']];
+$this->params['breadcrumbs'][] = ['label' => <?= $generator->generateString(Inflector::pluralize(Inflector::camel2words(StringHelper::basename($generator->modelClass)))) ?>, 'url' => ['index']];
 $this->params['breadcrumbs'][] = $this->title;
 ?>
 <div class="<?= Inflector::camel2id(StringHelper::basename($generator->modelClass)) ?>-view">
@@ -30,11 +30,11 @@ $this->params['breadcrumbs'][] = $this->title;
     <h1><?= "<?= " ?>Html::encode($this->title) ?></h1>
 
     <p>
-        <?= "<?= " ?>Html::a('Update', ['update', <?= $urlParams ?>], ['class' => 'btn btn-primary']) ?>
-        <?= "<?= " ?>Html::a('Delete', ['delete', <?= $urlParams ?>], [
+        <?= "<?= " ?>Html::a(<?= $generator->generateString('Update') ?>, ['update', <?= $urlParams ?>], ['class' => 'btn btn-primary']) ?>
+        <?= "<?= " ?>Html::a(<?= $generator->generateString('Delete') ?>, ['delete', <?= $urlParams ?>], [
             'class' => 'btn btn-danger',
             'data' => [
-                'confirm' => Yii::t('app', 'Are you sure you want to delete this item?'),
+                'confirm' => <?= $generator->generateString('Are you sure you want to delete this item?') ?>,
                 'method' => 'post',
             ],
         ]) ?>

extensions/gii/generators/crud/form.php

@@ -14,3 +14,5 @@ echo $form->field($generator, 'indexWidgetType')->dropDownList([
     'grid' => 'GridView',
     'list' => 'ListView',
 ]);
+echo $form->field($generator, 'enableI18N')->checkbox();
+echo $form->field($generator, 'messageCategory');