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|null $key, string|null $value = null)

Add a set of query string values to the paginator.

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

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

from  Paginator
$this
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
items()

No description

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

Get the URL for a given page.

Parameters

int $page

Return Value

string

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

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

in Paginator at line 42
$this withQueryString()

Add all current query string values to the paginator.

Return Value

$this

in Paginator at line 49
string|null nextPageUrl()

The URL for the next page, or null.

Return Value

string|null

in Paginator at line 56
string|null previousPageUrl()

Get the URL for the previous page, or null.

Return Value

string|null

in Paginator at line 63
items()

No description

in Paginator at line 70
int|null firstItem()

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

Return Value

int|null

in Paginator at line 77
int|null lastItem()

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

Return Value

int|null

in Paginator at line 84
int perPage()

Determine how many items are being shown per page.

Return Value

int

in Paginator at line 91
int currentPage()

Determine the current page being paginated.

Return Value

int

in Paginator at line 98
bool hasPages()

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

Return Value

bool

in Paginator at line 105
bool hasMorePages()

Determine if there are more items in the data store.

Return Value

bool

in Paginator at line 112
string|null path()

Get the base path for paginator generated URLs.

Return Value

string|null

in Paginator at line 119
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

in Paginator at line 126
bool isNotEmpty()

Determine if the list of items is not empty.

Return Value

bool

in Paginator at line 135
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 21
array getUrlRange(int $start, int $end)

Create a range of pagination URLs.

Parameters

int $start
int $end

Return Value

array

at line 28
int total()

Determine the total number of items in the data store.

Return Value

int

at line 35
int lastPage()

Get the page number of the last available page.

Return Value

int