web-controllers of modules are falsely auto-detected by the help command on the console

[schmunk42]

If you register a module for the console (eg. gii) it's web-controllers are detected as console commands, somewhere around here: https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/HelpController.php#L159

I wasn't sure if Reflection would be better and check instanceof console\Controller.

[cebe]

Yeah seen this before, you need to separate console and web controllers. A convention could be to ha ve commands dir like in basic app. Will work on this.

[cebe]

A simple fix for this would be to change Module::init() to the following:

    public function init()
    {
        if ($this->controllerNamespace === null) {
            $class = get_class($this);
            if (($pos = strrpos($class, '\\')) !== false) {
                $this->controllerNamespace = substr($class, 0, $pos) . '\\'
                    . (Yii::$app instanceof \yii\console\Application ? 'commands' : 'controllers');
            }
        }
    }

But then it would not be possible to configure different namespaces for different environments anymore. When using console and web controllers in a module one is bound to the default values.
@qiangxue any suggestions on this?

[qiangxue]

I think the help command needs to load the controller classes and detect their parent classes to determine whether they are console commands.

[cebe]

then there has to be a check in Module::createControllerByID() to not allow loading console controllers in web app and web controllers in console.

[qiangxue]

Yes, I think so, but this probably should be done in Application. It's not a very trivial change though.

[cebe]

Still the best way of separation would be to have different directories so it is clear from the location where the controller belongs to. The same issue is also with modules that can be used in different applications for example backend and frontend.

[qiangxue]

Agree. It doesn't make sense to mix two types of controllers in the same directory.

[schmunk42]

I'd also like to see two different directories, looks like to most intuitive solution to me.
Should Module get an commandNamespace property then?

[qiangxue]

Fixed the help command issue.

Regarding whether Module should get commandNamespace, my answer is no. A module should be either used for Web or console, but not both. This is just like you can't use a console application for Web, or vice versa.

So for the gii console support, we should introduce a ConsoleModule (which can inherit from the gii Web module) to manage the console commands.