PHP 클래스 Xpressengine\Site\SiteHandler

## app binding * xe.site 으로 바인딩 되어 있음 * XeSite Facade 제공 ## 사용법 ### 현재의 Site 객체를 획득 php XeSite::getCurrentSite() ### 현재의 Site 객체를 지정 php XeSite::setCurrentSite(Site $site) ### 현재의 SiteKey 획득 * 현재 사이트 객체에서 사이트 키를 가져옴. * 편의를 위해서 제공 php XeSite::getCurrentSiteKey() ### Site 의 ConfigEntity 획득 * siteKey 에 해당하는 설정 정보 가져옴 * siteKey 를 전달하지 않는 경우에는 defaultSiteKey 가 적용됨 php XeSite::getSiteConfig($siteKey = null) ### Site 의 ConfigEntity 업데이트 * siteKey 에 해당하는 ConfigEntity 수정 php XeSite::putSiteConfig(ConfigEntity $config)
저자: XE Developers ([email protected])
파일 보기 프로젝트 열기: xpressengine/xpressengine 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$config Xpressengine\Config\ConfigManager
$currentSite Site
$model

공개 메소드들

메소드 설명
__construct ( ConfigManager $config ) SiteHandler constructor.
add ( array $inputs ) : Site add
createModel ( ) : string Create new site model
getCurrentSite ( ) : Site getCurrentSite
getCurrentSiteKey ( ) : string getCurrentSiteKey
getDefaultMenuEntityId ( null | string $siteKey = null ) : string getDefaultMenuEntityId
getHomeInstanceId ( null | string $siteKey = null ) : string getHomeInstanceId
getModel ( ) : string Get site model
getSiteConfig ( string | null $siteKey = null ) : ConfigEntity getSiteConfig
getSiteConfigValue ( string $key, string | null $siteKey = null ) : string getSiteConfigValue
put ( Site $site ) : Site put
putSiteConfig ( ConfigEntity $config ) : void putSiteConfig
remove ( string $host ) : void remove
setCurrentSite ( Site $site ) : void setCurrentSite
setDefaultMenuEntityId ( string $menuId, null | string $siteKey = null ) : string setDefaultMenuEntityId
setHomeInstanceId ( string $instanceId, null | string $siteKey = null ) : string setHomeInstanceId
setModel ( string $model ) : void Set site model

보호된 메소드들

메소드 설명
checkUsableDomain ( string $host ) : void checkUsableDomain

메소드 상세

__construct() 공개 메소드

SiteHandler constructor.
public __construct ( ConfigManager $config )
$config Xpressengine\Config\ConfigManager xpressengine config manager

add() 공개 메소드

add
public add ( array $inputs ) : Site
$inputs array input array
리턴 Site

checkUsableDomain() 보호된 메소드

checkUsableDomain
protected checkUsableDomain ( string $host ) : void
$host string site host
리턴 void

createModel() 공개 메소드

Create new site model
public createModel ( ) : string
리턴 string

getCurrentSite() 공개 메소드

getCurrentSite
public getCurrentSite ( ) : Site
리턴 Site

getCurrentSiteKey() 공개 메소드

getCurrentSiteKey
public getCurrentSiteKey ( ) : string
리턴 string

getDefaultMenuEntityId() 공개 메소드

getDefaultMenuEntityId
public getDefaultMenuEntityId ( null | string $siteKey = null ) : string
$siteKey null | string site key
리턴 string

getHomeInstanceId() 공개 메소드

getHomeInstanceId
public getHomeInstanceId ( null | string $siteKey = null ) : string
$siteKey null | string site key
리턴 string

getModel() 공개 메소드

Get site model
public getModel ( ) : string
리턴 string

getSiteConfig() 공개 메소드

getSiteConfig
public getSiteConfig ( string | null $siteKey = null ) : ConfigEntity
$siteKey string | null site key
리턴 Xpressengine\Config\ConfigEntity

getSiteConfigValue() 공개 메소드

getSiteConfigValue
public getSiteConfigValue ( string $key, string | null $siteKey = null ) : string
$key string value key
$siteKey string | null site key
리턴 string

put() 공개 메소드

put
public put ( Site $site ) : Site
$site Site site object
리턴 Site

putSiteConfig() 공개 메소드

putSiteConfig
public putSiteConfig ( ConfigEntity $config ) : void
$config Xpressengine\Config\ConfigEntity site config entity
리턴 void

remove() 공개 메소드

remove
public remove ( string $host ) : void
$host string site host
리턴 void

setCurrentSite() 공개 메소드

setCurrentSite
public setCurrentSite ( Site $site ) : void
$site Site site
리턴 void

setDefaultMenuEntityId() 공개 메소드

setDefaultMenuEntityId
public setDefaultMenuEntityId ( string $menuId, null | string $siteKey = null ) : string
$menuId string MenuEntity id
$siteKey null | string site key
리턴 string

setHomeInstanceId() 공개 메소드

setHomeInstanceId
public setHomeInstanceId ( string $instanceId, null | string $siteKey = null ) : string
$instanceId string menu item instance id
$siteKey null | string site key
리턴 string

setModel() 공개 메소드

Set site model
public setModel ( string $model ) : void
$model string model class
리턴 void

프로퍼티 상세

$config 보호되어 있는 프로퍼티

protected ConfigManager,Xpressengine\Config $config
리턴 Xpressengine\Config\ConfigManager

$currentSite 보호되어 있는 프로퍼티

protected Site,Xpressengine\Site $currentSite
리턴 Site

$model 보호되어 있는 프로퍼티

protected $model