2 Copyright (c) 2009, Yahoo! Inc. All rights reserved.
3 Code licensed under the BSD License:
4 http://developer.yahoo.net/yui/license.txt
8 YUI.add('datatype-number-parse', function(Y) {
11 * Parse number submodule.
14 * @submodule datatype-number-parse
15 * @for DataType.Number
20 Y.mix(Y.namespace("DataType.Number"), {
22 * Converts data to type Number.
25 * @param data {String | Number | Boolean} Data to convert. The following
26 * values return as null: null, undefined, NaN, "".
27 * @return {Number} A number, or null.
29 parse: function(data) {
30 var number = (data === null) ? data : +data;
31 if(LANG.isNumber(number)) {
40 // Add Parsers shortcut
41 Y.namespace("Parsers").number = Y.DataType.Number.parse;
47 YUI.add('datatype-number-format', function(Y) {
53 * @submodule datatype-number
57 * Format number submodule.
60 * @submodule datatype-number-format
64 * DataType.Number provides a set of utility functions to operate against Number objects.
66 * @class DataType.Number
71 Y.mix(Y.namespace("DataType.Number"), {
73 * Takes a Number and formats to string for display to user.
76 * @param data {Number} Number.
77 * @param config {Object} (Optional) Optional configuration values:
79 * <dt>prefix {String}</dd>
80 * <dd>String prepended before each number, like a currency designator "$"</dd>
81 * <dt>decimalPlaces {Number}</dd>
82 * <dd>Number of decimal places to round. Must be a number 0 to 20.</dd>
83 * <dt>decimalSeparator {String}</dd>
84 * <dd>Decimal separator</dd>
85 * <dt>thousandsSeparator {String}</dd>
86 * <dd>Thousands separator</dd>
87 * <dt>suffix {String}</dd>
88 * <dd>String appended after each number, like " items" (note the space)</dd>
90 * @return {String} Formatted number for display. Note, the following values
91 * return as "": null, undefined, NaN, "".
93 format: function(data, config) {
94 if(LANG.isNumber(data)) {
95 config = config || {};
97 var isNeg = (data < 0),
99 decPlaces = config.decimalPlaces,
100 decSep = config.decimalSeparator || ".",
101 thouSep = config.thousandsSeparator,
106 if(LANG.isNumber(decPlaces) && (decPlaces >= 0) && (decPlaces <= 20)) {
107 // Round to the correct decimal place
108 output = data.toFixed(decPlaces);
113 output = output.replace(".", decSep);
116 // Add the thousands separator
118 // Find the dot or where it would be
119 decIndex = output.lastIndexOf(decSep);
120 decIndex = (decIndex > -1) ? decIndex : output.length;
121 // Start with the dot and everything to the right
122 newOutput = output.substring(decIndex);
123 // Working left, every third time add a separator, every time add a digit
124 for (count = 0, i=decIndex; i>0; i--) {
125 if ((count%3 === 0) && (i !== decIndex) && (!isNeg || (i > 1))) {
126 newOutput = thouSep + newOutput;
128 newOutput = output.charAt(i-1) + newOutput;
135 output = (config.prefix) ? config.prefix + output : output;
138 output = (config.suffix) ? output + config.suffix : output;
142 // Not a Number, just return as string
144 return (LANG.isValue(data) && data.toString) ? data.toString() : "";
155 YUI.add('datatype-number', function(Y){}, '3.0.0' ,{use:['datatype-number-parse', 'datatype-number-format']});
158 YUI.add('datatype-date-parse', function(Y) {
161 * Parse number submodule.
164 * @submodule datatype-date-parse
169 Y.mix(Y.namespace("DataType.Date"), {
171 * Converts data to type Date.
174 * @param data {String | Number} Data to convert. Values supported by the Date constructor are supported.
175 * @return {Date} A Date, or null.
177 parse: function(data) {
181 if(!(LANG.isDate(data))) {
182 date = new Date(data);
189 if(LANG.isDate(date) && (date != "Invalid Date") && !isNaN(date)) { // Workaround for bug 2527965
198 // Add Parsers shortcut
199 Y.namespace("Parsers").date = Y.DataType.Date.parse;
205 YUI.add('datatype-date-format', function(Y) {
208 * The DataType Utility provides type-conversion and string-formatting
209 * convenience methods for various JavaScript object types.
218 * @submodule datatype-date
222 * Format date submodule implements strftime formatters for javascript based on the
223 * Open Group specification defined at
224 * http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html
225 * This implementation does not include modified conversion specifiers (i.e., Ex and Ox)
228 * @submodule datatype-date-format
232 * DataType.Date provides a set of utility functions to operate against Date objects.
234 * @class DataType.Date
239 * Pad a number with leading spaces, zeroes or something else
241 * @param x {Number} The number to be padded
242 * @param pad {String} The character to pad the number with
243 * @param r {Number} (optional) The base of the pad, eg, 10 implies to two digits, 100 implies to 3 digits.
246 var xPad=function (x, pad, r)
248 if(typeof r === "undefined")
252 pad = pad.toString();
253 for( ; parseInt(x, 10)<r && r>1; r/=10) {
260 * Default date format.
263 * @property dateFormat
267 Y.config.dateFormat = Y.config.dateFormat || "%Y-%m-%d";
270 * Default locale for the YUI instance.
276 Y.config.locale = Y.config.locale || "en";
280 a: function (d, l) { return l.a[d.getDay()]; },
281 A: function (d, l) { return l.A[d.getDay()]; },
282 b: function (d, l) { return l.b[d.getMonth()]; },
283 B: function (d, l) { return l.B[d.getMonth()]; },
284 C: function (d) { return xPad(parseInt(d.getFullYear()/100, 10), 0); },
287 g: function (d) { return xPad(parseInt(Dt.formats.G(d)%100, 10), 0); },
289 var y = d.getFullYear();
290 var V = parseInt(Dt.formats.V(d), 10);
291 var W = parseInt(Dt.formats.W(d), 10);
295 } else if(W===0 && V>=52) {
301 H: ["getHours", "0"],
302 I: function (d) { var I=d.getHours()%12; return xPad(I===0?12:I, 0); },
304 var gmd_1 = new Date("" + d.getFullYear() + "/1/1 GMT");
305 var gmdate = new Date("" + d.getFullYear() + "/" + (d.getMonth()+1) + "/" + d.getDate() + " GMT");
306 var ms = gmdate - gmd_1;
307 var doy = parseInt(ms/60000/60/24, 10)+1;
308 return xPad(doy, 0, 100);
310 k: ["getHours", " "],
311 l: function (d) { var I=d.getHours()%12; return xPad(I===0?12:I, " "); },
312 m: function (d) { return xPad(d.getMonth()+1, 0); },
313 M: ["getMinutes", "0"],
314 p: function (d, l) { return l.p[d.getHours() >= 12 ? 1 : 0 ]; },
315 P: function (d, l) { return l.P[d.getHours() >= 12 ? 1 : 0 ]; },
316 s: function (d, l) { return parseInt(d.getTime()/1000, 10); },
317 S: ["getSeconds", "0"],
318 u: function (d) { var dow = d.getDay(); return dow===0?7:dow; },
320 var doy = parseInt(Dt.formats.j(d), 10);
321 var rdow = 6-d.getDay();
322 var woy = parseInt((doy+rdow)/7, 10);
326 var woy = parseInt(Dt.formats.W(d), 10);
327 var dow1_1 = (new Date("" + d.getFullYear() + "/1/1")).getDay();
328 // First week is 01 and not 00 as in the case of %U and %W,
329 // so we add 1 to the final result except if day 1 of the year
330 // is a Monday (then %W returns 01).
331 // We also need to subtract 1 if the day 1 of the year is
332 // Friday-Sunday, so the resulting equation becomes:
333 var idow = woy + (dow1_1 > 4 || dow1_1 <= 1 ? 0 : 1);
334 if(idow === 53 && (new Date("" + d.getFullYear() + "/12/31")).getDay() < 4)
340 idow = Dt.formats.V(new Date("" + (d.getFullYear()-1) + "/12/31"));
343 return xPad(idow, 0);
347 var doy = parseInt(Dt.formats.j(d), 10);
348 var rdow = 7-Dt.formats.u(d);
349 var woy = parseInt((doy+rdow)/7, 10);
350 return xPad(woy, 0, 10);
352 y: function (d) { return xPad(d.getFullYear()%100, 0); },
355 var o = d.getTimezoneOffset();
356 var H = xPad(parseInt(Math.abs(o/60), 10), 0);
357 var M = xPad(Math.abs(o%60), 0);
358 return (o>0?"-":"+") + H + M;
361 var tz = d.toString().replace(/^.*:\d\d( GMT[+-]\d+)? \(?([A-Za-z ]+)\)?\d*$/, "$2").replace(/[a-z ]/g, "");
363 tz = Dt.formats.z(d);
367 "%": function (d) { return "%"; }
382 //"+": "%a %b %e %T %Z %Y"
386 * Takes a native JavaScript Date and formats it as a string for display to user.
390 * @param oDate {Date} Date.
391 * @param oConfig {Object} (Optional) Object literal of configuration values:
393 * <dt>format {String} (Optional)</dt>
396 * Any strftime string is supported, such as "%I:%M:%S %p". strftime has several format specifiers defined by the Open group at
397 * <a href="http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html">http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html</a>
398 * PHP added a few of its own, defined at <a href="http://www.php.net/strftime">http://www.php.net/strftime</a>
401 * This javascript implementation supports all the PHP specifiers and a few more. The full list is below.
404 * If not specified, it defaults to the ISO8601 standard date format: %Y-%m-%d. This may be overridden by changing Y.config.dateFormat
407 * <dt>%a</dt> <dd>abbreviated weekday name according to the current locale</dd>
408 * <dt>%A</dt> <dd>full weekday name according to the current locale</dd>
409 * <dt>%b</dt> <dd>abbreviated month name according to the current locale</dd>
410 * <dt>%B</dt> <dd>full month name according to the current locale</dd>
411 * <dt>%c</dt> <dd>preferred date and time representation for the current locale</dd>
412 * <dt>%C</dt> <dd>century number (the year divided by 100 and truncated to an integer, range 00 to 99)</dd>
413 * <dt>%d</dt> <dd>day of the month as a decimal number (range 01 to 31)</dd>
414 * <dt>%D</dt> <dd>same as %m/%d/%y</dd>
415 * <dt>%e</dt> <dd>day of the month as a decimal number, a single digit is preceded by a space (range " 1" to "31")</dd>
416 * <dt>%F</dt> <dd>same as %Y-%m-%d (ISO 8601 date format)</dd>
417 * <dt>%g</dt> <dd>like %G, but without the century</dd>
418 * <dt>%G</dt> <dd>The 4-digit year corresponding to the ISO week number</dd>
419 * <dt>%h</dt> <dd>same as %b</dd>
420 * <dt>%H</dt> <dd>hour as a decimal number using a 24-hour clock (range 00 to 23)</dd>
421 * <dt>%I</dt> <dd>hour as a decimal number using a 12-hour clock (range 01 to 12)</dd>
422 * <dt>%j</dt> <dd>day of the year as a decimal number (range 001 to 366)</dd>
423 * <dt>%k</dt> <dd>hour as a decimal number using a 24-hour clock (range 0 to 23); single digits are preceded by a blank. (See also %H.)</dd>
424 * <dt>%l</dt> <dd>hour as a decimal number using a 12-hour clock (range 1 to 12); single digits are preceded by a blank. (See also %I.) </dd>
425 * <dt>%m</dt> <dd>month as a decimal number (range 01 to 12)</dd>
426 * <dt>%M</dt> <dd>minute as a decimal number</dd>
427 * <dt>%n</dt> <dd>newline character</dd>
428 * <dt>%p</dt> <dd>either "AM" or "PM" according to the given time value, or the corresponding strings for the current locale</dd>
429 * <dt>%P</dt> <dd>like %p, but lower case</dd>
430 * <dt>%r</dt> <dd>time in a.m. and p.m. notation equal to %I:%M:%S %p</dd>
431 * <dt>%R</dt> <dd>time in 24 hour notation equal to %H:%M</dd>
432 * <dt>%s</dt> <dd>number of seconds since the Epoch, ie, since 1970-01-01 00:00:00 UTC</dd>
433 * <dt>%S</dt> <dd>second as a decimal number</dd>
434 * <dt>%t</dt> <dd>tab character</dd>
435 * <dt>%T</dt> <dd>current time, equal to %H:%M:%S</dd>
436 * <dt>%u</dt> <dd>weekday as a decimal number [1,7], with 1 representing Monday</dd>
437 * <dt>%U</dt> <dd>week number of the current year as a decimal number, starting with the
438 * first Sunday as the first day of the first week</dd>
439 * <dt>%V</dt> <dd>The ISO 8601:1988 week number of the current year as a decimal number,
440 * range 01 to 53, where week 1 is the first week that has at least 4 days
441 * in the current year, and with Monday as the first day of the week.</dd>
442 * <dt>%w</dt> <dd>day of the week as a decimal, Sunday being 0</dd>
443 * <dt>%W</dt> <dd>week number of the current year as a decimal number, starting with the
444 * first Monday as the first day of the first week</dd>
445 * <dt>%x</dt> <dd>preferred date representation for the current locale without the time</dd>
446 * <dt>%X</dt> <dd>preferred time representation for the current locale without the date</dd>
447 * <dt>%y</dt> <dd>year as a decimal number without a century (range 00 to 99)</dd>
448 * <dt>%Y</dt> <dd>year as a decimal number including the century</dd>
449 * <dt>%z</dt> <dd>numerical time zone representation</dd>
450 * <dt>%Z</dt> <dd>time zone name or abbreviation</dd>
451 * <dt>%%</dt> <dd>a literal "%" character</dd>
454 * <dt>locale {String} (Optional)</dt>
456 * The locale to use when displaying days of week, months of the year, and other locale specific
457 * strings. If not specified, this defaults to "en" (though this may be overridden by changing Y.config.locale).
458 * The following locales are built in:
463 * <dd>US English</dd>
465 * <dd>British English</dd>
467 * <dd>Australian English (identical to British English)</dd>
469 * More locales may be added by subclassing of Y.DataType.Date.Locale["en"].
470 * See Y.DataType.Date.Locale for more information.
473 * @return {String} Formatted date for display.
475 format : function (oDate, oConfig) {
476 oConfig = oConfig || {};
478 if(!Y.Lang.isDate(oDate)) {
479 return Y.Lang.isValue(oDate) ? oDate : "";
482 var format = oConfig.format || Y.config.dateFormat,
483 sLocale = oConfig.locale || Y.config.locale,
484 LOCALE = Y.DataType.Date.Locale;
486 sLocale = sLocale.replace(/_/g, "-");
488 // Make sure we have a definition for the requested locale, or default to en.
489 if(!LOCALE[sLocale]) {
490 var tmpLocale = sLocale.replace(/-[a-zA-Z]+$/, "");
491 if(tmpLocale in LOCALE) {
493 } else if(Y.config.locale in LOCALE) {
494 sLocale = Y.config.locale;
500 var aLocale = LOCALE[sLocale];
502 var replace_aggs = function (m0, m1) {
503 var f = Dt.aggregates[m1];
504 return (f === "locale" ? aLocale[m1] : f);
507 var replace_formats = function (m0, m1) {
508 var f = Dt.formats[m1];
509 switch(Y.Lang.type(f)) {
510 case "string": // string => built in date function
512 case "function": // function => our own function
513 return f.call(oDate, oDate, aLocale);
514 case "array": // built in function with padding
515 if(Y.Lang.type(f[0]) === "string") {
516 return xPad(oDate[f[0]](), f[1]);
517 } // no break; (fall through to default:)
523 // First replace aggregates (run in a loop because an agg may be made up of other aggs)
524 while(format.match(/%[cDFhnrRtTxX]/)) {
525 format = format.replace(/%([cDFhnrRtTxX])/g, replace_aggs);
528 // Now replace formats (do not run in a loop otherwise %%a will be replace with the value of %a)
529 var str = format.replace(/%([aAbBCdegGHIjklmMpPsSuUVwWyYzZ%])/g, replace_formats);
531 replace_aggs = replace_formats = undefined;
537 Y.mix(Y.namespace("DataType.Date"), Dt);
544 * The Date.Locale class is a container for all localised date strings
545 * used by Y.DataType.Date. It is used internally, but may be extended
546 * to provide new date localisations.
548 * To create your own Locale, follow these steps:
550 * <li>Find an existing locale that matches closely with your needs</li>
551 * <li>Use this as your base class. Use Y.DataType.Date.Locale["en"] if nothing
553 * <li>Create your own class as an extension of the base class using
554 * Y.merge, and add your own localisations where needed.</li>
556 * See the Y.DataType.Date.Locale["en-US"] and Y.DataType.Date.Locale["en-GB"]
557 * classes which extend Y.DataType.Date.Locale["en"].
559 * For example, to implement locales for French french and Canadian french,
560 * we would do the following:
562 * <li>For French french, we have no existing similar locale, so use
563 * Y.DataType.Date.Locale["en"] as the base, and extend it:
565 * Y.DataType.Date.Locale["fr"] = Y.merge(Y.DataType.Date.Locale, {
566 * a: ["dim", "lun", "mar", "mer", "jeu", "ven", "sam"],
567 * A: ["dimanche", "lundi", "mardi", "mercredi", "jeudi", "vendredi", "samedi"],
568 * b: ["jan", "fév", "mar", "avr", "mai", "jun", "jui", "aoû", "sep", "oct", "nov", "déc"],
569 * B: ["janvier", "février", "mars", "avril", "mai", "juin", "juillet", "août", "septembre", "octobre", "novembre", "décembre"],
570 * c: "%a %d %b %Y %T %Z",
578 * <li>For Canadian french, we start with French french and change the meaning of \%x:
580 * Y.DataType.Date.Locale["fr-CA"] = Y.merge(Y.DataType.Date.Locale["fr"], {
587 * With that, you can use your new locales:
589 * var d = new Date("2008/04/22");
590 * Y.DataType.Date.format(d, { format: "%A, %d %B == %x", locale: "fr" });
594 * mardi, 22 avril == 22.04.2008
598 * Y.DataType.Date.format(d, {format: "%A, %d %B == %x", locale: "fr-CA" });
602 * mardi, 22 avril == 2008-04-22
605 * @class DataType.Date.Locale
609 a: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"],
610 A: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"],
611 b: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"],
612 B: ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"],
613 c: "%a %d %b %Y %T %Z",
621 Y.namespace("DataType.Date.Locale");
623 Y.DataType.Date.Locale["en"] = YDateEn;
625 Y.DataType.Date.Locale["en-US"] = Y.merge(YDateEn, {
626 c: "%a %d %b %Y %I:%M:%S %p %Z",
631 Y.DataType.Date.Locale["en-GB"] = Y.merge(YDateEn, {
634 Y.DataType.Date.Locale["en-AU"] = Y.merge(YDateEn);
644 YUI.add('datatype-date', function(Y){}, '3.0.0' ,{use:['datatype-date-parse', 'datatype-date-format']});
647 YUI.add('datatype-xml-parse', function(Y) {
650 * Parse XML submodule.
653 * @submodule datatype-xml-parse
659 Y.mix(Y.namespace("DataType.XML"), {
661 * Converts data to type XMLDocument.
664 * @param data {String} Data to convert.
665 * @return {XMLDoc} XML Document.
667 parse: function(data) {
669 if(LANG.isString(data)) {
671 if(!LANG.isUndefined(DOMParser)) {
672 xmlDoc = new DOMParser().parseFromString(data, "text/xml");
677 if(!LANG.isUndefined(ActiveXObject)) {
678 xmlDoc = new ActiveXObject("Microsoft.XMLDOM");
679 xmlDoc.async = false;
680 xmlDoc.loadXML(data);
688 if( (LANG.isNull(xmlDoc)) || (LANG.isNull(xmlDoc.documentElement)) || (xmlDoc.documentElement.nodeName === "parsererror") ) {
695 // Add Parsers shortcut
696 Y.namespace("Parsers").xml = Y.DataType.XML.parse;
703 YUI.add('datatype-xml-format', function(Y) {
706 * Format XML submodule.
709 * @submodule datatype-xml-format
716 * @submodule datatype-xml
720 * DataType.XML provides a set of utility functions to operate against XML documents.
722 * @class DataType.XML
727 Y.mix(Y.namespace("DataType.XML"), {
729 * Converts data to type XMLDocument.
732 * @param data {XMLDoc} Data to convert.
733 * @return {String} String.
735 format: function(data) {
737 if(!LANG.isUndefined(XMLSerializer)) {
738 return (new XMLSerializer()).serializeToString(data);
742 if(data && data.xml) {
746 return (LANG.isValue(data) && data.toString) ? data.toString() : "";
759 YUI.add('datatype-xml', function(Y){}, '3.0.0' ,{use:['datatype-xml-parse', 'datatype-xml-format']});
764 YUI.add('datatype', function(Y){}, '3.0.0' ,{use:['datatype-number', 'datatype-date', 'datatype-xml']});