HeuJung
b5c0ec1178
관리자 상품목록을 한 페이지 여는 것만으로 그 페이지 모든 상품의 옵션이 응답에 실렸다. 같은 패턴을 저장소 전역에서 찾아 14개 목록 엔드포인트를 함께 정리했다. 근본 원인은 둘이다. Resource 가 whenLoaded 로 방어하는데 Repository 가 목록 쿼리에서 관계를 무조건 로드해 가드가 항상 참이 되는 가짜 가드, 그리고 toListArray 경량 표현을 정의해 두고도 컬렉션이 toArray 를 부르는 목록/상세 미분리다. 둘 다 응답만 보면 정상이라 오류도 경고도 없이 페이로드만 불어난다. 목록은 화면이 실제로 그리는 것만 싣는다. 개수·합계는 PHP 컬렉션 연산이 아니라 DB 집계로, 대표 1건이 필요한 곳은 관계 자체를 oldestOfMany 로 좁힌다. eager load 의 limit(1) 은 부모별이 아니라 배치 쿼리 전체에 걸려 첫 행만 값을 갖게 되므로 쓸 수 없다. 뺀 값에는 대체 경로를 먼저 만들었다. 상품 옵션은 행을 펼칠 때 배치로 불러오고(상품 수와 무관하게 쿼리 상수), 종전 동작이 필요한 호출자를 위해 ?with_options=1 등 opt-in 을 남겼다. 배송정책 국가설정과 리뷰 첨부 이미지는 소비처를 실측한 결과 화면이 실제로 그리고 있어 제거하지 않았다 — 그 소비 사실을 회귀 테스트로 고정했다. 재발 방지로 정적 검사 룰 4종과 규정 문서 항목을 함께 넣었다.
359 lines
14 KiB
PHP
359 lines
14 KiB
PHP
<?php
|
|
|
|
namespace App\Contracts\Repositories;
|
|
|
|
use App\Enums\LayoutSourceType;
|
|
use App\Models\TemplateLayout;
|
|
use App\Models\TemplateLayoutVersion;
|
|
use Illuminate\Database\Eloquent\Collection;
|
|
use Illuminate\Support\Collection as SupportCollection;
|
|
|
|
interface LayoutRepositoryInterface
|
|
{
|
|
/**
|
|
* 특정 템플릿의 모든 레이아웃 조회
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @return Collection 레이아웃 컬렉션
|
|
*/
|
|
public function getByTemplateId(int $templateId): Collection;
|
|
|
|
/**
|
|
* 목록 표시용 경량 레이아웃 행 조회
|
|
*
|
|
* 본문(`content`)을 반환에 포함하지 않는다 — 설명·크기 등 본문 파생값만 계산해 담는다.
|
|
* 편집 대상 본문은 상세 조회가 제공한다.
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @return Collection<int, array> 목록 행 배열 컬렉션
|
|
*/
|
|
public function getListByTemplateId(int $templateId): SupportCollection;
|
|
|
|
/**
|
|
* 특정 레이아웃 조회 (템플릿 ID와 이름으로)
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string $name 레이아웃 이름
|
|
* @return TemplateLayout|null 찾은 레이아웃 모델 또는 null
|
|
*/
|
|
public function findByName(int $templateId, string $name): ?TemplateLayout;
|
|
|
|
/**
|
|
* 특정 레이아웃을 영구 삭제 (템플릿 ID와 이름으로)
|
|
*
|
|
* soft delete 가 아닌 `forceDelete` 다. 이름으로 재등록될 수 있는 레이아웃
|
|
* (파일 → DB 동기화 대상) 은 soft delete 잔여 행이 남으면 재등록이 충돌하므로
|
|
* 파일 기준 동기화 경로와 동일하게 영구 삭제한다.
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string $name 레이아웃 이름
|
|
* @return bool 삭제 여부 (대상 부재 시 false)
|
|
*/
|
|
public function deleteByName(int $templateId, string $name): bool;
|
|
|
|
/**
|
|
* ID로 레이아웃 조회
|
|
*
|
|
* @param int $id 레이아웃 ID
|
|
* @return TemplateLayout|null 찾은 레이아웃 모델 또는 null
|
|
*/
|
|
public function findById(int $id): ?TemplateLayout;
|
|
|
|
/**
|
|
* 레이아웃이 존재하는지 확인
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string $name 레이아웃 이름
|
|
* @return bool 존재 여부
|
|
*/
|
|
public function exists(int $templateId, string $name): bool;
|
|
|
|
/**
|
|
* 특정 템플릿의 레이아웃 중 지정한 확장점(extension_point)을 정의한 것이 있는지 확인
|
|
*
|
|
* 레이아웃 content JSON 트리를 재귀 순회하여 `type: extension_point` 노드의
|
|
* `name` 이 일치하는지 검사합니다.
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string $extensionPointName 확장점 이름
|
|
* @return bool 정의 존재 여부
|
|
*/
|
|
public function hasExtensionPoint(int $templateId, string $extensionPointName): bool;
|
|
|
|
/**
|
|
* 지정 extension_point 를 포함하는 레이아웃 이름 목록을 반환합니다.
|
|
*
|
|
* 확장 편집 모드에서 extension_point 확장의 대표 호스트 레이아웃 선택(picker)용. 여러
|
|
* 레이아웃에 같은 확장점이 있으면 모두 반환한다.
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string $extensionPointName 확장점 이름
|
|
* @return array<int, string> 호스트 레이아웃 이름 목록
|
|
*/
|
|
public function findLayoutNamesWithExtensionPoint(int $templateId, string $extensionPointName): array;
|
|
|
|
/**
|
|
* 레이아웃 content 트리에 지정 노드 id 가 존재하는지 확인합니다.
|
|
*
|
|
* overlay 확장의 호스트 유효성 판정용 — overlay 는 `injections[].target_id` 위치에 주입되므로,
|
|
* 호스트 레이아웃에 그 id 노드가 없으면 실제로 주입되지 않는다(`applyExtensions` no-op).
|
|
* 노드 식별자는 `id` 또는 `props.id` 두 형태를 모두 검사한다.
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string $layoutName 레이아웃 이름
|
|
* @param string $nodeId 찾을 노드 id
|
|
* @return bool 노드 id 존재 여부
|
|
*/
|
|
public function layoutContainsNodeId(int $templateId, string $layoutName, string $nodeId): bool;
|
|
|
|
/**
|
|
* extends를 가진 자식 레이아웃 조회
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string $extendsName extends 이름
|
|
* @return Collection 자식 레이아웃 컬렉션
|
|
*/
|
|
public function getChildrenByExtends(int $templateId, string $extendsName): Collection;
|
|
|
|
/**
|
|
* 레이아웃 업데이트
|
|
*
|
|
* @param int $id 레이아웃 ID
|
|
* @param array $data 업데이트할 데이터
|
|
* @return TemplateLayout 업데이트된 레이아웃 모델
|
|
*/
|
|
public function update(int $id, array $data): TemplateLayout;
|
|
|
|
/**
|
|
* 레이아웃 content + lock_version 동시 갱신 (낙관적 잠금)
|
|
*
|
|
* Service 가 호출 직전에 expected_lock_version 검증을 마친 상태로,
|
|
* 본 메서드는 content 교체와 lock_version 증가를 한 번의 UPDATE 로 수행한다.
|
|
*
|
|
* @param int $id 레이아웃 ID
|
|
* @param array $content 전체 레이아웃 JSON content
|
|
* @param int $newLockVersion 새 lock_version 값 (currentVersion + 1)
|
|
* @return TemplateLayout 업데이트된 레이아웃 모델
|
|
*/
|
|
public function updateContent(int $id, array $content, int $newLockVersion): TemplateLayout;
|
|
|
|
/**
|
|
* 특정 레이아웃의 최근 버전 목록 조회 (최신순)
|
|
*
|
|
* 버전 행은 저장할 때마다 쌓이고 정리되지 않으므로 조회 건수에 상한이 있습니다.
|
|
* 목록이 쓰지 않는 `content`(버전마다 레이아웃 본문 사본)는 조회하지 않습니다.
|
|
*
|
|
* @param int $layoutId 레이아웃 ID
|
|
* @param int $limit 조회할 최대 버전 수
|
|
* @return Collection 버전 컬렉션
|
|
*/
|
|
public function getVersionsByLayoutId(int $layoutId, int $limit = 100): Collection;
|
|
|
|
/**
|
|
* 특정 버전 조회
|
|
*
|
|
* @param int $layoutId 레이아웃 ID
|
|
* @param int $version 버전 번호
|
|
* @return TemplateLayoutVersion|null 찾은 버전 모델 또는 null
|
|
*/
|
|
public function findVersionByNumber(int $layoutId, int $version): ?TemplateLayoutVersion;
|
|
|
|
/**
|
|
* 템플릿 오버라이드 레이아웃 찾기
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string $layoutName 레이아웃 이름
|
|
* @return TemplateLayout|null 찾은 레이아웃 모델 또는 null
|
|
*/
|
|
public function findTemplateOverride(int $templateId, string $layoutName): ?TemplateLayout;
|
|
|
|
/**
|
|
* 모듈 기본 레이아웃 찾기
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string $layoutName 레이아웃 이름
|
|
* @return TemplateLayout|null 찾은 레이아웃 모델 또는 null
|
|
*/
|
|
public function findModuleLayout(int $templateId, string $layoutName): ?TemplateLayout;
|
|
|
|
/**
|
|
* 특정 템플릿의 모든 레이아웃 이름 조회
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @return \Illuminate\Support\Collection<int, string> 레이아웃 이름 컬렉션
|
|
*/
|
|
public function getLayoutNamesByTemplateId(int $templateId): \Illuminate\Support\Collection;
|
|
|
|
/**
|
|
* 특정 모듈의 모든 레이아웃 조회
|
|
*
|
|
* @param string $moduleIdentifier 모듈 식별자
|
|
* @return Collection 레이아웃 컬렉션
|
|
*/
|
|
public function getLayoutsByModule(string $moduleIdentifier): Collection;
|
|
|
|
/**
|
|
* 특정 템플릿에서 오버라이드된 모든 레이아웃 조회
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @return Collection 오버라이드 레이아웃 컬렉션
|
|
*/
|
|
public function getOverriddenLayouts(int $templateId): Collection;
|
|
|
|
/**
|
|
* 특정 모듈의 레이아웃 중 템플릿에서 오버라이드된 것들 조회
|
|
*
|
|
* @param string $moduleIdentifier 모듈 식별자
|
|
* @param int $templateId 템플릿 ID
|
|
* @return Collection 오버라이드 레이아웃 컬렉션
|
|
*/
|
|
public function getModuleLayoutOverrides(string $moduleIdentifier, int $templateId): Collection;
|
|
|
|
/**
|
|
* 우선순위에 따라 레이아웃 조회 (오버라이드 우선)
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string $name 레이아웃 이름
|
|
* @return TemplateLayout|null 찾은 레이아웃 모델 또는 null
|
|
*/
|
|
public function findByNameWithOverride(int $templateId, string $name): ?TemplateLayout;
|
|
|
|
/**
|
|
* 특정 템플릿의 모든 모듈 레이아웃 조회
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string|null $moduleIdentifier 특정 모듈만 조회 (선택)
|
|
* @return Collection 모듈 레이아웃 컬렉션
|
|
*/
|
|
public function findModuleLayouts(int $templateId, ?string $moduleIdentifier = null): Collection;
|
|
|
|
/**
|
|
* 특정 템플릿의 모든 레이아웃 조회 (source_type 필터 옵션 포함)
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string|null $sourceType 소스 타입 필터
|
|
* @param string|null $sourceIdentifier 소스 식별자 필터
|
|
* @return Collection 레이아웃 컬렉션
|
|
*/
|
|
public function getByTemplateIdWithFilter(
|
|
int $templateId,
|
|
?string $sourceType = null,
|
|
?string $sourceIdentifier = null
|
|
): Collection;
|
|
|
|
/**
|
|
* 특정 플러그인의 모든 레이아웃 조회
|
|
*
|
|
* @param string $pluginIdentifier 플러그인 식별자
|
|
* @return Collection 레이아웃 컬렉션
|
|
*/
|
|
public function getLayoutsByPlugin(string $pluginIdentifier): Collection;
|
|
|
|
/**
|
|
* 특정 템플릿의 모든 플러그인 레이아웃 조회
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @param string|null $pluginIdentifier 특정 플러그인만 조회 (선택)
|
|
* @return Collection 플러그인 레이아웃 컬렉션
|
|
*/
|
|
public function findPluginLayouts(int $templateId, ?string $pluginIdentifier = null): Collection;
|
|
|
|
/**
|
|
* 레이아웃을 생성하거나 업데이트합니다.
|
|
*
|
|
* @param array $attributes 조회 조건
|
|
* @param array $values 생성/업데이트할 데이터
|
|
* @return TemplateLayout 생성 또는 업데이트된 레이아웃 모델
|
|
*/
|
|
public function updateOrCreate(array $attributes, array $values): TemplateLayout;
|
|
|
|
/**
|
|
* 특정 모듈의 soft delete된 레이아웃을 조회합니다.
|
|
*
|
|
* @param string $moduleIdentifier 모듈 식별자
|
|
* @return Collection soft delete된 레이아웃 컬렉션
|
|
*/
|
|
public function getTrashedByModule(string $moduleIdentifier): Collection;
|
|
|
|
/**
|
|
* 특정 모듈의 레이아웃을 soft delete합니다.
|
|
*
|
|
* @param string $moduleIdentifier 모듈 식별자
|
|
* @return int soft delete된 레코드 수
|
|
*/
|
|
public function softDeleteByModule(string $moduleIdentifier): int;
|
|
|
|
/**
|
|
* 특정 모듈의 레이아웃을 영구 삭제합니다 (soft delete 포함).
|
|
*
|
|
* @param string $moduleIdentifier 모듈 식별자
|
|
* @return int 삭제된 레코드 수
|
|
*/
|
|
public function forceDeleteByModule(string $moduleIdentifier): int;
|
|
|
|
/**
|
|
* 특정 모듈의 레이아웃 개수를 반환합니다 (soft delete 포함).
|
|
*
|
|
* @param string $moduleIdentifier 모듈 식별자
|
|
* @return int 레이아웃 개수
|
|
*/
|
|
public function countByModule(string $moduleIdentifier): int;
|
|
|
|
/**
|
|
* 특정 모듈의 soft delete된 레이아웃을 복원합니다.
|
|
*
|
|
* @param string $moduleIdentifier 모듈 식별자
|
|
* @return int 복원된 레코드 수
|
|
*/
|
|
public function restoreByModule(string $moduleIdentifier): int;
|
|
|
|
/**
|
|
* 특정 모듈의 레이아웃들을 조회합니다 (soft delete 제외).
|
|
*
|
|
* @param string $moduleIdentifier 모듈 식별자
|
|
* @return Collection 레이아웃 컬렉션
|
|
*/
|
|
public function getByModuleIdentifier(string $moduleIdentifier): Collection;
|
|
|
|
/**
|
|
* 특정 확장(모듈 또는 플러그인)의 레이아웃들을 소스 타입과 함께 조회합니다.
|
|
*
|
|
* @param string $sourceIdentifier 확장 식별자
|
|
* @param LayoutSourceType $sourceType 소스 타입 (Module 또는 Plugin)
|
|
* @return Collection 레이아웃 컬렉션
|
|
*/
|
|
public function getBySourceIdentifier(string $sourceIdentifier, LayoutSourceType $sourceType): Collection;
|
|
|
|
/**
|
|
* 특정 템플릿의 모든 레이아웃을 삭제합니다.
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @return int 삭제된 레코드 수
|
|
*/
|
|
public function deleteByTemplateId(int $templateId): int;
|
|
|
|
/**
|
|
* 특정 템플릿의 레이아웃 개수를 조회합니다.
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @return int 레이아웃 개수
|
|
*/
|
|
public function countByTemplateId(int $templateId): int;
|
|
|
|
/**
|
|
* 특정 템플릿의 오버라이드 레이아웃들을 조회합니다.
|
|
*
|
|
* @param int $templateId 템플릿 ID
|
|
* @return Collection 오버라이드 레이아웃 컬렉션
|
|
*/
|
|
public function getOverridesByTemplateId(int $templateId): Collection;
|
|
|
|
/**
|
|
* 특정 소스 식별자의 레이아웃을 모두 삭제합니다.
|
|
*
|
|
* @param string $sourceIdentifier 소스 식별자 (모듈/템플릿 식별자)
|
|
* @return int 삭제된 레코드 수
|
|
*/
|
|
public function deleteBySourceIdentifier(string $sourceIdentifier): int;
|
|
}
|