Merge branch 'release-3.x'

Author: tvdijen

.github/workflows/php.yml

@@ -19,9 +19,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ['8.3', '8.4', '8.5']
+        php-version: ['8.5', '8.6']
 
-    uses: simplesamlphp/simplesamlphp-test-framework/.github/workflows/reusable_phplinter.yml@v1
+    uses: simplesamlphp/simplesamlphp-test-framework/.github/workflows/reusable_phplinter.yml@release-2.x
     secrets: inherit
     with:
       php-version: ${{ matrix.php-version }}
@@ -31,7 +31,7 @@ jobs:
     strategy:
       fail-fast: false
 
-    uses: simplesamlphp/simplesamlphp-test-framework/.github/workflows/reusable_linter.yml@v1
+    uses: simplesamlphp/simplesamlphp-test-framework/.github/workflows/reusable_linter.yml@release-2.x
     secrets: inherit
     with:
       enable_eslinter: false
@@ -47,7 +47,7 @@ jobs:
       fail-fast: false
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ['8.3', '8.4', '8.5']
+        php-versions: ['8.5', '8.6']
 
     steps:
       - name: Setup PHP, with composer and extensions
@@ -57,7 +57,7 @@ jobs:
           php-version: ${{ matrix.php-versions }}
           extensions: ctype, date, dom, filter, intl, libxml, pcre, sodium, spl, xml, xmlreader
           tools: composer
-          ini-values: error_reporting=E_ALL
+          ini-values: error_reporting=E_ALL, display_errors=on
           coverage: pcov
 
       - name: Setup problem matchers for PHP
@@ -119,7 +119,7 @@ jobs:
       fail-fast: true
       matrix:
         operating-system: [windows-latest]
-        php-versions: ['8.3', '8.4', '8.5']
+        php-versions: ['8.5', '8.6']
 
     steps:
       - name: Setup PHP, with composer and extensions
@@ -129,7 +129,7 @@ jobs:
           php-version: ${{ matrix.php-versions }}
           extensions: ctype, date, dom, filter, intl, libxml, pcre, sodium, spl, xml, xmlreader, zip
           tools: composer
-          ini-values: error_reporting=E_ALL
+          ini-values: error_reporting=E_ALL, display_errors=on
           coverage: none
 
       - name: Setup problem matchers for PHP
@@ -246,7 +246,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           # Should be the lowest supported version
-          php-version: '8.3'
+          php-version: '8.5'
           extensions: ctype, date, dom, filter, libxml, pcre, spl, xml
           tools: composer
           coverage: none

composer.json

@@ -33,7 +33,7 @@
         }
     },
     "require": {
-        "php": "^8.3",
+        "php": "^8.5",
 
         "ext-bcmath": "*",
         "ext-date": "*",
@@ -42,22 +42,22 @@
         "ext-libxml": "*",
         "ext-pcre": "*",
         "ext-spl": "*",
+        "ext-uri": "*",
 
-        "guzzlehttp/psr7": "~2.8",
         "psr/clock": "~1.0",
-        "simplesamlphp/assert": "~2.0",
+        "simplesamlphp/assert": "~3.0",
         "simplesamlphp/composer-xmlprovider-installer": "~1.3"
     },
     "require-dev": {
-        "simplesamlphp/simplesamlphp-test-framework": "~1.11.5"
+        "simplesamlphp/simplesamlphp-test-framework": "~2.0"
     },
     "support": {
         "issues": "https://github.com/simplesamlphp/xml-common/issues",
         "source": "https://github.com/simplesamlphp/xml-common"
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "v2.7.x-dev"
+            "dev-master": "v3.0.x-dev"
         }
     },
     "config": {
@@ -72,7 +72,6 @@
     "scripts": {
         "pre-commit": [
             "vendor/bin/phpcs -p",
-            "vendor/bin/composer-require-checker check --config-file=tools/composer-require-checker.json composer.json",
             "vendor/bin/phpstan analyze -c phpstan.neon",
             "vendor/bin/phpstan analyze -c phpstan-dev.neon",
             "vendor/bin/composer-unused --excludePackage=simplesamlphp/composer-xmlprovider-installer",

src/XML/AbstractElement.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\XML;
 
-use DOMElement;
+use Dom;
 use RuntimeException;
 use SimpleSAML\XML\Assert\Assert;
 use SimpleSAML\XML\SerializableElementTrait;
@@ -35,9 +35,9 @@ abstract class AbstractElement implements
     /**
      * Create a document structure for this element
      *
-     * @param \DOMElement|null $parent The element we should append to.
+     * @param \Dom\Element|null $parent The element we should append to.
      */
-    public function instantiateParentElement(?DOMElement $parent = null): DOMElement
+    public function instantiateParentElement(?Dom\Element $parent = null): Dom\Element
     {
         $qualifiedName = $this->getQualifiedName();
         $namespace = static::getNamespaceURI();
@@ -59,15 +59,15 @@ public function instantiateParentElement(?DOMElement $parent = null): DOMElement
 
     /**
      * @template T of \SimpleSAML\XMLSchema\Type\Interface\ValueTypeInterface
-     * @param \DOMElement     $xml The element where we should search for the attribute.
+     * @param \Dom\Element    $xml The element where we should search for the attribute.
      * @param string          $name The name of the attribute.
      * @param class-string<T> $type The type of the attribute value.
      * @return T
      *
      * @throws \SimpleSAML\XMLSchema\Exception\MissingAttributeException if the attribute is missing from the element
      */
     public static function getAttribute(
-        DOMElement $xml,
+        Dom\Element $xml,
         string $name,
         string $type = StringValue::class,
     ): ValueTypeInterface {
@@ -91,15 +91,15 @@ public static function getAttribute(
      * Get the value of an attribute from a given element.
      *
      * @template T of \SimpleSAML\XMLSchema\Type\Interface\ValueTypeInterface
-     * @param \DOMElement  $xml The element where we should search for the attribute.
+     * @param \Dom\Element  $xml The element where we should search for the attribute.
      * @param string       $name The name of the attribute.
      * @param class-string<T> $type The type of the attribute value.
      * @param \SimpleSAML\XMLSchema\Type\Interface\ValueTypeInterface|null $default
      *   The default to return in case the attribute does not exist and it is optional.
      * @return ($default is \SimpleSAML\XMLSchema\Type\Interface\ValueTypeInterface ? T : T|null)
      */
     public static function getOptionalAttribute(
-        DOMElement $xml,
+        Dom\Element $xml,
         string $name,
         string $type = StringValue::class,
         ?ValueTypeInterface $default = null,
@@ -142,15 +142,15 @@ public function getQualifiedName(): string
     /**
      * Extract localized names from the children of a given element.
      *
-     * @param \DOMElement $parent The element we want to search.
+     * @param \Dom\Element $parent The element we want to search.
      * @return list<static> An array of objects of this class.
      */
-    public static function getChildrenOfClass(DOMElement $parent): array
+    public static function getChildrenOfClass(Dom\Element $parent): array
     {
         $ret = [];
         foreach ($parent->childNodes as $node) {
             if (
-                $node instanceof DOMElement
+                $node instanceof Dom\Element
                 && $node->namespaceURI === static::getNamespaceURI()
                 && $node->localName === static::getLocalName()
             ) {

src/XML/Attribute.php

@@ -4,9 +4,9 @@
 
 namespace SimpleSAML\XML;
 
-use DOMAttr;
-use DOMElement;
+use Dom;
 use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Constants as C;
 use SimpleSAML\XMLSchema\Type\Interface\ValueTypeInterface;
 use SimpleSAML\XMLSchema\Type\StringValue;
 
@@ -83,9 +83,9 @@ public function getAttrValue(): ValueTypeInterface
     /**
      * Create a class from XML
      *
-     * @param \DOMAttr $attr
+     * @param \Dom\Attr $attr
      */
-    public static function fromXML(DOMAttr $attr): static
+    public static function fromXML(Dom\Attr $attr): static
     {
         return new static($attr->namespaceURI, $attr->prefix, $attr->localName, StringValue::fromString($attr->value));
     }
@@ -94,23 +94,20 @@ public static function fromXML(DOMAttr $attr): static
     /**
      * Create XML from this class
      *
-     * @param \DOMElement $parent
+     * @param \Dom\Element $parent
      */
-    public function toXML(DOMElement $parent): DOMElement
+    public function toXML(Dom\Element $parent): Dom\Element
     {
-        if ($this->getNamespaceURI() !== null && !$parent->lookupPrefix($this->getNamespacePrefix())) {
-            $parent->setAttributeNS(
-                'http://www.w3.org/2000/xmlns/',
-                'xmlns:' . $this->getNamespacePrefix(),
-                $this->getNamespaceURI(),
-            );
+        $prefix = $this->getNamespacePrefix();
+        $namespaceURI = $this->getNamespaceURI();
+
+        if ($namespaceURI !== null && !in_array($prefix, ['xml', 'xmlns']) && !$parent->lookupPrefix($prefix)) {
+            $parent->setAttributeNS(C::NS_XMLNS, 'xmlns:' . $prefix, $namespaceURI);
         }
 
         $parent->setAttributeNS(
-            $this->getNamespaceURI(),
-            !in_array($this->getNamespacePrefix(), ['', null])
-                ? ($this->getNamespacePrefix() . ':' . $this->getAttrName())
-                : $this->getAttrName(),
+            $namespaceURI,
+            !in_array($prefix, ['', null]) ? ($prefix . ':' . $this->getAttrName()) : $this->getAttrName(),
             strval($this->getAttrValue()),
         );
 

src/XML/Chunk.php

@@ -4,7 +4,7 @@
 
 namespace SimpleSAML\XML;
 
-use DOMElement;
+use Dom;
 use SimpleSAML\XML\Assert\Assert;
 use SimpleSAML\XML\DOMDocumentFactory;
 use SimpleSAML\XML\SerializableElementTrait;
@@ -57,10 +57,10 @@ final class Chunk implements
     /**
      * Create an XML Chunk from a copy of the given \DOMElement.
      *
-     * @param \DOMElement $xml The element we should copy.
+     * @param \Dom\Element $xml The element we should copy.
      */
     public function __construct(
-        protected DOMElement $xml,
+        protected Dom\Element $xml,
     ) {
         $this->setLocalName($xml->localName);
         $this->setNamespaceURI($xml->namespaceURI);
@@ -132,9 +132,9 @@ protected function setNamespaceURI(?string $namespaceURI = null): void
 
 
     /**
-     * Get this \DOMElement.
+     * Get this \Dom\Element.
      */
-    public function getXML(): DOMElement
+    public function getXML(): Dom\Element
     {
         return $this->xml;
     }
@@ -180,15 +180,15 @@ public function getQualifiedName(): string
      * Get the value of an attribute from a given element.
      *
      * @template T of \SimpleSAML\XMLSchema\Type\Interface\ValueTypeInterface
-     * @param \DOMElement     $xml The element where we should search for the attribute.
+     * @param \Dom\Element     $xml The element where we should search for the attribute.
      * @param string          $name The name of the attribute.
      * @param class-string<T> $type The type of the attribute value.
      * @return T
      *
      * @throws \SimpleSAML\XMLSchema\Exception\MissingAttributeException if the attribute is missing from the element
      */
     public static function getAttribute(
-        DOMElement $xml,
+        Dom\Element $xml,
         string $name,
         string $type = StringValue::class,
     ): ValueTypeInterface {
@@ -209,15 +209,15 @@ public static function getAttribute(
      * Get the value of an attribute from a given element.
      *
      * @template T of \SimpleSAML\XMLSchema\Type\Interface\ValueTypeInterface
-     * @param \DOMElement  $xml The element where we should search for the attribute.
+     * @param \Dom\Element  $xml The element where we should search for the attribute.
      * @param string       $name The name of the attribute.
      * @param class-string<T> $type The type of the attribute value.
      * @param \SimpleSAML\XMLSchema\Type\Interface\ValueTypeInterface|null $default
      *   The default to return in case the attribute does not exist and it is optional.
      * @return ($default is \SimpleSAML\XMLSchema\Type\Interface\ValueTypeInterface ? T : T|null)
      */
     public static function getOptionalAttribute(
-        DOMElement $xml,
+        Dom\Element $xml,
         string $name,
         string $type = StringValue::class,
         ?ValueTypeInterface $default = null,
@@ -235,16 +235,16 @@ public static function getOptionalAttribute(
      */
     public function isEmptyElement(): bool
     {
-        /** @var \DOMElement $xml */
+        /** @var \Dom\Element $xml */
         $xml = $this->getXML();
         return ($xml->childNodes->length === 0) && ($xml->attributes->count() === 0);
     }
 
 
     /**
-     * @param \DOMElement $xml
+     * @param \Dom\Element $xml
      */
-    public static function fromXML(DOMElement $xml): static
+    public static function fromXML(Dom\Element $xml): static
     {
         return new static($xml);
     }
@@ -253,10 +253,10 @@ public static function fromXML(DOMElement $xml): static
     /**
      * Append this XML element to a different XML element.
      *
-     * @param  \DOMElement|null $parent The element we should append this element to.
-     * @return \DOMElement The new element.
+     * @param  \Dom\Element|null $parent The element we should append this element to.
+     * @return \Dom\Element The new element.
      */
-    public function toXML(?DOMElement $parent = null): DOMElement
+    public function toXML(?Dom\Element $parent = null): Dom\Element
     {
         if ($parent === null) {
             $doc = DOMDocumentFactory::create();

src/XML/Container/AbstractTestContainer.php

@@ -4,6 +4,7 @@
 
 namespace SimpleSAML\XML\Container;
 
+use Dom;
 use SimpleSAML\XML\Attribute as XMLAttribute;
 use SimpleSAML\XML\Chunk;
 use SimpleSAML\XML\Type\LangValue;
@@ -28,4 +29,11 @@ abstract public function getLanguageValue(string $language = 'en'): LanguageValu
 
 
     abstract public function getXMLAttribute(int $x = 1): XMLAttribute;
+
+
+    /**
+     * @param non-empty-string $text
+     * @return \Dom\NodeList<\Dom\Node>
+     */
+    abstract public function getDOMText(string $text): Dom\NodeList;
 }