Class Illuminate\Pagination\AbstractPaginator

`<TKey is array-key, out TValue>`

`abstract`
`implements`	`CanBeEscapedWhenCastToString, Htmlable, Stringable`
`uses`	`ForwardsCalls, Tappable, TransformsToResourceCollection`

Illuminate\Pagination\AbstractPaginator implements CanBeEscapedWhenCastToString, Htmlable, Stringable uses ForwardsCalls, Tappable, TransformsToResourceCollection
- Illuminate\Pagination\LengthAwarePaginator implements Arrayable<TKey, TValue>, ArrayAccess<TKey, TValue>, Countable, IteratorAggregate<TKey, TValue>, Jsonable, JsonSerializable, LengthAwarePaginator<TKey, TValue>
- Illuminate\Pagination\Paginator implements Arrayable<TKey, TValue>, ArrayAccess<TKey, TValue>, Countable, IteratorAggregate<TKey, TValue>, Jsonable, JsonSerializable, Paginator<TKey, TValue>

Methods
`protected`	`isValidPageNumber(int $page): bool` Determine if the given value is a valid page number. Determine if the given value is a valid page number.	#
`public`	`previousPageUrl(): string\|null` Get the URL for the previous page. Get the URL for the previous page.	#
`public`	`getUrlRange(int $start, int $end): array` Create a range of pagination URLs. Create a range of pagination URLs.	#
`public`	`url(int $page): string` Get the URL for a given page number. Get the URL for a given page number.	#
`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`	`firstItem(): int\|null` Get the number of the first item in the slice. Get the number of the first item in the slice.	#
`public`	`lastItem(): int\|null` Get the number of the last item in the slice. Get the number of the last item in the slice.	#
`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`	`hasPages(): bool` Determine if there are enough items to split into multiple pages. Determine if there are enough items to split into multiple pages.	#
`public`	`onFirstPage(): bool` Determine if the paginator is on the first page. Determine if the paginator is on the first page.	#
`public`	`onLastPage(): bool` Determine if the paginator is on the last page. Determine if the paginator is on the last page.	#
`public`	`currentPage(): int` Get the current page. Get the current page.	#
`public`	`getPageName(): string` Get the query string variable used to store the page. Get the query string variable used to store the page.	#
`public`	`setPageName(string $name): $this` Set the query string variable used to store the page. Set the query string variable used to store the page.	#
`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`	`onEachSide(int $count): $this` Set the number of links to display on each side of current page link. Set the number of links to display on each side of current page link.	#
`public`	`path(): string\|null` Get the base path for paginator generated URLs. Get the base path for paginator generated URLs.	#
`public static`	`resolveCurrentPath(string $default = '/'): string` Resolve the current request path or return the default value. Resolve the current request path or return the default value.	#
`public static`	`currentPathResolver(Closure $resolver): void` Set the current request path resolver callback. Set the current request path resolver callback.	#
`public static`	`resolveCurrentPage(string $pageName = 'page', int $default = 1): int` Resolve the current page or return the default value. Resolve the current page or return the default value.	#
`public static`	`currentPageResolver(Closure $resolver): void` Set the current page resolver callback. Set the current page resolver callback.	#
`public static`	`resolveQueryString(string\|array\|null $default = null): string` Resolve the query string or return the default value. Resolve the query string or return the default value.	#
`public static`	`queryStringResolver(Closure $resolver): void` Set with query string resolver callback. Set with query string 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 static`	`viewFactoryResolver(Closure $resolver): void` Set the view factory resolver callback. Set the view factory resolver callback.	#
`public static`	`defaultView(string $view): void` Set the default pagination view. Set the default pagination view.	#
`public static`	`defaultSimpleView(string $view): void` Set the default "simple" pagination view. Set the default "simple" pagination view.	#
`public static`	`useTailwind(): void` Indicate that Tailwind styling should be used for generated links. Indicate that Tailwind styling should be used for generated links.	#
`public static`	`useBootstrap(): void` Indicate that Bootstrap 4 styling should be used for generated links. Indicate that Bootstrap 4 styling should be used for generated links.	#
`public static`	`useBootstrapThree(): void` Indicate that Bootstrap 3 styling should be used for generated links. Indicate that Bootstrap 3 styling should be used for generated links.	#
`public static`	`useBootstrapFour(): void` Indicate that Bootstrap 4 styling should be used for generated links. Indicate that Bootstrap 4 styling should be used for generated links.	#
`public static`	`useBootstrapFive(): void` Indicate that Bootstrap 5 styling should be used for generated links. Indicate that Bootstrap 5 styling should be used for generated links.	#
`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(Collection<TKey, TValue> $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 `Illuminate\Contracts\Support\Htmlable::toHtml()`	#
`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 `Stringable::__toString()`	#
`public`	`escapeWhenCastingToString(bool $escape = true): $this` Indicate that the paginator's string representation should be escaped when __toString is invoked. Indicate that the paginator's string representation should be escaped when __toString is invoked. Implements `Illuminate\Contracts\Support\CanBeEscapedWhenCastToString::escapeWhenCastingToString()`	#

Methods used from Illuminate\Support\Traits\ForwardsCalls
`forwardCallTo(), forwardDecoratedCallTo(), throwBadMethodCallException()`

Methods used from Illuminate\Support\Traits\Tappable
`tap()`

Methods used from Illuminate\Support\Traits\TransformsToResourceCollection
`toResourceCollection(), guessResourceCollection()`

Properties
`protected`	`Collection<TKey, TValue>`	`$items`	#
`protected`	`int`	`$perPage`	#
`protected`	`int`	`$currentPage`	#
`protected`	`string`	`$path = '/'`	#
`protected`	`array`	`$query = []`	#
`protected`	`string\|null`	`$fragment`	#
`protected`	`string`	`$pageName = 'page'`	#
`protected`	`bool`	`$escapeWhenCastingToString = false`	#
`public`	`int`	`$onEachSide = 3`	#
`protected`	`array`	`$options`	#
`protected static`	`Closure`	`$currentPathResolver`	#
`protected static`	`Closure`	`$currentPageResolver`	#
`protected static`	`Closure`	`$queryStringResolver`	#
`protected static`	`Closure`	`$viewFactoryResolver`	#
`public static`	`string`	`$defaultView = 'pagination::tailwind'`	#
`public static`	`string`	`$defaultSimpleView = 'pagination::simple-tailwind'`	#

Namespaces

Classes

Class Illuminate\Pagination\AbstractPaginator

`<TKey is array-key, out TValue>`

Implements

Implements

Implements