Laravelのwithメソッドのリファレンスが無い😂ヘルパ関数？PHP？

記事内にPRが含まれる場合があります

2022年8月1日2026年3月4日

URLをコピーしました！

Laravelを学習中です。

ところでLaravelをやってるとwith()メソッドがやたら出てくる。

しかも何故か公式リファレンスが見つからないのよ。探し方悪いのかな？😂

普通HTMLリファレンス、Javaリファレンス、JavaScriptリファレンス色々あるでしょ。クラス名、メソッド、その中身、機能、return値全部見つかるよ。でもねLaravelのwithは見つからねーんだわ。

PHPのリファレンスかな？と思ったけど、Laravel固有のwithメソッドはPHPの標準機能ではないので見つかりません。

けどLaravelのドキュメントにはしばしばあちこちでwithメソッドを見かける。けど、どのクラスのどのメソッドにwith()があるのかが見当たらない。

Laravelではwithメソッドは例えばこんな風に使われている

Laravelにおけるwith()メソッドは、文脈によって異なる役割を果たします。主に以下の3つのパターンで使用されます。それぞれ、Eloquentモデルのリレーションシップの eager loading、redirectメソッドのメソッドチェーン、viewメソッドのメソッドチェーンです。

①redirectメソッドのメソッドチェーン（->）で繋げてwithメソッド

Route::post('/user/profile', function () {
    // …
    return redirect('dashboard')->with('status', 'Profile updated!');
});

②viewメソッドのメソッドチェーンで繋げてwithメソッド

return view('greeting')
            ->with('name', 'Victoria')
            ->with('occupation', 'Astronaut');

③Eloquentモデルのリレーションシップの eager loadingで繋げてwithメソッド

$users = User::with('posts')->get();

どっちもwithメソッドだけど似たような使い方だけど同じものではなさそう。

Laravelのwithメソッドは何なのか？調べてみた

あちこち調べまわったけど公式リファレンスが見つからない。なのでソースから全頭検査することにしました。

そしたら見つかりました。

1つ目RedirectResponseクラスのwithメソッド

1つ目。ファイルの場所：
/vendor/laravel/framework/src/Illuminate/Http/RedirectResponse.php

    /**
     * Flash a piece of data to the session.
     *
     * @param  string|array  $key
     * @param  mixed  $value
     * @return $this
     */
    public function with($key, $value = null)
    {
        $key = is_array($key) ? $key : [$key => $value];

        foreach ($key as $k => $v) {
            $this->session->flash($k, $v);
        }

        return $this;
    }

これはRedirectResponseクラスのwithメソッドです。このメソッドは、リダイレクト時にセッションにフラッシュデータを設定するために使用されます。フラッシュデータは、次のリクエストでのみ利用可能で、その後自動的に削除されます。これは、リダイレクト後にユーザーに成功メッセージやエラーメッセージを表示するのに役立ちます。例えば、フォーム送信後に「プロフィールが更新されました！」のようなメッセージを表示する際に利用されます。return $thisなので、メソッドチェーンを可能にするために自分自身を返します。つまり、redirect()->with('success', 'メッセージ')->otherMethod();のように記述できます。

気になったのは$this->session。これはこのクラスのprotected変数$sessionを意味していると思います。
$sessionは

use Illuminate\Session\Store as SessionStore;

public function setSession(SessionStore $session)
{
    $this->session = $session;
}

という記述があるのでここでインスタンスをセットしてるように見える。この`setSession`メソッドは、通常、リクエストのライフサイクル中にLaravelのフレームワークによって呼び出されます。セッションストアのインスタンスを`RedirectResponse`に注入することで、リダイレクト時にセッションデータにアクセスして操作できるようになります。セッションストアは、セッションデータを保存・管理するための仕組みです。セッションは、ユーザーのブラウザとサーバー間で情報を保持するために使用され、ログイン状態の維持やショッピングカートの管理などに役立ちます。

$this->session->flash($k, $v)で、Storeクラスのflashメソッドを使ってるってことか。`flash`メソッドは、セッションにデータを保存し、次のリクエストでのみアクセス可能にします。これは、リダイレクト後に一時的な情報をユーザーに表示するのに非常に便利です。セッションに保存されたフラッシュデータは、次のリクエストが処理された後に自動的に削除されます。つまり、ユーザーがページをリロードしたり、別のページに移動したりすると、フラッシュデータは消えてしまうということです。

2つ目、Viewクラスのwithメソッド

2つ目。ファイルの場所：
/vendor/laravel/framework/src/Illuminate/View/View.php

    /**
     * Add a piece of data to the view.
     *
     * @param  string|array  $key
     * @param  mixed  $value
     * @return $this
     */
    public function with($key, $value = null)
    {
        if (is_array($key)) {
            $this->data = array_merge($this->data, $key);
        } else {
            $this->data[$key] = $value;
        }

        return $this;
    }

これはViewクラスのwithメソッドです。このメソッドは、ビューにデータを渡すために使用されます。ビューに渡されたデータは、ブレードテンプレート内で利用できます。例えば、ユーザーの名前や投稿のリストなどをビューに渡す際に使用されます。return $thisなのでView自身を返します。これにより、メソッドチェーンを使用して複数のデータを一度に渡すことができます。例えば、`->with(‘name’, ‘John’)->with(‘age’, 30)`のように記述できます。これにより、ビューテンプレート内で`{{ $name }}`や`{{ $age }}`のように変数としてアクセスできます。

withメソッドの中身は、data配列の$keyに$valueを入れてる。この`data`配列は、ビューのレンダリング時に利用され、テンプレート内で変数としてアクセスできます。ブレードテンプレートエンジンは、この`data`配列を解析し、変数に対応する値を表示します。ブレードテンプレートは、PHPコードをHTMLに埋め込むための強力なツールであり、動的なWebページを作成するのに役立ちます。

withメソッドの返り値がやはりViewクラスだから、さらにメソッドチェーン->で繋げて->withとかも出来る様子。

3つ目、Eloquentモデルのwithメソッド (Eager Loading)

Eloquentモデルで使用されるwithメソッドは、リレーションシップの eager loading を行うために使用されます。Eager loading は、関連するモデルを一度にロードすることで、N+1問題と呼ばれるパフォーマンスの問題を回避するために重要です。N+1問題とは、関連するデータが多い場合に、各データに対して個別にデータベースクエリが実行されることで、パフォーマンスが著しく低下する現象です。例えば、100人のユーザーとその投稿をロードする場合、Eager loadingを使用しないと101回のデータベースクエリが実行される可能性があります（1回のユーザーリストのクエリと、100回の投稿リストのクエリ）。

ファイルの場所：Eloquentモデルの定義ファイル

$users = User::with('posts')->get();

この例では、Userモデルに関連付けられたpostsリレーションシップを eager loading しています。これにより、すべてのユーザーとそれらの投稿が1つのデータベースクエリで取得されます。Eager loading を使用しない場合、各ユーザーに対して個別のクエリが実行され、パフォーマンスが低下する可能性があります。Eager loading は、特にリレーションシップが深く、関連するデータが多い場合に効果的です。Eager loadingは、アプリケーションの応答性を向上させ、データベースサーバーの負荷を軽減するのに役立ちます。

補足：Eager Loadingの仕組み

Eager loading は、Eloquentモデルのリレーションシップ定義に基づいて、関連するモデルをロードします。リレーションシップ定義は、モデルのメソッドとして定義され、関連するモデルのクエリビルダーを返します。Eager loading を使用すると、Eloquent は関連するモデルをロードするための追加のクエリを生成し、それをメインのクエリと結合して実行します。これにより、データベースへのアクセス回数を減らし、パフォーマンスを向上させることができます。Eloquentは、JOINクエリを使用して関連するデータを効率的に取得します。

Eager Loadingの種類

Eager loadingには、いくつかの種類があります。

基本的なEager Loading: User::with('posts')->get();のように、リレーションシップの名前を指定します。
複数のリレーションシップのEager Loading: User::with(['posts', 'profile'])->get();のように、配列で複数のリレーションシップを指定します。
制約付きのEager Loading: User::with(['posts' => function ($query) { $query->where('status', 'published'); }])->get();のように、クロージャを使用してリレーションシップに制約を追加します。

Laravelのヘルパ関数にもwithがあった

あと調べてる途中でヘルパー関数のwithっていうのもあることが判明。

・with関数は、指定値を返します。関数の２番目の引数としてクロージャを渡たすと、クロージャが実行され、その戻り値を返します。
$callback = function ($value) {
    return is_numeric($value) ? $value * 2 : 0;
};

$result = with(5, $callback);

// 10

もうややこしいよ。。

Laravelヘルパー関数のwithメソッドの詳細

このヘルパー関数with()は、指定された値に対してクロージャ（無名関数）を実行し、そのクロージャの戻り値を返します。これは、オブジェクトのメソッドを呼び出す前に、そのオブジェクトを操作する際に便利です。例えば、オブジェクトのプロパティを変更したり、何らかの計算を行ったりすることができます。この関数は、コードをより簡潔にし、可読性を向上させるのに役立ちます。例えば、文字列を大文字に変換したり、数値をフォーマットしたりする際に使用できます。この関数は、特に、オブジェクトのメソッドチェーンの中で、オブジェクトの状態を変更する必要がある場合に役立ちます。

補足：クロージャとは？

クロージャは、定義されたスコープ外でもアクセスできる変数を保持する関数です。Laravelでは、クロージャはコールバック関数としてよく使用されます。これにより、コードの再利用性と柔軟性が向上します。クロージャは、関数内で別の関数を定義し、その内部関数が外部関数の変数を参照する場合によく使用されます。クロージャは、イベントリスナーやコールバック関数として、Laravelアプリケーションのさまざまな場所で使用されます。クロージャは、関数型プログラミングの重要な概念であり、コードの可読性と保守性を向上させるのに役立ちます。

このヘルパー関数は、特にコレクションやオブジェクトを操作する際に、簡潔なコードを書くのに役立ちます。例えば、コレクション内の各要素に対して何らかの処理を行い、その結果を新しいコレクションとして取得する場合などに使用できます。これにより、コードの可読性と保守性が向上します。この関数は、Laravelのコレクションメソッドと組み合わせて使用することで、より強力なデータ操作が可能になります。