文章分页:
框架目录结构
框架部署目录(可为网站根目录或各级子目录) | ||
├ | index.php | 框架入口脚本 |
├ | readme.md | 框架介绍文档 |
├ | composer.json | composer扩展文件 |
├ | composer.lock | composer扩展文件 |
├ | favicon.ico | 网站图标文件 |
├ | LICENSE.txt | 框架协议文本 |
├ | error.log | 框架脚本错误记录(可通过管理后台或手动删除) |
├ | app | 目录,存放应用,框架自带应用详见后表 |
├ | config | 目录,存放各类框架配置文件 |
├ | cache | 目录,存放缓存(本目录需要可写,可通过管理后台或手动清除) |
├ | files | 目录,存放上传文件(本目录需要可写,框架提供的文件上传机制) |
├ | lib | 目录,存放各类框架核心功能库 |
├ | plugin | 目录,存放框架扩展插件 |
├ | static | 目录,存放框架静态文件,可不通过脚本直接调用 |
├ | vendor | 目录,存放各类框架扩展组件(js或php等,含composer扩展),框架提供统一调用模式 |
├ | .htaccess | Apache配置文件 |
├ | web.config | IIS配置文件 |
└ | NginX | Nginx配置文件 |
应用目录结构
应用是在框架基础上的独立功能组合,相关文件存放在框架APP目录对应应用名称的目录下,推荐结构如下:
APP目录/应用名称/ | ||
├ | config | 目录,配置文件描述,分语种,用于生成配置设置页面(参考 设置管理 栏目) |
├ | language | 目录,语言包文件,可通过框架自动调用 |
├ | module | 目录,针对不同请求的功能脚本,默认处理脚本为 index.php |
├ | template | 目录,模版文件,其下按照不用样式划分子目录 |
├ | asset | 目录,当前应用的资源文件,此目录下的文件可以直接通过"/[appName]/asset/[fileName]"的方式调用存放于"模版样式名子目录"下的文件,框架可自行根据设置调用,如设置了域名绑定,可进一步简化为"/asset/[fileName]"。例如:应用名为MyApp,模版类型为default,文件存储在 app/MyApp/asset/default/myfile.txt,调用网址为:http://hostname/MyApp/asset/myfile.txt |
├ | config.php | 配置信息(参考 设置管理 栏目) |
├ | index.php | 入口文件,规定不用路由信息所对应的功能脚本(必需) |
├ | info.php | 介绍文件,格式请参考自带样例(必需) |
├ | lib.php | 应用通用函数库,自动加载,建议定义命名空间以避免名称冲突 |
├ | global.php | 应用通用脚本,应用通用脚本,于所有功能代码之前自动加载 |
├ | plugin.php | 插件引用记录,通过框架后台控制,标注都有哪些插件用于当前应用 |
└ | route.php | 路由信息,格式详见路由章节 |
插件目录结构
插件为应用添加某一组功能,可通过框架后台插件管理设置参数,并在应用管理的插件选项中设置对应应用需调用那些插件,推荐结构如下:
PLUGIN目录/插件名称/ | ||
├ | index.php | 入口脚本,插件调用时将首先调用此文件(必需) |
├ | info.php | 介绍文件,格式请参考自带样例(必需) |
├ | class.php | 包含检测(check)、安装(install)、卸载(uninstall)以及其他基本功能(如模版标签解析,页面钩子等)的脚本(必需) |
├ | config.php | 配置信息(参考 设置管理 栏目) |
├ | route.php | 路由信息,格式详见路由章节 |
├ | template | 目录,存放插件所需的模版文件 |
├ | module | 目录,存放插件所需的脚本文件 |
├ | config | 目录,存放配置文件描述,分语种,用于生成配置设置页面 |
└ | language | 目录,存放语言包文件 |
框架自带应用
1 | myStep | 框架配置管理程序,用于设置各类框架功能 |
2 | Document | 框架各功能模块文档 |
3 | Sample | 框架各类功能测试,及调用样例 |
4 | CMS | 基于框架的内容管理系统(即本手册所用到的应用) |