Create type-classes for all xsd-types

Author: tvdijen

src/Type/AbstractValueType.php

@@ -0,0 +1,104 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+/**
+ * Abstract class to be implemented by all types
+ *
+ * @package simplesamlphp/xml-common
+ */
+abstract class AbstractValueType implements ValueTypeInterface
+{
+    /** @var string */
+    protected string $content;
+
+
+    /**
+     * Set the content of the type.
+     *
+     * @param string $content
+     */
+    protected function __construct(string $content)
+    {
+        $this->validateContent($content);
+        $this->content = $content;
+    }
+
+
+    /**
+     * Get the content.
+     *
+     * @return string
+     */
+    public function getContent(): string
+    {
+        return $this->sanitizeContent($this->getRawContent());
+    }
+
+
+    /**
+     * Get the raw content unsanitized content.
+     *
+     * @return string
+     */
+    public function getRawContent(): string
+    {
+        return $this->content;
+    }
+
+
+    /**
+     * Sanitize the content of the element.
+     *
+     * @param string $content  The value to go in the XML textContent
+     * @throws \Exception on failure
+     * @return string
+     */
+    protected function sanitizeContent(string $content): string
+    {
+        /**
+         * Perform no sanitation by default.
+         * Override this method on the implementing class to perform content sanitation.
+         */
+        return $content;
+    }
+
+
+    /**
+     * Validate the content of the element.
+     *
+     * @param string $content  The value to go in the XML textContent
+     * @throws \Exception on failure
+     * @return void
+     */
+    protected function validateContent(/** @scrutinizer ignore-unused */ string $content): void
+    {
+        /**
+         * Perform no validation by default.
+         * Override this method on the implementing class to perform content validation.
+         */
+    }
+
+
+    /**
+     * @param string $value
+     * @return \SimpleSAML\XML\Type\ValueTypeInterface
+     */
+    public static function fromString(string $value): static
+    {
+        return new static($value);
+    }
+
+
+    /**
+     * Output the value as a string
+     *
+     * @return string
+     */
+    public function __toString(): string
+    {
+        return $this->getContent();
+    }
+}

src/Type/HexBinaryValue.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class HexBinaryValue extends StringValue
+{
+    /**
+     * Sanitize the content.
+     *
+     * Note:  There are no processing rules for xs:hexBinary regarding whitespace. General consensus is to strip them
+     *
+     * @param string $content  The unsanitized content
+     * @throws \Exception on failure
+     * @return string
+     */
+    protected function sanitizeContent(string $content): string
+    {
+        return str_replace(["\f", "\r", "\n", "\t", "\v", ' '], '', $content);
+    }
+
+
+    /**
+     * Validate the content of the element.
+     *
+     * @param string $content
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateContent(string $content): void
+    {
+        // Note: content must already be sanitized before validating
+        Assert::regex(
+            $this->sanitizeContent($content),
+            '/([0-9A-F]{2})*/i',
+            SchemaViolationException::class,
+        );
+    }
+}

src/Type/IntegerValue.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class URIValue extends StringValue
+{
+    /**
+     * Validate the content of the element.
+     *
+     * @param string $content
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateContent(string $content): void
+    {
+        Assert::numeric($content, SchemaViolationException::class);
+    }
+}

src/Type/StringValue.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class StringValue extends AbstractValueType
+{
+}

src/Type/URIValue.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class URIValue extends StringValueType
+{
+    /**
+     * Validate the content of the element.
+     *
+     * @param string $content
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateContent(string $content): void
+    {
+        Assert::validURI($content, SchemaViolationException::class);
+    }
+}

src/Type/ValueTypeInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+/**
+ * interface class to be implemented by all the classes that represent a value type
+ *
+ * @package simplesamlphp/xml-common
+ */
+interface ValueTypeInterface
+{
+    /**
+     * @return string
+     */
+    public static function getValue(): string;
+
+
+    /**
+     * @param string $value
+     * @return \SimpleSAML\XML\Type\ValueTypeInterface
+     */
+    public static function fromString(string $value): static;
+}