FS/FS/bill_batch.pm

   1 package FS::bill_batch;
   2 use base qw(FS::Record);
   3
   4 use strict;
   5 use vars qw( $me $DEBUG );
   6 use CAM::PDF;
   7 use FS::Conf;
   8
   9 $me = '[ FS::bill_batch ]';
  10 $DEBUG = 0;
  11
  12 sub table { 'bill_batch' }
  13
  14 sub nohistory_fields { 'pdf' }
  15
  16 =head1 NAME
  17
  18 FS::bill_batch - Object methods for bill_batch records
  19
  20 =head1 SYNOPSIS
  21
  22   use FS::bill_batch;
  23
  24   $open_batch = FS::bill_batch->get_open_batch;
  25
  26   my $pdf = $open_batch->print_pdf;
  27
  28   $error = $open_batch->close;
  29
  30 =head1 DESCRIPTION
  31
  32 An FS::bill_batch object represents a batch of invoices.  FS::bill_batch
  33 inherits from FS::Record.  The following fields are currently supported:
  34
  35 =over 4
  36
  37 =item batchnum - primary key
  38
  39 =item agentnum - empty for global batches or agent (see L<FS::agent>)
  40
  41 =item status - either 'O' (open) or 'R' (resolved/closed).
  42
  43 =item pdf - blob field for temporarily storing the invoice as a PDF.
  44
  45 =back
  46
  47 =head1 METHODS
  48
  49 =over 4
  50
  51 =item print_pdf
  52
  53 Typeset the entire batch as a PDF file.  Returns the PDF as a string.
  54
  55 =cut
  56
  57 sub print_pdf {
  58   my $self = shift;
  59   my $job = shift;
  60   $job->update_statustext(0) if $job;
  61   my @invoices = sort { $a->invnum <=> $b->invnum } $self->cust_bill_batch;
  62   return "No invoices in batch ".$self->batchnum.'.' if !@invoices;
  63
  64   my $duplex = FS::Conf->exists('invoice_print_pdf-duplex');
  65
  66   my $pdf_out;
  67   my $num = 0;
  68   foreach my $invoice (@invoices) {
  69     my $part = $invoice->cust_bill->print_pdf({$invoice->options});
  70     die 'Failed creating PDF from invoice '.$invoice->invnum.'\n' if !$part;
  71
  72     if($pdf_out) {
  73       $pdf_out->appendPDF(CAM::PDF->new($part));
  74     }
  75     else {
  76       $pdf_out = CAM::PDF->new($part);
  77     }
  78     if ( $duplex ) {
  79       my $n = $pdf_out->numPages;
  80       if ( $n % 2 == 1 ) {
  81         # then insert a blank page so we end on an even number
  82         $pdf_out->duplicatePage($n, 1);
  83       }
  84     }
  85     if($job) {
  86       # update progressbar
  87       $num++;
  88       my $error = $job->update_statustext(int(100 * $num/scalar(@invoices)));
  89       die $error if $error;
  90     }
  91   }
  92   $job->update_statustext(100, 'Combining invoices') if $job;
  93
  94   return $pdf_out->toPDF;
  95 }
  96
  97 =item close
  98
  99 Set the status of the batch to 'R' (resolved).
 100
 101 =cut
 102
 103 sub close {
 104   my $self = shift;
 105   $self->status('R');
 106   return $self->replace;
 107 }
 108
 109 sub check {
 110   my $self = shift;
 111
 112   my $error =
 113        $self->ut_numbern('batchnum')
 114     || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
 115     || $self->ut_enum('status', [ 'O', 'R' ] )
 116   ;
 117   return $error if $error;
 118
 119   $self->SUPER::check;
 120 }
 121
 122 =item agent
 123
 124 Returns the agent (see L<FS::agent>) for this invoice batch.
 125
 126 =back
 127
 128 =head1 SUBROUTINES
 129
 130 =item process_print_pdf
 131
 132 =cut
 133
 134 use Data::Dumper;
 135
 136 sub process_print_pdf {
 137   my $job = shift;
 138   my $param = shift;
 139   warn Dumper($param) if $DEBUG;
 140   die "no batchnum specified!\n" if ! exists($param->{batchnum});
 141   my $batch = FS::bill_batch->by_key($param->{batchnum});
 142   die "batch '$param->{batchnum}' not found!\n" if !$batch;
 143
 144   if ( $param->{'close'} ) {
 145     my $error = $batch->close;
 146     die $error if $error;
 147   }
 148
 149   my $pdf = $batch->print_pdf($job);
 150   $batch->pdf($pdf);
 151   my $error = $batch->replace;
 152   die $error if $error;
 153 }
 154
 155 =back
 156
 157 =head1 BUGS
 158
 159 =head1 SEE ALSO
 160
 161 L<FS::Record>, schema.html from the base documentation.
 162
 163 =cut
 164
 165 1;
 166