# 数据库规范(草案)
## 表规范
* 命名统一小写下划线
* 非CMF核心应用,统一带应用表前缀,如portal_
* 插件表,统一带插件表前缀,如:plugin_demo_
* 表默认编码utf8mb4,默认排序规则utf8mb4_general_ci
* 引擎统一innodb
* 写表注释
## 字段规范
* 命名统一小写下划线
* 非自增主键一定要写字段注释
* 数据类型尽量用数字类型,数字类型的比字符类型的要快很多。
* 数据类型尽量小,这里的尽量小是指在满足可以预见的未来需求的前提下的,但是又不能太小
* 尽量不要允许NULL
* 布尔类型的值均以 is、has、exist 或者 can开头
* create_time作为记录创建时间
* update_time作为记录更新时间
* delete_time作为记录软删除时间
* 需要软删除的表统一加delete_time字段
* status表示记录状态
* table_name作为表名,字段varchar长度64
* remark代表备注,给管理员区分记录类型用
* description代表描述给前台用户用
* list_order代表记录排序字段,类型float,默认值10000,默认排序按从小到大
* image 代表图片,thumbnail 代表缩略图,photos代表相册
* 固定长度的字符串用char不用varchar
* more代表表扩展属性,text类型
* 除user表,其他表用user_id代表用户id
* parent_id代表父级ID
* 多语言排序要求字符串类型,统一utf8mb4_unicode_ci
## 内容保存规范
* thinkcmf所有字段内容都是`htmlspecialchars`方法处理过的
## 富文本字段保存规范
* 富文本字段里在保存时要用`htmlspecialchars_decode`解密后用`cmf_replace_content_file_url`处理后,再`htmlspecialchars`方法处理后再保存到数据库
> 注意`cmf_replace_content_file_url`第二个参数要设置为`true`
## 富文本字段显示规范
* 富文本字段里在从数据库取出时要用`htmlspecialchars_decode`解密后用`cmf_replace_content_file_url`处理
## 文件路径保存规范
* 所有上传的文件在数据库的保存格式都应该是相对路径,相对于 `upload` 目录,如`/upload/20170912/b249b3a5bd5ab59f726afb5c73eae699.jpg`在数据库中应该为`20170912/b249b3a5bd5ab59f726afb5c73eae699.jpg`, 在从数据库取出后可以用`cmf_get_image_url`函数和`cmf_get_file_download_url`函数转化为可以访问的 url 和可以下载的 url;
- 序言
- 基础
- 安装ThinkCMF
- 为了更爽
- 目录结构
- 入口文件
- 第三方库
- 开发规范
- 数据库规范
- 调试模式
- URL访问
- 应用
- 配置
- 路由
- 控制器
- 控制器定义
- 控制器模板赋值
- 控制器模板渲染
- 前台控制器
- 前台用户控制器
- 后台控制器
- 跳转,AJAX返回和重定向
- URL生成
- 请求
- 请求信息
- 输入变量
- 请求类型
- 获取请求头信息
- 伪静态
- 更多
- 系统函数
- cmf_auth_check 用户权限检查
- cmf_captcha_check图片验证码验证
- cmf_check_mobile 检查手机号
- cmf_check_user_action 用户访问控制
- cmf_check_verification_code 数字验证码检查
- cmf_clear_cache清空系统缓存
- cmf_clear_verification_code 清除数字验证码
- cmf_compare_password 用户密码比较
- cmf_current_lang 判断当前语言包
- cmf_generate_user_token生成用户token
- cmf_get_admin_style 获取后台风格
- cmf_get_content_images 获取HTML图片
- cmf_get_current_admin_id 登录管理员ID
- cmf_get_current_admin_theme获取当前后台模板
- cmf_get_current_theme获取前台当前模板
- cmf_get_current_user 获取登录用户信息
- cmf_get_current_user_id 登录用户ID
- cmf_get_domain返回带协议的域名
- cmf_get_file_download_url 获取文件下载链接
- cmf_get_file_extension 获取文件扩展名
- cmf_get_image_url 获取图片 URL
- cmf_get_option 获取系统配置
- cmf_get_plugin_class 获取插件类名
- cmf_get_plugin_config获取插件配置
- cmf_get_root 网站根目录
- cmf_get_site_info 获取网站信息
- cmf_get_theme_path获取前台模板根目录
- cmf_get_upload_setting获取上传配置
- cmf_get_user_avatar_url 获取用户头像URL
- cmf_get_verification_code 生成数字验证码
- cmf_is_android 判断是否为安卓手机
- cmf_is_ios 判断是否为ios访问
- cmf_is_ipad 判断是否为ipad访问
- cmf_is_iphone 判断是否为iphone访问
- cmf_is_mobile 判断是否为手机
- cmf_is_user_login 判断用户是否登录
- cmf_is_wechat 判断是否为微信
- cmf_password 密码加密
- cmf_plugin_url 插件URL生成
- cmf_random_string随机字符串生成
- cmf_replace_content_file_url 替换编辑器文件地址
- cmf_scan_dir 替代scan_dir的方法
- cmf_send_email 发送邮件
- cmf_set_dynamic_config 设置动态配置
- cmf_set_option 设置系统配置
- cmf_split_sql 切分SQL文件
- cmf_update_current_user 更新当前用户信息
- cmf_url_encode 生成base64的url
- cmf_verification_code_log 验证码发送日志
- cmf_version获取版本号
- get_client_ip 获取客户端IP地址
- hook 添加钩子
- 数据库
- 数据库配置
- 添加数据
- 更新数据
- 查询数据
- 删除数据
- 事务操作
- 更多数据库操作
- 模型
- 模型定义
- 添加数据
- 更新数据
- 查询数据
- 删除数据
- 应用
- 应用的概念
- 应用开发流程
- 导航共享
- 几个重要基类
- 后台菜单注解
- 用户操作配置
- URL 规则配置
- 应用第三方库
- API
- 规范
- 状态码说明
- 版本号
- 资源控制器模板
- 成功返回
- 错误返回
- API路由
- API基类控制器
- API应用开发流程
- API第三方库
- 模板
- 模板常量
- 模板标签
- 变量输出
- 系统变量
- 请求参数
- 使用函数
- 使用默认值
- 使用运算符
- 三元运算
- 原样输出
- 模板注释
- 模板目录
- 包含文件
- 模板布局
- 模板继承
- 网站信息
- 内置标签
- 循环输出标签
- 比较标签
- 条件判断
- 标签嵌套
- 原生PHP
- 定义标签
- CMF标签
- 导航标签
- 子导航标签
- 验证码标签
- 幻灯片标签
- 钩子标签
- 友情链接标签
- 分页标签
- 傻瓜式模板
- 什么是傻瓜式模板
- 模板描述文件
- 模板文件配置
- 模板变量类型
- 模板变量数据源
- 导航模板数据源
- 导航菜单模板数据源
- 幻灯片模板数据源
- 模板切换
- 插件
- 插件钩子
- 核心钩子
- 前台模板钩子
- 后台钩子
- send_mobile_verification_code
- comment
- guestbook
- admin_dashboard
- switch_theme
- admin_login
- admin_init
- home_init
- 插件类主文件
- 插件开发流程
- 插件配置
- 插件控制器
- 插件后台管理控制器
- 插件后台菜单
- 插件视图
- 插件数据库模型
- 插件多语言
- 插件API控制器
- 插件第三方库
- 插件URL生成
- 前端
- Wind.js
- 前端组件
- js-ajax-form
- js-ajax-delete
- js-ajax-dialog-btn
- js-count-btn
- js-date
- js-datetime
- js-bootstrap-date
- js-bootstrap-datetime
- 专题
- 缓存
- Session
- Cookie
- 分页
- 验证码
- 文件上传
- 第三方扩展
- Swoole
- 附录
- 升级日志
- 升级指导