/** - * @class Date - * - * The date parsing and formatting syntax contains a subset of - * PHP's date() function, and the formats that are - * supported will provide results equivalent to their PHP versions. - * - * The following is a list of all currently supported formats: - *+ +-Format Description Example returned values ------- ----------------------------------------------------------------------- ----------------------- - d Day of the month, 2 digits with leading zeros 01 to 31 - D A short textual representation of the day of the week Mon to Sun - j Day of the month without leading zeros 1 to 31 - l A full textual representation of the day of the week Sunday to Saturday - N ISO-8601 numeric representation of the day of the week 1 (for Monday) through 7 (for Sunday) - S English ordinal suffix for the day of the month, 2 characters st, nd, rd or th. Works well with j - w Numeric representation of the day of the week 0 (for Sunday) to 6 (for Saturday) - z The day of the year (starting from 0) 0 to 364 (365 in leap years) - W ISO-8601 week number of year, weeks starting on Monday 01 to 53 - F A full textual representation of a month, such as January or March January to December - m Numeric representation of a month, with leading zeros 01 to 12 - M A short textual representation of a month Jan to Dec - n Numeric representation of a month, without leading zeros 1 to 12 - t Number of days in the given month 28 to 31 - L Whether it's a leap year 1 if it is a leap year, 0 otherwise. - o ISO-8601 year number (identical to (Y), but if the ISO week number (W) Examples: 1998 or 2004 - belongs to the previous or next year, that year is used instead) - Y A full numeric representation of a year, 4 digits Examples: 1999 or 2003 - y A two digit representation of a year Examples: 99 or 03 - a Lowercase Ante meridiem and Post meridiem am or pm - A Uppercase Ante meridiem and Post meridiem AM or PM - g 12-hour format of an hour without leading zeros 1 to 12 - G 24-hour format of an hour without leading zeros 0 to 23 - h 12-hour format of an hour with leading zeros 01 to 12 - H 24-hour format of an hour with leading zeros 00 to 23 - i Minutes, with leading zeros 00 to 59 - s Seconds, with leading zeros 00 to 59 - u Decimal fraction of a second Examples: - (minimum 1 digit, arbitrary number of digits allowed) 001 (i.e. 0.001s) or - 100 (i.e. 0.100s) or - 999 (i.e. 0.999s) or - 999876543210 (i.e. 0.999876543210s) - O Difference to Greenwich time (GMT) in hours and minutes Example: +1030 - P Difference to Greenwich time (GMT) with colon between hours and minutes Example: -08:00 - T Timezone abbreviation of the machine running the code Examples: EST, MDT, PDT ... - Z Timezone offset in seconds (negative if west of UTC, positive if east) -43200 to 50400 - c ISO 8601 date - Notes: Examples: - 1) If unspecified, the month / day defaults to the current month / day, 1991 or - the time defaults to midnight, while the timezone defaults to the 1992-10 or - browser's timezone. If a time is specified, it must include both hours 1993-09-20 or - and minutes. The "T" delimiter, seconds, milliseconds and timezone 1994-08-19T16:20+01:00 or - are optional. 1995-07-18T17:21:28-02:00 or - 2) The decimal fraction of a second, if specified, must contain at 1996-06-17T18:22:29.98765+03:00 or - least 1 digit (there is no limit to the maximum number 1997-05-16T19:23:30,12345-0400 or - of digits allowed), and may be delimited by either a '.' or a ',' 1998-04-15T20:24:31.2468Z or - Refer to the examples on the right for the various levels of 1999-03-14T20:24:32Z or - date-time granularity which are supported, or see 2000-02-13T21:25:33 - http://www.w3.org/TR/NOTE-datetime for more info. 2001-01-12 22:26:34 - U Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) 1193432466 or -2138434463 - M$ Microsoft AJAX serialized dates \/Date(1238606590509)\/ (i.e. UTC milliseconds since epoch) or - \/Date(1238606590509+0800)\/ -- * - * Example usage (note that you must escape format specifiers with '\\' to render them as character literals): - *- * - * Here are some standard date/time patterns that you might find helpful. They - * are not part of the source of Date.js, but to use them you can simply copy this - * block of code into any script that is included after Date.js and they will also become - * globally available on the Date object. Feel free to add or remove patterns as needed in your code. - *-// Sample date: -// 'Wed Jan 10 2007 15:05:01 GMT-0600 (Central Standard Time)' - -var dt = new Date('1/10/2007 03:05:01 PM GMT-0600'); -document.write(dt.format('Y-m-d')); // 2007-01-10 -document.write(dt.format('F j, Y, g:i a')); // January 10, 2007, 3:05 pm -document.write(dt.format('l, \\t\\he jS \\of F Y h:i:s A')); // Wednesday, the 10th of January 2007 03:05:01 PM -- * - * Example usage: - *-Date.patterns = { - ISO8601Long:"Y-m-d H:i:s", - ISO8601Short:"Y-m-d", - ShortDate: "n/j/Y", - LongDate: "l, F d, Y", - FullDateTime: "l, F d, Y g:i:s A", - MonthDay: "F d", - ShortTime: "g:i A", - LongTime: "g:i:s A", - SortableDateTime: "Y-m-d\\TH:i:s", - UniversalSortableDateTime: "Y-m-d H:i:sO", - YearMonth: "F, Y" -}; -- *-var dt = new Date(); -document.write(dt.format(Date.patterns.ShortDate)); -Developer-written, custom formats may be used by supplying both a formatting and a parsing function - * which perform to specialized requirements. The functions are stored in {@link #parseFunctions} and {@link #formatFunctions}.
+ + + + +The source code + + + + + + +/** + * @class Date + * + * Creates `Date` instances which let you work with dates and times. + * + * If you supply no arguments, the constructor creates a `Date` object for today's + * date and time according to local time. If you supply some arguments but not + * others, the missing arguments are set to 0. If you supply any arguments, you + * must supply at least the year, month, and day. You can omit the hours, minutes, + * seconds, and milliseconds. + * + * The date is measured in milliseconds since midnight 01 January, 1970 UTC. A day + * holds 86,400,000 milliseconds. The `Date` object range is -100,000,000 days to + * 100,000,000 days relative to 01 January, 1970 UTC. + * + * The `Date` object provides uniform behavior across platforms. + * + * The `Date` object supports a number of UTC (universal) methods, as well as + * local time methods. UTC, also known as Greenwich Mean Time (GMT), refers to the + * time as set by the World Time Standard. The local time is the time known to the + * computer where JavaScript is executed. + * + * Invoking `Date` in a non-constructor context (i.e., without the `new` operator) + * will return a string representing the current time. + * + * Note that `Date` objects can only be instantiated by calling `Date` or using it + * as a constructor; unlike other JavaScript object types, `Date` objects have no + * literal syntax. + * + * # Several ways to assign dates + * + * The following example shows several ways to assign dates: + * + * today = new Date(); + * birthday = new Date("December 19, 1989 03:24:00"); + * birthday = new Date(1989,11,19); + * birthday = new Date(1989,11,17,3,24,0); + * + * # Calculating elapsed time + * + * The following examples show how to determine the elapsed time between two dates: + * + * // using static methods + * var start = Date.now(); + * // the event you'd like to time goes here: + * doSomethingForALongTime(); + * var end = Date.now(); + * var elapsed = end - start; // time in milliseconds + * + * // if you have Date objects + * var start = new Date(); + * // the event you'd like to time goes here: + * doSomethingForALongTime(); + * var end = new Date(); + * var elapsed = end.getTime() - start.getTime(); // time in milliseconds + * + * // if you want to test a function and get back its return + * function printElapsedTime (fTest) { + * var nStartTime = Date.now(), vReturn = fTest(), nEndTime = Date.now(); + * alert("Elapsed time: " + String(nEndTime - nStartTime) + " + * milliseconds"); + * return vReturn; + * } + * + * yourFunctionReturn = printElapsedTime(yourFunction); + * + * # ISO 8601 formatted dates + * + * The following example shows how to formate a date in an ISO 8601 format using + * UTC: + * + * // use a function for the exact format desired... + * function ISODateString(d){ + * function pad(n){return n<10 ? '0'+n : n} + * return d.getUTCFullYear()+'-' + * + pad(d.getUTCMonth()+1)+'-' + * + pad(d.getUTCDate())+'T' + * + pad(d.getUTCHours())+':' + * + pad(d.getUTCMinutes())+':' + * + pad(d.getUTCSeconds())+'Z'} + * + * var d = new Date(); + * print(ISODateString(d)); // prints something like 2009-09-28T19:03:12Z + * + * <div class="notice"> + * Documentation for this class comes from <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date">MDN</a> + * and is available under <a href="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons: Attribution-Sharealike license</a>. + * </div> */ -/* - * Most of the date-formatting functions below are the excellent work of Baron Schwartz. - * (see http://www.xaprb.com/blog/2005/12/12/javascript-closures-for-runtime-efficiency/) - * They generate precompiled functions from format patterns instead of parsing and - * processing each pattern every time a date is formatted. These functions are available - * on every Date object. +/** + * @method constructor + * Creates new Date object. + * + * @param {Number/String} [year] + * Either UNIX timestamp, date string, or year (when month and day parameters also provided): + * + * - Integer value representing the number of milliseconds since 1 January 1970 + * 00:00:00 UTC (Unix Epoch). + * + * - String value representing a date. The string should be in a format recognized + * by the parse method (IETF-compliant RFC 1123 timestamps). + * + * - Integer value representing the year. For compatibility (in order to avoid the + * Y2K problem), you should always specify the year in full; use 1998, rather + * than 98. + * + * @param {Number} [month] + * Integer value representing the month, beginning with 0 for January to 11 + * for December. + * @param {Number} [day] + * Integer value representing the day of the month (1-31). + * @param {Number} [hour] + * Integer value representing the hour of the day (0-23). + * @param {Number} [minute] + * Integer value representing the minute segment (0-59) of a time reading. + * @param {Number} [second] + * Integer value representing the second segment (0-59) of a time reading. + * @param {Number} [millisecond] + * Integer value representing the millisecond segment (0-999) of a time reading. */ -(function() { - -/** - * Global flag which determines if strict date parsing should be used. - * Strict date parsing will not roll-over invalid dates, which is the - * default behaviour of javascript Date objects. - * (see {@link #parseDate} for more information) - * Defaults to false. - * @static - * @type Boolean -*/ -Date.useStrict = false; - - -// create private copy of Ext's String.format() method -// - to remove unnecessary dependency -// - to resolve namespace conflict with M$-Ajax's implementation -function xf(format) { - var args = Array.prototype.slice.call(arguments, 1); - return format.replace(/\{(\d+)\}/g, function(m, i) { - return args[i]; - }); -} - - -// private -Date.formatCodeToRegex = function(character, currentGroup) { - // Note: currentGroup - position in regex result array (see notes for Date.parseCodes below) - var p = Date.parseCodes[character]; - - if (p) { - p = typeof p == 'function'? p() : p; - Date.parseCodes[character] = p; // reassign function result to prevent repeated execution - } - - return p? Ext.applyIf({ - c: p.c? xf(p.c, currentGroup || "{0}") : p.c - }, p) : { - g:0, - c:null, - s:Ext.escapeRe(character) // treat unrecognised characters as literals - } -} - -// private shorthand for Date.formatCodeToRegex since we'll be using it fairly often -var $f = Date.formatCodeToRegex; - -Ext.apply(Date, { - /** - *- - \ No newline at end of file +/** + * @method valueOf + * Returns the primitive value of a Date object. Overrides the + * Object.prototype.valueOf method. + * + * The `valueOf` method returns the primitive value of a `Date` object as a number data type, the + * number of milliseconds since midnight 01 January, 1970 UTC. + * + * This method is functionally equivalent to the `getTime` method. + * + * This method is usually called internally by JavaScript and not explicitly in code. + * + * x = new Date(56, 6, 17); + * myVar = x.valueOf(); //assigns -424713600000 to myVar + * + * @return {Number} Date represented as milliseconds. + */An object hash in which each property is a date parsing function. The property name is the - * format string which that function parses.
- *This object is automatically populated with date parsing functions as - * date formats are requested for Ext standard formatting strings.
- *Custom parsing functions may be inserted into this object, keyed by a name which from then on - * may be used as a format string to {@link #parseDate}.
- *
Example:
- *-Date.parseFunctions['x-date-format'] = myDateParser; -A parsing function should return a Date object, and is passed the following parameters:
- *- *
- - *
date: StringThe date string to parse.- - *
strict: BooleanTrue to validate date strings while parsing - * (i.e. prevent javascript Date "rollover") (The default must be false). - * Invalid date strings should return null when parsed.To enable Dates to also be formatted according to that format, a corresponding - * formatting function must be placed into the {@link #formatFunctions} property. - * @property parseFunctions - * @static - * @type Object - */ - parseFunctions: { - "M$": function(input, strict) { - // note: the timezone offset is ignored since the M$ Ajax server sends - // a UTC milliseconds-since-Unix-epoch value (negative values are allowed) - var re = new RegExp('\\/Date\\(([-+])?(\\d+)(?:[+-]\\d{4})?\\)\\/'); - var r = (input || '').match(re); - return r? new Date(((r[1] || '') + r[2]) * 1) : null; - } - }, - parseRegexes: [], - -
/** - *An object hash in which each property is a date formatting function. The property name is the - * format string which corresponds to the produced formatted date string.
- *This object is automatically populated with date formatting functions as - * date formats are requested for Ext standard formatting strings.
- *Custom formatting functions may be inserted into this object, keyed by a name which from then on - * may be used as a format string to {@link #format}. Example:
- *-Date.formatFunctions['x-date-format'] = myDateFormatter; -A formatting function should return a string repesentation of the passed Date object:
- *- *
- - *
date: DateThe Date to format.To enable date strings to also be parsed according to that format, a corresponding - * parsing function must be placed into the {@link #parseFunctions} property. - * @property formatFunctions - * @static - * @type Object - */ - formatFunctions: { - "M$": function() { - // UTC milliseconds since Unix epoch (M$-AJAX serialized date format (MRSF)) - return '\\/Date(' + this.getTime() + ')\\/'; - } - }, - - y2kYear : 50, - -
/** - * Date interval constant - * @static - * @type String - */ - MILLI : "ms", - - /** - * Date interval constant - * @static - * @type String - */ - SECOND : "s", - - /** - * Date interval constant - * @static - * @type String - */ - MINUTE : "mi", - - /** Date interval constant - * @static - * @type String - */ - HOUR : "h", - - /** - * Date interval constant - * @static - * @type String - */ - DAY : "d", - - /** - * Date interval constant - * @static - * @type String - */ - MONTH : "mo", - - /** - * Date interval constant - * @static - * @type String - */ - YEAR : "y", - - /** - *An object hash containing default date values used during date parsing.
- *The following properties are available:
- *- *
- - *
y: NumberThe default year value. (defaults to undefined)- - *
m: NumberThe default 1-based month value. (defaults to undefined)- - *
d: NumberThe default day value. (defaults to undefined)- - *
h: NumberThe default hour value. (defaults to undefined)- - *
i: NumberThe default minute value. (defaults to undefined)- - *
s: NumberThe default second value. (defaults to undefined)- - *
ms: NumberThe default millisecond value. (defaults to undefined)Override these properties to customize the default date values used by the {@link #parseDate} method.
- *Note: In countries which experience Daylight Saving Time (i.e. DST), the h, i, s - * and ms properties may coincide with the exact time in which DST takes effect. - * It is the responsiblity of the developer to account for this.
- * Example Usage: - *- * @property defaults - * @static - * @type Object - */ - defaults: {}, - - /** - * An array of textual day names. - * Override these values for international dates. - * Example: - *-// set default day value to the first day of the month -Date.defaults.d = 1; - -// parse a February date string containing only year and month values. -// setting the default day value to 1 prevents weird date rollover issues -// when attempting to parse the following date string on, for example, March 31st 2009. -Date.parseDate('2009-02', 'Y-m'); // returns a Date object representing February 1st 2009 -- * @type Array - * @static - */ - dayNames : [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - - /** - * An array of textual month names. - * Override these values for international dates. - * Example: - *-Date.dayNames = [ - 'SundayInYourLang', - 'MondayInYourLang', - ... -]; -- * @type Array - * @static - */ - monthNames : [ - "January", - "February", - "March", - "April", - "May", - "June", - "July", - "August", - "September", - "October", - "November", - "December" - ], - - /** - * An object hash of zero-based javascript month numbers (with short month names as keys. note: keys are case-sensitive). - * Override these values for international dates. - * Example: - *-Date.monthNames = [ - 'JanInYourLang', - 'FebInYourLang', - ... -]; -- * @type Object - * @static - */ - monthNumbers : { - Jan:0, - Feb:1, - Mar:2, - Apr:3, - May:4, - Jun:5, - Jul:6, - Aug:7, - Sep:8, - Oct:9, - Nov:10, - Dec:11 - }, - - /** - * Get the short month name for the given month number. - * Override this function for international dates. - * @param {Number} month A zero-based javascript month number. - * @return {String} The short month name. - * @static - */ - getShortMonthName : function(month) { - return Date.monthNames[month].substring(0, 3); - }, - - /** - * Get the short day name for the given day number. - * Override this function for international dates. - * @param {Number} day A zero-based javascript day number. - * @return {String} The short day name. - * @static - */ - getShortDayName : function(day) { - return Date.dayNames[day].substring(0, 3); - }, - - /** - * Get the zero-based javascript month number for the given short/full month name. - * Override this function for international dates. - * @param {String} name The short/full month name. - * @return {Number} The zero-based javascript month number. - * @static - */ - getMonthNumber : function(name) { - // handle camel casing for english month names (since the keys for the Date.monthNumbers hash are case sensitive) - return Date.monthNumbers[name.substring(0, 1).toUpperCase() + name.substring(1, 3).toLowerCase()]; - }, - - /** - * The base format-code to formatting-function hashmap used by the {@link #format} method. - * Formatting functions are strings (or functions which return strings) which - * will return the appropriate value when evaluated in the context of the Date object - * from which the {@link #format} method is called. - * Add to / override these mappings for custom date formatting. - * Note: Date.format() treats characters as literals if an appropriate mapping cannot be found. - * Example: - *-Date.monthNumbers = { - 'ShortJanNameInYourLang':0, - 'ShortFebNameInYourLang':1, - ... -}; -- * @type Object - * @static - */ - formatCodes : { - d: "String.leftPad(this.getDate(), 2, '0')", - D: "Date.getShortDayName(this.getDay())", // get localised short day name - j: "this.getDate()", - l: "Date.dayNames[this.getDay()]", - N: "(this.getDay() ? this.getDay() : 7)", - S: "this.getSuffix()", - w: "this.getDay()", - z: "this.getDayOfYear()", - W: "String.leftPad(this.getWeekOfYear(), 2, '0')", - F: "Date.monthNames[this.getMonth()]", - m: "String.leftPad(this.getMonth() + 1, 2, '0')", - M: "Date.getShortMonthName(this.getMonth())", // get localised short month name - n: "(this.getMonth() + 1)", - t: "this.getDaysInMonth()", - L: "(this.isLeapYear() ? 1 : 0)", - o: "(this.getFullYear() + (this.getWeekOfYear() == 1 && this.getMonth() > 0 ? +1 : (this.getWeekOfYear() >= 52 && this.getMonth() < 11 ? -1 : 0)))", - Y: "this.getFullYear()", - y: "('' + this.getFullYear()).substring(2, 4)", - a: "(this.getHours() < 12 ? 'am' : 'pm')", - A: "(this.getHours() < 12 ? 'AM' : 'PM')", - g: "((this.getHours() % 12) ? this.getHours() % 12 : 12)", - G: "this.getHours()", - h: "String.leftPad((this.getHours() % 12) ? this.getHours() % 12 : 12, 2, '0')", - H: "String.leftPad(this.getHours(), 2, '0')", - i: "String.leftPad(this.getMinutes(), 2, '0')", - s: "String.leftPad(this.getSeconds(), 2, '0')", - u: "String.leftPad(this.getMilliseconds(), 3, '0')", - O: "this.getGMTOffset()", - P: "this.getGMTOffset(true)", - T: "this.getTimezone()", - Z: "(this.getTimezoneOffset() * -60)", - - c: function() { // ISO-8601 -- GMT format - for (var c = "Y-m-dTH:i:sP", code = [], i = 0, l = c.length; i < l; ++i) { - var e = c.charAt(i); - code.push(e == "T" ? "'T'" : Date.getFormatCode(e)); // treat T as a character literal - } - return code.join(" + "); - }, - /* - c: function() { // ISO-8601 -- UTC format - return [ - "this.getUTCFullYear()", "'-'", - "String.leftPad(this.getUTCMonth() + 1, 2, '0')", "'-'", - "String.leftPad(this.getUTCDate(), 2, '0')", - "'T'", - "String.leftPad(this.getUTCHours(), 2, '0')", "':'", - "String.leftPad(this.getUTCMinutes(), 2, '0')", "':'", - "String.leftPad(this.getUTCSeconds(), 2, '0')", - "'Z'" - ].join(" + "); - }, - */ - - U: "Math.round(this.getTime() / 1000)" - }, - - /** - * Checks if the passed Date parameters will cause a javascript Date "rollover". - * @param {Number} year 4-digit year - * @param {Number} month 1-based month-of-year - * @param {Number} day Day of month - * @param {Number} hour (optional) Hour - * @param {Number} minute (optional) Minute - * @param {Number} second (optional) Second - * @param {Number} millisecond (optional) Millisecond - * @return {Boolean} true if the passed parameters do not cause a Date "rollover", false otherwise. - * @static - */ - isValid : function(y, m, d, h, i, s, ms) { - // setup defaults - h = h || 0; - i = i || 0; - s = s || 0; - ms = ms || 0; - - var dt = new Date(y, m - 1, d, h, i, s, ms); - - return y == dt.getFullYear() && - m == dt.getMonth() + 1 && - d == dt.getDate() && - h == dt.getHours() && - i == dt.getMinutes() && - s == dt.getSeconds() && - ms == dt.getMilliseconds(); - }, - - /** - * Parses the passed string using the specified date format. - * Note that this function expects normal calendar dates, meaning that months are 1-based (i.e. 1 = January). - * The {@link #defaults} hash will be used for any date value (i.e. year, month, day, hour, minute, second or millisecond) - * which cannot be found in the passed string. If a corresponding default date value has not been specified in the {@link #defaults} hash, - * the current date's year, month, day or DST-adjusted zero-hour time value will be used instead. - * Keep in mind that the input date string must precisely match the specified format string - * in order for the parse operation to be successful (failed parse operations return a null value). - *-Date.formatCodes.x = "String.leftPad(this.getDate(), 2, '0')"; -(new Date()).format("X"); // returns the current day of the month -Example:
- * @param {String} input The raw date string. - * @param {String} format The expected date string format. - * @param {Boolean} strict (optional) True to validate date strings while parsing (i.e. prevents javascript Date "rollover") - (defaults to false). Invalid date strings will return null when parsed. - * @return {Date} The parsed Date. - * @static - */ - parseDate : function(input, format, strict) { - var p = Date.parseFunctions; - if (p[format] == null) { - Date.createParser(format); - } - return p[format](input, Ext.isDefined(strict) ? strict : Date.useStrict); - }, - - // private - getFormatCode : function(character) { - var f = Date.formatCodes[character]; - - if (f) { - f = typeof f == 'function'? f() : f; - Date.formatCodes[character] = f; // reassign function result to prevent repeated execution - } - - // note: unknown characters are treated as literals - return f || ("'" + String.escape(character) + "'"); - }, - - // private - createFormat : function(format) { - var code = [], - special = false, - ch = ''; - - for (var i = 0; i < format.length; ++i) { - ch = format.charAt(i); - if (!special && ch == "\\") { - special = true; - } else if (special) { - special = false; - code.push("'" + String.escape(ch) + "'"); - } else { - code.push(Date.getFormatCode(ch)) - } - } - Date.formatFunctions[format] = new Function("return " + code.join('+')); - }, - - // private - createParser : function() { - var code = [ - "var dt, y, m, d, h, i, s, ms, o, z, zz, u, v,", - "def = Date.defaults,", - "results = String(input).match(Date.parseRegexes[{0}]);", // either null, or an array of matched strings - - "if(results){", - "{1}", - - "if(u != null){", // i.e. unix time is defined - "v = new Date(u * 1000);", // give top priority to UNIX time - "}else{", - // create Date object representing midnight of the current day; - // this will provide us with our date defaults - // (note: clearTime() handles Daylight Saving Time automatically) - "dt = (new Date()).clearTime();", - - // date calculations (note: these calculations create a dependency on Ext.num()) - "y = y >= 0? y : Ext.num(def.y, dt.getFullYear());", - "m = m >= 0? m : Ext.num(def.m - 1, dt.getMonth());", - "d = d >= 0? d : Ext.num(def.d, dt.getDate());", - - // time calculations (note: these calculations create a dependency on Ext.num()) - "h = h || Ext.num(def.h, dt.getHours());", - "i = i || Ext.num(def.i, dt.getMinutes());", - "s = s || Ext.num(def.s, dt.getSeconds());", - "ms = ms || Ext.num(def.ms, dt.getMilliseconds());", - - "if(z >= 0 && y >= 0){", - // both the year and zero-based day of year are defined and >= 0. - // these 2 values alone provide sufficient info to create a full date object - - // create Date object representing January 1st for the given year - "v = new Date(y, 0, 1, h, i, s, ms);", - - // then add day of year, checking for Date "rollover" if necessary - "v = !strict? v : (strict === true && (z <= 364 || (v.isLeapYear() && z <= 365))? v.add(Date.DAY, z) : null);", - "}else if(strict === true && !Date.isValid(y, m + 1, d, h, i, s, ms)){", // check for Date "rollover" - "v = null;", // invalid date, so return null - "}else{", - // plain old Date object - "v = new Date(y, m, d, h, i, s, ms);", - "}", - "}", - "}", - - "if(v){", - // favour UTC offset over GMT offset - "if(zz != null){", - // reset to UTC, then add offset - "v = v.add(Date.SECOND, -v.getTimezoneOffset() * 60 - zz);", - "}else if(o){", - // reset to GMT, then add offset - "v = v.add(Date.MINUTE, -v.getTimezoneOffset() + (sn == '+'? -1 : 1) * (hr * 60 + mn));", - "}", - "}", - - "return v;" - ].join('\n'); - return function(format) { - var regexNum = Date.parseRegexes.length, - currentGroup = 1, - calc = [], - regex = [], - special = false, - ch = ""; +//Methods - for (var i = 0; i < format.length; ++i) { - ch = format.charAt(i); - if (!special && ch == "\\") { - special = true; - } else if (special) { - special = false; - regex.push(String.escape(ch)); - } else { - var obj = $f(ch, currentGroup); - currentGroup += obj.g; - regex.push(obj.s); - if (obj.g && obj.c) { - calc.push(obj.c); - } - } - } - - Date.parseRegexes[regexNum] = new RegExp("^" + regex.join('') + "$", "i"); - Date.parseFunctions[format] = new Function("input", "strict", xf(code, regexNum, calc.join(''))); - } - }(), - - // private - parseCodes : { - /* - * Notes: - * g = {Number} calculation group (0 or 1. only group 1 contributes to date calculations.) - * c = {String} calculation method (required for group 1. null for group 0. {0} = currentGroup - position in regex result array) - * s = {String} regex pattern. all matches are stored in results[], and are accessible by the calculation mapped to 'c' - */ - d: { - g:1, - c:"d = parseInt(results[{0}], 10);\n", - s:"(\\d{2})" // day of month with leading zeroes (01 - 31) - }, - j: { - g:1, - c:"d = parseInt(results[{0}], 10);\n", - s:"(\\d{1,2})" // day of month without leading zeroes (1 - 31) - }, - D: function() { - for (var a = [], i = 0; i < 7; a.push(Date.getShortDayName(i)), ++i); // get localised short day names - return { - g:0, - c:null, - s:"(?:" + a.join("|") +")" - } - }, - l: function() { - return { - g:0, - c:null, - s:"(?:" + Date.dayNames.join("|") + ")" - } - }, - N: { - g:0, - c:null, - s:"[1-7]" // ISO-8601 day number (1 (monday) - 7 (sunday)) - }, - S: { - g:0, - c:null, - s:"(?:st|nd|rd|th)" - }, - w: { - g:0, - c:null, - s:"[0-6]" // javascript day number (0 (sunday) - 6 (saturday)) - }, - z: { - g:1, - c:"z = parseInt(results[{0}], 10);\n", - s:"(\\d{1,3})" // day of the year (0 - 364 (365 in leap years)) - }, - W: { - g:0, - c:null, - s:"(?:\\d{2})" // ISO-8601 week number (with leading zero) - }, - F: function() { - return { - g:1, - c:"m = parseInt(Date.getMonthNumber(results[{0}]), 10);\n", // get localised month number - s:"(" + Date.monthNames.join("|") + ")" - } - }, - M: function() { - for (var a = [], i = 0; i < 12; a.push(Date.getShortMonthName(i)), ++i); // get localised short month names - return Ext.applyIf({ - s:"(" + a.join("|") + ")" - }, $f("F")); - }, - m: { - g:1, - c:"m = parseInt(results[{0}], 10) - 1;\n", - s:"(\\d{2})" // month number with leading zeros (01 - 12) - }, - n: { - g:1, - c:"m = parseInt(results[{0}], 10) - 1;\n", - s:"(\\d{1,2})" // month number without leading zeros (1 - 12) - }, - t: { - g:0, - c:null, - s:"(?:\\d{2})" // no. of days in the month (28 - 31) - }, - L: { - g:0, - c:null, - s:"(?:1|0)" - }, - o: function() { - return $f("Y"); - }, - Y: { - g:1, - c:"y = parseInt(results[{0}], 10);\n", - s:"(\\d{4})" // 4-digit year - }, - y: { - g:1, - c:"var ty = parseInt(results[{0}], 10);\n" - + "y = ty > Date.y2kYear ? 1900 + ty : 2000 + ty;\n", // 2-digit year - s:"(\\d{1,2})" - }, - a: { - g:1, - c:"if (results[{0}] == 'am') {\n" - + "if (h == 12) { h = 0; }\n" - + "} else { if (h < 12) { h += 12; }}", - s:"(am|pm)" - }, - A: { - g:1, - c:"if (results[{0}] == 'AM') {\n" - + "if (h == 12) { h = 0; }\n" - + "} else { if (h < 12) { h += 12; }}", - s:"(AM|PM)" - }, - g: function() { - return $f("G"); - }, - G: { - g:1, - c:"h = parseInt(results[{0}], 10);\n", - s:"(\\d{1,2})" // 24-hr format of an hour without leading zeroes (0 - 23) - }, - h: function() { - return $f("H"); - }, - H: { - g:1, - c:"h = parseInt(results[{0}], 10);\n", - s:"(\\d{2})" // 24-hr format of an hour with leading zeroes (00 - 23) - }, - i: { - g:1, - c:"i = parseInt(results[{0}], 10);\n", - s:"(\\d{2})" // minutes with leading zeros (00 - 59) - }, - s: { - g:1, - c:"s = parseInt(results[{0}], 10);\n", - s:"(\\d{2})" // seconds with leading zeros (00 - 59) - }, - u: { - g:1, - c:"ms = results[{0}]; ms = parseInt(ms, 10)/Math.pow(10, ms.length - 3);\n", - s:"(\\d+)" // decimal fraction of a second (minimum = 1 digit, maximum = unlimited) - }, - O: { - g:1, - c:[ - "o = results[{0}];", - "var sn = o.substring(0,1),", // get + / - sign - "hr = o.substring(1,3)*1 + Math.floor(o.substring(3,5) / 60),", // get hours (performs minutes-to-hour conversion also, just in case) - "mn = o.substring(3,5) % 60;", // get minutes - "o = ((-12 <= (hr*60 + mn)/60) && ((hr*60 + mn)/60 <= 14))? (sn + String.leftPad(hr, 2, '0') + String.leftPad(mn, 2, '0')) : null;\n" // -12hrs <= GMT offset <= 14hrs - ].join("\n"), - s: "([+\-]\\d{4})" // GMT offset in hrs and mins - }, - P: { - g:1, - c:[ - "o = results[{0}];", - "var sn = o.substring(0,1),", // get + / - sign - "hr = o.substring(1,3)*1 + Math.floor(o.substring(4,6) / 60),", // get hours (performs minutes-to-hour conversion also, just in case) - "mn = o.substring(4,6) % 60;", // get minutes - "o = ((-12 <= (hr*60 + mn)/60) && ((hr*60 + mn)/60 <= 14))? (sn + String.leftPad(hr, 2, '0') + String.leftPad(mn, 2, '0')) : null;\n" // -12hrs <= GMT offset <= 14hrs - ].join("\n"), - s: "([+\-]\\d{2}:\\d{2})" // GMT offset in hrs and mins (with colon separator) - }, - T: { - g:0, - c:null, - s:"[A-Z]{1,4}" // timezone abbrev. may be between 1 - 4 chars - }, - Z: { - g:1, - c:"zz = results[{0}] * 1;\n" // -43200 <= UTC offset <= 50400 - + "zz = (-43200 <= zz && zz <= 50400)? zz : null;\n", - s:"([+\-]?\\d{1,5})" // leading '+' sign is optional for UTC offset - }, - c: function() { - var calc = [], - arr = [ - $f("Y", 1), // year - $f("m", 2), // month - $f("d", 3), // day - $f("h", 4), // hour - $f("i", 5), // minute - $f("s", 6), // second - {c:"ms = results[7] || '0'; ms = parseInt(ms, 10)/Math.pow(10, ms.length - 3);\n"}, // decimal fraction of a second (minimum = 1 digit, maximum = unlimited) - {c:[ // allow either "Z" (i.e. UTC) or "-0530" or "+08:00" (i.e. UTC offset) timezone delimiters. assumes local timezone if no timezone is specified - "if(results[8]) {", // timezone specified - "if(results[8] == 'Z'){", - "zz = 0;", // UTC - "}else if (results[8].indexOf(':') > -1){", - $f("P", 8).c, // timezone offset with colon separator - "}else{", - $f("O", 8).c, // timezone offset without colon separator - "}", - "}" - ].join('\n')} - ]; - - for (var i = 0, l = arr.length; i < l; ++i) { - calc.push(arr[i].c); - } - - return { - g:1, - c:calc.join(""), - s:[ - arr[0].s, // year (required) - "(?:", "-", arr[1].s, // month (optional) - "(?:", "-", arr[2].s, // day (optional) - "(?:", - "(?:T| )?", // time delimiter -- either a "T" or a single blank space - arr[3].s, ":", arr[4].s, // hour AND minute, delimited by a single colon (optional). MUST be preceded by either a "T" or a single blank space - "(?::", arr[5].s, ")?", // seconds (optional) - "(?:(?:\\.|,)(\\d+))?", // decimal fraction of a second (e.g. ",12345" or ".98765") (optional) - "(Z|(?:[-+]\\d{2}(?::)?\\d{2}))?", // "Z" (UTC) or "-0530" (UTC offset without colon delimiter) or "+08:00" (UTC offset with colon delimiter) (optional) - ")?", - ")?", - ")?" - ].join("") - } - }, - U: { - g:1, - c:"u = parseInt(results[{0}], 10);\n", - s:"(-?\\d+)" // leading minus sign indicates seconds before UNIX epoch - } - } -}); - -}()); - -Ext.apply(Date.prototype, { - // private - dateFormat : function(format) { - if (Date.formatFunctions[format] == null) { - Date.createFormat(format); - } - return Date.formatFunctions[format].call(this); - }, - - /** - * Get the timezone abbreviation of the current date (equivalent to the format specifier 'T'). - * - * Note: The date string returned by the javascript Date object's toString() method varies - * between browsers (e.g. FF vs IE) and system region settings (e.g. IE in Asia vs IE in America). - * For a given date string e.g. "Thu Oct 25 2007 22:55:35 GMT+0800 (Malay Peninsula Standard Time)", - * getTimezone() first tries to get the timezone abbreviation from between a pair of parentheses - * (which may or may not be present), failing which it proceeds to get the timezone abbreviation - * from the GMT offset portion of the date string. - * @return {String} The abbreviated timezone name (e.g. 'CST', 'PDT', 'EDT', 'MPST' ...). - */ - getTimezone : function() { - // the following list shows the differences between date strings from different browsers on a WinXP SP2 machine from an Asian locale: - // - // Opera : "Thu, 25 Oct 2007 22:53:45 GMT+0800" -- shortest (weirdest) date string of the lot - // Safari : "Thu Oct 25 2007 22:55:35 GMT+0800 (Malay Peninsula Standard Time)" -- value in parentheses always gives the correct timezone (same as FF) - // FF : "Thu Oct 25 2007 22:55:35 GMT+0800 (Malay Peninsula Standard Time)" -- value in parentheses always gives the correct timezone - // IE : "Thu Oct 25 22:54:35 UTC+0800 2007" -- (Asian system setting) look for 3-4 letter timezone abbrev - // IE : "Thu Oct 25 17:06:37 PDT 2007" -- (American system setting) look for 3-4 letter timezone abbrev - // - // this crazy regex attempts to guess the correct timezone abbreviation despite these differences. - // step 1: (?:\((.*)\) -- find timezone in parentheses - // step 2: ([A-Z]{1,4})(?:[\-+][0-9]{4})?(?: -?\d+)?) -- if nothing was found in step 1, find timezone from timezone offset portion of date string - // step 3: remove all non uppercase characters found in step 1 and 2 - return this.toString().replace(/^.* (?:\((.*)\)|([A-Z]{1,4})(?:[\-+][0-9]{4})?(?: -?\d+)?)$/, "$1$2").replace(/[^A-Z]/g, ""); - }, - - /** - * Get the offset from GMT of the current date (equivalent to the format specifier 'O'). - * @param {Boolean} colon (optional) true to separate the hours and minutes with a colon (defaults to false). - * @return {String} The 4-character offset string prefixed with + or - (e.g. '-0600'). - */ - getGMTOffset : function(colon) { - return (this.getTimezoneOffset() > 0 ? "-" : "+") - + String.leftPad(Math.floor(Math.abs(this.getTimezoneOffset()) / 60), 2, "0") - + (colon ? ":" : "") - + String.leftPad(Math.abs(this.getTimezoneOffset() % 60), 2, "0"); - }, - - /** - * Get the numeric day number of the year, adjusted for leap year. - * @return {Number} 0 to 364 (365 in leap years). - */ - getDayOfYear: function() { - var i = 0, - num = 0, - d = this.clone(), - m = this.getMonth(); +/** + * @method now + * @static + * Returns the numeric value corresponding to the current time. + * + * The `now` method returns the milliseconds elapsed since 1 January 1970 00:00:00 UTC up until now as + * a number. + * + * When using `now` to create timestamps or unique IDs, keep in mind that the resolution may be 15 + * milliseconds on Windows, so you could end up with several equal values if `now` is called multiple + * times within a short time span. + * + * @return {Number} Returns the number of milliseconds elapsed since 1 January 1970 00:00:00 UTC. + */ - for (i = 0, d.setMonth(0); i < m; d.setMonth(++i)) { - num += d.getDaysInMonth(); - } - return num + this.getDate() - 1; - }, +/** + * @method parse + * @static + * Parses a string representation of a date, and returns the number of milliseconds + * since January 1, 1970, 00:00:00, local time. + * + * The `parse` method takes a date string (such as `"Dec 25, 1995"`) and returns the number of + * milliseconds since January 1, 1970, 00:00:00 UTC. The local time zone is used to interpret + * arguments that do not contain time zone information. This function is useful for setting date + * values based on string values, for example in conjunction with the `setTime` method and the + * {@link Date} object. + * + * Given a string representing a time, parse returns the time value. It accepts the IETF standard (RFC + * 1123 Section 5.2.14 and elsewhere) date syntax: `"Mon, 25 Dec 1995 13:30:00 GMT"`. It understands + * the continental US time-zone abbreviations, but for general use, use a time-zone offset, for + * example, `"Mon, 25 Dec 1995 13:30:00 GMT+0430"` (4 hours, 30 minutes east of the Greenwich + * meridian). If you do not specify a time zone, the local time zone is assumed. GMT and UTC are + * considered equivalent. + * + * ### Using parse + * + * If `IPOdate` is an existing `Date` object, then you can set it to August 9, 1995 (local time) as + * follows: + * + * IPOdate.setTime(Date.parse("Aug 9, 1995")); + * + * Some other examples: + * + * // Returns 807937200000 in time zone GMT-0300, and other values in other + * // timezones, since the argument does not specify a time zone. + * Date.parse("Aug 9, 1995"); + * + * // Returns 807926400000 no matter the local time zone. + * Date.parse("Wed, 09 Aug 1995 00:00:00 GMT"); + * + * // Returns 807937200000 in timezone GMT-0300, and other values in other + * // timezones, since there is no time zone specifier in the argument. + * Date.parse("Wed, 09 Aug 1995 00:00:00"); + * + * // Returns 0 no matter the local time zone. + * Date.parse("Thu, 01 Jan 1970 00:00:00 GMT"); + * + * // Returns 14400000 in timezone GMT-0400, and other values in other + * // timezones, since there is no time zone specifier in the argument. + * Date.parse("Thu, 01 Jan 1970 00:00:00"); + * + * // Returns 14400000 no matter the local time zone. + * Date.parse("Thu, 01 Jan 1970 00:00:00 GMT-0400"); + * + * @param {String} dateString A string representing a date. + * @return {Number} Number of milliseconds since January 1, 1970, 00:00:00, local time. + */ - /** - * Get the numeric ISO-8601 week number of the year. - * (equivalent to the format specifier 'W', but without a leading zero). - * @return {Number} 1 to 53 - */ - getWeekOfYear : function() { - // adapted from http://www.merlyn.demon.co.uk/weekcalc.htm - var ms1d = 864e5, // milliseconds in a day - ms7d = 7 * ms1d; // milliseconds in a week +/** + * @method UTC + * @static + * Accepts the same parameters as the longest form of the constructor, and returns + * the number of milliseconds in a `Date` object since January 1, 1970, 00:00:00, + * universal time. + * + * `UTC` takes comma-delimited date parameters and returns the number of milliseconds between January + * 1, 1970, 00:00:00, universal time and the time you specified. + * + * You should specify a full year for the year; for example, 1998. If a year between 0 and 99 is + * specified, the method converts the year to a year in the 20th century (1900 + year); for example, + * if you specify 95, the year 1995 is used. + * + * The `UTC` method differs from the `Date` constructor in two ways. + * * `Date.UTC` uses universal time instead of the local time. + * * `Date.UTC` returns a time value as a number instead of creating a `Date` object. + * + * If a parameter you specify is outside of the expected range, the `UTC` method updates the other + * parameters to allow for your number. For example, if you use 15 for month, the year will be + * incremented by 1 (year + 1), and 3 will be used for the month. + * + * Because `UTC` is a static method of `Date`, you always use it as `Date.UTC()`, rather than as a + * method of a `Date` object you created. +* + * The following statement creates a `Date` object using GMT instead of local time: + * + * gmtDate = new Date(Date.UTC(96, 11, 1, 0, 0, 0)); + * + * @param {Number} year A year after 1900. + * @param {Number} month An integer between 0 and 11 representing the month. + * @param {Number} date An integer between 1 and 31 representing the day of the month. + * @param {Number} hrs An integer between 0 and 23 representing the hours. + * @param {Number} min An integer between 0 and 59 representing the minutes. + * @param {Number} sec An integer between 0 and 59 representing the seconds. + * @param {Number} ms An integer between 0 and 999 representing the milliseconds. + * @return {Date} Number of milliseconds since January 1, 1970, 00:00:00, universal time. + */ - return function() { // return a closure so constants get calculated only once - var DC3 = Date.UTC(this.getFullYear(), this.getMonth(), this.getDate() + 3) / ms1d, // an Absolute Day Number - AWN = Math.floor(DC3 / 7), // an Absolute Week Number - Wyr = new Date(AWN * ms7d).getUTCFullYear(); +//Methods - return AWN - Math.floor(Date.UTC(Wyr, 0, 7) / ms7d) + 1; - } - }(), +/** + * @method getDate + * Returns the numeric value corresponding to the current time. + * + * The second statement below assigns the value 25 to the variable `day`, based on the value of the + * `Date` object `Xmas95`. + * + * Xmas95 = new Date("December 25, 1995 23:15:00") + * day = Xmas95.getDate() + * + * @return {Number} Value between 1 and 31. + */ - /** - * Checks if the current date falls within a leap year. - * @return {Boolean} True if the current date falls within a leap year, false otherwise. - */ - isLeapYear : function() { - var year = this.getFullYear(); - return !!((year & 3) == 0 && (year % 100 || (year % 400 == 0 && year))); - }, +/** + * @method getDay + * Returns the numeric value corresponding to the current time. + * + * The value returned by `getDay` is an integer corresponding to the day of the week: 0 for Sunday, 1 + * for Monday, 2 for Tuesday, and so on. + * + * The second statement below assigns the value 1 to `weekday`, based on the value of the `Date` + * object `Xmas95`. December 25, 1995, is a Monday. + * + * Xmas95 = new Date("December 25, 1995 23:15:00"); + * weekday = Xmas95.getDay(); + * + * @return {Number} A numeric representation of the day from Sunday (0) to + * Saturday (6). + */ - /** - * Get the first day of the current month, adjusted for leap year. The returned value - * is the numeric day index within the week (0-6) which can be used in conjunction with - * the {@link #monthNames} array to retrieve the textual day name. - * Example: - *-//dt = Fri May 25 2007 (current date) -var dt = new Date(); - -//dt = Thu May 25 2006 (today's month/day in 2006) -dt = Date.parseDate("2006", "Y"); - -//dt = Sun Jan 15 2006 (all date parts specified) -dt = Date.parseDate("2006-01-15", "Y-m-d"); - -//dt = Sun Jan 15 2006 15:20:01 -dt = Date.parseDate("2006-01-15 3:20:01 PM", "Y-m-d g:i:s A"); - -// attempt to parse Sun Feb 29 2006 03:20:01 in strict mode -dt = Date.parseDate("2006-02-29 03:20:01", "Y-m-d H:i:s", true); // returns null -- * @return {Number} The day number (0-6). - */ - getFirstDayOfMonth : function() { - var day = (this.getDay() - (this.getDate() - 1)) % 7; - return (day < 0) ? (day + 7) : day; - }, +/** + * @method getFullYear + * Returns the numeric value corresponding to the current time. + * + * The value returned by `getFullYear` is an absolute number. For dates between the years 1000 and + * 9999, `getFullYear` returns a four-digit number, for example, 1995. Use this function to make sure + * a year is compliant with years after 2000. + * + * Use this method instead of the `getYear` method. + * + * The following example assigns the four-digit value of the current year to the variable yr. + * + * var today = new Date(); + * var yr = today.getFullYear(); + * + * @return {Number} Four digit representation of the year. + */ - /** - * Get the last day of the current month, adjusted for leap year. The returned value - * is the numeric day index within the week (0-6) which can be used in conjunction with - * the {@link #monthNames} array to retrieve the textual day name. - * Example: - *-var dt = new Date('1/10/2007'); -document.write(Date.dayNames[dt.getFirstDayOfMonth()]); //output: 'Monday' -- * @return {Number} The day number (0-6). - */ - getLastDayOfMonth : function() { - return this.getLastDateOfMonth().getDay(); - }, +/** + * @method getHours + * Returns the numeric value corresponding to the current time. + * + * The second statement below assigns the value 23 to the variable `hours`, based on the value of the + * `Date` object `Xmas95`. + * + * Xmas95 = new Date("December 25, 1995 23:15:00") + * hours = Xmas95.getHours() + * + * @return {Number} Value between 0 and 23, using 24-hour clock. + */ +/** + * @method getMilliseconds + * Returns the numeric value corresponding to the current time. + * + * The following example assigns the milliseconds portion of the current time to the variable ms. + * + * var ms; + * Today = new Date(); + * ms = Today.getMilliseconds(); + * + * @return {Number} A number between 0 and 999. + */ - /** - * Get the date of the first day of the month in which this date resides. - * @return {Date} - */ - getFirstDateOfMonth : function() { - return new Date(this.getFullYear(), this.getMonth(), 1); - }, +/** + * @method getMinutes + * Returns the numeric value corresponding to the current time. + * + * The second statement below assigns the value 15 to the variable `minutes`, based on the value of + * the `Date` object `Xmas95`. + * + * Xmas95 = new Date("December 25, 1995 23:15:00") + * minutes = Xmas95.getMinutes() + * + * @return {Number} Value between 0 and 59. + */ - /** - * Get the date of the last day of the month in which this date resides. - * @return {Date} - */ - getLastDateOfMonth : function() { - return new Date(this.getFullYear(), this.getMonth(), this.getDaysInMonth()); - }, +/** + * @method getMonth + * Returns the numeric value corresponding to the current time. + * + * The second statement below assigns the value 11 to the variable `month`, based on the value of the + * `Date` object `Xmas95`. + * + * Xmas95 = new Date("December 25, 1995 23:15:00") + * month = Xmas95.getMonth() + * + * @return {Number} An integer between 0 and 11. 0 corresponds to January, 1 to February, and so on. + */ - /** - * Get the number of days in the current month, adjusted for leap year. - * @return {Number} The number of days in the month. - */ - getDaysInMonth: function() { - var daysInMonth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]; +/** + * @method getSeconds + * Returns the numeric value corresponding to the current time. + * + * The second statement below assigns the value 30 to the variable `secs`, based on the value of the + * `Date` object `Xmas95`. + * + * Xmas95 = new Date("December 25, 1995 23:15:30") + * secs = Xmas95.getSeconds() + * + * @return {Number} Value between 0 and 59. + */ - return function() { // return a closure for efficiency - var m = this.getMonth(); +/** + * @method getTime + * Returns the numeric value corresponding to the current time. + * + * The value returned by the `getTime` method is the number of milliseconds since 1 January 1970 + * 00:00:00 UTC. You can use this method to help assign a date and time to another `Date` object. + * + * This method is functionally equivalent to the `valueOf` method. + * + * Using getTime for copying dates + * + * Constructing a date object with the identical time value. + * + * var birthday = new Date(1994, 12, 10); + * var copy = new Date(); + * copy.setTime(birthday.getTime()); + * + * Measuring execution time + * + * Subtracting two subsequent getTime calls on newly generated Date objects, give the time span + * between these two calls. This can be used to calculate the executing time of some operations. + * + * var end, start; + * + * start = new Date(); + * for (var i = 0; i < 1000; i++) + * Math.sqrt(i); + * end = new Date(); + * + * console.log("Operation took " + (end.getTime() - start.getTime()) + " msec"); + * + * @return {Number} Number of milliseconds since 1/1/1970 (GMT). + */ - return m == 1 && this.isLeapYear() ? 29 : daysInMonth[m]; - } - }(), +/** + * @method getTimezoneOffset + * Returns the numeric value corresponding to the current time. + * + * The time-zone offset is the difference, in minutes, between UTC and local time. Note that this + * means that the offset is positive if the local timezone is behind UTC and negative if it is ahead. + * For example, if your time zone is UTC+10 (Australian Eastern Standard Time), -600 will be returned. + * Daylight savings time prevents this value from being a constant even for a given locale + * + * x = new Date() + * currentTimeZoneOffsetInHours = x.getTimezoneOffset()/60 + * + * @return {Number} Minutes between GMT and local time. + */ - /** - * Get the English ordinal suffix of the current day (equivalent to the format specifier 'S'). - * @return {String} 'st, 'nd', 'rd' or 'th'. - */ - getSuffix : function() { - switch (this.getDate()) { - case 1: - case 21: - case 31: - return "st"; - case 2: - case 22: - return "nd"; - case 3: - case 23: - return "rd"; - default: - return "th"; - } - }, +/** + * @method getUTCDate + * Returns the numeric value corresponding to the current time. + * + * The following example assigns the day portion of the current date to the variable `d`. + * + * var d; + * Today = new Date(); + * d = Today.getUTCDate(); + * + * @return {Number} Integer between 1 and 31 representing the day. + */ - /** - * Creates and returns a new Date instance with the exact same date value as the called instance. - * Dates are copied and passed by reference, so if a copied date variable is modified later, the original - * variable will also be changed. When the intention is to create a new variable that will not - * modify the original instance, you should create a clone. - * - * Example of correctly cloning a date: - *-var dt = new Date('1/10/2007'); -document.write(Date.dayNames[dt.getLastDayOfMonth()]); //output: 'Wednesday' -- * @return {Date} The new Date instance. - */ - clone : function() { - return new Date(this.getTime()); - }, +/** + * @method getUTCFullYear + * Returns the numeric value corresponding to the current time. + * + * The following example assigns the four-digit value of the current year to the variable `yr`. + * + * var yr; + * Today = new Date(); + * yr = Today.getUTCFullYear(); + * + * @return {Number} Four digit representation of the year. + */ - /** - * Checks if the current date is affected by Daylight Saving Time (DST). - * @return {Boolean} True if the current date is affected by DST. - */ - isDST : function() { - // adapted from http://extjs.com/forum/showthread.php?p=247172#post247172 - // courtesy of @geoffrey.mcgill - return new Date(this.getFullYear(), 0, 1).getTimezoneOffset() != this.getTimezoneOffset(); - }, +/** + * @method getUTCHours + * Returns the numeric value corresponding to the current time. + * + * The following example assigns the hours portion of the current time to the variable `hrs`. + * + * var hrs; + * Today = new Date(); + * hrs = Today.getUTCHours(); + * + * @return {Number} Value between 0 and 23. + */ - /** - * Attempts to clear all time information from this Date by setting the time to midnight of the same day, - * automatically adjusting for Daylight Saving Time (DST) where applicable. - * (note: DST timezone information for the browser's host operating system is assumed to be up-to-date) - * @param {Boolean} clone true to create a clone of this date, clear the time and return it (defaults to false). - * @return {Date} this or the clone. - */ - clearTime : function(clone) { - if (clone) { - return this.clone().clearTime(); - } +/** + * @method getUTCMilliseconds + * Returns the numeric value corresponding to the current time. + * + * The following example assigns the milliseconds portion of the current time to the variable `ms`. + * + * var ms; + * Today = new Date(); + * ms = Today.getUTCMilliseconds(); + * + * @return {Number} Milliseconds portion of the Date. + */ - // get current date before clearing time - var d = this.getDate(); +/** + * @method getUTCMinutes + * Returns the numeric value corresponding to the current time. + * + * The following example assigns the minutes portion of the current time to the variable `min`. + * + * var min; + * Today = new Date(); + * min = Today.getUTCMinutes(); + * + * @return {Number} Value between 0 and 59. + */ - // clear time - this.setHours(0); - this.setMinutes(0); - this.setSeconds(0); - this.setMilliseconds(0); +/** + * @method getUTCMonth + * Returns the numeric value corresponding to the current time. + * + * The following example assigns the month portion of the current date to the variable `mon`. + * + * var mon; + * Today = new Date(); + * mon = Today.getUTCMonth(); + * + * @return {Number} Value between 0 (January) and 11 (December). +*/ - if (this.getDate() != d) { // account for DST (i.e. day of month changed when setting hour = 0) - // note: DST adjustments are assumed to occur in multiples of 1 hour (this is almost always the case) - // refer to http://www.timeanddate.com/time/aboutdst.html for the (rare) exceptions to this rule +/** + * @method getUTCSeconds + * Returns the numeric value corresponding to the current time. + * + * The following example assigns the seconds portion of the current time to the variable `sec`. + * + * var sec; + * Today = new Date(); + * sec = Today.getUTCSeconds(); + * + * @return {Number} Value between 0 and 59. +*/ - // increment hour until cloned date == current date - for (var hr = 1, c = this.add(Date.HOUR, hr); c.getDate() != d; hr++, c = this.add(Date.HOUR, hr)); +/** + * @method setDate + * Sets the day of the month (1-31) for a specified date according to local time. + * + * If the parameter you specify is outside of the expected range, `setDate` attempts to update the + * date information in the `Date` object accordingly. For example, if you use 0 for `dayValue`, the + * date will be set to the last day of the previous month. + * + * The second statement below changes the day for theBigDay to July 24 from its original value. + * + * theBigDay = new Date("July 27, 1962 23:30:00") + * theBigDay.setDate(24) + * + * @param {Number} dayValue An integer from 1 to 31, representing the day of the month. + * @return {Number} New date represented as milliseconds. +*/ - this.setDate(d); - this.setHours(c.getHours()); - } +/** + * @method setFullYear + * Sets the full year (4 digits for 4-digit years) for a specified date according to + * local time. + * + * If you do not specify the `monthValue` and `dayValue` parameters, the values returned from the + * `getMonth` and `getDate` methods are used. + * + * If a parameter you specify is outside of the expected range, `setFullYear` attempts to update the + * other parameters and the date information in the `Date` object accordingly. For example, if you + * specify 15 for monthValue, the year is incremented by 1 (year + 1), and 3 is used for the month. + * + * theBigDay = new Date(); + * theBigDay.setFullYear(1997); + * + * @param {Number} yearValue An integer specifying the numeric value of the year, for example, 1995. + * @param {Number} monthValue An integer between 0 and 11 representing the months January through + * December. + * @param {Number} dayValue An integer between 1 and 31 representing the day of the month. If you + * specify the `dayValue` parameter, you must also specify the `monthValue`. + * @return {Number} New date represented as milliseconds. + */ - return this; - }, +/** + * @method setHours + * Sets the hours (0-23) for a specified date according to local time. + * + * If you do not specify the `minutesValue`, `secondsValue`, and `msValue` parameters, the values + * returned from the `getUTCMinutes`, `getUTCSeconds`, and `getMilliseconds` methods are used. + * + * If a parameter you specify is outside of the expected range, setHours attempts to update the date + * information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`, the + * minutes will be incremented by 1 (min + 1), and 40 will be used for seconds. + * + * theBigDay.setHours(7) + * + * @param {Number} hoursValue An integer between 0 and 23, representing the hour. + * @param {Number} minutesValue An integer between 0 and 59, representing the minutes. + * @param {Number} secondsValue An integer between 0 and 59, representing the seconds. If you specify the + * `secondsValue` parameter, you must also specify the `minutesValue`. + * @param {Number} msValue A number between 0 and 999, representing the milliseconds. If you specify the + * `msValue` parameter, you must also specify the `minutesValue` and `secondsValue`. + * @return {Number} New date represented as milliseconds. + */ - /** - * Provides a convenient method for performing basic date arithmetic. This method - * does not modify the Date instance being called - it creates and returns - * a new Date instance containing the resulting date value. - * - * Examples: - *-//wrong way: -var orig = new Date('10/1/2006'); -var copy = orig; -copy.setDate(5); -document.write(orig); //returns 'Thu Oct 05 2006'! +/** + * @method getUTCDay + * Returns the numeric value corresponding to the current time. + * + * The following example assigns the weekday portion of the current date to the variable `weekday`. + * + * var weekday; + * Today = new Date() + * weekday = Today.getUTCDay() + * + * @return {Number} A numeric representation of the day from Sunday (0) to + * Saturday (6). + */ -//correct way: -var orig = new Date('10/1/2006'); -var copy = orig.clone(); -copy.setDate(5); -document.write(orig); //returns 'Thu Oct 01 2006' -- * - * @param {String} interval A valid date interval enum value. - * @param {Number} value The amount to add to the current date. - * @return {Date} The new Date instance. - */ - add : function(interval, value) { - var d = this.clone(); - if (!interval || value === 0) return d; +/** + * @method setMonth + * Sets the month (0-11) for a specified date according to local time. + * + * If you do not specify the `dayValue` parameter, the value returned from the `getDate` method is + * used. + * + * If a parameter you specify is outside of the expected range, `setMonth` attempts to update the date + * information in the `Date` object accordingly. For example, if you use 15 for `monthValue`, the year + * will be incremented by 1 (year + 1), and 3 will be used for month. + * + * theBigDay.setMonth(6) + * + * @param {Number} monthValue An integer between 0 and 11 (representing the months January through + * December). + * @param {Number} dayValue An integer from 1 to 31, representing the day of the month. + * @return {Number} New date represented as milliseconds. + */ - switch(interval.toLowerCase()) { - case Date.MILLI: - d.setMilliseconds(this.getMilliseconds() + value); - break; - case Date.SECOND: - d.setSeconds(this.getSeconds() + value); - break; - case Date.MINUTE: - d.setMinutes(this.getMinutes() + value); - break; - case Date.HOUR: - d.setHours(this.getHours() + value); - break; - case Date.DAY: - d.setDate(this.getDate() + value); - break; - case Date.MONTH: - var day = this.getDate(); - if (day > 28) { - day = Math.min(day, this.getFirstDateOfMonth().add('mo', value).getLastDateOfMonth().getDate()); - } - d.setDate(day); - d.setMonth(this.getMonth() + value); - break; - case Date.YEAR: - d.setFullYear(this.getFullYear() + value); - break; - } - return d; - }, +/** + * @method setSeconds + * Sets the seconds (0-59) for a specified date according to local time. + * + * If you do not specify the `msValue` parameter, the value returned from the `getMilliseconds` method + * is used. + * + * If a parameter you specify is outside of the expected range, `setSeconds` attempts to update the + * date information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`, + * the minutes stored in the `Date` object will be incremented by 1, and 40 will be used for seconds. + * + * theBigDay.setSeconds(30) + * + * @param {Number} secondsValue An integer between 0 and 59. + * @param {Number} msValue A number between 0 and 999, representing the milliseconds. If you specify + * the`msValue` parameter, you must also specify the `minutesValue` and `secondsValue`. + * @return {Number} New date represented as milliseconds. + */ - /** - * Checks if this date falls on or between the given start and end dates. - * @param {Date} start Start date - * @param {Date} end End date - * @return {Boolean} true if this date falls on or between the given start and end dates. - */ - between : function(start, end) { - var t = this.getTime(); - return start.getTime() <= t && t <= end.getTime(); - } -}); +/** + * @method setTime + * Sets the Date object to the time represented by a number of milliseconds since + * January 1, 1970, 00:00:00 UTC, allowing for negative numbers for times prior. + * + * Use the `setTime` method to help assign a date and time to another `Date` object. + * + * theBigDay = new Date("July 1, 1999") + * sameAsBigDay = new Date() + * sameAsBigDay.setTime(theBigDay.getTime()) + * + * @param {Number} timeValue An integer representing the number of milliseconds since 1 January + * 1970, 00:00:00 UTC. + * @return {Number} New date represented as milliseconds. + */ +/** + * @method setUTCDate + * Sets the day of the month (1-31) for a specified date according to universal time. + * + * If a parameter you specify is outside of the expected range, `setUTCDate` attempts to update the + * date information in the `Date` object accordingly. For example, if you use 40 for `dayValue`, and + * the month stored in the `Date` object is June, the day will be changed to 10 and the month will be + * incremented to July. + * + * theBigDay = new Date(); + * theBigDay.setUTCDate(20); + * + * @param {Number} dayValue An integer from 1 to 31, representing the day of the month. + * @return {Number} New date represented as milliseconds. + */ -/** - * Formats a date given the supplied format string. - * @param {String} format The format string. - * @return {String} The formatted date. - * @method format +/** + * @method setUTCFullYear + * Sets the full year (4 digits for 4-digit years) for a specified date according + * to universal time. + * + * If you do not specify the `monthValue` and `dayValue` parameters, the values returned from the + * `getMonth` and `getDate` methods are used. + * + * If a parameter you specify is outside of the expected range, `setUTCFullYear` attempts to update + * the other parameters and the date information in the `Date` object accordingly. For example, if you + * specify 15 for `monthValue`, the year is incremented by 1 (year + 1), and 3 is used for the month. + * + * theBigDay = new Date(); + * theBigDay.setUTCFullYear(1997); + * + * @param {Number} yearValue An integer specifying the numeric value of the year, for example, 1995. + * @param {Number} monthValue An integer between 0 and 11 representing the months January through + * December. + * @param {Number} dayValue An integer between 1 and 31 representing the day of the month. If you + * specify the `dayValue` parameter, you must also specify the `monthValue`. + * @return {Number} New date represented as milliseconds. */ -Date.prototype.format = Date.prototype.dateFormat; +/** + * @method setUTCHours + * Sets the hour (0-23) for a specified date according to universal time. + * + * If you do not specify the `minutesValue`, `secondsValue`, and `msValue` parameters, the values + * returned from the `getUTCMinutes`, `getUTCSeconds`, and `getUTCMilliseconds` methods are used. + * + * If a parameter you specify is outside of the expected range, `setUTCHours` attempts to update the + * date information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`, + * the minutes will be incremented by 1 (min + 1), and 40 will be used for seconds. + * + * theBigDay = new Date(); + * theBigDay.setUTCHours(8); + * + * @param {Number} hoursValue An integer between 0 and 23, representing the hour. + * @param {Number} minutesValue An integer between 0 and 59, representing the minutes. + * @param {Number} secondsValue An integer between 0 and 59, representing the seconds. If you specify the + * `secondsValue` parameter, you must also specify the `minutesValue`. + * @param {Number} msValue A number between 0 and 999, representing the milliseconds. If you specify the + * `msValue` parameter, you must also specify the `minutesValue` and `secondsValue`. + * @return {Number} New date represented as milliseconds. + */ -// private -if (Ext.isSafari && (navigator.userAgent.match(/WebKit\/(\d+)/)[1] || NaN) < 420) { - Ext.apply(Date.prototype, { - _xMonth : Date.prototype.setMonth, - _xDate : Date.prototype.setDate, +/** + * @method setUTCMilliseconds + * Sets the milliseconds (0-999) for a specified date according to universal time. + * + * If a parameter you specify is outside of the expected range, `setUTCMilliseconds` attempts to + * update the date information in the `Date` object accordingly. For example, if you use 1100 for + * `millisecondsValue`, the seconds stored in the Date object will be incremented by 1, and 100 will + * be used for milliseconds. + * + * theBigDay = new Date(); + * theBigDay.setUTCMilliseconds(500); + * + * @param {Number} millisecondsValue A number between 0 and 999, representing the milliseconds. + * @return {Number} New date represented as milliseconds. + */ - // Bug in Safari 1.3, 2.0 (WebKit build < 420) - // Date.setMonth does not work consistently if iMonth is not 0-11 - setMonth : function(num) { - if (num <= -1) { - var n = Math.ceil(-num), - back_year = Math.ceil(n / 12), - month = (n % 12) ? 12 - n % 12 : 0; +/** + * @method setUTCMinutes + * Sets the minutes (0-59) for a specified date according to universal time. + * + * If you do not specify the `secondsValue` and `msValue` parameters, the values returned from + * `getUTCSeconds` and `getUTCMilliseconds` methods are used. + * + * If a parameter you specify is outside of the expected range, `setUTCMinutes` attempts to update the + * date information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`, + * the minutes (`minutesValue`) will be incremented by 1 (`minutesValue` + 1), and 40 will be used for + * seconds. + * + * theBigDay = new Date(); + * theBigDay.setUTCMinutes(43); + * + * @param {Number} minutesValue An integer between 0 and 59, representing the minutes. + * @param {Number} secondsValue An integer between 0 and 59, representing the seconds. If you specify the `secondsValue` parameter, you must also specify the `minutesValue`. + * @param {Number} msValue A number between 0 and 999, representing the milliseconds. If you specify the `msValue` parameter, you must also specify the `minutesValue` and `secondsValue`. + * @return {Number} New date represented as milliseconds. + */ - this.setFullYear(this.getFullYear() - back_year); +/** + * @method setUTCMonth + * Sets the month (0-11) for a specified date according to universal time. + * + * If you do not specify the `dayValue` parameter, the value returned from the `getUTCDate` method is + * used. + * + * If a parameter you specify is outside of the expected range, `setUTCMonth` attempts to update the + * date information in the `Date` object accordingly. For example, if you use 15 for `monthValue`, the + * year will be incremented by 1 (year + 1), and 3 will be used for month. + * + * theBigDay = new Date(); + * theBigDay.setUTCMonth(11); + * + * @param {Number} monthValue An integer between 0 and 11, representing the months January through + * December. + * @param {Number} dayValue An integer from 1 to 31, representing the day of the month. + * @return {Number} New date represented as milliseconds. + */ - return this._xMonth(month); - } else { - return this._xMonth(num); - } - }, +/** + * @method setUTCSeconds + * Sets the seconds (0-59) for a specified date according to universal time. + * + * If you do not specify the `msValue` parameter, the value returned from the `getUTCMilliseconds` + * methods is used. + * + * If a parameter you specify is outside of the expected range, `setUTCSeconds` attempts to update the + * date information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`, + * the minutes stored in the `Date` object will be incremented by 1, and 40 will be used for seconds. + * + * theBigDay = new Date(); + * theBigDay.setUTCSeconds(20); + * + * @param {Number} secondsValue An integer between 0 and 59. + * @param {Number} msValue A number between 0 and 999, representing the milliseconds. + * @return {Number} New date represented as milliseconds. + */ - // Bug in setDate() method (resolved in WebKit build 419.3, so to be safe we target Webkit builds < 420) - // The parameter for Date.setDate() is converted to a signed byte integer in Safari - // http://brianary.blogspot.com/2006/03/safari-date-bug.html - setDate : function(d) { - // use setTime() to workaround setDate() bug - // subtract current day of month in milliseconds, then add desired day of month in milliseconds - return this.setTime(this.getTime() - (this.getDate() - d) * 864e5); - } - }); -} +/** + * @method toDateString + * Returns the "date" portion of the Date as a human-readable string in American English. + * + * {@link Date} instances refer to a specific point in time. Calling `toString` will return the + * date formatted in a human readable form in American English. In SpiderMonkey, this consists of the + * date portion (day, month, and year) followed by the time portion (hours, minutes, seconds, and time + * zone). Sometimes it is desirable to obtain a string of the date portion; such a thing can be + * accomplished with the `toDateString` method. + * + * The `toDateString` method is especially useful because compliant engines implementing ECMA-262 may + * differ in the string obtained from `toString` for `Date` objects, as the format is implementation- + * dependent and simple string slicing approaches may not produce consistent results across multiple + * engines. + * + * var d = new Date(1993, 6, 28, 14, 39, 7); + * println(d.toString()); // prints Wed Jul 28 1993 14:39:07 GMT-0600 (PDT) + * println(d.toDateString()); // prints Wed Jul 28 1993 + * + * @return {String} Human-readable string, in local time. + */ +/** + * @method toLocaleDateString + * Returns the "date" portion of the Date as a string, using the current locale's + * conventions. + * + * The `toLocaleDateString` method relies on the underlying operating system in formatting dates. It + * converts the date to a string using the formatting convention of the operating system where the + * script is running. For example, in the United States, the month appears before the date (04/15/98), + * whereas in Germany the date appears before the month (15.04.98). If the operating system is not + * year-2000 compliant and does not use the full year for years before 1900 or over 2000, + * `toLocaleDateString` returns a string that is not year-2000 compliant. `toLocaleDateString` behaves + * similarly to `toString` when converting a year that the operating system does not properly format. + * + * Methods such as `getDate`, `getMonth`, and `getFullYear` give more portable results than + * `toLocaleDateString`. Use `toLocaleDateString` when the intent is to display to the user a string + * formatted using the regional format chosen by the user. Be aware that this method, due to its + * nature, behaves differently depending on the operating system and on the user's settings. + * + * In the following example, `today` is a `Date` object: + * + * today = new Date(95,11,18,17,28,35) //months are represented by 0 to 11 + * today.toLocaleDateString() + * + * In this example, `toLocaleDateString` returns a string value that is similar to the following form. + * The exact format depends on the platform, locale and user's settings. + * + * 12/18/95 + * + * You shouldn't use this method in contexts where you rely on a particular format or locale. + * + * "Last visit: " + someDate.toLocaleDateString(); // Good example + * "Last visit was at " + someDate.toLocaleDateString(); // Bad example + * + * @return {String} Human-readable string that may be formatted differently depending + * on the country. + */ +/** + * @method toLocaleString + * Converts a date to a string, using the current locale's conventions. Overrides + * the `Object.toLocaleString` method. + * + * The `toLocaleString` method relies on the underlying operating system in formatting dates. It + * converts the date to a string using the formatting convention of the operating system where the + * script is running. For example, in the United States, the month appears before the date (04/15/98), + * whereas in Germany the date appears before the month (15.04.98). If the operating system is not + * year-2000 compliant and does not use the full year for years before 1900 or over 2000, + * `toLocaleString` returns a string that is not year-2000 compliant. `toLocaleString` behaves + * similarly to `toString` when converting a year that the operating system does not properly format. + * + * Methods such as `getDate`, `getMonth`, `getFullYear`, `getHours`, `getMinutes`, and `getSeconds` + * give more portable results than `toLocaleString`. Use `toLocaleString` when the intent is to + * display to the user a string formatted using the regional format chosen by the user. Be aware that + * this method, due to its nature, behaves differently depending on the operating system and on the + * user's settings. + * + * In the following example, `today` is a `Date` object: + * + * today = new Date(95,11,18,17,28,35); //months are represented by 0 to 11 + * today.toLocaleString(); + * + * In this example, `toLocaleString` returns a string value that is similar to the following form. The + * exact format depends on the platform, locale and user's settings. + * + * 12/18/95 17:28:35 + * + * You shouldn't use this method in contexts where you rely on a particular format or locale. + * + * "Last visit: " + someDate.toLocaleString(); // Good example + * "Last visit was at " + someDate.toLocaleString(); // Bad example + * + * @return {String} Human-readable string that may be formatted differently depending + * on the country. + */ -/* Some basic Date tests... (requires Firebug) +/** + * @method toLocaleTimeString + * Returns the "time" portion of the Date as a string, using the current locale's + * conventions. + * + * The `toLocaleTimeString` method relies on the underlying operating system in formatting dates. It + * converts the date to a string using the formatting convention of the operating system where the + * script is running. For example, in the United States, the month appears before the date (04/15/98), + * whereas in Germany the date appears before the month (15.04.98). + * + * Methods such as `getHours`, `getMinutes`, and `getSeconds` give more consistent results than + * `toLocaleTimeString`. Use `toLocaleTimeString` when the intent is to display to the user a string + * formatted using the regional format chosen by the user. Be aware that this method, due to its + * nature, behaves differently depending on the operating system and on the user's settings. + * + * In the following example, `today` is a `Date` object: + * + * today = new Date(95,11,18,17,28,35) //months are represented by 0 to 11 + * today.toLocaleTimeString() + * + * In this example, `toLocaleTimeString` returns a string value that is similar to the following form. + * The exact format depends on the platform. + * + * 17:28:35 + * + * You shouldn't use this method in contexts where you rely on a particular format or locale. + * + * "Last visit: " + someDate.toLocaleTimeString(); // Good example + * "Last visit was at " + someDate.toLocaleTimeString(); // Bad example + * + * @return {String} Human-readable string that may be formatted differently depending + * on the country. + */ -Date.parseDate('', 'c'); // call Date.parseDate() once to force computation of regex string so we can console.log() it -console.log('Insane Regex for "c" format: %o', Date.parseCodes.c.s); // view the insane regex for the "c" format specifier +/** + * @method toString + * Returns a string representing the specified Date object. Overrides the + * `Object.prototype.toString` method. + * + * The `Date` object overrides the toString method of the Object object; it does not inherit + * `Object.toString`. For `Date` objects, the `toString` method returns a string representation of the + * object. + * + * `toString` always returns a string representation of the date in American English. + * + * JavaScript calls the `toString` method automatically when a date is to be represented as a text + * value or when a date is referred to in a string concatenation. + * + * The following assigns the `toString` value of a `Date` object to `myVar`: + * + * x = new Date(); + * myVar=x.toString(); //assigns a value to myVar similar to: + * //Mon Sep 28 1998 14:36:22 GMT-0700 (Pacific Daylight Time) + * + * @return {String} Human-readable string of the date in local time. + */ -// standard tests -console.group('Standard Date.parseDate() Tests'); - console.log('Date.parseDate("2009-01-05T11:38:56", "c") = %o', Date.parseDate("2009-01-05T11:38:56", "c")); // assumes browser's timezone setting - console.log('Date.parseDate("2009-02-04T12:37:55.001000", "c") = %o', Date.parseDate("2009-02-04T12:37:55.001000", "c")); // assumes browser's timezone setting - console.log('Date.parseDate("2009-03-03T13:36:54,101000Z", "c") = %o', Date.parseDate("2009-03-03T13:36:54,101000Z", "c")); // UTC - console.log('Date.parseDate("2009-04-02T14:35:53.901000-0530", "c") = %o', Date.parseDate("2009-04-02T14:35:53.901000-0530", "c")); // GMT-0530 - console.log('Date.parseDate("2009-05-01T15:34:52,9876000+08:00", "c") = %o', Date.parseDate("2009-05-01T15:34:52,987600+08:00", "c")); // GMT+08:00 -console.groupEnd(); +/** + * @method toTimeString + * Returns the "time" portion of the Date as a human-readable string. + * + * {@link Date} instances refer to a specific point in time. Calling `toString` will return the + * date formatted in a human readable form in American English. In SpiderMonkey, this consists of the + * date portion (day, month, and year) followed by the time portion (hours, minutes, seconds, and + * time zone). Sometimes it is desirable to obtain a string of the time portion; such a thing can be + * accomplished with the `toTimeString` method. + * + * The `toTimeString` method is especially useful because compliant engines implementing ECMA-262 may + * differ in the string obtained from `toString` for `Date` objects, as the format is implementation- + * dependent; simple string slicing approaches may not produce consistent results across multiple + * engines. + * + * var d = new Date(1993, 6, 28, 14, 39, 7); + * println(d.toString()); // prints Wed Jul 28 1993 14:39:07 GMT-0600 (PDT) + * println(d.toTimeString()); // prints 14:39:07 GMT-0600 (PDT) + * + * @return {String} Human-readable string of the date in local time. + */ -// ISO-8601 format as specified in http://www.w3.org/TR/NOTE-datetime -// -- accepts ALL 6 levels of date-time granularity -console.group('ISO-8601 Granularity Test (see http://www.w3.org/TR/NOTE-datetime)'); - console.log('Date.parseDate("1997", "c") = %o', Date.parseDate("1997", "c")); // YYYY (e.g. 1997) - console.log('Date.parseDate("1997-07", "c") = %o', Date.parseDate("1997-07", "c")); // YYYY-MM (e.g. 1997-07) - console.log('Date.parseDate("1997-07-16", "c") = %o', Date.parseDate("1997-07-16", "c")); // YYYY-MM-DD (e.g. 1997-07-16) - console.log('Date.parseDate("1997-07-16T19:20+01:00", "c") = %o', Date.parseDate("1997-07-16T19:20+01:00", "c")); // YYYY-MM-DDThh:mmTZD (e.g. 1997-07-16T19:20+01:00) - console.log('Date.parseDate("1997-07-16T19:20:30+01:00", "c") = %o', Date.parseDate("1997-07-16T19:20:30+01:00", "c")); // YYYY-MM-DDThh:mm:ssTZD (e.g. 1997-07-16T19:20:30+01:00) - console.log('Date.parseDate("1997-07-16T19:20:30.45+01:00", "c") = %o', Date.parseDate("1997-07-16T19:20:30.45+01:00", "c")); // YYYY-MM-DDThh:mm:ss.sTZD (e.g. 1997-07-16T19:20:30.45+01:00) - console.log('Date.parseDate("1997-07-16 19:20:30.45+01:00", "c") = %o', Date.parseDate("1997-07-16 19:20:30.45+01:00", "c")); // YYYY-MM-DD hh:mm:ss.sTZD (e.g. 1997-07-16T19:20:30.45+01:00) - console.log('Date.parseDate("1997-13-16T19:20:30.45+01:00", "c", true)= %o', Date.parseDate("1997-13-16T19:20:30.45+01:00", "c", true)); // strict date parsing with invalid month value -console.groupEnd(); +/** + * @method toUTCString + * Converts a date to a string, using the universal time convention. + * + * The value returned by `toUTCString` is a readable string in American English in the UTC time zone. + * The format of the return value may vary according to the platform. + * + * var today = new Date(); + * var UTCstring = today.toUTCString(); + * // Mon, 03 Jul 2006 21:44:38 GMT + * + * @return {String} String of the date in UTC. + */ -//*/-// Basic usage: -var dt = new Date('10/29/2006').add(Date.DAY, 5); -document.write(dt); //returns 'Fri Nov 03 2006 00:00:00' +/** + * @method setMilliseconds + * Sets the milliseconds (0-999) for a specified date according to local time. + * + * If you specify a number outside the expected range, the date information in the `Date` object is + * updated accordingly. For example, if you specify 1005, the number of seconds is incremented by 1, + * and 5 is used for the milliseconds. + * + * theBigDay = new Date(); + * theBigDay.setMilliseconds(100); + * + * @param {Number} millisecondsValue A number between 0 and 999, representing the milliseconds. + * @return {Number} New date represented as milliseconds. + */ -// Negative values will be subtracted: -var dt2 = new Date('10/1/2006').add(Date.DAY, -5); -document.write(dt2); //returns 'Tue Sep 26 2006 00:00:00' +/** + * @method setMinutes + * Sets the minutes (0-59) for a specified date according to local time. + * + * If you do not specify the `secondsValue` and `msValue` parameters, the values returned from + * `getSeconds` and `getMilliseconds` methods are used. + * + * If a parameter you specify is outside of the expected range, `setMinutes` attempts to update the + * date information in the `Date` object accordingly. For example, if you use 100 for `secondsValue`, + * the minutes (`minutesValue`) will be incremented by 1 (minutesValue + 1), and 40 will be used for + * seconds. + * + * theBigDay.setMinutes(45) + * + * @param {Number} minutesValue An integer between 0 and 59, representing the minutes. + * @param {Number} secondsValue An integer between 0 and 59, representing the seconds. If you + * specify the secondsValue parameter, you must also specify the `minutesValue`. + * @param {Number} msValue A number between 0 and 999, representing the milliseconds. If you specify + * the `msValue` parameter, you must also specify the `minutesValue` and `secondsValue`. + * @return {Number} New date represented as milliseconds. + */ -// You can even chain several calls together in one line: -var dt3 = new Date('10/1/2006').add(Date.DAY, 5).add(Date.HOUR, 8).add(Date.MINUTE, -30); -document.write(dt3); //returns 'Fri Oct 06 2006 07:30:00' -