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

Public Member Functions

 getMetaDataVersion ()
 
 setMetaDataVersion ($metaDataVersion)
 
 setModuleData ($aModule)
 
 getModuleData ()
 
 load ($moduleId)
 
 loadByDir ($sModuleDir)
 
 getDescription ()
 
 getTitle ()
 
 getId ()
 
 getExtensions ()
 
 getControllers ()
 
 getSmartyPluginDirectories ()
 
 getFiles ()
 
 getIdByPath ($module)
 
 getIdFromExtension ($className)
 
 getModuleIdByClassName ($className)
 
 getInfo ($sName, $iLang=null)
 
 isActive ()
 
 hasExtendClass ()
 
 isRegistered ()
 
 hasMetadata ()
 
 getMetadataPath ()
 
 getModulePath ($sModuleId=null)
 
 getModuleFullPath ($sModuleId=null)
 
 getModulePaths ()
 
 getTemplates ($sModuleId=null)
 

Protected Member Functions

 includeModuleMetaData ($metadataPath)
 

Protected Attributes

 $metaDataVersion
 
 $_aModule = []
 
 $_blMetadata = false
 
 $_blRegistered = false
 

Private Member Functions

 getInstalledModuleConfigurations ()
 
 getShopConfiguration ()
 
 convertModuleConfigurationToArray (ModuleConfiguration $configuration)
 
 convertModuleSettingsToArray (ModuleConfiguration $moduleConfiguration)
 
 convertClassExtensionsToArray (ModuleConfiguration $moduleConfiguration)
 
 convertTemplatesToArray (ModuleConfiguration $moduleConfiguration)
 
 convertSmartyPluginDirectoriesToArray (ModuleConfiguration $moduleConfiguration)
 
 convertControllersToArray (ModuleConfiguration $moduleConfiguration)
 
 convertTemplateBlocksToArray (ModuleConfiguration $moduleConfiguration)
 
 convertEventsToArray (ModuleConfiguration $moduleConfiguration)
 
 convertClassesWithoutNamespaceToArray (ModuleConfiguration $moduleConfiguration)
 
 convertSettingsToArray (ModuleConfiguration $moduleConfiguration)
 

Detailed Description

Module class.

Deprecated:
since v6.4.0 (2019-03-22); Use service 'OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\Bridge\ShopConfigurationDaoBridgeInterface'.

Member Function Documentation

◆ convertClassesWithoutNamespaceToArray()

OxidEsales\EshopCommunity\Core\Module\Module::convertClassesWithoutNamespaceToArray ( ModuleConfiguration  $moduleConfiguration)
private
Parameters
ModuleConfiguration$moduleConfiguration
Returns
array

◆ convertClassExtensionsToArray()

OxidEsales\EshopCommunity\Core\Module\Module::convertClassExtensionsToArray ( ModuleConfiguration  $moduleConfiguration)
private
Parameters
ModuleConfiguration$moduleConfiguration
Returns
array

◆ convertControllersToArray()

OxidEsales\EshopCommunity\Core\Module\Module::convertControllersToArray ( ModuleConfiguration  $moduleConfiguration)
private
Parameters
ModuleConfiguration$moduleConfiguration
Returns
array

◆ convertEventsToArray()

OxidEsales\EshopCommunity\Core\Module\Module::convertEventsToArray ( ModuleConfiguration  $moduleConfiguration)
private
Parameters
ModuleConfiguration$moduleConfiguration
Returns
array

◆ convertModuleConfigurationToArray()

OxidEsales\EshopCommunity\Core\Module\Module::convertModuleConfigurationToArray ( ModuleConfiguration  $configuration)
private

Convert ModuleConfiguration to Array

Parameters
ModuleConfiguration$configuration
Returns
array

◆ convertModuleSettingsToArray()

OxidEsales\EshopCommunity\Core\Module\Module::convertModuleSettingsToArray ( ModuleConfiguration  $moduleConfiguration)
private
Parameters
ModuleConfiguration$moduleConfiguration
Returns
array

◆ convertSettingsToArray()

OxidEsales\EshopCommunity\Core\Module\Module::convertSettingsToArray ( ModuleConfiguration  $moduleConfiguration)
private
Parameters
ModuleConfiguration$moduleConfiguration
Returns
array

◆ convertSmartyPluginDirectoriesToArray()

OxidEsales\EshopCommunity\Core\Module\Module::convertSmartyPluginDirectoriesToArray ( ModuleConfiguration  $moduleConfiguration)
private
Parameters
ModuleConfiguration$moduleConfiguration
Returns
array

◆ convertTemplateBlocksToArray()

OxidEsales\EshopCommunity\Core\Module\Module::convertTemplateBlocksToArray ( ModuleConfiguration  $moduleConfiguration)
private
Parameters
ModuleConfiguration$moduleConfiguration
Returns
array

◆ convertTemplatesToArray()

OxidEsales\EshopCommunity\Core\Module\Module::convertTemplatesToArray ( ModuleConfiguration  $moduleConfiguration)
private
Parameters
ModuleConfiguration$moduleConfiguration
Returns
array

◆ getControllers()

OxidEsales\EshopCommunity\Core\Module\Module::getControllers ( )

Returns associative array of module controller ids and corresponding classes.

Returns
array

◆ getDescription()

OxidEsales\EshopCommunity\Core\Module\Module::getDescription ( )

Get module description

Returns
string

◆ getExtensions()

OxidEsales\EshopCommunity\Core\Module\Module::getExtensions ( )

Returns array of module extensions.

Returns
array

◆ getFiles()

OxidEsales\EshopCommunity\Core\Module\Module::getFiles ( )

Returns array of module PHP files.

Returns
array

◆ getId()

OxidEsales\EshopCommunity\Core\Module\Module::getId ( )

Get module ID

Returns
string

◆ getIdByPath()

OxidEsales\EshopCommunity\Core\Module\Module::getIdByPath (   $module)

Get module ID

Parameters
string$moduleextension full path
Returns
string

◆ getIdFromExtension()

OxidEsales\EshopCommunity\Core\Module\Module::getIdFromExtension (   $className)
Deprecated:
since v6.0.0 (2017-03-21); Use self::getModuleIdByClassName()

Get the module id of given extended class name or namespace.

Parameters
string$className
Returns
string

◆ getInfo()

OxidEsales\EshopCommunity\Core\Module\Module::getInfo (   $sName,
  $iLang = null 
)

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

Parameters
string$sNamename of info item to retrieve
string$iLanglanguage ID
Returns
mixed

◆ getInstalledModuleConfigurations()

OxidEsales\EshopCommunity\Core\Module\Module::getInstalledModuleConfigurations ( )
private
Returns
array

◆ getMetadataPath()

OxidEsales\EshopCommunity\Core\Module\Module::getMetadataPath ( )

Get full path to module metadata file.

Returns
string

◆ getMetaDataVersion()

OxidEsales\EshopCommunity\Core\Module\Module::getMetaDataVersion ( )
Returns
mixed

◆ getModuleData()

OxidEsales\EshopCommunity\Core\Module\Module::getModuleData ( )

Get the modules metadata array

Returns
array Module meta data array

◆ getModuleFullPath()

OxidEsales\EshopCommunity\Core\Module\Module::getModuleFullPath (   $sModuleId = null)

Returns full module path

Parameters
string$sModuleId
Returns
string

◆ getModuleIdByClassName()

OxidEsales\EshopCommunity\Core\Module\Module::getModuleIdByClassName (   $className)

Get the module id for a given class name. If there are duplicates, the first module id will be returned.

Parameters
string$className
Returns
string

◆ getModulePath()

OxidEsales\EshopCommunity\Core\Module\Module::getModulePath (   $sModuleId = null)

Get module dir

Parameters
string$sModuleIdModule ID
Returns
string

◆ getModulePaths()

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

Get module id's with path

Returns
array

◆ getShopConfiguration()

OxidEsales\EshopCommunity\Core\Module\Module::getShopConfiguration ( )
private
Returns
ShopConfiguration

◆ getSmartyPluginDirectories()

OxidEsales\EshopCommunity\Core\Module\Module::getSmartyPluginDirectories ( )
Returns
array

◆ getTemplates()

OxidEsales\EshopCommunity\Core\Module\Module::getTemplates (   $sModuleId = null)

Return templates affected by template blocks for given module id.

Parameters
string$sModuleIdModule id
Returns
array

◆ getTitle()

OxidEsales\EshopCommunity\Core\Module\Module::getTitle ( )

Get module title

Returns
string

◆ hasExtendClass()

OxidEsales\EshopCommunity\Core\Module\Module::hasExtendClass ( )

Checks if has extend class.

Returns
bool

◆ hasMetadata()

OxidEsales\EshopCommunity\Core\Module\Module::hasMetadata ( )

Checks if module has metadata

Returns
bool

◆ includeModuleMetaData()

OxidEsales\EshopCommunity\Core\Module\Module::includeModuleMetaData (   $metadataPath)
protected

Include data from metadata.php

Parameters
string$metadataPathPath to metadata.php

◆ isActive()

OxidEsales\EshopCommunity\Core\Module\Module::isActive ( )

Check if extension is active

Returns
bool

◆ isRegistered()

OxidEsales\EshopCommunity\Core\Module\Module::isRegistered ( )

Checks if module is registered in any way

Returns
bool

◆ load()

OxidEsales\EshopCommunity\Core\Module\Module::load (   $moduleId)

Load module info

Parameters
string$moduleId
Returns
bool

◆ loadByDir()

OxidEsales\EshopCommunity\Core\Module\Module::loadByDir (   $sModuleDir)

Load module by dir name

Parameters
string$sModuleDirModule dir name
Returns
bool

◆ setMetaDataVersion()

OxidEsales\EshopCommunity\Core\Module\Module::setMetaDataVersion (   $metaDataVersion)
Parameters
mixed$metaDataVersion

◆ setModuleData()

OxidEsales\EshopCommunity\Core\Module\Module::setModuleData (   $aModule)

Set passed module data

Parameters
array$aModulemodule data

Member Data Documentation

◆ $_aModule

OxidEsales\EshopCommunity\Core\Module\Module::$_aModule = []
protected

◆ $_blMetadata

OxidEsales\EshopCommunity\Core\Module\Module::$_blMetadata = false
protected

◆ $_blRegistered

OxidEsales\EshopCommunity\Core\Module\Module::$_blRegistered = false
protected

◆ $metaDataVersion

OxidEsales\EshopCommunity\Core\Module\Module::$metaDataVersion
protected

Metadata version as defined in metadata.php

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