Date Class
yui3/src/date/js/date-format.js:34
Parent Module: datatype-date
Date provides a set of utility functions to operate against Date objects.
Index
Methods
addDays
-
oDate -
numDays
Adds a specified number of days to the given date.
Parameters:
Returns:
A new Date with the specified number of days added to the original date.
addMonths
-
oDate -
numMonths
Adds a specified number of months to the given date.
Parameters:
Returns:
A new Date with the specified number of months added to the original date.
addYears
-
oDate -
numYears
Adds a specified number of years to the given date.
Parameters:
Returns:
A new Date with the specified number of years added to the original date.
areEqual
-
aDate -
bDate
Checks whether two dates correspond to the same date and time.
Returns:
True if the two dates correspond to the same date and time.
daysInMonth
-
oDate
Takes a native JavaScript Date and returns the number of days in the month that the given date belongs to.
Parameters:
-
oDateDateDate in the month for which the number of days is desired.
Returns:
A number (either 28, 29, 30 or 31) of days in the given month.
format
-
oDate -
oConfig
Takes a native JavaScript Date and formats it as a string for display to user.
Parameters:
-
oDateDateDate.
-
oConfigObject(Optional) Object literal of configuration values: <dl> <dt>format {HTML} (Optional)</dt> <dd> <p> Any strftime string is supported, such as "%I:%M:%S %p". strftime has several format specifiers defined by the Open group at <a href="http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html">http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html</a> PHP added a few of its own, defined at <a href="http://www.php.net/strftime">http://www.php.net/strftime</a> </p> <p> This javascript implementation supports all the PHP specifiers and a few more. The full list is below. </p> <p> If not specified, it defaults to the ISO 8601 standard date format: %Y-%m-%d. </p> <dl> <dt>%a</dt> <dd>abbreviated weekday name according to the current locale</dd> <dt>%A</dt> <dd>full weekday name according to the current locale</dd> <dt>%b</dt> <dd>abbreviated month name according to the current locale</dd> <dt>%B</dt> <dd>full month name according to the current locale</dd> <dt>%c</dt> <dd>preferred date and time representation for the current locale</dd> <dt>%C</dt> <dd>century number (the year divided by 100 and truncated to an integer, range 00 to 99)</dd> <dt>%d</dt> <dd>day of the month as a decimal number (range 01 to 31)</dd> <dt>%D</dt> <dd>same as %m/%d/%y</dd> <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> <dt>%E</dt> <dd>day of the month as a decimal number (range 1 to 31)</dd> <dt>%F</dt> <dd>same as %Y-%m-%d (ISO 8601 date format)</dd> <dt>%g</dt> <dd>like %G, but without the century</dd> <dt>%G</dt> <dd>The 4-digit year corresponding to the ISO week number</dd> <dt>%h</dt> <dd>same as %b</dd> <dt>%H</dt> <dd>hour as a decimal number using a 24-hour clock (range 00 to 23)</dd> <dt>%I</dt> <dd>hour as a decimal number using a 12-hour clock (range 01 to 12)</dd> <dt>%j</dt> <dd>day of the year as a decimal number (range 001 to 366)</dd> <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> <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> <dt>%m</dt> <dd>month as a decimal number (range 01 to 12)</dd> <dt>%M</dt> <dd>minute as a decimal number</dd> <dt>%n</dt> <dd>newline character</dd> <dt>%p</dt> <dd>either "AM" or "PM" according to the given time value, or the corresponding strings for the current locale</dd> <dt>%P</dt> <dd>like %p, but lower case</dd> <dt>%r</dt> <dd>time in a.m. and p.m. notation equal to %I:%M:%S %p</dd> <dt>%R</dt> <dd>time in 24 hour notation equal to %H:%M</dd> <dt>%s</dt> <dd>number of seconds since the Epoch, ie, since 1970-01-01 00:00:00 UTC</dd> <dt>%S</dt> <dd>second as a decimal number</dd> <dt>%t</dt> <dd>tab character</dd> <dt>%T</dt> <dd>current time, equal to %H:%M:%S</dd> <dt>%u</dt> <dd>weekday as a decimal number [1,7], with 1 representing Monday</dd> <dt>%U</dt> <dd>week number of the current year as a decimal number, starting with the first Sunday as the first day of the first week</dd> <dt>%V</dt> <dd>The ISO 8601:1988 week number of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the current year, and with Monday as the first day of the week.</dd> <dt>%w</dt> <dd>day of the week as a decimal, Sunday being 0</dd> <dt>%W</dt> <dd>week number of the current year as a decimal number, starting with the first Monday as the first day of the first week</dd> <dt>%x</dt> <dd>preferred date representation for the current locale without the time</dd> <dt>%X</dt> <dd>preferred time representation for the current locale without the date</dd> <dt>%y</dt> <dd>year as a decimal number without a century (range 00 to 99)</dd> <dt>%Y</dt> <dd>year as a decimal number including the century</dd> <dt>%z</dt> <dd>numerical time zone representation</dd> <dt>%Z</dt> <dd>time zone name or abbreviation</dd> <dt>%%</dt> <dd>a literal "%" character</dd> </dl> </dd> </dl>
Returns:
Formatted date for display.
isGreater
-
aDate -
bDate
Checks whether the first date comes later than the second.
Returns:
True if the first date is later than the second.
isGreaterOrEqual
-
aDate -
bDate
Checks whether the first date comes later than or is the same as the second.
Returns:
True if the first date is later than or the same as the second.
isInRange
-
aDate -
bDate -
cDate
Checks whether the date is between two other given dates.
Parameters:
Returns:
True if the date is between the two other given dates.
isValidDate
-
oDate
Checks whether a native JavaScript Date contains a valid value.
Parameters:
-
oDateDateDate in the month for which the number of days is desired.
Returns:
True if the date argument contains a valid value.
listOfDatesInMonth
-
oDate
Lists all dates in a given month.
Parameters:
-
oDateDateThe date corresponding to the month for which a list of dates is required.
Returns:
An Array of Dates from a given month.
parse
-
mask -
text -
opt_date
Takes a string mask and a text as input and parses it as a native JavaScript Date. If only one argument is passed, the YUI parser will be called for backwards compatibility.
Parameters:
-
maskStringMask as strftime string.
-
textStringText input to be parsed.
-
opt_dateDateOptional Date object to be used a base date for filling the parsed values.
parse {HTML} (Optional)
Any strftime string is supported, such as
%I:%M:%S %p. This format has several specifiers defined by the Open group at: http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.htmlPHP added a few of its own, defined at: http://www.php.net/strftime
This JavaScript implementation supports all the PHP specifiers and a few more. The full list is below:
If not specified, it defaults to the ISO 8601 standard date format:
%Y-%m-%d.- %a abbreviated weekday name according to the current locale
- %A full weekday name according to the current locale
- %b abbreviated month name according to the current locale
- %B full month name according to the current locale
- %c preferred date and time representation for the current locale
- %C century number (the year divided by 100 and truncated to an
integer, range
00to99) - %d day of the month as a decimal number (range
01to31) - %D same as
%m/%d/%y - %e day of the month as a decimal number, a single digit is preceded
by a space (range
1to31) - %E day of the month as a decimal number (range
1to31) - %F same as
%Y-%m-%d(ISO 8601 date format) - %g like
%G, but without the century - %G The 4-digit year corresponding to the ISO week number
- %h same as
%b - %H hour as a decimal number using a 24-hour clock (range
00to23) - %I hour as a decimal number using a 12-hour clock (range
01to12) - %j day of the year as a decimal number (range 001 to 366)
- %k hour as a decimal number using a 24-hour clock (range
0to23); single digits are preceded by a blank. (See also%H.) - %l hour as a decimal number using a 12-hour clock (range
1to12); single digits are preceded by a blank. (See also%I.) - %m month as a decimal number (range
01to12) - %M minute as a decimal number
- %n newline character
- %p either
AMorPMaccording to the given time value, or the corresponding strings for the current locale - %P like
%p, but lower case - %r time in a.m. and p.m. notation equal to
%I:%M:%S %p - %R time in 24 hour notation equal to
%H:%M - %s number of seconds since the Epoch, ie, since
1970-01-01 00:00:00UTC - %S second as a decimal number
- %t tab character
- %T current time, equal to
%H:%M:%S - %u weekday as a decimal number [1,7], with 1 representing Monday
- %U week number of the current year as a decimal number, starting with the first Sunday as the first day of the first week
- %V The ISO 8601:1988 week number of the current year as a decimal
number, range
01to53, where week 1 is the first week that has at least 4 days in the current year, and with Monday as the first day of the week. - %w day of the week as a decimal, Sunday being 0
- %W week number of the current year as a decimal number, starting with the first Monday as the first day of the first week
- %x preferred date representation for the current locale without the time
- %X preferred time representation for the current locale without the date
- %y year as a decimal number without a century (range
00to99) - %Y year as a decimal number including the century
- %z numerical time zone representation
- %Z time zone name or abbreviation
- %% a literal
%character
Returns:
native JavaScript Date. Returns false if cannot parse.