X-Git-Url: https://git.toastfreeware.priv.at/philipp/winterrodeln/wradmin.git/blobdiff_plain/47e86061cfc74f70ea67b8e41df9ca7b2d06b203..7170338241015cb2aee98f126ebf088e92284987:/wradmin/static/yui/datasource/datasource.js diff --git a/wradmin/static/yui/datasource/datasource.js b/wradmin/static/yui/datasource/datasource.js deleted file mode 100644 index af8e79b..0000000 --- a/wradmin/static/yui/datasource/datasource.js +++ /dev/null @@ -1,2946 +0,0 @@ -/* -Copyright (c) 2009, Yahoo! Inc. All rights reserved. -Code licensed under the BSD License: -http://developer.yahoo.net/yui/license.txt -version: 2.7.0 -*/ -(function () { - -var lang = YAHOO.lang, - util = YAHOO.util, - Ev = util.Event; - -/** - * The DataSource utility provides a common configurable interface for widgets to - * access a variety of data, from JavaScript arrays to online database servers. - * - * @module datasource - * @requires yahoo, event - * @optional json, get, connection - * @title DataSource Utility - */ - -/****************************************************************************/ -/****************************************************************************/ -/****************************************************************************/ - -/** - * Base class for the YUI DataSource utility. - * - * @namespace YAHOO.util - * @class YAHOO.util.DataSourceBase - * @constructor - * @param oLiveData {HTMLElement} Pointer to live data. - * @param oConfigs {object} (optional) Object literal of configuration values. - */ -util.DataSourceBase = function(oLiveData, oConfigs) { - if(oLiveData === null || oLiveData === undefined) { - return; - } - - this.liveData = oLiveData; - this._oQueue = {interval:null, conn:null, requests:[]}; - this.responseSchema = {}; - - // Set any config params passed in to override defaults - if(oConfigs && (oConfigs.constructor == Object)) { - for(var sConfig in oConfigs) { - if(sConfig) { - this[sConfig] = oConfigs[sConfig]; - } - } - } - - // Validate and initialize public configs - var maxCacheEntries = this.maxCacheEntries; - if(!lang.isNumber(maxCacheEntries) || (maxCacheEntries < 0)) { - maxCacheEntries = 0; - } - - // Initialize interval tracker - this._aIntervals = []; - - ///////////////////////////////////////////////////////////////////////////// - // - // Custom Events - // - ///////////////////////////////////////////////////////////////////////////// - - /** - * Fired when a request is made to the local cache. - * - * @event cacheRequestEvent - * @param oArgs.request {Object} The request object. - * @param oArgs.callback {Object} The callback object. - * @param oArgs.caller {Object} (deprecated) Use callback.scope. - */ - this.createEvent("cacheRequestEvent"); - - /** - * Fired when data is retrieved from the local cache. - * - * @event cacheResponseEvent - * @param oArgs.request {Object} The request object. - * @param oArgs.response {Object} The response object. - * @param oArgs.callback {Object} The callback object. - * @param oArgs.caller {Object} (deprecated) Use callback.scope. - */ - this.createEvent("cacheResponseEvent"); - - /** - * Fired when a request is sent to the live data source. - * - * @event requestEvent - * @param oArgs.request {Object} The request object. - * @param oArgs.callback {Object} The callback object. - * @param oArgs.tId {Number} Transaction ID. - * @param oArgs.caller {Object} (deprecated) Use callback.scope. - */ - this.createEvent("requestEvent"); - - /** - * Fired when live data source sends response. - * - * @event responseEvent - * @param oArgs.request {Object} The request object. - * @param oArgs.response {Object} The raw response object. - * @param oArgs.callback {Object} The callback object. - * @param oArgs.tId {Number} Transaction ID. - * @param oArgs.caller {Object} (deprecated) Use callback.scope. - */ - this.createEvent("responseEvent"); - - /** - * Fired when response is parsed. - * - * @event responseParseEvent - * @param oArgs.request {Object} The request object. - * @param oArgs.response {Object} The parsed response object. - * @param oArgs.callback {Object} The callback object. - * @param oArgs.caller {Object} (deprecated) Use callback.scope. - */ - this.createEvent("responseParseEvent"); - - /** - * Fired when response is cached. - * - * @event responseCacheEvent - * @param oArgs.request {Object} The request object. - * @param oArgs.response {Object} The parsed response object. - * @param oArgs.callback {Object} The callback object. - * @param oArgs.caller {Object} (deprecated) Use callback.scope. - */ - this.createEvent("responseCacheEvent"); - /** - * Fired when an error is encountered with the live data source. - * - * @event dataErrorEvent - * @param oArgs.request {Object} The request object. - * @param oArgs.callback {Object} The callback object. - * @param oArgs.caller {Object} (deprecated) Use callback.scope. - * @param oArgs.message {String} The error message. - */ - this.createEvent("dataErrorEvent"); - - /** - * Fired when the local cache is flushed. - * - * @event cacheFlushEvent - */ - this.createEvent("cacheFlushEvent"); - - var DS = util.DataSourceBase; - this._sName = "DataSource instance" + DS._nIndex; - DS._nIndex++; -}; - -var DS = util.DataSourceBase; - -lang.augmentObject(DS, { - -///////////////////////////////////////////////////////////////////////////// -// -// DataSourceBase public constants -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Type is unknown. - * - * @property TYPE_UNKNOWN - * @type Number - * @final - * @default -1 - */ -TYPE_UNKNOWN : -1, - -/** - * Type is a JavaScript Array. - * - * @property TYPE_JSARRAY - * @type Number - * @final - * @default 0 - */ -TYPE_JSARRAY : 0, - -/** - * Type is a JavaScript Function. - * - * @property TYPE_JSFUNCTION - * @type Number - * @final - * @default 1 - */ -TYPE_JSFUNCTION : 1, - -/** - * Type is hosted on a server via an XHR connection. - * - * @property TYPE_XHR - * @type Number - * @final - * @default 2 - */ -TYPE_XHR : 2, - -/** - * Type is JSON. - * - * @property TYPE_JSON - * @type Number - * @final - * @default 3 - */ -TYPE_JSON : 3, - -/** - * Type is XML. - * - * @property TYPE_XML - * @type Number - * @final - * @default 4 - */ -TYPE_XML : 4, - -/** - * Type is plain text. - * - * @property TYPE_TEXT - * @type Number - * @final - * @default 5 - */ -TYPE_TEXT : 5, - -/** - * Type is an HTML TABLE element. Data is parsed out of TR elements from all TBODY elements. - * - * @property TYPE_HTMLTABLE - * @type Number - * @final - * @default 6 - */ -TYPE_HTMLTABLE : 6, - -/** - * Type is hosted on a server via a dynamic script node. - * - * @property TYPE_SCRIPTNODE - * @type Number - * @final - * @default 7 - */ -TYPE_SCRIPTNODE : 7, - -/** - * Type is local. - * - * @property TYPE_LOCAL - * @type Number - * @final - * @default 8 - */ -TYPE_LOCAL : 8, - -/** - * Error message for invalid dataresponses. - * - * @property ERROR_DATAINVALID - * @type String - * @final - * @default "Invalid data" - */ -ERROR_DATAINVALID : "Invalid data", - -/** - * Error message for null data responses. - * - * @property ERROR_DATANULL - * @type String - * @final - * @default "Null data" - */ -ERROR_DATANULL : "Null data", - -///////////////////////////////////////////////////////////////////////////// -// -// DataSourceBase private static properties -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Internal class variable to index multiple DataSource instances. - * - * @property DataSourceBase._nIndex - * @type Number - * @private - * @static - */ -_nIndex : 0, - -/** - * Internal class variable to assign unique transaction IDs. - * - * @property DataSourceBase._nTransactionId - * @type Number - * @private - * @static - */ -_nTransactionId : 0, - -///////////////////////////////////////////////////////////////////////////// -// -// DataSourceBase public static methods -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Executes a configured callback. For object literal callbacks, the third - * param determines whether to execute the success handler or failure handler. - * - * @method issueCallback - * @param callback {Function|Object} the callback to execute - * @param params {Array} params to be passed to the callback method - * @param error {Boolean} whether an error occurred - * @param scope {Object} the scope from which to execute the callback - * (deprecated - use an object literal callback) - * @static - */ -issueCallback : function (callback,params,error,scope) { - if (lang.isFunction(callback)) { - callback.apply(scope, params); - } else if (lang.isObject(callback)) { - scope = callback.scope || scope || window; - var callbackFunc = callback.success; - if (error) { - callbackFunc = callback.failure; - } - if (callbackFunc) { - callbackFunc.apply(scope, params.concat([callback.argument])); - } - } -}, - -/** - * Converts data to type String. - * - * @method DataSourceBase.parseString - * @param oData {String | Number | Boolean | Date | Array | Object} Data to parse. - * The special values null and undefined will return null. - * @return {String} A string, or null. - * @static - */ -parseString : function(oData) { - // Special case null and undefined - if(!lang.isValue(oData)) { - return null; - } - - //Convert to string - var string = oData + ""; - - // Validate - if(lang.isString(string)) { - return string; - } - else { - return null; - } -}, - -/** - * Converts data to type Number. - * - * @method DataSourceBase.parseNumber - * @param oData {String | Number | Boolean} Data to convert. Note, the following - * values return as null: null, undefined, NaN, "". - * @return {Number} A number, or null. - * @static - */ -parseNumber : function(oData) { - if(!lang.isValue(oData) || (oData === "")) { - return null; - } - - //Convert to number - var number = oData * 1; - - // Validate - if(lang.isNumber(number)) { - return number; - } - else { - return null; - } -}, -// Backward compatibility -convertNumber : function(oData) { - return DS.parseNumber(oData); -}, - -/** - * Converts data to type Date. - * - * @method DataSourceBase.parseDate - * @param oData {Date | String | Number} Data to convert. - * @return {Date} A Date instance. - * @static - */ -parseDate : function(oData) { - var date = null; - - //Convert to date - if(!(oData instanceof Date)) { - date = new Date(oData); - } - else { - return oData; - } - - // Validate - if(date instanceof Date) { - return date; - } - else { - return null; - } -}, -// Backward compatibility -convertDate : function(oData) { - return DS.parseDate(oData); -} - -}); - -// Done in separate step so referenced functions are defined. -/** - * Data parsing functions. - * @property DataSource.Parser - * @type Object - * @static - */ -DS.Parser = { - string : DS.parseString, - number : DS.parseNumber, - date : DS.parseDate -}; - -// Prototype properties and methods -DS.prototype = { - -///////////////////////////////////////////////////////////////////////////// -// -// DataSourceBase private properties -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Name of DataSource instance. - * - * @property _sName - * @type String - * @private - */ -_sName : null, - -/** - * Local cache of data result object literals indexed chronologically. - * - * @property _aCache - * @type Object[] - * @private - */ -_aCache : null, - -/** - * Local queue of request connections, enabled if queue needs to be managed. - * - * @property _oQueue - * @type Object - * @private - */ -_oQueue : null, - -/** - * Array of polling interval IDs that have been enabled, needed to clear all intervals. - * - * @property _aIntervals - * @type Array - * @private - */ -_aIntervals : null, - -///////////////////////////////////////////////////////////////////////////// -// -// DataSourceBase public properties -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Max size of the local cache. Set to 0 to turn off caching. Caching is - * useful to reduce the number of server connections. Recommended only for data - * sources that return comprehensive results for queries or when stale data is - * not an issue. - * - * @property maxCacheEntries - * @type Number - * @default 0 - */ -maxCacheEntries : 0, - - /** - * Pointer to live database. - * - * @property liveData - * @type Object - */ -liveData : null, - -/** - * Where the live data is held: - * - *
- *
TYPE_UNKNOWN
- *
TYPE_LOCAL
- *
TYPE_XHR
- *
TYPE_SCRIPTNODE
- *
TYPE_JSFUNCTION
- *
- * - * @property dataType - * @type Number - * @default YAHOO.util.DataSourceBase.TYPE_UNKNOWN - * - */ -dataType : DS.TYPE_UNKNOWN, - -/** - * Format of response: - * - *
- *
TYPE_UNKNOWN
- *
TYPE_JSARRAY
- *
TYPE_JSON
- *
TYPE_XML
- *
TYPE_TEXT
- *
TYPE_HTMLTABLE
- *
- * - * @property responseType - * @type Number - * @default YAHOO.util.DataSourceBase.TYPE_UNKNOWN - */ -responseType : DS.TYPE_UNKNOWN, - -/** - * Response schema object literal takes a combination of the following properties: - * - *
- *
resultsList
Pointer to array of tabular data
- *
resultNode
Pointer to node name of row data (XML data only)
- *
recordDelim
Record delimiter (text data only)
- *
fieldDelim
Field delimiter (text data only)
- *
fields
Array of field names (aka keys), or array of object literals - * such as: {key:"fieldname",parser:YAHOO.util.DataSourceBase.parseDate}
- *
metaFields
Object literal of keys to include in the oParsedResponse.meta collection
- *
metaNode
Name of the node under which to search for meta information in XML response data
- *
- * - * @property responseSchema - * @type Object - */ -responseSchema : null, - -/** - * Additional arguments passed to the JSON parse routine. The JSON string - * is the assumed first argument (where applicable). This property is not - * set by default, but the parse methods will use it if present. - * - * @property parseJSONArgs - * @type {MIXED|Array} If an Array, contents are used as individual arguments. - * Otherwise, value is used as an additional argument. - */ -// property intentionally undefined - -///////////////////////////////////////////////////////////////////////////// -// -// DataSourceBase public methods -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Public accessor to the unique name of the DataSource instance. - * - * @method toString - * @return {String} Unique name of the DataSource instance. - */ -toString : function() { - return this._sName; -}, - -/** - * Overridable method passes request to cache and returns cached response if any, - * refreshing the hit in the cache as the newest item. Returns null if there is - * no cache hit. - * - * @method getCachedResponse - * @param oRequest {Object} Request object. - * @param oCallback {Object} Callback object. - * @param oCaller {Object} (deprecated) Use callback object. - * @return {Object} Cached response object or null. - */ -getCachedResponse : function(oRequest, oCallback, oCaller) { - var aCache = this._aCache; - - // If cache is enabled... - if(this.maxCacheEntries > 0) { - // Initialize local cache - if(!aCache) { - this._aCache = []; - } - // Look in local cache - else { - var nCacheLength = aCache.length; - if(nCacheLength > 0) { - var oResponse = null; - this.fireEvent("cacheRequestEvent", {request:oRequest,callback:oCallback,caller:oCaller}); - - // Loop through each cached element - for(var i = nCacheLength-1; i >= 0; i--) { - var oCacheElem = aCache[i]; - - // Defer cache hit logic to a public overridable method - if(this.isCacheHit(oRequest,oCacheElem.request)) { - // The cache returned a hit! - // Grab the cached response - oResponse = oCacheElem.response; - this.fireEvent("cacheResponseEvent", {request:oRequest,response:oResponse,callback:oCallback,caller:oCaller}); - - // Refresh the position of the cache hit - if(i < nCacheLength-1) { - // Remove element from its original location - aCache.splice(i,1); - // Add as newest - this.addToCache(oRequest, oResponse); - } - - // Add a cache flag - oResponse.cached = true; - break; - } - } - return oResponse; - } - } - } - else if(aCache) { - this._aCache = null; - } - return null; -}, - -/** - * Default overridable method matches given request to given cached request. - * Returns true if is a hit, returns false otherwise. Implementers should - * override this method to customize the cache-matching algorithm. - * - * @method isCacheHit - * @param oRequest {Object} Request object. - * @param oCachedRequest {Object} Cached request object. - * @return {Boolean} True if given request matches cached request, false otherwise. - */ -isCacheHit : function(oRequest, oCachedRequest) { - return (oRequest === oCachedRequest); -}, - -/** - * Adds a new item to the cache. If cache is full, evicts the stalest item - * before adding the new item. - * - * @method addToCache - * @param oRequest {Object} Request object. - * @param oResponse {Object} Response object to cache. - */ -addToCache : function(oRequest, oResponse) { - var aCache = this._aCache; - if(!aCache) { - return; - } - - // If the cache is full, make room by removing stalest element (index=0) - while(aCache.length >= this.maxCacheEntries) { - aCache.shift(); - } - - // Add to cache in the newest position, at the end of the array - var oCacheElem = {request:oRequest,response:oResponse}; - aCache[aCache.length] = oCacheElem; - this.fireEvent("responseCacheEvent", {request:oRequest,response:oResponse}); -}, - -/** - * Flushes cache. - * - * @method flushCache - */ -flushCache : function() { - if(this._aCache) { - this._aCache = []; - this.fireEvent("cacheFlushEvent"); - } -}, - -/** - * Sets up a polling mechanism to send requests at set intervals and forward - * responses to given callback. - * - * @method setInterval - * @param nMsec {Number} Length of interval in milliseconds. - * @param oRequest {Object} Request object. - * @param oCallback {Function} Handler function to receive the response. - * @param oCaller {Object} (deprecated) Use oCallback.scope. - * @return {Number} Interval ID. - */ -setInterval : function(nMsec, oRequest, oCallback, oCaller) { - if(lang.isNumber(nMsec) && (nMsec >= 0)) { - var oSelf = this; - var nId = setInterval(function() { - oSelf.makeConnection(oRequest, oCallback, oCaller); - }, nMsec); - this._aIntervals.push(nId); - return nId; - } - else { - } -}, - -/** - * Disables polling mechanism associated with the given interval ID. - * - * @method clearInterval - * @param nId {Number} Interval ID. - */ -clearInterval : function(nId) { - // Remove from tracker if there - var tracker = this._aIntervals || []; - for(var i=tracker.length-1; i>-1; i--) { - if(tracker[i] === nId) { - tracker.splice(i,1); - clearInterval(nId); - } - } -}, - -/** - * Disables all known polling intervals. - * - * @method clearAllIntervals - */ -clearAllIntervals : function() { - var tracker = this._aIntervals || []; - for(var i=tracker.length-1; i>-1; i--) { - clearInterval(tracker[i]); - } - tracker = []; -}, - -/** - * First looks for cached response, then sends request to live data. The - * following arguments are passed to the callback function: - *
- *
oRequest
- *
The same value that was passed in as the first argument to sendRequest.
- *
oParsedResponse
- *
An object literal containing the following properties: - *
- *
tId
- *
Unique transaction ID number.
- *
results
- *
Schema-parsed data results.
- *
error
- *
True in cases of data error.
- *
cached
- *
True when response is returned from DataSource cache.
- *
meta
- *
Schema-parsed meta data.
- *
- *
oPayload
- *
The same value as was passed in as argument in the oCallback object literal.
- *
- * - * @method sendRequest - * @param oRequest {Object} Request object. - * @param oCallback {Object} An object literal with the following properties: - *
- *
success
- *
The function to call when the data is ready.
- *
failure
- *
The function to call upon a response failure condition.
- *
scope
- *
The object to serve as the scope for the success and failure handlers.
- *
argument
- *
Arbitrary data that will be passed back to the success and failure handlers.
- *
- * @param oCaller {Object} (deprecated) Use oCallback.scope. - * @return {Number} Transaction ID, or null if response found in cache. - */ -sendRequest : function(oRequest, oCallback, oCaller) { - // First look in cache - var oCachedResponse = this.getCachedResponse(oRequest, oCallback, oCaller); - if(oCachedResponse) { - DS.issueCallback(oCallback,[oRequest,oCachedResponse],false,oCaller); - return null; - } - - - // Not in cache, so forward request to live data - return this.makeConnection(oRequest, oCallback, oCaller); -}, - -/** - * Overridable default method generates a unique transaction ID and passes - * the live data reference directly to the handleResponse function. This - * method should be implemented by subclasses to achieve more complex behavior - * or to access remote data. - * - * @method makeConnection - * @param oRequest {Object} Request object. - * @param oCallback {Object} Callback object literal. - * @param oCaller {Object} (deprecated) Use oCallback.scope. - * @return {Number} Transaction ID. - */ -makeConnection : function(oRequest, oCallback, oCaller) { - var tId = DS._nTransactionId++; - this.fireEvent("requestEvent", {tId:tId, request:oRequest,callback:oCallback,caller:oCaller}); - - /* accounts for the following cases: - YAHOO.util.DataSourceBase.TYPE_UNKNOWN - YAHOO.util.DataSourceBase.TYPE_JSARRAY - YAHOO.util.DataSourceBase.TYPE_JSON - YAHOO.util.DataSourceBase.TYPE_HTMLTABLE - YAHOO.util.DataSourceBase.TYPE_XML - YAHOO.util.DataSourceBase.TYPE_TEXT - */ - var oRawResponse = this.liveData; - - this.handleResponse(oRequest, oRawResponse, oCallback, oCaller, tId); - return tId; -}, - -/** - * Receives raw data response and type converts to XML, JSON, etc as necessary. - * Forwards oFullResponse to appropriate parsing function to get turned into - * oParsedResponse. Calls doBeforeCallback() and adds oParsedResponse to - * the cache when appropriate before calling issueCallback(). - * - * The oParsedResponse object literal has the following properties: - *
- *
tId {Number}
Unique transaction ID - *
results {Array}
Array of parsed data results - *
meta {Object}
Object literal of meta values - *
error {Boolean}
(optional) True if there was an error - *
cached {Boolean}
(optional) True if response was cached - *
- * - * @method handleResponse - * @param oRequest {Object} Request object - * @param oRawResponse {Object} The raw response from the live database. - * @param oCallback {Object} Callback object literal. - * @param oCaller {Object} (deprecated) Use oCallback.scope. - * @param tId {Number} Transaction ID. - */ -handleResponse : function(oRequest, oRawResponse, oCallback, oCaller, tId) { - this.fireEvent("responseEvent", {tId:tId, request:oRequest, response:oRawResponse, - callback:oCallback, caller:oCaller}); - var xhr = (this.dataType == DS.TYPE_XHR) ? true : false; - var oParsedResponse = null; - var oFullResponse = oRawResponse; - - // Try to sniff data type if it has not been defined - if(this.responseType === DS.TYPE_UNKNOWN) { - var ctype = (oRawResponse && oRawResponse.getResponseHeader) ? oRawResponse.getResponseHeader["Content-Type"] : null; - if(ctype) { - // xml - if(ctype.indexOf("text/xml") > -1) { - this.responseType = DS.TYPE_XML; - } - else if(ctype.indexOf("application/json") > -1) { // json - this.responseType = DS.TYPE_JSON; - } - else if(ctype.indexOf("text/plain") > -1) { // text - this.responseType = DS.TYPE_TEXT; - } - } - else { - if(YAHOO.lang.isArray(oRawResponse)) { // array - this.responseType = DS.TYPE_JSARRAY; - } - // xml - else if(oRawResponse && oRawResponse.nodeType && oRawResponse.nodeType == 9) { - this.responseType = DS.TYPE_XML; - } - else if(oRawResponse && oRawResponse.nodeName && (oRawResponse.nodeName.toLowerCase() == "table")) { // table - this.responseType = DS.TYPE_HTMLTABLE; - } - else if(YAHOO.lang.isObject(oRawResponse)) { // json - this.responseType = DS.TYPE_JSON; - } - else if(YAHOO.lang.isString(oRawResponse)) { // text - this.responseType = DS.TYPE_TEXT; - } - } - } - - switch(this.responseType) { - case DS.TYPE_JSARRAY: - if(xhr && oRawResponse && oRawResponse.responseText) { - oFullResponse = oRawResponse.responseText; - } - try { - // Convert to JS array if it's a string - if(lang.isString(oFullResponse)) { - var parseArgs = [oFullResponse].concat(this.parseJSONArgs); - // Check for YUI JSON Util - if(lang.JSON) { - oFullResponse = lang.JSON.parse.apply(lang.JSON,parseArgs); - } - // Look for JSON parsers using an API similar to json2.js - else if(window.JSON && JSON.parse) { - oFullResponse = JSON.parse.apply(JSON,parseArgs); - } - // Look for JSON parsers using an API similar to json.js - else if(oFullResponse.parseJSON) { - oFullResponse = oFullResponse.parseJSON.apply(oFullResponse,parseArgs.slice(1)); - } - // No JSON lib found so parse the string - else { - // Trim leading spaces - while (oFullResponse.length > 0 && - (oFullResponse.charAt(0) != "{") && - (oFullResponse.charAt(0) != "[")) { - oFullResponse = oFullResponse.substring(1, oFullResponse.length); - } - - if(oFullResponse.length > 0) { - // Strip extraneous stuff at the end - var arrayEnd = -Math.max(oFullResponse.lastIndexOf("]"),oFullResponse.lastIndexOf("}")); - oFullResponse = oFullResponse.substring(0,arrayEnd+1); - - // Turn the string into an object literal... - // ...eval is necessary here - oFullResponse = eval("(" + oFullResponse + ")"); - - } - } - } - } - catch(e1) { - } - oFullResponse = this.doBeforeParseData(oRequest, oFullResponse, oCallback); - oParsedResponse = this.parseArrayData(oRequest, oFullResponse); - break; - case DS.TYPE_JSON: - if(xhr && oRawResponse && oRawResponse.responseText) { - oFullResponse = oRawResponse.responseText; - } - try { - // Convert to JSON object if it's a string - if(lang.isString(oFullResponse)) { - var parseArgs = [oFullResponse].concat(this.parseJSONArgs); - // Check for YUI JSON Util - if(lang.JSON) { - oFullResponse = lang.JSON.parse.apply(lang.JSON,parseArgs); - } - // Look for JSON parsers using an API similar to json2.js - else if(window.JSON && JSON.parse) { - oFullResponse = JSON.parse.apply(JSON,parseArgs); - } - // Look for JSON parsers using an API similar to json.js - else if(oFullResponse.parseJSON) { - oFullResponse = oFullResponse.parseJSON.apply(oFullResponse,parseArgs.slice(1)); - } - // No JSON lib found so parse the string - else { - // Trim leading spaces - while (oFullResponse.length > 0 && - (oFullResponse.charAt(0) != "{") && - (oFullResponse.charAt(0) != "[")) { - oFullResponse = oFullResponse.substring(1, oFullResponse.length); - } - - if(oFullResponse.length > 0) { - // Strip extraneous stuff at the end - var objEnd = Math.max(oFullResponse.lastIndexOf("]"),oFullResponse.lastIndexOf("}")); - oFullResponse = oFullResponse.substring(0,objEnd+1); - - // Turn the string into an object literal... - // ...eval is necessary here - oFullResponse = eval("(" + oFullResponse + ")"); - - } - } - } - } - catch(e) { - } - - oFullResponse = this.doBeforeParseData(oRequest, oFullResponse, oCallback); - oParsedResponse = this.parseJSONData(oRequest, oFullResponse); - break; - case DS.TYPE_HTMLTABLE: - if(xhr && oRawResponse.responseText) { - var el = document.createElement('div'); - el.innerHTML = oRawResponse.responseText; - oFullResponse = el.getElementsByTagName('table')[0]; - } - oFullResponse = this.doBeforeParseData(oRequest, oFullResponse, oCallback); - oParsedResponse = this.parseHTMLTableData(oRequest, oFullResponse); - break; - case DS.TYPE_XML: - if(xhr && oRawResponse.responseXML) { - oFullResponse = oRawResponse.responseXML; - } - oFullResponse = this.doBeforeParseData(oRequest, oFullResponse, oCallback); - oParsedResponse = this.parseXMLData(oRequest, oFullResponse); - break; - case DS.TYPE_TEXT: - if(xhr && lang.isString(oRawResponse.responseText)) { - oFullResponse = oRawResponse.responseText; - } - oFullResponse = this.doBeforeParseData(oRequest, oFullResponse, oCallback); - oParsedResponse = this.parseTextData(oRequest, oFullResponse); - break; - default: - oFullResponse = this.doBeforeParseData(oRequest, oFullResponse, oCallback); - oParsedResponse = this.parseData(oRequest, oFullResponse); - break; - } - - - // Clean up for consistent signature - oParsedResponse = oParsedResponse || {}; - if(!oParsedResponse.results) { - oParsedResponse.results = []; - } - if(!oParsedResponse.meta) { - oParsedResponse.meta = {}; - } - - // Success - if(oParsedResponse && !oParsedResponse.error) { - // Last chance to touch the raw response or the parsed response - oParsedResponse = this.doBeforeCallback(oRequest, oFullResponse, oParsedResponse, oCallback); - this.fireEvent("responseParseEvent", {request:oRequest, - response:oParsedResponse, callback:oCallback, caller:oCaller}); - // Cache the response - this.addToCache(oRequest, oParsedResponse); - } - // Error - else { - // Be sure the error flag is on - oParsedResponse.error = true; - this.fireEvent("dataErrorEvent", {request:oRequest, response: oRawResponse, callback:oCallback, - caller:oCaller, message:DS.ERROR_DATANULL}); - } - - // Send the response back to the caller - oParsedResponse.tId = tId; - DS.issueCallback(oCallback,[oRequest,oParsedResponse],oParsedResponse.error,oCaller); -}, - -/** - * Overridable method gives implementers access to the original full response - * before the data gets parsed. Implementers should take care not to return an - * unparsable or otherwise invalid response. - * - * @method doBeforeParseData - * @param oRequest {Object} Request object. - * @param oFullResponse {Object} The full response from the live database. - * @param oCallback {Object} The callback object. - * @return {Object} Full response for parsing. - - */ -doBeforeParseData : function(oRequest, oFullResponse, oCallback) { - return oFullResponse; -}, - -/** - * Overridable method gives implementers access to the original full response and - * the parsed response (parsed against the given schema) before the data - * is added to the cache (if applicable) and then sent back to callback function. - * This is your chance to access the raw response and/or populate the parsed - * response with any custom data. - * - * @method doBeforeCallback - * @param oRequest {Object} Request object. - * @param oFullResponse {Object} The full response from the live database. - * @param oParsedResponse {Object} The parsed response to return to calling object. - * @param oCallback {Object} The callback object. - * @return {Object} Parsed response object. - */ -doBeforeCallback : function(oRequest, oFullResponse, oParsedResponse, oCallback) { - return oParsedResponse; -}, - -/** - * Overridable method parses data of generic RESPONSE_TYPE into a response object. - * - * @method parseData - * @param oRequest {Object} Request object. - * @param oFullResponse {Object} The full Array from the live database. - * @return {Object} Parsed response object with the following properties:
- * - results {Array} Array of parsed data results
- * - meta {Object} Object literal of meta values
- * - error {Boolean} (optional) True if there was an error
- */ -parseData : function(oRequest, oFullResponse) { - if(lang.isValue(oFullResponse)) { - var oParsedResponse = {results:oFullResponse,meta:{}}; - return oParsedResponse; - - } - return null; -}, - -/** - * Overridable method parses Array data into a response object. - * - * @method parseArrayData - * @param oRequest {Object} Request object. - * @param oFullResponse {Object} The full Array from the live database. - * @return {Object} Parsed response object with the following properties:
- * - results (Array) Array of parsed data results
- * - error (Boolean) True if there was an error - */ -parseArrayData : function(oRequest, oFullResponse) { - if(lang.isArray(oFullResponse)) { - var results = [], - i, j, - rec, field, data; - - // Parse for fields - if(lang.isArray(this.responseSchema.fields)) { - var fields = this.responseSchema.fields; - for (i = fields.length - 1; i >= 0; --i) { - if (typeof fields[i] !== 'object') { - fields[i] = { key : fields[i] }; - } - } - - var parsers = {}, p; - for (i = fields.length - 1; i >= 0; --i) { - p = (typeof fields[i].parser === 'function' ? - fields[i].parser : - DS.Parser[fields[i].parser+'']) || fields[i].converter; - if (p) { - parsers[fields[i].key] = p; - } - } - - var arrType = lang.isArray(oFullResponse[0]); - for(i=oFullResponse.length-1; i>-1; i--) { - var oResult = {}; - rec = oFullResponse[i]; - if (typeof rec === 'object') { - for(j=fields.length-1; j>-1; j--) { - field = fields[j]; - data = arrType ? rec[j] : rec[field.key]; - - if (parsers[field.key]) { - data = parsers[field.key].call(this,data); - } - - // Safety measure - if(data === undefined) { - data = null; - } - - oResult[field.key] = data; - } - } - else if (lang.isString(rec)) { - for(j=fields.length-1; j>-1; j--) { - field = fields[j]; - data = rec; - - if (parsers[field.key]) { - data = parsers[field.key].call(this,data); - } - - // Safety measure - if(data === undefined) { - data = null; - } - - oResult[field.key] = data; - } - } - results[i] = oResult; - } - } - // Return entire data set - else { - results = oFullResponse; - } - var oParsedResponse = {results:results}; - return oParsedResponse; - - } - return null; -}, - -/** - * Overridable method parses plain text data into a response object. - * - * @method parseTextData - * @param oRequest {Object} Request object. - * @param oFullResponse {Object} The full text response from the live database. - * @return {Object} Parsed response object with the following properties:
- * - results (Array) Array of parsed data results
- * - error (Boolean) True if there was an error - */ -parseTextData : function(oRequest, oFullResponse) { - if(lang.isString(oFullResponse)) { - if(lang.isString(this.responseSchema.recordDelim) && - lang.isString(this.responseSchema.fieldDelim)) { - var oParsedResponse = {results:[]}; - var recDelim = this.responseSchema.recordDelim; - var fieldDelim = this.responseSchema.fieldDelim; - if(oFullResponse.length > 0) { - // Delete the last line delimiter at the end of the data if it exists - var newLength = oFullResponse.length-recDelim.length; - if(oFullResponse.substr(newLength) == recDelim) { - oFullResponse = oFullResponse.substr(0, newLength); - } - if(oFullResponse.length > 0) { - // Split along record delimiter to get an array of strings - var recordsarray = oFullResponse.split(recDelim); - // Cycle through each record - for(var i = 0, len = recordsarray.length, recIdx = 0; i < len; ++i) { - var bError = false, - sRecord = recordsarray[i]; - if (lang.isString(sRecord) && (sRecord.length > 0)) { - // Split each record along field delimiter to get data - var fielddataarray = recordsarray[i].split(fieldDelim); - var oResult = {}; - - // Filter for fields data - if(lang.isArray(this.responseSchema.fields)) { - var fields = this.responseSchema.fields; - for(var j=fields.length-1; j>-1; j--) { - try { - // Remove quotation marks from edges, if applicable - var data = fielddataarray[j]; - if (lang.isString(data)) { - if(data.charAt(0) == "\"") { - data = data.substr(1); - } - if(data.charAt(data.length-1) == "\"") { - data = data.substr(0,data.length-1); - } - var field = fields[j]; - var key = (lang.isValue(field.key)) ? field.key : field; - // Backward compatibility - if(!field.parser && field.converter) { - field.parser = field.converter; - } - var parser = (typeof field.parser === 'function') ? - field.parser : - DS.Parser[field.parser+'']; - if(parser) { - data = parser.call(this, data); - } - // Safety measure - if(data === undefined) { - data = null; - } - oResult[key] = data; - } - else { - bError = true; - } - } - catch(e) { - bError = true; - } - } - } - // No fields defined so pass along all data as an array - else { - oResult = fielddataarray; - } - if(!bError) { - oParsedResponse.results[recIdx++] = oResult; - } - } - } - } - } - return oParsedResponse; - } - } - return null; - -}, - - -/** - * Overridable method parses XML data for one result into an object literal. - * - * @method parseXMLResult - * @param result {XML} XML for one result. - * @return {Object} Object literal of data for one result. - */ -parseXMLResult : function(result) { - var oResult = {}, - schema = this.responseSchema; - - try { - // Loop through each data field in each result using the schema - for(var m = schema.fields.length-1; m >= 0 ; m--) { - var field = schema.fields[m]; - var key = (lang.isValue(field.key)) ? field.key : field; - var data = null; - // Values may be held in an attribute... - var xmlAttr = result.attributes.getNamedItem(key); - if(xmlAttr) { - data = xmlAttr.value; - } - // ...or in a node - else { - var xmlNode = result.getElementsByTagName(key); - if(xmlNode && xmlNode.item(0)) { - var item = xmlNode.item(0); - // For IE, then DOM... - data = (item) ? ((item.text) ? item.text : (item.textContent) ? item.textContent : null) : null; - // ...then fallback, but check for multiple child nodes - if(!data) { - var datapieces = []; - for(var j=0, len=item.childNodes.length; j 0) { - data = datapieces.join(""); - } - } - } - } - // Safety net - if(data === null) { - data = ""; - } - // Backward compatibility - if(!field.parser && field.converter) { - field.parser = field.converter; - } - var parser = (typeof field.parser === 'function') ? - field.parser : - DS.Parser[field.parser+'']; - if(parser) { - data = parser.call(this, data); - } - // Safety measure - if(data === undefined) { - data = null; - } - oResult[key] = data; - } - } - catch(e) { - } - - return oResult; -}, - - - -/** - * Overridable method parses XML data into a response object. - * - * @method parseXMLData - * @param oRequest {Object} Request object. - * @param oFullResponse {Object} The full XML response from the live database. - * @return {Object} Parsed response object with the following properties
- * - results (Array) Array of parsed data results
- * - error (Boolean) True if there was an error - */ -parseXMLData : function(oRequest, oFullResponse) { - var bError = false, - schema = this.responseSchema, - oParsedResponse = {meta:{}}, - xmlList = null, - metaNode = schema.metaNode, - metaLocators = schema.metaFields || {}, - i,k,loc,v; - - // In case oFullResponse is something funky - try { - xmlList = (schema.resultNode) ? - oFullResponse.getElementsByTagName(schema.resultNode) : - null; - - // Pull any meta identified - metaNode = metaNode ? oFullResponse.getElementsByTagName(metaNode)[0] : - oFullResponse; - - if (metaNode) { - for (k in metaLocators) { - if (lang.hasOwnProperty(metaLocators, k)) { - loc = metaLocators[k]; - // Look for a node - v = metaNode.getElementsByTagName(loc)[0]; - - if (v) { - v = v.firstChild.nodeValue; - } else { - // Look for an attribute - v = metaNode.attributes.getNamedItem(loc); - if (v) { - v = v.value; - } - } - - if (lang.isValue(v)) { - oParsedResponse.meta[k] = v; - } - } - - } - } - } - catch(e) { - } - if(!xmlList || !lang.isArray(schema.fields)) { - bError = true; - } - // Loop through each result - else { - oParsedResponse.results = []; - for(i = xmlList.length-1; i >= 0 ; --i) { - var oResult = this.parseXMLResult(xmlList.item(i)); - // Capture each array of values into an array of results - oParsedResponse.results[i] = oResult; - } - } - if(bError) { - oParsedResponse.error = true; - } - else { - } - return oParsedResponse; -}, - -/** - * Overridable method parses JSON data into a response object. - * - * @method parseJSONData - * @param oRequest {Object} Request object. - * @param oFullResponse {Object} The full JSON from the live database. - * @return {Object} Parsed response object with the following properties
- * - results (Array) Array of parsed data results
- * - error (Boolean) True if there was an error - */ -parseJSONData : function(oRequest, oFullResponse) { - var oParsedResponse = {results:[],meta:{}}; - - if(lang.isObject(oFullResponse) && this.responseSchema.resultsList) { - var schema = this.responseSchema, - fields = schema.fields, - resultsList = oFullResponse, - results = [], - metaFields = schema.metaFields || {}, - fieldParsers = [], - fieldPaths = [], - simpleFields = [], - bError = false, - i,len,j,v,key,parser,path; - - // Function to convert the schema's fields into walk paths - var buildPath = function (needle) { - var path = null, keys = [], i = 0; - if (needle) { - // Strip the ["string keys"] and [1] array indexes - needle = needle. - replace(/\[(['"])(.*?)\1\]/g, - function (x,$1,$2) {keys[i]=$2;return '.@'+(i++);}). - replace(/\[(\d+)\]/g, - function (x,$1) {keys[i]=parseInt($1,10)|0;return '.@'+(i++);}). - replace(/^\./,''); // remove leading dot - - // If the cleaned needle contains invalid characters, the - // path is invalid - if (!/[^\w\.\$@]/.test(needle)) { - path = needle.split('.'); - for (i=path.length-1; i >= 0; --i) { - if (path[i].charAt(0) === '@') { - path[i] = keys[parseInt(path[i].substr(1),10)]; - } - } - } - else { - } - } - return path; - }; - - - // Function to walk a path and return the pot of gold - var walkPath = function (path, origin) { - var v=origin,i=0,len=path.length; - for (;i 1) { - fieldPaths[fieldPaths.length] = {key:key,path:path}; - } else { - simpleFields[simpleFields.length] = {key:key,path:path[0]}; - } - } else { - } - } - - // Process the results, flattening the records and/or applying parsers if needed - for (i = resultsList.length - 1; i >= 0; --i) { - var r = resultsList[i], rec = {}; - if(r) { - for (j = simpleFields.length - 1; j >= 0; --j) { - // Bug 1777850: data might be held in an array - rec[simpleFields[j].key] = - (r[simpleFields[j].path] !== undefined) ? - r[simpleFields[j].path] : r[j]; - } - - for (j = fieldPaths.length - 1; j >= 0; --j) { - rec[fieldPaths[j].key] = walkPath(fieldPaths[j].path,r); - } - - for (j = fieldParsers.length - 1; j >= 0; --j) { - var p = fieldParsers[j].key; - rec[p] = fieldParsers[j].parser(rec[p]); - if (rec[p] === undefined) { - rec[p] = null; - } - } - } - results[i] = rec; - } - } - else { - results = resultsList; - } - - for (key in metaFields) { - if (lang.hasOwnProperty(metaFields,key)) { - path = buildPath(metaFields[key]); - if (path) { - v = walkPath(path, oFullResponse); - oParsedResponse.meta[key] = v; - } - } - } - - } else { - - oParsedResponse.error = true; - } - - oParsedResponse.results = results; - } - else { - oParsedResponse.error = true; - } - - return oParsedResponse; -}, - -/** - * Overridable method parses an HTML TABLE element reference into a response object. - * Data is parsed out of TR elements from all TBODY elements. - * - * @method parseHTMLTableData - * @param oRequest {Object} Request object. - * @param oFullResponse {Object} The full HTML element reference from the live database. - * @return {Object} Parsed response object with the following properties
- * - results (Array) Array of parsed data results
- * - error (Boolean) True if there was an error - */ -parseHTMLTableData : function(oRequest, oFullResponse) { - var bError = false; - var elTable = oFullResponse; - var fields = this.responseSchema.fields; - var oParsedResponse = {results:[]}; - - if(lang.isArray(fields)) { - // Iterate through each TBODY - for(var i=0; i-1; j--) { - var elRow = elTbody.rows[j]; - var oResult = {}; - - for(var k=fields.length-1; k>-1; k--) { - var field = fields[k]; - var key = (lang.isValue(field.key)) ? field.key : field; - var data = elRow.cells[k].innerHTML; - - // Backward compatibility - if(!field.parser && field.converter) { - field.parser = field.converter; - } - var parser = (typeof field.parser === 'function') ? - field.parser : - DS.Parser[field.parser+'']; - if(parser) { - data = parser.call(this, data); - } - // Safety measure - if(data === undefined) { - data = null; - } - oResult[key] = data; - } - oParsedResponse.results[j] = oResult; - } - } - } - else { - bError = true; - } - - if(bError) { - oParsedResponse.error = true; - } - else { - } - return oParsedResponse; -} - -}; - -// DataSourceBase uses EventProvider -lang.augmentProto(DS, util.EventProvider); - - - -/****************************************************************************/ -/****************************************************************************/ -/****************************************************************************/ - -/** - * LocalDataSource class for in-memory data structs including JavaScript arrays, - * JavaScript object literals (JSON), XML documents, and HTML tables. - * - * @namespace YAHOO.util - * @class YAHOO.util.LocalDataSource - * @extends YAHOO.util.DataSourceBase - * @constructor - * @param oLiveData {HTMLElement} Pointer to live data. - * @param oConfigs {object} (optional) Object literal of configuration values. - */ -util.LocalDataSource = function(oLiveData, oConfigs) { - this.dataType = DS.TYPE_LOCAL; - - if(oLiveData) { - if(YAHOO.lang.isArray(oLiveData)) { // array - this.responseType = DS.TYPE_JSARRAY; - } - // xml - else if(oLiveData.nodeType && oLiveData.nodeType == 9) { - this.responseType = DS.TYPE_XML; - } - else if(oLiveData.nodeName && (oLiveData.nodeName.toLowerCase() == "table")) { // table - this.responseType = DS.TYPE_HTMLTABLE; - oLiveData = oLiveData.cloneNode(true); - } - else if(YAHOO.lang.isString(oLiveData)) { // text - this.responseType = DS.TYPE_TEXT; - } - else if(YAHOO.lang.isObject(oLiveData)) { // json - this.responseType = DS.TYPE_JSON; - } - } - else { - oLiveData = []; - this.responseType = DS.TYPE_JSARRAY; - } - - util.LocalDataSource.superclass.constructor.call(this, oLiveData, oConfigs); -}; - -// LocalDataSource extends DataSourceBase -lang.extend(util.LocalDataSource, DS); - -// Copy static members to LocalDataSource class -lang.augmentObject(util.LocalDataSource, DS); - - - - - - - - - - - - - -/****************************************************************************/ -/****************************************************************************/ -/****************************************************************************/ - -/** - * FunctionDataSource class for JavaScript functions. - * - * @namespace YAHOO.util - * @class YAHOO.util.FunctionDataSource - * @extends YAHOO.util.DataSourceBase - * @constructor - * @param oLiveData {HTMLElement} Pointer to live data. - * @param oConfigs {object} (optional) Object literal of configuration values. - */ -util.FunctionDataSource = function(oLiveData, oConfigs) { - this.dataType = DS.TYPE_JSFUNCTION; - oLiveData = oLiveData || function() {}; - - util.FunctionDataSource.superclass.constructor.call(this, oLiveData, oConfigs); -}; - -// FunctionDataSource extends DataSourceBase -lang.extend(util.FunctionDataSource, DS, { - -///////////////////////////////////////////////////////////////////////////// -// -// FunctionDataSource public properties -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Context in which to execute the function. By default, is the DataSource - * instance itself. If set, the function will receive the DataSource instance - * as an additional argument. - * - * @property scope - * @type Object - * @default null - */ -scope : null, - - -///////////////////////////////////////////////////////////////////////////// -// -// FunctionDataSource public methods -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Overriding method passes query to a function. The returned response is then - * forwarded to the handleResponse function. - * - * @method makeConnection - * @param oRequest {Object} Request object. - * @param oCallback {Object} Callback object literal. - * @param oCaller {Object} (deprecated) Use oCallback.scope. - * @return {Number} Transaction ID. - */ -makeConnection : function(oRequest, oCallback, oCaller) { - var tId = DS._nTransactionId++; - this.fireEvent("requestEvent", {tId:tId,request:oRequest,callback:oCallback,caller:oCaller}); - - // Pass the request in as a parameter and - // forward the return value to the handler - - - var oRawResponse = (this.scope) ? this.liveData.call(this.scope, oRequest, this) : this.liveData(oRequest); - - // Try to sniff data type if it has not been defined - if(this.responseType === DS.TYPE_UNKNOWN) { - if(YAHOO.lang.isArray(oRawResponse)) { // array - this.responseType = DS.TYPE_JSARRAY; - } - // xml - else if(oRawResponse && oRawResponse.nodeType && oRawResponse.nodeType == 9) { - this.responseType = DS.TYPE_XML; - } - else if(oRawResponse && oRawResponse.nodeName && (oRawResponse.nodeName.toLowerCase() == "table")) { // table - this.responseType = DS.TYPE_HTMLTABLE; - } - else if(YAHOO.lang.isObject(oRawResponse)) { // json - this.responseType = DS.TYPE_JSON; - } - else if(YAHOO.lang.isString(oRawResponse)) { // text - this.responseType = DS.TYPE_TEXT; - } - } - - this.handleResponse(oRequest, oRawResponse, oCallback, oCaller, tId); - return tId; -} - -}); - -// Copy static members to FunctionDataSource class -lang.augmentObject(util.FunctionDataSource, DS); - - - - - - - - - - - - - -/****************************************************************************/ -/****************************************************************************/ -/****************************************************************************/ - -/** - * ScriptNodeDataSource class for accessing remote data via the YUI Get Utility. - * - * @namespace YAHOO.util - * @class YAHOO.util.ScriptNodeDataSource - * @extends YAHOO.util.DataSourceBase - * @constructor - * @param oLiveData {HTMLElement} Pointer to live data. - * @param oConfigs {object} (optional) Object literal of configuration values. - */ -util.ScriptNodeDataSource = function(oLiveData, oConfigs) { - this.dataType = DS.TYPE_SCRIPTNODE; - oLiveData = oLiveData || ""; - - util.ScriptNodeDataSource.superclass.constructor.call(this, oLiveData, oConfigs); -}; - -// ScriptNodeDataSource extends DataSourceBase -lang.extend(util.ScriptNodeDataSource, DS, { - -///////////////////////////////////////////////////////////////////////////// -// -// ScriptNodeDataSource public properties -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Alias to YUI Get Utility, to allow implementers to use a custom class. - * - * @property getUtility - * @type Object - * @default YAHOO.util.Get - */ -getUtility : util.Get, - -/** - * Defines request/response management in the following manner: - *
- * - *
ignoreStaleResponses
- *
Send all requests, but handle only the response for the most recently sent request.
- *
allowAll
- *
Send all requests and handle all responses.
- *
- * - * @property asyncMode - * @type String - * @default "allowAll" - */ -asyncMode : "allowAll", - -/** - * Callback string parameter name sent to the remote script. By default, - * requests are sent to - * <URI>?<scriptCallbackParam>=callbackFunction - * - * @property scriptCallbackParam - * @type String - * @default "callback" - */ -scriptCallbackParam : "callback", - - -///////////////////////////////////////////////////////////////////////////// -// -// ScriptNodeDataSource public methods -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Creates a request callback that gets appended to the script URI. Implementers - * can customize this string to match their server's query syntax. - * - * @method generateRequestCallback - * @return {String} String fragment that gets appended to script URI that - * specifies the callback function - */ -generateRequestCallback : function(id) { - return "&" + this.scriptCallbackParam + "=YAHOO.util.ScriptNodeDataSource.callbacks["+id+"]" ; -}, - -/** - * Overridable method gives implementers access to modify the URI before the dynamic - * script node gets inserted. Implementers should take care not to return an - * invalid URI. - * - * @method doBeforeGetScriptNode - * @param {String} URI to the script - * @return {String} URI to the script - */ -doBeforeGetScriptNode : function(sUri) { - return sUri; -}, - -/** - * Overriding method passes query to Get Utility. The returned - * response is then forwarded to the handleResponse function. - * - * @method makeConnection - * @param oRequest {Object} Request object. - * @param oCallback {Object} Callback object literal. - * @param oCaller {Object} (deprecated) Use oCallback.scope. - * @return {Number} Transaction ID. - */ -makeConnection : function(oRequest, oCallback, oCaller) { - var tId = DS._nTransactionId++; - this.fireEvent("requestEvent", {tId:tId,request:oRequest,callback:oCallback,caller:oCaller}); - - // If there are no global pending requests, it is safe to purge global callback stack and global counter - if(util.ScriptNodeDataSource._nPending === 0) { - util.ScriptNodeDataSource.callbacks = []; - util.ScriptNodeDataSource._nId = 0; - } - - // ID for this request - var id = util.ScriptNodeDataSource._nId; - util.ScriptNodeDataSource._nId++; - - // Dynamically add handler function with a closure to the callback stack - var oSelf = this; - util.ScriptNodeDataSource.callbacks[id] = function(oRawResponse) { - if((oSelf.asyncMode !== "ignoreStaleResponses")|| - (id === util.ScriptNodeDataSource.callbacks.length-1)) { // Must ignore stale responses - - // Try to sniff data type if it has not been defined - if(oSelf.responseType === DS.TYPE_UNKNOWN) { - if(YAHOO.lang.isArray(oRawResponse)) { // array - oSelf.responseType = DS.TYPE_JSARRAY; - } - // xml - else if(oRawResponse.nodeType && oRawResponse.nodeType == 9) { - oSelf.responseType = DS.TYPE_XML; - } - else if(oRawResponse.nodeName && (oRawResponse.nodeName.toLowerCase() == "table")) { // table - oSelf.responseType = DS.TYPE_HTMLTABLE; - } - else if(YAHOO.lang.isObject(oRawResponse)) { // json - oSelf.responseType = DS.TYPE_JSON; - } - else if(YAHOO.lang.isString(oRawResponse)) { // text - oSelf.responseType = DS.TYPE_TEXT; - } - } - - oSelf.handleResponse(oRequest, oRawResponse, oCallback, oCaller, tId); - } - else { - } - - delete util.ScriptNodeDataSource.callbacks[id]; - }; - - // We are now creating a request - util.ScriptNodeDataSource._nPending++; - var sUri = this.liveData + oRequest + this.generateRequestCallback(id); - sUri = this.doBeforeGetScriptNode(sUri); - this.getUtility.script(sUri, - {autopurge: true, - onsuccess: util.ScriptNodeDataSource._bumpPendingDown, - onfail: util.ScriptNodeDataSource._bumpPendingDown}); - - return tId; -} - -}); - -// Copy static members to ScriptNodeDataSource class -lang.augmentObject(util.ScriptNodeDataSource, DS); - -// Copy static members to ScriptNodeDataSource class -lang.augmentObject(util.ScriptNodeDataSource, { - -///////////////////////////////////////////////////////////////////////////// -// -// ScriptNodeDataSource private static properties -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Unique ID to track requests. - * - * @property _nId - * @type Number - * @private - * @static - */ -_nId : 0, - -/** - * Counter for pending requests. When this is 0, it is safe to purge callbacks - * array. - * - * @property _nPending - * @type Number - * @private - * @static - */ -_nPending : 0, - -/** - * Global array of callback functions, one for each request sent. - * - * @property callbacks - * @type Function[] - * @static - */ -callbacks : [] - -}); - - - - - - - - - - - - - - -/****************************************************************************/ -/****************************************************************************/ -/****************************************************************************/ - -/** - * XHRDataSource class for accessing remote data via the YUI Connection Manager - * Utility - * - * @namespace YAHOO.util - * @class YAHOO.util.XHRDataSource - * @extends YAHOO.util.DataSourceBase - * @constructor - * @param oLiveData {HTMLElement} Pointer to live data. - * @param oConfigs {object} (optional) Object literal of configuration values. - */ -util.XHRDataSource = function(oLiveData, oConfigs) { - this.dataType = DS.TYPE_XHR; - this.connMgr = this.connMgr || util.Connect; - oLiveData = oLiveData || ""; - - util.XHRDataSource.superclass.constructor.call(this, oLiveData, oConfigs); -}; - -// XHRDataSource extends DataSourceBase -lang.extend(util.XHRDataSource, DS, { - -///////////////////////////////////////////////////////////////////////////// -// -// XHRDataSource public properties -// -///////////////////////////////////////////////////////////////////////////// - - /** - * Alias to YUI Connection Manager, to allow implementers to use a custom class. - * - * @property connMgr - * @type Object - * @default YAHOO.util.Connect - */ -connMgr: null, - - /** - * Defines request/response management in the following manner: - *
- *
queueRequests
- *
If a request is already in progress, wait until response is returned - * before sending the next request.
- * - *
cancelStaleRequests
- *
If a request is already in progress, cancel it before sending the next - * request.
- * - *
ignoreStaleResponses
- *
Send all requests, but handle only the response for the most recently - * sent request.
- * - *
allowAll
- *
Send all requests and handle all responses.
- * - *
- * - * @property connXhrMode - * @type String - * @default "allowAll" - */ -connXhrMode: "allowAll", - - /** - * True if data is to be sent via POST. By default, data will be sent via GET. - * - * @property connMethodPost - * @type Boolean - * @default false - */ -connMethodPost: false, - - /** - * The connection timeout defines how many milliseconds the XHR connection will - * wait for a server response. Any non-zero value will enable the Connection Manager's - * Auto-Abort feature. - * - * @property connTimeout - * @type Number - * @default 0 - */ -connTimeout: 0, - -///////////////////////////////////////////////////////////////////////////// -// -// XHRDataSource public methods -// -///////////////////////////////////////////////////////////////////////////// - -/** - * Overriding method passes query to Connection Manager. The returned - * response is then forwarded to the handleResponse function. - * - * @method makeConnection - * @param oRequest {Object} Request object. - * @param oCallback {Object} Callback object literal. - * @param oCaller {Object} (deprecated) Use oCallback.scope. - * @return {Number} Transaction ID. - */ -makeConnection : function(oRequest, oCallback, oCaller) { - - var oRawResponse = null; - var tId = DS._nTransactionId++; - this.fireEvent("requestEvent", {tId:tId,request:oRequest,callback:oCallback,caller:oCaller}); - - // Set up the callback object and - // pass the request in as a URL query and - // forward the response to the handler - var oSelf = this; - var oConnMgr = this.connMgr; - var oQueue = this._oQueue; - - /** - * Define Connection Manager success handler - * - * @method _xhrSuccess - * @param oResponse {Object} HTTPXMLRequest object - * @private - */ - var _xhrSuccess = function(oResponse) { - // If response ID does not match last made request ID, - // silently fail and wait for the next response - if(oResponse && (this.connXhrMode == "ignoreStaleResponses") && - (oResponse.tId != oQueue.conn.tId)) { - return null; - } - // Error if no response - else if(!oResponse) { - this.fireEvent("dataErrorEvent", {request:oRequest, - callback:oCallback, caller:oCaller, - message:DS.ERROR_DATANULL}); - - // Send error response back to the caller with the error flag on - DS.issueCallback(oCallback,[oRequest, {error:true}], true, oCaller); - - return null; - } - // Forward to handler - else { - // Try to sniff data type if it has not been defined - if(this.responseType === DS.TYPE_UNKNOWN) { - var ctype = (oResponse.getResponseHeader) ? oResponse.getResponseHeader["Content-Type"] : null; - if(ctype) { - // xml - if(ctype.indexOf("text/xml") > -1) { - this.responseType = DS.TYPE_XML; - } - else if(ctype.indexOf("application/json") > -1) { // json - this.responseType = DS.TYPE_JSON; - } - else if(ctype.indexOf("text/plain") > -1) { // text - this.responseType = DS.TYPE_TEXT; - } - } - } - this.handleResponse(oRequest, oResponse, oCallback, oCaller, tId); - } - }; - - /** - * Define Connection Manager failure handler - * - * @method _xhrFailure - * @param oResponse {Object} HTTPXMLRequest object - * @private - */ - var _xhrFailure = function(oResponse) { - this.fireEvent("dataErrorEvent", {request:oRequest, - callback:oCallback, caller:oCaller, - message:DS.ERROR_DATAINVALID}); - - // Backward compatibility - if(lang.isString(this.liveData) && lang.isString(oRequest) && - (this.liveData.lastIndexOf("?") !== this.liveData.length-1) && - (oRequest.indexOf("?") !== 0)){ - } - - // Send failure response back to the caller with the error flag on - oResponse = oResponse || {}; - oResponse.error = true; - DS.issueCallback(oCallback,[oRequest,oResponse],true, oCaller); - - return null; - }; - - /** - * Define Connection Manager callback object - * - * @property _xhrCallback - * @param oResponse {Object} HTTPXMLRequest object - * @private - */ - var _xhrCallback = { - success:_xhrSuccess, - failure:_xhrFailure, - scope: this - }; - - // Apply Connection Manager timeout - if(lang.isNumber(this.connTimeout)) { - _xhrCallback.timeout = this.connTimeout; - } - - // Cancel stale requests - if(this.connXhrMode == "cancelStaleRequests") { - // Look in queue for stale requests - if(oQueue.conn) { - if(oConnMgr.abort) { - oConnMgr.abort(oQueue.conn); - oQueue.conn = null; - } - else { - } - } - } - - // Get ready to send the request URL - if(oConnMgr && oConnMgr.asyncRequest) { - var sLiveData = this.liveData; - var isPost = this.connMethodPost; - var sMethod = (isPost) ? "POST" : "GET"; - // Validate request - var sUri = (isPost || !lang.isValue(oRequest)) ? sLiveData : sLiveData+oRequest; - var sRequest = (isPost) ? oRequest : null; - - // Send the request right away - if(this.connXhrMode != "queueRequests") { - oQueue.conn = oConnMgr.asyncRequest(sMethod, sUri, _xhrCallback, sRequest); - } - // Queue up then send the request - else { - // Found a request already in progress - if(oQueue.conn) { - var allRequests = oQueue.requests; - // Add request to queue - allRequests.push({request:oRequest, callback:_xhrCallback}); - - // Interval needs to be started - if(!oQueue.interval) { - oQueue.interval = setInterval(function() { - // Connection is in progress - if(oConnMgr.isCallInProgress(oQueue.conn)) { - return; - } - else { - // Send next request - if(allRequests.length > 0) { - // Validate request - sUri = (isPost || !lang.isValue(allRequests[0].request)) ? sLiveData : sLiveData+allRequests[0].request; - sRequest = (isPost) ? allRequests[0].request : null; - oQueue.conn = oConnMgr.asyncRequest(sMethod, sUri, allRequests[0].callback, sRequest); - - // Remove request from queue - allRequests.shift(); - } - // No more requests - else { - clearInterval(oQueue.interval); - oQueue.interval = null; - } - } - }, 50); - } - } - // Nothing is in progress - else { - oQueue.conn = oConnMgr.asyncRequest(sMethod, sUri, _xhrCallback, sRequest); - } - } - } - else { - // Send null response back to the caller with the error flag on - DS.issueCallback(oCallback,[oRequest,{error:true}],true,oCaller); - } - - return tId; -} - -}); - -// Copy static members to XHRDataSource class -lang.augmentObject(util.XHRDataSource, DS); - - - - - - - - - - - - - -/****************************************************************************/ -/****************************************************************************/ -/****************************************************************************/ - -/** - * Factory class for creating a BaseDataSource subclass instance. The sublcass is - * determined by oLiveData's type, unless the dataType config is explicitly passed in. - * - * @namespace YAHOO.util - * @class YAHOO.util.DataSource - * @constructor - * @param oLiveData {HTMLElement} Pointer to live data. - * @param oConfigs {object} (optional) Object literal of configuration values. - */ -util.DataSource = function(oLiveData, oConfigs) { - oConfigs = oConfigs || {}; - - // Point to one of the subclasses, first by dataType if given, then by sniffing oLiveData type. - var dataType = oConfigs.dataType; - if(dataType) { - if(dataType == DS.TYPE_LOCAL) { - lang.augmentObject(util.DataSource, util.LocalDataSource); - return new util.LocalDataSource(oLiveData, oConfigs); - } - else if(dataType == DS.TYPE_XHR) { - lang.augmentObject(util.DataSource, util.XHRDataSource); - return new util.XHRDataSource(oLiveData, oConfigs); - } - else if(dataType == DS.TYPE_SCRIPTNODE) { - lang.augmentObject(util.DataSource, util.ScriptNodeDataSource); - return new util.ScriptNodeDataSource(oLiveData, oConfigs); - } - else if(dataType == DS.TYPE_JSFUNCTION) { - lang.augmentObject(util.DataSource, util.FunctionDataSource); - return new util.FunctionDataSource(oLiveData, oConfigs); - } - } - - if(YAHOO.lang.isString(oLiveData)) { // strings default to xhr - lang.augmentObject(util.DataSource, util.XHRDataSource); - return new util.XHRDataSource(oLiveData, oConfigs); - } - else if(YAHOO.lang.isFunction(oLiveData)) { - lang.augmentObject(util.DataSource, util.FunctionDataSource); - return new util.FunctionDataSource(oLiveData, oConfigs); - } - else { // ultimate default is local - lang.augmentObject(util.DataSource, util.LocalDataSource); - return new util.LocalDataSource(oLiveData, oConfigs); - } -}; - -// Copy static members to DataSource class -lang.augmentObject(util.DataSource, DS); - -})(); - -/****************************************************************************/ -/****************************************************************************/ -/****************************************************************************/ - -/** - * The static Number class provides helper functions to deal with data of type - * Number. - * - * @namespace YAHOO.util - * @requires yahoo - * @class Number - * @static - */ - YAHOO.util.Number = { - - /** - * Takes a native JavaScript Number and formats to string for display to user. - * - * @method format - * @param nData {Number} Number. - * @param oConfig {Object} (Optional) Optional configuration values: - *
- *
prefix {String} - *
String prepended before each number, like a currency designator "$"
- *
decimalPlaces {Number} - *
Number of decimal places to round.
- *
decimalSeparator {String} - *
Decimal separator
- *
thousandsSeparator {String} - *
Thousands separator
- *
suffix {String} - *
String appended after each number, like " items" (note the space)
- *
- * @return {String} Formatted number for display. Note, the following values - * return as "": null, undefined, NaN, "". - */ - format : function(nData, oConfig) { - var lang = YAHOO.lang; - if(!lang.isValue(nData) || (nData === "")) { - return ""; - } - - oConfig = oConfig || {}; - - if(!lang.isNumber(nData)) { - nData *= 1; - } - - if(lang.isNumber(nData)) { - var bNegative = (nData < 0); - var sOutput = nData + ""; - var sDecimalSeparator = (oConfig.decimalSeparator) ? oConfig.decimalSeparator : "."; - var nDotIndex; - - // Manage decimals - if(lang.isNumber(oConfig.decimalPlaces)) { - // Round to the correct decimal place - var nDecimalPlaces = oConfig.decimalPlaces; - var nDecimal = Math.pow(10, nDecimalPlaces); - sOutput = Math.round(nData*nDecimal)/nDecimal + ""; - nDotIndex = sOutput.lastIndexOf("."); - - if(nDecimalPlaces > 0) { - // Add the decimal separator - if(nDotIndex < 0) { - sOutput += sDecimalSeparator; - nDotIndex = sOutput.length-1; - } - // Replace the "." - else if(sDecimalSeparator !== "."){ - sOutput = sOutput.replace(".",sDecimalSeparator); - } - // Add missing zeros - while((sOutput.length - 1 - nDotIndex) < nDecimalPlaces) { - sOutput += "0"; - } - } - } - - // Add the thousands separator - if(oConfig.thousandsSeparator) { - var sThousandsSeparator = oConfig.thousandsSeparator; - nDotIndex = sOutput.lastIndexOf(sDecimalSeparator); - nDotIndex = (nDotIndex > -1) ? nDotIndex : sOutput.length; - var sNewOutput = sOutput.substring(nDotIndex); - var nCount = -1; - for (var i=nDotIndex; i>0; i--) { - nCount++; - if ((nCount%3 === 0) && (i !== nDotIndex) && (!bNegative || (i > 1))) { - sNewOutput = sThousandsSeparator + sNewOutput; - } - sNewOutput = sOutput.charAt(i-1) + sNewOutput; - } - sOutput = sNewOutput; - } - - // Prepend prefix - sOutput = (oConfig.prefix) ? oConfig.prefix + sOutput : sOutput; - - // Append suffix - sOutput = (oConfig.suffix) ? sOutput + oConfig.suffix : sOutput; - - return sOutput; - } - // Still not a Number, just return unaltered - else { - return nData; - } - } - }; - - - -/****************************************************************************/ -/****************************************************************************/ -/****************************************************************************/ - -(function () { - -var xPad=function (x, pad, r) -{ - if(typeof r === 'undefined') - { - r=10; - } - for( ; parseInt(x, 10)1; r/=10) { - x = pad.toString() + x; - } - return x.toString(); -}; - - -/** - * The static Date class provides helper functions to deal with data of type Date. - * - * @namespace YAHOO.util - * @requires yahoo - * @class Date - * @static - */ - var Dt = { - formats: { - a: function (d, l) { return l.a[d.getDay()]; }, - A: function (d, l) { return l.A[d.getDay()]; }, - b: function (d, l) { return l.b[d.getMonth()]; }, - B: function (d, l) { return l.B[d.getMonth()]; }, - C: function (d) { return xPad(parseInt(d.getFullYear()/100, 10), 0); }, - d: ['getDate', '0'], - e: ['getDate', ' '], - g: function (d) { return xPad(parseInt(Dt.formats.G(d)%100, 10), 0); }, - G: function (d) { - var y = d.getFullYear(); - var V = parseInt(Dt.formats.V(d), 10); - var W = parseInt(Dt.formats.W(d), 10); - - if(W > V) { - y++; - } else if(W===0 && V>=52) { - y--; - } - - return y; - }, - H: ['getHours', '0'], - I: function (d) { var I=d.getHours()%12; return xPad(I===0?12:I, 0); }, - j: function (d) { - var gmd_1 = new Date('' + d.getFullYear() + '/1/1 GMT'); - var gmdate = new Date('' + d.getFullYear() + '/' + (d.getMonth()+1) + '/' + d.getDate() + ' GMT'); - var ms = gmdate - gmd_1; - var doy = parseInt(ms/60000/60/24, 10)+1; - return xPad(doy, 0, 100); - }, - k: ['getHours', ' '], - l: function (d) { var I=d.getHours()%12; return xPad(I===0?12:I, ' '); }, - m: function (d) { return xPad(d.getMonth()+1, 0); }, - M: ['getMinutes', '0'], - p: function (d, l) { return l.p[d.getHours() >= 12 ? 1 : 0 ]; }, - P: function (d, l) { return l.P[d.getHours() >= 12 ? 1 : 0 ]; }, - s: function (d, l) { return parseInt(d.getTime()/1000, 10); }, - S: ['getSeconds', '0'], - u: function (d) { var dow = d.getDay(); return dow===0?7:dow; }, - U: function (d) { - var doy = parseInt(Dt.formats.j(d), 10); - var rdow = 6-d.getDay(); - var woy = parseInt((doy+rdow)/7, 10); - return xPad(woy, 0); - }, - V: function (d) { - var woy = parseInt(Dt.formats.W(d), 10); - var dow1_1 = (new Date('' + d.getFullYear() + '/1/1')).getDay(); - // First week is 01 and not 00 as in the case of %U and %W, - // so we add 1 to the final result except if day 1 of the year - // is a Monday (then %W returns 01). - // We also need to subtract 1 if the day 1 of the year is - // Friday-Sunday, so the resulting equation becomes: - var idow = woy + (dow1_1 > 4 || dow1_1 <= 1 ? 0 : 1); - if(idow === 53 && (new Date('' + d.getFullYear() + '/12/31')).getDay() < 4) - { - idow = 1; - } - else if(idow === 0) - { - idow = Dt.formats.V(new Date('' + (d.getFullYear()-1) + '/12/31')); - } - - return xPad(idow, 0); - }, - w: 'getDay', - W: function (d) { - var doy = parseInt(Dt.formats.j(d), 10); - var rdow = 7-Dt.formats.u(d); - var woy = parseInt((doy+rdow)/7, 10); - return xPad(woy, 0, 10); - }, - y: function (d) { return xPad(d.getFullYear()%100, 0); }, - Y: 'getFullYear', - z: function (d) { - var o = d.getTimezoneOffset(); - var H = xPad(parseInt(Math.abs(o/60), 10), 0); - var M = xPad(Math.abs(o%60), 0); - return (o>0?'-':'+') + H + M; - }, - Z: function (d) { - var tz = d.toString().replace(/^.*:\d\d( GMT[+-]\d+)? \(?([A-Za-z ]+)\)?\d*$/, '$2').replace(/[a-z ]/g, ''); - if(tz.length > 4) { - tz = Dt.formats.z(d); - } - return tz; - }, - '%': function (d) { return '%'; } - }, - - aggregates: { - c: 'locale', - D: '%m/%d/%y', - F: '%Y-%m-%d', - h: '%b', - n: '\n', - r: 'locale', - R: '%H:%M', - t: '\t', - T: '%H:%M:%S', - x: 'locale', - X: 'locale' - //'+': '%a %b %e %T %Z %Y' - }, - - /** - * Takes a native JavaScript Date and formats to string for display to user. - * - * @method format - * @param oDate {Date} Date. - * @param oConfig {Object} (Optional) Object literal of configuration values: - *
- *
format <String>
- *
- *

- * Any strftime string is supported, such as "%I:%M:%S %p". strftime has several format specifiers defined by the Open group at - * http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html - *

- *

- * PHP added a few of its own, defined at http://www.php.net/strftime - *

- *

- * This javascript implementation supports all the PHP specifiers and a few more. The full list is below: - *

- *
- *
%a
abbreviated weekday name according to the current locale
- *
%A
full weekday name according to the current locale
- *
%b
abbreviated month name according to the current locale
- *
%B
full month name according to the current locale
- *
%c
preferred date and time representation for the current locale
- *
%C
century number (the year divided by 100 and truncated to an integer, range 00 to 99)
- *
%d
day of the month as a decimal number (range 01 to 31)
- *
%D
same as %m/%d/%y
- *
%e
day of the month as a decimal number, a single digit is preceded by a space (range ' 1' to '31')
- *
%F
same as %Y-%m-%d (ISO 8601 date format)
- *
%g
like %G, but without the century
- *
%G
The 4-digit year corresponding to the ISO week number
- *
%h
same as %b
- *
%H
hour as a decimal number using a 24-hour clock (range 00 to 23)
- *
%I
hour as a decimal number using a 12-hour clock (range 01 to 12)
- *
%j
day of the year as a decimal number (range 001 to 366)
- *
%k
hour as a decimal number using a 24-hour clock (range 0 to 23); single digits are preceded by a blank. (See also %H.)
- *
%l
hour as a decimal number using a 12-hour clock (range 1 to 12); single digits are preceded by a blank. (See also %I.)
- *
%m
month as a decimal number (range 01 to 12)
- *
%M
minute as a decimal number
- *
%n
newline character
- *
%p
either `AM' or `PM' according to the given time value, or the corresponding strings for the current locale
- *
%P
like %p, but lower case
- *
%r
time in a.m. and p.m. notation equal to %I:%M:%S %p
- *
%R
time in 24 hour notation equal to %H:%M
- *
%s
number of seconds since the Epoch, ie, since 1970-01-01 00:00:00 UTC
- *
%S
second as a decimal number
- *
%t
tab character
- *
%T
current time, equal to %H:%M:%S
- *
%u
weekday as a decimal number [1,7], with 1 representing Monday
- *
%U
week number of the current year as a decimal number, starting with the - * first Sunday as the first day of the first week
- *
%V
The ISO 8601:1988 week number of the current year as a decimal number, - * range 01 to 53, where week 1 is the first week that has at least 4 days - * in the current year, and with Monday as the first day of the week.
- *
%w
day of the week as a decimal, Sunday being 0
- *
%W
week number of the current year as a decimal number, starting with the - * first Monday as the first day of the first week
- *
%x
preferred date representation for the current locale without the time
- *
%X
preferred time representation for the current locale without the date
- *
%y
year as a decimal number without a century (range 00 to 99)
- *
%Y
year as a decimal number including the century
- *
%z
numerical time zone representation
- *
%Z
time zone name or abbreviation
- *
%%
a literal `%' character
- *
- *
- *
- * @param sLocale {String} (Optional) The locale to use when displaying days of week, - * months of the year, and other locale specific strings. The following locales are - * built in: - *
- *
en
- *
English
- *
en-US
- *
US English
- *
en-GB
- *
British English
- *
en-AU
- *
Australian English (identical to British English)
- *
- * More locales may be added by subclassing of YAHOO.util.DateLocale. - * See YAHOO.util.DateLocale for more information. - * @return {String} Formatted date for display. - * @sa YAHOO.util.DateLocale - */ - format : function (oDate, oConfig, sLocale) { - oConfig = oConfig || {}; - - if(!(oDate instanceof Date)) { - return YAHOO.lang.isValue(oDate) ? oDate : ""; - } - - var format = oConfig.format || "%m/%d/%Y"; - - // Be backwards compatible, support strings that are - // exactly equal to YYYY/MM/DD, DD/MM/YYYY and MM/DD/YYYY - if(format === 'YYYY/MM/DD') { - format = '%Y/%m/%d'; - } else if(format === 'DD/MM/YYYY') { - format = '%d/%m/%Y'; - } else if(format === 'MM/DD/YYYY') { - format = '%m/%d/%Y'; - } - // end backwards compatibility block - - sLocale = sLocale || "en"; - - // Make sure we have a definition for the requested locale, or default to en. - if(!(sLocale in YAHOO.util.DateLocale)) { - if(sLocale.replace(/-[a-zA-Z]+$/, '') in YAHOO.util.DateLocale) { - sLocale = sLocale.replace(/-[a-zA-Z]+$/, ''); - } else { - sLocale = "en"; - } - } - - var aLocale = YAHOO.util.DateLocale[sLocale]; - - var replace_aggs = function (m0, m1) { - var f = Dt.aggregates[m1]; - return (f === 'locale' ? aLocale[m1] : f); - }; - - var replace_formats = function (m0, m1) { - var f = Dt.formats[m1]; - if(typeof f === 'string') { // string => built in date function - return oDate[f](); - } else if(typeof f === 'function') { // function => our own function - return f.call(oDate, oDate, aLocale); - } else if(typeof f === 'object' && typeof f[0] === 'string') { // built in function with padding - return xPad(oDate[f[0]](), f[1]); - } else { - return m1; - } - }; - - // First replace aggregates (run in a loop because an agg may be made up of other aggs) - while(format.match(/%[cDFhnrRtTxX]/)) { - format = format.replace(/%([cDFhnrRtTxX])/g, replace_aggs); - } - - // Now replace formats (do not run in a loop otherwise %%a will be replace with the value of %a) - var str = format.replace(/%([aAbBCdegGHIjklmMpPsSuUVwWyYzZ%])/g, replace_formats); - - replace_aggs = replace_formats = undefined; - - return str; - } - }; - - YAHOO.namespace("YAHOO.util"); - YAHOO.util.Date = Dt; - -/** - * The DateLocale class is a container and base class for all - * localised date strings used by YAHOO.util.Date. It is used - * internally, but may be extended to provide new date localisations. - * - * To create your own DateLocale, follow these steps: - *
    - *
  1. Find an existing locale that matches closely with your needs
    2. - *
  2. Use this as your base class. Use YAHOO.util.DateLocale if nothing - * matches.
    3. - *
  3. Create your own class as an extension of the base class using - * YAHOO.lang.merge, and add your own localisations where needed.
    4. - *
- * See the YAHOO.util.DateLocale['en-US'] and YAHOO.util.DateLocale['en-GB'] - * classes which extend YAHOO.util.DateLocale['en']. - * - * For example, to implement locales for French french and Canadian french, - * we would do the following: - *
    - *
  1. For French french, we have no existing similar locale, so use - * YAHOO.util.DateLocale as the base, and extend it: - * 
    - *      YAHOO.util.DateLocale['fr'] = YAHOO.lang.merge(YAHOO.util.DateLocale, {
- *          a: ['dim', 'lun', 'mar', 'mer', 'jeu', 'ven', 'sam'],
- *          A: ['dimanche', 'lundi', 'mardi', 'mercredi', 'jeudi', 'vendredi', 'samedi'],
- *          b: ['jan', 'fév', 'mar', 'avr', 'mai', 'jun', 'jui', 'aoû', 'sep', 'oct', 'nov', 'déc'],
- *          B: ['janvier', 'février', 'mars', 'avril', 'mai', 'juin', 'juillet', 'août', 'septembre', 'octobre', 'novembre', 'décembre'],
- *          c: '%a %d %b %Y %T %Z',
- *          p: ['', ''],
- *          P: ['', ''],
- *          x: '%d.%m.%Y',
- *          X: '%T'
- *      });
- *
    - *
    2. - *
  2. For Canadian french, we start with French french and change the meaning of \%x: - * 
    - *      YAHOO.util.DateLocale['fr-CA'] = YAHOO.lang.merge(YAHOO.util.DateLocale['fr'], {
- *          x: '%Y-%m-%d'
- *      });
- *
    - *
    3. - *
- * - * With that, you can use your new locales: - * 
- *    var d = new Date("2008/04/22");
- *    YAHOO.util.Date.format(d, {format: "%A, %d %B == %x"}, "fr");
- *
- * will return: - * 
- *    mardi, 22 avril == 22.04.2008
- *
- * And - * 
- *    YAHOO.util.Date.format(d, {format: "%A, %d %B == %x"}, "fr-CA");
- *
- * Will return: - * 
- *   mardi, 22 avril == 2008-04-22
- *
- * @namespace YAHOO.util - * @requires yahoo - * @class DateLocale - */ - YAHOO.util.DateLocale = { - a: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'], - A: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'], - b: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'], - B: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'], - c: '%a %d %b %Y %T %Z', - p: ['AM', 'PM'], - P: ['am', 'pm'], - r: '%I:%M:%S %p', - x: '%d/%m/%y', - X: '%T' - }; - - YAHOO.util.DateLocale['en'] = YAHOO.lang.merge(YAHOO.util.DateLocale, {}); - - YAHOO.util.DateLocale['en-US'] = YAHOO.lang.merge(YAHOO.util.DateLocale['en'], { - c: '%a %d %b %Y %I:%M:%S %p %Z', - x: '%m/%d/%Y', - X: '%I:%M:%S %p' - }); - - YAHOO.util.DateLocale['en-GB'] = YAHOO.lang.merge(YAHOO.util.DateLocale['en'], { - r: '%l:%M:%S %P %Z' - }); - YAHOO.util.DateLocale['en-AU'] = YAHOO.lang.merge(YAHOO.util.DateLocale['en']); - -})(); - -YAHOO.register("datasource", YAHOO.util.DataSource, {version: "2.7.0", build: "1799"});