Files
Gnuboard7/modules/_bundled/sirsoft-page/docs/settings.md
T
HeuJung 6c63536f81 docs(core,extensions): 확장 20개 개발자 문서 완비와 문서 소유 이관
번들 확장 20개 전부에 AGENTS.md · README.md · docs/ 를 채우고, 코어가 들고
있던 확장 소유 문서 두 갈래를 그 확장으로 옮긴다. 번들 템플릿의 컴포넌트·
핸들러·레이아웃 상세와 확장이 구독하는 활동 로그 훅 목록이 그 대상이며,
코어에는 총계와 링크만 남아 확장이 기능을 늘릴 때 코어 문서를 고쳐야 하던
역방향 의존이 사라진다.

전수 완비를 확인하고 강제를 조인다 — 문서 동반 룰을 대상 목록 없는 error 로
승격하고, 검사 스크립트가 문서 미보유를 실패로 올리며, 미채움 마커 baseline 을
0 으로 기록한다. 한쪽만 조이면 "새 확장이 문서 없이 들어와도 초록" 인 상태가
남는데 그 결과는 이상 0건과 구분되지 않는다.

집필 과정에서 드러난 생성기 결함 셋을 함께 고친다. 스케줄 주기 열이 계약 키를
읽지 않아 모든 확장에서 '-' 였고, 네임스페이스를 붙인 핸들러 등록 키가 수집에서
통째로 빠졌으며, README 골격이 폐기된 히어로 배지를 계속 찍어내고 있었다.
셋 다 산출물이 아니라 원천이 틀린 것이라, 가드의 모집단에 생성기 출력 자체를
넣어 다음 확장이 같은 상태로 태어나는 경로를 막는다.
2026-08-31 22:57:36 +09:00

6.8 KiB

페이지 — 설정·권한·라우트

설정 스키마·권한·메뉴·라우트·의존 관계 · 진입점: AGENTS.md

설정 스키마

getSettingsSchema() 선언이 없습니다.

기본값 파일: config/settings/defaults.json

getSettingsSchema() 도 관리자 설정 화면도 없습니다. 조정 가능한 값은 첨부 제한 셋뿐이며 config/settings/defaults.json 이 SSoT 입니다.

키 기본값 쓰이는 곳
attachment.max_count 5 PageAttachmentService — 초과 시 AttachmentLimitExceededException
attachment.max_size_mb 10 UploadPageAttachmentRequest 검증 규칙
attachment.allowed_types 이미지 4종 + PDF + ZIP 같은 FormRequest (미설정 시 클래스 상수 폴백)

파일 형태가 다른 확장과 다릅니다 — 이커머스·게시판은 {_meta, defaults, frontend_schema} 3단 구조지만 여기는 평평한 값 트리입니다. 관리자 화면이 없어 frontend_schema 가 필요 없고, 그래서 _meta 도 두지 않았습니다. 읽기는 g7_module_settings('sirsoft-page', 'attachment.…') 로 하고, PageSettingsService 가 설정이 아직 동기화되지 않은 환경을 위해 파일 직접 읽기를 폴백으로 갖습니다.

서비스에서 상한을 리터럴로 재클램프하지 않습니다. 계산은 서비스가, 상한 검증은 FormRequest 가 단일 책임으로 갖습니다 — 이중 클램프가 생기면 설정을 올려도 반영되지 않습니다.

설정 화면을 나중에 추가한다면 _meta.categories 와 frontend_schema 를 더하는 방식이며, 그때 값의 위치(attachment.*)는 바꾸지 않아야 기존 설치의 값이 유지됩니다.

권한

카테고리 이름 액션 라우트 키
pages 페이지 관리 read, create, update, delete page

pages 하나에 read/create/update/delete 네 액션이 전부입니다. 라우트 키 page 가 선언되어 있어 관리자 라우트에 스코프 미들웨어가 걸립니다.

read 가 관장하는 범위에 주의가 필요합니다 — 관리자 목록·상세뿐 아니라 미발행 페이지의 공개 화면 미리보기와 미발행 페이지 첨부의 서빙까지 이 권한이 판정합니다. 그래서 이 권한을 넓게 주면 아직 공개하지 않은 문서가 그 계정에 열립니다.

역할(getRoles())은 선언하지 않습니다. 게시판처럼 대상마다 담당자가 갈리는 도메인이 아니라 페이지 전체를 한 사람이 관리하는 경우가 대부분이므로, 코어 역할에 이 권한을 부여하는 것으로 충분하다고 보았습니다.

메뉴

구분 slug 이름 URL 하위
관리자 sirsoft-page 페이지 관리 /admin/pages -

최상위 메뉴 하나(/admin/pages)뿐이고 하위 메뉴가 없습니다. 화면이 목록·작성/수정·상세 셋뿐이며 셋 다 목록에서 이어지므로 별도 진입점이 필요 없습니다.

메뉴는 권한과 짝을 이룰 때만 보입니다. pages.read 가 없는 역할에는 이 메뉴가 렌더되지 않습니다. 새 화면을 더한다면 권한·메뉴·라우트 이름 셋이 서로를 정확히 가리키는지 함께 확인합니다.

라우트

종류 파일 URL prefix
api src/routes/api.php /api/modules/sirsoft-page/...

확장 라우트는 활성 상태인 확장의 것만 등록됩니다. 라우트 정의를 바꾸면 라우트 캐시 재생성이 필요합니다.

17개가 파일 하나(src/routes/api.php)에 있고 세 무리로 갈립니다:

무리 prefix 인증
관리자 페이지 CRUD·버전 admin/pages auth:sanctum + 권한 스코프
관리자 첨부 admin/attachments auth:sanctum
공개 조회·첨부 서빙 pages optional.sanctum (비로그인 접근, 발행 상태는 컨트롤러가 판정)

화면용 라우트는 없습니다 — 관리자 화면은 레이아웃 JSON 이 이 API 를 호출해 그리고, 방문자 화면은 템플릿이 GET /pages/{slug} 를 씁니다.

공개 첨부 경로가 해시 기반(/pages/attachment/{hash}, .../preview)인 것에 주의합니다. 새 서빙 경로를 더하면 그 자리에서 발행 상태·권한 게이트를 다시 걸어야 합니다 — 한쪽만 막으면 같은 파일이 형제 엔드포인트로 새어나가고, 정상 응답이라 오류도 로그도 남지 않습니다.

모든 라우트에 name() 이 필요하고, 라우트를 바꾼 뒤에는 라우트 캐시를 다시 굽습니다. 캐시에 없는 라우트는 예외도 경고도 없이 404 가 됩니다.

의존 관계

이 확장이 의존하는 확장

없음 — 코어만으로 동작합니다.

이 확장에 의존하는 확장 (이 확장을 비활성화하면 함께 영향을 받습니다)

확장 유형 요구 버전
sirsoft-marketing 플러그인 >=1.0.0
sirsoft-basic 템플릿 >=1.1.0

이 모듈은 아무 확장에도 의존하지 않습니다. 관계는 한 방향으로 들어옵니다 — sirsoft-marketing 플러그인과 sirsoft-basic 템플릿이 이 모듈을 요구합니다.

manifest 에는 없지만 훅으로 맞물리는 확장이 하나 더 있습니다: sirsoft-ckeditor5 가 없으면 편집기 이미지 출처 제공만 비고 나머지는 정상 동작하므로, 의존으로 올리지 않는 것이 맞습니다.

이 모듈의 공개 표면(Service·Repository·Contracts·라우트·발행 훅)을 바꿀 때는 위 확장들의 dependencies 최소 버전 상향이 필요한지 검토합니다. 특히 공개 조회 API 의 응답 형태는 템플릿이 그대로 화면에 그리므로, 필드를 빼면 그 템플릿의 페이지 화면이 빈 채로 렌더됩니다.