更新统一使用 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 AdminUserService $adminUserService 管理用户服务
*/
class AdminUserController extends BaseController
{
/**
* 构造函数,注入管理员用户服务
* 构造方法
*
* @param AdminUserService $adminUserService 管理用户服务
* @return void
*/
public function __construct(
protected AdminUserService $adminUserService
@@ -24,9 +29,10 @@ class AdminUserController extends BaseController
}
/**
* GET /adminapi/admin-users
*
* 查询管理员用户列表。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
@@ -42,9 +48,11 @@ class AdminUserController extends BaseController
}
/**
* GET /adminapi/admin-users/{id}
*
* 查询管理员用户详情。
*
* @param Request $request 请求对象
* @param string $id 管理用户ID
* @return Response 响应对象
*/
public function show(Request $request, string $id): Response
{
@@ -59,9 +67,10 @@ class AdminUserController extends BaseController
}
/**
* POST /adminapi/admin-users
*
* 新增管理员用户。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function store(Request $request): Response
{
@@ -71,9 +80,11 @@ class AdminUserController extends BaseController
}
/**
* PUT /adminapi/admin-users/{id}
*
* 修改管理员用户。
*
* @param Request $request 请求对象
* @param string $id 管理用户ID
* @return Response 响应对象
*/
public function update(Request $request, string $id): Response
{
@@ -92,9 +103,11 @@ class AdminUserController extends BaseController
}
/**
* DELETE /adminapi/admin-users/{id}
*
* 删除管理员用户。
*
* @param Request $request 请求对象
* @param string $id 管理用户ID
* @return Response 响应对象
*/
public function destroy(Request $request, string $id): Response
{
@@ -120,3 +133,8 @@ class AdminUserController extends BaseController
return $this->success(true);
}
}

View File

@@ -11,15 +11,31 @@ use support\Response;
/**
* 管理员认证控制器。
*
* @property AdminAuthService $adminAuthService 管理认证服务
* @property AdminUserService $adminUserService 管理用户服务
*/
class AuthController extends BaseController
{
/**
* 构造方法。
*
* @param AdminAuthService $adminAuthService 管理认证服务
* @param AdminUserService $adminUserService 管理用户服务
* @return void
*/
public function __construct(
protected AdminAuthService $adminAuthService,
protected AdminUserService $adminUserService
) {
}
/**
* 管理员登录。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function login(Request $request): Response
{
$data = $this->validated($request->all(), AuthValidator::class, 'login');
@@ -32,6 +48,12 @@ class AuthController extends BaseController
));
}
/**
* 管理员退出登录。
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function logout(Request $request): Response
{
$token = trim((string) ($request->header('authorization', '') ?: $request->header('x-admin-token', '')));
@@ -47,7 +69,10 @@ class AuthController extends BaseController
}
/**
* 获取当前登录管理员信息
* 获取当前登录管理员信息
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function profile(Request $request): Response
{
@@ -63,3 +88,8 @@ class AuthController extends BaseController
}
}

View File

@@ -8,18 +8,42 @@ use app\service\system\config\SystemConfigPageService;
use support\Request;
use support\Response;
/**
* 系统配置页面控制器
*
* @property SystemConfigPageService $systemConfigPageService 系统配置页面服务
*/
class SystemConfigPageController extends BaseController
{
/**
* 构造方法。
*
* @param SystemConfigPageService $systemConfigPageService 系统配置页面服务
* @return void
*/
public function __construct(
protected SystemConfigPageService $systemConfigPageService
) {
}
/**
* 查询系统配置页面列表
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function index(Request $request): Response
{
return $this->success($this->systemConfigPageService->tabs());
}
/**
* 查询系统配置页面详情
*
* @param Request $request 请求对象
* @param string $groupCode 分组Code
* @return Response 响应对象
*/
public function show(Request $request, string $groupCode): Response
{
$data = $this->validated(['group_code' => $groupCode], SystemConfigPageValidator::class, 'show');
@@ -27,6 +51,13 @@ class SystemConfigPageController extends BaseController
return $this->success($this->systemConfigPageService->detail((string) $data['group_code']));
}
/**
* 新增系统配置页面
*
* @param Request $request 请求对象
* @param string $groupCode 分组Code
* @return Response 响应对象
*/
public function store(Request $request, string $groupCode): Response
{
$data = $this->validated(
@@ -40,3 +71,8 @@ class SystemConfigPageController extends BaseController
);
}
}

View File

@@ -9,22 +9,47 @@ use support\Response;
/**
* 管理后台系统数据控制器。
*
* @property SystemBootstrapService $systemBootstrapService 系统引导服务
*/
class SystemController extends BaseController
{
/**
* 构造方法。
*
* @param SystemBootstrapService $systemBootstrapService 系统引导服务
* @return void
*/
public function __construct(
protected SystemBootstrapService $systemBootstrapService
) {
}
/**
* 获取系统菜单树
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function menuTree(Request $request): Response
{
return $this->success($this->systemBootstrapService->getMenuTree('admin'));
}
/**
* 获取系统字典项
*
* @param Request $request 请求对象
* @return Response 响应对象
*/
public function dictItems(Request $request): Response
{
return $this->success($this->systemBootstrapService->getDictItems((string) $request->get('code', '')));
}
}