<?php

namespace App\Http\Controllers;

use App\User;
use Illuminate\Http\Request;

class PaginationController extends Controller
{

    /**
     * @param Request $request
     * @return mixed
     */
    public function index(Request $request)
    {
        // Results per page
        $limit = 50;

        // Creates an instance of Illuminate\Pagination\LengthAwarePaginator
        $users = User::paginate($limit);

        // getCollection() is a mathod available in Illuminate\Pagination\LengthAwarePaginator
        // It retrivies the Collection instance the Paginator will iterate over, allowing you to
        // use Collection methods. transform() modifies the collection itself.
        $users->getCollection()->transform(function($user, $key) {
            return [
                'name' => $user->name,
                'email' => $user->email,
                'custom_attribute' => 'custom value',
            ];
        });

        return $result;
    }

}