PHPackages                             jubaer/livechat - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Queues & Workers](/categories/queues)
4. /
5. jubaer/livechat

ActiveLibrary[Queues & Workers](/categories/queues)

jubaer/livechat
===============

LiveChat is a Laravel based realtime messaging, chatting and conversation system. It helps to develop users messaging, chatting and conversations in easy way.

2.1.1(2y ago)011MITPHPPHP >=5.6

Since Jun 13Pushed 2y ago1 watchersCompare

[ Source](https://github.com/JubaerHossain/livechat)[ Packagist](https://packagist.org/packages/jubaer/livechat)[ Docs](https://github.com/JubaerHossain/livechat)[ RSS](/packages/jubaer-livechat/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (8)Versions (2)Used By (0)

Laravel-Chat
============

[](#laravel-chat)

LiveChat is a Laravel based user conversation (chatting) system with realtime messaging. You can easily integrate this package with any Laravel based project. It helps you to develop a messaging system in just few minutes. Here is a project screenshot that was developed by LiveChat.

LiveChat v1.0.0 supports realtime messaging

So let's start your tour :)

### Features

[](#features)

- Head to head messaging
- Realtime messaging
- Creating new conversation
- Message threads with latest one
- View conversations by user id or conversation id
- Support pagination in threads and messages
- Delete (soft delete) message from both end. Sender and receiver can delete their message from their end
- Permanent delete message
- Mark message as seen
- Only participant can view or access there message or message threads
- Inline url render using oembed specifications

### Installation

[](#installation)

LiveChat is a Laravel package so you can install it via Composer. Run this command in your terminal from your project directory:

```
composer require jubaer/livechat

```

Wait for a while, Composer will automatically install LiveChat in your project.

### Configuration

[](#configuration)

When the download is complete, you have to call this package service in `config/app.php` config file. To do that, add this line in `app.php` in `providers` section:

```
Jubaer\LiveChat\TalkServiceProvider::class,
```

To use facade you have to add this line in `app.php` in `aliases` array:

```
'Talk'      => Jubaer\LiveChat\Facades\Talk::class,
```

Now run this command in your terminal to publish this package resources:

```
php artisan vendor:publish --provider="Jubaer\LiveChat\TalkServiceProvider"

```

After running this command, all necessary file will be included in your project. This package has two default migrations. So you have to run migrate command like this. (But make sure your database configuration is configured correctly.)

```
php artisan migrate
```

Okay, now you need to configure your user model for Talk. Go to `config/talk.php` and config it:

```
return [
    'user' => [
        'model' => 'App\User',
        'foreignKey' => null,
        'ownerKey' => null,
    ],

    'broadcast' => [
        'enable' => true,
        'app_name' => 'talk-example',
        'driver' => env('TALK_BROADCAST_DRIVER', 'pusher'), // pusher or laravel-websockets
        'pusher' => [
            'app_id' => env('PUSHER_APP_ID', ''),
            'app_key' => env('PUSHER_APP_KEY', ''),
            'app_secret' => env('PUSHER_APP_SECRET', ''),
            'options' => [
                'cluster' => env('PUSHER_APP_CLUSTER', 'ap2'),
                'encrypted' => env('PUSHER_APP_ENCRYPTION', false),
                'host' => '127.0.0.1',
                'port' => env('LARAVEL_WEBSOCKETS_PORT', 6001),
                'scheme' => 'http',
                'wsHost' => '127.0.0.1',
                'wsPort' => env('LARAVEL_WEBSOCKETS_PORT', 6001),
                'forceTLS' => false,
                'disableStats' => true
            ]
        ],
    ],

    'oembed' => [
        'enabled' => false,
        'url' => '',
        'key' => ''
    ]
];
```

### Usage

[](#usage)

Its very easy to use. If you want to set authenticate user id globally then you have to set a middleware first. Go to `app/Http/Kernel.php` and set it in `$routeMiddleware` array:

```
'talk'  =>  \Jubaer\LiveChat\Middleware\TalkMiddleware::class,
```

And now you can use it from anywhere with middleware. Suppose you have a Controller and you want to set authenticate user id globally then write this in controller constructor:

```
$this->middleware('talk');
```

But instead of set id globally you can use these procedure from any method in controller:

```
Talk::setAuthUserId(auth()->user()->id);
```

Now you may use any method what you need. But if want pass authentic id instantly, this method may help you:

```
Talk::user(auth()->user()->id)->anyMethodHere();
```

Please see the API Doc.

### API List

[](#api-list)

- [setAuthUserId](https://github.com/nahid/talk#setauthuserid)
- [user](https://github.com/nahid/talk#user)
- [isConversationExists](https://github.com/nahid/talk#isconversationexists)
- [isAuthenticUser](https://github.com/nahid/talk#isauthenticuser)
- [sendMessage](https://github.com/nahid/talk#sendmessage)
- [sendMessageByUserId](https://github.com/nahid/talk#sendmessagebyuserid)
- [getInbox](https://github.com/nahid/talk#getinbox)
- [getInboxAll](https://github.com/nahid/talk#getinboxAll)
- [threads](https://github.com/nahid/talk#threads)
- [threadsAll](https://github.com/nahid/talk#threadsall)
- [getConversationsById](https://github.com/nahid/talk#getconversationbyid)
- [getConversationsAllById](https://github.com/nahid/talk#getconversationallbyid)
- [getConversationsByUserId](https://github.com/nahid/talk#getconversationbyuserid)
- [getConversationsAllByUserId](https://github.com/nahid/talk#getconversationallbyuserid)
- [getMessages](https://github.com/nahid/talk#getmessages)
- [getMessagesByUserId](https://github.com/nahid/talk#getmessagesbyuserid)
- [getMessagesAll](https://github.com/nahid/talk#getmessagesall)
- [getMessagesAllByUserId](https://github.com/nahid/talk#getmessagesallbyuserid)
- [readMessage](https://github.com/nahid/talk#readmessage)
- [makeSeen](https://github.com/nahid/talk#makeseen)
- [getReceiverInfo](https://github.com/nahid/talk#getreceiverinfo)
- [deleteMessage](https://github.com/nahid/talk#deletemessage)
- [deleteForever](https://github.com/nahid/talk#deleteforever)
- [deleteConversations](https://github.com/nahid/talk#deleteconversations)

### setAuthUserId

[](#setauthuserid)

`setAuthUserId` method sets the currently loggedin user id, which you pass through parameter. If you pass `null` or `empty` value then it returns false.

**Syntax**

```
void setAuthUserId($userid)
```

**Example**

Constructor of a Controller is the best place to write this method.

```
function __construct()
{
    Talk::setAuthUserId(auth()->user()->id);
}
```

When you pass logged in user ID, Talk will know who is currently authenticated for this system. So Talk retrieve all information based on this user.

### user

[](#user)

You may use this method instead of `setAuthUserId()` method. When you have to instantly access users conversations then you may use it. **Syntax**

```
object user($id)
```

**Example**When you haven't set authenticated user id globally, then you just use this method directly with others method.

```
$inboxes = Talk::user(auth()->user()->id)->threads();
return view('messages.threads', compact('inboxes'));
```

### isConversationExists

[](#isconversationexists)

This method checks currently logged in user and if given user is already in conversation

**Syntax**

```
int|false isConversationExists($userid)
```

**Example**

```
if ($conversationId = Talk::isConversationExists($userId)) {
    Talk::sendMessage($conversationId, $message);
}
```

### isAuthenticUser

[](#isauthenticuser)

isAuthenticUser checks if the given user exists in given conversation.

**Syntax**

```
boolean isAuthenticUser($conversationId, $userId)
```

**Example**

```
if (Talk::isAuthenticUser($conversationId, $userId)) {
    Talk::sendMessage($conversationId, $message);
}
```

### sendMessage

[](#sendmessage)

You can send messages via conversation id by using this method. If the message is successfully sent, it will return objects of Message model otherwise, it will return `false`

**Syntax**

```
object|false sendMessage($conversationId, $message)
```

**Example**

```
    $message = Talk::sendMessage($conversationId, $message);
    if ($message) {
        return response()->json(['status'=>'success', 'data'=>$message], 200);
   }
```

### sendMessageByUserId

[](#sendmessagebyuserid)

You can send message via receiver id by using this method. If the message is successfully sent, it will return objects of Message model otherwise, it will return `false`

**Syntax**

```
object|false sendMessageByUserId($userId, $message)
```

### getInbox

[](#getinbox)

If you want to get all the inboxes except soft deleted message , this method may help you. This method gets all the inboxes via previously assigned authenticated user id. It returns collections of message thread with latest message.

**Syntax**

```
array getInbox([$order = 'desc'[,$offset = 0[, $take = 20]]])
```

**Example**

```
// controller method
$inboxes = Talk::getInbox();
return view('message.threads', compact('inboxes'));
```

```

  @foreach($inboxes as $inbox)

    {{$inbox->withUser->name}}
    {{$inbox->thread->message}}
    {{$inbox->thread->humans_time}}

  @endforeach

```

### getInboxAll

[](#getinboxall)

Its similar as `getInbox()` method. If you want to get all the inboxes with soft deleted messages, this method may help you. This method gets all the inboxes via given user id.

**Syntax**

```
object getInboxAll([$order = 'desc'[,$offset = 0[, $take = 20]]])
```

### threads

[](#threads)

This method is an alias of `getInbox()` method.

**Syntax**

```
array threads([$order = 'desc'[,$offset = 0[, $take = 20]]])
```

### threadsAll

[](#threadsall)

This method is an alias of `getInboxAll()` method.

**Syntax**

```
array threadsAll([$order = 'desc'[,$offset = 0[, $take = 20]]])
```

### getConversationsById

[](#getconversationsbyid)

When you want to get all the conversations using your desire conversation id, you can try this method. This method returns all the conversations (except soft deleted) with `sender` and `withUser` objects

**Syntax**

```
array getConversationsById($conversationId[, $offset = 0[, $take = 20]])
```

**Example**

```
// controller method
$conversations = Talk::getConversationsById($conversationId);
$messages = $conversations->messages;
$withUser = $conversations->withUser;

return view('messages.conversations', compact('messages', 'withUser'));
```

This method returns two objects `messages` and `withUser`. `messages` object contains messages collection and `withUser` object contains participant User collections.

Let's see how to use it with your views

```

  Chat with {{$withUser->name}}
  @foreach ($messages as $msg)

    {{$msg->sender->name}}
    {{$msg->humans_time}}
    {{$msg->message}}

  @endforeach

```

### getConversationsAllById

[](#getconversationsallbyid)

This method is similar as `getConversationsById()`. The only difference between this method is its return all messages with soft deleted items.

**Syntax**

```
array getConversationsAllById($conversationId[, $offset = 0[, $take = 20]])
```

### getConversationsByUserId

[](#getconversationsbyuserid)

When you want to get all the conversations using your desire receiver id, you can try this method. This method returns all the conversations (except soft deleted message) with user's objects

**Syntax**

```
object getConversationsByUserId($receiverId [, $offset = 0[, $take = 20]])
```

### getConversationsAllByUserId

[](#getconversationsallbyuserid)

This method is similar as `getConversationsByUserId()`. The only difference between this method is it returns all messages with soft deleted items.

**Syntax**

```
array getConversationsAllByUserId($receiverId[, $offset = 0[, $take = 20]])
```

### getMessages

[](#getmessages)

This is a alias of `getConversationsById()` method.

**Syntax**

```
array messages($conversationId[, $offset = 0[, $take = 20]])
```

### getMessagesAll

[](#getmessagesall)

This is a alias of `getConversationsAllById()` method.

**Syntax**

```
array messagesAll($conversationId[, $offset = 0[, $take = 20]])
```

### getMessagesByUserId

[](#getmessagesbyuserid)

This is a alias of `getConversationsByUserId()` method.

**Syntax**

```
array messagesByUserId($receiverId[, $offset = 0[, $take = 20]])
```

### getMessagesAllByUserId

[](#getmessagesallbyuserid)

This is a alias of `getConversationsAllByUserId()` method.

**Syntax**

```
array messagesAllByUserId($receiverId[, $offset = 0[, $take = 20]])
```

### readMessage

[](#readmessage)

If you want to read a single message then you may use it. This message is return a single message object by message id.

**Syntax**

```
array readMessage($messageId)
```

### getReceiverInfo

[](#getreceiverinfo)

This method returns all the information about message receiver.

> This method is deprecated from version 2.0.0 and it will be removed from version 2.0.2

**Syntax**

```
object getReceiverInfo($conversationId)
```

### makeSeen

[](#makeseen)

If you want to set a message as seen you can use this method.

**Syntax**

```
boolean makeSeen($messageId)
```

### deleteMessage

[](#deletemessage)

When you want to delete a specific message from a conversation, you have to use this method. This method soft delete message for both user-end individually.

**Syntax**

```
boolean deleteMessage($messageId)
```

### deleteForever

[](#deleteforever)

If you want to hard delete or permanently delete a specific message then you have to use this method.

**Syntax**

```
boolean deleteForever($messageId)
```

### deleteConversations

[](#deleteconversations)

This method is used to permanently delete all conversations.

**Syntax**

```
boolean deleteConversations($conversationId)
```

Realtime Messaging
------------------

[](#realtime-messaging)

LiveChat also support realtime messaging. LiveChat support pusher and laravel-websocket for realtime messaging. So first you have to configure pusher or laravel-websocket. Go to `app/talk.php` again and configure.

```
return [
    'user' => [
        'model' => 'App\User',
        'foreignKey' => null,
        'ownerKey' => null,
    ],

    'broadcast' => [
        'enable' => true,
        'app_name' => 'talk-example',
        'driver' => env('TALK_BROADCAST_DRIVER', 'pusher'), // pusher or laravel-websockets
        'pusher' => [
            'app_id' => env('PUSHER_APP_ID', ''),
            'app_key' => env('PUSHER_APP_KEY', ''),
            'app_secret' => env('PUSHER_APP_SECRET', ''),
            'options' => [
                'cluster' => env('PUSHER_APP_CLUSTER', 'ap2'),
                'encrypted' => env('PUSHER_APP_ENCRYPTION', false),
                'host' => '127.0.0.1',
                'port' => env('LARAVEL_WEBSOCKETS_PORT', 6001),
                'scheme' => 'http',
                'wsHost' => '127.0.0.1',
                'wsPort' => env('LARAVEL_WEBSOCKETS_PORT', 6001),
                'forceTLS' => false,
                'disableStats' => true
            ]
        ],
    ],

    'oembed' => [
        'enabled' => false,
        'url' => '',
        'key' => ''
    ]
];
```

in this new version broadcast section was added with talk config. Here broadcast is disabled by default. If you want to enable live (realtime) messaging then you have to enable it first. Then add pusher credentials to your .env file and you must add a new line called PUSHER\_APP\_NAME in the .env file to specify your application pusher name. Thats it. Every time when you send message then talk will automatically fire two event, one for specific user and second for specific conversation. So you may listen or subscribe one or both as per your wish. Finally you have to subscribe these events by using `talk_live()` helper function. Go to where you want to subscribe to work with message data follow this code.

```

    var msgshow = function(data) {
        // write what you want with this data

        console.log(data);
    }

{!! talk_live(['user'=>["id"=>auth()->user()->id, 'callback'=>['msgshow']]]) !!}

```

`talk_live()` supports one parameters as array. The first parameter is for channel name which you want to subscribe. You have not know which channel was broadcast. Talk broadcast two channel by default. One for user and second for conversation. If you want to subscribe channel for currently loggedin user then you have to pass

logedin user id in 'user' key. `['user'=>['id'=>auth()->user()->id, 'callback'=>[]]` or you want to subscribe for conversation id you have pass conversation id as 'conversation' key. `['conversation'=>['id'=>$conversationID, 'callback'=>[]]`. You may pass both if you want.

You can pass a callback for working with pusher recieved data. For both `user` and `conversation` section support callbacks as array. So you can pass multiple callback as array value that was shown in previous example.

You can watch [Talk-Live-Demo](https://youtu.be/bN3s_LbObnQ)

Oembed support
--------------

[](#oembed-support)

Talk also supports embed urls simply use `$message->toHtlmString()` in you views to render an embed link

Eg. `This is a youtube embed link: https://www.youtube.com/watch?v=jNQXAC9IVRw`

```

  Chat with {{$withUser->name}}
  @foreach ($messages as $msg)

    {{$msg->sender->name}}
    {{$msg->humans_time}}
    {{$msg->toHtmlString()}}

  @endforeach

```

Custom embed link
-----------------

[](#custom-embed-link)

If you want to setup your own implementation of oembed you can configure it in the talk config file. You endpoint should follow the [Oembed](https://oembed.com/) specifications

```
    'user' => [
        ...
    ],
    ...
    ],
    'oembed' => [
        'enabled' => true,
        'url' => 'http://your.domain/api/oembed',
        'key' => 'yout-auth-api-key'
    ]
```

### Testing

[](#testing)

Talk is backwards compatible with php 5.5. Use docker to run unit tests.

```
docker-compose run php55 composer install
docker-compose run php55 phpunit
```

```
docker-compose run php56 composer install
docker-compose run php56 phpunit
```

```
docker-compose run php7 composer install
docker-compose run php7 phpunit
```

```
docker-compose run hhvm composer install
docker-compose run hhvm phpunit
```

### This package extends version of [nahid/talk](https://github.com/nahid/talk)

[](#this-package-extends-version-of-nahidtalk)

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1069d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c35bffe684b1e1d38ff6069c608f4ff6cb92e4041f4e6f0d144eae950aead5be?d=identicon)[JubaerHossain](/maintainers/JubaerHossain)

---

Top Contributors

[![onesttitan](https://avatars.githubusercontent.com/u/141400593?v=4)](https://github.com/onesttitan "onesttitan (10 commits)")

---

Tags

messagephplaravelreal-timerealtimechatinboxconversations

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/jubaer-livechat/health.svg)

```
[![Health](https://phpackages.com/badges/jubaer-livechat/health.svg)](https://phpackages.com/packages/jubaer-livechat)
```

###  Alternatives

[nahid/talk

Talk is a Laravel based realtime messaging, chatting and conversation system. It helps to develop users messaging, chatting and conversations in easy way.

1.6k58.1k4](/packages/nahid-talk)[baklysystems/laravel-chat-messenger

Laravel chat package

121.8k](/packages/baklysystems-laravel-chat-messenger)[munafio/chatify

A package for Laravel PHP Framework to add a complete real-time chat system.

2.4k441.9k2](/packages/munafio-chatify)[laravel/reverb

Laravel Reverb provides a real-time WebSocket communication backend for Laravel applications.

1.5k9.4M48](/packages/laravel-reverb)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)