After publishing the package files, you need to update first the config/laravel-messenger.php config file to reference your User Model.
Don't forget to create a users table if you do not have one already.
Now you can run the php artisan migrate command to your database.
And add the Arcanedev\LaravelMessenger\Traits\Messagable trait to your User model like this:
<?php
namespace App;
use Arcanedev\LaravelMessenger\Traits\Messagable;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable {
use Messagable;
//...
}<?php namespace Arcanedev\LaravelMessenger\Contracts;
use Illuminate\Database\Eloquent\Builder;
/**
* Interface Discussion
*
* @package Arcanedev\LaravelMessenger\Contracts
* @author ARCANEDEV <arcanedev.maroc@gmail.com>
*
* @property int id
* @property string subject
* @property \Carbon\Carbon created_at
* @property \Carbon\Carbon updated_at
* @property \Carbon\Carbon deleted_at
*
* @property \Illuminate\Database\Eloquent\Model creator
* @property \Illuminate\Database\Eloquent\Collection messages
* @property \Illuminate\Database\Eloquent\Collection participants
* @property \Arcanedev\LaravelMessenger\Models\Message latest_message
*
* @method static \Illuminate\Database\Eloquent\Builder subject(string $subject, bool $strict)
* @method static \Illuminate\Database\Eloquent\Builder between(array $usersIds)
* @method static \Illuminate\Database\Eloquent\Builder forUser(int $userId)
* @method static \Illuminate\Database\Eloquent\Builder forUserWithNewMessages(int $userId)
*/
interface Discussion
{
/* ------------------------------------------------------------------------------------------------
| Relationships
| ------------------------------------------------------------------------------------------------
*/
/**
* Participants relationship.
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function participants();
/**
* Messages relationship.
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function messages();
/**
* Get the user that created the first message.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function creator();
/* ------------------------------------------------------------------------------------------------
| Scopes
| ------------------------------------------------------------------------------------------------
*/
/**
* Scope discussions that the user is associated with.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param int $userId
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeForUser(Builder $query, $userId);
/**
* Scope discussions with new messages that the user is associated with.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param int $userId
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeForUserWithNewMessages(Builder $query, $userId);
/**
* Scope discussions between given user ids.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param array $userIds
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeBetween(Builder $query, array $userIds);
/**
* Scope the query by the subject.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param string $subject
* @param bool $strict
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeSubject(Builder $query, $subject, $strict = false);
/* ------------------------------------------------------------------------------------------------
| Getters & Setters
| ------------------------------------------------------------------------------------------------
*/
/**
* Get the latest_message attribute.
*
* @return \Arcanedev\LaravelMessenger\Models\Message
*/
public function getLatestMessageAttribute();
/* ------------------------------------------------------------------------------------------------
| Main Functions
| ------------------------------------------------------------------------------------------------
*/
/**
* Returns all of the latest discussions by `updated_at` date.
*
* @return \Illuminate\Database\Eloquent\Collection
*/
public static function getLatest();
/**
* Returns all discussions by subject.
*
* @param string $subject
* @param bool $strict
*
* @return \Illuminate\Database\Eloquent\Collection
*/
public static function getBySubject($subject, $strict = false);
/**
* Returns an array of user ids that are associated with the discussion.
*
* @param int|null $userId
*
* @return \Illuminate\Support\Collection
*/
public function participantsUserIds($userId = null);
/**
* Add a user to discussion as a participant.
*
* @param int $userId
*
* @return \Arcanedev\LaravelMessenger\Models\Participant
*/
public function addParticipant($userId);
/**
* Add users to discussion as participants.
*
* @param array $userIds
*
* @return \Illuminate\Database\Eloquent\Collection
*/
public function addParticipants(array $userIds);
/**
* Remove a participant from discussion.
*
* @param int $userId
* @param bool $reload
*
* @return int
*/
public function removeParticipant($userId, $reload = true);
/**
* Remove participants from discussion.
*
* @param array $userIds
* @param bool $reload
*
* @return int
*/
public function removeParticipants(array $userIds, $reload = true);
/**
* Mark a discussion as read for a user.
*
* @param int $userId
*
* @return bool|int
*/
public function markAsRead($userId);
/**
* See if the current thread is unread by the user.
*
* @param int $userId
*
* @return bool
*/
public function isUnread($userId);
/**
* Finds the participant record from a user id.
*
* @param int $userId
*
* @return \Arcanedev\LaravelMessenger\Models\Participant
*/
public function getParticipantByUserId($userId);
/**
* Get the trashed participants.
*
* @return \Illuminate\Database\Eloquent\Collection
*/
public function getTrashedParticipants();
/**
* Restores all participants within a discussion.
*
* @param bool $reload
*
* @return int
*/
public function restoreAllParticipants($reload = true);
/**
* Generates a participant information as a string.
*
* @param int|null $ignoredUserId
* @param \Closure|null $callback
* @param string $glue
*
* @return string
*/
public function participantsString($ignoredUserId = null, $callback = null, $glue = ', ');
/**
* Checks to see if a user is a current participant of the discussion.
*
* @param int $userId
*
* @return bool
*/
public function hasParticipant($userId);
/**
* Returns array of unread messages in discussion for given user.
*
* @param int $userId
*
* @return \Illuminate\Support\Collection
*/
public function userUnreadMessages($userId);
}<?php namespace Arcanedev\LaravelMessenger\Contracts;
/**
* Interface Participant
*
* @package Arcanedev\LaravelMessenger\Contracts
* @author ARCANEDEV <arcanedev.maroc@gmail.com>
*
* @property int id
* @property int discussion_id
* @property \Arcanedev\LaravelMessenger\Models\Discussion discussion
* @property int user_id
* @property \Illuminate\Database\Eloquent\Model user
* @property \Carbon\Carbon last_read
* @property \Carbon\Carbon created_at
* @property \Carbon\Carbon updated_at
* @property \Carbon\Carbon deleted_at
*/
interface Participant
{
/* ------------------------------------------------------------------------------------------------
| Relationships
| ------------------------------------------------------------------------------------------------
*/
/**
* Discussion relationship.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function discussion();
/**
* User relationship.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function user();
/* ------------------------------------------------------------------------------------------------
| Getters & Setters
| ------------------------------------------------------------------------------------------------
*/
/**
* Get the participant string info.
*
* @return string
*/
public function stringInfo();
/* ------------------------------------------------------------------------------------------------
| Main Functions
| ------------------------------------------------------------------------------------------------
*/
/**
* Restore a soft-deleted model instance.
*
* @return bool|null
*/
public function restore();
}<?php namespace Arcanedev\LaravelMessenger\Contracts;
/**
* Interface Message
*
* @package Arcanedev\LaravelMessenger\Contracts
* @author ARCANEDEV <arcanedev.maroc@gmail.com>
*
* @property int id
* @property int discussion_id
* @property \Arcanedev\LaravelMessenger\Models\Discussion discussion
* @property int user_id
* @property \Illuminate\Database\Eloquent\Model user
* @property \Illuminate\Database\Eloquent\Model author
* @property int body
* @property \Carbon\Carbon created_at
* @property \Carbon\Carbon updated_at
* @property \Illuminate\Database\Eloquent\Collection participants
* @property \Illuminate\Database\Eloquent\Collection recipients
*/
interface Message
{
/* ------------------------------------------------------------------------------------------------
| Relationships
| ------------------------------------------------------------------------------------------------
*/
/**
* Discussion relationship.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function discussion();
/**
* User/Author relationship (alias).
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function author();
/**
* User/Author relationship.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function user();
/**
* Participants relationship.
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function participants();
/* ------------------------------------------------------------------------------------------------
| Getters & Setters
| ------------------------------------------------------------------------------------------------
*/
/**
* Recipients of this message.
*
* @return \Illuminate\Database\Eloquent\Collection
*/
public function getRecipientsAttribute();
}