IDataProvider

Пакет	system.web
Наследование	интерфейс IDataProvider
Подклассы	CActiveDataProvider, CArrayDataProvider, CDataProvider, CSqlDataProvider
С	1.1
Исходный код	framework/base/interfaces.php

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

Поставщики данных — это компоненты, которые могут предоставлять данные для виджетов, таких как таблица данных, список данных. Помимо предоставления данных, они также поддерживают пагинацию и сортировку.

Общедоступные методы

Метод	Описание	Определено
getData()	Возвращает элементы данных, доступные в настоящее время.	IDataProvider
getId()	Возвращает уникальный идентификатор, который отличает поставщика данных от других поставщиков данных.	IDataProvider
getItemCount()	Возвращает количество элементов данных на текущей странице.	IDataProvider
getKeys()	Возвращает значения ключей, связанные с элементами данных.	IDataProvider
getPagination()	Возвращает объект пагинации. Если это false, это означает, что пагинация отключена.	IDataProvider
getSort()	Возвращает объект сортировки. Если это false, это означает, что сортировка отключена.	IDataProvider
getTotalItemCount()	Возвращает общее количество элементов данных.	IDataProvider

Подробное описание методов

getData() метод

abstract public array getData(boolean $refresh=false)
$refresh	boolean	влияет ли на повторное извлечение данных из постоянного хранилища.
{return}	массив	список элементов данных, доступных в данный момент в этом поставщике данных.

Исходный код: framework/base/interfaces.php#587 (показать)

public function getData($refresh=false);

Возвращает элементы данных, доступные в настоящее время.

getId() метод

abstract public string getId()
{return}	строка	уникальный идентификатор, который отличает поставщика данных от других поставщиков данных.

Исходный код: framework/base/interfaces.php#566 (показать)

public function getId();

getItemCount() метод

abstract public integer getItemCount(boolean $refresh=false)
$refresh	boolean	должно ли количество элементов данных пересчитываться.
{return}	целое число	количество элементов данных на текущей странице.

Исходный код: framework/base/interfaces.php#574 (показать)

public function getItemCount($refresh=false);

Возвращает количество элементов данных на текущей странице. Это эквивалентно count($provider->getData()). Когда пагинация установлена в false, это возвращает то же значение, что и totalItemCount.

getKeys() метод

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

Исходный код: framework/base/interfaces.php#594 (показать)

public function getKeys($refresh=false);

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

getPagination() метод

abstract public CPagination getPagination()
{return}	CPagination	объект пагинации. Если это false, это означает, что пагинация отключена.

Исходный код: framework/base/interfaces.php#602 (показать)

public function getPagination();

getSort() метод

abstract public CSort getSort()
{return}	CSort	объект сортировки. Если это false, это означает, что сортировка отключена.

Исходный код: framework/base/interfaces.php#598 (показать)

public function getSort();

getTotalItemCount() метод

abstract public integer getTotalItemCount(boolean $refresh=false)
$refresh	boolean	должно ли общее количество элементов данных пересчитываться.
{return}	целое число	общее количество возможных элементов данных.

Исходный код: framework/base/interfaces.php#581 (показать)

public function getTotalItemCount($refresh=false);

Возвращает общее количество элементов данных. Когда пагинация установлена в false, это возвращает то же значение, что и itemCount.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/IDataProvider