Yii-modules
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フォルダー内にコントローラーとビューの2つのディレクトリを追加します。 *CustomController.php ファイルをコントローラーのフォルダーに追加します。
<?php
namespace app\modules\hello\controllers;
use yii\web\Controller;
class CustomController extends Controller {
public function actionGreet() {
return $this->render('greet');
}
}
?>
モジュールを作成するときの規則は、コントローラークラスをモジュールのベースパスのコントローラーのディレクトリに配置することです。 greet ビューを返すだけの actionGreet 関数を定義しました。
モジュール内のビューは、モジュールのベースパスのビューフォルダーに配置する必要があります。 ビューがコントローラーによってレンダリングされる場合、それらは controllerID に対応するフォルダーに配置する必要があります。 カスタム*フォルダーを *views フォルダーに追加します。
ステップ4 *-カスタムディレクトリ内で、次のコードを使用して *greet.php というファイルを作成します。
<h1>Hello world from custom module!</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
//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管理やブログ管理などの一般的に使用される機能はモジュールとして開発できるため、将来のプロジェクトで簡単に再利用できます。