Wraps User and Conversation clients in a factory (#278)

Author: dragonmantank

src/Client.php

@@ -39,7 +39,7 @@
 use Vonage\Client\Factory\FactoryInterface;
 use Vonage\Client\Factory\MapFactory;
 use Vonage\Client\Signature;
-use Vonage\Conversations\Collection as ConversationsCollection;
+use Vonage\Conversations\ClientFactory as ConversationsClientFactory;
 use Vonage\Conversion\ClientFactory as ConversionClientFactory;
 use Vonage\Entity\EntityInterface;
 use Vonage\Insights\ClientFactory as InsightsClientFactory;
@@ -49,7 +49,6 @@
 use Vonage\Redact\ClientFactory as RedactClientFactory;
 use Vonage\Secrets\ClientFactory as SecretsClientFactory;
 use Vonage\SMS\ClientFactory as SMSClientFactory;
-use Vonage\User\Collection as UserCollection;
 use Vonage\Verify\ClientFactory as VerifyClientFactory;
 use Vonage\Verify\Verification;
 use Vonage\Voice\ClientFactory as VoiceClientFactory;
@@ -58,7 +57,6 @@
 use function array_merge;
 use function base64_encode;
 use function call_user_func_array;
-use function class_exists;
 use function get_class;
 use function http_build_query;
 use function implode;
@@ -73,6 +71,7 @@
 use function strpos;
 use function unserialize;
 use Vonage\Logger\LoggerTrait;
+use Vonage\User\ClientFactory as UserClientFactory;
 
 /**
  * Vonage API Client, allows access to the API from PHP.
@@ -88,6 +87,8 @@
  * @method SMS\Client sms()
  * @method Verify\Client  verify()
  * @method Voice\Client voice()
+ * @method User\Collection user()
+ * @method Conversation\Collection conversation()
  *
  * @property string restUrl
  * @property string apiUrl
@@ -204,8 +205,8 @@ public function __construct(CredentialsInterface $credentials, $options = [], ?C
                     // Legacy Namespaces
                     'message' => MessageClient::class,
                     'calls' => Collection::class,
-                    'conversation' => ConversationsCollection::class,
-                    'user' => UserCollection::class,
+                    'conversation' => ConversationsClientFactory::class,
+                    'user' => UserClientFactory::class,
 
                     // Registered Services by name
                     'account' => ClientFactory::class,

src/Conversations/ClientFactory.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Vonage\Conversations;
+
+use Vonage\Client\Factory\MapFactory;
+
+class ClientFactory
+{
+    public function __invoke(MapFactory $factory)
+    {
+        $collection = new Collection();
+        $collection->setClient($factory->getClient());
+
+        return $collection;
+    }
+}

src/User/ClientFactory.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Vonage\User;
+
+use Vonage\Client\Factory\MapFactory;
+
+class ClientFactory
+{
+    public function __invoke(MapFactory $factory)
+    {
+        $collection = new Collection();
+        $collection->setClient($factory->getClient());
+
+        return $collection;
+    }
+}

src/User/Collection.php

@@ -236,4 +236,79 @@ public function offsetUnset($offset): void
     {
         throw new RuntimeException('can not unset collection properties');
     }
+
+    /**
+     * Handle pagination automatically (unless configured not to).
+     */
+    public function valid(): bool
+    {
+        //can't be valid if there's not a page (rewind sets this)
+        if (!isset($this->page)) {
+            return false;
+        }
+
+        if (isset($this->page['_embedded'])) {
+            //all hal collections have an `_embedded` object, we expect there to be a property matching the collection name
+            if (!isset($this->page['_embedded'][static::getCollectionName()])) {
+                return false;
+            }
+
+            //if we have a page with no items, we've gone beyond the end of the collection
+            if (!count($this->page['_embedded'][static::getCollectionName()])) {
+                return false;
+            }
+
+            //index the start of a page at 0
+            if (is_null($this->current)) {
+                $this->current = 0;
+            }
+
+            //if our current index is past the current page, fetch the next page if possible and reset the index
+            if (!isset($this->page['_embedded'][static::getCollectionName()][$this->current])) {
+                if (isset($this->page['_links']['next'])) {
+                    $this->fetchPage($this->page['_links']['next']['href']);
+                    $this->current = 0;
+
+                    return true;
+                }
+
+                return false;
+            }
+        } else {
+            if (!isset($this->page)) {
+                return false;
+            }
+
+            //index the start of a page at 0
+            if (is_null($this->current)) {
+                $this->current = 0;
+            }
+
+            //if our current index is past the current page, fetch the next page if possible and reset the index
+            if (!isset($this->page[$this->current])) {
+                if (isset($this->page['_links']['next'])) {
+                    $this->fetchPage($this->page['_links']['next']['href']);
+                    $this->current = 0;
+
+                    return true;
+                }
+
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Return the current item, expects concrete collection to handle creating the object.
+     */
+    public function current(): User
+    {
+        if (isset($this->page['_embedded'])) {
+            return $this->hydrateEntity($this->page['_embedded'][static::getCollectionName()][$this->current], $this->key());
+        } else {
+            return $this->hydrateEntity($this->page[$this->current], $this->key());
+        }
+    }
 }