1. class
  2. Illuminate
  3. \
  4. Pagination
  5. \
  6. LengthAwarePaginator

LengthAwarePaginator

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

Properties

protected Collection $items All of the items being paginated. from AbstractPaginator
protected int $perPage The number of items to be shown per page. from AbstractPaginator
protected int $currentPage The current page being "viewed". from AbstractPaginator
protected string $path The base path to assign to all URLs. from AbstractPaginator
protected array $query The query parameters to add to all URLs. from AbstractPaginator
protected string|null $fragment The URL fragment to add to all URLs. from AbstractPaginator
protected string $pageName The query string variable used to store the page. from AbstractPaginator
static protected Closure $currentPathResolver The current page resolver callback. from AbstractPaginator
static protected Closure $currentPageResolver The current page resolver callback. from AbstractPaginator
static protected Closure $presenterResolver The default presenter resolver. from AbstractPaginator
protected int $total The total number of items before slicing.
protected int $lastPage The last available page.

Methods

bool
isValidPageNumber(int $page)

Determine if the given value is a valid page number.

from AbstractPaginator
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
appendArray(array $keys)

Add an array of query string values.

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

Add a query string value to the paginator.

from AbstractPaginator
string
buildFragment()

Build the full fragment portion of a URL.

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(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
$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
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
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 = [])

Create a new paginator instance.

int
setCurrentPage(int $currentPage, int $lastPage)

Get the current page for the request.

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
render(Presenter $presenter = null)

Render the paginator using the given presenter.

array
toArray()

Get the instance as an array.

string
toJson(int $options)

Convert the object to its JSON representation.

Details

in AbstractPaginator at line 84
protected bool isValidPageNumber(int $page)

Determine if the given value is a valid page number.

Parameters

int $page

Return Value

bool

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

Create a range of pagination URLs.

Parameters

int $start
int $end

Return Value

string

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

Get a URL for a given page number.

Parameters

int $page

Return Value

string

in AbstractPaginator at line 138
string|null previousPageUrl()

Get the URL for the previous page.

Return Value

string|null

in AbstractPaginator at line 152
$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 168
$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 181
protected $this appendArray(array $keys)

Add an array of query string values.

Parameters

array $keys

Return Value

$this

in AbstractPaginator at line 198
$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 213
protected string buildFragment()

Build the full fragment portion of a URL.

Return Value

string

in AbstractPaginator at line 223
array items()

Get the slice of items being paginated.

Return Value

array

in AbstractPaginator at line 233
int firstItem()

Get the number of the first item in the slice.

Return Value

int

in AbstractPaginator at line 243
int lastItem()

Get the number of the last item in the slice.

Return Value

int

in AbstractPaginator at line 253
int perPage()

Get the number of items shown per page.

Return Value

int

in AbstractPaginator at line 263
int currentPage()

Get the current page.

Return Value

int

in AbstractPaginator at line 273
bool hasPages()

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

Return Value

bool

in AbstractPaginator at line 284
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 300
static void currentPathResolver(Closure $resolver)

Set the current request path resolver callback.

Parameters

Closure $resolver

Return Value

void

in AbstractPaginator at line 311
static int resolveCurrentPage(int $default = 1)

Resolve the current page or return the default value.

Parameters

int $default

Return Value

int

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

Set the current page resolver callback.

Parameters

Closure $resolver

Return Value

void

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

Set the default Presenter resolver.

Parameters

Closure $resolver

Return Value

void

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

Set the query string variable used to store the page.

Parameters

string $name

Return Value

$this

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

Set the base path to assign to all URLs.

Parameters

string $path

Return Value

$this

in AbstractPaginator at line 374
ArrayIterator getIterator()

Get an iterator for the items.

Return Value

ArrayIterator

in AbstractPaginator at line 384
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

in AbstractPaginator at line 394
int count()

Get the number of items for the current page.

Return Value

int

in AbstractPaginator at line 404
Collection getCollection()

Get the paginator's underlying collection.

Return Value

Collection

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

Determine if the given item exists.

Parameters

mixed $key

Return Value

bool

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

Get the item at the given offset.

Parameters

mixed $key

Return Value

mixed

in AbstractPaginator at line 438
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 449
void offsetUnset(mixed $key)

Unset the item at the given key.

Parameters

mixed $key

Return Value

void

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

Make dynamic calls into the collection.

Parameters

string $method
array $parameters

Return Value

mixed

in AbstractPaginator at line 471
string __toString()

Render the contents of the paginator when casting to string.

Return Value

string

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

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 60
protected int setCurrentPage(int $currentPage, int $lastPage)

Get the current page for the request.

Parameters

int $currentPage
int $lastPage

Return Value

int

at line 80
string|null nextPageUrl()

Get the URL for the next page.

Return Value

string|null

at line 93
bool hasMorePages()

Determine if there are more items in the data source.

Return Value

bool

at line 103
int total()

Get the total number of items being paginated.

Return Value

int

at line 113
int lastPage()

Get the last page.

Return Value

int

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

Render the paginator using the given presenter.

Parameters

Presenter $presenter

Return Value

string

at line 141
array toArray()

Get the instance as an array.

Return Value

array

at line 162
string toJson(int $options)

Convert the object to its JSON representation.

Parameters

int $options

Return Value

string