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