|
0
|
1 |
/* |
|
|
2 |
Copyright (c) 2009, Yahoo! Inc. All rights reserved. |
|
|
3 |
Code licensed under the BSD License: |
|
|
4 |
http://developer.yahoo.net/yui/license.txt |
|
|
5 |
version: 3.0.0b1 |
|
|
6 |
build: 1163 |
|
|
7 |
*/ |
|
|
8 |
YUI.add('datasource-local', function(Y) { |
|
|
9 |
|
|
|
10 |
/** |
|
|
11 |
* The DataSource utility provides a common configurable interface for widgets to |
|
|
12 |
* access a variety of data, from JavaScript arrays to online database servers. |
|
|
13 |
* |
|
|
14 |
* @module datasource |
|
|
15 |
*/ |
|
|
16 |
|
|
|
17 |
/** |
|
|
18 |
* Provides the base DataSource implementation, which can be extended to |
|
|
19 |
* create DataSources for specific data protocols, such as the IO Utility, the |
|
|
20 |
* Get Utility, or custom functions. |
|
|
21 |
* |
|
|
22 |
* @module datasource |
|
|
23 |
* @submodule datasource-local |
|
|
24 |
*/ |
|
|
25 |
|
|
|
26 |
/** |
|
|
27 |
* Base class for the DataSource Utility. |
|
|
28 |
* @class DataSource.Local |
|
|
29 |
* @extends Base |
|
|
30 |
* @constructor |
|
|
31 |
*/ |
|
|
32 |
var LANG = Y.Lang, |
|
|
33 |
|
|
|
34 |
DSLocal = function() { |
|
|
35 |
DSLocal.superclass.constructor.apply(this, arguments); |
|
|
36 |
}; |
|
|
37 |
|
|
|
38 |
///////////////////////////////////////////////////////////////////////////// |
|
|
39 |
// |
|
|
40 |
// DataSource static properties |
|
|
41 |
// |
|
|
42 |
///////////////////////////////////////////////////////////////////////////// |
|
|
43 |
Y.mix(DSLocal, { |
|
|
44 |
/** |
|
|
45 |
* Class name. |
|
|
46 |
* |
|
|
47 |
* @property NAME |
|
|
48 |
* @type String |
|
|
49 |
* @static |
|
|
50 |
* @final |
|
|
51 |
* @value "dataSourceLocal" |
|
|
52 |
*/ |
|
|
53 |
NAME: "dataSourceLocal", |
|
|
54 |
|
|
|
55 |
///////////////////////////////////////////////////////////////////////////// |
|
|
56 |
// |
|
|
57 |
// DataSource Attributes |
|
|
58 |
// |
|
|
59 |
///////////////////////////////////////////////////////////////////////////// |
|
|
60 |
|
|
|
61 |
ATTRS: { |
|
|
62 |
/** |
|
|
63 |
* @attribute source |
|
|
64 |
* @description Pointer to live data. |
|
|
65 |
* @type MIXED |
|
|
66 |
* @default null |
|
|
67 |
*/ |
|
|
68 |
source: { |
|
|
69 |
value: null |
|
|
70 |
} |
|
|
71 |
}, |
|
|
72 |
|
|
|
73 |
/** |
|
|
74 |
* Global transaction counter. |
|
|
75 |
* |
|
|
76 |
* @property DataSource._tId |
|
|
77 |
* @type Number |
|
|
78 |
* @static |
|
|
79 |
* @private |
|
|
80 |
* @default 0 |
|
|
81 |
*/ |
|
|
82 |
_tId: 0, |
|
|
83 |
|
|
|
84 |
/** |
|
|
85 |
* Executes a given callback. The third param determines whether to execute |
|
|
86 |
* |
|
|
87 |
* @method DataSource.issueCallback |
|
|
88 |
* @param callback {Object} The callback object. |
|
|
89 |
* @param params {Array} params to be passed to the callback method |
|
|
90 |
* @param error {Boolean} whether an error occurred |
|
|
91 |
* @static |
|
|
92 |
*/ |
|
|
93 |
issueCallback: function (e) { |
|
|
94 |
if(e.callback) { |
|
|
95 |
var callbackFunc = (e.error && e.callback.failure) || e.callback.success; |
|
|
96 |
if (callbackFunc) { |
|
|
97 |
callbackFunc(e); |
|
|
98 |
} |
|
|
99 |
} |
|
|
100 |
} |
|
|
101 |
}); |
|
|
102 |
|
|
|
103 |
Y.extend(DSLocal, Y.Base, { |
|
|
104 |
/** |
|
|
105 |
* Internal init() handler. |
|
|
106 |
* |
|
|
107 |
* @method initializer |
|
|
108 |
* @param config {Object} Config object. |
|
|
109 |
* @private |
|
|
110 |
*/ |
|
|
111 |
initializer: function(config) { |
|
|
112 |
this._initEvents(); |
|
|
113 |
}, |
|
|
114 |
|
|
|
115 |
/** |
|
|
116 |
* This method creates all the events for this module. |
|
|
117 |
* @method _initEvents |
|
|
118 |
* @private |
|
|
119 |
*/ |
|
|
120 |
_initEvents: function() { |
|
|
121 |
/** |
|
|
122 |
* Fired when a data request is received. |
|
|
123 |
* |
|
|
124 |
* @event request |
|
|
125 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
126 |
* <dl> |
|
|
127 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
128 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
129 |
* <dt>callback (Object)</dt> <dd>The callback object.</dd> |
|
|
130 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
131 |
* </dl> |
|
|
132 |
* @preventable _defRequestFn |
|
|
133 |
*/ |
|
|
134 |
this.publish("request", {defaultFn: Y.bind("_defRequestFn", this), queuable:true}); |
|
|
135 |
|
|
|
136 |
/** |
|
|
137 |
* Fired when raw data is received. |
|
|
138 |
* |
|
|
139 |
* @event data |
|
|
140 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
141 |
* <dl> |
|
|
142 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
143 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
144 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
145 |
* <dl> |
|
|
146 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
147 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
148 |
* </dl> |
|
|
149 |
* </dd> |
|
|
150 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
151 |
* <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
|
152 |
* </dl> |
|
|
153 |
* @preventable _defDataFn |
|
|
154 |
*/ |
|
|
155 |
this.publish("data", {defaultFn: Y.bind("_defDataFn", this), queuable:true}); |
|
|
156 |
|
|
|
157 |
/** |
|
|
158 |
* Fired when response is returned. |
|
|
159 |
* |
|
|
160 |
* @event response |
|
|
161 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
162 |
* <dl> |
|
|
163 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
164 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
165 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
166 |
* <dl> |
|
|
167 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
168 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
169 |
* </dl> |
|
|
170 |
* </dd> |
|
|
171 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
172 |
* <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
|
173 |
* <dt>response (Object)</dt> <dd>Normalized response object with the following properties: |
|
|
174 |
* <dl> |
|
|
175 |
* <dt>results (Object)</dt> <dd>Parsed results.</dd> |
|
|
176 |
* <dt>meta (Object)</dt> <dd>Parsed meta data.</dd> |
|
|
177 |
* <dt>error (Boolean)</dt> <dd>Error flag.</dd> |
|
|
178 |
* </dl> |
|
|
179 |
* </dd> |
|
|
180 |
* </dl> |
|
|
181 |
* @preventable _defResponseFn |
|
|
182 |
*/ |
|
|
183 |
this.publish("response", {defaultFn: Y.bind("_defResponseFn", this), queuable:true}); |
|
|
184 |
|
|
|
185 |
/** |
|
|
186 |
* Fired when an error is encountered. |
|
|
187 |
* |
|
|
188 |
* @event error |
|
|
189 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
190 |
* <dl> |
|
|
191 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
192 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
193 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
194 |
* <dl> |
|
|
195 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
196 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
197 |
* </dl> |
|
|
198 |
* </dd> |
|
|
199 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
200 |
* <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
|
201 |
* <dt>response (Object)</dt> <dd>Normalized response object with the following properties: |
|
|
202 |
* <dl> |
|
|
203 |
* <dt>results (Object)</dt> <dd>Parsed results.</dd> |
|
|
204 |
* <dt>meta (Object)</dt> <dd>Parsed meta data.</dd> |
|
|
205 |
* <dt>error (Object)</dt> <dd>Error object.</dd> |
|
|
206 |
* </dl> |
|
|
207 |
* </dd> |
|
|
208 |
* </dl> |
|
|
209 |
*/ |
|
|
210 |
|
|
|
211 |
}, |
|
|
212 |
|
|
|
213 |
/** |
|
|
214 |
* Manages request/response transaction. Must fire <code>response</code> |
|
|
215 |
* event when response is received. This method should be implemented by |
|
|
216 |
* subclasses to achieve more complex behavior such as accessing remote data. |
|
|
217 |
* |
|
|
218 |
* @method _defRequestFn |
|
|
219 |
* @param e {Event.Facade} Event Facadewith the following properties: |
|
|
220 |
* <dl> |
|
|
221 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
222 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
223 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
224 |
* <dl> |
|
|
225 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
226 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
227 |
* </dl> |
|
|
228 |
* </dd> |
|
|
229 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
230 |
* </dl> |
|
|
231 |
* @protected |
|
|
232 |
*/ |
|
|
233 |
_defRequestFn: function(e) { |
|
|
234 |
var data = this.get("source"); |
|
|
235 |
|
|
|
236 |
// Problematic data |
|
|
237 |
if(LANG.isUndefined(data)) { |
|
|
238 |
e.error = new Error("Local source undefined"); |
|
|
239 |
} |
|
|
240 |
if(e.error) { |
|
|
241 |
this.fire("error", e); |
|
|
242 |
} |
|
|
243 |
|
|
|
244 |
this.fire("data", Y.mix({data:data}, e)); |
|
|
245 |
}, |
|
|
246 |
|
|
|
247 |
/** |
|
|
248 |
* Normalizes raw data into a response that includes results and meta properties. |
|
|
249 |
* |
|
|
250 |
* @method _defDataFn |
|
|
251 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
252 |
* <dl> |
|
|
253 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
254 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
255 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
256 |
* <dl> |
|
|
257 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
258 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
259 |
* </dl> |
|
|
260 |
* </dd> |
|
|
261 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
262 |
* <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
|
263 |
* </dl> |
|
|
264 |
* @protected |
|
|
265 |
*/ |
|
|
266 |
_defDataFn: function(e) { |
|
|
267 |
var data = e.data, |
|
|
268 |
meta = e.meta, |
|
|
269 |
response = { |
|
|
270 |
results: (LANG.isArray(data)) ? data : [data], |
|
|
271 |
meta: (meta) ? meta : {} |
|
|
272 |
}; |
|
|
273 |
|
|
|
274 |
this.fire("response", Y.mix({response: response}, e)); |
|
|
275 |
}, |
|
|
276 |
|
|
|
277 |
/** |
|
|
278 |
* Sends data as a normalized response to callback. |
|
|
279 |
* |
|
|
280 |
* @method _defResponseFn |
|
|
281 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
282 |
* <dl> |
|
|
283 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
284 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
285 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
286 |
* <dl> |
|
|
287 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
288 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
289 |
* </dl> |
|
|
290 |
* </dd> |
|
|
291 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
292 |
* <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
|
293 |
* <dt>response (Object)</dt> <dd>Normalized response object with the following properties: |
|
|
294 |
* <dl> |
|
|
295 |
* <dt>results (Object)</dt> <dd>Parsed results.</dd> |
|
|
296 |
* <dt>meta (Object)</dt> <dd>Parsed meta data.</dd> |
|
|
297 |
* <dt>error (Boolean)</dt> <dd>Error flag.</dd> |
|
|
298 |
* </dl> |
|
|
299 |
* </dd> |
|
|
300 |
* </dl> |
|
|
301 |
* @protected |
|
|
302 |
*/ |
|
|
303 |
_defResponseFn: function(e) { |
|
|
304 |
// Send the response back to the callback |
|
|
305 |
DSLocal.issueCallback(e); |
|
|
306 |
}, |
|
|
307 |
|
|
|
308 |
/** |
|
|
309 |
* Generates a unique transaction ID and fires <code>request</code> event. |
|
|
310 |
* |
|
|
311 |
* @method sendRequest |
|
|
312 |
* @param request {Object} Request. |
|
|
313 |
* @param callback {Object} An object literal with the following properties: |
|
|
314 |
* <dl> |
|
|
315 |
* <dt><code>success</code></dt> |
|
|
316 |
* <dd>The function to call when the data is ready.</dd> |
|
|
317 |
* <dt><code>failure</code></dt> |
|
|
318 |
* <dd>The function to call upon a response failure condition.</dd> |
|
|
319 |
* <dt><code>argument</code></dt> |
|
|
320 |
* <dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd> |
|
|
321 |
* </dl> |
|
|
322 |
* @param cfg {Object} Configuration object |
|
|
323 |
* @return {Number} Transaction ID. |
|
|
324 |
*/ |
|
|
325 |
sendRequest: function(request, callback, cfg) { |
|
|
326 |
var tId = DSLocal._tId++; |
|
|
327 |
this.fire("request", {tId:tId, request:request, callback:callback, cfg:cfg || {}}); |
|
|
328 |
return tId; |
|
|
329 |
} |
|
|
330 |
}); |
|
|
331 |
|
|
|
332 |
Y.namespace("DataSource").Local = DSLocal; |
|
|
333 |
|
|
|
334 |
|
|
|
335 |
|
|
|
336 |
}, '3.0.0b1' ,{requires:['base']}); |
|
|
337 |
|
|
|
338 |
YUI.add('datasource-io', function(Y) { |
|
|
339 |
|
|
|
340 |
/** |
|
|
341 |
* Provides a DataSource implementation which can be used to retrieve data via the IO Utility. |
|
|
342 |
* |
|
|
343 |
* @module datasource |
|
|
344 |
* @submodule datasource-io |
|
|
345 |
*/ |
|
|
346 |
|
|
|
347 |
/** |
|
|
348 |
* IO subclass for the DataSource Utility. |
|
|
349 |
* @class DataSource.IO |
|
|
350 |
* @extends DataSource.Local |
|
|
351 |
* @constructor |
|
|
352 |
*/ |
|
|
353 |
var DSIO = function() { |
|
|
354 |
DSIO.superclass.constructor.apply(this, arguments); |
|
|
355 |
}; |
|
|
356 |
|
|
|
357 |
|
|
|
358 |
///////////////////////////////////////////////////////////////////////////// |
|
|
359 |
// |
|
|
360 |
// DataSource.IO static properties |
|
|
361 |
// |
|
|
362 |
///////////////////////////////////////////////////////////////////////////// |
|
|
363 |
Y.mix(DSIO, { |
|
|
364 |
/** |
|
|
365 |
* Class name. |
|
|
366 |
* |
|
|
367 |
* @property NAME |
|
|
368 |
* @type String |
|
|
369 |
* @static |
|
|
370 |
* @final |
|
|
371 |
* @value "dataSourceIO" |
|
|
372 |
*/ |
|
|
373 |
NAME: "dataSourceIO", |
|
|
374 |
|
|
|
375 |
|
|
|
376 |
///////////////////////////////////////////////////////////////////////////// |
|
|
377 |
// |
|
|
378 |
// DataSource.IO Attributes |
|
|
379 |
// |
|
|
380 |
///////////////////////////////////////////////////////////////////////////// |
|
|
381 |
|
|
|
382 |
ATTRS: { |
|
|
383 |
/** |
|
|
384 |
* Pointer to IO Utility. |
|
|
385 |
* |
|
|
386 |
* @attribute io |
|
|
387 |
* @type Y.io |
|
|
388 |
* @default Y.io |
|
|
389 |
*/ |
|
|
390 |
io: { |
|
|
391 |
value: Y.io, |
|
|
392 |
cloneDefaultValue: false |
|
|
393 |
} |
|
|
394 |
} |
|
|
395 |
}); |
|
|
396 |
|
|
|
397 |
Y.extend(DSIO, Y.DataSource.Local, { |
|
|
398 |
/** |
|
|
399 |
* Internal init() handler. |
|
|
400 |
* |
|
|
401 |
* @method initializer |
|
|
402 |
* @param config {Object} Config object. |
|
|
403 |
* @private |
|
|
404 |
*/ |
|
|
405 |
initializer: function(config) { |
|
|
406 |
this._queue = {interval:null, conn:null, requests:[]}; |
|
|
407 |
}, |
|
|
408 |
|
|
|
409 |
/** |
|
|
410 |
* @property _queue |
|
|
411 |
* @description Object literal to manage asynchronous request/response |
|
|
412 |
* cycles enabled if queue needs to be managed (asyncMode/ioConnMode): |
|
|
413 |
* <dl> |
|
|
414 |
* <dt>interval {Number}</dt> |
|
|
415 |
* <dd>Interval ID of in-progress queue.</dd> |
|
|
416 |
* <dt>conn</dt> |
|
|
417 |
* <dd>In-progress connection identifier (if applicable).</dd> |
|
|
418 |
* <dt>requests {Object[]}</dt> |
|
|
419 |
* <dd>Array of queued request objects: {request:request, callback:callback}.</dd> |
|
|
420 |
* </dl> |
|
|
421 |
* @type Object |
|
|
422 |
* @default {interval:null, conn:null, requests:[]} |
|
|
423 |
* @private |
|
|
424 |
*/ |
|
|
425 |
_queue: null, |
|
|
426 |
|
|
|
427 |
/** |
|
|
428 |
* Passes query string to IO. Fires <code>response</code> event when |
|
|
429 |
* response is received asynchronously. |
|
|
430 |
* |
|
|
431 |
* @method _defRequestFn |
|
|
432 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
433 |
* <dl> |
|
|
434 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
435 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
436 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
437 |
* <dl> |
|
|
438 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
439 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
440 |
* </dl> |
|
|
441 |
* </dd> |
|
|
442 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
443 |
* </dl> |
|
|
444 |
* @protected |
|
|
445 |
*/ |
|
|
446 |
_defRequestFn: function(e) { |
|
|
447 |
var uri = this.get("source"), |
|
|
448 |
cfg = Y.mix(e.cfg, { |
|
|
449 |
on: { |
|
|
450 |
success: function (id, response, e) { |
|
|
451 |
this.fire("data", Y.mix({data:response}, e)); |
|
|
452 |
}, |
|
|
453 |
failure: function (id, response, e) { |
|
|
454 |
e.error = new Error("IO data failure"); |
|
|
455 |
this.fire("error", Y.mix({data:response}, e)); |
|
|
456 |
this.fire("data", Y.mix({data:response}, e)); |
|
|
457 |
} |
|
|
458 |
}, |
|
|
459 |
context: this, |
|
|
460 |
arguments: e |
|
|
461 |
}); |
|
|
462 |
|
|
|
463 |
this.get("io")(uri, cfg); |
|
|
464 |
return e.tId; |
|
|
465 |
} |
|
|
466 |
}); |
|
|
467 |
|
|
|
468 |
Y.DataSource.IO = DSIO; |
|
|
469 |
|
|
|
470 |
|
|
|
471 |
|
|
|
472 |
|
|
|
473 |
}, '3.0.0b1' ,{requires:['datasource-local', 'io']}); |
|
|
474 |
|
|
|
475 |
YUI.add('datasource-get', function(Y) { |
|
|
476 |
|
|
|
477 |
/** |
|
|
478 |
* Provides a DataSource implementation which can be used to retrieve data via the Get Utility. |
|
|
479 |
* |
|
|
480 |
* @module datasource |
|
|
481 |
* @submodule datasource-get |
|
|
482 |
*/ |
|
|
483 |
|
|
|
484 |
/** |
|
|
485 |
* Get Utility subclass for the DataSource Utility. |
|
|
486 |
* @class DataSource.Get |
|
|
487 |
* @extends DataSource.Local |
|
|
488 |
* @constructor |
|
|
489 |
*/ |
|
|
490 |
var DSGet = function() { |
|
|
491 |
DSGet.superclass.constructor.apply(this, arguments); |
|
|
492 |
}; |
|
|
493 |
|
|
|
494 |
|
|
|
495 |
///////////////////////////////////////////////////////////////////////////// |
|
|
496 |
// |
|
|
497 |
// DataSource.Get static properties |
|
|
498 |
// |
|
|
499 |
///////////////////////////////////////////////////////////////////////////// |
|
|
500 |
Y.mix(DSGet, { |
|
|
501 |
/** |
|
|
502 |
* Class name. |
|
|
503 |
* |
|
|
504 |
* @property NAME |
|
|
505 |
* @type String |
|
|
506 |
* @static |
|
|
507 |
* @final |
|
|
508 |
* @value "dataSourceGet" |
|
|
509 |
*/ |
|
|
510 |
NAME: "dataSourceGet", |
|
|
511 |
|
|
|
512 |
|
|
|
513 |
///////////////////////////////////////////////////////////////////////////// |
|
|
514 |
// |
|
|
515 |
// DataSource.Get Attributes |
|
|
516 |
// |
|
|
517 |
///////////////////////////////////////////////////////////////////////////// |
|
|
518 |
|
|
|
519 |
ATTRS: { |
|
|
520 |
/** |
|
|
521 |
* Pointer to Get Utility. |
|
|
522 |
* |
|
|
523 |
* @attribute get |
|
|
524 |
* @type Y.Get |
|
|
525 |
* @default Y.Get |
|
|
526 |
*/ |
|
|
527 |
get: { |
|
|
528 |
value: Y.Get, |
|
|
529 |
cloneDefaultValue: false |
|
|
530 |
}, |
|
|
531 |
|
|
|
532 |
/** |
|
|
533 |
* Defines request/response management in the following manner: |
|
|
534 |
* <dl> |
|
|
535 |
* <!--<dt>queueRequests</dt> |
|
|
536 |
* <dd>If a request is already in progress, wait until response is returned before sending the next request.</dd> |
|
|
537 |
* <dt>cancelStaleRequests</dt> |
|
|
538 |
* <dd>If a request is already in progress, cancel it before sending the next request.</dd>--> |
|
|
539 |
* <dt>ignoreStaleResponses</dt> |
|
|
540 |
* <dd>Send all requests, but handle only the response for the most recently sent request.</dd> |
|
|
541 |
* <dt>allowAll</dt> |
|
|
542 |
* <dd>Send all requests and handle all responses.</dd> |
|
|
543 |
* </dl> |
|
|
544 |
* |
|
|
545 |
* @attribute asyncMode |
|
|
546 |
* @type String |
|
|
547 |
* @default "allowAll" |
|
|
548 |
*/ |
|
|
549 |
asyncMode: { |
|
|
550 |
value: "allowAll" |
|
|
551 |
}, |
|
|
552 |
|
|
|
553 |
/** |
|
|
554 |
* Callback string parameter name sent to the remote script. By default, |
|
|
555 |
* requests are sent to |
|
|
556 |
* <URI>?<scriptCallbackParam>=callbackFunction |
|
|
557 |
* |
|
|
558 |
* @attribute scriptCallbackParam |
|
|
559 |
* @type String |
|
|
560 |
* @default "callback" |
|
|
561 |
*/ |
|
|
562 |
scriptCallbackParam : { |
|
|
563 |
value: "callback" |
|
|
564 |
}, |
|
|
565 |
|
|
|
566 |
/** |
|
|
567 |
* Accepts the DataSource instance and a callback ID, and returns a callback |
|
|
568 |
* param/value string that gets appended to the script URI. Implementers |
|
|
569 |
* can customize this string to match their server's query syntax. |
|
|
570 |
* |
|
|
571 |
* @attribute generateRequestCallback |
|
|
572 |
* @type Function |
|
|
573 |
*/ |
|
|
574 |
generateRequestCallback : { |
|
|
575 |
value: function(self, id) { |
|
|
576 |
return "&" + self.get("scriptCallbackParam") + "=YUI.Env.DataSource.callbacks["+id+"]" ; |
|
|
577 |
} |
|
|
578 |
} |
|
|
579 |
|
|
|
580 |
|
|
|
581 |
|
|
|
582 |
|
|
|
583 |
|
|
|
584 |
}, |
|
|
585 |
|
|
|
586 |
/** |
|
|
587 |
* Global array of callback functions, one for each request sent. |
|
|
588 |
* |
|
|
589 |
* @property callbacks |
|
|
590 |
* @type Function[] |
|
|
591 |
* @static |
|
|
592 |
*/ |
|
|
593 |
callbacks : [], |
|
|
594 |
|
|
|
595 |
/** |
|
|
596 |
* Unique ID to track requests. |
|
|
597 |
* |
|
|
598 |
* @property _tId |
|
|
599 |
* @type Number |
|
|
600 |
* @private |
|
|
601 |
* @static |
|
|
602 |
*/ |
|
|
603 |
_tId : 0 |
|
|
604 |
}); |
|
|
605 |
|
|
|
606 |
Y.extend(DSGet, Y.DataSource.Local, { |
|
|
607 |
/** |
|
|
608 |
* Passes query string to Get Utility. Fires <code>response</code> event when |
|
|
609 |
* response is received asynchronously. |
|
|
610 |
* |
|
|
611 |
* @method _defRequestFn |
|
|
612 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
613 |
* <dl> |
|
|
614 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
615 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
616 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
617 |
* <dl> |
|
|
618 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
619 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
620 |
* </dl> |
|
|
621 |
* </dd> |
|
|
622 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
623 |
* </dl> |
|
|
624 |
* @protected |
|
|
625 |
*/ |
|
|
626 |
_defRequestFn: function(e) { |
|
|
627 |
var uri = this.get("source"), |
|
|
628 |
get = this.get("get"), |
|
|
629 |
id = DSGet._tId++, |
|
|
630 |
self = this; |
|
|
631 |
|
|
|
632 |
|
|
|
633 |
|
|
|
634 |
|
|
|
635 |
|
|
|
636 |
|
|
|
637 |
|
|
|
638 |
|
|
|
639 |
|
|
|
640 |
|
|
|
641 |
|
|
|
642 |
|
|
|
643 |
|
|
|
644 |
// Dynamically add handler function with a closure to the callback stack |
|
|
645 |
YUI.Env.DataSource.callbacks[id] = Y.rbind(function(response) { |
|
|
646 |
if((self.get("asyncMode") !== "ignoreStaleResponses")|| |
|
|
647 |
(id === DSGet.callbacks.length-1)) { // Must ignore stale responses |
|
|
648 |
|
|
|
649 |
self.fire("data", Y.mix({data:response}, e)); |
|
|
650 |
} |
|
|
651 |
else { |
|
|
652 |
} |
|
|
653 |
|
|
|
654 |
delete DSGet.callbacks[id]; |
|
|
655 |
}, this, id); |
|
|
656 |
|
|
|
657 |
// We are now creating a request |
|
|
658 |
uri += e.request + this.get("generateRequestCallback")(this, id); |
|
|
659 |
//uri = this.doBefore(sUri); |
|
|
660 |
get.script(uri, { |
|
|
661 |
autopurge: true, |
|
|
662 |
// Works in Firefox only.... |
|
|
663 |
onFailure: Y.bind(function(e) { |
|
|
664 |
e.error = new Error("Script node data failure"); |
|
|
665 |
this.fire("error", e); |
|
|
666 |
}, this, e) |
|
|
667 |
}); |
|
|
668 |
|
|
|
669 |
|
|
|
670 |
|
|
|
671 |
|
|
|
672 |
|
|
|
673 |
|
|
|
674 |
|
|
|
675 |
|
|
|
676 |
|
|
|
677 |
|
|
|
678 |
|
|
|
679 |
|
|
|
680 |
|
|
|
681 |
|
|
|
682 |
|
|
|
683 |
return e.tId; |
|
|
684 |
} |
|
|
685 |
}); |
|
|
686 |
|
|
|
687 |
Y.DataSource.Get = DSGet; |
|
|
688 |
YUI.namespace("Env.DataSource.callbacks"); |
|
|
689 |
|
|
|
690 |
|
|
|
691 |
|
|
|
692 |
|
|
|
693 |
}, '3.0.0b1' ,{requires:['datasource-local', 'get']}); |
|
|
694 |
|
|
|
695 |
YUI.add('datasource-function', function(Y) { |
|
|
696 |
|
|
|
697 |
/** |
|
|
698 |
* Provides a DataSource implementation which can be used to retrieve data from a custom function. |
|
|
699 |
* |
|
|
700 |
* @module datasource |
|
|
701 |
* @submodule datasource-function |
|
|
702 |
*/ |
|
|
703 |
|
|
|
704 |
/** |
|
|
705 |
* Function subclass for the DataSource Utility. |
|
|
706 |
* @class DataSource.Function |
|
|
707 |
* @extends DataSource.Local |
|
|
708 |
* @constructor |
|
|
709 |
*/ |
|
|
710 |
var LANG = Y.Lang, |
|
|
711 |
|
|
|
712 |
DSFn = function() { |
|
|
713 |
DSFn.superclass.constructor.apply(this, arguments); |
|
|
714 |
}; |
|
|
715 |
|
|
|
716 |
|
|
|
717 |
///////////////////////////////////////////////////////////////////////////// |
|
|
718 |
// |
|
|
719 |
// DataSource.Function static properties |
|
|
720 |
// |
|
|
721 |
///////////////////////////////////////////////////////////////////////////// |
|
|
722 |
Y.mix(DSFn, { |
|
|
723 |
/** |
|
|
724 |
* Class name. |
|
|
725 |
* |
|
|
726 |
* @property NAME |
|
|
727 |
* @type String |
|
|
728 |
* @static |
|
|
729 |
* @final |
|
|
730 |
* @value "dataSourceFunction" |
|
|
731 |
*/ |
|
|
732 |
NAME: "dataSourceFunction", |
|
|
733 |
|
|
|
734 |
|
|
|
735 |
///////////////////////////////////////////////////////////////////////////// |
|
|
736 |
// |
|
|
737 |
// DataSource.Function Attributes |
|
|
738 |
// |
|
|
739 |
///////////////////////////////////////////////////////////////////////////// |
|
|
740 |
|
|
|
741 |
ATTRS: { |
|
|
742 |
/** |
|
|
743 |
* @attribute source |
|
|
744 |
* @description Pointer to live data. |
|
|
745 |
* @type MIXED |
|
|
746 |
* @default null |
|
|
747 |
*/ |
|
|
748 |
source: { |
|
|
749 |
validator: LANG.isFunction |
|
|
750 |
} |
|
|
751 |
} |
|
|
752 |
}); |
|
|
753 |
|
|
|
754 |
Y.extend(DSFn, Y.DataSource.Local, { |
|
|
755 |
/** |
|
|
756 |
* Passes query string to IO. Fires <code>response</code> event when |
|
|
757 |
* response is received asynchronously. |
|
|
758 |
* |
|
|
759 |
* @method _defRequestFn |
|
|
760 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
761 |
* <dl> |
|
|
762 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
763 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
764 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
765 |
* <dl> |
|
|
766 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
767 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
768 |
* </dl> |
|
|
769 |
* </dd> |
|
|
770 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
771 |
* </dl> |
|
|
772 |
* @protected |
|
|
773 |
*/ |
|
|
774 |
_defRequestFn: function(e) { |
|
|
775 |
var fn = this.get("source"), |
|
|
776 |
response; |
|
|
777 |
|
|
|
778 |
if(fn) { |
|
|
779 |
response = fn(e.request, this, e); |
|
|
780 |
this.fire("data", Y.mix({data:response}, e)); |
|
|
781 |
} |
|
|
782 |
else { |
|
|
783 |
e.error = new Error("Function data failure"); |
|
|
784 |
this.fire("error", e); |
|
|
785 |
} |
|
|
786 |
|
|
|
787 |
return e.tId; |
|
|
788 |
} |
|
|
789 |
}); |
|
|
790 |
|
|
|
791 |
Y.DataSource.Function = DSFn; |
|
|
792 |
|
|
|
793 |
|
|
|
794 |
|
|
|
795 |
|
|
|
796 |
}, '3.0.0b1' ,{requires:['datasource-local']}); |
|
|
797 |
|
|
|
798 |
YUI.add('datasource-cache', function(Y) { |
|
|
799 |
|
|
|
800 |
/** |
|
|
801 |
* Extends DataSource with caching functionality. |
|
|
802 |
* |
|
|
803 |
* @module datasource |
|
|
804 |
* @submodule datasource-cache |
|
|
805 |
*/ |
|
|
806 |
|
|
|
807 |
/** |
|
|
808 |
* Adds cacheability to the DataSource Utility. |
|
|
809 |
* @class DataSourceCache |
|
|
810 |
* @extends Cache |
|
|
811 |
*/ |
|
|
812 |
var DataSourceCache = function() { |
|
|
813 |
DataSourceCache.superclass.constructor.apply(this, arguments); |
|
|
814 |
}; |
|
|
815 |
|
|
|
816 |
Y.mix(DataSourceCache, { |
|
|
817 |
/** |
|
|
818 |
* The namespace for the plugin. This will be the property on the host which |
|
|
819 |
* references the plugin instance. |
|
|
820 |
* |
|
|
821 |
* @property NS |
|
|
822 |
* @type String |
|
|
823 |
* @static |
|
|
824 |
* @final |
|
|
825 |
* @value "cache" |
|
|
826 |
*/ |
|
|
827 |
NS: "cache", |
|
|
828 |
|
|
|
829 |
/** |
|
|
830 |
* Class name. |
|
|
831 |
* |
|
|
832 |
* @property NAME |
|
|
833 |
* @type String |
|
|
834 |
* @static |
|
|
835 |
* @final |
|
|
836 |
* @value "dataSourceCache" |
|
|
837 |
*/ |
|
|
838 |
NAME: "dataSourceCache", |
|
|
839 |
|
|
|
840 |
///////////////////////////////////////////////////////////////////////////// |
|
|
841 |
// |
|
|
842 |
// DataSourceCache Attributes |
|
|
843 |
// |
|
|
844 |
///////////////////////////////////////////////////////////////////////////// |
|
|
845 |
|
|
|
846 |
ATTRS: { |
|
|
847 |
|
|
|
848 |
} |
|
|
849 |
}); |
|
|
850 |
|
|
|
851 |
Y.extend(DataSourceCache, Y.Cache, { |
|
|
852 |
/** |
|
|
853 |
* Internal init() handler. |
|
|
854 |
* |
|
|
855 |
* @method initializer |
|
|
856 |
* @param config {Object} Config object. |
|
|
857 |
* @private |
|
|
858 |
*/ |
|
|
859 |
initializer: function(config) { |
|
|
860 |
this.doBefore("_defRequestFn", this._beforeDefRequestFn); |
|
|
861 |
this.doBefore("_defResponseFn", this._beforeDefResponseFn); |
|
|
862 |
}, |
|
|
863 |
|
|
|
864 |
/** |
|
|
865 |
* First look for cached response, then send request to live data. |
|
|
866 |
* |
|
|
867 |
* @method _beforeDefRequestFn |
|
|
868 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
869 |
* <dl> |
|
|
870 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
871 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
872 |
* <dt>callback (Object)</dt> <dd>The callback object.</dd> |
|
|
873 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
874 |
* </dl> |
|
|
875 |
* @protected |
|
|
876 |
*/ |
|
|
877 |
_beforeDefRequestFn: function(e) { |
|
|
878 |
// Is response already in the Cache? |
|
|
879 |
var entry = (this.retrieve(e.request)) || null; |
|
|
880 |
if(entry && entry.response) { |
|
|
881 |
this.get("host").fire("response", Y.mix({response: entry.response}, e)); |
|
|
882 |
return new Y.Do.Halt("DataSourceCache plugin halted _defRequestFn"); |
|
|
883 |
} |
|
|
884 |
}, |
|
|
885 |
|
|
|
886 |
/** |
|
|
887 |
* Adds data to cache before returning data. |
|
|
888 |
* |
|
|
889 |
* @method _beforeDefResponseFn |
|
|
890 |
* @param e {Event.Facade} Event Facade with the following properties: |
|
|
891 |
* <dl> |
|
|
892 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
893 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
894 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
895 |
* <dl> |
|
|
896 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
897 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
898 |
* </dl> |
|
|
899 |
* </dd> |
|
|
900 |
* <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
|
901 |
* <dt>response (Object)</dt> <dd>Normalized response object with the following properties: |
|
|
902 |
* <dl> |
|
|
903 |
* <dt>cached (Object)</dt> <dd>True when response is cached.</dd> |
|
|
904 |
* <dt>results (Object)</dt> <dd>Parsed results.</dd> |
|
|
905 |
* <dt>meta (Object)</dt> <dd>Parsed meta data.</dd> |
|
|
906 |
* <dt>error (Object)</dt> <dd>Error object.</dd> |
|
|
907 |
* </dl> |
|
|
908 |
* </dd> |
|
|
909 |
* <dt>cfg (Object)</dt> <dd>Configuration object.</dd> |
|
|
910 |
* </dl> |
|
|
911 |
* @protected |
|
|
912 |
*/ |
|
|
913 |
_beforeDefResponseFn: function(e) { |
|
|
914 |
// Add to Cache before returning |
|
|
915 |
if(e.response && !e.response.cached) { |
|
|
916 |
e.response.cached = true; |
|
|
917 |
this.add(e.request, e.response, (e.callback && e.callback.argument)); |
|
|
918 |
} |
|
|
919 |
} |
|
|
920 |
}); |
|
|
921 |
|
|
|
922 |
Y.namespace('Plugin').DataSourceCache = DataSourceCache; |
|
|
923 |
|
|
|
924 |
|
|
|
925 |
|
|
|
926 |
}, '3.0.0b1' ,{requires:['datasource-local', 'cache']}); |
|
|
927 |
|
|
|
928 |
YUI.add('datasource-jsonschema', function(Y) { |
|
|
929 |
|
|
|
930 |
/** |
|
|
931 |
* Extends DataSource with schema-parsing on JSON data. |
|
|
932 |
* |
|
|
933 |
* @module datasource |
|
|
934 |
* @submodule datasource-jsonschema |
|
|
935 |
*/ |
|
|
936 |
|
|
|
937 |
/** |
|
|
938 |
* Adds schema-parsing to the DataSource Utility. |
|
|
939 |
* @class DataSourceJSONSchema |
|
|
940 |
* @extends Plugin.Base |
|
|
941 |
*/ |
|
|
942 |
var DataSourceJSONSchema = function() { |
|
|
943 |
DataSourceJSONSchema.superclass.constructor.apply(this, arguments); |
|
|
944 |
}; |
|
|
945 |
|
|
|
946 |
Y.mix(DataSourceJSONSchema, { |
|
|
947 |
/** |
|
|
948 |
* The namespace for the plugin. This will be the property on the host which |
|
|
949 |
* references the plugin instance. |
|
|
950 |
* |
|
|
951 |
* @property NS |
|
|
952 |
* @type String |
|
|
953 |
* @static |
|
|
954 |
* @final |
|
|
955 |
* @value "schema" |
|
|
956 |
*/ |
|
|
957 |
NS: "schema", |
|
|
958 |
|
|
|
959 |
/** |
|
|
960 |
* Class name. |
|
|
961 |
* |
|
|
962 |
* @property NAME |
|
|
963 |
* @type String |
|
|
964 |
* @static |
|
|
965 |
* @final |
|
|
966 |
* @value "dataSourceJSONSchema" |
|
|
967 |
*/ |
|
|
968 |
NAME: "dataSourceJSONSchema", |
|
|
969 |
|
|
|
970 |
///////////////////////////////////////////////////////////////////////////// |
|
|
971 |
// |
|
|
972 |
// DataSourceJSONSchema Attributes |
|
|
973 |
// |
|
|
974 |
///////////////////////////////////////////////////////////////////////////// |
|
|
975 |
|
|
|
976 |
ATTRS: { |
|
|
977 |
schema: { |
|
|
978 |
//value: {} |
|
|
979 |
} |
|
|
980 |
} |
|
|
981 |
}); |
|
|
982 |
|
|
|
983 |
Y.extend(DataSourceJSONSchema, Y.Plugin.Base, { |
|
|
984 |
/** |
|
|
985 |
* Internal init() handler. |
|
|
986 |
* |
|
|
987 |
* @method initializer |
|
|
988 |
* @param config {Object} Config object. |
|
|
989 |
* @private |
|
|
990 |
*/ |
|
|
991 |
initializer: function(config) { |
|
|
992 |
this.doBefore("_defDataFn", this._beforeDefDataFn); |
|
|
993 |
}, |
|
|
994 |
|
|
|
995 |
/** |
|
|
996 |
* Parses raw data into a normalized response. |
|
|
997 |
* |
|
|
998 |
* @method _beforeDefDataFn |
|
|
999 |
* <dl> |
|
|
1000 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
1001 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
1002 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
1003 |
* <dl> |
|
|
1004 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
1005 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
1006 |
* </dl> |
|
|
1007 |
* </dd> |
|
|
1008 |
* <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
|
1009 |
* </dl> |
|
|
1010 |
* @protected |
|
|
1011 |
*/ |
|
|
1012 |
_beforeDefDataFn: function(e) { |
|
|
1013 |
var data = (Y.DataSource.IO && (this.get("host") instanceof Y.DataSource.IO) && Y.Lang.isString(e.data.responseText)) ? e.data.responseText : e.data, |
|
|
1014 |
response = Y.DataSchema.JSON.apply(this.get("schema"), data); |
|
|
1015 |
|
|
|
1016 |
// Default |
|
|
1017 |
if(!response) { |
|
|
1018 |
response = { |
|
|
1019 |
meta: {}, |
|
|
1020 |
results: data |
|
|
1021 |
}; |
|
|
1022 |
} |
|
|
1023 |
|
|
|
1024 |
this.get("host").fire("response", Y.mix({response:response}, e)); |
|
|
1025 |
return new Y.Do.Halt("DataSourceJSONSchema plugin halted _defDataFn"); |
|
|
1026 |
} |
|
|
1027 |
}); |
|
|
1028 |
|
|
|
1029 |
Y.namespace('Plugin').DataSourceJSONSchema = DataSourceJSONSchema; |
|
|
1030 |
|
|
|
1031 |
|
|
|
1032 |
|
|
|
1033 |
}, '3.0.0b1' ,{requires:['plugin', 'datasource-local', 'dataschema-json']}); |
|
|
1034 |
|
|
|
1035 |
YUI.add('datasource-xmlschema', function(Y) { |
|
|
1036 |
|
|
|
1037 |
/** |
|
|
1038 |
* Extends DataSource with schema-parsing on XML data. |
|
|
1039 |
* |
|
|
1040 |
* @module datasource |
|
|
1041 |
* @submodule datasource-xmlschema |
|
|
1042 |
*/ |
|
|
1043 |
|
|
|
1044 |
/** |
|
|
1045 |
* Adds schema-parsing to the DataSource Utility. |
|
|
1046 |
* @class DataSourceXMLSchema |
|
|
1047 |
* @extends Plugin.Base |
|
|
1048 |
*/ |
|
|
1049 |
var DataSourceXMLSchema = function() { |
|
|
1050 |
DataSourceXMLSchema.superclass.constructor.apply(this, arguments); |
|
|
1051 |
}; |
|
|
1052 |
|
|
|
1053 |
Y.mix(DataSourceXMLSchema, { |
|
|
1054 |
/** |
|
|
1055 |
* The namespace for the plugin. This will be the property on the host which |
|
|
1056 |
* references the plugin instance. |
|
|
1057 |
* |
|
|
1058 |
* @property NS |
|
|
1059 |
* @type String |
|
|
1060 |
* @static |
|
|
1061 |
* @final |
|
|
1062 |
* @value "schema" |
|
|
1063 |
*/ |
|
|
1064 |
NS: "schema", |
|
|
1065 |
|
|
|
1066 |
/** |
|
|
1067 |
* Class name. |
|
|
1068 |
* |
|
|
1069 |
* @property NAME |
|
|
1070 |
* @type String |
|
|
1071 |
* @static |
|
|
1072 |
* @final |
|
|
1073 |
* @value "dataSourceXMLSchema" |
|
|
1074 |
*/ |
|
|
1075 |
NAME: "dataSourceXMLSchema", |
|
|
1076 |
|
|
|
1077 |
///////////////////////////////////////////////////////////////////////////// |
|
|
1078 |
// |
|
|
1079 |
// DataSourceXMLSchema Attributes |
|
|
1080 |
// |
|
|
1081 |
///////////////////////////////////////////////////////////////////////////// |
|
|
1082 |
|
|
|
1083 |
ATTRS: { |
|
|
1084 |
schema: { |
|
|
1085 |
//value: {} |
|
|
1086 |
} |
|
|
1087 |
} |
|
|
1088 |
}); |
|
|
1089 |
|
|
|
1090 |
Y.extend(DataSourceXMLSchema, Y.Plugin.Base, { |
|
|
1091 |
/** |
|
|
1092 |
* Internal init() handler. |
|
|
1093 |
* |
|
|
1094 |
* @method initializer |
|
|
1095 |
* @param config {Object} Config object. |
|
|
1096 |
* @private |
|
|
1097 |
*/ |
|
|
1098 |
initializer: function(config) { |
|
|
1099 |
this.doBefore("_defDataFn", this._beforeDefDataFn); |
|
|
1100 |
}, |
|
|
1101 |
|
|
|
1102 |
/** |
|
|
1103 |
* Parses raw data into a normalized response. |
|
|
1104 |
* |
|
|
1105 |
* @method _beforeDefDataFn |
|
|
1106 |
* <dl> |
|
|
1107 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
1108 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
1109 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
1110 |
* <dl> |
|
|
1111 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
1112 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
1113 |
* </dl> |
|
|
1114 |
* </dd> |
|
|
1115 |
* <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
|
1116 |
* </dl> |
|
|
1117 |
* @protected |
|
|
1118 |
*/ |
|
|
1119 |
_beforeDefDataFn: function(e) { |
|
|
1120 |
var data = (Y.DataSource.IO && (this.get("host") instanceof Y.DataSource.IO) && e.data.responseXML && (e.data.responseXML.nodeType === 9)) ? e.data.responseXML : e.data, |
|
|
1121 |
response = Y.DataSchema.XML.apply(this.get("schema"), data); |
|
|
1122 |
|
|
|
1123 |
// Default |
|
|
1124 |
if(!response) { |
|
|
1125 |
response = { |
|
|
1126 |
meta: {}, |
|
|
1127 |
results: data |
|
|
1128 |
}; |
|
|
1129 |
} |
|
|
1130 |
|
|
|
1131 |
this.get("host").fire("response", Y.mix({response:response}, e)); |
|
|
1132 |
return new Y.Do.Halt("DataSourceXMLSchema plugin halted _defDataFn"); |
|
|
1133 |
} |
|
|
1134 |
}); |
|
|
1135 |
|
|
|
1136 |
Y.namespace('Plugin').DataSourceXMLSchema = DataSourceXMLSchema; |
|
|
1137 |
|
|
|
1138 |
|
|
|
1139 |
|
|
|
1140 |
}, '3.0.0b1' ,{requires:['plugin', 'datasource-local', 'dataschema-xml']}); |
|
|
1141 |
|
|
|
1142 |
YUI.add('datasource-arrayschema', function(Y) { |
|
|
1143 |
|
|
|
1144 |
/** |
|
|
1145 |
* Extends DataSource with schema-parsing on array data. |
|
|
1146 |
* |
|
|
1147 |
* @module datasource |
|
|
1148 |
* @submodule datasource-arrayschema |
|
|
1149 |
*/ |
|
|
1150 |
|
|
|
1151 |
/** |
|
|
1152 |
* Adds schema-parsing to the DataSource Utility. |
|
|
1153 |
* @class DataSourceArraySchema |
|
|
1154 |
* @extends Plugin.Base |
|
|
1155 |
*/ |
|
|
1156 |
var DataSourceArraySchema = function() { |
|
|
1157 |
DataSourceArraySchema.superclass.constructor.apply(this, arguments); |
|
|
1158 |
}; |
|
|
1159 |
|
|
|
1160 |
Y.mix(DataSourceArraySchema, { |
|
|
1161 |
/** |
|
|
1162 |
* The namespace for the plugin. This will be the property on the host which |
|
|
1163 |
* references the plugin instance. |
|
|
1164 |
* |
|
|
1165 |
* @property NS |
|
|
1166 |
* @type String |
|
|
1167 |
* @static |
|
|
1168 |
* @final |
|
|
1169 |
* @value "schema" |
|
|
1170 |
*/ |
|
|
1171 |
NS: "schema", |
|
|
1172 |
|
|
|
1173 |
/** |
|
|
1174 |
* Class name. |
|
|
1175 |
* |
|
|
1176 |
* @property NAME |
|
|
1177 |
* @type String |
|
|
1178 |
* @static |
|
|
1179 |
* @final |
|
|
1180 |
* @value "dataSourceArraySchema" |
|
|
1181 |
*/ |
|
|
1182 |
NAME: "dataSourceArraySchema", |
|
|
1183 |
|
|
|
1184 |
///////////////////////////////////////////////////////////////////////////// |
|
|
1185 |
// |
|
|
1186 |
// DataSourceArraySchema Attributes |
|
|
1187 |
// |
|
|
1188 |
///////////////////////////////////////////////////////////////////////////// |
|
|
1189 |
|
|
|
1190 |
ATTRS: { |
|
|
1191 |
schema: { |
|
|
1192 |
//value: {} |
|
|
1193 |
} |
|
|
1194 |
} |
|
|
1195 |
}); |
|
|
1196 |
|
|
|
1197 |
Y.extend(DataSourceArraySchema, Y.Plugin.Base, { |
|
|
1198 |
/** |
|
|
1199 |
* Internal init() handler. |
|
|
1200 |
* |
|
|
1201 |
* @method initializer |
|
|
1202 |
* @param config {Object} Config object. |
|
|
1203 |
* @private |
|
|
1204 |
*/ |
|
|
1205 |
initializer: function(config) { |
|
|
1206 |
this.doBefore("_defDataFn", this._beforeDefDataFn); |
|
|
1207 |
}, |
|
|
1208 |
|
|
|
1209 |
/** |
|
|
1210 |
* Parses raw data into a normalized response. |
|
|
1211 |
* |
|
|
1212 |
* @method _beforeDefDataFn |
|
|
1213 |
* <dl> |
|
|
1214 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
1215 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
1216 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
1217 |
* <dl> |
|
|
1218 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
1219 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
1220 |
* </dl> |
|
|
1221 |
* </dd> |
|
|
1222 |
* <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
|
1223 |
* </dl> |
|
|
1224 |
* @protected |
|
|
1225 |
*/ |
|
|
1226 |
_beforeDefDataFn: function(e) { |
|
|
1227 |
var data = (Y.DataSource.IO && (this.get("host") instanceof Y.DataSource.IO) && Y.Lang.isString(e.data.responseText)) ? e.data.responseText : e.data, |
|
|
1228 |
response = Y.DataSchema.Array.apply(this.get("schema"), data); |
|
|
1229 |
|
|
|
1230 |
// Default |
|
|
1231 |
if(!response) { |
|
|
1232 |
response = { |
|
|
1233 |
meta: {}, |
|
|
1234 |
results: data |
|
|
1235 |
}; |
|
|
1236 |
} |
|
|
1237 |
|
|
|
1238 |
this.get("host").fire("response", Y.mix({response:response}, e)); |
|
|
1239 |
return new Y.Do.Halt("DataSourceArraySchema plugin halted _defDataFn"); |
|
|
1240 |
} |
|
|
1241 |
}); |
|
|
1242 |
|
|
|
1243 |
Y.namespace('Plugin').DataSourceArraySchema = DataSourceArraySchema; |
|
|
1244 |
|
|
|
1245 |
|
|
|
1246 |
|
|
|
1247 |
}, '3.0.0b1' ,{requires:['plugin', 'datasource-local', 'dataschema-array']}); |
|
|
1248 |
|
|
|
1249 |
YUI.add('datasource-textschema', function(Y) { |
|
|
1250 |
|
|
|
1251 |
/** |
|
|
1252 |
* Extends DataSource with schema-parsing on text data. |
|
|
1253 |
* |
|
|
1254 |
* @module datasource |
|
|
1255 |
* @submodule datasource-textschema |
|
|
1256 |
*/ |
|
|
1257 |
|
|
|
1258 |
/** |
|
|
1259 |
* Adds schema-parsing to the DataSource Utility. |
|
|
1260 |
* @class DataSourceTextSchema |
|
|
1261 |
* @extends Plugin.Base |
|
|
1262 |
*/ |
|
|
1263 |
var DataSourceTextSchema = function() { |
|
|
1264 |
DataSourceTextSchema.superclass.constructor.apply(this, arguments); |
|
|
1265 |
}; |
|
|
1266 |
|
|
|
1267 |
Y.mix(DataSourceTextSchema, { |
|
|
1268 |
/** |
|
|
1269 |
* The namespace for the plugin. This will be the property on the host which |
|
|
1270 |
* references the plugin instance. |
|
|
1271 |
* |
|
|
1272 |
* @property NS |
|
|
1273 |
* @type String |
|
|
1274 |
* @static |
|
|
1275 |
* @final |
|
|
1276 |
* @value "schema" |
|
|
1277 |
*/ |
|
|
1278 |
NS: "schema", |
|
|
1279 |
|
|
|
1280 |
/** |
|
|
1281 |
* Class name. |
|
|
1282 |
* |
|
|
1283 |
* @property NAME |
|
|
1284 |
* @type String |
|
|
1285 |
* @static |
|
|
1286 |
* @final |
|
|
1287 |
* @value "dataSourceTextSchema" |
|
|
1288 |
*/ |
|
|
1289 |
NAME: "dataSourceTextSchema", |
|
|
1290 |
|
|
|
1291 |
///////////////////////////////////////////////////////////////////////////// |
|
|
1292 |
// |
|
|
1293 |
// DataSourceTextSchema Attributes |
|
|
1294 |
// |
|
|
1295 |
///////////////////////////////////////////////////////////////////////////// |
|
|
1296 |
|
|
|
1297 |
ATTRS: { |
|
|
1298 |
schema: { |
|
|
1299 |
//value: {} |
|
|
1300 |
} |
|
|
1301 |
} |
|
|
1302 |
}); |
|
|
1303 |
|
|
|
1304 |
Y.extend(DataSourceTextSchema, Y.Plugin.Base, { |
|
|
1305 |
/** |
|
|
1306 |
* Internal init() handler. |
|
|
1307 |
* |
|
|
1308 |
* @method initializer |
|
|
1309 |
* @param config {Object} Config object. |
|
|
1310 |
* @private |
|
|
1311 |
*/ |
|
|
1312 |
initializer: function(config) { |
|
|
1313 |
this.doBefore("_defDataFn", this._beforeDefDataFn); |
|
|
1314 |
}, |
|
|
1315 |
|
|
|
1316 |
/** |
|
|
1317 |
* Parses raw data into a normalized response. |
|
|
1318 |
* |
|
|
1319 |
* @method _beforeDefDataFn |
|
|
1320 |
* <dl> |
|
|
1321 |
* <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd> |
|
|
1322 |
* <dt>request (Object)</dt> <dd>The request.</dd> |
|
|
1323 |
* <dt>callback (Object)</dt> <dd>The callback object with the following properties: |
|
|
1324 |
* <dl> |
|
|
1325 |
* <dt>success (Function)</dt> <dd>Success handler.</dd> |
|
|
1326 |
* <dt>failure (Function)</dt> <dd>Failure handler.</dd> |
|
|
1327 |
* </dl> |
|
|
1328 |
* </dd> |
|
|
1329 |
* <dt>data (Object)</dt> <dd>Raw data.</dd> |
|
|
1330 |
* </dl> |
|
|
1331 |
* @protected |
|
|
1332 |
*/ |
|
|
1333 |
_beforeDefDataFn: function(e) { |
|
|
1334 |
var data = (Y.DataSource.IO && (this.get("host") instanceof Y.DataSource.IO) && Y.Lang.isString(e.data.responseText)) ? e.data.responseText : e.data, |
|
|
1335 |
response = Y.DataSchema.Text.apply(this.get("schema"), data); |
|
|
1336 |
|
|
|
1337 |
// Default |
|
|
1338 |
if(!response) { |
|
|
1339 |
response = { |
|
|
1340 |
meta: {}, |
|
|
1341 |
results: data |
|
|
1342 |
}; |
|
|
1343 |
} |
|
|
1344 |
|
|
|
1345 |
this.get("host").fire("response", Y.mix({response:response}, e)); |
|
|
1346 |
return new Y.Do.Halt("DataSourceTextSchema plugin halted _defDataFn"); |
|
|
1347 |
} |
|
|
1348 |
}); |
|
|
1349 |
|
|
|
1350 |
Y.namespace('Plugin').DataSourceTextSchema = DataSourceTextSchema; |
|
|
1351 |
|
|
|
1352 |
|
|
|
1353 |
|
|
|
1354 |
}, '3.0.0b1' ,{requires:['plugin', 'datasource-local', 'dataschema-text']}); |
|
|
1355 |
|
|
|
1356 |
YUI.add('datasource-polling', function(Y) { |
|
|
1357 |
|
|
|
1358 |
/** |
|
|
1359 |
* Extends DataSource with polling functionality. |
|
|
1360 |
* |
|
|
1361 |
* @module datasource |
|
|
1362 |
* @submodule datasource-polling |
|
|
1363 |
*/ |
|
|
1364 |
|
|
|
1365 |
/** |
|
|
1366 |
* Adds polling to the DataSource Utility. |
|
|
1367 |
* @class Pollable |
|
|
1368 |
* @extends DataSource.Local |
|
|
1369 |
*/ |
|
|
1370 |
var LANG = Y.Lang, |
|
|
1371 |
|
|
|
1372 |
Pollable = function() { |
|
|
1373 |
this._intervals = {}; |
|
|
1374 |
}; |
|
|
1375 |
|
|
|
1376 |
Pollable.prototype = { |
|
|
1377 |
|
|
|
1378 |
/** |
|
|
1379 |
* @property _intervals |
|
|
1380 |
* @description Hash of polling interval IDs that have been enabled, |
|
|
1381 |
* stored here to be able to clear all intervals. |
|
|
1382 |
* @private |
|
|
1383 |
*/ |
|
|
1384 |
_intervals: null, |
|
|
1385 |
|
|
|
1386 |
/** |
|
|
1387 |
* Sets up a polling mechanism to send requests at set intervals and forward |
|
|
1388 |
* responses to given callback. |
|
|
1389 |
* |
|
|
1390 |
* @method setInterval |
|
|
1391 |
* @param msec {Number} Length of interval in milliseconds. |
|
|
1392 |
* @param request {Object} Request object. |
|
|
1393 |
* @param callback {Object} An object literal with the following properties: |
|
|
1394 |
* <dl> |
|
|
1395 |
* <dt><code>success</code></dt> |
|
|
1396 |
* <dd>The function to call when the data is ready.</dd> |
|
|
1397 |
* <dt><code>failure</code></dt> |
|
|
1398 |
* <dd>The function to call upon a response failure condition.</dd> |
|
|
1399 |
* <dt><code>argument</code></dt> |
|
|
1400 |
* <dd>Arbitrary data that will be passed back to the success and failure handlers.</dd> |
|
|
1401 |
* </dl> |
|
|
1402 |
* @return {Number} Interval ID. |
|
|
1403 |
*/ |
|
|
1404 |
setInterval: function(msec, request, callback) { |
|
|
1405 |
var x = Y.later(msec, this, this.sendRequest, [request, callback], true); |
|
|
1406 |
this._intervals[x.id] = x; |
|
|
1407 |
return x.id; |
|
|
1408 |
}, |
|
|
1409 |
|
|
|
1410 |
/** |
|
|
1411 |
* Disables polling mechanism associated with the given interval ID. |
|
|
1412 |
* |
|
|
1413 |
* @method clearInterval |
|
|
1414 |
* @param id {Number} Interval ID. |
|
|
1415 |
*/ |
|
|
1416 |
clearInterval: function(id, key) { |
|
|
1417 |
// In case of being called by clearAllIntervals() |
|
|
1418 |
id = key || id; |
|
|
1419 |
if(this._intervals[id]) { |
|
|
1420 |
// Clear the interval |
|
|
1421 |
this._intervals[id].cancel(); |
|
|
1422 |
// Clear from tracker |
|
|
1423 |
delete this._intervals[id]; |
|
|
1424 |
} |
|
|
1425 |
}, |
|
|
1426 |
|
|
|
1427 |
/** |
|
|
1428 |
* Clears all intervals. |
|
|
1429 |
* |
|
|
1430 |
* @method clearAllIntervals |
|
|
1431 |
*/ |
|
|
1432 |
clearAllIntervals: function() { |
|
|
1433 |
Y.each(this._intervals, this.clearInterval, this); |
|
|
1434 |
} |
|
|
1435 |
}; |
|
|
1436 |
|
|
|
1437 |
Y.augment(Y.DataSource.Local, Pollable); |
|
|
1438 |
|
|
|
1439 |
|
|
|
1440 |
|
|
|
1441 |
}, '3.0.0b1' ,{requires:['datasource-local']}); |
|
|
1442 |
|
|
|
1443 |
|
|
|
1444 |
|
|
|
1445 |
YUI.add('datasource', function(Y){}, '3.0.0b1' ,{use:['datasource-local','datasource-io','datasource-get','datasource-function','datasource-cache','datasource-jsonschema','datasource-xmlschema','datasource-arrayschema','datasource-textschema','datasource-polling']}); |
|
|
1446 |
|