Migrate DOM-classes to PHP 8.4's new DOM-API

Author: tvdijen

composer.json

@@ -31,9 +31,9 @@
         "psr/http-message": "~2.0",
         "psr/log": "~3.0",
         "simplesamlphp/assert": "~2.0",
-        "simplesamlphp/xml-common": "~2.8",
-        "simplesamlphp/xml-security": "~2.3",
-        "simplesamlphp/xml-soap": "~2.3",
+        "simplesamlphp/xml-common": "dev-feature/dom-migration-php84",
+        "simplesamlphp/xml-security": "dev-feature/dom-migration-php84",
+        "simplesamlphp/xml-soap": "dev-feature/dom-migration-php84",
         "robrichards/xmlseclibs": "^3.1"
     },
     "require-dev": {

src/Binding/SOAP.php

@@ -99,12 +99,12 @@ public function receive(/** @scrutinizer ignore-unused */ServerRequestInterface
         }
 
         $document = DOMDocumentFactory::fromString($postText);
-        /** @var \DOMNode $xml */
+        /** @var \Dom\Node $xml */
         $xml = $document->firstChild;
         Utils::getContainer()->debugMessage($document->documentElement, 'in');
 
         $xpCache = XPath::getXPath($document->documentElement);
-        /** @var \DOMElement[] $results */
+        /** @var \Dom\Element[] $results */
         $results = XPath::xpQuery($xml, '/SOAP-ENV:Envelope/SOAP-ENV:Body/*[1]', $xpCache);
 
         return MessageFactory::fromXML($results[0]);

src/Compat/AbstractContainer.php

@@ -142,7 +142,7 @@ abstract public function getLogger(): LoggerInterface;
      * - **encrypt** XML that is about to be encrypted
      * - **decrypt** XML that was just decrypted
      *
-     * @param \DOMElement|string $message
+     * @param \Dom\Element|string $message
      */
     abstract public function debugMessage($message, string $type): void;
 

src/Compat/MockContainer.php

@@ -45,7 +45,7 @@ public function getLogger(): LoggerInterface
      * - **encrypt** XML that is about to be encrypted
      * - **decrypt** XML that was just decrypted
      *
-     * @param \DOMElement|string $message
+     * @param \Dom\Element|string $message
      */
     public function debugMessage($message, string $type): void
     {

src/Utils/XPath.php

@@ -4,8 +4,7 @@
 
 namespace SimpleSAML\SAML2\Utils;
 
-use DOMNode;
-use DOMXPath;
+use Dom;
 use SimpleSAML\SAML2\Constants as C;
 
 /**
@@ -16,15 +15,15 @@
 class XPath extends \SimpleSAML\XMLSecurity\Utils\XPath
 {
     /**
-     * Get a DOMXPath object that can be used to search for SAML elements.
+     * Get a Dom\XPath object that can be used to search for SAML elements.
      *
-     * @param \DOMNode $node The document to associate to the DOMXPath object.
+     * @param \Dom\Node $node The document to associate to the Dom\XPath object.
      * @param bool $autoregister Whether to auto-register all namespaces used in the document
      *
-     * @return \DOMXPath A DOMXPath object ready to use in the given document, with several
+     * @return \Dom\XPath A Dom\XPath object ready to use in the given document, with several
      *   saml-related namespaces already registered.
      */
-    public static function getXPath(DOMNode $node, bool $autoregister = false): DOMXPath
+    public static function getXPath(Dom\Node $node, bool $autoregister = false): Dom\XPath
     {
         $xp = parent::getXPath($node, $autoregister);
 

src/XML/CanonicalizableElementTrait.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\SAML2\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\XMLSecurity\Assert\Assert;
 use SimpleSAML\XMLSecurity\Constants as C;
 use SimpleSAML\XMLSecurity\Exception\CanonicalizationFailedException;
@@ -26,15 +26,15 @@ trait CanonicalizableElementTrait
      * Process all transforms specified by a given Reference element.
      *
      * @param \SimpleSAML\XMLSecurity\XML\ds\Transforms $transforms The transforms to apply.
-     * @param \DOMElement $data The data referenced.
+     * @param \Dom\Element $data The data referenced.
      *
      * @return string The canonicalized data after applying all transforms specified by $ref.
      *
      * @see http://www.w3.org/TR/xmldsig-core/#sec-ReferenceProcessingModel
      */
     public function processTransforms(
         Transforms $transforms,
-        DOMElement $data,
+        Dom\Element $data,
     ): string {
         Assert::maxCount(
             $transforms->getTransform(),

src/XML/EncryptedElementTrait.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\SAML2\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\SAML2\Assert\Assert;
 use SimpleSAML\SAML2\Compat\ContainerSingleton;
 use SimpleSAML\SAML2\Exception\ProtocolViolationException;
@@ -92,7 +92,7 @@ public function getDecryptionKeys(): array
      * @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
      *   If the qualified name of the supplied element is wrong
      */
-    public static function fromXML(DOMElement $xml): static
+    public static function fromXML(Dom\Element $xml): static
     {
         Assert::same(
             $xml->localName,
@@ -120,7 +120,7 @@ public static function fromXML(DOMElement $xml): static
     /**
      * @inheritDoc
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         $e = $this->instantiateParentElement($parent);
 

src/XML/ExtensionsTrait.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\SAML2\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\XML\ExtendableElementTrait;
 
 /**
@@ -49,10 +49,10 @@ public function isEmptyElement(): bool
     /**
      * Convert this object into its md:Extensions XML representation.
      *
-     * @param \DOMElement|null $parent The element we should add this Extensions element to.
-     * @return \DOMElement The new md:Extensions XML element.
+     * @param \Dom\Element|null $parent The element we should add this Extensions element to.
+     * @return \Dom\Element The new md:Extensions XML element.
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         $e = $this->instantiateParentElement($parent);
 
@@ -70,5 +70,5 @@ public function toXML(?DOMElement $parent = null): DOMElement
 
     /**
      */
-    abstract public function instantiateParentElement(?DOMElement $parent = null): DOMElement;
+    abstract public function instantiateParentElement(?Dom\Element $parent = null): Dom\Element;
 }

src/XML/IdentifierTrait.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\SAML2\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\SAML2\Assert\Assert;
 use SimpleSAML\SAML2\XML\saml\AbstractBaseID;
 use SimpleSAML\SAML2\XML\saml\EncryptedID;
@@ -58,7 +58,7 @@ protected function setIdentifier(?IdentifierInterface $identifier): void
      * @throws \SimpleSAML\XMLSchema\Exception\TooManyElementsException
      *   if too many child-elements of a type are specified
      */
-    protected static function getIdentifierFromXML(DOMElement $xml): ?IdentifierInterface
+    protected static function getIdentifierFromXML(Dom\Element $xml): ?IdentifierInterface
     {
         $class = static::NS_PREFIX . ':' . self::getClassName(static::class);
 

src/XML/SignableElementTrait.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\SAML2\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\SAML2\Assert\Assert;
 use SimpleSAML\SAML2\Compat\ContainerSingleton;
 use SimpleSAML\XML\DOMDocumentFactory;
@@ -75,20 +75,20 @@ public function sign(
     /**
      * Do the actual signing of the document.
      *
-     * Note that this method does not insert the signature in the returned \DOMElement. The signature will be available
+     * Note that this method does not insert the signature in the returned \Dom\Element. The signature will be available
      * in $this->signature as a \SimpleSAML\XMLSecurity\XML\ds\Signature object, which can then be converted to XML
-     * calling toXML() on it, passing the \DOMElement value returned here as a parameter. The resulting \DOMElement
+     * calling toXML() on it, passing the \Dom\Element value returned here as a parameter. The resulting \Dom\Element
      * can then be inserted in the position desired.
      *
      * E.g.:
      *     $xml = // our XML to sign
      *     $signedXML = $this->doSign($xml);
      *     $signedXML->appendChild($this->signature->toXML($signedXML));
      *
-     * @param \DOMElement $xml The element to sign.
-     * @return \DOMElement The signed element, without the signature attached to it just yet.
+     * @param \Dom\Element $xml The element to sign.
+     * @return \Dom\Element The signed element, without the signature attached to it just yet.
      */
-    protected function doSign(DOMElement $xml): DOMElement
+    protected function doSign(Dom\Element $xml): Dom\Element
     {
         Assert::notNull(
             $this->signer,