Yii-モジュール

モジュールは、独自のモデル、ビュー、コントローラー、および場合によっては他のモジュールを持つエンティティです。これは、実際にはアプリケーション内のアプリケーションです。

Step 1 −というフォルダを作成します modulesプロジェクトルート内。modulesフォルダー内に、という名前のフォルダーを作成しますhello。これは、Helloモジュールの基本フォルダーになります。

Step 2 −内部 hello フォルダ、ファイルを作成します Hello.php 次のコードで。

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

モジュールクラスを作成しました。これは、モジュールのベースパスの下に配置する必要があります。モジュールにアクセスするたびに、対応するモジュールクラスのインスタンスが作成されます。ザ・init() 関数は、モジュールのプロパティを初期化するためのものです。

Step 3−ここで、helloフォルダ内にさらに2つのディレクトリを追加します−コントローラとビュー。追加する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 フォルダ。

Step 4 −カスタムディレクトリ内に、というファイルを作成します greet.php 次のコードで。

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

作成しました View 私たちのために actionGreet。この新しく作成されたモジュールを使用するには、アプリケーションを構成する必要があります。モジュールをアプリケーションのmodulesプロパティに追加する必要があります。

Step 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が続く必要があります。

Step 6 −を実行するには actionGreet このアプリケーションでは、次のルートを使用する必要があります。

hello/custom/greet

helloがモジュールIDである場合、customは controller ID と挨拶は action ID

Step 7 −ここで、 http://localhost:8080/index.php?r=hello/custom/greet 次の出力が表示されます。

重要なポイント

モジュールは-

  • 大規模なアプリケーションで使用されます。その機能をいくつかのグループに分割する必要があります。各機能グループは、モジュールとして開発できます。

  • 再利用可能であること。SEO管理やブログ管理など、一般的に使用される機能の一部をモジュールとして開発できるため、将来のプロジェクトで簡単に再利用できます。