Class SmartActiveDataProvider

CActiveDataProvider with persistent sort order and filters and optional id checksum calculation

CComponent

Extended by

CDataProvider implements IDataProvider

Extended by

CActiveDataProvider

Extended by

SmartActiveDataProvider

Package: application\components
Located at x2engine/protected/components/SmartActiveDataProvider.php

Methods summary
`public`	# `__construct( string $modelClass, array $config = array() )` Overrides parent __construct (). Overrides parent __construct (). Parameters `$modelClass` `string` $uid (optional) If set, will be used to uniquely identify this data provider. This overrides the default behavior of using the model name as the uid. This method is Copyright (c) 2008-2014 by Yii Software LLC http://www.yiiframework.com/license/ `$config` `array` $config configuration (name=>value) to be applied as the initial property values of this class. Overrides `CActiveDataProvider::__construct()`
`public CPagination`	# `getPagination( )` Returns the pagination object. Returns the pagination object. Returns `CPagination` the pagination object. If this is false, it means the pagination is disabled. Overrides `CDataProvider::getPagination()`
`protected array`	# `fetchData( )` Overrides parent fetchData (). Fetches the data from the persistent data storage. Overrides parent fetchData (). Fetches the data from the persistent data storage. Modified to always sort by id DESC as well as the chosen sort Returns `array` list of data items Throws `CException` if checksum couldn't be generated correctly This method is Copyright (c) 2008-2014 by Yii Software LLC http://www.yiiframework.com/license/ Overrides `CActiveDataProvider::fetchData()`
`public`	# `getIdChecksum( )` Throws `CException` if fetchData has not yet been called
`public`	# `getRecordIds( )` Throws `CException` if fetchData has not yet been called
`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. Overrides `CDataProvider::getData()`
`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. Overrides `CDataProvider::getKeys()`
`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. Overrides `CDataProvider::getTotalItemCount()`
`public type`	# `calculateTotalItemCount( )` Generates the item count without eager loading, to improve performance. Generates the item count without eager loading, to improve performance. Returns `type` Overrides `CActiveDataProvider::calculateTotalItemCount()`
`public static string`	# `calculateChecksumFromIds( array $ids )` Parameters `$ids` `array` ids array on integers Returns `string`

Methods inherited from CActiveDataProvider
`fetchKeys(), getCountCriteria(), getCriteria(), getModel(), getSort(), setCountCriteria(), setCriteria()`

Methods inherited from CDataProvider
`getId(), getItemCount(), setData(), setId(), setKeys(), setPagination(), setSort(), setTotalItemCount()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public mixed`	`$uid`	`null`	#
`public boolean`	`$dbPersistentGridSettings`	`false`	#
`public boolean`	`$disablePersistentGridSettings`	`false`	#
`public boolean`	`$calculateChecksum`	`false`	# $calculateChecksum If true, id checksum will be calculated when data is fetched. This also disables the ability to refresh the data provider $calculateChecksum If true, id checksum will be calculated when data is fetched. This also disables the ability to refresh the data provider

Properties inherited from CActiveDataProvider
`$keyAttribute, $model, $modelClass`

Magic properties inherited from CActiveDataProvider
`$countCriteria, $criteria, $sort`

Magic properties inherited from CDataProvider
`$data, $id, $itemCount, $keys, $pagination, $totalItemCount`