【Laravel】Collectionで使用できるメソッドの返り値

返り値（戻り値）ってみんな覚えてるの・・・？

LaravelのCollectionを扱っていると、

「あれ、このメソッドの返り値ってなんだっけ・・・」
「データがない時ってエラーになるんだっけ・・・あ、コレクション型だ」

という場面が往往にしてあります。
公式ドキュメントに載っていなかったり、コードヒントなどで一々確認したり、実際にコードを書いてみたりしていましたが、まとまったドキュメントがあれば整理しやすいな〜と思い下記にまとめてみます。

Laravel10の公式ドキュメントや実コードを元にまとめています。

よく使うCollectionのメソッドの返り値

メソッド	説明	データ存在時の返り値	データが存在しない時の返り値
all	コレクションの元の配列表現を返します。	array	array
get	指定されたキーのアイテムを返します。キーが存在していない場合はnullを返します。	mixed (値)	null
pluck	指定したキーの全コレクション値を取得します。	Collection	空のCollection
only	コレクション中の指定したアイテムのみを返します。	array	array (指定キーがない場合、空配列)
except	キーにより指定したアイテム以外の全コレクション要素を返します。※exceptの正反対の機能はonly	Collection	Collection
first	（条件に合う）コレクションの最初の要素を返します。	mixed (値)	null
firstOrFail	結果が見つからない場合にItemNotFoundException例外を投げる以外、firstメソッドと同じです。	mixed (値)	ItemNotFoundException
count	コレクションのアイテム数を返します。	int	0
values	キーをリセット後、連続した整数にした新しいコレクションを返します。	Collection	空のCollection
sort	コレクションをソートします。	Collection	Collection
sortBy	指定したキーでコレクションをソートします。	Collection	Collection
isEmpty	コレクションが空の場合にtrueを返します。そうでなければfalseを返します。	bool	bool
max	指定したキーの最大値を返します。	mixed (値)	null
min	指定したキーの最小値を返します。	mixed (値)	null
search	コレクションを検索し、指定値が見つかった場合はそのキーを返します。見つからない場合はfalseを返します。	int (キー)	false
toArray	コレクションをPHPの「配列」へ変換します。	array	array
unique	コレクションの重複を取り除いた全アイテムを返します。	Collection	Collection
where	指定したキー／値ペアでコレクションをフィルタリングします。	Collection	空のCollection
collect	コレクション中の現在のアイテムを利用した、新しいCollectionインスタンスを返します。	Collection	Collection
concat	指定したarrayまたはコレクションの値を別のコレクションの最後に追加します。	Collection	Collection
duplicates	コレクション中の重複値を返します。	Collection	空のCollection
each	コレクション内のアイテムを反復処理し、各アイテムをクロージャに渡します。	Collection	Collection
forget	キーによりコレクションのアイテムを削除します。※呼び出し元のコレクションを更新する	void	void
groupBy	指定したキーによりコレクションのアイテムをグループ化します。	Collection	空のCollection
has	指定したキーがコレクションに存在しているかを調べます。	bool	bool
implode	コレクション内のアイテムを結合します。	string	string
last	指定したテストをパスしたコレクションの最後のアイテムを返します。	mixed (値)	null

参考

• 10.x コレクション Laravel