PHP Интерфейс 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.
С версии: 2.0
Автор: Qiang Xue ([email protected])
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
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.

Описание методов

getCount() публичный Метод

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

getKeys() публичный Метод

Returns the key values associated with the data models.
public getKeys ( ) : array
Результат 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() публичный Метод

Returns the data models in the current page.
public getModels ( ) : array
Результат array the list of data models in the current page.

getPagination() публичный Метод

public getPagination ( ) : Pagination
Результат Pagination the pagination object. If this is false, it means the pagination is disabled.

getSort() публичный Метод

public getSort ( ) : Sort
Результат Sort the sorting object. If this is false, it means the sorting is disabled.

getTotalCount() публичный Метод

When [[getPagination|pagination]] is false, this is the same as [[getCount|count]].
public getTotalCount ( ) : integer
Результат integer total number of possible data models.

prepare() публичный Метод

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.