Paginator
interface Paginator (View source)
Methods
| string | url(int $page) Get the URL for a given page. | |
| $this | appends(array|string $key, string|null $value = null) Add a set of query string values to the paginator. | |
| $this|string | fragment(string|null $fragment = null) Get / set the URL fragment to be appended to URLs. | |
| string|null | nextPageUrl() The URL for the next page, or null. | |
| string|null | previousPageUrl() Get the URL for the previous page, or null. | |
| array | items() Get all of the items being paginated. | |
| int | firstItem() Get the "index" of the first item being paginated. | |
| int | lastItem() Get the "index" of the last item being paginated. | |
| int | perPage() Determine how many items are being shown per page. | |
| int | currentPage() Determine the current page being paginated. | |
| bool | hasPages() Determine if there are enough items to split into multiple pages. | |
| bool | hasMorePages() Determine if there are more items in the data store. | |
| string|null | path() Get the base path for paginator generated URLs. | |
| bool | isEmpty() Determine if the list of items is empty or not. | |
| bool | isNotEmpty() Determine if the list of items is not empty. | |
| string | render(string|null $view = null, array $data = []) Render the paginator using a given view. |
Details
string url(int $page)
Get the URL for a given page.
$this appends(array|string $key, string|null $value = null)
Add a set of query string values to the paginator.
$this|string fragment(string|null $fragment = null)
Get / set the URL fragment to be appended to URLs.
string|null nextPageUrl()
The URL for the next page, or null.
string|null previousPageUrl()
Get the URL for the previous page, or null.
array items()
Get all of the items being paginated.
int firstItem()
Get the "index" of the first item being paginated.
int lastItem()
Get the "index" of the last item being paginated.
int perPage()
Determine how many items are being shown per page.
int currentPage()
Determine the current page being paginated.
bool hasPages()
Determine if there are enough items to split into multiple pages.
bool hasMorePages()
Determine if there are more items in the data store.
string|null path()
Get the base path for paginator generated URLs.
bool isEmpty()
Determine if the list of items is empty or not.
bool isNotEmpty()
Determine if the list of items is not empty.
string render(string|null $view = null, array $data = [])
Render the paginator using a given view.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Contracts/Pagination/Paginator.html