本框架遵循THINKPHP的开发规范,详情请参照[THINKPHP开发规范](https://www.kancloud.cn/manual/thinkphp5/118007)
## 命名规范
### 目录和文件
* 目录使用小写+下划线;
* 类库、函数文件统一以`.php`为后缀;
* 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;
* 类文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名;
* 类名和类文件名保持一致,统一采用驼峰法命名(首字母大写);
### 函数和类、属性命名
* 类的命名采用驼峰法(首字母大写),例如`User`、`UserType`,默认不需要添加后缀,例如`UserController`应该直接命名为`User`;
* 函数的命名使用小写字母和下划线(小写字母开头)的方式,例如`get_client_ip`;
* 方法的命名使用驼峰法(首字母小写),例如`getUserName`;
* 属性的命名使用驼峰法(首字母小写),例如`tableName`、`instance`;
* 以双下划线“\_\_”打头的函数或方法作为魔术方法,例如`__call`和`__autoload`;
### 常量和配置
* 常量以大写字母和下划线命名,例如`APP_PATH`和`THINK_PATH`;
* 配置参数以小写字母和下划线命名,例如`url_route_on`和`url_convert`;
### 数据表和字段
* 数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如`think_user`表和`user_name`字段,不建议使用驼峰和中文作为数据表字段命名。
### 应用类库命名空间规范
应用类库的根命名空间统一为app(不建议更改,可以设置`app_namespace`配置参数更改,`V5.0.8`版本开始使用`APP_NAMESPACE`常量定义);
例如:`app\index\controller\Index`和`app\index\model\User`。
- 序言
- 基础
- 开发规范
- 目录结构
- 下载安装
- 快速开发
- 创建一个表格
- 设置页面标题
- 设置页面提示
- 创建右侧按钮
- 创建顶部按钮
- 隐藏和替换按钮
- 隐藏第一列多选框
- 一次添加多行列表
- 添加一列
- 字段类型
- status
- text
- text.edit
- picture
- callback
- img_url
- pictures
- link
- files
- switch(2.0+)
- 设置表格主键
- 创建一个顶部搜索
- 调用js
- 创建快捷搜索
- 添加数量索引
- 添加表头排序(2.0.0)
- 添加一个右侧弹窗按钮
- 创建一个表单
- 表单字段说明
- 文本框
- 密码框
- 单选框
- 复选框
- 单图上传
- 多图上传
- 下拉框
- 多行文本
- 隐藏域
- 单文件上传
- 多文件上传
- 富文本编辑器
- 静态文本
- 排序
- 数字输入框
- 选择图标
- 关联联动
- 多级联动
- selectAjax(2.0+)
- 使用自定义JS文件
- 使用自定义CSS文件
- 公用函数
- 框架common
- is_signin
- data_auth_sign
- parse_attr
- parse_sql
- get_client_ip
- get_file_url
- get_files_url
- get_thumb
- hook
- p
- get_location
- format_linkage
- format_bytes
- action_log
- parse_action
- execute_action
- role_auth
- module_config
- addons_menage
- addons_config
- get_addons_class
- addons_action_exists
- addons_model_exists
- addons_validate_exists
- get_addons_model
- get_model_name
- get_model_title
- get_model_type
- get_model_table
- is_default_field
- table_exist
- implode_attr
- parse_array
- parse_name
- parse_config
- addons_parse_config
- addons_action
- get_adminname
- get_nickname
- set_config_value
- get_file_name
- format_time
- get_order_sn
- get_msectime
- timeToHIS
- getMobileType
- curl_post
- friend_date
- str2sub
- createLinkagesToken
- get_level_data
- get_level_pid
- get_level_key_data
- clear_js
- get_sex
- get_age
- user_is_signin
- user_role_auth
- filter
- filter_data
- time_tran
- search_time
- time2string
- check_password
- check_mobile
- push
- common模块
- 模块开发
- 创建模块信息
- 安装模块
- 模块配置
- 控制器
- 创建菜单
- 第一个控制器
- 方法参考
- 导出模块
- 插件开发
- 插件结构
- 插件信息
- 管理界面的字段信息
- 新增或编辑字段
- 插件钩子
- 数据库表前缀
- 插件配置
- 插件开发
- 控制器
- 模型
- 验证器
- 方法参考
- 自定义表
- 接口开发
- 新增接口
- 请求参数/返回参数
- 业务流程
- 应用管理
- MOCK接口
- 其他说明
- Redis使用说明
- 图片上传说明
- CMS模块说明
- 函数参考
- 商城模块说明
- 购物流程
- 直接购买提交购物订单
- 购物车流程
- 商品添加到购物车
- 购物车中商品数量变化
- 购物车提交订单
- 单客服使用说明
- 服务部署
- 客户端调用
- 后台客服端使用
- 更新说明(2.0+)