jssource/src_files/include/javascript/yui3/build/datatype/datatype-date-format.js

   1 /*
   2 Copyright (c) 2010, Yahoo! Inc. All rights reserved.
   3 Code licensed under the BSD License:
   4 http://developer.yahoo.com/yui/license.html
   5 version: 3.3.0
   6 build: 3167
   7 */
   8 YUI.add('datatype-date-format', function(Y) {
   9
  10 /**
  11  * The DataType Utility provides type-conversion and string-formatting
  12  * convenience methods for various JavaScript object types.
  13  *
  14  * @module datatype
  15  */
  16
  17 /**
  18  * Date submodule.
  19  *
  20  * @module datatype
  21  * @submodule datatype-date
  22  */
  23
  24 /**
  25  * Format date submodule implements strftime formatters for javascript based on the
  26  * Open Group specification defined at
  27  * http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html
  28  * This implementation does not include modified conversion specifiers (i.e., Ex and Ox)
  29  *
  30  * @module datatype
  31  * @submodule datatype-date-format
  32  */
  33
  34 /**
  35  * DataType.Date provides a set of utility functions to operate against Date objects.
  36  *
  37  * @class DataType.Date
  38  * @static
  39  */
  40
  41 /**
  42  * Pad a number with leading spaces, zeroes or something else
  43  * @method xPad
  44  * @param x {Number}    The number to be padded
  45  * @param pad {String}  The character to pad the number with
  46  * @param r {Number}    (optional) The base of the pad, eg, 10 implies to two digits, 100 implies to 3 digits.
  47  * @private
  48  */
  49 var xPad=function (x, pad, r)
  50 {
  51         if(typeof r === "undefined")
  52         {
  53                 r=10;
  54         }
  55         pad = pad.toString();
  56         for( ; parseInt(x, 10)<r && r>1; r/=10) {
  57                 x = pad + x;
  58         }
  59         return x.toString();
  60 };
  61
  62 var Dt = {
  63         formats: {
  64                 a: function (d, l) { return l.a[d.getDay()]; },
  65                 A: function (d, l) { return l.A[d.getDay()]; },
  66                 b: function (d, l) { return l.b[d.getMonth()]; },
  67                 B: function (d, l) { return l.B[d.getMonth()]; },
  68                 C: function (d) { return xPad(parseInt(d.getFullYear()/100, 10), 0); },
  69                 d: ["getDate", "0"],
  70                 e: ["getDate", " "],
  71                 g: function (d) { return xPad(parseInt(Dt.formats.G(d)%100, 10), 0); },
  72                 G: function (d) {
  73                                 var y = d.getFullYear();
  74                                 var V = parseInt(Dt.formats.V(d), 10);
  75                                 var W = parseInt(Dt.formats.W(d), 10);
  76
  77                                 if(W > V) {
  78                                         y++;
  79                                 } else if(W===0 && V>=52) {
  80                                         y--;
  81                                 }
  82
  83                                 return y;
  84                         },
  85                 H: ["getHours", "0"],
  86                 I: function (d) { var I=d.getHours()%12; return xPad(I===0?12:I, 0); },
  87                 j: function (d) {
  88                                 var gmd_1 = new Date("" + d.getFullYear() + "/1/1 GMT");
  89                                 var gmdate = new Date("" + d.getFullYear() + "/" + (d.getMonth()+1) + "/" + d.getDate() + " GMT");
  90                                 var ms = gmdate - gmd_1;
  91                                 var doy = parseInt(ms/60000/60/24, 10)+1;
  92                                 return xPad(doy, 0, 100);
  93                         },
  94                 k: ["getHours", " "],
  95                 l: function (d) { var I=d.getHours()%12; return xPad(I===0?12:I, " "); },
  96                 m: function (d) { return xPad(d.getMonth()+1, 0); },
  97                 M: ["getMinutes", "0"],
  98                 p: function (d, l) { return l.p[d.getHours() >= 12 ? 1 : 0 ]; },
  99                 P: function (d, l) { return l.P[d.getHours() >= 12 ? 1 : 0 ]; },
 100                 s: function (d, l) { return parseInt(d.getTime()/1000, 10); },
 101                 S: ["getSeconds", "0"],
 102                 u: function (d) { var dow = d.getDay(); return dow===0?7:dow; },
 103                 U: function (d) {
 104                                 var doy = parseInt(Dt.formats.j(d), 10);
 105                                 var rdow = 6-d.getDay();
 106                                 var woy = parseInt((doy+rdow)/7, 10);
 107                                 return xPad(woy, 0);
 108                         },
 109                 V: function (d) {
 110                                 var woy = parseInt(Dt.formats.W(d), 10);
 111                                 var dow1_1 = (new Date("" + d.getFullYear() + "/1/1")).getDay();
 112                                 // First week is 01 and not 00 as in the case of %U and %W,
 113                                 // so we add 1 to the final result except if day 1 of the year
 114                                 // is a Monday (then %W returns 01).
 115                                 // We also need to subtract 1 if the day 1 of the year is
 116                                 // Friday-Sunday, so the resulting equation becomes:
 117                                 var idow = woy + (dow1_1 > 4 || dow1_1 <= 1 ? 0 : 1);
 118                                 if(idow === 53 && (new Date("" + d.getFullYear() + "/12/31")).getDay() < 4)
 119                                 {
 120                                         idow = 1;
 121                                 }
 122                                 else if(idow === 0)
 123                                 {
 124                                         idow = Dt.formats.V(new Date("" + (d.getFullYear()-1) + "/12/31"));
 125                                 }
 126
 127                                 return xPad(idow, 0);
 128                         },
 129                 w: "getDay",
 130                 W: function (d) {
 131                                 var doy = parseInt(Dt.formats.j(d), 10);
 132                                 var rdow = 7-Dt.formats.u(d);
 133                                 var woy = parseInt((doy+rdow)/7, 10);
 134                                 return xPad(woy, 0, 10);
 135                         },
 136                 y: function (d) { return xPad(d.getFullYear()%100, 0); },
 137                 Y: "getFullYear",
 138                 z: function (d) {
 139                                 var o = d.getTimezoneOffset();
 140                                 var H = xPad(parseInt(Math.abs(o/60), 10), 0);
 141                                 var M = xPad(Math.abs(o%60), 0);
 142                                 return (o>0?"-":"+") + H + M;
 143                         },
 144                 Z: function (d) {
 145                         var tz = d.toString().replace(/^.*:\d\d( GMT[+-]\d+)? \(?([A-Za-z ]+)\)?\d*$/, "$2").replace(/[a-z ]/g, "");
 146                         if(tz.length > 4) {
 147                                 tz = Dt.formats.z(d);
 148                         }
 149                         return tz;
 150                 },
 151                 "%": function (d) { return "%"; }
 152         },
 153
 154         aggregates: {
 155                 c: "locale",
 156                 D: "%m/%d/%y",
 157                 F: "%Y-%m-%d",
 158                 h: "%b",
 159                 n: "\n",
 160                 r: "%I:%M:%S %p",
 161                 R: "%H:%M",
 162                 t: "\t",
 163                 T: "%H:%M:%S",
 164                 x: "locale",
 165                 X: "locale"
 166                 //"+": "%a %b %e %T %Z %Y"
 167         },
 168
 169          /**
 170          * Takes a native JavaScript Date and formats it as a string for display to user.
 171          *
 172          * @for DataType.Date
 173          * @method format
 174          * @param oDate {Date} Date.
 175          * @param oConfig {Object} (Optional) Object literal of configuration values:
 176          *  <dl>
 177          *   <dt>format {String} (Optional)</dt>
 178          *   <dd>
 179          *   <p>
 180          *   Any strftime string is supported, such as "%I:%M:%S %p". strftime has several format specifiers defined by the Open group at
 181          *   <a href="http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html">http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html</a>
 182          *   PHP added a few of its own, defined at <a href="http://www.php.net/strftime">http://www.php.net/strftime</a>
 183          *   </p>
 184          *   <p>
 185          *   This javascript implementation supports all the PHP specifiers and a few more.  The full list is below.
 186          *   </p>
 187          *   <p>
 188          *   If not specified, it defaults to the ISO 8601 standard date format: %Y-%m-%d.
 189      *   This may be overridden by the deprecated Y.config.dateFormat property.
 190          *   </p>
 191          *   <dl>
 192          *      <dt>%a</dt> <dd>abbreviated weekday name according to the current locale</dd>
 193          *      <dt>%A</dt> <dd>full weekday name according to the current locale</dd>
 194          *      <dt>%b</dt> <dd>abbreviated month name according to the current locale</dd>
 195          *      <dt>%B</dt> <dd>full month name according to the current locale</dd>
 196          *      <dt>%c</dt> <dd>preferred date and time representation for the current locale</dd>
 197          *      <dt>%C</dt> <dd>century number (the year divided by 100 and truncated to an integer, range 00 to 99)</dd>
 198          *      <dt>%d</dt> <dd>day of the month as a decimal number (range 01 to 31)</dd>
 199          *      <dt>%D</dt> <dd>same as %m/%d/%y</dd>
 200          *      <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>
 201          *      <dt>%F</dt> <dd>same as %Y-%m-%d (ISO 8601 date format)</dd>
 202          *      <dt>%g</dt> <dd>like %G, but without the century</dd>
 203          *      <dt>%G</dt> <dd>The 4-digit year corresponding to the ISO week number</dd>
 204          *      <dt>%h</dt> <dd>same as %b</dd>
 205          *      <dt>%H</dt> <dd>hour as a decimal number using a 24-hour clock (range 00 to 23)</dd>
 206          *      <dt>%I</dt> <dd>hour as a decimal number using a 12-hour clock (range 01 to 12)</dd>
 207          *      <dt>%j</dt> <dd>day of the year as a decimal number (range 001 to 366)</dd>
 208          *      <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>
 209          *      <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>
 210          *      <dt>%m</dt> <dd>month as a decimal number (range 01 to 12)</dd>
 211          *      <dt>%M</dt> <dd>minute as a decimal number</dd>
 212          *      <dt>%n</dt> <dd>newline character</dd>
 213          *      <dt>%p</dt> <dd>either "AM" or "PM" according to the given time value, or the corresponding strings for the current locale</dd>
 214          *      <dt>%P</dt> <dd>like %p, but lower case</dd>
 215          *      <dt>%r</dt> <dd>time in a.m. and p.m. notation equal to %I:%M:%S %p</dd>
 216          *      <dt>%R</dt> <dd>time in 24 hour notation equal to %H:%M</dd>
 217          *      <dt>%s</dt> <dd>number of seconds since the Epoch, ie, since 1970-01-01 00:00:00 UTC</dd>
 218          *      <dt>%S</dt> <dd>second as a decimal number</dd>
 219          *      <dt>%t</dt> <dd>tab character</dd>
 220          *      <dt>%T</dt> <dd>current time, equal to %H:%M:%S</dd>
 221          *      <dt>%u</dt> <dd>weekday as a decimal number [1,7], with 1 representing Monday</dd>
 222          *      <dt>%U</dt> <dd>week number of the current year as a decimal number, starting with the
 223          *                      first Sunday as the first day of the first week</dd>
 224          *      <dt>%V</dt> <dd>The ISO 8601:1988 week number of the current year as a decimal number,
 225          *                      range 01 to 53, where week 1 is the first week that has at least 4 days
 226          *                      in the current year, and with Monday as the first day of the week.</dd>
 227          *      <dt>%w</dt> <dd>day of the week as a decimal, Sunday being 0</dd>
 228          *      <dt>%W</dt> <dd>week number of the current year as a decimal number, starting with the
 229          *                      first Monday as the first day of the first week</dd>
 230          *      <dt>%x</dt> <dd>preferred date representation for the current locale without the time</dd>
 231          *      <dt>%X</dt> <dd>preferred time representation for the current locale without the date</dd>
 232          *      <dt>%y</dt> <dd>year as a decimal number without a century (range 00 to 99)</dd>
 233          *      <dt>%Y</dt> <dd>year as a decimal number including the century</dd>
 234          *      <dt>%z</dt> <dd>numerical time zone representation</dd>
 235          *      <dt>%Z</dt> <dd>time zone name or abbreviation</dd>
 236          *      <dt>%%</dt> <dd>a literal "%" character</dd>
 237          *   </dl>
 238          *  </dd>
 239          *  <dt>locale {String} (Deprecated, optional)</dt>
 240          *  <dd>
 241      *   <b>Deprecated - use Y.config.lang instead, which provides access to a much larger set of built-in languages.</b>
 242          *   The locale to use when displaying days of week, months of the year, and other locale specific
 243          *   strings. If not specified, this defaults to "en" (though this may be overridden by the deprecated Y.config.locale).
 244          *   The following locales are built in:
 245          *   <dl>
 246          *    <dt>en</dt>
 247          *    <dd>English</dd>
 248          *    <dt>en-US</dt>
 249          *    <dd>US English</dd>
 250          *    <dt>en-GB</dt>
 251          *    <dd>British English</dd>
 252          *    <dt>en-AU</dt>
 253          *    <dd>Australian English (identical to British English)</dd>
 254          *   </dl>
 255          *   More locales may be added by subclassing of the deprecated Y.DataType.Date.Locale["en"].
 256          *   See Y.DataType.Date.Locale for more information.
 257          *  </dd>
 258          * </dl>
 259          * @return {String} Formatted date for display.
 260          */
 261         format : function (oDate, oConfig) {
 262                 oConfig = oConfig || {};
 263
 264                 if(!Y.Lang.isDate(oDate)) {
 265                         return Y.Lang.isValue(oDate) ? oDate : "";
 266                 }
 267
 268                 var format, resources, compatMode, sLocale, LOCALE;
 269
 270         // Y.config.dateFormat is deprecated - remove from YUI 3.2
 271         format = oConfig.format || Y.config.dateFormat  || "%Y-%m-%d";
 272         // compatMode supports deprecated features - remove from YUI 3.2
 273         compatMode = Y.Lang.isUndefined(Y.config.lang) && (Y.Lang.isValue(oConfig.locale) || Y.Lang.isValue(Y.config.locale));
 274         if (compatMode) {
 275                         sLocale = oConfig.locale || Y.config.locale;
 276                         LOCALE = Y.DataType.Date.Locale;
 277             sLocale = sLocale.replace(/_/g, "-");
 278
 279             // Make sure we have a definition for the requested locale, or default to en.
 280             if(!LOCALE[sLocale]) {
 281                 var tmpLocale = sLocale.replace(/-[a-zA-Z]+$/, "");
 282                 if(tmpLocale in LOCALE) {
 283                     sLocale = tmpLocale;
 284                 } else if(Y.config.locale in LOCALE) {
 285                     sLocale = Y.config.locale;
 286                 } else {
 287                     sLocale = "en";
 288                 }
 289             }
 290
 291             resources = LOCALE[sLocale];
 292         } else {
 293             resources = Y.Intl.get('datatype-date-format');
 294         }
 295
 296                 var replace_aggs = function (m0, m1) {
 297                         if (compatMode && m1 === "r") {
 298                             return resources[m1];
 299                         }
 300                         var f = Dt.aggregates[m1];
 301                         return (f === "locale" ? resources[m1] : f);
 302                 };
 303
 304                 var replace_formats = function (m0, m1) {
 305                         var f = Dt.formats[m1];
 306                         switch(Y.Lang.type(f)) {
 307                                 case "string":                                  // string => built in date function
 308                                         return oDate[f]();
 309                                 case "function":                                // function => our own function
 310                                         return f.call(oDate, oDate, resources);
 311                                 case "array":                                   // built in function with padding
 312                                         if(Y.Lang.type(f[0]) === "string") {
 313                                                 return xPad(oDate[f[0]](), f[1]);
 314                                         } // no break; (fall through to default:)
 315                                 default:
 316                     // Y.config.dateFormat is deprecated - remove from YUI 3.2
 317                                         return m1;
 318                         }
 319                 };
 320
 321                 // First replace aggregates (run in a loop because an agg may be made up of other aggs)
 322                 while(format.match(/%[cDFhnrRtTxX]/)) {
 323                         format = format.replace(/%([cDFhnrRtTxX])/g, replace_aggs);
 324                 }
 325
 326                 // Now replace formats (do not run in a loop otherwise %%a will be replace with the value of %a)
 327                 var str = format.replace(/%([aAbBCdegGHIjklmMpPsSuUVwWyYzZ%])/g, replace_formats);
 328
 329                 replace_aggs = replace_formats = undefined;
 330
 331                 return str;
 332         }
 333 };
 334
 335 Y.mix(Y.namespace("DataType.Date"), Dt);
 336 /**
 337  * @module datatype
 338 */
 339
 340 /**
 341  * The Date.Locale class is a container for all localised date strings
 342  * used by Y.DataType.Date. It is used internally, but may be extended
 343  * to provide new date localisations.
 344  *
 345  * To create your own Locale, follow these steps:
 346  * <ol>
 347  *  <li>Find an existing locale that matches closely with your needs</li>
 348  *  <li>Use this as your base class.  Use Y.DataType.Date.Locale["en"] if nothing
 349  *   matches.</li>
 350  *  <li>Create your own class as an extension of the base class using
 351  *   Y.merge, and add your own localisations where needed.</li>
 352  * </ol>
 353  * See the Y.DataType.Date.Locale["en-US"] and Y.DataType.Date.Locale["en-GB"]
 354  * classes which extend Y.DataType.Date.Locale["en"].
 355  *
 356  * For example, to implement locales for French french and Canadian french,
 357  * we would do the following:
 358  * <ol>
 359  *  <li>For French french, we have no existing similar locale, so use
 360  *   Y.DataType.Date.Locale["en"] as the base, and extend it:
 361  *   <pre>
 362  *      Y.DataType.Date.Locale["fr"] = Y.merge(Y.DataType.Date.Locale, {
 363  *          a: ["dim", "lun", "mar", "mer", "jeu", "ven", "sam"],
 364  *          A: ["dimanche", "lundi", "mardi", "mercredi", "jeudi", "vendredi", "samedi"],
 365  *          b: ["jan", "f&eacute;v", "mar", "avr", "mai", "jun", "jui", "ao&ucirc;", "sep", "oct", "nov", "d&eacute;c"],
 366  *          B: ["janvier", "f&eacute;vrier", "mars", "avril", "mai", "juin", "juillet", "ao&ucirc;t", "septembre", "octobre", "novembre", "d&eacute;cembre"],
 367  *          c: "%a %d %b %Y %T %Z",
 368  *          p: ["", ""],
 369  *          P: ["", ""],
 370  *          x: "%d.%m.%Y",
 371  *          X: "%T"
 372  *      });
 373  *   </pre>
 374  *  </li>
 375  *  <li>For Canadian french, we start with French french and change the meaning of \%x:
 376  *   <pre>
 377  *      Y.DataType.Date.Locale["fr-CA"] = Y.merge(Y.DataType.Date.Locale["fr"], {
 378  *          x: "%Y-%m-%d"
 379  *      });
 380  *   </pre>
 381  *  </li>
 382  * </ol>
 383  *
 384  * With that, you can use your new locales:
 385  * <pre>
 386  *    var d = new Date("2008/04/22");
 387  *    Y.DataType.Date.format(d, { format: "%A, %d %B == %x", locale: "fr" });
 388  * </pre>
 389  * will return:
 390  * <pre>
 391  *    mardi, 22 avril == 22.04.2008
 392  * </pre>
 393  * And
 394  * <pre>
 395  *    Y.DataType.Date.format(d, {format: "%A, %d %B == %x", locale: "fr-CA" });
 396  * </pre>
 397  * Will return:
 398  * <pre>
 399  *   mardi, 22 avril == 2008-04-22
 400  * </pre>
 401  * @requires oop
 402  * @class DataType.Date.Locale
 403  * @static
 404  * @deprecated - use Y.config.lang to request one of many built-in languages instead.
 405  */
 406 var YDateEn = {
 407         a: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"],
 408         A: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"],
 409         b: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"],
 410         B: ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"],
 411         c: "%a %d %b %Y %T %Z",
 412         p: ["AM", "PM"],
 413         P: ["am", "pm"],
 414         r: "%I:%M:%S %p",
 415         x: "%d/%m/%y",
 416         X: "%T"
 417 };
 418
 419 Y.namespace("DataType.Date.Locale");
 420
 421 Y.DataType.Date.Locale["en"] = YDateEn;
 422
 423 Y.DataType.Date.Locale["en-US"] = Y.merge(YDateEn, {
 424         c: "%a %d %b %Y %I:%M:%S %p %Z",
 425         x: "%m/%d/%Y",
 426         X: "%I:%M:%S %p"
 427 });
 428
 429 Y.DataType.Date.Locale["en-GB"] = Y.merge(YDateEn, {
 430         r: "%l:%M:%S %P %Z"
 431 });
 432 Y.DataType.Date.Locale["en-AU"] = Y.merge(YDateEn);
 433
 434
 435
 436
 437 }, '3.3.0' ,{requires:['yui-base'], lang:['ar','ar-JO','ca','ca-ES','da','da-DK','de','de-AT','de-DE','el','el-GR','en','en-AU','en-CA','en-GB','en-IE','en-IN','en-JO','en-MY','en-NZ','en-PH','en-SG','en-US','es','es-AR','es-BO','es-CL','es-CO','es-EC','es-ES','es-MX','es-PE','es-PY','es-US','es-UY','es-VE','fi','fi-FI','fr','fr-BE','fr-CA','fr-FR','hi','hi-IN','id','id-ID','it','it-IT','ja','ja-JP','ko','ko-KR','ms','ms-MY','nb','nb-NO','nl','nl-BE','nl-NL','pl','pl-PL','pt','pt-BR','ro','ro-RO','ru','ru-RU','sv','sv-SE','th','th-TH','tr','tr-TR','vi','vi-VN','zh-Hans','zh-Hans-CN','zh-Hant','zh-Hant-HK','zh-Hant-TW']});