cmgmyr/messenger

Simple user messaging tool for Laravel

, _(*1)

, _(*2)

Laravel Messenger

This package will allow you to add a full user messaging system into your Laravel application., _(*3)

Leave some feedback

How are you using laravel-messenger?, _(*4)

Features

• Multiple conversations per user
• Optionally loop in additional users with each new message
• View the last message for each thread available
• Returns either all messages in the system, all messages associated to the user, or all message associated to the user with new/unread messages
• Return the users unread message count easily
• Very flexible usage so you can implement your own access control

Common uses

• Open threads (everyone can see everything)
• Group messaging (only participants can see their threads)
• One to one messaging (private or direct thread)

Laravel Versions

Installation (Laravel 4.x - no longer actively supported)

Installation instructions for Laravel 4 can be found here., _(*5)

Installation (Laravel 5.x)

composer require cmgmyr/messenger

Or place manually in composer.json:, _(*6)

"require": {
    "cmgmyr/messenger": "~2.0"
}

Run:, _(*7)

composer update

Add the service provider to config/app.php under providers:, _(*8)

'providers' => [
    Cmgmyr\Messenger\MessengerServiceProvider::class,
],

Note: If you are using Laravel 5.5, this step is unnecessary. Laravel Messenger supports Package Discovery., _(*9)

Publish config:, _(*10)

php artisan vendor:publish --provider="Cmgmyr\Messenger\MessengerServiceProvider" --tag="config"

Update config file to reference your User Model:, _(*11)

config/messenger.php

Create a users table if you do not have one already. If you need one, the default Laravel migration will be satisfactory., _(*12)

(Optional) Define names of database tables in package config file if you don't want to use default ones:, _(*13)

'messages_table' => 'messenger_messages',
'participants_table' => 'messenger_participants',
'threads_table' => 'messenger_threads',

Publish migrations:, _(*14)

php artisan vendor:publish --provider="Cmgmyr\Messenger\MessengerServiceProvider" --tag="migrations"

Migrate your database:, _(*15)

php artisan migrate

Add the trait to your user model:, _(*16)

use Cmgmyr\Messenger\Traits\Messagable;

class User extends Authenticatable {
    use Messagable;
}

Examples

• Controller
• Routes
• Views

Example Projects

• [WIP] Pusher
• [WIP] Lumen API

Contributing

Please see CONTRIBUTING for details., _(*17)

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities., _(*18)

Credits

• Chris Gmyr
• Anton Komarev
• All Contributors

Special Thanks

This package used AndreasHeiberg/laravel-messenger as a starting point., _(*19)