XOOPS / XoopsCore25

htdocs/class/cache/xoopscache.php

Doc Comments +7 added lines, -7 removed lines

@@ -79,7 +79,7 @@ 
      * Tries to find and include a file for a cache engine and returns object instance
      *
      * @param  $name Name of the engine
-     * @return mixed $engine object or null
+     * @return boolean $engine object or null
      * @access private
      */
     private function loadEngine($name)
@@ -206,7 +206,7 @@ 
      *
      * @param  string $key       Identifier for the data
      * @param  mixed  $value     Data to be cached - anything except a resource
-     * @param  mixed  $duration  Optional - string configuration name OR how long to cache the data, either in seconds or a
+     * @param  string  $duration  Optional - string configuration name OR how long to cache the data, either in seconds or a
      *                           string that can be parsed by the strtotime() function OR array('config' => 'default', 'duration' => '3600')
      * @return boolean True if the data was successfully cached, false on failure
      * @access public
@@ -384,7 +384,7 @@ 
      * generates a safe key
      *
      * @param  string $key the key passed over
-     * @return mixed  string $key or false
+     * @return false|string  string $key or false
      * @access private
      */
     public function key($key)
@@ -449,7 +449,7 @@ 
      * @param  string $key      Identifier for the data
      * @param  mixed  $value    Data to be cached
      * @param  mixed  $duration How long to cache the data, in seconds
-     * @return boolean True if the data was successfully cached, false on failure
+     * @return boolean|null True if the data was successfully cached, false on failure
      * @access public
      */
     public function write($key, $value, $duration = null)
@@ -473,7 +473,7 @@ 
      * Delete a key from the cache
      *
      * @param  string $key Identifier for the data
-     * @return boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed
+     * @return boolean|null True if the value was successfully deleted, false if it didn't exist or couldn't be removed
      * @access public
      */
     public function delete($key)
@@ -484,7 +484,7 @@ 
      * Delete all keys from the cache
      *
      * @param  boolean $check if true will check expiration, otherwise delete all
-     * @return boolean True if the cache was successfully cleared, false otherwise
+     * @return boolean|null True if the cache was successfully cleared, false otherwise
      * @access public
      */
     public function clear($check)
@@ -494,7 +494,7 @@ 
     /**
      * Cache Engine settings
      *
-     * @return array settings
+     * @return integer settings
      * @access public
      */
     public function settings()

htdocs/class/xoopsform/grouppermform.php

Doc Comments +1 added lines, -1 removed lines

@@ -212,7 +212,7 @@
     /**
      * Constructor
      * @param      $caption
-     * @param      $name
+     * @param      string $name
      * @param      $groupId
      * @param null $values
      */

htdocs/class/xoopsmailer.php

Doc Comments +12 added lines, -12 removed lines

@@ -149,7 +149,7 @@ 
 
     // public
     /**
-     * @param null $value
+     * @param string $value
      */
     public function setTemplateDir($value = null)
     {
@@ -163,7 +163,7 @@ 
 
     // private
     /**
-     * @return bool|string
+     * @return string|false
      */
     public function getTemplatePath()
     {
@@ -187,7 +187,7 @@ 
 
     // public
     /**
-     * @param $value
+     * @param string $value
      */
     public function setTemplate($value)
     {
@@ -215,7 +215,7 @@ 
     // RMV-NOTIFY
     // public
     /**
-     * @param $user
+     * @param XoopsUser $user
      */
     public function setFromUser($user)
     {
@@ -235,7 +235,7 @@ 
 
     // public
     /**
-     * @param $value
+     * @param string $value
      */
     public function setSubject($value)
     {
@@ -244,7 +244,7 @@ 
 
     // public
     /**
-     * @param $value
+     * @param string $value
      */
     public function setBody($value)
     {
@@ -374,8 +374,8 @@ 
     // private
     /**
      * @param $uid
-     * @param $subject
-     * @param $body
+     * @param string $subject
+     * @param string $body
      *
      * @return bool
      */
@@ -402,9 +402,9 @@ 
      * Uses the new XoopsMultiMailer
      *
      * @param $email
-     * @param $subject
-     * @param $body
-     * @param $headers
+     * @param string $subject
+     * @param string $body
+     * @param string $headers
      *
      * @return bool
      */
@@ -572,7 +572,7 @@ 
     // abstract
     // to be overridden by lang specific mail class, if needed
     /**
-     * @param $text
+     * @param string $text
      *
      * @return mixed
      */

htdocs/install/class/dbmanager.php

Doc Comments +4 added lines, -4 removed lines

@@ -200,7 +200,7 @@ 
     }
 
     /**
-     * @param $sql
+     * @param string $sql
      *
      * @return mixed
      */
@@ -212,7 +212,7 @@ 
     }
 
     /**
-     * @param $table
+     * @param string $table
      *
      * @return mixed
      */
@@ -236,8 +236,8 @@ 
     }
 
     /**
-     * @param $table
-     * @param $query
+     * @param string $table
+     * @param string $query
      *
      * @return bool
      */

htdocs/kernel/configitem.php

Doc Comments +1 added lines, -1 removed lines

@@ -227,7 +227,7 @@
     /**
      * Assign one or more {@link XoopsConfigItemOption}s
      *
-     * @param mixed $option either a {@link XoopsConfigItemOption} object or an array of them
+     * @param XoopsConfigOption $option either a {@link XoopsConfigItemOption} object or an array of them
      */
     public function setConfOptions($option)
     {

htdocs/modules/system/class/menu.php

Doc Comments +1 added lines, -1 removed lines

@@ -50,7 +50,7 @@
     }
 
     /**
-     * @param        $value
+     * @param        string $value
      * @param string $name
      */
     public function addMenuTop($value, $name = '')

htdocs/modules/system/include/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -18,10 +18,10 @@ 
  *
  * Comment by Taiwen Jiang (a.k.a. phppp): THE METHOD IS NOT COMPLETE AND NOT SAFE. YOU ARE ENCOURAGED TO USE PHP'S NATIVE FILTER_VAR OR FILTER_INPUT FUNCTIONS DIRECTLY BEFORE WE MIGRATE TO XOOPS 3.
  * @param                   $global
- * @param                   $key
+ * @param                   string $key
  * @param  string           $default
  * @param  string           $type
- * @return int|mixed|string
+ * @return integer
  */
 function system_CleanVars(&$global, $key, $default = '', $type = 'int')
 {
@@ -103,7 +103,7 @@ 
 }
 
 /**
- * @param $img
+ * @param string $img
  *
  * @return mixed
  */

upgrade/upd-2.4.x-to-2.5.0/dbmanager.php

Doc Comments +4 added lines, -4 removed lines

@@ -200,7 +200,7 @@ 
     }
 
     /**
-     * @param $sql
+     * @param string $sql
      *
      * @return mixed
      */
@@ -212,7 +212,7 @@ 
     }
 
     /**
-     * @param $table
+     * @param string $table
      *
      * @return mixed
      */
@@ -236,8 +236,8 @@ 
     }
 
     /**
-     * @param $table
-     * @param $query
+     * @param string $table
+     * @param string $query
      *
      * @return bool
      */

htdocs/modules/system/class/fineuploadhandler.php

Doc Comments +4 added lines

@@ -62,6 +62,7 @@ 
 
     /**
      * Get the original filename
+     * @return string
      */
     public function getName()
     {
@@ -269,6 +270,9 @@ 
         }
     }
 
+    /**
+     * @param string $mimeType
+     */
     protected function storeUploadedFile($target, $mimeType, $uuid)
     {
         if (!is_dir(dirname($target))) {