1 package FS::TemplateItem_Mixin;
4 use vars qw( $DEBUG $me $conf $date_format );
8 use FS::Record qw( qsearch qsearchs dbh );
14 $me = '[FS::TemplateItem_Mixin]';
15 FS::UID->install_callback( sub {
17 $date_format = $conf->config('date_format') || '%x'; #/YY
22 Returns the package (see L<FS::cust_pkg>) for this invoice line item.
28 carp "$me $self -> cust_pkg" if $DEBUG;
29 qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
34 Returns the package definition for this invoice line item.
40 if ( $self->pkgpart_override ) {
41 qsearchs('part_pkg', { 'pkgpart' => $self->pkgpart_override } );
44 my $cust_pkg = $self->cust_pkg;
45 $part_pkg = $cust_pkg->part_pkg if $cust_pkg;
52 Returns the fee definition for this line item, if there is one.
59 ? FS::part_fee->by_key($self->feepart)
65 Returns L</part_pkg> or L</part_fee>, whichever is applicable (or nothing,
66 if called on a tax line item).
72 $self->part_pkg || $self->part_fee;
77 Returns a description for this line item. For typical line items, this is the
78 I<pkg> field of the corresponding B<FS::part_pkg> object (see L<FS::part_pkg>).
79 For one-shot line items and named taxes, it is the I<itemdesc> field of this
80 line item, and for generic taxes, simply returns "Tax".
85 my( $self, $locale ) = @_;
87 if ( $self->pkgnum > 0 ) {
88 return $self->itemdesc if $self->itemdesc;
89 my $part_pkg = $self->part_pkg or return 'UNKNOWN';
90 return $part_pkg->pkg_locale($locale);
92 } elsif ( $self->feepart ) {
93 return $self->part_fee->itemdesc_locale($locale);
95 } else { # by the process of elimination it must be a tax
96 my $desc = $self->itemdesc || 'Tax';
97 $desc .= ' '. $self->itemcomment if $self->itemcomment =~ /\S/;
103 =item time_period_pretty PART_PKG, AGENTNUM
105 Returns a formatted time period for this line item.
109 sub time_period_pretty {
110 my( $self, $part_pkg, $agentnum ) = @_;
112 #more efficient to look some of this conf stuff up outside the
113 # invoice/template display loop we're called from
114 # (Template_Mixin::_invoice_cust_bill_pkg) and pass them in as options
116 return '' if $conf->exists('disable_line_item_date_ranges')
117 || $part_pkg->option('disable_line_item_date_ranges',1)
122 $date_style = $conf->config( 'cust_bill-line_item-date_style-non_monhtly',
125 if $part_pkg && $part_pkg->freq !~ /^1m?$/;
126 $date_style ||= $conf->config( 'cust_bill-line_item-date_style',
131 if ( defined($date_style) && $date_style eq 'month_of' ) {
132 # (now watch, someone's going to make us do Chinese)
133 $time_period = $self->mt('The month of [_1]',
134 $self->time2str_local('%B', $self->sdate)
136 } elsif ( defined($date_style) && $date_style eq 'X_month' ) {
137 my $desc = $conf->config( 'cust_bill-line_item-date_description',
140 $desc .= ' ' unless $desc =~ /\s$/;
141 $time_period = $desc. $self->time2str_local('%B', $self->sdate);
143 $time_period = $self->time2str_local($date_format, $self->sdate).
144 " - ". $self->time2str_local($date_format, $self->edate);
151 =item details [ OPTION => VALUE ... ]
153 Returns an array of detail information for the invoice line item.
157 I<format>: set to 'html' or 'latex' to have the detail lines formatted for
158 inclusion in an HTML table (wrapped in <tr> and <td> elements) or LaTeX table
159 (delimited with & and \\ operators).
161 I<escape_function>: if present, then the array elements are processed by this
162 function before being returned.
164 I<format_function>: overrides the normal HTML or LaTeX function for returning
167 I<no_usage>: excludes call detail records. The method will still return
168 some special-case records like prorate details, and manually created package
174 my ( $self, %opt ) = @_;
175 my $escape_function = $opt{escape_function} || sub { shift };
177 my $csv = new Text::CSV_XS;
178 my $key = $self->primary_key;
180 if ( $opt{format_function} ) {
182 #this still expects to be passed a cust_bill_pkg_detail object as the
183 #second argument, which is expensive
184 carp "deprecated format_function passed to cust_bill_pkg->details";
185 my $format_sub = $opt{format_function} if $opt{format_function};
187 map { ( $_->format eq 'C'
188 ? &{$format_sub}( $_->detail, $_ )
189 : &{$escape_function}( $_->detail )
192 qsearch ({ 'table' => $self->detail_table,
193 'hashref' => { $key => $self->get($key) },
194 'order_by' => 'ORDER BY detailnum',
197 } elsif ( $opt{'no_usage'} ) {
199 my $sql = "SELECT detail FROM ". $self->detail_table.
200 " WHERE " . $key . " = ". $self->get($key).
201 " AND ( format IS NULL OR format != 'C' ) ".
202 " ORDER BY detailnum";
203 my $sth = dbh->prepare($sql) or die dbh->errstr;
204 $sth->execute or die $sth->errstr;
206 map &{$escape_function}( $_->[0] ), @{ $sth->fetchall_arrayref };
211 my $format = $opt{format} || '';
212 if ( $format eq 'html' ) {
214 $format_sub = sub { my $detail = shift;
215 $csv->parse($detail) or return "can't parse $detail";
216 join('</TD><TD>', map { &$escape_function($_) }
221 } elsif ( $format eq 'latex' ) {
225 $csv->parse($detail) or return "can't parse $detail";
226 #join(' & ', map { '\small{'. &$escape_function($_). '}' }
230 foreach ($csv->fields) {
231 $result .= ' & ' if $column > 1;
232 if ($column > 6) { # KLUDGE ALERT!
233 $result .= '\multicolumn{1}{l}{\scriptsize{'.
234 &$escape_function($_). '}}';
236 $result .= '\scriptsize{'. &$escape_function($_). '}';
245 $format_sub = sub { my $detail = shift;
246 $csv->parse($detail) or return "can't parse $detail";
247 join(' - ', map { &$escape_function($_) }
254 my $sql = "SELECT format, detail FROM ". $self->detail_table.
255 " WHERE " . $key . " = ". $self->get($key).
256 " ORDER BY detailnum";
257 my $sth = dbh->prepare($sql) or die dbh->errstr;
258 $sth->execute or die $sth->errstr;
260 #avoid the fetchall_arrayref and loop for less memory usage?
262 map { (defined($_->[0]) && $_->[0] eq 'C')
263 ? &{$format_sub}( $_->[1] )
264 : &{$escape_function}( $_->[1] );
266 @{ $sth->fetchall_arrayref };
272 =item details_header [ OPTION => VALUE ... ]
274 Returns a list representing an invoice line item detail header, if any.
275 This relies on the behavior of voip_cdr in that it expects the header
276 to be the first CSV formatted detail (as is expected by invoice generation
277 routines). Returns the empty list otherwise.
284 my $csv = new Text::CSV_XS;
287 qsearch ({ 'table' => $self->detail_table,
288 'hashref' => { 'billpkgnum' => $self->billpkgnum,
291 'order_by' => 'ORDER BY detailnum LIMIT 1',
293 return() unless scalar(@detail);
294 $csv->parse($detail[0]->detail) or return ();
303 my( $self, $value ) = @_;
304 if ( defined($value) ) {
305 $self->setfield('quantity', $value);
307 $self->getfield('quantity') || 1;
315 my( $self, $value ) = @_;
316 if ( defined($value) ) {
317 $self->setfield('unitsetup', $value);
319 $self->getfield('unitsetup') eq ''
320 ? $self->getfield('setup')
321 : $self->getfield('unitsetup');
329 my( $self, $value ) = @_;
330 if ( defined($value) ) {
331 $self->setfield('unitrecur', $value);
333 $self->getfield('unitrecur') eq ''
334 ? $self->getfield('recur')
335 : $self->getfield('unitrecur');
338 =item cust_bill_pkg_display [ type => TYPE ]
340 Returns an array of display information for the invoice line item optionally
345 sub cust_bill_pkg_display {
346 my ( $self, %opt ) = @_;
348 my $class = 'FS::'. $self->display_table;
350 my $default = $class->new( { billpkgnum =>$self->billpkgnum } );
352 my $type = $opt{type} if exists $opt{type};
355 if ( $self->get('display') ) {
356 @result = grep { defined($type) ? ($type eq $_->type) : 1 }
357 @{ $self->get('display') };
359 my $hashref = { 'billpkgnum' => $self->billpkgnum };
360 $hashref->{type} = $type if defined($type);
362 my $order_by = $self->display_table_orderby || 'billpkgdisplaynum';
364 @result = qsearch ({ 'table' => $self->display_table,
365 'hashref' => $hashref,
366 'order_by' => "ORDER BY $order_by",
370 push @result, $default unless ( scalar(@result) || $type );
376 =item cust_bill_pkg_detail [ CLASSNUM ]
378 Returns the list of associated cust_bill_pkg_detail objects
379 The optional CLASSNUM argument will limit the details to the specified usage
384 sub cust_bill_pkg_detail {
386 my $classnum = shift || '';
388 my %hash = ( 'billpkgnum' => $self->billpkgnum );
389 $hash{classnum} = $classnum if $classnum;
391 qsearch( $self->detail_table, \%hash ),
397 Returns the list of associated cust_bill_pkg_discount or
398 quotation_pkg_discount objects.
404 my $pkey = $self->primary_key;
405 qsearch( $self->discount_table, { $pkey => $self->get($pkey) } );