XOOPS / 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
      */
@@ -394,7 +394,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
      */
@@ -480,7 +480,7 @@ 
      * A quick solution for filtering XSS scripts
      *
      * @TODO : To be improved
-     * @param $text
+     * @param string $text
      * @return mixed
      */
     public function filterXss($text)
@@ -576,11 +576,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)
@@ -624,11 +624,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)
@@ -660,7 +660,7 @@ 
      * MyTextSanitizer::codePreConv()
      *
      * @param  mixed $text
-     * @param  mixed $xcode
+     * @param  integer $xcode
      * @return mixed
      */
     public function codePreConv($text, $xcode = 1)
@@ -696,8 +696,8 @@ 
      * MyTextSanitizer::codeConv()
      *
      * @param  mixed $text
-     * @param  mixed $xcode
-     * @return mixed
+     * @param  integer $xcode
+     * @return string
      */
     public function codeConv($text, $xcode = 1)
     {
@@ -713,7 +713,7 @@ 
     /**
      * MyTextSanitizer::executeExtensions()
      *
-     * @return bool
+     * @return boolean|null
      */
     public function executeExtensions()
     {
@@ -798,8 +798,8 @@ 
      * MyTextSanitizer::codeSanitizer()
      *
      * @param  mixed $str
-     * @param  mixed $image
-     * @return mixed|string
+     * @param  integer $image
+     * @return string
      */
     public function codeSanitizer($str, $image = 1)
     {
@@ -816,8 +816,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)
     {
@@ -847,8 +847,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)
     {
@@ -891,8 +891,8 @@ 
      * MyTextSanitizer::makeTboxData4Show()
      *
      * @param  mixed $text
-     * @param  mixed $smiley
-     * @return mixed|string
+     * @param  integer $smiley
+     * @return string
      */
     public function makeTboxData4Show($text, $smiley = 0)
     {
@@ -919,8 +919,8 @@ 
      * MyTextSanitizer::makeTboxData4Preview()
      *
      * @param  mixed $text
-     * @param  mixed $smiley
-     * @return mixed|string
+     * @param  integer $smiley
+     * @return string
      */
     public function makeTboxData4Preview($text, $smiley = 0)
     {
@@ -964,8 +964,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)
     {
@@ -994,8 +994,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)
     {