oxModule Class Reference

Inheritance diagram for oxModule:

Collaboration diagram for oxModule:

List of all members.

Public Member Functions
	setModuleData ($aModule)
	load ($sModuleId)
	loadByDir ($sModuleDir)
	loadModule ($sModuleId)
	loadLegacyModule ($sModuleId)
	loadUnregisteredModule ($sModuleId)
	getDescription ()
	getTitle ()
	getId ()
	getIdByPath ($sModule)
	getInfo ($sName, $iLang=null)
	isActive ()
	isExtended ()
	isLegacy ()
	isRegistered ()
	hasMetadata ()
	isFile ()
	activate ()
	deactivate ($sModuleId=null)
	buildModuleChains ($aModuleArray)
	mergeModuleArrays ($aAllModuleArray, $aAddModuleArray)
	filterModuleArray ($aModules, $sModuleId)
	getModulePath ($sModuleId=null)
	getModuleFullPath ($sModuleId)
	getAllModules ()
	getLegacyModules ()
	getDisabledModules ()
	getModulePaths ()
	getModuleTemplates ()
	getModuleFiles ()
	getModuleVersions ()
	getModuleEvents ()
	getTemplates ($sModuleId=null)
	saveLegacyModule ($sModuleId, $sModuleName, $aModuleInfo=null)
	updateModuleIds ($sModuleLegacyId, $sModuleId)
Protected Member Functions
	_callEvent ($sEvent, $sModuleId)
	_changeBlockStatus ($sModule, $iStatus=0)
	_resetCache ()
	_hasInstalledTemplateBlocks ($sModuleId)
	_addTemplateBlocks ($aModuleBlocks, $sModuleId=null)
	_addTemplateFiles ($aModuleTemplates, $sModuleId=null)
	_addModuleVersion ($sModuleVersion, $sModuleId=null)
	_addModuleEvents ($aModuleEvents, $sModuleId=null)
	_addModuleFiles ($aModuleFiles, $sModuleId=null)
	_addModuleSettings ($aModuleSettings, $sModuleId=null)
	_clearApcCache ()
Protected Attributes
	$_aModule = array()
	$_blMetadata = false
	$_blRegistered = false
	$_blFile = false
	$_blLegacy = false

---

Detailed Description

Class handling shop modules

Definition at line 7 of file oxmodule.php.

---

Member Function Documentation

oxModule._addModuleEvents	(	$	aModuleEvents,
		$	sModuleId = null
	)			[protected]

Add module events to config.

Parameters:

	array	$aModuleEvents Module events
	string	$sModuleId Module id

Returns:

null

Definition at line 829 of file oxmodule.php.

oxModule._addModuleFiles	(	$	aModuleFiles,
		$	sModuleId = null
	)			[protected]

Add module files to config for auto loader.

Parameters:

	array	$aModuleFiles Module files array
	string	$sModuleId Module id

Returns:

null

Definition at line 853 of file oxmodule.php.

oxModule._addModuleSettings	(	$	aModuleSettings,
		$	sModuleId = null
	)			[protected]

Add module settings to database.

Parameters:

	array	$aModuleSettings Module settings array
	string	$sModuleId Module id

Returns:

null

Definition at line 877 of file oxmodule.php.

oxModule._addModuleVersion	(	$	sModuleVersion,
		$	sModuleId = null
	)			[protected]

Add module version to config.

Parameters:

	string	$sModuleVersion Module version
	string	$sModuleId Module id

Returns:

null

Definition at line 805 of file oxmodule.php.

oxModule._addTemplateBlocks	(	$	aModuleBlocks,
		$	sModuleId = null
	)			[protected]

Add module templates to database.

Parameters:

	array	$aModuleBlocks Module blocks array
	string	$sModuleId Module id

Returns:

null

Definition at line 746 of file oxmodule.php.

oxModule._addTemplateFiles	(	$	aModuleTemplates,
		$	sModuleId = null
	)			[protected]

Add module template files to config for smarty.

Parameters:

	array	$aModuleTemplates Module templates array
	string	$sModuleId Module id

Returns:

null

Definition at line 781 of file oxmodule.php.

oxModule._callEvent	(	$	sEvent,
		$	sModuleId
	)			[protected]

Call module event.

Parameters:

	string	$sEvent Event name
	string	$sModuleId Module Id

Returns:

null

Definition at line 485 of file oxmodule.php.

oxModule._changeBlockStatus	(	$	sModule,
		$	iStatus = 0
	)			[protected]

Deactivates or activates oxblocks of a module

Parameters:

	string	$sModule Module name
	integer	$iStatus 0 or 1 to (de)activate blocks

Returns:

null

Definition at line 506 of file oxmodule.php.

oxModule._clearApcCache

(

)

[protected]

Cleans PHP APC cache

Definition at line 1020 of file oxmodule.php.

oxModule._hasInstalledTemplateBlocks

(

$

sModuleId

)

[protected]

Checks if module has installed template blocks

Parameters:

string

$sModuleId Module ID

Returns:

bool

Definition at line 730 of file oxmodule.php.

oxModule._resetCache

(

)

[protected]

Resets template, language and menu xml cache

Returns:

null

Definition at line 518 of file oxmodule.php.

oxModule.activate

(

)

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

Returns:

bool

Definition at line 379 of file oxmodule.php.

oxModule.buildModuleChains

(

$

aModuleArray

)

Build module chains from nested array

Parameters:

array

$aModuleArray Module array (nested format)

Returns:

array

Definition at line 540 of file oxmodule.php.

oxModule.deactivate

(

$

sModuleId = null

)

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

Parameters:

string

$sModuleId Module Id

Returns:

bool

Definition at line 444 of file oxmodule.php.

oxModule.filterModuleArray	(	$	aModules,
		$	sModuleId
	)

Filter module array using module id

Parameters:

	array	$aModules Module array (nested format)
	string	$sModuleId Module id/folder name

Returns:

array

Definition at line 590 of file oxmodule.php.

oxModule.getAllModules

(

)

Get parsed modules

Returns:

array

Definition at line 648 of file oxmodule.php.

oxModule.getDescription

(

)

Get module description

Returns:

string

Definition at line 186 of file oxmodule.php.

oxModule.getDisabledModules

(

)

Get disabled module id's

Returns:

array

Definition at line 668 of file oxmodule.php.

oxModule.getId

(

)

Get module ID

Returns:

string

Definition at line 210 of file oxmodule.php.

oxModule.getIdByPath

(

$

sModule

)

Get module ID

Parameters:

string

$sModule extension full path

Returns:

string

Definition at line 222 of file oxmodule.php.

oxModule.getInfo	(	$	sName,
		$	iLang = null
	)

Get module info item. If second param is passed, will try to get value according selected language.

Parameters:

	string	$sName name of info item to retrieve
	string	$iLang language ID

Returns:

mixed

Definition at line 252 of file oxmodule.php.

oxModule.getLegacyModules

(

)

Get legacy modules list

Returns:

array

Definition at line 658 of file oxmodule.php.

oxModule.getModuleEvents

(

)

Get module events

Returns:

array

Definition at line 718 of file oxmodule.php.

oxModule.getModuleFiles

(

)

Get module files

Returns:

array

Definition at line 698 of file oxmodule.php.

oxModule.getModuleFullPath

(

$

sModuleId

)

Returns full module path

Parameters:

string

$sModuleId

Returns:

string

Definition at line 635 of file oxmodule.php.

oxModule.getModulePath

(

$

sModuleId = null

)

Get module dir

Parameters:

string

$sModuleId Module ID

Returns:

string

Definition at line 610 of file oxmodule.php.

oxModule.getModulePaths

(

)

Get module id's with path

Returns:

array

Definition at line 678 of file oxmodule.php.

oxModule.getModuleTemplates

(

)

Get module template files

Returns:

array

Definition at line 688 of file oxmodule.php.

oxModule.getModuleVersions

(

)

Get module versions

Returns:

array

Definition at line 708 of file oxmodule.php.

oxModule.getTemplates

(

$

sModuleId = null

)

Return templates affected by template blocks for given module id.

Parameters:

string

$sModuleId Module id

Returns:

array

Definition at line 926 of file oxmodule.php.

oxModule.getTitle

(

)

Get module title

Returns:

string

Definition at line 198 of file oxmodule.php.

oxModule.hasMetadata

(

)

Checks if module has metadata

Returns:

bool

Definition at line 359 of file oxmodule.php.

oxModule.isActive

(

)

Check if extension is active

Returns:

bool

Definition at line 285 of file oxmodule.php.

oxModule.isExtended

(

)

Check if extension das any extended classes

Returns:

bool

Definition at line 325 of file oxmodule.php.

oxModule.isFile

(

)

Checks if module is single file

Returns:

bool

Definition at line 369 of file oxmodule.php.

oxModule.isLegacy

(

)

Checks if module is defined as legacy module

Returns:

bool

Definition at line 339 of file oxmodule.php.

oxModule.isRegistered

(

)

Checks if module is registered in any way

Returns:

bool

Definition at line 349 of file oxmodule.php.

oxModule.load

(

$

sModuleId

)

Load module info

Parameters:

string

$sModuleId Module ID

Returns:

bool

Definition at line 63 of file oxmodule.php.

oxModule.loadByDir

(

$

sModuleDir

)

Load module by dir name

Parameters:

string

$sModuleDir Module dir name

Returns:

bool

Definition at line 81 of file oxmodule.php.

oxModule.loadLegacyModule

(

$

sModuleId

)

Load Extension from legacy metadata

Parameters:

string

$sModuleId Module ID

Returns:

bool

Definition at line 131 of file oxmodule.php.

oxModule.loadModule

(

$

sModuleId

)

Load Extension from metadata

Parameters:

string

$sModuleId Module ID

Returns:

bool

Definition at line 105 of file oxmodule.php.

oxModule.loadUnregisteredModule

(

$

sModuleId

)

Load extension without any metadata

Parameters:

string

$sModuleId Module ID

Returns:

bool

Definition at line 156 of file oxmodule.php.

oxModule.mergeModuleArrays	(	$	aAllModuleArray,
		$	aAddModuleArray
	)

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

Definition at line 560 of file oxmodule.php.

oxModule.saveLegacyModule	(	$	sModuleId,
		$	sModuleName,
		$	aModuleInfo = null
	)

Enables modules, that don't have metadata file activation/deactivation. Writes to "aLegacyModules" config variable classes, that current module extends.

Parameters:

	string	$sModuleId Module id
	string	$sModuleName Module name
	string	$aModuleInfo Extended classes

Returns:

string module id

Definition at line 954 of file oxmodule.php.

oxModule.setModuleData

(

$

aModule

)

Set passed module data

Parameters:

array

$aModule module data

Returns:

null

Definition at line 51 of file oxmodule.php.

oxModule.updateModuleIds	(	$	sModuleLegacyId,
		$	sModuleId
	)

Update module ID in modules config variables aModulePaths and aDisabledModules.

Parameters:

	string	$sModuleLegacyId Old module ID
	string	$sModuleId New module ID

Returns:

null

Definition at line 987 of file oxmodule.php.

---

Member Data Documentation

oxModule.$_aModule = array() [protected]

Definition at line 14 of file oxmodule.php.

oxModule.$_blFile = false [protected]

Definition at line 35 of file oxmodule.php.

oxModule.$_blLegacy = false [protected]

Definition at line 42 of file oxmodule.php.

oxModule.$_blMetadata = false [protected]

Definition at line 21 of file oxmodule.php.

oxModule.$_blRegistered = false [protected]

Definition at line 28 of file oxmodule.php.

---

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

• core/oxmodule.php