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

THANKS

96       Gisle Aas (GAAS) for writing HTTP::Date.
97
98       Iain, for never quite finishing "HTTP::Date::XS".
99

SUPPORT

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

LICENCE AND COPYRIGHT

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

AUTHOR

126       Originally written by Iain Truskett <spoon@cpan.org>, who died on
127       December 29, 2003.
128
129       Maintained by Dave Rolsky <autarch@urth.org> and Christiaan Kras
130       <ckras@cpan.org>
131