devtoolboxuk / soteria

src/voku/Resources/Utf8.php

Doc Comments +38 added lines, -6 removed lines

@@ -236,12 +236,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 (
@@ -551,6 +559,9 @@ 
         return $buf;
     }
 
+    /**
+     * @param string $input
+     */
     private function toUtf8ConvertHelper($input)
     {
         // init
@@ -580,6 +591,9 @@ 
         return $buf;
     }
 
+    /**
+     * @param integer $code_point
+     */
     private function chr($code_point, $encoding = 'UTF-8')
     {
         // init
@@ -675,6 +689,9 @@ 
         return $CHAR_CACHE[$cacheKey] = $chr;
     }
 
+    /**
+     * @return string
+     */
     private function encode($toEncoding, $str)
     {
         if ($str === '' || $toEncoding === '') {
@@ -842,6 +859,9 @@ 
         return $var;
     }
 
+    /**
+     * @param string $str
+     */
     private function normalize_line_ending($str)
     {
         return str_replace(["\r\n", "\r"], "\n", $str);
@@ -898,6 +918,9 @@ 
         );
     }
 
+    /**
+     * @param string $char
+     */
     private function singleChrHtmlEncode($char, $keepAsciiChars = false, $encoding = 'UTF-8')
     {
         if ($char === '') {
@@ -1404,6 +1427,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $input
+     */
     private function is_binary($input, $strict = false)
     {
         $input = (string)$input;
@@ -1441,6 +1467,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $str
+     */
     private function get_file_type(
         $str,
         $fallback = [
@@ -1533,6 +1562,9 @@ 
         ];
     }
 
+    /**
+     * @param string $str
+     */
     private function is_utf16($str, $checkIfStringIsBinary = true)
     {
 
@@ -1615,7 +1647,7 @@ 
     /**
      * Check if the string is UTF-32.
      *
-     * @param mixed $str <p>The input string.</p>
+     * @param string $str <p>The input string.</p>
      * @param bool $checkIfStringIsBinary
      *
      * @return false|int
@@ -1693,8 +1725,7 @@ 
      *
      * @see    http://hsivonen.iki.fi/php-utf8/
      *
-     * @param string|string[] $str <p>The string to be checked.</p>
-     * @param bool $strict <p>Check also if the string is not UTF-16 or UTF-32.</p>
+     * @param string $str <p>The string to be checked.</p>
      *
      * @return bool
      */
@@ -1922,9 +1953,7 @@ 
     }
 
     /**
-     * @param $str
-     * @param string $encoding
-     * @param bool $cleanUtf8
+     * @param string $str
      * @return bool|int
      */
     private function stringLength($str)
@@ -1971,6 +2000,9 @@ 
         return $returnTmp;
     }
 
+    /**
+     * @param integer $int
+     */
     private function decimalToChr($int)
     {
         return $this->htmlEntityDecode('&#' . $int . ';', \ENT_QUOTES | \ENT_HTML5);