Interface yii\data\DataProviderInterface

Implemented byyii\data\ActiveDataProvider, yii\data\ArrayDataProvider, yii\data\BaseDataProvider, yii\data\SqlDataProvider, yii\debug\models\timeline\DataProvider, yii\elasticsearch\ActiveDataProvider, yii\sphinx\ActiveDataProvider
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/data/DataProviderInterface.php

DataProviderInterface is the interface that must be implemented by data provider classes.

Data providers are components that sort and paginate data, and provide them to widgets such as yii\grid\GridView, yii\widgets\ListView.

For more details and usage information on DataProviderInterface, see the guide article on data providers.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getCount() Returns the number of data models in the current page. yii\data\DataProviderInterface
getKeys() Returns the key values associated with the data models. yii\data\DataProviderInterface
getModels() Returns the data models in the current page. yii\data\DataProviderInterface
getPagination() yii\data\DataProviderInterface
getSort() yii\data\DataProviderInterface
getTotalCount() Returns the total number of data models. yii\data\DataProviderInterface
prepare() Prepares the data models and keys. yii\data\DataProviderInterface

Method Details

getCount() public abstract method

Returns the number of data models in the current page.

This is equivalent to count($provider->getModels()). When pagination is false, this is the same as totalCount.

public abstract integer getCount ( )
return integer

The number of data models in the current page.

getKeys() public abstract method

Returns the key values associated with the data models.

public abstract array getKeys ( )
return array

The list of key values corresponding to models. Each data model in models is uniquely identified by the corresponding key value in this array.

getModels() public abstract method

Returns the data models in the current page.

public abstract array getModels ( )
return array

The list of data models in the current page.

getPagination() public abstract method

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

The pagination object. If this is false, it means the pagination is disabled.

getSort() public abstract method

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

The sorting object. If this is false, it means the sorting is disabled.

getTotalCount() public abstract method

Returns the total number of data models.

When pagination is false, this is the same as count.

public abstract integer getTotalCount ( )
return integer

Total number of possible data models.

prepare() public abstract method

Prepares the data models and keys.

This method will prepare the data models and keys that can be retrieved via getModels() and getKeys().

This method will be implicitly called by getModels() and getKeys() if it has not been called before.

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

Whether to force data preparation even if it has been done before.