You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
60 lines
1.8 KiB
60 lines
1.8 KiB
12 years ago
|
<?php
|
||
|
|
/**
|
||
|
|
* @link http://www.yiiframework.com/
|
||
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
||
|
|
* @license http://www.yiiframework.com/license/
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace yii\data;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* IDataProvider is the interface that must be implemented by data provider classes.
|
||
|
|
*
|
||
|
|
* Data providers are components that can provide data that are sorted and paginated.
|
||
|
|
* Data providers are often used with widgets, such as [[GridView]], [[ListView]]
|
||
|
|
* that display data and support sorting and pagination.
|
||
|
|
*
|
||
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
||
|
|
* @since 2.0
|
||
|
|
*/
|
||
|
|
interface IDataProvider
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Returns the number of data items in the current page.
|
||
|
|
* This is equivalent to `count($provider->getItems())`.
|
||
|
|
* When [[pagination]] is false, this is the same as [[totalItemCount]].
|
||
|
|
* @return integer the number of data items in the current page.
|
||
|
|
*/
|
||
|
|
public function getItemCount();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the total number of data items.
|
||
|
|
* When [[pagination]] is false, this is the same as [[itemCount]].
|
||
|
|
* @return integer total number of possible data items.
|
||
|
|
*/
|
||
|
|
public function getTotalItemCount();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the data items in the current page.
|
||
|
|
* @return array the list of data items in the current page.
|
||
|
|
*/
|
||
|
|
public function getItems();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the key values associated with the data items.
|
||
|
|
* @return array the list of key values corresponding to [[items]]. Each data item in [[items]]
|
||
|
|
* is uniquely identified by the corresponding key value in this array.
|
||
|
|
*/
|
||
|
|
public function getKeys();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return Sort the sorting object. If this is false, it means the sorting is disabled.
|
||
|
|
*/
|
||
|
|
public function getSort();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return Pagination the pagination object. If this is false, it means the pagination is disabled.
|
||
|
|
*/
|
||
|
|
public function getPagination();
|
||
|
|
}
|