1. interface
  2. Illuminate
  3. Contracts
  4. Pagination
  5. Paginator

Paginator

interface Paginator (View source)

Methods

string
url( int $page)

Get the URL for a given page.

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

Add a set of query string values to the paginator.

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

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

string|null
nextPageUrl()

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

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

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

bool
isEmpty()

Determine if the list of items is empty or not.

string
render( Presenter $presenter = null)

Render the paginator using a given Presenter.

Details

at line line 13
string url( int $page)

Get the URL for a given page.

Parameters

int $page

Return Value

string

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

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

at line line 37
string|null nextPageUrl()

The the URL for the next page, or null.

Return Value

string|null

at line line 44
string|null previousPageUrl()

Get the URL for the previous page, or null.

Return Value

string|null

at line line 51
array items()

Get all of the items being paginated.

Return Value

array

at line line 58
int firstItem()

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

Return Value

int

at line line 65
int lastItem()

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

Return Value

int

at line line 72
int perPage()

Determine how many items are being shown per page.

Return Value

int

at line line 79
int currentPage()

Determine the current page being paginated.

Return Value

int

at line line 86
bool hasPages()

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

Return Value

bool

at line line 93
bool hasMorePages()

Determine if there is more items in the data store.

Return Value

bool

at line line 100
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

at line line 108
string render( Presenter $presenter = null)

Render the paginator using a given Presenter.

Parameters

Presenter $presenter

Return Value

string