From 52a281e8549d1a9269ce7ced1336a567086962c5 Mon Sep 17 00:00:00 2001
From: Gerrit Uitslag <klapinklapin@gmail.com>
Date: Wed, 10 Dec 2014 12:49:43 +0100
Subject: [PATCH] Some PHPDocs media and admin plugin
---
inc/media.php | 14 +++++++-------
lib/plugins/admin.php | 34 ++++++++++++++++++++++++++--------
2 files changed, 33 insertions(+), 15 deletions(-)
diff --git a/inc/media.php b/inc/media.php
index c77f3f952..09bfc99ac 100644
--- a/inc/media.php
+++ b/inc/media.php
@@ -383,20 +383,20 @@ function copy_uploaded_file($from, $to){
* (The triggered event is preventable.)
*
* Event data:
- * $data[0] fn_tmp: the temporary file name (read from $_FILES)
- * $data[1] fn: the file name of the uploaded file
- * $data[2] id: the future directory id of the uploaded file
- * $data[3] imime: the mimetype of the uploaded file
+ * $data[0] fn_tmp: the temporary file name (read from $_FILES)
+ * $data[1] fn: the file name of the uploaded file
+ * $data[2] id: the future directory id of the uploaded file
+ * $data[3] imime: the mimetype of the uploaded file
* $data[4] overwrite: if an existing file is going to be overwritten
- * $data[5] move:
+ * $data[5] move: name of function that performs move/copy/..
*
* @triggers MEDIA_UPLOAD_FINISH
*
* @param array $file
- * @param string $id
+ * @param string $id media id
* @param bool $ow overwrite?
* @param int $auth permission level
- * @param string $move function name
+ * @param string $move name of functions that performs move/copy/..
* @return false|array|string
*/
function media_save($file, $id, $ow, $auth, $move) {
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();
}
}
--
GitLab