Pagination
1. Pagination using Laravel's ORM
The illuminate/database
package of Laravel provides convenient pagination functionality.
Installation
Run the following command to install the package:
composer require illuminate/pagination
Usage
public function index(Request $request)
{
$per_page = 10;
$users = Db::table('user')->paginate($per_page);
return view('index/index', ['users' => $users]);
}
Paginator Instance Methods
Method | Description |
---|---|
$paginator->count() | Get the total number of items for the current page. |
$paginator->currentPage() | Get the current page number. |
$paginator->firstItem() | Get the number of the first item in the results. |
$paginator->getOptions() | Get the paginator's options. |
$paginator->getUrlRange($start, $end) | Get the URL for a given page range. |
$paginator->hasPages() | Determine if there are enough items to split into multiple pages. |
$paginator->hasMorePages() | Determine if there are more items in the result set. |
$paginator->items() | Get the items for the current page. |
$paginator->lastItem() | Get the number of the last item in the results. |
$paginator->lastPage() | Get the last page number (not available for simplePaginate). |
$paginator->nextPageUrl() | Get the URL for the next page. |
$paginator->onFirstPage() | Determine if the paginator is on the first page. |
$paginator->perPage() | Get the number of items to display per page. |
$paginator->previousPageUrl() | Get the URL for the previous page. |
$paginator->total() | Get the total number of items in the result set (not available for simplePaginate). |
$paginator->url($page) | Get the URL for a specific page. |
$paginator->getPageName() | Get the query string key used by the paginator. |
$paginator->setPageName($name) | Set the query string key used by the paginator. |
Note:
The$paginator->links()
method is not supported.
Pagination Component
In webman, the $paginator->links()
method cannot be used to render pagination buttons. Instead, you can use other components to render it, for example jasongrimes/php-paginator
.
Installation
Run the following command to install the package:
composer require "jasongrimes/paginator:~1.0"
Backend
<?php
namespace app\controller;
use JasonGrimes\Paginator;
use support\Request;
use support\Db;
class UserController
{
public function get(Request $request)
{
$per_page = 10;
$current_page = $request->input('page', 1);
$users = Db::table('user')->paginate($per_page, '*', 'page', $current_page);
$paginator = new Paginator($users->total(), $per_page, $current_page, '/user/get?page=(:num)');
return view('user/get', ['users' => $users, 'paginator' => $paginator]);
}
}
Template (PHP Native)
Create a new template app/view/user/get.html
<html>
<head>
<!-- Built-in support for Bootstrap pagination styles -->
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
</head>
<body>
<?= $paginator; ?>
</body>
</html>
Template (Twig)
Create a new template app/view/user/get.html
<html>
<head>
<!-- Built-in support for Bootstrap pagination styles -->
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
</head>
<body>
{% autoescape false %}
{{paginator}}
{% endautoescape %}
</body>
</html>
Template (Blade)
Create a new template app/view/user/get.blade.php
<html>
<head>
<!-- Built-in support for Bootstrap pagination styles -->
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
</head>
<body>
{!! $paginator !!}
</body>
</html>
Template (ThinkPHP)
Create a new template app/view/user/get.html
<html>
<head>
<!-- Built-in support for Bootstrap pagination styles -->
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
</head>
<body>
<?=$paginator?>
</body>
</html>
The result is as shown in the image below:
2. Pagination using ThinkPHP's ORM
There is no need to install additional libraries, as long as think-orm is installed.
Usage
public function index(Request $request)
{
$per_page = 10;
$users = Db::table('user')->paginate(['list_rows' => $per_page, 'page' => $request->get('page', 1), 'path' => $request->path()]);
return view('index/index', ['users' => $users]);
}
Template (ThinkPHP)
<html>
<head>
<!-- Built-in support for Bootstrap pagination styles -->
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
</head>
<body>
{$users|raw}
</body>
</html>