Абстрактный класс yii\data\BaseDataProvider

public integer getCount ( )

public string $id = null

public array getKeys ( )
public void setKeys ( $keys )

public array getModels ( )
public void setModels ( $models )

public yii\data\Pagination|false getPagination ( )
public void setPagination ( $value )

public yii\data\Sort|boolean getSort ( )
public void setSort ( $value )

public integer getTotalCount ( )
public void setTotalCount ( $value )

getCount() public method

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

public integer getCount ( )
return	integer	Количество моделей данных на текущей странице.

getKeys() public method

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

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

getModels() public method

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

public array getModels ( )
return	array	Список моделей данных на текущей странице.

getPagination() public method

Возвращает объект пагинации, используемый этим поставщиком данных.

Обратите внимание, что вам следует сначала вызвать prepare() или getModels(), чтобы получить правильные значения yii\data\Pagination::$totalCount и yii\data\Pagination::$pageCount.

public yii\data\Pagination|false getPagination ( )
return	yii\data\Pagination|false	Объект пагинации. Если это false, это означает, что пагинация отключена.

getSort() public method

Возвращает объект сортировки, используемый этим поставщиком данных.

public yii\data\Sort|boolean getSort ( )
return	yii\data\Sort|boolean	Объект сортировки. Если это false, это означает, что сортировка отключена.

getTotalCount() public method

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

Когда $pagination ложно, это возвращает то же значение, что и $count. В противном случае вызовется prepareTotalCount(), чтобы получить счет.

public integer getTotalCount ( )
return	integer	Общее количество возможных моделей данных.

init() public method

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.

public void init ( )

prepare() public method

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

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

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

public void prepare ( $forcePrepare = false )
$forcePrepare	boolean	Требуется ли принудительная подготовка данных, даже если она уже была выполнена ранее.

prepareKeys() protected abstract method

Подготавливает ключи, связанные с текущими доступными моделями данных.

protected abstract array prepareKeys ( $models )
$models	array	Доступные модели данных
return	array	Ключи

prepareModels() protected abstract method

Подготавливает модели данных, которые будут доступны на текущей странице.

protected abstract array prepareModels ( )
return	array	Доступные модели данных

prepareTotalCount() protected abstract method

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

protected abstract integer prepareTotalCount ( )
return	integer	Общее количество моделей данных в этом поставщике данных.

refresh() public method

Обновляет поставщик данных.

После вызова этого метода, если getModels(), getKeys() или getTotalCount() вызываются снова, они повторно выполнят запрос и вернут последние доступные данные.

public void refresh ( )

setKeys() public method

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

public void setKeys ( $keys )
$keys	array	Список значений ключей, соответствующих $models.

setModels() public method

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

public void setModels ( $models )
$models	array	Модели на текущей странице

setPagination() public method

Устанавливает пагинацию для этого поставщика данных.

public void setPagination ( $value )
$value	array|yii\data\Pagination|boolean	Пагинация, которая должна использоваться этим поставщиком данных. Это может быть одно из следующих: массив конфигурации для создания объекта пагинации. Элемент "class" по умолчанию равен 'yii\data\Pagination' экземпляр yii\data\Pagination или его подкласса false, если пагинация должна быть отключена.
throws	yii\base\InvalidParamException

setSort() public method

Устанавливает определение сортировки для этого поставщика данных.

public void setSort ( $value )
$value	array|yii\data\Sort|boolean	Определение сортировки, которое должно использоваться этим поставщиком данных. Это может быть одно из следующих: массив конфигурации для создания объекта определения сортировки. Элемент "class" по умолчанию равен 'yii\data\Sort' экземпляр yii\data\Sort или его подкласса false, если сортировка должна быть отключена.
throws	yii\base\InvalidParamException

setTotalCount() public method

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

public void setTotalCount ( $value )
$value	integer	Общее количество моделей данных.