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

LengthAwarePaginator

interface LengthAwarePaginator implements Paginator (View source)

Methods

string
url(int $page)

Get the URL for a given page.

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

Add a set of query string values to the paginator.

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

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

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

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

from Paginator
int
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 is more items in the data store.

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
string
render(string|null $view = null, array $data = [])

Render the paginator using a given view.

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

Get the URL for a given page.

Parameters

int $page

Return Value

string

in Paginator at line 22
$this appends(array|string $key, string|null $value = null)

Add a set of query string values to the paginator.

Parameters

array|string $key
string|null $value

Return Value

$this

in Paginator at line 30
$this|string fragment(string|null $fragment = null)

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

Parameters

string|null $fragment

Return Value

$this|string

in Paginator at line 37
string|null nextPageUrl()

The URL for the next page, or null.

Return Value

string|null

in Paginator at line 44
string|null previousPageUrl()

Get the URL for the previous page, or null.

Return Value

string|null

in Paginator at line 51
array items()

Get all of the items being paginated.

Return Value

array

in Paginator at line 58
int firstItem()

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

Return Value

int

in Paginator at line 65
int lastItem()

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

Return Value

int

in Paginator at line 72
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 86
bool hasPages()

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

Return Value

bool

in Paginator at line 93
bool hasMorePages()

Determine if there is more items in the data store.

Return Value

bool

in Paginator at line 100
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

in Paginator at line 107
bool isNotEmpty()

Determine if the list of items is not empty.

Return Value

bool

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

Render the paginator using a given view.

Parameters

string|null $view
array $data

Return Value

string

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

Create a range of pagination URLs.

Parameters

int $start
int $end

Return Value

array

at line 21
int total()

Determine the total number of items in the data store.

Return Value

int

at line 28
int lastPage()

Get the page number of the last available page.

Return Value

int