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/Models/SoteriaModel.php

Doc Comments +1 added lines, -1 removed lines

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

src/Classes/Url.php

Doc Comments +3 added lines

@@ -31,6 +31,9 @@
         $this->standardUrlRegEx = '/' . $standardUrlRegEx . '/i';
     }
 
+    /**
+     * @param string $str
+     */
     function remove($str)
     {
         return preg_replace($this->standardUrlRegEx, ' ', $str);

src/Handlers/Sanitise.php

Doc Comments +3 added lines, -3 removed lines

@@ -98,7 +98,7 @@ 
     }
 
     /**
-     * @param $data
+     * @param string $data
      * @param string $type
      * @param int $stringLength
      * @return mixed|string
@@ -168,7 +168,7 @@ 
 
 
     /**
-     * @return null
+     * @return null|boolean
      */
     public function isSanitised()
     {
@@ -177,7 +177,7 @@ 
 
     /**
      * Returns true if the data is valid
-     * @return null
+     * @return boolean
      */
     public function isValid()
     {

src/voku/Resources/Utf8.php

Doc Comments +24 added lines, -3 removed lines

@@ -187,7 +187,7 @@ 
     }
 
     /**
-     * @param $file
+     * @param string $file
      * @return mixed
      */
     private function getData($file)
@@ -197,9 +197,9 @@ 
 
     /**
      * @param $str
-     * @param null $flags
+     * @param integer $flags
      * @param string $encoding
-     * @return bool|false|string|string[]|null
+     * @return string
      */
     private function htmlEntityDecode($str, $flags = null, $encoding = 'UTF-8')
     {
@@ -511,6 +511,9 @@ 
         return $buf;
     }
 
+    /**
+     * @param string $input
+     */
     private function toUtf8ConvertHelper($input)
     {
         // init
@@ -540,6 +543,9 @@ 
         return $buf;
     }
 
+    /**
+     * @param integer $code_point
+     */
     private function chr($code_point, $encoding = 'UTF-8')
     {
         // init
@@ -635,6 +641,9 @@ 
         return $CHAR_CACHE[$cacheKey] = $chr;
     }
 
+    /**
+     * @return string
+     */
     private function encode($toEncoding, $str)
     {
         if ($str === '' || $toEncoding === '') {
@@ -802,6 +811,9 @@ 
         return $var;
     }
 
+    /**
+     * @param string $str
+     */
     private function normalizeLineEnding($str)
     {
         return str_replace(["\r\n", "\r"], "\n", $str);
@@ -858,6 +870,9 @@ 
         );
     }
 
+    /**
+     * @param string $char
+     */
     private function singleChrHtmlEncode($char, $keepAsciiChars = false, $encoding = 'UTF-8')
     {
         if ($char === '') {
@@ -1049,11 +1064,17 @@ 
         return $ret;
     }
 
+    /**
+     * @param integer $int
+     */
     private function decimalToChr($int)
     {
         return $this->htmlEntityDecode('&#' . $int . ';', \ENT_QUOTES | \ENT_HTML5);
     }
 
+    /**
+     * @return string
+     */
     private function clean($str, $remove_bom = false, $normalize_whitespace = false, $normalize_msword = false, $keep_non_breaking_space = false, $replace_diamond_question_mark = false, $remove_invisible_characters = true)
     {
         // http://stackoverflow.com/questions/1401317/remove-non-utf8-characters-from-string