【Laravel】ヘルパーファイル
※下記の内容に不備がありましたら、コメント頂けると幸いです。また、下記の内容をご使用頂ける場合は自己責任でお願いします。
【目次】
背景
Laravelの学習中に見たことがないメソッドが出てきたので、深掘りしていたらヘルパーファイルまで行き着きました。
自作のメソッドの追加方法にも触れながら、ヘルパーファイルについて書いていこうと思います。
ヘルパーファイル
ヘルパーファイルとは？
自作のメソッドを定義する際に使うファイルのことです。
ヘルパー関数は既にLaravelが豊富に用意してくれていますが、 独自のメソッドを追加したい場合などにヘルパーファイルを使用します。
ヘルパーファイルは自分で作る必要があります。
ちなみに、本番環境で利用するヘルパーファイルとテスト環境で利用するヘルパーファイルがあるようですが、ここでは触れません。
ヘルパーファイルの作成方法
Laravelプロジェクト環境かであれば、どこでも作成して構いません。
例えば、app/helpers.phpと作成しても大丈夫です。
ヘルパー関数の実装
ヘルパーファイルで以下のように記述します。
<?php
if (!function_exists('resources_collection')) {
function resources_collection($resources)
{
return \Illuminate\Http\Resources\Json\Resource::collection($resources);
}
}
function_exists()を使うことで、他に同じ名前のメソッドがあればそちらを優先するようにしています。
参考
素晴らしい記事に感謝いたします。
