标准化论坛插件

最后更新:2016-05-20

插件说明

在使用航加平台(家居、房产、婚嫁、美食等)中,部分业务功能需要调取论坛数据进行展示,因此采用在论坛开发接口形式给航加平台提供数据,为了减少站点开发接口的技术成本,对于discuz和phpwind论坛站点,我们已经提供了统一标准化的插件供下载安装。

插件使用要求

由于基于标准化形式开发,站点论坛必须同时满足下列要求才能使用该插件:

  1. 站点没有对论坛进行过二次开发,因为二次开发可能会导致论坛原有功能被破坏,进一步导致插件无法使用论坛原有功能而不可用。

  2. phpwind论坛版本要求大于等于8.0且小于9.0;discuz论坛版本要求大于等于X2.0(包括X2.5、X3.0、X3.1、X3.2)。插件对论坛编码无要求,GBK和UTF-8均可使用。

对于未达到要求的站点还需由其技术人员自主开发调用接口,开发文档请见相关页面。

插件安装

这里对phpwind和discuz论坛插件安装过程进行说明。

discuz插件安装教程

  1. 下载的插件压缩包中包含一个hangjiaapi文件夹,该文件夹就是一个discuz插件,将该文件夹放入论坛根目录/source/plugin文件夹下,并给hangjiaapi/protected/runtime目录服务器写的权限(切记);

  2. 如图,修改论坛根目录/config/config_global.php文件,在该文件?>符号之前任意处增加一行代码:$_config['plugindeveloper'] = 1;,如果该文件中已经有这段代码则不需要再加了;如图

  3. 使用论坛创始人帐号到discuz后台->应用->插件->设计新插件中,将插件名称(name)填写为hangjiaapi,将唯一标识符(identifier)填写为hangjiaapi,其他留空即可,并点击保存,此时会提示插件已经添加完成并继续填写详细信息,这里就可以跳过了,无需填写详细信息,直接回到插件列表;如图

  4. 回到插件列表,会发现对了一个hangjiaapi插件,点击启用即可。至此安装完成。如图

phpwind插件安装教程

  1. 下载的插件压缩包中包含一个hangjiaapi文件夹,该文件夹就是一个phpwind插件,将该文件夹放入论坛根目录/hack文件夹下,并给hangjiaapi/protected/runtime目录服务器写的权限(切记);

  2. 进入phpwind后台插件列表,下方显示hangjiaapi为为安装插件,点击安装即可。至此完成安装。如图

可配置项

配置论坛附件地址域名(只支持pw插件)

针对一些特殊情况,站方不想使用默认或论坛所配置的附件域名地址,可通过文件配置的形式来单独定义,定义完成后,该插件给出到航加平台的附件数据地址将会使用所配置的域名地址,域名后的URI PATH保持不变。在插件目录的protected/config目录下新增一个名为local.php的本地配置文件,其内容格式为:

return [
    'db_bbsurl' => 'http://pic.xxx.com'
];

意味着论坛附件域名将以http://pic.xxx.com开头,请将该域名替换成你需要使用的域名。

插件下载

点此下载phpwind适用插件

点此下载discuz适用插件