julian/superport_v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

주석화 진행상황 정리하고 핵심 모듈에 한글 주석 추가

Browse Source
This commit is contained in:
JiWoong Sul
2025-09-29 19:39:35 +09:00
parent 9467b8c87f
commit 47c87dc118
82 changed files with 596 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
lib/features/masters/group_permission/data/dtos/group_permission_dto.dart
View File

@@ -2,6 +2,7 @@ import 'package:superport_v2/core/common/models/paginated_result.dart';
import '../../domain/entities/group_permission.dart';
/// 그룹별 메뉴 권한을 표현하는 DTO.
class GroupPermissionDto {
GroupPermissionDto({
this.id,
@@ -31,6 +32,7 @@ class GroupPermissionDto {
final DateTime? createdAt;
final DateTime? updatedAt;
/// JSON에서 권한 정보를 파싱한다.
factory GroupPermissionDto.fromJson(Map<String, dynamic> json) {
return GroupPermissionDto(
id: json['id'] as int?,
@@ -52,6 +54,7 @@ class GroupPermissionDto {
);
}
/// DTO를 도메인 [GroupPermission] 엔티티로 변환한다.
GroupPermission toEntity() => GroupPermission(
id: id,
group: group.toEntity(),
@@ -67,6 +70,7 @@ class GroupPermissionDto {
updatedAt: updatedAt,
);
/// 페이징 응답을 [PaginatedResult]로 변환한다.
static PaginatedResult<GroupPermission> parsePaginated(
Map<String, dynamic>? json,
) {
@@ -84,12 +88,14 @@ class GroupPermissionDto {
}
}
/// 권한 설정에 포함된 그룹 정보를 담는 DTO.
class GroupPermissionGroupDto {
GroupPermissionGroupDto({required this.id, required this.groupName});
final int id;
final String groupName;
/// JSON에서 그룹 정보를 파싱한다.
factory GroupPermissionGroupDto.fromJson(Map<String, dynamic> json) {
return GroupPermissionGroupDto(
id: json['id'] as int? ?? json['group_id'] as int,
@@ -98,16 +104,19 @@ class GroupPermissionGroupDto {
);
}
/// DTO를 [GroupPermissionGroup] 엔티티로 변환한다.
GroupPermissionGroup toEntity() =>
GroupPermissionGroup(id: id, groupName: groupName);
}
/// 권한 대상 메뉴 정보를 담는 DTO.
class GroupPermissionMenuDto {
GroupPermissionMenuDto({required this.id, required this.menuName});
final int id;
final String menuName;
/// JSON에서 메뉴 정보를 파싱한다.
factory GroupPermissionMenuDto.fromJson(Map<String, dynamic> json) {
return GroupPermissionMenuDto(
id: json['id'] as int? ?? json['menu_id'] as int,
@@ -115,10 +124,12 @@ class GroupPermissionMenuDto {
);
}
/// DTO를 [GroupPermissionMenu] 엔티티로 변환한다.
GroupPermissionMenu toEntity() =>
GroupPermissionMenu(id: id, menuName: menuName);
}
/// 문자열/DateTime 값을 파싱해 [DateTime]으로 변환한다.
DateTime? _parseDate(Object? value) {
if (value == null) return null;
if (value is DateTime) return value;

6
lib/features/masters/group_permission/data/repositories/group_permission_repository_remote.dart
View File

@@ -6,6 +6,7 @@ import '../../domain/entities/group_permission.dart';
import '../../domain/repositories/group_permission_repository.dart';
import '../dtos/group_permission_dto.dart';
/// 그룹-메뉴 권한 API를 호출하는 원격 저장소.
class GroupPermissionRepositoryRemote implements GroupPermissionRepository {
GroupPermissionRepositoryRemote({required ApiClient apiClient})
: _api = apiClient;
@@ -14,6 +15,7 @@ class GroupPermissionRepositoryRemote implements GroupPermissionRepository {
static const _basePath = '/group-menu-permissions';
/// 그룹 권한 목록을 조회한다.
@override
Future<PaginatedResult<GroupPermission>> list({
int page = 1,
@@ -39,6 +41,7 @@ class GroupPermissionRepositoryRemote implements GroupPermissionRepository {
return GroupPermissionDto.parsePaginated(response.data ?? const {});
}
/// 그룹 권한을 생성한다.
@override
Future<GroupPermission> create(GroupPermissionInput input) async {
final response = await _api.post<Map<String, dynamic>>(
@@ -50,6 +53,7 @@ class GroupPermissionRepositoryRemote implements GroupPermissionRepository {
return GroupPermissionDto.fromJson(data).toEntity();
}
/// 그룹 권한을 수정한다.
@override
Future<GroupPermission> update(int id, GroupPermissionInput input) async {
final response = await _api.patch<Map<String, dynamic>>(
@@ -61,11 +65,13 @@ class GroupPermissionRepositoryRemote implements GroupPermissionRepository {
return GroupPermissionDto.fromJson(data).toEntity();
}
/// 그룹 권한을 삭제한다.
@override
Future<void> delete(int id) async {
await _api.delete<void>('$_basePath/$id');
}
/// 삭제된 그룹 권한을 복구한다.
@override
Future<GroupPermission> restore(int id) async {
final response = await _api.post<Map<String, dynamic>>(

6
lib/features/masters/group_permission/domain/repositories/group_permission_repository.dart
View File

@@ -2,7 +2,9 @@ import 'package:superport_v2/core/common/models/paginated_result.dart';
import '../entities/group_permission.dart';
/// 그룹-메뉴 권한을 다루는 도메인 저장소 인터페이스.
abstract class GroupPermissionRepository {
/// 권한 목록을 조회한다.
Future<PaginatedResult<GroupPermission>> list({
int page = 1,
int pageSize = 20,
@@ -12,11 +14,15 @@ abstract class GroupPermissionRepository {
bool includeDeleted = false,
});
/// 그룹 권한을 생성한다.
Future<GroupPermission> create(GroupPermissionInput input);
/// 그룹 권한을 수정한다.
Future<GroupPermission> update(int id, GroupPermissionInput input);
/// 그룹 권한을 삭제한다.
Future<void> delete(int id);
/// 삭제된 그룹 권한을 복구한다.
Future<GroupPermission> restore(int id);
}

14
lib/features/masters/group_permission/presentation/controllers/group_permission_controller.dart
View File

@@ -8,6 +8,7 @@ import '../../../menu/domain/repositories/menu_repository.dart';
import '../../domain/entities/group_permission.dart';
import '../../domain/repositories/group_permission_repository.dart';
/// 그룹 권한 활성 여부 필터.
enum GroupPermissionStatusFilter { all, activeOnly, inactiveOnly }
/// 그룹-메뉴 권한 화면용 컨트롤러
@@ -53,6 +54,7 @@ class GroupPermissionController extends ChangeNotifier {
List<Group> get groups => List.unmodifiable(_groups);
List<MenuItem> get menus => List.unmodifiable(_menus);
/// 그룹 목록을 로드해 권한 연결 시 선택할 수 있도록 준비한다.
Future<void> loadGroups() async {
_isLoadingGroups = true;
notifyListeners();
@@ -69,6 +71,7 @@ class GroupPermissionController extends ChangeNotifier {
}
}
/// 메뉴 목록을 로드해 권한 연결 시 선택할 수 있도록 준비한다.
Future<void> loadMenus() async {
_isLoadingMenus = true;
notifyListeners();
@@ -89,6 +92,7 @@ class GroupPermissionController extends ChangeNotifier {
}
}
/// 그룹 권한 목록을 조회한다.
Future<void> fetch({int page = 1}) async {
_isLoading = true;
_errorMessage = null;
@@ -116,26 +120,31 @@ class GroupPermissionController extends ChangeNotifier {
}
}
/// 그룹 필터를 변경한다.
void updateGroupFilter(int? groupId) {
_groupFilter = groupId;
notifyListeners();
}
/// 메뉴 필터를 변경한다.
void updateMenuFilter(int? menuId) {
_menuFilter = menuId;
notifyListeners();
}
/// 권한 활성 상태 필터를 변경한다.
void updateStatusFilter(GroupPermissionStatusFilter filter) {
_statusFilter = filter;
notifyListeners();
}
/// 삭제 포함 여부를 변경한다.
void updateIncludeDeleted(bool value) {
_includeDeleted = value;
notifyListeners();
}
/// 그룹 권한을 생성한다.
Future<GroupPermission?> create(GroupPermissionInput input) async {
_setSubmitting(true);
try {
@@ -151,6 +160,7 @@ class GroupPermissionController extends ChangeNotifier {
}
}
/// 그룹 권한을 수정한다.
Future<GroupPermission?> update(int id, GroupPermissionInput input) async {
_setSubmitting(true);
try {
@@ -166,6 +176,7 @@ class GroupPermissionController extends ChangeNotifier {
}
}
/// 그룹 권한을 삭제한다.
Future<bool> delete(int id) async {
_setSubmitting(true);
try {
@@ -181,6 +192,7 @@ class GroupPermissionController extends ChangeNotifier {
}
}
/// 삭제된 그룹 권한을 복구한다.
Future<GroupPermission?> restore(int id) async {
_setSubmitting(true);
try {
@@ -196,11 +208,13 @@ class GroupPermissionController extends ChangeNotifier {
}
}
/// 에러 메시지를 초기화한다.
void clearError() {
_errorMessage = null;
notifyListeners();
}
/// 제출 상태 플래그를 갱신하고 리스너에게 알린다.
void _setSubmitting(bool value) {
_isSubmitting = value;
notifyListeners();

3
lib/features/masters/group_permission/presentation/pages/group_permission_page.dart
View File

@@ -18,6 +18,7 @@ import '../../domain/entities/group_permission.dart';
import '../../domain/repositories/group_permission_repository.dart';
import '../controllers/group_permission_controller.dart';
/// 그룹-메뉴 권한 설정 페이지. 기능 플래그에 따라 사양/실제 화면을 전환한다.
class GroupPermissionPage extends StatelessWidget {
const GroupPermissionPage({super.key});
@@ -99,6 +100,7 @@ class GroupPermissionPage extends StatelessWidget {
}
}
/// 그룹 권한 기능이 활성화된 경우 사용하는 실제 화면 위젯.
class _GroupPermissionEnabledPage extends StatefulWidget {
const _GroupPermissionEnabledPage();
@@ -107,6 +109,7 @@ class _GroupPermissionEnabledPage extends StatefulWidget {
_GroupPermissionEnabledPageState();
}
/// 그룹 권한 목록/필터/폼 상태를 관리하는 상태 클래스.
class _GroupPermissionEnabledPageState
extends State<_GroupPermissionEnabledPage> {
late final GroupPermissionController _controller;