Dave Rolsky > DateTime-Format-Strptime-1.68 > DateTime::Format::Strptime

Download:
DateTime-Format-Strptime-1.68.tar.gz

Dependencies

Annotate this POD

Website

Related Modules

Date::Manip
Time::Local
Date::Calc
Date::Parse
Date::Format
Date::Language
Time::ParseDate
Data::Dumper
Time::Fuzzy
Date::Time
more...
By perlmonks.org

CPAN RT

Open  1
View/Report Bugs
Module Version: 1.68   Source   Latest Release: DateTime-Format-Strptime-1.69-TRIAL

NAME ^

DateTime::Format::Strptime - Parse and format strp and strf time patterns

VERSION ^

version 1.68

SYNOPSIS ^

    use DateTime::Format::Strptime;

    my $strp = DateTime::Format::Strptime->new(
        pattern   => '%T',
        locale    => 'en_AU',
        time_zone => 'Australia/Melbourne',
    );

    my $dt = $strp->parse_datetime('23:16:42');

    $strp->format_datetime($dt);

    # 23:16:42

    # Croak when things go wrong:
    my $strp = DateTime::Format::Strptime->new(
        pattern   => '%T',
        locale    => 'en_AU',
        time_zone => 'Australia/Melbourne',
        on_error  => 'croak',
    );

    # Do something else when things go wrong:
    my $strp = DateTime::Format::Strptime->new(
        pattern   => '%T',
        locale    => 'en_AU',
        time_zone => 'Australia/Melbourne',
        on_error  => \&phone_police,
    );

DESCRIPTION ^

This module implements most of strptime(3), the POSIX function that is the reverse of strftime(3), for DateTime. While strftime takes a DateTime and a pattern and returns a string, strptime takes a string and a pattern and returns the DateTime object associated.

METHODS ^

This class offers the following methods.

DateTime::Format::Strptime->new(%args)

This methods creates a new object. It accepts the following arguments:

$strptime->parse_datetime($string)

Given a string in the pattern specified in the constructor, this method will return a new DateTime object.

If given a string that doesn't match the pattern, the formatter will croak or return undef, depending on the setting of on_error in the constructor.

$strptime->format_datetime($datetime)

Given a DateTime object, this methods returns a string formatted in the object's format. This method is synonymous with DateTime's strftime method.

$strptime->locale

This method returns the locale passed to the object's constructor.

$strptime->pattern

This method returns the pattern passed to the object's constructor.

$strptime->time_zone

This method returns the time zone passed to the object's constructor.

$strptime->errmsg

If the on_error behavior of the object is 'undef', you can retrieve error messages with this method so you can work out why things went wrong.

EXPORTS ^

These subs are available as optional exports.

strptime( $strptime_pattern, $string )

Given a pattern and a string this function will return a new DateTime object.

strftime( $strftime_pattern, $datetime )

Given a pattern and a DateTime object this function will return a formatted string.

STRPTIME PATTERN TOKENS ^

The following tokens are allowed in the pattern string for strptime (parse_datetime):

AUTHOR EMERITUS ^

This module was created by Rick Measham.

SEE ALSO ^

datetime@perl.org mailing list.

http://datetime.perl.org/

perl, DateTime, DateTime::TimeZone, DateTime::Locale

BUGS ^

Please report any bugs or feature requests to bug-datetime-format-strptime@rt.cpan.org, or through the web interface at http://rt.cpan.org. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

Bugs may be submitted through the RT bug tracker (or bug-datetime-format-strptime@rt.cpan.org).

There is a mailing list available for users of this distribution, mailto:datetime@perl.org.

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

DONATIONS ^

If you'd like to thank me for the work I've done on this module, please consider making a "donation" to me via PayPal. I spend a lot of free time creating free software, and would appreciate any support you'd care to offer.

Please note that I am not suggesting that you must do this in order for me to continue working on this particular software. I will continue to do so, inasmuch as I have in the past, for as long as it interests me.

Similarly, a donation made in this way will probably not make me work on this software much more, unless I get so many donations that I can consider working on free software full time (let's all have a chuckle at that together).

To donate, log into PayPal and send money to autarch@urth.org, or use the button at http://www.urth.org/~autarch/fs-donation.html.

AUTHORS ^

CONTRIBUTORS ^

COPYRIGHT AND LICENCE ^

This software is Copyright (c) 2015 - 2016 by Dave Rolsky.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)
syntax highlighting: