包简介

Private messages module for yii2

README 文档

README

Private messages module for yii2

Installing

The preferred way to install this extension is through Composer.

{
  "require": {
    "nanson/yii2-messenger": "*"
  }
}

Migration

./yii migrate --migrationPath=@vendor/nanson/yii2-messenger/migrations/

Configure module:

    'modules' => [
        'messenger' => [
            'class' => \nanson\messenger\Messenger::className(),
        ],
    ],

Usage

Url for contacts list: /messenger/contacts/.

Url for messages list: /messenger/contacts/messages/?id={contact_id}

Contacts widget

Display contacts list for user with last message.

<?php
echo \nanson\messenger\widgets\Contacts::widget();
?>

Option	Type	Description
userId	integer	User ID. Default: `\Yii::$app->user->id`
tpl	string	Widget template. Default: `create`
options	array	The HTML attributes for the widget wrapper tag. Default: `[]`
pageSize	integer	Contacts per page. Default: `10`
defaultOrder	array	Default contacts order Default: `['last_message_id' => SORT_DESC]`
viewRoute	string	Route to messages. Default: `/messenger/contacts/messages`
dataProviderOptions	array	Options for `yii\data\ActiveDataProvider`. Default: `[]`
queryModifier	callable	Function to modify ActiveDataProvider query. Default: `null`
skinAsset	string	Skin Asset Bundles class. Default: `null`

Messages widget

Display user messages with current contact

<?php
echo \nanson\messenger\widgets\Messages::widget([
    'contactId' => $contactId,
]);
?>

Option	Type	Description
contactId	integer	Contact ID.
userId	integer	User ID. Default: `\Yii::$app->user->id`
tpl	string	Widget template. Default: `messages`
options	array	The HTML attributes for the widget wrapper tag. Default: `[]`
pageSize	integer	Messages per page. Default: `10`
defaultOrder	array	Default contacts order Default: `['created_at' => SORT_DESC]`
dataProviderOptions	array	Options for `yii\data\ActiveDataProvider`. Default: `[]`
queryModifier	callable	Function to modify ActiveDataProvider query. Default: `null`
skinAsset	string	Skin Asset Bundles class. Default: `null`

Add message widget

Display form to message creation.

<?php
echo \nanson\messenger\widgets\AddMessage::widget([
	'contactId' => $contactId,
	'pjaxId' => "pjaxMessages",
]);
?>

Option	Type	Description
contactId	integer	Contact ID.
userId	integer	User ID. Default: `\Yii::$app->user->id`
tpl	string	Widget template. Default: `create`
options	array	The HTML attributes for the widget wrapper tag. Default: `[]`
formOptions	array	The HTML attributes for the widget form. Default: `[]`
route	string	Route to create message action. Default: `/messenger/rest/create`
skinAsset	string	Skin Asset Bundles class. Default: `null`
pjaxId	string	Pjax widget Id. If specified, pjax will be reloaded after message creation. Default: `null`
fancySelector	string	Fancybox selector. If specified, widget will be rendered as Fancybox. https://github.com/newerton/yii2-fancybox Default: `null`
fancyOptions	array	Fancybox widget options. Default: `null`

Messages counter widget

Display count unreaded messages for user.

<?php
echo \nanson\messenger\widgets\Counter::widget();
?>

Option	Type	Description
route	string	Route to action. Default: `/messenger/rest/count`
timeout	integer	Update timout. Default: `30`
tag	string	Counter html tag. Default: `span`
options	array	The HTML attributes for the counter tag. Default: `['class' => 'badge']`

nanson/yii2-messenger 适用场景与选型建议

nanson/yii2-messenger 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 266 次下载、GitHub Stars 达 6，最近一次更新时间为 2015 年 12 月 18 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「module」「message」「extension」「yii」「messages」「Messenger」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 nanson/yii2-messenger 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 nanson/yii2-messenger 我们能提供哪些服务？

定制开发 / 二次开发

基于 nanson/yii2-messenger 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发