mambax7 / XoopsCore25

htdocs/class/module.textsanitizer.php

Doc Comments +31 added lines, -31 removed lines

@@ -222,7 +222,7 @@ 
     /**
      * Access the only instance of this class
      *
-     * @return object
+     * @return MyTextSanitizer
      * @static
      * @staticvar object
      */
@@ -395,7 +395,7 @@ 
      * Replace XoopsCodes with their equivalent HTML formatting
      *
      * @param  string   $text
-     * @param  bool|int $allowimage Allow images in the text?
+     * @param  integer $allowimage Allow images in the text?
      *                              On FALSE, uses links to images.
      * @return string
      */
@@ -481,7 +481,7 @@ 
      * A quick solution for filtering XSS scripts
      *
      * @TODO : To be improved
-     * @param $text
+     * @param string $text
      * @return mixed
      */
     public function filterXss($text)
@@ -577,11 +577,11 @@ 
      * Filters textarea form data in DB for display
      *
      * @param  string   $text
-     * @param  bool|int $html   allow html?
-     * @param  bool|int $smiley allow smileys?
-     * @param  bool|int $xcode  allow xoopscode?
-     * @param  bool|int $image  allow inline images?
-     * @param  bool|int $br     convert linebreaks?
+     * @param  integer $html   allow html?
+     * @param  integer $smiley allow smileys?
+     * @param  integer $xcode  allow xoopscode?
+     * @param  integer $image  allow inline images?
+     * @param  integer $br     convert linebreaks?
      * @return string
      */
     public function &displayTarea($text, $html = 0, $smiley = 1, $xcode = 1, $image = 1, $br = 1)
@@ -625,11 +625,11 @@ 
      * Filters textarea form data submitted for preview
      *
      * @param  string   $text
-     * @param  bool|int $html   allow html?
-     * @param  bool|int $smiley allow smileys?
-     * @param  bool|int $xcode  allow xoopscode?
-     * @param  bool|int $image  allow inline images?
-     * @param  bool|int $br     convert linebreaks?
+     * @param  integer $html   allow html?
+     * @param  integer $smiley allow smileys?
+     * @param  integer $xcode  allow xoopscode?
+     * @param  integer $image  allow inline images?
+     * @param  integer $br     convert linebreaks?
      * @return string
      */
     public function &previewTarea($text, $html = 0, $smiley = 1, $xcode = 1, $image = 1, $br = 1)
@@ -661,7 +661,7 @@ 
      * MyTextSanitizer::codePreConv()
      *
      * @param  mixed $text
-     * @param  mixed $xcode
+     * @param  integer $xcode
      * @return mixed
      */
     public function codePreConv($text, $xcode = 1)
@@ -697,8 +697,8 @@ 
      * MyTextSanitizer::codeConv()
      *
      * @param  mixed $text
-     * @param  mixed $xcode
-     * @return mixed
+     * @param  integer $xcode
+     * @return string
      */
     public function codeConv($text, $xcode = 1)
     {
@@ -714,7 +714,7 @@ 
     /**
      * MyTextSanitizer::executeExtensions()
      *
-     * @return bool
+     * @return boolean|null
      */
     public function executeExtensions()
     {
@@ -799,8 +799,8 @@ 
      * MyTextSanitizer::codeSanitizer()
      *
      * @param  mixed $str
-     * @param  mixed $image
-     * @return mixed|string
+     * @param  integer $image
+     * @return string
      */
     public function codeSanitizer($str, $image = 1)
     {
@@ -817,8 +817,8 @@ 
      * @param  mixed   $text
      * @param  integer $allowhtml
      * @param  integer $smiley
-     * @param  mixed   $bbcode
-     * @return mixed|string
+     * @param  integer   $bbcode
+     * @return string
      */
     public function sanitizeForDisplay($text, $allowhtml = 0, $smiley = 1, $bbcode = 1)
     {
@@ -848,8 +848,8 @@ 
      * @param  mixed   $text
      * @param  integer $allowhtml
      * @param  integer $smiley
-     * @param  mixed   $bbcode
-     * @return mixed|string
+     * @param  integer   $bbcode
+     * @return string
      */
     public function sanitizeForPreview($text, $allowhtml = 0, $smiley = 1, $bbcode = 1)
     {
@@ -892,8 +892,8 @@ 
      * MyTextSanitizer::makeTboxData4Show()
      *
      * @param  mixed $text
-     * @param  mixed $smiley
-     * @return mixed|string
+     * @param  integer $smiley
+     * @return string
      */
     public function makeTboxData4Show($text, $smiley = 0)
     {
@@ -920,8 +920,8 @@ 
      * MyTextSanitizer::makeTboxData4Preview()
      *
      * @param  mixed $text
-     * @param  mixed $smiley
-     * @return mixed|string
+     * @param  integer $smiley
+     * @return string
      */
     public function makeTboxData4Preview($text, $smiley = 0)
     {
@@ -965,8 +965,8 @@ 
      * @param  mixed   $text
      * @param  integer $html
      * @param  integer $smiley
-     * @param  mixed   $xcode
-     * @return mixed|string
+     * @param  integer   $xcode
+     * @return string
      */
     public function &makeTareaData4Show(&$text, $html = 1, $smiley = 1, $xcode = 1)
     {
@@ -995,8 +995,8 @@ 
      * @param  mixed   $text
      * @param  integer $html
      * @param  integer $smiley
-     * @param  mixed   $xcode
-     * @return mixed|string
+     * @param  integer   $xcode
+     * @return string
      */
     public function &makeTareaData4Preview(&$text, $html = 1, $smiley = 1, $xcode = 1)
     {

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/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))) {

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/class/userrank.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
 class SystemuserrankHandler extends XoopsPersistableObjectHandler
 {
     /**
-     * @param null|XoopsDatabase $db
+     * @param XoopsDatabase $db
      */
     public function __construct(XoopsDatabase $db)
     {

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
  */