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
|
package FS::rate_time_interval;
use base qw(FS::Record);
use strict;
use List::Util 'first';
=head1 NAME
FS::rate_time_interval - Object methods for rate_time_interval records
=head1 SYNOPSIS
use FS::rate_time_interval;
$record = new FS::rate_time_interval \%hash;
$record = new FS::rate_time_interval { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::rate_time_interval object represents an interval of clock time during
the week, such as "Monday, 7 AM to 8 PM". FS::rate_time_interval inherits
from FS::Record. The following fields are currently supported:
=over 4
=item intervalnum
primary key
=item stime
Start of the interval, in seconds from midnight on Sunday.
=item etime
End of the interval.
=item ratetimenum
A foreign key to an L<FS::rate_time> object representing the set of intervals
to which this belongs.
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new example. To add the example to the database, see L<"insert">.
Note that this stores the hash reference, not a distinct copy of the hash it
points to. You can ask the object for a copy with the I<hash> method.
=cut
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'rate_time_interval'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
# the insert method can be inherited from FS::Record
=item delete
Delete this record from the database.
=cut
# the delete method can be inherited from FS::Record
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=cut
# the replace method can be inherited from FS::Record
=item check
Checks all fields to make sure this is a valid interval. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
sub check {
my $self = shift;
my $error =
$self->ut_numbern('intervalnum')
|| $self->ut_number('stime')
|| $self->ut_number('etime')
|| $self->ut_number('ratetimenum')
;
return $error if $error;
# Disallow backward intervals. As a special case, an etime of 0
# should roll to the last second of the week.
$self->etime(7*24*60*60) if $self->etime == 0;
return "end of interval is before start" if ($self->etime < $self->stime);
# Detect overlap between intervals within the same rate_time.
# Since intervals are added one at a time, we only need to look
# for an existing interval that contains one of the endpoints of
# this one or that is completely inside this one.
my $overlap = $self->rate_time->contains($self->stime + 1) ||
$self->rate_time->contains($self->etime - 1) ||
first { $self->stime <= $_->stime && $self->etime >= $_->etime }
( $self->rate_time->intervals );
return "interval overlap: (".join('-',$self->description).') with ('.
join('-',$overlap->description).')' if $overlap;
$self->SUPER::check;
}
=item rate_time
Returns the L<FS::rate_time> comprising this interval.
=item description
Returns two strings containing stime and etime, formatted
"Day HH:MM AM/PM". Example: "Mon 5:00 AM". Seconds are
not displayed, so be careful.
=cut
my @days = qw(Sun Mon Tue Wed Thu Fri Sat);
sub description {
my $self = shift;
return map {
sprintf('%s %02d:%02d %s',
$days[int($_/86400) % 7],
(int($_/3600) % 12 || 12),
int($_/60) % 60,
(($_/3600) % 24 < 12) ? 'AM' : 'PM' )
} ( $self->stime, $self->etime );
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::rate_time>, L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
