diff options
author | Gerrit Uitslag <klapinklapin@gmail.com> | 2014-12-10 12:49:43 +0100 |
---|---|---|
committer | Gerrit Uitslag <klapinklapin@gmail.com> | 2014-12-10 12:49:43 +0100 |
commit | 52a281e8549d1a9269ce7ced1336a567086962c5 (patch) | |
tree | 9255538924d34bad30bf43a0f15afb9f84263c24 /lib/plugins/admin.php | |
parent | 192b8a107d82fab557bd9964d6c759b33663ab42 (diff) | |
download | rpg-52a281e8549d1a9269ce7ced1336a567086962c5.tar.gz rpg-52a281e8549d1a9269ce7ced1336a567086962c5.tar.bz2 |
Some PHPDocs media and admin plugin
Diffstat (limited to 'lib/plugins/admin.php')
-rw-r--r-- | lib/plugins/admin.php | 34 |
1 files changed, 26 insertions, 8 deletions
diff --git a/lib/plugins/admin.php b/lib/plugins/admin.php index d063af612..39dece453 100644 --- a/lib/plugins/admin.php +++ b/lib/plugins/admin.php @@ -15,10 +15,13 @@ if(!defined('DOKU_INC')) die(); class DokuWiki_Admin_Plugin extends DokuWiki_Plugin { /** + * Return the text that is displayed at the main admin menu + * (Default localized language string 'menu' is returned, override this function for setting another name) + * * @param string $language language code - * @return string + * @return string menu string */ - function getMenuText($language) { + public function getMenuText($language) { $menutext = $this->getLang('menu'); if (!$menutext) { $info = $this->getInfo(); @@ -28,32 +31,47 @@ class DokuWiki_Admin_Plugin extends DokuWiki_Plugin { } /** + * Determine position in list in admin window + * Lower values are sorted up + * * @return int */ - function getMenuSort() { + public function getMenuSort() { return 1000; } - - function handle() { + /** + * Carry out required processing + */ + public function handle() { trigger_error('handle() not implemented in '.get_class($this), E_USER_WARNING); } - function html() { + /** + * Output html of the admin page + */ + public function html() { trigger_error('html() not implemented in '.get_class($this), E_USER_WARNING); } /** + * Return true for access only by admins (config:superuser) or false if managers are allowed as well + * * @return bool */ - function forAdminOnly() { + public function forAdminOnly() { return true; } /** + * Return array with ToC items. Items can be created with the html_mktocitem() + * + * @see html_mktocitem() + * @see tpl_toc() + * * @return array */ - function getTOC(){ + public function getTOC(){ return array(); } } |