DateTime::Format::HTTP(3pm)

1DateTime::Format::HTTP(U3s)er Contributed Perl DocumentatDiaotneTime::Format::HTTP(3)
2
3
4

NAME

6       DateTime::Format::HTTP - Date conversion routines
7

SYNOPSIS

9           use DateTime::Format::HTTP;
10
11           my $class = 'DateTime::Format::HTTP';
12           $string = $class->format_datetime($dt); # Format as GMT ASCII time
13           $time = $class->parse_datetime($string); # convert ASCII date to machine time
14

DESCRIPTION

16       This module provides functions that deal the date formats used by the
17       HTTP protocol (and then some more).
18

METHODS

20       parse_datetime( $str [, $zone] )
21
22       The parse_datetime() function converts a string to machine time. It
23       throws an error if the format of $str is unrecognized, or the time is
24       outside the representable range. The time formats recognized are listed
25       below.
26
27       The function also takes an optional second argument that specifies the
28       default time zone to use when converting the date. This parameter is
29       ignored if the zone is found in the date string itself. If this parame‐
30       ter is missing, and the date string format does not contain any zone
31       specification, then the floating time zone is used.
32
33       The zone should be one that is recognized by DateTime::TimeZone.
34
35       Actual parsing is done with the HTTP::Date module. At the time of writ‐
36       ing it supports the formats listed next. Consult that module's documen‐
37       tation in case the list has been changed.
38
39        "Wed, 09 Feb 1994 22:23:32 GMT"       -- HTTP format
40        "Thu Feb  3 17:03:55 GMT 1994"        -- ctime(3) format
41        "Thu Feb  3 00:00:00 1994",           -- ANSI C asctime() format
42        "Tuesday, 08-Feb-94 14:15:29 GMT"     -- old rfc850 HTTP format
43        "Tuesday, 08-Feb-1994 14:15:29 GMT"   -- broken rfc850 HTTP format
44
45        "03/Feb/1994:17:03:55 -0700"   -- common logfile format
46        "09 Feb 1994 22:23:32 GMT"     -- HTTP format (no weekday)
47        "08-Feb-94 14:15:29 GMT"       -- rfc850 format (no weekday)
48        "08-Feb-1994 14:15:29 GMT"     -- broken rfc850 format (no weekday)
49
50        "1994-02-03 14:15:29 -0100"    -- ISO 8601 format
51        "1994-02-03 14:15:29"          -- zone is optional
52        "1994-02-03"                   -- only date
53        "1994-02-03T14:15:29"          -- Use T as separator
54        "19940203T141529Z"             -- ISO 8601 compact format
55        "19940203"                     -- only date
56
57        "08-Feb-94"         -- old rfc850 HTTP format    (no weekday, no time)
58        "08-Feb-1994"       -- broken rfc850 HTTP format (no weekday, no time)
59        "09 Feb 1994"       -- proposed new HTTP format  (no weekday, no time)
60        "03/Feb/1994"       -- common logfile format     (no time, no offset)
61
62        "Feb  3  1994"      -- Unix 'ls -l' format
63        "Feb  3 17:03"      -- Unix 'ls -l' format
64
65        "11-15-96  03:52PM" -- Windows 'dir' format
66
67       The parser ignores leading and trailing whitespace.  It also allow the
68       seconds to be missing and the month to be numerical in most formats.
69
70       If the year is missing, then we assume that the date is the first
71       matching date before current month.  If the year is given with only 2
72       digits, then parse_date() will select the century that makes the year
73       closest to the current date.
74
75       format_datetime()
76
77       The "format_datetime()" method converts a DateTime to a string. If the
78       function is called without an argument, it will use the current time.
79
80       The string returned is in the format preferred for the HTTP protocol.
81       This is a fixed length subset of the format defined by RFC 1123, repre‐
82       sented in Universal Time (GMT).  An example of a time stamp in this
83       format is:
84
85          Sun, 06 Nov 1994 08:49:37 GMT
86
87       format_iso( [$time] )
88
89       Same as format_datetime(), but returns a "YYYY-MM-DD hh:mm:ss"-format‐
90       ted string representing time in the local time zone. It is strongly
91       recommended that you use "format_isoz" or "format_datetime" instead (as
92       these provide time zone indication).
93
94       format_isoz( [$dt] )
95
96       Same as format_iso(), but returns a "YYYY-MM-DD hh:mm:ssZ"-formatted
97       string representing Universal Time.
98

THANKS

100       Gisle Aas (GAAS) for writing HTTP::Date.
101
102       Iain, for never quite finishing "HTTP::Date::XS".
103

SUPPORT

105       Support for this module is provided via the datetime@perl.org email
106       list. See http://lists.perl.org/ for more details.
107
108       Alternatively, log them via the CPAN RT system via the web or email:
109
110           http://rt.cpan.org/NoAuth/ReportBug.html?Queue=DateTime%3A%3AFormat%3A%3AHTTP
111           bug-datetime-format-http@rt.cpan.org
112
113       This makes it much easier for me to track things and thus means your
114       problem is less likely to be neglected.
115

LICENCE AND COPYRIGHT

117       Copyright Iain Truskett, 2003. All rights reserved.  Sections of the
118       documentation Gisle Aas, 1995-1999.  Changes since version 0.35 copy‐
119       right David Rolsky, 2004.
120
121       This library is free software; you can redistribute it and/or modify it
122       under the same terms as Perl itself, either Perl version 5.000 or, at
123       your option, any later version of Perl 5 you may have available.
124
125       The full text of the licences can be found in the Artistic and COPYING
126       files included with this module, or in perlartistic and perlgpl as sup‐
127       plied with Perl 5.8.1 and later.
128

AUTHOR

130       Originally written by Iain Truskett <spoon@cpan.org>, who died on
131       December 29, 2003.
132
133       Maintained by Dave Rolsky <autarch@urth.org>.
134