0 关注者

接口 yii\data\DataProviderInterface

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

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

数据提供者是排序和分页数据，并将其提供给诸如 yii\grid\GridView, yii\widgets\ListView 的组件。

有关 DataProviderInterface 的更多详细信息和使用信息，请参阅有关数据提供者的指南文章。

公共方法

方法	描述	定义于
getCount()	返回当前页面中数据模型的数量。	yii\data\DataProviderInterface
getKeys()	返回与数据模型关联的键值。	yii\data\DataProviderInterface
getModels()	返回当前页面中的数据模型。	yii\data\DataProviderInterface
getPagination()		yii\data\DataProviderInterface
getSort()		yii\data\DataProviderInterface
getTotalCount()	返回数据模型的总数。	yii\data\DataProviderInterface
prepare()	准备数据模型和键。	yii\data\DataProviderInterface

getCount() 公共抽象方法

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

这等效于 count($provider->getModels())。当分页为 false 时，这与 totalCount 相同。

public abstract integer getCount ( )
返回值	integer	当前页面中数据模型的数量。

                public function getCount();

getKeys() 公共抽象方法

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

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

                public function getKeys();

getModels() 公共抽象方法

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

public abstract array getModels ( )
返回值	array	当前页面中的数据模型列表。

                public function getModels();

getPagination() 公共抽象方法

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

                public function getPagination();

getSort() 公共抽象方法

public abstract yii\data\Sort\|false getSort ( )
返回值	yii\data\Sort\|false	排序对象。如果为 false，则表示已禁用排序。

                public function getSort();

getTotalCount() 公共抽象方法

返回数据模型的总数。

当分页为 false 时，这与 count 相同。

public abstract integer getTotalCount ( )
返回值	integer	可能的总数据模型数量。

                public function getTotalCount();

prepare() 公共抽象方法

准备数据模型和键。

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

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

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

                public function prepare($forcePrepare = false);