Merge pull request #6 from sdespont/phpstorm-inspection

PHPStorm inspections Thanks for the code cleanups
ch2877 · Dec 16, 2021 · 3ed94d2 · 3ed94d2
2 parents c85bb22 + 0374b1c
commit 3ed94d2
Show file tree

Hide file tree

Showing 47 changed files with 335 additions and 161 deletions.
diff --git a/src/Z38/SwissPayment/AccountInterface.php b/src/Z38/SwissPayment/AccountInterface.php
@@ -18,7 +18,7 @@ interface AccountInterface
     public function format();
 
     /**
-     * Returns a XML representation to identify the account
+     * Returns an XML representation to identify the account
      *
      * @param DOMDocument $doc
      *

diff --git a/src/Z38/SwissPayment/BIC.php b/src/Z38/SwissPayment/BIC.php
@@ -2,12 +2,15 @@
 
 namespace Z38\SwissPayment;
 
+use DOMDocument;
+use InvalidArgumentException;
+
 /**
  * BIC
  */
 class BIC implements FinancialInstitutionInterface
 {
-    const PATTERN = '/^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$/';
+    private const PATTERN = '/^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$/';
 
     /**
      * @var string
@@ -19,12 +22,12 @@ class BIC implements FinancialInstitutionInterface
      *
      * @param string $bic
      *
-     * @throws \InvalidArgumentException When the BIC does contain invalid characters or the length does not match.
+     * @throws InvalidArgumentException When the BIC does contain invalid characters or the length does not match.
      */
     public function __construct($bic)
     {
         if (!preg_match(self::PATTERN, $bic)) {
-            throw new \InvalidArgumentException('BIC is not properly formatted.');
+            throw new InvalidArgumentException('BIC is not properly formatted.');
         }
 
         $this->bic = $bic;
@@ -43,7 +46,7 @@ public function format()
     /**
      * {@inheritdoc}
      */
-    public function asDom(\DOMDocument $doc)
+    public function asDom(DOMDocument $doc)
     {
         $xml = $doc->createElement('FinInstnId');
         $xml->appendChild($doc->createElement('BIC', $this->format()));

diff --git a/src/Z38/SwissPayment/FinancialInstitutionAddress.php b/src/Z38/SwissPayment/FinancialInstitutionAddress.php
@@ -2,6 +2,9 @@
 
 namespace Z38\SwissPayment;
 
+use DOMDocument;
+use InvalidArgumentException;
+
 /**
  * FinancialInstitutionAddress holds information to identify a FI by name and address
  */
@@ -23,7 +26,7 @@ class FinancialInstitutionAddress implements FinancialInstitutionInterface
      * @param string                 $name    Name of the FI
      * @param PostalAddressInterface $address Address of the FI
      *
-     * @throws \InvalidArgumentException When the name is invalid.
+     * @throws InvalidArgumentException When the name is invalid.
      */
     public function __construct($name, PostalAddressInterface $address)
     {
@@ -34,7 +37,7 @@ public function __construct($name, PostalAddressInterface $address)
     /**
      * {@inheritdoc}
      */
-    public function asDom(\DOMDocument $doc)
+    public function asDom(DOMDocument $doc)
     {
         $xml = $doc->createElement('FinInstnId');
         $xml->appendChild(Text::xml($doc, 'Nm', $this->name));

diff --git a/src/Z38/SwissPayment/FinancialInstitutionInterface.php b/src/Z38/SwissPayment/FinancialInstitutionInterface.php
@@ -2,17 +2,20 @@
 
 namespace Z38\SwissPayment;
 
+use DOMDocument;
+use DOMElement;
+
 /**
  * General interface for financial institutions
  */
 interface FinancialInstitutionInterface
 {
     /**
-     * Returns a XML representation to identify the financial institution
+     * Returns an XML representation to identify the financial institution
      *
-     * @param \DOMDocument $doc
+     * @param DOMDocument $doc
      *
-     * @return \DOMElement The built DOM element
+     * @return DOMElement The built DOM element
      */
-    public function asDom(\DOMDocument $doc);
+    public function asDom(DOMDocument $doc);
 }
diff --git a/src/Z38/SwissPayment/IBAN.php b/src/Z38/SwissPayment/IBAN.php
@@ -3,14 +3,14 @@
 namespace Z38\SwissPayment;
 
 use DOMDocument;
+use InvalidArgumentException;
 
 /**
  * IBAN
  */
 class IBAN implements AccountInterface
 {
-    const MAX_LENGTH = 34;
-    const PATTERN = '/^[A-Z]{2,2}[0-9]{2,2}[A-Z0-9]{1,30}$/';
+    private const PATTERN = '/^[A-Z]{2,2}[0-9]{2,2}[A-Z0-9]{1,30}$/';
 
     /**
      * @var string
@@ -22,16 +22,16 @@ class IBAN implements AccountInterface
      *
      * @param string $iban
      *
-     * @throws \InvalidArgumentException When the IBAN does contain invalid characters or the checksum calculation fails.
+     * @throws InvalidArgumentException When the IBAN does contain invalid characters or the checksum calculation fails.
      */
     public function __construct($iban)
     {
         $cleanedIban = str_replace(' ', '', strtoupper($iban));
         if (!preg_match(self::PATTERN, $cleanedIban)) {
-            throw new \InvalidArgumentException('IBAN is not properly formatted.');
+            throw new InvalidArgumentException('IBAN is not properly formatted.');
         }
         if (!self::check($cleanedIban)) {
-            throw new \InvalidArgumentException('IBAN has an invalid checksum.');
+            throw new InvalidArgumentException('IBAN has an invalid checksum.');
         }
 
         $this->iban = $cleanedIban;

diff --git a/src/Z38/SwissPayment/IID.php b/src/Z38/SwissPayment/IID.php
@@ -20,7 +20,7 @@ class IID implements FinancialInstitutionInterface
      *
      * @param string $iid
      *
-     * @throws \InvalidArgumentException When the IID does contain invalid characters or the length does not match.
+     * @throws InvalidArgumentException When the IID does contain invalid characters or the length does not match.
      */
     public function __construct($iid)
     {
@@ -37,7 +37,7 @@ public function __construct($iid)
      *
      * @param IBAN $iban
      *
-     * @throws \InvalidArgumentException When the supplied IBAN is not from a supported country.
+     * @return IID
      */
     public static function fromIBAN(IBAN $iban)
     {

diff --git a/src/Z38/SwissPayment/ISRParticipant.php b/src/Z38/SwissPayment/ISRParticipant.php
@@ -20,7 +20,7 @@ class ISRParticipant implements AccountInterface
      *
      * @param string $number
      *
-     * @throws \InvalidArgumentException When the participation number is not valid.
+     * @throws InvalidArgumentException When the participation number is not valid.
      */
     public function __construct($number)
     {

diff --git a/src/Z38/SwissPayment/Message/AbstractMessage.php b/src/Z38/SwissPayment/Message/AbstractMessage.php
@@ -2,6 +2,8 @@
 
 namespace Z38\SwissPayment\Message;
 
+use DOMDocument;
+use DOMElement;
 use Z38\SwissPayment\Text;
 
 /**
@@ -12,11 +14,11 @@ abstract class AbstractMessage implements MessageInterface
     /**
      * Builds the DOM of the actual message
      *
-     * @param \DOMDocument $doc
+     * @param DOMDocument $doc
      *
-     * @return \DOMElement
+     * @return DOMElement
      */
-    abstract protected function buildDom(\DOMDocument $doc);
+    abstract protected function buildDom(DOMDocument $doc);
 
     /**
      * Gets the name of the schema
@@ -35,14 +37,14 @@ abstract protected function getSchemaLocation();
     /**
      * Builds a DOM document of the message
      *
-     * @return \DOMDocument
+     * @return DOMDocument
      */
     public function asDom()
     {
         $schema = $this->getSchemaName();
         $location = $this->getSchemaLocation();
 
-        $doc = new \DOMDocument('1.0', 'UTF-8');
+        $doc = new DOMDocument('1.0', 'UTF-8');
         $root = $doc->createElement('Document');
         $root->setAttribute('xmlns', $schema);
         if ($location !== null) {
@@ -86,11 +88,11 @@ public function getSoftwareVersion()
     /**
      * Creates a DOM element which contains details about the software used to create the message
      *
-     * @param \DOMDocument $doc
+     * @param DOMDocument $doc
      *
-     * @return \DOMElement
+     * @return DOMElement
      */
-    protected function buildContactDetails(\DOMDocument $doc)
+    protected function buildContactDetails(DOMDocument $doc)
     {
         $root = $doc->createElement('CtctDtls');
 

diff --git a/src/Z38/SwissPayment/Message/CustomerCreditTransfer.php b/src/Z38/SwissPayment/Message/CustomerCreditTransfer.php
@@ -2,6 +2,9 @@
 
 namespace Z38\SwissPayment\Message;
 
+use DateTime;
+use DOMDocument;
+use InvalidArgumentException;
 use Z38\SwissPayment\Money;
 use Z38\SwissPayment\PaymentInformation\PaymentInformation;
 use Z38\SwissPayment\Text;
@@ -27,7 +30,7 @@ class CustomerCreditTransfer extends AbstractMessage
     protected $payments;
 
     /**
-     * @var \DateTime
+     * @var DateTime
      */
     protected $creationTime;
 
@@ -37,24 +40,24 @@ class CustomerCreditTransfer extends AbstractMessage
      * @param string $id              Identifier of the message (should usually be unique over a period of at least 90 days)
      * @param string $initiatingParty Name of the initiating party
      *
-     * @throws \InvalidArgumentException When any of the inputs contain invalid characters or are too long.
+     * @throws InvalidArgumentException When any of the inputs contain invalid characters or are too long.
      */
     public function __construct($id, $initiatingParty)
     {
         $this->id = Text::assertIdentifier($id);
         $this->initiatingParty = Text::assert($initiatingParty, 70);
         $this->payments = [];
-        $this->creationTime = new \DateTime();
+        $this->creationTime = new DateTime();
     }
 
     /**
      * Manually sets the creation time
      *
-     * @param \DateTime $creationTime The desired creation time
+     * @param DateTime $creationTime The desired creation time
      *
      * @return CustomerCreditTransfer This message
      */
-    public function setCreationTime(\DateTime $creationTime)
+    public function setCreationTime(DateTime $creationTime)
     {
         $this->creationTime = $creationTime;
 
@@ -104,7 +107,7 @@ protected function getSchemaLocation()
     /**
      * {@inheritdoc}
      */
-    protected function buildDom(\DOMDocument $doc)
+    protected function buildDom(DOMDocument $doc)
     {
         $transactionCount = 0;
         $transactionSum = new Money\MixedMoney(0);

diff --git a/src/Z38/SwissPayment/Message/MessageInterface.php b/src/Z38/SwissPayment/Message/MessageInterface.php
@@ -8,7 +8,7 @@
 interface MessageInterface
 {
     /**
-     * Returns a XML representation of the message
+     * Returns an XML representation of the message
      *
      * @return string The XML source
      */

diff --git a/src/Z38/SwissPayment/Money/MixedMoney.php b/src/Z38/SwissPayment/Money/MixedMoney.php
@@ -41,7 +41,7 @@ final protected function getDecimals()
     }
 
     /**
-     * Returns the sum of this and an other amount of money
+     * Returns the sum of this and another amount of money
      *
      * @param Money $addend The addend
      *
@@ -55,7 +55,7 @@ public function plus(Money $addend)
     }
 
     /**
-     * Returns the subtraction of this and an other amount of money
+     * Returns the subtraction of this and another amount of money
      *
      * @param Money $subtrahend The subtrahend
      *

diff --git a/src/Z38/SwissPayment/Money/Money.php b/src/Z38/SwissPayment/Money/Money.php
@@ -2,6 +2,8 @@
 
 namespace Z38\SwissPayment\Money;
 
+use InvalidArgumentException;
+
 /**
  * Base class for all currencies
  */
@@ -66,54 +68,54 @@ public function getAmount()
     }
 
     /**
-     * Returns the sum of this and an other amount of money
+     * Returns the sum of this and another amount of money
      *
      * @param Money $addend The addend
      *
      * @return Money The sum
      *
-     * @throws \InvalidArgumentException When the currencies do not match
+     * @throws InvalidArgumentException When the currencies do not match
      */
     public function plus(self $addend)
     {
         if ($this->getCurrency() !== $addend->getCurrency()) {
-            throw new \InvalidArgumentException('Can not add different currencies');
+            throw new InvalidArgumentException('Can not add different currencies');
         }
 
         return new static($this->cents + $addend->getAmount());
     }
 
     /**
-     * Returns the subtraction of this and an other amount of money
+     * Returns the subtraction of this and another amount of money
      *
      * @param Money $subtrahend The subtrahend
      *
      * @return Money The difference
      *
-     * @throws \InvalidArgumentException When the currencies do not match
+     * @throws InvalidArgumentException When the currencies do not match
      */
     public function minus(self $subtrahend)
     {
         if ($this->getCurrency() !== $subtrahend->getCurrency()) {
-            throw new \InvalidArgumentException('Can not subtract different currencies');
+            throw new InvalidArgumentException('Can not subtract different currencies');
         }
 
         return new static($this->cents - $subtrahend->getAmount());
     }
 
     /**
-     * Compares this instance with an other instance.
+     * Compares this instance with another instance.
      *
      * @param Money $b The instance to which this instance is to be compared.
      *
      * @return int -1, 0 or 1 as this instance is less than, equal to, or greater than $b
      *
-     * @throws \InvalidArgumentException When the currencies do not match
+     * @throws InvalidArgumentException When the currencies do not match
      */
     public function compareTo(self $b)
     {
         if ($this->getCurrency() !== $b->getCurrency()) {
-            throw new \InvalidArgumentException('Can not compare different currencies');
+            throw new InvalidArgumentException('Can not compare different currencies');
         }
 
         if ($this->getAmount() < $b->getAmount()) {