Super classes

Ext.data.Proxy Ext.data.ServerProxy Ext.data.AjaxProxy

Mixins

Ext.util.Observable

RestProxy is a specialization of the AjaxProxy which simply maps the four actions (create, read, update and destroy) to RESTful HTTP verbs. For example, let's set up a Model with an inline RestProxy

Ext.regModel('User', {
    fields: ['id', 'name', 'email'],

    proxy: {
        type: 'rest',
        url : '/users'
    }
});

Now we can create a new User instance and save it via the RestProxy. Doing this will cause the Proxy to send a POST request to '/users':

var user = Ext.ModelMgr.create({name: 'Ed Spencer', email: '[email protected]'}, 'User');

user.save(); //POST /users

Let's expand this a little and provide a callback for the Ext.data.Model.save call to update the Model once it has been created. We'll assume the creation went successfully and that the server gave this user an ID of 123:

user.save({
    success: function(user) {
        user.set('name', 'Khan Noonien Singh');

        user.save(); //PUT /users/123
    }
});

Now that we're no longer creating a new Model instance, the request method is changed to an HTTP PUT, targeting the relevant url for that user. Now let's delete this user, which will use the DELETE method:

user.destroy(); //DELETE /users/123

Finally, when we perform a load of a Model or Store, RestProxy will use the GET method:

//1. Load via Store

//the Store automatically picks up the Proxy from the User model
var store = new Ext.data.Store({
    model: 'User'
});

store.load(); //GET /users

//2. Load directly from the Model

//GET /users/123
Ext.ModelMgr.getModel('User').load(123, {
    success: function(user) {
        console.log(user.getId()); //outputs 123
    }
});

Url generation

RestProxy is able to automatically generate the urls above based on two configuration options - appendId and format. If appendId is true (it is by default) then RestProxy will automatically append the ID of the Model instance in question to the configured url, resulting in the '/users/123' that we saw above.

If the request is not for a specific Model instance (e.g. loading a Store), the url is not appended with an id. RestProxy will automatically insert a '/' before the ID if one is not already present.

new Ext.data.RestProxy({
    url: '/users',
    appendId: true //default
});

// Collection url: /users
// Instance url  : /users/123

RestProxy can also optionally append a format string to the end of any generated url:

new Ext.data.RestProxy({
    url: '/users',
    format: 'json'
});

// Collection url: /users.json
// Instance url  : /users/123.json

If further customization is needed, simply implement the buildUrl method and add your custom generated url onto the Request object that is passed to buildUrl. See RestProxy's implementation for an example of how to achieve this.

Note that RestProxy inherits from AjaxProxy, which already injects all of the sorter, filter, group and paging options into the generated url. See the AjaxProxy docs for more details.

Config Options

appendId : Boolean

True to automatically append the ID of a Model instance when performing a request based on that single instance. See ...

True to automatically append the ID of a Model instance when performing a request based on that single instance. See RestProxy intro docs for more details. Defaults to true.

batchOrder : String

Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this to set a different ord...

Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this to set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy'

cacheString : String

The name of the cache param added to the url when using noCache (defaults to "_dc")

dirParam : String

The name of the direction parameter to send in a request. This is only used when legacySortMode is set to true. Defau...

The name of the direction parameter to send in a request. This is only used when legacySortMode is set to true. Defaults to 'dir'.

extraParams : Object

Extra parameters that will be included on every request. Individual requests with params of the same name will overri...

Extra parameters that will be included on every request. Individual requests with params of the same name will override these params when they are in conflict.

filterParam : String

The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set this to undefined if you don't wa...

The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set this to undefined if you don't want to send a filter parameter

format : String

Optional data format to send to the server when making any request (e.g. 'json'). See the RestProxy intro docs for fu...

Optional data format to send to the server when making any request (e.g. 'json'). See the RestProxy intro docs for full details. Defaults to undefined.

groupParam : String

The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this to undefined if you don't want ...

The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this to undefined if you don't want to send a group parameter

headers : Object

Any headers to add to the Ajax request. Defaults to undefined.

legacySortMode : Boolean

Enabling legacySortMode in conjunction with remoteSort will only send one sort property and a direction when a remote...

Enabling legacySortMode in conjunction with remoteSort will only send one sort property and a direction when a remote sort is requested. The dirParam and sortParam will be sent with the property name and either 'ASC' or 'DESC'

limitParam : String

The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this to undefined if you don't want ...

The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this to undefined if you don't want to send a limit parameter

listeners : Object

A config object containing one or more event handlers to be added to this object during initialization. This should ...

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

DOM events from ExtJs Components

While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's click event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

model : String/Ext.data.Model

The name of the Model to tie to this Proxy. Can be either the string name of the Model, or a reference to the Model c...

The name of the Model to tie to this Proxy. Can be either the string name of the Model, or a reference to the Model constructor. Required.

noCache : Boolean

Defaults to true. Disable caching by adding a unique parameter name to the request.

pageParam : String

The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to undefined if you don't want to...

The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to undefined if you don't want to send a page parameter

reader : Object/String/Ext.data.Reader

The Ext.data.Reader to use to decode the server's response. This can either be a Reader instance, a config object or ...

The Ext.data.Reader to use to decode the server's response. This can either be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml').

sortParam : String

The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this to undefined if you don't want to...

The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this to undefined if you don't want to send a sort parameter

startParam : String

The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this to undefined if you don't want ...

The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this to undefined if you don't want to send a start parameter

timeout : Number

The number of milliseconds to wait for a response. Defaults to 30 seconds.

url : String

The URL from which to request the data object.

writer : Object/String/Ext.data.Writer

The Ext.data.Writer to use to encode any request sent to the server. This can either be a Writer instance, a config o...

The Ext.data.Writer to use to encode any request sent to the server. This can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml').

Properties

actionMethods : Object

Mapping of action name to HTTP request method. These default to RESTful conventions for the 'create', 'read', 'update...

Mapping of action name to HTTP request method. These default to RESTful conventions for the 'create', 'read', 'update' and 'destroy' actions (which map to 'POST', 'GET', 'PUT' and 'DELETE' respectively). This object should not be changed except globally via Ext.override - the getMethod function can be overridden instead.

Methods

( String eventName, Function handler, [Object scope] ) : Void

Removes an event handler (shorthand for removeListener.)

Parameters

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

Returns

Void

addEvents( Object|String o, string Optional. ) : Void

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 or the first event name string if multiple event names are being passed as separate parameters.
Optional. : string
Event name if multiple event names are being passed as separate parameters. Usage:
```
this.addEvents('storeloaded', 'storecleared');
```

Returns

Void

addListener( String eventName, Function handler, [Object scope], [Object options] ) : Void

Appends an event handler to this object.

Parameters

eventName : String
The name of the event to listen for. May also be an object who's property names are event names. See
handler : Function
The method the event invokes.
scope : Object
(optional) The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
options : Object
(optional) An object containing handler configuration. properties. This may contain any of the following properties:
- scope : Object
  The scope (this reference) in which the handler function is executed. If 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 by the specified number of milliseconds. If the event fires again within that time, the original handler 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 if the event was bubbled up from a child Observable.
- element : String
  This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.
  This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
```
new Ext.Panel({
    title: 'The title',
    listeners: {
        click: this.handlePanelClick,
        element: 'body'
    }
});
```
  When added in this way, the options available are the options applicable to Ext.core.Element.addListener
Combining Options
Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.
```
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
```
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
```
myGridPanel.on({
    cellClick: this.onCellClick,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    scope: this // Important. Ensure "this" is correct during handler execution
});
```
.

Returns

Void

addManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope, Object opt ) : Void

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed...

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Parameters

item : Observable|Element
The item to which to add a listener/listeners.
ename : Object|String
The event name, or an object containing event name properties.
fn : Function
Optional. If the ename parameter was an event name, this is the handler function.
scope : Object
Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.
opt : Object
Optional. If the ename parameter was an event name, this is the addListener options.

Returns

Void

afterRequest( Ext.data.Request request, Boolean success ) : Void

Optional callback function which can be used to clean up after a request has been completed.

Parameters

request : Ext.data.Request
The Request object
success : Boolean
True if the request was successful

Returns

Void

batch( Object operations, Object listeners ) : Ext.data.Batch

Performs a batch of Operations, in the order specified by batchOrder. Used internally by Ext.data.Store's sync method...

Performs a batch of Operations, in the order specified by batchOrder. Used internally by Ext.data.Store's sync method. Example usage:

myProxy.batch({
create : [myModel1, myModel2],
update : [myModel3],
destroy: [myModel4, myModel5]
});

Where the myModel* above are Model instances - in this case 1 and 2 are new instances and have not been saved before, 3 has been saved previously but needs to be updated, and 4 and 5 have already been saved but should now be destroyed.

Parameters

operations : Object
Object containing the Model instances to act upon, keyed by action name
listeners : Object
Optional listeners object passed straight through to the Batch - see Ext.data.Batch

Returns

Ext.data.Batch The newly created Ext.data.Batch object

buildRequest( Ext.data.Operation operation ) : Ext.data.Request

Creates and returns an Ext.data.Request object based on the options passed by the Store that this Proxy is attached t...

Creates and returns an Ext.data.Request object based on the options passed by the Store that this Proxy is attached to.

Parameters

operation : Ext.data.Operation
The Operation object to execute

Returns

Ext.data.Request The request object

buildUrl : Void

Specialized version of buildUrl that incorporates the appendId and format options into the generated url. Override th...

Specialized version of buildUrl that incorporates the appendId and format options into the generated url. Override this to provide further customizations, but remember to call the superclass buildUrl so that additional parameters like the cache buster string are appended

capture( Observable o, Function fn, [Object scope] ) : Void

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

Parameters

o : Observable
The Observable to capture events from.
fn : Function
The function to call when an event is fired.
scope : Object
(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

Returns

Void

clearListeners : Void

Removes all listeners for this object including the managed listeners

clearManagedListeners : Void

Removes all managed listeners for this object.

create( Ext.data.Operation operation, Function callback, Object scope ) : Void

Performs the given create operation.

Parameters

operation : Ext.data.Operation
The Operation to perform
callback : Function
Callback function to be called when the Operation has completed (whether successful or not)
scope : Object
Scope to execute the callback function in

Returns

Void

createAlias( String eventName, Function handler, [Object scope], [Object options] ) : Void

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

Parameters

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

Returns

Void

destroy( Ext.data.Operation operation, Function callback, Object scope ) : Void

Performs the given destroy operation.

Parameters

operation : Ext.data.Operation
The Operation to perform
callback : Function
Callback function to be called when the Operation has completed (whether successful or not)
scope : Object
Scope to execute the callback function in

Returns

Void

doRequest( Ext.data.Operation operation, Function callback, Object scope ) : Void

In ServerProxy subclasses, the create, read, update and destroy methods all pass through to doRequest. Each ServerPro...

In ServerProxy subclasses, the create, read, update and destroy methods all pass through to doRequest. Each ServerProxy subclass must implement the doRequest method - see Ext.data.ScriptTagProxy and Ext.data.AjaxProxy for examples. This method carries the same signature as each of the methods that delegate to it.

Parameters

operation : Ext.data.Operation
The Ext.data.Operation object
callback : Function
The callback function to call when the Operation has completed
scope : Object
The scope in which to execute the callback

Returns

Void

enableBubble( String/Array events ) : Void

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

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

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

Example:

Ext.override(Ext.form.Field, {
//  Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.Function.createSequence(Ext.form.Field.prototype.initComponent, function() {
    this.enableBubble('change');
}),

//  We know that we want Field's events to bubble directly to the FormPanel.
getBubbleTarget : function() {
    if (!this.formPanel) {
        this.formPanel = this.findParentByType('form');
    }
    return this.formPanel;
}
});

var myForm = new Ext.formPanel({
title: 'User Details',
items: [{
    ...
}],
listeners: {
    change: function() {
        // Title goes red if form has been modified.
        myForm.header.setStyle('color', 'red');
    }
}
});

Parameters

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

Returns

Void

encodeFilters( Array sorters ) : String

Encodes the array of Ext.util.Filter objects into a string to be sent in the request url. By default, this simply JS...

Encodes the array of Ext.util.Filter objects into a string to be sent in the request url. By default, this simply JSON-encodes the filter data

Parameters

sorters : Array
The array of Filter objects

Returns

String The encoded filters

encodeGroupers( Object group ) : String

Encodes the grouping object (field and direction) into a string to be sent in the request url. Be default, this simpl...

Encodes the grouping object (field and direction) into a string to be sent in the request url. Be default, this simply JSON-encodes the grouping data

Parameters

group : Object
The group configuration (field and direction)

Returns

String The encoded group string

encodeSorters( Array sorters ) : String

Encodes the array of Ext.util.Sorter objects into a string to be sent in the request url. By default, this simply JS...

Encodes the array of Ext.util.Sorter objects into a string to be sent in the request url. By default, this simply JSON-encodes the sorter data

Parameters

sorters : Array
The array of Sorter objects

Returns

String The encoded sorters

fireEvent( String eventName, Object... args ) : Boolean

Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Obse...

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

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

Parameters

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

Returns

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

getMethod( Ext.data.Request request ) : String

Returns the HTTP method name for a given request. By default this returns based on a lookup on actionMethods.

Parameters

request : Ext.data.Request
The request object

Returns

String The HTTP method to use (should be one of 'GET', 'POST', 'PUT' or 'DELETE')

getModel : Ext.data.Model

Returns the model attached to this Proxy

getReader : Ext.data.Reader

Returns the reader currently attached to this proxy instance

getWriter : Ext.data.Writer

Returns the writer currently attached to this proxy instance

hasListener( String eventName ) : Boolean

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

Parameters

eventName : String
The name of the event to check for

Returns

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

observe( Function c, Object listeners ) : Void

Sets observability on the passed class constructor. This makes any event fired on any instance of the passed class al...

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

Ext.util.Observable.observe(Ext.data.Connection);
        Ext.data.Connection.on('beforerequest', function(con, options) {
            console.log('Ajax request made to ' + options.url);
        });

Parameters

c : Function
The class constructor to make observable.
listeners : Object
An object containing a series of listeners to add. See addListener.

Returns

Void

read( Ext.data.Operation operation, Function callback, Object scope ) : Void

Performs the given read operation.

Parameters

operation : Ext.data.Operation
The Operation to perform
callback : Function
Callback function to be called when the Operation has completed (whether successful or not)
scope : Object
Scope to execute the callback function in

Returns

Void

relayEvents( Object origin, Array events ) : Void

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

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

Returns

Void

releaseCapture( Observable o ) : Void

Removes all added captures from the Observable.

Removes all added captures from the Observable.

Parameters

o : Observable
The Observable to release

Returns

Void

removeListener( String eventName, Function handler, [Object scope] ) : Void

Removes an event handler.

Parameters

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

Returns

Void

removeManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope ) : Void

Removes listeners that were added by the mon method.

Parameters

item : Observable|Element
The item from which to remove a listener/listeners.
ename : Object|String
The event name, or an object containing event name properties.
fn : Function
Optional. If the ename parameter was an event name, this is the handler function.
scope : Object
Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Returns

Void

resumeEvents : Void

Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event...

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

setModel( String|Ext.data.Model model, Boolean setOnStore ) : Void

Sets the model associated with this proxy. This will only usually be called by a Store

Parameters

model : String|Ext.data.Model
The new model. Can be either the model name string, or a reference to the model's constructor
setOnStore : Boolean
Sets the new model on the associated Store, if one is present

Returns

Void

setReader( String|Object|Ext.data.Reader reader ) : Ext.data.Reader

Sets the Proxy's Reader by string, config object or Reader instance

Parameters

reader : String|Object|Ext.data.Reader
The new Reader, which can be either a type string, a configuration object or an Ext.data.Reader instance

Returns

Ext.data.Reader The attached Reader object

setWriter( String|Object|Ext.data.Writer writer ) : Ext.data.Writer

Sets the Proxy's Writer by string, config object or Writer instance

Parameters

writer : String|Object|Ext.data.Writer
The new Writer, which can be either a type string, a configuration object or an Ext.data.Writer instance

Returns

Ext.data.Writer The attached Writer object

suspendEvents( Boolean queueSuspended ) : Void

Suspend the firing of all events. (see resumeEvents)

Parameters

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

Returns

Void

update( Ext.data.Operation operation, Function callback, Object scope ) : Void

Performs the given update operation.

Parameters

operation : Ext.data.Operation
The Operation to perform
callback : Function
Callback function to be called when the Operation has completed (whether successful or not)
scope : Object
Scope to execute the callback function in

Returns

Void

Events

exception( Ext.data.Proxy this, Object response, Ext.data.Operation operation )

Fires when the server returns an exception

Parameters

this : Ext.data.Proxy
response : Object
The response from the AJAX request
operation : Ext.data.Operation
The operation that triggered request

Returns

Void

Sencha Documentation

Ext.data.RestProxy

Super classes

Mixins

Config Options

Properties

Methods

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Events

Parameters

Returns