1. interface
  2. Hypervel
  3. \
  4. Contracts
  5. \
  6. Pagination
  7. \
  8. CursorPaginator

CursorPaginator

interface CursorPaginator

Methods

string
url(Cursor|null $cursor)

Get the URL for a given cursor.

CursorPaginator
appends(array|int|string|null $key, array|bool|float|int|string|null $value = null)

Add a set of query string values to the paginator.

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

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

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

bool
hasMorePages()

Determine if there are more items in the data source.

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.

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

Render the paginator using a given view.

$this
through(TValue): $ixed $callback)

No description

Details

at line 22
string url(Cursor|null $cursor)

Get the URL for a given cursor.

Parameters

Cursor|null $cursor

Return Value

string

at line 29
CursorPaginator appends(array|int|string|null $key, array|bool|float|int|string|null $value = null)

Add a set of query string values to the paginator.

Parameters

array|int|string|null $key
array|bool|float|int|string|null $value

Return Value

CursorPaginator

at line 39
CursorPaginator|string|null fragment(string|null $fragment = null)

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

Parameters

string|null $fragment

Return Value

CursorPaginator|string|null

at line 46
CursorPaginator withQueryString()

Add all current query string values to the paginator.

Return Value

CursorPaginator

at line 51
string|null previousPageUrl()

Get the URL for the previous page, or null.

Return Value

string|null

at line 56
string|null nextPageUrl()

The URL for the next page, or null.

Return Value

string|null

at line 63
array items()

Get all of the items being paginated.

Return Value

array

at line 68
Cursor|null previousCursor()

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

Return Value

Cursor|null

at line 73
Cursor|null nextCursor()

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

Return Value

Cursor|null

at line 78
int perPage()

Determine how many items are being shown per page.

Return Value

int

at line 83
Cursor|null cursor()

Get the current cursor being paginated.

Return Value

Cursor|null

at line 88
bool hasPages()

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

Return Value

bool

at line 93
bool hasMorePages()

Determine if there are more items in the data source.

Return Value

bool

at line 98
string|null path()

Get the base path for paginator generated URLs.

Return Value

string|null

at line 103
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

at line 108
bool isNotEmpty()

Determine if the list of items is not empty.

Return Value

bool

at line 115
Htmlable render(string|null $view = null, array $data = [])

Render the paginator using a given view.

Parameters

string|null $view
array $data

Return Value

Htmlable

at line 17
$this through(TValue): $ixed $callback)

No description

Parameters

TValue): $ixed $callback

Return Value

$this