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

Datei anzeigen Open project: pradosoft/prado

Public Methods

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

Method Details

__construct() public method

Constructor.

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

getData() public method

public getData ( ) : mixed
return	mixed	new page data

getLimit() public method

public getLimit ( ) : integer
return	integer	number of items in the new page

getNewPageIndex() public method

public getNewPageIndex ( ) : integer
return	integer	the zero-based index of the new page

getOffset() public method

public getOffset ( ) : integer
return	integer	offset of the first item in the new page

setData() public method

public setData ( $value )