define(["../_base/xhr", "../_base/lang", "../json", "../_base/declare", "./util/QueryResults" /*=====, "./api/Store" =====*/
|
], function(xhr, lang, JSON, declare, QueryResults /*=====, Store =====*/){
|
|
// No base class, but for purposes of documentation, the base class is dojo/store/api/Store
|
var base = null;
|
/*===== base = Store; =====*/
|
|
/*=====
|
var __HeaderOptions = {
|
// headers: Object?
|
// Additional headers to send along with the request.
|
},
|
__PutDirectives = declare(Store.PutDirectives, __HeaderOptions),
|
__QueryOptions = declare(Store.QueryOptions, __HeaderOptions);
|
=====*/
|
|
return declare("dojo.store.JsonRest", base, {
|
// summary:
|
// This is a basic store for RESTful communicating with a server through JSON
|
// formatted data. It implements dojo/store/api/Store.
|
|
constructor: function(options){
|
// summary:
|
// This is a basic store for RESTful communicating with a server through JSON
|
// formatted data.
|
// options: dojo/store/JsonRest
|
// This provides any configuration information that will be mixed into the store
|
this.headers = {};
|
declare.safeMixin(this, options);
|
},
|
|
// headers: Object
|
// Additional headers to pass in all requests to the server. These can be overridden
|
// by passing additional headers to calls to the store.
|
headers: {},
|
|
// target: String
|
// The target base URL to use for all requests to the server. This string will be
|
// prepended to the id to generate the URL (relative or absolute) for requests
|
// sent to the server
|
target: "",
|
|
// idProperty: String
|
// Indicates the property to use as the identity property. The values of this
|
// property should be unique.
|
idProperty: "id",
|
|
// rangeParam: String
|
// Use a query parameter for the requested range. If this is omitted, than the
|
// Range header will be used. Independent of this, the X-Range header is always set.
|
|
// sortParam: String
|
// The query parameter to used for holding sort information. If this is omitted, than
|
// the sort information is included in a functional query token to avoid colliding
|
// with the set of name/value pairs.
|
|
// ascendingPrefix: String
|
// The prefix to apply to sort attribute names that are ascending
|
ascendingPrefix: "+",
|
|
// descendingPrefix: String
|
// The prefix to apply to sort attribute names that are ascending
|
descendingPrefix: "-",
|
|
_getTarget: function(id){
|
// summary:
|
// If the target has no trailing '/', then append it.
|
// id: Number
|
// The identity of the requested target
|
var target = this.target;
|
if(typeof id != "undefined"){
|
if(target.charAt(target.length-1) == '/'){
|
target += id;
|
}else{
|
target += '/' + id;
|
}
|
}
|
return target;
|
},
|
|
get: function(id, options){
|
// summary:
|
// Retrieves an object by its identity. This will trigger a GET request to the server using
|
// the url `this.target + id`.
|
// id: Number
|
// The identity to use to lookup the object
|
// options: Object?
|
// HTTP headers. For consistency with other methods, if a `headers` key exists on this object, it will be
|
// used to provide HTTP headers instead.
|
// returns: Object
|
// The object in the store that matches the given id.
|
options = options || {};
|
var headers = lang.mixin({ Accept: this.accepts }, this.headers, options.headers || options);
|
return xhr("GET", {
|
url: this._getTarget(id),
|
handleAs: "json",
|
headers: headers
|
});
|
},
|
|
// accepts: String
|
// Defines the Accept header to use on HTTP requests
|
accepts: "application/javascript, application/json",
|
|
getIdentity: function(object){
|
// summary:
|
// Returns an object's identity
|
// object: Object
|
// The object to get the identity from
|
// returns: Number
|
return object[this.idProperty];
|
},
|
|
put: function(object, options){
|
// summary:
|
// Stores an object. This will trigger a PUT request to the server
|
// if the object has an id, otherwise it will trigger a POST request.
|
// object: Object
|
// The object to store.
|
// options: __PutDirectives?
|
// Additional metadata for storing the data. Includes an "id"
|
// property if a specific id is to be used.
|
// returns: dojo/_base/Deferred
|
options = options || {};
|
var id = ("id" in options) ? options.id : this.getIdentity(object);
|
var hasId = typeof id != "undefined";
|
return xhr(hasId && !options.incremental ? "PUT" : "POST", {
|
url: this._getTarget(id),
|
postData: JSON.stringify(object),
|
handleAs: "json",
|
headers: lang.mixin({
|
"Content-Type": "application/json",
|
Accept: this.accepts,
|
"If-Match": options.overwrite === true ? "*" : null,
|
"If-None-Match": options.overwrite === false ? "*" : null
|
}, this.headers, options.headers)
|
});
|
},
|
|
add: function(object, options){
|
// summary:
|
// Adds an object. This will trigger a PUT request to the server
|
// if the object has an id, otherwise it will trigger a POST request.
|
// object: Object
|
// The object to store.
|
// options: __PutDirectives?
|
// Additional metadata for storing the data. Includes an "id"
|
// property if a specific id is to be used.
|
options = options || {};
|
options.overwrite = false;
|
return this.put(object, options);
|
},
|
|
remove: function(id, options){
|
// summary:
|
// Deletes an object by its identity. This will trigger a DELETE request to the server.
|
// id: Number
|
// The identity to use to delete the object
|
// options: __HeaderOptions?
|
// HTTP headers.
|
options = options || {};
|
return xhr("DELETE", {
|
url: this._getTarget(id),
|
headers: lang.mixin({}, this.headers, options.headers)
|
});
|
},
|
|
query: function(query, options){
|
// summary:
|
// Queries the store for objects. This will trigger a GET request to the server, with the
|
// query added as a query string.
|
// query: Object
|
// The query to use for retrieving objects from the store.
|
// options: __QueryOptions?
|
// The optional arguments to apply to the resultset.
|
// returns: dojo/store/api/Store.QueryResults
|
// The results of the query, extended with iterative methods.
|
options = options || {};
|
|
var headers = lang.mixin({ Accept: this.accepts }, this.headers, options.headers);
|
|
var hasQuestionMark = this.target.indexOf("?") > -1;
|
if(query && typeof query == "object"){
|
query = xhr.objectToQuery(query);
|
query = query ? (hasQuestionMark ? "&" : "?") + query: "";
|
}
|
if(options.start >= 0 || options.count >= 0){
|
headers["X-Range"] = "items=" + (options.start || '0') + '-' +
|
(("count" in options && options.count != Infinity) ?
|
(options.count + (options.start || 0) - 1) : '');
|
if(this.rangeParam){
|
query += (query || hasQuestionMark ? "&" : "?") + this.rangeParam + "=" + headers["X-Range"];
|
hasQuestionMark = true;
|
}else{
|
headers.Range = headers["X-Range"];
|
}
|
}
|
if(options && options.sort){
|
var sortParam = this.sortParam;
|
query += (query || hasQuestionMark ? "&" : "?") + (sortParam ? sortParam + '=' : "sort(");
|
for(var i = 0; i<options.sort.length; i++){
|
var sort = options.sort[i];
|
query += (i > 0 ? "," : "") + (sort.descending ? this.descendingPrefix : this.ascendingPrefix) + encodeURIComponent(sort.attribute);
|
}
|
if(!sortParam){
|
query += ")";
|
}
|
}
|
var results = xhr("GET", {
|
url: this.target + (query || ""),
|
handleAs: "json",
|
headers: headers
|
});
|
results.total = results.then(function(){
|
var range = results.ioArgs.xhr.getResponseHeader("Content-Range");
|
if (!range){
|
// At least Chrome drops the Content-Range header from cached replies.
|
range = results.ioArgs.xhr.getResponseHeader("X-Content-Range");
|
}
|
return range && (range = range.match(/\/(.*)/)) && +range[1];
|
});
|
return QueryResults(results);
|
}
|
});
|
|
});
|
