[+]: add phpstan

Author: voku

.gitattributes

@@ -6,3 +6,5 @@
 /.gitignore export-ignore
 /.travis.yml export-ignore
 /phpunit.xml export-ignore
+/phpcs.php_cs export-ignore
+/phpstan.neon export-ignore

.travis.yml

@@ -11,19 +11,22 @@ matrix:
     - php: 7.1
     - php: 7.2
     - php: 7.3
+    - php: 7.4
     - php: nightly
 
 before_script:
   - php --version
   - wget https://scrutinizer-ci.com/ocular.phar
   - travis_retry composer self-update
-  - travis_retry composer require satooshi/php-coveralls:1.0.0
+  - travis_retry composer require satooshi/php-coveralls
+  - if [ "$(phpenv version-name)" == 7.3 ]; then travis_retry composer require phpstan/phpstan; fi
   - travis_retry composer install --no-interaction --prefer-source
   - composer dump-autoload -o
 
 script:
   - mkdir -p build/logs
   - php vendor/bin/phpunit -c phpunit.xml --debug
+  - if [ "$(phpenv version-name)" == 7.3 ]; then php vendor/bin/phpstan analyse; fi
 
 after_script:
   - php vendor/bin/coveralls -v

composer.json

@@ -1,7 +1,12 @@
 {
     "name": "sabas/edifact",
     "description": "Tools in PHP for UN/EDIFACT",
-    "keywords": ["EDI", "EDIFACT", "message", "container"],
+    "keywords": [
+        "EDI",
+        "EDIFACT",
+        "message",
+        "container"
+    ],
     "homepage": "https://github.com/php-edifact/edifact",
     "license": "LGPL-3.0-or-later",
     "authors": [
@@ -20,28 +25,28 @@
             "role": "Developer"
         }
     ],
-    "support": {
-        "issues": "https://github.com/php-edifact/edifact/issues"
-    },
-    "repositories": [
-        {
-            "type": "vcs",
-            "url":  "https://github.com/php-edifact/edifact"
-        }
-    ],
     "require": {
         "php": ">=7.0.0",
-        "ext-simplexml": "*",
         "ext-json": "*",
-        "voku/arrayy": "5.*"
+        "ext-simplexml": "*",
+        "voku/arrayy": "~7.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "~6.0",
-        "php-edifact/edifact-mapping": "dev-master"
+        "php-edifact/edifact-mapping": "dev-master",
+        "phpunit/phpunit": "~6.0"
     },
     "autoload": {
         "psr-4": {
             "EDI\\": "src/EDI/"
         }
+    },
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/php-edifact/edifact"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/php-edifact/edifact/issues"
     }
 }

phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+    level: max
+    checkMissingIterableValueType: false
+    paths:
+        - %currentWorkingDirectory%/src/
+    ignoreErrors:

src/EDI/Analyser.php

@@ -11,17 +11,28 @@
 class Analyser
 {
 
+    /**
+     * @var array<mixed>
+     */
     public  $segments;
+
+    /**
+     * @var array<mixed>
+     */
     private $jsonedi;
 
     /**
      * @param string $message_xml_file
      *
-     * @return array
+     * @return array|false
      */
-    public function loadMessageXml(string $message_xml_file): array
+    public function loadMessageXml(string $message_xml_file)
     {
         $messageXmlString = \file_get_contents($message_xml_file);
+        if ($messageXmlString === false) {
+            return false;
+        }
+
         $messageXml = new \SimpleXMLIterator($messageXmlString);
         unset($messageXmlString);
         $message = [
@@ -92,7 +103,7 @@ protected function readXmlNodes(\SimpleXMLElement $element): array
     protected function readAttributesArray(\SimpleXMLElement $element): array
     {
         $attributes = [];
-        foreach ($element->attributes() as $attrName => $attr) {
+        foreach ($element->attributes() ?? [] as $attrName => $attr) {
             $attributes[(string)$attrName] = (string)$attr;
         }
 
@@ -104,23 +115,36 @@ protected function readAttributesArray(\SimpleXMLElement $element): array
      *
      * @param string $codesXml
      *
-     * @return array
+     * @return array|false
      */
-    public function loadCodesXml(string $codesXml): array
+    public function loadCodesXml(string $codesXml)
     {
         $codesXmlString = \file_get_contents($codesXml);
+        if ($codesXmlString === false) {
+            return false;
+        }
+
         $codesXml = new \SimpleXMLIterator($codesXmlString);
         unset($codesXmlString);
         $codes = [];
-        /* @var \SimpleXmlIterator $codeCollection */
         foreach ($codesXml as $codeCollection) {
-            $id = (string)$codeCollection->attributes()->id;
+            \assert($codeCollection instanceof \SimpleXMLIterator);
+
+            $codeCollectionAttributes = $codeCollection->attributes();
+            if ($codeCollectionAttributes === null) {
+                continue;
+            }
+
+            $id = (string)$codeCollectionAttributes->id;
             $codes[$id] = [];
-            /*  @var \SimpleXmlIterator $codeNode */
             foreach ($codeCollection as $codeNode) {
+                \assert($codeNode instanceof \SimpleXMLIterator);
+
                 $codeAttributes = $codeNode->attributes();
-                $code = (string)$codeAttributes->id;
-                $codes[$id][$code] = (string)$codeAttributes->desc;
+                if ($codeAttributes !== null) {
+                    $code = (string)$codeAttributes->id;
+                    $codes[$id][$code] = (string)$codeAttributes->desc;
+                }
             }
         }
 
@@ -133,18 +157,32 @@ public function loadCodesXml(string $codesXml): array
      *
      * @param string $segment_xml_file
      *
-     * @return array
+     * @return array|false
      */
-    public function loadSegmentsXml(string $segment_xml_file): array
+    public function loadSegmentsXml(string $segment_xml_file)
     {
+        // reset
+        $this->segments = [];
+
         $segments_xml = \file_get_contents($segment_xml_file);
+        if ($segments_xml === false) {
+            return false;
+        }
 
         $xml = \simplexml_load_string($segments_xml);
-        unset($segments_xml);
-        $this->segments = [];
+        if ($xml === false) {
+            return false;
+        }
+
+        // free memory
+        $segments_xml = null;
 
-        /* @var \SimpleXMLElement $segmentNode */
         foreach ($xml as $segmentNode) {
+
+            /** @noinspection PhpSillyAssignmentInspection - hack for phpstan */
+            /* @var \SimpleXMLElement $segmentNode */
+            $segmentNode = $segmentNode;
+
             $qualifier = (string)$segmentNode->attributes()->id;
             $segment = [];
             $segment["attributes"] = $this->readAttributesArray($segmentNode);
@@ -265,9 +303,9 @@ public function process(array $data, array $rawSegments = null): string
     /**
      * return the processed EDI in json format
      *
-     * @return string json
+     * @return string|false
      */
-    public function getJson(): string
+    public function getJson()
     {
         return \json_encode($this->jsonedi);
     }

src/EDI/Encoder.php

@@ -172,7 +172,7 @@ private function escapeValue(&$str): string
             $this->symbRel . $this->symbEnd,
         ];
 
-        return \str_replace($search, $replace, $str);
+        return \str_replace($search, $replace, (string)$str);
     }
 
     /**

src/EDI/Interpreter.php

@@ -23,7 +23,7 @@ class Interpreter
     private $xmlSeg;
 
     /**
-     * @var string
+     * @var array
      */
     private $xmlSvc;
 
@@ -48,7 +48,7 @@ class Interpreter
     private $serviceSeg;
 
     /**
-     * @var \Closure
+     * @var callable
      */
     private $comparisonFunction;
 
@@ -90,7 +90,18 @@ class Interpreter
      */
     public function __construct(string $xmlMsg, array $xmlSeg, array $xmlSvc, array $messageTextConf = null)
     {
-        $this->xmlMsg = \simplexml_load_file($xmlMsg);
+        // simplexml_load_file: This can be affected by a PHP bug #62577 (https://bugs.php.net/bug.php?id=62577)
+        $xmlData = \file_get_contents($xmlMsg);
+        if ($xmlData === false) {
+            throw new \InvalidArgumentException('file_get_contents for "' . $xmlMsg . '" faild');
+        }
+
+        $xmlMsgTmp = \simplexml_load_string($xmlData);
+        if ($xmlMsgTmp === false) {
+            throw new \InvalidArgumentException('simplexml_load_string for "' . $xmlMsg . '" faild');
+        }
+
+        $this->xmlMsg = $xmlMsgTmp;
         $this->xmlSeg = $xmlSeg;
         $this->xmlSvc = $xmlSvc;
         if ($messageTextConf !== null) {
@@ -571,7 +582,7 @@ public function getJson(bool $pretty = false)
     /**
      * Get result as Arrayy Object.
      *
-     * @return Arrayy
+     * @return Arrayy<mixed,mixed>
      */
     public function getArrayy()
     {
@@ -627,7 +638,7 @@ public function getJsonServiceSegments(bool $pretty = false)
     /**
      * Get service segments as Arrayy Object.
      *
-     * @return Arrayy
+     * @return Arrayy<mixed,mixed>
      */
     public function getArrayyServiceSegments()
     {