PHP Класс Prado\Collections\TPagedDataSource

TPagedDataSource implements an integer-indexed collection class with paging functionality. Data items in TPagedDataSource can be traversed using foreach PHP statement like the following,


foreach($pagedDataSource as $dataItem)

The data are fetched from {@link setDataSource DataSource}. Only the items within the specified page will be returned and traversed.

С версии: 3.0

Автор: Qiang Xue ([email protected])

Наследование: extends Prado\TComponent, implements IteratorAggregate, implements Countable

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
count ( ) : integer	Returns the number of items in the current page.
getAllowCustomPaging ( ) : boolean
getAllowPaging ( ) : boolean
getCount ( ) : integer
getCurrentPageIndex ( ) : integer
getDataSource ( ) : mixed
getDataSourceCount ( ) : integer
getFirstIndexInPage ( ) : integer
getIsFirstPage ( ) : boolean
getIsLastPage ( ) : boolean
getIterator ( ) : Iterator
getPageCount ( ) : integer
getPageSize ( ) : integer
getVirtualItemCount ( ) : integer
setAllowCustomPaging ( $value )
setAllowPaging ( $value )
setCurrentPageIndex ( $value )
setDataSource ( $value )
setPageSize ( $value )
setVirtualItemCount ( $value )

Описание методов

count() публичный Метод

This method is required by \Countable interface.

public count ( ) : integer
Результат	integer	number of items in the current page.

getAllowCustomPaging() публичный Метод

public getAllowCustomPaging ( ) : boolean
Результат	boolean	whether to allow custom paging. Defaults to false.

getAllowPaging() публичный Метод

public getAllowPaging ( ) : boolean
Результат	boolean	whether to allow paging. Defaults to false.

getCount() публичный Метод

public getCount ( ) : integer
Результат	integer	number of items in current page

getCurrentPageIndex() публичный Метод

public getCurrentPageIndex ( ) : integer
Результат	integer	current page index. Defaults to 0.

getDataSource() публичный Метод

public getDataSource ( ) : mixed
Результат	mixed	original data source. Defaults to null.

getDataSourceCount() публичный Метод

public getDataSourceCount ( ) : integer
Результат	integer	number of items in data source, if available

getFirstIndexInPage() публичный Метод

public getFirstIndexInPage ( ) : integer
Результат	integer	the index of the item in data source, where the item is the first in current page

getIsFirstPage() публичный Метод

public getIsFirstPage ( ) : boolean
Результат	boolean	whether the current page is the first page Defaults to false.

getIsLastPage() публичный Метод

public getIsLastPage ( ) : boolean
Результат	boolean	whether the current page is the last page

getIterator() публичный Метод

public getIterator ( ) : Iterator
Результат	Iterator	iterator

getPageCount() публичный Метод

public getPageCount ( ) : integer
Результат	integer	number of pages

getPageSize() публичный Метод

public getPageSize ( ) : integer
Результат	integer	number of items in each page. Defaults to 10.

getVirtualItemCount() публичный Метод

public getVirtualItemCount ( ) : integer
Результат	integer	user-assigned number of items in data source Defaults to 0.

setAllowCustomPaging() публичный Метод

public setAllowCustomPaging ( $value )

setAllowPaging() публичный Метод

public setAllowPaging ( $value )

setCurrentPageIndex() публичный Метод

public setCurrentPageIndex ( $value )

setDataSource() публичный Метод

public setDataSource ( $value )

setPageSize() публичный Метод

public setPageSize ( $value )

setVirtualItemCount() публичный Метод

public setVirtualItemCount ( $value )