更新统一使用 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

@@ -12,11 +12,16 @@ use support\Response;
* 支付通道管理控制器。
*
* 负责支付通道的列表、详情、新增、修改和删除。
*
* @property PaymentChannelService $paymentChannelService 支付渠道服务
*/
class PaymentChannelController extends BaseController
{
/**
* 构造函数,注入支付通道服务
* 构造方法
*
* @param PaymentChannelService $paymentChannelService 支付渠道服务
* @return void
*/
public function __construct(
protected PaymentChannelService $paymentChannelService
@@ -24,9 +29,10 @@ class PaymentChannelController extends BaseController
}
/**
* GET /admin/payment-channels
*
* 查询支付通道列表。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
@@ -42,9 +48,11 @@ class PaymentChannelController extends BaseController
}
/**
* GET /admin/payment-channels/{id}
*
* 查询支付通道详情。
*
* @param Request $request 请求对象
* @param string $id 支付渠道ID
* @return Response 响应对象
*/
public function show(Request $request, string $id): Response
{
@@ -59,9 +67,10 @@ class PaymentChannelController extends BaseController
}
/**
* POST /admin/payment-channels
*
* 新增支付通道。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
@@ -71,9 +80,11 @@ class PaymentChannelController extends BaseController
}
/**
* PUT /admin/payment-channels/{id}
*
* 修改支付通道。
*
* @param Request $request 请求对象
* @param string $id 支付渠道ID
* @return Response 响应对象
*/
public function update(Request $request, string $id): Response
{
@@ -94,9 +105,11 @@ class PaymentChannelController extends BaseController
}
/**
* DELETE /admin/payment-channels/{id}
*
* 删除支付通道。
*
* @param Request $request 请求对象
* @param string $id 支付渠道ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $id): Response
{
@@ -111,6 +124,9 @@ class PaymentChannelController extends BaseController
/**
* 查询启用中的通道选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function options(Request $request): Response
{
@@ -119,6 +135,9 @@ class PaymentChannelController extends BaseController
/**
* 查询路由编排场景下的通道选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function routeOptions(Request $request): Response
{
@@ -127,6 +146,9 @@ class PaymentChannelController extends BaseController
/**
* 远程查询支付通道选择项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function selectOptions(Request $request): Response
{
@@ -136,3 +158,8 @@ class PaymentChannelController extends BaseController
return $this->success($this->paymentChannelService->searchOptions($request->all(), $page, $pageSize));
}
}

View File

@@ -12,14 +12,28 @@ use support\Response;
* 支付插件配置控制器。
*
* 负责插件公共配置的列表、详情、增删改和选项输出。
*
* @property PaymentPluginConfService $paymentPluginConfService 支付插件配置服务
*/
class PaymentPluginConfController extends BaseController
{
/**
* 构造方法。
*
* @param PaymentPluginConfService $paymentPluginConfService 支付插件配置服务
* @return void
*/
public function __construct(
protected PaymentPluginConfService $paymentPluginConfService
) {
}
/**
* 查询支付插件配置列表。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
$data = $this->validated($request->all(), PaymentPluginConfValidator::class, 'index');
@@ -29,6 +43,13 @@ class PaymentPluginConfController extends BaseController
return $this->page($this->paymentPluginConfService->paginate($data, $page, $pageSize));
}
/**
* 查询支付插件配置详情。
*
* @param Request $request 请求对象
* @param string $id 支付插件配置ID
* @return Response 响应对象
*/
public function show(Request $request, string $id): Response
{
$data = $this->validated(['id' => (int) $id], PaymentPluginConfValidator::class, 'show');
@@ -41,6 +62,12 @@ class PaymentPluginConfController extends BaseController
return $this->success($pluginConf);
}
/**
* 新增支付插件配置。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
$data = $this->validated($request->all(), PaymentPluginConfValidator::class, 'store');
@@ -48,6 +75,13 @@ class PaymentPluginConfController extends BaseController
return $this->success($this->paymentPluginConfService->create($data));
}
/**
* 更新支付插件配置。
*
* @param Request $request 请求对象
* @param string $id 支付插件配置ID
* @return Response 响应对象
*/
public function update(Request $request, string $id): Response
{
$data = $this->validated(
@@ -64,6 +98,13 @@ class PaymentPluginConfController extends BaseController
return $this->success($pluginConf);
}
/**
* 删除支付插件配置。
*
* @param Request $request 请求对象
* @param string $id 支付插件配置ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $id): Response
{
$data = $this->validated(['id' => (int) $id], PaymentPluginConfValidator::class, 'destroy');
@@ -75,6 +116,12 @@ class PaymentPluginConfController extends BaseController
return $this->success(true);
}
/**
* 获取支付插件配置选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function options(Request $request): Response
{
$data = $this->validated($request->all(), PaymentPluginConfValidator::class, 'options');
@@ -86,6 +133,9 @@ class PaymentPluginConfController extends BaseController
/**
* 远程查询插件配置选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function selectOptions(Request $request): Response
{
@@ -96,3 +146,8 @@ class PaymentPluginConfController extends BaseController
return $this->success($this->paymentPluginConfService->searchOptions($data, $page, $pageSize));
}
}

View File

@@ -12,11 +12,16 @@ use support\Response;
* 支付插件管理控制器。
*
* 负责插件字典的列表、详情、刷新同步和状态备注维护。
*
* @property PaymentPluginService $paymentPluginService 支付插件服务
*/
class PaymentPluginController extends BaseController
{
/**
* 构造函数,注入支付插件服务
* 构造方法
*
* @param PaymentPluginService $paymentPluginService 支付插件服务
* @return void
*/
public function __construct(
protected PaymentPluginService $paymentPluginService
@@ -25,6 +30,9 @@ class PaymentPluginController extends BaseController
/**
* 查询支付插件列表。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
@@ -37,6 +45,10 @@ class PaymentPluginController extends BaseController
/**
* 查询支付插件详情。
*
* @param Request $request 请求对象
* @param string $code 编码
* @return Response 响应对象
*/
public function show(Request $request, string $code): Response
{
@@ -52,6 +64,10 @@ class PaymentPluginController extends BaseController
/**
* 修改支付插件。
*
* @param Request $request 请求对象
* @param string $code 编码
* @return Response 响应对象
*/
public function update(Request $request, string $code): Response
{
@@ -73,6 +89,9 @@ class PaymentPluginController extends BaseController
/**
* 从插件目录刷新同步支付插件。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function refresh(Request $request): Response
{
@@ -81,6 +100,9 @@ class PaymentPluginController extends BaseController
/**
* 查询支付插件下拉选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function options(Request $request): Response
{
@@ -91,6 +113,9 @@ class PaymentPluginController extends BaseController
/**
* 远程查询支付插件选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function selectOptions(Request $request): Response
{
@@ -103,6 +128,9 @@ class PaymentPluginController extends BaseController
/**
* 查询通道配置场景下的插件选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function channelOptions(Request $request): Response
{
@@ -113,6 +141,10 @@ class PaymentPluginController extends BaseController
/**
* 查询插件配置结构。
*
* @param Request $request 请求对象
* @param string $code 编码
* @return Response 响应对象
*/
public function schema(Request $request, string $code): Response
{
@@ -121,3 +153,8 @@ class PaymentPluginController extends BaseController
return $this->success($this->paymentPluginService->getSchema((string) $data['code']));
}
}

View File

@@ -10,14 +10,28 @@ use support\Response;
/**
* 商户分组路由绑定控制器。
*
* @property PaymentPollGroupBindService $paymentPollGroupBindService 支付轮询分组绑定服务
*/
class PaymentPollGroupBindController extends BaseController
{
/**
* 构造方法。
*
* @param PaymentPollGroupBindService $paymentPollGroupBindService 支付轮询分组绑定服务
* @return void
*/
public function __construct(
protected PaymentPollGroupBindService $paymentPollGroupBindService
) {
}
/**
* 查询支付轮询分组绑定列表
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
$data = $this->validated($request->all(), PaymentPollGroupBindValidator::class, 'index');
@@ -31,6 +45,13 @@ class PaymentPollGroupBindController extends BaseController
);
}
/**
* 查询支付轮询分组绑定详情
*
* @param Request $request 请求对象
* @param string $id 支付轮询分组绑定ID
* @return Response 响应对象
*/
public function show(Request $request, string $id): Response
{
$data = $this->validated(['id' => (int) $id], PaymentPollGroupBindValidator::class, 'show');
@@ -42,6 +63,12 @@ class PaymentPollGroupBindController extends BaseController
return $this->success($row);
}
/**
* 新增支付轮询分组绑定
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
$data = $this->validated($request->all(), PaymentPollGroupBindValidator::class, 'store');
@@ -49,6 +76,13 @@ class PaymentPollGroupBindController extends BaseController
return $this->success($this->paymentPollGroupBindService->create($data));
}
/**
* 更新支付轮询分组绑定
*
* @param Request $request 请求对象
* @param string $id 支付轮询分组绑定ID
* @return Response 响应对象
*/
public function update(Request $request, string $id): Response
{
$data = $this->validated(
@@ -65,6 +99,13 @@ class PaymentPollGroupBindController extends BaseController
return $this->success($row);
}
/**
* 删除支付轮询分组绑定
*
* @param Request $request 请求对象
* @param string $id 支付轮询分组绑定ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $id): Response
{
$data = $this->validated(['id' => (int) $id], PaymentPollGroupBindValidator::class, 'destroy');
@@ -75,3 +116,8 @@ class PaymentPollGroupBindController extends BaseController
return $this->success(true);
}
}

View File

@@ -10,14 +10,28 @@ use support\Response;
/**
* 轮询组通道编排控制器。
*
* @property PaymentPollGroupChannelService $paymentPollGroupChannelService 支付轮询分组渠道服务
*/
class PaymentPollGroupChannelController extends BaseController
{
/**
* 构造方法。
*
* @param PaymentPollGroupChannelService $paymentPollGroupChannelService 支付轮询分组渠道服务
* @return void
*/
public function __construct(
protected PaymentPollGroupChannelService $paymentPollGroupChannelService
) {
}
/**
* 查询支付轮询分组渠道列表
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
$data = $this->validated($request->all(), PaymentPollGroupChannelValidator::class, 'index');
@@ -31,6 +45,13 @@ class PaymentPollGroupChannelController extends BaseController
);
}
/**
* 查询支付轮询分组渠道详情
*
* @param Request $request 请求对象
* @param string $id 支付轮询分组渠道ID
* @return Response 响应对象
*/
public function show(Request $request, string $id): Response
{
$data = $this->validated(['id' => (int) $id], PaymentPollGroupChannelValidator::class, 'show');
@@ -42,6 +63,12 @@ class PaymentPollGroupChannelController extends BaseController
return $this->success($row);
}
/**
* 新增支付轮询分组渠道
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
$data = $this->validated($request->all(), PaymentPollGroupChannelValidator::class, 'store');
@@ -49,6 +76,13 @@ class PaymentPollGroupChannelController extends BaseController
return $this->success($this->paymentPollGroupChannelService->create($data));
}
/**
* 更新支付轮询分组渠道
*
* @param Request $request 请求对象
* @param string $id 支付轮询分组渠道ID
* @return Response 响应对象
*/
public function update(Request $request, string $id): Response
{
$payload = $request->all();
@@ -67,6 +101,13 @@ class PaymentPollGroupChannelController extends BaseController
return $this->success($row);
}
/**
* 删除支付轮询分组渠道
*
* @param Request $request 请求对象
* @param string $id 支付轮询分组渠道ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $id): Response
{
$data = $this->validated(['id' => (int) $id], PaymentPollGroupChannelValidator::class, 'destroy');
@@ -77,3 +118,8 @@ class PaymentPollGroupChannelController extends BaseController
return $this->success(true);
}
}

View File

@@ -12,11 +12,16 @@ use support\Response;
* 支付轮询组管理控制器。
*
* 负责轮询组的列表、详情、新增、修改和删除。
*
* @property PaymentPollGroupService $paymentPollGroupService 支付轮询分组服务
*/
class PaymentPollGroupController extends BaseController
{
/**
* 构造函数,注入轮询组服务
* 构造方法
*
* @param PaymentPollGroupService $paymentPollGroupService 支付轮询分组服务
* @return void
*/
public function __construct(
protected PaymentPollGroupService $paymentPollGroupService
@@ -24,9 +29,10 @@ class PaymentPollGroupController extends BaseController
}
/**
* GET /admin/payment-poll-groups
*
* 查询轮询组列表。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
@@ -42,9 +48,11 @@ class PaymentPollGroupController extends BaseController
}
/**
* GET /admin/payment-poll-groups/{id}
*
* 查询轮询组详情。
*
* @param Request $request 请求对象
* @param string $id 支付轮询分组ID
* @return Response 响应对象
*/
public function show(Request $request, string $id): Response
{
@@ -59,9 +67,10 @@ class PaymentPollGroupController extends BaseController
}
/**
* POST /admin/payment-poll-groups
*
* 新增轮询组。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
@@ -71,9 +80,11 @@ class PaymentPollGroupController extends BaseController
}
/**
* PUT /admin/payment-poll-groups/{id}
*
* 修改轮询组。
*
* @param Request $request 请求对象
* @param string $id 支付轮询分组ID
* @return Response 响应对象
*/
public function update(Request $request, string $id): Response
{
@@ -94,9 +105,11 @@ class PaymentPollGroupController extends BaseController
}
/**
* DELETE /admin/payment-poll-groups/{id}
*
* 删除轮询组。
*
* @param Request $request 请求对象
* @param string $id 支付轮询分组ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $id): Response
{
@@ -111,9 +124,17 @@ class PaymentPollGroupController extends BaseController
/**
* 查询轮询组下拉选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function options(Request $request): Response
{
return $this->success($this->paymentPollGroupService->enabledOptions($request->all()));
}
}

View File

@@ -12,11 +12,16 @@ use support\Response;
* 支付方式管理控制器。
*
* 负责支付方式字典的列表、详情、新增、修改、删除和选项输出。
*
* @property PaymentTypeService $paymentTypeService 支付类型服务
*/
class PaymentTypeController extends BaseController
{
/**
* 构造函数,注入支付方式服务
* 构造方法
*
* @param PaymentTypeService $paymentTypeService 支付类型服务
* @return void
*/
public function __construct(
protected PaymentTypeService $paymentTypeService
@@ -25,6 +30,9 @@ class PaymentTypeController extends BaseController
/**
* 查询支付方式列表。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
@@ -37,6 +45,10 @@ class PaymentTypeController extends BaseController
/**
* 查询支付方式详情。
*
* @param Request $request 请求对象
* @param string $id 支付类型ID
* @return Response 响应对象
*/
public function show(Request $request, string $id): Response
{
@@ -52,6 +64,9 @@ class PaymentTypeController extends BaseController
/**
* 新增支付方式。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
@@ -62,6 +77,10 @@ class PaymentTypeController extends BaseController
/**
* 修改支付方式。
*
* @param Request $request 请求对象
* @param string $id 支付类型ID
* @return Response 响应对象
*/
public function update(Request $request, string $id): Response
{
@@ -83,6 +102,10 @@ class PaymentTypeController extends BaseController
/**
* 删除支付方式。
*
* @param Request $request 请求对象
* @param string $id 支付类型ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $id): Response
{
@@ -97,9 +120,17 @@ class PaymentTypeController extends BaseController
/**
* 查询支付方式下拉选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function options(Request $request): Response
{
return $this->success($this->paymentTypeService->enabledOptions());
}
}

View File

@@ -9,14 +9,19 @@ use support\Request;
use support\Response;
/**
* 管理后台路由预览控制器。
* 管理后台路由解析控制器。
*
* 负责按商户分组、支付方式和金额条件解析可用通道。
*
* @property PaymentRouteService $paymentRouteService 支付路由服务
*/
class RouteController extends BaseController
{
/**
* 构造函数,注入路由服务
* 构造方法
*
* @param PaymentRouteService $paymentRouteService 支付路由服务
* @return void
*/
public function __construct(
protected PaymentRouteService $paymentRouteService
@@ -24,9 +29,10 @@ class RouteController extends BaseController
}
/**
* GET /admin/routes/resolve
*
* 解析路由结果。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function resolve(Request $request): Response
{
@@ -41,3 +47,8 @@ class RouteController extends BaseController
}
}