Reach phpstan level 8

Author: Naktibalda

src/Util/Xml.php

@@ -12,9 +12,15 @@
 
 class Xml
 {
+    /**
+     * @param array<mixed> $array
+     */
     public static function arrayToXml(DOMDocument $xml, DOMNode $domNode, array $array = []): DOMDocument
     {
         foreach ($array as $el => $val) {
+            /**
+             * @var string|array< $val
+             */
             if (is_array($val)) {
                 self::arrayToXml($xml, $domNode->$el, $val);
             } else {
@@ -24,7 +30,10 @@ public static function arrayToXml(DOMDocument $xml, DOMNode $domNode, array $arr
         return $xml;
     }
 
-    public static function toXml(DOMDocument|DOMElement|XmlBuilder|string|null $xml): DOMDocument
+    /**
+     * @param array<DOMNode|XmlBuilder|array<mixed>|string|null> $xml
+     */
+    public static function toXml(DOMNode|XmlBuilder|array|string|null $xml): DOMDocument
     {
         if ($xml instanceof XmlBuilder) {
             return $xml->getDom();

src/Util/XmlBuilder.php

@@ -6,6 +6,7 @@
 
 use DOMDocument;
 use DOMElement;
+use DOMNode;
 use Exception;
 
 /**
@@ -74,7 +75,7 @@ class XmlBuilder
 {
     protected DOMDocument $dom;
 
-    protected DOMElement|DOMDocument $currentNode;
+    protected DOMNode $currentNode;
 
     public function __construct()
     {
@@ -93,7 +94,7 @@ public function __get(string $tag): XmlBuilder
         return $this;
     }
 
-    public function val($val): self
+    public function val(string $val): self
     {
         $this->currentNode->nodeValue = $val;
         return $this;
@@ -104,6 +105,9 @@ public function val($val): self
      */
     public function attr(string $attr, string $val): self
     {
+        if (!$this->currentNode instanceof DOMElement) {
+            throw new Exception('Current node is not DOMElement');
+        }
         $this->currentNode->setAttribute($attr, $val);
         return $this;
     }
@@ -113,38 +117,46 @@ public function attr(string $attr, string $val): self
      */
     public function parent(): self
     {
+        if ($this->currentNode->parentNode === null) {
+            throw new Exception('Element has no parent');
+        }
         $this->currentNode = $this->currentNode->parentNode;
         return $this;
     }
 
     /**
-     * Traverses to parent with $name
+     * Traverses to parent with $tagName
      *
      * @throws Exception
      */
-    public function parents(string $tag): self
+    public function parents(string $tagName): self
     {
         $traverseNode = $this->currentNode;
         $elFound = false;
         while ($traverseNode->parentNode) {
             $traverseNode = $traverseNode->parentNode;
-            if ($traverseNode->tagName === $tag) {
+            if ($traverseNode instanceof DOMElement && $traverseNode->tagName === $tagName) {
                 $this->currentNode = $traverseNode;
                 $elFound = true;
                 break;
             }
         }
 
         if (!$elFound) {
-            throw new Exception("Parent {$tag} not found in XML");
+            throw new Exception("Parent {$tagName} not found in XML");
         }
 
         return $this;
     }
 
     public function __toString(): string
     {
-        return $this->dom->saveXML();
+        $string = $this->dom->saveXML();
+        if ($string === false) {
+            throw new Exception('Failed to convert DOM to string');
+        }
+
+        return $string;
     }
 
     public function getDom(): DOMDocument

src/Util/XmlStructure.php

@@ -14,8 +14,11 @@
 
 class XmlStructure
 {
-    protected DOMDocument|DOMNode $xml;
+    protected DOMDocument $xml;
 
+    /**
+     * @param array<DOMNode|XmlBuilder|array<mixed>|string|null> $xml
+     */
     public function __construct($xml)
     {
         $this->xml = SoapXmlUtil::toXml($xml);
@@ -36,37 +39,54 @@ public function matchElement(string $cssOrXPath): ?DOMNode
         $domXpath = new DOMXpath($this->xml);
         $selector = (new CssSelectorConverter())->toXPath($cssOrXPath);
         $els = $domXpath->query($selector);
-        if ($els) {
+        if ($els !== false && count($els) > 0) {
             return $els->item(0);
         }
         $els = $domXpath->query($cssOrXPath);
-        if ($els->length !== 0) {
+        if ($els !== false && count($els) > 0) {
             return $els->item(0);
         }
         throw new ElementNotFound($cssOrXPath);
     }
 
+    /**
+     * @param array<DOMNode|XmlBuilder|array<mixed>|string|null> $xml
+     */
     public function matchXmlStructure($xml): bool
     {
         $xml = SoapXmlUtil::toXml($xml);
         $root = $xml->firstChild;
+        if ($root === null) {
+            throw new \Exception('XML is empty');
+        }
         $els = $this->xml->getElementsByTagName($root->nodeName);
-        if (empty($els)) {
+        if (count($els) === 0) {
             throw new ElementNotFound($root->nodeName, 'Element');
         }
 
-        $matches = false;
         foreach ($els as $node) {
-            $matches |= $this->matchForNode($root, $node);
+            /**
+             * @var DOMNode $node
+             */
+            if ($this->matchForNode($root, $node)) {
+                return true;
+            }
         }
-        return $matches;
+
+        return false;
     }
 
-    protected function matchForNode($schema, $xml): bool
+    protected function matchForNode(DOMNode $schema, DOMNode $xml): bool
     {
         foreach ($schema->childNodes as $node1) {
+            /**
+             * @var DOMNode $node1
+             */
             $matched = false;
             foreach ($xml->childNodes as $node2) {
+                /**
+                 * @var DOMNode $node2
+                 */
                 if ($node1->nodeName == $node2->nodeName) {
                     $matched = $this->matchForNode($node1, $node2);
                     if ($matched) {