Class: PhpExt_AutoLoadConfigObject

Source Location: /PhpExt/AutoLoadConfigObject.php

Class PhpExt_AutoLoadConfigObject

Class Overview

Located in /PhpExt/AutoLoadConfigObject.php [line 23]

PhpExt_Object
   |
   --PhpExt_Config_ConfigObject
      |
      --PhpExt_AutoLoadConfigObject

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 ]

Constant Summary

AUTO_LOAD_METHOD_GET
AUTO_LOAD_METHOD_POST

[ Top ]

Method Summary

PhpExt_AutoLoadConfigObject	__construct()
PhpExt_Handler	getCallback()	A function to be called when the response from the server arrives. The following parameters are passed: el : Ext.Element - The Element being updated.
boolean	getDiscardUrl()	If not passed as false the URL of this request becomes the default URL for this Updater object, and will be subsequently used in refresh calls.
boolean	getMethod()	The HTTP method to use. Defaults to AUTO_LOAD_METHOD_POST if params are present, or AUTO_LOAD_METHOD_GET if not.
boolean	getNoCache()	Only needed for GET requests, this option causes an extra, generated parameter to be passed to defeat caching.
array	getParams()	The parameters to pass to the server. These may be specified as a urlencoded string, or as an array containing properties which represent parameters.
PhpExt_JavascriptStm	getScope()	The scope in which to execute the callback (The callback's this reference.) If the params option is a function, this scope is used for that function also.
boolean	getScripts()	If true any <script> tags embedded in the response text will be extracted and executed. If this option is specified, the callback will be called after the execution of the scripts.
string	getText()	The loading text displayed during request.
integer	getTimeout()	The timeout to use when waiting for a response.
string	getUrl()	The URL to request or a function which returns the URL.
PhpExt_AutoLoadConfigObject	setCallback()	A function to be called when the response from the server arrives. The following parameters are passed: el : Ext.Element - The Element being updated.
PhpExt_AutoLoadConfigObject	setDiscardUrl()	If not passed as false the URL of this request becomes the default URL for this Updater object, and will be subsequently used in refresh calls.
PhpExt_AutoLoadConfigObject	setMethod()	The HTTP method to use. Defaults to AUTO_LOAD_METHOD_POST if params are present, or AUTO_LOAD_METHOD_GET if not.
PhpExt_AutoLoadConfigObject	setNoCache()	Only needed for GET requests, this option causes an extra, generated parameter to be passed to defeat caching.
PhpExt_AutoLoadConfigObject	setParams()	The parameters to pass to the server. These may be specified as a urlencoded string, or as an array containing properties which represent parameters.
PhpExt_AutoLoadConfigObject	setScope()	The scope in which to execute the callback (The callback's this reference.) If the params option is a function, this scope is used for that function also.
PhpExt_AutoLoadConfigObject	setScripts()	If true any <script> tags embedded in the response text will be extracted and executed. If this option is specified, the callback will be called after the execution of the scripts.
PhpExt_AutoLoadConfigObject	setText()	The loading text displayed during request.
PhpExt_AutoLoadConfigObject	setTimeout()	The timeout to use when waiting for a response.
PhpExt_AutoLoadConfigObject	setUrl()	The URL to request.

[ Top ]

Properties

Methods

Constructor __construct [line 230]

PhpExt_AutoLoadConfigObject __construct(
string
$url, [array
$params = array()], [boolean
$scripts = null], [string
$method = null] 
)

Parameters:

string	$url:	The URL to request.
array	$params:	The parameters to pass to the server. These may be specified as a urlencoded string, or as an array containing properties which represent parameters.
boolean	$scripts:	If true any <script> tags embedded in the response text will be extracted and executed. If this option is specified, the callback will be called after the execution of the scripts.
string	$method:	The HTTP method to use. Defaults to AUTO_LOAD_METHOD_POST if params are present, or AUTO_LOAD_METHOD_GET if not.

API Tags:

Access:

public

Redefinition of:

PhpExt_Config_ConfigObject::__construct()

[ Top ]

getCallback [line 130]

PhpExt_Handler getCallback(
)

A function to be called when the response from the server arrives. The following parameters are passed:

el : Ext.Element - The Element being updated.

success : Boolean - True for success, false for failure.
response : XMLHttpRequest - The XMLHttpRequest which processed the update.

options : Object - The config object passed to the update call.

API Tags:

Access:

public

[ Top ]

getDiscardUrl [line 166]

boolean getDiscardUrl(
)

If not passed as false the URL of this request becomes the default URL for this Updater object, and will be subsequently used in refresh calls.

API Tags:

Access:

public

[ Top ]

getMethod [line 64]

boolean getMethod(
)

The HTTP method to use. Defaults to AUTO_LOAD_METHOD_POST if params are present, or AUTO_LOAD_METHOD_GET if not.

API Tags:

Access:	public
Uses:	PhpExt_AutoLoadConfigObject::AUTO_LOAD_METHOD_POST
Uses:	PhpExt_AutoLoadConfigObject::AUTO_LOAD_METHOD_GET

[ Top ]

getNoCache [line 202]

boolean getNoCache(
)

Only needed for GET requests, this option causes an extra, generated parameter to be passed to defeat caching.

API Tags:

Access:

public

[ Top ]

getParams [line 86]

array getParams(
)

The parameters to pass to the server. These may be specified as a urlencoded string, or as an array containing properties which represent parameters.

Format:

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

API Tags:

Access:

public

[ Top ]

getScope [line 148]

PhpExt_JavascriptStm getScope(
)

The scope in which to execute the callback (The callback's this reference.) If the params option is a function, this scope is used for that function also.

API Tags:

Access:

public

[ Top ]

getScripts [line 104]

boolean getScripts(
)

If true any <script> tags embedded in the response text will be extracted and executed. If this option is specified, the callback will be called after the execution of the scripts.

API Tags:

Access:

public

[ Top ]

getText [line 220]

string getText(
)

The loading text displayed during request.

API Tags:

Access:

public

[ Top ]

getTimeout [line 184]

integer getTimeout(
)

The timeout to use when waiting for a response.

API Tags:

Access:

public

[ Top ]

getUrl [line 42]

string getUrl(
)

The URL to request or a function which returns the URL.

API Tags:

Access:

public

[ Top ]

setCallback [line 118]

PhpExt_AutoLoadConfigObject setCallback(
PhpExt_Handler
$value 
)

A function to be called when the response from the server arrives. The following parameters are passed:

el : Ext.Element - The Element being updated.

success : Boolean - True for success, false for failure.
response : XMLHttpRequest - The XMLHttpRequest which processed the update.

options : Object - The config object passed to the update call.

Parameters:

PhpExt_Handler

$value:

API Tags:

Access:

public

[ Top ]

setDiscardUrl [line 158]

PhpExt_AutoLoadConfigObject setDiscardUrl(
boolean
$value 
)

If not passed as false the URL of this request becomes the default URL for this Updater object, and will be subsequently used in refresh calls.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setMethod [line 54]

PhpExt_AutoLoadConfigObject setMethod(
boolean
$value 
)

The HTTP method to use. Defaults to AUTO_LOAD_METHOD_POST if params are present, or AUTO_LOAD_METHOD_GET if not.

Parameters:

boolean

$value:

API Tags:

Access:	public
Uses:	PhpExt_AutoLoadConfigObject::AUTO_LOAD_METHOD_POST
Uses:	PhpExt_AutoLoadConfigObject::AUTO_LOAD_METHOD_GET

[ Top ]

setNoCache [line 194]

PhpExt_AutoLoadConfigObject setNoCache(
boolean
$value 
)

Only needed for GET requests, this option causes an extra, generated parameter to be passed to defeat caching.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setParams [line 76]

PhpExt_AutoLoadConfigObject setParams(
array
$value 
)

The parameters to pass to the server. These may be specified as a urlencoded string, or as an array containing properties which represent parameters.

Format:

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

Parameters:

array

$value:

API Tags:

Access:

public

[ Top ]

setScope [line 140]

PhpExt_AutoLoadConfigObject setScope(
PhpExt_JavascriptStm
$value 
)

The scope in which to execute the callback (The callback's this reference.) If the params option is a function, this scope is used for that function also.

Parameters:

PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

setScripts [line 96]

PhpExt_AutoLoadConfigObject setScripts(
boolean
$value 
)

If true any <script> tags embedded in the response text will be extracted and executed. If this option is specified, the callback will be called after the execution of the scripts.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setText [line 212]

PhpExt_AutoLoadConfigObject setText(
string
$value 
)

The loading text displayed during request.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setTimeout [line 176]

PhpExt_AutoLoadConfigObject setTimeout(
integer
$value 
)

The timeout to use when waiting for a response.

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setUrl [line 34]

PhpExt_AutoLoadConfigObject setUrl(
string
$value 
)

The URL to request.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

Constants

AUTO_LOAD_METHOD_GET = 'GET' [line 25]

API Tags:

Usedby:	PhpExt_AutoLoadConfigObject::getMethod()
Usedby:	PhpExt_AutoLoadConfigObject::setMethod()

[ Top ]

AUTO_LOAD_METHOD_POST = 'POST' [line 26]

API Tags:

Usedby:	PhpExt_AutoLoadConfigObject::getMethod()
Usedby:	PhpExt_AutoLoadConfigObject::setMethod()

[ Top ]

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