【Laravel】ビューコンポーザとは：共通するデータをViewに渡す方法

ビューコンポーザ（View Composer）とは

ビューコンポーザとはビューをレンダリングする際にビューにデータを提供するクラスです。簡単に言うと特定のページを表示する際に自動的に実行される処理を設定できるということです。

Laravelの用語確認

レンダリングとはテンプレートに記述されている変数や処理に必要な情報をはめ込み、実際の表示を生成することを意味します。レンダリングはテンプレートエンジンによって行われます。Laravelにはテンプレートエンジンとして「Blade」が備わっています

【Laravel】テンプレートエンジンのBladeとは：基本的な使い方

ビューコンポーザで定義したデータを複数のビューで利用することができ、ビューで共通して利用するデータのロジックをコントローラーから分離することができます。この特徴はビューとコントローラーの役割を理解している必要があります。以下にそれぞれの役割を記します。

関連リンク：【Laravel】コントローラーとは

ビューコンポーザはコントローラーが担っていたデータ処理（データを取得・生成してビューに渡す役割）を行うということです。これによりコントローラーからはデータ処理の部分を切り離すことができるのです。

コントローラーにロジックを記入してビューに渡すことはできますが、それだとコントローラーのコードが増加（Fat Controller）してしまいます。

ビューに特化したデータはコントローラーから分離してビューコンポーザに集約することで、コントローラーのコードを少なくしてコードの可読性を向上できます。

複数のビューで利用するロジックや変数があればビューコンポーザでまとめるような利用方法が主になります。

ビューコンポーザクラスの作成

まずビューコンポーザを作成していきます。ビューに提供するデータに関する処理をクラスとして定義します。

ビューコンポーザはartisanコマンドによる自動生成はできないため、手動でファイルの作成およびコードの記述を行います。

ビューコンポーザはHttp内であればどこに作成しても問題ありません。
ここでは「app/Http/View/Composers」を作成してその中にビューコンポーザを作りましょう。ここではMenuComposer.phpを以下の通りに作成します。

// app/Http/View/Composers/MenuComposer.php
<?php

namespace App\Http\View\Composers;

use Illuminate\View\View;

class MenuComposer
{
    public function compose(View $view)
    {
    $data = [
            'key1' => 'data1',
            'key2' => 'data2',
        ];

    $view->with('data', $data);
    }
}

クラス内ではcomposeメソッドを定義し、引数にViewクラスのインスタンスを指定します。

ビューに変数を渡すためにwithメソッドを使っています。上記では$dataをビューに変数dataという名前で渡しています。

サービスプロバイダの作成

ビューコンポーザを利用するためにサービスプロバイダを使う必要があります。サービスプロバイダを作成するには以下構文に沿ってartisanコマンドを実行します。

ここでは以下コマンドを実行してMenuServiceProviderを作成します。

$ php artisan make:provider MenuServiceProvider

上記コマンドを実行すると「app/Providers」内にMenuServiceProviderが作成されます。中を開くと次のように記述されています。

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class MenuServiceProvider extends ServiceProvider
{
    /**
     * Register services.
     */
    public function register(): void
    {
        //
    }

    /**
     * Bootstrap services.
     */
    public function boot(): void
    {
        //
    }
}

上記コードからわかるように、サービスプロバイダはServiceProviderクラスを継承します。

サービスプロバイダーにはregisterメソッドとbootメソッドの2つの重要なメソッドがあります。

ここではbootメソッドを使用します。bootメソッドには次のように記述してください。

// 追加する
use Illuminate\Support\Facades\View;

public function boot() {
// 以下を追加
    View::composer(
        'index','App\Http\View\Composers\MenuComposer'
    );
}

View::composerがビューコンポーザの設定を行うメソッドであり、第一引数にデータを渡すblade、第二引数にビューコンポーザクラスを指定します。

use Illuminate\Support\Facades\View;

サービスプロバイダの登録：app.phpのproviders配列

サービスプロバイダを作成したら、それらが実行されるようにサービスプロバイダを登録します。

サービスプロバイダを登録するために「config/app.php」を開き、以下のように作成したサービスプロバイダを追加します。

'providers' => [
    // 追加
    App\Providers\MenuServiceProvider::class,
],

ここまでの操作によって、指定したビュー内でビューコンポーザから渡されるデータが利用できます。