Add toArray for list-types

Author: tvdijen

src/Type/EntitiesValue.php

@@ -5,12 +5,13 @@
 namespace SimpleSAML\XML\Type;
 
 use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Constants as C;
 use SimpleSAML\XML\Exception\SchemaViolationException;
 
 /**
  * @package simplesaml/xml-common
  */
-class EntitiesValue extends TokenValue
+class EntitiesValue extends TokenValue implements ListTypeInterface
 {
     /**
      * Validate the value.
@@ -24,4 +25,16 @@ protected function validateValue(string $value): void
         // Note: value must already be sanitized before validating
         Assert::validEntities($this->sanitizeValue($value), SchemaViolationException::class);
     }
+
+
+    /**
+     * Convert this xs:ENTITIES to an array of xs:ENTITY items
+     *
+     * @return array<\SimpleSAML\XML\Type\EntityValue>
+     */
+    public function toArray(): array
+    {
+        $tokens = explode(' ', $this->getValue(), C::UNBOUNDED_LIMIT);
+        return array_map([EntityValue::class, 'fromString'], $tokens);
+    }
 }

src/Type/IDRefsValue.php

@@ -5,12 +5,13 @@
 namespace SimpleSAML\XML\Type;
 
 use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Constants as C;
 use SimpleSAML\XML\Exception\SchemaViolationException;
 
 /**
  * @package simplesaml/xml-common
  */
-class IDRefsValue extends TokenValue
+class IDRefsValue extends TokenValue implements ListTypeInterface
 {
     /**
      * Validate the value.
@@ -24,4 +25,16 @@ protected function validateValue(string $value): void
         // Note: value must already be sanitized before validating
         Assert::validIDRefs($this->sanitizeValue($value), SchemaViolationException::class);
     }
+
+
+    /**
+     * Convert this xs:IDREFS to an array of xs:IDREF items
+     *
+     * @return array<\SimpleSAML\XML\Type\IDRefValue>
+     */
+    public function toArray(): array
+    {
+        $tokens = explode(' ', $this->getValue(), C::UNBOUNDED_LIMIT);
+        return array_map([IDRefValue::class, 'fromString'], $tokens);
+    }
 }

src/Type/ListTypeInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+/**
+ * interface class to be implemented by all the classes that represent a list type
+ *
+ * @package simplesamlphp/xml-common
+ */
+interface ListTypeInterface extends ValueTypeInterface
+{
+    /**
+     * Convert this list type to an array of individual items
+     *
+     * @return array<\SimpleSAML\XML\Type\ValueTypeInterface>
+     */
+    public function toArray(): array;
+}

src/Type/NMTokensValue.php

@@ -5,12 +5,16 @@
 namespace SimpleSAML\XML\Type;
 
 use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Constants as C;
 use SimpleSAML\XML\Exception\SchemaViolationException;
 
+use function array_map;
+use function explode;
+
 /**
  * @package simplesaml/xml-common
  */
-class NMTokensValue extends TokenValue
+class NMTokensValue extends TokenValue implements ListTypeInterface
 {
     /**
      * Validate the value.
@@ -24,4 +28,16 @@ protected function validateValue(string $value): void
         // Note: value must already be sanitized before validating
         Assert::validNMTokens($this->sanitizeValue($value), SchemaViolationException::class);
     }
+
+
+    /**
+     * Convert this xs:NMTokens to an array of xs:NMToken items
+     *
+     * @return array<\SimpleSAML\XML\Type\NMTokenValue>
+     */
+    public function toArray(): array
+    {
+        $tokens = explode(' ', $this->getValue(), C::UNBOUNDED_LIMIT);
+        return array_map([NMTokenValue::class, 'fromString'], $tokens);
+    }
 }

tests/Type/EntitiesValueTest.php

@@ -53,4 +53,14 @@ public static function provideEntities(): array
             'normalization' => [true, ' foobar '],
         ];
     }
+
+
+    /**
+     * Test the toArray function
+     */
+    public function testToArray(): void
+    {
+        $entities = EntitiesValue::fromString("foo \nbar  baz");
+        $this->assertEquals(['foo', 'bar', 'baz'], $entities->toArray());
+    }
 }

tests/Type/IDRefsValueTest.php

@@ -54,4 +54,14 @@ public static function provideIDRefs(): array
             'normalization' => [true, ' foobar '],
         ];
     }
+
+
+    /**
+     * Test the toArray function
+     */
+    public function testToArray(): void
+    {
+        $idrefs = IDRefsValue::fromString("foo \nbar  baz");
+        $this->assertEquals(['foo', 'bar', 'baz'], $idrefs->toArray());
+    }
 }

tests/Type/NMTokenValueTest.php

@@ -23,7 +23,7 @@ final class NMTokenValueTest extends TestCase
      * @param string $nmtoken
      */
     #[DataProvider('provideNMToken')]
-    public function testName(bool $shouldPass, string $nmtoken): void
+    public function testNMToken(bool $shouldPass, string $nmtoken): void
     {
         try {
             NMTokenValue::fromString($nmtoken);

tests/Type/NMTokensValueTest.php

@@ -23,7 +23,7 @@ final class NMTokensValueTest extends TestCase
      * @param string $nmtokens
      */
     #[DataProvider('provideNMTokens')]
-    public function testName(bool $shouldPass, string $nmtokens): void
+    public function testNMtokens(bool $shouldPass, string $nmtokens): void
     {
         try {
             NMTokensValue::fromString($nmtokens);
@@ -50,4 +50,14 @@ public static function provideNMTokens(): array
             'normalization' => [true, ' foobar   nmtoken '],
         ];
     }
+
+
+    /**
+     * Test the toArray function
+     */
+    public function testToArray(): void
+    {
+        $nmtokens = NMTokensValue::fromString("foo \nbar  baz");
+        $this->assertEquals(['foo', 'bar', 'baz'], $nmtokens->toArray());
+    }
 }