dojo/store/JsonRest.js

• Provides:

  • dojo.store.JsonRest

• dojo.store.JsonRest

  • type

    Function

  • parameters:
    • options: (typeof dojo.store.JsonRest)

      This provides any configuration information that will be mixed into the store

  • source: [view]
      dojo.mixin(this, options);
  • summary

    This is a basic store for RESTful communicating with a server through JSON
    formatted data.

• dojo.store.JsonRest.target

  • type

    String

  • summary

    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

• dojo.store.JsonRest.idProperty

  • type

    String

  • summary

    Indicates the property to use as the identity property. The values of this
    property should be unique.

• dojo.store.JsonRest.get

  • type

    Function

  • parameters:
    • id: (typeof Number)

      The identity to use to lookup the object

    • options: (typeof )
  • source: [view]
      var headers = options || {};
      headers.Accept = "application/javascript, application/json";
      return dojo.xhrGet({
       url:this.target + id,
       handleAs: "json",
       headers: headers
      });
  • summary

    Retrieves an object by its identity. This will trigger a GET request to the server using
    the url `this.target + id`.

  • return_summary

    Object
    The object in the store that matches the given id.

• dojo.store.JsonRest.getIdentity

  • type

    Function

  • parameters:
    • object: (typeof Object)

      The object to get the identity from

  • source: [view]
      return object[this.idProperty];
  • summary

    Returns an object's identity

  • return_summary

    Number

• dojo.store.JsonRest.put

  • type

    Function

  • parameters:
    • object: (typeof Object)

      The object to store.

    • options: (typeof dojo.store.api.Store.PutDirectives)

      Additional metadata for storing the data.  Includes an "id"
      property if a specific id is to be used.

  • source: [view]
      options = options || {};
      var id = ("id" in options) ? options.id : this.getIdentity(object);
      var hasId = typeof id != "undefined";
      return dojo.xhr(hasId && !options.incremental ? "PUT" : "POST", {
        url: hasId ? this.target + id : this.target,
        postData: dojo.toJson(object),
        handleAs: "json",
        headers:{
         "Content-Type": "application/json",
         "If-Match": options.overwrite === true ? "*" : null,
         "If-None-Match": options.overwrite === false ? "*" : null
        }
       });
  • 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.

  • return_summary

    Number

• dojo.store.JsonRest.add

  • type

    Function

  • parameters:
    • object: (typeof Object)

      The object to store.

    • options: (typeof dojo.store.api.Store.PutDirectives)

      Additional metadata for storing the data.  Includes an "id"
      property if a specific id is to be used.

  • source: [view]
      options = options || {};
      options.overwrite = false;
      return this.put(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.

• dojo.store.JsonRest.remove

  • type

    Function

  • parameters:
    • id: (typeof Number)

      The identity to use to delete the object

  • source: [view]
      return dojo.xhrDelete({
       url:this.target + id
      });
  • summary

    Deletes an object by its identity. This will trigger a DELETE request to the server.

• dojo.store.JsonRest.query

  • type

    Function

  • parameters:
    • query: (typeof Object)

      The query to use for retrieving objects from the store.

    • options: (typeof dojo.store.api.Store.QueryOptions)

      The optional arguments to apply to the resultset.

  • source: [view]
      var headers = {Accept: "application/javascript, application/json"};
      options = options || {};
    
    
      if(options.start >= 0 || options.count >= 0){
       headers.Range = "items=" + (options.start || '0') + '-' +
        (("count" in options && options.count != Infinity) ?
         (options.count + (options.start || 0) - 1) : '');
      }
      if(dojo.isObject(query)){
       query = dojo.objectToQuery(query);
       query = query ? "?" + query: "";
      }
      if(options && options.sort){
       query += (query ? "&" : "?") + "sort(";
       for(var i = 0; i    var sort = options.sort[i];
        query += (i > 0 ? "," : "") + (sort.descending ? '-' : '+') + encodeURIComponent(sort.attribute);
       }
       query += ")";
      }
      var results = dojo.xhrGet({
       url: this.target + (query || ""),
       handleAs: "json",
       headers: headers
      });
      results.total = results.then(function(){
       var range = results.ioArgs.xhr.getResponseHeader("Content-Range");
       return range && (range=range.match(/\/(.*)/)) && +range[1];
      });
      return dojo.store.util.QueryResults(results);
  • summary

    Queries the store for objects. This will trigger a GET request to the server, with the
    query added as a query string.

  • return_summary

    dojo.store.api.Store.QueryResults
    The results of the query, extended with iterative methods.

• this

  • mixins:
    • options: (normal)
  • summary

• dojo.store

  • type

    Object

  • summary

• dojo

  • type

    Object

  • summary