Added Iban value object

Author: benatespina

CHANGELOG.md

@@ -3,8 +3,10 @@
 This changelog references the relevant changes done between versions.
 
 To get the diff for a specific change, go to https://github.com/LIN3S/SharedKernel/commit/XXX where XXX is the change hash 
-To get the diff between two versions, go to https://github.com/LIN3S/SharedKernel/compare/v0.6.0...v0.7.0
+To get the diff between two versions, go to https://github.com/LIN3S/SharedKernel/compare/v0.7.0...v0.8.0
 
+* 0.8.0
+    * Added Iban value object.
 * 0.7.1
     * Added accesses to the primitive value of the TaxIdNumber.
 * 0.7.0

composer.json

@@ -18,7 +18,8 @@
         "keyvanakbary/slugifier": "^4.0",
         "ramsey/uuid": "^3.5",
         "uvinum/zipcodevalidator": "^1.0",
-        "ulabox/nif-validator": "^1.2"
+        "ulabox/nif-validator": "^1.2",
+        "jschaedl/iban": "^1.3"
     },
     "require-dev": {
         "doctrine/orm": "^2.5",

src/LIN3S/SharedKernel/Domain/Model/Iban/Iban.php

@@ -0,0 +1,95 @@
+<?php
+
+/*
+ * This file is part of the Shared Kernel library.
+ *
+ * Copyright (c) 2016-present LIN3S <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace LIN3S\SharedKernel\Domain\Model\Iban;
+
+use IBAN\Core\IBAN as BaseIban;
+use IBAN\Generation\IBANGeneratorES;
+
+/**
+ * @author Beñat Espiña <[email protected]>
+ */
+class Iban
+{
+    /** @var BaseIban */
+    private $iban;
+
+    public static function from(string $iban) : self
+    {
+        return new self($iban);
+    }
+
+    public static function fromSpain(string $instituteIdentification, string $bankAccountNumber) : self
+    {
+        return new self((new IBANGeneratorES())->generate($instituteIdentification, $bankAccountNumber));
+    }
+
+    private function __construct(string $iban)
+    {
+        $this->setIban($iban);
+    }
+
+    private function setIban(string $iban) : void
+    {
+        $iban = new BaseIban($iban);
+        $this->checkIbanIsValid($iban);
+        $this->iban = $iban;
+    }
+
+    private function checkIbanIsValid(BaseIban $iban) : void
+    {
+        if (!$iban->validate()) {
+            throw new IbanInvalidException($iban->format());
+        }
+    }
+
+    public function iban() : string
+    {
+        return $this->iban->format();
+    }
+
+    public function localCode() : string
+    {
+        return (string) $this->iban->getLocaleCode();
+    }
+
+    public function checksum() : string
+    {
+        return (string) $this->iban->getChecksum();
+    }
+
+    public function accountIdentification() : string
+    {
+        return (string) $this->iban->getAccountIdentification();
+    }
+
+    public function instituteIdentification() : string
+    {
+        return (string) $this->iban->getInstituteIdentification();
+    }
+
+    public function bankAccountNumber() : string
+    {
+        return (string) $this->iban->getBankAccountNumber();
+    }
+
+    public function equals(Iban $iban) : bool
+    {
+        return $this->iban() === $iban->iban();
+    }
+
+    public function __toString() : string
+    {
+        return (string) $this->iban();
+    }
+}

src/LIN3S/SharedKernel/Domain/Model/Iban/IbanInvalidException.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the Shared Kernel library.
+ *
+ * Copyright (c) 2016-present LIN3S <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace LIN3S\SharedKernel\Domain\Model\Iban;
+
+use LIN3S\SharedKernel\Exception\DomainException;
+
+/**
+ * @author Beñat Espiña <[email protected]>
+ */
+class IbanInvalidException extends DomainException
+{
+    public function __construct(string $iban)
+    {
+        parent::__construct(sprintf('The given "%s" is not a valid.', $iban));
+    }
+}

src/LIN3S/SharedKernel/Domain/Model/TaxIdNumber/TaxIdNumberInvalidException.php

@@ -13,12 +13,12 @@
 
 namespace LIN3S\SharedKernel\Domain\Model\TaxIdNumber;
 
-use LIN3S\SharedKernel\Exception\Exception;
+use LIN3S\SharedKernel\Exception\DomainException;
 
 /**
  * @author Beñat Espiña <[email protected]>
  */
-class TaxIdNumberInvalidException extends Exception
+class TaxIdNumberInvalidException extends DomainException
 {
     public static function fromSpain(string $tin) : self
     {