Download the PHP package sevenspan/laravel-chat without Composer
On this page you can find all versions of the php package sevenspan/laravel-chat. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sevenspan/laravel-chat
More information about sevenspan/laravel-chat
Files in sevenspan/laravel-chat
Package laravel-chat
Short Description The Laravel Chat package simplifies one-to-one and group chat integration, facilitates document sharing within chats, manages read and unread message counts, and supports document uploads to both local and AWS S3 storage
License MIT
Homepage https://github.com/7span/chat
Informations about the package laravel-chat
Laravel Chat
The Laravel Chat package simplifies one-to-one and group chat integration facilitates document sharing within chats, manages read and unread message counts, and supports document uploads to both local and AWS S3 storage
Index
- Prerequisites
- Features
- Installation
- Configurations
- Credits
- Contributing
- License
Prerequisites
Before you get started, make sure you have the following prerequisites installed:
- PHP >= 8.1 (Support 8.2)
- Composer >= 2.0
- Laravel >= 8.1 (Supports L10 and L11)
- AWS API credentials (Optional)
- Pusher
Features
- One-to-One Chat Integration
- Group Chat Integration
- Document Sharing within Chats
- Read and Unread Message Count Management
- Document Upload Support for Local Storage
- Document Upload Support for AWS S3 Storage
- Message body encryption and decryption
Installation
To install this package, use Composer:
Configurations
To configure the package, publish the migration file with the following command:
This command will publish the configuration file chat.php to your project's config directories, respectively.
If you have cached configurations locally, clear the config cache using one of these commands:
After publishing the migration and configuring, create the required tables for this package by running:
To configure message body encryption add these key on .env
file.
Usage
Once you have installed the package, you can start using its features in your Laravel application. Here's a brief overview of how to use some of the main features:
1. List Channels
Use the list
method to get all channels.
2. Detail of Channel
Use the detail
method to get the detail of channel.
3. Create Channel
Use the create
method to create the new channel.
4. Update Channel
Use the update
method to update the channel details.
5. Delete Channel
Use the delete
method to delete the channel.
6. Clear Channel History
Use the clearMessage
method to clear the chat history.
7. List Message
Use the list
method to get all messages of the channel.
8. Send Message
Use the send
method to send a message.
[!NOTE] In the $data param either body or file is required.
9. Get Files Message
Use the getFiles
method to document of the channel.
[!NOTE] $type param supported value is
image
orzip
.
10. Delete Message
Use the delete
method to delete the message.
11. Read Message
Use the read
method to read the message of a channel.
[!NOTE] The messages that have a lesser value than $messageId will be read automatically.
12. User List
Use the list
method to get a list of users and also search for the name of the user.
Credits
Contributing
If you encounter any issues or would like to contribute to this package, we welcome contributions from the community to improve and enhance this package. If you'd like to contribute, please follow our contribution guidelines:
- Fork this repository.
- Clone the forked repository to your local machine.
- Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name
- Make your changes and commit them: git commit -m 'Add new feature'
- Push your changes to your fork: git push origin feature/your-feature-name
- Create a pull request to the original repository.
License
This package is open-source software licensed under the MIT License. Feel free to use, modify, and distribute it according to the terms of the license.
All versions of laravel-chat with dependencies
aws/aws-sdk-php Version ^3.283
league/flysystem-aws-s3-v3 Version ^3.0
spatie/laravel-sluggable Version ^3.5