emlog插件开发指南..docVIP

emlog插件开发指南（基于最新版本emlog 3.4.0） emlog支持插件机制，这样使得开发者可以方便地向emlog中添加自己需要的功能。 1.插件实现原理：在emlog整个运行过程中我们设定了一些动作事件，遇到这些事件时emlog会自动的调用插件绑定到该事件的上的所有插件函数，从而实现插件的功能。 2.插件运行机制 2.1 API函数? ? ? ? API函数addAction()? ? ? ? 本函数的功能是将对系统事件的绑定? ? ? ? 本函数有两个参数：$hook, $actionFunc。$hook是绑定事件的名称,$actionFunc 是绑定到该事件钩子上的函数名称? ? ? ? 例子:? ? ? ? addAction(save_log,plugin_addlog);? ? ? ? 例子中将plugin_addlog函数绑定到系统的save_log事件中,只要系统执行到了save_log事件时,就会调用plugin_addlog函数.? ? ? ? API函数doAction()? ? ? ? 本函数的功能是指定某个动作下绑定的所有事件函数? ? ? ? 本函数有一个固定的参数：$hook，$hook是执行动作的名称? ? ? ? 其他的参数则可以在调用本函数时依次传入,函数会自动的发送给钩子函数? ? ? ? 例子:? ? ? ? doAction(save_log,$id);? ? ? ? 这是emlog的添加日志事件,在添加日志后会触发,参数为新日志的$id号码.? ? ? ? 那么系统会自动的将$id传入到每一个绑定到本事件的钩子函数中。? 2.2 插件文件系统? ? ? ? 插件目录：/content/plugins/ 仅识别 “插件目录/插件名/插件名.php” 目录结构的插件。例如emlog默认的tips插件,其文件夹名称为tips,程序文件名称为tips.php 2.3 插件的激活与关闭在emlog后台的插件管理中,点击每个插件后的状态按钮即可激活/关闭插件。 2.4 插件的配置数据保存插件配置数据保存方式,可以有开发者自己决定,可以是写于php程序文件中,也可以是写入到数据库中. 3.插件开发标准 3.1 插件命名规则 插件名只能以半角的字母、数字、下划线(_)、横杠(-) 组合而成，且只能以字母作为开头 3.2 函数/变量命名标准????? ? 插件的所有函数/变量采用 插件名_ 作为前缀来命名????? ? 例如:????? ? $emlogplugin_var????? ? emlogplugin_dosomething()????? ? 采用这样的命名方式可以避免于其他插件的函数或者变量出现冲突. 3.3 代码书写规范 代码请严格参照emlog代码书写规范： /p/emlog/wiki/coding_criterion 与下面标准有冲突的以下面为标准?? 3.4 插件文件名称????? ? 插件主文件名称必须与插件所在文件夹名称相同????? ? 设定插件参数的配置程序文件名称必须为 “插件名称_setting.php”????? ? (注:该文件为可选,如果你的插件需要用户配置参数才需要该文件来完成配置功能)????? ? 例如:????? ? emlogplugin/??????????? ? emlogplugin.php??????????? ? emlogplugin_setting.php? 3.5 请在你的插件文件开头增加限制语句? ? ? ? 插件函数文件需要增加:? ? ? ? !defined(EMLOG_ROOT) exit(access deined!);? ? ? ? 如果不增加该语句,那么直接访问插件的程序文件php会爆出博客的物理路径,对博客的安全造成威胁。? 3.6 过滤相关参数? ? ? ? 如果你的插件需要接收一些参数,请务必严格过滤每一个变量的数据.? ? ? ? 具体的内容可以参考一下这篇文章 PHP 安全指南 ? ? ? ? /files/200709/1/index.html 3.7 前台链接使用绝对地址 如果插件有在前台显示任何链接，必须使用BLOG_URL 常量拼接出绝对地址。 如：相关日志插件在前台阅读文章页面显示相关日志的链接 $out .= pa href=\.BLOG_URL.?post={$val[gid]}\{$val[title]}/a/p;。 4、当前插件挂载点及说明 插件挂载点 所在文件 描述 doAction(adm