Class: PhpExt_Data_GroupingStore

Source Location: /PhpExt/Data/GroupingStore.php

Class PhpExt_Data_GroupingStore

Class Overview

A specialized store implementation that provides for grouping records by one of the available fields.

Located in /PhpExt/Data/GroupingStore.php [line 25]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Data_Store
         |
         --PhpExt_Data_GroupingStore

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Observable

PhpExt_Observable::$_listeners

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Data_Store

PhpExt_Data_Store::__construct()

PhpExt_Data_Store::getAutoLoad()

If passed, this store's load method is automatically called after creation with the autoLoad object

PhpExt_Data_Store::getBaseParams()

An object containing properties which are to be sent as parameters on any HTTP request

PhpExt_Data_Store::getData()

Inline data to be loaded when the store is initialized.

PhpExt_Data_Store::getProxy()

The Proxy object which provides access to a data object.

PhpExt_Data_Store::getPruneModifiedRecords()

True to clear all modified record information each time the store is loaded or when a record is removed. (defaults to false).

PhpExt_Data_Store::getReader()

The Reader object which processes the data object and returns an Array of Ext.data.record objects which are cached keyed by their id property.

PhpExt_Data_Store::getRemoteSort()

True if sorting is to be handled by requesting the Proxy to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).

PhpExt_Data_Store::getSortInfo()

SortInfo Configuration Object

PhpExt_Data_Store::getStoreId()

If passed, the id to use to register with the StoreMgr

PhpExt_Data_Store::getUrl()

If passed, an HttpProxy is created for the passed URL

PhpExt_Data_Store::load()

Loads the Record cache from the configured Proxy using the configured Reader.

PhpExt_Data_Store::loadData()

Loads data from a passed data block. A Reader which understands the format of the data must have been configured in the constructor.

PhpExt_Data_Store::setAutoLoad()

If passed, this store's load method is automatically called after creation with the autoLoad object

PhpExt_Data_Store::setBaseParams()

An array containing properties which are to be sent as parameters on any HTTP request.

PhpExt_Data_Store::setData()

Inline data to be loaded when the store is initialized.

PhpExt_Data_Store::setProxy()

The Proxy object which provides access to a data object.

PhpExt_Data_Store::setPruneModifiedRecords()

True to clear all modified record information each time the store is loaded or when a record is removed. (defaults to false).

PhpExt_Data_Store::setReader()

The Reader object which processes the data object and returns an Array of Ext.data.record objects which are cached keyed by their id property.

PhpExt_Data_Store::setRemoteSort()

True if sorting is to be handled by requesting the Proxy to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).

PhpExt_Data_Store::setSortInfo()

SortInfo Configuration Object

PhpExt_Data_Store::setStoreId()

If passed, the id to use to register with the StoreMgr

PhpExt_Data_Store::setUrl()

If passed, an HttpProxy is created for the passed URL

Inherited From PhpExt_Observable

PhpExt_Observable::__construct()

PhpExt_Observable::attachListener()

Adds a PhpExt_Listener to the specified $eventName. This lintener will execute when the Javascript object fires that event.

PhpExt_Observable::getConfigParams()

PhpExt_Observable::getListeners()

Inherited From PhpExt_Object

PhpExt_Object::__construct()

PhpExt_Object::addValidConfigProperties()

PhpExt_Object::createMethodSignature()

PhpExt_Object::getConfigParams()

PhpExt_Object::getExtConfigProperty()

PhpExt_Object::getJavascript()

PhpExt_Object::getMethodInvokeStm()

PhpExt_Object::isExtObject()

PhpExt_Object::paramToString()

PhpExt_Object::setExtClassInfo()

PhpExt_Object::setExtConfigProperty()

PhpExt_Object::__get()

PhpExt_Object::__set()

[ Top ]

Method Summary

PhpExt_Data_GroupingStore	__construct()
string	getGroupField()	The field name by which to sort the store's data (defaults to '').
boolean	getGroupOnSort()	True to sort the data on the grouping field when a grouping operation occurs, false to sort based on the existing sort info (defaults to false).
boolean	getRemoteGroup()	True if the grouping should apply on the server side, false if it is local only (defaults to false). If the grouping is local, it can be applied immediately to the data. If it is remote, then it will simply act as a helper, automatically sending the grouping field name as the 'groupBy' param with each XHR call.
PhpExt_Data_GroupingStore	setGroupField()	The field name by which to sort the store's data (defaults to '').
PhpExt_Data_GroupingStore	setGroupOnSort()	True to sort the data on the grouping field when a grouping operation occurs, false to sort based on the existing sort info (defaults to false).
PhpExt_Data_GroupingStore	setRemoteGroup()	True if the grouping should apply on the server side, false if it is local only (defaults to false). If the grouping is local, it can be applied immediately to the data. If it is remote, then it will simply act as a helper, automatically sending the grouping field name as the 'groupBy' param with each XHR call.

[ Top ]

Properties

Methods

Constructor __construct [line 81]

PhpExt_Data_GroupingStore __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Data_Store::__construct()

[ Top ]

getGroupField [line 41]

string getGroupField(
)

The field name by which to sort the store's data (defaults to '').

API Tags:

Access:

public

[ Top ]

getGroupOnSort [line 59]

boolean getGroupOnSort(
)

True to sort the data on the grouping field when a grouping operation occurs, false to sort based on the existing sort info (defaults to false).

API Tags:

Access:

public

[ Top ]

getRemoteGroup [line 77]

boolean getRemoteGroup(
)

True if the grouping should apply on the server side, false if it is local only (defaults to false). If the grouping is local, it can be applied immediately to the data. If it is remote, then it will simply act as a helper, automatically sending the grouping field name as the 'groupBy' param with each XHR call.

API Tags:

Access:

public

[ Top ]

setGroupField [line 33]

PhpExt_Data_GroupingStore setGroupField(
string
$value 
)

The field name by which to sort the store's data (defaults to '').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setGroupOnSort [line 51]

PhpExt_Data_GroupingStore setGroupOnSort(
boolean
$value 
)

True to sort the data on the grouping field when a grouping operation occurs, false to sort based on the existing sort info (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setRemoteGroup [line 69]

PhpExt_Data_GroupingStore setRemoteGroup(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:54:50 -0500 by phpDocumentor 1.4.0