WebIM Application for PHP5 project
NexTalk为PHP5项目提供的快速WebIM开发包，可为PHP5开发的站点或应用提供立即可用的站内即时消息。
WebIM的前端界面，集成后直接嵌入站点右下角。并支持在站点页面的任意位置，添加聊天按钮:
NexTalk是基于WEB标准协议设计的，主要应用于WEB站点的，简单开放的即时消息系统。可快速为社区微博、电子商务、企业应用集成即时消息服务。
NexTalk架构上分解为：WebIM业务服务器 + 消息路由服务器 两个独立部分，遵循 Open Close的架构设计原则。WebIM插件方式与第三方的站点或应用的用户体系开放集成，独立的消息服务器负责稳定的连接管理、消息路由和消息推送。
PHP > 5.3.10
PDO support
cURL support
-
'webim'作为子目录复制到PHP5项目下；
-
创建数据库, 导入webim/install.sql表;
-
配置webim/config.php：
//Database
'dbhost' => "127.0.0.1",
'dbport' => "3306",
'dbuser' => "webim",
'dbpassword' => "webim",
'dbname' => "webim5",
'dbprefix' => "webim_",
//WebIM Config
'version' => '5.7',
'isopen' => true,
'debug' => true,
//消息服务器通信域名
'domain' => 'localhost',
//消息服务器通信APIKEY
'apikey' => 'public',
//消息服务器地址
'server' => 't.nextalk.im:8000',
//集群服务器列表
//'server' => array('t1.nextalk.im:8080', 't2.nextalk.im:8080'),
'emot' => 'default',
'theme' => 'base',
'opacity' => '80',
'local' => 'zh-CN',
'show_realname' => false,
'discussion' => false,
'enable_room' => true,
'enable_chatlink' => true,
'enable_shortcut' => true,
'enable_menu' => false,
'enable_login' => false,
'enable_ask' => false,
'enable_noti' => true,
'admin_uids' => '0',
'visitor' => true,
'show_unavailable' => true,
'upload' => true,
'censor' => false,
-
编码webim/src/Plugin.php，集成PHP项目的用户体系;
-
在需要显示webim的页面，footer插入js链接:
<script type="text/javascript" src="webim/index.php?action=boot"></script>WebIM通过'webim/src/Plugin.php'的接口函数，与PHP项目的用户体系、好友关系等数据集成。
Plugin.php的集成方法列表:
| 方法 | 参数 | 返回 | 说明 |
|---|---|---|---|
| user() | 当前登陆用户(属性详见代码注释) | 初始化WebIM当前的用户对象,一般从SESSION和数据库读取 | |
| buddies($uid) | $uid | 好友对象列表 | 根据当前用户uid，读取用户的好友列表 |
| buddiesByIds($uid, $ids) | $uid: 用户id, $ids: 好友id列表 | 好友对象列表 | 根据ids列表读取好友列表 |
| rooms($uid) | $uid: 用户id | 群组对象列表 | 读取当前用户所属的群组，以支持群聊 |
| roomsByIds($uid, $ids) | $uid: 用户id, $ids: 群组id列表 | 群组对象列表 | 根据群组id列表读取群组对象列表 |
| members($room) | $room: 群组id | 群组成员对象列表 | 根据群组Id，读取群组成员对象 |
| notifications($uid) | $uid: 用户id | 通知对象列表 | 读取当前用户的通知信息 |
| menu($uid) | $uid: 用户id | 菜单列表 | 读取当前用户的菜单项(显示在底栏) |
webim/config.php中WebIM相关的配置参数，详细说明如下:
| 参数 | 类型 | 默认 | 说明 |
|---|---|---|---|
| isopen | bool | true | 是否开启WebIM |
| server | string | t.nextalk.im:8000 | WebIM消息服务器列表,逗号分割列表支持集群 |
| domain | string | localhost | WebIM插件与消息服务器通信的认证域名 |
| apikey | string | public | WebIM插件与消息服务器通信的认证APIKEY |
| theme | string | base | WebIM插件界面Theme |
| local | string | zh-CN | WebIM插件本地语言 |
| emot | string | default | WebIM插件表情库: emot, qq |
| opacity | inteter | 80 | WebIM插件工具条透明度 |
| enable_room | bool | true | WebIM插件是否支持群组聊天 |
| enable_discussion | bool | true | WebIM插件支持临时讨论组 |
| enable_noti | bool | true | WebIM插件显示通知按钮 |
| enable_shortcut | bool | false | WebIM插件支持快捷工具栏 |
| enable_chatlink | bool | true | WebIM插件支持聊天按钮 |
| enable_menu | bool | false | WebIM插件显示菜单栏 |
| show_unavailable | bool | true | WebIM插件显示不在线好友 |
| visitor | bool | true | WebIM插件支持访客 |
| upload | bool | false | WebIM插件支持文件上传 |
| censor | bool | false | 是否开启敏感词过滤 |
| robot | bool | true | WebIM插件是否支持机器人 |
WebIM集成包采用单入口结构实现，所有前端请求通过'webim/index.php'分发处理。
WebIM的业务逻辑代码在'webim/src/':
| 代码 | 说明 |
|---|---|
| App.php | WebIM应用入口类 |
| Router.php | WebIM应用AJAX请求分发处理 |
| Model.php | WebIM数据库访问 |
| Plugin.php | WebIM集成插件类 |
WebIM自身需要创建几张数据库表，用于保存聊天记录、用户设置、临时讨论组、访客信息。MySQL数据库脚本在'webim/install.sql'文件:
| 数据库表 | 说明 |
|---|---|
| webim_histories | 历史聊天记录表 |
| webim_settings | 用户个人WebIM设置表 |
| webim_buddies | 好友关系表(注: 如果项目没有自身的好友关系，可以通过该表存储) |
| webim_visitors | 访客信息表 |
| webim_rooms | 临时讨论组表(注: Plugin.php是集成项目的固定群组，webim_rooms表是存储WebIM自己的临时讨论组 |
| webim_members | 临时讨论组成员表 |
| webim_blocked | 群组是否block |
公司: NexTalk.IM
作者: Feng Lee
版本: 5.7.1 (2014/10/15)