How to add ActionBar button in foreign module?

chaotix

Hello.

I wrote a module that uses appy.pod (~~[url=http://appyframework.org/pod.html]~~http://appyframework.org/pod.html[/url]) to generate ODF-Documents.

For example the user uploads a letter template, opens a contact page, clicks on "Generate office document", selects his template and a letter with the information from the contact is generated and downloaded.

This works fine, but I don't know how to properly get the "Generate office document" ActionBar button in the recordviewer. Currently I added the call to Base_ActionBarCommon::add() directly to RecordBrowser->view_entry() which is not a really clean solution. Is there another way to add an ActionBar button to the RecordBrowser when an item is viewed (not edited)?

Thanks,
Lars

ajb

Yes there is 🙂

Use

Utils_RecordBrowserCommon::register_processing_callback('contact', 'Custom_MyModuleCommon::add_action_button');

then create this method:

class Custom_MyModuleCommon {

 public static function add_action_button($record, $mode) {

  if ($mode == 'display') {

   Base_ActionBarCommon::add( ... );

  }

 }

}

With this approach it will be permanent upon EPESI updates.
Of course adjust class names - it doesn't have to be Common class. You can create a simple class in separate file and autoloader will do the job.

Regards,
Adam

chaotix

Thanks for the reply. Unfortunately this does not solve my problem.

The document generation code is flexible enough to work with every record type, so I would like to add the additional button to each one.



Utils_RecordBrowserCommon::register_processing_callback('contact', 'Custom_MyModuleCommon::add_action_button');

This just adds the button to the contact records. I could probably add all the different record types from the base install (contact, company, task, phonecall, etc.) but then it wouldn't work for new extensions.
Even getting the list of all records dynamically from the database wouldn't work as registering the processing callback is done at install time and record types created afterwards would not get the extra button.

If there is no better solution that's ok. I can patch RecordBrowser_0.php on every update. It just seems unclean,
Lars

ajb

So yes - we don't have an option for all recordsets. Leave it as is right now and remember to patch. We're working to improve RB and probably we'll add such option in future.

Regards,
Adam

chaotix

Thanks for the reply.

I will just patch RecordBrowser_0.php on updates. As the document generation depends on a python script that should not be in the webroot for security purposes I don't have to think about easy distribution of the module anyway.

Epesi ENS | Epesi Academy | epesi.cloud PaaS | GitHub

Help Me! | Download from SourceForge