summaryrefslogtreecommitdiff
path: root/ext/Time/Piece/Seconds.pm
blob: 7544915dfaef966ed372899fddbcdc70d7241146 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
package Time::Seconds;
use strict;
use vars qw/@EXPORT @ISA/;

@ISA = 'Exporter';

@EXPORT = qw(
		ONE_MINUTE 
		ONE_HOUR 
		ONE_DAY 
		ONE_WEEK 
		ONE_MONTH
		ONE_YEAR
		ONE_FINANCIAL_MONTH
		LEAP_YEAR 
		NON_LEAP_YEAR
		);

use constant ONE_MINUTE => 60;
use constant ONE_HOUR => 3_600;
use constant ONE_DAY => 86_400;
use constant ONE_WEEK => 604_800;
use constant ONE_MONTH => 2_629_744; # ONE_YEAR / 12
use constant ONE_YEAR => 31_556_930; # 365.24225 days
use constant ONE_FINANCIAL_MONTH => 2_592_000; # 30 days
use constant LEAP_YEAR => 31_622_400; # 366 * ONE_DAY
use constant NON_LEAP_YEAR => 31_536_000; # 365 * ONE_DAY

use overload 
		'0+' => \&seconds,
		'""' => \&seconds,
		'<=>' => \&compare,
		'+' => \&add,
		'-' => \&subtract,
		'-=' => \&subtract_from,
		'+=' => \&add_to,
		'=' => \&copy;

sub new {
	my $class = shift;
	my ($val) = @_;
	$val = 0 unless defined $val;
	bless \$val, $class;
}

sub _get_ovlvals {
	my ($lhs, $rhs, $reverse) = @_;
	$lhs = $lhs->seconds;
	
	if (UNIVERSAL::isa($rhs, 'Time::Seconds')) {
		$rhs = $rhs->seconds;
	}
	elsif (ref($rhs)) {
		die "Can't use non Seconds object in operator overload";
	}
	
	if ($reverse) {
		return $rhs, $lhs;
	}
	
	return $lhs, $rhs;
}

sub compare {
	my ($lhs, $rhs) = _get_ovlvals(@_);
	return $lhs <=> $rhs;
}

sub add {
	my ($lhs, $rhs) = _get_ovlvals(@_);
	return Time::Seconds->new($lhs + $rhs);
}

sub add_to {
	my $lhs = shift;
	my $rhs = shift;
	$rhs = $rhs->seconds if UNIVERSAL::isa($rhs, 'Time::Seconds');
	$$lhs += $rhs;
	return $lhs;
}

sub subtract {
	my ($lhs, $rhs) = _get_ovlvals(@_);
	return Time::Seconds->new($lhs - $rhs);
}

sub subtract_from {
	my $lhs = shift;
	my $rhs = shift;
	$rhs = $rhs->seconds if UNIVERSAL::isa($rhs, 'Time::Seconds');
	$$lhs -= $rhs;
	return $lhs;
}

sub copy {
	Time::Seconds->new(${$_[0]});
}

sub seconds {
	my $s = shift;
	$$s;
}

sub minutes {
	my $s = shift;
	$$s / 60;
}

sub hours {
	my $s = shift;
	$s->minutes / 60;
}

sub days {
	my $s = shift;
	$s->hours / 24;
}

sub weeks {
	my $s = shift;
	$s->days / 7;
}

sub months {
	my $s = shift;
	$s->days / 30.4368541;
}

sub financial_months {
	my $s = shift;
	$s->days / 30;
}

*f_months = \&financial_months;

sub years {
	my $s = shift;
	$s->days / 365.24225;
}

1;
__END__

=head1 NAME

Time::Seconds - a simple API to convert seconds to other date values

=head1 SYNOPSIS

    use Time::Piece;
    use Time::Seconds;
    
    my $t = localtime;
    $t += ONE_DAY;
    
    my $t2 = localtime;
    my $s = $t - $t2;
    
    print "Difference is: ", $s->days, "\n";

=head1 DESCRIPTION

This module is part of the Time::Piece distribution. It allows the user
to find out the number of minutes, hours, days, weeks or years in a given
number of seconds. It is returned by Time::Piece when you delta two
Time::Piece objects.

Time::Seconds also exports the following constants:

    ONE_DAY
    ONE_WEEK
    ONE_HOUR
    ONE_MINUTE
	ONE_MONTH
	ONE_YEAR
	ONE_FINANCIAL_MONTH
    LEAP_YEAR
    NON_LEAP_YEAR

Since perl does not (yet?) support constant objects, these constants
are in seconds only, so you cannot, for example, do this: C<print
ONE_WEEK-E<gt>minutes;>

=head1 METHODS

The following methods are available:

    my $val = Time::Seconds->new(SECONDS)
    $val->seconds;
    $val->minutes;
    $val->hours;
    $val->days;
    $val->weeks;
	$val->months;
	$val->financial_months; # 30 days
    $val->years;

The methods make the assumption that there are 24 hours in a day, 7 days in
a week, 365.24225 days in a year and 12 months in a year.
(from The Calendar FAQ at http://www.tondering.dk/claus/calendar.html)

=head1 AUTHOR

Matt Sergeant, matt@sergeant.org

Tobias Brox, tobiasb@tobiasb.funcom.com

=head1 LICENSE

Please see Time::Piece for the license.

=head1 Bugs

Currently the methods aren't as efficient as they could be, for reasons of
clarity. This is probably a bad idea.

=cut