search

houseabsolute / DateTime-Format-ISO8601

Parses ISO8601 formats
http://metacpan.org/release/DateTime-Format-ISO8601/
Other
3 stars 3 forks source link

readme

NAME

DateTime::Format::ISO8601 - Parses ISO8601 formats

VERSION

version 0.16

SYNOPSIS

use DateTime::Format::ISO8601;

my $datetime_str = '2020-07-25T11:32:31';
my $dt = DateTime::Format::ISO8601->parse_datetime($datetime_str);
say $dt;

# This format is ambiguous and could be either a date or time, so use the
# parse_time method.
my $time_str = '113231';
$dt = DateTime::Format::ISO8601->parse_time($time_str);
say $dt;

# or

my $iso8601 = DateTime::Format::ISO8601->new;
$dt = $iso8601->parse_datetime($datetime_str);
say $dt;

$dt = $iso8601->parse_time($time_str);
say $dt;

say DateTime::Format::ISO8601->format_datetime($dt);

DESCRIPTION

Parses almost all ISO8601 date and time formats. ISO8601 time-intervals will be supported in a later release.

METHODS

This class provides the following methods:

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,
);

$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.

FORMATS

There are 6 strings that can match against date only or time only formats. The parse_datetime method will attempt to match these ambiguous strings against date only formats. If you want to match against the time only formats use the parse_time method.

Conventions

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.3 Time of Day

5.4 Combinations of date and time of day

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'.

STANDARDS DOCUMENT

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

CREDITS

Iain 'Spoon' Truskett (SPOON) who wrote DateTime::Format::Builder. That has grown into The Vacuum Energy Powered Swiss Army Katana of date and time parsing. This module was inspired by and conceived in honor of Iain's work.

Tom Phoenix (PHOENIX) and PDX.pm for helping me solve the ISO week conversion bug. Not by fixing the code but motivation me to fix it so I could participate in a game of Zendo.

Jonathan Leffler (JOHNL) for reporting a test bug.

Kelly McCauley for a patch to add 8 missing formats.

Alasdair Allan (AALLAN) for complaining about excessive test execution time.

Everyone at the DateTime Asylum.

SEE ALSO

SUPPORT

Bugs may be submitted at https://github.com/houseabsolute/DateTime-Format-ISO8601/issues.

I am also usually active on IRC as 'autarch' on irc://irc.perl.org.

SOURCE

The source code repository for DateTime-Format-ISO8601 can be found at https://github.com/houseabsolute/DateTime-Format-ISO8601.

AUTHORS

CONTRIBUTORS

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by Joshua Hoblitt.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.