v2.5.0

globalcitizen · Feb 26, 2016 · 045f39b · 045f39b
1 parent 7d916cf
commit 045f39b
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -140,7 +140,7 @@ Then just add the following to your `composer.json` file:
 // composer.json
 {
     "require": {
-        "globalcitizen/php-iban": "2.4.20"
+        "globalcitizen/php-iban": "2.5.0"
     }
 }
 ```
@@ -236,7 +236,7 @@ The following table compares __php-iban__ to other PHP projects offering IBAN-re
 
 | Project                                                    | Lic. | Proc | OO  | Began  | Latest | Star | Watch | Fork | Installs | Home culture | Deps    |
 | ---------------------------------------------------------- | ---- | ---- | --- | ------ | ------ | ---- | ----- | ---- | -------- | ------------ | ------- |
-| __php-iban__                                               | LGPL | ✔    | ✔   | 2009   | 2.4.20 | 27   | 11    | 13   | 10k+*    | Global*      | *none*  |
+| __php-iban__                                               | LGPL | ✔    | ✔   | 2009   | 2.5.0  | 27   | 11    | 13   | 10k+*    | Global*      | *none*  |
 | [Iban](https://github.com/jschaedl/Iban)                   | MIT  | ✘    | ✔   | 2013   | 1.1.6  | 38   | 10    | 14   | 52k      | German       | lots    |
 | [IsoCodes](https://github.com/ronanguilloux/IsoCodes)      | GPL3 | ✘    | ✔   | 2012   | 2.0.0  | 241  | 14    | 28   | 36k      | French       | lots    |
 | [SepaUtil's](https://github.com/AbcAeffchen/SepaUtilities) | GPL3 | ✘    | ✔   | 2014   | 1.1.2  | 4    | 3     | 3    | 1.4k     | German       | phpunit |
@@ -293,6 +293,24 @@ Your Help Wanted
 News: February 2016
 -------------------
 
+__[Version 2.5.0](https://github.com/globalcitizen/php-iban/releases/tag/v2.5.0)__ has been released.
+ * All users are encouraged to upgrade; this release is considered long term stable.
+ * The following national checksum schemes added in the 2.4.x series are now included and well validated, while invalid assumptions have been removed:
+  * Beligum (BE)
+  * Spain (ES)
+  * Monaco (MC)
+  * France (FR)
+  * Norway (NO)
+  * Montenegro (ME)
+  * Macedonia (MK)
+  * Netherlands (NL) - including exception for `INGB` (ING Bank) who have dropped the original checksum
+  * Portugal (PT)
+  * Serbia (RS)
+  * Slovenia (SI) - including exception for `01` (Bank of Slovenia) who do not honour checksums
+  * Timor Lest (TL)
+ * In addition, a library of test IBANs is being maintained under `utils/example-ibans` which has a good number of entries for a good number of countries already. This should simplify future research.
+ * Documented ideas (in code) for the enhancement of the mistranscription error correction suggestion function.
+
 __[Version 2.4.20](https://github.com/globalcitizen/php-iban/releases/tag/v2.4.20)__ has been released.
  * Another bugfix release, based on further real world test IBANs from certain countries:
   * Remove Bosnia (BA) national checksum support

diff --git a/php-iban.php b/php-iban.php
@@ -386,6 +386,15 @@ function iban_countries() {
 # Given an incorrect IBAN, return an array of zero or more checksum-valid
 # suggestions for what the user might have meant, based upon common
 # mistranscriptions.
+#  IDEAS:
+#   - length correction via adding/removing leading zeros from any single component
+#   - overlength correction via dropping final digit(s)
+#   - national checksum algorithm checks (apply same testing methodology, abstract to separate function)
+#   - length correction by removing double digits (xxyzabxybaaz = change aa to a, or xx to x)
+#   - validate bank codes
+#   - utilize format knowledge with regards to alphanumeric applicability in that offset in that national BBAN format
+#   - turkish TL/TK thing
+#   - norway NO gets dropped due to mis-identification with "No." for number (ie. if no country code try prepending NO)
 function iban_mistranscription_suggestions($incorrect_iban) {
 
  # remove funky characters