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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
package FS::quotation_pkg;
use base qw( FS::TemplateItem_Mixin FS::Record );
use strict;
use FS::Record qw( qsearchs ); #qsearch
use FS::part_pkg;
use FS::quotation_pkg_discount; #so its loaded when TemplateItem_Mixin needs it
=head1 NAME
FS::quotation_pkg - Object methods for quotation_pkg records
=head1 SYNOPSIS
use FS::quotation_pkg;
$record = new FS::quotation_pkg \%hash;
$record = new FS::quotation_pkg { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::quotation_pkg object represents a quotation package.
FS::quotation_pkg inherits from FS::Record. The following fields are currently
supported:
=over 4
=item quotationpkgnum
primary key
=item pkgpart
pkgpart
=item locationnum
locationnum
=item start_date
start_date
=item contract_end
contract_end
=item quantity
quantity
=item waive_setup
waive_setup
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new quotation package. To add the quotation package 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
sub table { 'quotation_pkg'; }
sub display_table { 'quotation_pkg'; }
#forget it, just overriding cust_bill_pkg_display entirely
#sub display_table_orderby { 'quotationpkgnum'; } # something else?
# # (for invoice display order)
sub discount_table { 'quotation_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.
=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.
=item check
Checks all fields to make sure this is a valid quotation package. 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('quotationpkgnum')
|| $self->ut_foreign_key( 'quotationnum', 'quotation', 'quotationnum' )
|| $self->ut_foreign_key( 'pkgpart', 'part_pkg', 'pkgpart' )
|| $self->ut_foreign_keyn( 'locationnum', 'cust_location', 'locationnum' )
|| $self->ut_numbern('start_date')
|| $self->ut_numbern('contract_end')
|| $self->ut_numbern('quantity')
|| $self->ut_enum('waive_setup', [ '', 'Y'] )
;
return $error if $error;
$self->SUPER::check;
}
#it looks redundant with a v4.x+ auto-generated method, but need to override
# FS::TemplateItem_Mixin's version
sub part_pkg {
my $self = shift;
qsearchs('part_pkg', { 'pkgpart' => $self->pkgpart } );
}
sub desc {
my $self = shift;
$self->part_pkg->pkg;
}
sub setup {
my $self = shift;
return '0.00' if $self->waive_setup eq 'Y' || $self->{'_NO_SETUP_KLUDGE'};
my $part_pkg = $self->part_pkg;
#my $setup = $part_pkg->can('base_setup') ? $part_pkg->base_setup
# : $part_pkg->option('setup_fee');
my $setup = $part_pkg->option('setup_fee');
#XXX discounts
$setup *= $self->quantity if $self->quantity;
sprintf('%.2f', $setup);
}
sub recur {
my $self = shift;
return '0.00' if $self->{'_NO_RECUR_KLUDGE'};
my $part_pkg = $self->part_pkg;
my $recur = $part_pkg->can('base_recur') ? $part_pkg->base_recur($self)
: $part_pkg->option('recur_fee');
#XXX discounts
$recur *= $self->quantity if $self->quantity;
sprintf('%.2f', $recur);
}
=item part_pkg_currency_option OPTIONNAME
Returns a two item list consisting of the currency of this quotation's customer
or prospect, if any, and a value for the provided option. If the customer or
prospect has a currency, the value is the option value the given name and the
currency (see L<FS::part_pkg_currency>). Otherwise, if the customer or
prospect has no currency, is the regular option value for the given name (see
L<FS::part_pkg_option>).
=cut
#false laziness w/cust_pkg->part_pkg_currency_option
sub part_pkg_currency_option {
my( $self, $optionname ) = @_;
my $part_pkg = $self->part_pkg;
my $prospect_or_customer = $self->cust_main || $self->prospect_main;
if ( my $currency = $prospect_or_customer->currency ) {
($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
} else {
('', $part_pkg->option($optionname) );
}
}
=item cust_bill_pkg_display [ type => TYPE ]
=cut
sub cust_bill_pkg_display {
my ( $self, %opt ) = @_;
my $type = $opt{type} if exists $opt{type};
return () if $type eq 'U'; #quotations don't have usage
if ( $self->get('display') ) {
return ( grep { defined($type) ? ($type eq $_->type) : 1 }
@{ $self->get('display') }
);
} else {
#??
my $setup = $self->new($self->hashref);
$setup->{'_NO_RECUR_KLUDGE'} = 1;
$setup->{'type'} = 'S';
my $recur = $self->new($self->hashref);
$recur->{'_NO_SETUP_KLUDGE'} = 1;
$recur->{'type'} = 'R';
if ( $type eq 'S' ) {
return ($setup);
} elsif ( $type eq 'R' ) {
return ($recur);
} else {
#return ($setup, $recur);
return ($self);
}
}
}
=item cust_main
Returns the customer (L<FS::cust_main> object).
=cut
sub cust_main {
my $self = shift;
my $quotation = FS::quotation->by_key($self->quotationnum) or return '';
$quotation->cust_main;
}
=item prospect_main
Returns the prospect (L<FS::prospect_main> object).
=cut
sub prospect_main {
my $self = shift;
my $quotation = FS::quotation->by_key($self->quotationnum) or return '';
$quotation->prospect_main;
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|