OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator Class Reference

Collaboration diagram for OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator:

Public Member Functions
	__construct ($fileCache, $shopIdCalculator)
	getModuleVariable ($name)
	setModuleVariable ($name, $value)

Static Public Member Functions
static	resetModuleVariables ()

Protected Member Functions
	getConfigurationKey ()
	getModuleVarFromDB ($name)
	getFileCache ()
	getShopIdCalculator ()

Static Protected Attributes
static	$moduleVariables = []

Private Attributes
	$fileCache
	$shopIdCalculator

Detailed Description

Selects module variables from database or cache.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::__construct	(		$fileCache,
			$shopIdCalculator
	)

Parameters

FileCache	$fileCache
ShopIdCalculator	$shopIdCalculator

Member Function Documentation

getConfigurationKey()

OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::getConfigurationKey ( )

protected

Returns configuration key. This method is independent from oxConfig functionality.

Returns

string

getFileCache()

OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::getFileCache ( )

protected

Returns

FileCache

getModuleVarFromDB()

OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::getModuleVarFromDB (   $name )

protected

Returns shop module variable value directly from database.

Parameters

string

$name

Module variable name

Returns

string

getModuleVariable()

OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::getModuleVariable

(

$name

)

Retrieves module configuration variable for the base shop. Currently getModuleVar() is expected to be called with one of the values: aModules | aDisabledModules | aModulePaths This method is independent from oxConfig functionality.

Parameters

string

$name

Configuration array name

Returns

array

getShopIdCalculator()

OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::getShopIdCalculator ( )

protected

Returns

ShopIdCalculator

resetModuleVariables()

static OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::resetModuleVariables ( )

static

Resets previously set module information.

setModuleVariable()

OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::setModuleVariable	(		$name,
			$value
	)

Sets module information variable. The variable is set statically and is not saved for future.

Parameters

string	$name	Configuration array name
array	$value	Module name values

Member Data Documentation

$fileCache

OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::$fileCache

private

$moduleVariables

OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::$moduleVariables = []

staticprotected

$shopIdCalculator

OxidEsales\EshopCommunity\Core\Module\ModuleVariablesLocator::$shopIdCalculator

private

---

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

• /oxideshop-ce/source/Core/Module/ModuleVariablesLocator.php