Dear developers,

some time ago we implemented a custom widget and added it to our fork:

https://github.com/asig2016/egroupware/blob/19.1_p1/api/js/etemplate/et2_widget_currency.js8
https://github.com/asig2016/egroupware/blob/19.1_p1/api/src/Etemplate/Widget/Currency.php5

The widget is working just fine from there. But in order to have to minimize the differences between our fork and the upstream branch I tried to move the widget to a custom api application.

For this I used the hook etemplate2_register_widgets as used in the import_export application:

$setup_info[‘importexport’][‘hooks’][‘etemplate2_register_widgets’] = ‘importexport_admin_prefs_sidebox_hooks::widgets’;

I created I class file and added

Etemplate\Widget::registerWidget(‘achelper_widget_currency’, array(‘currency’));

at the end.

Since I din’t find a way to include the js file to be recognized before loading of the form I included it in the

*egw:uses …

section of etemplate2.js

in the

/api/js/etemplate/

folder.

The widget appears correctly in the templates I use it, but when I submit the form it does not transfer the value to the php $content array.

Is the way I moved the widget correct, what can I do to fix this issue?

Thanks a lot in advance and

Best regards

Alex

Hello @RalfBecker,
thanks for your reply, it helped me search at the right place. The different class name currency2 at the commented out code was a desperate action while trying to find out why things where not working… Nevertheless I actually had made 2 similar mistakes:

1. I had forgotten the “.inc.” letters in the filename of my class file, so it was not autoloaded.
2. I made an error when using the Api\Framework::includeJS("/$app/$file") function you mentioned.

After that I can confirm that moving a widget to a custom application is straight forward. Let’s say

1. the application is called “achelper”,
2. the widget is called “currency”
3. then the php class should be named achelper_widget_currency and the classfile class.achelper_widget_currency.inc.php
4. the js file is named et2_widget_currency.js

Steps:

1. In the setup.inc.php of the achelper application add the ‘etemplate2_register_widgets’ hook to a static function:

$setup_info[‘achelper’][‘hooks’][‘etemplate2_register_widgets’] = ‘achelper_hooks::widgets’;

2. In the achelper_hooks class add a static function, in this case named widgets as defined in setup.inc.php returning the widget class:

/**
Returns a list of custom widgets classes for etemplate2
*/
public static function widgets()
{
return [‘achelper_widget_currency’];
}

3. Put the js file ‘et2_widget_currency.js’ in the js folder of the achelper app:

/achelper/js/et2_widget_currency.js

4. Include the js file in the constructor of the php class:

**
eTemplate currency textbox
Supports formatting for decimal & thousands, and currency prefix/suffix
*/
class achelper_widget_currency extends Etemplate\Widget
{
public function __construct($xml=’’) {

  Api\Framework::IncludeJS("/achelper/js/et2_widget_currency.js");
    parent::__construct($xml);

}

Including in the beforeSendToClient() function works also fine, I don’t know which is the better place…

Now my last question about this is how the et2_widget_currency.js can be included in the min.js files. I included it in the Gruntfile.js in the Egroupware root and ran “grunt” but my widget is still using the uncompressed version.

Thanks again everyone and Best Regards,
Alex