README

• Installation

• Usage

  • Send message
  • Mark message
  • Get user messages

• Unit Testing

• TODO

Installation

Install the package via composer:

composer require kamelz/larachat

If you are using a laravel version older than 5.5 then add the service provider in config/app.php.

'providers' => [
    // ...
    Kamelz\Larachat\LarachatServiceProvider::class,
];

Publish migration files with:

php artisan vendor:publish

After that run the migration command:

php artisan migrate

Usage

Send message

You may pass a user model or the user ID in the $from and $to parameters.

$from; 		// User model or Integer
$to; 		// User model or Integer
$message; 	// String message

Message::send($from,$to,$message);

Mark message

$message; // Message model

$message->is_read; // 0

Message::markAsRead($message);

$message->is_read; // 1

You can also mark it as unread.

$message; // Message model

$message->is_read; // 1

Message::markAsUnread($message);

$message->is_read; // 0

Get user messages

$user; // User model or Integer

Message::getUserMessages($user);

Returns an `Eloquent\Collection` of `Message` model.

You can get read/unread messages

$user; // User model or Integer

Message::getUnreadMessages($user);
Message::getRadMessages($user);

Unit Testing

vendor/phpunit/phpunit/phpunit

TODO

- Blade component 
- Send email