1. class
  2. Illuminate
  3. Pagination
  4. LengthAwarePaginator

LengthAwarePaginator

class LengthAwarePaginator extends AbstractPaginator implements Arrayable, ArrayAccess, Countable, IteratorAggregate, JsonSerializable, Jsonable, LengthAwarePaginator (View source)

Methods

string
getUrlRange( int $start, int $end)

Create a range of pagination URLs.

from AbstractPaginator
string
url( int $page)

Get a URL for a given page number.

from AbstractPaginator
string|null
previousPageUrl()

Get the URL for the previous page.

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

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

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

Add a set of query string values to the paginator.

from AbstractPaginator
$this
addQuery( string $key, string $value)

Add a query string value to the paginator.

from AbstractPaginator
array
items()

Get the slice of items being paginated.

from AbstractPaginator
int
firstItem()

Get the number of the first item in the slice.

from AbstractPaginator
int
lastItem()

Get the number of the last item in the slice.

from AbstractPaginator
int
perPage()

Get the number of items shown per page.

from AbstractPaginator
int
currentPage()

Get the current page.

from AbstractPaginator
bool
hasPages()

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

from AbstractPaginator
static  string
resolveCurrentPath( string $default = '/')

Resolve the current request path or return the default value.

from AbstractPaginator
static  void
currentPathResolver( Closure $resolver)

Set the current request path resolver callback.

from AbstractPaginator
static  int
resolveCurrentPage( string $pageName = 'page', int $default = 1)

Resolve the current page or return the default value.

from AbstractPaginator
static  void
currentPageResolver( Closure $resolver)

Set the current page resolver callback.

from AbstractPaginator
static  void
presenter( Closure $resolver)

Set the default Presenter resolver.

from AbstractPaginator
string
getPageName()

Get the query string variable used to store the page.

from AbstractPaginator
$this
setPageName( string $name)

Set the query string variable used to store the page.

from AbstractPaginator
$this
setPath( string $path)

Set the base path to assign to all URLs.

from AbstractPaginator
ArrayIterator
getIterator()

Get an iterator for the items.

from AbstractPaginator
bool
isEmpty()

Determine if the list of items is empty or not.

from AbstractPaginator
int
count()

Get the number of items for the current page.

from AbstractPaginator
Collection
getCollection()

Get the paginator's underlying collection.

from AbstractPaginator
$this
setCollection( Collection $collection)

Set the paginator's underlying collection.

from AbstractPaginator
bool
offsetExists( mixed $key)

Determine if the given item exists.

from AbstractPaginator
mixed
offsetGet( mixed $key)

Get the item at the given offset.

from AbstractPaginator
void
offsetSet( mixed $key, mixed $value)

Set the item at the given offset.

from AbstractPaginator
void
offsetUnset( mixed $key)

Unset the item at the given key.

from AbstractPaginator
string
toHtml()

Render the contents of the paginator to HTML.

from AbstractPaginator
mixed
__call( string $method, array $parameters)

Make dynamic calls into the collection.

from AbstractPaginator
string
__toString()

Render the contents of the paginator when casting to string.

from AbstractPaginator
void
__construct( mixed $items, int $total, int $perPage, int|null $currentPage = null, array $options = array())

Create a new paginator instance.

string|null
nextPageUrl()

Get the URL for the next page.

bool
hasMorePages()

Determine if there are more items in the data source.

int
total()

Get the total number of items being paginated.

int
lastPage()

Get the last page.

string
links( Presenter $presenter = null)

Render the paginator using the given presenter.

string
render( Presenter $presenter = null)

Render the paginator using the given presenter.

array
toArray()

Get the instance as an array.

array
jsonSerialize()

Convert the object into something JSON serializable.

string
toJson( int $options)

Convert the object to its JSON representation.

Details

in AbstractPaginator at line line 101
string getUrlRange( int $start, int $end)

Create a range of pagination URLs.

Parameters

int $start
int $end

Return Value

string

in AbstractPaginator at line line 118
string url( int $page)

Get a URL for a given page number.

Parameters

int $page

Return Value

string

in AbstractPaginator at line line 144
string|null previousPageUrl()

Get the URL for the previous page.

Return Value

string|null

in AbstractPaginator at line line 157
$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 AbstractPaginator at line line 175
$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 AbstractPaginator at line line 206
$this addQuery( string $key, string $value)

Add a query string value to the paginator.

Parameters

string $key
string $value

Return Value

$this

in AbstractPaginator at line line 230
array items()

Get the slice of items being paginated.

Return Value

array

in AbstractPaginator at line line 240
int firstItem()

Get the number of the first item in the slice.

Return Value

int

in AbstractPaginator at line line 254
int lastItem()

Get the number of the last item in the slice.

Return Value

int

in AbstractPaginator at line line 268
int perPage()

Get the number of items shown per page.

Return Value

int

in AbstractPaginator at line line 278
int currentPage()

Get the current page.

Return Value

int

in AbstractPaginator at line line 288
bool hasPages()

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

Return Value

bool

in AbstractPaginator at line line 299
static string resolveCurrentPath( string $default = '/')

Resolve the current request path or return the default value.

Parameters

string $default

Return Value

string

in AbstractPaginator at line line 314
static void currentPathResolver( Closure $resolver)

Set the current request path resolver callback.

Parameters

Closure $resolver

Return Value

void

in AbstractPaginator at line line 326
static int resolveCurrentPage( string $pageName = 'page', int $default = 1)

Resolve the current page or return the default value.

Parameters

string $pageName
int $default

Return Value

int

in AbstractPaginator at line line 341
static void currentPageResolver( Closure $resolver)

Set the current page resolver callback.

Parameters

Closure $resolver

Return Value

void

in AbstractPaginator at line line 352
static void presenter( Closure $resolver)

Set the default Presenter resolver.

Parameters

Closure $resolver

Return Value

void

in AbstractPaginator at line line 362
string getPageName()

Get the query string variable used to store the page.

Return Value

string

in AbstractPaginator at line line 373
$this setPageName( string $name)

Set the query string variable used to store the page.

Parameters

string $name

Return Value

$this

in AbstractPaginator at line line 386
$this setPath( string $path)

Set the base path to assign to all URLs.

Parameters

string $path

Return Value

$this

in AbstractPaginator at line line 398
ArrayIterator getIterator()

Get an iterator for the items.

Return Value

ArrayIterator

in AbstractPaginator at line line 408
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

in AbstractPaginator at line line 418
int count()

Get the number of items for the current page.

Return Value

int

in AbstractPaginator at line line 428
Collection getCollection()

Get the paginator's underlying collection.

Return Value

Collection

in AbstractPaginator at line line 439
$this setCollection( Collection $collection)

Set the paginator's underlying collection.

Parameters

Collection $collection

Return Value

$this

in AbstractPaginator at line line 452
bool offsetExists( mixed $key)

Determine if the given item exists.

Parameters

mixed $key

Return Value

bool

in AbstractPaginator at line line 463
mixed offsetGet( mixed $key)

Get the item at the given offset.

Parameters

mixed $key

Return Value

mixed

in AbstractPaginator at line line 475
void offsetSet( mixed $key, mixed $value)

Set the item at the given offset.

Parameters

mixed $key
mixed $value

Return Value

void

in AbstractPaginator at line line 486
void offsetUnset( mixed $key)

Unset the item at the given key.

Parameters

mixed $key

Return Value

void

in AbstractPaginator at line line 496
string toHtml()

Render the contents of the paginator to HTML.

Return Value

string

in AbstractPaginator at line line 508
mixed __call( string $method, array $parameters)

Make dynamic calls into the collection.

Parameters

string $method
array $parameters

Return Value

mixed

in AbstractPaginator at line line 518
string __toString()

Render the contents of the paginator when casting to string.

Return Value

string

at line line 41
void __construct( mixed $items, int $total, int $perPage, int|null $currentPage = null, array $options = array())

Create a new paginator instance.

Parameters

mixed $items
int $total
int $perPage
int|null $currentPage
array $options (path, query, fragment, pageName)

Return Value

void

at line line 74
string|null nextPageUrl()

Get the URL for the next page.

Return Value

string|null

at line line 86
bool hasMorePages()

Determine if there are more items in the data source.

Return Value

bool

at line line 96
int total()

Get the total number of items being paginated.

Return Value

int

at line line 106
int lastPage()

Get the last page.

Return Value

int

Render the paginator using the given presenter.

Parameters

Presenter $presenter

Return Value

string

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

Render the paginator using the given presenter.

Parameters

Presenter $presenter

Return Value

string

at line line 144
array toArray()

Get the instance as an array.

Return Value

array

at line line 164
array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

at line line 175
string toJson( int $options)

Convert the object to its JSON representation.

Parameters

int $options

Return Value

string