author | Giulio Cesare Solaroli <giulio.cesare@solaroli.it> | 2011-10-03 16:04:12 (UTC) |
---|---|---|
committer | Giulio Cesare Solaroli <giulio.cesare@solaroli.it> | 2011-10-03 16:04:12 (UTC) |
commit | 541bb378ddece2eab135a8066a16994e94436dea (patch) (side-by-side diff) | |
tree | ff160ea3e26f7fe07fcfd401387c5a0232ca715e /backend/php/src/plugins/IPlugin.php | |
parent | 1bf431fd3d45cbdf4afa3e12afefe5d24f4d3bc7 (diff) | |
parent | ecad5e895831337216544e81f1a467e0c68c4a6a (diff) | |
download | clipperz-541bb378ddece2eab135a8066a16994e94436dea.zip clipperz-541bb378ddece2eab135a8066a16994e94436dea.tar.gz clipperz-541bb378ddece2eab135a8066a16994e94436dea.tar.bz2 |
Merge pull request #1 from gcsolaroli/master
First version of the restructured repository
Diffstat (limited to 'backend/php/src/plugins/IPlugin.php') (more/less context) (show whitespace changes)
-rw-r--r-- | backend/php/src/plugins/IPlugin.php | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/backend/php/src/plugins/IPlugin.php b/backend/php/src/plugins/IPlugin.php new file mode 100644 index 0000000..3e39e70 --- a/dev/null +++ b/backend/php/src/plugins/IPlugin.php @@ -0,0 +1,48 @@ +<?php +/** + * All functions must be implemented to create a correct POG plugin + * The 'optional' functions SetupRender() and AuthorPage() must be implemented and return null + * if your plugin does not need them. + * + */ +interface POG_Plugin +{ + /** + * + * REQUIRED + * This function must return the version of the plugin. + * It will be used to automatically notify developer when your plugin is updated. + * + */ + function Version(); + + /** + * + * REQUIRED + * This function performs the actions that your plugin provides. + * + */ + function Execute(); + + /** + * 'OPTIONAL' + * If your plugin needs an administrative interface, implement this function. + * Else return null + * + */ + function SetupRender(); + + + /** + * + * 'OPTIONAL' + * Implement this function to provide a link to your homepage. + * e.g. return 'http://myhomepage.com'; + * + * return null if you do not want to link to your homepage + * e.g. return null + * + */ + function AuthorPage(); +} +?>
\ No newline at end of file |