Pagination
in package
Uses ElementTrait

This is the Pagination class.

The pagination of the current navigation items will be stored in that class and will remain immutable (only get methods are available)

Tags
see
Pagination::getPage()
see
Pagination::getPerPage()
see
Pagination::getTotalItems()
see
Pagination::getTotalPages()
see
ElementTrait

Table of Contents

__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getPage() Returns the current page of the pagination.  : int
getPerPage() Returns the number of items per page on the current pagination.  : int
getTotalItems() Returns the total number of items on the current pagination.  : int
getTotalPages() Returns the total number of pages on the current pagination.  : int
jsonSerialize() Allow elements to be serialized.  : array<string|int, mixed>
toArray() Used to allow elements to be serialized.  : array<string|int, mixed>
getFieldItem()  : object|null
getFormattedData()  : mixed
setArrayField() Convert an API array of objects to a PHP array of objects.  : array<string|int, mixed>

Methods

__construct()

Elements constructor.

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []

Array that contains all the values to the object to initialize

Return values
mixed —

__toString()

Uses "json_encode" function to return the JSON format of the element.

public __toString() : string

Auto-invoked using echo or concatenations.

Return values
string —

getPage()

Returns the current page of the pagination.

public getPage() : int
Return values
int —

getPerPage()

Returns the number of items per page on the current pagination.

public getPerPage() : int
Return values
int —

getTotalItems()

Returns the total number of items on the current pagination.

public getTotalItems() : int
Return values
int —

getTotalPages()

Returns the total number of pages on the current pagination.

public getTotalPages() : int
Return values
int —

jsonSerialize()

Allow elements to be serialized.

public jsonSerialize() : array<string|int, mixed>

Auto-invoked using "json_encode" function.

Return values
array<string|int, mixed> —

toArray()

Used to allow elements to be serialized.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getFieldItem()

protected getFieldItem(array<string|int, mixed> $item, string $class) : object|null
Parameters
$item : array<string|int, mixed>
$class : string
Return values
object|null —

getFormattedData()

protected getFormattedData(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

setArrayField()

Convert an API array of objects to a PHP array of objects.

protected setArrayField(array<string|int, mixed> $data, string $class) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Array that contains all the values to the objects to initialize

$class : string

The PHP class we want the objects to be

Return values
array<string|int, mixed> —

Search results