OxidEsales\EshopCommunity\Core\Module\ModuleInstaller Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Core\Module\ModuleInstaller:

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

Public Member Functions
	__construct (\OxidEsales\Eshop\Core\Module\ModuleCache $moduleCache=null, $moduleCleaner=null)
	setModuleCache ($oModuleCache)
	getModuleCache ()
	activate (\OxidEsales\Eshop\Core\Module\Module $module)
	deactivate (\OxidEsales\Eshop\Core\Module\Module $module)
	getModulesWithExtendedClass ()
	buildModuleChains ($aModuleArray)
	diffModuleArrays ($aAllModuleArray, $aRemModuleArray)

Protected Member Functions
	getModuleCleaner ()
	_addToDisabledList ($sModuleId)
	_deleteModule ($sModuleId)
	_deleteBlock ($sModuleId)
	_deleteTemplateFiles ($sModuleId)
	_deleteModuleFiles ($sModuleId)
	_deleteModuleEvents ($sModuleId)
	_deleteModuleVersions ($sModuleId)
	_addExtensions (\OxidEsales\Eshop\Core\Module\Module $module)
	_mergeModuleArrays ($aAllModuleArray, $aAddModuleArray)
	_removeFromDisabledList ($sModuleId)
	_addTemplateBlocks ($moduleBlocks, $moduleId)
	_addModuleFiles ($aModuleFiles, $sModuleId)
	_addTemplateFiles ($aModuleTemplates, $sModuleId)
	_addModuleEvents ($aModuleEvents, $sModuleId)
	_addModuleVersion ($sModuleVersion, $sModuleId)
	_addModuleExtensions ($moduleExtensions, $moduleId)
	addModuleControllers ($moduleControllers, $moduleId)
	deleteModuleControllers ($moduleId)
	_callEvent ($sEvent, $sModuleId)
	_removeNotUsedExtensions ($installedExtensions, \OxidEsales\Eshop\Core\Module\Module $module)
	_saveToConfig ($sVariableName, $sVariableValue, $sVariableType='aarr')
	resetCache ()
	getModuleControllerMapProvider ()
	getShopControllerMapProvider ()
	getClassProviderStorage ()
	validateModuleMetadataControllersOnActivation ($moduleControllers)
	validateMetadataExtendSection (\OxidEsales\Eshop\Core\Module\Module $module)
	getModuleMetadataValidator ()

Protected Attributes
	$_oModuleCache

Private Member Functions
	addModuleSmartyPluginDirectories (EshopModule $module)
	deleteModuleSmartyPluginDirectories ($moduleId)
	getModuleSmartyPluginDirectoryRepository ()
	getShopIdCalculator ()

Private Attributes
	$moduleCleaner

Detailed Description

Modules installer class.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::__construct	(	\OxidEsales\Eshop\Core\Module\ModuleCache	$moduleCache = null,
			$moduleCleaner = null
	)

Sets dependencies.

Parameters

\OxidEsales\Eshop\Core\Module\ModuleCache	$moduleCache
\OxidEsales\Eshop\Core\Module\ModuleExtensionsCleaner	$moduleCleaner

Member Function Documentation

_addExtensions()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_addExtensions ( \OxidEsales\Eshop\Core\Module\Module  $module )

protected

Add extension to module

Parameters

\OxidEsales\Eshop\Core\Module\Module

$module

_addModuleEvents()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_addModuleEvents (   $aModuleEvents,   $sModuleId  )

protected

Add module events to config.

Parameters

array	$aModuleEvents	Module events
string	$sModuleId	Module id

_addModuleExtensions()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_addModuleExtensions (   $moduleExtensions,   $moduleId  )

protected

Add module id with extensions to config.

Parameters

array	$moduleExtensions	Module version
string	$moduleId	Module id

_addModuleFiles()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_addModuleFiles (   $aModuleFiles,   $sModuleId  )

protected

Add module files to config for auto loader.

Parameters

array	$aModuleFiles	Module files array
string	$sModuleId	Module id

_addModuleVersion()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_addModuleVersion (   $sModuleVersion,   $sModuleId  )

protected

Add module version to config.

Parameters

string	$sModuleVersion	Module version
string	$sModuleId	Module id

_addTemplateBlocks()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_addTemplateBlocks (   $moduleBlocks,   $moduleId  )

protected

Add module templates to database.

Parameters

array	$moduleBlocks	Module blocks array
string	$moduleId	Module id

_addTemplateFiles()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_addTemplateFiles (   $aModuleTemplates,   $sModuleId  )

protected

Add module template files to config for smarty.

Parameters

array	$aModuleTemplates	Module templates array
string	$sModuleId	Module id

_addToDisabledList()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_addToDisabledList (   $sModuleId )

protected

Add module to disable list

Parameters

string

$sModuleId

Module id

_callEvent()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_callEvent (   $sEvent,   $sModuleId  )

protected

Call module event.

Parameters

string	$sEvent	Event name
string	$sModuleId	Module Id

_deleteBlock()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_deleteBlock (   $sModuleId )

protected

Deactivates or activates oxBlocks of a module

Parameters

string

$sModuleId

Module id

_deleteModule()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_deleteModule (   $sModuleId )

protected

Removes extension from modules array.

Deprecated:

on b-dev, This method is not used in code.

Parameters

string

$sModuleId

Module id

_deleteModuleEvents()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_deleteModuleEvents (   $sModuleId )

protected

Removes module events

Parameters

string

$sModuleId

Module id

_deleteModuleFiles()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_deleteModuleFiles (   $sModuleId )

protected

Add module files

Parameters

string

$sModuleId

Module id

_deleteModuleVersions()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_deleteModuleVersions (   $sModuleId )

protected

Removes module versions

Parameters

string

$sModuleId

Module id

_deleteTemplateFiles()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_deleteTemplateFiles (   $sModuleId )

protected

Add module template files to config for smarty.

Parameters

string

$sModuleId

Module id

_mergeModuleArrays()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_mergeModuleArrays (   $aAllModuleArray,   $aAddModuleArray  )

protected

Merge two nested module arrays together so that the values of $aAddModuleArray are appended to the end of the $aAllModuleArray

Parameters

array	$aAllModuleArray	All Module array (nested format)
array	$aAddModuleArray	Added Module array (nested format)

Returns

array

_removeFromDisabledList()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_removeFromDisabledList (   $sModuleId )

protected

Removes module from disabled module list

Parameters

string

$sModuleId

Module id

_removeNotUsedExtensions()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_removeNotUsedExtensions (   $installedExtensions, \OxidEsales\Eshop\Core\Module\Module  $module  )

protected

Removes garbage ( module not used extensions ) from all installed extensions list

Parameters

array	$installedExtensions	Installed extensions
\OxidEsales\Eshop\Core\Module\Module	$module	Module

Deprecated:

on b-dev, \OxidEsales\Eshop\Core\Module\ModuleExtensionsCleaner::cleanExtensions() should be used.

Returns

array

_saveToConfig()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::_saveToConfig (   $sVariableName,   $sVariableValue,   $sVariableType = 'aarr'  )

protected

Save module parameters to shop config

Parameters

string	$sVariableName	config name
string	$sVariableValue	config value
string	$sVariableType	config type

activate()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::activate

(

\OxidEsales\Eshop\Core\Module\Module

$module

)

Activate extension by merging module class inheritance information with shop module array

Parameters

\OxidEsales\Eshop\Core\Module\Module

$module

Returns

bool

addModuleControllers()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::addModuleControllers (   $moduleControllers,   $moduleId  )

protected

Add controllers map for a given module Id to config

Parameters

array	$moduleControllers	Map of controller ids and class names
string	$moduleId	The Id of the module

addModuleSmartyPluginDirectories()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::addModuleSmartyPluginDirectories ( EshopModule  $module )

private

Parameters

EshopModule

$module

buildModuleChains()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::buildModuleChains

(

$aModuleArray

)

Build module chains from nested array

Parameters

array

$aModuleArray

Module array (nested format)

Returns

array

deactivate()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::deactivate

(

\OxidEsales\Eshop\Core\Module\Module

$module

)

Deactivate extension by adding disable module class information to disabled module array

Parameters

\OxidEsales\Eshop\Core\Module\Module

$module

Returns

bool

deleteModuleControllers()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::deleteModuleControllers (   $moduleId )

protected

Remove controllers map for a given module Id from config

Parameters

string

$moduleId

The Id of the module

deleteModuleSmartyPluginDirectories()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::deleteModuleSmartyPluginDirectories (   $moduleId )

private

Parameters

string

$moduleId

diffModuleArrays()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::diffModuleArrays	(		$aAllModuleArray,
			$aRemModuleArray
	)

Diff two nested module arrays together so that the values of $aRmModuleArray are removed from $aAllModuleArray

Parameters

array	$aAllModuleArray	All Module array (nested format)
array	$aRemModuleArray	Remove Module array (nested format)

Returns

array

getClassProviderStorage()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::getClassProviderStorage ( )

protected

Returns

object

getModuleCache()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::getModuleCache

(

)

Gets module cache.

Returns

\OxidEsales\Eshop\Core\Module\ModuleCache

getModuleCleaner()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::getModuleCleaner ( )

protected

Returns module cleaner object.

Returns

\OxidEsales\Eshop\Core\Module\ModuleExtensionsCleaner

getModuleControllerMapProvider()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::getModuleControllerMapProvider ( )

protected

Returns

\OxidEsales\Eshop\Core\Contract\ControllerMapProviderInterface

getModuleMetadataValidator()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::getModuleMetadataValidator ( )

protected

Returns

\OxidEsales\Eshop\Core\Module\ModuleMetadataValidator

getModuleSmartyPluginDirectoryRepository()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::getModuleSmartyPluginDirectoryRepository ( )

private

Returns

EshopModuleSmartyPluginDirectoryRepository

getModulesWithExtendedClass()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::getModulesWithExtendedClass

(

)

Get parsed modules

Returns

array

getShopControllerMapProvider()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::getShopControllerMapProvider ( )

protected

Returns

\OxidEsales\Eshop\Core\Contract\ControllerMapProviderInterface

getShopIdCalculator()

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

private

Returns

ShopIdCalculator

resetCache()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::resetCache ( )

protected

Resets modules cache.

setModuleCache()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::setModuleCache

(

$oModuleCache

)

Sets module cache.

Parameters

\OxidEsales\Eshop\Core\Module\ModuleCache

$oModuleCache

validateMetadataExtendSection()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::validateMetadataExtendSection ( \OxidEsales\Eshop\Core\Module\Module  $module )

protected

Validate module metadata extend section. Only Unified Namespace shop classes are free to patch.

Parameters

\OxidEsales\Eshop\Core\Module\Module

$module

Exceptions

ModuleValidationException

validateModuleMetadataControllersOnActivation()

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::validateModuleMetadataControllersOnActivation (   $moduleControllers )

protected

Ensure integrity of the controllerMap before storing it. Both keys and values must be unique with in the same shop or sub-shop.

Parameters

array

$moduleControllers

Exceptions

ModuleValidationException

Member Data Documentation

$_oModuleCache

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::$_oModuleCache

protected

$moduleCleaner

OxidEsales\EshopCommunity\Core\Module\ModuleInstaller::$moduleCleaner

private

---

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

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