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
|
package FS::discount;
use base qw( FS::Record );
use strict;
=head1 NAME
FS::discount - Object methods for discount records
=head1 SYNOPSIS
use FS::discount;
$record = new FS::discount \%hash;
$record = new FS::discount { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::discount object represents a discount definition. FS::discount inherits
from FS::Record. The following fields are currently supported:
=over 4
=item discountnum
primary key
=item name
name
=item amount
amount
=item percent
percent
=item months
months
=item disabled
disabled
=item setup - apply discount to setup fee (not just to recurring fee)
If the discount is based on a percentage, then the % will be applied to the
setup and recurring portions.
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new discount. To add the discount 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 { 'discount'; }
=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 discount. 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;
if ( $self->_type eq 'Select discount type' ) {
return 'Please select a discount type';
} elsif ( $self->amount > 0 ) {
$self->set('percent', '0');
} elsif ( $self->percent > 0 ) {
$self->set('amount', '0.00');
} else {
return "Discount amount or percentage must be > 0";
}
my $error =
$self->ut_numbern('discountnum')
|| $self->ut_foreign_keyn('classnum', 'discount_class', 'classnum')
|| $self->ut_textn('name')
|| $self->ut_money('amount')
|| $self->ut_float('percent') #actually decimal, but this will do
|| $self->ut_floatn('months') #actually decimal, but this will do
|| $self->ut_enum('disabled', [ '', 'Y' ])
|| $self->ut_enum('setup', [ '', 'Y' ])
#|| $self->ut_enum('linked', [ '', 'Y' ])
;
return $error if $error;
#causes "months must be integers greater than 1" errors when you go back and
# try to edit an existing discount (because the months format as NN.000)
#not worth whatever reason it came in with "prepayment discounts rt#5318" for
# #discourage non-integer months for package discounts
# if ($self->discountnum) {
# my $sql =
# "SELECT count(*) FROM part_pkg_discount WHERE part_pkg_discount.discountnum = ".
# $self->discountnum;
#
# my $count = $self->scalar_sql($sql);
# return "months must be integers greater than 1"
# if ( $count && ($self->ut_number('months') || $self->months < 2) );
# }
$self->SUPER::check;
}
=item description_short
=item description
Returns a text description incorporating the amount, percent and months fields.
description_short omits term information
=cut
sub description_short {
my $self = shift;
my $conf = new FS::Conf;
my $money_char = $conf->config('money_char') || '$';
my $desc;
if ( $self->name ) {
$desc = $self->name . ': ';
} else {
$desc = 'Discount of ';
}
$desc .= $money_char. sprintf('%.2f/month', $self->amount)
if $self->amount > 0;
( my $percent = $self->percent ) =~ s/\.0+$//;
$percent =~ s/(\.\d*[1-9])0+$/$1/;
$desc .= $percent. '%'
if $self->percent > 0;
$desc;
}
sub description {
my $self = shift;
my $desc = $self->description_short;
( my $months = $self->months ) =~ s/\.0+$//;
$months =~ s/(\.\d*[1-9])0+$/$1/;
if ($months) {
if ($months == 1) {
$desc .= " for 1 month";
} else {
$desc .= " for $months months";
}
}
$desc .= ', applies to setup' if $self->setup;
$desc;
}
sub classname {
my $self = shift;
my $discount_class = $self->discount_class;
$discount_class ? $discount_class->classname : '(none)';
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::cust_pkg_discount>, L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
