src/cm/media/js/lib/yui/yui3-3.15.0/build/datasource-io/datasource-io.js
author gibus
Mon, 10 Mar 2014 15:19:48 +0100
changeset 602 e16a97fb364a
permissions -rw-r--r--
Use YUI 3.15
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
602
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     1
YUI.add('datasource-io', function (Y, NAME) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     2
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     3
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     4
 * Provides a DataSource implementation which can be used to retrieve data via the IO Utility.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
 * @module datasource
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
 * @submodule datasource-io
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    11
 * IO subclass for the DataSource Utility.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    12
 * @class DataSource.IO
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    13
 * @extends DataSource.Local
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
var DSIO = function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
    DSIO.superclass.constructor.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
    /////////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
    //
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
    // DataSource.IO static properties
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
    //
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
    /////////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
Y.mix(DSIO, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
     * Class name.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
     * @property NAME
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
     * @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
     * @final
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
     * @value "dataSourceIO"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
    NAME: "dataSourceIO",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
    /////////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
    //
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
    // DataSource.IO Attributes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
    //
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
    /////////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
    ATTRS: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
         * Pointer to IO Utility.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
         * @attribute io
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
         * @type Y.io
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
         * @default Y.io
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    52
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    53
        io: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    54
            value: Y.io,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
            cloneDefaultValue: false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
        },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
         * Default IO Config.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
         * @attribute ioConfig
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
         * @type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
         * @default null
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
         ioConfig: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
            value: null
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
         }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
Y.extend(DSIO, Y.DataSource.Local, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
    * Internal init() handler.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
    *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
    * @method initializer
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
    * @param config {Object} Config object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
    initializer: function(config) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
        this._queue = {interval:null, conn:null, requests:[]};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
    * IO success callback.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    85
    *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    86
    * @method successHandler
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    87
    * @param id {String} Transaction ID.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    88
    * @param response {String} Response.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    89
    * @param e {EventFacade} Event facade.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    90
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    91
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    92
    successHandler: function (id, response, e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    93
        var defIOConfig = this.get("ioConfig"),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    94
            payload = e.details[0];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    95
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    96
        delete Y.DataSource.Local.transactions[e.tId];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    97
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    98
        payload.data = response;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    99
        this.fire("data", payload);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   100
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   101
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   102
        if (defIOConfig && defIOConfig.on && defIOConfig.on.success) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   103
            defIOConfig.on.success.apply(defIOConfig.context || Y, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   104
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   105
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   106
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   107
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   108
    * IO failure callback.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   109
    *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   110
    * @method failureHandler
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   111
    * @param id {String} Transaction ID.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   112
    * @param response {String} Response.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   113
    * @param e {EventFacade} Event facade.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   114
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   115
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   116
    failureHandler: function (id, response, e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   117
        var defIOConfig = this.get("ioConfig"),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   118
            payload = e.details[0];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   119
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   120
        delete Y.DataSource.Local.transactions[e.tId];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   121
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   122
        payload.error = new Error("IO data failure");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   123
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   124
        payload.data = response;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   125
        this.fire("data", payload);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   126
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   127
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   128
        if (defIOConfig && defIOConfig.on && defIOConfig.on.failure) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   129
            defIOConfig.on.failure.apply(defIOConfig.context || Y, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   130
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   131
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   132
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   133
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   134
    * @property _queue
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   135
    * @description Object literal to manage asynchronous request/response
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   136
    * cycles enabled if queue needs to be managed (asyncMode/ioConnMode):
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   137
    * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   138
    *     <dt>interval {Number}</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   139
    *         <dd>Interval ID of in-progress queue.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   140
    *     <dt>conn</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   141
    *         <dd>In-progress connection identifier (if applicable).</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   142
    *     <dt>requests {Object[]}</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   143
    *         <dd>Array of queued request objects: {request:request, callback:callback}.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   144
    * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   145
    * @type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   146
    * @default {interval:null, conn:null, requests:[]}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   147
    * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   148
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   149
    _queue: null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   150
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   151
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   152
     * Passes query string to IO. Fires <code>response</code> event when
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   153
     * response is received asynchronously.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   154
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   155
     * @method _defRequestFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   156
     * @param e {EventFacade} Event Facade with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   157
     * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   158
     * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   159
     * <dt>request (Object)</dt> <dd>The request.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   160
     * <dt>callback (Object)</dt> <dd>The callback object with the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   161
     *     <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   162
     *         <dt>success (Function)</dt> <dd>Success handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   163
     *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   164
     *     </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   165
     * </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   166
     * <dt>cfg (Object)</dt> <dd>Configuration object.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   167
     * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   168
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   169
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   170
    _defRequestFn: function(e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   171
        var uri = this.get("source"),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   172
            io = this.get("io"),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   173
            defIOConfig = this.get("ioConfig"),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   174
            request = e.request,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   175
            cfg = Y.merge(defIOConfig, e.cfg, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   176
                on: Y.merge(defIOConfig, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   177
                    success: this.successHandler,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   178
                    failure: this.failureHandler
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   179
                }),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   180
                context: this,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   181
                "arguments": e
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   182
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   183
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   184
        // Support for POST transactions
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   185
        if(Y.Lang.isString(request)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   186
            if(cfg.method && (cfg.method.toUpperCase() === "POST")) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   187
                cfg.data = cfg.data ? cfg.data+request : request;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   188
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   189
            else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   190
                uri += request;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   191
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   192
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   193
        Y.DataSource.Local.transactions[e.tId] = io(uri, cfg);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   194
        return e.tId;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   195
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   196
});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   197
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   198
Y.DataSource.IO = DSIO;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   199
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   200
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   201
}, '@VERSION@', {"requires": ["datasource-local", "io-base"]});