laravelで指定したカラムだけ返却するjsonレスポンスを作成するメソッド

Question

laravelでAPI作成のレスポンスを作成したいのですが、デフォルトでは、jsonレスポンスに全てのカラムが入ってきます。

$companies = Company::all();
return $companies;

[
	{
		"id": 1,
		"name": "A株式会社",
		"stuff_name": "AAA"
	},
	{
		"id": 2,
		"name": "B株式会社",
		"stuff_name": "BBB"
	},
	{
		"id": 3,
		"name": "C株式会社",
		"stuff_name": "CCC"
	},
	{
		"id": 4,
		"name": "D株式会社",
		"stuff_name": "DDD"
	}
]

これを、以下のような感じで、「stuff_name」抜きで表示したいのですがいいメソッドはあるでしょうか？

[
	{
		"id": 1,
		"name": "A株式会社",
	},
	{
		"id": 2,
		"name": "B株式会社",
	},
	{
		"id": 3,
		"name": "C株式会社",
	},
	{
		"id": 4,
		"name": "D株式会社",
	}
]

もちろん、forを回して、unsetとかしたらできないことないんですが、なんかいいメソッッドがありそうな気がして。

ちなみに、pluckをやってみましたが,keyを取得できなくなったんで、やめました。
お分かりでしたら回答お願いします.

Comments

[yambejp]

stuff_nameとstuff_departmentの違いはなんでしょう？
stuff_departmentも抜くのでしょうか？
処理はPHP側でよいのですよね？

[renren643]

間違えました。修正します

>処理はPHP側でよいのですよね？
はい

Answer 1

Laravel的には
Modelに

protected $hidden = ['stuff_name'];

と、隠したいフィールドを列挙しておく事で、toArray/toJsonされる時に
列挙したフィールドを取り除いてくれる。
デフォルトで用意されているUserモデルもパスワードやリメンバートークンをこの方法で隠している

Comments

[退会済みユーザー]

そういえば、この手があった・・・

Answer 2

$companies = Company::query()->select('id', 'name')->get();
return $companies;

---

「stuff_name以外」は指示できるのでしょうか？

動作未検証ですが。

$companies = Company::all()->map(function ($item, $key){
    return $item->pull('stuff_name');
});
return $companies;

https://readouble.com/laravel/6.0/ja/collections.html#method-map
https://readouble.com/laravel/6.0/ja/collections.html#method-pull

Comments

[yambejp]

ちなみに命題のような「stuff_name以外」は指示できるのでしょうか？

Answer 3

この場合はselect()だけで済みそう。

もっと複雑な場合はAPIリソース。
https://readouble.com/laravel/6.0/ja/eloquent-resources.html

Laravelなら大抵のことは用意されてる。

Answer 4

$json=<<<eof
[
    {
        "id": 1,
        "name": "A株式会社",
        "stuff_name": "AAA"
    },
    {
        "id": 2,
        "name": "B株式会社",
        "stuff_department": "BBB"
    },
    {
        "id": 3,
        "name": "C株式会社",
        "stuff_department": "CCC"
    },
    {
        "id": 4,
        "name": "D株式会社",
        "stuff_department": "DDD"
    }
]
eof;
$data=json_decode($json,true);
$data=array_map(function($x){
  return array_filter($x,function($y){
    return !preg_match("/^stuff_/",$y);
  },ARRAY_FILTER_USE_KEY);
},$data);
print_r($data);

調整

stuff_departmentをやめてstuff_nameに統一するということなので以下

<?PHP
$json=<<<eof
[
    {
        "id": 1,
        "name": "A株式会社",
        "stuff_name": "AAA"
    },
    {
        "id": 2,
        "name": "B株式会社",
        "stuff_name": "BBB"
    },
    {
        "id": 3,
        "name": "C株式会社",
        "stuff_name": "CCC"
    },
    {
        "id": 4,
        "name": "D株式会社",
        "stuff_name": "DDD"
    }
]
eof;
$data=json_decode($json,true);
$data=array_map(function($x){
  return array_filter($x,function($y){
    return $y!=="stuff_name";
  },ARRAY_FILTER_USE_KEY);
},$data);
print_r($data);