refactor: rename getIsConnectedViaSockets to isConnectedViaSockets for consistency and clarity

chore: update version to 0.3.0 in composer.json
docs: clarify message lifecycle and connection methods in documentation

Author: mwargan

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "mmedia/le-chat",
     "type": "library",
-    "version": "0.2.1",
+    "version": "0.3.0",
     "description": "Add chat functionality to your Laravel application.",
     "keywords": [
         "Michal",

docs/src/content/docs/broadcasting.md

@@ -123,7 +123,7 @@ $yourModel = YourModel::find($id);
 
 $yourModel->is_connected; // Returns true if connected to own private channel
 // OR
-$yourModel->getIsConnectedViaSockets(); // True if connected, otherwise false. If the connection could not be determined, it will return null.
+$yourModel->isConnectedViaSockets(); // True if connected, otherwise false. If the connection could not be determined, it will return null.
 ```
 
 The default channel is the private channel for the model as defined by the native Laravel `broadcastChannel()` method.
@@ -132,7 +132,7 @@ The default channel is the private channel for the model as defined by the nativ
 If you want to check for a specific channel, you can pass the channel name as an argument:
 
 ```php
-if ($yourModel->getIsConnectedViaSockets('your.channel.name', 'private')) {
+if ($yourModel->isConnectedViaSockets('your.channel.name', 'private')) {
     // The model is connected to the specified private channel
 } else {
     // The model is not connected to the specified channel

docs/src/content/docs/participants.md

@@ -28,7 +28,7 @@ $teacher->sendMessageTo($chatroom, 'Hi class!');
 ### The message lifecycle
 When you send a message, Le Chat will automatically create a chatroom if one doesn't already exist between only the participants and the sender.
 
-If you send a message to a single participant, Le Chat will create a chatroom with just those two participants (the sender and the recipient). If you add another participant to the chatroom, the next time you `sendMessageTo` the original participant and NOT an array of all the participants, Le Chat will create a new private chatroom with just the sender and the participant.
+If you send a message to a single participant, Le Chat will create a chatroom with just those two participants (the sender and the recipient). If you add another participant to the chatroom, the next time you call `sendMessageTo` with only the original participant and NOT an array of all the participants, Le Chat will create a new private chatroom with just the sender and the participant.
 
 ```php
 $firstMessage = $teacher->sendMessageTo($student, 'Hello!');

src/Models/ChatParticipant.php

@@ -121,7 +121,7 @@ public function scopeOfParticipant(
     protected function isConnected(): CastsAttribute
     {
         return CastsAttribute::make(
-            get: fn () => $this->getIsConnectedViaSockets(
+            get: fn () => $this->isConnectedViaSockets(
                 localId: 'participant_id',
                 channelName: $this->chatroom->broadcastChannel(),
                 type: 'presence'

src/Notifications/NewMessage.php

@@ -42,7 +42,7 @@ public function via(object $notifiable): array
         $connected = false;
 
         // Check if notifiable has ConnectsToBroadcast trait
-        if (method_exists($notifiable, 'getIsConnectedViaSockets')) {
+        if (method_exists($notifiable, 'isConnectedViaSockets')) {
             $connected = $notifiable->is_connected;
         } else {
             $connected = $this->participant->is_connected;

src/Traits/ConnectsToBroadcast.php

@@ -32,7 +32,7 @@ trait ConnectsToBroadcast
      * @throws \RuntimeException if the broadcast driver is not set or is not supported.
      * @throws \Exception if there is an error checking the participant connection status.
      */
-    public function getIsConnectedViaSockets(?string $channelName = null, string $type = 'private', ?string $localId = null): ?bool
+    public function isConnectedViaSockets(?string $channelName = null, string $type = 'private', ?string $localId = null): ?bool
     {
         if (! $channelName && $this instanceof HasBroadcastChannel) {
             $channelName = $this->broadcastChannel();
@@ -97,7 +97,7 @@ public function getIsConnectedViaSockets(?string $channelName = null, string $ty
     protected function isConnected(): CastsAttribute
     {
         return CastsAttribute::make(
-            get: fn () => $this->getIsConnectedViaSockets()
+            get: fn () => $this->isConnectedViaSockets()
         )->shouldCache();
     }
 }

usage.md

@@ -277,6 +277,8 @@ $users = User::whereHasUnreadMessages(7, true)->get(); // unread messages sent i
 $users = User::whereHasUnreadMessagesToday(true)->get(); // unread messages sent today, including system messages
 ```
 
+Le Chat will not consider deleted messages as unread, so if a message was deleted, it will not be counted as unread.
+
 #### Loading unread messages count
 You can load the unread messages count for a participant in a chatroom using the `loadUnreadMessagesCount` method. This will load the `unread_messages_count` attribute on the participant model.
 
@@ -355,10 +357,10 @@ $user->isConnectedToChatroomViaSockets($chatroom);
 $chatParticipant->is_connected;
 
 # OR, if using the trait (note, this will check the model-specific broadcasting channel, not the chatroom channel)
-$user->getIsConnectedViaSockets();
+$user->isConnectedViaSockets();
 ```
 
-If you want to use this feature for your own models, you can use the `ConnectsToBroadcast` trait, which will provide the `getIsConnectedViaSockets` method. This method will return true if the participant is connected to the chatroom via sockets, false if they are not, and null if the connection could not be determined (e.g. if the broadcast driver does not support it).
+If you want to use this feature for your own models, you can use the `ConnectsToBroadcast` trait, which will provide the `isConnectedViaSockets` method. This method will return true if the participant is connected to the chatroom via sockets, false if they are not, and null if the connection could not be determined (e.g. if the broadcast driver does not support it).
 
 Under the hood, it makes an API call to the websocket server to check if the participant is connected to the chatroom.
 
@@ -368,7 +370,7 @@ use Illuminate\Database\Eloquent\Casts\Attribute as CastsAttribute;
  protected function isConnected(): CastsAttribute
 {
     return CastsAttribute::make(
-        get: fn() => $this->getIsConnectedViaSockets()
+        get: fn() => $this->isConnectedViaSockets()
     )->shouldCache();
 }
 ```
@@ -377,7 +379,7 @@ This will check using the `broadcastChannel` of the model, if the user is curren
 
 If you want to check if the model is connected to a presence channel, you can pass the chatroom name and type as parameters to the method:
 ```php
-$chatParticipant->getIsConnectedViaSockets(
+$chatParticipant->isConnectedViaSockets(
     type: 'presence',
     channelName: $this->broadcastChannel(), // or any other chatroom name
     localId: 'id' // the local ID of the model, defaults to 'id'. This is the ID column on the model that will be used to check if the participant is connected to the chatroom - this is only relevant in presence channels. In private channels, we can only determine if the participant is connected or not, not which participant is connected.