Merge pull request #7 from RSully/feature-maskednumber

Add `CreditCard::getNumberMasked()` and tests

Author: amacneil

src/Omnipay/Common/CreditCard.php

@@ -197,6 +197,19 @@ public function getNumberLastFour()
         return substr($this->getNumber(), -4, 4) ?: null;
     }
 
+    /**
+     * Returns a masked credit card number with only the last 4 chars visible
+     *
+     * @param string $mask Character to use in place of numbers
+     * @return string
+     */
+    public function getNumberMasked($mask = 'X')
+    {
+        $maskLength = strlen($this->getNumber()) - 4;
+
+        return str_repeat($mask, $maskLength) . $this->getNumberLastFour();
+    }
+
     /**
      * Credit Card Brand
      *

tests/Omnipay/Common/CreditCardTest.php

@@ -179,6 +179,20 @@ public function testGetNumberLastFourNonDigits()
         $this->assertSame('1234', $this->card->getNumberLastFour());
     }
 
+    public function testGetNumberMasked()
+    {
+        $this->card->setNumber('4000000000001234');
+
+        $this->assertSame('XXXXXXXXXXXX1234', $this->card->getNumberMasked());
+    }
+
+    public function testGetNumberMaskedNonDigits()
+    {
+        $this->card->setNumber('4000 0000 0000 12x34');
+
+        $this->assertSame('XXXXXXXXXXXX1234', $this->card->getNumberMasked());
+    }
+
     public function testGetBrandDefault()
     {
         $card = new CreditCard;