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)
     {
@@ -187,6 +187,9 @@ 
         return $str;
     }
 
+    /**
+     * @param string $str
+     */
     public function decodeString($str)
     {
         // init
@@ -195,6 +198,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);
                 },
@@ -233,7 +240,7 @@ 
     }
 
     /**
-     * @return null
+     * @return null|boolean
      */
     public function isXssFound()
     {
@@ -245,7 +252,7 @@ 
      *
      * @param StringResource $str
      *
-     * @return StringResource
+     * @return string
      */
     private function _entity_decode($str)
     {
@@ -348,6 +355,9 @@ 
         return $str;
     }
 
+    /**
+     * @param string $file
+     */
     private function _get_data($file)
     {
         /** @noinspection PhpIncludeInspection */

Unused Use Statements -2 removed lines

@@ -3,12 +3,10 @@
 namespace devtoolboxuk\soteria\handlers;
 
 use devtoolboxuk\soteria\voku\Resources\Attributes;
-
 use devtoolboxuk\soteria\voku\Resources\Exploded;
 use devtoolboxuk\soteria\voku\Resources\Html;
 use devtoolboxuk\soteria\voku\Resources\JavaScript;
 use devtoolboxuk\soteria\voku\Resources\NeverAllowed;
-
 use devtoolboxuk\soteria\voku\Resources\System;
 use devtoolboxuk\soteria\voku\Resources\Utf7;
 use devtoolboxuk\soteria\voku\Resources\Utf8;

src/voku/Resources/Attributes.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
         $this->_evil_attributes_regex = $evil->regEx();
     }
 
+    /**
+     * @param string $str
+     */
     public function removeEvilAttributes($str)
     {
         // replace style-attribute, first (if needed)

src/voku/Resources/Decode.php

Unused Use Statements -2 removed lines

@@ -2,8 +2,6 @@
 
 namespace devtoolboxuk\soteria\voku\Resources;
 
-use devtoolboxuk\soteria\handlers\XssClean;
-
 class Decode
 {
 

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/NeverAllowed.php

Doc Comments +3 added lines

@@ -310,6 +310,9 @@
         return $this->_never_allowed_str;
     }
 
+    /**
+     * @param string $str
+     */
     public function doNeverAllowedAfterwards($str)
     {
         if (\stripos($str, 'on') !== false) {

src/voku/Resources/Utf8.php

Doc Comments +32 added lines

@@ -257,6 +257,11 @@ 
         return include __DIR__ . '/../Data/' . $file . '.php';
     }
 
+    /**
+     * @param integer $flags
+     *
+     * @return string
+     */
     public function html_entity_decode($str, $flags = null, $encoding = 'UTF-8')
     {
         if (
@@ -601,6 +606,9 @@ 
         return $buf;
     }
 
+    /**
+     * @param string $input
+     */
     private function to_utf8_convert_helper($input)
     {
         // init
@@ -630,6 +638,9 @@ 
         return $buf;
     }
 
+    /**
+     * @param integer $code_point
+     */
     public function chr($code_point, $encoding = 'UTF-8')
     {
         // init
@@ -733,6 +744,9 @@ 
         return $CHAR_CACHE[$cacheKey] = $chr;
     }
 
+    /**
+     * @return string
+     */
     public function encode(
         $toEncoding,
         $str,
@@ -942,6 +956,9 @@ 
         return $var;
     }
 
+    /**
+     * @param string $str
+     */
     public function normalize_line_ending($str)
     {
         return \str_replace(["\r\n", "\r"], "\n", $str);
@@ -998,6 +1015,9 @@ 
         );
     }
 
+    /**
+     * @param string $char
+     */
     public function single_chr_html_encode($char, $keepAsciiChars = false, $encoding = 'UTF-8')
     {
         if ($char === '') {
@@ -1524,6 +1544,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $input
+     */
     public function is_binary($input, $strict = false)
     {
         $input = (string)$input;
@@ -1561,6 +1584,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $str
+     */
     public function get_file_type(
         $str,
         $fallback = [
@@ -1653,6 +1679,9 @@ 
         ];
     }
 
+    /**
+     * @param string $str
+     */
     public function is_utf16($str, $checkIfStringIsBinary = true)
     {
 
@@ -1742,6 +1771,9 @@ 
         );
     }
 
+    /**
+     * @param integer $int
+     */
     public function decimal_to_chr($int)
     {
         return $this->html_entity_decode('&#' . $int . ';', \ENT_QUOTES | \ENT_HTML5);