Merge pull request #55 from simplesamlphp/feature/xsd-types

Create type-classes for all xsd-types

Author: tvdijen

composer.json

@@ -27,6 +27,8 @@
     },
     "require": {
         "php": "^8.1",
+
+        "ext-bcmath": "*",
         "ext-date": "*",
         "ext-dom": "*",
         "ext-filter": "*",

src/AbstractElement.php

@@ -7,16 +7,13 @@
 use DOMElement;
 use RuntimeException;
 use SimpleSAML\XML\Assert\Assert;
-use SimpleSAML\XML\Exception\MissingAttributeException;
-use SimpleSAML\XML\Exception\SchemaViolationException;
+use SimpleSAML\XML\Exception\{MissingAttributeException, SchemaViolationException};
 use SimpleSAML\XML\SerializableElementTrait;
+use SimpleSAML\XML\Type\{QNameValue, StringValue, ValueTypeInterface};
 
 use function array_slice;
 use function defined;
 use function explode;
-use function func_num_args;
-use function in_array;
-use function intval;
 use function join;
 use function strval;
 
@@ -57,133 +54,59 @@ public function instantiateParentElement(?DOMElement $parent = null): DOMElement
 
 
     /**
-     * Get the value of an attribute from a given element.
-     *
-     * @param \DOMElement $xml The element where we should search for the attribute.
-     * @param string      $name The name of the attribute.
-     * @return string
+     * @template T of \SimpleSAML\XML\Type\ValueTypeInterface
+     * @param \DOMElement     $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\XML\Exception\MissingAttributeException if the attribute is missing from the element
      */
-    public static function getAttribute(DOMElement $xml, string $name): string
-    {
+    public static function getAttribute(
+        DOMElement $xml,
+        string $name,
+        string $type = StringValue::class,
+    ): ValueTypeInterface {
+        Assert::isAOf($type, ValueTypeInterface::class);
+
         $prefix = static::getNamespacePrefix();
         $localName = static::getLocalName();
         $qName = $prefix ? ($prefix . ':' . $localName) : $localName;
         Assert::true(
-            $xml->hasAttribute($name) && func_num_args() === 2,
+            $xml->hasAttribute($name),
             sprintf('Missing \'%s\' attribute on %s.', $name, $qName),
             MissingAttributeException::class,
         );
 
-        return $xml->getAttribute($name);
+        $value = $xml->getAttribute($name);
+        return ($type === QNameValue::class) ? QNameValue::fromDocument($value, $xml) : $type::fromString($value);
     }
 
 
     /**
      * Get the value of an attribute from a given element.
      *
-     * @param \DOMElement $xml The element where we should search for the attribute.
-     * @param string      $name The name of the attribute.
-     * @param string|null $default The default to return in case the attribute does not exist and it is optional.
-     * @return ($default is string ? string : string|null)
-     */
-    public static function getOptionalAttribute(DOMElement $xml, string $name, ?string $default = null): ?string
-    {
-        if (!$xml->hasAttribute($name)) {
-            return $default;
-        }
-
-        return self::getAttribute($xml, $name);
-    }
-
-
-    /**
-     * @param \DOMElement $xml The element where we should search for the attribute.
-     * @param string      $name The name of the attribute.
-     * @return bool
-     *
-     * @throws \SimpleSAML\XML\Exception\MissingAttributeException if the attribute is missing from the element
-     * @throws \SimpleSAML\Assert\AssertionFailedException if the attribute is not a boolean
+     * @template T of \SimpleSAML\XML\Type\ValueTypeInterface
+     * @param \DOMElement  $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\XML\Type\ValueTypeInterface|null $default
+     *   The default to return in case the attribute does not exist and it is optional.
+     * @return ($default is \SimpleSAML\XML\Type\ValueTypeInterface ? T : T|null)
      */
-    public static function getBooleanAttribute(DOMElement $xml, string $name): bool
-    {
-        $value = self::getAttribute($xml, $name);
+    public static function getOptionalAttribute(
+        DOMElement $xml,
+        string $name,
+        string $type = StringValue::class,
+        ?ValueTypeInterface $default = null,
+    ): ?ValueTypeInterface {
+        Assert::nullOrIsInstanceOf($default, $type);
 
-        $prefix = static::getNamespacePrefix();
-        $localName = static::getLocalName();
-        $qName = $prefix ? ($prefix . ':' . $localName) : $localName;
-        Assert::oneOf(
-            $value,
-            ['0', '1', 'false', 'true'],
-            sprintf('The \'%s\' attribute of %s must be a boolean.', $name, $qName),
-        );
-
-        return in_array($value, ['1', 'true'], true);
-    }
-
-
-    /**
-     * @param \DOMElement $xml The element where we should search for the attribute.
-     * @param string      $name The name of the attribute.
-     * @param bool|null   $default The default to return in case the attribute does not exist and it is optional.
-     * @return ($default is bool ? bool : bool|null)
-     *
-     * @throws \SimpleSAML\Assert\AssertionFailedException if the attribute is not a boolean
-     */
-    public static function getOptionalBooleanAttribute(DOMElement $xml, string $name, ?bool $default = null): ?bool
-    {
         if (!$xml->hasAttribute($name)) {
             return $default;
         }
 
-        return self::getBooleanAttribute($xml, $name);
-    }
-
-
-    /**
-     * Get the integer value of an attribute from a given element.
-     *
-     * @param \DOMElement $xml The element where we should search for the attribute.
-     * @param string      $name The name of the attribute.
-     * @return int
-     *
-     * @throws \SimpleSAML\XML\Exception\MissingAttributeException if the attribute is missing from the element
-     * @throws \SimpleSAML\Assert\AssertionFailedException if the attribute is not an integer
-     */
-    public static function getIntegerAttribute(DOMElement $xml, string $name): int
-    {
-        $value = self::getAttribute($xml, $name);
-
-        $prefix = static::getNamespacePrefix();
-        $localName = static::getLocalName();
-        $qName = $prefix ? ($prefix . ':' . $localName) : $localName;
-        Assert::numeric(
-            $value,
-            sprintf('The \'%s\' attribute of %s must be numerical.', $name, $qName),
-        );
-
-        return intval($value);
-    }
-
-
-    /**
-     * Get the integer value of an attribute from a given element.
-     *
-     * @param \DOMElement $xml The element where we should search for the attribute.
-     * @param string      $name The name of the attribute.
-     * @param int|null    $default The default to return in case the attribute does not exist and it is optional.
-     * @return ($default is int ? int : int|null)
-     *
-     * @throws \SimpleSAML\Assert\AssertionFailedException if the attribute is not an integer
-     */
-    public static function getOptionalIntegerAttribute(DOMElement $xml, string $name, ?int $default = null): ?int
-    {
-        if (!$xml->hasAttribute($name)) {
-            return $default;
-        }
-
-        return self::getIntegerAttribute($xml, $name);
+        return self::getAttribute($xml, $name, $type);
     }
 
 
@@ -230,11 +153,6 @@ public static function getChildrenOfClass(DOMElement $parent): array
                 && $node->namespaceURI === static::getNamespaceURI()
                 && $node->localName === static::getLocalName()
             ) {
-                // Normalize the DOMElement by importing it into a clean empty document
-                $newDoc = DOMDocumentFactory::create();
-                /** @var \DOMElement $node */
-                $node = $newDoc->appendChild($newDoc->importNode($node, true));
-
                 $ret[] = static::fromXML($node);
             }
         }

src/Assert/AnyURITrait.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait AnyURITrait
+{
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validAnyURI(string $value, string $message = ''): void
+    {
+        parent::validURI(
+            $value,
+            $message ?: '%s is not a valid xs:anyURI',
+            InvalidArgumentException::class,
+        );
+    }
+}