PHP Class Newscoop\Gimme\Pagination

Show file Open project: sourcefabric/newscoop Class Usage Examples

Protected Properties

Property Type Description
$itemsPerPage integer Requested number items per page.
$page integer Requested page number
$sort array Array with sorting parameters

Public Methods

Method Description
getItemsPerPage ( ) : integer Get requested number items per page
getPage ( ) : integer Get currently requested page number
getSort ( ) : array Get sort parameters
setItemsPerPage ( integer $itemsPerPage ) Set requested number items per page.
setPage ( integer $page ) Set currently requested page number
setSort ( array $sort ) Set sort parameters

Method Details

getItemsPerPage() public method

Get requested number items per page
public getItemsPerPage ( ) : integer
return integer Number items per page.

getPage() public method

Get currently requested page number
public getPage ( ) : integer
return integer Page number

getSort() public method

Get sort parameters
public getSort ( ) : array
return array Sort parameters array

setItemsPerPage() public method

Set requested number items per page.
public setItemsPerPage ( integer $itemsPerPage )
$itemsPerPage integer Number items per page.

setPage() public method

Set currently requested page number
public setPage ( integer $page )
$page integer Page number

setSort() public method

Set sort parameters
public setSort ( array $sort )
$sort array Sort parameters array

Property Details

$itemsPerPage protected property

Requested number items per page.
protected int $itemsPerPage
return integer

$page protected property

Requested page number
protected int $page
return integer

$sort protected property

Array with sorting parameters
protected array $sort
return array