Extensions and Widgets Creation: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
'''Note: This manual is for osCommerce v4.''' | '''Note: This manual is for osCommerce v4.''' | ||
'''Basic Provisions:''' | |||
# | # All extensions must be placed in separate folder. | ||
# | # The class file name must be the same as the folder name. | ||
# | # Templates must be placed in folder 'views'. | ||
//additional | |||
if you want to use widgets in extensions | |||
1. Add method getWidgets with $type parameter and describe widgets in array | |||
example: | |||
return [ | return [ | ||
Line 27: | Line 24: | ||
]; | ]; | ||
in this case ShoppingCart (in subfolder \ShoppingCart) is widget ( ShoppingCart.php) can be used in customizing Themes | |||
2. to show additional settings for widget use method showSettings | |||
example: | |||
public static function showSettings($settings){ | public static function showSettings($settings){ | ||
Line 39: | Line 36: | ||
} | } | ||
extension installer: | |||
1) extends \common\classes\modules\ModuleExtensions | |||
2) install (example) | |||
public function install($platform_id){ | public function install($platform_id){ | ||
Line 63: | Line 60: | ||
} | } | ||
2) check extension enabled - use \common\helpers\Acl::checkExtensionAllowed($extName, 'allowed') | |||
public static function allowed() { | public static function allowed() { |
Latest revision as of 16:58, 24 February 2023
Note: This manual is for osCommerce v4.
Basic Provisions:
- All extensions must be placed in separate folder.
- The class file name must be the same as the folder name.
- Templates must be placed in folder 'views'.
//additional
if you want to use widgets in extensions
1. Add method getWidgets with $type parameter and describe widgets in array
example:
return [
[
'name' => 'CustomerLoyalty\ShoppingCart', 'title' => 'Customer Loyalty Info Box', 'description' => '', 'type' => 'cart',
],
];
in this case ShoppingCart (in subfolder \ShoppingCart) is widget ( ShoppingCart.php) can be used in customizing Themes
2. to show additional settings for widget use method showSettings
example:
public static function showSettings($settings){
return self::begin()->render('settings.tpl', ['settings' => $settings]);
}
extension installer:
1) extends \common\classes\modules\ModuleExtensions
2) install (example)
public function install($platform_id){
parent::install($platform_id);// install in liek other modules
// install extention envirenment
$migration = new \common\classes\Migration;
$migration->addTranslation(['admin/main'], [
//add keys
]);
return;
}
2) check extension enabled - use \common\helpers\Acl::checkExtensionAllowed($extName, 'allowed')
public static function allowed() {
return self::enabled();
}