hdk-core/src/Constants/CommonErrorCode.php

<?php

/**
 * CommonErrorCode.php@hyperf-development-kit
 *
 * @author 李东云<dongyun.li@luxcreo.cn>
 * Powered by PhpStorm
 * Created on 2022/4/25
 */

namespace Singularity\HDK\Core\Constants;

use Hyperf\Constants\AbstractConstants;
use Hyperf\Constants\Annotation\Constants;

/**
 * Singularity\HyperfDevelopmentKit\Utils\Constants\CommonErrorCode@hyperf-development-kit
 *
 * @author 李东云<dongyun.li@luxcreo.cn>
 * Powered by PhpStorm
 * Created on 2022/4/25
 *
 * @see https://lux-software.yuque.com/htnx76/vcm2oc/pkzgpv
 */
#[Constants]
class CommonErrorCode extends AbstractConstants
{
    // =============== 9 服务器异常 =================
    /**
     * @Message("common_error.server_common_error")
     */
    public const SERVER_ERROR = 9000000;
    /**
     * @Message("common_error.program.default")
     */
    public const PROGRAM_ERROR = 9000000;
    // 901 逻辑错误
    /**
     * @Message("common_error.program.syntax.default")
     */
    public const PROGRAM_SYNTAX_ERROR = 9010001;
    // 902 SQL 错误
    /**
     * @Message("common_error.program.sql.default")
     */
    public const PROGRAM_SQL_ERROR = 9020001;
    /**
     * @Message("common_error.program.sql.update")
     */
    public const PROGRAM_SQL_UPDATE_ERROR = 9020101;
    // 90201 字段不存在
    /**
     * @Message("common_error.program.sql.column_not_found")
     */
    public const PROGRAM_SQL_COLUMN_NOT_FOUND = 9020101;
    /**
     * @Message("common_error.program.sql.insert")
     */
    public const PROGRAM_SQL_INSERT_ERROR = 9020201;
    // =============== 1 请求错误 =================
    // 101 请求方式有误
    /**
     * @Message("common_error.params.method.default")
     */
    public const REQUEST_METHOD_ERROR = 1010001;
    // 102 参数非法
    /**
     * 参数非法.
     * @Message("common_error.params.format_error")
     */
    public const FORMATTER_ERROR = 1020001;
    /**
     * 缺少参数.
     * @Message("common_error.params.error.default")
     */
    public const REQUEST_PARAMS_MISS = 1020002;
    /**
     * 签名非法.
     * @Message("common_error.params.error.default")
     */
    public const REQUEST_SIGN_ERROR = 1020003;
    // 103 参数错误
    /**
     * @Message("common_error.params.error.default")
     */
    public const REQUEST_PARAMS_ERROR = 1030001;
    // 10301 用户信息错误
    /**
     * @Message("common_error.params.error.user.default")
     */
    public const REQUEST_PARAMS_ERROR_USER = 1030101;
    /**
     * @Message("common_error.params.error.user.sign_up.default")
     */
    public const REQUEST_PARAMS_ERROR_USER_REGISTERED = 1030102;
    /**
     * @Message("common_error.params.error.user.username.unique")
     */
    public const REQUEST_PARAMS_ERROR_USER_USERNAME_UNIQUE = 1030111;
    /**
     * @Message("common_error.params.error.user.sec_phone.unique")
     */
    public const REQUEST_PARAMS_ERROR_USER_SEC_PHONE_UNIQUE = 1030121;
    /**
     * @Message("common_error.params.error.user.sec_phone.required")
     */
    public const REQUEST_PARAMS_ERROR_USER_SEC_PHONE_REQUIRED = 1030122;
    /**
     * @Message("common_error.params.error.user.sec_phone.undefined")
     */
    public const REQUEST_PARAMS_ERROR_USER_SEC_PHONE_UNDEFINED = 1030123;
    /**
     * @Message("common_error.params.error.user.sec_email.unique")
     */
    public const REQUEST_PARAMS_ERROR_USER_SEC_EMAIL_UNIQUE = 1030131;
    /**
     * @Message("common_error.params.error.user.sec_email.required")
     */
    public const REQUEST_PARAMS_ERROR_USER_SEC_EMAIL_REQUIRED = 1030132;
    /**
     * @Message("common_error.params.error.user.sec_email.undefined")
     */
    public const REQUEST_PARAMS_ERROR_USER_SEC_EMAIL_UNDEFINED = 1030133;
    /**
     * @Message("common_error.params.error.user.action.error")
     */
    public const REQUEST_PARAMS_ERROR_USER_ACTION_ERROR = 1030141;
    // 10302 验证码错误
    /**
     * @Message("common_error.params.error.code.error")
     */
    public const REQUEST_PARAMS_ERROR_CODE_ERROR = 1030201;
    /**
     * @Message("common_error.params.error.code.timeout")
     */
    public const REQUEST_PARAMS_ERROR_CODE_TIMEOUT = 1030202;
    /**
     * @Message("common_error.params.error.code.limit.minute")
     */
    public const REQUEST_PARAMS_ERROR_CODE_MAX_TIMES_MINUTE = 1030301;
    /**
     * @Message("common_error.params.error.code.limit.hour")
     */
    public const REQUEST_PARAMS_ERROR_CODE_MAX_TIMES_HOUR = 1030302;
    /**
     * @Message("common_error.params.error.code.limit.day")
     */
    public const REQUEST_PARAMS_ERROR_CODE_MAX_TIMES_DAY = 1030303;
    /**
     * @Message("common_error.params.error.target.format")
     */
    public const REQUEST_PARAMS_ERROR_TARGET_FORMAT = 1030401;
    /**
     * @Message("common_error.params.error.target.missing")
     */
    public const REQUEST_PARAMS_ERROR_TARGET_MISSING = 1030402;
    // =============== 2 鉴权问题 =================
    // 201 JWT 鉴权失败
    /**
     * @Message("common_error.auth.default")
     */
    public const UNAUTHORIZED = 200000;
    /**
     * @Message("common_error.auth.jwt.default")
     */
    public const AUTH_JWT_ERROR = 201000;
    // 20101 验证
    /**
     * @Message("common_error.auth.jwt.iat")
     */
    public const AUTH_JWT_IAT_ERROR = 2010101;
    /**
     * @Message("common_error.auth.jwt.nbf")
     */
    public const AUTH_JWT_NBF_ERROR = 2010102;
    /**
     * @Message("common_error.auth.jwt.exp")
     */
    public const AUTH_JWT_EXP_TIMEOUT = 2010103;
    /**
     * @Message("common_error.auth.jwt.iss")
     */
    public const AUTH_JWT_ISS_ERROR = 2010104;
    /**
     * @Message("common_error.auth.jwt.uid")
     */
    public const AUTH_JWT_UID_ERROR = 2010105;
    // 202 Session 鉴权
    /**
     * @Message("common_error.auth.session.default")
     */
    public const AUTH_SESSION_ERROR = 202000;
    // 20201 验证
    /**
     * @Message("common_error.auth.session.uid")
     */
    public const AUTH_SESSION_UID_ERROR = 2020101;
    /**
     * @Message("common_error.auth.session.created_at")
     */
    public const AUTH_SESSION_CREATED_AT_ERROR = 2020102;
    // 203 SAML 鉴权
    /**
     * @Message("common_error.auth.saml.default")
     */
    public const AUTH_SAML_ERROR = 203000;
    // 20301 验证
    /**
     * @Message("common_error.auth.saml.params.default")
     */
    public const AUTH_SAML_REQUEST_PARAMS_ERROR = 2030100;
    /**
     * @Message("common_error.auth.saml.params.saml_request")
     */
    public const AUTH_SAML_REQUEST_PARAMS_SAML_REQUEST = 2030101;
    // 204 无权访问
    /**
     * @Message("common_error.auth.forbidden.default")
     */
    public const FORBIDDEN = 204000;
    // 20401 无权访问
    /**
     * @Message("common_error.auth.forbidden.read.default")
     */
    public const FORBIDDEN_READ_ERROR = 2040101;
    // 20402 无权修改
    /**
     * @Message("common_error.auth.forbidden.update.default")
     */
    public const FORBIDDEN_UPDATE_ERROR = 2040201;
    /**
     * @Message("common_error.auth.forbidden.update.address.unique")
     */
    public const FORBIDDEN_UPDATE_ADDRESS_DEFAULT_UNIQUE_ERROR = 2040211;
    // 20403 无权创建
    /**
     * @Message("common_error.auth.forbidden.create.default")
     */
    public const FORBIDDEN_CREATE_ERROR = 2040301;
    /**
     * @Message("common_error.auth.forbidden.create.wechat.redundant")
     */
    public const FORBIDDEN_CREATE_WECHAT_REDUNDANT_ERROR = 2040311;
    // 20404 无权删除
    /**
     * @Message("common_error.auth.forbidden.delete.default")
     */
    public const FORBIDDEN_DELETE_ERROR = 2040401;
    /**
     * @Message("common_error.auth.forbidden.delete.wechat.only")
     */
    public const FORBIDDEN_DELETE_ONLY_USERNAME_WITH_WECHAT = 2040411;
    // 205 App 鉴权
    /**
     * @Message("common_error.auth.app.default")
     */
    public const AUTH_APP_ERROR = 205000;
    // ============== 3 依赖服务出错 ===============
    // 303 缓存异常
    // 30301 Redis 异常
    /**
     * @Message("common_error.server.cache.redis.default")
     */
    public const SERVER_CACHE_REDIS_ERROR = 3030101;
    /**
     * @Message("common_error.server.cache.redis.refused")
     */
    public const SERVER_CACHE_REDIS_REFUSED_ERROR = 3030110;
    // 30302 SMS 异常
    /**
     * @Message("common_error.server.dependency_sms_common_error")
     */
    public const SERVER_DEPENDENCY_SMS_ERROR = 3030201;
    // 30303 微信错误
    /**
     * @Message("common_error.server.dependency.wechat.default")
     */
    public const SERVER_DEPENDENCY_WECHAT_ERROR = 3030301;
    /**
     * @Message("common_error.server.dependency.wechat.code")
     */
    public const SERVER_DEPENDENCY_WECHAT_CODE_ERROR = 3030302;
    /**
     * @Message("common_error.server.dependency.wechat.timeout")
     */
    public const SERVER_DEPENDENCY_WECHAT_CODE_TIMEOUT_ERROR = 3030311;
    // 306 消息异常
    // 30601 自建邮箱发件服务异常
    /**
     * @Message("common_error.server.message.email.default")
     */
    public const SERVER_MESSAGE_EMAIL_ERROR = 3060101;
    /**
     * @Message("common_error.server.message.email.not_found")
     */
    public const SERVER_MESSAGE_EMAIL_NOT_FOUND = 3060102;
    // =============== 4 资源不存在 ================
    // 401 路由不存在
    /**
     * @Message("common_error.not_found.route.default")
     */
    public const ROUTE_NOT_FOUND = 4010001;
    // 402 模型不存在
    /**
     * @Message("common_error.model.not_found")
     */
    public const MODEL_NOT_FOUND = 4020001;
    // 40201 用户不存在
    /**
     * @Message("common_error.model.user.default")
     * @note ！！！这个码一定不要改，前端根据这个做判断了！！！！
     */
    public const USER_NOT_FOUND = 4020101;
    /**
     * @Message("common_error.model.user.not_valid")
     */
    public const USER_NOT_VALID = 4020102;
    /**
     * @Message("common_error.model.document.default")
     */
    public const DOCUMENT_NOT_EXISTS = 4020201;
}