OXID eShop CE  6.1.5
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
OxidEsales\EshopCommunity\Core\Module\ModuleList Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Core\Module\ModuleList:
+ Collaboration diagram for OxidEsales\EshopCommunity\Core\Module\ModuleList:

Public Member Functions

 getList ()
 
 getModulesWithExtendedClass ()
 
 getActiveModuleInfo ()
 
 getDisabledModuleInfo ()
 
 getModuleVersions ()
 
 getModules ()
 
 getDisabledModules ()
 
 getModulePaths ()
 
 getModuleEvents ()
 
 extractModulePaths ()
 
 getModuleFiles ()
 
 getModuleTemplates ()
 
 getDisabledModuleClasses ()
 
 cleanup ()
 
 getDeletedExtensions ()
 
 diffModuleArrays ($aAllModuleArray, $aRemModuleArray)
 
 buildModuleChains ($aModuleArray)
 
 getModule ()
 
 parseModuleChains ($modules)
 
 getModuleConfigParametersByKey ($key)
 
 getModulesFromDir ($sModulesDir, $sVendorDir=null)
 
 getModuleValidatorFactory ()
 
 getModuleIds ()
 
 getModuleExtensions ($sModuleId)
 

Public Attributes

const MODULE_KEY_PATHS = 'Paths'
 
const MODULE_KEY_EVENTS = 'Events'
 
const MODULE_KEY_VERSIONS = 'Versions'
 
const MODULE_KEY_FILES = 'Files'
 
const MODULE_KEY_TEMPLATES = 'Templates'
 
const MODULE_KEY_EXTENSIONS = 'Extensions'
 
const MODULE_KEY_CONTROLLERS = 'Controllers'
 

Protected Member Functions

 _removeExtensions ($aModuleIds)
 
 _removeFromDisabledModulesArray ($aDeletedExtIds)
 
 removeFromModulesArray ($key, $aDeletedModule)
 
 _removeFromDatabase ($aDeletedExtIds)
 
 _sortModules ($oModule1, $oModule2)
 
 _isVendorDir ($sModuleDir)
 
 _extendsClasses ($sModuleDir)
 
 _saveModulePath ($sModuleId, $sModulePath)
 

Protected Attributes

 $_aModules = []
 
 $_aModuleExtensions = null
 
 $_aSkipFiles = ['functions.php', 'vendormetadata.php']
 

Private Member Functions

 _getModuleIdsFromExtensions ($aData)
 
 _getInvalidExtensions ($moduleId)
 
 backwardsCompatibleGetInvalidExtensions ($moduleClass, &$invalidModuleClasses, $extendedShopClass)
 

Detailed Description

Modules list class.

Member Function Documentation

◆ _extendsClasses()

OxidEsales\EshopCommunity\Core\Module\ModuleList::_extendsClasses (   $sModuleDir)
protected

Checks if module extends any shop class.

Parameters
string$sModuleDirdir path
Returns
bool

◆ _getInvalidExtensions()

OxidEsales\EshopCommunity\Core\Module\ModuleList::_getInvalidExtensions (   $moduleId)
private

Returns shop classes and associated invalid module classes for a given module id

Parameters
string$moduleIdModule id
Returns
array

◆ _getModuleIdsFromExtensions()

OxidEsales\EshopCommunity\Core\Module\ModuleList::_getModuleIdsFromExtensions (   $aData)
private

Returns module ids which have extensions.

Parameters
array$aDataData
Returns
array

◆ _isVendorDir()

OxidEsales\EshopCommunity\Core\Module\ModuleList::_isVendorDir (   $sModuleDir)
protected

Checks if directory is vendor directory.

Parameters
string$sModuleDirdir path
Returns
bool

◆ _removeExtensions()

OxidEsales\EshopCommunity\Core\Module\ModuleList::_removeExtensions (   $aModuleIds)
protected

Removes extension by given modules ids.

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

◆ _removeFromDatabase()

OxidEsales\EshopCommunity\Core\Module\ModuleList::_removeFromDatabase (   $aDeletedExtIds)
protected

Removes extension from database - oxConfig, oxConfigDisplay and oxTplBlocks tables

Parameters
array$aDeletedExtIdsdeleted extensions ID's
Returns
null

◆ _removeFromDisabledModulesArray()

OxidEsales\EshopCommunity\Core\Module\ModuleList::_removeFromDisabledModulesArray (   $aDeletedExtIds)
protected

Removes extension from disabled modules array

Parameters
array$aDeletedExtIdsDeleted extension id's of array

◆ _saveModulePath()

OxidEsales\EshopCommunity\Core\Module\ModuleList::_saveModulePath (   $sModuleId,
  $sModulePath 
)
protected

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

Parameters
string$sModuleIdModule ID
string$sModulePathModule path

◆ _sortModules()

OxidEsales\EshopCommunity\Core\Module\ModuleList::_sortModules (   $oModule1,
  $oModule2 
)
protected

Callback function for sorting module objects by name.

Parameters
object$oModule1module object
object$oModule2module object
Returns
bool

◆ backwardsCompatibleGetInvalidExtensions()

OxidEsales\EshopCommunity\Core\Module\ModuleList::backwardsCompatibleGetInvalidExtensions (   $moduleClass,
&  $invalidModuleClasses,
  $extendedShopClass 
)
private

Backwards compatible version of self::_getInvalidExtensions()

Parameters
string$moduleClassThe module class, which extends a given shop class
array$invalidModuleClassesThe Collection of module classes , which are marked as deleted Note: This parameter is passed by reference
string$extendedShopClassThe shop class, which is extended by the module class
Deprecated:
since v6.0 (2017-03-14); This method will be removed in the future.

◆ buildModuleChains()

OxidEsales\EshopCommunity\Core\Module\ModuleList::buildModuleChains (   $aModuleArray)

Build module chains from nested array

Parameters
array$aModuleArrayModule array (nested format)
Returns
array

◆ cleanup()

OxidEsales\EshopCommunity\Core\Module\ModuleList::cleanup ( )

Removes extension metadata from shop.

◆ diffModuleArrays()

OxidEsales\EshopCommunity\Core\Module\ModuleList::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

◆ extractModulePaths()

OxidEsales\EshopCommunity\Core\Module\ModuleList::extractModulePaths ( )

Extract module id's with paths from extended classes.

Returns
array

◆ getActiveModuleInfo()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getActiveModuleInfo ( )

Get active modules path info

Returns
array

◆ getDeletedExtensions()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getDeletedExtensions ( )

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

Returns
array

◆ getDisabledModuleClasses()

OxidEsales\EshopCommunity\Core\Module\ModuleList::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

◆ getDisabledModuleInfo()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getDisabledModuleInfo ( )

Get disabled module paths

Returns
array

◆ getDisabledModules()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getDisabledModules ( )

Get disabled module id's

Returns
array

◆ getList()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getList ( )

Return array of modules

Returns
array

◆ getModule()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModule ( )

Returns oxModule object.

Returns
oxModule

◆ getModuleConfigParametersByKey()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleConfigParametersByKey (   $key)

Gets Module config parameters by key

e.g. to get 'aModulePaths' call $obj->getModuleConfigParametersByKey(ModuleList::MODULE_KEY_PATHS)

Parameters
string$keyKey
Returns
array module config parameters for given key

◆ getModuleEvents()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleEvents ( )

Get module events

Returns
array
Deprecated:
since v6.0.0 (2016-09-15); Use getModuleConfigParametersByKey(ModuleList::MODULE_KEY_EVENTS) instead.

◆ getModuleExtensions()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleExtensions (   $sModuleId)

Returns module extensions.

Parameters
string$sModuleId
Returns
array

◆ getModuleFiles()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleFiles ( )

Get all modules files paths

Returns
array
Deprecated:
since v6.0.0 (2016-09-15); Use getModuleConfigParametersByKey(ModuleList::MODULE_KEY_FILES) instead.

◆ getModuleIds()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleIds ( )

Returns module ids which have extensions or files.

Returns
array

◆ getModulePaths()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModulePaths ( )

Get module id's with path

Returns
array
Deprecated:
since v6.0.0 (2016-09-15); Use getModuleConfigParametersByKey(ModuleList::MODULE_KEY_PATHS) instead.

◆ getModules()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModules ( )

Get the list of modules

Returns
array

◆ getModulesFromDir()

OxidEsales\EshopCommunity\Core\Module\ModuleList::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

◆ getModulesWithExtendedClass()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModulesWithExtendedClass ( )

Get parsed modules

Returns
array

◆ getModuleTemplates()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleTemplates ( )

Get all modules templates paths

Returns
array
Deprecated:
since v6.0.0 (2016-09-15); Use getModuleConfigParametersByKey(ModuleList::MODULE_KEY_TEMPLATES) instead.

◆ getModuleValidatorFactory()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleValidatorFactory ( )

Gets module validator factory.

Returns
oxModuleValidatorFactory

◆ getModuleVersions()

OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleVersions ( )

Get module id's with versions

Returns
array
Deprecated:
since v6.0.0 (2016-09-15); Use getModuleConfigParametersByKey(ModuleList::MODULE_KEY_VERSIONS) instead.

◆ parseModuleChains()

OxidEsales\EshopCommunity\Core\Module\ModuleList::parseModuleChains (   $modules)

Parse array of module chains to nested array

Parameters
array$modulesModule array (config format)
Returns
array

◆ removeFromModulesArray()

OxidEsales\EshopCommunity\Core\Module\ModuleList::removeFromModulesArray (   $key,
  $aDeletedModule 
)
protected

Removes extension from given modules array.

Parameters
string$keyModule array key.
array$aDeletedModuleDeleted extensions ID's.

Member Data Documentation

◆ $_aModuleExtensions

OxidEsales\EshopCommunity\Core\Module\ModuleList::$_aModuleExtensions = null
protected

◆ $_aModules

OxidEsales\EshopCommunity\Core\Module\ModuleList::$_aModules = []
protected

◆ $_aSkipFiles

OxidEsales\EshopCommunity\Core\Module\ModuleList::$_aSkipFiles = ['functions.php', 'vendormetadata.php']
protected

◆ MODULE_KEY_CONTROLLERS

const OxidEsales\EshopCommunity\Core\Module\ModuleList::MODULE_KEY_CONTROLLERS = 'Controllers'

◆ MODULE_KEY_EVENTS

const OxidEsales\EshopCommunity\Core\Module\ModuleList::MODULE_KEY_EVENTS = 'Events'

◆ MODULE_KEY_EXTENSIONS

const OxidEsales\EshopCommunity\Core\Module\ModuleList::MODULE_KEY_EXTENSIONS = 'Extensions'

◆ MODULE_KEY_FILES

const OxidEsales\EshopCommunity\Core\Module\ModuleList::MODULE_KEY_FILES = 'Files'

◆ MODULE_KEY_PATHS

const OxidEsales\EshopCommunity\Core\Module\ModuleList::MODULE_KEY_PATHS = 'Paths'

◆ MODULE_KEY_TEMPLATES

const OxidEsales\EshopCommunity\Core\Module\ModuleList::MODULE_KEY_TEMPLATES = 'Templates'

◆ MODULE_KEY_VERSIONS

const OxidEsales\EshopCommunity\Core\Module\ModuleList::MODULE_KEY_VERSIONS = 'Versions'
The documentation for this class was generated from the following file: