<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=gbk" />
<title>Discuz! X 插件开发手册</title>
<meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7" />
<link rel="stylesheet" href="data/discuz_guide.css" />
</head>
<body leftmargin="0" rightmargin="0" topmargin="0">
<script type="text/javascript" language="JavaScript" src="data/header.js"></script>
<div class="sd" id="sd"></div>
<div class="mn" id="mn">
<div class="mainbox">
<table cellpadding="0" cellspacing="0" border="0" style="table-layout: fixed">
<tr>
<td class="title">
<a name="title">插件设计</a>
</td>
</tr>
<tr>
<td>
<br />
您在开始进行社区插件的设计之前,有必要了解一下我们所推荐的插件设计方式,更好的规范性和兼容性,将使得您设计的插件受到更多使用者的欢迎,对于程序员而言,也有助于形成良好的编码习惯,实现自身能力的提升。如果您有意编写 Discuz! 社区插件,请按照先后顺序仔细阅读本文档。
<br />
<br />
<br />
</td>
</tr>
<tr>
<td class="title">
<a name="title">准备工作</a>
</td>
</tr>
<tr>
<td>
<br />
<p class="subtitle">
插件实现流程
</p>
<p>
开始编写社区插件,您应当首先对插件实现的流程有一个大致的了解,以下是我们推荐的插件编写流程:
</p>
<ul>
<li>
熟练使用 Discuz! 社区系统后,对希望完善或补充的个性化功能进行评估,进而提出插件的功能需求。
</li>
<li>
对插件做一个概括性的设计,例如:需要使用什么菜单、什么参数,配置哪些选项、数据结构如何设计、前后台实现哪些功能等等。
</li>
<li>
阅读本文档并在系统设置中实际体验 Discuz! 插件接口所实现的功用,例如:您的插件应当如何设计才能良好的挂接到社区系统中来。插件接口能够实现哪些功能、不能实现哪些功能,插件为此而需要做的优化、改造和取舍。
</li>
<li>
编写相应程序代码和模板语句,实现所需的功能并进行代码测试、兼容性测试和代码改进。
</li>
<li>
如果需要公开您的插件,可以用插件导出的方式,将插件配置信息导出到一个 XML 文件中,连同相应的程序和模板文件一同打包。同时,编写一个适合新手的插件的说明书也是必不可少的,其中包括:插件适用的 Discuz! 版本、功能概述、兼容性声明、安装方法、使用方法、卸载方法等等。
</li>
<li>
将插件提供给他人,或自己使用,根据使用者反馈,对插件进行完善。插件实现流程至此结束。
</li>
</ul>
<p class="subtitle">
文件命名规范
</p>
<p>
Discuz! 按照如下的规范对程序和模板进行命名,请在设计插件时尽量遵循此命名规范:
</p>
<ul>
<li>
可以直接通过浏览器访问的普通程序文件,以 .php 后缀命名。
</li>
<li>
被普通程序文件引用的程序文件,以 .inc.php 后缀命名。
</li>
<li>
被普通程序文件,或引用程序文件引用的函数库或类库,以 .func.php(函数库) 或 .class.php(类库) 后缀命名。
</li>
<li>
模板文件,以 .htm 后缀命名,插件模板文件存在于 source/plugin/
<font color="blue">
identifier
</font>/template/ 目录中,手机版插件模板存在于 source/plugin/
<font color="blue">
identifier
</font>/template/mobile/目录中
</li>
<li>
模板语言包文件,以 .lang.php 后缀命名,插件语言包文件开发时存放于 data/plugindata/ 目录中,文件名为
<font color="blue">
identifier
</font>.lang.php。
</li>
<li>
动态缓存文件,存放于 ./data/cache 目录中,依据不同的功用进行独立的命名。
</li>
<li>
使用后台数据备份功能生成的备份文件,通常以 .sql 为后缀,存放于 data/ 目录中。
</li>
<li>
有些目录中存在内容为空白的 index.htm 文件,此类文件是为了避免 Web 服务器打开 Directory Index 时可能产生的安全问题。
</li>
</ul>
<p class="subtitle">
class_core.php 模块功能白皮书
</p>
<p>
source/class/class_core.php 是 Discuz! 的通用初始化模块程序,其几乎被所有的外部代码所引用,在您开始插件设计之前,可以先对该模块的大致功能做一定的了解。class_core.php 主要完成了以下任务:
</p>
<ul>
<li>
对不同 PHP 及操作系统环境做了判断和兼容性处理,使得 Discuz! 可以运行于各种不同配置的服务器环境下。
</li>
<li>
初始化常量 IN_DISCUZ 为 TRUE,用于 include 或 require 后续程序的判断,避免其他程序被非法引用。
</li>
<li>
读取社区程序所在绝对路径,存放于常量 DISCUZ_ROOT 中。
</li>
<li>
加载所需的基本函数库 source/function/function_core.php。
</li>
<li>
通过 config/config_global.php 中提供的数据库账号信息,建立数据库连接。Discuz! 支持数据表的前缀,如需获得表的全名,可使用“DB::table('tablename')”方式。
</li>
<li>
判断用户是否登录,如登录标记 $_G['uid'] 为非 0,同时将 $_G['user'](加了 addslashes 的用户名,可用于不加修改的插入数据库)、
$_G['member']['username'](原始的用户名,可用于页面显示)、$_G['member']['password'](用户密码的MD5串)等相应用户信息赋值,其他用户信息存放于 $_G['member'],更多信息可通过“getuserprofile()”获取。
</li>
<li>
判断用户管理权限,将管理权限标记 $_G['adminid'] 为 1~3 中间的值。0 代表普通用户;1 代表论坛管理员;2 代表超级版主;3 代表论坛版主。
将用户权限按照其所在的主用户组 ID 标记为 $_G['groupid'],相关权限从该 $_G['groupid'] 所对应的系统缓存中读出,存放于 $_G['group']。
</li>
<li>
预置读入了每个模块的各种设置变量。
</li>
</ul>
<br />
<br />
</td>
</tr>
<tr>
<td class="title">
<a name="title">插件接口概述</a>
</td>
</tr>
<tr>
<td>
<br />
<p>
- 1
- 2
前往页