Spec-Zone.ru › Yii 2.0

Интерфейс yii\data\DataProviderInterface

Все классы | Методы
Реализовано в yii\data\ActiveDataProvider, yii\data\ArrayDataProvider, yii\data\BaseDataProvider, yii\data\SqlDataProvider, yii\debug\models\timeline\DataProvider, yii\elasticsearch\ActiveDataProvider, yii\sphinx\ActiveDataProvider
Доступна с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/data/DataProviderInterface.php

DataProviderInterface — это интерфейс, который должен быть реализован классами поставщиков данных.

Поставщики данных — это компоненты, которые сортируют и постраничивают данные, и предоставляют их таким виджетам, как yii\grid\GridView, yii\widgets\ListView.

Для получения дополнительной информации и справочной информации по DataProviderInterface см. статью руководства по поставщикам данных.

Публичные методы

Метод Описание Определено в
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 method

Возвращает количество моделей данных на текущей странице.

Это эквивалентно count($provider->getModels()). Когда пагинация выключена, это то же самое, что и totalCount.

public abstract integer getCount ( )
return integer

Количество моделей данных на текущей странице.

getKeys() public abstract method

Возвращает значения ключей, связанные с моделями данных.

public abstract array getKeys ( )
return array

Список значений ключей, соответствующих моделям. Каждая модель данных в models уникально идентифицируется соответствующим значением ключа в этом массиве.

getModels() public abstract method

Возвращает модели данных на текущей странице.

public abstract array getModels ( )
return array

Список моделей данных на текущей странице.

getPagination() public abstract method

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

Объект пагинации. Если это false, значит, пагинация отключена.

getSort() public abstract method

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

Объект сортировки. Если это false, значит, сортировка отключена.

getTotalCount() public abstract method

Возвращает общее количество моделей данных.

Когда пагинация выключена, это то же самое, что и count.

public abstract integer getTotalCount ( )
return integer

Общее количество возможных моделей данных.

prepare() public abstract method

Подготавливает модели данных и ключи.

Этот метод подготовит модели данных и ключи, которые можно получить через getModels() и getKeys().

Этот метод будет неявно вызван getModels() и getKeys(), если он не был вызван ранее.

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

Выполнять ли принудительную подготовку данных, даже если она уже была выполнена.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-data-dataproviderinterface.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API