CursorPaginator
interface CursorPaginator (View source)
Methods
| string | url(Cursor|null $cursor) Get the URL for a given cursor. |
|
| $this | appends(array|string|null $key, string|null $value = null) Add a set of query string values to the paginator. |
|
| $this|string|null | fragment(string|null $fragment = null) Get / set the URL fragment to be appended to URLs. |
|
| $this | withQueryString() Add all current query string values to the paginator. |
|
| string|null | previousPageUrl() Get the URL for the previous page, or null. |
|
| string|null | nextPageUrl() The URL for the next page, or null. |
|
| array | items() Get all of the items being paginated. |
|
| Cursor|null | previousCursor() Get the "cursor" of the previous set of items. |
|
| Cursor|null | nextCursor() Get the "cursor" of the next set of items. |
|
| int | perPage() Determine how many items are being shown per page. |
|
| Cursor|null | cursor() Get the current cursor being paginated. |
|
| bool | hasPages() Determine if there are enough items to split into multiple pages. |
|
| 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(Cursor|null $cursor)
Get the URL for a given cursor.
$this appends(array|string|null $key, string|null $value = null)
Add a set of query string values to the paginator.
$this|string|null fragment(string|null $fragment = null)
Get / set the URL fragment to be appended to URLs.
$this withQueryString()
Add all current query string values to the paginator.
string|null previousPageUrl()
Get the URL for the previous page, or null.
string|null nextPageUrl()
The URL for the next page, or null.
array items()
Get all of the items being paginated.
Cursor|null previousCursor()
Get the "cursor" of the previous set of items.
Cursor|null nextCursor()
Get the "cursor" of the next set of items.
int perPage()
Determine how many items are being shown per page.
Cursor|null cursor()
Get the current cursor being paginated.
bool hasPages()
Determine if there are enough items to split into multiple pages.
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/10.x/Illuminate/Contracts/Pagination/CursorPaginator.html