Class: PhpExt_Data_JsonStore

Source Location: /PhpExt/Data/JsonStore.php

Class PhpExt_Data_JsonStore

Class Overview

Small helper class to make creating Stores for JSON data easier.

An object literal of this form could also be used as the data config option. Note: Although they are not listed, this class inherits all of the config options of Store, JsonReader.

Located in /PhpExt/Data/JsonStore.php [line 31]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Data_Store
         |
         --PhpExt_Data_JsonStore

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_JsonStore	__construct()
PhpExt_Data_FieldConfigObject	addField()
string	getData()	A json string readable by this object's JsonReader. Either this option, or the url option must be specified.
PhpExt_Data_FieldConfigObject	getField()
PhpExt_Data_FieldConfigObjectCollection	getFields()	Fields Collection
string	getId()	Name of the property within a row object that contains a record identifier value.
string	getRoot()	Name of the property which contains the Array of row objects.
string	getSuccessProperty()	Name of the property from which to retrieve the success attribute used by forms.
string	getTotalProperty()	Name of the property from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server.
string	getUrl()	The URL from which to load data through an HttpProxy. Either this option, or the data option must be specified.
PhpExt_Data_JsonStore	setData()	A json string readable by this object's JsonReader. Either this option, or the url option must be specified.
PhpExt_Data_JsonReader	setId()	Name of the property within a row object that contains a record identifier value.
PhpExt_Data_JsonReader	setRoot()	Name of the property which contains the Array of row objects.
PhpExt_Data_JsonReader	setSuccessProperty()	Name of the property from which to retrieve the success attribute used by forms.
PhpExt_Data_JsonReader	setTotalProperty()	Name of the property from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server.
PhpExt_Data_JsonStore	setUrl()	The URL from which to load data through an HttpProxy. Either this option, or the data option must be specified.

[ Top ]

Properties

PhpExt_Data_FieldConfigObjectCollection $_fields = null [line 53]

API Tags:

Access:

public

[ Top ]

Methods

Constructor __construct [line 165]

PhpExt_Data_JsonStore __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Data_Store::__construct()

[ Top ]

addField [line 189]

PhpExt_Data_FieldConfigObject addField(
PhpExt_Data_FieldConfigObject
$field 
)

Parameters:

PhpExt_Data_FieldConfigObject

$field:

API Tags:

Access:

public

[ Top ]

getData [line 46]

string getData(
)

A json string readable by this object's JsonReader. Either this option, or the url option must be specified.

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

getField [line 197]

PhpExt_Data_FieldConfigObject getField(

$name 
)

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

getFields [line 60]

PhpExt_Data_FieldConfigObjectCollection getFields(
)

Fields Collection

API Tags:

Access:

public

[ Top ]

getId [line 104]

string getId(
)

Name of the property within a row object that contains a record identifier value.

JsonReader Config Options:

This class inherits all of the config options of Store, JsonReader.

API Tags:

Access:

public

[ Top ]

getRoot [line 122]

string getRoot(
)

Name of the property which contains the Array of row objects.

JsonReader Config Options:

This class inherits all of the config options of Store, JsonReader.

API Tags:

Access:

public

[ Top ]

getSuccessProperty [line 140]

string getSuccessProperty(
)

Name of the property from which to retrieve the success attribute used by forms.

JsonReader Config Options:

This class inherits all of the config options of Store, JsonReader.

API Tags:

Access:

public

[ Top ]

getTotalProperty [line 158]

string getTotalProperty(
)

Name of the property from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server.

JsonReader Config Options:

This class inherits all of the config options of Store, JsonReader.

API Tags:

Access:

public

[ Top ]

getUrl [line 78]

string getUrl(
)

The URL from which to load data through an HttpProxy. Either this option, or the data option must be specified.

API Tags:

Access:

public

Redefinition of:

PhpExt_Data_Store::getUrl(): If passed, an HttpProxy is created for the passed URL

[ Top ]

setData [line 39]

PhpExt_Data_JsonStore setData(
string
$value 
)

A json string readable by this object's JsonReader. Either this option, or the url option must be specified.

Parameters:

string

$value:

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

setId [line 96]

PhpExt_Data_JsonReader setId(
string
$value 
)

Name of the property within a row object that contains a record identifier value.

JsonReader Config Options:

This class inherits all of the config options of Store, JsonReader.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setRoot [line 114]

PhpExt_Data_JsonReader setRoot(
string
$value 
)

Name of the property which contains the Array of row objects.

JsonReader Config Options:

This class inherits all of the config options of Store, JsonReader.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setSuccessProperty [line 132]

PhpExt_Data_JsonReader setSuccessProperty(
string
$value 
)

Name of the property from which to retrieve the success attribute used by forms.

JsonReader Config Options:

This class inherits all of the config options of Store, JsonReader.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setTotalProperty [line 150]

PhpExt_Data_JsonReader setTotalProperty(
string
$value 
)

JsonReader Config Options:

This class inherits all of the config options of Store, JsonReader.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setUrl [line 70]

PhpExt_Data_JsonStore setUrl(
string
$value 
)

The URL from which to load data through an HttpProxy. Either this option, or the data option must be specified.

Parameters:

string

$value:

API Tags:

Access:

public

Redefinition of:

PhpExt_Data_Store::setUrl(): If passed, an HttpProxy is created for the passed URL

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:56:18 -0500 by phpDocumentor 1.4.0