Laravel provides pagination out of the box for Eloquent Collections, but you can't use that by default on ordinary Collections.
Collections do have the forPage()
method, but it's more low-level, so it doesn't generate pagination links.
So you have to create a LengthAwarePaginator instance. But what if you want the behaviour to be the same as an Eloquent collection? Then use this macro!
The benefit of this is that the syntax and output is almost identical to the Eloquent Collection paginate()
method and so it can (relatively) easily be swapped out for an Eloquent Collection when testing.
Feel free to copy the most relevant code into your project. You're free to use and adapt as you need.
There are 2 approaches below. Which one you use is up to you, but you don't need both. I personally prefer the macro method as I feel it's cleaner and works well with minimal effort, but it's not so good at working with your IDE (code hints etc) and can feel a little detached in some cases.
If you prefer, add the Collection
macro to a Service Provider. That way you can call paginate()
on any collection:
collect([ ... ])->paginate( 20 );
See AppServiceProvider.php
for a sample implementation.
Where you want a "pageable" collection that is distinct from the standard Illuminate\Support\Collection
, implement a copy of Collection.php
in your application and simply replace your use Illuminate\Support\Collection
statements at the top of your dependent files with use App\Support\Collection
:
- use Illuminate\Support\Collection
+ use App\Support\Collection;
$collection = (new Collection([ ... ]))->paginate(20);
Note that this approach won't work with the collect()
helper function.
Spatie have create an awesome Composer package of loads of useful Collection macros. Go check it out!
@hesammoosapour can you define an objective level of ‘more clean’?
This is just a code snippet that you can put wherever you like. I’ve only suggested to put in your
AppServiceProvider
as this is likely to be available for most Laravel applications from a default install.If you want to load some other file into the boot up sequence of your application to register this macro, you’re welcome to do so - it is your application after all 😊
I have tried to get this PR’d into Laravel core, but it was rejected. I believe it’s available in a Spatie package along with a bunch of other potentially-useful macros - that feels quite ‘clean’.