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

LengthAwarePaginator

class LengthAwarePaginator extends AbstractPaginator implements Arrayable, ArrayAccess, Countable, IteratorAggregate, JsonSerializable, Jsonable, LengthAwarePaginator

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 path resolver callback.

 from  AbstractPaginator
static protected Closure $currentPageResolver

The current page resolver callback.

 from  AbstractPaginator
static protected Closure $viewFactoryResolver

The view factory resolver callback.

 from  AbstractPaginator
static string $defaultView

The default pagination view.

 from  AbstractPaginator
static string $defaultSimpleView

The default "simple" pagination view.

 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|null
previousPageUrl()

Get the URL for the previous page.

from  AbstractPaginator
array
getUrlRange(int $start, int $end)

Create a range of pagination URLs.

from  AbstractPaginator
string
url(int $page)

Get the URL for a given page number.

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
bool
hasPages()

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

from  AbstractPaginator
bool
onFirstPage()

Determine if the paginator is on the first page.

from  AbstractPaginator
int
currentPage()

Get the current page.

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
withPath(string $path)

Set the base path to assign to all URLs.

from  AbstractPaginator
$this
setPath(string $path)

Set the base path to assign to all URLs.

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 Factory
viewFactory()

Get an instance of the view factory from the resolver.

from  AbstractPaginator
static void
viewFactoryResolver(Closure $resolver)

Set the view factory resolver callback.

from  AbstractPaginator
static void
defaultView(string $view)

Set the default pagination view.

from  AbstractPaginator
static void
defaultSimpleView(string $view)

Set the default "simple" pagination view.

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

Create a new paginator instance.

int
setCurrentPage(int $currentPage, string $pageName)

Get the current page for the request.

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

Render the paginator using the given view.

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

Render the paginator using the given view.

array
elements()

Get the array of elements to pass to the view.

int
total()

Get the total number of items being paginated.

bool
hasMorePages()

Determine if there are more items in the data source.

string|null
nextPageUrl()

Get the URL for the next page.

int
lastPage()

Get the last page.

array
toArray()

Get the instance as an array.

array
jsonSerialize()

Convert the object into something JSON serializable.

string
toJson(int $options = 0)

Convert the object to its JSON representation.

Details

in AbstractPaginator at line 106
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 116
string|null previousPageUrl()

Get the URL for the previous page.

Return Value

string|null

in AbstractPaginator at line 130
array getUrlRange(int $start, int $end)

Create a range of pagination URLs.

Parameters

int $start
int $end

Return Value

array

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

Get the URL for a given page number.

Parameters

int $page

Return Value

string

in AbstractPaginator at line 170
$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 188
$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 203
protected $this appendArray(array $keys)

Add an array of query string values.

Parameters

array $keys

Return Value

$this

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

Build the full fragment portion of a URL.

Return Value

string

in AbstractPaginator at line 243
array items()

Get the slice of items being paginated.

Return Value

array

in AbstractPaginator at line 253
int firstItem()

Get the number of the first item in the slice.

Return Value

int

in AbstractPaginator at line 263
int lastItem()

Get the number of the last item in the slice.

Return Value

int

in AbstractPaginator at line 273
int perPage()

Get the number of items shown per page.

Return Value

int

in AbstractPaginator at line 283
bool hasPages()

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

Return Value

bool

in AbstractPaginator at line 293
bool onFirstPage()

Determine if the paginator is on the first page.

Return Value

bool

in AbstractPaginator at line 303
int currentPage()

Get the current page.

Return Value

int

in AbstractPaginator at line 313
string getPageName()

Get the query string variable used to store the page.

Return Value

string

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

Set the query string variable used to store the page.

Parameters

string $name

Return Value

$this

in AbstractPaginator at line 337
$this withPath(string $path)

Set the base path to assign to all URLs.

Parameters

string $path

Return Value

$this

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

Set the base path to assign to all URLs.

Parameters

string $path

Return Value

$this

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

Set the current request path resolver callback.

Parameters

Closure $resolver

Return Value

void

in AbstractPaginator at line 388
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 403
static void currentPageResolver(Closure $resolver)

Set the current page resolver callback.

Parameters

Closure $resolver

Return Value

void

in AbstractPaginator at line 413
static Factory viewFactory()

Get an instance of the view factory from the resolver.

Return Value

Factory

in AbstractPaginator at line 424
static void viewFactoryResolver(Closure $resolver)

Set the view factory resolver callback.

Parameters

Closure $resolver

Return Value

void

in AbstractPaginator at line 435
static void defaultView(string $view)

Set the default pagination view.

Parameters

string $view

Return Value

void

in AbstractPaginator at line 446
static void defaultSimpleView(string $view)

Set the default "simple" pagination view.

Parameters

string $view

Return Value

void

in AbstractPaginator at line 456
ArrayIterator getIterator()

Get an iterator for the items.

Return Value

ArrayIterator

in AbstractPaginator at line 466
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

in AbstractPaginator at line 476
int count()

Get the number of items for the current page.

Return Value

int

in AbstractPaginator at line 486
Collection getCollection()

Get the paginator's underlying collection.

Return Value

Collection

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

Set the paginator's underlying collection.

Parameters

Collection $collection

Return Value

$this

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

Determine if the given item exists.

Parameters

mixed $key

Return Value

bool

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

Get the item at the given offset.

Parameters

mixed $key

Return Value

mixed

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

Unset the item at the given key.

Parameters

mixed $key

Return Value

void

in AbstractPaginator at line 554
string toHtml()

Render the contents of the paginator to HTML.

Return Value

string

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

Make dynamic calls into the collection.

Parameters

string $method
array $parameters

Return Value

mixed

in AbstractPaginator at line 576
string __toString()

Render the contents of the paginator when casting to string.

Return Value

string

at line 41
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 62
protected int setCurrentPage(int $currentPage, string $pageName)

Get the current page for the request.

Parameters

int $currentPage
string $pageName

Return Value

int

Render the paginator using the given view.

Parameters

string $view
array $data

Return Value

string

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

Render the paginator using the given view.

Parameters

string|null $view
array $data

Return Value

string

at line 101
protected array elements()

Get the array of elements to pass to the view.

Return Value

array

at line 119
int total()

Get the total number of items being paginated.

Return Value

int

at line 129
bool hasMorePages()

Determine if there are more items in the data source.

Return Value

bool

at line 139
string|null nextPageUrl()

Get the URL for the next page.

Return Value

string|null

at line 151
int lastPage()

Get the last page.

Return Value

int

at line 161
array toArray()

Get the instance as an array.

Return Value

array

at line 182
array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

at line 193
string toJson(int $options = 0)

Convert the object to its JSON representation.

Parameters

int $options

Return Value

string