Yii - 模块

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

步骤 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文件添加到controllers文件夹。

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

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

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

步骤 4 − 在 custom 目录内，创建一个名为greet.php的文件，内容如下。

<h1>Hello world from custom module!</h1>

我们刚刚为actionGreet创建了一个视图。要使用这个新创建的模块，我们应该配置应用程序。我们应该将我们的模块添加到应用程序的 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
               //required by cookie validation
            'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO',
         ],
         'cache' => [
            'class' => 'yii\caching\FileCache',
         ],
         'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
         ],
         'errorHandler' => [
            'errorAction' => 'site/error',
         ],
         'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            // send all mails to a file by default. You have to set
            // 'useFileTransport' to false and configure a transport
            // for the mailer to send real emails.
            '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) {
      // configuration adjustments for 'dev' environment
      $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，我们应该使用以下路由。

hello/custom/greet

其中 hello 是模块 ID，custom 是控制器 ID，greet 是操作 ID。

步骤 7 − 现在，输入https://127.0.0.1:8080/index.php?r=hello/custom/greet，您将看到以下输出。

重要提示

模块应该：

用于大型应用程序。您应该将其功能分成几个组。每个功能组都可以开发为一个模块。
可重用。一些常用的功能，如 SEO 管理或博客管理，可以开发成模块，以便您可以在未来的项目中轻松重用它们。

打印页面