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