Classes/class-hook.php

   1 <?php
   2
   3 /* Hook Definitions
   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 */
   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_db" 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  */
  47 define('HOOKTYPE_PRE_OVERVIEW_CARD', 102);
  48
  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  *
  60 */
  61 define('HOOKTYPE_OVERVIEW_CARD', 103);
  62
  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);
  83
  84
  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
  99 /** HOOKTYPE_USER_LOOKUP
 100  * @param array $user [name, id]
 101  */
 102 define('HOOKTYPE_USER_LOOKUP', 107);
 103
 104 /** HOOKTYPE_USERMETA_ADD
 105  * @param array $meta [[id, key, value], (object)PanelUser]
 106  */
 107 define('HOOKTYPE_USERMETA_ADD', 108);
 108
 109 /** HOOKTYPE_USERMETA_ADD
 110  * @param array $meta [id, key, value]
 111  */
 112 define('HOOKTYPE_USERMETA_DEL', 109);
 113
 114 /** HOOKTYPE_USERMETA_ADD
 115  * @param array $meta [id, key, value]
 116  */
 117 define('HOOKTYPE_USERMETA_GET', 110);
 118
 119 /** HOOKTYPE_USER_CREATE
 120  * @param array $userinfo []
 121  */
 122 define('HOOKTYPE_USER_CREATE', 111);
 123
 124 /** HOOKTYPE_GET_USER_LIST
 125  * @param array $userlist []
 126  */
 127 define('HOOKTYPE_GET_USER_LIST', 112);
 128
 129 define('HOOKTYPE_USER_DELETE', 113);
 130
 131 define('HOOKTYPE_USER_LOGIN', 114);
 132
 133 define('HOOKTYPE_USER_LOGIN_FAIL', 115);
 134
 135 define('HOOKTYPE_USER_PERMISSION_LIST', 116);
 136
 137 define('HOOKTYPE_EDIT_USER', 117);
 138
 139 define('HOOKTYPE_RIGHTCLICK_MENU', 118);
 140
 141 define('HOOKTYPE_AUTH_MOD', 200);
 142
 143 /** An upgrade has been detected.
 144  * @param array $versioninfo[]
 145  * Array contains: "old_version" and "new_version"
 146  */
 147 define('HOOKTYPE_UPGRADE', 201);
 148
 149 /**
 150  *  Class for "Hook"
 151  * This is the main function which gets called whenever you want to use a Hook.
 152  *
 153  * Example:
 154  * Calling the Hook using a function:
 155  * Hook::func(HOOKTYPE_NAVBAR, 'bob');
 156  *
 157  * This Hook references the function 'bob', and will run this
 158  * function bob
 159  * {
 160  *      echo "We rehashed!";
 161  * }
 162  *
 163  * Example 2:
 164  * Calling the Hook using an initialized object class method:
 165  * Hook::func(HOOKTYPE_NAVBAR, [$this, 'method']);
 166  *
 167  * Example 3:
 168  * Calling the Hook using a static class method:
 169  * Hook::func(HOOKTYPE_NAVBAR, 'classname::method');
 170  *
 171  */
 172 class Hook {
 173
 174         /** A static list of Hooks and their associated functions */
 175         private static $actions = [];
 176
 177         /** Runs a Hook.
 178          * The parameter for $Hook should be a "HOOKTYPE_" as defined in hook.php
 179          * @param string $Hook The define or string name of the Hook. For example, HOOKTYPE_REHASH.
 180          * @param array &$args The array of information you are sending along in the Hook, so that other functions may see and modify things.
 181          * @return void Does not return anything.
 182          *
 183          */
 184         public static function run($Hook, &$args = array())
 185         {
 186                 if (!empty(self::$actions[$Hook]))
 187                         foreach (self::$actions[$Hook] as &$f)
 188                                 $f($args);
 189
 190         }
 191
 192         /** Calls a Hook
 193          * @param string $Hook The define or string name of the Hook. For example, HOOKTYPE_REHASH.
 194          * @param string|Closure $function This is a string reference to a Closure function or a class method.
 195          * @return void Does not return anything.
 196          */
 197         public static function func($Hook, $function)
 198         {
 199                 self::$actions[$Hook][] = $function;
 200         }
 201
 202         /** Deletes a Hook
 203          * @param string $Hook The Hook from which we are removing a function reference.
 204          * @param string $function The name of the function that we are removing.
 205          * @return void Does not reuturn anything.
 206          */
 207         public static function del($Hook, $function)
 208         {
 209                 for ($i = 0; isset(self::$actions[$Hook][$i]); $i++)
 210                         if (self::$actions[$Hook][$i] == $function)
 211                                 array_splice(self::$actions[$Hook],$i);
 212         }
 213 }