### 命名規范
`LiveStar API`遵循PSR-2命名規范和PSR-4自動加載規范,并且注意如下規范:
### 目錄和文件
* 目錄不強制規范,駝峰和小寫+下劃線模式均支持;
* 類庫、函數文件統一以`.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`字段,不建議使用駝峰和中文作為數據表字段命名。
- 前言
- 基礎說明
- 開發規范
- 目錄結構
- 狀態說明
- 返回說明
- 登錄模塊
- 第三方注冊
- 手機號注冊
- 手機號登錄
- 獲取驗證碼
- 重置密碼
- 退出登錄
- 用戶模塊
- 首頁列表
- 明星分類
- 明星列表
- 直播列表
- 預播列表
- 回放列表
- 點贊直播
- 支付觀看
- 進離房間
- 訂閱預播
- 呼喚列表
- 明星主頁
- 明星預播
- 明星回放
- 守護列表
- 觀看回放
- 明星檔案
- 直播信息
- 分享直播
- 明星模塊
- 預播列表
- 開始直播
- 進離直播
- 初始預播
- 預播提交
- 守護列表
- 明星檔案
- 明星主頁
- 賬戶詳情
- 明星回放
- 預告列表
- 明星背景
- 贊助商
- 用戶操作
- 個人信息
- 賬戶余額
- 關注取消
- 我關注的
- 我訂閱的
- 修改資料
- 賬戶經驗
- 禮品模塊
- 禮物列表
- 明星送禮
- 用戶送禮
- 隨機紅包
- 固定紅包
- 呼喚明星
- 消息模塊
- 未讀消息
- 設置已讀
- 發送消息
- 消息中心
- 消息列表
- 查看消息
- 留言評論
- 留言詳情
- 評論詳情
- 私信詳情
- 私信列表
- 系統模塊
- 公告信息
- 版本控制
- 用戶反饋
- 圖像上傳
- 廣告接口
- 搜索明星
- 地區數據
- 支付模塊
- 購買類型
- 支付訂單
- 水果驗證
- 圈子模塊
- 發布動態
- 我的圈子
- 我的留言
- 圈子列表
- 評論列表
- 點贊圈子
- 發表評論
- 分享圈子
- 記錄模塊
- 購買記錄
- 觀看記錄
- 紅包記錄
- 中獎記錄
- 獲獎記錄
- 送禮記錄
- 流量模塊
- 流量列表
- 購買流量