Yii模块


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

第1步 - 在项目根目录下创建一个名为 模块 的文件夹。在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 函数,它只是返回一个 问候 视图。

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

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

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

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

第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管理或博客管理)可以作为模块进行开发,以便您可以在未来的项目中轻松地重用它们。