AbstractPaginator (Pagination)
AbstractPaginator
class AbstractPaginator implements Htmlable (View source)
Properties
static string | $defaultView | The default pagination view. | |
static string | $defaultSimpleView | The default "simple" pagination view. |
Methods
string | getUrlRange(int $start, int $end) Create a range of pagination URLs. | |
string | url(int $page) Get the URL for a given page number. | |
string|null | previousPageUrl() Get the URL for the previous page. | |
$this|string|null | fragment(string|null $fragment = null) Get / set the URL fragment to be appended to URLs. | |
$this | appends(array|string $key, string|null $value = null) Add a set of query string values to the paginator. | |
$this | addQuery(string $key, string $value) Add a query string value to the paginator. | |
array | items() Get the slice of items being paginated. | |
int | firstItem() Get the number of the first item in the slice. | |
int | lastItem() Get the number of the last item in the slice. | |
int | perPage() Get the number of items shown per page. | |
bool | onFirstPage() Determine if the paginator is on the first page. | |
int | currentPage() Get the current page. | |
bool | hasPages() Determine if there are enough items to split into multiple pages. | |
static string | resolveCurrentPath(string $default = '/') Resolve the current request path or return the default value. | |
static void | currentPathResolver(Closure $resolver) Set the current request path resolver callback. | |
static int | resolveCurrentPage(string $pageName = 'page', int $default = 1) Resolve the current page or return the default value. | |
static void | currentPageResolver(Closure $resolver) Set the current page resolver callback. | |
static Factory | viewFactory() Get an instance of the view factory from the resolver. | |
static void | viewFactoryResolver(Closure $resolver) Set the view factory resolver callback. | |
static void | defaultView(string $view) Set the default pagination view. | |
static void | defaultSimpleView(string $view) Set the default "simple" pagination view. | |
string | getPageName() Get the query string variable used to store the page. | |
$this | setPageName(string $name) Set the query string variable used to store the page. | |
$this | setPath(string $path) Set the base path to assign to all URLs. | |
ArrayIterator | getIterator() Get an iterator for the items. | |
bool | isEmpty() Determine if the list of items is empty or not. | |
int | count() Get the number of items for the current page. | |
Collection | getCollection() Get the paginator's underlying collection. | |
$this | setCollection(Collection $collection) Set the paginator's underlying collection. | |
bool | offsetExists(mixed $key) Determine if the given item exists. | |
mixed | offsetGet(mixed $key) Get the item at the given offset. | |
void | offsetSet(mixed $key, mixed $value) Set the item at the given offset. | |
void | offsetUnset(mixed $key) Unset the item at the given key. | |
string | toHtml() Render the contents of the paginator to HTML. | |
mixed | __call(string $method, array $parameters) Make dynamic calls into the collection. | |
string | __toString() Render the contents of the paginator when casting to string. |
Details
string getUrlRange(int $start, int $end)
Create a range of pagination URLs.
string url(int $page)
Get the URL for a given page number.
string|null previousPageUrl()
Get the URL for the previous page.
$this|string|null fragment(string|null $fragment = null)
Get / set the URL fragment to be appended to URLs.
$this appends(array|string $key, string|null $value = null)
Add a set of query string values to the paginator.
$this addQuery(string $key, string $value)
Add a query string value to the paginator.
array items()
Get the slice of items being paginated.
int firstItem()
Get the number of the first item in the slice.
int lastItem()
Get the number of the last item in the slice.
int perPage()
Get the number of items shown per page.
bool onFirstPage()
Determine if the paginator is on the first page.
int currentPage()
Get the current page.
bool hasPages()
Determine if there are enough items to split into multiple pages.
static string resolveCurrentPath(string $default = '/')
Resolve the current request path or return the default value.
static void currentPathResolver(Closure $resolver)
Set the current request path resolver callback.
static int resolveCurrentPage(string $pageName = 'page', int $default = 1)
Resolve the current page or return the default value.
static void currentPageResolver(Closure $resolver)
Set the current page resolver callback.
static Factory viewFactory()
Get an instance of the view factory from the resolver.
static void viewFactoryResolver(Closure $resolver)
Set the view factory resolver callback.
static void defaultView(string $view)
Set the default pagination view.
static void defaultSimpleView(string $view)
Set the default "simple" pagination view.
string getPageName()
Get the query string variable used to store the page.
$this setPageName(string $name)
Set the query string variable used to store the page.
$this setPath(string $path)
Set the base path to assign to all URLs.
ArrayIterator getIterator()
Get an iterator for the items.
bool isEmpty()
Determine if the list of items is empty or not.
int count()
Get the number of items for the current page.
Collection getCollection()
Get the paginator's underlying collection.
$this setCollection(Collection $collection)
Set the paginator's underlying collection.
bool offsetExists(mixed $key)
Determine if the given item exists.
mixed offsetGet(mixed $key)
Get the item at the given offset.
void offsetSet(mixed $key, mixed $value)
Set the item at the given offset.
void offsetUnset(mixed $key)
Unset the item at the given key.
string toHtml()
Render the contents of the paginator to HTML.
mixed __call(string $method, array $parameters)
Make dynamic calls into the collection.
string __toString()
Render the contents of the paginator when casting to string.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Pagination/AbstractPaginator.html