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

Paginator

interface Paginator (View source)

Methods

string
url(int $page)

Get the URL for a given page.

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

Add a set of query string values to the paginator.

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

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

$this
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.

items()

No description

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.

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

Render the paginator using a given view.

Details

at line 18
string url(int $page)

Get the URL for a given page.

Parameters

int $page

Return Value

string

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

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

at line 42
$this withQueryString()

Add all current query string values to the paginator.

Return Value

$this

at line 49
string|null nextPageUrl()

The URL for the next page, or null.

Return Value

string|null

at line 56
string|null previousPageUrl()

Get the URL for the previous page, or null.

Return Value

string|null

at line 63
items()

No description

at line 70
int|null firstItem()

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

Return Value

int|null

at line 77
int|null lastItem()

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

Return Value

int|null

at line 84
int perPage()

Determine how many items are being shown per page.

Return Value

int

at line 91
int currentPage()

Determine the current page being paginated.

Return Value

int

at line 98
bool hasPages()

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

Return Value

bool

at line 105
bool hasMorePages()

Determine if there are more items in the data store.

Return Value

bool

at line 112
string|null path()

Get the base path for paginator generated URLs.

Return Value

string|null

at line 119
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

at line 126
bool isNotEmpty()

Determine if the list of items is not empty.

Return Value

bool

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