/ext-4.1.0_b3/docs/source/JsonP.html

https://bitbucket.org/srogerf/javascript · HTML · 273 lines · 244 code · 29 blank · 0 comment · 0 complexity · 383d227e9cfe61851d6a1f8a4909758d MD5 · raw file 

    

  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4.   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    5. 

  5.   <title>The source code</title>
    6. 

  6.   <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
    7. 

  7.   <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
    8. 

  8.   <style type="text/css">
    9. 

  9.     .highlight { display: block; background-color: #ddd; }
    10. 

  10.   </style>
    11. 

  11.   <script type="text/javascript">
    12. 

  12.     function highlight() {
    13. 

  13.       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
    14. 

  14.     }
    15. 

  15.   </script>
    16. 

  16. </head>
    17. 

  17. <body onload="prettyPrint(); highlight();">
    18. 

  18.   <pre class="prettyprint lang-js"><span id='Ext-data-JsonP'>/**
    19. 

  19. </span> * @class Ext.data.JsonP
    20. 

  20.  * @singleton
    21. 

  21.  * This class is used to create JSONP requests. JSONP is a mechanism that allows for making
    22. 

  22.  * requests for data cross domain. More information is available &lt;a href=&quot;http://en.wikipedia.org/wiki/JSONP&quot;&gt;here&lt;/a&gt;.
    23. 

  23.  */
    24. 

  24. Ext.define('Ext.data.JsonP', {
    25. 

  25. 

  26.     /* Begin Definitions */
    27. 

  27. 

  28.     singleton: true,
    29. 

  29. 

  30.     statics: {
    31. 

  31.         requestCount: 0,
    32. 

  32.         requests: {}
    33. 

  33.     },
    34. 

  34. 

  35.     /* End Definitions */
    36. 

  36. 

  37. <span id='Ext-data-JsonP-property-timeout'>    /**
    38. 

  38. </span>     * @property timeout
    39. 

  39.      * @type Number
    40. 

  40.      * A default timeout for any JsonP requests. If the request has not completed in this time the
    41. 

  41.      * failure callback will be fired. The timeout is in ms. Defaults to &lt;tt&gt;30000&lt;/tt&gt;.
    42. 

  42.      */
    43. 

  43.     timeout: 30000,
    44. 

  44. 

  45. <span id='Ext-data-JsonP-property-disableCaching'>    /**
    46. 

  46. </span>     * @property disableCaching
    47. 

  47.      * @type Boolean
    48. 

  48.      * True to add a unique cache-buster param to requests. Defaults to &lt;tt&gt;true&lt;/tt&gt;.
    49. 

  49.      */
    50. 

  50.     disableCaching: true,
    51. 

  51. 

  52. <span id='Ext-data-JsonP-property-disableCachingParam'>    /**
    53. 

  53. </span>     * @property disableCachingParam
    54. 

  54.      * @type String
    55. 

  55.      * Change the parameter which is sent went disabling caching through a cache buster. Defaults to &lt;tt&gt;'_dc'&lt;/tt&gt;.
    56. 

  56.      */
    57. 

  57.     disableCachingParam: '_dc',
    58. 

  58. 

  59. <span id='Ext-data-JsonP-property-callbackKey'>    /**
    60. 

  60. </span>     * @property callbackKey
    61. 

  61.      * @type String
    62. 

  62.      * Specifies the GET parameter that will be sent to the server containing the function name to be executed when
    63. 

  63.      * the request completes. Defaults to &lt;tt&gt;callback&lt;/tt&gt;. Thus, a common request will be in the form of
    64. 

  64.      * url?callback=Ext.data.JsonP.callback1
    65. 

  65.      */
    66. 

  66.     callbackKey: 'callback',
    67. 

  67. 

  68. <span id='Ext-data-JsonP-method-request'>    /**
    69. 

  69. </span>     * Makes a JSONP request.
    70. 

  70.      * @param {Object} options An object which may contain the following properties. Note that options will
    71. 

  71.      * take priority over any defaults that are specified in the class.
    72. 

  72.      * &lt;ul&gt;
    73. 

  73.      * &lt;li&gt;&lt;b&gt;url&lt;/b&gt; : String &lt;div class=&quot;sub-desc&quot;&gt;The URL to request.&lt;/div&gt;&lt;/li&gt;
    74. 

  74.      * &lt;li&gt;&lt;b&gt;params&lt;/b&gt; : Object (Optional)&lt;div class=&quot;sub-desc&quot;&gt;An object containing a series of
    75. 

  75.      * key value pairs that will be sent along with the request.&lt;/div&gt;&lt;/li&gt;
    76. 

  76.      * &lt;li&gt;&lt;b&gt;timeout&lt;/b&gt; : Number (Optional) &lt;div class=&quot;sub-desc&quot;&gt;See {@link #timeout}&lt;/div&gt;&lt;/li&gt;
    77. 

  77.      * &lt;li&gt;&lt;b&gt;callbackKey&lt;/b&gt; : String (Optional) &lt;div class=&quot;sub-desc&quot;&gt;See {@link #callbackKey}&lt;/div&gt;&lt;/li&gt;
    78. 

  78.      * &lt;li&gt;&lt;b&gt;callbackName&lt;/b&gt; : String (Optional) &lt;div class=&quot;sub-desc&quot;&gt;The function name to use for this request.
    79. 

  79.      * By default this name will be auto-generated: Ext.data.JsonP.callback1, Ext.data.JsonP.callback2, etc.
    80. 

  80.      * Setting this option to &quot;my_name&quot; will force the function name to be Ext.data.JsonP.my_name.
    81. 

  81.      * Use this if you want deterministic behavior, but be careful - the callbackName should be different
    82. 

  82.      * in each JsonP request that you make.&lt;/div&gt;&lt;/li&gt;
    83. 

  83.      * &lt;li&gt;&lt;b&gt;disableCaching&lt;/b&gt; : Boolean (Optional) &lt;div class=&quot;sub-desc&quot;&gt;See {@link #disableCaching}&lt;/div&gt;&lt;/li&gt;
    84. 

  84.      * &lt;li&gt;&lt;b&gt;disableCachingParam&lt;/b&gt; : String (Optional) &lt;div class=&quot;sub-desc&quot;&gt;See {@link #disableCachingParam}&lt;/div&gt;&lt;/li&gt;
    85. 

  85.      * &lt;li&gt;&lt;b&gt;success&lt;/b&gt; : Function (Optional) &lt;div class=&quot;sub-desc&quot;&gt;A function to execute if the request succeeds.&lt;/div&gt;&lt;/li&gt;
    86. 

  86.      * &lt;li&gt;&lt;b&gt;failure&lt;/b&gt; : Function (Optional) &lt;div class=&quot;sub-desc&quot;&gt;A function to execute if the request fails.&lt;/div&gt;&lt;/li&gt;
    87. 

  87.      * &lt;li&gt;&lt;b&gt;callback&lt;/b&gt; : Function (Optional) &lt;div class=&quot;sub-desc&quot;&gt;A function to execute when the request
    88. 

  88.      * completes, whether it is a success or failure.&lt;/div&gt;&lt;/li&gt;
    89. 

  89.      * &lt;li&gt;&lt;b&gt;scope&lt;/b&gt; : Object (Optional)&lt;div class=&quot;sub-desc&quot;&gt;The scope in
    90. 

  90.      * which to execute the callbacks: The &quot;this&quot; object for the callback function. Defaults to the browser window.&lt;/div&gt;&lt;/li&gt;
    91. 

  91.      * &lt;/ul&gt;
    92. 

  92.      * @return {Object} request An object containing the request details.
    93. 

  93.      */
    94. 

  94.     request: function(options){
    95. 

  95.         options = Ext.apply({}, options);
    96. 

  96. 

  97.         //&lt;debug&gt;
    98. 

  98.         if (!options.url) {
    99. 

  99.             Ext.Error.raise('A url must be specified for a JSONP request.');
    100. 

  100.         }
    101. 

  101.         //&lt;/debug&gt;
    102. 

  102. 

  103.         var me = this,
    104. 

  104.             disableCaching = Ext.isDefined(options.disableCaching) ? options.disableCaching : me.disableCaching,
    105. 

  105.             cacheParam = options.disableCachingParam || me.disableCachingParam,
    106. 

  106.             id = ++me.statics().requestCount,
    107. 

  107.             callbackName = options.callbackName || 'callback' + id,
    108. 

  108.             callbackKey = options.callbackKey || me.callbackKey,
    109. 

  109.             timeout = Ext.isDefined(options.timeout) ? options.timeout : me.timeout,
    110. 

  110.             params = Ext.apply({}, options.params),
    111. 

  111.             url = options.url,
    112. 

  112.             name = Ext.name,
    113. 

  113.             request,
    114. 

  114.             script;
    115. 

  115. 

  116.         params[callbackKey] = name + '.data.JsonP.' + callbackName;
    117. 

  117.         if (disableCaching) {
    118. 

  118.             params[cacheParam] = new Date().getTime();
    119. 

  119.         }
    120. 

  120. 

  121.         script = me.createScript(url, params, options);
    122. 

  122. 

  123.         me.statics().requests[id] = request = {
    124. 

  124.             url: url,
    125. 

  125.             params: params,
    126. 

  126.             script: script,
    127. 

  127.             id: id,
    128. 

  128.             scope: options.scope,
    129. 

  129.             success: options.success,
    130. 

  130.             failure: options.failure,
    131. 

  131.             callback: options.callback,
    132. 

  132.             callbackKey: callbackKey,
    133. 

  133.             callbackName: callbackName
    134. 

  134.         };
    135. 

  135. 

  136.         if (timeout &gt; 0) {
    137. 

  137.             request.timeout = setTimeout(Ext.bind(me.handleTimeout, me, [request]), timeout);
    138. 

  138.         }
    139. 

  139. 

  140.         me.setupErrorHandling(request);
    141. 

  141.         me[callbackName] = Ext.bind(me.handleResponse, me, [request], true);
    142. 

  142.         me.loadScript(request);
    143. 

  143.         return request;
    144. 

  144.     },
    145. 

  145. 

  146. <span id='Ext-data-JsonP-method-abort'>    /**
    147. 

  147. </span>     * Abort a request. If the request parameter is not specified all open requests will
    148. 

  148.      * be aborted.
    149. 

  149.      * @param {Object/String} request (Optional) The request to abort
    150. 

  150.      */
    151. 

  151.     abort: function(request){
    152. 

  152.         var me = this,
    153. 

  153.             requests = me.statics().requests,
    154. 

  154.             key;
    155. 

  155. 

  156.         if (request) {
    157. 

  157.             if (!request.id) {
    158. 

  158.                 request = requests[request];
    159. 

  159.             }
    160. 

  160.             me.handleAbort(request);
    161. 

  161.         } else {
    162. 

  162.             for (key in requests) {
    163. 

  163.                 if (requests.hasOwnProperty(key)) {
    164. 

  164.                     me.abort(requests[key]);
    165. 

  165.                 }
    166. 

  166.             }
    167. 

  167.         }
    168. 

  168.     },
    169. 

  169. 

  170. <span id='Ext-data-JsonP-method-setupErrorHandling'>    /**
    171. 

  171. </span>     * Sets up error handling for the script
    172. 

  172.      * @private
    173. 

  173.      * @param {Object} request The request
    174. 

  174.      */
    175. 

  175.     setupErrorHandling: function(request){
    176. 

  176.         request.script.onerror = Ext.bind(this.handleError, this, [request]);
    177. 

  177.     },
    178. 

  178. 

  179. <span id='Ext-data-JsonP-method-handleAbort'>    /**
    180. 

  180. </span>     * Handles any aborts when loading the script
    181. 

  181.      * @private
    182. 

  182.      * @param {Object} request The request
    183. 

  183.      */
    184. 

  184.     handleAbort: function(request){
    185. 

  185.         request.errorType = 'abort';
    186. 

  186.         this.handleResponse(null, request);
    187. 

  187.     },
    188. 

  188. 

  189. <span id='Ext-data-JsonP-method-handleError'>    /**
    190. 

  190. </span>     * Handles any script errors when loading the script
    191. 

  191.      * @private
    192. 

  192.      * @param {Object} request The request
    193. 

  193.      */
    194. 

  194.     handleError: function(request){
    195. 

  195.         request.errorType = 'error';
    196. 

  196.         this.handleResponse(null, request);
    197. 

  197.     },
    198. 

  198. 

  199. <span id='Ext-data-JsonP-method-cleanupErrorHandling'>    /**
    200. 

  200. </span>     * Cleans up anu script handling errors
    201. 

  201.      * @private
    202. 

  202.      * @param {Object} request The request
    203. 

  203.      */
    204. 

  204.     cleanupErrorHandling: function(request){
    205. 

  205.         request.script.onerror = null;
    206. 

  206.     },
    207. 

  207. 

  208. <span id='Ext-data-JsonP-method-handleTimeout'>    /**
    209. 

  209. </span>     * Handle any script timeouts
    210. 

  210.      * @private
    211. 

  211.      * @param {Object} request The request
    212. 

  212.      */
    213. 

  213.     handleTimeout: function(request){
    214. 

  214.         request.errorType = 'timeout';
    215. 

  215.         this.handleResponse(null, request);
    216. 

  216.     },
    217. 

  217. 

  218. <span id='Ext-data-JsonP-method-handleResponse'>    /**
    219. 

  219. </span>     * Handle a successful response
    220. 

  220.      * @private
    221. 

  221.      * @param {Object} result The result from the request
    222. 

  222.      * @param {Object} request The request
    223. 

  223.      */
    224. 

  224.     handleResponse: function(result, request){
    225. 

  225. 

  226.         var success = true;
    227. 

  227. 

  228.         if (request.timeout) {
    229. 

  229.             clearTimeout(request.timeout);
    230. 

  230.         }
    231. 

  231.         delete this[request.callbackName];
    232. 

  232.         delete this.statics().requests[request.id];
    233. 

  233.         this.cleanupErrorHandling(request);
    234. 

  234.         Ext.fly(request.script).remove();
    235. 

  235. 

  236.         if (request.errorType) {
    237. 

  237.             success = false;
    238. 

  238.             Ext.callback(request.failure, request.scope, [request.errorType]);
    239. 

  239.         } else {
    240. 

  240.             Ext.callback(request.success, request.scope, [result]);
    241. 

  241.         }
    242. 

  242.         Ext.callback(request.callback, request.scope, [success, result, request.errorType]);
    243. 

  243.     },
    244. 

  244. 

  245. <span id='Ext-data-JsonP-method-createScript'>    /**
    246. 

  246. </span>     * Create the script tag given the specified url, params and options. The options
    247. 

  247.      * parameter is passed to allow an override to access it.
    248. 

  248.      * @private
    249. 

  249.      * @param {String} url The url of the request
    250. 

  250.      * @param {Object} params Any extra params to be sent
    251. 

  251.      * @param {Object} options The object passed to {@link #request}.
    252. 

  252.      */
    253. 

  253.     createScript: function(url, params, options) {
    254. 

  254.         var script = document.createElement('script');
    255. 

  255.         script.setAttribute(&quot;src&quot;, Ext.urlAppend(url, Ext.Object.toQueryString(params)));
    256. 

  256.         script.setAttribute(&quot;async&quot;, true);
    257. 

  257.         script.setAttribute(&quot;type&quot;, &quot;text/javascript&quot;);
    258. 

  258.         return script;
    259. 

  259.     },
    260. 

  260. 

  261. <span id='Ext-data-JsonP-method-loadScript'>    /**
    262. 

  262. </span>     * Loads the script for the given request by appending it to the HEAD element. This is
    263. 

  263.      * its own method so that users can override it (as well as {@link #createScript}).
    264. 

  264.      * @private
    265. 

  265.      * @param request The request object.
    266. 

  266.      */
    267. 

  267.     loadScript: function (request) {
    268. 

  268.         Ext.getHead().appendChild(request.script);
    269. 

  269.     }
    270. 

  270. });
    271. 

  271. </pre>
    272. 

  272. </body>
    273. 

  273. </html>
    274.