clean up payinfo_Mixin to use payby.pm for payby info and have card masking full...

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

diff --git a/FS/FS/payby.pm b/FS/FS/payby.pm
index 3d43dff..e44ac6a 100644 (file)
--- a/FS/FS/payby.pm
+++ b/FS/FS/payby.pm
@@ -1,8 +1,10 @@
 package FS::payby;
 
 use strict;
-use vars qw(%hash);
+use vars qw(%hash %payby2bop);
 use Tie::IxHash;
+use Business::CreditCard;
+
 
 =head1 NAME
 
@@ -16,6 +18,8 @@ FS::payby - Object methods for payment type records
 
   my @payby = FS::payby->payby;
 
+  my $bool = FS::payby->can_payby('cust_main', 'CARD');
+
   tie my %payby, 'Tie::IxHash', FS::payby->payby2longname
 
   my @cust_payby = FS::payby->cust_payby;
@@ -34,6 +38,11 @@ Payment types.
 
 =cut
 
+# paybys can be any/all of:
+# - a customer payment type (cust_main.payby)
+# - a payment or refund type (cust_pay.payby, cust_pay_batch.payby, cust_refund.payby)
+# - an event type (part_bill_event.payby)
+
 tie %hash, 'Tie::IxHash',
   'CARD' => {
     tinyname  => 'card',
@@ -89,6 +98,23 @@ tie %hash, 'Tie::IxHash',
     tinyname  => 'comp',
     shortname => 'Complimentary',
     longname  => 'Complimentary',
+    cust_pay  => '', # (free) is depricated as a payment type in cust_pay
+  },
+  'CBAK' => {
+    tinyname  => 'chargeback',
+    shortname => 'Chargeback',
+    longname  => 'Chargeback',
+    cust_main => '', # not a customer type
+  },
+  'DCLN' => {  # This is only an event.
+    tinyname  => 'declined',
+    shortname => 'Batch declined payment',
+    longname  => 'Batch declined payment',
+
+    #its neither of these..
+    cust_main => '',
+    cust_pay  => '',
+
   },
 ;
 
@@ -96,14 +122,51 @@ sub payby {
   keys %hash;
 }
 
+sub can_payby {
+  my( $self, $table, $payby ) = @_;
+
+  #return "Illegal payby" unless $hash{$payby};
+  return 0 unless $hash{$payby};
+
+  $table = 'cust_pay' if $table eq 'cust_pay_batch' || $table eq 'cust_refund';
+  return 0 if exists( $hash{$payby}->{$table} );
+
+  return 1;
+}
+
 sub payby2longname {
   my $self = shift;
   map { $_ => $hash{$_}->{longname} } $self->payby;
 }
 
+sub shortname {
+  my( $self, $payby ) = @_;
+  $hash{$payby}->{shortname};
+}
+
+sub longname {
+  my( $self, $payby ) = @_;
+  $hash{$payby}->{longname};
+}
+
+%payby2bop = (
+  'CARD' => 'CC',
+  'CHEK' => 'ECHECK',
+);
+
+sub payby2bop {
+  my( $self, $payby ) = @_;
+  $payby2bop{ $self->payby2payment($payby) };
+}
+
+sub payby2payment {
+  my( $self, $payby ) = @_;
+  $hash{$payby}{'cust_pay'} || $payby;
+}
+
 sub cust_payby {
   my $self = shift;
-  grep { ! exists $hash{$_}->{cust_main} } self->payby;
+  grep { ! exists $hash{$_}->{cust_main} } $self->payby;
 }
 
 sub cust_payby2longname {
@@ -115,7 +178,8 @@ sub cust_payby2longname {
 
 =head1 BUGS
 
-This should eventually be an actual database table.
+This should eventually be an actual database table, and all tables that
+currently have a char payby field should have a foreign key into here instead.
 
 =head1 SEE ALSO