Commit | Line | Data |
36477c24 |
1 | package Time::gmtime; |
2 | use strict; |
3 | use Time::tm; |
4 | |
14fe70c2 |
5 | use 5.6.1; |
17f410f9 |
6 | our(@ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS, $VERSION); |
36477c24 |
7 | BEGIN { |
8 | use Exporter (); |
36477c24 |
9 | @ISA = qw(Exporter Time::tm); |
10 | @EXPORT = qw(gmtime gmctime); |
11 | @EXPORT_OK = qw( |
12 | $tm_sec $tm_min $tm_hour $tm_mday |
13 | $tm_mon $tm_year $tm_wday $tm_yday |
14 | $tm_isdst |
15 | ); |
16 | %EXPORT_TAGS = ( FIELDS => [ @EXPORT_OK, @EXPORT ] ); |
03136e13 |
17 | $VERSION = 1.01; |
36477c24 |
18 | } |
19 | use vars @EXPORT_OK; |
20 | |
21 | sub populate (@) { |
22 | return unless @_; |
23 | my $tmob = Time::tm->new(); |
24 | @$tmob = ( |
25 | $tm_sec, $tm_min, $tm_hour, $tm_mday, |
26 | $tm_mon, $tm_year, $tm_wday, $tm_yday, |
27 | $tm_isdst ) |
28 | = @_; |
29 | return $tmob; |
30 | } |
31 | |
03136e13 |
32 | sub gmtime (;$) { populate CORE::gmtime(@_ ? shift : time)} |
33 | sub gmctime (;$) { scalar CORE::gmtime(@_ ? shift : time)} |
36477c24 |
34 | |
35 | 1; |
36 | __END__ |
37 | |
38 | =head1 NAME |
39 | |
2ae324a7 |
40 | Time::gmtime - by-name interface to Perl's built-in gmtime() function |
36477c24 |
41 | |
42 | =head1 SYNOPSIS |
43 | |
44 | use Time::gmtime; |
45 | $gm = gmtime(); |
46 | printf "The day in Greenwich is %s\n", |
47 | (qw(Sun Mon Tue Wed Thu Fri Sat Sun))[ gm->wday() ]; |
48 | |
49 | use Time::gmtime w(:FIELDS; |
50 | printf "The day in Greenwich is %s\n", |
51 | (qw(Sun Mon Tue Wed Thu Fri Sat Sun))[ gm_wday() ]; |
52 | |
53 | $now = gmctime(); |
54 | |
55 | use Time::gmtime; |
56 | use File::stat; |
57 | $date_string = gmctime(stat($file)->mtime); |
58 | |
59 | =head1 DESCRIPTION |
60 | |
61 | This module's default exports override the core gmtime() function, |
62 | replacing it with a version that returns "Time::tm" objects. |
63 | This object has methods that return the similarly named structure field |
64 | name from the C's tm structure from F<time.h>; namely sec, min, hour, |
65 | mday, mon, year, wday, yday, and isdst. |
66 | |
67 | You may also import all the structure fields directly into your namespace |
68 | as regular variables using the :FIELDS import tag. (Note that this |
69 | still overrides your core functions.) Access these fields as variables |
70 | named with a preceding C<tm_> in front their method names. Thus, |
71 | C<$tm_obj-E<gt>mday()> corresponds to $tm_mday if you import the fields. |
72 | |
ae83f377 |
73 | The gmctime() function provides a way of getting at the |
36477c24 |
74 | scalar sense of the original CORE::gmtime() function. |
75 | |
76 | To access this functionality without the core overrides, |
77 | pass the C<use> an empty import list, and then access |
78 | function functions with their full qualified names. |
79 | On the other hand, the built-ins are still available |
80 | via the C<CORE::> pseudo-package. |
81 | |
82 | =head1 NOTE |
83 | |
8cc95fdb |
84 | While this class is currently implemented using the Class::Struct |
36477c24 |
85 | module to build a struct-like class, you shouldn't rely upon this. |
86 | |
87 | =head1 AUTHOR |
88 | |
89 | Tom Christiansen |