「CodeIgniter4のモジュール（HMVC）①」の続きです。

モジュールの実装

CodeIgniter4のモジュールは、名前空間をベースにコードをまとめるものです。

1つのPSR-4の名前空間が1つのモジュールになります。

これは、名前空間をCodeIgniter4のオートローダーの設定ファイルに追加してもいいですし、Composerパッケージで設定してもOKです。

つまり、Composerパッケージはモジュールとして使えます。というか、デフォルトでは全てのComposerパッケージがモジュールとして扱われます。

名前空間の中にコードをまとめるだけなら、そのようにコードを配置して、名前空間を指定して呼び出せばいいだけです。 PSR-4オートローダーがあれば、他には特に必要ありません。

しかし、それだけでは不便なのでフレームワークの機能としてモジュールを簡単に扱えるようにしています。

オートディスカバリー

オートディスカバリーとは、モジュールのファイルを自動的に検出する機能です。

デフォルトでは以下のファイルが自動的に検出されます。

• イベント
• フィルター
• レジストラ
• ルートファイル
• Services

前回、modules/Home/src/Config/Routes.php を用意しただけでルーティングが登録されたのは、このオートディスカバリーの機能によります。

オートディスカバリーは app/Config/Modules.php で項目別にオフに設定することができます。

Factories (config() と model())

Factories はデフォルトでは preferApp が true に設定されています。

これは、モジュール内のクラスを App にあるクラスで置き換えるための機能です。

クラスをロードする際に、同じショートネームのクラスが App 名前空間に存在すると、そちらが優先されます。

例えば、App\Models\UserModel と Blog\Models\UserModel があった場合、以下のコードはどちらも App\Models\UserModel をロードします。

$users = Factories::models('UserModel');
$users = Factories::models(\Blog\Models\UserModel::class);

Blog\Models\UserModel をロードしたい場合は、以下のように preferApp を false に指定する必要があります。

$users = Factories::models('Blog\Models\UserModel', ['preferApp' => false]);

この場合、model() 関数には preferApp を変更するオプションはありませんので、Blog\Models\UserModel はロードできないことになります。

helper()

helper() 関数は、モジュールの名前空間を指定することで、そのモジュールにあるヘルパーだけをロードできます。

helper('Blog\Helpers\blog');

名前空間を指定しない場合は、定義された全ての名前空間にある同じ名前のヘルパーファイルがロードされます。

view()

view() 関数は、モジュールの名前空間を指定することで、そのモジュールにあるビューをロードできます。

view('Blog\Views\blog_view');

名前空間を指定しない場合は、App\Views 以下のファイルがロードされます。

関連

• CodeIgniter4のモジュール（HMVC）内の設定ファイルとヘルパーの呼び出し方

参考

• Code Modules — CodeIgniter 4.2.10 documentation