agent-virtualize credit card surcharge percentage, RT#72961

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

diff --git a/FS/FS/cust_bill_void.pm b/FS/FS/cust_bill_void.pm
index cce77b3..50f69c9 100644 (file)
--- a/FS/FS/cust_bill_void.pm
+++ b/FS/FS/cust_bill_void.pm
@@ -1,14 +1,18 @@
 package FS::cust_bill_void;
-use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record );
+use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin
+             FS::reason_Mixin FS::Record );
 
 use strict;
+use vars qw( $me $DEBUG );
 use FS::Record qw( qsearch qsearchs dbh fields );
-use FS::cust_main;
 use FS::cust_statement;
 use FS::access_user;
 use FS::cust_bill_pkg_void;
 use FS::cust_bill;
 
+$me = '[ FS::cust_bill_void ]';
+$DEBUG = 0;
+
 =head1 NAME
 
 FS::cust_bill_void - Object methods for cust_bill_void records
@@ -83,9 +87,13 @@ promised_date
 
 void_date
 
-=item reason
+=item reason 
+
+freeform string (deprecated)
 
-reason
+=item reasonnum 
+
+reason for voiding the payment (see L<FS::reson>)
 
 =item void_usernum
 
@@ -109,7 +117,17 @@ points to.  You can ask the object for a copy with the I<hash> method.
 
 sub table { 'cust_bill_void'; }
 sub notice_name { 'VOIDED Invoice'; }
-#XXXsub template_conf { 'quotation_'; }
+sub template_conf { 'invoice_'; }
+
+sub has_sections {
+  my $self = shift;
+  my $agentnum = $self->cust_main->agentnum;
+  my $tc = $self->template_conf;
+
+  $self->conf->exists($tc.'sections', $agentnum) ||
+  $self->conf->exists($tc.'sections_by_location', $agentnum);
+}
+
 
 =item insert
 
@@ -207,6 +225,7 @@ sub check {
     || $self->ut_numbern('void_date')
     || $self->ut_textn('reason')
     || $self->ut_numbern('void_usernum')
+    || $self->ut_foreign_keyn('reasonnum', 'reason', 'reasonnum')
   ;
   return $error if $error;
 
@@ -248,30 +267,103 @@ sub void_access_user {
 
 =item cust_main
 
+=item cust_bill_pkg
+
+=item reason
+
+Returns the text of the associated void reason (see L<FS::reason>) for this.
+
 =cut
 
-sub cust_main {
+sub cust_bill_pkg { #actually cust_bill_pkg_void objects
   my $self = shift;
-  qsearchs('cust_main', { 'custnum' => $self->custnum } );
+  qsearch('cust_bill_pkg_void', { invnum=>$self->invnum });
 }
 
-=item cust_bill_pkg
+=back
+
+=item cust_pkg
+
+Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
+this invoice.
 
 =cut
 
-sub cust_bill_pkg { #actually cust_bill_pkg_void objects
+sub cust_pkg {
   my $self = shift;
-  qsearch('cust_bill_pkg_void', { invnum=>$self->invnum });
+  my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
+                 $self->cust_bill_pkg;
+  my %saw = ();
+  grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
 }
 
+=item search_sql_where HASHREF
+
+Class method which returns an SQL WHERE fragment to search for parameters
+specified in HASHREF.  Accepts the following parameters for 
+L<FS::cust_bill::search_sql_where>: C<_date>, C<invnum_min>, C<invnum_max>,
+C<agentnum>, C<custnum>, C<cust_classnum>, C<refnum>.  Also 
+accepts the following:
+
+=over 4
+
+=item void_date
+
+Arrayref of start and end date to find invoices voided in a date range.
+
+=item void_usernum
+
+User identifier (L<FS::access_user> key) that voided the invoice.
+
 =back
 
+=cut
+
+sub search_sql_where {
+  my($class, $param) = @_;
+
+  my $cust_bill_param = {
+    map { $_ => $param->{$_} }
+    grep { exists($param->{$_}) }
+    qw( _date invnum_min invnum_max agentnum custnum cust_classnum 
+        refnum )
+  };
+  my $search_sql = FS::cust_bill->search_sql_where($cust_bill_param);
+  $search_sql =~ s/cust_bill/cust_bill_void/g;
+  my @search = ($search_sql);
+
+  if ( $param->{void_date} ) {
+    my($beginning, $ending) = @{$param->{void_date}};
+    push @search, "cust_bill_void.void_date >= $beginning",
+                  "cust_bill_void.void_date <  $ending";
+  }
+
+  if ( $param->{void_usernum} =~ /^(\d+)$/ ) {
+    my $usernum = $1;
+    push @search, "cust_bill_void.void_usernum = $1";
+  }
+
+  join(" AND ", @search);
+}
+
+
 =item enable_previous
 
 =cut
 
 sub enable_previous { 0 }
 
+# _upgrade_data
+#
+# Used by FS::Upgrade to migrate to a new database.
+sub _upgrade_data {  # class method
+  my ($class, %opts) = @_;
+
+  warn "$me upgrading $class\n" if $DEBUG;
+
+  $class->_upgrade_reasonnum(%opts);
+}
+
 =back
 
 =head1 BUGS