how to add custom(new) column in laravel pagination collection result

Question

I am creating an API and I want to add extra column in the result of pagination query. For example I have price and discount in my database. I want to send discounted_price column with result set.

Here is what I have tried so far:

Controller:

$products = Products::latest()->paginate(10);
if (! empty($products)) {
    $final_prod = [];
    foreach ($products as $product) {
        $final_prod[] = $product->asFilterJson();
    }
    $data['products'] = $final_prod;
    $data['status'] = 200;
} else {
    $data['error'] = "No product available";
}

and in my Products model I have

public function asFilterJson() {
    $json = [];
    $json['id'] = $this->id;
    $json['title'] = $this->title;
    $json['category_id'] = $this->category_id;
    $json['price'] = $this->price;
    $json['description'] = $this->description;
    $json['quantity'] = $this->quantity;
    $json['discount'] = $this->discount;
    $json['type_id'] = $this->type_id;
    $json['created_by_id'] = $this->created_by_id;
    $json['created_at'] = $this->created_at;
    $json['updated_at'] = $this->updated_at;
    if($this->type_id == self::ITEM_SPECIAL) {
        $json['discounted_price'] = ($this->discount * $this->price) / 100;    }
    return $json;
}

It works fine but it removes the pagination.

Create a new collection, and use $products->merge(...); – Milkmannetje Dec 31 '18 at 10:51 — Milkmannetje, Dec 31 '18 at 10:51
please add the code that you are returning from controller – Shibon Dec 31 '18 at 11:06 — Shibon, Dec 31 '18 at 11:06

score 4 · Accepted Answer · answered Dec 31 '18 at 11:31

you can add key and value in collection object by using map method

$products = Products::latest()->paginate(10);

$itemSpecial = self::ITEM_SPECIAL; //pass variable in closure by using use 

$products->map(function($item) use ($itemSpecial) {
     if($item->type_id == $itemSpecial) {
        $item->discounted_price = ($item->discount * $item->price) / 100; 
     }
     return $item;
});

you can used condition also in clourse

score 0 · Answer 2 · answered Dec 31 '18 at 11:31

In Controller

public function index() {
     $products = Products::latest()->paginate(10);
     if (! empty($products)) {
        $final_prod = [];
        foreach ($products as $product) {
             $final_prod[] = $this->asFilterJson($product);
        }
        return response()->json(['status'=>'200','message'=>'Product list ','data'=>$final_prod]);
     } else {
        return response()->json(['status'=>'200','message'=>'No product available','data'=>[]]);
     }
}
// function for extra column add
static function asFilterJson($product){
    $value['discounted_price'] = ($value['discount'] * $value['price']) / 100;
    return $value;
}

score -2 · Answer 3 · answered Dec 31 '18 at 11:19

-2

You can define new mutator in your model.

public function getDiscountedPriceAttribute()
{
     return ($this->discount * $this->price) / 100;
}

After than, you can use it as $this->discountedPrice

answered Dec 31 '18 at 11:19

FGDeveloper

1,030
9
23

let me check this – Ashish Dec 31 '18 at 11:31
yes. Jignesh answer is helpful and solved my question – Ashish Jan 02 '19 at 07:37

how to add custom(new) column in laravel pagination collection result

3 Answers3