技术文库
[ 隐藏 ][ 展开 ]插件机制
插件设计的准备工作
插件实现流程
开始编写记事狗微博插件,您应当首先对插件实现的流程有一个大致的了解,以下是我们推荐的插件编写流程:
§ 熟练使用 Jishigou 微博系统后,对希望完善或补充的个性化功能进行评估,进而提出插件的功能需求。
§ 对插件做一个概括性的设计,例如:需要使用什么菜单、什么参数,配置哪些选项、数据结构如何设计、前后台实现哪些功能等等。
§ 阅读本文档并在系统设置中实际体验 Jishigou 插件接口所实现的功用,例如:您的插件应当如何设计才能良好的挂接到微博系统中来。插件接口能够实现哪些功能、不能实现哪些功能,插件为此而需要做的优化、改造和取舍。
§ 编写相应程序代码和模板语句,实现所需的功能并进行代码测试、兼容性测试和代码改进。
§ 如果需要公开您的插件,可以用插件导出的方式,将插件配置信息导出到一个 XML 文件中,连同相应的程序和模板文件一同打包。同时,编写一个适合新手的插件的说明书也是必不可少的,其中包括:插件适用的 Jishigou 版本、功能概述、兼容性声明、安装方法、使用方法、卸载方法等等。
§ 将插件提供给他人,或自己使用,根据使用者反馈,对插件进行完善。插件实现流程至此结束。
文件命名规范
Jishigou 按照如下的规范对程序和模板进行命名,请在设计插件时尽量遵循此命名规范:
§ 可以直接通过浏览器访问的普通程序文件,以 .php 后缀命名,文件存在于根目录下。
§ 被普通程序文件,或引用程序文件引用的函数库或类库,以 .func.php(函数库) 或 .class.php(类库) 后缀命名,文件存在于 include/ 目录下。
§ 被普通程序文件引用的模块程序文件,以 .mod.php 后缀命名,文件存在于 modules/ 目录下。
§ 被普通程序文件或模块程序文件引用的业务逻辑程序文件,以 .logic.php 后缀命名,文件存在于 include/logic/ 目录下。
§ 模板文件,以 .html 后缀命名,插件模板文件存在于 templates/default/plugin/ identifier / 目录中,暂不支持手机版插件。
§ 使用后台数据备份功能生成的备份文件,通常以 .sql 为后缀,存放于 data/ 目录中。
§ 有些目录中存在内容为空白的 index.htm 文件,此类文件是为了避免 Web 服务器打开 Directory Index 时列目录可能产生的安全问题。
global.func.php 基本函数库和类库白皮书
include/function/global.func.php 是 Jishigou 的基本函数库和类库程序,可直接被所有的外部代码所使用,在您开始插件设计之前,可以先对其大致功能做一定的了解。在这里定义了:
§ 数据库类:DB
§ 加载类:load
§ 对象类:obj
§ 配置类:ConfigHandler
master.mod.php 模块功能白皮书
modules/master.mod.php 是 Jishigou 的通用初始化模块程序,其几乎被所有的外部代码所引用,在您开始插件设计之前,可以先对该模块的大致功能做一定的了解。master.mod.php 主要完成了以下任务:
§ 对不同 PHP 及操作系统环境做了判断和兼容性处理,使得 Jishigou 可以运行于各种不同配置的服务器环境下。
§ 初始化常量 IN_JISHIGOU 为 TRUE,用于 include 或 require 后续程序的判断,避免其他程序被非法引用。
§ 读取微博程序所在绝对路径,存放于常量 ROOT_PATH 中。
§ 加载所需的基本函数库。
§ 预置读入了每个模块的各种设置变量。
| 欢迎光临 杭州神话信息技术有限公司 (http://www.cenwor.com/) | Powered by Discuz! X2 |