项目文档

本文档是Industry SCRM API项目的开发文档,包含了系统架构、开发规范、API使用等相关内容。

文档结构

核心文档

系统安装.md：系统安装指南
接口说明.md：API接口说明
支付.md：支付功能相关文档
队列.md：消息队列相关文档
saas.md：SaaS相关文档
form.md：表单相关文档

开发指南

插件开发

插件开发/index.md：插件开发指南
插件开发/api.md：插件API开发指南
插件开发/model.md：插件模型开发指南
插件开发/search.md：插件搜索功能开发指南
插件开发/命令行.md：插件命令行工具使用指南

控制器

控制器/controller.md：控制器开发指南
控制器/search.md：搜索控制器开发指南
控制器/changeField.md：字段变更相关指南

模型

模型/model.md：模型开发指南
模型/behavior.md：模型行为开发指南
模型/验证规则.md：模型验证规则指南

数据库

数据库/数据库配置.md：数据库配置指南
数据库/事务.md：数据库事务使用指南
数据库/读写分离.md：数据库读写分离配置
数据库/分表.md：数据库分表指南
数据库/字段设计要求.md：数据库字段设计要求
数据库/集群.md：数据库集群配置
数据库/sql执行.md：SQL执行指南
数据库/smproxy.md：SMProxy使用指南

缓存

缓存/关于缓存.md：缓存使用指南
缓存/cookie.md：Cookie使用指南

命令行

命令行/console.md：控制台开发指南
命令行/command.md：命令行工具开发指南

事件

事件/addonsEvent.md：插件事件开发指南

用户

用户/用户信息获取.md：用户信息获取指南

技术文档

PHP SDK

phpSdk/README.md：PHP SDK文档
phpSdk/物联网PHP-SDK使用指南.md：物联网PHP SDK使用指南

RPC

rpc/start.md：RPC服务启动指南
rpc/client.md：RPC客户端使用指南
rpc/http.md：HTTP RPC使用指南
rpc/addons.md：插件RPC使用指南
rpc/数据库/：数据库RPC相关文档

Composer

composer/composer.md：Composer使用指南

开发规范

代码规范

遵循 PSR-2 代码风格规范
遵循 PSR-4 命名空间规范
类名使用大驼峰命名法
方法名和变量名使用小驼峰命名法
常量使用全大写加下划线命名法

目录规范

插件目录：addons/{插件标识}/
控制器目录：controllers/ 或 api/
模型目录：models/
配置目录：config/
视图目录：views/

命名规范

插件标识：小写字母加下划线,如 diandi_mall
类名：大驼峰命名法,如 GoodsController
方法名：小驼峰命名法,如 actionIndex
变量名：小驼峰命名法,如 $userId
常量名：全大写加下划线,如 MAX_PAGE_SIZE

技术栈

PHP 7.4+
Yii2 框架
MySQL 数据库
Redis 缓存
RabbitMQ 队列
SMProxy 数据库代理

联系我们

技术支持：support@example.com
开发文档：https://docs.example.com
代码仓库：https://github.com/example/industry-scrm-api

更新日志

2026-01-30：整理文档结构,添加PHP SDK文档
2026-01-20：添加插件开发相关文档
2026-01-10：添加数据库相关文档
2026-01-01：初始文档结构搭建