Class: PhpExt_Data_SimpleStore

Source Location: /PhpExt/Data/SimpleStore.php

Class PhpExt_Data_SimpleStore

Class Overview

Small helper class to make creating Stores from Array data easier.

Located in /PhpExt/Data/SimpleStore.php [line 28]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Data_Store
         |
         --PhpExt_Data_SimpleStore

Properties

$_fields

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 ]

Property Summary

PhpExt_Data_FieldConfigObjectCollection

$_fields

[ Top ]

Method Summary

PhpExt_Data_SimpleStore	__construct()
PhpExt_Data_FieldConfigObject	addField()
array\|PhpExt_JavascriptStm	getData()	The multi-dimensional array of data
PhpExt_Data_FieldConfigObject	getField()
PhpExt_Data_FieldConfigObjectCollection	getFields()	Fields Collection
integer	getId()	The array index of the record id. Leave blank to auto generate ids.
PhpExt_Data_SimpleStore	setData()	The multi-dimensional array of data
PhpExt_Data_SimpleStore	setId()	The array index of the record id. Leave blank to auto generate ids.

[ Top ]

Properties

PhpExt_Data_FieldConfigObjectCollection $_fields = null [line 50]

API Tags:

Access:

public

[ Top ]

Methods

Constructor __construct [line 98]

PhpExt_Data_SimpleStore __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Data_Store::__construct()

[ Top ]

addField [line 65]

PhpExt_Data_FieldConfigObject addField(
PhpExt_Data_FieldConfigObject|string
$field 
)

Parameters:

PhpExt_Data_FieldConfigObject|string

$field:

API Tags:

Access:

public

[ Top ]

getData [line 43]

array|PhpExt_JavascriptStm getData(
)

The multi-dimensional array of data

API Tags:

Access:

public

Redefinition of:

PhpExt_Data_Store::getData(): Inline data to be loaded when the store is initialized.

[ Top ]

getField [line 75]

PhpExt_Data_FieldConfigObject getField(

$name 
)

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

getFields [line 57]

PhpExt_Data_FieldConfigObjectCollection getFields(
)

Fields Collection

API Tags:

Access:

public

[ Top ]

getId [line 93]

integer getId(
)

The array index of the record id. Leave blank to auto generate ids.

API Tags:

Access:

public

[ Top ]

setData [line 36]

PhpExt_Data_SimpleStore setData(
array|PhpExt_JavascriptStm
$value 
)

The multi-dimensional array of data

Parameters:

array|PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

Redefinition of:

PhpExt_Data_Store::setData(): Inline data to be loaded when the store is initialized.

[ Top ]

setId [line 85]

PhpExt_Data_SimpleStore setId(
integer
$value 
)

The array index of the record id. Leave blank to auto generate ids.

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:59:46 -0500 by phpDocumentor 1.4.0