Merge pull request #11 from fschmtt/add-realm-collection

Return RealmCollection for Realms::all()

Author: fschmtt

README.md

@@ -60,7 +60,7 @@ More examples can be found in the [examples](examples) directory.
 | Endpoint | Status Code | Response | API |
 |----------|-------------|----------|-----|
 | `POST /auth/admin/realms` | `201` | [Realm](src/Representation/Realm.php) | [Realms::import()](src/Resource/Realms.php) |
-| `GET /auth/admin/realms` | `200` | array<[Realm](src/Representation/Realm.php)> | [Realms::all()](src/Resource/Realms.php) |
+| `GET /auth/admin/realms` | `200` | [RealmCollection](src/Collection/RealmCollection.php)> | [Realms::all()](src/Resource/Realms.php) |
 | `PUT /auth/admin/realms/{realm}` | `204` | [Realm](src/Representation/Realm.php) | [Realms::update()](src/Resource/Realms.php) |
 | `DELETE /auth/admin/realms/{realm}` | `204` | `n/a` | [Realms::delete()](src/Resource/Realms.php) |
 | `GET /auth/admin/realms/{realm}/admin-events` | `200` | `array` | [Realms::adminEvents()](src/Resource/Realms.php) |

src/Collection/RealmCollection.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Fschmtt\Keycloak\Collection;
+
+use Fschmtt\Keycloak\Representation\Realm;
+
+/**
+ * @method Realm[] getIterator()
+ */
+class RealmCollection extends Collection
+{
+    public static function getRepresentationClass(): string
+    {
+        return Realm::class;
+    }
+}

src/Resource/Realms.php

@@ -6,6 +6,7 @@
 
 use Fschmtt\Keycloak\Collection\ClientCollection;
 use Fschmtt\Keycloak\Collection\GroupCollection;
+use Fschmtt\Keycloak\Collection\RealmCollection;
 use Fschmtt\Keycloak\Collection\UserCollection;
 use Fschmtt\Keycloak\Json\JsonDecoder;
 use Fschmtt\Keycloak\Json\JsonEncoder;
@@ -17,7 +18,7 @@ class Realms extends Resource
 {
     private const BASE_PATH = '/auth/admin/realms';
 
-    public function all(): array
+    public function all(): RealmCollection
     {
         /** @var Realm[] $realms */
         $realms = [];
@@ -33,7 +34,7 @@ public function all(): array
             $realms[] = Realm::from($realm);
         }
 
-        return $realms;
+        return new RealmCollection($realms);
     }
 
     public function get(string $realm): Realm

tests/Integration/Resource/RealmsTest.php

@@ -4,6 +4,7 @@
 
 namespace Fschmtt\Keycloak\Test\Integration\Resource;
 
+use Fschmtt\Keycloak\Collection\RealmCollection;
 use Fschmtt\Keycloak\Representation\Realm;
 use Fschmtt\Keycloak\Test\Integration\IntegrationTestBehaviour;
 use PHPUnit\Framework\TestCase;
@@ -16,9 +17,8 @@ public function testCanGetAllRealms(): void
     {
         $realms = $this->getKeycloak()->realms()->all();
 
-        foreach ($realms as $realm) {
-            static::assertInstanceOf(Realm::class, $realm);
-        }
+        static::assertInstanceOf(RealmCollection::class, $realms);
+        static::assertCount(1, $realms);
     }
 
     public function testCanGetRealm(): void