Interface yii\data\DataProviderInterface

所有类 | 方法

实现	yii\data\ActiveDataProvider, yii\data\ArrayDataProvider, yii\data\BaseDataProvider, yii\data\SqlDataProvider
可用版本自	2.0
源码	https://github.com/yiichina/yii2/blob/api/framework/data/DataProviderInterface.php

DataProviderInterface是数据提供器类必须实现的接口。

数据提供器是对数据进行排序和分页的组件，并将其提供给小部件如 yii\grid\GridView，yii\widgets\ListView。

有关 DataProviderInterface 的详细信息和使用信息，请参阅 guide article on data providers。

公共方法

方法	描述	被定义在
getCount()	返回当前页中的数据模型数。这相当于 `count($provider->getModels())`。当 pagination 为 false 时，这相当于 totalCount。	yii\data\DataProviderInterface
getKeys()	返回与数据模型关联的键值。	yii\data\DataProviderInterface
getModels()	返回当前页中的数据模型。	yii\data\DataProviderInterface
getPagination()		yii\data\DataProviderInterface
getSort()		yii\data\DataProviderInterface
getTotalCount()	返回数据模型总数。当 pagination 为 false 时，这相当于 count。	yii\data\DataProviderInterface
prepare()	准备数据模型和键。	yii\data\DataProviderInterface

getCount() 公共抽象方法

返回当前页中的数据模型数。这相当于 count($provider->getModels())。当 pagination 为 false 时，这相当于 totalCount。

public abstract integer getCount()
return	integer	当前页中的数据模型数。

getKeys() 公共抽象方法

返回与数据模型关联的键值。

public abstract array getKeys()
return	array	与 models 对应的键值列表。models 中的每个数据模型都由该数组中相应的键值唯一标识。

getModels() 公共抽象方法

返回当前页中的数据模型。

public abstract array getModels()
return	array	当前页中的数据模型列表。

getPagination() 公共抽象方法

public abstract yii\data\Pagination\|false getPagination()
return	yii\data\Pagination\|false	分页对象。如果为 false，则表示禁用分页。

getSort() 公共抽象方法

public abstract yii\data\Sort getSort()
return	yii\data\Sort	排序对象。如果为 false，则表示排序被禁用。

getTotalCount() 公共抽象方法

返回数据模型总数。当 pagination 为 false 时，这相当于 count。

public abstract integer getTotalCount()
return	integer	数据模型总数。

prepare() 公共抽象方法

准备数据模型和键。

此方法将准备可通过 getModels() 和 getKeys() 检索的数据模型和密钥。

如果没有调用此方法，则它将由 getModels() 和 getKeys() 隐式调用。

public abstract void prepare($forcePrepare = false)
$forcePrepare	boolean	是否强制进行数据准备，即使之前已经进行过。