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 文件夹中添加另外两个目录 - 控制器和视图。将CustomController.php文件添加到控制器的文件夹中。
    
    <?php
       namespace app\modules\hello\controllers;
       use yii\web\Controller;
       class CustomController extends Controller {
          public function actionGreet() {
             return $this->render('greet');
          }
       }
    ?>
    
    创建模块时,约定是将控制器类放入模块基本路径的控制器目录中。我们刚刚定义了actionGreet函数,它只返回一个问候视图。
    模块中的视图应该放在模块基本路径的views文件夹中。如果视图由控制器呈现,则它们应位于与controllerID对应的文件夹中。将自定义文件夹添加到视图文件夹。
    第 4 步- 在自定义目录中,使用以下代码创建一个名为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 步- 现在,输入http://localhost:8080/index.php?r=hello/custom/greet,您将看到以下输出。
    自定义模块
  • 要点

    模块应该 -
    • 用于大型应用。您应该将其功能分为几组。每个功能组都可以开发为一个模块。
    • 可重复使用。一些常用的功能,如 SEO 管理或博客管理,可以开发为模块,以便您在以后的项目中轻松重用它们。