xinyin025/mpay_v2_webman
1
0
Fork 0
mirror of https://gitee.com/technical-laohu/mpay_v2_webman.git synced 2026-04-25 19:44:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

更新统一使用 PHPDoc + PSR-19 标准注释

Browse Source
This commit is contained in:
技术老胡
2026-04-21 08:38:59 +08:00
parent dcd58e24ce
commit 9a16a88640
252 changed files with 9218 additions and 659 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
app/common/constant/AuthConstant.php
View File

@@ -9,19 +9,51 @@ namespace app\common\constant;
*/
final class AuthConstant
{
/**
* 管理员登录域。
*/
public const GUARD_ADMIN = 1;
/**
* 商户登录域。
*/
public const GUARD_MERCHANT = 2;
/**
* JWT 签名算法。
*/
public const JWT_ALG_HS256 = 'HS256';
/**
* 令牌禁用状态。
*/
public const TOKEN_STATUS_DISABLED = 0;
/**
* 令牌启用状态。
*/
public const TOKEN_STATUS_ENABLED = 1;
/**
* 登录禁用状态。
*/
public const LOGIN_STATUS_DISABLED = 0;
/**
* 登录启用状态。
*/
public const LOGIN_STATUS_ENABLED = 1;
/**
* API 签名类型：MD5。
*/
public const API_SIGN_TYPE_MD5 = 0;
/**
* 获取签名类型映射。
*
* @return array<int, string> 签名类型名称表
*/
public static function signTypeMap(): array
{
return [
@@ -29,6 +61,11 @@ final class AuthConstant
];
}
/**
* 获取登录域映射。
*
* @return array<int, string> 登录域名称表
*/
public static function guardMap(): array
{
return [
@@ -37,3 +74,7 @@ final class AuthConstant
];
}
}

30
app/common/constant/CommonConstant.php
View File

@@ -3,16 +3,35 @@
namespace app\common\constant;
/**
* 通用状态常量。
* 通用状态枚举。
*/
final class CommonConstant
{
/**
* 禁用状态。
*/
public const STATUS_DISABLED = 0;
/**
* 启用状态。
*/
public const STATUS_ENABLED = 1;
/**
* 否。
*/
public const NO = 0;
/**
* 是。
*/
public const YES = 1;
/**
* 获取状态名称映射。
*
* @return array<int, string> 状态名称表
*/
public static function statusMap(): array
{
return [
@@ -21,6 +40,11 @@ final class CommonConstant
];
}
/**
* 获取是否名称映射。
*
* @return array<int, string> 是否名称表
*/
public static function yesNoMap(): array
{
return [
@@ -29,3 +53,7 @@ final class CommonConstant
];
}
}

95
app/common/constant/FileConstant.php
View File

@@ -4,23 +4,69 @@ namespace app\common\constant;
/**
* 文件相关常量。
*
* 用于描述文件来源、可见性、场景、存储引擎和文件类型白名单。
*/
final class FileConstant
{
/**
* 上传来源。
*/
public const SOURCE_UPLOAD = 1;
/**
* 远程 URL 导入来源。
*/
public const SOURCE_REMOTE_URL = 2;
/**
* 公开可访问文件。
*/
public const VISIBILITY_PUBLIC = 1;
/**
* 私有文件。
*/
public const VISIBILITY_PRIVATE = 2;
/**
* 图片场景。
*/
public const SCENE_IMAGE = 1;
/**
* 证书场景。
*/
public const SCENE_CERTIFICATE = 2;
/**
* 文本场景。
*/
public const SCENE_TEXT = 3;
/**
* 其他场景。
*/
public const SCENE_OTHER = 4;
/**
* 本地存储引擎。
*/
public const STORAGE_LOCAL = 1;
/**
* 阿里云 OSS 存储引擎。
*/
public const STORAGE_ALIYUN_OSS = 2;
/**
* 腾讯云 COS 存储引擎。
*/
public const STORAGE_TENCENT_COS = 3;
/**
* 远程引用存储引擎。
*/
public const STORAGE_REMOTE_URL = 4;
public const CONFIG_DEFAULT_ENGINE = 'file_storage_default_engine';
@@ -42,6 +88,11 @@ final class FileConstant
public const CONFIG_COS_SECRET_KEY = 'file_storage_tencent_cos_secret_key';
public const CONFIG_COS_PUBLIC_DOMAIN = 'file_storage_tencent_cos_public_domain';
/**
* 获取文件来源映射。
*
* @return array<int, string> 来源名称表
*/
public static function sourceTypeMap(): array
{
return [
@@ -50,6 +101,11 @@ final class FileConstant
];
}
/**
* 获取文件可见性映射。
*
* @return array<int, string> 可见性名称表
*/
public static function visibilityMap(): array
{
return [
@@ -58,6 +114,11 @@ final class FileConstant
];
}
/**
* 获取文件场景映射。
*
* @return array<int, string> 场景名称表
*/
public static function sceneMap(): array
{
return [
@@ -68,6 +129,11 @@ final class FileConstant
];
}
/**
* 获取存储引擎映射。
*
* @return array<int, string> 存储引擎名称表
*/
public static function storageEngineMap(): array
{
return [
@@ -78,6 +144,11 @@ final class FileConstant
];
}
/**
* 获取可选存储引擎映射。
*
* @return array<int, string> 可选存储引擎名称表
*/
public static function selectableStorageEngineMap(): array
{
return [
@@ -87,6 +158,11 @@ final class FileConstant
];
}
/**
* 获取图片扩展名白名单。
*
* @return array<string, bool> 白名单集合
*/
public static function imageExtensionMap(): array
{
return [
@@ -100,6 +176,11 @@ final class FileConstant
];
}
/**
* 获取证书扩展名白名单。
*
* @return array<string, bool> 白名单集合
*/
public static function certificateExtensionMap(): array
{
return [
@@ -112,6 +193,11 @@ final class FileConstant
];
}
/**
* 获取文本扩展名白名单。
*
* @return array<string, bool> 白名单集合
*/
public static function textExtensionMap(): array
{
return [
@@ -128,8 +214,17 @@ final class FileConstant
];
}
/**
* 获取默认允许上传的扩展名。
*
* @return array<int, string> 扩展名列表
*/
public static function defaultAllowedExtensions(): array
{
return array_keys(self::imageExtensionMap() + self::certificateExtensionMap() + self::textExtensionMap());
}
}

21
app/common/constant/LedgerConstant.php
View File

@@ -3,7 +3,7 @@
namespace app\common\constant;
/**
* 账户流水相关枚举。
* 账户流水枚举。
*/
final class LedgerConstant
{
@@ -22,6 +22,11 @@ final class LedgerConstant
public const DIRECTION_IN = 0;
public const DIRECTION_OUT = 1;
/**
* 获取业务类型映射。
*
* @return array<int, string> 业务类型名称表
*/
public static function bizTypeMap(): array
{
return [
@@ -34,6 +39,11 @@ final class LedgerConstant
];
}
/**
* 获取事件类型映射。
*
* @return array<int, string> 事件类型名称表
*/
public static function eventTypeMap(): array
{
return [
@@ -44,6 +54,11 @@ final class LedgerConstant
];
}
/**
* 获取流水方向映射。
*
* @return array<int, string> 方向名称表
*/
public static function directionMap(): array
{
return [
@@ -52,3 +67,7 @@ final class LedgerConstant
];
}
}

36
app/common/constant/MerchantConstant.php
View File

@@ -7,14 +7,41 @@ namespace app\common\constant;
*/
final class MerchantConstant
{
/**
* 个人商户类型。
*/
public const TYPE_PERSON = 0;
/**
* 企业商户类型。
*/
public const TYPE_COMPANY = 1;
/**
* 其他商户类型。
*/
public const TYPE_OTHER = 2;
/**
* 低风险等级。
*/
public const RISK_LOW = 0;
/**
* 中风险等级。
*/
public const RISK_MEDIUM = 1;
/**
* 高风险等级。
*/
public const RISK_HIGH = 2;
/**
* 获取商户类型映射。
*
* @return array<int, string> 商户类型名称表
*/
public static function typeMap(): array
{
return [
@@ -24,6 +51,11 @@ final class MerchantConstant
];
}
/**
* 获取商户风险等级映射。
*
* @return array<int, string> 风险等级名称表
*/
public static function riskLevelMap(): array
{
return [
@@ -33,3 +65,7 @@ final class MerchantConstant
];
}
}

31
app/common/constant/NotifyConstant.php
View File

@@ -3,7 +3,7 @@
namespace app\common\constant;
/**
* 通知与回调相关枚举。
* 通知与回调枚举。
*/
final class NotifyConstant
{
@@ -25,6 +25,11 @@ final class NotifyConstant
public const TASK_STATUS_SUCCESS = 1;
public const TASK_STATUS_FAILED = 2;
/**
* 获取通知类型映射。
*
* @return array<int, string> 通知类型名称表
*/
public static function notifyTypeMap(): array
{
return [
@@ -33,6 +38,11 @@ final class NotifyConstant
];
}
/**
* 获取回调类型映射。
*
* @return array<int, string> 回调类型名称表
*/
public static function callbackTypeMap(): array
{
return [
@@ -41,6 +51,11 @@ final class NotifyConstant
];
}
/**
* 验证状态Map
*
* @return array<int, string> 验证状态名称表
*/
public static function verifyStatusMap(): array
{
return [
@@ -50,6 +65,11 @@ final class NotifyConstant
];
}
/**
* 处理状态Map
*
* @return array<int, string> 处理状态名称表
*/
public static function processStatusMap(): array
{
return [
@@ -59,6 +79,11 @@ final class NotifyConstant
];
}
/**
* 获取任务状态映射。
*
* @return array<int, string> 任务状态名称表
*/
public static function taskStatusMap(): array
{
return [
@@ -68,3 +93,7 @@ final class NotifyConstant
];
}
}

37
app/common/constant/RouteConstant.php
View File

@@ -3,14 +3,30 @@
namespace app\common\constant;
/**
* 路由与通道编排相关枚举。
* 路由与通道编排枚举。
*
* 用于描述通道类型、通道模式以及轮询组的路由策略。
*/
final class RouteConstant
{
/**
* 平台代收通道类型。
*/
public const CHANNEL_TYPE_PLATFORM_COLLECT = 0;
/**
* 商户自有通道类型。
*/
public const CHANNEL_TYPE_MERCHANT_SELF = 1;
/**
* 代收通道模式。
*/
public const CHANNEL_MODE_COLLECT = 0;
/**
* 自收通道模式。
*/
public const CHANNEL_MODE_SELF = 1;
/**
@@ -28,6 +44,11 @@ final class RouteConstant
*/
public const ROUTE_MODE_FIRST_AVAILABLE = 2;
/**
* 获取通道类型名称映射。
*
* @return array<int, string> 通道类型名称表
*/
public static function channelTypeMap(): array
{
return [
@@ -36,6 +57,11 @@ final class RouteConstant
];
}
/**
* 获取通道模式名称映射。
*
* @return array<int, string> 通道模式名称表
*/
public static function channelModeMap(): array
{
return [
@@ -44,6 +70,11 @@ final class RouteConstant
];
}
/**
* 获取路由模式名称映射。
*
* @return array<int, string> 路由模式名称表
*/
public static function routeModeMap(): array
{
return [
@@ -53,3 +84,7 @@ final class RouteConstant
];
}
}

79
app/common/constant/TradeConstant.php
View File

@@ -3,7 +3,7 @@
namespace app\common\constant;
/**
* 交易、订单与结算相关枚举。
* 交易、订单与结算状态枚举。
*/
final class TradeConstant
{
@@ -36,6 +36,11 @@ final class TradeConstant
public const REFUND_STATUS_FAILED = 3;
public const REFUND_STATUS_CLOSED = 4;
/**
* 获取清算周期映射。
*
* @return array<int, string> 清算周期名称表
*/
public static function settlementCycleMap(): array
{
return [
@@ -47,6 +52,11 @@ final class TradeConstant
];
}
/**
* 获取订单状态映射。
*
* @return array<int, string> 订单状态名称表
*/
public static function orderStatusMap(): array
{
return [
@@ -59,6 +69,11 @@ final class TradeConstant
];
}
/**
* 获取手续费状态映射。
*
* @return array<int, string> 手续费状态名称表
*/
public static function feeStatusMap(): array
{
return [
@@ -69,6 +84,11 @@ final class TradeConstant
];
}
/**
* 获取清算状态映射。
*
* @return array<int, string> 清算状态名称表
*/
public static function settlementStatusMap(): array
{
return [
@@ -79,6 +99,11 @@ final class TradeConstant
];
}
/**
* 获取退款状态映射。
*
* @return array<int, string> 退款状态名称表
*/
public static function refundStatusMap(): array
{
return [
@@ -90,6 +115,11 @@ final class TradeConstant
];
}
/**
* 获取可变更的订单状态列表。
*
* @return array<int, int> 状态列表
*/
public static function orderMutableStatuses(): array
{
return [
@@ -98,6 +128,11 @@ final class TradeConstant
];
}
/**
* 获取订单终态列表。
*
* @return array<int, int> 状态列表
*/
public static function orderTerminalStatuses(): array
{
return [
@@ -108,11 +143,22 @@ final class TradeConstant
];
}
/**
* 判断订单是否为终态。
*
* @param int $status 状态
* @return bool 是否为终态
*/
public static function isOrderTerminalStatus(int $status): bool
{
return in_array($status, self::orderTerminalStatuses(), true);
}
/**
* 获取可变更的退款状态列表。
*
* @return array<int, int> 状态列表
*/
public static function refundMutableStatuses(): array
{
return [
@@ -122,6 +168,11 @@ final class TradeConstant
];
}
/**
* 获取退款终态列表。
*
* @return array<int, int> 状态列表
*/
public static function refundTerminalStatuses(): array
{
return [
@@ -130,11 +181,22 @@ final class TradeConstant
];
}
/**
* 判断退款是否为终态。
*
* @param int $status 状态
* @return bool 是否为终态
*/
public static function isRefundTerminalStatus(int $status): bool
{
return in_array($status, self::refundTerminalStatuses(), true);
}
/**
* 获取可变更的清算状态列表。
*
* @return array<int, int> 状态列表
*/
public static function settlementMutableStatuses(): array
{
return [
@@ -142,6 +204,11 @@ final class TradeConstant
];
}
/**
* 获取清算终态列表。
*
* @return array<int, int> 状态列表
*/
public static function settlementTerminalStatuses(): array
{
return [
@@ -150,8 +217,18 @@ final class TradeConstant
];
}
/**
* 判断清算是否为终态。
*
* @param int $status 状态
* @return bool 是否为终态
*/
public static function isSettlementTerminalStatus(int $status): bool
{
return in_array($status, self::settlementTerminalStatuses(), true);
}
}