Class FreeOrder to use PaymentModule (abstract class, cannot be instancied)
- Class name: FreeOrder
- Parent class: PaymentModule
- Source: controllers/front/ParentOrderController.php line 30
- $active
- $displayName
- $name
- $currencies
- $currencies_mode
- $currentOrder
- $_INSTANCE
- $_confirmations
- $_errors
- $_generate_config_xml_mode
- $_lang
- $_path
- $additional_description
- $allow_push
- $author
- $author_uri
- $avg_rate
- $badges
- $cache_permissions
- $classInModule
- $compatibility
- $context
- $controllers
- $current_subtemplate
- $database_version
- $dependencies
- $description
- $description_full
- $enable_device
- $hosted_modules_blacklist
- $id
- $identifier
- $l_cache
- $limited_countries
- $local_path
- $module_key
- $modules_cache
- $nb_rates
- $need_instance
- $ps_versions_compliancy
- $push_time_limit
- $registered_version
- $smarty
- $tab
- $table
- $trusted
- $update_translations_after_install
- $version
- $warning
- __construct
- _clearCache
- _generateConfigXml
- _getApplicableTemplateDir
- _getFormatedAddress
- _getTxtFormatedAddress
- _isTemplateOverloaded
- _isTemplateOverloadedStatic
- addCheckboxCountryRestrictionsForModule
- addCheckboxCurrencyRestrictionsForModule
- addCurrencyPermissions
- addOverride
- addRadioCurrencyRestrictionsForModule
- adminDisplayInformation
- adminDisplayWarning
- checkCompliancy
- checkModuleFromAddonsApi
- cleanPositions
- configXmlStringFormat
- disable
- disableByName
- disableDevice
- display
- displayConfirmation
- displayError
- displayFlags
- editExceptions
- enable
- enableByName
- enableDevice
- findTranslation
- formatProductAndVoucherForEmail
- generateTrustedXml
- getAuthorizedModules
- getCacheId
- getConfirmations
- getCurrency
- getCurrentSubTemplate
- getEmailTemplateContent
- getErrors
- getExceptions
- getExceptionsStatic
- getInstalledPaymentModules
- getInstanceById
- getInstanceByName
- getLocalPath
- getModuleIdByName
- getModuleName
- getModuleNameFromClass
- getModulesDirOnDisk
- getModulesInstalled
- getModulesOnDisk
- getNativeModuleList
- getNonNativeModuleList
- getPathUri
- getPaymentModules
- getPaypalIgnore
- getPermission
- getPermissionStatic
- getPosition
- getTemplatePath
- getUpgradeStatus
- hookExec
- hookExecPayment
- initUpgradeModule
- install
- installControllers
- installOverrides
- isCached
- isEnabled
- isEnabledForShopContext
- isHookableOn
- isInstalled
- isModuleTrusted
- isRegisteredInHook
- l
- loadUpgradeVersionList
- needUpgrade
- preCall
- registerExceptions
- registerHook
- removeOverride
- resetCurrentSubTemplate
- runUpgradeModule
- setUpgradeMessage
- uninstall
- uninstallOverrides
- unregisterExceptions
- unregisterHook
- updateModuleTranslations
- updatePosition
- updateTranslationsAfterInstall
- upgradeModuleVersion
- useTooMuchMemory
- validateOrder
public mixed $active = 1
- Visibility: public
- Source: controllers/front/ParentOrderController.php line 32.
public mixed $displayName = 'free_order'
- Visibility: public
- Source: controllers/front/ParentOrderController.php line 34.
public mixed $name = 'free_order'
- Visibility: public
- Source: controllers/front/ParentOrderController.php line 33.
public mixed $currencies = true
- Visibility: public
- This property is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 31.
public mixed $currencies_mode = 'checkbox'
- Visibility: public
- This property is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 32.
public integer $currentOrder
- Visibility: public
- This property is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 30.
protected \protected $_INSTANCE = array()
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 131.
protected \protected $_confirmations = array()
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 119.
protected \protected $_errors = array()
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 116.
protected \protected $_generate_config_xml_mode = false
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 134.
protected array $_lang = array()
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 105.
protected string $_path = null
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 108.
public mixed $additional_description
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 68.
public \allow $allow_push
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 154.
public string $author
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 58.
public string $author_uri = ''
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 61.
public mixed $avg_rate
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 74.
public mixed $badges
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 76.
protected \protected $cache_permissions = array()
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 140.
public array $classInModule = array()
- Visibility: public
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 102.
public mixed $compatibility
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 70.
protected \Context $context
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 143.
public array $controllers = array()
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 99.
protected \currentSmartySubTemplate $current_subtemplate = null
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 149.
public mixed $database_version
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 34.
public array $dependencies = array()
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 46.
public string $description
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 55.
public mixed $description_full
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 66.
public mixed $enable_device = 7
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 93.
public mixed $hosted_modules_blacklist = array('autoupgrade')
- Visibility: public
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 172.
public integer $id = null
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 30.
protected \protected $identifier = 'id_module'
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 125.
protected \protected $l_cache = array()
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 137.
public array $limited_countries = array()
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 96.
protected string $local_path = null
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 113.
public string $module_key = ''
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 64.
protected \protected $modules_cache
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 128.
public mixed $nb_rates
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 72.
public integer $need_instance = 1
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 79.
public array $ps_versions_compliancy = array()
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 43.
public mixed $push_time_limit = 180
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 156.
public string $registered_version
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 40.
protected \Smarty_Data $smarty
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 146.
public string $tab = null
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 82.
protected \protected $table = 'module'
- Visibility: protected
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 122.
public boolean $trusted = false
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 88.
protected mixed $update_translations_after_install = true
- Visibility: protected
- This property is static.
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 151.
public float $version
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 33.
public string $warning
- Visibility: public
- This property is defined by ModuleCore.
- Source: classes/module/Module.php line 91.
mixed ModuleCore::__construct(string $name, \Context $context)
Constructor
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 180
- $name string - Module unique name
- $context Context
mixed ModuleCore::_clearCache($template, $cache_id, $compile_id)
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2166
- $template mixed
- $cache_id mixed
- $compile_id mixed
mixed ModuleCore::_generateConfigXml()
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2181
mixed ModuleCore::_getApplicableTemplateDir($template)
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2141
- $template mixed
String PaymentModuleCore::_getFormatedAddress(\Address $the_address, $line_sep, $fields_style)
- Visibility: protected
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 857
- $the_address Address
- $line_sep mixed
- $fields_style mixed
String PaymentModuleCore::_getTxtFormatedAddress($the_address)
- Visibility: protected
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 833
- $the_address mixed
mixed ModuleCore::_isTemplateOverloaded($template)
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2045
- $template mixed
mixed ModuleCore::_isTemplateOverloadedStatic($module_name, $template)
- Visibility: protected
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2028
- $module_name mixed
- $template mixed
boolean PaymentModuleCore::addCheckboxCountryRestrictionsForModule(array $shops)
Add checkbox country restrictions for a new module
- Visibility: public
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 125
- $shops array
boolean PaymentModuleCore::addCheckboxCurrencyRestrictionsForModule(array $shops)
Add checkbox currency restrictions for a new module
- Visibility: public
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 86
- $shops array
boolean PaymentModuleCore::addCurrencyPermissions(integer $id_currency, array $id_module_list)
Allows specified payment modules to be used by a specific currency
- Visibility: public
- This method is static.
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 903
- $id_currency integer
- $id_module_list array
boolean ModuleCore::addOverride(string $classname)
Add all methods in a module override to the override class
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2481
- $classname string
boolean PaymentModuleCore::addRadioCurrencyRestrictionsForModule(array $shops)
Add radio currency restrictions for a new module
- Visibility: public
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 107
- $shops array
mixed ModuleCore::adminDisplayInformation(string $msg)
add a info message to display at the top of the admin page
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2384
- $msg string
mixed ModuleCore::adminDisplayWarning(string $msg)
add a warning message to display at the top of the admin page
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2372
- $msg string
mixed ModuleCore::checkCompliancy()
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 337
boolean ModuleCore::checkModuleFromAddonsApi($module_name)
Create the Addons API call from the module name only
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1686
- $module_name mixed
mixed ModuleCore::cleanPositions($id_hook, $shop_list)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1867
- $id_hook mixed
- $shop_list mixed
mixed ModuleCore::configXmlStringFormat($string)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1076
- $string mixed
mixed ModuleCore::disable(boolean $forceAll)
Desactivate current module.
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 742
- $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/Module.php line 724
- $name array|string
mixed ModuleCore::disableDevice($device)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 704
- $device mixed
mixed ModuleCore::display($file, $template, $cacheId, $compileId)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2068
- $file mixed
- $template mixed
- $cacheId mixed
- $compileId mixed
mixed ModuleCore::displayConfirmation($string)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1905
- $string mixed
mixed ModuleCore::displayError($error)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1892
- $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/Module.php line 760
- $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 "¤"
boolean ModuleCore::editExceptions($id_hook, array $excepts)
Edit exceptions for module->Hook
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 959
- $id_hook mixed
- $excepts array - List of shopID and file name
mixed ModuleCore::enable(boolean $forceAll)
Activate current module.
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 665
- $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/Module.php line 647
- $name array|string
mixed ModuleCore::enableDevice($device)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 692
- $device mixed
mixed ModuleCore::findTranslation($name, $string, $source)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1787
- $name mixed
- $string mixed
- $source mixed
mixed PaymentModuleCore::formatProductAndVoucherForEmail($content)
- Visibility: public
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 823
- $content mixed
mixed ModuleCore::generateTrustedXml()
Generate XML files for trusted and untrusted modules
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1603
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/Module.php line 2275
- $group_id mixed
mixed ModuleCore::getCacheId($name)
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2050
- $name mixed
array ModuleCore::getConfirmations()
Get module messages confirmation
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2316
\Currency PaymentModuleCore::getCurrency($current_id_currency)
- Visibility: public
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 866
- $current_id_currency mixed
mixed ModuleCore::getCurrentSubTemplate($template, $cache_id, $compile_id)
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2097
- $template mixed
- $cache_id mixed
- $compile_id mixed
string PaymentModuleCore::getEmailTemplateContent(string $template_name, integer $mail_type, array $var)
Fetch the content of $template_name inside the folder current_theme/mails/current_iso_lang/ if found, otherwise in mails/current_iso_lang
- Visibility: protected
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 971
- $template_name string - template name with extension
- $mail_type integer - Mail::TYPE_HTML or Mail::TYPE_TXT
- $var array - list send to smarty
array ModuleCore::getErrors()
Get module errors
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2305
mixed ModuleCore::getExceptions($id_hook, $dispatch)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1974
- $id_hook mixed
- $dispatch mixed
mixed ModuleCore::getExceptionsStatic($id_module, $id_hook, $dispatch)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1924
- $id_module mixed
- $id_hook mixed
- $dispatch mixed
array PaymentModuleCore::getInstalledPaymentModules()
List all installed and active payment modules
- Visibility: public
- This method is static.
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 934
\Module ModuleCore::getInstanceById(integer $id_module)
Return an instance of the specified module
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1057
- $id_module integer - Module ID
\Module ModuleCore::getInstanceByName(string $module_name)
Return an instance of the specified module
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1019
- $module_name string - Module name
string ModuleCore::getLocalPath()
Get local path for module
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2327
integer ModuleCore::getModuleIdByName($name)
Get id module by name
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2288
- $name mixed
mixed ModuleCore::getModuleName($module)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1082
- $module 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/Module.php line 981
- $currentClass mixed - the
array ModuleCore::getModulesDirOnDisk()
Return modules directory list
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1450
array ModuleCore::getModulesInstalled(integer $position)
Return installed modules
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1519
- $position integer - Take only positionnables modules
array ModuleCore::getModulesOnDisk(boolean $useConfig, $loggedOnAddons, $id_employee)
Return available modules
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1138
- $useConfig boolean - in order to use config.xml file in module dir
- $loggedOnAddons mixed
- $id_employee mixed
mixed ModuleCore::getNativeModuleList()
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1494
array ModuleCore::getNonNativeModuleList()
Return non native module
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1476
string ModuleCore::getPathUri()
Get uri path for module
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2338
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/Module.php line 1743
mixed ModuleCore::getPaypalIgnore()
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1732
boolean ModuleCore::getPermission(array $variable, object $employee)
Check employee permission for module
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2230
- $variable array - (action)
- $employee object
boolean ModuleCore::getPermissionStatic(integer $id_module, array $variable, object $employee)
Check employee permission for module (static method)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2242
- $id_module integer
- $variable array - (action)
- $employee object
mixed ModuleCore::getPosition($id_hook)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2349
- $id_hook 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/Module.php line 2123
- $template string
boolean ModuleCore::getUpgradeStatus($module_name)
Return the status of the upgraded module
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 574
- $module_name mixed
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/Module.php line 1712
- $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/Module.php line 1718
boolean ModuleCore::initUpgradeModule($module)
Init the upgrade module
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 396
- $module mixed
mixed PaymentModuleCore::install()
- Visibility: public
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 36
boolean ModuleCore::installControllers()
Install module's controllers using public property $controllers
- Visibility: private
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2395
boolean ModuleCore::installOverrides()
Install overrides files for the module
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2438
mixed ModuleCore::isCached($template, $cacheId, $compileId)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2146
- $template mixed
- $cacheId mixed
- $compileId mixed
mixed ModuleCore::isEnabled($module_name)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2000
- $module_name mixed
mixed ModuleCore::isEnabledForShopContext()
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1989
boolean ModuleCore::isHookableOn(string $hook_name)
Check if the module is transplantable on the hook in parameter
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2218
- $hook_name string
mixed ModuleCore::isInstalled($module_name)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1979
- $module_name mixed
integer ModuleCore::isModuleTrusted($module_name)
Return if the module is provided by addons.prestashop.com or not
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1537
- $module_name mixed
mixed ModuleCore::isRegisteredInHook($hook)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2013
- $hook mixed
string ModuleCore::l(string $string, boolean|string $specific)
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/Module.php line 1803
- $string string - String to translate
- $specific boolean|string - filename to use in translation key
boolean ModuleCore::loadUpgradeVersionList($module_name, $module_version, $registered_version)
Load the available list of upgrade of a specified module with an associated version
- Visibility: protected
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 520
- $module_name mixed
- $module_version mixed
- $registered_version mixed
boolean ModuleCore::needUpgrade($module)
Check if a module need to be upgraded.
This method modify the module_cache adding an upgrade list file
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 496
- $module mixed
mixed PaymentModuleCore::preCall($module_name)
- Visibility: public
- This method is static.
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 950
- $module_name mixed
boolean ModuleCore::registerExceptions(integer $id_hook, array $excepts, array $shop_list)
Add exceptions for module->Hook
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 925
- $id_hook integer - Hook id
- $excepts array - List of file name
- $shop_list array - List of shop
boolean ModuleCore::registerHook(string $hook_name, array $shop_list)
Connect module to a hook
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 790
- $hook_name string - Hook name
- $shop_list array - List of shop linked to the hook (if null, link hook to all shops)
boolean ModuleCore::removeOverride(string $classname)
Remove all methods in a module override from the override class
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2595
- $classname string
mixed ModuleCore::resetCurrentSubTemplate($template, $cache_id, $compile_id)
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2111
- $template mixed
- $cache_id mixed
- $compile_id mixed
array ModuleCore::runUpgradeModule()
Run the upgrade for a given module name and version
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 426
mixed ModuleCore::setUpgradeMessage($upgrade_detail)
Set errors, warning or success message of a module upgrade
- Visibility: protected
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 360
- $upgrade_detail mixed
mixed PaymentModuleCore::uninstall()
- Visibility: public
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 70
boolean ModuleCore::uninstallOverrides()
Uninstall overrides files for the module
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 2459
boolean ModuleCore::unregisterExceptions($hook_id, array $shop_list)
Unregister exceptions linked to module
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 909
- $hook_id mixed
- $shop_list array - List of shop
boolean ModuleCore::unregisterHook($hook_id, array $shop_list)
Unregister module from hook
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 872
- $hook_id mixed
- $shop_list array - List of shop
mixed ModuleCore::updateModuleTranslations()
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 350
mixed ModuleCore::updatePosition($id_hook, $way, $position)
- Visibility: public
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1818
- $id_hook mixed
- $way mixed
- $position mixed
mixed ModuleCore::updateTranslationsAfterInstall($update)
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 345
- $update mixed
boolean ModuleCore::upgradeModuleVersion($name, $version)
Upgrade the registered version to a new one
- Visibility: public
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 479
- $name mixed
- $version mixed
mixed ModuleCore::useTooMuchMemory()
- Visibility: protected
- This method is static.
- This method is defined by ModuleCore.
- Source: classes/module/Module.php line 1117
boolean PaymentModuleCore::validateOrder(integer $id_cart, integer $id_order_state, float $amount_paid, string $payment_method, null $message, array $extra_vars, null $currency_special, boolean $dont_touch_amount, boolean $secure_key, \Shop $shop)
Validate an order in database Function called from a payment module
- Visibility: public
- This method is defined by PaymentModuleCore.
- Source: classes/PaymentModule.php line 152
- $id_cart integer
- $id_order_state integer
- $amount_paid float - Amount really paid by customer (in the default currency)
- $payment_method string - Payment method (eg. 'Credit card')
- $message null - Message to attach to order
- $extra_vars array
- $currency_special null
- $dont_touch_amount boolean
- $secure_key boolean
- $shop Shop