W3cubDocs

Paginator

class Paginator extends AbstractPaginator implements Arrayable, ArrayAccess, Countable, IteratorAggregate, JsonSerializable, Jsonable, Paginator (View source)

Methods

string

getUrlRange( int $start, int $end)

Create a range of pagination URLs.

from AbstractPaginator

string

url( int $page)

Get a URL for a given page number.

from AbstractPaginator

string|null

previousPageUrl()

Get the URL for the previous page.

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

addQuery( string $key, string $value)

Add a query string value to the paginator.

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

int

currentPage()

Get the current page.

from AbstractPaginator

bool

hasPages()

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

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 void

presenter( Closure $resolver)

Set the default Presenter resolver.

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

setPath( string $path)

Set the base path to assign to all URLs.

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

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 = array())

Create a new paginator instance.

string|null

nextPageUrl()

Get the URL for the next page.

bool

hasMorePages()

Determine if there are more items in the data source.

string

links( Presenter $presenter = null)

Render the paginator using the given presenter.

string

render( Presenter $presenter = null)

Render the paginator using the given presenter.

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.

Details

string getUrlRange( int $start, int $end)

Create a range of pagination URLs.

Parameters

int	$start
int	$end

Return Value

string

string url( int $page)

Get a URL for a given page number.

Parameters

int

$page

Return Value

string

string|null previousPageUrl()

Get the URL for the previous page.

Return Value

string|null

$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

$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

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

Add a query string value to the paginator.

Parameters

string	$key
string	$value

Return Value

$this

array items()

Get the slice of items being paginated.

Return Value

array

int firstItem()

Get the number of the first item in the slice.

Return Value

int

int lastItem()

Get the number of the last item in the slice.

Return Value

int

int perPage()

Get the number of items shown per page.

Return Value

int

int currentPage()

Get the current page.

Return Value

int

bool hasPages()

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

Return Value

bool

static string resolveCurrentPath( string $default = '/')

Resolve the current request path or return the default value.

Parameters

string

$default

Return Value

string

static void currentPathResolver( Closure $resolver)

Set the current request path resolver callback.

Parameters

Closure

$resolver

Return Value

void

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

static void currentPageResolver( Closure $resolver)

Set the current page resolver callback.

Parameters

Closure

$resolver

Return Value

void

static void presenter( Closure $resolver)

Set the default Presenter resolver.

Parameters

Closure

$resolver

Return Value

void

string getPageName()

Get the query string variable used to store the page.

Return Value

string

$this setPageName( string $name)

Set the query string variable used to store the page.

Parameters

string

$name

Return Value

$this

$this setPath( string $path)

Set the base path to assign to all URLs.

Parameters

string

$path

Return Value

$this

ArrayIterator getIterator()

Get an iterator for the items.

Return Value

ArrayIterator

bool isEmpty()

Determine if the list of items is empty or not.

Return Value

bool

int count()

Get the number of items for the current page.

Return Value

int

Collection getCollection()

Get the paginator's underlying collection.

Return Value

Collection

$this setCollection( Collection $collection)

Set the paginator's underlying collection.

Parameters

Collection

$collection

Return Value

$this

bool offsetExists( mixed $key)

Determine if the given item exists.

Parameters

mixed

$key

Return Value

bool

mixed offsetGet( mixed $key)

Get the item at the given offset.

Parameters

mixed

$key

Return Value

mixed

void offsetSet( mixed $key, mixed $value)

Set the item at the given offset.

Parameters

mixed	$key
mixed	$value

Return Value

void

void offsetUnset( mixed $key)

Unset the item at the given key.

Parameters

mixed

$key

Return Value

void

string toHtml()

Render the contents of the paginator to HTML.

Return Value

string

mixed __call( string $method, array $parameters)

Make dynamic calls into the collection.

Parameters

string	$method
array	$parameters

Return Value

mixed

string __toString()

Render the contents of the paginator when casting to string.

Return Value

string

void __construct( mixed $items, int $perPage, int|null $currentPage = null, array $options = array())

Create a new paginator instance.

Parameters

mixed	$items
int	$perPage
int\|null	$currentPage
array	$options	(path, query, fragment, pageName)

Return Value

void

string|null nextPageUrl()

Get the URL for the next page.

Return Value

string|null

bool hasMorePages()

Determine if there are more items in the data source.

Return Value

bool

string links( Presenter $presenter = null)

Render the paginator using the given presenter.

Parameters

Presenter

$presenter

Return Value

string

string render( Presenter $presenter = null)

Render the paginator using the given presenter.

Parameters

Presenter

$presenter

Return Value

string

array toArray()

Get the instance as an array.

Return Value

array

array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

string toJson( int $options)

Convert the object to its JSON representation.

Parameters

int

$options

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.2/Illuminate/Pagination/Paginator.html