Constructors¶

DateTime::Format::ISO8601->new( ... )

Accepts an optional hash.

    my $iso8601 = DateTime::Format::ISO8601->new(
        base_datetime => $dt,
        cut_off_year  => 42,
        legacy_year   => 1,
    );

• base_datetime

  A "DateTime" object that will be used to fill in missing information from incomplete date/time formats.

  This key is optional.

• cut_off_year

  A integer representing the cut-off point between interpreting 2-digits years as 19xx or 20xx.

      2-digit years <  cut_off_year will be interpreted as 20xx
      2-digit years >= cut_off_year will be untreated as 19xx
      

  This key defaults to the value of "DefaultCutOffYear".

• legacy_year

  A boolean value controlling if a 2-digit year is interpreted as being in the current century (unless a "base_datetime" is set) or if "cut_off_year" should be used to place the year in either 20xx or 19xx.

  If this is true, then the "cut_off_year" is used. If this is false, then the year is always interpreted as being in the current century.

  This key defaults to the value of "DefaultLegacyYear".

$iso8601->clone

Returns a replica of the given object.

Object Methods¶

$iso8601->base_datetime

Returns a "DateTime" object if a "base_datetime" has been set.

$iso8601->set_base_datetime( object => $object )

Accepts a "DateTime" object that will be used to fill in missing information from incomplete date/time formats.

$iso8601->cut_off_year

Returns a integer representing the cut-off point between interpreting 2-digits years as 19xx or 20xx.

$iso8601->set_cut_off_year($int)

Accepts a integer representing the cut-off point between interpreting 2-digits years as 19xx or 20xx.

    2-digit years <  legacy_year will be interpreted as 20xx
    2-digit years >= legacy_year will be interpreted as 19xx

$iso8601->legacy_year

Returns a boolean value indicating the 2-digit year handling behavior.

$iso8601->set_legacy_year($bool)

Accepts a boolean value controlling if a 2-digit year is interpreted as being in the current century (unless a "base_datetime" is set) or if "cut_off_year" should be used to place the year in either 20xx or 19xx.

Class Methods¶

DateTime::Format::ISO8601->DefaultCutOffYear($int)

Accepts a integer representing the cut-off point for 2-digit years when calling "parse_*" as class methods and the default value for "cut_off_year" when creating objects. If called with no parameters this method will return the default value for "cut_off_year".

DateTime::Format::ISO8601->DefaultLegacyYear($bool)

Accepts a boolean value controlling the legacy year behavior when calling "parse_*" as class methods and the default value for "legacy_year" when creating objects. If called with no parameters this method will return the default value for "legacy_year".

Parser(s)¶

These methods may be called as either class or object methods.

parse_datetime

parse_time

Please see the "FORMATS" section.

Formatter¶

This may be called as either class or object method.

format_datetime($dt)

Formats the datetime in an ISO8601-compatible format. This differs from "iso8601" in DateTime by including nanoseconds/milliseconds and the correct timezone offset.

Conventions¶

• Expanded ISO8601

  These formats are supported with exactly 6 digits for the year. Support for a variable number of digits will be in a later release.

• Precision

  If a format doesn't include a year all larger time unit up to and including the year are filled in using the current date/time or [if set] the "base_datetime" object.

• Fractional time

  There is no limit on the expressed precision.

Supported via parse_datetime¶

The supported formats are listed by the section of ISO 8601:2000(E) in which they appear.

5.2 Dates

•

5.2.1.1

•

5.2.1.2

•

5.2.1.3

•

5.2.1.4

•

5.2.2.1

•

5.2.2.2

•

5.2.2.3

•

5.2.3.1

•

5.2.3.2

•

5.2.3.4

5.3 Time of Day

• 5.3.1.1 - 5.3.1.3

  Values can optionally be prefixed with 'T'.

• 5.3.1.1

•

5.3.1.2

• 5.3.1.3 - 5.3.1.4

  fractional (decimal) separator maybe either ',' or '.'

• 5.3.1.3

•

5.3.1.4

• 5.3.3 - 5.3.4.2

  Values can optionally be prefixed with 'T'.

• 5.3.3

•

5.3.4.2

5.4 Combinations of date and time of day

•

5.4.1

•

5.4.2

•

5.4.3

Support for this section is not complete.

5.5 Time-Intervals

These are not currently supported

Supported via parse_time¶

5.3.1.1 - 5.3.1.3

Values can optionally be prefixed with 'T'.

•

5.3.1.1

•

5.3.1.2

•

5.3.1.4

Title¶

    ISO8601:2000(E)
    Data elements and interchange formats - information exchange -
    Representation of dates and times
    Second edition 2000-12-15

Reference Number¶

    ISO/TC 154 N 362