Rename laravel collection "data" key

Question

Is there way i can rename the data key in laravel collection results? At the moment this

DB::table('contracts AS C')->paginate(1)

returns

  {
  "current_page": 1,
    "data": [
        {
            "id": 191,
            "buyer": "John",
            "provider": "Jane"
        }
    ],
    "from": 1,
    "last_page": 1,
    "next_page_url": "",
    "path": "",
    "per_page": 1,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

What i would like is this

  {
  "current_page": 1,
    "parties": [
        {
            "id": 191,
            "buyer": "John",
            "provider": "Jane"
        }
    ],
    "from": 1,
    "last_page": 1,
    "next_page_url": "",
    "path": "",
    "per_page": 1,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

The challenge here changing the data key to parties

Have you solved this? I have the same problem – Paranoid Android Oct 23 '17 at 11:59 — Paranoid Android, Oct 23 '17 at 11:59

linktoahref · Answer 1 · 2017-07-05T05:13:04.900

7

You could use the keyBy() method of collection.

$unfiltered = DB::table('contracts AS C')->paginate(1);

$filtered = $unfiltered->keyBy(function ($value, $key) {
     if ($key == 'data') {
         return 'parties';
     } else {
         return $key;
     }
});

return $filtered;

edited Jul 05 '17 at 05:13

answered Jul 04 '17 at 13:36

linktoahref

7,812
3
29
51

This returns an empty object – Cengkuru Michael Jul 04 '17 at 13:42
it is not the desired result. The edited solution creates extra empty object along with the results. – Cengkuru Michael Jul 04 '17 at 15:24
@CengkuruMichael : If you'd want to alter the original collection keys, use the `keyBy` method instead – linktoahref Jul 05 '17 at 05:13

score 1 · Answer 2 · answered Oct 23 '17 at 12:59

You could just convert the collection to array and manipulate it:

$result = DB::table('contracts AS C')->paginate(1)->toArray();
$data = $result['data'];
unset($result['data']);
$result['parties'] = $data;

return $result;

This does not require any extra loops either.

score 0 · Answer 3 · answered Jul 04 '17 at 14:08

The data key is only set when the Paginator object toArray() is called. Before that it's a Collection with the key items.

Quick and dirty solution would be to call toArray() on the Paginator object and change the key name of the array before the json_encode().

Another solution would be to extend the Builder class, much like it's done here, overwrite the paginate() method and Paginator's toArray() method.

score 0 · Answer 4 · answered Nov 18 '21 at 07:33

0

you can return data with below code :

$coins = CoinResource::collection(Cryptocurrency::all());
return ['your_custom_name' => $coins];

answered Nov 18 '21 at 07:33

Mohammad Sadeghyan

68
7

Rename laravel collection "data" key

4 Answers4

Linked