Chat

https://github.com/musonza/chat
Admin
A Laravel package that allows you to add a chat system to your application, enabling multiple models...
Tokens:64,422
Snippets:672
Trust Score:8.4
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Development Setup Commands

Source: https://github.com/musonza/chat/blob/master/CONTRIBUTING.md

Run these commands in order to set up the development environment: install dependencies, run the test suite, run static analysis, and fix code style.

```bash
composer install
```

```bash
composer test
```

```bash
composer analyse
```

```bash
composer format
```

--------------------------------

### Usage examples of get() with filters

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Shows multiple usage examples of the get() method with various filters: participant, private, direct, name, archived, and withArchived.

```php
Chat::conversations()->setParticipant($user)->get();
Chat::conversations()->setParticipant($user)->isPrivate()->get();       // private only
Chat::conversations()->setParticipant($user)->isDirect()->get();        // DMs
Chat::conversations()->isPrivate(false)->name('announcements')->get();  // public discovery
Chat::conversations()->setParticipant($user)->archived()->get();        // archive inbox
Chat::conversations()->setParticipant($user)->withArchived()->get();    // all incl. archived
```

--------------------------------

### makeDirect usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation.md

Usage example for makeDirect, creating a direct conversation.

```php
$dm = Chat::createConversation($participants)->makeDirect();
```

--------------------------------

### delete usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Usage example for delete. Requires setParticipant().

```php
Chat::message($message)->setParticipant($user)->delete();
```

--------------------------------

### Install musonza/chat via Composer

Source: https://github.com/musonza/chat/blob/master/README.md

Run this command in the terminal to install the package using Composer.

```bash
composer require musonza/chat
```

--------------------------------

### reactionsSummary() usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Gets the reaction summary for a message.

```php
$summary = Chat::message($message)->reactionsSummary();
```

--------------------------------

### Chat facade usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/chat.md

Usage example of the `Chat` facade. Every static-looking call in the package's documentation is actually an instance method called through the facade.

```php
use Chat;

$conversation = Chat::createConversation([$user, $bot]);
```

--------------------------------

### start() method signature

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Method signature for start(). Called by Chat::createConversation() and dispatches the ConversationStarted event after creation.

```php
public function start(array $payload)
```

--------------------------------

### markRead usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Usage example for markRead. Requires setParticipant().

```php
Chat::message($message)->setParticipant($user)->markRead();
```

--------------------------------

### makePrivate usage examples

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation.md

Usage examples for makePrivate, showing how to create a private or public conversation.

```php
$private = Chat::createConversation($participants)->makePrivate();    // private
$public  = Chat::createConversation($participants)->makePrivate(false); // public
```

--------------------------------

### send() usage examples

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Shows basic usage, custom type and data, and error handling when from() is missing. The error example catches the exception with message 'Message sender has not been set'.

```php
// Basic
$message = Chat::message('Hello')
    ->from($user)
    ->to($conversation)
    ->send();

// Custom type + data + type chaining
$message = Chat::message('Attachment 1')
    ->type('attachment')
    ->data(['file_name' => 'post_image.jpg', 'file_url' => 'http://example.com/img.jpg'])
    ->from($user)
    ->to($conversation)
    ->send();

// Error handling
try {
    Chat::message('Hello')->to($conversation)->send(); // missing ->from()
} catch (Exception $e) {
    // $e->getMessage() === 'Message sender has not been set'
}
```

--------------------------------

### archive and unarchive usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation.md

Usage example showing how to archive and unarchive a conversation for a user.

```php
$conversation->archive($user);
$conversation->unarchive($user);
```

--------------------------------

### start(array $payload)

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Start a new conversation with participants and optional data.

```APIDOC
## POST /conversations

### Description
Create a new conversation and dispatch the ConversationStarted event.

### Method
POST

### Endpoint
/start

### Parameters
#### Request Body
- **participants** (array of Models) - Required - Array of participant models.
- **data** (array) - Optional - Additional data.
- **direct_message** (bool) - Optional - Whether this is a direct message.
- **name** (string|null) - Optional - Conversation name.

### Request Example
{
  "participants": ["..."],
  "data": {},
  "direct_message": false,
  "name": null
}

### Response
#### Success Response (200)
- **conversation** (Conversation) - The created conversation.

#### Response Example
{
  "id": 1,
  "name": null,
  "direct_message": false
}

### Error Handling
- `InvalidDirectMessageNumberOfParticipants` - Thrown when direct_message is true and participant count is invalid.
- `DirectMessagingExistsException` - Thrown when a direct message already exists between participants.

```

--------------------------------

### setPaginationParams usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/traits.md

Usage example for setPaginationParams. Chains setPaginationParams with setParticipant and get on the conversations service.

```php
Chat::conversations()->setPaginationParams([
    'page'     => 3,
    'perPage'  => 10,
    'sorting'  => 'desc',
    'columns'  => ['*'],
    'pageName' => 'test',
])->setParticipant($user)->get();
```

--------------------------------

### start

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation.md

Creates a conversation with validation and adds participants.

```APIDOC
## start

### Description
Creates a conversation with validation and adds participants.

### Method
start

### Signature
`public function start(array $payload): self`

### Parameters
- **payload** (array) - Required - Keys: `participants` (array), `data` (array), `direct_message` (bool), `name` (string|null)

### Validation
- If `direct_message` is truthy and more than 2 participants: throws `InvalidDirectMessageNumberOfParticipants`.
- If `direct_message`: `ensureNoDirectMessagingExist($participants)` throws `DirectMessagingExistsException` when a direct conversation already exists between participants[0] and participants[1].

### Behavior
Creates the conversation row (`direct_message` stored as bool, `name` stored when provided), then adds participants.

### Throws
- `InvalidDirectMessageNumberOfParticipants`
- `DirectMessagingExistsException`

### Returns
`$this` (the created conversation).
```

--------------------------------

### toggleFlag and flagged usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Usage example for toggleFlag and flagged. Requires setParticipant().

```php
Chat::message($message)->setParticipant($user)->toggleFlag();
$isFlagged = Chat::message($message)->setParticipant($user)->flagged();
```

--------------------------------

### unreadCount usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Usage example for unreadCount. Requires setParticipant().

```php
$totalUnread = Chat::messages()->setParticipant($user)->unreadCount();
```

--------------------------------

### Usage example for conversationPartners

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/traits.md

Usage example for conversationPartners, retrieving unique partner models for a user, excluding the user itself.

```php
$partners = $user->conversationPartners(); // unique models, user excluded

```

--------------------------------

### start method signature

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation.md

Signature for the start method, which creates a conversation with validation for direct messages.

```php
public function start(array $payload): self
```

--------------------------------

### getMessages() usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Usage example for getMessages(). Shows chaining setParticipant(), setPaginationParams(), optional ofType(), and getMessages().

```php
$messages = Chat::conversation($conversation)
    ->setParticipant($user)
    ->setPaginationParams(['perPage' => 10, 'sorting' => 'desc'])
    ->ofType('image')          // optional type filter
    ->getMessages();
```

--------------------------------

### getMessagesWithCursor() usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Usage example for getMessagesWithCursor(). Shows fetching the first page, encoding the next cursor, and fetching the second page with the cursor.

```php
$firstPage = Chat::conversation($conversation)
    ->setParticipant($user)
    ->setCursorPaginationParams(['perPage' => 25, 'sorting' => 'asc'])
    ->getMessagesWithCursor();

$nextCursor = $firstPage->nextCursor()?->encode();
$secondPage = Chat::conversation($conversation)
    ->setParticipant($user)
    ->setCursorPaginationParams(['perPage' => 25, 'sorting' => 'asc', 'cursor' => $nextCursor])
    ->getMessagesWithCursor();
```

--------------------------------

### Participation usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/participation-models.md

Shows how to archive a participation, check its archived status, and update its settings.

```php
$participation = Chat::conversation($conversation)->getParticipation($user);
$participation->archive();
$participation->isArchived(); // true
$participation->update(['settings' => ['mute_conversation' => true]]);
```

--------------------------------

### setCursorPaginationParams usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/traits.md

Usage example for setCursorPaginationParams. Chains setParticipant, setCursorPaginationParams, and getMessagesWithCursor on a conversation.

```php
Chat::conversation($conversation)
    ->setParticipant($user)
    ->setCursorPaginationParams(['perPage' => 25, 'sorting' => 'asc', 'cursor' => $nextCursor])
    ->getMessagesWithCursor();
```

--------------------------------

### Reaction usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/participation-models.md

Shows how to create a reaction using the react method and how to query reactions directly using the ofType scope.

```php
$reaction = $message->react($user, 'like');

// or query reactions directly
$likes = Reaction::where('message_id', $message->id)->ofType('like')->get();
```

--------------------------------

### Create a conversation

Source: https://github.com/musonza/chat/blob/master/README.md

Starts a conversation by passing an array of models as participants.

```php
$participants = [$model1, $model2,..., $modelN];

$conversation = Chat::createConversation($participants);
```

--------------------------------

### toggleReaction() usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Shows the result array shape for adding and removing a reaction.

```php
$result = Chat::message($message)->setParticipant($user)->toggleReaction('👍');
// $result === ['added' => true,  'reaction' => Reaction]
// second call → ['added' => false, 'reaction' => null]
```

--------------------------------

### get method declaration

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Declares the get method, which lists conversations. Behavior depends on whether a participant is set.

```php
public function get()
```

--------------------------------

### react() usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Adds a reaction (e.g., emoji) to a message by a participant.

```php
Chat::message($message)->setParticipant($user)->react('👍');
```

--------------------------------

### Custom command and handler via CommandBus

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/commanding.md

Demonstrates how to create a custom command and handler following the XxxCommand / XxxCommandHandler naming convention, and execute it through the CommandBus. The handler must implement Musonza\Chat\Commanding\CommandHandler. The example shows a PingCommand that returns the uppercased text.

```php
// 1. command class
class PingCommand { public function __construct(public string $text) {} }

// 2. handler implementing Musonza\Chat\Commanding\CommandHandler
class PingCommandHandler implements CommandHandler
{
    public function handle($command) { return strtoupper($command->text); }
}

// 3. execution via the bus (container-resolved)
$bus = app(Musonza\Chat\Commanding\CommandBus::class);
$result = $bus->execute(new PingCommand('pong')); // 'PONG'
```

--------------------------------

### conversations method and usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/chat.md

Returns a ConversationService. Use to fetch a conversation by ID or list conversations for a participant.

```php
public function conversations()
```

```php
$conversation = Chat::conversations()->getById($id);
$list = Chat::conversations()->setParticipant($user)->get();
```

--------------------------------

### hasReacted() usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Checks for a specific reaction or any reaction.

```php
Chat::message($message)->setParticipant($user)->hasReacted('👍'); // specific
Chat::message($message)->setParticipant($user)->hasReacted();     // any reaction
```

--------------------------------

### ConversationTransformer example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/support.md

Example subclass of the abstract Transformer. Implements the transform method to return an array with id, name, and private fields from a conversation object.

```php
class ConversationTransformer extends Musonza\Chat\Transformers\Transformer
{
    public function transform($conversation)
    {
        return [
            'id'      => $conversation->id,
            'name'    => $conversation->name,
            'private' => $conversation->private,
        ];
    }
}
```

--------------------------------

### Message Reactions - Get all reactions

Source: https://github.com/musonza/chat/blob/master/README.md

Retrieves all reactions on a message.

```php
$reactions = Chat::message($message)->reactions();
```

--------------------------------

### conversation method and usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/chat.md

Binds a specific conversation on the ConversationService and returns it. Use to retrieve messages for a given conversation.

```php
public function conversation(Conversation $conversation)
```

```php
$messages = Chat::conversation($conversation)->setParticipant($user)->getMessages();
```

--------------------------------

### makeDirect method and usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/chat.md

Flags the next createConversation() call as a direct message. Mutates ConversationService::$directMessage to true and returns $this for chaining.

```php
public function makeDirect()
```

```php
$dm = Chat::makeDirect()->createConversation([$user1, $user2]);
```

--------------------------------

### getParticipation usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Retrieves the participation for a user in a conversation and updates its settings, e.g., to mute mentions.

```php
$participation = Chat::conversation($conversation)->getParticipation($user);
$participation->update(['settings' => ['mute_mentions' => true]]);
```

--------------------------------

### messages method and usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/chat.md

Returns a MessageService bound to the injected instance. Use it to query unread counts or fetch messages by ID.

```php
public function messages()
```

```php
$unread = Chat::messages()->setParticipant($user)->unreadCount();
$byId   = Chat::messages()->getById($messageId);
```

--------------------------------

### message method and usage examples

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/chat.md

Sets the message body or an existing Message model and returns the MessageService. Accepts a raw body string or an existing Message model for mark read/delete/react/flag operations.

```php
public function message($message)
```

```php
// New message body string
Chat::message('Hello')->from($user)->to($conversation)->send();

// Existing message model: mark as read
Chat::message($message)->setParticipant($user)->markRead();
```

--------------------------------

### Usage example: sending a message creates notifications automatically

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/participation-models.md

Shows typical usage where notifications are created automatically by the Chat facade when sending a message, so you don't build them manually.

```php
// Usually you do not build notifications yourself:
$message = Chat::message('Hi')->from($user)->to($conversation)->send();
// ...created a MessageNotification row for every participant automatically
```

--------------------------------

### Get a message by id

Source: https://github.com/musonza/chat/blob/master/README.md

Retrieves a message instance using its ID.

```php
$message = Chat::messages()->getById($id);
```

--------------------------------

### Message Reactions - Summary

Source: https://github.com/musonza/chat/blob/master/README.md

Gets a summary of reactions with counts. Returns an associative array mapping reaction to count.

```php
$summary = Chat::message($message)->reactionsSummary();
// ['👍' => 5, '❤️' => 3, '😂' => 1]
```

--------------------------------

### ConversationController show method signature

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Method signature for the show action that retrieves a single conversation by ID. It is mapped to GET /chat/conversations/{id} and returns a Response.

```php
public function show($id)
```

--------------------------------

### Custom getParticipantDetailsAttribute accessor

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/traits.md

Custom accessor example for getParticipantDetailsAttribute, as documented in the README, to override the default participant details.

```php
public function getParticipantDetailsAttribute()
{
    return ['name' => $this->someValue, 'foo' => 'bar'];
}

```

--------------------------------

### ChatServiceProvider boot method

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/support.md

Boot method that publishes migrations and config, and conditionally loads routes when the 'musonza_chat.should_load_routes' config is true.

```php
public function boot()
{
    $this->publishMigrations();
    $this->publishConfig();

    if (config('musonza_chat.should_load_routes')) {
        require __DIR__ . '/Http/routes.php';
    }
}
```

--------------------------------

### indexWithCursor method signature for ConversationMessageController

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Handles GET /chat/conversations/{id}/messages-cursor. Uses getCursorPaginationParams() and getMessagesWithCursor(). Returns a CursorPaginator with next_cursor and prev_cursor when serialized.

```php
public function indexWithCursor(GetParticipantMessagesWithCursor $request, $conversationId)
```

--------------------------------

### Run database migrations

Source: https://github.com/musonza/chat/blob/master/README.md

Executes the published migrations to create the necessary database tables.

```bash
php artisan migrate
```

--------------------------------

### Get messages with cursor pagination

Source: https://github.com/musonza/chat/blob/master/README.md

Uses cursor-based pagination for real-time chat to prevent duplicate messages. First page retrieves messages with perPage and sorting; subsequent pages pass the cursor from the previous response's next_cursor.

```php
// Get first page
$messages = Chat::conversation($conversation)
    ->setParticipant($participantModel)
    ->setCursorPaginationParams([
        'perPage' => 25,
        'sorting' => 'asc',
    ])
    ->getMessagesWithCursor();

// Get next page using cursor from previous response
$nextCursor = $messages->nextCursor()?->encode();

$moreMessages = Chat::conversation($conversation)
    ->setParticipant($participantModel)
    ->setCursorPaginationParams([
        'perPage' => 25,
        'sorting' => 'asc',
        'cursor' => $nextCursor,
    ])
    ->getMessagesWithCursor();
```

--------------------------------

### index method signature for ConversationMessageController

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Handles GET /chat/conversations/{id}/messages. Uses the participant from $request->getParticipant() and pagination params from $request->getPaginationParams(), returning Chat::conversation($conversation)->setParticipant(...)->setPaginationParams(...)->getMessages(). Returns a LengthAwarePaginator, transformed if a message transformer is set, otherwise raw response($messages).

```php
public function index(GetParticipantMessages $request, $conversationId)
```

--------------------------------

### Get all conversation partners for a user

Source: https://github.com/musonza/chat/blob/master/README.md

Retrieves a collection of unique models that the user has ever conversed with, excluding the user themselves. Duplicate partners across multiple conversations are included only once.

```php
// Get all models that a user has ever conversed with
$partners = $user->conversationPartners();
```

--------------------------------

### unReadNotifications method and usage example

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/chat.md

Reads the participant previously set via setParticipant() and returns their unread MessageNotification rows. Requires setParticipant() to have been called first; otherwise $this->participant is null and the query matches nothing.

```php
public function unReadNotifications()
```

```php
$unreadNotifications = Chat::setParticipant($user)->unReadNotifications();
```

--------------------------------

### Run Static Analysis with composer analyse

Source: https://github.com/musonza/chat/blob/master/CONTRIBUTING.md

Run PHPStan static analysis using Composer.

```bash
composer analyse
```

--------------------------------

### Run Tests with composer test

Source: https://github.com/musonza/chat/blob/master/CONTRIBUTING.md

Run the test suite using Composer.

```bash
composer test
```

--------------------------------

### show method signature for ConversationMessageController

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Handles GET /chat/conversations/{id}/messages/{message_id}. Calls Chat::messages()->getById($messageId) and returns a Response with the single message. Throws ModelNotFoundException (404) for unknown ids because getById uses findOrFail.

```php
public function show(GetParticipantMessages $request, $conversationId, $messageId)
```

--------------------------------

### Publish command

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/support.md

Command to publish the package's migrations and config.

```bash
php artisan vendor:publish --provider="Musonza\Chat\ChatServiceProvider"
```

--------------------------------

### GET /conversations

Source: https://github.com/musonza/chat/blob/master/_autodocs/endpoints.md

Retrieves all conversations.

```APIDOC
## GET /conversations

### Description
Retrieves all conversations.

### Method
GET

### Endpoint
/conversations

### Parameters
#### Query Parameters
None.

### Response
#### Success Response (200)
- **conversations** (array) - All conversations, either as a raw response or a Fractal collection when a transformer is configured.

#### Response Example
```json
[
  {
    "id": 1,
    "data": {}
  }
]
```
```

--------------------------------

### reactionsSummary() method signature

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Signature for retrieving a summary of reactions with counts.

```php
public function reactionsSummary()
```

--------------------------------

### GET /conversations/{id}/participants

Source: https://github.com/musonza/chat/blob/master/_autodocs/endpoints.md

Retrieves the participants of a conversation.

```APIDOC
## GET /conversations/{id}/participants

### Description
Retrieves the participants of a conversation.

### Method
GET

### Endpoint
/conversations/{id}/participants

### Parameters
#### Path Parameters
- **id** (string) - Required - The conversation ID.

### Response
#### Success Response (200)
- Returns an array of participant models.

#### Response Example
```json
[
  {
    "id": 1,
    "conversation_id": 1,
    "messageable_id": 1,
    "messageable_type": "App\\Models\\User",
    "settings": null,
    "created_at": "2023-01-01T00:00:00.000000Z",
    "updated_at": "2023-01-01T00:00:00.000000Z"
  }
]
```
```

--------------------------------

### GET /conversations/{id}

Source: https://github.com/musonza/chat/blob/master/_autodocs/endpoints.md

Retrieves a single conversation by its ID.

```APIDOC
## GET /conversations/{id}

### Description
Retrieves a single conversation by its ID.

### Method
GET

### Endpoint
/conversations/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The conversation ID.

### Response
#### Success Response (200)
- **conversation** (object) - The requested conversation, either as a raw response or a transformed item.

#### Response Example
```json
{
  "id": 1,
  "data": {}
}
```

#### Error Response (404)
- **message** (string) - Not found.
```

--------------------------------

### GET /chat/conversations/{id}/participants

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Retrieves all participants of a conversation.

```APIDOC
## GET /chat/conversations/{id}/participants

### Description
Retrieves all participants of a conversation.

### Method
GET

### Endpoint
/chat/conversations/{id}/participants

### Parameters
#### Path Parameters
- **id** (integer) - Required - The conversation ID.

### Response
#### Success Response (200)
- **data** (array) - List of participant models.

#### Response Example
{
  "data": [
    {
      "id": 1,
      "type": "App\\Models\\User"
    }
  ]
}
```

--------------------------------

### GET /chat/conversations/{id}

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Retrieves a single conversation by its ID.

```APIDOC
## GET /chat/conversations/{id}

### Description
Retrieves a single conversation by its ID.

### Method
GET

### Endpoint
/chat/conversations/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The conversation ID

### Response
#### Success Response (200)
- **conversation** (object) - The requested conversation

#### Response Example
```json
{
  "id": 1,
  "data": {}
}
```
```

--------------------------------

### Common entry call shapes with Chat facade

Source: https://github.com/musonza/chat/blob/master/_autodocs/README.md

Shows the typical fluent interface for creating a conversation via Chat::createConversation, sending a message via Chat::message()->from()->to()->send(), querying participant conversations via Chat::conversations()->setParticipant(), and marking messages read, deleted, or reacted via Chat::message()->setParticipant(). Each method returns the indicated model or paginator and signatures are per-class.

```php
use Musonza\Chat\Traits\Messageable;

class User extends Model { use Messageable; }

// Create a conversation (returns Models\Conversation)
$conversation = Chat::createConversation([$user1, $user2], ['title' => 'x'], 'general');

// Send a message (returns Models\Message)
$message = Chat::message('Hello')->from($user1)->to($conversation)->send();

// Query conversations for a participant (returns LengthAwarePaginator)
$page = Chat::conversations()->setParticipant($user1)->limit(25)->page(1)->get();

// Mark message read / delete / react
Chat::message($message)->setParticipant($user1)->markRead();
Chat::message($message)->setParticipant($user1)->delete();
Chat::message($message)->setParticipant($user1)->react('👍');
```

--------------------------------

### Get a conversation between two participants

Source: https://github.com/musonza/chat/blob/master/README.md

Finds a conversation between two participants.

```php
$conversation = Chat::conversations()->between($participantModel1, $participantModel2);
```

--------------------------------

### Fix Code Style with composer format

Source: https://github.com/musonza/chat/blob/master/CONTRIBUTING.md

Run Laravel Pint to fix code style using Composer.

```bash
composer format
```

--------------------------------

### Get a conversation by id

Source: https://github.com/musonza/chat/blob/master/README.md

Retrieves a conversation instance using its ID.

```php
$conversation = Chat::conversations()->getById($id);
```

--------------------------------

### Create private, public, and direct conversations

Source: https://github.com/musonza/chat/blob/master/README.md

Shows how to create private, public, and direct conversations. Direct conversations cannot have additional participants added or removed.

```php
$participants = [$model1, $model2,..., $modelN];

// Create a private conversation
$conversation = Chat::createConversation($participants)->makePrivate();

// Create a public conversation
$conversation = Chat::createConversation($participants)->makePrivate(false);

// Create a direct message

// Make direct conversation after creation
$conversation = Chat::createConversation($participants)->makeDirect();

// Specify intent for direct conversation before creation
$conversation = Chat::makeDirect()->createConversation($participants);
```

--------------------------------

### getById($id)

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Get a conversation by its ID. Returns null if not found.

```APIDOC
## GET /conversations/{id}

### Description
Retrieve a conversation by its primary key.

### Method
GET

### Endpoint
/{id}

### Parameters
#### Path Parameters
- **id** (mixed) - Required - Primary key of the conversation.

### Response
#### Success Response (200)
- **conversation** (Conversation|null) - The conversation if found, otherwise null.

#### Response Example
{
  "id": 1,
  "name": "Test"
}

```

--------------------------------

### GET /conversations/{id}/participants/{participation_id}

Source: https://github.com/musonza/chat/blob/master/_autodocs/endpoints.md

Retrieves a specific participation by its ID.

```APIDOC
## GET /conversations/{id}/participants/{participation_id}

### Description
Retrieves a specific participation by its ID.

### Method
GET

### Endpoint
/conversations/{id}/participants/{participation_id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The conversation ID.
- **participation_id** (string) - Required - The participation ID.

### Response
#### Success Response (200)
- Returns the `Participation` model. If the ID is unknown, the response body is null.

#### Response Example
```json
{
  "id": 1,
  "conversation_id": 1,
  "messageable_id": 1,
  "messageable_type": "App\\Models\\User",
  "settings": null,
  "created_at": "2023-01-01T00:00:00.000000Z",
  "updated_at": "2023-01-01T00:00:00.000000Z"
}
```
```

--------------------------------

### GET /chat/conversations

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Retrieves all conversations. Responses are transformed when a conversation transformer is configured.

```APIDOC
## GET /chat/conversations

### Description
Retrieves all conversations. Responses are transformed when a conversation transformer is configured.

### Method
GET

### Endpoint
/chat/conversations

### Response
#### Success Response (200)
- **conversations** (array) - List of conversation objects

#### Response Example
```json
{
  "data": []
}
```
```

--------------------------------

### send() method implementation

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Validates sender, body, and recipient, then executes SendMessageCommand. Throws exceptions with specific messages when prerequisites are not met.

```php
public function send()
{
    if (! $this->sender) {
        throw new Exception('Message sender has not been set');
    }

    if (strlen($this->body) === 0) {
        throw new Exception('Message body has not been set');
    }

    if (! $this->recipient) {
        throw new Exception('Message receiver has not been set');
    }

    $command = new SendMessageCommand($this->recipient, $this->body, $this->sender, $this->type, $this->data);

    return $this->commandBus->execute($command);
}
```

--------------------------------

### Get message sender

Source: https://github.com/musonza/chat/blob/master/README.md

Accesses the sender model of a message via the `sender` property.

```php
$sendModel = $message->sender;
```

--------------------------------

### GET /chat/conversations/{id}/participants/{participation_id}

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Retrieves a single participation record by its ID.

```APIDOC
## GET /chat/conversations/{id}/participants/{participation_id}

### Description
Retrieves a single participation record by its ID.

### Method
GET

### Endpoint
/chat/conversations/{id}/participants/{participation_id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The conversation ID.
- **participation_id** (integer) - Required - The participation record ID.

### Response
#### Success Response (200)
- **data** (object) - The participation row.

#### Response Example
{
  "data": {
    "id": 1,
    "conversation_id": 1,
    "participant_id": 1,
    "participant_type": "App\\Models\\User"
  }
}
```

--------------------------------

### react() method signature

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Signature for adding a reaction to the bound message. Requires setParticipant().

```php
public function react(string $reaction): Reaction
```

--------------------------------

### ConfigurationManager class with table constants and pagination defaults

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/support.md

Defines the ConfigurationManager class containing table name constants and a static method to return pagination defaults with fallback values from configuration.

```php
class ConfigurationManager
{
    const CONVERSATIONS_TABLE = 'chat_conversations';
    const MESSAGES_TABLE = 'chat_messages';
    const MESSAGE_NOTIFICATIONS_TABLE = 'chat_message_notifications';
    const PARTICIPATION_TABLE = 'chat_participation';
    const REACTIONS_TABLE = 'chat_message_reactions';

    public static function paginationDefaultParameters()
    {
        $pagination = config('musonza_chat.pagination', []);

        return [
            'page'     => $pagination['page']     ?? 1,
            'perPage'  => $pagination['perPage']  ?? 25,
            'sorting'  => $pagination['sorting']  ?? 'asc',
            'columns'  => $pagination['columns']  ?? ['*'],
            'pageName' => $pagination['pageName'] ?? 'page',
        ];
    }
}
```

--------------------------------

### GET /conversations/{id}/messages/{message_id}

Source: https://github.com/musonza/chat/blob/master/_autodocs/endpoints.md

Retrieves a single message by its ID within a conversation.

```APIDOC
## GET /conversations/{id}/messages/{message_id}

### Description
Retrieves a single message by its ID within a conversation.

### Method
GET

### Endpoint
/conversations/{id}/messages/{message_id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The conversation ID.
- **message_id** (integer) - Required - The message ID.

### Response
#### Success Response (200)
- **message** (object) - The message object.

#### Response Example
{
  "id": 1,
  "body": "Hello",
  "sender": { "id": 1, "name": "John" }
}

### Error Handling
- **404** - Message not found.
```

--------------------------------

### SendMessageCommandHandler constructor

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/commanding.md

Shows the constructor signature of the SendMessageCommandHandler, which receives an EventDispatcher and a Message instance. The handler is part of the Musonza\Chat\Messages namespace.

```php
class SendMessageCommandHandler
{
    protected $message;
    protected $dispatcher;

    public function __construct(EventDispatcher $dispatcher, Message $message)
```

--------------------------------

### Get participants in a conversation

Source: https://github.com/musonza/chat/blob/master/README.md

Retrieves the participants of a conversation using the getParticipants() method on a conversation instance.

```php
$participants = $conversation->getParticipants();
```

--------------------------------

### reactionsSummary()

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Returns a summary of reactions keyed by reaction value with counts.

```APIDOC
## reactionsSummary()

### Description
Returns a summary of reactions keyed by reaction value with counts.

### Returns
`Illuminate\Support\Collection` keyed by reaction value with counts (e.g. `['👍' => 5, '❤️' => 3]`).

### Usage Example

```php
$summary = Chat::message($message)->reactionsSummary();
```
```

--------------------------------

### Usage of unreadCount

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Shows usage of unreadCount to get the count of unread messages for a participant in a conversation.

```php
$count = Chat::conversation($conversation)->setParticipant($user)->unreadCount();
```

--------------------------------

### PUT /conversations/{id}/participants/{participation_id}

Source: https://github.com/musonza/chat/blob/master/_autodocs/endpoints.md

Updates a participation, for example to mute mentions. Validated by `UpdateParticipation`.

```APIDOC
## PUT /conversations/{id}/participants/{participation_id}

### Description
Updates a participation, for example to mute mentions. Validated by `UpdateParticipation`.

### Method
PUT

### Endpoint
/conversations/{id}/participants/{participation_id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The conversation ID.
- **participation_id** (string) - Required - The participation ID.

#### Request Body
- **settings** (array) - Optional - Settings to update.

### Request Example
```json
{
  "settings": {
    "mute_mentions": true
  }
}
```

### Response
#### Success Response (200)
- Returns the updated participation.

#### Response Example
```json
{
  "id": 1,
  "conversation_id": 1,
  "messageable_id": 1,
  "messageable_type": "App\\Models\\User",
  "settings": {
    "mute_mentions": true
  },
  "created_at": "2023-01-01T00:00:00.000000Z",
  "updated_at": "2023-01-01T00:00:00.000000Z"
}
```

### Error Handling
- **403** - If the participation's `conversation_id` does not match the URL conversation.
```

--------------------------------

### Route registration group in routes.php

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Registers the chat API routes under a configurable prefix and middleware group. The prefix and middleware come from the 'musonza_chat.routes.path_prefix' and 'musonza_chat.routes.middleware' config keys, with defaults 'chat' and ['web'] respectively.

```php
$chatRoutesPrefix = config('musonza_chat.routes.path_prefix');
$middleware       = config('musonza_chat.routes.middleware');

Route::group([
    'middleware' => $middleware,
    'namespace'  => 'Musonza\Chat\Http\Controllers',
    'prefix'     => $chatRoutesPrefix,
], function () {
```

--------------------------------

### Get participant conversations

Source: https://github.com/musonza/chat/blob/master/README.md

Retrieves conversations for a participant with pagination parameters. Supports sorting, limit, and page.

```php
Chat::conversations()->setPaginationParams(['sorting' => 'desc'])
	->setParticipant($participantModel)
	->limit(1)
	->page(1)
	->get();
```

--------------------------------

### CommandBus constructor

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/commanding.md

Constructor signature for the CommandBus class, which takes an Application instance and a CommandTranslator. The class is part of the Musonza\Chat\Commanding namespace.

```php
class CommandBus
{
    private $app;

    protected $commandTranslator;

    public function __construct(Application $app, CommandTranslator $commandTranslator)
```

--------------------------------

### GET /conversations/{id}/messages

Source: https://github.com/musonza/chat/blob/master/_autodocs/endpoints.md

Retrieves a paginated list of messages for a conversation, with optional sorting and pagination.

```APIDOC
## GET /conversations/{id}/messages

### Description
Retrieves a paginated list of messages for a conversation, with optional sorting and pagination.

### Method
GET

### Endpoint
/conversations/{id}/messages

### Parameters
#### Path Parameters
- **id** (integer) - Required - The conversation ID.

#### Query Parameters
- **participant_id** (mixed) - Required - The participant ID.
- **participant_type** (string) - Required - The participant model class.
- **page** (integer) - Optional - Page number (default: 1).
- **perPage** (integer) - Optional - Items per page (default: 25).
- **sorting** (string) - Optional - Sort order: asc or desc (default: asc).
- **columns** (array) - Optional - Columns to select (default: ['*']).
- **pageName** (string) - Optional - Query parameter name for page (default: 'page').

### Response
#### Success Response (200)
- **data** (array) - List of messages. Each message includes `read_at`, `deleted_at`, `messageable_id`, `notification_id`, `is_seen`, `is_sender`, and `sender` attribute.
- **pagination** (object) - LengthAwarePaginator metadata (current_page, last_page, total, etc.).

#### Response Example
{
  "data": [
    {
      "id": 1,
      "body": "Hello",
      "read_at": "2023-01-01T00:00:00.000000Z",
      "deleted_at": null,
      "messageable_id": 1,
      "notification_id": 1,
      "is_seen": false,
      "is_sender": true,
      "sender": { "id": 1, "name": "John" }
    }
  ],
  "current_page": 1,
  "last_page": 1,
  "total": 1
}
```

--------------------------------

### Usage of between with null check

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Shows how to use the between method to find a direct conversation between two participants and handle the case when none exists.

```php
$conversation = Chat::conversations()->between($alpha, $beta);
if ($conversation === null) {
    // no 1-to-1 conversation between alpha and beta yet
}
```

--------------------------------

### Chat constructor with injected services

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/chat.md

Constructor signature for the Chat class. Dependencies are injected by the container; no direct construction is needed in consumer code.

```php
public function __construct(
    MessageService $messageService,
    ConversationService $conversationService,
    MessageNotification $messageNotification
)
```

--------------------------------

### Bind Chat class

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/support.md

Binds the Chat class to the container.

```php
$this->app->bind('\Musonza\Chat\Chat', function () {
    return $this->app->make(Chat::class);
});
```

--------------------------------

### Get recent messages

Source: https://github.com/musonza/chat/blob/master/README.md

Retrieves recent messages for a participant with limit and page parameters using the conversations() method.

```php
$messages = Chat::conversations()->setParticipant($participantModel)->limit(25)->page(1)->get();
```

--------------------------------

### markRead($participant): void

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message.md

Marks the participant's notification as read by setting is_seen to 1.

```APIDOC
## markRead($participant): void

### Description
Calls `getNotification($participant)->markAsRead()` (sets `is_seen = 1`).

### Method
markRead

### Parameters
- **participant** (Model) - Required - Participant

### Returns
`void`.
```

--------------------------------

### Get messages in a conversation

Source: https://github.com/musonza/chat/blob/master/README.md

Retrieves messages from a conversation by setting the participant and calling getMessages(). Requires a participant to be set.

```php
Chat::conversation($conversation)->setParticipant($participantModel)->getMessages()
```

--------------------------------

### makeDirect

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/chat.md

Flags the next createConversation call as a direct message and returns the Chat instance for chaining.

```APIDOC
## makeDirect

### Description
Flags the next `createConversation()` call as a direct message.

### Method
makeDirect

### Signature
public function makeDirect()

### Parameters
None.

### Returns
`$this` (`Musonza\Chat\Chat`) - for chaining.

### Usage Example
```php
$dm = Chat::makeDirect()->createConversation([$user1, $user2]);
```
```

--------------------------------

### readAll method declaration

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Declares the readAll method. Requires setParticipant() to be called first. Marks all received notifications as seen.

```php
public function readAll()
```

--------------------------------

### Add Messageable trait to a Model

Source: https://github.com/musonza/chat/blob/master/README.md

Add the `Musonza\Chat\Traits\Messageable` trait to any model that should participate in conversations. This example shows a `Bot` model.

```php
use Illuminate\Database\Eloquent\Model;
use Musonza\Chat\Traits\Messageable;

class Bot extends Model
{
    use Messageable;
}
```

--------------------------------

### ConversationService class definition with traits

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/conversation-service.md

Imports and class definition for ConversationService, including the Paginates and SetsParticipants traits and protected/public properties.

```php
use Illuminate\Contracts\Pagination\CursorPaginator;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Support\Collection;
use Musonza\Chat\Eventing\ConversationStarted;
use Musonza\Chat\Models\Conversation;
use Musonza\Chat\Traits\Paginates;
use Musonza\Chat\Traits\SetsParticipants;

class ConversationService
{
    use Paginates;
    use SetsParticipants;

    protected $filters = [];
    protected $messageType;
    public $conversation;
    public $directMessage = false;
```

--------------------------------

### Get common conversations among participants

Source: https://github.com/musonza/chat/blob/master/README.md

Finds conversations common to all given participants. $participants is an array of participant models.

```php
$conversations = Chat::conversations()->common($participants);
```

--------------------------------

### GET /conversations/{id}/messages-cursor

Source: https://github.com/musonza/chat/blob/master/_autodocs/endpoints.md

Retrieves a cursor-paginated list of messages for a conversation, using cursor-based pagination for efficient navigation.

```APIDOC
## GET /conversations/{id}/messages-cursor

### Description
Retrieves a cursor-paginated list of messages for a conversation, using cursor-based pagination for efficient navigation.

### Method
GET

### Endpoint
/conversations/{id}/messages-cursor

### Parameters
#### Path Parameters
- **id** (integer) - Required - The conversation ID.

#### Query Parameters
- **participant_id** (mixed) - Required - The participant ID.
- **participant_type** (string) - Required - The participant model class.
- **perPage** (integer) - Optional - Items per page (default: 25).
- **sorting** (string) - Optional - Sort order: asc or desc (default: asc).
- **columns** (array) - Optional - Columns to select (default: ['*']).
- **cursor** (string|null) - Optional - Encoded cursor from a previous `next_cursor` (default: null).
- **cursorName** (string) - Optional - Query parameter name for cursor (default: 'cursor').

### Response
#### Success Response (200)
- **data** (array) - List of messages.
- **next_cursor** (string|null) - Cursor for the next page.
- **prev_cursor** (string|null) - Cursor for the previous page.

#### Response Example
{
  "data": [
    {
      "id": 1,
      "body": "Hello",
      "sender": { "id": 1, "name": "John" }
    }
  ],
  "next_cursor": "eyJpZCI6MX0",
  "prev_cursor": null
}
```

--------------------------------

### toggleReaction() method signature

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/message-service.md

Signature for toggling a reaction. Adds if absent, removes if present. Requires setParticipant().

```php
public function toggleReaction(string $reaction): array
```

--------------------------------

### GET /chat/conversations/{id}/messages/{message_id}

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Retrieves a single message by its ID within a conversation. Throws a ModelNotFoundException if the message does not exist.

```APIDOC
## GET /chat/conversations/{id}/messages/{message_id}

### Description
Retrieves a single message by its ID within a conversation. Throws a ModelNotFoundException if the message does not exist.

### Method
GET

### Endpoint
/chat/conversations/{id}/messages/{message_id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The conversation ID.
- **message_id** (integer) - Required - The message ID.

### Response
#### Success Response (200)
- Returns a single message as a Response object.

#### Response Example
{
  "id": 1,
  "body": "Hello",
  "conversation_id": 1,
  "participant_id": 1,
  "type": "text",
  "created_at": "2023-01-01T00:00:00.000000Z",
  "updated_at": "2023-01-01T00:00:00.000000Z"
}

#### Error Response (404)
- ModelNotFoundException when the message ID is unknown.
```

--------------------------------

### ConversationController index method signature

Source: https://github.com/musonza/chat/blob/master/_autodocs/api-reference/http.md

Method signature for the index action that lists all conversations. It is mapped to GET /chat/conversations and returns a Response.

```php
public function index()
```
Tokens:
Raw