ekremogul/laravel-messaging

v1.0.1 2022-10-27 11:38 UTC

This package is auto-updated.

Last update: 2024-09-30 01:46:42 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Messaging package for Laravel

安装

您可以通过 composer 安装此包

composer require ekremogul/laravel-messaging

您可以使用以下命令发布和运行迁移

php artisan vendor:publish --tag="messaging-migrations"
php artisan migrate

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="messaging-config"

这是已发布配置文件的内容

return [
    "user_model" => "App\Models\User"
];

使用方法

定义

$laravelMessaging = Ekremogul\LaravelMessaging\LaravelMessaging::create();

获取收件箱

$inbox = $laravelMessaging($order = "desc", $offset = 0, $take = 20); // Retrieve the last 20 messages

foreach($inbox as $item) {
    /*
    * App\Models\User 
    * return the messaging user
    */
    $item->withUser;
    
    /*
    * Ekremogul\LaravelMessaging\Model\Message
    * return last message with user
    */ 
    $item->message;
    
    /*
    * Return 0 or 1
    * Returns 1 if there is a message you haven't read
    */
    $item->unreaded_message;
    
    /*
    * Return integer
    * Returns the total number of unread messages
    */
    $item->total_unread;
}

与用户接收消息

$laravelMessaging->getMessagesWithUser($user_id, $offset = 0, $take = 20);

发送消息

$laravelMessaging->sendMessage($user_id, $message);

使特定消息可见

$laravelMessaging->makeSeen($message_id);

使特定消息可见

$laravelMessaging->makeSeen($message_id);

使与用户发送的所有消息都可见

$laravelMessaging->makeSeenAll($user_id);

测试

composer test

变更日志

请参阅 变更日志 了解最近更改的更多信息。

贡献

请参阅 贡献指南 了解详细信息。

安全漏洞

请审查 我们的安全策略 了解如何报告安全漏洞。

鸣谢

许可

MIT 许可证(MIT)。请参阅 许可文件 了解更多信息。