devtoolboxuk / soteria

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

Unused Use Statements -2 removed lines

@@ -4,12 +4,10 @@
 
 use devtoolboxuk\soteria\models\SoteriaModel;
 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/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 +32 added lines

@@ -185,12 +185,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 htmlEntityDecode($str, $flags = null, $encoding = 'UTF-8')
     {
         if (
@@ -496,6 +504,9 @@ 
         return $buf;
     }
 
+    /**
+     * @param string $input
+     */
     private function toUtf8ConvertHelper($input)
     {
         // init
@@ -525,6 +536,9 @@ 
         return $buf;
     }
 
+    /**
+     * @param integer $code_point
+     */
     private function chr($code_point, $encoding = 'UTF-8')
     {
         // init
@@ -620,6 +634,9 @@ 
         return $CHAR_CACHE[$cacheKey] = $chr;
     }
 
+    /**
+     * @return string
+     */
     private function encode($toEncoding, $str)
     {
         if ($str === '' || $toEncoding === '') {
@@ -787,6 +804,9 @@ 
         return $var;
     }
 
+    /**
+     * @param string $str
+     */
     private function normalizeLineEnding($str)
     {
         return str_replace(["\r\n", "\r"], "\n", $str);
@@ -843,6 +863,9 @@ 
         );
     }
 
+    /**
+     * @param string $char
+     */
     private function singleChrHtmlEncode($char, $keepAsciiChars = false, $encoding = 'UTF-8')
     {
         if ($char === '') {
@@ -1349,6 +1372,9 @@ 
 //        return false;
 //    }
 
+    /**
+     * @param integer $int
+     */
     private function decimalToChr($int)
     {
         return $this->htmlEntityDecode('&#' . $int . ';', \ENT_QUOTES | \ENT_HTML5);
@@ -1502,6 +1528,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $input
+     */
     private function is_binary($input, $strict = false)
     {
         $input = (string)$input;
@@ -1539,6 +1568,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $str
+     */
     private function get_file_type(
         $str,
         $fallback = [

src/Handlers/Sanitise.php

Doc Comments +4 added lines, -4 removed lines

@@ -102,7 +102,7 @@ 
     }
 
     /**
-     * @param $data
+     * @param string $data
      * @param string $type
      * @param int $stringLength
      * @return mixed|string
@@ -171,7 +171,7 @@ 
     }
 
     /**
-     * @param $data
+     * @param string $data
      * @param int $length
      * @return bool|string
      */
@@ -187,7 +187,7 @@ 
 
 
     /**
-     * @return null
+     * @return null|boolean
      */
     public function isSanitised()
     {
@@ -196,7 +196,7 @@ 
 
     /**
      * Returns true if the data is valid
-     * @return null
+     * @return boolean
      */
     public function isValid()
     {

src/Models/SoteriaModel.php

Doc Comments +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getResult()
     {