Download the PHP package gicminos/chat without Composer
On this page you can find all versions of the php package gicminos/chat. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gicminos/chat
More information about gicminos/chat
Files in gicminos/chat
Package chat
Short Description Fork of musonza/chat to mantain version 3 in future laravel releases
License MIT
Informations about the package chat
Chat
Want to use any Laravel model as Chat participant? Follow this PR https://github.com/musonza/chat/pull/163
- Introduction
- Installation
- Usage
- Creating a conversation
- Get a conversation by Id
- Update conversation details
- Send a text message
- Send a message of custom type
- Get a message by id
- Mark a message as read
- Mark whole conversation as read
- Unread messages count
- Delete a message
- Clear a conversation
- Get a conversation between two users
- Get common conversations among users
- Remove users from a conversation
- Add users to a conversation
- Get messages in a conversation
- Get recent messages
- Get users in a conversation
- License
Introduction
This package allows you to add a chat system to your Laravel ^5.4 application
Installation
From the command line, run:
Add the service provider to your config\app.php
the providers array
Add the Facade to your aliases:
The class is bound to the ioC as chat
Publish the assets:
This will publish database migrations and a configuration file musonza_chat.php
in the Laravel config folder.
Configuration
Run the migrations:
Usage
By default the package assumes you have a User model in the App namespace.
However, you can update the user model in musonza_chat.php
published in the config
folder.
Creating a conversation
Creating a conversation of type private / public
Get a conversation by id
Update conversation details
Send a text message
Send a message of custom type
The default message type is text
. If you want to specify custom type you can call the type()
function as below:
Get a message by id
Mark a message as read
Flag / mark a message
Mark whole conversation as read
Unread messages count
Unread messages count per Conversation
Delete a message
Clear a conversation
Get a conversation between two users
Get common conversations among users
$users
can be an array of user ids ex. [1,4,6]
or a collection (\Illuminate\Database\Eloquent\Collection)
of users
Remove users from a conversation
Add users to a conversation
Note: By default, a third user will classify the conversation as not private if it was. See config on how to change this.
Get messages in a conversation
Get user conversations by type
Get recent messages
Example
Pagination
There are a few ways you can achieve pagination
You can specify the limit
and page
as above using the respective functions or as below:
You don't have to specify all the parameters. If you leave the parameters out, default values will be used.
$paginated
above will return Illuminate\Pagination\LengthAwarePaginator
To get the conversations
simply call $paginated->items()
Get users in a conversation
License
Chat is open-sourced software licensed under the MIT license