Modules list class.
- Deprecated:
- since v6.4.0 (2019-03-22); Use service 'OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\Bridge\ShopConfigurationDaoBridgeInterface'.
◆ _getInvalidExtensions()
OxidEsales\EshopCommunity\Core\Module\ModuleList::_getInvalidExtensions |
( |
|
$moduleId | ) |
|
|
private |
Returns shop classes and associated invalid module classes for a given module id
- Parameters
-
- Returns
- array
◆ _isVendorDir()
OxidEsales\EshopCommunity\Core\Module\ModuleList::_isVendorDir |
( |
|
$sModuleDir | ) |
|
|
protected |
Checks if directory is vendor directory.
- Parameters
-
string | $sModuleDir | dir path |
- Returns
- bool
- Deprecated:
- underscore prefix violates PSR12, will be renamed to "isVendorDir" in next major
◆ _sortModules()
OxidEsales\EshopCommunity\Core\Module\ModuleList::_sortModules |
( |
|
$oModule1, |
|
|
|
$oModule2 |
|
) |
| |
|
protected |
Callback function for sorting module objects by name.
- Parameters
-
object | $oModule1 | module object |
object | $oModule2 | module object |
- Returns
- bool
- Deprecated:
- underscore prefix violates PSR12, will be renamed to "sortModules" in next major
◆ backwardsCompatibleGetInvalidExtensions()
OxidEsales\EshopCommunity\Core\Module\ModuleList::backwardsCompatibleGetInvalidExtensions |
( |
|
$moduleClass, |
|
|
& |
$invalidModuleClasses, |
|
|
|
$extendedShopClass |
|
) |
| |
|
private |
Backwards compatible version of self::_getInvalidExtensions()
- Parameters
-
string | $moduleClass | The module class, which extends a given shop class |
array | $invalidModuleClasses | The Collection of module classes , which are marked as deleted Note: This parameter is passed by reference |
string | $extendedShopClass | The shop class, which is extended by the module class |
◆ buildModuleChains()
OxidEsales\EshopCommunity\Core\Module\ModuleList::buildModuleChains |
( |
|
$aModuleArray | ) |
|
Build module chains from nested array
- Parameters
-
array | $aModuleArray | Module 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 | $aAllModuleArray | All Module array (nested format) |
array | $aRemModuleArray | Remove Module array (nested format) |
- Returns
- array
◆ extractModulePaths()
OxidEsales\EshopCommunity\Core\Module\ModuleList::extractModulePaths |
( |
| ) |
|
Extract module id's with paths from extended classes.
- Returns
- array
◆ getActivateModulesWithExtendedClass()
OxidEsales\EshopCommunity\Core\Module\ModuleList::getActivateModulesWithExtendedClass |
( |
| ) |
|
|
private |
Get activate modules with Extended classes
- Returns
- array
◆ getActiveModuleConfigurations()
OxidEsales\EshopCommunity\Core\Module\ModuleList::getActiveModuleConfigurations |
( |
| ) |
|
|
private |
Returns Active module ids which have extensions or files.
- Returns
- ModuleConfiguration[]
◆ 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
◆ getDisabledModuleConfigurations()
OxidEsales\EshopCommunity\Core\Module\ModuleList::getDisabledModuleConfigurations |
( |
| ) |
|
|
private |
- Returns
- ModuleConfiguration[]
◆ 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
-
- Returns
- array module config parameters for given key
◆ getModuleEvents()
OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleEvents |
( |
| ) |
|
Get module events
- Returns
- array
◆ getModuleExtensions()
OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleExtensions |
( |
|
$sModuleId | ) |
|
Returns module extensions.
- Parameters
-
- Returns
- array
◆ getModuleFiles()
OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleFiles |
( |
| ) |
|
Get all modules files paths
- Returns
- array
◆ 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
◆ 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 | $sModulesDir | Main module dir path |
string | $sVendorDir | Vendor directory name |
- Returns
- array
◆ getModulesWithExtendedClass()
OxidEsales\EshopCommunity\Core\Module\ModuleList::getModulesWithExtendedClass |
( |
| ) |
|
Get all modules with Extended classes
- Returns
- array
◆ getModuleTemplates()
OxidEsales\EshopCommunity\Core\Module\ModuleList::getModuleTemplates |
( |
| ) |
|
Get all modules templates paths
- Returns
- array
◆ 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
◆ parseModuleChains()
OxidEsales\EshopCommunity\Core\Module\ModuleList::parseModuleChains |
( |
|
$modules | ) |
|
Parse array of module chains to nested array
- Parameters
-
array | $modules | Module array (config format) |
- Returns
- array
◆ $_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: