model 模型层规范

模型基类

所有模型必须继承自 core\base\BaseModel ，该基类提供了通用的功能

<?php
namespace core\base;

use think\facade\Db;
use think\Model;

/**
 * 基础模型
 * Class BaseModel
 * @package app\model
 */
class BaseModel extends Model
{
    /**
     * 获取模型字段信息
     */
    public function getModelColumn()
    {
        // 实现逻辑...
    }

    /**
     * 处理搜索条件特殊字符（%、_）
     */
    public function handelSpecialCharacter($value)
    {
        $value = str_replace('%', '\%', str_replace('_', '\_', $value));
        return $value;
    }
}

类名规范

• 使用大驼峰命名法

• 模型类名应与数据表名对应（去除表前缀）

• 禁止使用Model后缀

文件名规范

• 文件名与类名保持一致

• 使用 .php 后缀

• 统一使用UTF-8编码

模型注释规范

类注释

每个模型类必须有完整的类注释

/**
 * 会员模型
 * Class Member
 * @package app\model\member
 */
class Member extends BaseModel

方法注释

所有公共方法必须有完整的注释，包括参数说明和返回值

/**
 * 创建时间搜索器
 * @param Query $query
 * @param $value
 * @param $data
 */
public function searchCreateTimeAttr(Query $query, $value, $data)