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

LengthAwarePaginator

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

Traits

ForwardsCalls
Tappable
TransformsToResourceCollection

Constants

protected DEFAULT_VIEW

The default pagination view name.
protected DEFAULT_SIMPLE_VIEW

The default simple pagination view name.

Properties

protected TValue> $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<array-key, mixed> $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
protected bool $escapeWhenCastingToString

Indicates that the paginator's string representation should be escaped when __toString is invoked.

 from  AbstractPaginator
int $onEachSide

The number of links to display on each side of current page link.

 from  AbstractPaginator
protected array<string, mixed> $options

The paginator options.

 from  AbstractPaginator
static protected Closure|null $currentPathResolver

The current path resolver callback.

 from  AbstractPaginator
static protected Closure|null $currentPageResolver

The current page resolver callback.

 from  AbstractPaginator
static protected Closure|null $queryStringResolver

The query string resolver callback.

 from  AbstractPaginator
static protected Closure|null $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

mixed
forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

from  ForwardsCalls
mixed
forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

from  ForwardsCalls
static never
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

from  ForwardsCalls
mixed
tap(callable|null $callback = null)

Call the given Closure with this instance then return the instance.

from  Tappable
ResourceCollection
toResourceCollection(string|null $resourceClass = null)

Create a new resource collection instance for the given resource.

from  TransformsToResourceCollection
ResourceCollection
guessResourceCollection()

Guess the resource collection for the items.

from  TransformsToResourceCollection
string|null
resolveResourceFromAttribute(string $class)

Get the resource class from the class attribute.

from  TransformsToResourceCollection
string|null
resolveResourceCollectionFromAttribute(string $class)

Get the resource collection class from the class attribute.

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

Render the paginator using the given view.

bool
hasMorePages()

Determine if there are more items in the data source.

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
AbstractPaginator|string|null
fragment(string|null $fragment = null)

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

from  AbstractPaginator
AbstractPaginator
appends(array|int|string|null $key, array|bool|float|int|string|null $value = null)

Add a set of query string values to the paginator.

from  AbstractPaginator
AbstractPaginator
appendArray(array $keys)

Add an array of query string values.

from  AbstractPaginator
AbstractPaginator
withQueryString()

Add all current query string values to the paginator.

from  AbstractPaginator
AbstractPaginator
addQuery(int|string $key, mixed $value)

Add a query string value to the paginator.

from  AbstractPaginator
string
buildFragment()

Build the full fragment portion of a URL.

from  AbstractPaginator
AbstractPaginator
loadMorph(string $relation, array $relations)

Load a set of relationships onto the mixed relationship collection.

from  AbstractPaginator
AbstractPaginator
loadMorphCount(string $relation, array $relations)

Load a set of relationship counts onto the mixed relationship collection.

from  AbstractPaginator
array
items()

Get the slice of items being paginated.

from  AbstractPaginator
int|null
firstItem()

Get the number of the first item in the slice.

from  AbstractPaginator
int|null
lastItem()

Get the number of the last item in the slice.

from  AbstractPaginator
AbstractPaginator
through(callable $callback)

Transform each item in the slice of items using a callback.

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

Determine if the paginator is on the last 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
AbstractPaginator
setPageName(string $name)

Set the query string variable used to store the page.

from  AbstractPaginator
AbstractPaginator
withPath(string $path)

Set the base path to assign to all URLs.

from  AbstractPaginator
AbstractPaginator
setPath(string $path)

Set the base path to assign to all URLs.

from  AbstractPaginator
AbstractPaginator
onEachSide(int $count)

Set the number of links to display on each side of current page link.

from  AbstractPaginator
string|null
path()

Get the base path for paginator generated 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 string|array|null
resolveQueryString(string|array|null $default = null)

Resolve the query string or return the default value.

from  AbstractPaginator
static void
queryStringResolver(Closure $resolver)

Set with query string 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
static void
useTailwind()

Indicate that Tailwind styling should be used for generated links.

from  AbstractPaginator
static void
flushState()

Flush all static state.

from  AbstractPaginator
Traversable
getIterator()

Get an iterator for the items.

from  AbstractPaginator
bool
isEmpty()

Determine if the list of items is empty.

from  AbstractPaginator
bool
isNotEmpty()

Determine if the list of items is not empty.

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
AbstractPaginator
setCollection(Collection $collection)

Set the paginator's underlying collection.

from  AbstractPaginator
array
getOptions()

Get the paginator options.

from  AbstractPaginator
bool
offsetExists(TKey $offset)

Determine if the given item exists.

from  AbstractPaginator
mixed
offsetGet(TKey $offset)

Get the item at the given offset.

from  AbstractPaginator
void
offsetSet(null|TKey $offset, TValue $value)

Set the item at the given offset.

from  AbstractPaginator
void
offsetUnset(TKey $offset)

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 a string.

from  AbstractPaginator
CanBeEscapedWhenCastToString
escapeWhenCastingToString(bool $escape = true)

Indicate that the paginator's string representation should be escaped when __toString is invoked.

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

Create a new paginator instance.

int
setCurrentPage(int|null $currentPage, string $pageName)

Get the current page for the request.

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

Render the paginator using the given view.

Collection
linkCollection()

Get the paginator links as a collection (for JSON responses).

array
elements()

Get the array of elements to pass to the view.

int
total()

Get the total number of items being paginated.

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.

string
toPrettyJson(int $options = 0)

Convert the object to pretty print formatted JSON.

Details

in ForwardsCalls at line 22
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in ForwardsCalls at line 52
protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in ForwardsCalls at line 66
static protected never throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

never

Exceptions

BadMethodCallException

in Tappable at line 17
mixed tap(callable|null $callback = null)

Call the given Closure with this instance then return the instance.

Parameters

callable|null $callback

Return Value

mixed

in TransformsToResourceCollection at line 24
ResourceCollection toResourceCollection(string|null $resourceClass = null)

Create a new resource collection instance for the given resource.

Parameters

string|null $resourceClass

Return Value

ResourceCollection

Exceptions

Throwable

in TransformsToResourceCollection at line 38
protected ResourceCollection guessResourceCollection()

Guess the resource collection for the items.

Return Value

ResourceCollection

Exceptions

Throwable

in TransformsToResourceCollection at line 93
protected string|null resolveResourceFromAttribute(string $class)

Get the resource class from the class attribute.

Parameters

string $class

Return Value

string|null

in TransformsToResourceCollection at line 112
protected string|null resolveResourceCollectionFromAttribute(string $class)

Get the resource collection class from the class attribute.

Parameters

string $class

Return Value

string|null

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

Render the paginator using the given view.

Parameters

string|null $view
array $data

Return Value

Htmlable

at line 164
bool hasMorePages()

Determine if there are more items in the data source.

Return Value

bool

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

Get the URL for the previous page.

Return Value

string|null

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

Create a range of pagination URLs.

Parameters

int $start
int $end

Return Value

array

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

Get the URL for a given page number.

Parameters

int $page

Return Value

string

in AbstractPaginator at line 206
AbstractPaginator|string|null fragment(string|null $fragment = null)

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

Parameters

string|null $fragment

Return Value

AbstractPaginator|string|null

in AbstractPaginator at line 222
AbstractPaginator appends(array|int|string|null $key, array|bool|float|int|string|null $value = null)

Add a set of query string values to the paginator.

Parameters

array|int|string|null $key
array|bool|float|int|string|null $value

Return Value

AbstractPaginator

in AbstractPaginator at line 243
protected AbstractPaginator appendArray(array $keys)

Add an array of query string values.

Parameters

array $keys

Return Value

AbstractPaginator

in AbstractPaginator at line 257
AbstractPaginator withQueryString()

Add all current query string values to the paginator.

Return Value

AbstractPaginator

in AbstractPaginator at line 271
protected AbstractPaginator addQuery(int|string $key, mixed $value)

Add a query string value to the paginator.

Parameters

int|string $key
mixed $value

Return Value

AbstractPaginator

in AbstractPaginator at line 283
protected string buildFragment()

Build the full fragment portion of a URL.

Return Value

string

in AbstractPaginator at line 297
AbstractPaginator loadMorph(string $relation, array $relations)

Load a set of relationships onto the mixed relationship collection.

Parameters

string $relation
array $relations

Return Value

AbstractPaginator

in AbstractPaginator at line 314
AbstractPaginator loadMorphCount(string $relation, array $relations)

Load a set of relationship counts onto the mixed relationship collection.

Parameters

string $relation
array $relations

Return Value

AbstractPaginator

in AbstractPaginator at line 327
array items()

Get the slice of items being paginated.

Return Value

array

in AbstractPaginator at line 335
int|null firstItem()

Get the number of the first item in the slice.

Return Value

int|null

in AbstractPaginator at line 343
int|null lastItem()

Get the number of the last item in the slice.

Return Value

int|null

in AbstractPaginator at line 358
AbstractPaginator through(callable $callback)

Transform each item in the slice of items using a callback.

Parameters

callable $callback

Return Value

AbstractPaginator

in AbstractPaginator at line 368
int perPage()

Get the number of items shown per page.

Return Value

int

in AbstractPaginator at line 376
bool hasPages()

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

Return Value

bool

in AbstractPaginator at line 384
bool onFirstPage()

Determine if the paginator is on the first page.

Return Value

bool

in AbstractPaginator at line 392
bool onLastPage()

Determine if the paginator is on the last page.

Return Value

bool

in AbstractPaginator at line 400
int currentPage()

Get the current page.

Return Value

int

in AbstractPaginator at line 408
string getPageName()

Get the query string variable used to store the page.

Return Value

string

in AbstractPaginator at line 418
AbstractPaginator setPageName(string $name)

Set the query string variable used to store the page.

Parameters

string $name

Return Value

AbstractPaginator

in AbstractPaginator at line 430
AbstractPaginator withPath(string $path)

Set the base path to assign to all URLs.

Parameters

string $path

Return Value

AbstractPaginator

in AbstractPaginator at line 440
AbstractPaginator setPath(string $path)

Set the base path to assign to all URLs.

Parameters

string $path

Return Value

AbstractPaginator

in AbstractPaginator at line 452
AbstractPaginator onEachSide(int $count)

Set the number of links to display on each side of current page link.

Parameters

int $count

Return Value

AbstractPaginator

in AbstractPaginator at line 462
string|null path()

Get the base path for paginator generated URLs.

Return Value

string|null

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

Set the current request path resolver callback.

The resolver persists in a static property for the worker lifetime and runs on every subsequent paginator's path lookup.

Parameters

Closure $resolver

Return Value

void

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

Set the current page resolver callback.

The resolver persists in a static property for the worker lifetime and runs on every subsequent paginator's page lookup.

Parameters

Closure $resolver

Return Value

void

in AbstractPaginator at line 518
static string|array|null resolveQueryString(string|array|null $default = null)

Resolve the query string or return the default value.

Parameters

string|array|null $default

Return Value

string|array|null

in AbstractPaginator at line 533
static void queryStringResolver(Closure $resolver)

Set with query string resolver callback.

The resolver persists in a static property for the worker lifetime and runs on every subsequent paginator's query-string lookup.

Parameters

Closure $resolver

Return Value

void

in AbstractPaginator at line 542
static Factory viewFactory()

Get an instance of the view factory from the resolver.

Return Value

Factory

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

Set the view factory resolver callback.

The resolver persists in a static property for the worker lifetime and runs on every subsequent paginator render.

Parameters

Closure $resolver

Return Value

void

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

Set the default pagination view.

The view name persists in a static property for the worker lifetime and applies to every subsequent paginator render.

Parameters

string $view

Return Value

void

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

Set the default "simple" pagination view.

The view name persists in a static property for the worker lifetime and applies to every subsequent simple-paginator render.

Parameters

string $view

Return Value

void

in AbstractPaginator at line 589
static void useTailwind()

Indicate that Tailwind styling should be used for generated links.

Sets the default view names in static properties for the worker lifetime; applies to every subsequent paginator render.

Return Value

void

in AbstractPaginator at line 601
static void flushState()

Flush all static state.

Return Value

void

in AbstractPaginator at line 616
Traversable getIterator()

Get an iterator for the items.

Return Value

Traversable

in AbstractPaginator at line 624
bool isEmpty()

Determine if the list of items is empty.

Return Value

bool

in AbstractPaginator at line 632
bool isNotEmpty()

Determine if the list of items is not empty.

Return Value

bool

in AbstractPaginator at line 640
int count()

Get the number of items for the current page.

Return Value

int

in AbstractPaginator at line 650
Collection getCollection()

Get the paginator's underlying collection.

Return Value

Collection

in AbstractPaginator at line 667
AbstractPaginator setCollection(Collection $collection)

Set the paginator's underlying collection.

Parameters

Collection $collection

Return Value

AbstractPaginator

in AbstractPaginator at line 679
array getOptions()

Get the paginator options.

Return Value

array

in AbstractPaginator at line 689
bool offsetExists(TKey $offset)

Determine if the given item exists.

Parameters

TKey $offset

Return Value

bool

in AbstractPaginator at line 700
mixed offsetGet(TKey $offset)

Get the item at the given offset.

Parameters

TKey $offset

Return Value

mixed

in AbstractPaginator at line 711
void offsetSet(null|TKey $offset, TValue $value)

Set the item at the given offset.

Parameters

null|TKey $offset
TValue $value

Return Value

void

in AbstractPaginator at line 721
void offsetUnset(TKey $offset)

Unset the item at the given key.

Parameters

TKey $offset

Return Value

void

in AbstractPaginator at line 729
string toHtml()

Render the contents of the paginator to HTML.

Return Value

string

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

Make dynamic calls into the collection.

Parameters

string $method
array $parameters

Return Value

mixed

in AbstractPaginator at line 749
string __toString()

Render the contents of the paginator when casting to a string.

Return Value

string

in AbstractPaginator at line 766
CanBeEscapedWhenCastToString escapeWhenCastingToString(bool $escape = true)

Indicate that the paginator's string representation should be escaped when __toString is invoked.

Parameters

bool $escape

Return Value

CanBeEscapedWhenCastToString

at line 50
__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)

at line 69
protected int setCurrentPage(int|null $currentPage, string $pageName)

Get the current page for the request.

Parameters

int|null $currentPage
string $pageName

Return Value

int

Render the paginator using the given view.

Parameters

string|null $view
array $data

Return Value

Htmlable

at line 106
Collection linkCollection()

Get the paginator links as a collection (for JSON responses).

Return Value

Collection

at line 140
protected array elements()

Get the array of elements to pass to the view.

Return Value

array

at line 156
int total()

Get the total number of items being paginated.

Return Value

int

at line 172
string|null nextPageUrl()

Get the URL for the next page.

Return Value

string|null

at line 184
int lastPage()

Get the last page.

Return Value

int

at line 194
array toArray()

Get the instance as an array.

Return Value

array

at line 219
array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

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

Convert the object to its JSON representation.

Parameters

int $options

Return Value

string

Exceptions

JsonException

at line 239
string toPrettyJson(int $options = 0)

Convert the object to pretty print formatted JSON.

Parameters

int $options

Return Value

string

Exceptions

JsonException