1 序言协议许可版权声明关于我们版本说明基础应用目录结构模块目录开发规范配置 install 目录下的 module.php 文

Size: px

Start display at page:

李累公孙
7 years ago
Views:

1 YTF-DM 开发文档 Version 1.0

3 1 序言 1.1 协议许可参照 : 1.2 版权声明发布本资料须遵守开放出版许可协议 1.0 或者更新版本未经版权所有者明确授权, 禁止发行本文档及其被实质上修改的版本未经版权所有者事先授权, 禁止将此作品及其衍生作品以标准 ( 纸质 ) 书籍形式发行如果有兴趣再发行或再版本手册的全部或部分内容, 不论修改过与否, 或者有任何问题, 请联系版权所有者 Yuantuan<tq@yuantuan.com> 有关 YTF 项目及本文档的最新资料, 请及时访问 YTF 项目主站本文档的版权归 YTF 文档小组所有, 本文档及其描述的内容受有关法律的版权保护, 对本文档内容的任何形式的非法复制, 泄露或散布, 将导致相应的法律责任 1.3 关于我们 YTF-DM 是什么 : YTF-DM 是基于 YTF 核心框架开发的一套一个模块 ( 积木 ) 化系统, 全名叫 YTF-DiyModule 自定义模块化系统, 支持在线安装在线配置自动配置菜单自动处理模块化路由白名单自动缓存模块配置 1.4 版本说明版本 : YTF 小组制作成都猿团科技有限公司

4 1.0 版发布日期 :2016 年 6 月首次公开发行版本 2 基础 2.1 应用目录结构 www WEB 部署目录 common 公共文件 config 配置文件 controllers 控制器 core 核心文件 log 日志记录 models Model 层 modules 项目模块 org 扩展 runtime 缓存文件 smarty smarty 模板引擎 views 视图 webroot 静态文件和 index 入口开发人员可以在这个基础之上灵活调整友情提示 : 以上目录名为 (common,controllers,config,models,modules,views,webroot) 为开发者经常要操作的目录. 2.2 模块目录 YTF-DM 采用模块化的设计架构, 下面是一个应用目录下面的模块目录结构, 每个模块可以方便的迁移和部署, 模块的目录结构与 YTF 核心框架一样, 只是额外增加一个 install 目录, 该目录必须包含, 以下是一个 demo 模块的目录图标 modules 模块目录结构如下 : demo demo 模块目录 ( 含有子模块 ) admin demo 下子模块 admin common 当前模块全局函数文件目录 controllers 当前模块控制器文件目录 models 当前模块数据模型文件目录 YTF 小组制作成都猿团科技有限公司

5 view 当前模块视图文件目录 org 当前模块扩展文件目录 install 模块安装目录 install.sql 安装时所执行的 sql 代码 update.sql 更新时所执行的 sql 代码 ( 版本更新时按需存放 ) uninstall.sql 卸载时所执行的 sql 代码 module.php 模块配置文件 readme.md Markdown 格式的模块说明文件友情提示 : 一个应用中的模块个数不限定, 模块下的子模块也不限定. 2.3 开发规范 YTF-DM 系统的所有开发规范请参照 YTF 框架说明 3 配置 3.1 install 目录下的 module.php 文件详细说明 module.php 返回数组格式其中包含 4 个主要参数缺一不可 : module( 模块基本信息 ) config( 模块配置参数 ) admin_menu( 后台管理菜单 ) user_menu( 前台用户菜单 ) 通过配置 module.php 的 config 后台系统会自动根据 config 配置信息生成表单, 并生成模块配置缓存文件, 以便于开发者及用户自定义控制模块参数以下是配置的 demo 示例 : <?php return [ // 模块信息及说明 'module' => [ // 模块名 ( 与模块目录一致 ) 'name' => 'project', // 模块标题 'title' => ' 众包项目 ', 'ico' => 'project', // 模块描述 'description' => ' 提供项目发布项目管理项目类型项目跟踪权限指派客服指派附件项目支付等功能 ', // 开发者 YTF 小组制作成都猿团科技有限公司

6 'developer' => ' 成都猿团科技有限公司 ', // 开发者网址 'website' => ' // 当前模块的版本号 'version' => '1.9.0', // 版本依赖 'dependences' => [ 'admin' => '1.0.0', 'user' => '1.0.0', 'wallet' => '1.0.0', 'order' => '1.0.0' // 模块配置 'config' => [ // 单选框 name 为 radio 'radio' => [ 'title' => 'radio 是否开启 ', 'type' => 'radio', '1' => ' 开启 ', '0' => ' 关闭 ', 'value' => '0', // 表单文本框 name 为 text 'text' => [ 'title' => 'text 标题 ', 'type' => 'text', //type: radio text select textarea editor checkbox 'value' => ' 默认的 text', // 下拉列表 name 为 select 'select' => [ 'title' => 'select 标题 ', 'type' => 'select', YTF 小组制作成都猿团科技有限公司

7 'option1' => 'option 值 1', 'option2' => 'option 值 2', 'option3' => 'option 值 3', 'value' => 'option1', // 表单文本域 name 为 textarea 'textarea' => [ 'title' => 'textarea 标题 ', 'type' => 'textarea', 'cols' => '100', 'rows' => '5', 'value' => ' 默认的 Textarea', // 表单复选框 name 为 checkbox 'checkbox' => [ 'title' => 'checkbox 标题 ', 'type' => 'checkbox', '1' => ' 工程师 ', '2' => 'PHP', '3' => 'Android', '5' => 'IOS', '6' => 'HTML5', '7' => ' 前端工程师 ', checkbox 默认选项支持多选 'value' => [ '3', '4', '7' YTF 小组制作成都猿团科技有限公司

8 // 后台管理菜单 'admin_menu' => [ '0' => [ 'title' => ' 项目管理 ', 'ico' => 'ico', 'child' => [ '0' => [ 'title' => ' 项目 1', 'url' => '', 'ico' => 'ico' '1' => [ 'title' => ' 项目 2', 'url' => '', 'ico' => 'ico' '2' => [ 'title' => ' 项目 3', 'url' => '', 'ico' => 'ico' '1' => [ 'title' => ' 项目管理 2', 'ico' => 'ico', 'child' => [ '0' => [ 'title' => ' 项目 1-2', 'url' => '', 'ico' => 'ico' '1' => [ 'title' => ' 项目 2-2', 'url' => '', 'ico' => 'ico' '2' => [ 'title' => ' 项目 3-2', 'url' => '', 'ico' => 'ico' YTF 小组制作成都猿团科技有限公司

9 ; // 前台用户菜单 'user_menu' => [ '0' => [ 'title' => ' 内容管理 ', 'ico' => ' 图标 ', 'url' => ' 链接 ' config 下的是模块的字段配置, 字段类型分为 radio text select textarea checkbox 几种类型配置说明如下 : 单选 radio: [ 'title' => 'radio 是否开启 ', 'type' => 'radio', '1' => ' 开启 ', '0' => ' 关闭 ', 该值为 options 的 key 'value' => '0', 文本框 text: [ 'title' => 'text 标题 ', 'type' => 'text', 'value' => ' 默认的 text 的 value', 下拉列表 select: [ YTF 小组制作成都猿团科技有限公司

10 'title' => 'select 标题 ', 'type' => 'select', 'option1' => 'option 值 1', 'option2' => 'option 值 2', 'option3' => 'option 值 3', 'value' => 'option1', 文本域 textarea: [ 'title' => 'textarea 标题 ', 'type' => 'textarea', // 可见宽度 'cols' => '100', // 可见行数 'rows' => '5', 'value' => ' 默认的 Textarea 文本内容 ', 复选框 checkbox: [ 'title' => 'checkbox 标题 ', 'type' => 'checkbox', '1' => ' 工程师 ', '2' => 'PHP', '3' => 'Android', YTF 小组制作成都猿团科技有限公司

11 '5' => 'IOS', '6' => 'HTML5', '7' => ' 前端工程师 ', checkbox 默认选项支持多选数组类型 'value' => [ '3', '4', '7' 3.2 模块配置文件的缓存读取通过 ytf_getmoduleconfig($module_name) 函数获取模块的配置文件例 :ytf_getmoduleconfig('project') 返回的是一个配置文件数组, 开发者可以按需调用 ( 不传参数时默认调用当前模块缓存配置 ) 3.3 模块 sql 文件说明 sql 文件只需要把 sql 原始的代码放入即可, 唯一不同的是表前缀需要用 {{ytf_tablepre}} 代替即可 3.4 readme.md 文件说明该文件为 Markdown 语法文件, 相关的写法可以参考 Markdown 相关的说明该文件仅作为模块的说明以及详细介绍使用 4 目录权限 4.1 目录权限列表 ( 以下需要目录读写权限 ) runtime webroot/uploads log config YTF 小组制作成都猿团科技有限公司

12 5 YTF-DM 路由 5.1 URL 介绍 YTF-DM 默认使用 YTF 框架的子模块形式, 根据 YTF 框架说明 URL 路由格式是这样的 : 例 : 网址 / 模块 / 子模块 / 控制器 / 方法其中如果控制器与方法是都是 index, 那么可以简写为那么在没有子模块控制器的情况下, 系统会自动调用父模块下面的控制器如 : 这样的路由情况下会直接调用 demo 模块下的 controllers 里面的控制器 YTF 小组制作成都猿团科技有限公司

PowerPoint 演示文稿

PowerPoint 演示文稿按钮对象 (button) 当 JavaScript 读到标记中的 type 属性值为 button 时, 自动建立一个按钮对象, 并将该对象放到表单对象的 elements 数组当中按钮对象包括 : 普通按钮 (button) 提交按钮 (submit) 重置按钮 (reset) 1. 使用按钮对象的格式 document.forms[ 索引值 ].elements[ 索引值

1 序言 协议许可 版权声明 关于我们 版本说明 基础 应用目录结构 模块目录 开发规范 配置 install 目录下的 module.php 文

1 序言协议许可版权声明关于我们版本说明基础应用目录结构模块目录开发规范配置 install 目录下的 module.php 文