模块

模块

模块是独立的软件单元，由模型, 视图,
控制器和其他支持组件组成，
终端用户可以访问在应用主体中已安装的模块的控制器，
模块被当成小应用主体来看待，和应用主体不同的是，
模块不能单独部署，必须属于某个应用主体。

" class="reference-link">创建模块

模块被组织成一个称为[[yii\base\Module::basePath|base path]]的目录，
在该目录中有子目录如controllers, models, views 分别为对应控制器，模型，视图和其他代码，和应用非常类似。
如下例子显示一个模型的目录结构：

forum/
    Module.php                   模块类文件
    controllers/                 包含控制器类文件
        DefaultController.php    default 控制器类文件
    models/                      包含模型类文件
    views/                       包含控制器视图文件和布局文件
        layouts/                 包含布局文件
        default/                 包含DefaultController控制器视图文件
            index.php            index视图文件

" class="reference-link">模块类

每个模块都有一个继承[[yii\base\Module]]的模块类，
该类文件直接放在模块的[[yii\base\Module::basePath|base path]]目录下，
并且能被自动加载。当一个模块被访问，
和应用主体实例
类似会创建该模块类唯一实例，模块实例用来帮模块内代码共享数据和组件。

以下示例一个模块类大致定义：

namespace app\modules\forum;
class Module extends \yii\base\Module
{
    public function init()
    {
        parent::init();
        $this->params['foo'] = 'bar';
        // ...  其他初始化代码 ...
    }
}

如果 init() 方法包含很多初始化模块属性代码，
可将他们保存在配置并在init()中使用以下代码加载：

public function init()
{
    parent::init();
    // 从config.php加载配置来初始化模块
    \Yii::configure($this, require __DIR__ . '/config.php');
}

config.php配置文件可能包含以下内容，类似
应用主体配置.

<?php
return [
    'components' => [
        // list of component configurations
    ],
    'params' => [
        // list of parameters
    ],
];

" class="reference-link">模块中的控制器

创建模块的控制器时，惯例是将控制器类放在模块类命名空间的controllers子命名空间中，
也意味着要将控制器类文件放在模块
[[yii\base\Module::basePath|base path]]目录中的controllers子目录中。
例如，上小节中要在forum模块中创建post控制器，
应像如下申明控制器类：

namespace app\modules\forum\controllers;
use yii\web\Controller;
class PostController extends Controller
{
    // ...
}

可配置[[yii\base\Module::controllerNamespace]]属性来自定义控制器类的命名空间，
如果一些控制器不再该命名空间下，可配置[[yii\base\Module::controllerMap]]属性让它们能被访问，
这类似于应用主体配置所做的。

" class="reference-link">模块中的视图

视图应放在模块的[[yii\base\Module::basePath|base path]]对应目录下的 views 目录，
对于模块中控制器对应的视图文件应放在 views/ControllerID 目录下，
其中ControllerID对应控制器 ID. For example, if
例如，假定控制器类为PostController，
目录对应模块[[yii\base\Module::basePath|base path]]目录下的 views/post 目录。

模块可指定布局，它用在模块的控制器视图渲染。
布局文件默认放在 views/layouts 目录下，
可配置[[yii\base\Module::layout]]属性指定布局名，
如果没有配置 layout 属性名，默认会使用应用的布局。

" class="reference-link">模块中的控制台命令

您的模块也可以声明命令，这将通过控制台模式可用。

当 Yii 在控制台模式下执行并将其指向命令的命名空间时。想要在命令行中查看你的命令，
你需要更改 [[yii\base\Module::controllerNamespace]] 属性。

一种实现方法是在模块的 init() 方法中测试Yii应用程序的实例类型：

public function init()
{
    parent::init();
    if (Yii::$app instanceof \yii\console\Application) {
        $this->controllerNamespace = 'app\modules\forum\commands';
    }
}

然后您的命令将从命令行使用以下路由：

yii <module_id>/<command>/<sub_command>

" class="reference-link">使用模块

要在应用中使用模块，只需要将模块加入到应用主体配置的[[yii\base\Application::modules|modules]]属性的列表中，
如下代码的应用主体配置
使用 forum 模块:

[
    'modules' => [
        'forum' => [
            'class' => 'app\modules\forum\Module',
            // ... 模块其他配置 ...
        ],
    ],
]

[[yii\base\Application::modules|modules]] 属性使用模块配置数组，
每个数组键为模块 ID，它标识该应用中唯一的模块，
数组的值为用来创建模块的配置。

" class="reference-link">路由

和访问应用的控制器类似，路由
也用在模块中控制器的寻址，
模块中控制器的路由必须以模块ID开始，接下来为控制器ID和操作ID。
例如，假定应用使用一个名为 forum 模块，
路由forum/post/index 代表模块中 post 控制器的 index 操作，
如果路由只包含模块ID，默认为 default 的
[[yii\base\Module::defaultRoute]] 属性来决定使用哪个控制器/操作，
也就是说路由 forum 可能代表 forum 模块的 default 控制器。

" class="reference-link">访问模块

在模块中，可能经常需要获取模块类的实例来访问模块ID，模块参数，模块组件等，
可以使用如下语句来获取：

$module = MyModuleClass::getInstance();

其中 MyModuleClass 对应你想要的模块类，
getInstance() 方法返回当前请求的模块类实例，
如果模块没有被请求，该方法会返回空，注意不需要手动创建一个模块类，
因为手动创建的和Yii处理请求时自动创建的不同。

Info: 当开发模块时，你不能假定模块使用固定的ID，
因为在应用或其他没模块中，模块可能会对应到任意的ID，
为了获取模块ID，应使用上述代码获取模块实例，
然后通过$module->id获取模块ID。

也可以使用如下方式访问模块实例:

// 获取ID为 "forum" 的模块
$module = \Yii::$app->getModule('forum');
// 获取处理当前请求控制器所属的模块
$module = \Yii::$app->controller->module;

第一种方式仅在你知道模块ID的情况下有效，
第二种方式在你知道处理请求的控制器下使用。

一旦获取到模块实例，可访问注册到模块的参数和组件，例如：

$maxPostCount = $module->params['maxPostCount'];

" class="reference-link">引导启动模块

有些模块在每个请求下都有运行， [[yii\debug\Module|debug]] 模块就是这种，
为此将这种模块加入到应用主体的 [[yii\base\Application::bootstrap|bootstrap]] 属性中。

例如，如下示例的应用主体配置会确保debug模块每次都被加载：

[
    'bootstrap' => [
        'debug',
    ],
    'modules' => [
        'debug' => 'yii\debug\Module',
    ],
]

" class="reference-link">模块嵌套

模块可无限级嵌套，也就是说，模块可以包含另一个包含模块的模块，我们称前者为父模块，后者为子模块，
子模块必须在父模块的[[yii\base\Module::modules|modules]]属性中申明，
例如：

namespace app\modules\forum;
class Module extends \yii\base\Module
{
    public function init()
    {
        parent::init();
        $this->modules = [
            'admin' => [
                // 此处应考虑使用一个更短的命名空间
                'class' => 'app\modules\forum\modules\admin\Module',
            ],
        ];
    }
}

在嵌套模块中的控制器，它的路由应包含它所有祖先模块的ID，
例如forum/admin/dashboard/index 代表
在模块forum中子模块admin中dashboard控制器的index操作。

Info: [[yii\base\Module::getModule()|getModule()]] 方法只返回子模块的直属的
父模块。 [[yii\base\Application::loadedModules]] 保存了已加所有载模块的属性, 包括两者的子模块和
嵌套模块，并用他们的类名进行索引。