eliminate some false laziness in FS::Misc::send_email vs. msg_template/email.pm send_...

[freeside.git] / FS / FS / cust_bill_pay.pm

diff --git a/FS/FS/cust_bill_pay.pm b/FS/FS/cust_bill_pay.pm
index 7abbe9a..23f8814 100644 (file)
--- a/FS/FS/cust_bill_pay.pm
+++ b/FS/FS/cust_bill_pay.pm
@@ -1,12 +1,9 @@
 package FS::cust_bill_pay;
+use base qw( FS::cust_main_Mixin FS::cust_bill_ApplicationCommon );
 
 use strict;
-use vars qw( @ISA $conf );
-use FS::Record qw( qsearch qsearchs dbh );
-use FS::cust_bill;
-use FS::cust_pay;
-
-@ISA = qw( FS::Record );
+use vars qw( $conf );
+use FS::UID;
 
 #ask FS::UID to run this stuff for us later
 FS::UID->install_callback( sub { 
@@ -35,8 +32,9 @@ FS::cust_bill_pay - Object methods for cust_bill_pay records
 =head1 DESCRIPTION
 
 An FS::cust_bill_pay object represents the application of a payment to a
-specific invoice.  FS::cust_bill_pay inherits from FS::Record.  The following
-fields are currently supported:
+specific invoice.  FS::cust_bill_pay inherits from
+FS::cust_bill_ApplicationCommon and FS::Record.  The following fields are
+currently supported:
 
 =over 4
 
@@ -65,6 +63,11 @@ Creates a new record.  To add the record to the database, see L<"insert">.
 
 sub table { 'cust_bill_pay'; }
 
+sub _app_source_name   { 'payment'; }
+sub _app_source_table { 'cust_pay'; }
+sub _app_lineitem_breakdown_table { 'cust_bill_pay_pkg'; }
+sub _app_part_pkg_weight_column { 'pay_weight'; }
+
 =item insert
 
 Adds this record to the database.  If there is an error, returns the error,
@@ -80,7 +83,9 @@ Deletes this payment application, unless the closed flag for the parent payment
 sub delete {
   my $self = shift;
   return "Can't delete application for closed payment"
-    if $self->cust_pay->closed =~ /^Y/i;
+    if $self->cust_pay && $self->cust_pay->closed =~ /^Y/i;
+  return "Can't delete application for closed invoice"
+    if $self->cust_bill && $self->cust_bill->closed =~ /^Y/i;
   $self->SUPER::delete(@_);
 }
 
@@ -91,13 +96,14 @@ Currently unimplemented (accounting reasons).
 =cut
 
 sub replace {
-   return "Can't (yet?) modify cust_bill_pay records!";
+   return "Can't modify application of payment!";
 }
 
 =item check
 
-Checks all fields to make sure this is a valid payment.  If there is an error,
-returns the error, otherwise returns false.  Called by the insert method.
+Checks all fields to make sure this is a valid payment application.  If there
+is an error, returns the error, otherwise returns false.  Called by the insert
+method.
 
 =cut
 
@@ -106,30 +112,23 @@ sub check {
 
   my $error = 
     $self->ut_numbern('billpaynum')
-    || $self->ut_number('invnum')
-    || $self->ut_number('paynum')
-    || $self->ut_money('amount')
+    || $self->ut_foreign_key('paynum', 'cust_pay', 'paynum' )
+    || $self->ut_foreign_key('invnum', 'cust_bill', 'invnum' )
     || $self->ut_numbern('_date')
+    || $self->ut_money('amount')
+    || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
   ;
   return $error if $error;
 
   return "amount must be > 0" if $self->amount <= 0;
   
-  return "Unknown invoice"
-    unless my $cust_bill =
-      qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
-
-  return "Unknown payment"
-    unless my $cust_pay = 
-      qsearchs( 'cust_pay', { 'paynum' => $self->paynum } );
-
   $self->_date(time) unless $self->_date;
 
   return "Cannot apply more than remaining value of invoice"
-    unless $self->amount <= $cust_bill->owed;
+    unless $self->amount <= $self->cust_bill->owed;
 
   return "Cannot apply more than remaining value of payment"
-    unless $self->amount <= $cust_pay->unapplied;
+    unless $self->amount <= $self->cust_pay->unapplied;
 
   $self->SUPER::check;
 }
@@ -138,22 +137,22 @@ sub check {
 
 Returns the payment (see L<FS::cust_pay>)
 
-=cut
+=item send_receipt HASHREF | OPTION => VALUE ...
 
-sub cust_pay {
-  my $self = shift;
-  qsearchs( 'cust_pay', { 'paynum' => $self->paynum } );
-}
+Sends a payment receipt for the associated payment, against this specific
+invoice.  If there is an error, returns the error, otherwise returns false.
 
-=item cust_bill 
-
-Returns the invoice (see L<FS::cust_bill>)
+See L<FS::cust_pay/send_receipt>.
 
 =cut
 
-sub cust_bill {
+sub send_receipt {
   my $self = shift;
-  qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
+  my $opt = ref($_[0]) ? shift : { @_ };
+  $self->cust_pay->send_receipt(
+    'cust_bill' => $self->cust_bill,
+    %$opt,
+  );
 }
 
 =back
@@ -162,9 +161,6 @@ sub cust_bill {
 
 Delete and replace methods.
 
-the checks for over-applied payments could be better done like the ones in
-cust_bill_credit
-
 =head1 SEE ALSO
 
 L<FS::cust_pay>, L<FS::cust_bill>, L<FS::Record>, schema.html from the