1. class
  2. Xpressengine
  3. Document
  4. ConfigHandler

ConfigHandler

class ConfigHandler

ConfigHandler

Constants

CONFIG_NAME

config name

Properties

protected ConfigManager $configManager ConfigManager instance
protected array $default

Methods

__construct(ConfigManager $configManager)

create instance

ConfigManager
getConfigManager()

get config handler instance

ConfigEntity
getDefault()

get default config

ConfigEntity
get(string $instanceId = null)

get config Entity $instanceId 가 없을 경우 default config 반환

ConfigEntity
getOrDefault(string $instanceId)

Return default config when cannot found config

array
gets()

config entity list 반환 list of ConfigEntity

ConfigEntity
make(string $instanceId, array $params)

새로운 document config entity 를 만들어 반환

ConfigEntity
add(ConfigEntity $config)

create document instance

ConfigEntity
put(ConfigEntity $config)

update document instance config

  • Cannot changed 'division', 'revision' configure.

void
remove(ConfigEntity $config)

drop document instance

Details

at line 61
__construct(ConfigManager $configManager)

create instance

Parameters

ConfigManager $configManager ConfigManager instance

at line 71
ConfigManager getConfigManager()

get config handler instance

Return Value

ConfigManager

at line 81
ConfigEntity getDefault()

get default config

Return Value

ConfigEntity

at line 93
ConfigEntity get(string $instanceId = null)

get config Entity $instanceId 가 없을 경우 default config 반환

Parameters

string $instanceId instance id

Return Value

ConfigEntity

at line 110
ConfigEntity getOrDefault(string $instanceId)

Return default config when cannot found config

Parameters

string $instanceId instance id

Return Value

ConfigEntity

at line 125
array gets()

config entity list 반환 list of ConfigEntity

Return Value

array

at line 137
ConfigEntity make(string $instanceId, array $params)

새로운 document config entity 를 만들어 반환

Parameters

string $instanceId instance id
array $params parameters

Return Value

ConfigEntity

at line 166
ConfigEntity add(ConfigEntity $config)

create document instance

Parameters

ConfigEntity $config document instance config

Return Value

ConfigEntity

at line 183
ConfigEntity put(ConfigEntity $config)

update document instance config

  • Cannot changed 'division', 'revision' configure.

Parameters

ConfigEntity $config document instance config

Return Value

ConfigEntity

at line 203
void remove(ConfigEntity $config)

drop document instance

Parameters

ConfigEntity $config config

Return Value

void