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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
package FS::rate;
use strict;
use vars qw( @ISA );
use FS::Record qw( qsearch qsearchs dbh );
use FS::rate_detail;
@ISA = qw(FS::Record);
=head1 NAME
FS::rate - Object methods for rate records
=head1 SYNOPSIS
use FS::rate;
$record = new FS::rate \%hash;
$record = new FS::rate { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::rate object represents an rate plan. FS::rate inherits from
FS::Record. The following fields are currently supported:
=over 4
=item ratenum - primary key
=item ratename
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new rate plan. To add the rate plan 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'; }
=item insert [ , OPTION => VALUE ... ]
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
Currently available options are: I<rate_detail>
If I<rate_detail> is set to an array reference of FS::rate_detail objects, the
objects will have their ratenum field set and will be inserted after this
record.
=cut
sub insert {
my $self = shift;
my %options = @_;
local $SIG{HUP} = 'IGNORE';
local $SIG{INT} = 'IGNORE';
local $SIG{QUIT} = 'IGNORE';
local $SIG{TERM} = 'IGNORE';
local $SIG{TSTP} = 'IGNORE';
local $SIG{PIPE} = 'IGNORE';
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
my $error = $self->check;
return $error if $error;
$error = $self->SUPER::insert;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
if ( $options{'rate_detail'} ) {
foreach my $rate_detail ( @{$options{'rate_detail'}} ) {
$rate_detail->ratenum($self->ratenum);
$error = $rate_detail->insert;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
}
}
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
}
=item delete
Delete this record from the database.
=cut
# the delete method can be inherited from FS::Record
=item replace OLD_RECORD [ , OPTION => VALUE ... ]
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
Currently available options are: I<rate_detail>
If I<rate_detail> is set to an array reference of FS::rate_detail objects, the
objects will have their ratenum field set and will be inserted after this
record. Any existing rate_detail records associated with this record will be
deleted.
=cut
sub replace {
my ($new, $old) = (shift, shift);
my %options = @_;
local $SIG{HUP} = 'IGNORE';
local $SIG{INT} = 'IGNORE';
local $SIG{QUIT} = 'IGNORE';
local $SIG{TERM} = 'IGNORE';
local $SIG{TSTP} = 'IGNORE';
local $SIG{PIPE} = 'IGNORE';
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
my @old_rate_detail = ();
@old_rate_detail = $old->rate_detail if $options{'rate_detail'};
my $error = $new->SUPER::replace($old);
if ($error) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
foreach my $old_rate_detail ( @old_rate_detail ) {
my $error = $old_rate_detail->delete;
if ($error) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
}
foreach my $rate_detail ( @{$options{'rate_detail'}} ) {
$rate_detail->ratenum($new->ratenum);
$error = $rate_detail->insert;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
}
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
}
=item check
Checks all fields to make sure this is a valid rate plan. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('ratenum')
|| $self->ut_text('ratename')
;
return $error if $error;
$self->SUPER::check;
}
=item dest_detail REGIONNUM | RATE_REGION_OBJECTD
Returns the rate detail (see L<FS::rate_detail>) for this rate to the
specificed destination.
=cut
sub dest_detail {
my $self = shift;
my $regionnum = ref($_[0]) ? shift->regionnum : shift;
qsearchs( 'rate_detail', { 'ratenum' => $self->ratenum,
'dest_regionnum' => $regionnum, } );
}
=item rate_detail
Returns all region-specific details (see L<FS::rate_detail>) for this rate.
=cut
sub rate_detail {
my $self = shift;
qsearch( 'rate_detail', { 'ratenum' => $self->ratenum } );
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
