summaryrefslogtreecommitdiff
path: root/backend/php/src/plugins/IPlugin.php
blob: 3e39e70ad0723339fb55ddc4851d235c35aa967a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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();
}
?>