class Paginator extends AbstractPaginator implements Arrayable, ArrayAccess, Countable, IteratorAggregate, JsonSerializable, Jsonable, Paginator (View source)
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 | $hasMore | 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 |
$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 |
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 |
$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 $perPage, int|null $currentPage = null, array $options = []) Create a new paginator instance. | |
int | setCurrentPage(int $currentPage) Get the current page for the request. | |
void | setItems(mixed $items) Set the items for the paginator. | |
string|null | nextPageUrl() Get the URL for the next page. | |
string | 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. | |
$this | hasMorePagesWhen(bool $value = true) Manually indicate that the paginator does have more pages. | |
bool | hasMorePages() Determine if there are more items in the data source. | |
array | toArray() Get the instance as an array. | |
array | jsonSerialize() Convert the object into something JSON serializable. | |
string | toJson(int $options) Convert the object to its JSON representation. |
Determine if the given value is a valid page number.
Get the URL for the previous page.
Create a range of pagination URLs.
Get the URL for a given page number.
Get / set the URL fragment to be appended to URLs.
Add a set of query string values to the paginator.
Add an array of query string values.
Add a query string value to the paginator.
Build the full fragment portion of a URL.
Get the slice of items being paginated.
Get the number of the first item in the slice.
Get the number of the last item in the slice.
Get the number of items shown per page.
Determine if there are enough items to split into multiple pages.
Determine if the paginator is on the first page.
Get the current page.
Get the query string variable used to store the page.
Set the query string variable used to store the page.
Set the base path to assign to all URLs.
Set the base path to assign to all URLs.
Resolve the current request path or return the default value.
Set the current request path resolver callback.
Resolve the current page or return the default value.
Set the current page resolver callback.
Get an instance of the view factory from the resolver.
Set the view factory resolver callback.
Set the default pagination view.
Set the default "simple" pagination view.
Get an iterator for the items.
Determine if the list of items is empty or not.
Determine if the list of items is not empty.
Get the number of items for the current page.
Get the paginator's underlying collection.
Set the paginator's underlying collection.
Determine if the given item exists.
Get the item at the given offset.
Set the item at the given offset.
Unset the item at the given key.
Render the contents of the paginator to HTML.
Make dynamic calls into the collection.
Render the contents of the paginator when casting to string.
Create a new paginator instance.
Get the current page for the request.
Set the items for the paginator.
Get the URL for the next page.
Render the paginator using the given view.
Render the paginator using the given view.
Manually indicate that the paginator does have more pages.
Determine if there are more items in the data source.
Get the instance as an array.
Convert the object into something JSON serializable.
Convert the object to its JSON representation.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Pagination/Paginator.html