devtoolboxuk / soteria

src/Handlers/Xss.php

Doc Comments +13 added lines, -3 removed lines

@@ -107,7 +107,7 @@ 
     /**
      * @param StringResource $str
      *
-     * @return mixed
+     * @return string
      */
     private function _do($str)
     {
@@ -176,6 +176,9 @@ 
         return $str;
     }
 
+    /**
+     * @param string $str
+     */
     public function decodeString($str)
     {
         // init
@@ -184,6 +187,10 @@ 
         if (strpos($str, '<') !== false && preg_match($regExForHtmlTags, $str, $matches) === 1) {
             $str = (string)preg_replace_callback(
                 $regExForHtmlTags,
+
+                /**
+                 * @param string $matches
+                 */
                 function ($matches) {
                     return $this->decodeEntity($matches);
                 },
@@ -222,7 +229,7 @@ 
     }
 
     /**
-     * @return null
+     * @return null|boolean
      */
     public function isXssFound()
     {
@@ -234,7 +241,7 @@ 
      *
      * @param StringResource $str
      *
-     * @return StringResource
+     * @return string
      */
     private function _entity_decode($str)
     {
@@ -337,6 +344,9 @@ 
         return $str;
     }
 
+    /**
+     * @param string $file
+     */
     private function _get_data($file)
     {
         /** @noinspection PhpIncludeInspection */

src/voku/Resources/Html.php

Doc Comments +7 added lines

@@ -13,6 +13,9 @@ 
         $this->_evil_html_tags = $evil->html();
     }
 
+    /**
+     * @param string $str
+     */
     public function naughtyHtml($str)
     {
         $evil_html_tags = implode('|', $this->_evil_html_tags);
@@ -20,6 +23,10 @@ 
 
         $str = (string)preg_replace_callback(
             '#<(?<start>/*\s*)(?<content>' . $evil_html_tags . ')(?<end>[^><]*)(?<rest>[><]*)#ius',
+
+            /**
+             * @param string $matches
+             */
             function ($matches) {
                 return $this->naughtyHtmlCallback($matches);
             },

src/voku/Resources/Utf8.php

Doc Comments +37 added lines, -2 removed lines

@@ -237,12 +237,20 @@ 
         return \str_replace($BROKEN_UTF8_TO_UTF8_KEYS_CACHE, $BROKEN_UTF8_TO_UTF8_VALUES_CACHE, $str);
     }
 
+    /**
+     * @param string $file
+     */
     private function getData($file)
     {
 
         return include __DIR__ . '/../Data/' . $file . '.php';
     }
 
+    /**
+     * @param integer $flags
+     *
+     * @return string
+     */
     private function html_entity_decode($str, $flags = null, $encoding = 'UTF-8')
     {
         if (
@@ -552,6 +560,9 @@ 
         return $buf;
     }
 
+    /**
+     * @param string $input
+     */
     private function to_utf8_convert_helper($input)
     {
         // init
@@ -581,6 +592,9 @@ 
         return $buf;
     }
 
+    /**
+     * @param integer $code_point
+     */
     private function chr($code_point, $encoding = 'UTF-8')
     {
         // init
@@ -676,6 +690,9 @@ 
         return $CHAR_CACHE[$cacheKey] = $chr;
     }
 
+    /**
+     * @return string
+     */
     private function encode($toEncoding, $str, $autodetectFromEncoding = true, $fromEncoding = '')
     {
         if ($str === '' || $toEncoding === '') {
@@ -843,6 +860,9 @@ 
         return $var;
     }
 
+    /**
+     * @param string $str
+     */
     private function normalize_line_ending($str)
     {
         return \str_replace(["\r\n", "\r"], "\n", $str);
@@ -899,6 +919,9 @@ 
         );
     }
 
+    /**
+     * @param string $char
+     */
     private function single_chr_html_encode($char, $keepAsciiChars = false, $encoding = 'UTF-8')
     {
         if ($char === '') {
@@ -1409,6 +1432,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $input
+     */
     private function is_binary($input, $strict = false)
     {
         $input = (string)$input;
@@ -1446,6 +1472,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $str
+     */
     private function get_file_type(
         $str,
         $fallback = [
@@ -1538,6 +1567,9 @@ 
         ];
     }
 
+    /**
+     * @param string $str
+     */
     private function is_utf16($str, $checkIfStringIsBinary = true)
     {
 
@@ -1620,7 +1652,7 @@ 
     /**
      * Check if the string is UTF-32.
      *
-     * @param mixed $str <p>The input string.</p>
+     * @param string $str <p>The input string.</p>
      * @param bool $checkIfStringIsBinary
      *
      * @return false|int
@@ -1698,7 +1730,7 @@ 
      *
      * @see    http://hsivonen.iki.fi/php-utf8/
      *
-     * @param string|string[] $str <p>The string to be checked.</p>
+     * @param string $str <p>The string to be checked.</p>
      * @param bool $strict <p>Check also if the string is not UTF-16 or UTF-32.</p>
      *
      * @return bool
@@ -2053,6 +2085,9 @@ 
         return $returnTmp;
     }
 
+    /**
+     * @param integer $int
+     */
     private function decimal_to_chr($int)
     {
         return $this->html_entity_decode('&#' . $int . ';', \ENT_QUOTES | \ENT_HTML5);