- Class name: TaxManagerModuleCore
- This is an abstract class
- Parent class: Module
- Source: classes/tax/TaxManagerModule.php line 28
- $tax_manager_class
- $_INSTANCE
- $_db
- $_errors
- $_generateConfigXmlMode
- $_lang
- $_path
- $active
- $author
- $beforeUninstall
- $cache_permissions
- $classInModule
- $context
- $description
- $displayName
- $exceptionsCache
- $id
- $identifier
- $l_cache
- $limited_countries
- $modulesCache
- $name
- $need_instance
- $tab
- $table
- $version
- $warning
- __construct
- _clearCache
- _generateConfigXml
- _getApplicableTemplateDir
- _isTemplateOverloaded
- _isTemplateOverloadedStatic
- cleanPositions
- configXmlStringFormat
- disable
- disableByName
- display
- displayConfirmation
- displayError
- displayFlags
- editExceptions
- enable
- enableByName
- findTranslation
- getAuthorizedModules
- getExceptions
- getInstanceById
- getInstanceByName
- getModuleIdByName
- getModuleNameFromClass
- getModulesDirOnDisk
- getModulesInstalled
- getModulesOnDisk
- getNonNativeModuleList
- getPaymentModules
- getPermission
- getPermissionStatic
- getTemplatePath
- hookExec
- hookExecPayment
- hookTaxManager
- install
- isCached
- isHookableOn
- isInstalled
- isRegisteredInHook
- l
- preCall
- registerExceptions
- registerHook
- sqlShopRestriction
- templateAssign
- uninstall
- unregisterExceptions
- unregisterHook
- updatePosition
public mixed $tax_manager_class
- Visibility: public
- Source: classes/tax/TaxManagerModule.php line 30.
protected mixed $_INSTANCE = array()
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/Module.php line 82.
public mixed $_db
- Visibility: public
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/Module.php line 75.
protected mixed $_errors = false
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/Module.php line 69.
protected mixed $_generateConfigXmlMode = false
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/Module.php line 84.
protected array $_lang = array()
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/Module.php line 58.
protected string $_path = NULL
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/Module.php line 61.
public boolean $active = false
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 55.
public string $author
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 46.
public string $beforeUninstall = NULL
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 67.
protected mixed $cache_permissions = array()
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/Module.php line 88.
public array $classInModule = array()
- Visibility: public
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/Module.php line 93.
protected \Context $context
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/Module.php line 96.
public string $description
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 43.
public string $displayName
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 40.
protected mixed $exceptionsCache = NULL
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/Module.php line 1115.
public integer $id = NULL
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 31.
protected mixed $identifier = 'id_module'
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/Module.php line 73.
protected mixed $l_cache = array()
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/Module.php line 86.
public array $limited_countries = array()
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 78.
protected mixed $modulesCache
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/Module.php line 80.
public string $name
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 37.
public integer $need_instance = 1
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 49.
public string $tab = NULL
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 52.
protected mixed $table = 'module'
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/Module.php line 71.
public float $version
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 34.
public string $warning
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/Module.php line 64.
mixed ModuleCore::__construct(string $name, \Context $context)
Constructor
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 104
- $name string - Module unique name
- $context Context
mixed ModuleCore::_clearCache($template, $cacheId, $compileId)
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1255
- $template mixed
- $cacheId mixed
- $compileId mixed
mixed ModuleCore::_generateConfigXml()
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1260
mixed ModuleCore::_getApplicableTemplateDir($template)
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1243
- $template mixed
mixed ModuleCore::_isTemplateOverloaded($template)
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1190
- $template mixed
mixed ModuleCore::_isTemplateOverloadedStatic($moduleName, $template)
- Visibility: protected
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1181
- $moduleName mixed
- $template mixed
mixed ModuleCore::cleanPositions($id_hook, $shopList)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1064
- $id_hook mixed
- $shopList mixed
mixed ModuleCore::configXmlStringFormat($string)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 580
- $string mixed
mixed ModuleCore::disable(boolean $forceAll)
Desactivate current module.
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 291
- $forceAll boolean - If true, disable module for all shop
true ModuleCore::disableByName(array|string $name)
This function disable module $name. If an $name is an array, this will disable all of them
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 275
- $name array|string
mixed ModuleCore::display($file, $template, $cacheId, $compileId)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1195
- $file mixed
- $template mixed
- $cacheId mixed
- $compileId mixed
mixed ModuleCore::displayConfirmation($string)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1100
- $string mixed
mixed ModuleCore::displayError($error)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1090
- $error mixed
mixed ModuleCore::displayFlags(array $languages, integer $default_language, string $ids, string $id, boolean $return, boolean $use_vars_instead_of_ids)
Display flags in forms for translations
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 309
- $languages array - All languages available
- $default_language integer - Default language id
- $ids string - Multilingual div ids in form
- $id string - Current div id]
- $return boolean - define the return way : false for a display, true for a return
- $use_vars_instead_of_ids boolean - use an js vars instead of ids seperate by "¤"
mixed ModuleCore::editExceptions($hookID, $excepts)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 489
- $hookID mixed
- $excepts mixed
mixed ModuleCore::enable(boolean $forceAll)
Activate current module.
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 245
- $forceAll boolean - If true, enable module for all shop
true ModuleCore::enableByName(array|string $name)
This function enable module $name. If an $name is an array, this will enable all of them
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 231
- $name array|string
string ModuleCore::findTranslation(string $name, string $string, string $source)
find translation from $_MODULES and put it in self::$l_cache if not already exist and return it.
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 946
- $name string - name of the module
- $string string - term to find
- $source string - additional param for building translation key
mixed ModuleCore::getAuthorizedModules($group_id)
get Unauthorized modules for a client group
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1314
- $group_id mixed
mixed ModuleCore::getExceptions($hookID, $dispatch)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1116
- $hookID mixed
- $dispatch mixed
\Module ModuleCore::getInstanceById($moduleID)
Return an instance of the specified module
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 561
- $moduleID mixed
\Module ModuleCore::getInstanceByName(string $moduleName)
Return an instance of the specified module
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 542
- $moduleName string - Module name
integer ModuleCore::getModuleIdByName($name)
get id module by name
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1329
- $name mixed
boolean|string ModuleCore::getModuleNameFromClass(mixed $currentClass)
This function is used to determine the module name of an AdminTab which belongs to a module, in order to keep translation related to a module in its directory (instead of $_LANGADM)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 511
- $currentClass mixed - the
mixed ModuleCore::getModulesDirOnDisk()
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 802
array ModuleCore::getModulesInstalled(integer $position)
Return installed modules
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 851
- $position integer - Take only positionnables modules
array ModuleCore::getModulesOnDisk(boolean $useConfig, $loggedOnAddons)
Return available modules
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 591
- $useConfig boolean - in order to use config.xml file in module dir
- $loggedOnAddons mixed
array ModuleCore::getNonNativeModuleList()
Return non native module
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 824
array ModuleCore::getPaymentModules()
Returns the list of the payment module associated to the current customer
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 896
mixed ModuleCore::getPermission($variable, $employee)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1286
- $variable mixed
- $employee mixed
mixed ModuleCore::getPermissionStatic($id_module, $variable, $employee)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1291
- $id_module mixed
- $variable mixed
- $employee mixed
string ModuleCore::getTemplatePath(string $template)
Get realpath of a template of current module (check if template is overriden too)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1217
- $template string
string ModuleCore::hookExec(string $hook_name, array $hookArgs, $id_module)
Execute modules for specified hook
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 870
- $hook_name string - Hook Name
- $hookArgs array - Parameters for the functions
- $id_module mixed
mixed ModuleCore::hookExecPayment()
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 876
mixed TaxManagerModuleCore::hookTaxManager($args)
- Visibility: public
- Source: classes/tax/TaxManagerModule.php line 37
- $args mixed
mixed TaxManagerModuleCore::install()
- Visibility: public
- Source: classes/tax/TaxManagerModule.php line 32
mixed ModuleCore::isCached($template, $cacheId, $compileId)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1248
- $template mixed
- $cacheId mixed
- $compileId mixed
boolean ModuleCore::isHookableOn(string $hook_name)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1281
- $hook_name string
mixed ModuleCore::isInstalled($moduleName)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1159
- $moduleName mixed
mixed ModuleCore::isRegisteredInHook($hook)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1165
- $hook mixed
string ModuleCore::l(string $string, boolean|string $specific, $id_lang)
Get translation for a given module text
Note: $specific parameter is mandatory for library files. Otherwise, translation key will not match for Module library when module is loaded with eval() Module::getModulesOnDisk()
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 987
- $string string - String to translate
- $specific boolean|string - filename to use in translation key
- $id_lang mixed
mixed ModuleCore::preCall($moduleName)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/Module.php line 883
- $moduleName mixed
boolean ModuleCore::registerExceptions(integer $id_hook, array $excepts, array $shopList)
Add exceptions for module->Hook
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 464
- $id_hook integer - Hook id
- $excepts array - List of file name
- $shopList array - List of shop
boolean ModuleCore::registerHook(string $hook_name, array $shopList)
Connect module to a hook
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 338
- $hook_name string - Hook name
- $shopList array - List of shop linked to the hook (if null, link hook to all shops)
mixed ModuleCore::sqlShopRestriction($share, $alias)
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/Module.php line 142
- $share mixed
- $alias mixed
mixed ModuleCore::templateAssign(string $key, mixed $value)
Assign a smarty vars (same syntax as smarty->assign) but prefix all keys with module name
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1232
- $key string - Variable key (can be an array)
- $value mixed - Variable value
boolean ModuleCore::uninstall()
Delete module from datable
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 194
boolean ModuleCore::unregisterExceptions($hook_id, array $shopList)
Unregister exceptions linked to module
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 446
- $hook_id mixed
- $shopList array - List of shop
boolean ModuleCore::unregisterHook($hook_id, array $shopList)
Unregister module from hook
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 412
- $hook_id mixed
- $shopList array - List of shop
mixed ModuleCore::updatePosition($id_hook, $way, $position)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/Module.php line 1014
- $id_hook mixed
- $way mixed
- $position mixed