質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.48%
Laravel

LaravelとはTaylor Otwellによって開発された、オープンソースなPHPフレームワークです。Laravelはシンプルで表現的なシンタックスを持ち合わせており、ウェブアプリケーション開発の手助けをしてくれます。

Q&A

解決済

1回答

1306閲覧

[Laravel8]レスポンスするjsonデータを加工したいです。

Zera8

総合スコア1

Laravel

LaravelとはTaylor Otwellによって開発された、オープンソースなPHPフレームワークです。Laravelはシンプルで表現的なシンタックスを持ち合わせており、ウェブアプリケーション開発の手助けをしてくれます。

0グッド

0クリップ

投稿2022/07/21 12:30

編集2022/07/22 05:00

前提

LaravelでAPI開発をしています。
レスポンスするjsonデータをより綺麗に加工したいと考え投稿させて頂きました。

現在は以下のようにjsonデータが二つ返ってきています。

現在のレスポンスjsonデータ

{ "id": 3, "item_id": 3, "item": { "id": 3, "code": "205", "name": "商品" }, "item_split_detail": { "id": 9, "item_split_id": 3, "no": 1, "sub_item_id": 1, "split_price": 3000, "created_at": "2022-07-21 10:22:34", "created_user": null, "updated_at": "2022-07-21 10:22:34", "updated_user": null }, "created_at": "2022-07-21T09:28:26.000000Z", "created_user": "created_user", "updated_at": "2022-07-21T10:22:34.000000Z", "updated_user": null }, //*********ここから二つ目のデータ "item_split_detail"以外は一つ目と同じデータを持つ************* { "id": 3, "item_id": 3, "item": { "id": 3, "code": "205", "name": "商品" }, "item_split_detail": { "id": 10, "item_split_id": 3, "no": 2, "sub_item_id": 2, "split_price": 2000, "created_at": "2022-07-21 10:22:34", "created_user": null, "updated_at": "2022-07-21 10:22:34", "updated_user": null }, "created_at": "2022-07-21T09:28:26.000000Z", "created_user": "created_user", "updated_at": "2022-07-21T10:22:34.000000Z", "updated_user": null }

実現したいこと

親となるテーブルのid,item_idは同じでitem_split_detail内のデータが異なっているので、一つのjsonデータにまとめてあげたいです。

実現したいjsonデータ

{ "id": 3, "item_id": 3, "item": { "id": 3, "code": "205", "name": "商品" }, "item_split_detail": { "id": 9, "item_split_id": 3, "no": 1, "sub_item_id": 1, "split_price": 3000, "created_at": "2022-07-21 10:22:34", "created_user": null, "updated_at": "2022-07-21 10:22:34", "updated_user": null }, //*********ここから下に二つ目のデータを入れたい************* { "id": 10, "item_split_id": 3, "no": 2, "sub_item_id": 2, "split_price": 2000, "created_at": "2022-07-21 10:22:34", "created_user": null, "updated_at": "2022-07-21 10:22:34", "updated_user": null }, "created_at": "2022-07-21T09:28:26.000000Z", "created_user": "created_user", "updated_at": "2022-07-21T10:22:34.000000Z", "updated_user": null }

発生している問題・エラーメッセージ

jsonデータを一つにまとめる方法がわからないです。

該当のソースコード

リレーションメソッド

public function item() { return $this->belongsTo(SMItem::class, 'item_id')->withDefault(); } public function splitDetail() { return $this->belongsTo(MItemSplitDetail::class, 'item_id')->withDefault(); }

検索結果取得コード

PHP

1$query = MItemSplit::get(); 2 3 $query = $query->map(function ($getQuery) { 4 $query = [ 5 "id" => $getQuery->id, 6 "item_id" => $getQuery->item_id, 7 "item" => array( 8 "id" => $getQuery->item->id, 9 "code" => $getQuery->item->code, 10 "name" => $getQuery->item->name, 11 ), 12 "item_split_detail" => array( 13 "id" => $getQuery->splitDetail->id, 14 "item_split_id" => $getQuery->splitDetail->item_split_id, 15 "no" => $getQuery->splitDetail->no, 16 "sub_item_id" => $getQuery->splitDetail->sub_item_id, 17 "split_price" => $getQuery->splitDetail->split_price, 18 "created_at" => $getQuery->splitDetail->created_at, 19 "created_user" => $getQuery->splitDetail->created_user, 20 "updated_at" => $getQuery->splitDetail->updated_at, 21 "updated_user" => $getQuery->splitDetail->updated_user, 22 ), 23 "created_at" => $getQuery->created_at, 24 "created_user" => $getQuery->created_user, 25 "updated_at" => $getQuery->updated_at, 26 "updated_user" => $getQuery->updated_user, 27 ]; 28 return $query; 29 }); 30 return $query;

試したこと

mapで加工しようとしましたが、二つデータが出てきてしまっています。

補足情報(FW/ツールのバージョンなど)

Laravel8

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答1

0

ベストアンサー

JSON としての文法

提示されたイメージは,そのままでは JSON としてはシンタックスエラーになるものです。

JSON入門 - とほほのWWW入門

json

1{ 2 "item_split_detail": { 3 }, // ←A 4 {} // ←B 5}

一番外側のオブジェクト {} 直下のエントリは,必ず キー のペアで無ければなりません。 A は item_split_detail というキーに対応していますが,B は対応するキーが存在しないので文法として無効です。

代替案としては,以下のように配列の中に入れてしまうことです。また,配列に対するキーとしては英単語の複数形を採用するのが一般的であるため, item_split_details としています。(逆に, JSON の配列直下の値は文字列のキーを持つことができません。0番目,1番目,…という番目の情報しか与えることができません)

json

1{ 2 "item_split_details": [ 3 {}, // ←A 4 {} // ←B 5 ] 6}

Eloquent としての扱い

…を書こうとしたんですが,テーブル構造が不明であるため,あるべき形を書こうとしても書くのが難しい状態です。現在のテーブル定義を提示していただけませんか?特に, テーブル間のリレーション を重点的に示していただきたいです。 HasMany HasOne BelongsTo BelongsToMany とかのアレです。

※ 蛇足ですが,変数の命名があまり良くないように思えます。 $query とされているものは,実際にはクエリではありません。 クエリを実行して得た結果 です。

(以下追記)

一般的なルールとして,Eloquent は 明示的な JOIN は使用禁止 です。一部使っていいケースはありますが,初心者は基本的には避けたほうが無難ですね。提示されたコードは,根本から直すべきということになります。

SQL は表指向の言語であり,階層構造を表現することに適しておりません。そのため今回のような「共通なものはまとめて子要素にしたい」などの階層構造にしたいニーズが有る場合,表としてそのまま取得する JOIN とクエリビルダを使ったコードを書いてしまうと,ゴールから離れてしまいます。

一方リレーション機能は, SQL を使用してはいるものの,内部的には JOIN は殆ど使わずにバラバラに SQL を発行して取得してくるロジックになります。こちらは取得結果を階層化する整形を自動で行ってくれるため, Eloquent と言えばリレーション ぐらいの感覚でいたほうがよいでしょう。

一度,上記のマニュアルを参考に,各モデル上でリレーションメソッドを定義してみてください。提示された SQL からもまだ

  • A HasMany B: A1個に対してB複数が存在する
  • A HasOne B B BelongsTo A: A1個に対してB1個が存在する

といった情報は読み取れません。

(追記)

推測するに,正しいリレーションはこうじゃないですかね?

php

1class MItemSplit 2{ 3 protected $hidden = []; 4 5 public function item() 6 { 7 return $this->belongsTo(SMItem::class, 'item_id'); 8 } 9 public function itemSplitDetails() 10 { 11 return $this->hasMany(MItemSplitDetail::class, 'item_split_id'); 12 } 13}

php

1$items = MItemSplit::with('item', 'itemSplitDetails')->get(); 2 3var_dump($items->toArray()); //コントローラから返すときは toArray() 不要

投稿2022/07/21 15:02

編集2022/07/22 08:00
mpyw

総合スコア5223

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

Zera8

2022/07/22 00:01

コメントありがとうございます。 現在のコード部分に追記しました。 全てjoinで繋いでいる状況になっております。
mpyw

2022/07/22 02:48

(更新通知飛ばし忘れた気がするのでコメントで) 更新しました!再度内容を確認し,リレーションメソッド実装の提示をお願いします。
Zera8

2022/07/22 05:01

リレーションメソッドとソースを修正しました。 加工の仕方が調べてもわからなかったため、mapのままにしております。。
mpyw

2022/07/22 05:27

再度追記しました。最終的には Http Resource の機能を併用するほうが自由度は高くなりますが,軽く済ませるのであれば Eloquent をそのままコントローラからリターンする形でいいと思います
mpyw

2022/07/22 08:02 編集

また蛇足ですが, Laravel はどちらかというと「設定より規約」指向のフレームワークなので,テーブル名とモデルクラス名は(テーブル名の単数形として)完全に一致させるほうが書きやすいです。おそらくモデルを意味しているであろう `M` などの接頭辞は取っ払ってしまい, `app/Models` ディレクトリの中に集約するだけで十分だと思います
Zera8

2022/07/25 01:31

ご返信が遅くなり、申し訳ございません。 上記を試してみたのですが、itemSplitDetailsの部分でhasOneなら問題なく動作するのですがhasManyを使用すると「Call to undefined relationship [itemSplitDetails] on model [App\Models\MItemSplit].」が表示されてしまうのですが、こちらの原因は何なのか知見があったりしますでしょうか? hasOneでは動く当たりが何故でしたので。。
Zera8

2022/07/25 02:42

itemSplitDetailsにwithDefault を指定していたのが原因でした! 無事動作しました! ありがとうございました!
guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.48%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問