| Methods |
public
|
url(Cursor|null $cursor): string
Get the URL for a given cursor.
Get the URL for a given cursor.
|
#
|
public
|
previousPageUrl(): string|null
Get the URL for the previous page.
Get the URL for the previous page.
|
#
|
public
|
nextPageUrl(): string|null
The URL for the next page, or null.
The URL for the next page, or null.
|
#
|
public
|
previousCursor(): Cursor|null
Get the "cursor" that points to the previous set of items.
Get the "cursor" that points to the previous set of items.
|
#
|
public
|
nextCursor(): Cursor|null
Get the "cursor" that points to the next set of items.
Get the "cursor" that points to the next set of items.
|
#
|
public
|
getCursorForItem(ArrayAccess|stdClass $item, bool $isNext = true): Cursor
Get a cursor instance for the given item.
Get a cursor instance for the given item.
|
#
|
public
|
getParametersForItem(ArrayAccess|stdClass $item): array
Get the cursor parameters for a given object.
Get the cursor parameters for a given object.
Throws
|
#
|
protected
|
getPivotParameterForItem(ArrayAccess|stdClass $item, string $parameterName): string|null
Get the cursor parameter value from a pivot model if applicable.
Get the cursor parameter value from a pivot model if applicable.
|
#
|
protected
|
ensureParameterIsPrimitive(mixed $parameter): mixed
Ensure the parameter is a primitive type.
Ensure the parameter is a primitive type.
This can resolve issues that arise the developer uses a value object for an attribute.
|
#
|
public
|
fragment(string|null $fragment = null): $this|string|null
Get / set the URL fragment to be appended to URLs.
Get / set the URL fragment to be appended to URLs.
|
#
|
public
|
appends(array|string|null $key, string|null $value = null): $this
Add a set of query string values to the paginator.
Add a set of query string values to the paginator.
|
#
|
protected
|
appendArray(array $keys): $this
Add an array of query string values.
Add an array of query string values.
|
#
|
public
|
withQueryString(): $this
Add all current query string values to the paginator.
Add all current query string values to the paginator.
|
#
|
protected
|
addQuery(string $key, string $value): $this
Add a query string value to the paginator.
Add a query string value to the paginator.
|
#
|
protected
|
buildFragment(): string
Build the full fragment portion of a URL.
Build the full fragment portion of a URL.
|
#
|
public
|
loadMorph(string $relation, array $relations): $this
Load a set of relationships onto the mixed relationship collection.
Load a set of relationships onto the mixed relationship collection.
|
#
|
public
|
loadMorphCount(string $relation, array $relations): $this
Load a set of relationship counts onto the mixed relationship collection.
Load a set of relationship counts onto the mixed relationship collection.
|
#
|
public
|
items(): array<TKey, TValue>
Get the slice of items being paginated.
Get the slice of items being paginated.
|
#
|
public
|
through(callable $callback): $this
Transform each item in the slice of items using a callback.
Transform each item in the slice of items using a callback.
|
#
|
public
|
perPage(): int
Get the number of items shown per page.
Get the number of items shown per page.
|
#
|
public
|
cursor(): Cursor|null
Get the current cursor being paginated.
Get the current cursor being paginated.
|
#
|
public
|
getCursorName(): string
Get the query string variable used to store the cursor.
Get the query string variable used to store the cursor.
|
#
|
public
|
setCursorName(string $name): $this
Set the query string variable used to store the cursor.
Set the query string variable used to store the cursor.
|
#
|
public
|
withPath(string $path): $this
Set the base path to assign to all URLs.
Set the base path to assign to all URLs.
|
#
|
public
|
setPath(string $path): $this
Set the base path to assign to all URLs.
Set the base path to assign to all URLs.
|
#
|
public
|
path(): string|null
Get the base path for paginator generated URLs.
Get the base path for paginator generated URLs.
|
#
|
public
static
|
resolveCurrentCursor(string $cursorName = 'cursor', $default = null): Cursor|null
Resolve the current cursor or return the default value.
Resolve the current cursor or return the default value.
|
#
|
public
static
|
currentCursorResolver(Closure $resolver): void
Set the current cursor resolver callback.
Set the current cursor resolver callback.
|
#
|
public
static
|
viewFactory(): Factory
Get an instance of the view factory from the resolver.
Get an instance of the view factory from the resolver.
|
#
|
public
|
getIterator(): ArrayIterator<TKey, TValue>
Get an iterator for the items.
Get an iterator for the items.
|
#
|
public
|
isEmpty(): bool
Determine if the list of items is empty.
Determine if the list of items is empty.
|
#
|
public
|
isNotEmpty(): bool
Determine if the list of items is not empty.
Determine if the list of items is not empty.
|
#
|
public
|
count(): int
Get the number of items for the current page.
Get the number of items for the current page.
|
#
|
public
|
getCollection(): Collection<TKey, TValue>
Get the paginator's underlying collection.
Get the paginator's underlying collection.
|
#
|
public
|
setCollection<TSetKey is array-key, TSetValue>(Collection<TSetKey, TSetValue> $collection): $this
Set the paginator's underlying collection.
Set the paginator's underlying collection.
|
#
|
public
|
getOptions(): array
Get the paginator options.
Get the paginator options.
|
#
|
public
|
offsetExists(TKey $key): bool
Determine if the given item exists.
Determine if the given item exists.
|
#
|
public
|
offsetGet(TKey $key): TValue|null
Get the item at the given offset.
Get the item at the given offset.
|
#
|
public
|
offsetSet(TKey|null $key, TValue $value): void
Set the item at the given offset.
Set the item at the given offset.
|
#
|
public
|
offsetUnset(TKey $key): void
Unset the item at the given key.
Unset the item at the given key.
|
#
|
public
|
toHtml(): string
Render the contents of the paginator to HTML.
Render the contents of the paginator to HTML.
Implements
|
#
|
public
|
__call(string $method, array $parameters): mixed
Make dynamic calls into the collection.
Make dynamic calls into the collection.
|
#
|
public
|
__toString(): string
Render the contents of the paginator when casting to a string.
Render the contents of the paginator when casting to a string.
Implements
|
#
|