OXID eShop CE  6.1.5
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 ($sModuleId)
 
 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

 _countActivatedExtensions ($aModuleExtensions, $aInstalledExtensions)
 
 _countExtensions ($aModuleExtensions)
 
 _isExtensionsActive ()
 
 _isInDisabledList ($sId)
 
 includeModuleMetaData ($metadataPath)
 
 getUnifiedShopClassExtensionsForBc ($rawExtensions)
 

Protected Attributes

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

Private Member Functions

 backwardsCompatibleGetModuleIdByClassName ($classPath)
 

Detailed Description

Module class.

Member Function Documentation

◆ _countActivatedExtensions()

OxidEsales\EshopCommunity\Core\Module\Module::_countActivatedExtensions (   $aModuleExtensions,
  $aInstalledExtensions 
)
protected

Counts activated module extensions.

Parameters
array$aModuleExtensionsModule extensions
array$aInstalledExtensionsInstalled extensions
Returns
int

◆ _countExtensions()

OxidEsales\EshopCommunity\Core\Module\Module::_countExtensions (   $aModuleExtensions)
protected

Counts module extensions.

Parameters
array$aModuleExtensionsModule extensions
Returns
int

◆ _isExtensionsActive()

OxidEsales\EshopCommunity\Core\Module\Module::_isExtensionsActive ( )
protected

Checks if module extensions count is the same as in activated extensions list.

Returns
bool

◆ _isInDisabledList()

OxidEsales\EshopCommunity\Core\Module\Module::_isInDisabledList (   $sId)
protected

Checks if module is in disabled list.

Parameters
string$sIdModule id
Returns
bool

◆ backwardsCompatibleGetModuleIdByClassName()

OxidEsales\EshopCommunity\Core\Module\Module::backwardsCompatibleGetModuleIdByClassName (   $classPath)
private
Deprecated:
since v6.0.0 (2017-03-21); Needed to ensure backwards compatibility.

Backwards compatible version of self::getModuleIdByClassName()

Parameters
string$classPathThe class path as defined in metadata.php section 'extend'. This is not a valid file path.
Returns
bool

◆ 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

◆ 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

◆ 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

◆ getUnifiedShopClassExtensionsForBc()

OxidEsales\EshopCommunity\Core\Module\Module::getUnifiedShopClassExtensionsForBc (   $rawExtensions)
protected

Translate module metadata information about the patched shop classes into Unified Namespace. There might still be BC class names used in module metadata.php.

Parameters
array$rawExtensionsExtension information from module metadata.php.
Returns
array

◆ 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 (   $sModuleId)

Load module info

Parameters
string$sModuleIdModule ID
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: