Upgrade to ExtJS 3.1.0 - Released 12/16/2009

[extjs.git] / docs / source / XmlReader.html
diff --git a/docs/source/XmlReader.html b/docs/source/XmlReader.html

index 41affb9..2042f60 100644 (file)
--- a/docs/source/XmlReader.html
+++ b/docs/source/XmlReader.html
@@ -1,17 +1,12 @@
-<html>
-<head>
-  <title>The source code</title>
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
-</head>
-<body  onload="prettyPrint();">
-    <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.0.3
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-<div id="cls-Ext.data.XmlReader"></div>/**
+<html>\r
+<head>\r
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js"><div id="cls-Ext.data.XmlReader"></div>/**
   * @class Ext.data.XmlReader
   * @extends Ext.data.DataReader
   * <p>Data reader class to create an Array of {@link Ext.data.Record} objects from an XML document
@@ -66,8 +61,11 @@ var myReader = new Ext.data.XmlReader({
  Ext.data.XmlReader = function(meta, recordType){
      meta = meta || {};
  
-    // backwards compat, convert idPath to idProperty
-    meta.idProperty = meta.idProperty || meta.idPath;
+    // backwards compat, convert idPath or id / success
+    Ext.applyIf(meta, {
+        idProperty: meta.idProperty || meta.idPath || meta.id,
+        successProperty: meta.successProperty || meta.success
+    });
  
      Ext.data.XmlReader.superclass.constructor.call(this, meta, recordType || meta.fields);
  };
@@ -125,17 +123,19 @@ Ext.extend(Ext.data.XmlReader, Ext.data.DataReader, {
      /**
       * Decode a json response from server.
       * @param {String} action [{@link Ext.data.Api#actions} create|read|update|destroy]
-     * @param {Ext.data.Response} response Returns an instance of {@link Ext.data.Response}
+     * @param {Object} response HTTP Response object from browser.
+     * @return {Ext.data.Response} response Returns an instance of {@link Ext.data.Response}
       */
      readResponse : function(action, response) {
          var q   = Ext.DomQuery,
          doc     = response.responseXML;
  
+        // create general Response instance.
          var res = new Ext.data.Response({
              action: action,
              success : this.getSuccess(doc),
              message: this.getMessage(doc),
-            data: this.extractData(q.select(this.meta.record, doc) || q.select(this.meta.root, doc)),
+            data: this.extractData(q.select(this.meta.record, doc) || q.select(this.meta.root, doc), false),
              raw: doc
          });
  
@@ -143,6 +143,7 @@ Ext.extend(Ext.data.XmlReader, Ext.data.DataReader, {
              throw new Ext.data.DataReader.Error('successProperty-response', this.meta.successProperty);
          }
  
+        // Create actions from a response having status 200 must return pk
          if (action === Ext.data.Api.actions.create) {
              var def = Ext.isDefined(res.data);
              if (def && Ext.isEmpty(res.data)) {
@@ -236,36 +237,6 @@ Ext.extend(Ext.data.XmlReader, Ext.data.DataReader, {
          };
      }(),
  
-    /**
-     * Extracts rows of record-data from server.  iterates and calls #extractValues
-     * TODO I don't care much for method-names of #extractData, #extractValues.
-     * @param {Array} root
-     * @param {Boolean} returnRecords When true, will return instances of Ext.data.Record; otherwise just hashes.
-     * @private
-     * @ignore
-     */
-    extractData : function(root, returnRecords) {
-        var Record  = this.recordType,
-        records     = [],
-        f           = Record.prototype.fields,
-        fi          = f.items,
-        fl          = f.length;
-        if (returnRecords === true) {
-            for (var i = 0, len = root.length; i < len; i++) {
-                var data = root[i],
-                    record = new Record(this.extractValues(data, fi, fl), this.getId(data));
-                    
-                record.node = data;
-                records.push(record);
-            }
-        } else {
-            for (var i = 0, len = root.length; i < len; i++) {
-                records.push(this.extractValues(root[i], fi, fl));
-            }
-        }
-        return records;
-    },
-
      /**
       * extracts values and type-casts a row of data from server, extracted by #extractData
       * @param {Hash} data
@@ -283,6 +254,6 @@ Ext.extend(Ext.data.XmlReader, Ext.data.DataReader, {
          }
          return values;
      }
-});</pre>
-</body>
+});</pre>    \r
+</body>\r
  </html>
 \ No newline at end of file