xref: /dokuwiki/lib/plugins/admin.php (revision 71b40da27911263b852a9c60b0243b04e4802d08) 
1<?php
2/**
3 * Admin Plugin Prototype
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Christopher Smith <chris@jalakai.co.uk>
7 */
8// must be run within Dokuwiki
9if(!defined('DOKU_INC')) die();
10
11if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
12require_once(DOKU_INC.'inc/plugin.php');
13
14/**
15 * All DokuWiki plugins to extend the admin function
16 * need to inherit from this class
17 */
18class DokuWiki_Admin_Plugin extends DokuWiki_Plugin {
19
20    function getMenuText($language) {
21        $menutext = $this->getLang('menu');
22        if (!$menutext) {
23            $info = $this->getInfo();
24            $menutext = $info['name'].' ...';
25        }
26        return $menutext;
27    }
28
29    function getMenuSort() {
30        return 1000;
31    }
32
33    function handle() {
34        trigger_error('handle() not implemented in '.get_class($this), E_USER_WARNING);
35    }
36
37    function html() {
38        trigger_error('html() not implemented in '.get_class($this), E_USER_WARNING);
39    }
40
41    function forAdminOnly() {
42        return true;
43    }
44}
45//Setup VIM: ex: et ts=4 enc=utf-8 :
46