This commit was generated by cvs2svn to compensate for changes in r5562,

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

diff --git a/FS/FS/payinfo_Mixin.pm b/FS/FS/payinfo_Mixin.pm
index 652dc41..2d7b4ff 100644 (file)
--- a/FS/FS/payinfo_Mixin.pm
+++ b/FS/FS/payinfo_Mixin.pm
@@ -14,7 +14,7 @@ package FS::some_table;
 use vars qw(@ISA);
 @ISA = qw( FS::payinfo_Mixin FS::Record );
 
-=had1 DESCRIPTION
+=head1 DESCRIPTION
 
 This is a mixin class for records that contain payinfo. 
 
@@ -110,21 +110,26 @@ sub paycvv {
 =cut
 
 sub paymask {
-  my($self,$paymask)=@_;
+  my($self, $paymask) = @_;
 
-
-  if ($paymask ne '') {
-    # I hate this little bit of magic...  I don't expect it to cause a problem, but who knows...
-    # If the payinfo is passed in masked then ignore it and set it based on the payinfo
-    # The only guy that should call this in this way is... $self->payinfo
+  if ( defined($paymask) && $paymask ne '' ) {
+    # I hate this little bit of magic...  I don't expect it to cause a problem,
+    # but who knows...  If the payinfo is passed in masked then ignore it and
+    # set it based on the payinfo.  The only guy that should call this in this
+    # way is... $self->payinfo
     $self->setfield('paymask', $self->mask_payinfo());
+
   } else {
+
     $paymask=$self->getfield('paymask');
     if (!defined($paymask) || $paymask eq '') {
-      # Generate it if it's blank - Note that we're not going to set it - just generate
+      # Generate it if it's blank - Note that we're not going to set it - just
+      # generate
       $paymask = $self->mask_payinfo();
     }
+
   }
+
   return $paymask;
 }
 
@@ -134,28 +139,36 @@ sub paymask {
 
 =over 4
 
-=item mask_payinfo
+=item mask_payinfo [ PAYBY, PAYINFO ]
+
+This method converts the payment info (credit card, bank account, etc.) into a
+masked string.
 
-This method converts the payment info (credit card, bank account, etc.) into a masked string.
+Optionally, an arbitrary payby and payinfo can be passed.
 
 =cut
 
 sub mask_payinfo {
   my $self = shift;
-  my $paymask;
-  my $payinfo = $self->payinfo;
-  my $payby = $self->payby;
+  my $payby   = scalar(@_) ? shift : $self->payby;
+  my $payinfo = scalar(@_) ? shift : $self->payinfo;
+
   # Check to see if it's encrypted...
-  if ($self->is_encrypted($payinfo)) {
+  my $paymask;
+  if ( $self->is_encrypted($payinfo) ) {
     $paymask = 'N/A';
   } else {
     # if not, mask it...
-    if ($payby eq 'CARD' || $payby eq 'DCRD' || $payby eq 'MCRD') { # Credit Cards (Show first and last four)
-      $paymask = substr($payinfo,0,6). 'x'x(length($payinfo)-10). substr($payinfo,(length($payinfo)-4));
-    } elsif ($payby eq 'CHEK' ||
-             $payby eq 'DCHK' ) { # Checks (Show last 2 @ bank)
+    if ($payby eq 'CARD' || $payby eq 'DCRD' || $payby eq 'MCRD') {
+      # Credit Cards (Show first and last four)
+      $paymask = substr($payinfo,0,6).
+                 'x'x(length($payinfo)-10).
+                 substr($payinfo,(length($payinfo)-4));
+    } elsif ($payby eq 'CHEK' || $payby eq 'DCHK' ) {
+      # Checks (Show last 2 @ bank)
       my( $account, $aba ) = split('@', $payinfo );
-      $paymask = 'x'x(length($account)-2). substr($account,(length($account)-2))."@".$aba;
+      $paymask = 'x'x(length($account)-2).
+                 substr($account,(length($account)-2))."@".$aba;
     } else { # Tie up loose ends
       $paymask = $payinfo;
     }
@@ -163,6 +176,11 @@ sub mask_payinfo {
   return $paymask;
 }
 
+=cut
+
+sub _mask_payinfo {
+  my $self = shift;
+
 =item payinfo_check
 
 Checks payby and payinfo.
@@ -190,7 +208,7 @@ sub payinfo_check {
   my $self = shift;
 
   FS::payby->can_payby($self->table, $self->payby)
-    or return "Illegal payby";
+    or return "Illegal payby: ". $self->payby;
 
   if ( $self->payby eq 'CARD' ) {
     my $payinfo = $self->payinfo;