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

AbstractPaginator

abstract class AbstractPaginator implements Htmlable mixin Collection

Properties

protected Collection $items

All of the items being paginated.
protected int $perPage

The number of items to be shown per page.
protected int $currentPage

The current page being "viewed".
protected string $path

The base path to assign to all URLs.
protected array $query

The query parameters to add to all URLs.
protected string|null $fragment

The URL fragment to add to all URLs.
protected string $pageName

The query string variable used to store the page.
static protected Closure $currentPathResolver

The current path resolver callback.
static protected Closure $currentPageResolver

The current page resolver callback.
static protected Closure $viewFactoryResolver

The view factory resolver callback.
static string $defaultView

The default pagination view.
static string $defaultSimpleView

The default "simple" pagination view.

Methods

bool
isValidPageNumber(int $page)

Determine if the given value is a valid page number.

string|null
previousPageUrl()

Get the URL for the previous page.

array
getUrlRange(int $start, int $end)

Create a range of pagination URLs.

string
url(int $page)

Get the URL for a given page number.

$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
appendArray(array $keys)

Add an array of query string values.

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

Add a query string value to the paginator.

string
buildFragment()

Build the full fragment portion of a URL.

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
hasPages()

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

bool
onFirstPage()

Determine if the paginator is on the first page.

int
currentPage()

Get the current page.

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
withPath(string $path)

Set the base path to assign to all URLs.

$this
setPath(string $path)

Set the base path to assign to all URLs.

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.

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

at line 106
protected bool isValidPageNumber(int $page)

Determine if the given value is a valid page number.

Parameters

int $page

Return Value

bool

at line 116
string|null previousPageUrl()

Get the URL for the previous page.

Return Value

string|null

at line 130
array getUrlRange(int $start, int $end)

Create a range of pagination URLs.

Parameters

int $start
int $end

Return Value

array

at line 143
string url(int $page)

Get the URL for a given page number.

Parameters

int $page

Return Value

string

at line 170
$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

at line 188
$this appends(array|string $key, string|null $value = null)

Add a set of query string values to the paginator.

Parameters

array|string $key
string|null $value

Return Value

$this

at line 203
protected $this appendArray(array $keys)

Add an array of query string values.

Parameters

array $keys

Return Value

$this

at line 219
protected $this addQuery(string $key, string $value)

Add a query string value to the paginator.

Parameters

string $key
string $value

Return Value

$this

at line 233
protected string buildFragment()

Build the full fragment portion of a URL.

Return Value

string

at line 243
array items()

Get the slice of items being paginated.

Return Value

array

at line 253
int firstItem()

Get the number of the first item in the slice.

Return Value

int

at line 263
int lastItem()

Get the number of the last item in the slice.

Return Value

int

at line 273
int perPage()

Get the number of items shown per page.

Return Value

int

at line 283
bool hasPages()

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

Return Value

bool

at line 293
bool onFirstPage()

Determine if the paginator is on the first page.

Return Value

bool

at line 303
int currentPage()

Get the current page.

Return Value

int

at line 313
string getPageName()

Get the query string variable used to store the page.

Return Value

string

at line 324
$this setPageName(string $name)

Set the query string variable used to store the page.

Parameters

string $name

Return Value

$this

at line 337
$this withPath(string $path)

Set the base path to assign to all URLs.

Parameters

string $path

Return Value

$this

at line 348
$this setPath(string $path)

Set the base path to assign to all URLs.

Parameters

string $path

Return Value

$this

at line 361
static string resolveCurrentPath(string $default = '/')

Resolve the current request path or return the default value.

Parameters

string $default

Return Value

string

at line 376
static void currentPathResolver(Closure $resolver)

Set the current request path resolver callback.

Parameters

Closure $resolver

Return Value

void

at line 388
static int resolveCurrentPage(string $pageName = 'page', int $default = 1)

Resolve the current page or return the default value.

Parameters

string $pageName
int $default

Return Value

int

at line 403
static void currentPageResolver(Closure $resolver)

Set the current page resolver callback.

Parameters

Closure $resolver

Return Value

void

at line 413
static Factory viewFactory()

Get an instance of the view factory from the resolver.

Return Value

Factory

at line 424
static void viewFactoryResolver(Closure $resolver)

Set the view factory resolver callback.

Parameters

Closure $resolver

Return Value

void

at line 435
static void defaultView(string $view)

Set the default pagination view.

Parameters

string $view

Return Value

void

at line 446
static void defaultSimpleView(string $view)

Set the default "simple" pagination view.

Parameters

string $view

Return Value

void

at line 456
ArrayIterator getIterator()

Get an iterator for the items.

Return Value

ArrayIterator

at line 466
bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

at line 476
int count()

Get the number of items for the current page.

Return Value

int

at line 486
Collection getCollection()

Get the paginator's underlying collection.

Return Value

Collection

at line 497
$this setCollection(Collection $collection)

Set the paginator's underlying collection.

Parameters

Collection $collection

Return Value

$this

at line 510
bool offsetExists(mixed $key)

Determine if the given item exists.

Parameters

mixed $key

Return Value

bool

at line 521
mixed offsetGet(mixed $key)

Get the item at the given offset.

Parameters

mixed $key

Return Value

mixed

at line 533
void offsetSet(mixed $key, mixed $value)

Set the item at the given offset.

Parameters

mixed $key
mixed $value

Return Value

void

at line 544
void offsetUnset(mixed $key)

Unset the item at the given key.

Parameters

mixed $key

Return Value

void

at line 554
string toHtml()

Render the contents of the paginator to HTML.

Return Value

string

at line 566
mixed __call(string $method, array $parameters)

Make dynamic calls into the collection.

Parameters

string $method
array $parameters

Return Value

mixed

at line 576
string __toString()

Render the contents of the paginator when casting to string.

Return Value

string