1.插件结构
┌─╌╌assets 静态资源
├─╌╌plugin.php 插件类
└─╌╌usualtool.config 配置引导
2.插件usualtool.config配置文件
详细说明
| 字段 | 必填 | 说明与取值 |
|---|---|---|
id |
必填 | 插件标志,由英文组成,用于唯一标识插件。必须保证与众不同且独一无二,建议使用小写字母 + 中划线/下划线,与插件目录名保持一致。 |
type |
必填 |
插件类别: 1 — 官网插件,只能从官网列表安装; 2 — 自用插件,可从本地安装,且不会出现在官网列表中。 |
cate |
必填 | 收费类型,取值 Sale(收费)/Free(免费)。 |
price |
必填 | 插件售价。如果没有请填写 0(保留两位小数)。 |
auther |
必填 | 插件作者。注明作者信息(名字/邮箱/站点),有助于开发者快速联络到你。无作者时填 NULL。 |
title |
必填 | 插件名称,展示在后台插件列表中,支持中文。 |
ver |
必填 | 版本号,建议语义化版本,便于后续升级比对。 |
description |
可选 | 插件详细说明:功能范围、依赖条件、使用方式、注意事项等。无内容时填 NULL。 |
installsql |
按需 |
安装数据表 SQL 代码。插件需要新增数据表时,把建表 SQL 写入 <![CDATA[ ... ]]> 内;
否则保持原样(默认 0,表示不执行任何 SQL)。
|
uninstallsql |
按需 |
卸载数据表 SQL 代码。用于引导用户在卸载插件后同步删除数据表;
如没有请保持原样(默认 0)。建议只写 DROP TABLE,并提醒用户先备份。
|
code |
按需 |
插件后端管理代码。插件涉及后端操作、设置时,把代码一并写入 <![CDATA[ ... ]]>;
代码首行使用 ?> 结束 XML,随后是 <?php ... 形式的 PHP 代码。
如无后端请保持原样。
|
3.加载方法
| 手工加载(默认) | 如果你开发的应用未预埋任何钩子(预埋插座),你需要在使用插件的代码中手工引入插件。如:<{plugin=>插件标志}> |
| 自动加载 | 如果你在开发的应用中直接加入诸如<{plugin=>插件标志}>的代码,那么在安装插件后会自动加载运行。请放心,未安装这个插件时,此代码会自动被程序忽略。 |
引用插件静态资源示例路径为:/assets/plugins/插件名/xxx.css
4.调用插件
插件后端代码储存在配置文件的code节点。插件类方法放在 /app/plugins/插件名 下。插件静态资源放在 /open/assets/plugins/插件名 下。
| 在模板中引用插件 | <{plugin=>插件名,方法名}> |
| 在动态脚本中引用插件 |
use usualtool\Lib\Inc; |
引用插件代码中的“方法名”,默认为index,若为index该参数可以忽略。