/ 
DateTime-Format-RFC3339-v1.8.0
River stage two • 11 direct dependents • 24 total dependents
/ DateTime::Format::RFC3339

NAME

DateTime::Format::RFC3339 - Parse and format RFC3339 datetime strings

VERSION

Version 1.8.0

SYNOPSIS

use DateTime::Format::RFC3339;

my $format = DateTime::Format::RFC3339->new();
my $dt = $format->parse_datetime( '2002-07-01T13:50:05Z' );

# 2002-07-01T13:50:05Z
say $format->format_datetime( $dt );

DESCRIPTION

This module understands the RFC3339 date/time format, an ISO 8601 profile, defined at http://tools.ietf.org/html/rfc3339.

It can be used to parse these formats in order to create the appropriate objects.

CONSTRUCTOR

new

my $format = DateTime::Format::RFC3339->new();
my $format = DateTime::Format::RFC3339->new( %options );

A number of options are supported:

  • decimals

    decimals => undef      [default]
decimals => $decimals

    Date-time strings generated by <format_datetime> will have this many decimals (an integer from zero to nine). If undef, zero will be used if the date-time has no decimals, nine otherwise.

  • sep

    sep => "T"      [default]
sep => $sep

  • sep_re

    sep_re => $sep_re

    The spec allows for a separator other than "T" to be used between the date and the time.

    The string provided to the sep option is used when formatting date-time objects into strings, and the regex pattern provided to the sep_re option is used when parsing strings into date-time objects.

    The default for sep_re is a regex pattern that matches the separator (which is "T" by default).

  • uc_only

    uc_only => 0   [default]
uc_only => 1

    Only an uppercase date and time separator and an uppercase timezone offset "Z" will be accepted by parse_datetime when this option is true.

METHODS

parse_datetime

my $dt = DateTime::Format::RFC3339->parse_datetime( $string );
my $dt = $format->parse_datetime( $string );

Given a RFC3339 datetime string, this method will return a new DateTime object.

If given an improperly formatted string, this method will croak.

For a more flexible parser, see DateTime::Format::ISO8601.

format_datetime

my $string = DateTime::Format::RFC3339->format_datetime( $dt );
my $string = $format->format_datetime( $dt );

Given a DateTime object, this methods returns a RFC3339 datetime string.

SEE ALSO

DOCUMENTATION AND SUPPORT

You can find documentation for this module with the perldoc command.

perldoc DateTime::Format::RFC3339

You can also find it online at this location:

If you need help, the following are great resources:

BUGS

Please report any bugs or feature requests using https://github.com/ikegami/perl-Datetime-Format-RFC3339/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

REPOSITORY

AUTHOR

Eric Brine, <ikegami@adaelis.com>

COPYRIGHT & LICENSE

No rights reserved.

The author has dedicated the work to the Commons by waiving all of his or her rights to the work worldwide under copyright law and all related or neighboring legal rights he or she had in the work, to the extent allowable by law.

Works under CC0 do not require attribution. When citing the work, you should not imply endorsement by the author.