devtoolboxuk / soteria

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