Fixes #5070: Gii controller generator should use controller class name instead…

extensions/gii/CHANGELOG.md

@@ -4,6 +4,7 @@ Yii Framework 2 gii extension Change Log
 2.0.1 under development
 -----------------------
 
+- Bug #5070: Gii controller generator should use controller class name instead of controller ID to specify new controller (qiangxue)
 - Bug #5745: Gii and debug modules may cause 404 exception when the route contains dashes (qiangxue)
 - Bug: Gii console command help information does not contain global options (qiangxue)
 - Enh #5613: Added `--overwrite` option to Gii console command to support overwriting all files (motin, qiangxue)

extensions/gii/assets/gii.js

@@ -146,13 +146,24 @@ yii.gii = (function ($) {
             initConfirmationCheckboxes();
             initToggleActions();
 
+            // hide message category when I18N is disabled
+            $('form #generator-enablei18n').change(function () {
+                $('form .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();
+                $('.default-view button[name="generate"]').hide();
+            });
+
             // model generator: hide class name input when table name input contains *
             $('#model-generator #generator-tablename').change(function () {
-                $('#model-generator .field-generator-modelclass').toggle($(this).val().indexOf('*') == -1);
+                $('.field-generator-modelclass').toggle($(this).val().indexOf('*') == -1);
             }).change();
 
             // model generator: translate table name to model class
-            $('#generator-tablename').on('blur', function () {
+            $('#model-generator #generator-tablename').on('blur', function () {
                 var tableName = $(this).val();
                 if ($('#generator-modelclass').val()=='' && tableName && tableName.indexOf('*') === -1){
                     var modelClass='';
@@ -164,17 +175,6 @@ yii.gii = (function ($) {
                 }
             });
 
-            // hide message category when I18N is disabled
-            $('form #generator-enablei18n').change(function () {
-                $('form .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();
-                $('.default-view button[name="generate"]').hide();
-            });
-
             $('.module-form #generator-moduleclass').change(function () {
                 var value = $(this).val().match(/(\w+)\\\w+$/);
                 var $idInput = $('#generator-moduleid');

extensions/gii/generators/controller/Generator.php

@@ -11,13 +11,12 @@ use Yii;
 use yii\gii\CodeFile;
 use yii\helpers\Html;
 use yii\helpers\Inflector;
+use yii\helpers\StringHelper;
 
 /**
  * This generator will generate a controller and one or a few action view files.
  *
  * @property array $actionIDs An array of action IDs entered by the user. This property is read-only.
- * @property string $controllerClass The controller class name without the namespace part. This property is
- * read-only.
  * @property string $controllerFile The controller class file path. This property is read-only.
  * @property string $controllerID The controller ID (without the module ID prefix). This property is
  * read-only.
@@ -30,17 +29,17 @@ use yii\helpers\Inflector;
 class Generator extends \yii\gii\Generator
 {
     /**
-     * @var string the controller ID
+     * @var string the controller class name
      */
-    public $controller;
+    public $controllerClass;
     /**
-     * @var string the base class of the controller
+     * @var string the controller's view path
      */
-    public $baseClass = 'yii\web\Controller';
+    public $viewPath;
     /**
-     * @var string the namespace of the controller class
+     * @var string the base class of the controller
      */
-    public $ns;
+    public $baseClass = 'yii\web\Controller';
     /**
      * @var string list of action IDs separated by commas or spaces
      */
@@ -50,15 +49,6 @@ class Generator extends \yii\gii\Generator
     /**
      * @inheritdoc
      */
-    public function init()
-    {
-        parent::init();
-        $this->ns = \Yii::$app->controllerNamespace;
-    }
-
-    /**
-     * @inheritdoc
-     */
     public function getName()
     {
         return 'Controller Generator';
@@ -69,7 +59,7 @@ class Generator extends \yii\gii\Generator
      */
     public function getDescription()
     {
-        return 'This generator helps you to quickly generate a new controller class,
+        return 'This generator helps you to quickly generate a new controller class with
             one or several controller actions and their corresponding views.';
     }
 
@@ -79,12 +69,12 @@ class Generator extends \yii\gii\Generator
     public function rules()
     {
         return array_merge(parent::rules(), [
-            [['controller', 'actions', 'baseClass', 'ns'], 'filter', 'filter' => 'trim'],
-            [['controller', 'baseClass'], 'required'],
-            [['controller'], 'match', 'pattern' => '/^[a-z][a-z0-9\\-\\/]*$/', 'message' => 'Only a-z, 0-9, dashes (-) and slashes (/) are allowed.'],
-            [['actions'], 'match', 'pattern' => '/^[a-z][a-z0-9\\-,\\s]*$/', 'message' => 'Only a-z, 0-9, dashes (-), spaces and commas are allowed.'],
-            [['baseClass'], 'match', 'pattern' => '/^[\w\\\\]*$/', 'message' => 'Only word characters and backslashes are allowed.'],
-            [['ns'], 'match', 'pattern' => '/^[\w\\\\]*$/', 'message' => 'Only word characters and backslashes are allowed.'],
+            [['controllerClass', 'actions', 'baseClass'], 'filter', 'filter' => 'trim'],
+            [['controllerClass', 'baseClass'], 'required'],
+            ['controllerClass', 'match', 'pattern' => '/^[\w\\\\]*Controller$/', 'message' => 'Only word characters and backslashes are allowed, and the class name must end with "Controller".'],
+            ['controllerClass', 'validateNewClass'],
+            ['baseClass', 'match', 'pattern' => '/^[\w\\\\]*$/', 'message' => 'Only word characters and backslashes are allowed.'],
+            ['actions', 'match', 'pattern' => '/^[a-z][a-z0-9\\-,\\s]*$/', 'message' => 'Only a-z, 0-9, dashes (-), spaces and commas are allowed.'],
         ]);
     }
 
@@ -95,9 +85,9 @@ class Generator extends \yii\gii\Generator
     {
         return [
             'baseClass' => 'Base Class',
-            'controller' => 'Controller ID',
+            'controllerClass' => 'Controller Class',
+            'viewPath' => 'View Path',
             'actions' => 'Action IDs',
-            'ns' => 'Controller Namespace',
         ];
     }
 
@@ -117,7 +107,7 @@ class Generator extends \yii\gii\Generator
      */
     public function stickyAttributes()
     {
-        return ['ns', 'baseClass'];
+        return ['baseClass'];
     }
 
     /**
@@ -126,19 +116,19 @@ class Generator extends \yii\gii\Generator
     public function hints()
     {
         return [
-            'controller' => 'Controller ID should be in lower case and may contain module ID(s) separated by slashes. For example:
-                <ul>
-                    <li><code>order</code> generates <code>OrderController.php</code></li>
-                    <li><code>order-item</code> generates <code>OrderItemController.php</code></li>
-                    <li><code>admin/user</code> generates <code>UserController.php</code> within the <code>admin</code> module.</li>
-                </ul>',
+            'controllerClass' => 'This is the name of the controller class to be generated. You should
+                provide a fully qualified namespaced class (e.g. <code>app\controllers\PostController</code>),
+                and class name should be in CamelCase ending with the word <code>Controller</code>. Make sure the class
+                is using the same namespace as specified by your application\'s controllerNamespace property.',
             'actions' => 'Provide one or multiple action IDs to generate empty action method(s) in the controller. Separate multiple action IDs with commas or spaces.
                 Action IDs should be in lower case. For example:
                 <ul>
                     <li><code>index</code> generates <code>actionIndex()</code></li>
                     <li><code>create-order</code> generates <code>actionCreateOrder()</code></li>
                 </ul>',
-            'ns' => 'This is the namespace that the new controller class will use.',
+            'viewPath' => 'Specify the directory for storing the view scripts for the controller. You may use path alias here, e.g.,
+                <code>/var/www/basic/controllers/views/order</code>, <code>@app/views/order</code>. If not set, it will default
+                to <code>@app/views/ControllerID</code>',
             'baseClass' => 'This is the class that the new controller class will extend from. Please make sure the class exists and can be autoloaded.',
         ];
     }
@@ -150,9 +140,9 @@ class Generator extends \yii\gii\Generator
     {
         $actions = $this->getActionIDs();
         if (in_array('index', $actions)) {
-            $route = $this->controller . '/index';
+            $route = $this->getControllerID() . '/index';
         } else {
-            $route = $this->controller . '/' . reset($actions);
+            $route = $this->getControllerID() . '/' . reset($actions);
         }
         $link = Html::a('try it now', Yii::$app->getUrlManager()->createUrl($route), ['target' => '_blank']);
 
@@ -194,58 +184,41 @@ class Generator extends \yii\gii\Generator
     }
 
     /**
-     * @return string the controller class name without the namespace part.
+     * @return string the controller class file path
      */
-    public function getControllerClass()
+    public function getControllerFile()
     {
-        return Inflector::id2camel($this->getControllerID()) . 'Controller';
+        return Yii::getAlias('@' . str_replace('\\', '/', $this->controllerClass)) . '.php';
     }
 
     /**
-     * @return string the controller ID (without the module ID prefix)
+     * @return string the controller ID
      */
     public function getControllerID()
     {
-        if (($pos = strrpos($this->controller, '/')) !== false) {
-            return substr($this->controller, $pos + 1);
-        } else {
-            return $this->controller;
-        }
+        $name = StringHelper::basename($this->controllerClass);
+        return Inflector::camel2id(substr($name, 0, strlen($name) - 10));
     }
 
     /**
-     * @return \yii\base\Module the module that the new controller belongs to
+     * @param string $action the action ID
+     * @return string the action view file path
      */
-    public function getModule()
+    public function getViewFile($action)
     {
-        if (($pos = strrpos($this->controller, '/')) !== false) {
-            $id = substr($this->controller, 0, $pos);
-            if (($module = Yii::$app->getModule($id)) !== null) {
-                return $module;
-            }
+        if (empty($this->viewPath)) {
+            return Yii::getAlias('@app/views/' . $this->getControllerID() . "/$action.php");
+        } else {
+            return Yii::getAlias($this->viewPath . "/$action.php");
         }
-
-        return Yii::$app;
     }
 
     /**
-     * @return string the controller class file path
+     * @return string the namespace of the controller class
      */
-    public function getControllerFile()
+    public function getControllerNamespace()
     {
-        $module = $this->getModule();
-
-        return $module->getControllerPath() . '/' . $this->getControllerClass() . '.php';
-    }
-
-    /**
-     * @param string $action the action ID
-     * @return string the action view file path
-     */
-    public function getViewFile($action)
-    {
-        $module = $this->getModule();
-
-        return $module->getViewPath() . '/' . $this->getControllerID() . '/' . $action . '.php';
+        $name = StringHelper::basename($this->controllerClass);
+        return ltrim(substr($this->controllerClass, 0, strlen($name) + 1), '\\');
     }
 }

extensions/gii/generators/controller/default/controller.php

@@ -4,6 +4,7 @@
  */
 
 use yii\helpers\Inflector;
+use yii\helpers\StringHelper;
 
 /* @var $this yii\web\View */
 /* @var $generator yii\gii\generators\controller\Generator */
@@ -11,11 +12,9 @@ use yii\helpers\Inflector;
 echo "<?php\n";
 ?>
 
-<?php if (!empty($generator->ns)): ?>
-namespace <?= $generator->ns ?>;
-<?php endif; ?>
+namespace <?= $generator->getControllerNamespace() ?>;
 
-class <?= $generator->getControllerClass() ?> extends <?= '\\' . trim($generator->baseClass, '\\') . "\n" ?>
+class <?= StringHelper::basename($generator->controllerClass) ?> extends <?= '\\' . trim($generator->baseClass, '\\') . "\n" ?>
 {
 <?php foreach ($generator->getActionIDs() as $action): ?>
     public function action<?= Inflector::id2camel($action) ?>()

extensions/gii/generators/controller/form.php

@@ -3,7 +3,7 @@
 /* @var $form yii\widgets\ActiveForm */
 /* @var $generator yii\gii\generators\controller\Generator */
 
-echo $form->field($generator, 'controller');
+echo $form->field($generator, 'controllerClass');
 echo $form->field($generator, 'actions');
-echo $form->field($generator, 'ns');
+echo $form->field($generator, 'viewPath');
 echo $form->field($generator, 'baseClass');

extensions/gii/generators/extension/form.php

@@ -5,7 +5,7 @@
 ?>
 <div class="alert alert-info">
     Please read the
-    <?= \yii\helpers\Html::a('Extension Guidelines', 'https://github.com/yiisoft/yii2/blob/master/docs/guide/structure-extensions.md', ['target'=>'new']) ?>
+    <?= \yii\helpers\Html::a('Extension Guidelines', 'http://www.yiiframework.com/doc-2.0/guide-structure-extensions.html', ['target'=>'new']) ?>
     before creating an extension.
 </div>
 <div class="module-form">

framework/CHANGELOG.md

@@ -7,6 +7,7 @@ Yii Framework 2 Change Log
 - Bug #4471: `yii\caching\ApcCache::getValues()` now returns array in case of APC is installed but not enabled in CLI mode (samdark, cebe)
 - Bug #4823: `yii message` accuracy and error handling were improved (samdark)
 - Bug #4889: Application was getting into redirect loop when user wasn't allowed accessing login page. Now shows 403 (samdark)
+- Bug #5070: Gii controller generator should use controller class name instead of controller ID to specify new controller (qiangxue)
 - Bug #5402: Debugger was not loading when there were closures in asset classes (samdark)
 - Bug #5448: Date formatter was doing timezone conversion on date only values resulting in different date displayed than provided (cebe)
 - Bug #5452: Errors occurring after the response is sent are not displayed (qiangxue) 

tests/unit/extensions/gii/GeneratorsTest.php

@@ -18,7 +18,7 @@ class GeneratorsTest extends GiiTestCase
     {
         $generator = new ControllerGenerator();
         $generator->template = 'default';
-        $generator->controller = 'test';
+        $generator->controllerClass = 'test';
 
         if ($generator->validate()) {
             $generator->generate();
@@ -107,4 +107,4 @@ class GeneratorsTest extends GiiTestCase
             print_r($generator->getErrors());
         }
     }
-}
+}
\ No newline at end of file