UTF8::int_to_chr() - Code Metrics - Inspection of "[~]: optimize "UTF8::is_binary()" + more tests" - voku/portable-utf8 - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( d98de5...cd7fbc )

by Lars
created 2016-12-24 13:42 UTC
UTF8::int_to_chr() A

↳ Parent: UTF8
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
dl	0
loc	4
ccs	0
cts	1
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	2
<?php

namespace voku\helper;

use Symfony\Polyfill\Intl\Grapheme\Grapheme;
use Symfony\Polyfill\Xml\Xml;

/**
 * UTF8-Helper-Class
 *
 * @package voku\helper
 */
final class UTF8
{
  /**
   * @var array
   */
  private static $win1252ToUtf8 = array(
      128 => "\xe2\x82\xac", // EURO SIGN
      130 => "\xe2\x80\x9a", // SINGLE LOW-9 QUOTATION MARK
      131 => "\xc6\x92", // LATIN SMALL LETTER F WITH HOOK
      132 => "\xe2\x80\x9e", // DOUBLE LOW-9 QUOTATION MARK
      133 => "\xe2\x80\xa6", // HORIZONTAL ELLIPSIS
      134 => "\xe2\x80\xa0", // DAGGER
      135 => "\xe2\x80\xa1", // DOUBLE DAGGER
      136 => "\xcb\x86", // MODIFIER LETTER CIRCUMFLEX ACCENT
      137 => "\xe2\x80\xb0", // PER MILLE SIGN
      138 => "\xc5\xa0", // LATIN CAPITAL LETTER S WITH CARON
      139 => "\xe2\x80\xb9", // SINGLE LEFT-POINTING ANGLE QUOTE
      140 => "\xc5\x92", // LATIN CAPITAL LIGATURE OE
      142 => "\xc5\xbd", // LATIN CAPITAL LETTER Z WITH CARON
      145 => "\xe2\x80\x98", // LEFT SINGLE QUOTATION MARK
      146 => "\xe2\x80\x99", // RIGHT SINGLE QUOTATION MARK
      147 => "\xe2\x80\x9c", // LEFT DOUBLE QUOTATION MARK
      148 => "\xe2\x80\x9d", // RIGHT DOUBLE QUOTATION MARK
      149 => "\xe2\x80\xa2", // BULLET
      150 => "\xe2\x80\x93", // EN DASH
      151 => "\xe2\x80\x94", // EM DASH
      152 => "\xcb\x9c", // SMALL TILDE
      153 => "\xe2\x84\xa2", // TRADE MARK SIGN
      154 => "\xc5\xa1", // LATIN SMALL LETTER S WITH CARON
      155 => "\xe2\x80\xba", // SINGLE RIGHT-POINTING ANGLE QUOTE
      156 => "\xc5\x93", // LATIN SMALL LIGATURE OE
      158 => "\xc5\xbe", // LATIN SMALL LETTER Z WITH CARON
      159 => "\xc5\xb8", // LATIN CAPITAL LETTER Y WITH DIAERESIS
  );

  /**
   * @var array
   */
  private static $cp1252ToUtf8 = array(
      '' => '€',
      '' => '‚',
      '' => 'ƒ',
      '' => '„',
      '' => '…',
      '' => '†',
      '' => '‡',
      '' => 'ˆ',
      '' => '‰',
      '' => 'Š',
      '' => '‹',
      '' => 'Œ',
      '' => 'Ž',
      '' => '‘',
      '' => '’',
      '' => '“',
      '' => '”',
      '' => '•',
      '' => '–',
      '' => '—',
      '' => '˜',
      '' => '™',
      '' => 'š',
      '' => '›',
      '' => 'œ',
      '' => 'ž',
      '' => 'Ÿ',
  );

  /**
   * Bom => Byte-Length
   *
   * INFO: https://en.wikipedia.org/wiki/Byte_order_mark
   *
   * @var array
   */
  private static $bom = array(
      "\xef\xbb\xbf"     => 3, // UTF-8 BOM
      'ï»¿'              => 6, // UTF-8 BOM as "WINDOWS-1252" (one char has [maybe] more then one byte ...)
      "\x00\x00\xfe\xff" => 4, // UTF-32 (BE) BOM
      '  þÿ'             => 6, // UTF-32 (BE) BOM as "WINDOWS-1252"

      "\xff\xfe\x00\x00" => 4, // UTF-32 (LE) BOM
      'ÿþ  '             => 6, // UTF-32 (LE) BOM as "WINDOWS-1252"

      "\xfe\xff"         => 2, // UTF-16 (BE) BOM
      'þÿ'               => 4, // UTF-16 (BE) BOM as "WINDOWS-1252"

      "\xff\xfe"         => 2, // UTF-16 (LE) BOM
      'ÿþ'               => 4, // UTF-16 (LE) BOM as "WINDOWS-1252"

  );

  /**
   * Numeric code point => UTF-8 Character
   *
   * url: http://www.w3schools.com/charsets/ref_utf_punctuation.asp
   *
   * @var array
   */
  private static $whitespace = array(
    // NUL Byte
    0     => "\x0",
    // Tab
    9     => "\x9",
    // New Line
    10    => "\xa",
    // Vertical Tab
    11    => "\xb",
    // Carriage Return
    13    => "\xd",
    // Ordinary Space
    32    => "\x20",
    // NO-BREAK SPACE
    160   => "\xc2\xa0",
    // OGHAM SPACE MARK
    5760  => "\xe1\x9a\x80",
    // MONGOLIAN VOWEL SEPARATOR
    6158  => "\xe1\xa0\x8e",
    // EN QUAD
    8192  => "\xe2\x80\x80",
    // EM QUAD
    8193  => "\xe2\x80\x81",
    // EN SPACE
    8194  => "\xe2\x80\x82",
    // EM SPACE
    8195  => "\xe2\x80\x83",
    // THREE-PER-EM SPACE
    8196  => "\xe2\x80\x84",
    // FOUR-PER-EM SPACE
    8197  => "\xe2\x80\x85",
    // SIX-PER-EM SPACE
    8198  => "\xe2\x80\x86",
    // FIGURE SPACE
    8199  => "\xe2\x80\x87",
    // PUNCTUATION SPACE
    8200  => "\xe2\x80\x88",
    // THIN SPACE
    8201  => "\xe2\x80\x89",
    //HAIR SPACE
    8202  => "\xe2\x80\x8a",
    // LINE SEPARATOR
    8232  => "\xe2\x80\xa8",
    // PARAGRAPH SEPARATOR
    8233  => "\xe2\x80\xa9",
    // NARROW NO-BREAK SPACE
    8239  => "\xe2\x80\xaf",
    // MEDIUM MATHEMATICAL SPACE
    8287  => "\xe2\x81\x9f",
    // IDEOGRAPHIC SPACE
    12288 => "\xe3\x80\x80",
  );

  /**
   * @var array
   */
  private static $whitespaceTable = array(
      'SPACE'                     => "\x20",
      'NO-BREAK SPACE'            => "\xc2\xa0",
      'OGHAM SPACE MARK'          => "\xe1\x9a\x80",
      'EN QUAD'                   => "\xe2\x80\x80",
      'EM QUAD'                   => "\xe2\x80\x81",
      'EN SPACE'                  => "\xe2\x80\x82",
      'EM SPACE'                  => "\xe2\x80\x83",
      'THREE-PER-EM SPACE'        => "\xe2\x80\x84",
      'FOUR-PER-EM SPACE'         => "\xe2\x80\x85",
      'SIX-PER-EM SPACE'          => "\xe2\x80\x86",
      'FIGURE SPACE'              => "\xe2\x80\x87",
      'PUNCTUATION SPACE'         => "\xe2\x80\x88",
      'THIN SPACE'                => "\xe2\x80\x89",
      'HAIR SPACE'                => "\xe2\x80\x8a",
      'LINE SEPARATOR'            => "\xe2\x80\xa8",
      'PARAGRAPH SEPARATOR'       => "\xe2\x80\xa9",
      'ZERO WIDTH SPACE'          => "\xe2\x80\x8b",
      'NARROW NO-BREAK SPACE'     => "\xe2\x80\xaf",
      'MEDIUM MATHEMATICAL SPACE' => "\xe2\x81\x9f",
      'IDEOGRAPHIC SPACE'         => "\xe3\x80\x80",
  );

  /**
   * bidirectional text chars
   *
   * url: https://www.w3.org/International/questions/qa-bidi-unicode-controls
   *
   * @var array
   */
  private static $bidiUniCodeControlsTable = array(
    // LEFT-TO-RIGHT EMBEDDING (use -> dir = "ltr")
    8234 => "\xE2\x80\xAA",
    // RIGHT-TO-LEFT EMBEDDING (use -> dir = "rtl")
    8235 => "\xE2\x80\xAB",
    // POP DIRECTIONAL FORMATTING // (use -> </bdo>)
    8236 => "\xE2\x80\xAC",
    // LEFT-TO-RIGHT OVERRIDE // (use -> <bdo dir = "ltr">)
    8237 => "\xE2\x80\xAD",
    // RIGHT-TO-LEFT OVERRIDE // (use -> <bdo dir = "rtl">)
    8238 => "\xE2\x80\xAE",
    // LEFT-TO-RIGHT ISOLATE // (use -> dir = "ltr")
    8294 => "\xE2\x81\xA6",
    // RIGHT-TO-LEFT ISOLATE // (use -> dir = "rtl")
    8295 => "\xE2\x81\xA7",
    // FIRST STRONG ISOLATE // (use -> dir = "auto")
    8296 => "\xE2\x81\xA8",
    // POP DIRECTIONAL ISOLATE
    8297 => "\xE2\x81\xA9",
  );

  /**
   * @var array
   */
  private static $commonCaseFold = array(
      'ſ'            => 's',
      "\xCD\x85"     => 'ι',
      'ς'            => 'σ',
      "\xCF\x90"     => 'β',
      "\xCF\x91"     => 'θ',
      "\xCF\x95"     => 'φ',
      "\xCF\x96"     => 'π',
      "\xCF\xB0"     => 'κ',
      "\xCF\xB1"     => 'ρ',
      "\xCF\xB5"     => 'ε',
      "\xE1\xBA\x9B" => "\xE1\xB9\xA1",
      "\xE1\xBE\xBE" => 'ι',
  );

  /**
   * @var array
   */
  private static $brokenUtf8ToUtf8 = array(
      "\xc2\x80" => "\xe2\x82\xac", // EURO SIGN
      "\xc2\x82" => "\xe2\x80\x9a", // SINGLE LOW-9 QUOTATION MARK
      "\xc2\x83" => "\xc6\x92", // LATIN SMALL LETTER F WITH HOOK
      "\xc2\x84" => "\xe2\x80\x9e", // DOUBLE LOW-9 QUOTATION MARK
      "\xc2\x85" => "\xe2\x80\xa6", // HORIZONTAL ELLIPSIS
      "\xc2\x86" => "\xe2\x80\xa0", // DAGGER
      "\xc2\x87" => "\xe2\x80\xa1", // DOUBLE DAGGER
      "\xc2\x88" => "\xcb\x86", // MODIFIER LETTER CIRCUMFLEX ACCENT
      "\xc2\x89" => "\xe2\x80\xb0", // PER MILLE SIGN
      "\xc2\x8a" => "\xc5\xa0", // LATIN CAPITAL LETTER S WITH CARON
      "\xc2\x8b" => "\xe2\x80\xb9", // SINGLE LEFT-POINTING ANGLE QUOTE
      "\xc2\x8c" => "\xc5\x92", // LATIN CAPITAL LIGATURE OE
      "\xc2\x8e" => "\xc5\xbd", // LATIN CAPITAL LETTER Z WITH CARON
      "\xc2\x91" => "\xe2\x80\x98", // LEFT SINGLE QUOTATION MARK
      "\xc2\x92" => "\xe2\x80\x99", // RIGHT SINGLE QUOTATION MARK
      "\xc2\x93" => "\xe2\x80\x9c", // LEFT DOUBLE QUOTATION MARK
      "\xc2\x94" => "\xe2\x80\x9d", // RIGHT DOUBLE QUOTATION MARK
      "\xc2\x95" => "\xe2\x80\xa2", // BULLET
      "\xc2\x96" => "\xe2\x80\x93", // EN DASH
      "\xc2\x97" => "\xe2\x80\x94", // EM DASH
      "\xc2\x98" => "\xcb\x9c", // SMALL TILDE
      "\xc2\x99" => "\xe2\x84\xa2", // TRADE MARK SIGN
      "\xc2\x9a" => "\xc5\xa1", // LATIN SMALL LETTER S WITH CARON
      "\xc2\x9b" => "\xe2\x80\xba", // SINGLE RIGHT-POINTING ANGLE QUOTE
      "\xc2\x9c" => "\xc5\x93", // LATIN SMALL LIGATURE OE
      "\xc2\x9e" => "\xc5\xbe", // LATIN SMALL LETTER Z WITH CARON
      "\xc2\x9f" => "\xc5\xb8", // LATIN CAPITAL LETTER Y WITH DIAERESIS
      'Ã¼'       => 'ü',
      'Ã¤'       => 'ä',
      'Ã¶'       => 'ö',
      'Ã–'       => 'Ö',
      'ÃŸ'       => 'ß',
      'Ã '       => 'à',
      'Ã¡'       => 'á',
      'Ã¢'       => 'â',
      'Ã£'       => 'ã',
      'Ã¹'       => 'ù',
      'Ãº'       => 'ú',
      'Ã»'       => 'û',
      'Ã™'       => 'Ù',
      'Ãš'       => 'Ú',
      'Ã›'       => 'Û',
      'Ãœ'       => 'Ü',
      'Ã²'       => 'ò',
      'Ã³'       => 'ó',
      'Ã´'       => 'ô',
      'Ã¨'       => 'è',
      'Ã©'       => 'é',
      'Ãª'       => 'ê',
      'Ã«'       => 'ë',
      'Ã€'       => 'À',
      'Ã'       => 'Á',
      'Ã‚'       => 'Â',
      'Ãƒ'       => 'Ã',
      'Ã„'       => 'Ä',
      'Ã…'       => 'Å',
      'Ã‡'       => 'Ç',
      'Ãˆ'       => 'È',
      'Ã‰'       => 'É',
      'ÃŠ'       => 'Ê',
      'Ã‹'       => 'Ë',
      'ÃŒ'       => 'Ì',
      'Ã'       => 'Í',
      'ÃŽ'       => 'Î',
      'Ã'       => 'Ï',
      'Ã‘'       => 'Ñ',
      'Ã’'       => 'Ò',
      'Ã“'       => 'Ó',
      'Ã”'       => 'Ô',
      'Ã•'       => 'Õ',
      'Ã˜'       => 'Ø',
      'Ã¥'       => 'å',
      'Ã¦'       => 'æ',
      'Ã§'       => 'ç',
      'Ã¬'       => 'ì',
      'Ã­'       => 'í',
      'Ã®'       => 'î',
      'Ã¯'       => 'ï',
      'Ã°'       => 'ð',
      'Ã±'       => 'ñ',
      'Ãµ'       => 'õ',
      'Ã¸'       => 'ø',
      'Ã½'       => 'ý',
      'Ã¿'       => 'ÿ',
      'â‚¬'      => '€',
      'â€™'      => '’',
  );

  /**
   * @var array
   */
  private static $utf8ToWin1252 = array(
      "\xe2\x82\xac" => "\x80", // EURO SIGN
      "\xe2\x80\x9a" => "\x82", // SINGLE LOW-9 QUOTATION MARK
      "\xc6\x92"     => "\x83", // LATIN SMALL LETTER F WITH HOOK
      "\xe2\x80\x9e" => "\x84", // DOUBLE LOW-9 QUOTATION MARK
      "\xe2\x80\xa6" => "\x85", // HORIZONTAL ELLIPSIS
      "\xe2\x80\xa0" => "\x86", // DAGGER
      "\xe2\x80\xa1" => "\x87", // DOUBLE DAGGER
      "\xcb\x86"     => "\x88", // MODIFIER LETTER CIRCUMFLEX ACCENT
      "\xe2\x80\xb0" => "\x89", // PER MILLE SIGN
      "\xc5\xa0"     => "\x8a", // LATIN CAPITAL LETTER S WITH CARON
      "\xe2\x80\xb9" => "\x8b", // SINGLE LEFT-POINTING ANGLE QUOTE
      "\xc5\x92"     => "\x8c", // LATIN CAPITAL LIGATURE OE
      "\xc5\xbd"     => "\x8e", // LATIN CAPITAL LETTER Z WITH CARON
      "\xe2\x80\x98" => "\x91", // LEFT SINGLE QUOTATION MARK
      "\xe2\x80\x99" => "\x92", // RIGHT SINGLE QUOTATION MARK
      "\xe2\x80\x9c" => "\x93", // LEFT DOUBLE QUOTATION MARK
      "\xe2\x80\x9d" => "\x94", // RIGHT DOUBLE QUOTATION MARK
      "\xe2\x80\xa2" => "\x95", // BULLET
      "\xe2\x80\x93" => "\x96", // EN DASH
      "\xe2\x80\x94" => "\x97", // EM DASH
      "\xcb\x9c"     => "\x98", // SMALL TILDE
      "\xe2\x84\xa2" => "\x99", // TRADE MARK SIGN
      "\xc5\xa1"     => "\x9a", // LATIN SMALL LETTER S WITH CARON
      "\xe2\x80\xba" => "\x9b", // SINGLE RIGHT-POINTING ANGLE QUOTE
      "\xc5\x93"     => "\x9c", // LATIN SMALL LIGATURE OE
      "\xc5\xbe"     => "\x9e", // LATIN SMALL LETTER Z WITH CARON
      "\xc5\xb8"     => "\x9f", // LATIN CAPITAL LETTER Y WITH DIAERESIS
  );

  /**
   * @var array
   */
  private static $utf8MSWord = array(
      "\xc2\xab"     => '"', // « (U+00AB) in UTF-8
      "\xc2\xbb"     => '"', // » (U+00BB) in UTF-8
      "\xe2\x80\x98" => "'", // ‘ (U+2018) in UTF-8
      "\xe2\x80\x99" => "'", // ’ (U+2019) in UTF-8
      "\xe2\x80\x9a" => "'", // ‚ (U+201A) in UTF-8
      "\xe2\x80\x9b" => "'", // ‛ (U+201B) in UTF-8
      "\xe2\x80\x9c" => '"', // “ (U+201C) in UTF-8
      "\xe2\x80\x9d" => '"', // ” (U+201D) in UTF-8
      "\xe2\x80\x9e" => '"', // „ (U+201E) in UTF-8
      "\xe2\x80\x9f" => '"', // ‟ (U+201F) in UTF-8
      "\xe2\x80\xb9" => "'", // ‹ (U+2039) in UTF-8
      "\xe2\x80\xba" => "'", // › (U+203A) in UTF-8
      "\xe2\x80\x93" => '-', // – (U+2013) in UTF-8
      "\xe2\x80\x94" => '-', // — (U+2014) in UTF-8
      "\xe2\x80\xa6" => '...' // … (U+2026) in UTF-8
  );

  /**
   * @var array
   */
  private static $iconvEncoding = array(
      'ANSI_X3.4-1968',
      'ANSI_X3.4-1986',
      'ASCII',
      'CP367',
      'IBM367',
      'ISO-IR-6',
      'ISO646-US',
      'ISO_646.IRV:1991',
      'US',
      'US-ASCII',
      'CSASCII',
      'UTF-8',
      'ISO-10646-UCS-2',
      'UCS-2',
      'CSUNICODE',
      'UCS-2BE',
      'UNICODE-1-1',
      'UNICODEBIG',
      'CSUNICODE11',
      'UCS-2LE',
      'UNICODELITTLE',
      'ISO-10646-UCS-4',
      'UCS-4',
      'CSUCS4',
      'UCS-4BE',
      'UCS-4LE',
      'UTF-16',
      'UTF-16BE',
      'UTF-16LE',
      'UTF-32',
      'UTF-32BE',
      'UTF-32LE',
      'UNICODE-1-1-UTF-7',
      'UTF-7',
      'CSUNICODE11UTF7',
      'UCS-2-INTERNAL',
      'UCS-2-SWAPPED',
      'UCS-4-INTERNAL',
      'UCS-4-SWAPPED',
      'C99',
      'JAVA',
      'CP819',
      'IBM819',
      'ISO-8859-1',
      'ISO-IR-100',
      'ISO8859-1',
      'ISO_8859-1',
      'ISO_8859-1:1987',
      'L1',
      'LATIN1',
      'CSISOLATIN1',
      'ISO-8859-2',
      'ISO-IR-101',
      'ISO8859-2',
      'ISO_8859-2',
      'ISO_8859-2:1987',
      'L2',
      'LATIN2',
      'CSISOLATIN2',
      'ISO-8859-3',
      'ISO-IR-109',
      'ISO8859-3',
      'ISO_8859-3',
      'ISO_8859-3:1988',
      'L3',
      'LATIN3',
      'CSISOLATIN3',
      'ISO-8859-4',
      'ISO-IR-110',
      'ISO8859-4',
      'ISO_8859-4',
      'ISO_8859-4:1988',
      'L4',
      'LATIN4',
      'CSISOLATIN4',
      'CYRILLIC',
      'ISO-8859-5',
      'ISO-IR-144',
      'ISO8859-5',
      'ISO_8859-5',
      'ISO_8859-5:1988',
      'CSISOLATINCYRILLIC',
      'ARABIC',
      'ASMO-708',
      'ECMA-114',
      'ISO-8859-6',
      'ISO-IR-127',
      'ISO8859-6',
      'ISO_8859-6',
      'ISO_8859-6:1987',
      'CSISOLATINARABIC',
      'ECMA-118',
      'ELOT_928',
      'GREEK',
      'GREEK8',
      'ISO-8859-7',
      'ISO-IR-126',
      'ISO8859-7',
      'ISO_8859-7',
      'ISO_8859-7:1987',
      'ISO_8859-7:2003',
      'CSISOLATINGREEK',
      'HEBREW',
      'ISO-8859-8',
      'ISO-IR-138',
      'ISO8859-8',
      'ISO_8859-8',
      'ISO_8859-8:1988',
      'CSISOLATINHEBREW',
      'ISO-8859-9',
      'ISO-IR-148',
      'ISO8859-9',
      'ISO_8859-9',
      'ISO_8859-9:1989',
      'L5',
      'LATIN5',
      'CSISOLATIN5',
      'ISO-8859-10',
      'ISO-IR-157',
      'ISO8859-10',
      'ISO_8859-10',
      'ISO_8859-10:1992',
      'L6',
      'LATIN6',
      'CSISOLATIN6',
      'ISO-8859-11',
      'ISO8859-11',
      'ISO_8859-11',
      'ISO-8859-13',
      'ISO-IR-179',
      'ISO8859-13',
      'ISO_8859-13',
      'L7',
      'LATIN7',
      'ISO-8859-14',
      'ISO-CELTIC',
      'ISO-IR-199',
      'ISO8859-14',
      'ISO_8859-14',
      'ISO_8859-14:1998',
      'L8',
      'LATIN8',
      'ISO-8859-15',
      'ISO-IR-203',
      'ISO8859-15',
      'ISO_8859-15',
      'ISO_8859-15:1998',
      'LATIN-9',
      'ISO-8859-16',
      'ISO-IR-226',
      'ISO8859-16',
      'ISO_8859-16',
      'ISO_8859-16:2001',
      'L10',
      'LATIN10',
      'KOI8-R',
      'CSKOI8R',
      'KOI8-U',
      'KOI8-RU',
      'CP1250',
      'MS-EE',
      'WINDOWS-1250',
      'CP1251',
      'MS-CYRL',
      'WINDOWS-1251',
      'CP1252',
      'MS-ANSI',
      'WINDOWS-1252',
      'CP1253',
      'MS-GREEK',
      'WINDOWS-1253',
      'CP1254',
      'MS-TURK',
      'WINDOWS-1254',
      'CP1255',
      'MS-HEBR',
      'WINDOWS-1255',
      'CP1256',
      'MS-ARAB',
      'WINDOWS-1256',
      'CP1257',
      'WINBALTRIM',
      'WINDOWS-1257',
      'CP1258',
      'WINDOWS-1258',
      '850',
      'CP850',
      'IBM850',
      'CSPC850MULTILINGUAL',
      '862',
      'CP862',
      'IBM862',
      'CSPC862LATINHEBREW',
      '866',
      'CP866',
      'IBM866',
      'CSIBM866',
      'MAC',
      'MACINTOSH',
      'MACROMAN',
      'CSMACINTOSH',
      'MACCENTRALEUROPE',
      'MACICELAND',
      'MACCROATIAN',
      'MACROMANIA',
      'MACCYRILLIC',
      'MACUKRAINE',
      'MACGREEK',
      'MACTURKISH',
      'MACHEBREW',
      'MACARABIC',
      'MACTHAI',
      'HP-ROMAN8',
      'R8',
      'ROMAN8',
      'CSHPROMAN8',
      'NEXTSTEP',
      'ARMSCII-8',
      'GEORGIAN-ACADEMY',
      'GEORGIAN-PS',
      'KOI8-T',
      'CP154',
      'CYRILLIC-ASIAN',
      'PT154',
      'PTCP154',
      'CSPTCP154',
      'KZ-1048',
      'RK1048',
      'STRK1048-2002',
      'CSKZ1048',
      'MULELAO-1',
      'CP1133',
      'IBM-CP1133',
      'ISO-IR-166',
      'TIS-620',
      'TIS620',
      'TIS620-0',
      'TIS620.2529-1',
      'TIS620.2533-0',
      'TIS620.2533-1',
      'CP874',
      'WINDOWS-874',
      'VISCII',
      'VISCII1.1-1',
      'CSVISCII',
      'TCVN',
      'TCVN-5712',
      'TCVN5712-1',
      'TCVN5712-1:1993',
      'ISO-IR-14',
      'ISO646-JP',
      'JIS_C6220-1969-RO',
      'JP',
      'CSISO14JISC6220RO',
      'JISX0201-1976',
      'JIS_X0201',
      'X0201',
      'CSHALFWIDTHKATAKANA',
      'ISO-IR-87',
      'JIS0208',
      'JIS_C6226-1983',
      'JIS_X0208',
      'JIS_X0208-1983',
      'JIS_X0208-1990',
      'X0208',
      'CSISO87JISX0208',
      'ISO-IR-159',
      'JIS_X0212',
      'JIS_X0212-1990',
      'JIS_X0212.1990-0',
      'X0212',
      'CSISO159JISX02121990',
      'CN',
      'GB_1988-80',
      'ISO-IR-57',
      'ISO646-CN',
      'CSISO57GB1988',
      'CHINESE',
      'GB_2312-80',
      'ISO-IR-58',
      'CSISO58GB231280',
      'CN-GB-ISOIR165',
      'ISO-IR-165',
      'ISO-IR-149',
      'KOREAN',
      'KSC_5601',
      'KS_C_5601-1987',
      'KS_C_5601-1989',
      'CSKSC56011987',
      'EUC-JP',
      'EUCJP',
      'EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE',
      'CSEUCPKDFMTJAPANESE',
      'MS_KANJI',
      'SHIFT-JIS',
      'SHIFT_JIS',
      'SJIS',
      'CSSHIFTJIS',
      'CP932',
      'ISO-2022-JP',
      'CSISO2022JP',
      'ISO-2022-JP-1',
      'ISO-2022-JP-2',
      'CSISO2022JP2',
      'CN-GB',
      'EUC-CN',
      'EUCCN',
      'GB2312',
      'CSGB2312',
      'GBK',
      'CP936',
      'MS936',
      'WINDOWS-936',
      'GB18030',
      'ISO-2022-CN',
      'CSISO2022CN',
      'ISO-2022-CN-EXT',
      'HZ',
      'HZ-GB-2312',
      'EUC-TW',
      'EUCTW',
      'CSEUCTW',
      'BIG-5',
      'BIG-FIVE',
      'BIG5',
      'BIGFIVE',
      'CN-BIG5',
      'CSBIG5',
      'CP950',
      'BIG5-HKSCS:1999',
      'BIG5-HKSCS:2001',
      'BIG5-HKSCS',
      'BIG5-HKSCS:2004',
      'BIG5HKSCS',
      'EUC-KR',
      'EUCKR',
      'CSEUCKR',
      'CP949',
      'UHC',
      'CP1361',
      'JOHAB',
      'ISO-2022-KR',
      'CSISO2022KR',
      'CP856',
      'CP922',
      'CP943',
      'CP1046',
      'CP1124',
      'CP1129',
      'CP1161',
      'IBM-1161',
      'IBM1161',
      'CSIBM1161',
      'CP1162',
      'IBM-1162',
      'IBM1162',
      'CSIBM1162',
      'CP1163',
      'IBM-1163',
      'IBM1163',
      'CSIBM1163',
      'DEC-KANJI',
      'DEC-HANYU',
      '437',
      'CP437',
      'IBM437',
      'CSPC8CODEPAGE437',
      'CP737',
      'CP775',
      'IBM775',
      'CSPC775BALTIC',
      '852',
      'CP852',
      'IBM852',
      'CSPCP852',
      'CP853',
      '855',
      'CP855',
      'IBM855',
      'CSIBM855',
      '857',
      'CP857',
      'IBM857',
      'CSIBM857',
      'CP858',
      '860',
      'CP860',
      'IBM860',
      'CSIBM860',
      '861',
      'CP-IS',
      'CP861',
      'IBM861',
      'CSIBM861',
      '863',
      'CP863',
      'IBM863',
      'CSIBM863',
      'CP864',
      'IBM864',
      'CSIBM864',
      '865',
      'CP865',
      'IBM865',
      'CSIBM865',
      '869',
      'CP-GR',
      'CP869',
      'IBM869',
      'CSIBM869',
      'CP1125',
      'EUC-JISX0213',
      'SHIFT_JISX0213',
      'ISO-2022-JP-3',
      'BIG5-2003',
      'ISO-IR-230',
      'TDS565',
      'ATARI',
      'ATARIST',
      'RISCOS-LATIN1',
  );

  /**
   * @var array
   */
  private static $support = array();

  /**
   * __construct()
   */
  public function __construct()
  {
    self::checkForSupport();
  }

  /**
   * Return the character at the specified position: $str[1] like functionality.
   *
   * @param string $str <p>A UTF-8 string.</p>
   * @param int    $pos <p>The position of character to return.</p>
   *
   * @return string <p>Single Multi-Byte character.</p>
   */
  public static function access($str, $pos)
  {
    $str = (string)$str;
    $pos = (int)$pos;

    if (!isset($str[0])) {
      return '';
    }

    if ($pos < 0) {
      return '';
    }

    return self::substr($str, $pos, 1);
  }

  /**
   * Prepends UTF-8 BOM character to the string and returns the whole string.
   *
   * INFO: If BOM already existed there, the Input string is returned.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return string <p>The output string that contains BOM.</p>
   */
  public static function add_bom_to_string($str)
  {
    if (self::string_has_bom($str) === false) {
      $str = self::bom() . $str;
    }

    return $str;
  }

  /**
   * Convert binary into an string.
   *
   * @param mixed $bin 1|0
   *
   * @return string
   */
  public static function binary_to_str($bin)
  {
    if (!isset($bin[0])) {
      return '';
    }

    return pack('H*', base_convert($bin, 2, 16));
  }

  /**
   * Returns the UTF-8 Byte Order Mark Character.
   *
   * INFO: take a look at UTF8::$bom for e.g. UTF-16 and UTF-32 BOM values
   *
   * @return string UTF-8 Byte Order Mark
   */
  public static function bom()
  {
    return "\xef\xbb\xbf";
  }

  /**
   * @alias of UTF8::chr_map()
   *
   * @see   UTF8::chr_map()
   *
   * @param string|array $callback
   * @param string       $str
   *
   * @return array
   */
  public static function callback($callback, $str)
  {
    return self::chr_map($callback, $str);
  }

  /**
   * This method will auto-detect your server environment for UTF-8 support.
   *
   * INFO: You don't need to run it manually, it will be triggered if it's needed.
   */
  public static function checkForSupport()
  {
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {

      self::$support['already_checked_via_portable_utf8'] = true;

      // http://php.net/manual/en/book.mbstring.php
      self::$support['mbstring'] = self::mbstring_loaded();

      // http://php.net/manual/en/book.iconv.php
      self::$support['iconv'] = self::iconv_loaded();

      // http://php.net/manual/en/book.intl.php
      self::$support['intl'] = self::intl_loaded();

      // http://php.net/manual/en/class.intlchar.php
      self::$support['intlChar'] = self::intlChar_loaded();

      // http://php.net/manual/en/book.pcre.php
      self::$support['pcre_utf8'] = self::pcre_utf8_support();
    }
  }

  /**
   * Generates a UTF-8 encoded character from the given code point.
   *
   * INFO: opposite to UTF8::ord()
   *
   * @param int    $code_point <p>The code point for which to generate a character.</p>
   * @param string $encoding   [optional] <p>Default is UTF-8</p>
   *
   * @return string|null <p>Multi-Byte character, returns null on failure or empty input.</p>
   */
  public static function chr($code_point, $encoding = 'UTF-8')
  {
    $i = (int)$code_point;
    if ($i !== $code_point) {
      return null;
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    } elseif (self::$support['intlChar'] === true) {
      return \IntlChar::chr($code_point);
    }

    // use static cache, if there is no support for "IntlChar"
    static $cache = array();
    $cacheKey = $code_point . $encoding;
    if (isset($cache[$cacheKey]) === true) {
      return $cache[$cacheKey];
    }

    if (0x80 > $code_point %= 0x200000) {
      $str = chr($code_point);
    } elseif (0x800 > $code_point) {
      $str = chr(0xC0 | $code_point >> 6) .
             chr(0x80 | $code_point & 0x3F);
    } elseif (0x10000 > $code_point) {
      $str = chr(0xE0 | $code_point >> 12) .
             chr(0x80 | $code_point >> 6 & 0x3F) .
             chr(0x80 | $code_point & 0x3F);
    } else {
      $str = chr(0xF0 | $code_point >> 18) .
             chr(0x80 | $code_point >> 12 & 0x3F) .
             chr(0x80 | $code_point >> 6 & 0x3F) .
             chr(0x80 | $code_point & 0x3F);
    }

    if ($encoding !== 'UTF-8') {
      $str = \mb_convert_encoding($str, $encoding, 'UTF-8');
    }

    // add into static cache
    $cache[$cacheKey] = $str;

    return $str;
  }

  /**
   * Applies callback to all characters of a string.
   *
   * @param string|array $callback <p>The callback function.</p>
   * @param string       $str      <p>UTF-8 string to run callback on.</p>
   *
   * @return array <p>The outcome of callback.</p>
   */
  public static function chr_map($callback, $str)
  {
    $chars = self::split($str);

    return array_map($callback, $chars);
  }

  /**
   * Generates an array of byte length of each character of a Unicode string.
   *
   * 1 byte => U+0000  - U+007F
   * 2 byte => U+0080  - U+07FF
   * 3 byte => U+0800  - U+FFFF
   * 4 byte => U+10000 - U+10FFFF
   *
   * @param string $str <p>The original Unicode string.</p>
   *
   * @return array <p>An array of byte lengths of each character.</p>
   */
  public static function chr_size_list($str)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return array();
    }

    return array_map('strlen', self::split($str));
  }

  /**
   * Get a decimal code representation of a specific character.
   *
   * @param string $char <p>The input character.</p>
   *
   * @return int
   */
  public static function chr_to_decimal($char)
  {
    $char = (string)$char;
    $code = self::ord($char[0]);
    $bytes = 1;

    if (!($code & 0x80)) {
      // 0xxxxxxx
      return $code;
    }

    if (($code & 0xe0) === 0xc0) {
      // 110xxxxx
      $bytes = 2;
      $code &= ~0xc0;
    } elseif (($code & 0xf0) === 0xe0) {
      // 1110xxxx
      $bytes = 3;
      $code &= ~0xe0;
    } elseif (($code & 0xf8) === 0xf0) {
      // 11110xxx
      $bytes = 4;
      $code &= ~0xf0;
    }

    for ($i = 2; $i <= $bytes; $i++) {
      // 10xxxxxx
      $code = ($code << 6) + (self::ord($char[$i - 1]) & ~0x80);
    }

    return $code;
  }

  /**
   * Get hexadecimal code point (U+xxxx) of a UTF-8 encoded character.
   *
   * @param string $char <p>The input character</p>
   * @param string $pfix [optional]
   *
   * @return string <p>The code point encoded as U+xxxx<p>
   */
  public static function chr_to_hex($char, $pfix = 'U+')
  {
    if ($char === '&#0;') {
      $char = '';
    }

    return self::int_to_hex(self::ord($char), $pfix);
  }

  /**
   * alias for "UTF8::chr_to_decimal()"
   *
   * @see UTF8::chr_to_decimal()
   *
   * @param string $chr
   *
   * @return int
   */
  public static function chr_to_int($chr)
  {
    return self::chr_to_decimal($chr);
  }

  /**
   * Splits a string into smaller chunks and multiple lines, using the specified line ending character.
   *
   * @param string $body     <p>The original string to be split.</p>
   * @param int    $chunklen [optional] <p>The maximum character length of a chunk.</p>
   * @param string $end      [optional] <p>The character(s) to be inserted at the end of each chunk.</p>
   *
   * @return string <p>The chunked string</p>
   */
  public static function chunk_split($body, $chunklen = 76, $end = "\r\n")
  {
    return implode($end, self::split($body, $chunklen));
  }

  /**
   * Accepts a string and removes all non-UTF-8 characters from it + extras if needed.
   *
   * @param string $str                     <p>The string to be sanitized.</p>
   * @param bool   $remove_bom              [optional] <p>Set to true, if you need to remove UTF-BOM.</p>
   * @param bool   $normalize_whitespace    [optional] <p>Set to true, if you need to normalize the whitespace.</p>
   * @param bool   $normalize_msword        [optional] <p>Set to true, if you need to normalize MS Word chars e.g.: "…"
   *                                        => "..."</p>
   * @param bool   $keep_non_breaking_space [optional] <p>Set to true, to keep non-breaking-spaces, in combination with
   *                                        $normalize_whitespace</p>
   *
   * @return string <p>Clean UTF-8 encoded string.</p>
   */
  public static function clean($str, $remove_bom = false, $normalize_whitespace = false, $normalize_msword = false, $keep_non_breaking_space = false)
  {
    // http://stackoverflow.com/questions/1401317/remove-non-utf8-characters-from-string
    // caused connection reset problem on larger strings

    $regx = '/
      (
        (?: [\x00-\x7F]               # single-byte sequences   0xxxxxxx
        |   [\xC0-\xDF][\x80-\xBF]    # double-byte sequences   110xxxxx 10xxxxxx
        |   [\xE0-\xEF][\x80-\xBF]{2} # triple-byte sequences   1110xxxx 10xxxxxx * 2
        |   [\xF0-\xF7][\x80-\xBF]{3} # quadruple-byte sequence 11110xxx 10xxxxxx * 3
        ){1,100}                      # ...one or more times
      )
    | ( [\x80-\xBF] )                 # invalid byte in range 10000000 - 10111111
    | ( [\xC0-\xFF] )                 # invalid byte in range 11000000 - 11111111
    /x';
    $str = preg_replace($regx, '$1', $str);

    $str = self::replace_diamond_question_mark($str, '');
    $str = self::remove_invisible_characters($str);

    if ($normalize_whitespace === true) {
      $str = self::normalize_whitespace($str, $keep_non_breaking_space);
    }

    if ($normalize_msword === true) {
      $str = self::normalize_msword($str);
    }

    if ($remove_bom === true) {
      $str = self::remove_bom($str);
    }

    return $str;
  }

  /**
   * Clean-up a and show only printable UTF-8 chars at the end  + fix UTF-8 encoding.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return string
   */
  public static function cleanup($str)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    // fixed ISO <-> UTF-8 Errors
    $str = self::fix_simple_utf8($str);

    // remove all none UTF-8 symbols
    // && remove diamond question mark (�)
    // && remove remove invisible characters (e.g. "\0")
    // && remove BOM
    // && normalize whitespace chars (but keep non-breaking-spaces)
    $str = self::clean($str, true, true, false, true);

    return (string)$str;
  }

  /**
   * Accepts a string or a array of strings and returns an array of Unicode code points.
   *
   * INFO: opposite to UTF8::string()
   *
   * @param string|string[] $arg        <p>A UTF-8 encoded string or an array of such strings.</p>
   * @param bool            $u_style    <p>If True, will return code points in U+xxxx format,
   *                                    default, code points will be returned as integers.</p>
   *
   * @return array <p>The array of code points.</p>
   */
  public static function codepoints($arg, $u_style = false)
  {
    if (is_string($arg)) {
      $arg = self::split($arg);
    }

    $arg = array_map(
        array(
            '\\voku\\helper\\UTF8',
            'ord',
        ),
        $arg
    );

    if ($u_style) {
      $arg = array_map(
          array(
              '\\voku\\helper\\UTF8',
              'int_to_hex',
          ),
          $arg
      );
    }

    return $arg;
  }

  /**
   * Returns count of characters used in a string.
   *
   * @param string $str       <p>The input string.</p>
   * @param bool   $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return array <p>An associative array of Character as keys and
   *               their count as values.</p>
   */
  public static function count_chars($str, $cleanUtf8 = false)
  {
    return array_count_values(self::split($str, 1, $cleanUtf8));
  }

  /**
   * Converts a int-value into an UTF-8 character.
   *
   * @param int $int
   *
   * @return string
   */
  public static function decimal_to_chr($int)
  {
    if (Bootup::is_php('5.4') === true) {
      $flags = ENT_QUOTES | ENT_HTML5;
    } else {
      $flags = ENT_QUOTES;
    }

    return self::html_entity_decode('&#' . $int . ';', $flags);
  }

  /**
   * Encode a string with a new charset-encoding.
   *
   * INFO:  The different to "UTF8::utf8_encode()" is that this function, try to fix also broken / double encoding,
   *        so you can call this function also on a UTF-8 String and you don't mess the string.
   *
   * @param string $encoding <p>e.g. 'UTF-8', 'ISO-8859-1', etc.</p>
   * @param string $str      <p>The input string</p>
   * @param bool   $force    [optional] <p>Force the new encoding (we try to fix broken / double encoding for UTF-8)<br
   *                         /> otherwise we auto-detect the current string-encoding</p>
   *
   * @return string
   */
  public static function encode($encoding, $str, $force = true)
  {
    $str = (string)$str;
    $encoding = (string)$encoding;

    if (!isset($str[0], $encoding[0])) {
      return $str;
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    $encodingDetected = self::str_detect_encoding($str);

    if (
        $encodingDetected
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
        &&
        (
            $force === true
            ||
            $encodingDetected !== $encoding
        )
    ) {

      if (
          $encoding === 'UTF-8'
          &&
          (
              $force === true
              || $encodingDetected === 'UTF-8'
              || $encodingDetected === 'WINDOWS-1252'
              || $encodingDetected === 'ISO-8859-1'
          )
      ) {
        return self::to_utf8($str);
      }

      if (
          $encoding === 'ISO-8859-1'
          &&
          (
              $force === true
              || $encodingDetected === 'ISO-8859-1'
              || $encodingDetected === 'UTF-8'
          )
      ) {
        return self::to_iso8859($str);
      }

      if (

          $encoding !== 'UTF-8'
          &&
          $encoding !== 'WINDOWS-1252'
          &&
          self::$support['mbstring'] === false
      ) {
        trigger_error('UTF8::encode() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
      }

      $strEncoded = \mb_convert_encoding(
          $str,
          $encoding,
          $encodingDetected
      );

      if ($strEncoded) {
        return $strEncoded;
      }
    }

    return $str;
  }

  /**
   * Reads entire file into a string.
   *
   * WARNING: do not use UTF-8 Option ($convertToUtf8) for binary-files (e.g.: images) !!!
   *
   * @link http://php.net/manual/en/function.file-get-contents.php
   *
   * @param string        $filename      <p>
   *                                     Name of the file to read.
   *                                     </p>
   * @param int|null      $flags         [optional] <p>
   *                                     Prior to PHP 6, this parameter is called
   *                                     use_include_path and is a bool.
   *                                     As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
   *                                     to trigger include path
   *                                     search.
   *                                     </p>
   *                                     <p>
   *                                     The value of flags can be any combination of
   *                                     the following flags (with some restrictions), joined with the
   *                                     binary OR (|)
   *                                     operator.
   *                                     </p>
   *                                     <p>
   *                                     <table>
   *                                     Available flags
   *                                     <tr valign="top">
   *                                     <td>Flag</td>
   *                                     <td>Description</td>
   *                                     </tr>
   *                                     <tr valign="top">
   *                                     <td>
   *                                     FILE_USE_INCLUDE_PATH
   *                                     </td>
   *                                     <td>
   *                                     Search for filename in the include directory.
   *                                     See include_path for more
   *                                     information.
   *                                     </td>
   *                                     </tr>
   *                                     <tr valign="top">
   *                                     <td>
   *                                     FILE_TEXT
   *                                     </td>
   *                                     <td>
   *                                     As of PHP 6, the default encoding of the read
   *                                     data is UTF-8. You can specify a different encoding by creating a
   *                                     custom context or by changing the default using
   *                                     stream_default_encoding. This flag cannot be
   *                                     used with FILE_BINARY.
   *                                     </td>
   *                                     </tr>
   *                                     <tr valign="top">
   *                                     <td>
   *                                     FILE_BINARY
   *                                     </td>
   *                                     <td>
   *                                     With this flag, the file is read in binary mode. This is the default
   *                                     setting and cannot be used with FILE_TEXT.
   *                                     </td>
   *                                     </tr>
   *                                     </table>
   *                                     </p>
   * @param resource|null $context       [optional] <p>
   *                                     A valid context resource created with
   *                                     stream_context_create. If you don't need to use a
   *                                     custom context, you can skip this parameter by &null;.
   *                                     </p>
   * @param int|null      $offset        [optional] <p>
   *                                     The offset where the reading starts.
   *                                     </p>
   * @param int|null      $maxlen        [optional] <p>
   *                                     Maximum length of data read. The default is to read until end
   *                                     of file is reached.
   *                                     </p>
   * @param int           $timeout       <p>The time in seconds for the timeout.</p>
   *
   * @param boolean       $convertToUtf8 <strong>WARNING!!!</strong> <p>Maybe you can't use this option for e.g. images
   *                                     or pdf, because they used non default utf-8 chars</p>
   *
   * @return string <p>The function returns the read data or false on failure.</p>
   */
  public static function file_get_contents($filename, $flags = null, $context = null, $offset = null, $maxlen = null, $timeout = 10, $convertToUtf8 = true)
  {
    // init
    $timeout = (int)$timeout;
    $filename = filter_var($filename, FILTER_SANITIZE_STRING);

    if ($timeout && $context === null) {
      $context = stream_context_create(
          array(
              'http' =>
                  array(
                      'timeout' => $timeout,
                  ),
          )
      );
    }

    if (is_int($maxlen) === true) {
      $data = file_get_contents($filename, $flags, $context, $offset, $maxlen);
    } else {
      $data = file_get_contents($filename, $flags, $context, $offset);
    }

    // return false on error
    if ($data === false) {
      return false;
    }

    if ($convertToUtf8 === true) {
      $data = self::encode('UTF-8', $data, false);
      $data = self::cleanup($data);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    return $data;
  }

  /**
   * Checks if a file starts with BOM (Byte Order Mark) character.
   *
   * @param string $file_path <p>Path to a valid file.</p>
   *
   * @return bool <p><strong>true</strong> if the file has BOM at the start, <strong>false</strong> otherwise.</>
   */
  public static function file_has_bom($file_path)
  {
    return self::string_has_bom(file_get_contents($file_path));
  }

  /**
   * Normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
   *
   * @param mixed  $var
   * @param int    $normalization_form
   * @param string $leading_combining
   *
   * @return mixed
   */
  public static function filter($var, $normalization_form = 4 /* n::NFC */, $leading_combining = '◌')
  {
    switch (gettype($var)) {
      case 'array':

        foreach ($var as $k => $v) {
          /** @noinspection AlterInForeachInspection */
          $var[$k] = self::filter($v, $normalization_form, $leading_combining);
        }
        break;
      case 'object':

        foreach ($var as $k => $v) {
          $var->{$k} = self::filter($v, $normalization_form, $leading_combining);
        }
        break;
      case 'string':
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

        if (false !== strpos($var, "\r")) {
          // Workaround https://bugs.php.net/65732
          $var = str_replace(array("\r\n", "\r"), "\n", $var);
        }

        if (self::is_ascii($var) === false) {
          /** @noinspection PhpUndefinedClassInspection */
          if (\Normalizer::isNormalized($var, $normalization_form)) {
            $n = '-';
          } else {
            /** @noinspection PhpUndefinedClassInspection */
            $n = \Normalizer::normalize($var, $normalization_form);

            if (isset($n[0])) {
              $var = $n;
            } else {
              $var = self::encode('UTF-8', $var);
            }
          }

          if (
              $var[0] >= "\x80" && isset($n[0], $leading_combining[0])
              &&
              preg_match('/^\p{Mn}/u', $var)
          ) {
            // Prevent leading combining chars
            // for NFC-safe concatenations.
            $var = $leading_combining . $var;
          }
        }

        break;
    }

    return $var;
  }

  /**
   * "filter_input()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
   *
   * Gets a specific external variable by name and optionally filters it
   *
   * @link  http://php.net/manual/en/function.filter-input.php
   *
   * @param int    $type          <p>
   *                              One of <b>INPUT_GET</b>, <b>INPUT_POST</b>,
   *                              <b>INPUT_COOKIE</b>, <b>INPUT_SERVER</b>, or
   *                              <b>INPUT_ENV</b>.
   *                              </p>
   * @param string $variable_name <p>
   *                              Name of a variable to get.
   *                              </p>
   * @param int    $filter        [optional] <p>
   *                              The ID of the filter to apply. The
   *                              manual page lists the available filters.
   *                              </p>
   * @param mixed  $options       [optional] <p>
   *                              Associative array of options or bitwise disjunction of flags. If filter
   *                              accepts options, flags can be provided in "flags" field of array.
   *                              </p>
   *
   * @return mixed Value of the requested variable on success, <b>FALSE</b> if the filter fails,
   * or <b>NULL</b> if the <i>variable_name</i> variable is not set.
   * If the flag <b>FILTER_NULL_ON_FAILURE</b> is used, it
   * returns <b>FALSE</b> if the variable is not set and <b>NULL</b> if the filter fails.
   * @since 5.2.0
   */
  public static function filter_input($type, $variable_name, $filter = FILTER_DEFAULT, $options = null)

  {
    if (4 > func_num_args()) {
      $var = filter_input($type, $variable_name, $filter);
    } else {
      $var = filter_input($type, $variable_name, $filter, $options);
    }

    return self::filter($var);
  }

  /**
   * "filter_input_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
   *
   * Gets external variables and optionally filters them
   *
   * @link  http://php.net/manual/en/function.filter-input-array.php
   *
   * @param int   $type       <p>
   *                          One of <b>INPUT_GET</b>, <b>INPUT_POST</b>,
   *                          <b>INPUT_COOKIE</b>, <b>INPUT_SERVER</b>, or
   *                          <b>INPUT_ENV</b>.
   *                          </p>
   * @param mixed $definition [optional] <p>
   *                          An array defining the arguments. A valid key is a string
   *                          containing a variable name and a valid value is either a filter type, or an array
   *                          optionally specifying the filter, flags and options. If the value is an
   *                          array, valid keys are filter which specifies the
   *                          filter type,
   *                          flags which specifies any flags that apply to the
   *                          filter, and options which specifies any options that
   *                          apply to the filter. See the example below for a better understanding.
   *                          </p>
   *                          <p>
   *                          This parameter can be also an integer holding a filter constant. Then all values in the
   *                          input array are filtered by this filter.
   *                          </p>
   * @param bool  $add_empty  [optional] <p>
   *                          Add missing keys as <b>NULL</b> to the return value.
   *                          </p>
   *
   * @return mixed An array containing the values of the requested variables on success, or <b>FALSE</b>
   * on failure. An array value will be <b>FALSE</b> if the filter fails, or <b>NULL</b> if
   * the variable is not set. Or if the flag <b>FILTER_NULL_ON_FAILURE</b>
   * is used, it returns <b>FALSE</b> if the variable is not set and <b>NULL</b> if the filter
   * fails.
   * @since 5.2.0
   */
  public static function filter_input_array($type, $definition = null, $add_empty = true)

  {
    if (2 > func_num_args()) {
      $a = filter_input_array($type);
    } else {
      $a = filter_input_array($type, $definition, $add_empty);
    }

    return self::filter($a);
  }

  /**
   * "filter_var()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
   *
   * Filters a variable with a specified filter
   *
   * @link  http://php.net/manual/en/function.filter-var.php
   *
   * @param mixed $variable <p>
   *                        Value to filter.
   *                        </p>
   * @param int   $filter   [optional] <p>
   *                        The ID of the filter to apply. The
   *                        manual page lists the available filters.
   *                        </p>
   * @param mixed $options  [optional] <p>
   *                        Associative array of options or bitwise disjunction of flags. If filter
   *                        accepts options, flags can be provided in "flags" field of array. For
   *                        the "callback" filter, callable type should be passed. The
   *                        callback must accept one argument, the value to be filtered, and return
   *                        the value after filtering/sanitizing it.
   *                        </p>
   *                        <p>
   *                        <code>
   *                        // for filters that accept options, use this format
   *                        $options = array(
   *                        'options' => array(
   *                        'default' => 3, // value to return if the filter fails
   *                        // other options here
   *                        'min_range' => 0
   *                        ),
   *                        'flags' => FILTER_FLAG_ALLOW_OCTAL,
   *                        );
   *                        $var = filter_var('0755', FILTER_VALIDATE_INT, $options);
   *                        // for filter that only accept flags, you can pass them directly
   *                        $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
   *                        // for filter that only accept flags, you can also pass as an array
   *                        $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN,
   *                        array('flags' => FILTER_NULL_ON_FAILURE));
   *                        // callback validate filter
   *                        function foo($value)
   *                        {
   *                        // Expected format: Surname, GivenNames
   *                        if (strpos($value, ", ") === false) return false;
   *                        list($surname, $givennames) = explode(", ", $value, 2);
   *                        $empty = (empty($surname) || empty($givennames));
   *                        $notstrings = (!is_string($surname) || !is_string($givennames));
   *                        if ($empty || $notstrings) {
   *                        return false;
   *                        } else {
   *                        return $value;
   *                        }
   *                        }
   *                        $var = filter_var('Doe, Jane Sue', FILTER_CALLBACK, array('options' => 'foo'));
   *                        </code>
   *                        </p>
   *
   * @return mixed the filtered data, or <b>FALSE</b> if the filter fails.
   * @since 5.2.0
   */
  public static function filter_var($variable, $filter = FILTER_DEFAULT, $options = null)

  {
    if (3 > func_num_args()) {
      $variable = filter_var($variable, $filter);
    } else {
      $variable = filter_var($variable, $filter, $options);
    }

    return self::filter($variable);
  }

  /**
   * "filter_var_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
   *
   * Gets multiple variables and optionally filters them
   *
   * @link  http://php.net/manual/en/function.filter-var-array.php
   *
   * @param array $data       <p>
   *                          An array with string keys containing the data to filter.
   *                          </p>
   * @param mixed $definition [optional] <p>
   *                          An array defining the arguments. A valid key is a string
   *                          containing a variable name and a valid value is either a
   *                          filter type, or an
   *                          array optionally specifying the filter, flags and options.
   *                          If the value is an array, valid keys are filter
   *                          which specifies the filter type,
   *                          flags which specifies any flags that apply to the
   *                          filter, and options which specifies any options that
   *                          apply to the filter. See the example below for a better understanding.
   *                          </p>
   *                          <p>
   *                          This parameter can be also an integer holding a filter constant. Then all values in the
   *                          input array are filtered by this filter.
   *                          </p>
   * @param bool  $add_empty  [optional] <p>
   *                          Add missing keys as <b>NULL</b> to the return value.
   *                          </p>
   *
   * @return mixed An array containing the values of the requested variables on success, or <b>FALSE</b>
   * on failure. An array value will be <b>FALSE</b> if the filter fails, or <b>NULL</b> if
   * the variable is not set.
   * @since 5.2.0
   */
  public static function filter_var_array($data, $definition = null, $add_empty = true)

  {
    if (2 > func_num_args()) {
      $a = filter_var_array($data);
    } else {
      $a = filter_var_array($data, $definition, $add_empty);
    }

    return self::filter($a);
  }

  /**
   * Check if the number of unicode characters are not more than the specified integer.
   *
   * @param string $str      The original string to be checked.
   * @param int    $box_size The size in number of chars to be checked against string.
   *
   * @return bool true if string is less than or equal to $box_size, false otherwise.
   */
  public static function fits_inside($str, $box_size)
  {
    return (self::strlen($str) <= $box_size);
  }

  /**
   * Try to fix simple broken UTF-8 strings.
   *
   * INFO: Take a look at "UTF8::fix_utf8()" if you need a more advanced fix for broken UTF-8 strings.
   *
   * If you received an UTF-8 string that was converted from Windows-1252 as it was ISO-8859-1
   * (ignoring Windows-1252 chars from 80 to 9F) use this function to fix it.
   * See: http://en.wikipedia.org/wiki/Windows-1252
   *
   * @param string $str <p>The input string</p>
   *
   * @return string
   */
  public static function fix_simple_utf8($str)

  {
    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    static $BROKEN_UTF8_TO_UTF8_KEYS_CACHE = null;
    static $BROKEN_UTF8_TO_UTF8_VALUES_CACHE = null;

    if ($BROKEN_UTF8_TO_UTF8_KEYS_CACHE === null) {
      $BROKEN_UTF8_TO_UTF8_KEYS_CACHE = array_keys(self::$brokenUtf8ToUtf8);
      $BROKEN_UTF8_TO_UTF8_VALUES_CACHE = array_values(self::$brokenUtf8ToUtf8);
    }

    return str_replace($BROKEN_UTF8_TO_UTF8_KEYS_CACHE, $BROKEN_UTF8_TO_UTF8_VALUES_CACHE, $str);
  }

  /**
   * Fix a double (or multiple) encoded UTF8 string.
   *
   * @param string|string[] $str <p>You can use a string or an array of strings.</p>
   *
   * @return mixed
   */
  public static function fix_utf8($str)
  {
    if (is_array($str)) {

      /** @noinspection ForeachSourceInspection */
      foreach ($str as $k => $v) {
        /** @noinspection AlterInForeachInspection */
        /** @noinspection OffsetOperationsInspection */
        $str[$k] = self::fix_utf8($v);
      }

      return $str;
    }

    $last = '';
    while ($last !== $str) {
      $last = $str;
      $str = self::to_utf8(
          self::utf8_decode($str)
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
      );
    }

    return $str;
  }

  /**
   * Get character of a specific character.
   *
   * @param string $char
   *
   * @return string <p>'RTL' or 'LTR'</p>
   */
  public static function getCharDirection($char)
  {
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (self::$support['intlChar'] === true) {
      $tmpReturn = \IntlChar::charDirection($char);

      // from "IntlChar"-Class
      $charDirection = array(
          'RTL' => array(1, 13, 14, 15, 21),
          'LTR' => array(0, 11, 12, 20),
      );

      if (in_array($tmpReturn, $charDirection['LTR'], true)) {
        return 'LTR';
      } elseif (in_array($tmpReturn, $charDirection['RTL'], true)) {
        return 'RTL';
      }
    }

    $c = static::chr_to_decimal($char);

    if (!(0x5be <= $c && 0x10b7f >= $c)) {
      return 'LTR';
    }

    if (0x85e >= $c) {

      if (0x5be === $c ||
          0x5c0 === $c ||
          0x5c3 === $c ||
          0x5c6 === $c ||
          (0x5d0 <= $c && 0x5ea >= $c) ||
          (0x5f0 <= $c && 0x5f4 >= $c) ||
          0x608 === $c ||
          0x60b === $c ||
          0x60d === $c ||
          0x61b === $c ||
          (0x61e <= $c && 0x64a >= $c) ||
          (0x66d <= $c && 0x66f >= $c) ||
          (0x671 <= $c && 0x6d5 >= $c) ||
          (0x6e5 <= $c && 0x6e6 >= $c) ||
          (0x6ee <= $c && 0x6ef >= $c) ||
          (0x6fa <= $c && 0x70d >= $c) ||
          0x710 === $c ||
          (0x712 <= $c && 0x72f >= $c) ||
          (0x74d <= $c && 0x7a5 >= $c) ||
          0x7b1 === $c ||
          (0x7c0 <= $c && 0x7ea >= $c) ||
          (0x7f4 <= $c && 0x7f5 >= $c) ||
          0x7fa === $c ||
          (0x800 <= $c && 0x815 >= $c) ||
          0x81a === $c ||
          0x824 === $c ||
          0x828 === $c ||
          (0x830 <= $c && 0x83e >= $c) ||
          (0x840 <= $c && 0x858 >= $c) ||
          0x85e === $c
      ) {
        return 'RTL';
      }

    } elseif (0x200f === $c) {

      return 'RTL';

    } elseif (0xfb1d <= $c) {

      if (0xfb1d === $c ||
          (0xfb1f <= $c && 0xfb28 >= $c) ||
          (0xfb2a <= $c && 0xfb36 >= $c) ||
          (0xfb38 <= $c && 0xfb3c >= $c) ||
          0xfb3e === $c ||
          (0xfb40 <= $c && 0xfb41 >= $c) ||
          (0xfb43 <= $c && 0xfb44 >= $c) ||
          (0xfb46 <= $c && 0xfbc1 >= $c) ||
          (0xfbd3 <= $c && 0xfd3d >= $c) ||
          (0xfd50 <= $c && 0xfd8f >= $c) ||
          (0xfd92 <= $c && 0xfdc7 >= $c) ||
          (0xfdf0 <= $c && 0xfdfc >= $c) ||
          (0xfe70 <= $c && 0xfe74 >= $c) ||
          (0xfe76 <= $c && 0xfefc >= $c) ||
          (0x10800 <= $c && 0x10805 >= $c) ||
          0x10808 === $c ||
          (0x1080a <= $c && 0x10835 >= $c) ||
          (0x10837 <= $c && 0x10838 >= $c) ||
          0x1083c === $c ||
          (0x1083f <= $c && 0x10855 >= $c) ||
          (0x10857 <= $c && 0x1085f >= $c) ||
          (0x10900 <= $c && 0x1091b >= $c) ||
          (0x10920 <= $c && 0x10939 >= $c) ||
          0x1093f === $c ||
          0x10a00 === $c ||
          (0x10a10 <= $c && 0x10a13 >= $c) ||
          (0x10a15 <= $c && 0x10a17 >= $c) ||
          (0x10a19 <= $c && 0x10a33 >= $c) ||
          (0x10a40 <= $c && 0x10a47 >= $c) ||
          (0x10a50 <= $c && 0x10a58 >= $c) ||
          (0x10a60 <= $c && 0x10a7f >= $c) ||
          (0x10b00 <= $c && 0x10b35 >= $c) ||
          (0x10b40 <= $c && 0x10b55 >= $c) ||
          (0x10b58 <= $c && 0x10b72 >= $c) ||
          (0x10b78 <= $c && 0x10b7f >= $c)
      ) {
        return 'RTL';
      }
    }

    return 'LTR';
  }

  /**
   * get data from "/data/*.ser"
   *
   * @param string $file
   *
   * @return bool|string|array|int <p>Will return false on error.</p>
   */
  private static function getData($file)
  {
    $file = __DIR__ . '/data/' . $file . '.php';
    if (file_exists($file)) {
      /** @noinspection PhpIncludeInspection */
      return require $file;
    } else {
      return false;
    }
  }

  /**
   * alias for "UTF8::string_has_bom()"
   *
   * @see UTF8::string_has_bom()
   *
   * @param string $str
   *
   * @return bool
   *
   * @deprecated
   */
  public static function hasBom($str)
  {
    return self::string_has_bom($str);
  }

  /**
   * Converts a hexadecimal-value into an UTF-8 character.
   *
   * @param string $hexdec <p>The hexadecimal value.</p>
   *
   * @return string|false <p>One single UTF-8 character.</p>
   */
  public static function hex_to_chr($hexdec)
  {
    return self::decimal_to_chr(hexdec($hexdec));
  }

  /**
   * Converts hexadecimal U+xxxx code point representation to integer.
   *
   * INFO: opposite to UTF8::int_to_hex()
   *
   * @param string $hexdec <p>The hexadecimal code point representation.</p>
   *
   * @return int|false <p>The code point, or false on failure.</p>
   */
  public static function hex_to_int($hexdec)
  {
    if (!$hexdec) {
      return false;
    }

    if (preg_match('/^(?:\\\u|U\+|)([a-z0-9]{4,6})$/i', $hexdec, $match)) {
      return intval($match[1], 16);
    }

    return false;
  }

  /**
   * alias for "UTF8::html_entity_decode()"
   *
   * @see UTF8::html_entity_decode()
   *
   * @param string $str
   * @param int    $flags
   * @param string $encoding
   *
   * @return string
   */
  public static function html_decode($str, $flags = null, $encoding = 'UTF-8')
  {
    return self::html_entity_decode($str, $flags, $encoding);
  }

  /**
   * Converts a UTF-8 string to a series of HTML numbered entities.
   *
   * INFO: opposite to UTF8::html_decode()
   *
   * @param string $str            <p>The Unicode string to be encoded as numbered entities.</p>
   * @param bool   $keepAsciiChars [optional] <p>Keep ASCII chars.</p>
   * @param string $encoding       [optional] <p>Default is UTF-8</p>
   *
   * @return string <p>HTML numbered entities.</p>
   */
  public static function html_encode($str, $keepAsciiChars = false, $encoding = 'UTF-8')
  {
    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    # INFO: http://stackoverflow.com/questions/35854535/better-explanation-of-convmap-in-mb-encode-numericentity
    if (function_exists('mb_encode_numericentity')) {

      $startCode = 0x00;
      if ($keepAsciiChars === true) {
        $startCode = 0x80;
      }

      return mb_encode_numericentity(
          $str,
          array($startCode, 0xfffff, 0, 0xfffff, 0),
          $encoding
      );
    }

    return implode(
        '',
        array_map(
            function ($data) use ($keepAsciiChars, $encoding) {
              return UTF8::single_chr_html_encode($data, $keepAsciiChars, $encoding);
            },
            self::split($str)
        )
    );
  }

  /**
   * UTF-8 version of html_entity_decode()
   *
   * The reason we are not using html_entity_decode() by itself is because
   * while it is not technically correct to leave out the semicolon
   * at the end of an entity most browsers will still interpret the entity
   * correctly. html_entity_decode() does not convert entities without
   * semicolons, so we are left with our own little solution here. Bummer.
   *
   * Convert all HTML entities to their applicable characters
   *
   * INFO: opposite to UTF8::html_encode()
   *
   * @link http://php.net/manual/en/function.html-entity-decode.php
   *
   * @param string $str      <p>
   *                         The input string.
   *                         </p>
   * @param int    $flags    [optional] <p>
   *                         A bitmask of one or more of the following flags, which specify how to handle quotes and
   *                         which document type to use. The default is ENT_COMPAT | ENT_HTML401.
   *                         <table>
   *                         Available <i>flags</i> constants
   *                         <tr valign="top">
   *                         <td>Constant Name</td>
   *                         <td>Description</td>
   *                         </tr>
   *                         <tr valign="top">
   *                         <td><b>ENT_COMPAT</b></td>
   *                         <td>Will convert double-quotes and leave single-quotes alone.</td>
   *                         </tr>
   *                         <tr valign="top">
   *                         <td><b>ENT_QUOTES</b></td>
   *                         <td>Will convert both double and single quotes.</td>
   *                         </tr>
   *                         <tr valign="top">
   *                         <td><b>ENT_NOQUOTES</b></td>
   *                         <td>Will leave both double and single quotes unconverted.</td>
   *                         </tr>
   *                         <tr valign="top">
   *                         <td><b>ENT_HTML401</b></td>
   *                         <td>
   *                         Handle code as HTML 4.01.
   *                         </td>
   *                         </tr>
   *                         <tr valign="top">
   *                         <td><b>ENT_XML1</b></td>
   *                         <td>
   *                         Handle code as XML 1.
   *                         </td>
   *                         </tr>
   *                         <tr valign="top">
   *                         <td><b>ENT_XHTML</b></td>
   *                         <td>
   *                         Handle code as XHTML.
   *                         </td>
   *                         </tr>
   *                         <tr valign="top">
   *                         <td><b>ENT_HTML5</b></td>
   *                         <td>
   *                         Handle code as HTML 5.
   *                         </td>
   *                         </tr>
   *                         </table>
   *                         </p>
   * @param string $encoding [optional] <p>Encoding to use.</p>
   *
   * @return string <p>The decoded string.</p>
   */
  public static function html_entity_decode($str, $flags = null, $encoding = 'UTF-8')
  {
    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    if (!isset($str[3])) { // examples: &; || &x;

      return $str;
    }

    if (
        strpos($str, '&') === false
        ||
        (
            strpos($str, '&#') === false
            &&
            strpos($str, ';') === false
        )
    ) {
      return $str;
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    if ($flags === null) {
      if (Bootup::is_php('5.4') === true) {
        $flags = ENT_QUOTES | ENT_HTML5;
      } else {
        $flags = ENT_QUOTES;
      }
    }

    do {
      $str_compare = $str;

      $str = preg_replace_callback(
          "/&#\d{2,6};/",
          function ($matches) use ($encoding) {
            $returnTmp = \mb_convert_encoding($matches[0], $encoding, 'HTML-ENTITIES');

            if ($returnTmp !== '"' && $returnTmp !== "'") {
              return $returnTmp;
            } else {
              return $matches[0];
            }
          },
          $str
      );

      // decode numeric & UTF16 two byte entities
      $str = html_entity_decode(
          preg_replace('/(&#(?:x0*[0-9a-f]{2,6}(?![0-9a-f;])|(?:0*\d{2,6}(?![0-9;]))))/iS', '$1;', $str),
          $flags,
          $encoding
      );

    } while ($str_compare !== $str);

    return $str;
  }

  /**
   * Convert all applicable characters to HTML entities: UTF-8 version of htmlentities()
   *
   * @link http://php.net/manual/en/function.htmlentities.php
   *
   * @param string $str           <p>
   *                              The input string.
   *                              </p>
   * @param int    $flags         [optional] <p>
   *                              A bitmask of one or more of the following flags, which specify how to handle quotes,
   *                              invalid code unit sequences and the used document type. The default is
   *                              ENT_COMPAT | ENT_HTML401.
   *                              <table>
   *                              Available <i>flags</i> constants
   *                              <tr valign="top">
   *                              <td>Constant Name</td>
   *                              <td>Description</td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_COMPAT</b></td>
   *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_QUOTES</b></td>
   *                              <td>Will convert both double and single quotes.</td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_NOQUOTES</b></td>
   *                              <td>Will leave both double and single quotes unconverted.</td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_IGNORE</b></td>
   *                              <td>
   *                              Silently discard invalid code unit sequences instead of returning
   *                              an empty string. Using this flag is discouraged as it
   *                              may have security implications.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_SUBSTITUTE</b></td>
   *                              <td>
   *                              Replace invalid code unit sequences with a Unicode Replacement Character
   *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty string.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_DISALLOWED</b></td>
   *                              <td>
   *                              Replace invalid code points for the given document type with a
   *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
   *                              (otherwise) instead of leaving them as is. This may be useful, for
   *                              instance, to ensure the well-formedness of XML documents with
   *                              embedded external content.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_HTML401</b></td>
   *                              <td>
   *                              Handle code as HTML 4.01.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_XML1</b></td>
   *                              <td>
   *                              Handle code as XML 1.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_XHTML</b></td>
   *                              <td>
   *                              Handle code as XHTML.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_HTML5</b></td>
   *                              <td>
   *                              Handle code as HTML 5.
   *                              </td>
   *                              </tr>
   *                              </table>
   *                              </p>
   * @param string $encoding      [optional] <p>
   *                              Like <b>htmlspecialchars</b>,
   *                              <b>htmlentities</b> takes an optional third argument
   *                              <i>encoding</i> which defines encoding used in
   *                              conversion.
   *                              Although this argument is technically optional, you are highly
   *                              encouraged to specify the correct value for your code.
   *                              </p>
   * @param bool   $double_encode [optional] <p>
   *                              When <i>double_encode</i> is turned off PHP will not
   *                              encode existing html entities. The default is to convert everything.
   *                              </p>
   *
   *
   * @return string the encoded string.
   * </p>
   * <p>
   * If the input <i>string</i> contains an invalid code unit
   * sequence within the given <i>encoding</i> an empty string
   * will be returned, unless either the <b>ENT_IGNORE</b> or
   * <b>ENT_SUBSTITUTE</b> flags are set.
   */
  public static function htmlentities($str, $flags = ENT_COMPAT, $encoding = 'UTF-8', $double_encode = true)
  {
    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    $str = htmlentities($str, $flags, $encoding, $double_encode);

    if ($encoding !== 'UTF-8') {
      return $str;
    }

    $byteLengths = self::chr_size_list($str);
    $search = array();
    $replacements = array();
    foreach ($byteLengths as $counter => $byteLength) {
      if ($byteLength >= 3) {
        $char = self::access($str, $counter);

        if (!isset($replacements[$char])) {
          $search[$char] = $char;
          $replacements[$char] = self::html_encode($char);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
        }
      }
    }

    return str_replace($search, $replacements, $str);
  }

  /**
   * Convert only special characters to HTML entities: UTF-8 version of htmlspecialchars()
   *
   * INFO: Take a look at "UTF8::htmlentities()"
   *
   * @link http://php.net/manual/en/function.htmlspecialchars.php
   *
   * @param string $str           <p>
   *                              The string being converted.
   *                              </p>
   * @param int    $flags         [optional] <p>
   *                              A bitmask of one or more of the following flags, which specify how to handle quotes,
   *                              invalid code unit sequences and the used document type. The default is
   *                              ENT_COMPAT | ENT_HTML401.
   *                              <table>
   *                              Available <i>flags</i> constants
   *                              <tr valign="top">
   *                              <td>Constant Name</td>
   *                              <td>Description</td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_COMPAT</b></td>
   *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_QUOTES</b></td>
   *                              <td>Will convert both double and single quotes.</td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_NOQUOTES</b></td>
   *                              <td>Will leave both double and single quotes unconverted.</td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_IGNORE</b></td>
   *                              <td>
   *                              Silently discard invalid code unit sequences instead of returning
   *                              an empty string. Using this flag is discouraged as it
   *                              may have security implications.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_SUBSTITUTE</b></td>
   *                              <td>
   *                              Replace invalid code unit sequences with a Unicode Replacement Character
   *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty string.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_DISALLOWED</b></td>
   *                              <td>
   *                              Replace invalid code points for the given document type with a
   *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
   *                              (otherwise) instead of leaving them as is. This may be useful, for
   *                              instance, to ensure the well-formedness of XML documents with
   *                              embedded external content.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_HTML401</b></td>
   *                              <td>
   *                              Handle code as HTML 4.01.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_XML1</b></td>
   *                              <td>
   *                              Handle code as XML 1.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_XHTML</b></td>
   *                              <td>
   *                              Handle code as XHTML.
   *                              </td>
   *                              </tr>
   *                              <tr valign="top">
   *                              <td><b>ENT_HTML5</b></td>
   *                              <td>
   *                              Handle code as HTML 5.
   *                              </td>
   *                              </tr>
   *                              </table>
   *                              </p>
   * @param string $encoding      [optional] <p>
   *                              Defines encoding used in conversion.
   *                              </p>
   *                              <p>
   *                              For the purposes of this function, the encodings
   *                              ISO-8859-1, ISO-8859-15,
   *                              UTF-8, cp866,
   *                              cp1251, cp1252, and
   *                              KOI8-R are effectively equivalent, provided the
   *                              <i>string</i> itself is valid for the encoding, as
   *                              the characters affected by <b>htmlspecialchars</b> occupy
   *                              the same positions in all of these encodings.
   *                              </p>
   * @param bool   $double_encode [optional] <p>
   *                              When <i>double_encode</i> is turned off PHP will not
   *                              encode existing html entities, the default is to convert everything.
   *                              </p>
   *
   * @return string The converted string.
   * </p>
   * <p>
   * If the input <i>string</i> contains an invalid code unit
   * sequence within the given <i>encoding</i> an empty string
   * will be returned, unless either the <b>ENT_IGNORE</b> or
   * <b>ENT_SUBSTITUTE</b> flags are set.
   */
  public static function htmlspecialchars($str, $flags = ENT_COMPAT, $encoding = 'UTF-8', $double_encode = true)
  {
    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    return htmlspecialchars($str, $flags, $encoding, $double_encode);
  }

  /**
   * Checks whether iconv is available on the server.
   *
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
   */
  public static function iconv_loaded()
  {
    $return = extension_loaded('iconv') ? true : false;

    // INFO: "default_charset" is already set by the "Bootup"-class

    if (!Bootup::is_php('5.6')) {
      // INFO: "iconv_set_encoding" is deprecated cince PHP 5.6
      iconv_set_encoding('input_encoding', 'UTF-8');
      iconv_set_encoding('output_encoding', 'UTF-8');
      iconv_set_encoding('internal_encoding', 'UTF-8');
    }

    return $return;
  }

  /**
   * alias for "UTF8::decimal_to_chr()"
   *
   * @see UTF8::decimal_to_chr()
   *
   * @param int $int
   *
   * @return string
   */
  public static function int_to_chr($int)
  {
    return self::decimal_to_chr($int);
  }

  /**
   * Converts Integer to hexadecimal U+xxxx code point representation.
   *
   * INFO: opposite to UTF8::hex_to_int()
   *
   * @param int    $int  <p>The integer to be converted to hexadecimal code point.</p>
   * @param string $pfix [optional]
   *
   * @return string <p>The code point, or empty string on failure.</p>
   */
  public static function int_to_hex($int, $pfix = 'U+')
  {
    if (ctype_digit((string)$int)) {
      $hex = dechex((int)$int);

      $hex = (strlen($hex) < 4 ? substr('0000' . $hex, -4) : $hex);

      return $pfix . $hex;
    }

    return '';
  }

  /**
   * Checks whether intl-char is available on the server.
   *
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
   */
  public static function intlChar_loaded()
  {
    return (Bootup::is_php('7.0') === true && class_exists('IntlChar') === true);
  }

  /**
   * Checks whether intl is available on the server.
   *
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
   */
  public static function intl_loaded()
  {
    return extension_loaded('intl') ? true : false;
  }

  /**
   * alias for "UTF8::is_ascii()"
   *
   * @see UTF8::is_ascii()
   *
   * @param string $str
   *
   * @return boolean
   *
   * @deprecated
   */
  public static function isAscii($str)
  {
    return self::is_ascii($str);
  }

  /**
   * alias for "UTF8::is_base64()"
   *
   * @see UTF8::is_base64()
   *
   * @param string $str
   *
   * @return bool
   *
   * @deprecated
   */
  public static function isBase64($str)
  {
    return self::is_base64($str);
  }

  /**
   * alias for "UTF8::is_binary()"
   *
   * @see UTF8::is_binary()
   *
   * @param string $str
   *
   * @return bool
   *
   * @deprecated
   */
  public static function isBinary($str)
  {
    return self::is_binary($str);
  }

  /**
   * alias for "UTF8::is_bom()"
   *
   * @see UTF8::is_bom()
   *
   * @param string $utf8_chr
   *
   * @return boolean
   *
   * @deprecated
   */
  public static function isBom($utf8_chr)
  {
    return self::is_bom($utf8_chr);
  }

  /**
   * alias for "UTF8::is_html()"
   *
   * @see UTF8::is_html()
   *
   * @param string $str
   *
   * @return boolean
   *
   * @deprecated
   */
  public static function isHtml($str)
  {
    return self::is_html($str);
  }

  /**
   * alias for "UTF8::is_json()"
   *
   * @see UTF8::is_json()
   *
   * @param string $str
   *
   * @return bool
   *
   * @deprecated
   */
  public static function isJson($str)
  {
    return self::is_json($str);
  }

  /**
   * alias for "UTF8::is_utf16()"
   *
   * @see UTF8::is_utf16()
   *
   * @param string $str
   *
   * @return int|false false if is't not UTF16, 1 for UTF-16LE, 2 for UTF-16BE.
   *
   * @deprecated
   */
  public static function isUtf16($str)
  {
    return self::is_utf16($str);
  }

  /**
   * alias for "UTF8::is_utf32()"
   *
   * @see UTF8::is_utf32()
   *
   * @param string $str
   *
   * @return int|false false if is't not UTF16, 1 for UTF-32LE, 2 for UTF-32BE.
   *
   * @deprecated
   */
  public static function isUtf32($str)
  {
    return self::is_utf32($str);
  }

  /**
   * alias for "UTF8::is_utf8()"
   *
   * @see UTF8::is_utf8()
   *
   * @param string $str
   * @param bool   $strict
   *
   * @return bool
   *
   * @deprecated
   */
  public static function isUtf8($str, $strict = false)
  {
    return self::is_utf8($str, $strict);
  }

  /**
   * Checks if a string is 7 bit ASCII.
   *
   * @param string $str <p>The string to check.</p>
   *
   * @return bool <p>
   *              <strong>true</strong> if it is ASCII<br />
   *              <strong>false</strong> otherwise
   *              </p>
   */
  public static function is_ascii($str)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return true;
    }

    return (bool)!preg_match('/[\x80-\xFF]/', $str);
  }

  /**
   * Returns true if the string is base64 encoded, false otherwise.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return bool <p>Whether or not $str is base64 encoded.</p>
   */
  public static function is_base64($str)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return false;
    }

    if (base64_encode(base64_decode($str, true)) === $str) {
      return true;
    } else {
      return false;
    }
  }

  /**
   * Check if the input is binary... (is look like a hack).
   *
   * @param mixed $input
   *
   * @return bool
   */
  public static function is_binary($input)
  {
    if (preg_match('~^[01]+$~', $input)) {
      return true;
    }

    $testLength = strlen($input);
    if (substr_count($input, "\x0") / $testLength > 0.3) {
      return true;
    }

    return false;
  }

  /**
   * Check if the file is binary.
   *
   * @param string $file
   *
   * @return boolean
   */
  public static function is_binary_file($file)
  {
    try {
      $fp = fopen($file, 'rb');
      $block = fread($fp, 512);
      fclose($fp);
    } catch (\Exception $e) {
      $block = '';
    }

    return self::is_binary($block);
  }

  /**
   * Checks if the given string is equal to any "Byte Order Mark".
   *
   * WARNING: Use "UTF8::string_has_bom()" if you will check BOM in a string.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return bool <p><strong>true</strong> if the $utf8_chr is Byte Order Mark, <strong>false</strong> otherwise.</p>
   */
  public static function is_bom($str)
  {
    foreach (self::$bom as $bomString => $bomByteLength) {
      if ($str === $bomString) {
        return true;
      }
    }

    return false;
  }

  /**
   * Check if the string contains any html-tags <lall>.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return boolean
   */
  public static function is_html($str)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return false;
    }

    // init
    $matches = array();

    preg_match("/<\/?\w+(?:(?:\s+\w+(?:\s*=\s*(?:\".*?\"|'.*?'|[^'\">\s]+))?)*+\s*|\s*)\/?>/", $str, $matches);

    if (count($matches) === 0) {
      return false;
    } else {
      return true;
    }
  }

  /**
   * Try to check if "$str" is an json-string.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return bool
   */
  public static function is_json($str)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return false;
    }

    if (
        is_object(self::json_decode($str))
        &&
        json_last_error() === JSON_ERROR_NONE
    ) {
      return true;
    } else {
      return false;
    }
  }

  /**
   * Check if the string is UTF-16.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return int|false <p>
   *                   <strong>false</strong> if is't not UTF-16,<br />
   *                   <strong>1</strong> for UTF-16LE,<br />
   *                   <strong>2</strong> for UTF-16BE.
   *                   </p>
   */
  public static function is_utf16($str)

  {
    $str = self::remove_bom($str);

    if (self::is_binary($str)) {

      $maybeUTF16LE = 0;
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16LE');
      if ($test) {
        $test2 = \mb_convert_encoding($test, 'UTF-16LE', 'UTF-8');
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16LE');
        if ($test3 === $test) {
          $strChars = self::count_chars($str, true);
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
            if (in_array($test3char, $strChars, true) === true) {
              $maybeUTF16LE++;
            }
          }
        }
      }

      $maybeUTF16BE = 0;
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16BE');
      if ($test) {
        $test2 = \mb_convert_encoding($test, 'UTF-16BE', 'UTF-8');
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16BE');
        if ($test3 === $test) {
          $strChars = self::count_chars($str, true);
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
            if (in_array($test3char, $strChars, true) === true) {
              $maybeUTF16BE++;
            }
          }
        }
      }

      if ($maybeUTF16BE !== $maybeUTF16LE) {
        if ($maybeUTF16LE > $maybeUTF16BE) {
          return 1;
        } else {
          return 2;
        }
      }

    }

    return false;
  }

  /**
   * Check if the string is UTF-32.
   *
   * @param string $str
   *
   * @return int|false <p>
   *                   <strong>false</strong> if is't not UTF-16,<br />
   *                   <strong>1</strong> for UTF-32LE,<br />
   *                   <strong>2</strong> for UTF-32BE.
   *                   </p>
   */
  public static function is_utf32($str)

  {
    $str = self::remove_bom($str);

    if (self::is_binary($str)) {

      $maybeUTF32LE = 0;
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32LE');
      if ($test) {
        $test2 = \mb_convert_encoding($test, 'UTF-32LE', 'UTF-8');
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32LE');
        if ($test3 === $test) {
          $strChars = self::count_chars($str, true);
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
            if (in_array($test3char, $strChars, true) === true) {
              $maybeUTF32LE++;
            }
          }
        }
      }

      $maybeUTF32BE = 0;
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32BE');
      if ($test) {
        $test2 = \mb_convert_encoding($test, 'UTF-32BE', 'UTF-8');
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32BE');
        if ($test3 === $test) {
          $strChars = self::count_chars($str, true);
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
            if (in_array($test3char, $strChars, true) === true) {
              $maybeUTF32BE++;
            }
          }
        }
      }

      if ($maybeUTF32BE !== $maybeUTF32LE) {
        if ($maybeUTF32LE > $maybeUTF32BE) {
          return 1;
        } else {
          return 2;
        }
      }

    }

    return false;
  }

  /**
   * Checks whether the passed string contains only byte sequences that appear valid UTF-8 characters.
   *
   * @see    http://hsivonen.iki.fi/php-utf8/
   *
   * @param 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>
   *
   * @return bool
   */
  public static function is_utf8($str, $strict = false)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return true;
    }

    if ($strict === true) {
      if (self::is_utf16($str) !== false) {
        return false;
      }

      if (self::is_utf32($str) !== false) {
        return false;
      }
    }

    if (self::pcre_utf8_support() !== true) {

      // If even just the first character can be matched, when the /u
      // modifier is used, then it's valid UTF-8. If the UTF-8 is somehow
      // invalid, nothing at all will match, even if the string contains
      // some valid sequences
      return (preg_match('/^.{1}/us', $str, $ar) === 1);

    } else {

      $mState = 0; // cached expected number of octets after the current octet
      // until the beginning of the next UTF8 character sequence
      $mUcs4 = 0; // cached Unicode character
      $mBytes = 1; // cached expected number of octets in the current sequence
      $len = strlen($str);

      /** @noinspection ForeachInvariantsInspection */
      for ($i = 0; $i < $len; $i++) {
        $in = ord($str[$i]);
        if ($mState === 0) {
          // When mState is zero we expect either a US-ASCII character or a
          // multi-octet sequence.
          if (0 === (0x80 & $in)) {
            // US-ASCII, pass straight through.
            $mBytes = 1;
          } elseif (0xC0 === (0xE0 & $in)) {

            // First octet of 2 octet sequence.
            $mUcs4 = $in;
            $mUcs4 = ($mUcs4 & 0x1F) << 6;
            $mState = 1;
            $mBytes = 2;
          } elseif (0xE0 === (0xF0 & $in)) {
            // First octet of 3 octet sequence.
            $mUcs4 = $in;
            $mUcs4 = ($mUcs4 & 0x0F) << 12;
            $mState = 2;
            $mBytes = 3;
          } elseif (0xF0 === (0xF8 & $in)) {

            // First octet of 4 octet sequence.
            $mUcs4 = $in;
            $mUcs4 = ($mUcs4 & 0x07) << 18;
            $mState = 3;
            $mBytes = 4;
          } elseif (0xF8 === (0xFC & $in)) {
            /* First octet of 5 octet sequence.
            *
            * This is illegal because the encoded codepoint must be either
            * (a) not the shortest form or
            * (b) outside the Unicode range of 0-0x10FFFF.
            * Rather than trying to resynchronize, we will carry on until the end
            * of the sequence and let the later error handling code catch it.
            */
            $mUcs4 = $in;
            $mUcs4 = ($mUcs4 & 0x03) << 24;
            $mState = 4;
            $mBytes = 5;
          } elseif (0xFC === (0xFE & $in)) {

            // First octet of 6 octet sequence, see comments for 5 octet sequence.
            $mUcs4 = $in;
            $mUcs4 = ($mUcs4 & 1) << 30;
            $mState = 5;
            $mBytes = 6;
          } else {
            /* Current octet is neither in the US-ASCII range nor a legal first
             * octet of a multi-octet sequence.
             */
            return false;
          }
        } else {
          // When mState is non-zero, we expect a continuation of the multi-octet
          // sequence
          if (0x80 === (0xC0 & $in)) {
            // Legal continuation.
            $shift = ($mState - 1) * 6;
            $tmp = $in;
            $tmp = ($tmp & 0x0000003F) << $shift;
            $mUcs4 |= $tmp;
            /**
             * End of the multi-octet sequence. mUcs4 now contains the final
             * Unicode code point to be output
             */
            if (0 === --$mState) {
              /*
              * Check for illegal sequences and code points.
              */
              // From Unicode 3.1, non-shortest form is illegal
              if (
                  (2 === $mBytes && $mUcs4 < 0x0080) ||
                  (3 === $mBytes && $mUcs4 < 0x0800) ||
                  (4 === $mBytes && $mUcs4 < 0x10000) ||
                  (4 < $mBytes) ||
                  // From Unicode 3.2, surrogate characters are illegal.
                  (($mUcs4 & 0xFFFFF800) === 0xD800) ||
                  // Code points outside the Unicode range are illegal.
                  ($mUcs4 > 0x10FFFF)
              ) {
                return false;
              }
              // initialize UTF8 cache
              $mState = 0;
              $mUcs4 = 0;
              $mBytes = 1;
            }
          } else {
            /**
             *((0xC0 & (*in) != 0x80) && (mState != 0))
             * Incomplete multi-octet sequence.
             */
            return false;
          }
        }
      }

      return true;
    }
  }

  /**
   * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
   * Decodes a JSON string
   *
   * @link http://php.net/manual/en/function.json-decode.php
   *
   * @param string $json    <p>
   *                        The <i>json</i> string being decoded.
   *                        </p>
   *                        <p>
   *                        This function only works with UTF-8 encoded strings.
   *                        </p>
   *                        <p>PHP implements a superset of
   *                        JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
   *                        only supports these values when they are nested inside an array or an object.
   *                        </p>
   * @param bool   $assoc   [optional] <p>
   *                        When <b>TRUE</b>, returned objects will be converted into
   *                        associative arrays.
   *                        </p>
   * @param int    $depth   [optional] <p>
   *                        User specified recursion depth.
   *                        </p>
   * @param int    $options [optional] <p>
   *                        Bitmask of JSON decode options. Currently only
   *                        <b>JSON_BIGINT_AS_STRING</b>
   *                        is supported (default is to cast large integers as floats)
   *                        </p>
   *
   * @return mixed the value encoded in <i>json</i> in appropriate
   * PHP type. Values true, false and
   * null (case-insensitive) are returned as <b>TRUE</b>, <b>FALSE</b>
   * and <b>NULL</b> respectively. <b>NULL</b> is returned if the
   * <i>json</i> cannot be decoded or if the encoded
   * data is deeper than the recursion limit.
   */
  public static function json_decode($json, $assoc = false, $depth = 512, $options = 0)
  {
    $json = self::filter($json);

    if (Bootup::is_php('5.4') === true) {
      $json = json_decode($json, $assoc, $depth, $options);
    } else {
      $json = json_decode($json, $assoc, $depth);
    }

    return $json;
  }

  /**
   * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
   * Returns the JSON representation of a value.
   *
   * @link http://php.net/manual/en/function.json-encode.php
   *
   * @param mixed $value   <p>
   *                       The <i>value</i> being encoded. Can be any type except
   *                       a resource.
   *                       </p>
   *                       <p>
   *                       All string data must be UTF-8 encoded.
   *                       </p>
   *                       <p>PHP implements a superset of
   *                       JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
   *                       only supports these values when they are nested inside an array or an object.
   *                       </p>
   * @param int   $options [optional] <p>
   *                       Bitmask consisting of <b>JSON_HEX_QUOT</b>,
   *                       <b>JSON_HEX_TAG</b>,
   *                       <b>JSON_HEX_AMP</b>,
   *                       <b>JSON_HEX_APOS</b>,
   *                       <b>JSON_NUMERIC_CHECK</b>,
   *                       <b>JSON_PRETTY_PRINT</b>,
   *                       <b>JSON_UNESCAPED_SLASHES</b>,
   *                       <b>JSON_FORCE_OBJECT</b>,
   *                       <b>JSON_UNESCAPED_UNICODE</b>. The behaviour of these
   *                       constants is described on
   *                       the JSON constants page.
   *                       </p>
   * @param int   $depth   [optional] <p>
   *                       Set the maximum depth. Must be greater than zero.
   *                       </p>
   *
   * @return string a JSON encoded string on success or <b>FALSE</b> on failure.
   */
  public static function json_encode($value, $options = 0, $depth = 512)
  {
    $value = self::filter($value);

    if (Bootup::is_php('5.5')) {
      $json = json_encode($value, $options, $depth);
    } else {
      $json = json_encode($value, $options);
    }

    return $json;
  }

  /**
   * Makes string's first char lowercase.
   *
   * @param string $str <p>The input string</p>
   *
   * @return string <p>The resulting string</p>
   */
  public static function lcfirst($str)
  {
    return self::strtolower(self::substr($str, 0, 1)) . self::substr($str, 1);

  }

  /**
   * Strip whitespace or other characters from beginning of a UTF-8 string.
   *
   * @param string $str   <p>The string to be trimmed</p>
   * @param string $chars <p>Optional characters to be stripped</p>
   *
   * @return string <p>The string with unwanted characters stripped from the left.</p>
   */
  public static function ltrim($str = '', $chars = INF)

  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
    if ($chars === INF || !$chars) {
      return preg_replace('/^[\pZ\pC]+/u', '', $str);
    }

    return preg_replace('/^' . self::rxClass($chars) . '+/u', '', $str);
  }

  /**
   * Returns the UTF-8 character with the maximum code point in the given data.
   *
   * @param mixed $arg <p>A UTF-8 encoded string or an array of such strings.</p>
   *
   * @return string <p>The character with the highest code point than others.</p>
   */
  public static function max($arg)

  {
    if (is_array($arg)) {
      $arg = implode('', $arg);
    }

    return self::chr(max(self::codepoints($arg)));
  }

  /**
   * Calculates and returns the maximum number of bytes taken by any
   * UTF-8 encoded character in the given string.
   *
   * @param string $str <p>The original Unicode string.</p>
   *
   * @return int <p>Max byte lengths of the given chars.</p>
   */
  public static function max_chr_width($str)
  {
    $bytes = self::chr_size_list($str);
    if (count($bytes) > 0) {
      return (int)max($bytes);
    } else {
      return 0;
    }
  }

  /**
   * Checks whether mbstring is available on the server.
   *
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
   */
  public static function mbstring_loaded()
  {
    $return = extension_loaded('mbstring') ? true : false;

    if ($return === true) {
      \mb_internal_encoding('UTF-8');
    }

    return $return;
  }

  /**
   * Returns the UTF-8 character with the minimum code point in the given data.
   *
   * @param mixed $arg <strong>A UTF-8 encoded string or an array of such strings.</strong>
   *
   * @return string <p>The character with the lowest code point than others.</p>
   */
  public static function min($arg)

  {
    if (is_array($arg)) {
      $arg = implode('', $arg);
    }

    return self::chr(min(self::codepoints($arg)));
  }

  /**
   * alias for "UTF8::normalize_encoding()"
   *
   * @see UTF8::normalize_encoding()
   *
   * @param string $encoding
   *
   * @return string
   *
   * @deprecated
   */
  public static function normalizeEncoding($encoding)
  {
    return self::normalize_encoding($encoding);
  }

  /**
   * Normalize the encoding-"name" input.
   *
   * @param string $encoding <p>e.g.: ISO, UTF8, WINDOWS-1251 etc.</p>
   *
   * @return string <p>e.g.: ISO-8859-1, UTF-8, WINDOWS-1251 etc.</p>
   */
  public static function normalize_encoding($encoding)
  {
    static $staticNormalizeEncodingCache = array();

    if (!$encoding) {
      return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    if ('UTF-8' === $encoding) {
      return $encoding;
    }

    if (in_array($encoding, self::$iconvEncoding, true)) {
      return $encoding;
    }

    if (isset($staticNormalizeEncodingCache[$encoding])) {
      return $staticNormalizeEncodingCache[$encoding];
    }

    $encodingOrig = $encoding;
    $encoding = strtoupper($encoding);
    $encodingUpperHelper = preg_replace('/[^a-zA-Z0-9\s]/', '', $encoding);

    $equivalences = array(
        'ISO88591'    => 'ISO-8859-1',
        'ISO8859'     => 'ISO-8859-1',
        'ISO'         => 'ISO-8859-1',
        'LATIN1'      => 'ISO-8859-1',
        'LATIN'       => 'ISO-8859-1',
        'WIN1252'     => 'ISO-8859-1',
        'WINDOWS1252' => 'ISO-8859-1',
        'UTF16'       => 'UTF-16',
        'UTF32'       => 'UTF-32',
        'UTF8'        => 'UTF-8',
        'UTF'         => 'UTF-8',
        'UTF7'        => 'UTF-7',
        '8BIT'        => 'CP850',
        'BINARY'      => 'CP850',
    );

    if (!empty($equivalences[$encodingUpperHelper])) {
      $encoding = $equivalences[$encodingUpperHelper];
    }

    $staticNormalizeEncodingCache[$encodingOrig] = $encoding;

    return $encoding;
  }

  /**
   * Normalize some MS Word special characters.
   *
   * @param string $str <p>The string to be normalized.</p>
   *
   * @return string
   */
  public static function normalize_msword($str)

  {
    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    static $UTF8_MSWORD_KEYS_CACHE = null;
    static $UTF8_MSWORD_VALUES_CACHE = null;

    if ($UTF8_MSWORD_KEYS_CACHE === null) {
      $UTF8_MSWORD_KEYS_CACHE = array_keys(self::$utf8MSWord);
      $UTF8_MSWORD_VALUES_CACHE = array_values(self::$utf8MSWord);
    }

    return str_replace($UTF8_MSWORD_KEYS_CACHE, $UTF8_MSWORD_VALUES_CACHE, $str);
  }

  /**
   * Normalize the whitespace.
   *
   * @param string $str                     <p>The string to be normalized.</p>
   * @param bool   $keepNonBreakingSpace    [optional] <p>Set to true, to keep non-breaking-spaces.</p>
   * @param bool   $keepBidiUnicodeControls [optional] <p>Set to true, to keep non-printable (for the web)
   *                                        bidirectional text chars.</p>
   *
   * @return string
   */
  public static function normalize_whitespace($str, $keepNonBreakingSpace = false, $keepBidiUnicodeControls = false)
  {
    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    static $WHITESPACE_CACHE = array();
    $cacheKey = (int)$keepNonBreakingSpace;

    if (!isset($WHITESPACE_CACHE[$cacheKey])) {

      $WHITESPACE_CACHE[$cacheKey] = self::$whitespaceTable;

      if ($keepNonBreakingSpace === true) {
        /** @noinspection OffsetOperationsInspection */
        unset($WHITESPACE_CACHE[$cacheKey]['NO-BREAK SPACE']);
      }

      $WHITESPACE_CACHE[$cacheKey] = array_values($WHITESPACE_CACHE[$cacheKey]);
    }

    if ($keepBidiUnicodeControls === false) {
      static $BIDI_UNICODE_CONTROLS_CACHE = null;

      if ($BIDI_UNICODE_CONTROLS_CACHE === null) {
        $BIDI_UNICODE_CONTROLS_CACHE = array_values(self::$bidiUniCodeControlsTable);
      }

      $str = str_replace($BIDI_UNICODE_CONTROLS_CACHE, '', $str);
    }

    return str_replace($WHITESPACE_CACHE[$cacheKey], ' ', $str);
  }

  /**
   * Format a number with grouped thousands.
   *
   * @param float  $number
   * @param int    $decimals
   * @param string $dec_point
   * @param string $thousands_sep
   *
   * @return string
   *    *
   * @deprecated Because this has nothing to do with UTF8. :/
   */
  public static function number_format($number, $decimals = 0, $dec_point = '.', $thousands_sep = ',')
  {
    $thousands_sep = (string)$thousands_sep;
    $dec_point = (string)$dec_point;

    if (
        isset($thousands_sep[1], $dec_point[1])
        &&
        Bootup::is_php('5.4') === true
    ) {
      return str_replace(
          array(
              '.',
              ',',
          ),
          array(
              $dec_point,
              $thousands_sep,
          ),
          number_format($number, $decimals, '.', ',')
      );
    }

    return number_format($number, $decimals, $dec_point, $thousands_sep);
  }

  /**
   * Calculates Unicode code point of the given UTF-8 encoded character.
   *
   * INFO: opposite to UTF8::chr()
   *
   * @param string      $chr      <p>The character of which to calculate code point.<p/>
   * @param string|null $encoding [optional] <p>Default is UTF-8</p>
   *
   * @return int <p>
   *             Unicode code point of the given character,<br />
   *             0 on invalid UTF-8 byte sequence.
   *             </p>
   */
  public static function ord($chr, $encoding = 'UTF-8')
  {
    if (!$chr && $chr !== '0') {
      return 0;
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
      $chr = (string)\mb_convert_encoding($chr, 'UTF-8', $encoding);
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (self::$support['intlChar'] === true) {
      $tmpReturn = \IntlChar::ord($chr);
      if ($tmpReturn) {
        return $tmpReturn;
      }
    }

    // use static cache, if there is no support for "IntlChar"
    static $cache = array();
    if (isset($cache[$chr]) === true) {
      return $cache[$chr];
    }

    $chr_orig = $chr;
    /** @noinspection CallableParameterUseCaseInTypeContextInspection */
    $chr = unpack('C*', substr($chr, 0, 4));
    $code = $chr ? $chr[1] : 0;

    if (0xF0 <= $code && isset($chr[4])) {
      return $cache[$chr_orig] = (($code - 0xF0) << 18) + (($chr[2] - 0x80) << 12) + (($chr[3] - 0x80) << 6) + $chr[4] - 0x80;
    }

    if (0xE0 <= $code && isset($chr[3])) {
      return $cache[$chr_orig] = (($code - 0xE0) << 12) + (($chr[2] - 0x80) << 6) + $chr[3] - 0x80;
    }

    if (0xC0 <= $code && isset($chr[2])) {
      return $cache[$chr_orig] = (($code - 0xC0) << 6) + $chr[2] - 0x80;
    }

    return $cache[$chr_orig] = $code;
  }

  /**
   * Parses the string into an array (into the the second parameter).
   *
   * WARNING: Instead of "parse_str()" this method do not (re-)placing variables in the current scope,
   *          if the second parameter is not set!
   *
   * @link http://php.net/manual/en/function.parse-str.php
   *
   * @param string  $str       <p>The input string.</p>
   * @param array   $result    <p>The result will be returned into this reference parameter.</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return bool <p>Will return <strong>false</strong> if php can't parse the string and we haven't any $result.</p>
   */
  public static function parse_str($str, &$result, $cleanUtf8 = false)
  {
    if ($cleanUtf8 === true) {
      $str = self::clean($str);
    }

    $return = \mb_parse_str($str, $result);
    if ($return === false || empty($result)) {
      return false;
    }

    return true;
  }

  /**
   * Checks if \u modifier is available that enables Unicode support in PCRE.
   *
   * @return bool <p><strong>true</strong> if support is available, <strong>false</strong> otherwise.</p>
   */
  public static function pcre_utf8_support()
  {
    /** @noinspection PhpUsageOfSilenceOperatorInspection */
    return (bool)@preg_match('//u', '');
  }

  /**
   * Create an array containing a range of UTF-8 characters.
   *
   * @param mixed $var1 <p>Numeric or hexadecimal code points, or a UTF-8 character to start from.</p>
   * @param mixed $var2 <p>Numeric or hexadecimal code points, or a UTF-8 character to end at.</p>
   *
   * @return array
   */
  public static function range($var1, $var2)
  {
    if (!$var1 || !$var2) {
      return array();
    }

    if (ctype_digit((string)$var1)) {

      $start = (int)$var1;
    } elseif (ctype_xdigit($var1)) {
      $start = (int)self::hex_to_int($var1);
    } else {
      $start = self::ord($var1);
    }

    if (!$start) {
      return array();
    }

    if (ctype_digit((string)$var2)) {

      $end = (int)$var2;
    } elseif (ctype_xdigit($var2)) {
      $end = (int)self::hex_to_int($var2);
    } else {
      $end = self::ord($var2);
    }

    if (!$end) {
      return array();
    }

    return array_map(
        array(
            '\\voku\\helper\\UTF8',
            'chr',
        ),
        range($start, $end)
    );
  }

  /**
   * Multi decode html entity & fix urlencoded-win1252-chars.
   *
   * e.g:
   * 'test+test'                     => 'test+test'
   * 'D&#252;sseldorf'               => 'Düsseldorf'
   * 'D%FCsseldorf'                  => 'Düsseldorf'
   * 'D&#xFC;sseldorf'               => 'Düsseldorf'
   * 'D%26%23xFC%3Bsseldorf'         => 'Düsseldorf'
   * 'DÃ¼sseldorf'                   => 'Düsseldorf'
   * 'D%C3%BCsseldorf'               => 'Düsseldorf'
   * 'D%C3%83%C2%BCsseldorf'         => 'Düsseldorf'
   * 'D%25C3%2583%25C2%25BCsseldorf' => 'Düsseldorf'
   *
   * @param string $str          <p>The input string.</p>
   * @param bool   $multi_decode <p>Decode as often as possible.</p>
   *
   * @return string
   */
  public static function rawurldecode($str, $multi_decode = true)

  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    $pattern = '/%u([0-9a-f]{3,4})/i';
    if (preg_match($pattern, $str)) {
      $str = preg_replace($pattern, '&#x\\1;', rawurldecode($str));
    }

    $flags = Bootup::is_php('5.4') ? ENT_QUOTES | ENT_HTML5 : ENT_QUOTES;

    do {
      $str_compare = $str;

      $str = self::fix_simple_utf8(
          rawurldecode(
              self::html_entity_decode(
                  self::to_utf8($str),

                  $flags
              )
          )
      );

    } while ($multi_decode === true && $str_compare !== $str);

    return (string)$str;
  }

  /**
   * alias for "UTF8::remove_bom()"
   *
   * @see UTF8::remove_bom()
   *
   * @param string $str
   *
   * @return string
   *
   * @deprecated
   */
  public static function removeBOM($str)
  {
    return self::remove_bom($str);
  }

  /**
   * Remove the BOM from UTF-8 / UTF-16 / UTF-32 strings.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return string <p>String without UTF-BOM</p>
   */
  public static function remove_bom($str)
  {
    foreach (self::$bom as $bomString => $bomByteLength) {
      if (0 === strpos($str, $bomString)) {
        $str = substr($str, $bomByteLength);
      }
    }

    return $str;
  }

  /**
   * Removes duplicate occurrences of a string in another string.
   *
   * @param string          $str  <p>The base string.</p>
   * @param string|string[] $what <p>String to search for in the base string.</p>
   *
   * @return string <p>The result string with removed duplicates.</p>
   */
  public static function remove_duplicates($str, $what = ' ')
  {
    if (is_string($what)) {
      $what = array($what);
    }

    if (is_array($what)) {
      /** @noinspection ForeachSourceInspection */
      foreach ($what as $item) {
        $str = preg_replace('/(' . preg_quote($item, '/') . ')+/', $item, $str);
      }
    }

    return $str;
  }

  /**
   * Remove invisible characters from a string.
   *
   * e.g.: This prevents sandwiching null characters between ascii characters, like Java\0script.
   *
   * copy&past from https://github.com/bcit-ci/CodeIgniter/blob/develop/system/core/Common.php
   *
   * @param string $str
   * @param bool   $url_encoded
   * @param string $replacement
   *
   * @return string
   */
  public static function remove_invisible_characters($str, $url_encoded = true, $replacement = '')
  {
    // init
    $non_displayables = array();

    // every control character except newline (dec 10),
    // carriage return (dec 13) and horizontal tab (dec 09)

    if ($url_encoded) {
      $non_displayables[] = '/%0[0-8bcef]/'; // url encoded 00-08, 11, 12, 14, 15

      $non_displayables[] = '/%1[0-9a-f]/'; // url encoded 16-31
    }

    $non_displayables[] = '/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]+/S'; // 00-08, 11, 12, 14-31, 127


    do {
      $str = preg_replace($non_displayables, $replacement, $str, -1, $count);
    } while ($count !== 0);

    return $str;
  }

  /**
   * Replace the diamond question mark (�) and invalid-UTF8 chars with the replacement.
   *
   * @param string $str                <p>The input string</p>
   * @param string $replacementChar    <p>The replacement character.</p>
   * @param bool   $processInvalidUtf8 <p>Convert invalid UTF-8 chars </p>
   *
   * @return string
   */
  public static function replace_diamond_question_mark($str, $replacementChar = '', $processInvalidUtf8 = true)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    if ($processInvalidUtf8 === true) {
      $replacementCharHelper = $replacementChar;
      if ($replacementChar === '') {
        $replacementCharHelper = 'none';
      }

      if (!isset(self::$support['already_checked_via_portable_utf8'])) {
        self::checkForSupport();
      }

      if (self::$support['mbstring'] === false) {
        trigger_error('UTF8::replace_diamond_question_mark() without mbstring cannot handle all chars correctly', E_USER_WARNING);
      }

      $save = \mb_substitute_character();
      \mb_substitute_character($replacementCharHelper);
      /** @noinspection CallableParameterUseCaseInTypeContextInspection */
      $str = \mb_convert_encoding($str, 'UTF-8', 'UTF-8');
      \mb_substitute_character($save);
    }

    return str_replace(
        array(
            "\xEF\xBF\xBD",
            '�',
        ),
        array(
            $replacementChar,
            $replacementChar,
        ),
        $str
    );
  }

  /**
   * Strip whitespace or other characters from end of a UTF-8 string.
   *
   * @param string $str   <p>The string to be trimmed.</p>
   * @param string $chars <p>Optional characters to be stripped.</p>
   *
   * @return string <p>The string with unwanted characters stripped from the right.</p>
   */
  public static function rtrim($str = '', $chars = INF)

  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
    if ($chars === INF || !$chars) {
      return preg_replace('/[\pZ\pC]+$/u', '', $str);
    }

    return preg_replace('/' . self::rxClass($chars) . '+$/u', '', $str);
  }

  /**
   * rxClass
   *
   * @param string $s
   * @param string $class
   *
   * @return string
   */
  private static function rxClass($s, $class = '')
  {
    static $rxClassCache = array();

    $cacheKey = $s . $class;

    if (isset($rxClassCache[$cacheKey])) {
      return $rxClassCache[$cacheKey];
    }

    /** @noinspection CallableParameterUseCaseInTypeContextInspection */
    $class = array($class);

    /** @noinspection SuspiciousLoopInspection */
    foreach (self::str_split($s) as $s) {
      if ('-' === $s) {
        $class[0] = '-' . $class[0];
      } elseif (!isset($s[2])) {
        $class[0] .= preg_quote($s, '/');
      } elseif (1 === self::strlen($s)) {
        $class[0] .= $s;
      } else {
        $class[] = $s;
      }
    }

    if ($class[0]) {
      $class[0] = '[' . $class[0] . ']';
    }

    if (1 === count($class)) {
      $return = $class[0];
    } else {
      $return = '(?:' . implode('|', $class) . ')';
    }

    $rxClassCache[$cacheKey] = $return;

    return $return;
  }

  /**
   * WARNING: Echo native UTF8-Support libs, e.g. for debugging.
   */
  public static function showSupport()
  {
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    foreach (self::$support as $utf8Support) {
      echo $utf8Support . "\n<br>";
    }
  }

  /**
   * Converts a UTF-8 character to HTML Numbered Entity like "&#123;".
   *
   * @param string $char           <p>The Unicode character to be encoded as numbered entity.</p>
   * @param bool   $keepAsciiChars <p>Set to <strong>true</strong> to keep ASCII chars.</>
   * @param string $encoding       [optional] <p>Default is UTF-8</p>
   *
   * @return string <p>The HTML numbered entity.</p>
   */
  public static function single_chr_html_encode($char, $keepAsciiChars = false, $encoding = 'UTF-8')
  {
    // init
    $char = (string)$char;

    if (!isset($char[0])) {
      return '';
    }

    if (
        $keepAsciiChars === true
        &&
        self::is_ascii($char) === true
    ) {
      return $char;
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    return '&#' . self::ord($char, $encoding) . ';';
  }

  /**
   * Convert a string to an array of Unicode characters.
   *
   * @param string  $str       <p>The string to split into array.</p>
   * @param int     $length    [optional] <p>Max character length of each array element.</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string[] <p>An array containing chunks of the string.</p>
   */
  public static function split($str, $length = 1, $cleanUtf8 = false)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return array();
    }

    // init
    $str = (string)$str;
    $ret = array();

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (self::$support['pcre_utf8'] === true) {

      if ($cleanUtf8 === true) {
        $str = self::clean($str);
      }

      preg_match_all('/./us', $str, $retArray);
      if (isset($retArray[0])) {
        $ret = $retArray[0];
      }
      unset($retArray);

    } else {

      // fallback

      $len = strlen($str);

      /** @noinspection ForeachInvariantsInspection */
      for ($i = 0; $i < $len; $i++) {
        if (($str[$i] & "\x80") === "\x00") {
          $ret[] = $str[$i];
        } elseif ((($str[$i] & "\xE0") === "\xC0") && isset($str[$i + 1])) {
          if (($str[$i + 1] & "\xC0") === "\x80") {
            $ret[] = $str[$i] . $str[$i + 1];

            $i++;
          }
        } elseif ((($str[$i] & "\xF0") === "\xE0") && isset($str[$i + 2])) {

          if ((($str[$i + 1] & "\xC0") === "\x80") && (($str[$i + 2] & "\xC0") === "\x80")) {
            $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2];

            $i += 2;
          }
        } elseif ((($str[$i] & "\xF8") === "\xF0") && isset($str[$i + 3])) {
          if ((($str[$i + 1] & "\xC0") === "\x80") && (($str[$i + 2] & "\xC0") === "\x80") && (($str[$i + 3] & "\xC0") === "\x80")) {

            $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2] . $str[$i + 3];

            $i += 3;
          }
        }
      }
    }

    if ($length > 1) {
      $ret = array_chunk($ret, $length);

      return array_map(
          function ($item) {
            return implode('', $item);
          }, $ret
      );
    }

    /** @noinspection OffsetOperationsInspection */
    if (isset($ret[0]) && $ret[0] === '') {
      return array();
    }

    return $ret;
  }

  /**
   * Optimized "\mb_detect_encoding()"-function -> with support for UTF-16 and UTF-32.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return false|string <p>
   *                      The detected string-encoding e.g. UTF-8 or UTF-16BE,<br />
   *                      otherwise it will return false.
   *                      </p>
   */
  public static function str_detect_encoding($str)
  {
    //
    // 1.) check binary strings (010001001...) like UTF-16 / UTF-32
    //

    if (self::is_binary($str)) {
      if (self::is_utf16($str) === 1) {
        return 'UTF-16LE';
      } elseif (self::is_utf16($str) === 2) {
        return 'UTF-16BE';
      } elseif (self::is_utf32($str) === 1) {
        return 'UTF-32LE';
      } elseif (self::is_utf32($str) === 2) {
        return 'UTF-32BE';
      }
    }

    //
    // 2.) simple check for ASCII chars
    //

    if (self::is_ascii($str) === true) {
      return 'ASCII';
    }

    //
    // 3.) simple check for UTF-8 chars
    //

    if (self::is_utf8($str) === true) {
      return 'UTF-8';
    }

    //
    // 4.) check via "\mb_detect_encoding()"
    //
    // INFO: UTF-16, UTF-32, UCS2 and UCS4, encoding detection will fail always with "\mb_detect_encoding()"

    $detectOrder = array(
        'ISO-8859-1',
        'ISO-8859-2',
        'ISO-8859-3',
        'ISO-8859-4',
        'ISO-8859-5',
        'ISO-8859-6',
        'ISO-8859-7',
        'ISO-8859-8',
        'ISO-8859-9',
        'ISO-8859-10',
        'ISO-8859-13',
        'ISO-8859-14',
        'ISO-8859-15',
        'ISO-8859-16',
        'WINDOWS-1251',
        'WINDOWS-1252',
        'WINDOWS-1254',
        'ISO-2022-JP',
        'JIS',
        'EUC-JP',
    );

    $encoding = \mb_detect_encoding($str, $detectOrder, true);
    if ($encoding) {
      return $encoding;
    }

    //
    // 5.) check via "iconv()"
    //

    $md5 = md5($str);
    foreach (self::$iconvEncoding as $encodingTmp) {
      # INFO: //IGNORE and //TRANSLIT still throw notice
      /** @noinspection PhpUsageOfSilenceOperatorInspection */
      if (md5(@\iconv($encodingTmp, $encodingTmp . '//IGNORE', $str)) === $md5) {
        return $encodingTmp;
      }
    }

    return false;
  }

  /**
   * Check if the string ends with the given substring.
   *
   * @param string $haystack <p>The string to search in.</p>
   * @param string $needle   <p>The substring to search for.</p>
   *
   * @return bool
   */
  public static function str_ends_with($haystack, $needle)

  {
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    if ($needle === self::substr($haystack, -self::strlen($needle))) {
      return true;
    }

    return false;
  }

  /**
   * Check if the string ends with the given substring, case insensitive.
   *
   * @param string $haystack <p>The string to search in.</p>
   * @param string $needle   <p>The substring to search for.</p>
   *
   * @return bool
   */
  public static function str_iends_with($haystack, $needle)

  {
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    if (self::strcasecmp(self::substr($haystack, -self::strlen($needle)), $needle) === 0) {

      return true;
    }

    return false;
  }

  /**
   * Case-insensitive and UTF-8 safe version of <function>str_replace</function>.
   *
   * @link  http://php.net/manual/en/function.str-ireplace.php
   *
   * @param mixed $search  <p>
   *                       Every replacement with search array is
   *                       performed on the result of previous replacement.
   *                       </p>
   * @param mixed $replace <p>
   *                       </p>
   * @param mixed $subject <p>
   *                       If subject is an array, then the search and
   *                       replace is performed with every entry of
   *                       subject, and the return value is an array as
   *                       well.
   *                       </p>
   * @param int   $count   [optional] <p>
   *                       The number of matched and replaced needles will
   *                       be returned in count which is passed by
   *                       reference.
   *                       </p>
   *
   * @return mixed <p>A string or an array of replacements.</p>
   */
  public static function str_ireplace($search, $replace, $subject, &$count = null)
  {
    $search = (array)$search;

    /** @noinspection AlterInForeachInspection */
    foreach ($search as &$s) {
      if ('' === $s .= '') {
        $s = '/^(?<=.)$/';
      } else {
        $s = '/' . preg_quote($s, '/') . '/ui';
      }
    }

    $subject = preg_replace($search, $replace, $subject, -1, $replace);
    $count = $replace; // used as reference parameter

    return $subject;
  }

  /**
   * Check if the string starts with the given substring, case insensitive.
   *
   * @param string $haystack <p>The string to search in.</p>
   * @param string $needle   <p>The substring to search for.</p>
   *
   * @return bool
   */
  public static function str_istarts_with($haystack, $needle)

  {
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    if (self::stripos($haystack, $needle) === 0) {
      return true;
    }

    return false;
  }

  /**
   * Limit the number of characters in a string, but also after the next word.
   *
   * @param string $str
   * @param int    $length
   * @param string $strAddOn
   *
   * @return string
   */
  public static function str_limit_after_word($str, $length = 100, $strAddOn = '...')
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    $length = (int)$length;

    if (self::strlen($str) <= $length) {
      return $str;
    }

    if (self::substr($str, $length - 1, 1) === ' ') {
      return self::substr($str, 0, $length - 1) . $strAddOn;
    }

    $str = self::substr($str, 0, $length);
    $array = explode(' ', $str);
    array_pop($array);
    $new_str = implode(' ', $array);

    if ($new_str === '') {
      $str = self::substr($str, 0, $length - 1) . $strAddOn;

    } else {
      $str = $new_str . $strAddOn;
    }

    return $str;
  }

  /**
   * Pad a UTF-8 string to given length with another string.
   *
   * @param string $str        <p>The input string.</p>
   * @param int    $pad_length <p>The length of return string.</p>
   * @param string $pad_string [optional] <p>String to use for padding the input string.</p>
   * @param int    $pad_type   [optional] <p>
   *                           Can be <strong>STR_PAD_RIGHT</strong> (default),
   *                           <strong>STR_PAD_LEFT</strong> or <strong>STR_PAD_BOTH</strong>
   *                           </p>
   *
   * @return string <strong>Returns the padded string</strong>
   */
  public static function str_pad($str, $pad_length, $pad_string = ' ', $pad_type = STR_PAD_RIGHT)
  {
    $str_length = self::strlen($str);

    if (
        is_int($pad_length) === true
        &&
        $pad_length > 0
        &&
        $pad_length >= $str_length
    ) {
      $ps_length = self::strlen($pad_string);

      $diff = $pad_length - $str_length;

      switch ($pad_type) {
        case STR_PAD_LEFT:

          $pre = str_repeat($pad_string, (int)ceil($diff / $ps_length));
          $pre = self::substr($pre, 0, $diff);
          $post = '';
          break;

        case STR_PAD_BOTH:
          $pre = str_repeat($pad_string, (int)ceil($diff / $ps_length / 2));
          $pre = self::substr($pre, 0, (int)$diff / 2);
          $post = str_repeat($pad_string, (int)ceil($diff / $ps_length / 2));
          $post = self::substr($post, 0, (int)ceil($diff / 2));
          break;

        case STR_PAD_RIGHT:
        default:

          $post = str_repeat($pad_string, (int)ceil($diff / $ps_length));
          $post = self::substr($post, 0, $diff);
          $pre = '';
      }

      return $pre . $str . $post;
    }

    return $str;
  }

  /**
   * Repeat a string.
   *
   * @param string $str        <p>
   *                           The string to be repeated.
   *                           </p>
   * @param int    $multiplier <p>
   *                           Number of time the input string should be
   *                           repeated.
   *                           </p>
   *                           <p>
   *                           multiplier has to be greater than or equal to 0.
   *                           If the multiplier is set to 0, the function
   *                           will return an empty string.
   *                           </p>
   *
   * @return string <p>The repeated string.</p>
   */
  public static function str_repeat($str, $multiplier)
  {
    $str = self::filter($str);

    return str_repeat($str, $multiplier);
  }

  /**
   * INFO: This is only a wrapper for "str_replace()"  -> the original functions is already UTF-8 safe.
   *
   * Replace all occurrences of the search string with the replacement string
   *
   * @link http://php.net/manual/en/function.str-replace.php
   *
   * @param mixed $search  <p>
   *                       The value being searched for, otherwise known as the needle.
   *                       An array may be used to designate multiple needles.
   *                       </p>
   * @param mixed $replace <p>
   *                       The replacement value that replaces found search
   *                       values. An array may be used to designate multiple replacements.
   *                       </p>
   * @param mixed $subject <p>
   *                       The string or array being searched and replaced on,
   *                       otherwise known as the haystack.
   *                       </p>
   *                       <p>
   *                       If subject is an array, then the search and
   *                       replace is performed with every entry of
   *                       subject, and the return value is an array as
   *                       well.
   *                       </p>
   * @param int   $count   [optional] If passed, this will hold the number of matched and replaced needles.
   *
   * @return mixed <p>This function returns a string or an array with the replaced values.</p>
   */
  public static function str_replace($search, $replace, $subject, &$count = null)
  {
    return str_replace($search, $replace, $subject, $count);
  }

  /**
   * Replace the first "$search"-term with the "$replace"-term.
   *
   * @param string $search
   * @param string $replace
   * @param string $subject
   *
   * @return string
   */
  public static function str_replace_first($search, $replace, $subject)
  {
    $pos = self::strpos($subject, $search);

    if ($pos !== false) {
      return self::substr_replace($subject, $replace, $pos, self::strlen($search));
    }

    return $subject;
  }

  /**
   * Shuffles all the characters in the string.
   *
   * @param string $str <p>The input string</p>
   *
   * @return string <p>The shuffled string.</p>
   */
  public static function str_shuffle($str)
  {
    $array = self::split($str);

    shuffle($array);

    return implode('', $array);
  }

  /**
   * Sort all characters according to code points.
   *
   * @param string $str    <p>A UTF-8 string.</p>
   * @param bool   $unique <p>Sort unique. If <strong>true</strong>, repeated characters are ignored.</p>
   * @param bool   $desc   <p>If <strong>true</strong>, will sort characters in reverse code point order.</p>
   *
   * @return string <p>String of sorted characters.</p>
   */
  public static function str_sort($str, $unique = false, $desc = false)
  {
    $array = self::codepoints($str);

    if ($unique) {
      $array = array_flip(array_flip($array));
    }

    if ($desc) {
      arsort($array);
    } else {
      asort($array);
    }

    return self::string($array);
  }

  /**
   * Split a string into an array.
   *
   * @param string $str
   * @param int    $len
   *
   * @return array
   */
  public static function str_split($str, $len = 1)
  {
    // init
    $len = (int)$len;
    $str = (string)$str;

    if (!isset($str[0])) {
      return array();
    }

    if ($len < 1) {
      return str_split($str, $len);
    }

    /** @noinspection PhpInternalEntityUsedInspection */
    preg_match_all('/' . Grapheme::GRAPHEME_CLUSTER_RX . '/u', $str, $a);
    $a = $a[0];

    if ($len === 1) {
      return $a;
    }

    $arrayOutput = array();
    $p = -1;

    /** @noinspection PhpForeachArrayIsUsedAsValueInspection */
    foreach ($a as $l => $a) {
      if ($l % $len) {
        $arrayOutput[$p] .= $a;
      } else {
        $arrayOutput[++$p] = $a;
      }
    }

    return $arrayOutput;
  }

  /**
   * Check if the string starts with the given substring.
   *
   * @param string $haystack <p>The string to search in.</p>
   * @param string $needle   <p>The substring to search for.</p>
   *
   * @return bool
   */
  public static function str_starts_with($haystack, $needle)

  {
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    if (self::strpos($haystack, $needle) === 0) {
      return true;
    }

    return false;
  }

  /**
   * Get a binary representation of a specific string.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return string
   */
  public static function str_to_binary($str)
  {
    $str = (string)$str;

    $value = unpack('H*', $str);

    return base_convert($value[1], 16, 2);
  }

  /**
   * Convert a string into an array of words.
   *
   * @param string $str
   * @param string $charlist
   *
   * @return array
   */
  public static function str_to_words($str, $charlist = '')
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return array('');
    }

    $charlist = self::rxClass($charlist, '\pL');

    return \preg_split("/({$charlist}+(?:[\p{Pd}’']{$charlist}+)*)/u", $str, -1, PREG_SPLIT_DELIM_CAPTURE);
  }

  /**
   * alias for "UTF8::to_ascii()"
   *
   * @see UTF8::to_ascii()
   *
   * @param string $str
   * @param string $unknown
   * @param bool   $strict
   *
   * @return string
   */
  public static function str_transliterate($str, $unknown = '?', $strict = false)
  {
    return self::to_ascii($str, $unknown, $strict);
  }

  /**
   * Counts number of words in the UTF-8 string.
   *
   * @param string $str      <p>The input string.</p>
   * @param int    $format   [optional] <p>
   *                         <strong>0</strong> => return a number of words (default)<br />
   *                         <strong>1</strong> => return an array of words<br />
   *                         <strong>2</strong> => return an array of words with word-offset as key
   *                         </p>
   * @param string $charlist [optional] <p>Additional chars that contains to words and do not start a new word.</p>
   *
   * @return array|int <p>The number of words in the string</p>
   */
  public static function str_word_count($str, $format = 0, $charlist = '')
  {
    $strParts = self::str_to_words($str, $charlist);

    $len = count($strParts);

    if ($format === 1) {

      $numberOfWords = array();
      for ($i = 1; $i < $len; $i += 2) {
        $numberOfWords[] = $strParts[$i];
      }

    } elseif ($format === 2) {

      $numberOfWords = array();
      $offset = self::strlen($strParts[0]);
      for ($i = 1; $i < $len; $i += 2) {
        $numberOfWords[$offset] = $strParts[$i];
        $offset += self::strlen($strParts[$i]) + self::strlen($strParts[$i + 1]);
      }

    } else {

      $numberOfWords = ($len - 1) / 2;

    }

    return $numberOfWords;
  }

  /**
   * Case-insensitive string comparison.
   *
   * INFO: Case-insensitive version of UTF8::strcmp()
   *
   * @param string $str1
   * @param string $str2
   *
   * @return int <p>
   *             <strong>&lt; 0</strong> if str1 is less than str2;<br />
   *             <strong>&gt; 0</strong> if str1 is greater than str2,<br />
   *             <strong>0</strong> if they are equal.
   *             </p>
   */
  public static function strcasecmp($str1, $str2)
  {
    return self::strcmp(self::strtocasefold($str1), self::strtocasefold($str2));
  }

  /**
   * alias for "UTF8::strstr()"
   *
   * @see UTF8::strstr()
   *
   * @param string  $haystack
   * @param string  $needle
   * @param bool    $before_needle
   * @param string  $encoding
   * @param boolean $cleanUtf8
   *
   * @return string|false
   */
  public static function strchr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    return self::strstr($haystack, $needle, $before_needle, $encoding, $cleanUtf8);
  }

  /**
   * Case-sensitive string comparison.
   *
   * @param string $str1
   * @param string $str2
   *
   * @return int  <p>
   *              <strong>&lt; 0</strong> if str1 is less than str2<br />
   *              <strong>&gt; 0</strong> if str1 is greater than str2<br />
   *              <strong>0</strong> if they are equal.
   *              </p>
   */
  public static function strcmp($str1, $str2)
  {
    /** @noinspection PhpUndefinedClassInspection */
    return $str1 . '' === $str2 . '' ? 0 : strcmp(
        \Normalizer::normalize($str1, \Normalizer::NFD),
        \Normalizer::normalize($str2, \Normalizer::NFD)
    );
  }

  /**
   * Find length of initial segment not matching mask.
   *
   * @param string $str
   * @param string $charList
   * @param int    $offset
   * @param int    $length
   *
   * @return int|null
   */
  public static function strcspn($str, $charList, $offset = 0, $length = 2147483647)
  {
    if ('' === $charList .= '') {
      return null;
    }

    if ($offset || 2147483647 !== $length) {
      $str = (string)self::substr($str, $offset, $length);
    }

    $str = (string)$str;
    if (!isset($str[0])) {
      return null;
    }

    if (preg_match('/^(.*?)' . self::rxClass($charList) . '/us', $str, $length)) {
      /** @noinspection OffsetOperationsInspection */
      return self::strlen($length[1]);
    }

    return self::strlen($str);
  }

  /**
   * alias for "UTF8::stristr()"
   *
   * @see UTF8::stristr()
   *
   * @param string  $haystack
   * @param string  $needle
   * @param bool    $before_needle
   * @param string  $encoding
   * @param boolean $cleanUtf8
   *
   * @return string|false
   */
  public static function strichr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    return self::stristr($haystack, $needle, $before_needle, $encoding, $cleanUtf8);
  }

  /**
   * Create a UTF-8 string from code points.
   *
   * INFO: opposite to UTF8::codepoints()
   *
   * @param array $array <p>Integer or Hexadecimal codepoints.</p>
   *
   * @return string <p>UTF-8 encoded string.</p>
   */
  public static function string(array $array)
  {
    return implode(
        '',
        array_map(
            array(
                '\\voku\\helper\\UTF8',
                'chr',
            ),
            $array
        )
    );
  }

  /**
   * Checks if string starts with "BOM" (Byte Order Mark Character) character.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return bool <p><strong>true</strong> if the string has BOM at the start, <strong>false</strong> otherwise.</p>
   */
  public static function string_has_bom($str)
  {
    foreach (self::$bom as $bomString => $bomByteLength) {
      if (0 === strpos($str, $bomString)) {
        return true;
      }
    }

    return false;
  }

  /**
   * Strip HTML and PHP tags from a string + clean invalid UTF-8.
   *
   * @link http://php.net/manual/en/function.strip-tags.php
   *
   * @param string  $str            <p>
   *                                The input string.
   *                                </p>
   * @param string  $allowable_tags [optional] <p>
   *                                You can use the optional second parameter to specify tags which should
   *                                not be stripped.
   *                                </p>
   *                                <p>
   *                                HTML comments and PHP tags are also stripped. This is hardcoded and
   *                                can not be changed with allowable_tags.
   *                                </p>
   * @param boolean $cleanUtf8      [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string <p>The stripped string.</p>
   */
  public static function strip_tags($str, $allowable_tags = null, $cleanUtf8 = false)
  {
    if ($cleanUtf8) {
      $str = self::clean($str);
    }

    return strip_tags($str, $allowable_tags);
  }

  /**
   * Finds position of first occurrence of a string within another, case insensitive.
   *
   * @link http://php.net/manual/en/function.mb-stripos.php
   *
   * @param string  $haystack  <p>
   *                           The string from which to get the position of the first occurrence
   *                           of needle
   *                           </p>
   * @param string  $needle    <p>
   *                           The string to find in haystack
   *                           </p>
   * @param int     $offset    [optional] <p>
   *                           The position in haystack
   *                           to start searching
   *                           </p>
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return int|false <p>
   *                   Return the numeric position of the first occurrence of needle in the haystack string,<br />
   *                   or false if needle is not found.
   *                   </p>
   */
  public static function stripos($haystack, $needle, $offset = null, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    if ($cleanUtf8 === true) {
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
      // if invalid characters are found in $haystack before $needle
      $haystack = self::clean($haystack);
      $needle = self::clean($needle);
    }

    if (

        $encoding === 'UTF-8'
        ||
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
    ) {
      $encoding = 'UTF-8';
    } else {
      $encoding = self::normalize_encoding($encoding);
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (
        $encoding == 'UTF-8' // INFO: "grapheme_stripos()" can't handle other encodings
        &&
        self::$support['intl'] === true
        &&
        Bootup::is_php('5.4')
    ) {
      return \grapheme_stripos($haystack, $needle, $offset);
    }

    // fallback to "mb_"-function via polyfill
    return \mb_stripos($haystack, $needle, $offset, $encoding);
  }

  /**
   * Returns all of haystack starting from and including the first occurrence of needle to the end.
   *
   * @param string  $haystack      <p>The input string. Must be valid UTF-8.</p>
   * @param string  $needle        <p>The string to look for. Must be valid UTF-8.</p>
   * @param bool    $before_needle [optional] <p>
   *                               If <b>TRUE</b>, grapheme_strstr() returns the part of the
   *                               haystack before the first occurrence of the needle (excluding the needle).
   *                               </p>
   * @param string  $encoding      [optional] <p>Set the charset for e.g. "\mb_" function</p>
   * @param boolean $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return false|string A sub-string,<br />or <strong>false</strong> if needle is not found.
   */
  public static function stristr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    if ($cleanUtf8 === true) {
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
      // if invalid characters are found in $haystack before $needle
      $needle = self::clean($needle);
      $haystack = self::clean($haystack);
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (

        $encoding !== 'UTF-8'
        &&
        self::$support['mbstring'] === false
    ) {
      trigger_error('UTF8::stristr() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
    }

    if (self::$support['mbstring'] === true) {
      return \mb_stristr($haystack, $needle, $before_needle, $encoding);
    }

    if (self::$support['intl'] === true) {
      return \grapheme_stristr($haystack, $needle, $before_needle);
    }

    preg_match('/^(.*?)' . preg_quote($needle, '/') . '/usi', $haystack, $match);

    if (!isset($match[1])) {
      return false;
    }

    if ($before_needle) {
      return $match[1];
    }

    return self::substr($haystack, self::strlen($match[1]));
  }

  /**
   * Get the string length, not the byte-length!
   *
   * @link     http://php.net/manual/en/function.mb-strlen.php
   *
   * @param string  $str       <p>The string being checked for length.</p>
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return int <p>The number of characters in the string $str having character encoding $encoding. (One multi-byte
   *             character counted as +1)</p>
   */
  public static function strlen($str, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return 0;
    }

    if (

        $encoding === 'UTF-8'
        ||
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
    ) {
      $encoding = 'UTF-8';
    } else {
      $encoding = self::normalize_encoding($encoding);
    }

    switch ($encoding) {
      case 'ASCII':
      case 'CP850':
        return strlen($str);
    }

    if ($cleanUtf8 === true) {
      $str = self::clean($str);
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (

        $encoding !== 'UTF-8'
        &&
        self::$support['mbstring'] === false
        &&
        self::$support['iconv'] === false
    ) {
      trigger_error('UTF8::strlen() without mbstring / iconv cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
    }

    if (
        $encoding !== 'UTF-8'
        &&
        self::$support['iconv'] === true
        &&
        self::$support['mbstring'] === false
    ) {
      $returnTmp = \iconv_strlen($str, $encoding);
      if ($returnTmp !== false) {
        return $returnTmp;
      }
    }

    if (self::$support['mbstring'] === true) {
      return \mb_strlen($str, $encoding);
    }

    if (self::$support['intl'] === true) {
      $str = self::clean($str);
      $returnTmp = \grapheme_strlen($str);
      if ($returnTmp !== null) {
        return $returnTmp;
      }
    }

    if (self::$support['iconv'] === true) {
      $returnTmp = \iconv_strlen($str, $encoding);
      if ($returnTmp !== false) {
        return $returnTmp;
      }
    }

    // fallback via vanilla php
    preg_match_all('/./us', $str, $parts);
    $returnTmp = count($parts[0]);
    if ($returnTmp !== 0) {
      return $returnTmp;
    }

    // fallback to "mb_"-function via polyfill
    return \mb_strlen($str);
  }

  /**
   * Case insensitive string comparisons using a "natural order" algorithm.
   *
   * INFO: natural order version of UTF8::strcasecmp()
   *
   * @param string $str1 <p>The first string.</p>
   * @param string $str2 <p>The second string.</p>
   *
   * @return int <strong>&lt; 0</strong> if str1 is less than str2<br />
   *             <strong>&gt; 0</strong> if str1 is greater than str2<br />
   *             <strong>0</strong> if they are equal
   */
  public static function strnatcasecmp($str1, $str2)
  {
    return self::strnatcmp(self::strtocasefold($str1), self::strtocasefold($str2));
  }

  /**
   * String comparisons using a "natural order" algorithm
   *
   * INFO: natural order version of UTF8::strcmp()
   *
   * @link  http://php.net/manual/en/function.strnatcmp.php
   *
   * @param string $str1 <p>The first string.</p>
   * @param string $str2 <p>The second string.</p>
   *
   * @return int <strong>&lt; 0</strong> if str1 is less than str2;<br />
   *             <strong>&gt; 0</strong> if str1 is greater than str2;<br />
   *             <strong>0</strong> if they are equal
   */
  public static function strnatcmp($str1, $str2)
  {
    return $str1 . '' === $str2 . '' ? 0 : strnatcmp(self::strtonatfold($str1), self::strtonatfold($str2));
  }

  /**
   * Case-insensitive string comparison of the first n characters.
   *
   * @link  http://php.net/manual/en/function.strncasecmp.php
   *
   * @param string $str1 <p>The first string.</p>
   * @param string $str2 <p>The second string.</p>
   * @param int    $len  <p>The length of strings to be used in the comparison.</p>
   *
   * @return int <strong>&lt; 0</strong> if <i>str1</i> is less than <i>str2</i>;<br />
   *             <strong>&gt; 0</strong> if <i>str1</i> is greater than <i>str2</i>;<br />
   *             <strong>0</strong> if they are equal
   */
  public static function strncasecmp($str1, $str2, $len)
  {
    return self::strncmp(self::strtocasefold($str1), self::strtocasefold($str2), $len);
  }

  /**
   * String comparison of the first n characters.
   *
   * @link  http://php.net/manual/en/function.strncmp.php
   *
   * @param string $str1 <p>The first string.</p>
   * @param string $str2 <p>The second string.</p>
   * @param int    $len  <p>Number of characters to use in the comparison.</p>
   *
   * @return int <strong>&lt; 0</strong> if <i>str1</i> is less than <i>str2</i>;<br />
   *             <strong>&gt; 0</strong> if <i>str1</i> is greater than <i>str2</i>;<br />
   *             <strong>0</strong> if they are equal
   */
  public static function strncmp($str1, $str2, $len)
  {
    $str1 = self::substr($str1, 0, $len);
    $str2 = self::substr($str2, 0, $len);

    return self::strcmp($str1, $str2);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
  }

  /**
   * Search a string for any of a set of characters.
   *
   * @link  http://php.net/manual/en/function.strpbrk.php
   *
   * @param string $haystack  <p>The string where char_list is looked for.</p>
   * @param string $char_list <p>This parameter is case sensitive.</p>
   *
   * @return string String starting from the character found, or false if it is not found.
   */
  public static function strpbrk($haystack, $char_list)
  {
    $haystack = (string)$haystack;
    $char_list = (string)$char_list;

    if (!isset($haystack[0], $char_list[0])) {
      return false;
    }

    if (preg_match('/' . self::rxClass($char_list) . '/us', $haystack, $m)) {
      return substr($haystack, strpos($haystack, $m[0]));
    } else {
      return false;
    }
  }

  /**
   * Find position of first occurrence of string in a string.
   *
   * @link http://php.net/manual/en/function.mb-strpos.php
   *
   * @param string  $haystack  <p>The string being checked.</p>
   * @param string  $needle    <p>The position counted from the beginning of haystack.</p>
   * @param int     $offset    [optional] <p>The search offset. If it is not specified, 0 is used.</p>
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return int|false <p>
   *                   The numeric position of the first occurrence of needle in the haystack string.<br />
   *                   If needle is not found it returns false.
   *                   </p>
   */
  public static function strpos($haystack, $needle, $offset = 0, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    // init
    $offset = (int)$offset;

    // iconv and mbstring do not support integer $needle

    if (((int)$needle) === $needle && ($needle >= 0)) {

      $needle = (string)self::chr($needle);
    }

    if ($cleanUtf8 === true) {
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
      // if invalid characters are found in $haystack before $needle
      $needle = self::clean($needle);
      $haystack = self::clean($haystack);
    }

    if (

        $encoding === 'UTF-8'
        ||
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
    ) {
      $encoding = 'UTF-8';
    } else {
      $encoding = self::normalize_encoding($encoding);
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (

        $encoding !== 'UTF-8'
// Returns always int(0).
return 0 === $foo & 4;
return (0 === $foo) & 4;

// More likely intended return: true/false
return 0 === ($foo & 4);
        &
        self::$support['iconv'] === true
        &&
        self::$support['mbstring'] === false
    ) {
      trigger_error('UTF8::strpos() without mbstring / iconv cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
    }

    if (
        $offset >= 0 // iconv_strpos() can't handle negative offset
        &&
        $encoding !== 'UTF-8'
        &&
        self::$support['mbstring'] === false
        &&
        self::$support['iconv'] === true
    ) {
      // ignore invalid negative offset to keep compatibility
      // with php < 5.5.35, < 5.6.21, < 7.0.6

      return \iconv_strpos($haystack, $needle, $offset > 0 ? $offset : 0, $encoding);
    }

    if (self::$support['mbstring'] === true) {
      return \mb_strpos($haystack, $needle, $offset, $encoding);
    }

    if (self::$support['intl'] === true) {

      $returnTmp = \grapheme_strpos($haystack, $needle, $offset);
      if ($returnTmp !== false) {
        return $returnTmp;
      }
    }

    if (
        $offset >= 0 // iconv_strpos() can't handle negative offset
        &&
        self::$support['iconv'] === true
    ) {
      // ignore invalid negative offset to keep compatibility
      // with php < 5.5.35, < 5.6.21, < 7.0.6

      return \iconv_strpos($haystack, $needle, $offset > 0 ? $offset : 0, $encoding);
    }

    // fallback via vanilla php

    $haystack = self::substr($haystack, $offset);

    if ($offset < 0) {
      $offset = 0;
    }

    $pos = strpos($haystack, $needle);
    if ($pos === false) {
      return false;
    }

    $returnTmp = $offset + self::strlen(substr($haystack, 0, $pos));
    if ($returnTmp !== false) {
      return $returnTmp;
    }

    // fallback to "mb_"-function via polyfill
    return \mb_strpos($haystack, $needle, $offset);
  }

  /**
   * Finds the last occurrence of a character in a string within another.
   *
   * @link http://php.net/manual/en/function.mb-strrchr.php
   *
   * @param string $haystack      <p>The string from which to get the last occurrence of needle.</p>
   * @param string $needle        <p>The string to find in haystack</p>
   * @param bool   $before_needle [optional] <p>
   *                              Determines which portion of haystack
   *                              this function returns.
   *                              If set to true, it returns all of haystack
   *                              from the beginning to the last occurrence of needle.
   *                              If set to false, it returns all of haystack
   *                              from the last occurrence of needle to the end,
   *                              </p>
   * @param string $encoding      [optional] <p>
   *                              Character encoding name to use.
   *                              If it is omitted, internal character encoding is used.
   *                              </p>
   * @param bool   $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string|false The portion of haystack or false if needle is not found.
   */
  public static function strrchr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)

  {
    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    if ($cleanUtf8 === true) {
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
      // if invalid characters are found in $haystack before $needle
      $needle = self::clean($needle);
      $haystack = self::clean($haystack);
    }

    // fallback to "mb_"-function via polyfill
    return \mb_strrchr($haystack, $needle, $before_needle, $encoding);
  }

  /**
   * Reverses characters order in the string.
   *
   * @param string $str The input string
   *
   * @return string The string with characters in the reverse sequence
   */
  public static function strrev($str)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    return implode('', array_reverse(self::split($str)));
  }

  /**
   * Finds the last occurrence of a character in a string within another, case insensitive.
   *
   * @link http://php.net/manual/en/function.mb-strrichr.php
   *
   * @param string  $haystack      <p>The string from which to get the last occurrence of needle.</p>
   * @param string  $needle        <p>The string to find in haystack.</p>
   * @param bool    $before_needle [optional] <p>
   *                               Determines which portion of haystack
   *                               this function returns.
   *                               If set to true, it returns all of haystack
   *                               from the beginning to the last occurrence of needle.
   *                               If set to false, it returns all of haystack
   *                               from the last occurrence of needle to the end,
   *                               </p>
   * @param string  $encoding      [optional] <p>
   *                               Character encoding name to use.
   *                               If it is omitted, internal character encoding is used.
   *                               </p>
   * @param boolean $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string|false <p>The portion of haystack or<br />false if needle is not found.</p>
   */
  public static function strrichr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)

  {
    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    if ($cleanUtf8 === true) {
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
      // if invalid characters are found in $haystack before $needle
      $needle = self::clean($needle);
      $haystack = self::clean($haystack);
    }

    return \mb_strrichr($haystack, $needle, $before_needle, $encoding);
  }

  /**
   * Find position of last occurrence of a case-insensitive string.
   *
   * @param string  $haystack  <p>The string to look in.</p>
   * @param string  $needle    <p>The string to look for.</p>
   * @param int     $offset    [optional] <p>Number of characters to ignore in the beginning or end.</p>
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return int|false <p>
   *                   The numeric position of the last occurrence of needle in the haystack string.<br />If needle is
   *                   not found, it returns false.
   *                   </p>
   */
  public static function strripos($haystack, $needle, $offset = 0, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    if ((int)$needle === $needle && $needle >= 0) {

      $needle = (string)self::chr($needle);
    }

    // init
    $haystack = (string)$haystack;
    $needle = (string)$needle;
    $offset = (int)$offset;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    if (

        $cleanUtf8 === true
        ||
        $encoding === true // INFO: the "bool"-check is only a fallback for old versions
    ) {
      // \mb_strripos && iconv_strripos is not tolerant to invalid characters

      $needle = self::clean($needle);
      $haystack = self::clean($haystack);
    }

    if (

        $encoding === 'UTF-8'
        ||
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
    ) {
      $encoding = 'UTF-8';
    } else {
      $encoding = self::normalize_encoding($encoding);
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (

        $encoding !== 'UTF-8'
        &&
        self::$support['mbstring'] === false
    ) {
      trigger_error('UTF8::strripos() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
    }

    if (self::$support['mbstring'] === true) {
      return \mb_strripos($haystack, $needle, $offset, $encoding);
    }

    if (self::$support['intl'] === true) {

      $returnTmp = \grapheme_strripos($haystack, $needle, $offset);
      if ($returnTmp !== false) {
        return $returnTmp;
      }
    }

    // fallback via vanilla php

    return self::strrpos(self::strtonatfold($haystack), self::strtonatfold($needle), $offset, $encoding, $cleanUtf8);
  }

  /**
   * Find position of last occurrence of a string in a string.
   *
   * @link http://php.net/manual/en/function.mb-strrpos.php
   *
   * @param string     $haystack  <p>The string being checked, for the last occurrence of needle</p>
   * @param string|int $needle    <p>The string to find in haystack.<br />Or a code point as int.</p>
   * @param int        $offset    [optional] <p>May be specified to begin searching an arbitrary number of characters
   *                              into the string. Negative values will stop searching at an arbitrary point prior to
   *                              the end of the string.
   *                              </p>
   * @param string     $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
   * @param boolean    $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return int|false <p>The numeric position of the last occurrence of needle in the haystack string.<br />If needle
   *                   is not found, it returns false.</p>
   */
  public static function strrpos($haystack, $needle, $offset = null, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    if ((int)$needle === $needle && $needle >= 0) {
      $needle = (string)self::chr($needle);
    }

    // init
    $haystack = (string)$haystack;
    $needle = (string)$needle;
    $offset = (int)$offset;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    if (

        $cleanUtf8 === true
        ||
        $encoding === true // INFO: the "bool"-check is only a fallback for old versions
    ) {
      // \mb_strrpos && iconv_strrpos is not tolerant to invalid characters
      $needle = self::clean($needle);
      $haystack = self::clean($haystack);
    }

    if (

        $encoding === 'UTF-8'
        ||
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
    ) {
      $encoding = 'UTF-8';
    } else {
      $encoding = self::normalize_encoding($encoding);
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (

        $encoding !== 'UTF-8'
        &&
        self::$support['mbstring'] === false
    ) {
      trigger_error('UTF8::strrpos() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
    }

    if (self::$support['mbstring'] === true) {

      $returnTmp = \mb_strrpos($haystack, $needle, $offset, $encoding);
      if ($returnTmp !== false) {
        return $returnTmp;
      }
    }

    if (self::$support['intl'] === true) {

      $returnTmp = \grapheme_strrpos($haystack, $needle, $offset);
      if ($returnTmp !== false) {
        return $returnTmp;
      }
    }

    // fallback via vanilla php

    if ($offset > 0) {
      $haystack = self::substr($haystack, $offset);
    } elseif ($offset < 0) {
      $haystack = self::substr($haystack, 0, $offset);
      $offset = 0;
    }

    $pos = strrpos($haystack, $needle);
    if ($pos === false) {
      return false;
    }

    return $offset + self::strlen(substr($haystack, 0, $pos));
  }

  /**
   * Finds the length of the initial segment of a string consisting entirely of characters contained within a given
   * mask.
   *
   * @param string $str    <p>The input string.</p>
   * @param string $mask   <p>The mask of chars</p>
   * @param int    $offset [optional]
   * @param int    $length [optional]
   *
   * @return int
   */
  public static function strspn($str, $mask, $offset = 0, $length = 2147483647)
  {
    // init
    $length = (int)$length;
    $offset = (int)$offset;

    if ($offset || 2147483647 !== $length) {
      $str = self::substr($str, $offset, $length);
    }

    $str = (string)$str;
    if (!isset($str[0], $mask[0])) {
      return 0;
    }

    return preg_match('/^' . self::rxClass($mask) . '+/u', $str, $str) ? self::strlen($str[0]) : 0;
  }

  /**
   * Returns part of haystack string from the first occurrence of needle to the end of haystack.
   *
   * @param string  $haystack      <p>The input string. Must be valid UTF-8.</p>
   * @param string  $needle        <p>The string to look for. Must be valid UTF-8.</p>
   * @param bool    $before_needle [optional] <p>
   *                               If <b>TRUE</b>, strstr() returns the part of the
   *                               haystack before the first occurrence of the needle (excluding the needle).
   *                               </p>
   * @param string  $encoding      [optional] <p>Set the charset for e.g. "\mb_" function.</p>
   * @param boolean $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string|false A sub-string,<br />or <strong>false</strong> if needle is not found.
   */
  public static function strstr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    if ($cleanUtf8 === true) {
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
      // if invalid characters are found in $haystack before $needle
      $needle = self::clean($needle);
      $haystack = self::clean($haystack);
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (

        $encoding !== 'UTF-8'
        &&
        self::$support['mbstring'] === false
    ) {
      trigger_error('UTF8::strstr() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
    }

    if (self::$support['mbstring'] === true) {
      $returnTmp = \mb_strstr($haystack, $needle, $before_needle, $encoding);
      if ($returnTmp !== false) {
        return $returnTmp;
      }
    }

    if (self::$support['intl'] === true) {
      $returnTmp = \grapheme_strstr($haystack, $needle, $before_needle);
      if ($returnTmp !== false) {
        return $returnTmp;
      }
    }

    preg_match('/^(.*?)' . preg_quote($needle, '/') . '/us', $haystack, $match);

    if (!isset($match[1])) {
      return false;
    }

    if ($before_needle) {
      return $match[1];
    }

    return self::substr($haystack, self::strlen($match[1]));
  }

  /**
   * Unicode transformation for case-less matching.
   *
   * @link http://unicode.org/reports/tr21/tr21-5.html
   *
   * @param string  $str       <p>The input string.</p>
   * @param bool    $full      [optional] <p>
   *                           <b>true</b>, replace full case folding chars (default)<br />
   *                           <b>false</b>, use only limited static array [UTF8::$commonCaseFold]
   *                           </p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string
   */
  public static function strtocasefold($str, $full = true, $cleanUtf8 = false)
  {
    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    static $COMMON_CASE_FOLD_KEYS_CACHE = null;
    static $COMMAN_CASE_FOLD_VALUES_CACHE = null;

    if ($COMMON_CASE_FOLD_KEYS_CACHE === null) {
      $COMMON_CASE_FOLD_KEYS_CACHE = array_keys(self::$commonCaseFold);
      $COMMAN_CASE_FOLD_VALUES_CACHE = array_values(self::$commonCaseFold);
    }

    $str = str_replace($COMMON_CASE_FOLD_KEYS_CACHE, $COMMAN_CASE_FOLD_VALUES_CACHE, $str);

    if ($full) {

      static $fullCaseFold = null;

      if ($fullCaseFold === null) {
        $fullCaseFold = self::getData('caseFolding_full');
      }

      /** @noinspection OffsetOperationsInspection */
      $str = str_replace($fullCaseFold[0], $fullCaseFold[1], $str);
    }

    if ($cleanUtf8 === true) {
      $str = self::clean($str);
    }

    return self::strtolower($str);
  }

  /**
   * Make a string lowercase.
   *
   * @link http://php.net/manual/en/function.mb-strtolower.php
   *
   * @param string  $str       <p>The string being lowercased.</p>
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string str with all alphabetic characters converted to lowercase.
   */
  public static function strtolower($str, $encoding = 'UTF-8', $cleanUtf8 = false)

  {
    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    if ($cleanUtf8 === true) {
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
      // if invalid characters are found in $haystack before $needle
      $str = self::clean($str);
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    return \mb_strtolower($str, $encoding);
  }

  /**
   * Generic case sensitive transformation for collation matching.
   *
   * @param string $str <p>The input string</p>
   *
   * @return string
   */
  private static function strtonatfold($str)
  {
    /** @noinspection PhpUndefinedClassInspection */
    return preg_replace('/\p{Mn}+/u', '', \Normalizer::normalize($str, \Normalizer::NFD));
  }

  /**
   * Make a string uppercase.
   *
   * @link http://php.net/manual/en/function.mb-strtoupper.php
   *
   * @param string  $str       <p>The string being uppercased.</p>
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string str with all alphabetic characters converted to uppercase.
   */
  public static function strtoupper($str, $encoding = 'UTF-8', $cleanUtf8 = false)

  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    if ($cleanUtf8 === true) {
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
      // if invalid characters are found in $haystack before $needle
      $str = self::clean($str);
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    return \mb_strtoupper($str, $encoding);
  }

  /**
   * Translate characters or replace sub-strings.
   *
   * @link  http://php.net/manual/en/function.strtr.php
   *
   * @param string          $str  <p>The string being translated.</p>
   * @param string|string[] $from <p>The string replacing from.</p>
   * @param string|string[] $to   <p>The string being translated to to.</p>
   *
   * @return string <p>
   *                This function returns a copy of str, translating all occurrences of each character in from to the
   *                corresponding character in to.
   *                </p>
   */
  public static function strtr($str, $from, $to = INF)
  {
    if (INF !== $to) {
      $from = self::str_split($from);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
      $to = self::str_split($to);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
      $countFrom = count($from);
      $countTo = count($to);

      if ($countFrom > $countTo) {
        $from = array_slice($from, 0, $countTo);
      } elseif ($countFrom < $countTo) {
        $to = array_slice($to, 0, $countFrom);
      }

      $from = array_combine($from, $to);
    }

    return strtr($str, $from);

  }

  /**
   * Return the width of a string.
   *
   * @param string  $str       <p>The input string.</p>
   * @param string  $encoding  [optional] <p>Default is UTF-8</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return int
   */
  public static function strwidth($str, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    if ($cleanUtf8 === true) {
      // iconv and mbstring are not tolerant to invalid encoding
      // further, their behaviour is inconsistent with that of PHP's substr
      $str = self::clean($str);
    }

    // fallback to "mb_"-function via polyfill
    return \mb_strwidth($str, $encoding);
  }

  /**
   * Get part of a string.
   *
   * @link http://php.net/manual/en/function.mb-substr.php
   *
   * @param string  $str       <p>The string being checked.</p>
   * @param int     $start     <p>The first position used in str.</p>
   * @param int     $length    [optional] <p>The maximum length of the returned string.</p>
   * @param string  $encoding  [optional] <p>Default is UTF-8</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string <p>Returns a sub-string specified by the start and length parameters.</p>
   */
  public static function substr($str, $start = 0, $length = null, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    if ($cleanUtf8 === true) {
      // iconv and mbstring are not tolerant to invalid encoding
      // further, their behaviour is inconsistent with that of PHP's substr
      $str = self::clean($str);
    }

    $str_length = 0;
    if ($start || $length === null) {
      $str_length = (int)self::strlen($str);
    }

    if ($start && $start > $str_length) {
      return false;
    }

    if ($length === null) {
      $length = $str_length;
    } else {
      $length = (int)$length;
    }

    if (

        $encoding === 'UTF-8'
        ||
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
    ) {
      $encoding = 'UTF-8';
    } else {
      $encoding = self::normalize_encoding($encoding);
    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (

        $encoding !== 'UTF-8'
        &&
        self::$support['mbstring'] === false
    ) {
      trigger_error('UTF8::substr() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
    }

    if (self::$support['mbstring'] === true) {
      return \mb_substr($str, $start, $length, $encoding);
    }

    if (
        $length >= 0 // "iconv_substr()" can't handle negative length
        &&
        self::$support['iconv'] === true
    ) {
      return \iconv_substr($str, $start, $length);
    }

    if (self::$support['intl'] === true) {
      return \grapheme_substr($str, $start, $length);
    }

    // fallback via vanilla php

    // split to array, and remove invalid characters
    $array = self::split($str);

    // extract relevant part, and join to make sting again
    return implode('', array_slice($array, $start, $length));
  }

  /**
   * Binary safe comparison of two strings from an offset, up to length characters.
   *
   * @param string  $main_str           <p>The main string being compared.</p>
   * @param string  $str                <p>The secondary string being compared.</p>
   * @param int     $offset             <p>The start position for the comparison. If negative, it starts counting from
   *                                    the end of the string.</p>
   * @param int     $length             [optional] <p>The length of the comparison. The default value is the largest of
   *                                    the length of the str compared to the length of main_str less the offset.</p>
   * @param boolean $case_insensitivity [optional] <p>If case_insensitivity is TRUE, comparison is case
   *                                    insensitive.</p>
   *
   * @return int
   */
  public static function substr_compare($main_str, $str, $offset, $length = 2147483647, $case_insensitivity = false)
  {
    $main_str = self::substr($main_str, $offset, $length);
    $str = self::substr($str, 0, self::strlen($main_str));
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

    return $case_insensitivity === true ? self::strcasecmp($main_str, $str) : self::strcmp($main_str, $str);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
  }

  /**
   * Count the number of substring occurrences.
   *
   * @link  http://php.net/manual/en/function.substr-count.php
   *
   * @param string  $haystack  <p>The string to search in.</p>
   * @param string  $needle    <p>The substring to search for.</p>
   * @param int     $offset    [optional] <p>The offset where to start counting.</p>
   * @param int     $length    [optional] <p>
   *                           The maximum length after the specified offset to search for the
   *                           substring. It outputs a warning if the offset plus the length is
   *                           greater than the haystack length.
   *                           </p>
   * @param string  $encoding  <p>Set the charset for e.g. "\mb_" function.</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return int|false <p>This functions returns an integer or false if there isn't a string.</p>
   */
  public static function substr_count($haystack, $needle, $offset = 0, $length = null, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    // init
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0], $needle[0])) {
      return false;
    }

    if ($offset || $length) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
      $offset = (int)$offset;
      $length = (int)$length;

      if (
          $length + $offset <= 0
          &&
          Bootup::is_php('7.1') === false
      ) {
        return false;
      }

      $haystack = self::substr($haystack, $offset, $length, $encoding);
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    if ($cleanUtf8 === true) {
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
      // if invalid characters are found in $haystack before $needle
      $needle = self::clean($needle);
      $haystack = self::clean($haystack);

    }

    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
      self::checkForSupport();
    }

    if (

        $encoding !== 'UTF-8'
        &&
        self::$support['mbstring'] === false
    ) {
      trigger_error('UTF8::substr_count() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
    }

    if (self::$support['mbstring'] === true) {
      return \mb_substr_count($haystack, $needle, $encoding);
    }

    preg_match_all('/' . preg_quote($needle, '/') . '/us', $haystack, $matches, PREG_SET_ORDER);

    return count($matches);
  }

  /**
   * Removes an prefix ($needle) from start of the string ($haystack), case insensitive.
   *
   * @param string $haystack <p>The string to search in.</p>
   * @param string $needle   <p>The substring to search for.</p>
   *
   * @return string <p>Return the sub-string.</p>
   */
  public static function substr_ileft($haystack, $needle)

  {
    // init
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0])) {
      return '';
    }

    if (!isset($needle[0])) {
      return $haystack;
    }

    if (self::str_istarts_with($haystack, $needle) === true) {
      $haystack = self::substr($haystack, self::strlen($needle));
    }

    return $haystack;
  }

  /**
   * Removes an suffix ($needle) from end of the string ($haystack), case insensitive.
   *
   * @param string $haystack <p>The string to search in.</p>
   * @param string $needle   <p>The substring to search for.</p>
   *
   * @return string <p>Return the sub-string.</p>
   */
  public static function substr_iright($haystack, $needle)

  {
    // init
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0])) {
      return '';
    }

    if (!isset($needle[0])) {
      return $haystack;
    }

    if (self::str_iends_with($haystack, $needle) === true) {
      $haystack = self::substr($haystack, 0, self::strlen($haystack) - self::strlen($needle));
    }

    return $haystack;
  }

  /**
   * Removes an prefix ($needle) from start of the string ($haystack).
   *
   * @param string $haystack <p>The string to search in.</p>
   * @param string $needle   <p>The substring to search for.</p>
   *
   * @return string <p>Return the sub-string.</p>
   */
  public static function substr_left($haystack, $needle)

  {
    // init
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0])) {
      return '';
    }

    if (!isset($needle[0])) {
      return $haystack;
    }

    if (self::str_starts_with($haystack, $needle) === true) {
      $haystack = self::substr($haystack, self::strlen($needle));
    }

    return $haystack;
  }

  /**
   * Replace text within a portion of a string.
   *
   * source: https://gist.github.com/stemar/8287074
   *
   * @param string|string[] $str              <p>The input string or an array of stings.</p>
   * @param string|string[] $replacement      <p>The replacement string or an array of stings.</p>
   * @param int|int[]       $start            <p>
   *                                          If start is positive, the replacing will begin at the start'th offset
   *                                          into string.
   *                                          <br /><br />
   *                                          If start is negative, the replacing will begin at the start'th character
   *                                          from the end of string.
   *                                          </p>
   * @param int|int[]|void  $length           [optional] <p>If given and is positive, it represents the length of the
   *                                          portion of string which is to be replaced. If it is negative, it
   *                                          represents the number of characters from the end of string at which to
   *                                          stop replacing. If it is not given, then it will default to strlen(
   *                                          string ); i.e. end the replacing at the end of string. Of course, if
   *                                          length is zero then this function will have the effect of inserting
   *                                          replacement into string at the given start offset.</p>
   *
   * @return string|string[] <p>The result string is returned. If string is an array then array is returned.</p>
   */
  public static function substr_replace($str, $replacement, $start, $length = null)
  {
    if (is_array($str)) {
      $num = count($str);

      // $replacement
      if (is_array($replacement)) {
        $replacement = array_slice($replacement, 0, $num);
      } else {
        $replacement = array_pad(array($replacement), $num, $replacement);
      }

      // $start
      if (is_array($start)) {

        $start = array_slice($start, 0, $num);
        foreach ($start as &$valueTmp) {
          $valueTmp = (int)$valueTmp === $valueTmp ? $valueTmp : 0;
        }
        unset($valueTmp);
      } else {
        $start = array_pad(array($start), $num, $start);
      }

      // $length
      if (!isset($length)) {
        $length = array_fill(0, $num, 0);
      } elseif (is_array($length)) {

        $length = array_slice($length, 0, $num);
        foreach ($length as &$valueTmpV2) {
          if (isset($valueTmpV2)) {
            $valueTmpV2 = (int)$valueTmpV2 === $valueTmpV2 ? $valueTmpV2 : $num;
          } else {
            $valueTmpV2 = 0;
          }
        }
        unset($valueTmpV2);
      } else {
        $length = array_pad(array($length), $num, $length);
      }

      // Recursive call
      return array_map(array(__CLASS__, 'substr_replace'), $str, $replacement, $start, $length);

    } else {

      if (is_array($replacement)) {
        if (count($replacement) > 0) {
          $replacement = $replacement[0];
        } else {
          $replacement = '';
        }
      }
    }

    // init
    $str = (string)$str;
    $replacement = (string)$replacement;

    if (!isset($str[0])) {
      return $replacement;
    }

    preg_match_all('/./us', $str, $smatches);
    preg_match_all('/./us', $replacement, $rmatches);

    if ($length === null) {
      $length = (int)self::strlen($str);
    }

    array_splice($smatches[0], $start, $length, $rmatches[0]);

    return implode('', $smatches[0]);
  }

  /**
   * Removes an suffix ($needle) from end of the string ($haystack).
   *
   * @param string $haystack <p>The string to search in.</p>
   * @param string $needle   <p>The substring to search for.</p>
   *
   * @return string <p>Return the sub-string.</p>
   */
  public static function substr_right($haystack, $needle)

  {
    $haystack = (string)$haystack;
    $needle = (string)$needle;

    if (!isset($haystack[0])) {
      return '';
    }

    if (!isset($needle[0])) {
      return $haystack;
    }

    if (self::str_ends_with($haystack, $needle) === true) {
      $haystack = self::substr($haystack, 0, self::strlen($haystack) - self::strlen($needle));
    }

    return $haystack;
  }

  /**
   * Returns a case swapped version of the string.
   *
   * @param string  $str       <p>The input string.</p>
   * @param string  $encoding  [optional] <p>Default is UTF-8</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string <p>Each character's case swapped.</p>
   */
  public static function swapCase($str, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    if ($encoding !== 'UTF-8') {
      $encoding = self::normalize_encoding($encoding);
    }

    if ($cleanUtf8 === true) {
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
      // if invalid characters are found in $haystack before $needle
      $str = self::clean($str);
    }

    $strSwappedCase = preg_replace_callback(
        '/[\S]/u',
        function ($match) use ($encoding) {
          $marchToUpper = UTF8::strtoupper($match[0], $encoding);

          if ($match[0] === $marchToUpper) {
            return UTF8::strtolower($match[0], $encoding);
          } else {
            return $marchToUpper;
          }
        },
        $str
    );

    return $strSwappedCase;
  }

  /**
   * alias for "UTF8::to_ascii()"
   *
   * @see UTF8::to_ascii()
   *
   * @param string $s
   * @param string $subst_chr
   * @param bool   $strict
   *
   * @return string
   *
   * @deprecated
   */
  public static function toAscii($s, $subst_chr = '?', $strict = false)
  {
    return self::to_ascii($s, $subst_chr, $strict);
  }

  /**
   * alias for "UTF8::to_iso8859()"
   *
   * @see UTF8::to_iso8859()
   *
   * @param string $str
   *
   * @return string|string[]
   *
   * @deprecated
   */
  public static function toIso8859($str)
  {
    return self::to_iso8859($str);
  }

  /**
   * alias for "UTF8::to_latin1()"
   *
   * @see UTF8::to_latin1()
   *
   * @param $str
   *
   * @return string
   *
   * @deprecated
   */
  public static function toLatin1($str)
  {
    return self::to_latin1($str);
  }

  /**
   * alias for "UTF8::to_utf8()"
   *
   * @see UTF8::to_utf8()
   *
   * @param string $str
   *
   * @return string
   *
   * @deprecated
   */
  public static function toUTF8($str)
  {
    return self::to_utf8($str);
  }

  /**
   * Convert a string into ASCII.
   *
   * @param string $str     <p>The input string.</p>
   * @param string $unknown [optional] <p>Character use if character unknown. (default is ?)</p>
   * @param bool   $strict  [optional] <p>Use "transliterator_transliterate()" from PHP-Intl | WARNING: bad
   *                        performance</p>
   *
   * @return string
   *
   * @throws \Exception
   */
  public static function to_ascii($str, $unknown = '?', $strict = false)
  {
    static $UTF8_TO_ASCII;

    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    $str = self::clean($str, true, true, true);

    // check if we only have ASCII
    if (self::is_ascii($str) === true) {
      return $str;
    }

    if ($strict === true) {
      if (!isset(self::$support['already_checked_via_portable_utf8'])) {
        self::checkForSupport();
      }

      if (self::$support['intl'] === true && Bootup::is_php('5.4')) {

        // HACK for issue from "transliterator_transliterate()"
        $str = str_replace(
            'ℌ',
            'H',
            $str
        );

        $str = transliterator_transliterate('Any-Latin; Latin-ASCII;', $str);

        // check again, if we only have ASCII, now ...
        if (self::is_ascii($str) === true) {
          return $str;
        }

      } else {
        throw new \Exception('Intl is not supported or you use PHP < 5.4!');
      }
    }

    preg_match_all('/.{1}|[^\x00]{1,1}$/us', $str, $ar);
    $chars = $ar[0];
    foreach ($chars as &$c) {

      $ordC0 = ord($c[0]);

      if ($ordC0 >= 0 && $ordC0 <= 127) {
        continue;
      }

      $ordC1 = ord($c[1]);

      // ASCII - next please
      if ($ordC0 >= 192 && $ordC0 <= 223) {
        $ord = ($ordC0 - 192) * 64 + ($ordC1 - 128);
      }

      if ($ordC0 >= 224) {
        $ordC2 = ord($c[2]);

        if ($ordC0 <= 239) {
          $ord = ($ordC0 - 224) * 4096 + ($ordC1 - 128) * 64 + ($ordC2 - 128);
        }

        if ($ordC0 >= 240) {
          $ordC3 = ord($c[3]);

          if ($ordC0 <= 247) {
            $ord = ($ordC0 - 240) * 262144 + ($ordC1 - 128) * 4096 + ($ordC2 - 128) * 64 + ($ordC3 - 128);
          }

          if ($ordC0 >= 248) {
            $ordC4 = ord($c[4]);

            if ($ordC0 <= 251) {

              $ord = ($ordC0 - 248) * 16777216 + ($ordC1 - 128) * 262144 + ($ordC2 - 128) * 4096 + ($ordC3 - 128) * 64 + ($ordC4 - 128);
            }

            if ($ordC0 >= 252) {
              $ordC5 = ord($c[5]);

              if ($ordC0 <= 253) {

                $ord = ($ordC0 - 252) * 1073741824 + ($ordC1 - 128) * 16777216 + ($ordC2 - 128) * 262144 + ($ordC3 - 128) * 4096 + ($ordC4 - 128) * 64 + ($ordC5 - 128);
              }
            }
          }
        }
      }

      if ($ordC0 == 254 || $ordC0 == 255) {
        $c = $unknown;
        continue;
      }

      if (!isset($ord)) {
        $c = $unknown;
        continue;
      }

      $bank = $ord >> 8;
      if (!isset($UTF8_TO_ASCII[$bank])) {
        $UTF8_TO_ASCII[$bank] = self::getData(sprintf('x%02x', $bank));
        if ($UTF8_TO_ASCII[$bank] === false) {
          $UTF8_TO_ASCII[$bank] = array();
        }
      }

      $newchar = $ord & 255;

      if (isset($UTF8_TO_ASCII[$bank], $UTF8_TO_ASCII[$bank][$newchar])) {

        // keep for debugging
        /*

        echo "file: " . sprintf('x%02x', $bank) . "\n";
        echo "char: " . $c . "\n";
        echo "ord: " . $ord . "\n";
        echo "newchar: " . $newchar . "\n";
        echo "ascii: " . $UTF8_TO_ASCII[$bank][$newchar] . "\n";
        echo "bank:" . $bank . "\n\n";
        */

        $c = $UTF8_TO_ASCII[$bank][$newchar];
      } else {

        // keep for debugging missing chars
        /*

        echo "file: " . sprintf('x%02x', $bank) . "\n";
        echo "char: " . $c . "\n";
        echo "ord: " . $ord . "\n";
        echo "newchar: " . $newchar . "\n";
        echo "bank:" . $bank . "\n\n";
        */

        $c = $unknown;
      }
    }

    return implode('', $chars);
  }

  /**
   * Convert a string into "ISO-8859"-encoding (Latin-1).
   *
   * @param string|string[] $str
   *
   * @return string|string[]
   */
  public static function to_iso8859($str)
  {
    if (is_array($str)) {

      /** @noinspection ForeachSourceInspection */
      foreach ($str as $k => $v) {
        /** @noinspection AlterInForeachInspection */
        /** @noinspection OffsetOperationsInspection */
        $str[$k] = self::to_iso8859($v);
      }

      return $str;
    }

    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    return self::utf8_decode($str);
  }

  /**
   * alias for "UTF8::to_iso8859()"
   *
   * @see UTF8::to_iso8859()
   *
   * @param string|string[] $str
   *
   * @return string|string[]
   */
  public static function to_latin1($str)
  {
    return self::to_iso8859($str);
  }

  /**
   * This function leaves UTF-8 characters alone, while converting almost all non-UTF8 to UTF8.
   *
   * <ul>
   * <li>It decode UTF-8 codepoints and unicode escape sequences.</li>
   * <li>It assumes that the encoding of the original string is either WINDOWS-1252 or ISO-8859-1.</li>
   * <li>WARNING: It does not remove invalid UTF-8 characters, so you maybe need to use "UTF8::clean()" for this
   * case.</li>
   * </ul>
   *
   * @param string|string[] $str                    <p>Any string or array.</p>
   * @param bool            $decodeHtmlEntityToUtf8 <p>Set to true, if you need to decode html-entities.</p>
   *
   * @return string|string[] <p>The UTF-8 encoded string.</p>
   */
  public static function to_utf8($str, $decodeHtmlEntityToUtf8 = false)
  {
    if (is_array($str)) {
      /** @noinspection ForeachSourceInspection */
      foreach ($str as $k => $v) {
        /** @noinspection AlterInForeachInspection */
        /** @noinspection OffsetOperationsInspection */
        $str[$k] = self::to_utf8($v, $decodeHtmlEntityToUtf8);
      }

      return $str;
    }

    $str = (string)$str;

    if (!isset($str[0])) {
      return $str;
    }

    $max = strlen($str);
    $buf = '';

    /** @noinspection ForeachInvariantsInspection */
    for ($i = 0; $i < $max; $i++) {
      $c1 = $str[$i];

      if ($c1 >= "\xc0") { // should be converted to UTF8, if it's not UTF8 already
        $c2 = $i + 1 >= $max ? "\x00" : $str[$i + 1];
        $c3 = $i + 2 >= $max ? "\x00" : $str[$i + 2];
        $c4 = $i + 3 >= $max ? "\x00" : $str[$i + 3];

        if ($c1 >= "\xc0" & $c1 <= "\xdf") { // looks like 2 bytes UTF8

          if ($c2 >= "\x80" && $c2 <= "\xbf") { // yeah, almost sure it's UTF8 already
            $buf .= $c1 . $c2;
            $i++;
          } else { // not valid UTF8 - convert it
            $cc1 = (chr(ord($c1) / 64) | "\xc0");
            $cc2 = ($c1 & "\x3f") | "\x80";
            $buf .= $cc1 . $cc2;
          }

        } elseif ($c1 >= "\xe0" & $c1 <= "\xef") { // looks like 3 bytes UTF8


          if ($c2 >= "\x80" && $c2 <= "\xbf" && $c3 >= "\x80" && $c3 <= "\xbf") { // yeah, almost sure it's UTF8 already
            $buf .= $c1 . $c2 . $c3;
            $i += 2;
          } else { // not valid UTF8 - convert it
            $cc1 = (chr(ord($c1) / 64) | "\xc0");
            $cc2 = ($c1 & "\x3f") | "\x80";
            $buf .= $cc1 . $cc2;
          }

        } elseif ($c1 >= "\xf0" & $c1 <= "\xf7") { // looks like 4 bytes UTF8

          if ($c2 >= "\x80" && $c2 <= "\xbf" && $c3 >= "\x80" && $c3 <= "\xbf" && $c4 >= "\x80" && $c4 <= "\xbf") { // yeah, almost sure it's UTF8 already

            $buf .= $c1 . $c2 . $c3 . $c4;
            $i += 3;
          } else { // not valid UTF8 - convert it
            $cc1 = (chr(ord($c1) / 64) | "\xc0");
            $cc2 = ($c1 & "\x3f") | "\x80";
            $buf .= $cc1 . $cc2;
          }

        } else { // doesn't look like UTF8, but should be converted
          $cc1 = (chr(ord($c1) / 64) | "\xc0");
          $cc2 = (($c1 & "\x3f") | "\x80");
          $buf .= $cc1 . $cc2;
        }

      } elseif (($c1 & "\xc0") === "\x80") { // needs conversion

        $ordC1 = ord($c1);
        if (isset(self::$win1252ToUtf8[$ordC1])) { // found in Windows-1252 special cases
          $buf .= self::$win1252ToUtf8[$ordC1];
        } else {
          $cc1 = (chr($ordC1 / 64) | "\xc0");
          $cc2 = (($c1 & "\x3f") | "\x80");
          $buf .= $cc1 . $cc2;
        }

      } else { // it doesn't need conversion
        $buf .= $c1;
      }
    }

    // decode unicode escape sequences
    $buf = preg_replace_callback(
        '/\\\\u([0-9a-f]{4})/i',
        function ($match) {
          return \mb_convert_encoding(pack('H*', $match[1]), 'UTF-8', 'UCS-2BE');
        },
        $buf
    );

    // decode UTF-8 codepoints
    if ($decodeHtmlEntityToUtf8 === true) {
      $buf = self::html_entity_decode($buf);
    }

    return $buf;
  }

  /**
   * Strip whitespace or other characters from beginning or end of a UTF-8 string.
   *
   * INFO: This is slower then "trim()"
   *
   * We can only use the original-function, if we use <= 7-Bit in the string / chars
   * but the check for ACSII (7-Bit) cost more time, then we can safe here.
   *
   * @param string $str   <p>The string to be trimmed</p>
   * @param string $chars [optional] <p>Optional characters to be stripped</p>
   *
   * @return string <p>The trimmed string.</p>
   */
  public static function trim($str = '', $chars = INF)
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
    if ($chars === INF || !$chars) {
      return preg_replace('/^[\pZ\pC]+|[\pZ\pC]+$/u', '', $str);
    }

    return self::rtrim(self::ltrim($str, $chars), $chars);
  }

  /**
   * Makes string's first char uppercase.
   *
   * @param string  $str       <p>The input string.</p>
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string <p>The resulting string</p>
   */
  public static function ucfirst($str, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    return self::strtoupper(self::substr($str, 0, 1, $encoding, $cleanUtf8), $encoding, $cleanUtf8) . self::substr($str, 1, null, $encoding, $cleanUtf8);

  }

  /**
   * alias for "UTF8::ucfirst()"
   *
   * @see UTF8::ucfirst()
   *
   * @param string  $word
   * @param string  $encoding
   * @param boolean $cleanUtf8
   *
   * @return string
   */
  public static function ucword($word, $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    return self::ucfirst($word, $encoding, $cleanUtf8);
  }

  /**
   * Uppercase for all words in the string.
   *
   * @param string   $str        <p>The input string.</p>
   * @param string[] $exceptions [optional] <p>Exclusion for some words.</p>
   * @param string   $charlist   [optional] <p>Additional chars that contains to words and do not start a new word.</p>
   * @param string   $encoding   [optional] <p>Set the charset for e.g. "\mb_" function.</p>
   * @param boolean  $cleanUtf8  [optional] <p>Clean non UTF-8 chars from the string.</p>
   *
   * @return string
   */
  public static function ucwords($str, $exceptions = array(), $charlist = '', $encoding = 'UTF-8', $cleanUtf8 = false)
  {
    if (!$str) {
      return '';
    }

    $words = self::str_to_words($str, $charlist);
    $newwords = array();

    if (count($exceptions) > 0) {
      $useExceptions = true;
    } else {
      $useExceptions = false;
    }

    foreach ($words as $word) {

      if (!$word) {
        continue;
      }

      if (
          ($useExceptions === false)
          ||
          (
              $useExceptions === true
              &&
              !in_array($word, $exceptions, true)
          )
      ) {
        $word = self::ucfirst($word, $encoding, $cleanUtf8);
      }

      $newwords[] = $word;
    }

    return implode('', $newwords);
  }

  /**
   * Multi decode html entity & fix urlencoded-win1252-chars.
   *
   * e.g:
   * 'test+test'                     => 'test test'
   * 'D&#252;sseldorf'               => 'Düsseldorf'
   * 'D%FCsseldorf'                  => 'Düsseldorf'
   * 'D&#xFC;sseldorf'               => 'Düsseldorf'
   * 'D%26%23xFC%3Bsseldorf'         => 'Düsseldorf'
   * 'DÃ¼sseldorf'                   => 'Düsseldorf'
   * 'D%C3%BCsseldorf'               => 'Düsseldorf'
   * 'D%C3%83%C2%BCsseldorf'         => 'Düsseldorf'
   * 'D%25C3%2583%25C2%25BCsseldorf' => 'Düsseldorf'
   *
   * @param string $str          <p>The input string.</p>
   * @param bool   $multi_decode <p>Decode as often as possible.</p>
   *
   * @return string
   */
  public static function urldecode($str, $multi_decode = true)

  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    $pattern = '/%u([0-9a-f]{3,4})/i';
    if (preg_match($pattern, $str)) {
      $str = preg_replace($pattern, '&#x\\1;', urldecode($str));
    }

    $flags = Bootup::is_php('5.4') ? ENT_QUOTES | ENT_HTML5 : ENT_QUOTES;

    do {
      $str_compare = $str;

      $str = self::fix_simple_utf8(
          urldecode(
              self::html_entity_decode(
                  self::to_utf8($str),

                  $flags
              )
          )
      );

    } while ($multi_decode === true && $str_compare !== $str);

    return (string)$str;
  }

  /**
   * Return a array with "urlencoded"-win1252 -> UTF-8
   *
   * @deprecated use the "UTF8::urldecode()" function to decode a string
   *
   * @return array
   */
  public static function urldecode_fix_win1252_chars()
  {
    static $array = array(
        '%20' => ' ',
        '%21' => '!',
        '%22' => '"',
        '%23' => '#',
        '%24' => '$',
        '%25' => '%',
        '%26' => '&',
        '%27' => "'",
        '%28' => '(',
        '%29' => ')',
        '%2A' => '*',
        '%2B' => '+',
        '%2C' => ',',
        '%2D' => '-',
        '%2E' => '.',
        '%2F' => '/',
        '%30' => '0',
        '%31' => '1',
        '%32' => '2',
        '%33' => '3',
        '%34' => '4',
        '%35' => '5',
        '%36' => '6',
        '%37' => '7',
        '%38' => '8',
        '%39' => '9',
        '%3A' => ':',
        '%3B' => ';',
        '%3C' => '<',
        '%3D' => '=',
        '%3E' => '>',
        '%3F' => '?',
        '%40' => '@',
        '%41' => 'A',
        '%42' => 'B',
        '%43' => 'C',
        '%44' => 'D',
        '%45' => 'E',
        '%46' => 'F',
        '%47' => 'G',
        '%48' => 'H',
        '%49' => 'I',
        '%4A' => 'J',
        '%4B' => 'K',
        '%4C' => 'L',
        '%4D' => 'M',
        '%4E' => 'N',
        '%4F' => 'O',
        '%50' => 'P',
        '%51' => 'Q',
        '%52' => 'R',
        '%53' => 'S',
        '%54' => 'T',
        '%55' => 'U',
        '%56' => 'V',
        '%57' => 'W',
        '%58' => 'X',
        '%59' => 'Y',
        '%5A' => 'Z',
        '%5B' => '[',
        '%5C' => '\\',
        '%5D' => ']',
        '%5E' => '^',
        '%5F' => '_',
        '%60' => '`',
        '%61' => 'a',
        '%62' => 'b',
        '%63' => 'c',
        '%64' => 'd',
        '%65' => 'e',
        '%66' => 'f',
        '%67' => 'g',
        '%68' => 'h',
        '%69' => 'i',
        '%6A' => 'j',
        '%6B' => 'k',
        '%6C' => 'l',
        '%6D' => 'm',
        '%6E' => 'n',
        '%6F' => 'o',
        '%70' => 'p',
        '%71' => 'q',
        '%72' => 'r',
        '%73' => 's',
        '%74' => 't',
        '%75' => 'u',
        '%76' => 'v',
        '%77' => 'w',
        '%78' => 'x',
        '%79' => 'y',
        '%7A' => 'z',
        '%7B' => '{',
        '%7C' => '|',
        '%7D' => '}',
        '%7E' => '~',
        '%7F' => '',
        '%80' => '`',
        '%81' => '',
        '%82' => '‚',
        '%83' => 'ƒ',
        '%84' => '„',
        '%85' => '…',
        '%86' => '†',
        '%87' => '‡',
        '%88' => 'ˆ',
        '%89' => '‰',
        '%8A' => 'Š',
        '%8B' => '‹',
        '%8C' => 'Œ',
        '%8D' => '',
        '%8E' => 'Ž',
        '%8F' => '',
        '%90' => '',
        '%91' => '‘',
        '%92' => '’',
        '%93' => '“',
        '%94' => '”',
        '%95' => '•',
        '%96' => '–',
        '%97' => '—',
        '%98' => '˜',
        '%99' => '™',
        '%9A' => 'š',
        '%9B' => '›',
        '%9C' => 'œ',
        '%9D' => '',
        '%9E' => 'ž',
        '%9F' => 'Ÿ',
        '%A0' => '',
        '%A1' => '¡',
        '%A2' => '¢',
        '%A3' => '£',
        '%A4' => '¤',
        '%A5' => '¥',
        '%A6' => '¦',
        '%A7' => '§',
        '%A8' => '¨',
        '%A9' => '©',
        '%AA' => 'ª',
        '%AB' => '«',
        '%AC' => '¬',
        '%AD' => '',
        '%AE' => '®',
        '%AF' => '¯',
        '%B0' => '°',
        '%B1' => '±',
        '%B2' => '²',
        '%B3' => '³',
        '%B4' => '´',
        '%B5' => 'µ',
        '%B6' => '¶',
        '%B7' => '·',
        '%B8' => '¸',
        '%B9' => '¹',
        '%BA' => 'º',
        '%BB' => '»',
        '%BC' => '¼',
        '%BD' => '½',
        '%BE' => '¾',
        '%BF' => '¿',
        '%C0' => 'À',
        '%C1' => 'Á',
        '%C2' => 'Â',
        '%C3' => 'Ã',
        '%C4' => 'Ä',
        '%C5' => 'Å',
        '%C6' => 'Æ',
        '%C7' => 'Ç',
        '%C8' => 'È',
        '%C9' => 'É',
        '%CA' => 'Ê',
        '%CB' => 'Ë',
        '%CC' => 'Ì',
        '%CD' => 'Í',
        '%CE' => 'Î',
        '%CF' => 'Ï',
        '%D0' => 'Ð',
        '%D1' => 'Ñ',
        '%D2' => 'Ò',
        '%D3' => 'Ó',
        '%D4' => 'Ô',
        '%D5' => 'Õ',
        '%D6' => 'Ö',
        '%D7' => '×',
        '%D8' => 'Ø',
        '%D9' => 'Ù',
        '%DA' => 'Ú',
        '%DB' => 'Û',
        '%DC' => 'Ü',
        '%DD' => 'Ý',
        '%DE' => 'Þ',
        '%DF' => 'ß',
        '%E0' => 'à',
        '%E1' => 'á',
        '%E2' => 'â',
        '%E3' => 'ã',
        '%E4' => 'ä',
        '%E5' => 'å',
        '%E6' => 'æ',
        '%E7' => 'ç',
        '%E8' => 'è',
        '%E9' => 'é',
        '%EA' => 'ê',
        '%EB' => 'ë',
        '%EC' => 'ì',
        '%ED' => 'í',
        '%EE' => 'î',
        '%EF' => 'ï',
        '%F0' => 'ð',
        '%F1' => 'ñ',
        '%F2' => 'ò',
        '%F3' => 'ó',
        '%F4' => 'ô',
        '%F5' => 'õ',
        '%F6' => 'ö',
        '%F7' => '÷',
        '%F8' => 'ø',
        '%F9' => 'ù',
        '%FA' => 'ú',
        '%FB' => 'û',
        '%FC' => 'ü',
        '%FD' => 'ý',
        '%FE' => 'þ',
        '%FF' => 'ÿ',
    );

    return $array;
  }

  /**
   * Decodes an UTF-8 string to ISO-8859-1.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return string
   */
  public static function utf8_decode($str)
  {
    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    $str = (string)self::to_utf8($str);

    static $UTF8_TO_WIN1252_KEYS_CACHE = null;
    static $UTF8_TO_WIN1252_VALUES_CACHE = null;

    if ($UTF8_TO_WIN1252_KEYS_CACHE === null) {
      $UTF8_TO_WIN1252_KEYS_CACHE = array_keys(self::$utf8ToWin1252);
      $UTF8_TO_WIN1252_VALUES_CACHE = array_values(self::$utf8ToWin1252);
    }

    /** @noinspection PhpInternalEntityUsedInspection */
    return Xml::utf8_decode(str_replace($UTF8_TO_WIN1252_KEYS_CACHE, $UTF8_TO_WIN1252_VALUES_CACHE, $str));
  }

  /**
   * Encodes an ISO-8859-1 string to UTF-8.
   *
   * @param string $str <p>The input string.</p>
   *
   * @return string
   */
  public static function utf8_encode($str)
  {
    // init
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    $str = \utf8_encode($str);

    if (false === strpos($str, "\xC2")) {
      return $str;
    } else {

      static $CP1252_TO_UTF8_KEYS_CACHE = null;
      static $CP1252_TO_UTF8_VALUES_CACHE = null;

      if ($CP1252_TO_UTF8_KEYS_CACHE === null) {
        $CP1252_TO_UTF8_KEYS_CACHE = array_keys(self::$cp1252ToUtf8);
        $CP1252_TO_UTF8_VALUES_CACHE = array_values(self::$cp1252ToUtf8);
      }

      return str_replace($CP1252_TO_UTF8_KEYS_CACHE, $CP1252_TO_UTF8_VALUES_CACHE, $str);
    }
  }

  /**
   * fix -> utf8-win1252 chars
   *
   * @param string $str <p>The input string.</p>
   *
   * @return string
   *
   * @deprecated use "UTF8::fix_simple_utf8()"
   */
  public static function utf8_fix_win1252_chars($str)
  {
    return self::fix_simple_utf8($str);
  }

  /**
   * Returns an array with all utf8 whitespace characters.
   *
   * @see   : http://www.bogofilter.org/pipermail/bogofilter/2003-March/001889.html
   *
   * @author: Derek E. [email protected]
   *
   * @return array <p>
   *               An array with all known whitespace characters as values and the type of whitespace as keys
   *               as defined in above URL.
   *               </p>
   */
  public static function whitespace_table()
  {
    return self::$whitespaceTable;
  }

  /**
   * Limit the number of words in a string.
   *
   * @param string $str      <p>The input string.</p>
   * @param int    $words    <p>The limit of words as integer.</p>
   * @param string $strAddOn <p>Replacement for the striped string.</p>
   *
   * @return string
   */
  public static function words_limit($str, $words = 100, $strAddOn = '...')
  {
    $str = (string)$str;

    if (!isset($str[0])) {
      return '';
    }

    $words = (int)$words;

    if ($words < 1) {
      return '';
    }

    preg_match('/^\s*+(?:\S++\s*+){1,' . $words . '}/u', $str, $matches);

    if (
        !isset($matches[0])
        ||
        self::strlen($str) === self::strlen($matches[0])
    ) {
      return $str;
    }

    return self::rtrim($matches[0]) . $strAddOn;
  }

  /**
   * Wraps a string to a given number of characters
   *
   * @link  http://php.net/manual/en/function.wordwrap.php
   *
   * @param string $str   <p>The input string.</p>
   * @param int    $width [optional] <p>The column width.</p>
   * @param string $break [optional] <p>The line is broken using the optional break parameter.</p>
   * @param bool   $cut   [optional] <p>
   *                      If the cut is set to true, the string is
   *                      always wrapped at or before the specified width. So if you have
   *                      a word that is larger than the given width, it is broken apart.
   *                      </p>
   *
   * @return string <p>The given string wrapped at the specified column.</p>
   */
  public static function wordwrap($str, $width = 75, $break = "\n", $cut = false)
  {
    $str = (string)$str;
    $break = (string)$break;

    if (!isset($str[0], $break[0])) {
      return '';
    }

    $w = '';
    $strSplit = explode($break, $str);
    $count = count($strSplit);

    $chars = array();
    /** @noinspection ForeachInvariantsInspection */
    for ($i = 0; $i < $count; ++$i) {

      if ($i) {
        $chars[] = $break;
        $w .= '#';
      }

      $c = $strSplit[$i];
      unset($strSplit[$i]);

      foreach (self::split($c) as $c) {
        $chars[] = $c;
        $w .= ' ' === $c ? ' ' : '?';
      }
    }

    $strReturn = '';
    $j = 0;
    $b = $i = -1;
    $w = wordwrap($w, $width, '#', $cut);

    while (false !== $b = self::strpos($w, '#', $b + 1)) {
      for (++$i; $i < $b; ++$i) {
        $strReturn .= $chars[$j];
        unset($chars[$j++]);
      }

      if ($break === $chars[$j] || ' ' === $chars[$j]) {
        unset($chars[$j++]);
      }

      $strReturn .= $break;
    }

    return $strReturn . implode('', $chars);
  }

  /**
   * Returns an array of Unicode White Space characters.
   *
   * @return array <p>An array with numeric code point as key and White Space Character as value.</p>
   */
  public static function ws()
  {
    return self::$whitespace;
  }

}

voku / portable-utf8

Push — master ( d98de5...cd7fbc )

UTF8::int_to_chr() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
