view()が返すのはResponseクラスのインスタンス？

Question

Laravelの勉強を参考書でしていたのですが、次のような記述がありました。

『viewメソッドが返すのは、Responseインスタンスです。』

しかし、実際にget_class()で確認してみると、「Illuminate\View\View」のインスタンスでした。
フレームワークのソースコードを見ても、view()がResponseを返す処理はないように思えます。

誤植かなとも思いましたが、ドキュメント(翻訳版)を読んでいると次のようなコードがありました。

class UserController extends Controller
{
    /**
     * 指定ユーザーのプロフィール表示
     *
     * @param  int  $id
     * @return Response
     */
    public function show($id)
    {
        return view('user.profile', ['user' => User::findOrFail($id)]);
    }
}

ソース内のコメントにもある通り、view()がResponseを返すような書かれかたをしています。

これはどういうことなんでしょうか？view()がResponseクラスのインスタンスを返すようなことはあるのでしょうか？

回答よろしくお願いします。

Answer 1

『viewメソッドが返すのは、Responseインスタンスです。』
というのがどういった文脈で語られているのかちょっとわかりかねますが、
「viewメソッド」という言い方をしているので恐らくなにかのクラスのメソッドのことをさしているんだと思います。
ResponseFactoryクラス（responseヘルパの返り値はResponseFactoryのインスタンスです）にもviewというメソッドがあって、そちらはResponseを返します。

monokuroさんがソースコードを確認しているのはviewヘルパーです。
なので根本的に違うもののことを言っているんじゃないかと思います。
viewヘルパーはご確認なさっている通りviewのインスタンスを返します。

viewヘルパーの説明は以下です。
https://readouble.com/laravel/5.6/ja/helpers.html#method-view

Comments

[monokuro]

回答ありがとうございます。

『viewメソッドが返すのは、Responseインスタンスです。』という文が本書で出てきたタイミングは、ヘルパという概念を説明する前の段階でしたので、便宜的にメソッドという呼び方をしてたのだと思います。文章が足りずわかりにくくてすみませんでした。
なので、ヘルパのview()として使用されていたと思います。

しかし仮にこちらの参考書が誤植だとして、上であげたコードには、PHPDocのコメントとして「@return Response」のように記述されています。これだとviewヘルパーがResponseクラスを返すように解釈できるのですが、ドキュメントの方も誤植なのでしょうか？

細かいことで申し訳ないのですが、返答いただけると幸いです。

Answer 2

viewヘルパーの方がResponseクラスを返すことはないです。

returnのところにResponseとありますが、Viewを返却しても問題ありません。
公式ドキュメントの方にも記載がありました。

英語
日本語

もちろん、カスタムHTTPステータスコードやヘッダの指定が不必要であれば、シンプルにグローバルviewヘルパ関数を使用することもできます。

PHPDocの記載がResponseとなってる理由はちょっとわかりません。
最終的にResponseに変換されるからPHPDocの記載もResponseとしてるのかもしれないですね。

ViewでもResponseでもどっちでもいいってそんなんでちゃんと動くの？という疑問が当然湧くかと思います。
これはLaravelが内部でViewオブジェクトをResponseオブジェクトに変換していました。
Illuminate\Routing\Routerクラスでこの変換が行われています。

Laravelがリクエストを受け取ってからレスポンスを返すまでの流れはここでは詳しく説明できませんが、
もし興味があったら調べてみてください。参考になるページを貼って起きます。

https://readouble.com/laravel/5.6/ja/lifecycle.html
https://www.pupha.net/archives/3032/

Comments

[YamajiDaisuke]

回答かぶった。恥ずかしい(*ノノ)

[monokuro]

お返事が遅れてしまい申し訳ありません。回答ありがとうございます。
内部的にResponseに変換されていたのですね。勉強になりました。
参考にあげてくださったリンクも目を通しましたが、正直、今の私では完璧に理解することは難しかったです。
ですが、なんとなくの流れはわかりました。ありがとうございました。

Answer 3

結論を言ってしまえば、誤植ではありません。responseを返しています。
途中の処理は端折りますが、Illuminate\Routing\RouterのprepareResponseを通った時にresponse化されて返却します。

    /**
     * Create a response instance from the given value.
     *
     * @param  \Symfony\Component\HttpFoundation\Request  $request
     * @param  mixed  $response
     * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
     */
    public function prepareResponse($request, $response)
    {
        return static::toResponse($request, $response);
    }

    /**
     * Static version of prepareResponse.
     *
     * @param  \Symfony\Component\HttpFoundation\Request  $request
     * @param  mixed  $response
     * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
     */
    public static function toResponse($request, $response)
    {
        if ($response instanceof Responsable) {
            $response = $response->toResponse($request);
        }

        if ($response instanceof PsrResponseInterface) {
            $response = (new HttpFoundationFactory)->createResponse($response);
        } elseif (! $response instanceof SymfonyResponse &&
                   ($response instanceof Arrayable ||
                    $response instanceof Jsonable ||
                    $response instanceof ArrayObject ||
                    $response instanceof JsonSerializable ||
                    is_array($response))) {
            $response = new JsonResponse($response);
        } elseif (! $response instanceof SymfonyResponse) {
            $response = new Response($response);
        }

        if ($response->getStatusCode() === Response::HTTP_NOT_MODIFIED) {
            $response->setNotModified();
        }

        return $response->prepare($request);
    }

Comments

[monokuro]

お返事が遅れてしまい申し訳ありません。回答ありがとうございます。
なるほど、prepareResponseでResponseに変換されるのですね。
具体的な箇所まであげていただきありがとうございます。