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

Unused Use Statements -2 removed lines

@@ -3,7 +3,6 @@ 
 namespace devtoolboxuk\soteria\handlers;
 
 use devtoolboxuk\soteria\models\SoteriaModel;
-
 use devtoolboxuk\soteriautf\Resources\Attributes;
 use devtoolboxuk\soteriautf\Resources\Exploded;
 use devtoolboxuk\soteriautf\Resources\Html;
@@ -11,7 +10,6 @@ 
 use devtoolboxuk\soteriautf\Resources\NeverAllowed;
 use devtoolboxuk\soteriautf\Resources\System;
 use devtoolboxuk\soteriautf\Resources\StringResource;
-
 use devtoolboxuk\soteriautf\Utf8;
 use devtoolboxuk\soteriautf\Utf7;
 

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 +5 added lines

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

src/Handlers/Sanitise.php

Doc Comments +3 added lines, -3 removed lines

@@ -30,7 +30,7 @@ 
      *
      * Removes URLs from strings
      *
-     * @param array|string $data
+     * @param string $data
      * @return array|string|string[]|null
      */
     public function removeUrl($data)
@@ -167,7 +167,7 @@ 
 
 
     /**
-     * @return null
+     * @return null|boolean
      */
     public function isSanitised()
     {
@@ -176,7 +176,7 @@ 
 
     /**
      * Returns true if the data is valid
-     * @return null
+     * @return boolean
      */
     public function isValid()
     {