Hierarchy
Ext.util.ObservableExt.data.DataProxyExt.data.DirectProxy
Files
DirectProxy.js

Defined By

Config options

Ext.data.DataProxy
view source

api : Object

Specific urls to call on CRUD action methods \"read\", \"create\", \"update\" and \"destroy\". ...

Specific urls to call on CRUD action methods \"read\", \"create\", \"update\" and \"destroy\".\nDefaults to:

\n\n

api: {\n    read    : undefined,\n    create  : undefined,\n    update  : undefined,\n    destroy : undefined\n}\n

\n\n\n

The url is built based upon the action being executed [load|create|save|destroy]\nusing the commensurate api property, or if undefined default to the\nconfigured Ext.data.Store.url.

\n\n\n
\n\n\n

For example:

\n\n\n

api: {\n    load :    '/controller/load',\n    create :  '/controller/new',  // Server MUST return idProperty of new record\n    save :    '/controller/update',\n    destroy : '/controller/destroy_action'\n}\n\n// Alternatively, one can use the object-form to specify each API-action\napi: {\n    load: {url: 'read.php', method: 'GET'},\n    create: 'create.php',\n    destroy: 'destroy.php',\n    save: 'update.php'\n}\n

\n\n\n

If the specific URL for a given CRUD action is undefined, the CRUD action request\nwill be directed to the configured url.

\n\n\n

Note: To modify the URL for an action dynamically the appropriate API\n\n\n

property should be modified before the action is requested using the corresponding before\naction event. For example to modify the URL associated with the load action:

\n\n

// modify the url for the action\nmyStore.on({\n    beforeload: {\n        fn: function (store, options) {\n            // use setUrl to change the URL for *just* this request.\n            store.proxy.setUrl('changed1.php');\n\n            // set optional second parameter to true to make this URL change\n            // permanent, applying this URL for all subsequent requests.\n            store.proxy.setUrl('changed1.php', true);\n\n            // Altering the proxy API should be done using the public\n            // method setApi.\n            store.proxy.setApi('read', 'changed2.php');\n\n            // Or set the entire API with a config-object.\n            // When using the config-object option, you must redefine the entire\n            // API -- not just a specific action of it.\n            store.proxy.setApi({\n                read    : 'changed_read.php',\n                create  : 'changed_create.php',\n                update  : 'changed_update.php',\n                destroy : 'changed_destroy.php'\n            });\n        }\n    }\n});\n

\n\n\n

Ext.data.DirectProxy
view source

directFn : Function

Function to call when executing a request. ...

Function to call when executing a request. directFn is a simple alternative to defining the api configuration-parameter\nfor Store's which will not implement a full CRUD api.

Ext.data.DataProxy
view source

doRequest : Function

Abstract method that should be implemented in all subclasses. ...

Abstract method that should be implemented in all subclasses. Note: Should only be used by custom-proxy developers.\n(e.g.: HttpProxy.doRequest,\nDirectProxy.doRequest).

Ext.util.Observable
view source

listeners : Object

(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. ...

(optional)

A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.

\n\n

DOM events from ExtJs Components

\n\n\n

While some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n

is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a Component's HTMLElement, listeners must be added to the Element after the Component\nhas been rendered. A plugin can simplify this step:

\n\n

// Plugin is configured with a listeners config object.\n// The Component is appended to the argument list of all handler functions.\nExt.DomObserver = Ext.extend(Object, {\n    constructor: function(config) {\n        this.listeners = config.listeners ? config.listeners : config;\n    },\n\n    // Component passes itself into plugin's init method\n    init: function(c) {\n        var p, l = this.listeners;\n        for (p in l) {\n            if (Ext.isFunction(l[p])) {\n                l[p] = this.createHandler(l[p], c);\n            } else {\n                l[p].fn = this.createHandler(l[p].fn, c);\n            }\n        }\n\n        // Add the listeners to the Element immediately following the render call\n        c.render = c.render.createSequence(function() {\n            var e = c.getEl();\n            if (e) {\n                e.on(l);\n            }\n        });\n    },\n\n    createHandler: function(fn, c) {\n        return function(e) {\n            fn.call(this, e, c);\n        };\n    }\n});\n\nvar combo = new Ext.form.ComboBox({\n\n    // Collapse combo when its element is clicked on\n    plugins: [ new Ext.DomObserver({\n        click: function(evt, comp) {\n            comp.collapse();\n        }\n    })],\n    store: myStore,\n    typeAhead: true,\n    mode: 'local',\n    triggerAction: 'all'\n});\n

\n\n\n

Ext.data.DataProxy
view source

onRead : Functionprotected

Abstract method that should be implemented in all subclasses. ...

Abstract method that should be implemented in all subclasses. Note: Should only be used by custom-proxy developers. Callback for read action.

Ext.data.DataProxy
view source

onWrite : Functionprotected

Abstract method that should be implemented in all subclasses. ...

Abstract method that should be implemented in all subclasses. Note: Should only be used by custom-proxy developers. Callback for create, update and destroy actions.

Ext.data.DirectProxy
view source

paramOrder : Array/String

Defaults to undefined. ...

Defaults to undefined. A list of params to be executed\nserver side. Specify the params in the order in which they must be executed on the server-side\nas either (1) an Array of String values, or (2) a String of params delimited by either whitespace,\ncomma, or pipe. For example,\nany of the following would be acceptable:

\n\n

paramOrder: ['param1','param2','param3']\nparamOrder: 'param1 param2 param3'\nparamOrder: 'param1,param2,param3'\nparamOrder: 'param1|param2|param'\n

\n\n

Ext.data.DirectProxy
view source

paramsAsHash : Boolean

Send parameters as a collection of named arguments (defaults to true). ...

Send parameters as a collection of named arguments (defaults to true). Providing a\nparamOrder nullifies this configuration.

Defaults to: true

Ext.data.DataProxy
view source

restful : Boolean

Defaults to false. ...

Defaults to false. Set to true to operate in a RESTful manner.

\n\n\n

Note: this parameter will automatically be set to true if the\n\n\n

Ext.data.Store it is plugged into is set to restful: true. If the\nStore is RESTful, there is no need to set this option on the proxy.

\n\n

RESTful implementations enable the serverside framework to automatically route\n\n\n

actions sent to one url based upon the HTTP method, for example:

\n\n

store: new Ext.data.Store({\n    restful: true,\n    proxy: new Ext.data.HttpProxy({url:'/users'}); // all requests sent to /users\n    ...\n)}\n

\n\n\n

If there is no api specified in the configuration of the proxy,\nall requests will be marshalled to a single RESTful url (/users) so the serverside\nframework can inspect the HTTP Method and act accordingly:

\n\n

Method   url        action\nPOST     /users     create\nGET      /users     read\nPUT      /users/23  update\nDESTROY  /users/23  delete\n

\n\n\n

\n\n

If set to true, a non-phantom record's\nid will be appended to the url. Some MVC (e.g., Ruby on Rails,\nMerb and Django) support segment based urls where the segments in the URL follow the\nModel-View-Controller approach:\n

someSite.com/controller/action/id\n

\nWhere the segments in the url are typically:

The first segment : represents the controller class that should be invoked.
The second segment : represents the class function, or method, that should be called.
The third segment : represents the ID (a variable typically passed to the method).

\n\n\n

Refer to api for additional information.

\n\n

Defaults to: false

Defined By

Methods

Ext.util.Observable
view source

addEvents( o, Optional )

Adds the specified events to the list of events which this Observable may fire. ...

Adds the specified events to the list of events which this Observable may fire.

Parameters

o : Object|String
Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.
\n
Optional : string
. Event name if multiple event names are being passed as separate parameters.\nUsage:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n\n

Ext.util.Observable
view source

addListener( eventName, handler, [scope], [options] )

Appends an event handler to this object. ...

Appends an event handler to this object.

Parameters

eventName : String
The name of the event to listen for.
\n
handler : Function
The method the event invokes.
\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
\n
options : Object (optional)
An object containing handler configuration.\nproperties. This may contain any of the following properties:
- scope : Object
  The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
- target : Observable
  Only call the handler if the event was fired on the target Observable, not\nif the event was bubbled up from a child Observable.
\n\n
\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
```
myDataView.on('click', this.onClick, this, {\nsingle: true,\ndelay: 100\n});
```
\n
\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n
\n
```
myGridPanel.on({\n'click' : {\n    fn: this.onClick,\n    scope: this,\n    delay: 100\n},\n'mouseover' : {\n    fn: this.onMouseOver,\n    scope: this\n},\n'mouseout' : {\n    fn: this.onMouseOut,\n    scope: this\n}\n});
```
\n
\nOr a shorthand syntax:
\n
```
myGridPanel.on({\n'click' : this.onClick,\n'mouseover' : this.onMouseOver,\n'mouseout' : this.onMouseOut,\n scope: this\n});
```
\n\n

Ext.data.DataProxy
view source

buildUrl( action, record ) : Stringprivate

buildUrl\nSets the appropriate url based upon the action being executed. ...

buildUrl\nSets the appropriate url based upon the action being executed. If restful is true, and only a single record is being acted upon,\nurl will be built Rails-style, as in \"/controller/action/32\". restful will aply iff the supplied record is an\ninstance of Ext.data.Record rather than an Array of them.

Parameters

action : String
The api action being executed [read|create|update|destroy]
\n
record : Ext.data.Record/Ext.data.Record[]
The record or Array of Records being acted upon.
\n

Returns

String
url
\n

Ext.data.DataProxy
view source

destroy( )

Destroys the proxy by purging any event listeners and cancelling any active requests. ...

Destroys the proxy by purging any event listeners and cancelling any active requests.

Ext.data.DirectProxy
view source

doRequest( action, rs, params, reader, callback, scope, arg )protected

DirectProxy implementation of Ext.data.DataProxy.doRequest ...

DirectProxy implementation of Ext.data.DataProxy.doRequest

Parameters

action : String
The crud action type (create, read, update, destroy)
\n
rs : Ext.data.Record/Ext.data.Record[]
If action is load, rs will be null
\n
params : Object
An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.
\n
reader : Ext.data.DataReader
The Reader object which converts the data\nobject into a block of Ext.data.Records.
\n
callback : Function
A function to be called after the request.\nThe callback is passed the following arguments:
- r : Ext.data.Record[] The block of Ext.data.Records.
- options: Options object from the action request
- success: Boolean success indicator
\n\n
scope : Object
The scope (this reference) in which the callback function is executed. Defaults to the browser window.
\n
arg : Object
An optional argument which is passed to the callback as its second parameter.
\n

Ext.util.Observable
view source

enableBubble( events )

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. ...

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.

\n\n\n

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.

\n\n\n

Example:

\n\n\n

Ext.override(Ext.form.Field, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n

\n\n

Parameters

events : String/Array
The event name to bubble, or an Array of event names.
\n

Ext.util.Observable
view source

fireEvent( eventName, args ) : Boolean

Fires the specified event with the passed parameters (minus the event name). ...

Fires the specified event with the passed parameters (minus the event name).

\n\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.

\n\n

Parameters

eventName : String
The name of the event to fire.
\n
args : Object...
Variable number of parameters are passed to handlers.
\n

Returns

Boolean
returns false if any of the handlers return false otherwise it returns true.
\n

Ext.util.Observable
view source

hasListener( eventName ) : Boolean

Checks to see if this object has any listeners for a specified event ...

Checks to see if this object has any listeners for a specified event

Parameters

eventName : String
The name of the event to check for
\n

Returns

Boolean
True if the event is being listened for, else false
\n

Ext.data.DataProxy
view source

isApiAction( action ) : Boolean

Returns true if the specified action is defined as a unique action in the api-config. ...

Returns true if the specified action is defined as a unique action in the api-config.\nrequest. If all API-actions are routed to unique urls, the xaction parameter is unecessary. However, if no api is defined\nand all Proxy actions are routed to DataProxy#url, the server-side will require the xaction parameter to perform a switch to\nthe corresponding code for CRUD action.

Parameters

action : String
CREATE READ UPDATE or DESTROY
\n

Returns

Boolean
\n

Ext.data.DataProxy
view source

load( params, reader, callback, scope, arg )deprecated

Deprecated load method using old method signature. ...

Deprecated load method using old method signature. See {@doRequest} for preferred method.

This method has been deprecated

\n \n\n

Parameters

params : Object
\n
reader : Object
\n
callback : Object
\n
scope : Object
\n
arg : Object
\n

Ext.util.Observable
view source

on( eventName, handler, [scope], [options] )

Appends an event handler to this object (shorthand for addListener.) ...

Appends an event handler to this object (shorthand for addListener.)

Parameters

eventName : String
The type of event to listen for
\n
handler : Function
The method the event invokes
\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
\n
options : Object (optional)
An object containing handler configuration.
\n

Ext.data.DirectProxy
view source

onRead( action, trans, result, res )protected

Callback for read actions ...

Callback for read actions

Parameters

action : String
[Ext.data.Api.actions.create|read|update|destroy]
\n
trans : Object
The request transaction object
\n
result : Object
Data object picked out of the server-response.
\n
res : Object
The server response
\n

Ext.data.DirectProxy
view source

onWrite( action, trans, result, res, rs )protected

Callback for write actions ...

Callback for write actions

Parameters

action : String
[create|read|update|destroy]
\n
trans : Object
The request transaction object
\n
result : Object
Data object picked out of the server-response.
\n
res : Object
The server response
\n
rs : Ext.data.Record/Ext.data.Record[]
The Store resultset associated with the action.
\n

Ext.util.Observable
view source

purgeListeners( )

Removes all listeners for this object ...

Removes all listeners for this object

Ext.util.Observable
view source

relayEvents( o, events )

Relays selected events from the specified Observable as if the events were fired by this. ...

Relays selected events from the specified Observable as if the events were fired by this.

Parameters

o : Object
The Observable whose events this object is to relay.
\n
events : Array
Array of event names to relay.
\n

Ext.util.Observable
view source

removeListener( eventName, handler, [scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
\n
scope : Object (optional)
The scope originally specified for the handler.
\n

Ext.data.DataProxy
view source

request( action, rs, params, reader, callback, scope, options )

All proxy actions are executed through this method. ...

All proxy actions are executed through this method. Automatically fires the \"before\" + action event

Parameters

action : String
Name of the action
\n
rs : Ext.data.Record/Ext.data.Record[]/null
Will be null when action is 'load'
\n
params : Object
\n
reader : Ext.data.DataReader
\n
callback : Function
\n
scope : Object
The scope (this reference) in which the callback function is executed. Defaults to the Proxy object.
\n
options : Object
Any options specified for the action (e.g. see Ext.data.Store.load.
\n

Ext.util.Observable
view source

resumeEvents( )

Resume firing events. ...

Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.

Ext.data.DataProxy
view source

setApi( api, url )

Redefines the Proxy's API or a single action of an API. ...

Redefines the Proxy's API or a single action of an API. Can be called with two method signatures.

\n\n\n

If called with an object as the only parameter, the object should redefine the entire API, e.g.:

\n\n\n

proxy.setApi({\n    read    : '/users/read',\n    create  : '/users/create',\n    update  : '/users/update',\n    destroy : '/users/destroy'\n});\n

\n\n\n

If called with two parameters, the first parameter should be a string specifying the API action to\nredefine and the second parameter should be the URL (or function if using DirectProxy) to call for that action, e.g.:

\n\n\n

proxy.setApi(Ext.data.Api.actions.read, '/users/new_load_url');\n

\n\n

Parameters

api : String/Object
An API specification object, or the name of an action.
\n
url : String/Function
The URL (or function if using DirectProxy) to call for the action.
\n

Ext.util.Observable
view source

suspendEvents( queueSuspended )

Suspend the firing of all events. ...

Suspend the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\n

Ext.util.Observable
view source

un( eventName, handler, [scope] )

Removes an event handler (shorthand for removeListener.) ...

Removes an event handler (shorthand for removeListener.)

Parameters

eventName : String
The type of event the handler was associated with.
\n
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
\n
scope : Object (optional)
The scope originally specified for the handler.
\n

Defined By

Events

Ext.data.DataProxy
view source

beforeload( this, params )

Fires before a request to retrieve a data object. ...

Fires before a request to retrieve a data object.

Parameters

this : DataProxy
The proxy for the request
\n
params : Object
The params object passed to the request function
\n

Ext.data.DataProxy
view source

beforewrite( this, action, rs, params )

Fires before a request is generated for one of the actions Ext.data.Api.actions.create|update|destroy\n\n\nIn addition t...

Fires before a request is generated for one of the actions Ext.data.Api.actions.create|update|destroy

\n\n\n

In addition to being fired through the DataProxy instance that raised the event, this event is also fired\nthrough the Ext.data.DataProxy class to allow for centralized processing of beforewrite events from all\nDataProxies by attaching a listener to the Ext.data.DataProxy class itself.

\n\n

Parameters

this : DataProxy
The proxy for the request
\n
action : String
[Ext.data.Api.actions.create|update|destroy]
\n
rs : Record/Record[]
The Record(s) to create|update|destroy.
\n
params : Object
The request params object. Edit params to add parameters to the request.
\n

Ext.data.DataProxy
view source

exception( this, type, action, options, response, arg )

Fires if an exception occurs in the Proxy during a remote request. ...

Fires if an exception occurs in the Proxy during a remote request. This event is relayed\nthrough a corresponding Ext.data.Store.exception,\nso any Store instance may observe this event.

\n\n\n

In addition to being fired through the DataProxy instance that raised the event, this event is also fired\nthrough the Ext.data.DataProxy class to allow for centralized processing of exception events from all\nDataProxies by attaching a listener to the Ext.data.DataProxy class itself.

\n\n\n

This event can be fired for one of two reasons:

\n\n\n

remote-request failed :
\nThe server did not return status === 200.\n
remote-request succeeded :
\nThe remote-request succeeded but the reader could not read the response.\nThis means the server returned data, but the configured Reader threw an\nerror while reading the response. In this case, this event will be\nraised and the caught error will be passed along into this event.\n

\n\n\n

This event fires with two different contexts based upon the 2nd\n\n\n

parameter type [remote|response]. The first four parameters\nare identical between the two contexts -- only the final two parameters\ndiffer.

Parameters

this : DataProxy
The proxy that sent the request
\n
type : String
The value of this parameter will be either 'response' or 'remote'.
\n\n\n
- 'response' :
  \n
  An invalid response from the server was returned: either 404,\n500 or the response meta-data does not match that defined in the DataReader\n(e.g.: root, idProperty, successProperty).
  \n
- 'remote' :
  \n
  A valid response was returned from the server having\nsuccessProperty === false. This response might contain an error-message\nsent from the server. For example, the user may have failed\nauthentication/authorization or a database validation error occurred.
  \n
\n\n
action : String
Name of the action (see Ext.data.Api.actions.
\n
options : Object
The options for the action that were specified in the request.
\n
response : Object
The value of this parameter depends on the value of the type parameter:
\n\n\n
- 'response' :
  \n
  The raw browser response object (e.g.: XMLHttpRequest)
  \n
- 'remote' :
  \n
  The decoded response object sent from the server.
  \n
\n\n
arg : Mixed
The type and value of this parameter depends on the value of the type parameter:
\n\n\n
- 'response' : Error
  \n
  The JavaScript Error object caught if the configured Reader could not read the data.\nIf the remote request returns success===false, this parameter will be null.
  \n
- 'remote' : Record/Record[]
  \n
  This parameter will only exist if the action was a write action\n(Ext.data.Api.actions.create|update|destroy).
  \n
\n\n

Ext.data.DataProxy
view source

load( this, o, options )

Fires before the load method's callback is called. ...

Fires before the load method's callback is called.

Parameters

this : DataProxy
The proxy for the request
\n
o : Object
The request transaction object
\n
options : Object
The callback's options property as passed to the request function
\n

Ext.data.DataProxy
view source

loadexception( misc )deprecated

This event is deprecated. ...

This event is deprecated. The signature of the loadexception event\nvaries depending on the proxy, use the catch-all exception event instead.\nThis event will fire in addition to the exception event.

\n\n

This event has been deprecated

\n \n\n

Parameters

misc : misc
See exception.
\n

Ext.data.DataProxy
view source

write( this, action, data, response, rs, options )

Fires before the request-callback is called\n\n\nIn addition to being fired through the DataProxy instance that raised t...

Fires before the request-callback is called

\n\n\n

In addition to being fired through the DataProxy instance that raised the event, this event is also fired\nthrough the Ext.data.DataProxy class to allow for centralized processing of write events from all\nDataProxies by attaching a listener to the Ext.data.DataProxy class itself.

\n\n

Parameters

this : DataProxy
The proxy that sent the request
\n
action : String
[Ext.data.Api.actions.create|upate|destroy]
\n
data : Object
The data object extracted from the server-response
\n
response : Object
The decoded response from server
\n
rs : Record/Record[]
The Record(s) from Store
\n
options : Object
The callback's options property as passed to the request function
\n