wip docblocks

src/PubSub/Drivers/LocalClient.php

@@ -73,6 +73,7 @@ class LocalClient implements ReplicationInterface
      * @param  string  $channel
      * @param  string  $socketId
      * @param  string  $data
+     * @return void
      */
     public function joinChannel(string $appId, string $channel, string $socketId, string $data)
     {
@@ -86,10 +87,12 @@ class LocalClient implements ReplicationInterface
      * @param  string  $appId
      * @param  string  $channel
      * @param  string  $socketId
+     * @return void
      */
     public function leaveChannel(string $appId, string $channel, string $socketId)
     {
         unset($this->channelData["$appId:$channel"][$socketId]);
+
         if (empty($this->channelData["$appId:$channel"])) {
             unset($this->channelData["$appId:$channel"]);
         }
@@ -106,7 +109,6 @@ class LocalClient implements ReplicationInterface
     {
         $members = $this->channelData["$appId:$channel"] ?? [];
 
-        // The data is expected as objects, so we need to JSON decode
         $members = array_map(function ($user) {
             return json_decode($user);
         }, $members);

src/PubSub/Drivers/RedisClient.php

@@ -79,6 +79,7 @@ class RedisClient implements ReplicationInterface
      *
      * @param  string  $redisChannel
      * @param  string  $payload
+     * @return void
      */
     protected function onMessage(string $redisChannel, string $payload)
     {
@@ -192,6 +193,7 @@ class RedisClient implements ReplicationInterface
      * @param  string  $channel
      * @param  string  $socketId
      * @param  string  $data
+     * @return void
      */
     public function joinChannel(string $appId, string $channel, string $socketId, string $data)
     {
@@ -205,6 +207,7 @@ class RedisClient implements ReplicationInterface
      * @param  string  $appId
      * @param  string  $channel
      * @param  string  $socketId
+     * @return void
      */
     public function leaveChannel(string $appId, string $channel, string $socketId)
     {

src/PubSub/ReplicationInterface.php

@@ -52,6 +52,7 @@ interface ReplicationInterface
      * @param  string  $channel
      * @param  string  $socketId
      * @param  string  $data
+     * @return void
      */
     public function joinChannel(string $appId, string $channel, string $socketId, string $data);
 
@@ -62,6 +63,7 @@ interface ReplicationInterface
      * @param  string  $appId
      * @param  string  $channel
      * @param  string  $socketId
+     * @return void
      */
     public function leaveChannel(string $appId, string $channel, string $socketId);
 

src/WebSockets/Channels/Channel.php

@@ -67,20 +67,18 @@ class Channel
     {
         $this->saveConnection($connection);
 
-        // Subscribe to broadcasted messages from the pub/sub backend
-        $this->replicator->subscribe($connection->app->id, $this->channelName);
-
         $connection->send(json_encode([
             'event' => 'pusher_internal:subscription_succeeded',
             'channel' => $this->channelName,
         ]));
+
+        $this->replicator->subscribe($connection->app->id, $this->channelName);
     }
 
     public function unsubscribe(ConnectionInterface $connection)
     {
         unset($this->subscribedConnections[$connection->socketId]);
 
-        // Unsubscribe from the pub/sub backend
         $this->replicator->unsubscribe($connection->app->id, $this->channelName);
 
         if (! $this->hasConnections()) {

src/WebSockets/Channels/PresenceChannel.php

@@ -22,22 +22,24 @@ class PresenceChannel extends Channel
     protected $users = [];
 
     /**
+     * Get the members in the presence channel.
+     *
      * @param  string  $appId
      * @return PromiseInterface
      */
     public function getUsers(string $appId)
     {
-        // Get the members list from the replication backend
+        return $this->replicator->channelMembers($appId, $this->channelName);
-        return $this->replicator
-            ->channelMembers($appId, $this->channelName);
     }
 
     /**
-     * @link https://pusher.com/docs/pusher_protocol#presence-channel-events
+     * Subscribe the connection to the channel.
      *
      * @param  ConnectionInterface  $connection
      * @param  stdClass  $payload
+     * @return void
      * @throws InvalidSignature
+     * @see     https://pusher.com/docs/pusher_protocol#presence-channel-events
      */
     public function subscribe(ConnectionInterface $connection, stdClass $payload)
     {
@@ -49,8 +51,7 @@ class PresenceChannel extends Channel
         $this->users[$connection->socketId] = $channelData;
 
         // Add the connection as a member of the channel
-        $this->replicator
+        $this->replicator->joinChannel(
-            ->joinChannel(
             $connection->app->id,
             $this->channelName,
             $connection->socketId,
@@ -62,7 +63,6 @@ class PresenceChannel extends Channel
         $this->replicator
             ->channelMembers($connection->app->id, $this->channelName)
             ->then(function ($users) use ($connection) {
-                // Send the success event
                 $connection->send(json_encode([
                     'event' => 'pusher_internal:subscription_succeeded',
                     'channel' => $this->channelName,
@@ -77,6 +77,12 @@ class PresenceChannel extends Channel
         ]);
     }
 
+    /**
+     * Unsubscribe the connection from the Presence channel.
+     *
+     * @param  ConnectionInterface  $connection
+     * @return void
+     */
     public function unsubscribe(ConnectionInterface $connection)
     {
         parent::unsubscribe($connection);
@@ -105,6 +111,8 @@ class PresenceChannel extends Channel
     }
 
     /**
+     * Get the Presence Channel to array.
+     *
      * @param  string|null  $appId
      * @return PromiseInterface
      */
@@ -119,6 +127,12 @@ class PresenceChannel extends Channel
             });
     }
 
+    /**
+     * Get the Presence channel data.
+     *
+     * @param  array  $users
+     * @return array
+     */
     protected function getChannelData(array $users): array
     {
         return [
@@ -130,6 +144,12 @@ class PresenceChannel extends Channel
         ];
     }
 
+    /**
+     * Get the Presence Channel's users.
+     *
+     * @param  array  $users
+     * @return array
+     */
     protected function getUserIds(array $users): array
     {
         $userIds = array_map(function ($channelData) {