◀ 42.

【Laravel】ViewComposerを用いてviewに共通の値を付与する方法

▶
この記事の要点
  • Laravel の ViewComposer: 特定 View にデータを自動注入する仕組み
  • 実装: ServiceProvider の boot() で View::composer('view名', Closure)
  • View::share との違い: 「特定 View のみ」に注入できる（全 View ではない）
  • コンポーネント単位で重い処理を限定的に走らせたい時に有効

 

Layoutで必ず取得しなければならない値をわざわざ一つずつのコントローラーで取得するのは冗長的である。

当問題はViewComposerという機能を用いて解決することができる。

 

プロバイダーの作成

php artisan make:provider ComposerSeriviceProvider

 

プロバイダーの登録

config/app.phpに以下の記述を追加する。

'providers' => [

    ...

    App\Providers\ComposerSeriviceProvider::class,

]

 

サービスプロバイダー

<?php

namespace App\Providers;

use App\Http\ViewComposers\CommonComposer;
use Illuminate\Support\Facades\View;
use Illuminate\Support\ServiceProvider;

class ComposerSeriviceProvider extends ServiceProvider
{
    /**
     * コンテナ結合の登録
     *
     * @return void
     */
    public function boot()
    {
        // クラスがどのビューに対して実行されるか定義する方法
         View::composers([
            CommonComposer::class => [
                'layout.*',
                'admin.*'
            ]
        ]);

        // どのビューでどのクラスが実行されるか定義する方法
        View::composer(
            'profile', 'App\Http\ViewComposers\CommonComposer'
        );

        // クロージャベースのコンポーザを使用する
        View::composer('dashboard', function ($view) {
            //
        });

        // 単純にサービスプロバイダー直下に処理を記載するのもあり
        処理...

    }
}

 

コンポーザー（クラスベースの場合）

<?php

namespace App\Http\ViewComposers;

use Illuminate\View\View;
use App\Repositories\UserRepository;

class CommonComposer
{
    /**
     * userリポジトリの実装
     *
     * @var UserRepository
     */
    protected $users;

    /**
     * 新しいプロフィールコンポーザの生成
     *
     * @param  UserRepository  $users
     * @return void
     */
    public function __construct(UserRepository $users)
    {
        // 依存はサービスコンテナにより自動的に解決される
        $this->users = $users;
    }

    /**
     * データをビューと結合
     *
     * @param  View  $view
     * @return void
     */
    public function compose(View $view)
    {

        $view->with('aaa', 'bbb')
            ->with('ccc', 'ddd');
    }
}

 

composeの実行タイミング

View::composer(...)はViewのレンダリング後に実行される。

View::creator(...)を使用するとレンダリング前に実行される。

例えばAuth::check()の値はcreatorを使用しなければ正しい真偽値が取得できないといった事例がある。

 

Post Share
子ページ

子ページはありません

同階層のページ
  1. インストールと設定
  2. クイックスタート & チュートリアル(初心者向け)
  3. クイックスタート & チュートリアル(中級者向け)
  4. ルーティング
  5. Bladeテンプレート(ビュー/レイアウト)
  6. コントローラー
  7. マイグレーションとテーブル定義
  8. データベースの設定
  9. Eloquentモデル (ORM)
  10. SQLとクエリビルダー
  11. バリデーション
  12. .envファイルの設定値へのアクセス
  13. 動作環境による分岐処理
  14. configフォルダ配下の設定値へのアクセス
  15. assetヘルパーを利用したpublicフォルダへのアクセス
  16. storageフォルダへのアクセス
  17. アプリケーション名の変更
  18. メンテナンス
  19. ログイン画面(認証システム)の作成
  20. ログインの必須化
  21. ログインユーザー情報の取得
  22. ルートの認証化
  23. 本番サーバーへのデプロイ方法
  24. 多言語化
  25. csrf_field
  26. ファイルのダウンロード
  27. CSVのアップロードおよび読み込み(maatwebsite/excel)
  28. ページタイトルの設定
  29. コマンド一覧
  30. エラー一覧
  31. SQLの実行ログ出力方法
  32. キャッシュのクリア
  33. Selectの結果の最初もしくは最後に任意の値を追加する方法
  34. ajaxでPOST通信する際の注意点
  35. ソーシャルログインの実装
  36. セッション情報の確認
  37. ログイン、ユーザー登録、パスワードリセット後のリダイレクト先の変更方法
  38. redirectやreturn viewにメッセージを付与する方法
  39. クッキー(cookie)の設定と取得
  40. クラスの再読み込み
  41. csrfの有効時間を変更する方法
  42. ViewComposerを用いてviewに共通の値を付与する方法
  43. View::shareを用いて共通の値を各ビューに渡す方法
  44. ミドルウェアを用いた処理の共通化
  45. Middleware内でAuth::check()などを使用する方法
  46. Controller以外でリダイレクトする方法
  47. セッションの値の取得/保存/更新/削除
  48. $requestの値を変更する方法
  49. 常時SSL化
  50. ページング(ページネーション)をする方法
  51. vue.jsとの連携
  52. Vue.jsと連携するSPA実行環境構築
  53. .envの値をvue.jsで参照する方法
  54. vue.jsを本番環境にリリースする方法
  55. could not find driver（Windows, MySQL編）
2026-06-11 07:29:05 atom 1789

人気ページ

最近更新/作成されたページ