RT# 81961 Repair broken links in POD documentation

[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 cd6a9e1..5693371 100644 (file)
--- a/FS/FS/cust_bill_void.pm
+++ b/FS/FS/cust_bill_void.pm
@@ -2,11 +2,12 @@ package FS::cust_bill_void;
 use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record );
 
 use strict;
-use FS::Record qw( qsearch qsearchs );
+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;
 
 =head1 NAME
 
@@ -117,7 +118,55 @@ otherwise returns false.
 
 =cut
 
-# the insert method can be inherited from FS::Record
+=item unvoid 
+
+"Un-void"s this invoice: Deletes the voided invoice from the database and adds
+back a normal invoice (and related tables).
+
+=cut
+
+sub unvoid {
+  my $self = shift;
+
+  local $SIG{HUP} = 'IGNORE';
+  local $SIG{INT} = 'IGNORE';
+  local $SIG{QUIT} = 'IGNORE';
+  local $SIG{TERM} = 'IGNORE';
+  local $SIG{TSTP} = 'IGNORE';
+  local $SIG{PIPE} = 'IGNORE';
+
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  my $cust_bill = new FS::cust_bill ( {
+    map { $_ => $self->get($_) } fields('cust_bill')
+  } );
+  my $error = $cust_bill->insert;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  foreach my $cust_bill_pkg_void ( $self->cust_bill_pkg ) {
+    my $error = $cust_bill_pkg_void->unvoid;
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return $error;
+    }
+  }
+
+  $error = $self->delete;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+
+  '';
+
+}
 
 =item delete
 
@@ -125,8 +174,6 @@ Delete this record from the database.
 
 =cut
 
-# the delete method can be inherited from FS::Record
-
 =item replace OLD_RECORD
 
 Replaces the OLD_RECORD with this one in the database.  If there is an error,
@@ -134,8 +181,6 @@ returns the error, otherwise returns false.
 
 =cut
 
-# the replace method can be inherited from FS::Record
-
 =item check
 
 Checks all fields to make sure this is a valid voided invoice.  If there is
@@ -144,9 +189,6 @@ and replace methods.
 
 =cut
 
-# the check method should currently be supplied - FS::Record contains some
-# data checking routines
-
 sub check {
   my $self = shift;
 
@@ -224,13 +266,77 @@ sub cust_bill_pkg { #actually cust_bill_pkg_void objects
 
 =back
 
+=item cust_pkg
+
+Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
+this invoice.
+
+=cut
+
+sub cust_pkg {
+  my $self = shift;
+  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>, C<payby>.  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 payby )
+  };
+  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 }
 
-
 =back
 
 =head1 BUGS