summaryrefslogtreecommitdiff
path: root/backend/php/src/plugins/IPlugin.php
Unidiff
Diffstat (limited to 'backend/php/src/plugins/IPlugin.php') (more/less context) (ignore whitespace changes)
-rw-r--r--backend/php/src/plugins/IPlugin.php48
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 @@
1<?php
2/**
3 * All functions must be implemented to create a correct POG plugin
4 * The 'optional' functions SetupRender() and AuthorPage() must be implemented and return null
5 * if your plugin does not need them.
6 *
7 */
8interface POG_Plugin
9{
10 /**
11 *
12 * REQUIRED
13 * This function must return the version of the plugin.
14 * It will be used to automatically notify developer when your plugin is updated.
15 *
16 */
17 function Version();
18
19 /**
20 *
21 * REQUIRED
22 * This function performs the actions that your plugin provides.
23 *
24 */
25 function Execute();
26
27 /**
28 * 'OPTIONAL'
29 * If your plugin needs an administrative interface, implement this function.
30 * Else return null
31 *
32 */
33 function SetupRender();
34
35
36 /**
37 *
38 * 'OPTIONAL'
39 * Implement this function to provide a link to your homepage.
40 * e.g. return 'http://myhomepage.com';
41 *
42 * return null if you do not want to link to your homepage
43 * e.g. return null
44 *
45 */
46 function AuthorPage();
47}
48?> \ No newline at end of file