invoice configurations, #24723

1 files changed, 274 insertions, 0 deletions

diff --git a/FS/FS/invoice_conf.pm b/FS/FS/invoice_conf.pm
new file mode 100644
index 0000000..043cab0
--- /dev/null
+++ b/FS/FS/invoice_conf.pm
@@ -0,0 +1,274 @@
+package FS::invoice_conf;
+
+use strict;
+use base qw( FS::Record FS::Conf );
+use FS::Record qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::invoice_conf - Object methods for invoice_conf records
+
+=head1 SYNOPSIS
+
+  use FS::invoice_conf;
+
+  $record = new FS::invoice_conf \%hash;
+  $record = new FS::invoice_conf { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::invoice_conf object represents a set of localized invoice 
+configuration values.  FS::invoice_conf inherits from FS::Record and FS::Conf,
+and supports the FS::Conf interface.  The following fields are supported:
+
+=over 4
+
+=item confnum - primary key
+
+=item modenum - L<FS::invoice_mode> foreign key
+
+=item locale - locale string (see L<FS::Locales>)
+
+=item notice_name - the title to display on the invoice
+
+=item subject - subject line of the email
+
+=item htmlnotes - "notes" section (HTML)
+
+=item htmlfooter - footer (HTML)
+
+=item htmlsummary - summary header, for invoices in summary format (HTML)
+
+=item htmlreturnaddress - return address (HTML)
+
+=item latexnotes - "notes" section (LaTeX)
+
+=item latexfooter - footer (LaTeX)
+
+=item latexsummary - summary header, for invoices in summary format (LaTeX)
+
+=item latexreturnaddress - return address (LaTeX)
+
+=item latexcoupon - payment coupon section (LaTeX)
+
+=item latexsmallfooter - footer for pages after the first (LaTeX)
+
+=item latextopmargin - top margin
+
+=item latexheadsep - distance from bottom of header to top of body
+
+=item latexaddresssep - distance from top of body to customer address
+
+=item latextextheight - maximum height of invoice body text
+
+=item latexextracouponspace - additional footer space to allow for coupon
+
+=item latexcouponfootsep - distance from bottom of coupon content to top
+of page footer
+
+=item latexcouponamountenclosedsep - distance from coupon balance line to
+"Amount Enclosed" box
+
+=item latexcoupontoaddresssep - distance from "Amount Enclosed" box to 
+coupon mailing address
+
+=item latexverticalreturnaddress - 'Y' to place the return address below 
+the company logo rather than beside it
+
+=item latexcouponaddcompanytoaddress - 'Y' to add the company name to the 
+address on the payment coupon
+
+=item logo_png - company logo, as a PNG, for HTML invoices
+
+=item logo_eps - company logo, as an EPS, for LaTeX invoices
+
+=item lpr - command to print the invoice (passed on stdin as a PDF)
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new invoice configuration.  To add it to the database, see 
+L<"insert">.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'invoice_conf'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# slightly special: you can insert/replace the invoice mode this way
+
+sub insert {
+  my $self = shift;
+  if (!$self->modenum) {
+    my $invoice_mode = FS::invoice_mode->new({
+        'modename' => $self->modename,
+        'agentnum' => $self->agentnum,
+    });
+    my $error = $invoice_mode->insert;
+    return $error if $error;
+    $self->set('modenum' => $invoice_mode->modenum);
+  } else {
+    my $invoice_mode = FS::invoice_mode->by_key($self->modenum);
+    my $changed = 0;
+    foreach (qw(agentnum modename)) {
+      $changed ||= ($invoice_mode->get($_) eq $self->get($_));
+      $invoice_mode->set($_, $self->get($_));
+    }
+    my $error = $invoice_mode->replace if $changed;
+    return $error if $error;
+  }
+  $self->SUPER::insert(@_);
+}
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+sub delete {
+  my $self = shift;
+  my $error = $self->FS::Record::delete; # not Conf::delete
+  return $error if $error;
+  my $invoice_mode = FS::invoice_mode->by_key($self->modenum);
+  if ( $invoice_mode and
+       FS::invoice_conf->count('modenum = '.$invoice_mode->modenum) == 0 ) {
+    $error = $invoice_mode->delete;
+    return $error if $error;
+  }
+  '';
+}
+
+=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
+
+sub replace {
+  my $self = shift;
+  my $error = $self->SUPER::replace(@_);
+  return $error if $error;
+
+  my $invoice_mode = FS::invoice_mode->by_key($self->modenum);
+  my $changed = 0;
+  foreach (qw(agentnum modename)) {
+    $changed ||= ($invoice_mode->get($_) eq $self->get($_));
+    $invoice_mode->set($_, $self->get($_));
+  }
+  $error = $invoice_mode->replace if $changed;
+  return $error if $error;
+}
+
+=item check
+
+Checks all fields to make sure this is a valid example.  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;
+
+  my $error = 
+    $self->ut_numbern('confnum')
+    || $self->ut_number('modenum')
+    || $self->ut_textn('locale')
+    || $self->ut_anything('notice_name')
+    || $self->ut_anything('subject')
+    || $self->ut_anything('htmlnotes')
+    || $self->ut_anything('htmlfooter')
+    || $self->ut_anything('htmlsummary')
+    || $self->ut_anything('htmlreturnaddress')
+    || $self->ut_anything('latexnotes')
+    || $self->ut_anything('latexfooter')
+    || $self->ut_anything('latexsummary')
+    || $self->ut_anything('latexcoupon')
+    || $self->ut_anything('latexsmallfooter')
+    || $self->ut_anything('latexreturnaddress')
+    || $self->ut_textn('latextopmargin')
+    || $self->ut_textn('latexheadsep')
+    || $self->ut_textn('latexaddresssep')
+    || $self->ut_textn('latextextheight')
+    || $self->ut_textn('latexextracouponspace')
+    || $self->ut_textn('latexcouponfootsep')
+    || $self->ut_textn('latexcouponamountenclosedsep')
+    || $self->ut_textn('latexcoupontoaddresssep')
+    || $self->ut_flag('latexverticalreturnaddress')
+    || $self->ut_flag('latexcouponaddcompanytoaddress')
+    || $self->ut_anything('logo_png')
+    || $self->ut_anything('logo_eps')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+# hook _config to substitute our own values; let FS::Conf do the rest of 
+# the interface
+
+sub _config {
+  my $self = shift;
+  # if we fall back, we still want FS::Conf to respect our locale
+  $self->{locale} = $self->get('locale');
+  my ($key, $agentnum, $nodefault) = @_;
+  # some fields, but not all, start with invoice_
+  my $colname = $key;
+  if ( $key =~ /^invoice_(.*)$/ ) {
+    $colname = $1;
+  }
+  if ( length($self->get($colname)) ) {
+    return FS::conf->new({ 'name'   => $key,
+                           'value'  => $self->get($colname) });
+  } else {
+    return $self->FS::Conf::_config(@_);
+  }
+}
+
+# disambiguation
+sub set {
+  my $self = shift;
+  $self->FS::Record::set(@_);
+}
+
+sub exists {
+  my $self = shift;
+  $self->FS::Conf::exists(@_);
+}
+
+=back
+
+=head1 SEE ALSO
+
+L<FS::Template_Mixin>, L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+