Interface IDataProvider

IDataProvider is the interface that must be implemented by data provider classes.

Data providers are components that can feed data for widgets such as data grid, data list. Besides providing data, they also support pagination and sorting.

Direct known implementers

CDataProvider

Indirect known implementers

CActiveDataProvider, CArrayDataProvider, CSqlDataProvider, FileSystemObjectDataProvider, SmartActiveDataProvider

Package: system\web
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.1
Located at x2engine/framework/base/interfaces.php

Methods summary
`public string`	# `getId( )` Returns `string` the unique ID that identifies the data provider from other data providers.
`public integer`	# `getItemCount( boolean $refresh = false )` Returns the number of data items in the current page. This is equivalent to `<span class="php-keyword2">count</span>(<span class="php-var">$provider</span>->getData())`. When pagination is set false, this returns the same value as totalItemCount. Returns the number of data items in the current page. This is equivalent to `<span class="php-keyword2">count</span>(<span class="php-var">$provider</span>->getData())`. When pagination is set false, this returns the same value as totalItemCount. Parameters `$refresh` `boolean` $refresh whether the number of data items should be re-calculated. Returns `integer` the number of data items in the current page.
`public integer`	# `getTotalItemCount( boolean $refresh = false )` Returns the total number of data items. When pagination is set false, this returns the same value as itemCount. Returns the total number of data items. When pagination is set false, this returns the same value as itemCount. Parameters `$refresh` `boolean` $refresh whether the total number of data items should be re-calculated. Returns `integer` total number of possible data items.
`public array`	# `getData( boolean $refresh = false )` Returns the data items currently available. Returns the data items currently available. Parameters `$refresh` `boolean` $refresh whether the data should be re-fetched from persistent storage. Returns `array` the list of data items currently available in this data provider.
`public array`	# `getKeys( boolean $refresh = false )` Returns the key values associated with the data items. Returns the key values associated with the data items. Parameters `$refresh` `boolean` $refresh whether the keys should be re-calculated. Returns `array` the list of key values corresponding to data. Each data item in data is uniquely identified by the corresponding key value in this array.
`public CSort`	# `getSort( )` Returns `CSort` the sorting object. If this is false, it means the sorting is disabled.
`public CPagination`	# `getPagination( )` Returns `CPagination` the pagination object. If this is false, it means the pagination is disabled.

Packages

Classes

Interfaces

Interface IDataProvider

Direct known implementers

Indirect known implementers

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns