Skip to content

Latest commit

 

History

History
78 lines (47 loc) · 2.69 KB

pagination.md

File metadata and controls

78 lines (47 loc) · 2.69 KB
Raw

Pagination

Configuration

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.

Usage

There are several ways to paginate items. The simplest is by using the paginate method on the query builder or an Eloquent model.

Paginating Database Results

$users = DB::table('users')->paginate(15);

You may also paginate Eloquent models:

Paginating An Eloquent Model

$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.

You may also access additional pagination information via the following methods:

  • getCurrentPage
  • getLastPage
  • getPerPage
  • getTotal
  • getFrom
  • getTo
  • count

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:

Creating A Paginator Manually

$paginator = Paginator::make($items, $totalItems, $perPage);

Customizing The Paginator URI

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

Appending To Pagination Links

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