IDataProvider - YII 类库手册

所有包 | 方法

包	system.web
继承	interface IDataProvider
子类	CActiveDataProvider, CArrayDataProvider, CDataProvider, CSqlDataProvider
源自	1.1
版本	$Id: interfaces.PHP 3515 2011-12-28 12:29:24Z mDOMba $
源码

IDataProvider是数据提供者类必须实现的接口。

数据提供者组件能够为挂件，如data grid，data list提供数据。除了提供数据，它也支持分页与排序。

公共方法

方法	描述	定义在
getData()	返回当前可用数据项。	IDataProvider
getId()	返回唯一ID用来区分其它数据提供者。	IDataProvider
getItemCount()	返回当页面数据项的数量。	IDataProvider
getKeys()	Returns the key values associated with the data items.	IDataProvider
getPagination()	返回分页对象。如果为false，意味着禁用分页。	IDataProvider
getSort()	返回排序对象。如果为false，意味禁用排序。	IDataProvider
getTotalItemCount()	返回数据项总数量。	IDataProvider

getData() 方法

abstract public array getData(boolean $refresh=false)
$refresh	boolean	是否从持久存储中重新计算。
{return}	array	数据提供者中当前可用的数据项列表。


public function getData($refresh=false);

返回当前可用数据项。

getId() 方法

abstract public string getId()
{return}	string	唯一ID用来区分其它数据提供者。


public function getId();

getItemCount() 方法

abstract public integer getItemCount(boolean $refresh=false)
$refresh	boolean	是否重新计算数据项中的数量。
{return}	integer	当页面数据项的数量。


public function getItemCount($refresh=false);

返回当页面数据项的数量。这相当于count($provider->getData())。当pagination设置为false，它与totalItemCount返回同样的值。

getKeys() 方法

abstract public array getKeys(boolean $refresh=false)
$refresh	boolean	是否应该重新计算
{return}	array	键值对应的data列表。数组中的每一个键唯一对应data中每一个数据项。


public function getKeys($refresh=false);

Returns the key values associated with the data items.

getPagination() 方法

abstract public CPagination getPagination()
{return}	CPagination	分页对象。如果为false，意味着禁用分页。


public function getPagination();

getSort() 方法

abstract public CSort getSort()
{return}	CSort	排序对象。如果为false，意味禁用排序。


public function getSort();

getTotalItemCount() 方法

abstract public integer getTotalItemCount(boolean $refresh=false)
$refresh	boolean	是否重新计算数据项中的数量。
{return}	integer	数据项总数量。


public function getTotalItemCount($refresh=false);

返回数据项总数量。当pagination设置为false，它与itemCount返回同样的值。