PHP Interface yii\data\DataProviderInterface

Data providers are components that sort and paginate data, and provide them to widgets such as GridView, ListView. For more details and usage information on DataProviderInterface, see the guide article on data providers.
Since: 2.0
Author: Qiang Xue ([email protected])
显示文件 Open project: yiisoft/yii2 Interface Usage Examples

Public Methods

Method Description
getCount ( ) : integer Returns the number of data models in the current page.
getKeys ( ) : array Returns the key values associated with the data models.
getModels ( ) : array Returns the data models in the current page.
getPagination ( ) : Pagination
getSort ( ) : Sort
getTotalCount ( ) : integer Returns the total number of data models.
prepare ( boolean $forcePrepare = false ) Prepares the data models and keys.

Method Details

getCount() public method

This is equivalent to count($provider->getModels()). When [[getPagination|pagination]] is false, this is the same as [[getTotalCount|totalCount]].
public getCount ( ) : integer
return integer the number of data models in the current page.

getKeys() public method

Returns the key values associated with the data models.
public getKeys ( ) : array
return array the list of key values corresponding to [[getModels|models]]. Each data model in [[getModels|models]] is uniquely identified by the corresponding key value in this array.

getModels() public method

Returns the data models in the current page.
public getModels ( ) : array
return array the list of data models in the current page.

getPagination() public method

public getPagination ( ) : Pagination
return Pagination the pagination object. If this is false, it means the pagination is disabled.

getSort() public method

public getSort ( ) : Sort
return Sort the sorting object. If this is false, it means the sorting is disabled.

getTotalCount() public method

When [[getPagination|pagination]] is false, this is the same as [[getCount|count]].
public getTotalCount ( ) : integer
return integer total number of possible data models.

prepare() public method

This method will prepare the data models and keys that can be retrieved via DataProviderInterface::getModels and DataProviderInterface::getKeys. This method will be implicitly called by DataProviderInterface::getModels and DataProviderInterface::getKeys if it has not been called before.
public prepare ( boolean $forcePrepare = false )
$forcePrepare boolean whether to force data preparation even if it has been done before.