]>
Commit | Line | Data |
---|---|---|
90dc8f2b VP |
1 | <?php |
2 | ||
440ff671 | 3 | /* Hook Definitions |
33f512fa VP |
4 | * |
5 | * Hooks let you do things in your plugin, like add nav items for your | |
6 | * own pages, add extra cards to the overview and more (to come) | |
7 | */ | |
440ff671 VP |
8 | /** HOOKTYPE_NAVBAR |
9 | * | |
10 | * @param array $pages | |
11 | * Receives an array of pages. For example: | |
12 | * $pages = ["Overview" => ""]; | |
13 | * | |
14 | * So when you call this hook, you must refer to the | |
15 | * parameter by reference. For example: | |
16 | * Hook::func(HOOKTYPE_NAVBAR, 'add_navbar_item'); | |
17 | * | |
18 | * function add_navbar_item(&$pages) // remember the & to use by reference | |
19 | * { insert_hacks_here(); } | |
20 | */ | |
21 | define('HOOKTYPE_NAVBAR', 100); | |
22 | ||
23 | /** HOOKTYPE_PRE_HEADER | |
24 | * | |
25 | * This doesn't receive anything, however you must still specify an | |
26 | * parameter for your hook function, because it's referring to memory. Sorry =] | |
27 | * | |
28 | * Currently this is only used by the "sql_auth" plugin by Valware in order to | |
29 | * redirect users immediately to the login page. | |
30 | * | |
31 | * Putting HTML in this hook is not a good idea. | |
32 | */ | |
33 | define('HOOKTYPE_PRE_HEADER', 101); | |
34 | ||
35 | /** HOOKTYPE_PRE_OVERVIEW_CARD | |
36 | * | |
37 | * @param object $stats | |
38 | * | |
39 | * This is called before the initial cards have loaded in the overview. | |
40 | * This lets you add your own HTML or whatever you like on the overview, | |
41 | * new cards, whatever. | |
42 | * | |
43 | * The parameter is an object containing stats used in the overview. | |
44 | * See "index.php" to see how it's used. | |
45 | * | |
46 | */ | |
440ff671 | 47 | define('HOOKTYPE_PRE_OVERVIEW_CARD', 102); |
33f512fa | 48 | |
440ff671 VP |
49 | /** HOOKTYPE_OVERVIEW_CARD |
50 | * | |
51 | * @param object $stats | |
52 | * | |
53 | * This is called after the initial cards have loaded in the overview. | |
54 | * This lets you add your own HTML or whatever you like on the overview, | |
55 | * new cards, whatever. | |
56 | * | |
57 | * The parameter is an object containing stats used in the overview. | |
58 | * See "index.php" to see how it's used. | |
59 | * | |
33f512fa VP |
60 | */ |
61 | define('HOOKTYPE_OVERVIEW_CARD', 103); | |
440ff671 | 62 | |
33f512fa VP |
63 | /** HOOKTYPE_NOTIFICATION |
64 | * | |
65 | * @param array $notification | |
66 | * The array should contain: | |
67 | * | |
68 | * "name" - The name of the recipient | |
69 | * "message" - The notification message | |
70 | * | |
71 | * This does not do anything special by itself. It simply allows plugins | |
72 | * to be able to use it with regards to notification sending. | |
73 | * This is not run at any place, but should be run from your plugin. | |
74 | * | |
75 | * This hook is simple in design and only contains two elements in attempt | |
76 | * to make it work cross-plugin. That is, if you have implemented your own | |
77 | * notificiation system, you will be able to do whatever you like such as | |
78 | * display a navbar list of notifications or send important emails by running | |
79 | * this hook. | |
80 | * | |
81 | */ | |
82 | define('HOOKTYPE_NOTIFICATION', 104); | |
0c2d6a6a | 83 | |
90dc8f2b | 84 | |
33f512fa VP |
85 | /** HOOKTYPE_PRE_FOOTER |
86 | * $param array $empty - Doesn't do anything | |
87 | * | |
88 | * This runs inside the footer body before anything else. | |
89 | */ | |
90 | define('HOOKTYPE_PRE_FOOTER', 105); | |
91 | ||
92 | /** HOOKTYPE_FOOTER | |
93 | * $param array $empty - Doesn't do anything | |
94 | * | |
95 | * This runs inside the footer body after everything else. | |
96 | */ | |
97 | define('HOOKTYPE_FOOTER', 106); | |
98 | ||
90dc8f2b VP |
99 | /** |
100 | * Class for "Hook" | |
101 | * This is the main function which gets called whenever you want to use a Hook. | |
102 | * | |
103 | * Example: | |
104 | * Calling the Hook using a function: | |
105 | * Hook::func(HOOKTYPE_NAVBAR, 'bob'); | |
106 | * | |
107 | * This Hook references the function 'bob', and will run this | |
108 | * function bob | |
109 | * { | |
110 | * echo "We rehashed!"; | |
111 | * } | |
112 | * | |
113 | * Example 2: | |
114 | * Calling the Hook using an initialized object class method: | |
115 | * Hook::func(HOOKTYPE_NAVBAR, [$this, 'method']); | |
116 | * | |
117 | * Example 3: | |
118 | * Calling the Hook using a static class method: | |
fe2a6f27 | 119 | * Hook::func(HOOKTYPE_NAVBAR, 'classname::method'); |
90dc8f2b VP |
120 | * |
121 | */ | |
122 | class Hook { | |
123 | ||
124 | /** A static list of Hooks and their associated functions */ | |
125 | private static $actions = []; | |
126 | ||
127 | /** Runs a Hook. | |
128 | * The parameter for $Hook should be a "HOOKTYPE_" as defined in hook.php | |
129 | * @param string $Hook The define or string name of the Hook. For example, HOOKTYPE_REHASH. | |
130 | * @param array &$args The array of information you are sending along in the Hook, so that other functions may see and modify things. | |
131 | * @return void Does not return anything. | |
132 | * | |
133 | */ | |
134 | public static function run($Hook, &$args = array()) | |
135 | { | |
371aa651 VP |
136 | if (!empty(self::$actions[$Hook])) |
137 | foreach (self::$actions[$Hook] as &$f) | |
138 | $f($args); | |
139 | ||
90dc8f2b VP |
140 | } |
141 | ||
142 | /** Calls a Hook | |
143 | * @param string $Hook The define or string name of the Hook. For example, HOOKTYPE_REHASH. | |
144 | * @param string|Closure $function This is a string reference to a Closure function or a class method. | |
145 | * @return void Does not return anything. | |
146 | */ | |
147 | public static function func($Hook, $function) | |
371aa651 | 148 | { |
90dc8f2b VP |
149 | self::$actions[$Hook][] = $function; |
150 | } | |
151 | ||
152 | /** Deletes a Hook | |
153 | * @param string $Hook The Hook from which we are removing a function reference. | |
154 | * @param string $function The name of the function that we are removing. | |
155 | * @return void Does not reuturn anything. | |
156 | */ | |
157 | ||
158 | public static function del($Hook, $function) | |
371aa651 | 159 | { |
90dc8f2b | 160 | for ($i = 0; isset(self::$actions[$Hook][$i]); $i++) |
371aa651 VP |
161 | if (self::$actions[$Hook][$i] == $function) |
162 | array_splice(self::$actions[$Hook],$i); | |
90dc8f2b VP |
163 | } |
164 | } |