NAME

Date::Utility - A class that represents a datetime in various format

SYNOPSIS

use Date::Utility;

Date::Utility->new(); # Use current time
Date::Utility->new(1249637400);
Date::Utility->new('dd-mmm-yy');
Date::Utility->new('dd-mmm-yyyy');
Date::Utility->new('dd-Mmm-yy hh:mm:ssGMT');
Date::Utility->new('dd-Mmm-yy hhhmm');
Date::Utility->new('YYYY-MM-DD');
Date::Utility->new('YYYYMMDD');
Date::Utility->new('YYYYMMDDHHMMSS');
Date::Utility->new('YYYY-MM-DD HH:MM:SS');
Date::Utility->new('YYYY-MM-DDTHH:MM:SSZ');

DESCRIPTION

A class that represents a datetime in various format

ATTRIBUTES

second

minute

hour

day_of_month

month

quarter_of_year

day_of_week

return day of week begin with 0

day_of_year

year

time

time_hhmm

Returns time in hh:mm format

time_hhmmss

Returns time in hh:mm:ss format

time_cutoff

Set the timezone for cutoff to UTC

year_in_two_digit

Returns year in two digit format. Example: 15

timezone

Set the timezone to GMT

datetime

See, db_timestamp

datetime_ddmmmyy_hhmmss_TZ

Returns datetime in "dd-mmm-yy hh:mm:ssGMT" format

datetime_ddmmmyy_hhmmss

Returns datetime in "dd-mmm-yy hh:mm:ss" format

date_ddmmmyyyy

Returns date in dd-mmm-yyyy format

date_ddmonthyyyy

Returns date in dd-month-yyyy format

date

Returns datetime in YYYY-MM-DD format

date_ddmmmyy

Returns datetime in dd-Mmm-yy format

days_since_epoch

Returns number of days since 1970-01-01

seconds_after_midnight

Returns number of seconds after midnight of the same day.

is_a_weekend

is_a_weekday

new

Returns a Date::Utility object.

_parse_datetime_param

User may supplies datetime parameters but it currently only supports the following formats: dd-mmm-yy ddhddGMT, dd-mmm-yy, dd-mmm-yyyy, dd-Mmm-yy hh:mm:ssGMT, YYYY-MM-DD, YYYYMMDD, YYYYMMDDHHMMSS, yyyy-mm-dd hh:mm:ss, yyyy-mm-ddThh:mm:ss or yyyy-mm-ddThh:mm:ssZ.

days_between

Returns number of days between two dates.

is_before

Returns a boolean which indicates whether this date object is earlier in time than the supplied date object.

is_after

Returns a boolean which indicates whether this date object is later in time than the supplied date object.

is_same_as

Returns a boolean which indicates whether this date object is the same time as the supplied date object.

day_as_string

Returns the name of the current day in short form. Example: Sun.

full_day_name

Returns the name of the current day. Example: Sunday

month_as_string

Returns the name of current month in short form. Example: Jan

full_month_name

Returns the full name of current month. Example: January

http_expires_format

Returns datetime in this format: Fri, 27 Nov 2009 02:12:02 GMT

date_ddmmyy

Returns date in this format "dd-mm-yy" (28-02-10)

date_ddmmyyyy

Returns date in this format "dd-mm-yyyy" (28-02-2010)

date_yyyymmdd

Returns date in this format "yyyy-mm-dd" (2010-03-02)

datetime_yyyymmdd_hhmmss

Returns: "yyyy-mm-dd hh:mm:ss" (2010-03-02 05:09:40)

datetime_iso8601 iso8601

Since all internal representations are in UTC Returns "yyyy-mm-ddThh:mm:ssZ" (2010-02-02T05:09:40Z)

datetime_yyyymmdd_hhmmss_TZ

Returns datetime in this format "yyyy-mm-dd hh:mm:ssGMT" (2010-03-02 05:09:40GMT)

days_in_month

timezone_offset

Returns a TimeInterval which represents the difference between UTC and the time in certain timezone

is_dst_in_zone

Returns a boolean which indicates whether a certain zone is in DST at the given epoch

plus_time_interval

Returns a new Date::Utility plus the supplied Time::Duration::Concise::Localize. Negative TimeIntervals will move backward.

Will also attempt to create a TimeInterval from a supplied code, if possible.

minus_time_interval

Returns a new Date::Utility minus the supplied Time::Duration::Concise::Localize. Negative TimeIntervals will move forward.

Will also attempt to create a TimeInterval from a supplied code, if possible.

months_ahead

Returns the month ahead or backward from the supplied month in the format of Mmm-yy. It could hanlde backward or forward move from the supplied month.

move_to_nth_dow

Takes an integer as an ordinal and a day of week representation

The following are all equivalent: move_to_nth_dow(3, 'Monday') move_to_nth_dow(3, 'Mon') move_to_nth_dow(3, 1)

Returning the 3rd Monday of the month represented by the object or undef if it does not exist.

An exception is thrown on improper day of week representations.

STATIC METHODS

month_number_to_abbrev

Static method returns a standard mapping from month numbers to our 3 character abbreviated format.

month_abbrev_to_number

Static method returns a standard mapping from 3 character abbreviated format to month numbers

STATIC METHODS

month_number_to_fullname

Static method returns a standard mapping from month numbers to fullname.

is_epoch_timestamp

Check if a given datetime is an epoch timestemp, i.e. an integer of under 14 digits.

is_ddmmmyy

Check if a given "date" is in dd-Mmm-yy format (e.g. 1-Oct-10)

truncate_to_day

Returns a Date::Utility object with the time part truncated out of it.

For instance, '2011-12-13 23:24:25' will return a new Date::Utility object representing '2011-12-13 00:00:00'

truncate_to_month

Returns a Date::Utility object with the day and time part truncated out of it.

For instance, '2011-12-13 23:24:25' will return a new Date::Utility object representing '2011-12-01 00:00:00'

truncate_to_hour

Returns a Date::Utility object with the minutes and seconds truncated out of it.

For instance, '2011-12-13 23:24:25' will return a new Date::Utility object representing '2011-12-13 23:00:00'

today

Returns Date::Utility object for the start of the current day. Much faster than Date::Utility->new, as it will return the same object till the end of the day.