PHP Class Prado\Collections\TPagedListFetchDataEventParameter

TPagedListFetchDataEventParameter is used as the parameter for {@link TPagedList::onFetchData OnFetchData} event. To obtain the new page index, use {@link getNewPageIndex NewPageIndex}. The {@link getOffset Offset} property refers to the index of the first item in the new page, while {@link getLimit Limit} specifies how many items are requested for the page. Newly fetched data should be saved in {@link setData Data} property.

Since: 3.0

Author: Qiang Xue ([email protected])

Inheritance: extends Prado\TEventParameter

Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode	Description
__construct ( $pageIndex, $offset, $limit )	Constructor.
getData ( ) : mixed
getLimit ( ) : integer
getNewPageIndex ( ) : integer
getOffset ( ) : integer
setData ( $value )

Method Details

__construct() public méthode

Constructor.

public __construct ( $pageIndex, $offset, $limit )

getData() public méthode

public getData ( ) : mixed
Résultat	mixed	new page data

getLimit() public méthode

public getLimit ( ) : integer
Résultat	integer	number of items in the new page

getNewPageIndex() public méthode

public getNewPageIndex ( ) : integer
Résultat	integer	the zero-based index of the new page

getOffset() public méthode

public getOffset ( ) : integer
Résultat	integer	offset of the first item in the new page

setData() public méthode

public setData ( $value )