Add type for xml:lang attribute

Author: tvdijen

src/XML/Type/LangValue.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\XML\Attribute;
+use SimpleSAML\XML\Constants as C;
+use SimpleSAML\XMLSchema\Type\Builtin\LanguageValue;
+use SimpleSAML\XMLSchema\Type\Helper\AttributeTypeInterface;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class LangValue extends LanguageValue implements AttributeTypeInterface
+{
+    /** @var string */
+    public const SCHEMA_TYPE = 'xs:language';
+
+
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XMLSchema\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        $sanitized = $this->sanitizeValue($value);
+
+        if ($sanitized !== '') {
+            parent::validateValue($value);
+        }
+    }
+
+
+    /**
+     * Convert this value to an attribute
+     *
+     * @return \SimpleSAML\XML\Attribute
+     */
+    public function toAttribute(): Attribute
+    {
+        return new Attribute(C::NS_XML, 'xml', 'lang', $this);
+    }
+}

src/XMLSchema/Type/Helper/AttributeTypeInterface.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSchema\Type\Helper;
+
+use SimpleSAML\XML\Attribute;
+
+/**
+ * interface class to be implemented by all the classes that represent a DOM Attribute
+ *
+ * @package simplesamlphp/xml-common
+ */
+interface AttributeTypeInterface extends ValueTypeInterface
+{
+    /**
+     * Convert this value to an attribute
+     *
+     * @return \SimpleSAML\XML\Attribute
+     */
+    public function toAttribute(): Attribute;
+}

tests/XML/Type/LangValueTest.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XML\Type;
+
+use PHPUnit\Framework\Attributes\{CoversClass, DataProvider, DataProviderExternal, DependsOnClass};
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\Test\XML\Assert\LanguageTest;
+use SimpleSAML\XML\Constants as C;
+use SimpleSAML\XML\Type\LangValue;
+use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
+
+/**
+ * Class \SimpleSAML\Test\XML\Type\LangValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(LangValue::class)]
+final class LangValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $language
+     */
+    #[DataProvider('provideInvalidLang')]
+    #[DataProvider('provideValidLang')]
+    #[DataProviderExternal(LanguageTest::class, 'provideValidLanguage')]
+    #[DependsOnClass(LanguageTest::class)]
+    public function testLanguage(bool $shouldPass, string $language): void
+    {
+        try {
+            LangValue::fromString($language);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * Test helpers
+     */
+    public function testHelpers(): void
+    {
+        $lang = LangValue::fromString('en-us');
+        $attr = $lang->toAttribute();
+
+        $this->assertEquals($attr->getNamespaceURI(), C::NS_XML);
+        $this->assertEquals($attr->getNamespacePrefix(), 'xml');
+        $this->assertEquals($attr->getAttrName(), 'lang');
+        $this->assertEquals($attr->getAttrValue(), 'en-us');
+    }
+
+
+    /**
+     * @return array<string, array{0: true, 1: string}>
+     */
+    public static function provideValidLang(): array
+    {
+        return [
+            'empty string' => [true, ''],
+        ];
+    }
+
+
+    /**
+     * @return array<string, array{0: false, 1: string}>
+     */
+    public static function provideInvalidLang(): array
+    {
+        return [
+            'too long' => [false, 'toolongLanguage'],
+        ];
+    }
+}