Add some doc blocks

ariselseng · Jul 15, 2020 · 3dd7e4b · 3dd7e4b
1 parent 2f3c654
commit 3dd7e4b
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/src/NorwegianBanks.php b/src/NorwegianBanks.php
@@ -102,6 +102,10 @@ private function processData()
         }
     }
 
+    /**
+     * @param string $prefix
+     * @return string|null
+     */
     public function getBankCodeByPrefix(string $prefix)
     {
 
@@ -111,6 +115,10 @@ public function getBankCodeByPrefix(string $prefix)
         return $this->prefixToBankCode[$prefix];
     }
 
+    /**
+     * @param string $account
+     * @return NorwegianBank|null
+     */
     public function getBankByAccountNumber(string $account)
     {
         $prefix = substr($account, 0, 4);
@@ -121,12 +129,22 @@ public function getBankByAccountNumber(string $account)
         return $this->banks[$this->getBankCodeByPrefix($prefix)];
     }
 
+    /**
+     * @param string $unformattedAccount
+     * @param string $delimiter
+     * @return string
+     */
     public function getFormattedAccountNumber(string $unformattedAccount, string $delimiter = '.')
     {
         $onlyDigits = preg_replace('/[^0-9]/', '', $unformattedAccount);
         return substr($onlyDigits, 0, 4) . $delimiter . substr($onlyDigits, 4, 2) . $delimiter . substr($onlyDigits, 6);
     }
 
+    /**
+     * @param string $account
+     * @param bool $validateBankPrefix
+     * @return bool
+     */
     public function validateAccountNumber(string $account, bool $validateBankPrefix = true)
     {
 
@@ -163,11 +181,17 @@ public function validateAccountNumber(string $account, bool $validateBankPrefix
         return !is_null($this->getBankByAccountNumber(substr($onlyDigits, 0, 4)));
     }
 
+    /**
+     * @return string[]
+     */
     public function getAllPrefixes()
     {
         return array_map('strval', array_keys($this->prefixToBankCode));
     }
 
+    /**
+     * @return NorwegianBank[]|null
+     */
     public function getAllBanks()
     {
         return $this->banks;