chrisidakwo/laravel-messages

1.0.2 2020-05-09 10:34 UTC

Requires

• php: ^7.1.3
• illuminate/config: ^5.5|^6.0|^7.0
• illuminate/database: ^5.5|^6.0|^7.0
• illuminate/support: ^5.5|^6.0|^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.5
• orchestra/testbench: ^3.0|^4.0|^5.0
• phpunit/phpunit: ^7.0
• vimeo/psalm: ^3.11

MIT

• Chris Idakwo

• user
• message
• messaging
• chat
• send
• laravel
• system
• eloquent
• Messenger

README

This package will allow you to add a full user messaging system into your Laravel application.

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
• 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)

Installation (Laravel 5.x)

composer require chrisidakwo/laravel-messages

Or place manually in composer.json:

"require": {
    "chrisidakwo/laravel-messages": "~1.0"
}

Run:

composer update

Add the service provider to config/app.php under providers:

'providers' => [
    ChrisIdakwo\Messages\MessagesServiceProvider::class,
],

Note: If you are using Laravel 5.5, this step is unnecessary. Laravel Messages supports Package Discovery.

Publish config:

php artisan vendor:publish --provider="ChrisIdakwo\Messages\MessagesServiceProvider" --tag="config"

Update config file to reference your User Model:

config/messages.php

Publish migrations:

php artisan vendor:publish --provider="ChrisIdakwo\Messages\MessagesServiceProvider" --tag="migrations"

Migrate your database:

php artisan migrate

Add the trait to your user model:

use ChrisIdakwo\Messages\Traits\HasMessages;

class User extends Authenticatable {
    use HasMessages;
}

Contributing?

Please format your code before creating a pull-request. This will format all files as specified in .php_cs:

vendor/bin/php-cs-fixer fix .

Security

If you discover any security related issues, please email Chris Idakwo instead of using the issue tracker.

Credits

• Chris Idakwo

Special Thanks

This package used cmgmyr/laravel-messenger as a starting point.