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])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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