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

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

View File

@@ -13,12 +13,17 @@ use support\Response;
/**
* 清算接口控制器。
*
* 负责清算单创建、查询和清算态推进。
* 负责清算单创建、查询和清算态推进。
*
* @property SettlementService $settlementService 结算服务
*/
class SettlementController extends BaseController
{
/**
* 构造函数,注入清算相关依赖
* 构造方法
*
* @param SettlementService $settlementService 结算服务
* @return void
*/
public function __construct(
protected SettlementService $settlementService,
@@ -26,7 +31,12 @@ class SettlementController extends BaseController
}
/**
* 创建清算单。
* 创建清算单。
*
* 会把传入的清算明细和汇总一起交给清算生命周期服务落库。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function create(Request $request): Response
{
@@ -37,7 +47,13 @@ class SettlementController extends BaseController
}
/**
* 查询清算单详情。
* 查询清算单详情。
*
* 用于查看批次金额、状态和关联支付单明细。
*
* @param Request $request 请求对象
* @param string $settleNo 结算单号
* @return Response 响应对象
*/
public function show(Request $request, string $settleNo): Response
{
@@ -49,7 +65,13 @@ class SettlementController extends BaseController
}
/**
* 标记清算成功。
* 标记清算成功。
*
* 会触发商户余额入账,并同步清算单、清算明细和关联支付单状态。
*
* @param Request $request 请求对象
* @param string $settleNo 结算单号
* @return Response 响应对象
*/
public function complete(Request $request, string $settleNo): Response
{
@@ -63,7 +85,13 @@ class SettlementController extends BaseController
}
/**
* 标记清算失败。
* 标记清算失败。
*
* 仅在清算批次未成功入账时使用,用于把批次推进到失败终态并保留原因。
*
* @param Request $request 请求对象
* @param string $settleNo 结算单号
* @return Response 响应对象
*/
public function failSettlement(Request $request, string $settleNo): Response
{
@@ -76,3 +104,7 @@ class SettlementController extends BaseController
return $this->success($this->settlementService->failSettlement($settleNo, (string) ($data['reason'] ?? '')));
}
}