Commit | Line | Data |
---|---|---|
b62f8858 | 1 | <?php |
2 | /*************************************************************************** | |
179afa7f | 3 | * Copyright (C) 2003-2008 Polytechnique.org * |
b62f8858 | 4 | * http://opensource.polytechnique.org/ * |
5 | * * | |
6 | * This program is free software; you can redistribute it and/or modify * | |
7 | * it under the terms of the GNU General Public License as published by * | |
8 | * the Free Software Foundation; either version 2 of the License, or * | |
9 | * (at your option) any later version. * | |
10 | * * | |
11 | * This program is distributed in the hope that it will be useful, * | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of * | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * | |
14 | * GNU General Public License for more details. * | |
15 | * * | |
16 | * You should have received a copy of the GNU General Public License * | |
17 | * along with this program; if not, write to the Free Software * | |
18 | * Foundation, Inc., * | |
19 | * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * | |
20 | ***************************************************************************/ | |
21 | ||
bf517daf | 22 | abstract class PLModule |
b62f8858 | 23 | { |
bf517daf | 24 | abstract function handlers(); |
b62f8858 | 25 | |
bf517daf | 26 | /** Register a hook |
27 | * @param fun name of the handler (the exact name will be handler_$fun) | |
28 | * @param auth authentification level of needed to run this handler | |
29 | * @param perms permission required to run this handler | |
30 | * @param type additionnal flags | |
31 | * | |
32 | * Perms syntax is the following: | |
33 | * perms = rights(,rights)* | |
34 | * rights = right(:right)* | |
35 | * right is an atomic right permission (like 'admin', 'user', 'groupadmin', 'groupmember'...) | |
36 | * | |
37 | * If type is set to NO_AUTH, the system will return 403 instead of asking auth data | |
8fc4efa3 | 38 | * this is useful for Ajax handler |
39 | * If type is not set to NO_SKIN, the system will consider redirecting the user to https | |
bf517daf | 40 | */ |
41 | public function make_hook($fun, $auth, $perms = 'user', $type = DO_AUTH) | |
b62f8858 | 42 | { |
4a5fb34b | 43 | return array('hook' => array($this, 'handler_'.$fun), |
b62f8858 | 44 | 'auth' => $auth, |
4a5fb34b | 45 | 'perms' => $perms, |
b62f8858 | 46 | 'type' => $type); |
47 | } | |
48 | ||
49 | /* static functions */ | |
50 | ||
6995a9b9 | 51 | public static function factory($modname) |
b62f8858 | 52 | { |
1edb5aa5 FB |
53 | global $globals; |
54 | if ($modname == 'core') { | |
55 | $mod_path = $globals->spoolroot . '/core/modules/' . $modname . '.php'; | |
56 | } else { | |
57 | $mod_path = $globals->spoolroot . '/modules/' . $modname . '.php'; | |
58 | } | |
a18afbdc | 59 | $class = ucfirst($modname) . 'Module'; |
b62f8858 | 60 | |
61 | require_once $mod_path; | |
c807f50d | 62 | return new $class(); |
b62f8858 | 63 | } |
64 | } | |
65 | ||
a7de4ef7 | 66 | // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: |
b62f8858 | 67 | ?> |