Merge pull request #15 from veewee/upgrade/veewee-xml-v4

veewee · web-flow · commit 951fd6710a23 · 2026-03-27T08:35:00.000+01:00
Upgrade to veewee/xml v4 with PHP 8.4+ minimum
diff --git a/.github/workflows/analyzers.yaml b/.github/workflows/analyzers.yaml
@@ -7,7 +7,7 @@ jobs:
         strategy:
             matrix:
                 operating-system: [ubuntu-latest]
-                php-versions: ['8.3', '8.4', '8.5']
+                php-versions: ['8.4', '8.5']
                 composer-options: ['--ignore-platform-req=php+']
             fail-fast: false
         name: PHP ${{ matrix.php-versions }} @ ${{ matrix.operating-system }}
diff --git a/.github/workflows/code-style.yaml b/.github/workflows/code-style.yaml
@@ -7,7 +7,7 @@ jobs:
         strategy:
             matrix:
                 operating-system: [ubuntu-latest]
-                php-versions: ['8.3', '8.4', '8.5']
+                php-versions: ['8.4', '8.5']
                 composer-options: ['--ignore-platform-req=php+']
             fail-fast: false
         name: PHP ${{ matrix.php-versions }} @ ${{ matrix.operating-system }}
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -7,7 +7,7 @@ jobs:
         strategy:
             matrix:
                 operating-system: [ubuntu-latest]
-                php-versions: ['8.3', '8.4', '8.5']
+                php-versions: ['8.4', '8.5']
                 composer-options: ['--ignore-platform-req=php+']
             fail-fast: false
         name: PHP ${{ matrix.php-versions }} @ ${{ matrix.operating-system }}
diff --git a/composer.json b/composer.json
@@ -20,9 +20,11 @@
         }
     ],
     "require": {
-        "php": "~8.3.0 || ~8.4.0 || ~8.5.0",
+        "php": "~8.4.0 || ~8.5.0",
         "ext-dom": "*",
-        "veewee/xml": "^3.4"
+        "php-standard-library/dict": "^6.1",
+        "php-standard-library/foundation": "^6.1",
+        "veewee/xml": "^4.8"
     },
     "require-dev": {
         "phpunit/phpunit": "~12.3",
diff --git a/psalm.xml b/psalm.xml
@@ -3,7 +3,7 @@
     errorLevel="1"
     resolveFromConfigFile="true"
     strictBinaryOperands="true"
-    phpVersion="8.0"
+    phpVersion="8.4"
     allowStringToStandInForClass="true"
     rememberPropertyAssignmentsAfterCall="false"
     skipChecksOnUnresolvableIncludes="false"
@@ -22,6 +22,9 @@
             <directory name="tests" />
         </ignoreFiles>
     </projectFiles>
+    <stubs>
+        <file name="vendor/veewee/xml/stubs/DOM.phpstub" />
+    </stubs>
     <ignoreExceptions>
         <class name="InvalidArgumentException" />
     </ignoreExceptions>
diff --git a/src/Builder/Header/Actor.php b/src/Builder/Header/Actor.php
@@ -3,7 +3,7 @@
 
 namespace Soap\Xml\Builder\Header;
 
-use DOMNode;
+use Dom\Node;
 use VeeWee\Xml\Dom\Builder\Builder;
 use VeeWee\Xml\Exception\RuntimeException;
 use function VeeWee\Xml\Dom\Builder\namespaced_attribute;
@@ -26,7 +26,7 @@ public static function next(): self
     /**
      * @psalm-suppress MissingThrowsDocblock
      */
-    public function __invoke(DOMNode $node): DOMNode
+    public function __invoke(Node $node): Node
     {
         $document = detect_document($node);
         $namespace = root_namespace_uri()($document) ?? '';
diff --git a/src/Builder/Header/MustUnderstand.php b/src/Builder/Header/MustUnderstand.php
@@ -3,7 +3,7 @@
 
 namespace Soap\Xml\Builder\Header;
 
-use DOMNode;
+use Dom\Node;
 use VeeWee\Xml\Dom\Builder\Builder;
 use VeeWee\Xml\Exception\RuntimeException;
 use function VeeWee\Xml\Dom\Builder\namespaced_attribute;
@@ -16,7 +16,7 @@ final class MustUnderstand implements Builder
     /**
      * @psalm-suppress MissingThrowsDocblock
      */
-    public function __invoke(DOMNode $node): DOMNode
+    public function __invoke(Node $node): Node
     {
         $document = detect_document($node);
         $namespace = root_namespace_uri()($document) ?? '';
diff --git a/src/Builder/SoapHeader.php b/src/Builder/SoapHeader.php
@@ -3,22 +3,22 @@
 
 namespace Soap\Xml\Builder;
 
-use DOMElement;
-use DOMNode;
+use Dom\Element;
+use Dom\Node;
 use VeeWee\Xml\Dom\Builder\Builder;
 use function VeeWee\Xml\Dom\Builder\children;
 use function VeeWee\Xml\Dom\Builder\namespaced_element;
 
 final class SoapHeader implements Builder
 {
     /**
-     * @var list<callable(DOMNode): DOMElement>
+     * @var list<callable(Node): Element>
      */
     private array $configurators;
 
     /**
      * @no-named-arguments
-     * @param list<callable(DOMNode): DOMElement> $configurators
+     * @param list<callable(Node): Element> $configurators
      */
     public function __construct(
         private string $namespace,
@@ -31,7 +31,7 @@ public function __construct(
     /**
      * @psalm-suppress MissingThrowsDocblock
      */
-    public function __invoke(DOMNode $node): DOMNode
+    public function __invoke(Node $node): Node
     {
         return children(
             namespaced_element(
diff --git a/src/Builder/SoapHeaders.php b/src/Builder/SoapHeaders.php
@@ -2,8 +2,8 @@
 
 namespace Soap\Xml\Builder;
 
-use DOMElement;
-use DOMNode;
+use Dom\Element;
+use Dom\Node;
 use VeeWee\Xml\Dom\Builder\Builder;
 use function VeeWee\Xml\Dom\Builder\namespaced_element;
 use function VeeWee\Xml\Dom\Locator\Node\detect_document;
@@ -12,13 +12,13 @@
 final class SoapHeaders implements Builder
 {
     /**
-     * @var list<callable(DOMNode): DOMElement>
+     * @var list<callable(Node): Element>
      */
     private array $configurators;
 
     /**
      * @no-named-arguments
-     * @param list<callable(DOMNode): DOMElement> $configurators
+     * @param list<callable(Node): Element> $configurators
      */
     public function __construct(callable ... $configurators)
     {
@@ -28,7 +28,7 @@ public function __construct(callable ... $configurators)
     /**
      * @psalm-suppress MissingThrowsDocblock
      */
-    public function __invoke(DOMNode $node): DOMNode
+    public function __invoke(Node $node): Node
     {
         $document = detect_document($node);
 
diff --git a/src/Locator/BodyNamespaceLocator.php b/src/Locator/BodyNamespaceLocator.php
@@ -4,19 +4,15 @@
 
 namespace Soap\Xml\Locator;
 
-use DOMDocument;
+use Dom\XMLDocument;
 use VeeWee\Xml\Exception\RuntimeException;
 
 final class BodyNamespaceLocator
 {
     /**
-     * @psalm-suppress UndefinedPropertyFetch - psalm gets lost
-     * @psalm-suppress MixedReturnStatement - psalm gets lost
-     * @psalm-suppress MixedPropertyFetch - psalm gets lost
-     * @psalm-suppress MixedInferredReturnType - psalm gets lost
      * @throws RuntimeException
      */
-    public function __invoke(DOMDocument $document): ?string
+    public function __invoke(XMLDocument $document): ?string
     {
         return (new SoapBodyLocator())($document)?->firstElementChild?->namespaceURI;
     }
diff --git a/src/Locator/SoapBodyLocator.php b/src/Locator/SoapBodyLocator.php
@@ -4,8 +4,8 @@
 
 namespace Soap\Xml\Locator;
 
-use DOMDocument;
-use DOMElement;
+use Dom\Element;
+use Dom\XMLDocument;
 use VeeWee\Xml\Dom\Document;
 use VeeWee\Xml\Exception\RuntimeException;
 use function VeeWee\Xml\Dom\Locator\root_namespace_uri;
@@ -16,11 +16,11 @@ final class SoapBodyLocator
     /**
      * @throws RuntimeException
      */
-    public function __invoke(DOMDocument $document): ?DOMElement
+    public function __invoke(XMLDocument $document): ?Element
     {
         $soapNs = root_namespace_uri()($document) ?? '';
         $xpath = Document::fromUnsafeDocument($document)->xpath(namespaces(['soap' => $soapNs]));
 
-        return $xpath->query('//soap:Envelope/soap:Body')->expectAllOfType(DOMElement::class)->first();
+        return $xpath->query('//soap:Envelope/soap:Body')->expectAllOfType(Element::class)->first();
     }
 }
diff --git a/src/Locator/SoapEnvelopeLocator.php b/src/Locator/SoapEnvelopeLocator.php
@@ -4,13 +4,14 @@
 
 namespace Soap\Xml\Locator;
 
-use DOMDocument;
-use DOMElement;
+use Dom\Element;
+use Dom\XMLDocument;
+use function VeeWee\Xml\Dom\Locator\document_element;
 
 final class SoapEnvelopeLocator
 {
-    public function __invoke(DOMDocument $document): DOMElement
+    public function __invoke(XMLDocument $document): Element
     {
-        return $document->documentElement;
+        return document_element()($document);
     }
 }
diff --git a/src/Locator/SoapHeaderLocator.php b/src/Locator/SoapHeaderLocator.php
@@ -4,8 +4,8 @@
 
 namespace Soap\Xml\Locator;
 
-use DOMDocument;
-use DOMElement;
+use Dom\Element;
+use Dom\XMLDocument;
 use VeeWee\Xml\Dom\Document;
 use VeeWee\Xml\Exception\RuntimeException;
 use function VeeWee\Xml\Dom\Locator\root_namespace_uri;
@@ -16,11 +16,11 @@ final class SoapHeaderLocator
     /**
      * @throws RuntimeException
      */
-    public function __invoke(DOMDocument $document): ?DOMElement
+    public function __invoke(XMLDocument $document): ?Element
     {
         $soapNs = root_namespace_uri()($document) ?? '';
         $xpath = Document::fromUnsafeDocument($document)->xpath(namespaces(['soap' => $soapNs]));
 
-        return $xpath->query('//soap:Envelope/soap:Header')->expectAllOfType(DOMElement::class)->first();
+        return $xpath->query('//soap:Envelope/soap:Header')->expectAllOfType(Element::class)->first();
     }
 }
diff --git a/src/Manipulator/PrependSoapHeaders.php b/src/Manipulator/PrependSoapHeaders.php
@@ -4,23 +4,23 @@
 
 namespace Soap\Xml\Manipulator;
 
-use DOMDocument;
-use DOMElement;
+use Dom\Element;
+use Dom\XMLDocument;
 use Soap\Xml\Locator\SoapEnvelopeLocator;
 use VeeWee\Xml\Dom\Document;
 use VeeWee\Xml\Exception\RuntimeException;
 
 final class PrependSoapHeaders
 {
     /**
-     * @var list<DOMElement>
+     * @var list<Element>
      */
     private array $soapHeaders;
 
     /**
      * @no-named-arguments
      */
-    public function __construct(DOMElement ... $soapHeaders)
+    public function __construct(Element ... $soapHeaders)
     {
         $this->soapHeaders = $soapHeaders;
     }
@@ -30,7 +30,7 @@ public function __construct(DOMElement ... $soapHeaders)
      * @psalm-suppress LessSpecificReturnStatement
      * @psalm-suppress MoreSpecificReturnType
      */
-    public function __invoke(DOMDocument $document): DOMElement
+    public function __invoke(XMLDocument $document): Element
     {
         $doc = Document::fromUnsafeDocument($document);
         $envelope = $doc->locate(new SoapEnvelopeLocator());
diff --git a/src/Xpath/EnvelopePreset.php b/src/Xpath/EnvelopePreset.php
@@ -4,7 +4,7 @@
 
 namespace Soap\Xml\Xpath;
 
-use DOMXPath;
+use Dom\XPath;
 use Soap\Xml\Locator\BodyNamespaceLocator;
 use VeeWee\Xml\Dom\Document;
 use VeeWee\Xml\Dom\Xpath\Configurator\Configurator;
@@ -24,7 +24,7 @@ public function __construct(Document $document)
     /**
      * @throws RuntimeException
      */
-    public function __invoke(DOMXPath $xpath): DOMXPath
+    public function __invoke(XPath $xpath): XPath
     {
         return namespaces(array_filter([
             'soap' => $this->document->locate(root_namespace_uri()),
diff --git a/src/Xpath/WsdlPreset.php b/src/Xpath/WsdlPreset.php
@@ -4,7 +4,7 @@
 
 namespace Soap\Xml\Xpath;
 
-use DOMXPath;
+use Dom\XPath;
 use Soap\Xml\Xmlns;
 use VeeWee\Xml\Dom\Document;
 use VeeWee\Xml\Dom\Xpath\Configurator\Configurator;
@@ -22,7 +22,7 @@ public function __construct(Document $document)
         $this->document = $document;
     }
 
-    public function __invoke(DOMXPath $xpath): DOMXPath
+    public function __invoke(XPath $xpath): XPath
     {
         $tns = $this->document->map(document_element())->getAttribute('targetNamespace');
 
@@ -34,7 +34,7 @@ public function __invoke(DOMXPath $xpath): DOMXPath
                     'soap12' => Xmlns::soap12()->value(),
                     'wsdl' => Xmlns::wsdl()->value(),
                 ],
-                $tns ? ['tns' => $tns] : []
+                $tns !== null ? ['tns' => $tns] : []
             )
         ))($xpath);
     }
diff --git a/tests/Unit/Builder/SoapHeaderTest.php b/tests/Unit/Builder/SoapHeaderTest.php
@@ -13,7 +13,6 @@
 use function VeeWee\Xml\Dom\Builder\children;
 use function VeeWee\Xml\Dom\Builder\namespaced_element;
 use function VeeWee\Xml\Dom\Builder\value;
-use function VeeWee\Xml\Dom\Configurator\comparable;
 
 final class SoapHeaderTest extends TestCase
 {
@@ -47,13 +46,9 @@ public function test_it_can_create_a_header_element(): void
                 <Acting xmlns="https://foo.bar" soap:actor="http://schemas.xmlsoap.org/soap/actor/next" />
                 <Understanding xmlns="https://foo.bar" soap:mustUnderstand="1" />
             </soap:Header>
-        </soap:Envelope>        
+        </soap:Envelope>
         EOXML;
 
-
-        static::assertXmlStringEqualsXmlString(
-            Document::fromXmlString($expected, comparable())->toXmlString(),
-            Document::fromUnsafeDocument($doc->toUnsafeDocument(), comparable())->toXmlString()
-        );
+        static::assertXmlStringEqualsXmlString($expected, $doc->toXmlString());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -4,19 +4,15 @@`
`4`	`4`
`5`	`5`	`namespace Soap\Xml\Locator;`
`6`	`6`
`7`		`-use DOMDocument;`
	`7`	`+use Dom\XMLDocument;`
`8`	`8`	`use VeeWee\Xml\Exception\RuntimeException;`
`9`	`9`
`10`	`10`	`final class BodyNamespaceLocator`
`11`	`11`	`{`
`12`	`12`	`/**`
`13`		`- * @psalm-suppress UndefinedPropertyFetch - psalm gets lost`
`14`		`- * @psalm-suppress MixedReturnStatement - psalm gets lost`
`15`		`- * @psalm-suppress MixedPropertyFetch - psalm gets lost`
`16`		`- * @psalm-suppress MixedInferredReturnType - psalm gets lost`
`17`	`13`	`* @throws RuntimeException`
`18`	`14`	`*/`
`19`		`- public function __invoke(DOMDocument $document): ?string`
	`15`	`+ public function __invoke(XMLDocument $document): ?string`
`20`	`16`	`{`
`21`	`17`	`return (new SoapBodyLocator())($document)?->firstElementChild?->namespaceURI;`
`22`	`18`	`}`