summaryrefslogtreecommitdiff
path: root/backend/php/src/plugins/IPlugin.php
Side-by-side diff
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 @@
+<?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