Interface yii\data\DataProviderInterface
| Implemented by | yii\data\ActiveDataProvider, yii\data\ArrayDataProvider, yii\data\BaseDataProvider, yii\data\SqlDataProvider, yii\sphinx\ActiveDataProvider |
|---|---|
| Available since version | 2.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.
Public Methods
| Method | Description | Defined 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
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.
| integer getCount( ) | ||
| return | integer | The number of data models in the current page. |
|---|---|---|
Returns the key values associated with the data models.
| 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. |
|---|---|---|
Returns the data models in the current page.
| array getModels( ) | ||
| return | array | The list of data models in the current page. |
|---|---|---|
| yii\data\Pagination getPagination( ) | ||
| return | yii\data\Pagination | The pagination object. If this is false, it means the pagination is disabled. |
|---|---|---|
| yii\data\Sort getSort( ) | ||
| return | yii\data\Sort | The sorting object. If this is false, it means the sorting is disabled. |
|---|---|---|
Returns the total number of data models.
When pagination is false, this is the same as count.
| integer getTotalCount( ) | ||
| return | integer | Total number of possible data models. |
|---|---|---|
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.
| void prepare( $forcePrepare = false ) | ||
| $forcePrepare | boolean | Whether to force data preparation even if it has been done before. |