W3cubDocs

/Laravel 11

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.

Parameters

Cursor|null $cursor

Return Value

string

$this appends(array|string|null $key, string|null $value = null)

Add a set of query string values to the paginator.

Parameters

array|string|null $key
string|null $value

Return Value

$this

$this|string|null fragment(string|null $fragment = null)

Get / set the URL fragment to be appended to URLs.

Parameters

string|null $fragment

Return Value

$this|string|null

$this withQueryString()

Add all current query string values to the paginator.

Return Value

$this

string|null previousPageUrl()

Get the URL for the previous page, or null.

Return Value

string|null

string|null nextPageUrl()

The URL for the next page, or null.

Return Value

string|null

array items()

Get all of the items being paginated.

Return Value

array

Cursor|null previousCursor()

Get the "cursor" of the previous set of items.

Return Value

Cursor|null

Cursor|null nextCursor()

Get the "cursor" of the next set of items.

Return Value

Cursor|null

int perPage()

Determine how many items are being shown per page.

Return Value

int

Cursor|null cursor()

Get the current cursor being paginated.

Return Value

Cursor|null

bool hasPages()

Determine if there are enough items to split into multiple pages.

Return Value

bool

string|null path()

Get the base path for paginator generated URLs.

Return Value

string|null

bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

bool isNotEmpty()

Determine if the list of items is not empty.

Return Value

bool

string render(string|null $view = null, array $data = [])

Render the paginator using a given view.

Parameters

string|null $view
array $data

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Contracts/Pagination/CursorPaginator.html