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
|
package FS::cust_pkg_discount;
use strict;
use base qw( FS::otaker_Mixin
FS::cust_main_Mixin
FS::pkg_discount_Mixin
FS::Record );
use FS::Record qw( dbh qsearchs ); # qsearch );
use FS::cust_pkg;
use FS::discount;
=head1 NAME
FS::cust_pkg_discount - Object methods for cust_pkg_discount records
=head1 SYNOPSIS
use FS::cust_pkg_discount;
$record = new FS::cust_pkg_discount \%hash;
$record = new FS::cust_pkg_discount { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_pkg_discount object represents the application of a discount to a
customer package. FS::cust_pkg_discount inherits from FS::Record. The
following fields are currently supported:
=over 4
=item pkgdiscountnum
primary key
=item pkgnum
Customer package (see L<FS::cust_pkg>)
=item discountnum
Discount (see L<FS::discount>)
=item months_used
months_used
=item end_date
end_date
=item usernum
order taker, see L<FS::access_user>
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new discount application. To add the record 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 { 'cust_pkg_discount'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=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 discount applciation. 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('pkgdiscountnum')
|| $self->ut_foreign_key('pkgnum', 'cust_pkg', 'pkgnum')
|| $self->ut_foreign_key('discountnum', 'discount', 'discountnum' )
|| $self->ut_sfloat('months_used') #actually decimal, but this will do
|| $self->ut_numbern('end_date')
|| $self->ut_alphan('otaker')
|| $self->ut_numbern('usernum')
|| $self->ut_enum('disabled', [ '', 'Y' ] )
;
return $error if $error;
return "Discount does not apply to setup fees, and package has no recurring"
if ! $self->discount->setup && $self->cust_pkg->part_pkg->freq =~ /^0/;
$self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
$self->SUPER::check;
}
=item cust_pkg
Returns the customer package (see L<FS::cust_pkg>).
=cut
sub cust_pkg {
my $self = shift;
qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );
}
=item discount
Returns the discount (see L<FS::discount>).
=cut
sub discount {
my $self = shift;
qsearchs('discount', { 'discountnum' => $self->discountnum } );
}
=item increment_months_used MONTHS
Increments months_used by the given parameter
=cut
sub increment_months_used {
my( $self, $used ) = @_;
#UPDATE cust_pkg_discount SET months_used = months_used + ?
#leaves no history, and billing is mutexed per-customer, so the dum way is ok
$self->months_used( $self->months_used + $used );
$self->replace();
}
=item decrement_months_used MONTHS
Decrement months_used by the given parameter
(Note: as in, extending the length of the discount. Typically only used to
stack/extend a discount when the customer package has one active already.)
=cut
sub decrement_months_used {
my( $self, $recharged ) = @_;
#UPDATE cust_pkg_discount SET months_used = months_used - ?
#leaves no history, and billing is mutexed per-customer
#we're run from part_event/Action/referral_pkg_discount on behalf of a
# different customer, so we need to grab this customer's mutex.
# incidentally, that's some inelegant encapsulation breaking shit, and a
# great argument in favor of native-DB trigger history so we can trust
# in normal ACID like the SQL above instead of this
$self->cust_pkg->cust_main->select_for_update;
$self->months_used( $self->months_used - $recharged );
$self->replace();
}
=item status
=cut
sub status {
my $self = shift;
my $discount = $self->discount;
if ( $self->disabled ne 'Y'
and ( ! $discount->months || $self->months_used < $discount->months )
#XXX also end date
) {
'active';
} else {
'expired';
}
}
# Used by FS::Upgrade to migrate to a new database.
sub _upgrade_data { # class method
my ($class, %opts) = @_;
$class->_upgrade_otaker(%opts);
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::discount>, L<FS::cust_pkg>, L<FS::Record>, schema.html from the base documentation.
=cut
1;
|