splitbrain / dokuwiki

inc/remote.php

Doc Comments +1 added lines, -1 removed lines

@@ -306,7 +306,7 @@
     /**
      * Transform file to xml
      *
-     * @param mixed $data
+     * @param string $data
      * @return mixed
      */
     public function toFile($data) {

inc/Tar.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -145,7 +145,7 @@
      * Reopen the file with open() again if you want to do additional operations
      *
      * @param string     $outdir  the target directory for extracting
-     * @param int|string $strip   either the number of path components or a fixed prefix to strip
+     * @param string $strip   either the number of path components or a fixed prefix to strip
      * @param string     $exclude a regular expression of files to exclude
      * @param string     $include a regular expression of files to include
      * @throws TarIOException

lib/plugins/auth.php

Doc Comments +3 added lines, -3 removed lines

@@ -183,7 +183,7 @@ 
      * @param   string  $user    Username
      * @param   string  $pass    Cleartext Password
      * @param   bool    $sticky  Cookie should not expire
-     * @return  bool             true on successful auth
+     * @return  boolean|null             true on successful auth
      */
     public function trustExternal($user, $pass, $sticky = false) {
         /* some example:
@@ -238,7 +238,7 @@ 
      * @author  Andreas Gohr <andi@splitbrain.org>
      * @param   string $user the user name
      * @param   bool $requireGroups whether or not the returned data must include groups
-     * @return  false|array containing user data or false
+     * @return  boolean containing user data or false
      */
     public function getUserData($user, $requireGroups=true) {
         if(!$this->cando['external']) msg("no valid authorisation system in use", -1);
@@ -291,7 +291,7 @@ 
      *
      * @author  Chris Smith <chris@jalakai.co.uk>
      * @param   array  $users
-     * @return  int    number of users deleted
+     * @return  boolean    number of users deleted
      */
     public function deleteUsers($users) {
         msg("authorisation method does not allow deleting of users", -1);

lib/plugins/authad/auth.php

Doc Comments +1 added lines, -1 removed lines

@@ -421,7 +421,7 @@
      * domain if no current one is available.
      *
      * @param string|null $domain The AD domain to use
-     * @return adLDAP|bool true if a connection was established
+     * @return string true if a connection was established
      */
     protected function _adldap($domain) {
         if(is_null($domain) && is_array($this->opts)) {

lib/plugins/authplain/auth.php

Doc Comments +5 added lines, -2 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();
@@ -205,7 +205,7 @@ 
      * Remove one or more users from the list of registered users
      *
      * @author  Christopher Smith <chris@jalakai.co.uk>
-     * @param   array  $users   array of users to be deleted
+     * @param   string[]  $users   array of users to be deleted
      * @return  int             the number of users deleted
      */
     public function deleteUsers($users) {
@@ -347,6 +347,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