Methods

Static access to the default instance

__callStatic(string $name, array $arguments) : mixed

Parameters

$name

string

$arguments

array

Exceptions

\BadMethodCallException if the request method does not exist

Returns

mixed

__construct()

__construct(array $config) 

Parameters

$config

array

configuration value getter

__get($name) : mixed

Parameters

$name

Returns

mixed

configuration value setter

__set($name, mixed $value) 

Parameters

$name

$value

mixed

Render the pagination when the object is cast to string

__toString() 

Init

_init() : void

Loads in the config and sets the variables

Pagination "First" link

first(string $marker) : string

Parameters

$marker

string

optional text to display in the link

Returns

stringMarkup for the 'first' page number link

forge a new pagination instance

forge(string $name, array $config) : \Pagination

Parameters

$name

string

$config

array

Returns

\Paginationa new pagination instance

retrieve an existing pagination instance

instance(string $name) : \Pagination

Parameters

$name

string

Returns

\Paginationa existing pagination instance

Pagination "Last" link

last(string $marker) : string

Parameters

$marker

string

optional text to display in the link

Returns

stringMarkup for the 'last' page number link

generate the HTML for the page links only

pages_render() : string

Returns

stringMarkup for the pagination block

Creates the pagination markup

render(mixed $raw) : mixed

Parameters

$raw

mixed

Returns

mixedHTML Markup for page number links, or an array of raw pagination data

Prepares vars for creating links

_recalculate() 

configuration value setter

_set($name, mixed $value) 

Parameters

$name

$value

mixed

Validate the input configuration

_validate($name, $value) : int | mixed

Parameters

$name

$value

Returns

intmixed

 Properties

 

<p>Pagination default instance</p>

$_instance : array

 

<p>Pagination instances</p>

$_instances : array

 

instance configuration values

$config 

 

raw pagination results

$raw_results 

 

instance template values

$template