lengnuan-v/yii2-message

yii2 message

安装: 3

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

类型:yii2-extension

dev-master 2021-08-16 01:00 UTC

This package is auto-updated.

Last update: 2024-09-16 07:44:49 UTC


README

为yii2提供的一个简单的私有消息扩展,只包含模型和API,没有Web界面。

安装

安装此扩展的首选方式是通过 composer

运行以下命令之一:

 composer require --prefer-dist lengnuan-v/yii2-message "dev-master"

或者在您的 composer.json 文件的require部分添加以下内容:

"lengnuan-v/yii2-message": "*"

然后

 php yii migrate/up --migrationPath=@vendor/lengnuan-v/yii2-message/src/migrations

配置

要使用此扩展,只需在您的应用程序配置中添加以下代码:

return [
    //....
    'components' => [
        'message' => [
            'class' => 'lengnuan\message\Message',
        ],
    ],
];

用法

扩展安装后,只需在代码中使用它即可:

// 发送一条消息.
Yii::$app->message->send($userId = 12, $title = 'How are u?', $message = 'How are u?');

// 回复一条消息
Yii::$app->message->reply($messageId = 2100, $message = 'Fine, and u?');

// 返回一条消息
Yii::$app->message->getMessage($messageId = 2100);

// 获取列表
Yii::$app->message->messageList($userId = 12, $status = null, $cate = 'to', $page = 1, $limit = 20, $orderBy = ['id' => SORT_DESC]);

// 获取对话中的消息列表
Yii::$app->message->getMessage($dialogueHash = '4795342d74935999cc82ded1b589072c');

// 删除一条消息
Yii::$app->message->del($dialogueHash = '4795342d74935999cc82ded1b589072c');

// 设置消息已读状态
Yii::$app->message->setMessageRead($dialogueHash = '4795342d74935999cc82ded1b589072c');