User Tools

Site Tools


plug-in_development

Creating an OpenDocMan™ Plug-In

Note: The plug-in feature is only available for OpenDocMan 1.2.6beta and upwards

We will use the HelloWorld example plugin to show how to create your own. Lets say you are creating a new plug-in for doing some reports. Here is how you would get started….

  1. Download the HelloWorld plug-in from OpenDocMan.com
  2. Extract the plug-in inside the plug-ins/ folder. You should have plug-ins/HelloWorld now.
  3. Rename the `HelloWorld` folder to `Reports`
  4. Edit the plug-ins/Reports/readme.txt file
  5. Rename the `plug-ins/Reports/HelloWorld_class.php` file to `plug-ins/Reports/Reports_class.php`.
  6. Edit the plug-ins/Reports/index.php file
  7. Ensure the plug-ins/Reports/templates_c folder is writeable.
  8. Edit the Reports_class.php file

Your views go inside of plug-ins/Reports/templates. They are Smarty template engine files.

You can view the Plugin_class.php file for all the current methods available. You would over-ride the inherited methods with your own. If you search for those method names inside the OpenDocMan code you will find where they are being called. Each method is called in one unique spot. For example, the onFailedLogin() method is being called in index.php right after it is determined that the user authentication failed.

For more information on the available API methods visit our Plug-in API page.

plug-in_development.txt · Last modified: 2010/12/28 13:33 by admin