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

composer.json

@@ -14,7 +14,7 @@
         "ext-dom": "*",
 
         "simplesamlphp/assert": "~2.0",
-        "simplesamlphp/xml-common": "~2.0"
+        "simplesamlphp/xml-common": "dev-feature/dom-migration-php84"
     },
     "require-dev": {
         "simplesamlphp/simplesamlphp-test-framework": "~1.11"
@@ -31,7 +31,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "v2.0.x-dev"
+            "dev-master": "v3.0.x-dev"
         }
     },
     "config": {

src/CAS/Utils/XPath.php

@@ -4,8 +4,7 @@
 
 namespace SimpleSAML\CAS\Utils;
 
-use DOMNode;
-use DOMXPath;
+use Dom;
 use SimpleSAML\CAS\Constants as C;
 
 /**
@@ -16,21 +15,21 @@
 class XPath extends \SimpleSAML\XPath\XPath
 {
     /**
-     * Get a DOMXPath object that can be used to search for CAS elements.
+     * Get a Dom\XPath object that can be used to search for CAS 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
      *   cas-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);
 
         /*
          * - Registering 'cas' to the same URI again is fine.
-         * - If someone previously bound 'cas' to a different URI on the same DOMXPath,
+         * - If someone previously bound 'cas' to a different URI on the same Dom\XPath,
          *   your call will change its meaning for subsequent queries
          * */
         $xp->registerNamespace('cas', C::NS_CAS);

src/CAS/XML/AbstractAttributes.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\CAS\Constants as C;
 use SimpleSAML\XML\ExtendableElementTrait;
 use SimpleSAML\XMLSchema\XML\Constants\NS;
@@ -80,10 +80,10 @@ public function getIsFromNewLogin(): IsFromNewLogin
     /**
      * Convert this Attributes to XML.
      *
-     * @param \DOMElement|null $parent The element we should append this Attributes to.
-     * @return \DOMElement
+     * @param \Dom\Element|null $parent The element we should append this Attributes to.
+     * @return \Dom\Element
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         $e = $this->instantiateParentElement($parent);
 

src/CAS/XML/AbstractAuthenticationFailure.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\CAS\Type\CodeValue;
 use SimpleSAML\XML\TypedTextContentTrait;
 use SimpleSAML\XMLSchema\Type\StringValue;
@@ -52,10 +52,10 @@ public function getCode(): CodeValue
     /**
      * Convert this AuthenticationFailure to XML.
      *
-     * @param \DOMElement|null $parent The element we should append to.
-     * @return \DOMElement This AuthenticatioFailure-element.
+     * @param \Dom\Element|null $parent The element we should append to.
+     * @return \Dom\Element This AuthenticatioFailure-element.
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         $e = $this->instantiateParentElement($parent);
 

src/CAS/XML/AbstractAuthenticationSuccess.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 
 /**
  * Class for CAS authenticationSuccess
@@ -72,10 +72,10 @@ public function getProxies(): ?Proxies
     /**
      * Convert this AuthenticationSuccess to XML.
      *
-     * @param \DOMElement|null $parent The element we should append this AuthenticationSuccess to.
-     * @return \DOMElement
+     * @param \Dom\Element|null $parent The element we should append this AuthenticationSuccess to.
+     * @return \Dom\Element
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         $e = $this->instantiateParentElement($parent);
 

src/CAS/XML/AbstractProxies.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\CAS\Assert\Assert;
 use SimpleSAML\CAS\Constants as C;
 use SimpleSAML\XMLSchema\Exception\MissingElementException;
@@ -45,10 +45,10 @@ public function getProxy(): array
     /**
      * Convert this Proxies to XML.
      *
-     * @param \DOMElement|null $parent The element we should append this Proxies to.
-     * @return \DOMElement
+     * @param \Dom\Element|null $parent The element we should append this Proxies to.
+     * @return \Dom\Element
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         $e = $this->instantiateParentElement($parent);
 

src/CAS/XML/AbstractProxyFailure.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\CAS\Type\CodeValue;
 use SimpleSAML\XML\TypedTextContentTrait;
 use SimpleSAML\XMLSchema\Type\StringValue;
@@ -52,10 +52,10 @@ public function getCode(): CodeValue
     /**
      * Convert this ProxyFailure to XML.
      *
-     * @param \DOMElement|null $parent The element we should append to.
-     * @return \DOMElement This ProxyFailure-element.
+     * @param \Dom\Element|null $parent The element we should append to.
+     * @return \Dom\Element This ProxyFailure-element.
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         $e = $this->instantiateParentElement($parent);
 

src/CAS/XML/AbstractProxySuccess.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 
 /**
  * Class for CAS proxySuccess
@@ -39,10 +39,10 @@ public function getProxyTicket(): ProxyTicket
     /**
      * Convert this ProxySuccess to XML.
      *
-     * @param \DOMElement|null $parent The element we should append to.
-     * @return \DOMElement This ProxySuccess-element.
+     * @param \Dom\Element|null $parent The element we should append to.
+     * @return \Dom\Element This ProxySuccess-element.
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         $e = $this->instantiateParentElement($parent);
 

src/CAS/XML/AbstractServiceResponse.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 
 /**
  * Class for CAS serviceResponse
@@ -39,10 +39,10 @@ public function getResponse(): AbstractResponse
     /**
      * Convert this ServiceResponse to XML.
      *
-     * @param \DOMElement|null $parent The element we should append this ServiceResponse to.
-     * @return \DOMElement
+     * @param \Dom\Element|null $parent The element we should append this ServiceResponse to.
+     * @return \Dom\Element
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         $e = $this->instantiateParentElement($parent);
 

src/CAS/XML/Attributes.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\CAS\Assert\Assert;
 use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
 use SimpleSAML\XMLSchema\Exception\MissingElementException;
@@ -19,15 +19,15 @@ final class Attributes extends AbstractAttributes
     /**
      * Convert XML into a cas:attributes-element
      *
-     * @param \DOMElement $xml The XML element we should load
+     * @param \Dom\Element $xml The XML element we should load
      * @return static
      *
      * @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
      *   if the qualified name of the supplied element is wrong
      * @throws \SimpleSAML\XMLSchema\Exception\MissingAttributeException
      *   if the supplied element is missing one of the mandatory attributes
      */
-    public static function fromXML(DOMElement $xml): static
+    public static function fromXML(Dom\Element $xml): static
     {
         Assert::same($xml->localName, static::getLocalName(), InvalidDOMElementException::class);
         Assert::same($xml->namespaceURI, static::getNamespaceURI(), InvalidDOMElementException::class);

src/CAS/XML/AuthenticationDate.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\CAS\Assert\Assert;
 use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
 use SimpleSAML\XMLSchema\Type\DateTimeValue;
@@ -44,9 +44,9 @@ public function getTimestamp(): DateTimeValue
     /**
      * Convert this element into an XML document.
      *
-     * @return \DOMElement The root element of the DOM tree
+     * @return \Dom\Element The root element of the DOM tree
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         $e = $this->instantiateParentElement($parent);
         $e->textContent = strval($this->getTimestamp());
@@ -58,17 +58,17 @@ public function toXML(?DOMElement $parent = null): DOMElement
     /**
      * Convert XML into a cas:authenticationDate
      *
-     * @param \DOMElement $xml The XML element we should load
+     * @param \Dom\Element $xml The XML element we should load
      * @return static
      *
      * @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, static::getLocalName(), InvalidDOMElementException::class);
         Assert::same($xml->namespaceURI, static::getNamespaceURI(), InvalidDOMElementException::class);
 
-        return new static(DateTimeValue::fromString($xml->textContent));
+        return new static(DateTimeValue::fromString((string) $xml->textContent));
     }
 }

src/CAS/XML/AuthenticationFailure.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\CAS\Assert\Assert;
 use SimpleSAML\CAS\Type\CodeValue;
 use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
@@ -20,21 +20,21 @@ final class AuthenticationFailure extends AbstractAuthenticationFailure
     /**
      * Initialize an AuthenticationFailure element.
      *
-     * @param \DOMElement $xml The XML element we should load.
+     * @param \Dom\Element $xml The XML element we should load.
      * @return static
      *
      * @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
      *   if the qualified name of the supplied element is wrong
      * @throws \SimpleSAML\XMLSchema\Exception\MissingAttributeException
      *   if the supplied element is missing any of the mandatory attributes
      */
-    public static function fromXML(DOMElement $xml): static
+    public static function fromXML(Dom\Element $xml): static
     {
         Assert::same($xml->localName, static::getLocalName(), InvalidDOMElementException::class);
         Assert::same($xml->namespaceURI, static::getNamespaceURI(), InvalidDOMElementException::class);
 
         return new static(
-            StringValue::fromString($xml->textContent),
+            StringValue::fromString((string) $xml->textContent),
             self::getAttribute($xml, 'code', CodeValue::class),
         );
     }

src/CAS/XML/AuthenticationSuccess.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\CAS\Assert\Assert;
 use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
 use SimpleSAML\XMLSchema\Exception\MissingElementException;
@@ -21,15 +21,15 @@ final class AuthenticationSuccess extends AbstractAuthenticationSuccess
     /**
      * Convert XML into a cas:authenticationSuccess-element
      *
-     * @param \DOMElement $xml The XML element we should load
+     * @param \Dom\Element $xml The XML element we should load
      * @return static
      *
      * @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
      *   if the qualified name of the supplied element is wrong
      * @throws \SimpleSAML\XMLSchema\Exception\MissingAttributeException
      *   if the supplied element is missing one of the mandatory attributes
      */
-    public static function fromXML(DOMElement $xml): static
+    public static function fromXML(Dom\Element $xml): static
     {
         Assert::same($xml->localName, static::getLocalName(), InvalidDOMElementException::class);
         Assert::same($xml->namespaceURI, static::getNamespaceURI(), InvalidDOMElementException::class);

src/CAS/XML/Proxies.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\CAS\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\CAS\Assert\Assert;
 use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
 
@@ -18,13 +18,13 @@ final class Proxies extends AbstractProxies
     /**
      * Convert XML into a Proxies-element
      *
-     * @param \DOMElement $xml The XML element we should load
+     * @param \Dom\Element $xml The XML element we should load
      * @return static
      *
      * @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, static::getLocalName(), InvalidDOMElementException::class);
         Assert::same($xml->namespaceURI, static::getNamespaceURI(), InvalidDOMElementException::class);