show credit balance on invoices, #11564

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

diff --git a/FS/FS/cust_bill_event.pm b/FS/FS/cust_bill_event.pm
index 82e22f7..36afed0 100644 (file)
--- a/FS/FS/cust_bill_event.pm
+++ b/FS/FS/cust_bill_event.pm
@@ -38,18 +38,30 @@ currently supported:
 
 =over 4
 
-=item eventnum - primary key
+=item eventnum
 
-=item invnum - invoice (see L<FS::cust_bill>)
+Primary key
 
-=item eventpart - event definition (see L<FS::part_bill_event>)
+=item invnum
 
-=item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
+Invoice (see L<FS::cust_bill>)
+
+=item eventpart
+
+Event definition (see L<FS::part_bill_event>)
+
+=item _date
+
+Specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 L<Time::Local> and L<Date::Parse> for conversion functions.
 
-=item status - event status: B<done> or B<failed>
+=item status
+
+Event status: B<done> or B<failed>
 
-=item statustext - additional status detail (i.e. error message)
+=item statustext
+
+Additional status detail (i.e. error message)
 
 =back
 
@@ -189,6 +201,79 @@ sub retriable {
   $self->replace($old);
 }
 
+=item search_sql_where HASHREF
+
+Class method which returns an SQL WHERE fragment to search for parameters
+specified in HASHREF.  Valid parameters are
+
+=over 4
+
+=item agentnum
+
+=item beginning
+
+An epoch date setting a lower bound for _date values
+
+=item ending
+
+An epoch date setting a upper bound for _date values
+
+=item failed
+
+Limits the search to failed events if true
+
+=item payby
+
+Requires that the search be JOIN'd to part_bill_event # Bug?
+
+=item invnum 
+
+=item currentuser
+
+Specifies the user for agent virtualization
+
+=back
+
+=cut
+
+sub search_sql_where {
+  my ($class, $params) = @_;
+  my @search = ();
+
+  push @search, "agentnum = ". $params->{agentnum} if $params->{agentnum};
+
+  push @search, "cust_bill_event._date >= ". $params->{beginning}
+    if $params->{beginning};
+  push @search, "cust_bill_event._date <= ". $params->{ending}
+    if $params->{ending};
+
+  push @search, "statustext != ''",
+                "statustext IS NOT NULL",
+                "statustext != 'N/A'"
+    if $params->{failed};
+
+  push @search, "part_bill_event.payby = '". $params->{payby}. "'"
+    if $params->{payby};
+
+  push @search, "cust_bill_event.invnum = '". $params->{invnum}. "'"
+    if $params->{invnum};
+
+  my $currentuser = $params->{currentuser} || $params->{CurrentUser};
+  if ($currentuser) {
+    my $access_user = qsearchs('access_user', { username => $currentuser });
+    if ($access_user) {
+      push @search, $access_user->agentnums_sql;
+    }else{
+      push @search, "1=0";
+    }
+  }else{
+    push @search, $FS::CurrentUser::CurrentUser->agentnums_sql;
+  }
+
+  join(' AND ', @search );
+
+}
+
 =back
 
 =head1 SUBROUTINES
@@ -230,24 +315,21 @@ sub process_re_X {
 
   re_X(
     $method,
-    $param->{'beginning'},
-    $param->{'ending'},
-    $param->{'failed'},
+    $param,
     $job,
   );
 
 }
 
 sub re_X {
-  my($method, $beginning, $ending, $failed, $job) = @_;
+  my($method, $param, $job) = @_;
 
-  my $where = " WHERE plan LIKE 'send%'".
-              "   AND cust_bill_event._date >= $beginning".
-              "   AND cust_bill_event._date <= $ending";
-  $where .= " AND statustext != '' AND statustext IS NOT NULL"
-    if $failed;
+  my $where = FS::cust_bill_event->search_sql_where($param);
+  $where = " WHERE plan LIKE 'send%'". ( $where ? " AND $where" : "" );
 
-  my $from = 'LEFT JOIN part_bill_event USING ( eventpart )';
+  my $from = 'LEFT JOIN part_bill_event USING ( eventpart )'.
+             'LEFT JOIN cust_bill       USING ( invnum )'.
+             'LEFT JOIN cust_main       USING ( custnum )';
 
   my @cust_bill_event = qsearch( 'cust_bill_event', {}, '', $where, '', $from );