OXID eShop CE  4.10.4
 All Classes Namespaces Files Functions Variables Pages
oxModuleList Class Reference
+ Inheritance diagram for oxModuleList:
+ Collaboration diagram for oxModuleList:

Public Member Functions

 getList ()
 getModulesWithExtendedClass ()
 getActiveModuleInfo ()
 getDisabledModuleInfo ()
 getModuleVersions ()
 getModules ()
 getDisabledModules ()
 getModulePaths ()
 getModuleEvents ()
 extractModulePaths ()
 getModuleFiles ()
 getModuleTemplates ()
 getDisabledModuleClasses ()
 cleanup ()
 getDeletedExtensions ()
 diffModuleArrays ($aAllModuleArray, $aRemModuleArray)
 buildModuleChains ($aModuleArray)
 getModule ()
 getModulesFromDir ($sModulesDir, $sVendorDir=null)
 getModuleValidatorFactory ()
 getModuleIds ()
 getModuleExtensions ($sModuleId)
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Member Functions

 _removeExtensions ($aModuleIds)
 _removeFromDisabledModulesArray ($aDeletedExtIds)
 _removeFromModulesPathsArray ($aDeletedModule)
 _removeFromModulesVersionsArray ($aDeletedModule)
 _removeFromModulesEventsArray ($aDeletedModule)
 _removeFromModulesFilesArray ($aDeletedModule)
 _removeFromModulesTemplatesArray ($aDeletedModule)
 _removeFromDatabase ($aDeletedExtIds)
 _sortModules ($oModule1, $oModule2)
 _isVendorDir ($sModuleDir)
 _extendsClasses ($sModuleDir)
 _saveModulePath ($sModuleId, $sModulePath)

Protected Attributes

 $_aModules = array()
 $_aModuleExtensions = null
 $_aSkipFiles = array('functions.php', 'vendormetadata.php')

Private Member Functions

 _getModuleIdsFromExtensions ($aData)
 _getInvalidExtensions ($sModuleId)

Additional Inherited Members

- Static Protected Attributes inherited from oxSuperCfg
static $_oConfig = null
static $_oSession = null
static $_oRights = null
static $_oActUser = null
static $_blIsAdmin = null

Detailed Description

Modules list class.

Definition at line 9 of file oxmodulelist.php.

Member Function Documentation

oxModuleList::_extendsClasses (   $sModuleDir)
protected

Checks if module extends any shop class.

Parameters
string$sModuleDirdir path
Returns
bool

Definition at line 662 of file oxmodulelist.php.

oxModuleList::_getInvalidExtensions (   $sModuleId)
private

Returns invalid extensions array by module id.

Parameters
string$sModuleIdModule id
Returns
array

Definition at line 718 of file oxmodulelist.php.

oxModuleList::_getModuleIdsFromExtensions (   $aData)
private

Returns module ids which have extensions.

Parameters
array$aDataData
Returns
array

Definition at line 697 of file oxmodulelist.php.

oxModuleList::_isVendorDir (   $sModuleDir)
protected

Checks if directory is vendor directory.

Parameters
string$sModuleDirdir path
Returns
bool

Definition at line 646 of file oxmodulelist.php.

oxModuleList::_removeExtensions (   $aModuleIds)
protected

Removes extension by given modules ids.

Parameters
array$aModuleIdsModules ids which must be deleted from config.

Definition at line 364 of file oxmodulelist.php.

oxModuleList::_removeFromDatabase (   $aDeletedExtIds)
protected

Removes extension from database - oxConfig, oxConfigDisplay and oxTplBlocks tables

Parameters
array$aDeletedExtIdsdeleted extensions ID's
Returns
null

Definition at line 488 of file oxmodulelist.php.

oxModuleList::_removeFromDisabledModulesArray (   $aDeletedExtIds)
protected

Removes extension from disabled modules array

Parameters
array$aDeletedExtIdsDeleted extension id's of array

Definition at line 383 of file oxmodulelist.php.

oxModuleList::_removeFromModulesEventsArray (   $aDeletedModule)
protected

Removes extension from modules events array

Parameters
array$aDeletedModuledeleted extensions ID's

Definition at line 432 of file oxmodulelist.php.

oxModuleList::_removeFromModulesFilesArray (   $aDeletedModule)
protected

Removes extension from modules files array

Parameters
array$aDeletedModuledeleted extensions ID's

Definition at line 450 of file oxmodulelist.php.

oxModuleList::_removeFromModulesPathsArray (   $aDeletedModule)
protected

Removes extension from modules paths array

Parameters
array$aDeletedModuledeleted extensions ID's

Definition at line 396 of file oxmodulelist.php.

oxModuleList::_removeFromModulesTemplatesArray (   $aDeletedModule)
protected

Removes extension from modules templates array

Parameters
array$aDeletedModuledeleted extensions ID's

Definition at line 468 of file oxmodulelist.php.

oxModuleList::_removeFromModulesVersionsArray (   $aDeletedModule)
protected

Removes extension from modules versions array

Parameters
array$aDeletedModuledeleted extensions ID's

Definition at line 414 of file oxmodulelist.php.

oxModuleList::_saveModulePath (   $sModuleId,
  $sModulePath 
)
protected

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

Parameters
string$sModuleIdModule ID
string$sModulePathModule path

Definition at line 682 of file oxmodulelist.php.

oxModuleList::_sortModules (   $oModule1,
  $oModule2 
)
protected

Callback function for sorting module objects by name.

Parameters
object$oModule1module object
object$oModule2module object
Returns
bool

Definition at line 634 of file oxmodulelist.php.

oxModuleList::buildModuleChains (   $aModuleArray)

Build module chains from nested array

Parameters
array$aModuleArrayModule array (nested format)
Returns
array

Definition at line 337 of file oxmodulelist.php.

oxModuleList::cleanup ( )

Removes extension metadata from shop.

Definition at line 232 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$aAllModuleArrayAll Module array (nested format)
array$aRemModuleArrayRemove Module array (nested format)
Returns
array

Definition at line 301 of file oxmodulelist.php.

oxModuleList::extractModulePaths ( )

Extract module id's with paths from extended classes.

Returns
array

Definition at line 157 of file oxmodulelist.php.

oxModuleList::getActiveModuleInfo ( )

Get active modules path info

Returns
array

Definition at line 59 of file oxmodulelist.php.

oxModuleList::getDeletedExtensions ( )

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

Returns
array

Definition at line 269 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 202 of file oxmodulelist.php.

oxModuleList::getDisabledModuleInfo ( )

Get disabled module paths

Returns
array

Definition at line 81 of file oxmodulelist.php.

oxModuleList::getDisabledModules ( )

Get disabled module id's

Returns
array

Definition at line 127 of file oxmodulelist.php.

oxModuleList::getList ( )

Return array of modules

Returns
array

Definition at line 39 of file oxmodulelist.php.

oxModuleList::getModule ( )

Returns oxModule object.

Returns
oxModule

Definition at line 354 of file oxmodulelist.php.

oxModuleList::getModuleEvents ( )

Get module events

Returns
array

Definition at line 147 of file oxmodulelist.php.

oxModuleList::getModuleExtensions (   $sModuleId)

Returns module extensions.

Parameters
string$sModuleId
Returns
array

Definition at line 607 of file oxmodulelist.php.

oxModuleList::getModuleFiles ( )

Get all modules files paths

Returns
array

Definition at line 179 of file oxmodulelist.php.

oxModuleList::getModuleIds ( )

Returns module ids which have extensions or files.

Returns
array

Definition at line 592 of file oxmodulelist.php.

oxModuleList::getModulePaths ( )

Get module id's with path

Returns
array

Definition at line 137 of file oxmodulelist.php.

oxModuleList::getModules ( )

Get the list of modules

Returns
array

Definition at line 117 of file oxmodulelist.php.

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

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

Parameters
string$sModulesDirMain module dir path
string$sVendorDirVendor directory name
Returns
array

Definition at line 523 of file oxmodulelist.php.

oxModuleList::getModulesWithExtendedClass ( )

Get parsed modules

Returns
array

Definition at line 49 of file oxmodulelist.php.

oxModuleList::getModuleTemplates ( )

Get all modules templates paths

Returns
array

Definition at line 189 of file oxmodulelist.php.

oxModuleList::getModuleValidatorFactory ( )

Gets module validator factory.

Returns
oxModuleValidatorFactory

Definition at line 582 of file oxmodulelist.php.

oxModuleList::getModuleVersions ( )

Get module id's with versions

Returns
array

Definition at line 107 of file oxmodulelist.php.

Member Data Documentation

oxModuleList::$_aModuleExtensions = null
protected

Definition at line 25 of file oxmodulelist.php.

oxModuleList::$_aModules = array()
protected

Definition at line 18 of file oxmodulelist.php.

oxModuleList::$_aSkipFiles = array('functions.php', 'vendormetadata.php')
protected

Definition at line 32 of file oxmodulelist.php.


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