PHPDocs and some improvements

bin/gittool.php

@@ -206,12 +206,13 @@ public function cmd_repos() {
      * Install extension from the given download URL
      *
      * @param string $ext
-     * @return bool
+     * @return bool|null
      */
     private function downloadExtension($ext) {
         /** @var helper_plugin_extension_extension $plugin */
         $plugin = plugin_load('helper', 'extension_extension');
         if(!$ext) die("extension plugin not available, can't continue");
+
         $plugin->setExtension($ext);
 
         $url = $plugin->getDownloadURL();
@@ -297,6 +298,7 @@ private function getSourceRepo($extension) {
         /** @var helper_plugin_extension_extension $ext */
         $ext = plugin_load('helper', 'extension_extension');
         if(!$ext) die("extension plugin not available, can't continue");
+
         $ext->setExtension($extension);
 
         $repourl = $ext->getSourcerepoURL();

inc/Tar.class.php

@@ -53,6 +53,7 @@ class Tar {
 
     protected $file = '';
     protected $comptype = Tar::COMPRESS_AUTO;
+    /** @var  resource|int */
     protected $fh;
     protected $memory = '';
     protected $closed = true;
@@ -530,7 +531,7 @@ protected function writeFileHeader($name, $uid, $gid, $perm, $size, $mtime, $typ
      * Decode the given tar file header
      *
      * @param string $block a 512 byte block containign the header data
-     * @return array|false
+     * @return false|array
      */
     protected function parseHeader($block) {
         if(!$block || strlen($block) != 512) return false;
@@ -633,8 +634,14 @@ public function filetype($file) {
     }
 }
 
+/**
+ * Class TarIOException
+ */
 class TarIOException extends Exception {
 }
 
+/**
+ * Class TarIllegalCompressionException
+ */
 class TarIllegalCompressionException extends Exception {
 }

inc/ZipLib.class.php

@@ -142,10 +142,10 @@ function add_dir($name) {
      *
      * @param string $data
      * @param string $name filename
-     * @param int $compact
+     * @param bool $compact
      * @return bool
      */
-    function add_File($data, $name, $compact = 1) {
+    function add_File($data, $name, $compact = true) {
         $name     = str_replace('\\', '/', $name);
         $dtime    = dechex($this->DosTime());
 

inc/auth.php

@@ -283,7 +283,7 @@ function auth_login($user, $pass, $sticky = false, $silent = false) {
  * @author Andreas Gohr <[email protected]>
  *
  * @param  string $token The authentication token
- * @return boolean true (or will exit on failure)
+ * @return boolean|null true (or will exit on failure)
  */
 function auth_validateToken($token) {
     if(!$token || $token != $_SESSION[DOKU_COOKIE]['auth']['token']) {

inc/common.php

@@ -1461,7 +1461,7 @@ function dformat($dt = null, $format = '') {
  * @author <ungu at terong dot com>
  * @link http://www.php.net/manual/en/function.date.php#54072
  *
- * @param int $int_date: current date in UNIX timestamp
+ * @param int $int_date current date in UNIX timestamp
  * @return string
  */
 function date_iso8601($int_date) {

inc/events.php

@@ -27,6 +27,9 @@ class Doku_Event {
 
     /**
      * event constructor
+     *
+     * @param string $name
+     * @param mixed $data
      */
     function Doku_Event($name, &$data) {
 
@@ -120,14 +123,18 @@ function trigger($action=null, $enablePrevent=true) {
      * stop any further processing of the event by event handlers
      * this function does not prevent the default action taking place
      */
-    function stopPropagation() { $this->_continue = false;  }
+    function stopPropagation() {
+        $this->_continue = false;
+    }
 
     /**
      * preventDefault
      *
      * prevent the default action taking place
      */
-    function preventDefault() { $this->_default = false;  }
+    function preventDefault() {
+        $this->_default = false;
+    }
 }
 
 /**

inc/parserutils.php

@@ -655,7 +655,7 @@ function p_render($mode,$instructions,&$info){
  * Figure out the correct renderer class to use for $mode,
  * instantiate and return it
  *
- * @param $mode string Mode of the renderer to get
+ * @param string $mode Mode of the renderer to get
  * @return null|Doku_Renderer The renderer
  *
  * @author Christopher Smith <[email protected]>

inc/plugin.php

@@ -60,15 +60,15 @@ function getPluginType() {
      * @return string  plugin name
      */
     function getPluginName() {
-        list($t, $p, $n) = explode('_', get_class($this), 4);
+        list(/* $t */, /* $p */, $n) = explode('_', get_class($this), 4);
         return $n;
     }
 
     /**
      * @return string  component name
      */
     function getPluginComponent() {
-        list($t, $p, $n, $c) = explode('_', get_class($this), 4);
+        list(/* $t */, /* $p */, /* $n */, $c) = explode('_', get_class($this), 4);
         return (isset($c)?$c:'');
     }
 

inc/template.php

@@ -1066,8 +1066,8 @@ function tpl_pagetitle($id = null, $ret = false) {
  *
  * @author Andreas Gohr <[email protected]>
  *
- * @param array  $tags tags to try
- * @param string $alt alternative output if no data was found
+ * @param array|string $tags tags to try
+ * @param string       $alt  alternative output if no data was found
  * @param null|string   $src the image src, uses global $SRC if not given
  * @return string
  */

inc/utf8.php

@@ -611,7 +611,7 @@ function utf8_unhtml($str, $entities=null) {
      * Decodes numeric HTML entities to their correct UTF-8 characters
      *
      * @param $ent string A numeric entity
-     * @return string
+     * @return string|false
      */
     function utf8_decode_numeric($ent) {
         switch ($ent[2]) {
@@ -657,7 +657,7 @@ function makeutf8($c) {
          * Decodes any HTML entity to it's correct UTF-8 char equivalent
          *
          * @param string $ent An entity
-         * @return string
+         * @return string|false
          */
         function decode($ent) {
             if ($ent[1] == '#') {

lib/exe/xmlrpc.php

@@ -23,6 +23,11 @@ function dokuwiki_xmlrpc_server(){
         $this->IXR_Server();
     }
 
+    /**
+     * @param string $methodname
+     * @param array $args
+     * @return IXR_Error|mixed
+     */
     function call($methodname, $args){
         try {
             $result = $this->remote->call($methodname, $args);

lib/plugins/admin.php

@@ -14,6 +14,10 @@
  */
 class DokuWiki_Admin_Plugin extends DokuWiki_Plugin {
 
+    /**
+     * @param string $language language code
+     * @return string
+     */
     function getMenuText($language) {
         $menutext = $this->getLang('menu');
         if (!$menutext) {
@@ -23,10 +27,14 @@ function getMenuText($language) {
         return $menutext;
     }
 
+    /**
+     * @return int
+     */
     function getMenuSort() {
         return 1000;
     }
 
+
     function handle() {
         trigger_error('handle() not implemented in '.get_class($this), E_USER_WARNING);
     }
@@ -35,10 +43,16 @@ function html() {
         trigger_error('html() not implemented in '.get_class($this), E_USER_WARNING);
     }
 
+    /**
+     * @return bool
+     */
     function forAdminOnly() {
         return true;
     }
 
+    /**
+     * @return array
+     */
     function getTOC(){
         return array();
     }

lib/plugins/authplain/_test/escaping.test.php

@@ -12,10 +12,11 @@
  * @group plugins
  */
 class helper_plugin_authplain_escaping_test extends DokuWikiTest {
- 
+
     protected $pluginsEnabled = array('authplain');
+    /** @var  auth_plugin_authplain */
     protected $auth;
- 
+
     protected function reloadUsers() {
         /* auth caches data loaded from file, but recreated object forces reload */
         $this->auth = new auth_plugin_authplain();

lib/plugins/config/settings/config.class.php

@@ -570,7 +570,7 @@ public function error() { return $this->_error; }
         /**
          * Returns caution
          *
-         * @return bool|string caution string, otherwise false for invalid caution
+         * @return false|string caution string, otherwise false for invalid caution
          */
         public function caution() {
             if (!empty($this->_caution)) {

lib/plugins/extension/admin.php

@@ -75,10 +75,10 @@ public function handle() {
                             case 'uninstall':
                                 $extension->setExtension($extname);
                                 $status = $extension->uninstall();
-                                if($status !== true) {
-                                    msg($status, -1);
-                                } else {
+                                if($status) {
                                     msg(sprintf($this->getLang('msg_delete_success'), hsc($extension->getDisplayName())), 1);
+                                } else {
+                                    msg(sprintf($this->getLang('msg_delete_failed'), hsc($extension->getDisplayName())), -1);
                                 }
                                 break;
                             case 'enable';

lib/plugins/extension/helper/repository.php

@@ -32,7 +32,7 @@ public function init() {
             $request_needed = false;
             foreach ($list as $name) {
                 $cache = new cache('##extension_manager##'.$name, '.repo');
-                $result = null;
+
                 if (!isset($this->loaded_extensions[$name]) && $this->hasAccess() && !$cache->useCache(array('age' => 3600 * 24))) {
                     $this->loaded_extensions[$name] = true;
                     $request_data['ext'][] = $name;
@@ -64,7 +64,7 @@ public function init() {
     public function hasAccess() {
         if ($this->has_access === null) {
             $cache = new cache('##extension_manager###hasAccess', '.repo');
-            $result = null;
+
             if (!$cache->useCache(array('age' => 3600 * 24, 'purge'=>1))) {
                 $httpclient = new DokuHTTPClient();
                 $httpclient->timeout = 5;
@@ -91,7 +91,7 @@ public function hasAccess() {
      */
     public function getData($name) {
         $cache = new cache('##extension_manager##'.$name, '.repo');
-        $result = null;
+
         if (!isset($this->loaded_extensions[$name]) && $this->hasAccess() && !$cache->useCache(array('age' => 3600 * 24))) {
             $this->loaded_extensions[$name] = true;
             $httpclient = new DokuHTTPClient();

lib/plugins/extension/lang/en/lang.php

@@ -69,7 +69,8 @@
 
 $lang['msg_enabled']                  = 'Plugin %s enabled';
 $lang['msg_disabled']                 = 'Plugin %s disabled';
-$lang['msg_delete_success']           = 'Extension uninstalled';
+$lang['msg_delete_success']           = 'Extension %s uninstalled';
+$lang['msg_delete_failed']            = 'Uninstalling Extension %s failed';
 $lang['msg_template_install_success'] = 'Template %s installed successfully';
 $lang['msg_template_update_success']  = 'Template %s updated successfully';
 $lang['msg_plugin_install_success']   = 'Plugin %s installed successfully';

lib/plugins/extension/lang/nl/lang.php

@@ -63,7 +63,7 @@
 $lang['status_bundled']        = 'Gebundeld';
 $lang['msg_enabled']           = 'Plugin %s ingeschakeld';
 $lang['msg_disabled']          = 'Plugin %s uitgeschakeld';
-$lang['msg_delete_success']    = 'Uitbreiding gedeinstalleerd';
+$lang['msg_delete_success']    = 'Uitbreiding %s gedeinstalleerd';
 $lang['msg_template_install_success'] = 'Template %s werd succesvol geïnstalleerd';
 $lang['msg_template_update_success'] = 'Template %s werd succesvol geüpdatet';
 $lang['msg_plugin_install_success'] = 'Plugin %s werd succesvol geïnstalleerd';