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

@@ -9,12 +9,17 @@ use support\Request;
use support\Response;
/**
* 商户接口凭证管理控制器。
* 商户 API 凭证管理控制器。
*
* @property MerchantApiCredentialService $merchantApiCredentialService 商户 API 凭证服务
*/
class MerchantApiCredentialController extends BaseController
{
/**
* 构造函数,注入商户 API 凭证服务
* 构造方法
*
* @param MerchantApiCredentialService $merchantApiCredentialService 商户 API 凭证服务
* @return void
*/
public function __construct(
protected MerchantApiCredentialService $merchantApiCredentialService
@@ -23,6 +28,9 @@ class MerchantApiCredentialController extends BaseController
/**
* 查询商户 API 凭证列表。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
@@ -39,6 +47,10 @@ class MerchantApiCredentialController extends BaseController
/**
* 查询商户 API 凭证详情。
*
* @param Request $request 请求对象
* @param string $id 商户 API 凭证ID
* @return Response 响应对象
*/
public function show(Request $request, string $id): Response
{
@@ -46,7 +58,7 @@ class MerchantApiCredentialController extends BaseController
$credential = $this->merchantApiCredentialService->findById((int) $data['id']);
if (!$credential) {
return $this->fail('商户接口凭证不存在', 404);
return $this->fail('商户 API 凭证不存在', 404);
}
return $this->success($credential);
@@ -54,6 +66,9 @@ class MerchantApiCredentialController extends BaseController
/**
* 新增商户 API 凭证。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
@@ -64,6 +79,10 @@ class MerchantApiCredentialController extends BaseController
/**
* 修改商户 API 凭证。
*
* @param Request $request 请求对象
* @param string $id 商户 API 凭证ID
* @return Response 响应对象
*/
public function update(Request $request, string $id): Response
{
@@ -75,7 +94,7 @@ class MerchantApiCredentialController extends BaseController
$credential = $this->merchantApiCredentialService->update((int) $data['id'], $data);
if (!$credential) {
return $this->fail('商户接口凭证不存在', 404);
return $this->fail('商户 API 凭证不存在', 404);
}
return $this->success($credential);
@@ -83,6 +102,10 @@ class MerchantApiCredentialController extends BaseController
/**
* 删除商户 API 凭证。
*
* @param Request $request 请求对象
* @param string $id 商户 API 凭证ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $id): Response
{
@@ -90,14 +113,19 @@ class MerchantApiCredentialController extends BaseController
$credential = $this->merchantApiCredentialService->findById((int) $data['id']);
if (!$credential) {
return $this->fail('商户接口凭证不存在', 404);
return $this->fail('商户 API 凭证不存在', 404);
}
if (!$this->merchantApiCredentialService->delete((int) $data['id'])) {
return $this->fail('商户接口凭证删除失败');
return $this->fail('商户 API 凭证删除失败');
}
return $this->success(true);
}
}

View File

@@ -12,11 +12,16 @@ use support\Response;
* 商户管理控制器。
*
* 当前先提供商户列表查询,后续可继续扩展商户详情、新增、编辑等能力。
*
* @property MerchantService $merchantService 商户服务
*/
class MerchantController extends BaseController
{
/**
* 构造函数,注入商户服务
* 构造方法
*
* @param MerchantService $merchantService 商户服务
* @return void
*/
public function __construct(
protected MerchantService $merchantService
@@ -27,6 +32,9 @@ class MerchantController extends BaseController
* 查询商户列表。
*
* 返回值里额外携带启用中的商户分组选项,方便前端一次性渲染筛选条件。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
@@ -39,6 +47,10 @@ class MerchantController extends BaseController
/**
* 查询商户详情。
*
* @param Request $request 请求对象
* @param string $id 商户ID
* @return Response 响应对象
*/
public function show(Request $request, string $id): Response
{
@@ -54,6 +66,9 @@ class MerchantController extends BaseController
/**
* 新增商户。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
@@ -63,6 +78,10 @@ class MerchantController extends BaseController
/**
* 更新商户。
*
* @param Request $request 请求对象
* @param string $id 商户ID
* @return Response 响应对象
*/
public function update(Request $request, string $id): Response
{
@@ -80,6 +99,10 @@ class MerchantController extends BaseController
/**
* 删除商户。
*
* @param Request $request 请求对象
* @param string $id 商户ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $id): Response
{
@@ -90,6 +113,10 @@ class MerchantController extends BaseController
/**
* 重置商户登录密码。
*
* @param Request $request 请求对象
* @param string $id 商户ID
* @return Response 响应对象
*/
public function resetPassword(Request $request, string $id): Response
{
@@ -100,7 +127,11 @@ class MerchantController extends BaseController
}
/**
* 生成或重置商户接口凭证。
* 生成或重置商户 API 凭证。
*
* @param Request $request 请求对象
* @param string $id 商户ID
* @return Response 响应对象
*/
public function issueCredential(Request $request, string $id): Response
{
@@ -111,6 +142,10 @@ class MerchantController extends BaseController
/**
* 查询商户总览。
*
* @param Request $request 请求对象
* @param string $id 商户ID
* @return Response 响应对象
*/
public function overview(Request $request, string $id): Response
{
@@ -121,6 +156,9 @@ class MerchantController extends BaseController
/**
* 查询商户下拉选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function options(Request $request): Response
{
@@ -129,6 +167,9 @@ class MerchantController extends BaseController
/**
* 远程查询商户选择项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function selectOptions(Request $request): Response
{
@@ -139,3 +180,9 @@ class MerchantController extends BaseController
}
}

View File

@@ -12,11 +12,16 @@ use support\Response;
* 商户分组管理控制器。
*
* 负责商户分组的列表、详情、新增、修改和删除。
*
* @property MerchantGroupService $merchantGroupService 商户分组服务
*/
class MerchantGroupController extends BaseController
{
/**
* 构造函数,注入商户分组服务
* 构造方法
*
* @param MerchantGroupService $merchantGroupService 商户分组服务
* @return void
*/
public function __construct(
protected MerchantGroupService $merchantGroupService
@@ -24,9 +29,10 @@ class MerchantGroupController extends BaseController
}
/**
* GET /admin/merchant-groups
*
* 查询商户分组列表。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
@@ -42,9 +48,11 @@ class MerchantGroupController extends BaseController
}
/**
* GET /admin/merchant-groups/{id}
*
* 查询商户分组详情。
*
* @param Request $request 请求对象
* @param string $id 商户分组ID
* @return Response 响应对象
*/
public function show(Request $request, string $id): Response
{
@@ -59,9 +67,10 @@ class MerchantGroupController extends BaseController
}
/**
* POST /admin/merchant-groups
*
* 新增商户分组。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
@@ -71,9 +80,11 @@ class MerchantGroupController extends BaseController
}
/**
* PUT /admin/merchant-groups/{id}
*
* 修改商户分组。
*
* @param Request $request 请求对象
* @param string $id 商户分组ID
* @return Response 响应对象
*/
public function update(Request $request, string $id): Response
{
@@ -92,9 +103,11 @@ class MerchantGroupController extends BaseController
}
/**
* DELETE /admin/merchant-groups/{id}
*
* 删除商户分组。
*
* @param Request $request 请求对象
* @param string $id 商户分组ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $id): Response
{
@@ -109,6 +122,9 @@ class MerchantGroupController extends BaseController
/**
* 查询商户分组下拉选项。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function options(Request $request): Response
{
@@ -116,3 +132,8 @@ class MerchantGroupController extends BaseController
}
}

View File

@@ -10,14 +10,28 @@ use support\Response;
/**
* 商户策略控制器。
*
* @property MerchantPolicyService $merchantPolicyService 商户策略服务
*/
class MerchantPolicyController extends BaseController
{
/**
* 构造方法。
*
* @param MerchantPolicyService $merchantPolicyService 商户策略服务
* @return void
*/
public function __construct(
protected MerchantPolicyService $merchantPolicyService
) {
}
/**
* 查询商户策略列表。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
$data = $this->validated($request->all(), MerchantPolicyValidator::class, 'index');
@@ -31,6 +45,13 @@ class MerchantPolicyController extends BaseController
);
}
/**
* 查询商户策略详情。
*
* @param Request $request 请求对象
* @param string $merchantId 商户ID
* @return Response 响应对象
*/
public function show(Request $request, string $merchantId): Response
{
$data = $this->validated(['merchant_id' => (int) $merchantId], MerchantPolicyValidator::class, 'show');
@@ -38,6 +59,12 @@ class MerchantPolicyController extends BaseController
return $this->success($this->merchantPolicyService->findByMerchantId((int) $data['merchant_id']));
}
/**
* 新增商户策略。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
$data = $this->validated($request->all(), MerchantPolicyValidator::class, 'store');
@@ -45,6 +72,13 @@ class MerchantPolicyController extends BaseController
return $this->success($this->merchantPolicyService->saveByMerchantId((int) $data['merchant_id'], $data));
}
/**
* 更新商户策略。
*
* @param Request $request 请求对象
* @param string $merchantId 商户ID
* @return Response 响应对象
*/
public function update(Request $request, string $merchantId): Response
{
$data = $this->validated(
@@ -56,6 +90,13 @@ class MerchantPolicyController extends BaseController
return $this->success($this->merchantPolicyService->saveByMerchantId((int) $data['merchant_id'], $data));
}
/**
* 删除商户策略。
*
* @param Request $request 请求对象
* @param string $merchantId 商户ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $merchantId): Response
{
$data = $this->validated(['merchant_id' => (int) $merchantId], MerchantPolicyValidator::class, 'show');
@@ -64,3 +105,8 @@ class MerchantPolicyController extends BaseController
}
}