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

CursorPaginator

class CursorPaginator extends AbstractCursorPaginator implements Arrayable, ArrayAccess, Countable, IteratorAggregate, Jsonable, JsonSerializable, CursorPaginator (View source)

Traits

ForwardsCalls
Tappable

Properties

protected TValue> $items

All of the items being paginated.

 from  AbstractCursorPaginator
protected int $perPage

The number of items to be shown per page.

 from  AbstractCursorPaginator
protected string $path

The base path to assign to all URLs.

 from  AbstractCursorPaginator
protected array $query

The query parameters to add to all URLs.

 from  AbstractCursorPaginator
protected string|null $fragment

The URL fragment to add to all URLs.

 from  AbstractCursorPaginator
protected string $cursorName

The cursor string variable used to store the page.

 from  AbstractCursorPaginator
protected Cursor|null $cursor

The current cursor.

 from  AbstractCursorPaginator
protected array $parameters

The paginator parameters for the cursor.

 from  AbstractCursorPaginator
protected array $options

The paginator options.

 from  AbstractCursorPaginator
static protected Closure $currentCursorResolver

The current cursor resolver callback.

 from  AbstractCursorPaginator
protected $hasMore

Indicates whether there are more items in the data source.

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
tap($callback = null)

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

from  Tappable
string
url(Cursor|null $cursor)

Get the URL for a given cursor.

from  AbstractCursorPaginator
string|null
previousPageUrl()

Get the URL for the previous page.

from  AbstractCursorPaginator
string|null
nextPageUrl()

The URL for the next page, or null.

from  AbstractCursorPaginator
Cursor|null
previousCursor()

Get the "cursor" that points to the previous set of items.

from  AbstractCursorPaginator
Cursor|null
nextCursor()

Get the "cursor" that points to the next set of items.

from  AbstractCursorPaginator
Cursor
getCursorForItem(ArrayAccess|stdClass $item, bool $isNext = true)

Get a cursor instance for the given item.

from  AbstractCursorPaginator
array
getParametersForItem(ArrayAccess|stdClass $item)

Get the cursor parameters for a given object.

from  AbstractCursorPaginator
string|null
getPivotParameterForItem(ArrayAccess|stdClass $item, string $parameterName)

Get the cursor parameter value from a pivot model if applicable.

from  AbstractCursorPaginator
mixed
ensureParameterIsPrimitive(mixed $parameter)

Ensure the parameter is a primitive type.

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

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

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

Add a set of query string values to the paginator.

from  AbstractCursorPaginator
$this
appendArray(array $keys)

Add an array of query string values.

from  AbstractCursorPaginator
$this
withQueryString()

Add all current query string values to the paginator.

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

Add a query string value to the paginator.

from  AbstractCursorPaginator
string
buildFragment()

Build the full fragment portion of a URL.

from  AbstractCursorPaginator
$this
loadMorph(string $relation, array $relations)

Load a set of relationships onto the mixed relationship collection.

from  AbstractCursorPaginator
$this
loadMorphCount(string $relation, array $relations)

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

from  AbstractCursorPaginator
items()

No description

from  AbstractCursorPaginator
$this
through(callable $callback)

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

from  AbstractCursorPaginator
int
perPage()

Get the number of items shown per page.

from  AbstractCursorPaginator
Cursor|null
cursor()

Get the current cursor being paginated.

from  AbstractCursorPaginator
string
getCursorName()

Get the query string variable used to store the cursor.

from  AbstractCursorPaginator
$this
setCursorName(string $name)

Set the query string variable used to store the cursor.

from  AbstractCursorPaginator
$this
withPath(string $path)

Set the base path to assign to all URLs.

from  AbstractCursorPaginator
$this
setPath(string $path)

Set the base path to assign to all URLs.

from  AbstractCursorPaginator
string|null
path()

Get the base path for paginator generated URLs.

from  AbstractCursorPaginator
static Cursor|null
resolveCurrentCursor(string $cursorName = 'cursor', $default = null)

Resolve the current cursor or return the default value.

from  AbstractCursorPaginator
static void
currentCursorResolver(Closure $resolver)

Set the current cursor resolver callback.

from  AbstractCursorPaginator
static Factory
viewFactory()

Get an instance of the view factory from the resolver.

from  AbstractCursorPaginator
Traversable
getIterator()

Get an iterator for the items.

from  AbstractCursorPaginator
bool
isEmpty()

Determine if the list of items is empty.

from  AbstractCursorPaginator
bool
isNotEmpty()

Determine if the list of items is not empty.

from  AbstractCursorPaginator
int
count()

Get the number of items for the current page.

from  AbstractCursorPaginator
TValue>
getCollection()

Get the paginator's underlying collection.

from  AbstractCursorPaginator
$this
setCollection(Collection $collection)

Set the paginator's underlying collection.

from  AbstractCursorPaginator
array
getOptions()

Get the paginator options.

from  AbstractCursorPaginator
bool
offsetExists(TKey $key)

Determine if the given item exists.

from  AbstractCursorPaginator
mixed
offsetGet(TKey $key)

Get the item at the given offset.

from  AbstractCursorPaginator
void
offsetSet(TKey|null $key, TValue $value)

Set the item at the given offset.

from  AbstractCursorPaginator
void
offsetUnset(TKey $key)

Unset the item at the given key.

from  AbstractCursorPaginator
string
toHtml()

Render the contents of the paginator to HTML.

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

Make dynamic calls into the collection.

from  AbstractCursorPaginator
string
__toString()

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

from  AbstractCursorPaginator
__construct(TValue>|TValue>|TValue>|null $items, int $perPage, Cursor|null $cursor = null, array $options = [])

Create a new paginator instance.

void
setItems(TValue>|TValue>|TValue>|null $items)

Set the items for the paginator.

Htmlable
links(string|null $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.

bool
hasMorePages()

Determine if there are more items in the data source.

bool
hasPages()

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

bool
onFirstPage()

Determine if the paginator is on the first page.

bool
onLastPage()

Determine if the paginator is on the last page.

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 ForwardsCalls at line 20
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 50
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 65
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 13
tap($callback = null)

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

Parameters

$callback

in AbstractCursorPaginator at line 107
string url(Cursor|null $cursor)

Get the URL for a given cursor.

Parameters

Cursor|null $cursor

Return Value

string

in AbstractCursorPaginator at line 129
string|null previousPageUrl()

Get the URL for the previous page.

Return Value

string|null

in AbstractCursorPaginator at line 143
string|null nextPageUrl()

The URL for the next page, or null.

Return Value

string|null

in AbstractCursorPaginator at line 157
Cursor|null previousCursor()

Get the "cursor" that points to the previous set of items.

Return Value

Cursor|null

in AbstractCursorPaginator at line 176
Cursor|null nextCursor()

Get the "cursor" that points to the next set of items.

Return Value

Cursor|null

in AbstractCursorPaginator at line 197
Cursor getCursorForItem(ArrayAccess|stdClass $item, bool $isNext = true)

Get a cursor instance for the given item.

Parameters

ArrayAccess|stdClass $item
bool $isNext

Return Value

Cursor

in AbstractCursorPaginator at line 210
array getParametersForItem(ArrayAccess|stdClass $item)

Get the cursor parameters for a given object.

Parameters

ArrayAccess|stdClass $item

Return Value

array

Exceptions

Exception

in AbstractCursorPaginator at line 244
protected string|null getPivotParameterForItem(ArrayAccess|stdClass $item, string $parameterName)

Get the cursor parameter value from a pivot model if applicable.

Parameters

ArrayAccess|stdClass $item
string $parameterName

Return Value

string|null

in AbstractCursorPaginator at line 265
protected mixed ensureParameterIsPrimitive(mixed $parameter)

Ensure the parameter is a primitive type.

This can resolve issues that arise the developer uses a value object for an attribute.

Parameters

mixed $parameter

Return Value

mixed

in AbstractCursorPaginator at line 278
$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 AbstractCursorPaginator at line 296
$this appends(array|string|null $key, string|null $value = null)

Add a set of query string values to the paginator.

Parameters

array|string|null $key
string|null $value

Return Value

$this

in AbstractCursorPaginator at line 315
protected $this appendArray(array $keys)

Add an array of query string values.

Parameters

array $keys

Return Value

$this

in AbstractCursorPaginator at line 329
$this withQueryString()

Add all current query string values to the paginator.

Return Value

$this

in AbstractCursorPaginator at line 345
protected $this addQuery(string $key, string $value)

Add a query string value to the paginator.

Parameters

string $key
string $value

Return Value

$this

in AbstractCursorPaginator at line 359
protected string buildFragment()

Build the full fragment portion of a URL.

Return Value

string

in AbstractCursorPaginator at line 371
$this loadMorph(string $relation, array $relations)

Load a set of relationships onto the mixed relationship collection.

Parameters

string $relation
array $relations

Return Value

$this

in AbstractCursorPaginator at line 385
$this loadMorphCount(string $relation, array $relations)

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

Parameters

string $relation
array $relations

Return Value

$this

in AbstractCursorPaginator at line 397
items()

No description

in AbstractCursorPaginator at line 408
$this through(callable $callback)

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

Parameters

callable $callback

Return Value

$this

in AbstractCursorPaginator at line 420
int perPage()

Get the number of items shown per page.

Return Value

int

in AbstractCursorPaginator at line 430
Cursor|null cursor()

Get the current cursor being paginated.

Return Value

Cursor|null

in AbstractCursorPaginator at line 440
string getCursorName()

Get the query string variable used to store the cursor.

Return Value

string

in AbstractCursorPaginator at line 451
$this setCursorName(string $name)

Set the query string variable used to store the cursor.

Parameters

string $name

Return Value

$this

in AbstractCursorPaginator at line 464
$this withPath(string $path)

Set the base path to assign to all URLs.

Parameters

string $path

Return Value

$this

in AbstractCursorPaginator at line 475
$this setPath(string $path)

Set the base path to assign to all URLs.

Parameters

string $path

Return Value

$this

in AbstractCursorPaginator at line 487
string|null path()

Get the base path for paginator generated URLs.

Return Value

string|null

in AbstractCursorPaginator at line 498
static Cursor|null resolveCurrentCursor(string $cursorName = 'cursor', $default = null)

Resolve the current cursor or return the default value.

Parameters

string $cursorName
$default

Return Value

Cursor|null

in AbstractCursorPaginator at line 513
static void currentCursorResolver(Closure $resolver)

Set the current cursor resolver callback.

Parameters

Closure $resolver

Return Value

void

in AbstractCursorPaginator at line 523
static Factory viewFactory()

Get an instance of the view factory from the resolver.

Return Value

Factory

in AbstractCursorPaginator at line 533
Traversable getIterator()

Get an iterator for the items.

Return Value

Traversable

in AbstractCursorPaginator at line 543
bool isEmpty()

Determine if the list of items is empty.

Return Value

bool

in AbstractCursorPaginator at line 553
bool isNotEmpty()

Determine if the list of items is not empty.

Return Value

bool

in AbstractCursorPaginator at line 563
int count()

Get the number of items for the current page.

Return Value

int

in AbstractCursorPaginator at line 573
TValue> getCollection()

Get the paginator's underlying collection.

Return Value

TValue>

in AbstractCursorPaginator at line 589
$this setCollection(Collection $collection)

Set the paginator's underlying collection.

Parameters

Collection $collection

Return Value

$this

in AbstractCursorPaginator at line 601
array getOptions()

Get the paginator options.

Return Value

array

in AbstractCursorPaginator at line 612
bool offsetExists(TKey $key)

Determine if the given item exists.

Parameters

TKey $key

Return Value

bool

in AbstractCursorPaginator at line 623
mixed offsetGet(TKey $key)

Get the item at the given offset.

Parameters

TKey $key

Return Value

mixed

in AbstractCursorPaginator at line 635
void offsetSet(TKey|null $key, TValue $value)

Set the item at the given offset.

Parameters

TKey|null $key
TValue $value

Return Value

void

in AbstractCursorPaginator at line 646
void offsetUnset(TKey $key)

Unset the item at the given key.

Parameters

TKey $key

Return Value

void

in AbstractCursorPaginator at line 656
string toHtml()

Render the contents of the paginator to HTML.

Return Value

string

in AbstractCursorPaginator at line 668
mixed __call(string $method, array $parameters)

Make dynamic calls into the collection.

Parameters

string $method
array $parameters

Return Value

mixed

in AbstractCursorPaginator at line 678
string __toString()

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

Return Value

string

at line 43
__construct(TValue>|TValue>|TValue>|null $items, int $perPage, Cursor|null $cursor = null, array $options = [])

Create a new paginator instance.

Parameters

TValue>|TValue>|TValue>|null $items
int $perPage
Cursor|null $cursor
array $options

(path, query, fragment, pageName)

at line 64
protected void setItems(TValue>|TValue>|TValue>|null $items)

Set the items for the paginator.

Parameters

TValue>|TValue>|TValue>|null $items

Return Value

void

Render the paginator using the given view.

Parameters

string|null $view
array $data

Return Value

Htmlable

at line 96
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 108
bool hasMorePages()

Determine if there are more items in the data source.

Return Value

bool

at line 120
bool hasPages()

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

Return Value

bool

at line 130
bool onFirstPage()

Determine if the paginator is on the first page.

Return Value

bool

at line 140
bool onLastPage()

Determine if the paginator is on the last page.

Return Value

bool

at line 150
toArray()

Get the instance as an array.

at line 168
array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

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

Convert the object to its JSON representation.

Parameters

int $options

Return Value

string