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

Paginator

interface Paginator

Methods

string
url(int $page)

Get the URL for a given page.

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

Add a set of query string values to the paginator.

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

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

Paginator
withQueryString()

Add all current query string values to the paginator.

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|null
firstItem()

Get the "index" of the first item being paginated.

int|null
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.

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 21
string url(int $page)

Get the URL for a given page.

Parameters

int $page

Return Value

string

at line 28
Paginator 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

Paginator

at line 38
Paginator|string|null fragment(string|null $fragment = null)

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

Parameters

string|null $fragment

Return Value

Paginator|string|null

at line 45
Paginator withQueryString()

Add all current query string values to the paginator.

Return Value

Paginator

at line 50
string|null nextPageUrl()

The URL for the next page, or null.

Return Value

string|null

at line 55
string|null previousPageUrl()

Get the URL for the previous page, or null.

Return Value

string|null

at line 62
array items()

Get all of the items being paginated.

Return Value

array

at line 67
int|null firstItem()

Get the "index" of the first item being paginated.

Return Value

int|null

at line 72
int|null lastItem()

Get the "index" of the last item being paginated.

Return Value

int|null

at line 77
int perPage()

Determine how many items are being shown per page.

Return Value

int

at line 82
int currentPage()

Determine the current page being paginated.

Return Value

int

at line 87
bool hasPages()

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

Return Value

bool

at line 92
bool hasMorePages()

Determine if there are more items in the data store.

Return Value

bool

at line 97
string|null path()

Get the base path for paginator generated URLs.

Return Value

string|null

at line 102
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

at line 107
bool isNotEmpty()

Determine if the list of items is not empty.

Return Value

bool

at line 114
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 16
$this through(TValue): $ixed $callback)

No description

Parameters

TValue): $ixed $callback

Return Value

$this