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
|
package FS::rate_time;
use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs );
use FS::rate_time_interval;
=head1 NAME
FS::rate_time - Object methods for rate_time records
=head1 SYNOPSIS
use FS::rate_time;
$record = new FS::rate_time \%hash;
$record = new FS::rate_time { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::rate_time object represents a time period for selection of CDR billing
rates. FS::rate_time inherits from FS::Record. The following fields are
currently supported:
=over 4
=item ratetimenum
primary key
=item ratetimename
A label (like "Daytime" or "Weekend").
=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'; }
=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 example. 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('ratetimenum')
|| $self->ut_text('ratetimename')
;
return $error if $error;
$self->SUPER::check;
}
=item intervals
Return the L<FS::rate_time_interval> objects included in this rating period.
=cut
sub intervals {
my $self = shift;
return qsearch({ table => 'rate_time_interval',
hashref => { ratetimenum => $self->ratetimenum },
order_by => 'ORDER BY stime ASC',
});
}
=item contains TIME
Return the L<FS::rate_time_interval> object that contains the specified
time-of-week (in seconds from the start of Sunday). The primary use of
this is to test whether that time falls within this rating period.
=cut
sub contains {
my $self = shift;
my $weektime = shift;
return qsearchs('rate_time_interval', { ratetimenum => $self->ratetimenum,
stime => { op => '<=',
value => $weektime },
etime => { op => '>',
value => $weektime },
} );
}
=item description
Returns a list of arrayrefs containing the starting and
ending times of each interval in this period, in a readable
format.
=cut
sub description {
my $self = shift;
return map { [ $_->description ] } $self->intervals;
}
=back
=head1 BUGS
To be seen.
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
