In other frameworks, pagination can be very painful. Laravel makes it a breeze. There is a single configuration option in the app/config/view.php file. The pagination option specifies which view should be used to create pagination links. By default, Laravel includes two views.
The pagination::slider view will show an intelligent "range" of links based on the current page, while the pagination::simple view will simply show "previous" and "next" buttons. Both views are compatible with Twitter Bootstrap out of the box.
There are several ways to paginate items. The simplest is by using the paginate method on the query builder or an Eloquent model.
$users = DB::table('users')->paginate(15);
You may also paginate Eloquent models:
$allUsers = User::paginate(15);
$someUsers = User::where('votes', '>', 100)->paginate(15);
The argument passed to the paginate method is the number of items you wish to display per page. Once you have retrieved the results, you may display them on your view, and create the pagination links using the links method:
<div class="container">
<?php foreach ($users as $user): ?>
<?php echo $user->name; ?>
<?php endforeach; ?>
</div>
<?php echo $users->links(); ?>
This is all it takes to create a pagination system! Note that we did not have to inform the framework of the current page. Laravel will determine this for you automatically.
If you would like to specify a custom view to use for pagination, you may pass a view to the links method:
<?php echo $users->links('view.name'); ?>
You may also access additional pagination information via the following methods:
getCurrentPagegetLastPagegetPerPagegetTotalgetFromgetTocount
Sometimes you may wish to create a pagination instance manually, passing it an array of items. You may do so using the Paginator::make method:
$paginator = Paginator::make($items, $totalItems, $perPage);
You may also customize the URI used by the paginator via the setBaseUrl method:
$users = User::paginate();
$users->setBaseUrl('custom/url');
The example above will create URLs like the following: http://example.com/custom/url?page=2
You can add to the query string of pagination links using the appends method on the Paginator:
<?php echo $users->appends(array('sort' => 'votes'))->links(); ?>
This will generate URLs that look something like this:
http://example.com/something?page=2&sort=votes
If you wish to append a "hash fragment" to the paginator's URLs, you may use the fragment method:
<?php echo $users->fragment('foo')->links(); ?>
This method call will generate URLs that look something like this:
http://example.com/something?page=2#foo
The Paginator class implements the Illuminate\Support\Contracts\JsonableInterface contract and exposes the toJson method. You can may also convert a Paginator instance to JSON by returning it from a route. The JSON'd form of the instance will include some "meta" information such as total, current_page, last_page, from, and to. The instance's data will be available via the data key in the JSON array.
The default pagination presenter is Bootstrap compatible out of the box; however, you may customize this with a presenter of your choice.
Extend the Illuminate\Pagination\Presenter class and implement its abstract methods. An example presenter for Zurb Foundation might look like this:
class ZurbPresenter extends Illuminate\Pagination\Presenter {
public function getActivePageWrapper($text)
{
return '<li class="current">'.$text.'</li>';
}
public function getDisabledTextWrapper($text)
{
return '<li class="unavailable">'.$text.'</li>';
}
public function getPageLinkWrapper($url, $page)
{
return '<li><a href="'.$url.'">'.$page.'</a></li>';
}
}
First, create a view in your app/views directory that will server as your custom presenter. Then, replace pagination option in the app/config/view.php configuration file with the new view's name. Finally, the following code would be placed in your custom presenter view:
<ul class="pagination">
<?php echo with(new ZurbPresenter($paginator))->render(); ?>
</ul>