1.模块结构
┌─lang 模块语言包(可选)
├─assets 模块静态资源(可选)
├─cache 缓存
├─front 前端控制
├─admin 后端控制
├─skin 模板视图
├─model 模型
├─controller 独立控制器(可选)
├─route.php 路由映射配置(可选)
└─usualtool.config 配置文件
引用模块静态资源示例路径为:/assets/modules/模块名/xxx.css
其中:
Lang语言包是标准的JSON文件其格式为:
{
"s": {
"language": "zh",
"charset": "utf-8",
"speak": "中文简体",
"web": "UT"
},
"l": {"参数":"翻译"}
}
文件名以标准国别为准。
admin、front存放后端与前端的动态脚本。
cache文件夹必须存在,给予写入权限,将自动写入缓存文件。
skin为模板目录,包含front、admin前端与后端的模板文件,其名称与动态脚本文件名称对应,后缀为.cms
2.usualtool.config配置文件
详细说明
| 字段 | 必填 | 说明与取值 |
|---|---|---|
id |
必填 | 模块标志,由英文组成,独一无二。建议与模块目录名保持一致(小写字母 + 中划线/下划线)。 |
type |
必填 |
模块类别: 1 — 官网模块,只能从官网列表安装; 2 — 自用模块,可从本地安装,且不会出现在官网列表中。 |
cate |
必填 | 收费类型,取值 Sale(收费)/Free(免费)。 |
auther |
必填 | 模块作者。注明作者信息(名字/邮箱/站点),有助于开发者快速联络到你。无作者时填 NULL。 |
title |
必填 | 模块名称,展示在后台模块列表中,支持中文。 |
ver |
必填 | 版本号,建议语义化版本,便于后续升级比对。 |
description |
可选 | 模块详细说明:功能范围、依赖条件、使用方式、注意事项等。无内容时填 NULL。 |
itemid |
必填 |
模块所属种类: 1 — 内容模块; 2 — 互联模块; 3 — 交互模块。 |
sorting |
必填 | 模块排序,数字。数字越小越靠前,对应 XML 标签 <sorting>。 |
prepose |
可选 |
前置模块,节点可选(对应 XML 标签 <befoitem>)。若不安装指定模块,本模块将无法运行。无依赖时填 NULL。
|
composer |
可选 |
模块依赖的 Composer 包,节点可选,多个用半角逗号分隔。 若不安装指定依赖,模块将提示无法运行。无依赖时留空。 |
starturl |
必填 | 模块启动地址,默认 index.php(对应 XML 标签 <starturl>)。 |
befoitem |
可选 |
模块前端文件列表。编写规则:url,url……,文件(带后缀)半角逗号分隔。如需在安装时复制目录到指定位置,使用 dir:images 写法,表示将模块下 images 目录复制到根目录 images。
|
backitem |
可选 |
模块后端文件列表。编写规则:title:url,title:url……,名称半角冒号接文件(带后缀),半角逗号分隔。示例: 广告管理:index.php,效果测试:test.php。
|
installsql |
按需 |
安装数据表 SQL 代码。模块需要新增数据表时,把建表 SQL 写入 <![CDATA[ ... ]]> 内;
否则保持原样(默认 0,表示不执行任何 SQL)。
|
uninstallsql |
按需 |
卸载数据表 SQL 代码。引导用户卸载模块后同步删除数据表;
如没有请保持原样(默认 0)。建议只写 DROP TABLE,并提醒用户先备份。
|