splitbrain / dokuwiki

lib/plugins/authmysql/auth.php

Doc Comments +1 added lines, -1 removed lines

@@ -765,7 +765,7 @@
      * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
      *
      * @param  string $user  user's nick to get data for
-     * @return false|array false on error, user info on success
+     * @return string false on error, user info on success
      */
     protected function _retrieveUserInfo($user) {
         $sql    = str_replace('%{user}', $this->_escape($user), $this->getConf('getUserInfo'));

lib/plugins/authplain/auth.php

Doc Comments +4 added lines, -1 removed lines

@@ -82,7 +82,7 @@ 
      * @author  Andreas Gohr <andi@splitbrain.org>
      * @param string $user
      * @param bool $requireGroups  (optional) ignored by this plugin, grps info always supplied
-     * @return array|false
+     * @return string
      */
     public function getUserData($user, $requireGroups=true) {
         if($this->users === null) $this->_loadUserData();
@@ -348,6 +348,9 @@ 
         }
     }
 
+    /**
+     * @param string $line
+     */
     protected function _splitUserData($line){
         // due to a bug in PCRE 6.6, preg_split will fail with the regex we use here
         // refer github issues 877 & 885

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

Doc Comments +2 added lines, -2 removed lines

@@ -174,7 +174,7 @@ 
          *
          * @param DokuWiki_Plugin $plugin object of config plugin
          * @param bool            $echo   true: show inputted value, when error occurred, otherwise the stored setting
-         * @return array with content array(string $label_html, string $input_html)
+         * @return string[] with content array(string $label_html, string $input_html)
          */
         function html(&$plugin, $echo=false) {
             global $lang;
@@ -283,7 +283,7 @@ 
          *
          * @param DokuWiki_Plugin $plugin object of config plugin
          * @param bool            $echo   true: show inputted value, when error occurred, otherwise the stored setting
-         * @return array with content array(string $label_html, string $input_html)
+         * @return string[] with content array(string $label_html, string $input_html)
          */
         function html(&$plugin, $echo=false) {
 

lib/plugins/info/syntax.php

Doc Comments +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
      * @param   int          $state   The lexer state for the match
      * @param   int          $pos     The character position of the matched text
      * @param   Doku_Handler $handler The Doku_Handler object
-     * @return  array Return an array with all data you want to use in render
+     * @return  string[] Return an array with all data you want to use in render
      */
     function handle($match, $state, $pos, Doku_Handler $handler){
         $match = substr($match,7,-2); //strip ~~INFO: from start and ~~ from end

lib/plugins/syntax.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
      * @param string          $format   output format being rendered
      * @param Doku_Renderer   $renderer the current renderer object
      * @param array           $data     data created by handler()
-     * @return  boolean                 rendered correctly? (however, returned value is not used at the moment)
+     * @return  boolean|null                 rendered correctly? (however, returned value is not used at the moment)
      */
     function render($format, Doku_Renderer $renderer, $data) {
         trigger_error('render() not implemented in '.get_class($this), E_USER_WARNING);

lib/plugins/usermanager/_test/csv_import.test.php

Doc Comments +4 added lines

@@ -43,6 +43,10 @@
         parent::tearDown();
     }
 
+    /**
+     * @param string $importCsv
+     * @param boolean $expectedResult
+     */
     function doImportTest($importCsv, $expectedResult, $expectedNewUsers, $expectedFailures) {
         global $auth;
         $before_users = $auth->retrieveUsers();

lib/plugins/usermanager/_test/mocks.class.php

Doc Comments +5 added lines

@@ -29,6 +29,7 @@ 
     /**
      * @deprecated    remove when dokuwiki requires php 5.3+
      *                also associated unit test & usermanager methods
+     * @param string $line
      */
     public function access_str_getcsv($line){
         return $this->str_getcsv($line);
@@ -51,6 +52,10 @@ 
 
 class auth_mock_authplain extends auth_plugin_authplain {
 
+    /**
+     * @param string $op
+     * @param boolean $canDo
+     */
     public function setCanDo($op, $canDo) {
         $this->cando[$op] = $canDo;
     }

lib/plugins/usermanager/admin.php

Doc Comments +1 added lines

@@ -1035,6 +1035,7 @@
      *
      * @param array  $user   data of user
      * @param string &$error reference catched error message
+     * @param string $error
      * @return bool whether successful
      */
     protected function _addImportUser($user, & $error){

lib/plugins/authpdo/auth.php

Doc Comments +2 added lines, -2 removed lines

@@ -204,7 +204,7 @@ 
      * @param  string $clear
      * @param  string $name
      * @param  string $mail
-     * @param  null|array $grps
+     * @param  string[] $grps
      * @return bool|null
      */
     public function createUser($user, $clear, $name, $mail, $grps = null) {
@@ -406,7 +406,7 @@ 
      * Return a count of the number of user which meet $filter criteria
      *
      * @param  array $filter array of field/pattern pairs, empty array for no filter
-     * @return int
+     * @return boolean
      */
     public function getUserCount($filter = array()) {
         if(is_null($filter)) $filter = array();