oxModuleList Class Reference

Inheritance diagram for oxModuleList:

Collaboration diagram for oxModuleList:

List of all members.

Public Member Functions
	getAllModules ()
	getActiveModuleInfo ()
	getLegacyModules ()
	getDisabledModules ()
	getModulePaths ()
	getModuleFiles ()
	getModuleTemplates ()
	getDisabledModuleClasses ()
	cleanup ()
	getDeletedExtensionIds ($aDeletedExt)
	getDeletedExtensions ()
	diffModuleArrays ($aAllModuleArray, $aRemModuleArray)
	buildModuleChains ($aModuleArray)
	getModulesFromDir ($sModulesDir, $sVendorDir=null)
Protected Member Functions
	_removeFromModulesArray ($aDeletedExt)
	_removeFromDisabledModulesArray ($aDeletedExtIds)
	_removeFromLegacyModulesArray ($aDeletedExtIds)
	_removeFromModulesPathsArray ($aDeletedModule)
	_removeFromModulesFilesArray ($aDeletedModule)
	_removeFromModulesTemplatesArray ($aDeletedModule)
	_removeFromDatabase ($aDeletedExtIds)
	_sortModules ($oModule1, $oModule2)
	_isVendorDir ($sModuleDir)
	_extendsClasses ($sModuleDir)
	_saveModulePath ($sModuleId, $sModulePath)
Protected Attributes
	$_aModule = array()
	$_aSkipFiles = array( "functions.php", "vendormetadata.php" )

---

Detailed Description

Class handling shop modules.

Definition at line 7 of file oxmodulelist.php.

---

Member Function Documentation

oxModuleList._extendsClasses

(

$

sModuleDir

)

[protected]

Checks if module extends any shop class.

Parameters:

string

$sModuleDir dir path

Returns:

bool

Definition at line 521 of file oxmodulelist.php.

oxModuleList._isVendorDir

(

$

sModuleDir

)

[protected]

Checks if directory is vedor directory.

Parameters:

string

$sModuleDir dir path

Returns:

bool

Definition at line 505 of file oxmodulelist.php.

oxModuleList._removeFromDatabase

(

$

aDeletedExtIds

)

[protected]

Removes extension from database - oxconfig, oxconfigdisplay and oxtplblocks tables

Parameters:

array

$aDeletedExtIds deleted extensions ID's

Returns:

null

Definition at line 404 of file oxmodulelist.php.

oxModuleList._removeFromDisabledModulesArray

(

$

aDeletedExtIds

)

[protected]

Removes extension from disabled modules array

Parameters:

array

$aDeletedExtIds Id's of deleated extendion array

Returns:

null

Definition at line 309 of file oxmodulelist.php.

oxModuleList._removeFromLegacyModulesArray

(

$

aDeletedExtIds

)

[protected]

Removes extension from legacy modules array

Parameters:

array

$aDeletedExtIds deleted extensions ID's

Returns:

null

Definition at line 324 of file oxmodulelist.php.

oxModuleList._removeFromModulesArray

(

$

aDeletedExt

)

[protected]

Removes extension from modules array

Parameters:

array

$aDeletedExt Deleated extendion array

Returns:

null

Definition at line 293 of file oxmodulelist.php.

oxModuleList._removeFromModulesFilesArray

(

$

aDeletedModule

)

[protected]

Removes extension from modules files array

Parameters:

array

$aDeletedModule deleted extensions ID's

Returns:

null

Definition at line 364 of file oxmodulelist.php.

oxModuleList._removeFromModulesPathsArray

(

$

aDeletedModule

)

[protected]

Removes extension from modules paths array

Parameters:

array

$aDeletedModule deleted extensions ID's

Returns:

null

Definition at line 344 of file oxmodulelist.php.

oxModuleList._removeFromModulesTemplatesArray

(

$

aDeletedModule

)

[protected]

Removes extension from legacy modules templates array

Parameters:

array

$aDeletedModule deleted extensions ID's

Returns:

null

Definition at line 384 of file oxmodulelist.php.

oxModuleList._saveModulePath	(	$	sModuleId,
		$	sModulePath
	)			[protected]

Saving module path info. Module path is saved to config variable "aModulePaths".

Parameters:

	string	$sModuleId Module ID
	string	$sModulePath Module path

Returns:

null

Definition at line 543 of file oxmodulelist.php.

oxModuleList._sortModules	(	$	oModule1,
		$	oModule2
	)			[protected]

Callback function for sorting module objects by name.

Parameters:

	object	$oModule1 module object
	object	$oModule2 module object

Returns:

bool

Definition at line 493 of file oxmodulelist.php.

oxModuleList.buildModuleChains

(

$

aModuleArray

)

Build module chains from nested array

Parameters:

array

$aModuleArray Module array (nested format)

Returns:

array

Definition at line 275 of file oxmodulelist.php.

oxModuleList.cleanup

(

)

Removes extension metadata from eshop

Returns:

null

Definition at line 152 of file oxmodulelist.php.

oxModuleList.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

Definition at line 238 of file oxmodulelist.php.

oxModuleList.getActiveModuleInfo

(

)

Get parsed active modules info

Returns:

array

Definition at line 39 of file oxmodulelist.php.

oxModuleList.getAllModules

(

)

Get parsed modules

Returns:

array

Definition at line 29 of file oxmodulelist.php.

oxModuleList.getDeletedExtensionIds

(

$

aDeletedExt

)

Returns deleted extension Ids

Parameters:

array

$aDeletedExt deleted extensions

Returns:

array

Definition at line 188 of file oxmodulelist.php.

oxModuleList.getDeletedExtensions

(

)

Checks moduels list - if there is extensions that are registered, but extension directory is missing

Returns:

array

Definition at line 213 of file oxmodulelist.php.

oxModuleList.getDisabledModuleClasses

(

)

Returns disabled module classes with path using config aModules and aModulePaths. aModules has all extended classes aModulePaths has module id to main path array

Returns:

array

Definition at line 120 of file oxmodulelist.php.

oxModuleList.getDisabledModules

(

)

Get disabled module id's

Returns:

array

Definition at line 77 of file oxmodulelist.php.

oxModuleList.getLegacyModules

(

)

Get legacy modules list

Returns:

array

Definition at line 67 of file oxmodulelist.php.

oxModuleList.getModuleFiles

(

)

Get all modules files paths

Returns:

array

Definition at line 97 of file oxmodulelist.php.

oxModuleList.getModulePaths

(

)

Get module id's with path

Returns:

array

Definition at line 87 of file oxmodulelist.php.

oxModuleList.getModulesFromDir	(	$	sModulesDir,
		$	sVendorDir = null
	)

Scans modules dir and returns colected modules list. Recursively loads also modules that are in vendor directory.

Parameters:

	string	$sModulesDir Main module dir path
	string	$sVendorDir Vendor directory name

Returns:

array

Definition at line 438 of file oxmodulelist.php.

oxModuleList.getModuleTemplates

(

)

Get all modules templates paths

Returns:

array

Definition at line 107 of file oxmodulelist.php.

---

Member Data Documentation

oxModuleList.$_aModule = array() [protected]

Definition at line 14 of file oxmodulelist.php.

oxModuleList.$_aSkipFiles = array( "functions.php", "vendormetadata.php" ) [protected]

Definition at line 21 of file oxmodulelist.php.

---

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

• core/oxmodulelist.php