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

LengthAwarePaginator

interface LengthAwarePaginator implements Paginator

Methods

string
url(int $page)

Get the URL for a given page.

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

Add a set of query string values to the paginator.

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

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

from  Paginator
Paginator
withQueryString()

Add all current query string values to the paginator.

from  Paginator
string|null
nextPageUrl()

The URL for the next page, or null.

from  Paginator
string|null
previousPageUrl()

Get the URL for the previous page, or null.

from  Paginator
array
items()

Get all of the items being paginated.

from  Paginator
int|null
firstItem()

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

from  Paginator
int|null
lastItem()

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

from  Paginator
int
perPage()

Determine how many items are being shown per page.

from  Paginator
int
currentPage()

Determine the current page being paginated.

from  Paginator
bool
hasPages()

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

from  Paginator
bool
hasMorePages()

Determine if there are more items in the data store.

from  Paginator
string|null
path()

Get the base path for paginator generated URLs.

from  Paginator
bool
isEmpty()

Determine if the list of items is empty or not.

from  Paginator
bool
isNotEmpty()

Determine if the list of items is not empty.

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

Render the paginator using a given view.

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

No description

from  Paginator
array
getUrlRange(int $start, int $end)

Create a range of pagination URLs.

int
total()

Determine the total number of items in the data store.

int
lastPage()

Get the page number of the last available page.

Details

in Paginator at line 21
string url(int $page)

Get the URL for a given page.

Parameters

int $page

Return Value

string

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

Paginator

in Paginator at line 35
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

in Paginator at line 42
Paginator withQueryString()

Add all current query string values to the paginator.

Return Value

Paginator

in Paginator at line 47
string|null nextPageUrl()

The URL for the next page, or null.

Return Value

string|null

in Paginator at line 52
string|null previousPageUrl()

Get the URL for the previous page, or null.

Return Value

string|null

in Paginator at line 59
array items()

Get all of the items being paginated.

Return Value

array

in Paginator at line 64
int|null firstItem()

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

Return Value

int|null

in Paginator at line 69
int|null lastItem()

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

Return Value

int|null

in Paginator at line 74
int perPage()

Determine how many items are being shown per page.

Return Value

int

in Paginator at line 79
int currentPage()

Determine the current page being paginated.

Return Value

int

in Paginator at line 84
bool hasPages()

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

Return Value

bool

in Paginator at line 89
bool hasMorePages()

Determine if there are more items in the data store.

Return Value

bool

in Paginator at line 94
string|null path()

Get the base path for paginator generated URLs.

Return Value

string|null

in Paginator at line 99
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

in Paginator at line 104
bool isNotEmpty()

Determine if the list of items is not empty.

Return Value

bool

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

Render the paginator using a given view.

Parameters

string|null $view
array $data

Return Value

Htmlable

in Paginator at line 16
$this through(TValue): $ixed $callback)

No description

Parameters

TValue): $ixed $callback

Return Value

$this

at line 21
array getUrlRange(int $start, int $end)

Create a range of pagination URLs.

Parameters

int $start
int $end

Return Value

array

at line 26
int total()

Determine the total number of items in the data store.

Return Value

int

at line 31
int lastPage()

Get the page number of the last available page.

Return Value

int