class Pagination extends Dto (View source)

Class represents pagination information

Properties

int $Page

Page number

int $ItemsPerPage

Number of items per page

int $TotalPages

Number of total pages

int $TotalItems

Number of total items

$Links

Array with links to navigation.

Methods

array
GetSubObjects()

Get array with mapping which property is object and what type of object.

from  Dto
array
GetDependsObjects()

Get array with mapping which property depends on other property To be overridden in child class if has any dependent objects.

from  Dto
array
GetReadOnlyProperties()

Get array with read only properties - not used in response To be overridden in child class if has any read-only properties.

from  Dto
__construct(int $page = 1, int $itemsPerPage = 10)

Construct

Details

array GetSubObjects()

Get array with mapping which property is object and what type of object.

To be overridden in child class if has any sub objects.

Return Value

array

array GetDependsObjects()

Get array with mapping which property depends on other property To be overridden in child class if has any dependent objects.

Return Value

array

array GetReadOnlyProperties()

Get array with read only properties - not used in response To be overridden in child class if has any read-only properties.

Return Value

array

__construct(int $page = 1, int $itemsPerPage = 10)

Construct

Parameters

int $page

Number of page

int $itemsPerPage

Number of items on one page