1. class
  2. Xpressengine
  3. Site
  4. SiteHandler

SiteHandler

class SiteHandler

Class SiteHandler

Properties

protected SiteRepository $repo
protected ConfigManager $config
protected Site $currentSite

Methods

__construct(SiteRepository $repo, ConfigManager $config)

SiteHandler constructor.

Site
getCurrentSite()

getCurrentSite

void
setCurrentSite(Site $site)

setCurrentSite

string
getCurrentSiteKey()

getCurrentSiteKey

ConfigEntity
getSiteConfig(string|null $siteKey = null)

getSiteConfig

void
putSiteConfig(ConfigEntity $config)

putSiteConfig

string
getDefaultMenuEntityId(null|string $siteKey = null)

getDefaultMenuEntityId

string
setDefaultMenuEntityId(string $menuId, null|string $siteKey = null)

setDefaultMenuEntityId

string
getHomeInstanceId(null|string $siteKey = null)

getHomeInstanceId

string
setHomeInstanceId(string $instanceId, null|string $siteKey = null)

setHomeInstanceId

string
getSiteConfigValue(string $key, string|null $siteKey = null)

getSiteConfigValue

Site
add(array $inputs)

add

Site
put(Site $site)

put

bool|int
remove(string $host)

remove

mixed
__call(string $name, array $arguments)

__call

Details

at line 54
__construct(SiteRepository $repo, ConfigManager $config)

SiteHandler constructor.

Parameters

SiteRepository $repo SiteRepository instance
ConfigManager $config ConfigManager instance

at line 65
Site getCurrentSite()

getCurrentSite

Return Value

Site

at line 77
void setCurrentSite(Site $site)

setCurrentSite

Parameters

Site $site site

Return Value

void

at line 87
string getCurrentSiteKey()

getCurrentSiteKey

Return Value

string

at line 99
ConfigEntity getSiteConfig(string|null $siteKey = null)

getSiteConfig

Parameters

string|null $siteKey site key

Return Value

ConfigEntity

at line 115
void putSiteConfig(ConfigEntity $config)

putSiteConfig

Parameters

ConfigEntity $config site config entity

Return Value

void

Exceptions

InvalidArgumentException

at line 128
string getDefaultMenuEntityId(null|string $siteKey = null)

getDefaultMenuEntityId

Parameters

null|string $siteKey site key

Return Value

string

at line 144
string setDefaultMenuEntityId(string $menuId, null|string $siteKey = null)

setDefaultMenuEntityId

Parameters

string $menuId MenuEntity id
null|string $siteKey site key

Return Value

string

at line 160
string getHomeInstanceId(null|string $siteKey = null)

getHomeInstanceId

Parameters

null|string $siteKey site key

Return Value

string

at line 176
string setHomeInstanceId(string $instanceId, null|string $siteKey = null)

setHomeInstanceId

Parameters

string $instanceId menu item instance id
null|string $siteKey site key

Return Value

string

at line 192
string getSiteConfigValue(string $key, string|null $siteKey = null)

getSiteConfigValue

Parameters

string $key value key
string|null $siteKey site key

Return Value

string

at line 208
Site add(array $inputs)

add

Parameters

array $inputs input array

Return Value

Site

at line 222
Site put(Site $site)

put

Parameters

Site $site site object

Return Value

Site

at line 236
bool|int remove(string $host)

remove

Parameters

string $host site host

Return Value

bool|int

at line 248
mixed __call(string $name, array $arguments)

__call

Parameters

string $name method name
array $arguments arguments

Return Value

mixed