Yii - 模块

更新于 2025/2/12 10:07:17

模块是一个实体，它有自己的模型、视图、控制器，可能还有其他模块。它实际上是应用程序内部的一个应用程序。

步骤 1 − 在项目根目录中创建一个名为 modules 的文件夹。在 modules 文件夹中，创建一个名为 hello 的文件夹。这将是我们的 Hello 模块的基本文件夹。

步骤 2 − 在 hello 文件夹中，使用以下代码创建一个文件 Hello.php。

<?php
   namespace app\modules\hello;
   class Hello extends \yii\base\Module {
      public function init() {
         parent::init();
      }
   }
?>

我们刚刚创建了一个模块类。它应该位于模块的基本路径下。每次访问模块时，都会创建相应模块类的实例。init() 函数用于初始化模块的属性。

步骤 3 − 现在，在 hello 文件夹内再添加两个目录 − controllers 和 views。将 CustomController.php 文件添加到控制器的文件夹中。

<?php
   namespace app\modules\hello\controllers;
   use yii\web\Controller;
   class CustomController extends Controller {
      public function actionGreet() {
         return $this->render('greet');
      }
   }
?>

创建模块时，惯例是将控制器类放入模块基本路径的控制器目录中。我们刚刚定义了 actionGreet 函数，它只返回一个 greet 视图。

模块中的视图应放在模块基本路径的 views 文件夹中。如果视图由控制器呈现，则它们应位于与 controllerID 对应的文件夹中。将 custom 文件夹添加到 views 文件夹。

步骤 4 − 在自定义目录中，使用以下代码创建一个名为 greet.php 的文件。

<h1>来自自定义模块的 Hello world!</h1>

我们刚刚为 actionGreet 创建了一个 View。要使用这个新创建的模块，我们应该配置应用程序。我们应该将我们的模块添加到应用程序的 modules 属性中。

步骤 5 − 修改 config/web.php 文件。

<?php
   $params = require(__DIR__ . '/params.php');
   $config = [
      'id' => 'basic',
      'basePath' => dirname(__DIR__),
      'bootstrap' => ['log'],
      'components' => [
         'request' => [
            // !!! insert a secret key in the following (if it is empty) - this is
               //cookie 验证所需
            'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO',
         ],
         'cache' => [
            'class' => 'yii\caching\FileCache',
         ],
         'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
         ],
         'errorHandler' => [
            'errorAction' => 'site/error',
         ],
         'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            // 默认将所有邮件发送到一个文件。您必须设置
            // 'useFileTransport' 为 false 并配置传输
            // 以便邮件程序发送真实的电子邮件。
            'useFileTransport' => true,
         ],
         'log' => [
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
               [
                  'class' => 'yii\log\FileTarget',
                  'levels' => ['error', 'warning'],
               ],
            ],
         ],
         'db' => require(__DIR__ . '/db.php'),
      ],
      'modules' => [
         'hello' => [
            'class' => 'app\modules\hello\Hello', 
         ],
      ],
      'params' => $params,
   ];
   if (YII_ENV_DEV) {
      // 针对"dev"环境的配置调整
      $config['bootstrap'][] = 'debug';
      $config['modules']['debug'] = [
         'class' => 'yii\debug\Module',
      ];
      $config['bootstrap'][] = 'gii';
      $config['modules']['gii'] = [
         'class' => 'yii\gii\Module',
      ];
   }
   return $config;
?>

模块控制器的路由必须以模块 ID 开头，后跟控制器 ID 和操作 ID。

步骤 6 − 要在我们的应用程序中运行 actionGreet，我们应该使用以下路由。