Merge pull request #9 from easybill/pr/code-cleanup-and-refactor

Code cleanups, refactor etc.

composer.json

@@ -15,7 +15,8 @@
   ],
   "require": {
     "php": "^7.2",
-    "jms/serializer": "^3.4"
+    "jms/serializer": "^3.4",
+    "ext-dom": "*"
   },
   "require-dev": {
     "phpunit/phpunit": "^8"

src/Easybill/ZUGFeRD/Builder.php

@@ -3,25 +3,25 @@
 namespace Easybill\ZUGFeRD;
 
 use Easybill\ZUGFeRD\Model\Document;
-use JMS\Serializer\Serializer;
 use JMS\Serializer\SerializerBuilder;
+use JMS\Serializer\SerializerInterface;
 
 class Builder
 {
 
     private $serializer;
 
-    function __construct(Serializer $serializer)
+    public function __construct(SerializerInterface $serializer)
     {
         $this->serializer = $serializer;
     }
 
-    public function getXML(Document $document)
+    public function getXML(Document $document): string
     {
         return $this->serializer->serialize($document, 'xml');
     }
 
-    public static function create()
+    public static function create(): Builder
     {
         $serializer = SerializerBuilder::create()
             ->setDebug(true)

src/Easybill/ZUGFeRD/Helper/UnitCodeHelper.php

@@ -1,22 +1,14 @@
 <?php
 
 namespace Easybill\ZUGFeRD\Helper;
+
 use Easybill\ZUGFeRD\Model\UnitCode;
 
-/**
- * Class UnitCodeHelper
- */
 class UnitCodeHelper
 {
-
-    /**
-     * @param string $rawString
-     *
-     * @return string
-     */
-    public static function getUnitCode($rawString = '')
+    public static function getUnitCode(string $rawString = ''): string
     {
-        switch(strtolower($rawString)) {
+        switch (strtolower($rawString)) {
             case 'box':
             case 'kiste':
                 $unit = UnitCode::BOX;

src/Easybill/ZUGFeRD/Reader.php

@@ -3,29 +3,24 @@
 namespace Easybill\ZUGFeRD;
 
 use Easybill\ZUGFeRD\Model\Document;
-use JMS\Serializer\Serializer;
 use JMS\Serializer\SerializerBuilder;
+use JMS\Serializer\SerializerInterface;
 
 class Reader
 {
     private $serializer;
 
-    function __construct(Serializer $serializer)
+    public function __construct(SerializerInterface $serializer)
     {
         $this->serializer = $serializer;
     }
 
-    /**
-     * @param $xml
-     *
-     * @return mixed|Document
-     */
-    public function getDocument($xml)
+    public function getDocument(string $xml): Document
     {
-        return $this->serializer->deserialize($xml, 'Easybill\ZUGFeRD\Model\Document', 'xml');
+        return $this->serializer->deserialize($xml, Document::class, 'xml');
     }
 
-    public static function create()
+    public static function create(): Reader
     {
         $serializer = SerializerBuilder::create()
             ->setDebug(true)

src/Easybill/ZUGFeRD/SchemaValidator.php

@@ -8,12 +8,8 @@ class SchemaValidator
 
     /**
      * Validates the given XML-string against the ZUGFeRD XSD-files.
-     *
-     * @param string $xml
-     *
-     * @return bool
      */
-    public static function isValid($xml)
+    public static function isValid(string $xml): bool
     {
         $xmlValidate = new \DOMDocument();
         $xmlValidate->loadXML($xml);