PRADO 3.0.6 : Vue détaillée de TPagedDataSource.php

TPagedDataSource, TPagedListIterator, TPagedMapIterator classes

Author:	Qiang Xue <qiang.xue@gmail.com>
Copyright:	Copyright © 2005 PradoSoft
License:	http://www.pradosoft.com/license/
Version:	$Id: TPagedDataSource.php 1397 2006-09-07 07:55:53Z wei $
Poids:	447 lignes (11 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Définit 3 classes

TPagedDataSource:: (20 méthodes):
  getDataSource()
  setDataSource()
  getPageSize()
  setPageSize()
  getCurrentPageIndex()
  setCurrentPageIndex()
  getAllowPaging()
  setAllowPaging()
  getAllowCustomPaging()
  setAllowCustomPaging()
  getVirtualItemCount()
  setVirtualItemCount()
  getCount()
  count()
  getPageCount()
  getIsFirstPage()
  getIsLastPage()
  getFirstIndexInPage()
  getDataSourceCount()
  getIterator()

TPagedListIterator:: (6 méthodes):
  __construct()
  rewind()
  key()
  current()
  next()
  valid()

TPagedMapIterator:: (6 méthodes):
  __construct()
  rewind()
  key()
  current()
  next()
  valid()

Classe: TPagedDataSource - X-Ref

TPagedDataSource class

TPagedDataSource implements an integer-indexed collection class with paging functionality.

Data items in TPagedDataSource can be traversed using <b>foreach</b>
PHP statement like the following,
<code>
foreach($pagedDataSource as $dataItem)
</code>
The data are fetched from {@link setDataSource DataSource}. Only the items
within the specified page will be returned and traversed.

getDataSource() X-Ref

return: mixed original data source. Defaults to null.

setDataSource($value) X-Ref

param: mixed original data source

getPageSize() X-Ref

return: integer number of items in each page. Defaults to 10.

setPageSize($value) X-Ref

param: integer number of items in each page

getCurrentPageIndex() X-Ref

return: integer current page index. Defaults to 0.

setCurrentPageIndex($value) X-Ref

param: integer current page index

getAllowPaging() X-Ref

return: boolean whether to allow paging. Defaults to false.

setAllowPaging($value) X-Ref

param: boolean whether to allow paging

getAllowCustomPaging() X-Ref

return: boolean whether to allow custom paging. Defaults to false.

setAllowCustomPaging($value) X-Ref

param: boolean whether to allow custom paging

getVirtualItemCount() X-Ref

return: integer user-assigned number of items in data source Defaults to 0.

setVirtualItemCount($value) X-Ref

param: integer user-assigned number of items in data source

getCount() X-Ref

return: integer number of items in current page

count() X-Ref

Returns the number of items in the current page.
This method is required by Countable interface.

return: integer number of items in the current page.

getPageCount() X-Ref

return: integer number of pages

getIsFirstPage() X-Ref

return: boolean whether the current page is the first page Defaults to false.

getIsLastPage() X-Ref

return: boolean whether the current page is the last page

getFirstIndexInPage() X-Ref

return: integer the index of the item in data source, where the item is the first in

getDataSourceCount() X-Ref

return: integer number of items in data source, if available

getIterator() X-Ref

return: Iterator iterator

Classe: TPagedListIterator - X-Ref

TPagedListIterator class

TPagedListIterator implements Iterator interface.

TPagedListIterator is used by {@link TPagedDataSource}. It allows TPagedDataSource
to return a new iterator for traversing the items in a {@link TList} object.

__construct(TList $list,$startIndex,$count) X-Ref

Constructor.

param: TList the data to be iterated through
param: integer start index
param: integer number of items to be iterated through

rewind() X-Ref

Rewinds internal array pointer.
This method is required by the interface Iterator.

key() X-Ref

Returns the key of the current array item.
This method is required by the interface Iterator.

return: integer the key of the current array item

current() X-Ref

Returns the current array item.
This method is required by the interface Iterator.

return: mixed the current array item

next() X-Ref

Moves the internal pointer to the next array item.
This method is required by the interface Iterator.

valid() X-Ref

Returns whether there is an item at current position.
This method is required by the interface Iterator.

return: boolean

Classe: TPagedMapIterator - X-Ref

TPagedMapIterator class

TPagedMapIterator implements Iterator interface.

TPagedMapIterator is used by {@link TPagedDataSource}. It allows TPagedDataSource
to return a new iterator for traversing the items in a {@link TMap} object.

__construct(TMap $map,$startIndex,$count) X-Ref

Constructor.

param: array the data to be iterated through