Arrayizable IDPEntry

tvdijen · tvdijen · commit 19c658cfc47c · 2023-06-12T21:46:07.000+02:00
diff --git a/src/SAML2/XML/samlp/IDPEntry.php b/src/SAML2/XML/samlp/IDPEntry.php
@@ -6,9 +6,15 @@
 
 use DOMElement;
 use SimpleSAML\Assert\Assert;
+use SimpleSAML\SAML2\Exception\ArrayValidationException;
 use SimpleSAML\XML\Exception\InvalidDOMElementException;
 use SimpleSAML\XML\Exception\SchemaViolationException;
 
+use function array_change_key_case;
+use function array_filter;
+use function array_key_exists;
+use function array_keys;
+
 /**
  * Class for handling SAML2 IDPEntry.
  *
@@ -106,4 +112,80 @@ public function toXML(DOMElement $parent = null): DOMElement
 
         return $e;
     }
+
+
+    /**
+     * Create a class from an array
+     *
+     * @param array $data
+     * @return static
+     */
+    public static function fromArray(array $data): static
+    {
+        $data = self::processArrayContents($data);
+
+        return new static(
+            $data['ProviderID'],
+            $data['Name'] ?? null,
+            $data['Loc'] ?? null,
+        );
+    }
+
+
+    /**
+     * Validates an array representation of this object and returns the same array with
+     * rationalized keys (casing) and parsed sub-elements.
+     *
+     * @param array $data
+     * @return array $data
+     */
+    private static function processArrayContents(array $data): array
+    {
+        $data = array_change_key_case($data, CASE_LOWER);
+
+        // Make sure the array keys are known for this kind of object
+        Assert::allOneOf(
+            array_keys($data),
+            [
+                'providerid',
+                'name',
+                'loc',
+            ],
+            ArrayValidationException::class,
+        );
+
+        Assert::keyExists($data, 'providerid', ArrayValidationException::class);
+        Assert::string($data['providerid'], ArrayValidationException::class);
+
+        $retval = ['ProviderID' => $data['providerid']];
+
+        if (array_key_exists('name', $data)) {
+            Assert::string($data['name'], ArrayValidationException::class);
+            $retval['Name'] = $data['name'];
+        }
+
+        if (array_key_exists('loc', $data)) {
+            Assert::string($data['loc'], ArrayValidationException::class);
+            $retval['Loc'] = $data['loc'];
+        }
+
+        return $retval;
+    }
+
+
+    /**
+     * Create an array from this class
+     *
+     * @return array
+     */
+    public function toArray(): array
+    {
+        $data = [
+            'ProviderID' => $this->getProviderID(),
+            'Name' => $this->getName(),
+            'Loc' => $this->getLoc(),
+        ];
+
+        return array_filter($data);
+    }
 }
diff --git a/tests/SAML2/XML/samlp/IDPEntryTest.php b/tests/SAML2/XML/samlp/IDPEntryTest.php
@@ -8,6 +8,7 @@
 use PHPUnit\Framework\TestCase;
 use SimpleSAML\SAML2\XML\samlp\IDPEntry;
 use SimpleSAML\XML\DOMDocumentFactory;
+use SimpleSAML\XML\TestUtils\ArrayizableElementTestTrait;
 use SimpleSAML\XML\TestUtils\SchemaValidationTestTrait;
 use SimpleSAML\XML\TestUtils\SerializableElementTestTrait;
 
@@ -24,6 +25,7 @@
  */
 final class IDPEntryTest extends TestCase
 {
+    use ArrayizableElementTestTrait;
     use SchemaValidationTestTrait;
     use SerializableElementTestTrait;
 
@@ -36,6 +38,12 @@ public static function setUpBeforeClass(): void
 
         self::$testedClass = IDPentry::class;
 
+        self::$arrayRepresentation = [
+            'ProviderID' => 'urn:some:requester',
+            'Name' => 'testName',
+            'Loc' => 'urn:test:testLoc',
+        ];
+
         self::$xmlRepresentation = DOMDocumentFactory::fromFile(
             dirname(__FILE__, 4) . '/resources/xml/samlp_IDPEntry.xml',
         );
