SkinHandler
class SkinHandler
SkinHandler는 XpressEngine에 등록된 스킨들을 관리하는 역할을 합니다. SkinHandler는 XE에서 XeSkin
파사드를 할당받습니다.
Constants
INSTANCE_DELIMITER |
타겟에 대한 스킨정보를 저장할 때 사용하는 Key의 구분자. |
Properties
protected PluginRegister | $register | ||
protected SkinInstanceStore | $store | ||
protected string[] | $defaultSkins | ||
protected string[] | $defaultSettingsSkins | ||
protected Closure | $mobileResolver |
Methods
생성자.
스킨 지정 정보 저장소를 반환한다.
현재 요청이 모바일 버전인지 조회할 때 사용되는 resolver를 조회한다.
주어진 id로 등록된 스킨을 반환한다.
해당 id의 스킨이 등록돼 있는지 검사
주어진 타겟에 등록된 스킨의 목록을 조회하여 반환한다.
주어진 타겟에 등록된 모바일 스킨의 목록을 조회하여 반환한다.
주어진 타겟에 등록된 데스크탑 스킨의 목록을 조회하여 반환한다.
타겟이 지정돼 있는 스킨을 반환한다.
타겟이 지정돼 있는 설정스킨을 반환한다.
타겟에 주어진 스킨을 지정한다. 지정된 정보를 저장소에 저장하고, getAssigned() 메소드를 통해 조회할 수 있다.
기본스킨으로 사용할 스킨을 지정한다.
기본스킨으로 사용할 설정스킨을 지정한다.
스킨 지정정보를 저장소에 사용하는 키를 조합한다.
Details
at line 72
__construct(PluginRegister $register, SkinInstanceStore $store, array $defaultSkins, array $defaultSettingsSkins)
생성자.
at line 91
void
setStore(SkinInstanceStore $store)
스킨 지정 정보 저장소를 설정한다.
at line 101
SkinInstanceStore
getStore()
스킨 지정 정보 저장소를 반환한다.
at line 114
void
setMobileResolver(Closure $callback)
현재 요청이 모바일 버전인지 조회할 때 사용되는 resolver를 지정한다.
at line 124
Closure
getMobileResolver()
현재 요청이 모바일 버전인지 조회할 때 사용되는 resolver를 조회한다.
at line 138
SkinEntity
get(string $id, array $config = null)
주어진 id로 등록된 스킨을 반환한다.
at line 160
bool
has(string $id)
해당 id의 스킨이 등록돼 있는지 검사
at line 180
SkinEntity[]
getList(string|string[] $target, bool $isSettings = false)
주어진 타겟에 등록된 스킨의 목록을 조회하여 반환한다.
at line 202
SkinEntity[]
getListSupportingMobile(string|string[] $target, bool $isSettings = false)
주어진 타겟에 등록된 모바일 스킨의 목록을 조회하여 반환한다.
at line 222
SkinEntity[]
getListSupportingDesktop(string|string[] $target, bool $isSettings = false)
주어진 타겟에 등록된 데스크탑 스킨의 목록을 조회하여 반환한다.
at line 243
SkinEntity
getAssigned(string|string[] $target, string $mode = null)
타겟이 지정돼 있는 스킨을 반환한다.
at line 288
SkinEntity
getAssignedSettings(string|string[] $target)
타겟이 지정돼 있는 설정스킨을 반환한다.
설정스킨을 모바일|데스크탑을 구분하지 않고, 스킨 정보를 저장소에 저장하는 기능도 제공하지 않는다.
at line 320
void
assign(string $target, SkinEntity $skin, string|null $mode = 'desktop')
타겟에 주어진 스킨을 지정한다. 지정된 정보를 저장소에 저장하고, getAssigned() 메소드를 통해 조회할 수 있다.
at line 336
void
saveConfig(string $target, SkinEntity $skin)
주어진 타겟에 지정된 스킨의 설정을 저장한다.
at line 353
void
setDefaultSkin(string $target, string $skinId)
기본스킨으로 사용할 스킨을 지정한다.
해당 타겟에 사용할 스킨을 찾을 때, 저장소에 지정된 스킨 정보가 없을 경우, 이 메소드를 통해 지정된 기본스킨을 조회한다.
at line 367
void
setDefaultSettingsSkin(string $target, string $skinId)
기본스킨으로 사용할 설정스킨을 지정한다.
해당 타겟에 사용할 설정스킨을 찾을 때, 저장소에 지정된 스킨 정보가 없을 경우, 이 메소드를 통해 지정된 스킨을 조회한다.
at line 381
string
mergeKey(string|string[] $target, string|null $instanceId = null)
스킨 지정정보를 저장소에 사용하는 키를 조합한다.
보통 타겟과 해당 타겟의 인스턴스 아이디를 전달받는다.