BackEnd

EloquentのtoArray()とtoJson()をカスタマイズ

投稿日:2021年6月28日 更新日:

はじめに

LaravelのEloquentには色々便利な機能がありますが、今回はモデルのシリアライズに関する機能を紹介したいと思います。

$visibleプロパティと$hiddenプロパティ

Laravel開発ではモデルを toArray() メソッドや toJson() メソッドで配列やJSONに変換して利用する事がよくあると思います。
その際に含める属性と含めない属性を定める事が出来ます。

例えばよくあるユーザー情報テーブルのUserモデルを例にします。

このモデルには、 id, firstname, lastname, email, password の値を保持しています。

$visibleプロパティ

$visible プロパティに加えた属性は変換結果に含まれます。所謂、ホワイトリスト的な使い方が出来ます。

APIのレスポンスにモデルを使用したい場合などに、パスワードなど極力外に出したく無いものを除いて、変換結果を取得する事が出来ますね。

$hiddenプロパティ

$hidden プロパティに加えた属性は変換結果に含まれません。

$visible プロパティとは逆にブラックリスト形式に指定する事が出来ます。

独自属性の追加

$appendsプロパティ

データベースのカラムに存在しない属性をモデル変換後の配列やJSONに含めたい場合があると思います。その場合は、 $appends プロパティに定義しておく事で通常のカラム属性の様に扱える事が出来ます。例として、関数の返却値を独自属性として追加しています。

ここで、先程の $visible プロパティや $hidden プロパティに追加すると、その他属性と同様に扱えます。

使い所

モデルの中身をAPIレスポンスとして返す際に、不要な値をレスポンスに含めない様にしたり、データベースカラムにない独自属性をレスポンスに含めたりする様な場面で使用出来るかと思います。

また、フロントサイドにJSフレームワーク(Vue.jsなど)を使用している場合に、Laravel側からVue側にモデルデータをJSONとして渡す事があるかと思いますが、こういう場合にも独自属性を利用してVue側で必要な値を予め渡しておく事も可能になるかと思います。

さいごに

Laravelは細かな便利機能も多いので、今後も紹介していけたらと思います。

おすすめ書籍

PHPフレームワークLaravel Webアプリケーション開発 バージョン8.x対応 PHPフレームワークLaravel入門 第2版 PHPフレームワーク Laravel実践開発

blog-page_footer_336




blog-page_footer_336




-BackEnd
-,

執筆者:


comment

メールアドレスが公開されることはありません。

CAPTCHA


関連記事

Go言語

Go言語の基礎〜基本構文その1〜

1 はじめに2 変数2.1 変数の定義2.2 暗黙的な定義2.3 varと暗黙的な定義2.4 ローカル変数とパッケージ変数3 定数3.1 const3.2 iota4 関数4.1 関数定義の基本4.2 ...

Stripe Connectを使って継続課金にクーポンを適用する

1 はじめに2 クーポンについて2.1 クーポンのタイプ2.2 期間2.3 引き換え回数制限2.4 その他3 クーポンの作成4 クーポンの使用4.1 定期支払にクーポンを適用4.2 Checkoutで ...

rails

Rails5で出力される「alias_method_chain is deprecated.」について

1 はじめに2 alias_method_chainとは3 Module#prependとは4 とりあえず、DEPRECATION WARNINGの出力をなくしたい5 さいごに はじめに 直近のプロジ ...

laravel logo

Laravelでメールを送る

1 はじめに1.1 準備2 実装2.1 Mailableクラスの作成2.2 テンプレートの作成2.3 Mailableクラスの修正2.4 コントローラの作成2.5 コンフィグの修正3 さいごに4 おす ...

laravel logo

Laravelのブラウザテスト「Dusk」をシンプルなCRUDで始めてみよう

1 はじめに2 Laravel Duskのセットアップ3 新規登録のテスト3.1 テスト対象となるコード3.2 Duskのテストコード3.3 テストの実行4 更新のテスト4.1 テスト対象となるコード ...

フォロー

blog-page_side_responsive

2021年6月
 12345
6789101112
13141516171819
20212223242526
27282930  

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。