Interface yii\data\DataProviderInterface

Implemented byyii\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 的更多详细信息和使用信息, 请参阅 权威指南 - 显示数据 - 数据提供器(Data Providers).

公共方法

隐藏继承的方法

方法描述定义在
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() public abstract 方法

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

这相当于count($provider->getModels()).

paginationfalse时, 与 totalCount 相同.

public abstract integer getCount ( )
return integer

当前页面中的数据模型的数量.

getKeys() public abstract 方法

返回与数据模型关联的键值列表.

public abstract array getKeys ( )
return array

models 对应的键值列表. models 中的每个数据模型都由该数组中相应的键值唯一标识.

getModels() public abstract 方法

返回当前页面中的数据模型列表.

public abstract array getModels ( )
return array

当前页面中的数据模型列表.

getPagination() public abstract 方法

返回此数据提供者使用的分页对象.

public abstract yii\data\Pagination|false getPagination ( )
return yii\data\Pagination|false

分页对象. 如果为false, 则表示分页被禁用.

getSort() public abstract 方法

返回此数据提供者使用的排序对象.

public abstract yii\data\Sort getSort ( )
return yii\data\Sort

排序对象. 如果为false, 则表示排序被禁用.

getTotalCount() public abstract 方法

返回数据模型的总数.

paginationfalse时, 与 count 相同.

public abstract integer getTotalCount ( )
return integer

可能的数据模型的总数.

prepare() public abstract 方法

准备数据模型和键.

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

如果之前没有调用过该方法, 则将由 getModels()getKeys() 隐式调用.

public abstract void prepare ( $forcePrepare false )
$forcePrepare boolean

是否强制数据准备, 即使之前已经完成.