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

app/repository/payment/trade/BizOrderRepository.php

@@ -7,11 +7,15 @@ use app\model\payment\BizOrder;
 
 /**
  * 业务订单仓库。
+ *
+ * 封装业务单号、追踪号、商户订单号和加锁查询方法。
  */
 class BizOrderRepository extends BaseRepository
 {
     /**
-     * 构造函数，注入对应模型。
+     * 构造方法。
+     *
+     * @return void
      */
     public function __construct()
     {
@@ -20,6 +24,10 @@ class BizOrderRepository extends BaseRepository
 
     /**
      * 根据业务单号查询业务订单。
+     *
+     * @param string $bizNo 业务单号
+     * @param array $columns 字段列表
+     * @return BizOrder|null 业务订单记录
      */
     public function findByBizNo(string $bizNo, array $columns = ['*'])
     {
@@ -30,6 +38,10 @@ class BizOrderRepository extends BaseRepository
 
     /**
      * 根据追踪号查询业务订单。
+     *
+     * @param string $traceNo 追踪号
+     * @param array $columns 字段列表
+     * @return BizOrder|null 业务订单记录
      */
     public function findByTraceNo(string $traceNo, array $columns = ['*'])
     {
@@ -40,6 +52,11 @@ class BizOrderRepository extends BaseRepository
 
     /**
      * 根据商户 ID 和商户订单号查询业务订单。
+     *
+     * @param int $merchantId 商户ID
+     * @param string $merchantOrderNo 商户订单号
+     * @param array $columns 字段列表
+     * @return BizOrder|null 业务订单记录
      */
     public function findByMerchantAndOrderNo(int $merchantId, string $merchantOrderNo, array $columns = ['*'])
     {
@@ -51,6 +68,10 @@ class BizOrderRepository extends BaseRepository
 
     /**
      * 根据业务单号查询当前有效的业务订单。
+     *
+     * @param string $bizNo 业务单号
+     * @param array $columns 字段列表
+     * @return BizOrder|null 有效业务订单记录
      */
     public function findActiveByBizNo(string $bizNo, array $columns = ['*'])
     {
@@ -62,6 +83,10 @@ class BizOrderRepository extends BaseRepository
 
     /**
      * 根据业务单号加锁查询业务订单。
+     *
+     * @param string $bizNo 业务单号
+     * @param array $columns 字段列表
+     * @return BizOrder|null 业务订单记录
      */
     public function findForUpdateByBizNo(string $bizNo, array $columns = ['*'])
     {
@@ -73,6 +98,10 @@ class BizOrderRepository extends BaseRepository
 
     /**
      * 根据追踪号加锁查询业务订单。
+     *
+     * @param string $traceNo 追踪号
+     * @param array $columns 字段列表
+     * @return BizOrder|null 业务订单记录
      */
     public function findForUpdateByTraceNo(string $traceNo, array $columns = ['*'])
     {
@@ -84,6 +113,11 @@ class BizOrderRepository extends BaseRepository
 
     /**
      * 根据商户 ID 和商户订单号加锁查询业务订单。
+     *
+     * @param int $merchantId 商户ID
+     * @param string $merchantOrderNo 商户订单号
+     * @param array $columns 字段列表
+     * @return BizOrder|null 业务订单记录
      */
     public function findForUpdateByMerchantAndOrderNo(int $merchantId, string $merchantOrderNo, array $columns = ['*'])
     {
@@ -96,6 +130,9 @@ class BizOrderRepository extends BaseRepository
 
     /**
      * 统计商户下的业务订单数量。
+     *
+     * @param int $merchantId 商户ID
+     * @return int 整数结果
      */
     public function countByMerchantId(int $merchantId): int
     {
@@ -105,3 +142,7 @@ class BizOrderRepository extends BaseRepository
     }
 }
 
+
+
+
+

app/repository/payment/trade/PayOrderRepository.php

@@ -6,12 +6,16 @@ use app\common\base\BaseRepository;
 use app\model\payment\PayOrder;
 
 /**
- * 支付单仓库。
+ * 支付单基础查询仓库。
+ *
+ * 封装支付单号、业务单号、追踪号和商户请求号等常用查询方法。
  */
 class PayOrderRepository extends BaseRepository
 {
     /**
-     * 构造函数，注入对应模型。
+     * 构造方法。
+     *
+     * @return void
      */
     public function __construct()
     {
@@ -20,6 +24,10 @@ class PayOrderRepository extends BaseRepository
 
     /**
      * 根据支付单号查询支付单。
+     *
+     * @param string $payNo 支付单号
+     * @param array $columns 字段列表
+     * @return PayOrder|null 支付单记录
      */
     public function findByPayNo(string $payNo, array $columns = ['*'])
     {
@@ -30,6 +38,10 @@ class PayOrderRepository extends BaseRepository
 
     /**
      * 根据追踪号查询支付单。
+     *
+     * @param string $traceNo 追踪号
+     * @param array $columns 字段列表
+     * @return PayOrder|null 支付单记录
      */
     public function findByTraceNo(string $traceNo, array $columns = ['*'])
     {
@@ -40,6 +52,10 @@ class PayOrderRepository extends BaseRepository
 
     /**
      * 根据追踪号查询支付单列表。
+     *
+     * @param string $traceNo 追踪号
+     * @param array $columns 字段列表
+     * @return \Illuminate\Database\Eloquent\Collection<int, PayOrder> 支付单列表
      */
     public function listByTraceNo(string $traceNo, array $columns = ['*'])
     {
@@ -52,6 +68,10 @@ class PayOrderRepository extends BaseRepository
 
     /**
      * 根据业务单号查询支付单列表。
+     *
+     * @param string $bizNo 业务单号
+     * @param array $columns 字段列表
+     * @return \Illuminate\Database\Eloquent\Collection<int, PayOrder> 支付单列表
      */
     public function listByBizNo(string $bizNo, array $columns = ['*'])
     {
@@ -64,6 +84,10 @@ class PayOrderRepository extends BaseRepository
 
     /**
      * 根据业务单号查询最新支付单。
+     *
+     * @param string $bizNo 业务单号
+     * @param array $columns 字段列表
+     * @return PayOrder|null 支付单记录
      */
     public function findLatestByBizNo(string $bizNo, array $columns = ['*'])
     {
@@ -75,6 +99,11 @@ class PayOrderRepository extends BaseRepository
 
     /**
      * 根据商户和渠道请求号查询支付单。
+     *
+     * @param int $merchantId 商户ID
+     * @param string $channelRequestNo 渠道Request号
+     * @param array $columns 字段列表
+     * @return PayOrder|null 支付单记录
      */
     public function findByChannelRequestNo(int $merchantId, string $channelRequestNo, array $columns = ['*'])
     {
@@ -86,6 +115,10 @@ class PayOrderRepository extends BaseRepository
 
     /**
      * 根据支付单号加锁查询支付单。
+     *
+     * @param string $payNo 支付单号
+     * @param array $columns 字段列表
+     * @return PayOrder|null 支付单记录
      */
     public function findForUpdateByPayNo(string $payNo, array $columns = ['*'])
     {
@@ -97,6 +130,10 @@ class PayOrderRepository extends BaseRepository
 
     /**
      * 根据追踪号加锁查询支付单。
+     *
+     * @param string $traceNo 追踪号
+     * @param array $columns 字段列表
+     * @return PayOrder|null 支付单记录
      */
     public function findForUpdateByTraceNo(string $traceNo, array $columns = ['*'])
     {
@@ -108,6 +145,10 @@ class PayOrderRepository extends BaseRepository
 
     /**
      * 根据业务单号加锁查询最新支付单。
+     *
+     * @param string $bizNo 业务单号
+     * @param array $columns 字段列表
+     * @return PayOrder|null 支付单记录
      */
     public function findLatestForUpdateByBizNo(string $bizNo, array $columns = ['*'])
     {
@@ -120,6 +161,10 @@ class PayOrderRepository extends BaseRepository
 
     /**
      * 查询商户最近支付单列表，用于总览展示。
+     *
+     * @param int $merchantId 商户ID
+     * @param int $limit 限制条数
+     * @return \Illuminate\Database\Eloquent\Collection<int, PayOrder> 最近支付单列表
      */
     public function recentByMerchantId(int $merchantId, int $limit = 5)
     {
@@ -141,3 +186,7 @@ class PayOrderRepository extends BaseRepository
     }
 }
 
+
+
+
+

app/repository/payment/trade/RefundOrderRepository.php

@@ -6,12 +6,16 @@ use app\common\base\BaseRepository;
 use app\model\payment\RefundOrder;
 
 /**
- * 退款单仓库。
+ * 退款单基础查询仓库。
+ *
+ * 封装退款单号、业务单号、追踪号、支付单号和商户退款号等常用查询方法。
  */
 class RefundOrderRepository extends BaseRepository
 {
     /**
-     * 构造函数，注入对应模型。
+     * 构造方法。
+     *
+     * @return void
      */
     public function __construct()
     {
@@ -20,6 +24,10 @@ class RefundOrderRepository extends BaseRepository
 
     /**
      * 根据退款单号查询退款单。
+     *
+     * @param string $refundNo 退款单号
+     * @param array $columns 字段列表
+     * @return RefundOrder|null 退款单记录
      */
     public function findByRefundNo(string $refundNo, array $columns = ['*'])
     {
@@ -30,6 +38,10 @@ class RefundOrderRepository extends BaseRepository
 
     /**
      * 根据追踪号查询退款单。
+     *
+     * @param string $traceNo 追踪号
+     * @param array $columns 字段列表
+     * @return RefundOrder|null 退款单记录
      */
     public function findByTraceNo(string $traceNo, array $columns = ['*'])
     {
@@ -40,6 +52,10 @@ class RefundOrderRepository extends BaseRepository
 
     /**
      * 根据追踪号查询退款单列表。
+     *
+     * @param string $traceNo 追踪号
+     * @param array $columns 字段列表
+     * @return \Illuminate\Database\Eloquent\Collection<int, RefundOrder> 退款单列表
      */
     public function listByTraceNo(string $traceNo, array $columns = ['*'])
     {
@@ -51,6 +67,10 @@ class RefundOrderRepository extends BaseRepository
 
     /**
      * 根据业务单号查询退款单列表。
+     *
+     * @param string $bizNo 业务单号
+     * @param array $columns 字段列表
+     * @return \Illuminate\Database\Eloquent\Collection<int, RefundOrder> 退款单列表
      */
     public function listByBizNo(string $bizNo, array $columns = ['*'])
     {
@@ -62,6 +82,11 @@ class RefundOrderRepository extends BaseRepository
 
     /**
      * 根据商户退款单号查询退款单。
+     *
+     * @param int $merchantId 商户ID
+     * @param string $merchantRefundNo 商户退款号
+     * @param array $columns 字段列表
+     * @return RefundOrder|null 退款单记录
      */
     public function findByMerchantRefundNo(int $merchantId, string $merchantRefundNo, array $columns = ['*'])
     {
@@ -73,6 +98,10 @@ class RefundOrderRepository extends BaseRepository
 
     /**
      * 根据支付单号查询退款单。
+     *
+     * @param string $payNo 支付单号
+     * @param array $columns 字段列表
+     * @return RefundOrder|null 退款单记录
      */
     public function findByPayNo(string $payNo, array $columns = ['*'])
     {
@@ -83,6 +112,10 @@ class RefundOrderRepository extends BaseRepository
 
     /**
      * 根据退款单号加锁查询退款单。
+     *
+     * @param string $refundNo 退款单号
+     * @param array $columns 字段列表
+     * @return RefundOrder|null 退款单记录
      */
     public function findForUpdateByRefundNo(string $refundNo, array $columns = ['*'])
     {
@@ -94,6 +127,10 @@ class RefundOrderRepository extends BaseRepository
 
     /**
      * 根据追踪号加锁查询退款单。
+     *
+     * @param string $traceNo 追踪号
+     * @param array $columns 字段列表
+     * @return RefundOrder|null 退款单记录
      */
     public function findForUpdateByTraceNo(string $traceNo, array $columns = ['*'])
     {
@@ -105,6 +142,10 @@ class RefundOrderRepository extends BaseRepository
 
     /**
      * 根据支付单号加锁查询退款单。
+     *
+     * @param string $payNo 支付单号
+     * @param array $columns 字段列表
+     * @return RefundOrder|null 退款单记录
      */
     public function findForUpdateByPayNo(string $payNo, array $columns = ['*'])
     {
@@ -116,6 +157,9 @@ class RefundOrderRepository extends BaseRepository
 
     /**
      * 统计商户下的退款订单数量。
+     *
+     * @param int $merchantId 商户ID
+     * @return int 退款订单数量
      */
     public function countByMerchantId(int $merchantId): int
     {
@@ -125,3 +169,7 @@ class RefundOrderRepository extends BaseRepository
     }
 }
 
+
+
+
+