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
-,

執筆者:

免責事項

このブログは、記事上部に記載のある投稿日時点の一般的な情報を提供するものであり、投資等の勧誘・法的・税務上の助言を提供するものではありません。仮想通貨の投資・損益計算は複雑であり、個々の取引状況や法律の変更によって異なる可能性があります。ブログに記載された情報は参考程度のものであり、特定の状況に基づいた行動の決定には専門家の助言を求めることをお勧めします。当ブログの情報に基づいた行動に関連して生じた損失やリスクについて、筆者は責任を負いかねます。最新の法律や税務情報を確認し、必要に応じて専門家に相談することをお勧めします。


  1. 匿名 より:

    そんなことできたんですね~勉強になります(^^♪

comment

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

CAPTCHA


関連記事

【Ruby Advent Calender 2017】Rubyでスクレイピングをしてみる【11日目】

1 はじめに1.1 概要2 仕様3 ソースコード4 使用したモジュール、Gem5 対象ページを取得6 XPATHから目的のものを抜き出す7 次のページのリンクを取得する8 他のサイトの記事でも試してみ ...

laravel logo

Laravelの基礎知識

1 はじめに2 Laravelの概要2.1 学習コストが低い2.2 Symfonyがベース2.3 DIを積極的に活用している3 ディレクトリ構成3.1 app3.2 bootstrap3.3 conf ...

js

TypeScriptでJavaScriptのライブラリを使用するには?

1 はじめに2 対応方法2.1 npmで@typesからインストールする2.2 自分で型定義ファイルを作る3 Declaration Space3.1 Type Declaration Space3. ...

php logo

PHP入門 〜文字列と数値の操作〜

1 はじめに2 基本ルール2.1 開始と終了のタグ2.2 ホワイトスペース2.3 大文字と小文字の区別2.4 コメント2.5 変数の定義3 文字列の操作3.1 文字列の定義3.2 無駄なスペースを削除 ...

crypto

公開鍵暗号の概要、用語と使用例

1 はじめに1.1 前提条件2 暗号化と復号2.1 暗号化とは2.2 復号とは3 暗号化方式3.1 共通鍵暗号3.2 公開鍵暗号4 署名と検証4.1 署名とは4.2 検証とは5 RSA暗号とは5.1 ...

フォロー

blog-page_side_responsive

2021年6月
 12345
6789101112
13141516171819
20212223242526
27282930  

アプリ情報

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