OxidEsales\EshopCommunity\Core\SettingsHandler Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Core\SettingsHandler:

Collaboration diagram for OxidEsales\EshopCommunity\Core\SettingsHandler:

Public Member Functions
	setModuleType ($moduleType)
	run ($module)

Protected Member Functions
	addModuleSettings ($moduleSettings, $moduleId)
	isTheme ($moduleId)
	removeNotUsedSettings ($moduleSettings, $moduleId)
	getModuleConfigs ($moduleId)
	parseModuleSettings ($moduleSettings)
	removeModuleConfigs ($moduleId, $configsToRemove)
	getModuleConfigId ($moduleId)

Protected Attributes
	$moduleType

Detailed Description

Settings handler class.

Member Function Documentation

addModuleSettings()

OxidEsales\EshopCommunity\Core\SettingsHandler::addModuleSettings (   $moduleSettings,   $moduleId  )

protected

Adds settings to database.

Parameters

array	$moduleSettings	Module settings array
string	$moduleId	Module id

getModuleConfigId()

OxidEsales\EshopCommunity\Core\SettingsHandler::getModuleConfigId (   $moduleId )

protected

Get config tables specific module id

Parameters

string

$moduleId

Returns

string

getModuleConfigs()

OxidEsales\EshopCommunity\Core\SettingsHandler::getModuleConfigs (   $moduleId )

protected

Returns module configuration from database

Parameters

string

$moduleId

Module id

Returns

array key=>value

isTheme()

OxidEsales\EshopCommunity\Core\SettingsHandler::isTheme (   $moduleId )

protected

Check if module is theme.

Parameters

string

$moduleId

Returns

bool

parseModuleSettings()

OxidEsales\EshopCommunity\Core\SettingsHandler::parseModuleSettings (   $moduleSettings )

protected

Parses module config variable names to array from module settings

Parameters

array

$moduleSettings

Module settings

Returns

array

removeModuleConfigs()

OxidEsales\EshopCommunity\Core\SettingsHandler::removeModuleConfigs (   $moduleId,   $configsToRemove  )

protected

Removes module configs from database

Parameters

string	$moduleId	Module id
array	$configsToRemove	Configs to remove

removeNotUsedSettings()

OxidEsales\EshopCommunity\Core\SettingsHandler::removeNotUsedSettings (   $moduleSettings,   $moduleId  )

protected

Removes configs which are removed from module metadata

Parameters

array	$moduleSettings	Module settings
string	$moduleId	Module id

run()

OxidEsales\EshopCommunity\Core\SettingsHandler::run

(

$module

)

Get settings and module id and starts import process.

Run module settings import logic only if it has settings array On empty settings array, it will remove the settings.

Parameters

object

$module

Module or Theme Object

setModuleType()

OxidEsales\EshopCommunity\Core\SettingsHandler::setModuleType

(

$moduleType

)

Sets the Module type

Parameters

string

$moduleType

can be either 'module' or 'theme'

Returns

oxSettingsHandler

Member Data Documentation

$moduleType

OxidEsales\EshopCommunity\Core\SettingsHandler::$moduleType

protected

---

The documentation for this class was generated from the following file:

• /oxideshop-ce/source/Core/SettingsHandler.php