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;
53 Returns a description for this line item. For typical line items, this is the
54 I<pkg> field of the corresponding B<FS::part_pkg> object (see L<FS::part_pkg>).
55 For one-shot line items and named taxes, it is the I<itemdesc> field of this
56 line item, and for generic taxes, simply returns "Tax".
61 my( $self, $locale ) = @_;
63 if ( $self->pkgnum > 0 ) {
64 $self->itemdesc || $self->part_pkg->pkg_locale($locale);
65 } elsif ( $self->feepart ) {
66 $self->part_fee->itemdesc_locale($locale);
67 } else { # by the process of elimination it must be a tax
68 my $desc = $self->itemdesc || 'Tax';
69 $desc .= ' '. $self->itemcomment if $self->itemcomment =~ /\S/;
74 =item time_period_pretty PART_PKG, AGENTNUM
76 Returns a formatted time period for this line item.
80 sub time_period_pretty {
81 my( $self, $part_pkg, $agentnum ) = @_;
83 #more efficient to look some of this conf stuff up outside the
84 # invoice/template display loop we're called from
85 # (Template_Mixin::_invoice_cust_bill_pkg) and pass them in as options
87 return '' if $conf->exists('disable_line_item_date_ranges')
88 || $part_pkg->option('disable_line_item_date_ranges',1)
93 $date_style = $conf->config( 'cust_bill-line_item-date_style-non_monhtly',
96 if $part_pkg && $part_pkg->freq !~ /^1m?$/;
97 $date_style ||= $conf->config( 'cust_bill-line_item-date_style',
102 if ( defined($date_style) && $date_style eq 'month_of' ) {
103 # (now watch, someone's going to make us do Chinese)
104 $time_period = $self->mt('The month of [_1]',
105 $self->time2str_local('%B', $self->sdate)
107 } elsif ( defined($date_style) && $date_style eq 'X_month' ) {
108 my $desc = $conf->config( 'cust_bill-line_item-date_description',
111 $desc .= ' ' unless $desc =~ /\s$/;
112 $time_period = $desc. $self->time2str_local('%B', $self->sdate);
114 $time_period = $self->time2str_local($date_format, $self->sdate).
115 " - ". $self->time2str_local($date_format, $self->edate);
122 =item details [ OPTION => VALUE ... ]
124 Returns an array of detail information for the invoice line item.
126 Currently available options are: I<format>, I<escape_function> and
129 If I<format> is set to html or latex then the array members are improved
130 for tabular appearance in those environments if possible.
132 If I<escape_function> is set then the array members are processed by this
133 function before being returned.
135 I<format_function> overrides the normal HTML or LaTeX function for returning
136 formatted CDRs. It can be set to a subroutine which returns an empty list
137 to skip usage detail:
139 'format_function' => sub { () },
144 my ( $self, %opt ) = @_;
145 my $escape_function = $opt{escape_function} || sub { shift };
147 my $csv = new Text::CSV_XS;
149 if ( $opt{format_function} ) {
151 #this still expects to be passed a cust_bill_pkg_detail object as the
152 #second argument, which is expensive
153 carp "deprecated format_function passed to cust_bill_pkg->details";
154 my $format_sub = $opt{format_function} if $opt{format_function};
156 map { ( $_->format eq 'C'
157 ? &{$format_sub}( $_->detail, $_ )
158 : &{$escape_function}( $_->detail )
161 qsearch ({ 'table' => $self->detail_table,
162 'hashref' => { 'billpkgnum' => $self->billpkgnum },
163 'order_by' => 'ORDER BY detailnum',
166 } elsif ( $opt{'no_usage'} ) {
168 my $sql = "SELECT detail FROM ". $self->detail_table.
169 " WHERE billpkgnum = ". $self->billpkgnum.
170 " AND ( format IS NULL OR format != 'C' ) ".
171 " ORDER BY detailnum";
172 my $sth = dbh->prepare($sql) or die dbh->errstr;
173 $sth->execute or die $sth->errstr;
175 map &{$escape_function}( $_->[0] ), @{ $sth->fetchall_arrayref };
180 my $format = $opt{format} || '';
181 if ( $format eq 'html' ) {
183 $format_sub = sub { my $detail = shift;
184 $csv->parse($detail) or return "can't parse $detail";
185 join('</TD><TD>', map { &$escape_function($_) }
190 } elsif ( $format eq 'latex' ) {
194 $csv->parse($detail) or return "can't parse $detail";
195 #join(' & ', map { '\small{'. &$escape_function($_). '}' }
199 foreach ($csv->fields) {
200 $result .= ' & ' if $column > 1;
201 if ($column > 6) { # KLUDGE ALERT!
202 $result .= '\multicolumn{1}{l}{\scriptsize{'.
203 &$escape_function($_). '}}';
205 $result .= '\scriptsize{'. &$escape_function($_). '}';
214 $format_sub = sub { my $detail = shift;
215 $csv->parse($detail) or return "can't parse $detail";
216 join(' - ', map { &$escape_function($_) }
223 my $sql = "SELECT format, detail FROM ". $self->detail_table.
224 " WHERE billpkgnum = ". $self->billpkgnum.
225 " ORDER BY detailnum";
226 my $sth = dbh->prepare($sql) or die dbh->errstr;
227 $sth->execute or die $sth->errstr;
229 #avoid the fetchall_arrayref and loop for less memory usage?
231 map { (defined($_->[0]) && $_->[0] eq 'C')
232 ? &{$format_sub}( $_->[1] )
233 : &{$escape_function}( $_->[1] );
235 @{ $sth->fetchall_arrayref };
241 =item details_header [ OPTION => VALUE ... ]
243 Returns a list representing an invoice line item detail header, if any.
244 This relies on the behavior of voip_cdr in that it expects the header
245 to be the first CSV formatted detail (as is expected by invoice generation
246 routines). Returns the empty list otherwise.
253 my $csv = new Text::CSV_XS;
256 qsearch ({ 'table' => $self->detail_table,
257 'hashref' => { 'billpkgnum' => $self->billpkgnum,
260 'order_by' => 'ORDER BY detailnum LIMIT 1',
262 return() unless scalar(@detail);
263 $csv->parse($detail[0]->detail) or return ();
272 my( $self, $value ) = @_;
273 if ( defined($value) ) {
274 $self->setfield('quantity', $value);
276 $self->getfield('quantity') || 1;
284 my( $self, $value ) = @_;
285 if ( defined($value) ) {
286 $self->setfield('unitsetup', $value);
288 $self->getfield('unitsetup') eq ''
289 ? $self->getfield('setup')
290 : $self->getfield('unitsetup');
298 my( $self, $value ) = @_;
299 if ( defined($value) ) {
300 $self->setfield('unitrecur', $value);
302 $self->getfield('unitrecur') eq ''
303 ? $self->getfield('recur')
304 : $self->getfield('unitrecur');
307 =item cust_bill_pkg_display [ type => TYPE ]
309 Returns an array of display information for the invoice line item optionally
314 sub cust_bill_pkg_display {
315 my ( $self, %opt ) = @_;
317 my $class = 'FS::'. $self->display_table;
319 my $default = $class->new( { billpkgnum =>$self->billpkgnum } );
321 my $type = $opt{type} if exists $opt{type};
324 if ( $self->get('display') ) {
325 @result = grep { defined($type) ? ($type eq $_->type) : 1 }
326 @{ $self->get('display') };
328 my $hashref = { 'billpkgnum' => $self->billpkgnum };
329 $hashref->{type} = $type if defined($type);
331 my $order_by = $self->display_table_orderby || 'billpkgdisplaynum';
333 @result = qsearch ({ 'table' => $self->display_table,
334 'hashref' => $hashref,
335 'order_by' => "ORDER BY $order_by",
339 push @result, $default unless ( scalar(@result) || $type );
345 =item cust_bill_pkg_detail [ CLASSNUM ]
347 Returns the list of associated cust_bill_pkg_detail objects
348 The optional CLASSNUM argument will limit the details to the specified usage
353 sub cust_bill_pkg_detail {
355 my $classnum = shift || '';
357 my %hash = ( 'billpkgnum' => $self->billpkgnum );
358 $hash{classnum} = $classnum if $classnum;
360 qsearch( $self->detail_table, \%hash ),
364 =item cust_bill_pkg_discount
366 Returns the list of associated cust_bill_pkg_discount objects.
370 sub cust_bill_pkg_discount {
372 qsearch( $self->discount_table, { 'billpkgnum' => $self->billpkgnum } );