Class: PhpExt_Data_StoreLoadOptions

Source Location: /PhpExt/Data/StoreLoadOptions.php

Class PhpExt_Data_StoreLoadOptions

Class Overview

Store load method options PhpExt_Data_Store

Located in /PhpExt/Data/StoreLoadOptions.php [line 26]

PhpExt_Object
   |
   --PhpExt_Config_ConfigObject
      |
      --PhpExt_Data_StoreLoadOptions

Author(s):

API Tags:

See:

PhpExt_Data_Store

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Config_ConfigObject

PhpExt_Config_ConfigObject::$_options

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Config_ConfigObject

PhpExt_Config_ConfigObject::__construct()

PhpExt_Config_ConfigObject::getJavascript()

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_StoreLoadOptions	__construct()
boolean	getAdd()	Indicator to append loaded records rather than replace the current cache.
PhpExt_Handler	getCallback()	A function to be called after the Records have been loaded. The callback is passed the following arguments:
array	getParams()
PhpExt_JavascriptStm	getScope()	Scope with which to call the callback (defaults to the Store object)
PhpExt_Data_StoreLoadOptions	setAdd()	Indicator to append loaded records rather than replace the current cache.
PhpExt_Data_StoreLoadOptions	setCallback()	A function to be called after the Records have been loaded. The callback is passed the following arguments:
PhpExt_Data_StoreLoadOptions	setParams()	An object containing properties to pass as HTTP parameters to a remote data source.
PhpExt_Data_StoreLoadOptions	setScope()	Scope with which to call the callback (defaults to the Store object)

[ Top ]

Properties

Methods

Constructor __construct [line 116]

PhpExt_Data_StoreLoadOptions __construct(
[array
$params = null], [PhpExt_Handler
$callback = null], [PhpExt_JavascriptStm
$scope = null], [boolean
$add = null] 
)

Parameters:

array	$params:	An object containing properties to pass as HTTP parameters to a remote data source.
PhpExt_Handler	$callback:	A function to be called after the Records have been loaded.
PhpExt_JavascriptStm	$scope:	Scope with which to call the callback (defaults to the Store object)
boolean	$add:	Indicator to append loaded records rather than replace the current cache.

API Tags:

Access:

public

Redefinition of:

PhpExt_Config_ConfigObject::__construct()

[ Top ]

getAdd [line 104]

boolean getAdd(
)

Indicator to append loaded records rather than replace the current cache.

API Tags:

Access:

public

[ Top ]

getCallback [line 68]

PhpExt_Handler getCallback(
)

A function to be called after the Records have been loaded. The callback is passed the following arguments:

r : Ext.data.Record[]
options: Options object from the load call
success: Boolean success indicator

API Tags:

Access:

public

[ Top ]

getParams [line 44]

array getParams(
)

API Tags:

Access:

public

[ Top ]

getScope [line 86]

PhpExt_JavascriptStm getScope(
)

Scope with which to call the callback (defaults to the Store object)

API Tags:

Access:

public

[ Top ]

setAdd [line 96]

PhpExt_Data_StoreLoadOptions setAdd(
boolean
$value 
)

Indicator to append loaded records rather than replace the current cache.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setCallback [line 57]

PhpExt_Data_StoreLoadOptions setCallback(
PhpExt_Handler
$value 
)

A function to be called after the Records have been loaded. The callback is passed the following arguments:

r : Ext.data.Record[]
options: Options object from the load call
success: Boolean success indicator

Parameters:

PhpExt_Handler

$value:

API Tags:

Access:

public

[ Top ]

setParams [line 36]

PhpExt_Data_StoreLoadOptions setParams(
array
$value 
)

An object containing properties to pass as HTTP parameters to a remote data source.

Format:

array('param1'=>10,'param2'=>'some value')

Parameters:

array

$value:

API Tags:

Access:

public

[ Top ]

setScope [line 78]

PhpExt_Data_StoreLoadOptions setScope(
PhpExt_JavascriptStm
$value 
)

Scope with which to call the callback (defaults to the Store object)

Parameters:

PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 16:00:37 -0500 by phpDocumentor 1.4.0