Merge pull request #17 from RikudouSage/feature/rename-get-iban

rename getIban to asString in IbanInterface
RikudouSage · Dec 21, 2018 · 03a82f2 · 03a82f2
2 parents c9ede5f + c96a22e
commit 03a82f2
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -129,7 +129,8 @@ $payment = new QrPayment("CZ5530300000001325090010");
 ### getIban()
 
 Returns instance of `IbanInterface`, you can get the string
-representation of IBAN via method `getIban()` of `IbanInterface`.
+representation of IBAN via method `asString()` of `IbanInterface` or by casting
+the object to string.
 
 **Returns**
 
@@ -144,7 +145,8 @@ use rikudou\EuQrPayment\QrPayment;
 
 $payment = new QrPayment("CZ5530300000001325090010");
 $iban = $payment->getIban(); // holds instance of rikudou\EuQrPayment\Iban\IBAN
-$ibanAsString = $payment->getIban()->getIban();
+$ibanAsString = $payment->getIban()->asString();
+$ibanAsString = (string) $payment->getIban();
 
 ```
 

diff --git a/src/Helper/ToStringIban.php b/src/Helper/ToStringIban.php
@@ -6,11 +6,11 @@ trait ToStringIban
 {
     public function __toString()
     {
-        if (!method_exists($this, 'getIban')) {
+        if (!method_exists($this, 'asString')) {
             return '';
         }
         try {
-            return $this->getIban();
+            return $this->asString();
         } catch (\Throwable $exception) {
             return '';
         }

diff --git a/src/Iban/CzechIbanAdapter.php b/src/Iban/CzechIbanAdapter.php
@@ -36,7 +36,7 @@ public function __construct(string $accountNumber, string $bankCode)
      *
      * @return string
      */
-    public function getIban(): string
+    public function asString(): string
     {
         if (is_null($this->iban)) {
             $part1 = ord('C') - ord('A') + 10;

diff --git a/src/Iban/IBAN.php b/src/Iban/IBAN.php
@@ -25,7 +25,7 @@ public function __construct(string $iban)
      *
      * @return string
      */
-    public function getIban(): string
+    public function asString(): string
     {
         return $this->iban;
     }

diff --git a/src/Iban/IbanInterface.php b/src/Iban/IbanInterface.php
@@ -11,7 +11,7 @@ interface IbanInterface
      *
      * @return string
      */
-    public function getIban(): string;
+    public function asString(): string;
 
     /**
      * Returns the validator that checks whether the IBAN is valid.

diff --git a/src/Iban/Validator/GenericIbanValidator.php b/src/Iban/Validator/GenericIbanValidator.php
@@ -19,7 +19,7 @@ public function __construct(IbanInterface $iban)
 
     public function isValid(): bool
     {
-        $stringIban = strtoupper($this->iban->getIban());
+        $stringIban = strtoupper($this->iban->asString());
 
         $country = substr($stringIban, 0, 2);
         $checksum = substr($stringIban, 2, 2);

diff --git a/src/QrPayment.php b/src/QrPayment.php
@@ -320,7 +320,7 @@ public function getQrString(): string
         $result[] = 'SCT'; // identification
         $result[] = $this->getBic();
         $result[] = $this->getBeneficiaryName();
-        $result[] = $this->getIban()->getIban();
+        $result[] = $this->getIban()->asString();
         $result[] = $this->getAmount() ? $this->getCurrency() . $this->getAmount() : '';
         $result[] = $this->getPurpose();
         $result[] = $this->getRemittanceText();

diff --git a/tests/CzechIbanAdapterTest.php b/tests/CzechIbanAdapterTest.php
@@ -35,7 +35,7 @@ public function testAccountsWithoutPrefix()
 
         foreach ($accounts as $iban => $accountData) {
             $iban = str_replace(" ", "", $iban);
-            $this->assertEquals($iban, $this->getIban($accountData["acc"], $accountData["bank"])->getIban());
+            $this->assertEquals($iban, $this->getIban($accountData["acc"], $accountData["bank"])->asString());
             $this->assertEquals($iban, strval($this->getIban($accountData["acc"], $accountData["bank"])));
         }
     }
@@ -57,7 +57,7 @@ public function testAccountsWithPrefix()
 
         foreach ($accounts as $iban => $accountData) {
             $iban = str_replace(" ", "", $iban);
-            $this->assertEquals($iban, $this->getIban($accountData["acc"], $accountData["bank"], $accountData["prefix"])->getIban());
+            $this->assertEquals($iban, $this->getIban($accountData["acc"], $accountData["bank"], $accountData["prefix"])->asString());
             $this->assertEquals($iban, strval($this->getIban($accountData["acc"], $accountData["bank"], $accountData["prefix"])));
         }
     }

diff --git a/tests/IBANTest.php b/tests/IBANTest.php
@@ -17,7 +17,7 @@ class IBANTest extends TestCase
     public function testGetIban()
     {
         $iban = new IBAN($this->getIbanString());
-        $this->assertEquals($this->getIbanString(), $iban->getIban());
+        $this->assertEquals($this->getIbanString(), $iban->asString());
     }
 
     public function testToString()

diff --git a/tests/QrPaymentTest.php b/tests/QrPaymentTest.php
@@ -126,7 +126,7 @@ public function testGetQrStringNoValidator()
 
             use ToStringIban;
 
-            public function getIban(): string
+            public function asString(): string
             {
                 return "123";
             }

diff --git a/tests/ToStringIbanTraitTest.php b/tests/ToStringIbanTraitTest.php
@@ -15,7 +15,7 @@ public function testValid()
 
             use ToStringIban;
 
-            public function getIban(): string
+            public function asString(): string
             {
                 return "testString";
             }