LaravelでAPIリソースでのcollectionとnewの使用タイミング

Question

現在LaravelでAPIサーバーを開発しているプログラミング初心者です。

APIを構築するに当たり、JSONレスポンスを整形するために書籍やネットにある情報を見ながら、見よう見まねでresourceを作成しました。

正常に動作はしているのですが、よく理解できない点が下記

CategoryController.php

public function index()
    {
        return CategoryResource::collection(Category::latest()->get());
    }

public function show(Category $category)
    {
        return new CategoryResource($category);
    }

この場合なぜ　showメソッドではインスタンスを生成しているにもかかわらず、indexメソッドでは::collectionとしているのでしょうか？

どなたかご教示いただけると幸いです。

Answer 1

https://readouble.com/laravel/5.6/ja/eloquent-resources.html

new CategoryResource と CategoryResource::collection の使い分けは、単に 一つのモデルを返却したいのか それとも 複数のモデル(=コレクション)を返却したいのか ということです。

細かく確認したわけではありませんが CategoryResource::collection もコレクションインスタンスを生成して返しているはずです。

一般的に、 index では複数データを返し、 show では単一データを返す作りにする場合が多いです。
なので index では CategoryResource::collection 、 show では new CategoryResource とそれぞれ用いているのだと思います。

Answer 2

クラスそのものは、インスタンスを生成しないと利用できません。

ただし、クラス内でstaticに定義されたメソッドは、
「クラスのインスタンス」を生成せずに、スコープ定義演算子::（ダブルコロン）で、利用可能です。

聞きたいのは、この差のことでしょうか？
これはlaravelがどう・・という話ではなく、phpそのもののお話ですね。。

---

追記です。

indexメソッドとshowメソッドそのものの定義に、大きな差はありません。

showメソッドで、::を使ってはいけないわけではないですし、
indexメソッドで、newしてはいけないということでもありません。

ただ、目的の異なるメソッドですので、中身のコードは変わりますよね。
返却したいものを作る為に、一番簡単に書いたコードがこうだったという話です。

■laraveのリソースについても書いてみます■

CategoryResourceは、1つのCategoryモデルを配列にしてくれます。

ここでいう「1つのCategoryモデル」は、

$category = Category::find(1);

のように取得された結果で、

$category->id;
$category->name;

こんな感じで値を参照できる形をしています。

showメソッドで扱っている$cateogry は、$category = Category::find($id)　の結果と同じものが入っていますので、new CategoryResource($cateogry)のように使うことが出来ます。

一方、indexメソッドで扱っているCategory::latest()->get()は、「複数のCategoryモデルが入っているCollection」です。

phpでこれを扱う場合、

$categories = Category::latest()->get();
foreach($categories as $category){
  echo $category->id;
  echo $category->name;
}

こんな風に使います。Categoryモデルとは、中身が違いますよね。

CategoryResourceでは、1つのCategoryモデルしか取り扱えないので、new CategoryResource(Category::latest()->get())こういうことはできません。

「複数のCategoryモデルが入っているCollection」を配列にする為には、「コレクションリソース」が必要ですが、作るのはちょっと面倒です。
で、「リソース」を使って、簡易的に「コレクションリソース」を返却できるよう用意されているのがcollection関数です。

CategoryResource::collection()で返却されるのは、「コレクションリソース」です。
CategoryResourceで返却される「リソース」とは中身が異なります。

中身が違うということは、new CategoryResource では生成できないということです。
そのため、collection関数はstaticな関数として定義されているのだと思います。

staticな関数を呼び出す場合には、スコープ定義演算子::を使います。

ということで、
indexメソッドでは、```CategoryResource::collection(Category::latest()->get())

Comments

[kokaa]

こちら試しにshowメソッドで :: で利用しようとしたところエラーとなりました。

indexメソッドとshowメソッドで何が違うのでしょうか？

[mix-peach]

回答に追記してみました！

[kokaa]

とてもわかりやすい説明ありがとうございます！
スッキリ理解できました！