Passed
Push — master ( 4d3fa0...0e1dca )
by Lars
03:36
created

UTF8   F

Complexity

Total Complexity 1704

Size/Duplication

Total Lines 12634
Duplicated Lines 0 %

Test Coverage

Coverage 79.57%

Importance

Changes 0
Metric Value
eloc 4381
dl 0
loc 12634
ccs 3054
cts 3838
cp 0.7957
rs 0.8
c 0
b 0
f 0
wmc 1704

298 Methods

Rating   Name   Duplication   Size   Complexity  
A chr_to_decimal() 0 30 6
A add_bom_to_string() 0 7 2
A array_change_key_case() 0 20 5
A count_chars() 0 11 1
A ctype_loaded() 0 3 1
D chr() 0 101 18
A chr_to_int() 0 3 1
A decode_mimeheader() 0 15 5
A chunk_split() 0 3 1
A css_stripe_media_queries() 0 6 1
A clean() 0 46 6
A __construct() 0 2 1
A decimal_to_chr() 0 3 1
B between() 0 48 8
A codepoints() 0 29 4
A chr_map() 0 5 1
A cleanup() 0 25 2
A char_at() 0 7 2
A chars() 0 3 1
A chr_size_list() 0 17 3
A checkForSupport() 0 47 4
A chr_to_hex() 0 11 3
A collapse_whitespace() 0 8 2
A access() 0 11 4
A callback() 0 3 1
A binary_to_str() 0 12 3
A bom() 0 3 1
A file_has_bom() 0 8 2
A filter_input() 0 13 2
A encode_mimeheader() 0 25 5
A emoji_decode() 0 16 2
C filter() 0 54 13
A emoji_encode() 0 16 2
A fix_utf8() 0 30 4
A first_char() 0 11 4
D getCharDirection() 0 105 118
A filter_var_array() 0 9 2
A finfo_loaded() 0 3 1
A fits_inside() 0 3 1
F extract_text() 0 175 34
A filter_var() 0 9 2
F encode() 0 139 37
A fix_simple_utf8() 0 19 4
A filter_input_array() 0 9 2
A getSupportInfo() 0 13 3
B file_get_contents() 0 58 11
A str_substr_after_first_separator() 0 28 6
A str_begins() 0 3 1
A max() 0 14 3
B str_camelize() 0 70 10
A parse_str() 0 16 4
A str_contains() 0 10 2
B str_to_lines() 0 29 8
A substr_in_byte() 0 18 6
A get_unique_string() 0 15 2
A is_bom() 0 10 3
A is_hexadecimal() 0 8 2
A strnatcasecmp() 0 5 1
A substr_left() 0 15 4
D strlen() 0 96 19
A str_isubstr_last() 0 20 4
A str_replace_beginning() 0 21 6
A has_uppercase() 0 8 2
A remove_left() 0 21 4
B stripos() 0 59 11
A str_offset_exists() 0 10 2
D strrchr() 0 101 20
A to_filename() 0 24 2
A str_iends_with() 0 11 3
A max_chr_width() 0 8 2
A isBinary() 0 3 1
C utf8_decode() 0 60 13
A ltrim() 0 19 4
D is_utf8() 0 144 31
A remove_html() 0 3 1
B str_longest_common_suffix() 0 51 10
C wordwrap() 0 52 12
B ucfirst() 0 57 7
A lcword() 0 8 1
A str_pad_both() 0 7 1
A str_index_last() 0 11 1
A str_substr_last() 0 33 6
A mbstring_loaded() 0 3 1
A str_limit() 0 26 6
A html_escape() 0 6 1
A toUTF8() 0 3 1
A string() 0 10 1
C normalize_encoding() 0 134 14
B rxClass() 0 39 8
C get_file_type() 0 95 15
A str_ensure_right() 0 13 4
B str_titleize_for_humans() 0 152 5
C is_utf16() 0 65 16
A isHtml() 0 3 1
A normalize_whitespace() 0 30 6
A str_starts_with() 0 11 3
A isBase64() 0 3 1
A str_humanize() 0 15 1
A is_html() 0 12 2
C substr_count_in_byte() 0 54 15
A html_decode() 0 3 1
A strchr() 0 8 1
A strichr() 0 8 1
A isUtf32() 0 3 1
A str_index_first() 0 11 1
A strlen_in_byte() 0 12 3
A str_ireplace_ending() 0 21 6
A rtrim() 0 19 4
C str_longest_common_substring() 0 73 16
A regex_replace() 0 20 3
A titlecase() 0 24 5
A getData() 0 6 1
A str_iindex_first() 0 11 1
B strtolower() 0 54 10
B urldecode() 0 37 8
A str_isubstr_before_first_separator() 0 16 5
B strrev() 0 43 10
A replace_all() 0 11 2
D substr_replace() 0 124 27
A removeBOM() 0 3 1
A strstr_in_byte() 0 12 4
A str_matches_pattern() 0 3 1
A is_alpha() 0 8 2
B str_titleize() 0 55 10
A ws() 0 3 1
B get_random_string() 0 53 10
A str_replace_first() 0 17 2
A toLatin1() 0 3 1
A str_pad_right() 0 7 1
B ucwords() 0 48 9
A to_boolean() 0 35 5
C stristr() 0 68 15
A isUtf8() 0 3 1
A strncasecmp() 0 10 1
B strwidth() 0 40 8
A str_iends() 0 3 1
A trim() 0 19 4
A is_serialized() 0 11 3
A str_upper_camelize() 0 8 1
A is_uppercase() 0 8 2
A substr_compare() 0 33 6
C substr_count() 0 62 16
A strnatcmp() 0 9 2
D str_pad() 0 146 16
A urldecode_unicode_helper() 0 8 2
A str_ireplace() 0 18 3
A to_latin1() 0 3 1
A str_replace_ending() 0 21 6
A string_has_bom() 0 10 3
B strtr() 0 33 8
A str_contains_all() 0 23 6
A is_ascii() 0 7 2
A normalize_line_ending() 0 3 1
A str_isubstr_after_last_separator() 0 23 5
B range() 0 41 10
B strspn() 0 30 10
A strcasecmp() 0 5 1
A str_transliterate() 0 3 1
B rawurldecode() 0 37 8
A str_ends() 0 3 1
B str_capitalize_name_helper() 0 80 10
A utf8_encode() 0 16 3
A normalize_msword() 0 43 2
C str_detect_encoding() 0 111 13
A spaces_to_tabs() 0 11 3
A str_istarts_with() 0 11 3
A is_blank() 0 8 2
A str_replace() 0 14 1
A substr_iright() 0 15 4
A htmlspecialchars() 0 11 3
A replace() 0 11 2
A to_iso8859() 0 16 4
A words_limit() 0 17 5
A strip_tags() 0 15 4
A pcre_utf8_support() 0 4 1
A str_isubstr_before_last_separator() 0 21 6
D str_truncate_safe() 0 78 18
A substr_right() 0 31 6
A lowerCaseFirst() 0 8 1
D str_split() 0 125 28
A str_ends_with_any() 0 13 4
A strrpos_in_byte() 0 12 4
F strrpos() 0 118 25
A remove_right() 0 22 4
A remove_html_breaks() 0 3 1
A showSupport() 0 8 2
A remove_invisible_characters() 0 19 3
A single_chr_html_encode() 0 15 4
A str_replace_last() 0 19 2
A str_iindex_last() 0 11 1
A str_substr_before_last_separator() 0 31 6
B is_binary() 0 35 9
A intlChar_loaded() 0 3 1
B strtocasefold() 0 33 7
A lcfirst() 0 44 5
A tabs_to_spaces() 0 11 3
B str_truncate() 0 44 7
D strripos() 0 96 19
A strpos_in_byte() 0 12 4
A str_ends_with() 0 11 3
F to_ascii() 0 149 27
A is_binary_file() 0 16 3
A intl_loaded() 0 3 1
A reduce_string_array() 0 26 6
B str_longest_common_prefix() 0 48 8
A mbstring_overloaded() 0 11 2
A str_pad_left() 0 7 1
A str_substr_first() 0 33 6
A html_stripe_empty_tags() 0 6 1
A remove_bom() 0 21 5
A str_repeat() 0 5 1
A strpbrk() 0 11 4
A whitespace_table() 0 3 1
A substr_count_simple() 0 32 6
A str_iends_with_any() 0 13 4
A str_substr_after_last_separator() 0 28 6
A str_isubstr_after_first_separator() 0 23 5
A json_loaded() 0 3 1
A isBom() 0 3 1
B str_snakeize() 0 55 6
A int_to_chr() 0 3 1
A is_lowercase() 0 8 2
A str_sort() 0 15 3
D to_utf8() 0 117 35
A ucword() 0 3 1
A str_underscored() 0 3 1
A str_offset_get() 0 14 4
A strip_whitespace() 0 7 2
A getDataIfExists() 0 10 2
A hasBom() 0 3 1
A toAscii() 0 3 1
A str_ibegins() 0 3 1
A str_capitalize_name() 0 8 1
B str_limit_after_word() 0 53 11
A iconv_loaded() 0 3 1
A lcwords() 0 31 6
A str_upper_first() 0 8 1
A isAscii() 0 3 1
A normalizeEncoding() 0 3 1
A swapCase() 0 17 4
A substr_ileft() 0 15 4
A is_empty() 0 3 1
B html_encode() 0 42 7
A str_dasherize() 0 3 1
A isUtf16() 0 3 1
A str_ensure_left() 0 11 3
B urldecode_fix_win1252_chars() 0 227 1
A toIso8859() 0 3 1
C is_utf32() 0 65 16
C ord() 0 65 16
A is_alphanumeric() 0 8 2
A strtonatfold() 0 6 1
A json_decode() 0 14 2
C strcspn() 0 51 12
B is_json() 0 27 8
A fixStrCaseHelper() 0 33 5
A int_to_hex() 0 7 2
B str_split_pattern() 0 49 11
D strstr() 0 92 18
A has_lowercase() 0 8 2
A json_encode() 0 10 2
A str_isubstr_first() 0 25 4
A is_base64() 0 16 5
A str_last_char() 0 13 4
A str_ireplace_beginning() 0 21 6
A hex_to_int() 0 14 3
A htmlentities() 0 23 3
A hex_to_chr() 0 3 1
A str_substr_before_first_separator() 0 32 6
F substr() 0 143 32
A isJson() 0 3 1
A wordwrap_per_line() 0 15 3
A str_surround() 0 3 1
A strncmp() 0 19 4
A str_insert() 0 28 4
A utf8_fix_win1252_chars() 0 3 1
A replace_diamond_question_mark() 0 35 5
A to_utf8_convert_helper() 0 27 5
B str_delimit() 0 33 8
B strtoupper() 0 54 10
A min() 0 14 3
C html_entity_decode() 0 86 17
A str_starts_with_any() 0 17 5
B strrichr() 0 54 11
A split() 0 6 1
A str_istarts_with_any() 0 17 5
A str_contains_any() 0 23 6
A initEmojiData() 0 26 4
A remove_duplicates() 0 14 4
B str_slice() 0 33 10
F strpos() 0 131 27
A str_shuffle() 0 35 6
A strcmp() 0 9 2
A str_word_count() 0 23 5
A strripos_in_byte() 0 12 4
A str_to_binary() 0 5 1
A symfony_polyfill_used() 0 16 5
B str_to_words() 0 36 8

How to fix   Complexity   

Complex Class

Complex classes like UTF8 often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use UTF8, and based on these observations, apply Extract Interface, too.

1
<?php
2
3
declare(strict_types=1);
4
5
namespace voku\helper;
6
7
final class UTF8
8
{
9
    // (CRLF|([ZWNJ-ZWJ]|T+|L*(LV?V+|LV|LVT)T*|L+|[^Control])[Extend]*|[Control])
10
    // This regular expression is a work around for http://bugs.exim.org/1279
11
    const GRAPHEME_CLUSTER_RX = "(?:\r\n|(?:[ -~\x{200C}\x{200D}]|[ᆨ-ᇹ]+|[ᄀ-ᅟ]*(?:[가개갸걔거게겨계고과괘괴교구궈궤귀규그긔기까깨꺄꺠꺼께껴꼐꼬꽈꽤꾀꾜꾸꿔꿰뀌뀨끄끠끼나내냐냬너네녀녜노놔놰뇌뇨누눠눼뉘뉴느늬니다대댜댸더데뎌뎨도돠돼되됴두둬뒈뒤듀드듸디따때땨떄떠떼뗘뗴또똬뙈뙤뚀뚜뚸뛔뛰뜌뜨띄띠라래랴럐러레려례로롸뢔뢰료루뤄뤠뤼류르릐리마매먀먜머메며몌모뫄뫠뫼묘무뭐뭬뮈뮤므믜미바배뱌뱨버베벼볘보봐봬뵈뵤부붜붸뷔뷰브븨비빠빼뺘뺴뻐뻬뼈뼤뽀뽜뽸뾔뾰뿌뿨쀄쀠쀼쁘쁴삐사새샤섀서세셔셰소솨쇄쇠쇼수숴쉐쉬슈스싀시싸쌔쌰썌써쎄쎠쎼쏘쏴쐐쐬쑈쑤쒀쒜쒸쓔쓰씌씨아애야얘어에여예오와왜외요우워웨위유으의이자재쟈쟤저제져졔조좌좨죄죠주줘줴쥐쥬즈즤지짜째쨔쨰쩌쩨쪄쪠쪼쫘쫴쬐쬬쭈쭤쮀쮜쮸쯔쯰찌차채챠챼처체쳐쳬초촤쵀최쵸추춰췌취츄츠츼치카캐캬컈커케켜켸코콰쾌쾨쿄쿠쿼퀘퀴큐크킈키타태탸턔터테텨톄토톼퇘퇴툐투퉈퉤튀튜트틔티파패퍄퍠퍼페펴폐포퐈퐤푀표푸풔풰퓌퓨프픠피하해햐햬허헤혀혜호화홰회효후훠훼휘휴흐희히]?[ᅠ-ᆢ]+|[가-힣])[ᆨ-ᇹ]*|[ᄀ-ᅟ]+|[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}])[\p{Mn}\p{Me}\x{09BE}\x{09D7}\x{0B3E}\x{0B57}\x{0BBE}\x{0BD7}\x{0CC2}\x{0CD5}\x{0CD6}\x{0D3E}\x{0D57}\x{0DCF}\x{0DDF}\x{200C}\x{200D}\x{1D165}\x{1D16E}-\x{1D172}]*|[\p{Cc}\p{Cf}\p{Zl}\p{Zp}])";
12
13
    /**
14
     * Bom => Byte-Length
15
     *
16
     * INFO: https://en.wikipedia.org/wiki/Byte_order_mark
17
     *
18
     * @var array
19
     */
20
    private static $BOM = [
21
        "\xef\xbb\xbf"     => 3, // UTF-8 BOM
22
        ''              => 6, // UTF-8 BOM as "WINDOWS-1252" (one char has [maybe] more then one byte ...)
23
        "\x00\x00\xfe\xff" => 4, // UTF-32 (BE) BOM
24
        '  þÿ'             => 6, // UTF-32 (BE) BOM as "WINDOWS-1252"
25
        "\xff\xfe\x00\x00" => 4, // UTF-32 (LE) BOM
26
        'ÿþ  '             => 6, // UTF-32 (LE) BOM as "WINDOWS-1252"
27
        "\xfe\xff"         => 2, // UTF-16 (BE) BOM
28
        'þÿ'               => 4, // UTF-16 (BE) BOM as "WINDOWS-1252"
29
        "\xff\xfe"         => 2, // UTF-16 (LE) BOM
30
        'ÿþ'               => 4, // UTF-16 (LE) BOM as "WINDOWS-1252"
31
    ];
32
33
    /**
34
     * Numeric code point => UTF-8 Character
35
     *
36
     * url: http://www.w3schools.com/charsets/ref_utf_punctuation.asp
37
     *
38
     * @var array
39
     */
40
    private static $WHITESPACE = [
41
        // NUL Byte
42
        0 => "\x0",
43
        // Tab
44
        9 => "\x9",
45
        // New Line
46
        10 => "\xa",
47
        // Vertical Tab
48
        11 => "\xb",
49
        // Carriage Return
50
        13 => "\xd",
51
        // Ordinary Space
52
        32 => "\x20",
53
        // NO-BREAK SPACE
54
        160 => "\xc2\xa0",
55
        // OGHAM SPACE MARK
56
        5760 => "\xe1\x9a\x80",
57
        // MONGOLIAN VOWEL SEPARATOR
58
        6158 => "\xe1\xa0\x8e",
59
        // EN QUAD
60
        8192 => "\xe2\x80\x80",
61
        // EM QUAD
62
        8193 => "\xe2\x80\x81",
63
        // EN SPACE
64
        8194 => "\xe2\x80\x82",
65
        // EM SPACE
66
        8195 => "\xe2\x80\x83",
67
        // THREE-PER-EM SPACE
68
        8196 => "\xe2\x80\x84",
69
        // FOUR-PER-EM SPACE
70
        8197 => "\xe2\x80\x85",
71
        // SIX-PER-EM SPACE
72
        8198 => "\xe2\x80\x86",
73
        // FIGURE SPACE
74
        8199 => "\xe2\x80\x87",
75
        // PUNCTUATION SPACE
76
        8200 => "\xe2\x80\x88",
77
        // THIN SPACE
78
        8201 => "\xe2\x80\x89",
79
        //HAIR SPACE
80
        8202 => "\xe2\x80\x8a",
81
        // LINE SEPARATOR
82
        8232 => "\xe2\x80\xa8",
83
        // PARAGRAPH SEPARATOR
84
        8233 => "\xe2\x80\xa9",
85
        // NARROW NO-BREAK SPACE
86
        8239 => "\xe2\x80\xaf",
87
        // MEDIUM MATHEMATICAL SPACE
88
        8287 => "\xe2\x81\x9f",
89
        // IDEOGRAPHIC SPACE
90
        12288 => "\xe3\x80\x80",
91
    ];
92
93
    /**
94
     * @var array
95
     */
96
    private static $WHITESPACE_TABLE = [
97
        'SPACE'                     => "\x20",
98
        'NO-BREAK SPACE'            => "\xc2\xa0",
99
        'OGHAM SPACE MARK'          => "\xe1\x9a\x80",
100
        'EN QUAD'                   => "\xe2\x80\x80",
101
        'EM QUAD'                   => "\xe2\x80\x81",
102
        'EN SPACE'                  => "\xe2\x80\x82",
103
        'EM SPACE'                  => "\xe2\x80\x83",
104
        'THREE-PER-EM SPACE'        => "\xe2\x80\x84",
105
        'FOUR-PER-EM SPACE'         => "\xe2\x80\x85",
106
        'SIX-PER-EM SPACE'          => "\xe2\x80\x86",
107
        'FIGURE SPACE'              => "\xe2\x80\x87",
108
        'PUNCTUATION SPACE'         => "\xe2\x80\x88",
109
        'THIN SPACE'                => "\xe2\x80\x89",
110
        'HAIR SPACE'                => "\xe2\x80\x8a",
111
        'LINE SEPARATOR'            => "\xe2\x80\xa8",
112
        'PARAGRAPH SEPARATOR'       => "\xe2\x80\xa9",
113
        'ZERO WIDTH SPACE'          => "\xe2\x80\x8b",
114
        'NARROW NO-BREAK SPACE'     => "\xe2\x80\xaf",
115
        'MEDIUM MATHEMATICAL SPACE' => "\xe2\x81\x9f",
116
        'IDEOGRAPHIC SPACE'         => "\xe3\x80\x80",
117
    ];
118
119
    /**
120
     * bidirectional text chars
121
     *
122
     * url: https://www.w3.org/International/questions/qa-bidi-unicode-controls
123
     *
124
     * @var array
125
     */
126
    private static $BIDI_UNI_CODE_CONTROLS_TABLE = [
127
        // LEFT-TO-RIGHT EMBEDDING (use -> dir = "ltr")
128
        8234 => "\xE2\x80\xAA",
129
        // RIGHT-TO-LEFT EMBEDDING (use -> dir = "rtl")
130
        8235 => "\xE2\x80\xAB",
131
        // POP DIRECTIONAL FORMATTING // (use -> </bdo>)
132
        8236 => "\xE2\x80\xAC",
133
        // LEFT-TO-RIGHT OVERRIDE // (use -> <bdo dir = "ltr">)
134
        8237 => "\xE2\x80\xAD",
135
        // RIGHT-TO-LEFT OVERRIDE // (use -> <bdo dir = "rtl">)
136
        8238 => "\xE2\x80\xAE",
137
        // LEFT-TO-RIGHT ISOLATE // (use -> dir = "ltr")
138
        8294 => "\xE2\x81\xA6",
139
        // RIGHT-TO-LEFT ISOLATE // (use -> dir = "rtl")
140
        8295 => "\xE2\x81\xA7",
141
        // FIRST STRONG ISOLATE // (use -> dir = "auto")
142
        8296 => "\xE2\x81\xA8",
143
        // POP DIRECTIONAL ISOLATE
144
        8297 => "\xE2\x81\xA9",
145
    ];
146
147
    /**
148
     * @var array
149
     */
150
    private static $COMMON_CASE_FOLD = [
151
        'upper' => [
152
            'µ',
153
            'ſ',
154
            "\xCD\x85",
155
            'ς',
156
            'ẞ',
157
            "\xCF\x90",
158
            "\xCF\x91",
159
            "\xCF\x95",
160
            "\xCF\x96",
161
            "\xCF\xB0",
162
            "\xCF\xB1",
163
            "\xCF\xB5",
164
            "\xE1\xBA\x9B",
165
            "\xE1\xBE\xBE",
166
        ],
167
        'lower' => [
168
            'μ',
169
            's',
170
            'ι',
171
            'σ',
172
            'ß',
173
            'β',
174
            'θ',
175
            'φ',
176
            'π',
177
            'κ',
178
            'ρ',
179
            'ε',
180
            "\xE1\xB9\xA1",
181
            'ι',
182
        ],
183
    ];
184
185
    /**
186
     * @var array
187
     */
188
    private static $SUPPORT = [];
189
190
    /**
191
     * @var array|null
192
     */
193
    private static $BROKEN_UTF8_FIX;
194
195
    /**
196
     * @var array|null
197
     */
198
    private static $WIN1252_TO_UTF8;
199
200
    /**
201
     * @var array|null
202
     */
203
    private static $INTL_TRANSLITERATOR_LIST;
204
205
    /**
206
     * @var array|null
207
     */
208
    private static $ENCODINGS;
209
210
    /**
211
     * @var array|null
212
     */
213
    private static $ORD;
214
215
    /**
216
     * @var array|null
217
     */
218
    private static $EMOJI;
219
220
    /**
221
     * @var array|null
222
     */
223
    private static $EMOJI_VALUES_CACHE;
224
225
    /**
226
     * @var array|null
227
     */
228
    private static $EMOJI_KEYS_CACHE;
229
230
    /**
231
     * @var array|null
232
     */
233
    private static $EMOJI_KEYS_REVERSIBLE_CACHE;
234
235
    /**
236
     * @var array|null
237
     */
238
    private static $CHR;
239
240
    /**
241
     * __construct()
242
     */
243 32
    public function __construct()
244
    {
245 32
    }
246
247
    /**
248
     * Return the character at the specified position: $str[1] like functionality.
249
     *
250
     * @param string $str      <p>A UTF-8 string.</p>
251
     * @param int    $pos      <p>The position of character to return.</p>
252
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
253
     *
254
     * @return string single multi-byte character
255
     */
256 3
    public static function access(string $str, int $pos, string $encoding = 'UTF-8'): string
257
    {
258 3
        if ($str === '' || $pos < 0) {
259 2
            return '';
260
        }
261
262 3
        if ($encoding === 'UTF-8') {
263 3
            return (string) \mb_substr($str, $pos, 1);
264
        }
265
266
        return (string) self::substr($str, $pos, 1, $encoding);
267
    }
268
269
    /**
270
     * Prepends UTF-8 BOM character to the string and returns the whole string.
271
     *
272
     * INFO: If BOM already existed there, the Input string is returned.
273
     *
274
     * @param string $str <p>The input string.</p>
275
     *
276
     * @return string the output string that contains BOM
277
     */
278 2
    public static function add_bom_to_string(string $str): string
279
    {
280 2
        if (self::string_has_bom($str) === false) {
281 2
            $str = self::bom() . $str;
282
        }
283
284 2
        return $str;
285
    }
286
287
    /**
288
     * Changes all keys in an array.
289
     *
290
     * @param array  $array    <p>The array to work on</p>
291
     * @param int    $case     [optional] <p> Either <strong>CASE_UPPER</strong><br>
292
     *                         or <strong>CASE_LOWER</strong> (default)</p>
293
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
294
     *
295
     * @return string[] an array with its keys lower or uppercased
296
     */
297 2
    public static function array_change_key_case(array $array, int $case = \CASE_LOWER, string $encoding = 'UTF-8'): array
298
    {
299
        if (
300 2
            $case !== \CASE_LOWER
301
            &&
302 2
            $case !== \CASE_UPPER
303
        ) {
304
            $case = \CASE_LOWER;
305
        }
306
307 2
        $return = [];
308 2
        foreach ($array as $key => &$value) {
309 2
            $key = $case === \CASE_LOWER
310 2
                ? self::strtolower((string) $key, $encoding)
311 2
                : self::strtoupper((string) $key, $encoding);
312
313 2
            $return[$key] = $value;
314
        }
315
316 2
        return $return;
317
    }
318
319
    /**
320
     * Returns the substring between $start and $end, if found, or an empty
321
     * string. An optional offset may be supplied from which to begin the
322
     * search for the start string.
323
     *
324
     * @param string $str
325
     * @param string $start    <p>Delimiter marking the start of the substring.</p>
326
     * @param string $end      <p>Delimiter marking the end of the substring.</p>
327
     * @param int    $offset   [optional] <p>Index from which to begin the search. Default: 0</p>
328
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
329
     *
330
     * @return string
331
     */
332 16
    public static function between(
333
        string $str,
334
        string $start,
335
        string $end,
336
        int $offset = 0,
337
        string $encoding = 'UTF-8'
338
    ): string {
339 16
        if ($encoding === 'UTF-8') {
340 8
            $posStart = \mb_strpos($str, $start, $offset);
341 8
            if ($posStart === false) {
342 1
                return '';
343
            }
344
345 7
            $substrIndex = $posStart + (int) \mb_strlen($start);
346 7
            $posEnd = \mb_strpos($str, $end, $substrIndex);
347
            if (
348 7
                $posEnd === false
349
                ||
350 7
                $posEnd === $substrIndex
351
            ) {
352 2
                return '';
353
            }
354
355 5
            return (string) \mb_substr($str, $substrIndex, $posEnd - $substrIndex);
356
        }
357
358 8
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
359
360 8
        $posStart = self::strpos($str, $start, $offset, $encoding);
361 8
        if ($posStart === false) {
362 1
            return '';
363
        }
364
365 7
        $substrIndex = $posStart + (int) self::strlen($start, $encoding);
366 7
        $posEnd = self::strpos($str, $end, $substrIndex, $encoding);
367
        if (
368 7
            $posEnd === false
369
            ||
370 7
            $posEnd === $substrIndex
371
        ) {
372 2
            return '';
373
        }
374
375 5
        return (string) self::substr(
376 5
            $str,
377 5
            $substrIndex,
378 5
            $posEnd - $substrIndex,
379 5
            $encoding
380
        );
381
    }
382
383
    /**
384
     * Convert binary into an string.
385
     *
386
     * @param mixed $bin 1|0
387
     *
388
     * @return string
389
     */
390 2
    public static function binary_to_str($bin): string
391
    {
392 2
        if (!isset($bin[0])) {
393
            return '';
394
        }
395
396 2
        $convert = \base_convert($bin, 2, 16);
397 2
        if ($convert === '0') {
398 1
            return '';
399
        }
400
401 2
        return \pack('H*', $convert);
402
    }
403
404
    /**
405
     * Returns the UTF-8 Byte Order Mark Character.
406
     *
407
     * INFO: take a look at UTF8::$bom for e.g. UTF-16 and UTF-32 BOM values
408
     *
409
     * @return string UTF-8 Byte Order Mark
410
     */
411 4
    public static function bom(): string
412
    {
413 4
        return "\xef\xbb\xbf";
414
    }
415
416
    /**
417
     * @alias of UTF8::chr_map()
418
     *
419
     * @param array|string $callback
420
     * @param string       $str
421
     *
422
     * @return string[]
423
     *
424
     * @see UTF8::chr_map()
425
     */
426 2
    public static function callback($callback, string $str): array
427
    {
428 2
        return self::chr_map($callback, $str);
429
    }
430
431
    /**
432
     * Returns the character at $index, with indexes starting at 0.
433
     *
434
     * @param string $str      <p>The input string.</p>
435
     * @param int    $index    <p>Position of the character.</p>
436
     * @param string $encoding [optional] <p>Default is UTF-8</p>
437
     *
438
     * @return string the character at $index
439
     */
440 9
    public static function char_at(string $str, int $index, string $encoding = 'UTF-8'): string
441
    {
442 9
        if ($encoding === 'UTF-8') {
443 5
            return (string) \mb_substr($str, $index, 1);
444
        }
445
446 4
        return (string) self::substr($str, $index, 1, $encoding);
447
    }
448
449
    /**
450
     * Returns an array consisting of the characters in the string.
451
     *
452
     * @param string $str <p>The input string.</p>
453
     *
454
     * @return string[] an array of chars
455
     */
456 3
    public static function chars(string $str): array
457
    {
458 3
        return self::str_split($str);
459
    }
460
461
    /**
462
     * This method will auto-detect your server environment for UTF-8 support.
463
     *
464
     * @return true|null
465
     *
466
     * @internal <p>You don't need to run it manually, it will be triggered if it's needed.</p>
467
     */
468 5
    public static function checkForSupport()
469
    {
470 5
        if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
471
            self::$SUPPORT['already_checked_via_portable_utf8'] = true;
472
473
            // http://php.net/manual/en/book.mbstring.php
474
            self::$SUPPORT['mbstring'] = self::mbstring_loaded();
475
            self::$SUPPORT['mbstring_func_overload'] = self::mbstring_overloaded();
476
            if (self::$SUPPORT['mbstring'] === true) {
477
                \mb_internal_encoding('UTF-8');
478
                /** @noinspection UnusedFunctionResultInspection */
479
                /** @noinspection PhpComposerExtensionStubsInspection */
480
                \mb_regex_encoding('UTF-8');
481
                self::$SUPPORT['mbstring_internal_encoding'] = 'UTF-8';
482
            }
483
484
            // http://php.net/manual/en/book.iconv.php
485
            self::$SUPPORT['iconv'] = self::iconv_loaded();
486
487
            // http://php.net/manual/en/book.intl.php
488
            self::$SUPPORT['intl'] = self::intl_loaded();
489
490
            // http://php.net/manual/en/class.intlchar.php
491
            self::$SUPPORT['intlChar'] = self::intlChar_loaded();
492
493
            // http://php.net/manual/en/book.ctype.php
494
            self::$SUPPORT['ctype'] = self::ctype_loaded();
495
496
            // http://php.net/manual/en/class.finfo.php
497
            self::$SUPPORT['finfo'] = self::finfo_loaded();
498
499
            // http://php.net/manual/en/book.json.php
500
            self::$SUPPORT['json'] = self::json_loaded();
501
502
            // http://php.net/manual/en/book.pcre.php
503
            self::$SUPPORT['pcre_utf8'] = self::pcre_utf8_support();
504
505
            self::$SUPPORT['symfony_polyfill_used'] = self::symfony_polyfill_used();
506
            if (self::$SUPPORT['symfony_polyfill_used'] === true) {
507
                \mb_internal_encoding('UTF-8');
508
                self::$SUPPORT['mbstring_internal_encoding'] = 'UTF-8';
509
            }
510
511
            return true;
512
        }
513
514 5
        return null;
515
    }
516
517
    /**
518
     * Generates a UTF-8 encoded character from the given code point.
519
     *
520
     * INFO: opposite to UTF8::ord()
521
     *
522
     * @param int|string $code_point <p>The code point for which to generate a character.</p>
523
     * @param string     $encoding   [optional] <p>Default is UTF-8</p>
524
     *
525
     * @return string|null multi-byte character, returns null on failure or empty input
526
     */
527 25
    public static function chr($code_point, string $encoding = 'UTF-8')
528
    {
529
        // init
530 25
        static $CHAR_CACHE = [];
531
532 25
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
533 4
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
534
        }
535
536
        if (
537 25
            $encoding !== 'UTF-8'
538
            &&
539 25
            $encoding !== 'ISO-8859-1'
540
            &&
541 25
            $encoding !== 'WINDOWS-1252'
542
            &&
543 25
            self::$SUPPORT['mbstring'] === false
544
        ) {
545
            \trigger_error('UTF8::chr() without mbstring cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
546
        }
547
548 25
        $cacheKey = $code_point . $encoding;
549 25
        if (isset($CHAR_CACHE[$cacheKey]) === true) {
550 23
            return $CHAR_CACHE[$cacheKey];
551
        }
552
553 13
        if ($code_point <= 127) { // use "simple"-char only until "\x80"
554
555 12
            if (self::$CHR === null) {
556
                self::$CHR = (array) self::getData('chr');
557
            }
558
559
            /**
560
             * @psalm-suppress PossiblyNullArrayAccess
561
             */
562 12
            $chr = self::$CHR[$code_point];
563
564 12
            if ($encoding !== 'UTF-8') {
565 1
                $chr = self::encode($encoding, $chr);
566
            }
567
568 12
            return $CHAR_CACHE[$cacheKey] = $chr;
569
        }
570
571
        //
572
        // fallback via "IntlChar"
573
        //
574
575 7
        if (self::$SUPPORT['intlChar'] === true) {
576
            /** @noinspection PhpComposerExtensionStubsInspection */
577 7
            $chr = \IntlChar::chr($code_point);
578
579 7
            if ($encoding !== 'UTF-8') {
580
                $chr = self::encode($encoding, $chr);
581
            }
582
583 7
            return $CHAR_CACHE[$cacheKey] = $chr;
584
        }
585
586
        //
587
        // fallback via vanilla php
588
        //
589
590
        if (self::$CHR === null) {
591
            self::$CHR = (array) self::getData('chr');
592
        }
593
594
        $code_point = (int) $code_point;
595
        if ($code_point <= 0x7F) {
596
            /**
597
             * @psalm-suppress PossiblyNullArrayAccess
598
             */
599
            $chr = self::$CHR[$code_point];
600
        } elseif ($code_point <= 0x7FF) {
601
            /**
602
             * @psalm-suppress PossiblyNullArrayAccess
603
             */
604
            $chr = self::$CHR[($code_point >> 6) + 0xC0] .
605
                   self::$CHR[($code_point & 0x3F) + 0x80];
606
        } elseif ($code_point <= 0xFFFF) {
607
            /**
608
             * @psalm-suppress PossiblyNullArrayAccess
609
             */
610
            $chr = self::$CHR[($code_point >> 12) + 0xE0] .
611
                   self::$CHR[(($code_point >> 6) & 0x3F) + 0x80] .
612
                   self::$CHR[($code_point & 0x3F) + 0x80];
613
        } else {
614
            /**
615
             * @psalm-suppress PossiblyNullArrayAccess
616
             */
617
            $chr = self::$CHR[($code_point >> 18) + 0xF0] .
618
                   self::$CHR[(($code_point >> 12) & 0x3F) + 0x80] .
619
                   self::$CHR[(($code_point >> 6) & 0x3F) + 0x80] .
620
                   self::$CHR[($code_point & 0x3F) + 0x80];
621
        }
622
623
        if ($encoding !== 'UTF-8') {
624
            $chr = self::encode($encoding, $chr);
625
        }
626
627
        return $CHAR_CACHE[$cacheKey] = $chr;
628
    }
629
630
    /**
631
     * Applies callback to all characters of a string.
632
     *
633
     * @param array|string $callback <p>The callback function.</p>
634
     * @param string       $str      <p>UTF-8 string to run callback on.</p>
635
     *
636
     * @return string[] the outcome of callback
637
     */
638 2
    public static function chr_map($callback, string $str): array
639
    {
640 2
        return \array_map(
641 2
            $callback,
642 2
            self::str_split($str)
643
        );
644
    }
645
646
    /**
647
     * Generates an array of byte length of each character of a Unicode string.
648
     *
649
     * 1 byte => U+0000  - U+007F
650
     * 2 byte => U+0080  - U+07FF
651
     * 3 byte => U+0800  - U+FFFF
652
     * 4 byte => U+10000 - U+10FFFF
653
     *
654
     * @param string $str <p>The original unicode string.</p>
655
     *
656
     * @return int[] an array of byte lengths of each character
657
     */
658 4
    public static function chr_size_list(string $str): array
659
    {
660 4
        if ($str === '') {
661 4
            return [];
662
        }
663
664 4
        if (self::$SUPPORT['mbstring_func_overload'] === true) {
665
            return \array_map(
666
                static function (string $data): int {
667
                    // "mb_" is available if overload is used, so use it ...
668
                    return \mb_strlen($data, 'CP850'); // 8-BIT
669
                },
670
                self::str_split($str)
671
            );
672
        }
673
674 4
        return \array_map('\strlen', self::str_split($str));
675
    }
676
677
    /**
678
     * Get a decimal code representation of a specific character.
679
     *
680
     * @param string $char <p>The input character.</p>
681
     *
682
     * @return int
683
     */
684 4
    public static function chr_to_decimal(string $char): int
685
    {
686 4
        $code = self::ord($char[0]);
687 4
        $bytes = 1;
688
689 4
        if (!($code & 0x80)) {
690
            // 0xxxxxxx
691 4
            return $code;
692
        }
693
694 4
        if (($code & 0xe0) === 0xc0) {
695
            // 110xxxxx
696 4
            $bytes = 2;
697 4
            $code &= ~0xc0;
698 4
        } elseif (($code & 0xf0) === 0xe0) {
699
            // 1110xxxx
700 4
            $bytes = 3;
701 4
            $code &= ~0xe0;
702 2
        } elseif (($code & 0xf8) === 0xf0) {
703
            // 11110xxx
704 2
            $bytes = 4;
705 2
            $code &= ~0xf0;
706
        }
707
708 4
        for ($i = 2; $i <= $bytes; ++$i) {
709
            // 10xxxxxx
710 4
            $code = ($code << 6) + (self::ord($char[$i - 1]) & ~0x80);
711
        }
712
713 4
        return $code;
714
    }
715
716
    /**
717
     * Get hexadecimal code point (U+xxxx) of a UTF-8 encoded character.
718
     *
719
     * @param int|string $char <p>The input character</p>
720
     * @param string     $pfix [optional]
721
     *
722
     * @return string The code point encoded as U+xxxx
723
     */
724 2
    public static function chr_to_hex($char, string $pfix = 'U+'): string
725
    {
726 2
        if ($char === '') {
727 2
            return '';
728
        }
729
730 2
        if ($char === '&#0;') {
731 2
            $char = '';
732
        }
733
734 2
        return self::int_to_hex(self::ord((string) $char), $pfix);
735
    }
736
737
    /**
738
     * alias for "UTF8::chr_to_decimal()"
739
     *
740
     * @param string $chr
741
     *
742
     * @return int
743
     *
744
     * @see UTF8::chr_to_decimal()
745
     */
746 2
    public static function chr_to_int(string $chr): int
747
    {
748 2
        return self::chr_to_decimal($chr);
749
    }
750
751
    /**
752
     * Splits a string into smaller chunks and multiple lines, using the specified line ending character.
753
     *
754
     * @param string $body     <p>The original string to be split.</p>
755
     * @param int    $chunklen [optional] <p>The maximum character length of a chunk.</p>
756
     * @param string $end      [optional] <p>The character(s) to be inserted at the end of each chunk.</p>
757
     *
758
     * @return string the chunked string
759
     */
760 4
    public static function chunk_split(string $body, int $chunklen = 76, string $end = "\r\n"): string
761
    {
762 4
        return \implode($end, self::str_split($body, $chunklen));
763
    }
764
765
    /**
766
     * Accepts a string and removes all non-UTF-8 characters from it + extras if needed.
767
     *
768
     * @param string $str                           <p>The string to be sanitized.</p>
769
     * @param bool   $remove_bom                    [optional] <p>Set to true, if you need to remove UTF-BOM.</p>
770
     * @param bool   $normalize_whitespace          [optional] <p>Set to true, if you need to normalize the
771
     *                                              whitespace.</p>
772
     * @param bool   $normalize_msword              [optional] <p>Set to true, if you need to normalize MS Word chars
773
     *                                              e.g.: "…"
774
     *                                              => "..."</p>
775
     * @param bool   $keep_non_breaking_space       [optional] <p>Set to true, to keep non-breaking-spaces, in
776
     *                                              combination with
777
     *                                              $normalize_whitespace</p>
778
     * @param bool   $replace_diamond_question_mark [optional] <p>Set to true, if you need to remove diamond question
779
     *                                              mark e.g.: "�"</p>
780
     * @param bool   $remove_invisible_characters   [optional] <p>Set to false, if you not want to remove invisible
781
     *                                              characters e.g.: "\0"</p>
782
     *
783
     * @return string clean UTF-8 encoded string
784
     */
785 114
    public static function clean(
786
        string $str,
787
        bool $remove_bom = false,
788
        bool $normalize_whitespace = false,
789
        bool $normalize_msword = false,
790
        bool $keep_non_breaking_space = false,
791
        bool $replace_diamond_question_mark = false,
792
        bool $remove_invisible_characters = true
793
    ): string {
794
        // http://stackoverflow.com/questions/1401317/remove-non-utf8-characters-from-string
795
        // caused connection reset problem on larger strings
796
797 114
        $regx = '/
798
          (
799
            (?: [\x00-\x7F]               # single-byte sequences   0xxxxxxx
800
            |   [\xC0-\xDF][\x80-\xBF]    # double-byte sequences   110xxxxx 10xxxxxx
801
            |   [\xE0-\xEF][\x80-\xBF]{2} # triple-byte sequences   1110xxxx 10xxxxxx * 2
802
            |   [\xF0-\xF7][\x80-\xBF]{3} # quadruple-byte sequence 11110xxx 10xxxxxx * 3
803
            ){1,100}                      # ...one or more times
804
          )
805
        | ( [\x80-\xBF] )                 # invalid byte in range 10000000 - 10111111
806
        | ( [\xC0-\xFF] )                 # invalid byte in range 11000000 - 11111111
807
        /x';
808 114
        $str = (string) \preg_replace($regx, '$1', $str);
809
810 114
        if ($replace_diamond_question_mark === true) {
811 60
            $str = self::replace_diamond_question_mark($str, '');
812
        }
813
814 114
        if ($remove_invisible_characters === true) {
815 114
            $str = self::remove_invisible_characters($str);
816
        }
817
818 114
        if ($normalize_whitespace === true) {
819 64
            $str = self::normalize_whitespace($str, $keep_non_breaking_space);
820
        }
821
822 114
        if ($normalize_msword === true) {
823 32
            $str = self::normalize_msword($str);
824
        }
825
826 114
        if ($remove_bom === true) {
827 64
            $str = self::remove_bom($str);
828
        }
829
830 114
        return $str;
831
    }
832
833
    /**
834
     * Clean-up a and show only printable UTF-8 chars at the end  + fix UTF-8 encoding.
835
     *
836
     * @param string $str <p>The input string.</p>
837
     *
838
     * @return string
839
     */
840 33
    public static function cleanup($str): string
841
    {
842
        // init
843 33
        $str = (string) $str;
844
845 33
        if ($str === '') {
846 5
            return '';
847
        }
848
849
        // fixed ISO <-> UTF-8 Errors
850 33
        $str = self::fix_simple_utf8($str);
851
852
        // remove all none UTF-8 symbols
853
        // && remove diamond question mark (�)
854
        // && remove remove invisible characters (e.g. "\0")
855
        // && remove BOM
856
        // && normalize whitespace chars (but keep non-breaking-spaces)
857 33
        return self::clean(
858 33
            $str,
859 33
            true,
860 33
            true,
861 33
            false,
862 33
            true,
863 33
            true,
864 33
            true
865
        );
866
    }
867
868
    /**
869
     * Accepts a string or a array of strings and returns an array of Unicode code points.
870
     *
871
     * INFO: opposite to UTF8::string()
872
     *
873
     * @param string|string[] $arg     <p>A UTF-8 encoded string or an array of such strings.</p>
874
     * @param bool            $u_style <p>If True, will return code points in U+xxxx format,
875
     *                                 default, code points will be returned as integers.</p>
876
     *
877
     * @return array<int|string>
878
     *                           The array of code points:<br>
879
     *                           array<int> for $u_style === false<br>
880
     *                           array<string> for $u_style === true<br>
881
     */
882 12
    public static function codepoints($arg, bool $u_style = false): array
883
    {
884 12
        if (\is_string($arg) === true) {
885 12
            $arg = self::str_split($arg);
886
        }
887
888 12
        $arg = \array_map(
889
            [
890 12
                self::class,
891
                'ord',
892
            ],
893 12
            $arg
894
        );
895
896 12
        if (\count($arg) === 0) {
897 7
            return [];
898
        }
899
900 11
        if ($u_style === true) {
901 2
            $arg = \array_map(
902
                [
903 2
                    self::class,
904
                    'int_to_hex',
905
                ],
906 2
                $arg
907
            );
908
        }
909
910 11
        return $arg;
911
    }
912
913
    /**
914
     * Trims the string and replaces consecutive whitespace characters with a
915
     * single space. This includes tabs and newline characters, as well as
916
     * multibyte whitespace such as the thin space and ideographic space.
917
     *
918
     * @param string $str <p>The input string.</p>
919
     *
920
     * @return string string with a trimmed $str and condensed whitespace
921
     */
922 13
    public static function collapse_whitespace(string $str): string
923
    {
924 13
        if (self::$SUPPORT['mbstring'] === true) {
925
            /** @noinspection PhpComposerExtensionStubsInspection */
926 13
            return \trim((string) \mb_ereg_replace('[[:space:]]+', ' ', $str));
927
        }
928
929
        return \trim(self::regex_replace($str, '[[:space:]]+', ' '));
930
    }
931
932
    /**
933
     * Returns count of characters used in a string.
934
     *
935
     * @param string $str                <p>The input string.</p>
936
     * @param bool   $cleanUtf8          [optional] <p>Remove non UTF-8 chars from the string.</p>
937
     * @param bool   $tryToUseMbFunction [optional] <p>Set to false, if you don't want to use
938
     *
939
     * @return int[] an associative array of Character as keys and
940
     *               their count as values
941
     */
942 19
    public static function count_chars(
943
        string $str,
944
        bool $cleanUtf8 = false,
945
        bool $tryToUseMbFunction = true
946
    ): array {
947 19
        return \array_count_values(
948 19
            self::str_split(
949 19
                $str,
950 19
                1,
951 19
                $cleanUtf8,
952 19
                $tryToUseMbFunction
953
            )
954
        );
955
    }
956
957
    /**
958
     * Remove css media-queries.
959
     *
960
     * @param string $str
961
     *
962
     * @return string
963
     */
964 1
    public static function css_stripe_media_queries(string $str): string
965
    {
966 1
        return (string) \preg_replace(
967 1
            '#@media\\s+(?:only\\s)?(?:[\\s{\\(]|screen|all)\\s?[^{]+{.*}\\s*}\\s*#isumU',
968 1
            '',
969 1
            $str
970
        );
971
    }
972
973
    /**
974
     * Checks whether ctype is available on the server.
975
     *
976
     * @return bool
977
     *              <strong>true</strong> if available, <strong>false</strong> otherwise
978
     */
979
    public static function ctype_loaded(): bool
980
    {
981
        return \extension_loaded('ctype');
982
    }
983
984
    /**
985
     * Converts a int-value into an UTF-8 character.
986
     *
987
     * @param mixed $int
988
     *
989
     * @return string
990
     */
991 19
    public static function decimal_to_chr($int): string
992
    {
993 19
        return self::html_entity_decode('&#' . $int . ';', \ENT_QUOTES | \ENT_HTML5);
994
    }
995
996
    /**
997
     * Decodes a MIME header field
998
     *
999
     * @param string $str
1000
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
1001
     *
1002
     * @return false|string
1003
     *                      A decoded MIME field on success,
1004
     *                      or false if an error occurs during the decoding
1005
     */
1006
    public static function decode_mimeheader($str, string $encoding = 'UTF-8')
1007
    {
1008
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
1009
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
1010
        }
1011
1012
        if (self::$SUPPORT['iconv'] === true) {
1013
            return \iconv_mime_decode($str, \ICONV_MIME_DECODE_CONTINUE_ON_ERROR, $encoding);
1014
        }
1015
1016
        if ($encoding !== 'UTF-8') {
1017
            $str = self::encode($encoding, $str);
1018
        }
1019
1020
        return \mb_decode_mimeheader($str);
1021
    }
1022
1023
    /**
1024
     * Decodes a string which was encoded by "UTF8::emoji_encode()".
1025
     *
1026
     * @param string $str                        <p>The input string.</p>
1027
     * @param bool   $useReversibleStringMapping [optional] <p>
1028
     *                                           When <b>TRUE</b>, we se a reversible string mapping
1029
     *                                           between "emoji_encode" and "emoji_decode".</p>
1030
     *
1031
     * @return string
1032
     */
1033 9
    public static function emoji_decode(string $str, bool $useReversibleStringMapping = false): string
1034
    {
1035 9
        self::initEmojiData();
1036
1037 9
        if ($useReversibleStringMapping === true) {
1038 9
            return (string) \str_replace(
1039 9
                (array) self::$EMOJI_KEYS_REVERSIBLE_CACHE,
1040 9
                (array) self::$EMOJI_VALUES_CACHE,
1041 9
                $str
1042
            );
1043
        }
1044
1045 1
        return (string) \str_replace(
1046 1
            (array) self::$EMOJI_KEYS_CACHE,
1047 1
            (array) self::$EMOJI_VALUES_CACHE,
1048 1
            $str
1049
        );
1050
    }
1051
1052
    /**
1053
     * Encode a string with emoji chars into a non-emoji string.
1054
     *
1055
     * @param string $str                        <p>The input string</p>
1056
     * @param bool   $useReversibleStringMapping [optional] <p>
1057
     *                                           when <b>TRUE</b>, we se a reversible string mapping
1058
     *                                           between "emoji_encode" and "emoji_decode"</p>
1059
     *
1060
     * @return string
1061
     */
1062 9
    public static function emoji_encode(string $str, bool $useReversibleStringMapping = false): string
1063
    {
1064 9
        self::initEmojiData();
1065
1066 9
        if ($useReversibleStringMapping === true) {
1067 9
            return (string) \str_replace(
1068 9
                (array) self::$EMOJI_VALUES_CACHE,
1069 9
                (array) self::$EMOJI_KEYS_REVERSIBLE_CACHE,
1070 9
                $str
1071
            );
1072
        }
1073
1074 1
        return (string) \str_replace(
1075 1
            (array) self::$EMOJI_VALUES_CACHE,
1076 1
            (array) self::$EMOJI_KEYS_CACHE,
1077 1
            $str
1078
        );
1079
    }
1080
1081
    /**
1082
     * Encode a string with a new charset-encoding.
1083
     *
1084
     * INFO:  The different to "UTF8::utf8_encode()" is that this function, try to fix also broken / double encoding,
1085
     *        so you can call this function also on a UTF-8 String and you don't mess the string.
1086
     *
1087
     * @param string $toEncoding             <p>e.g. 'UTF-16', 'UTF-8', 'ISO-8859-1', etc.</p>
1088
     * @param string $str                    <p>The input string</p>
1089
     * @param bool   $autodetectFromEncoding [optional] <p>Force the new encoding (we try to fix broken / double
1090
     *                                       encoding for UTF-8)<br> otherwise we auto-detect the current
1091
     *                                       string-encoding</p>
1092
     * @param string $fromEncoding           [optional] <p>e.g. 'UTF-16', 'UTF-8', 'ISO-8859-1', etc.<br>
1093
     *                                       A empty string will trigger the autodetect anyway.</p>
1094
     *
1095
     * @return string
1096
     *
1097
     * @psalm-suppress InvalidReturnStatement
1098
     */
1099 28
    public static function encode(
1100
        string $toEncoding,
1101
        string $str,
1102
        bool $autodetectFromEncoding = true,
1103
        string $fromEncoding = ''
1104
    ): string {
1105 28
        if ($str === '' || $toEncoding === '') {
1106 13
            return $str;
1107
        }
1108
1109 28
        if ($toEncoding !== 'UTF-8' && $toEncoding !== 'CP850') {
1110 7
            $toEncoding = self::normalize_encoding($toEncoding, 'UTF-8');
1111
        }
1112
1113 28
        if ($fromEncoding && $fromEncoding !== 'UTF-8' && $fromEncoding !== 'CP850') {
1114 2
            $fromEncoding = self::normalize_encoding($fromEncoding, null);
1115
        }
1116
1117
        if (
1118 28
            $toEncoding
1119
            &&
1120 28
            $fromEncoding
1121
            &&
1122 28
            $fromEncoding === $toEncoding
1123
        ) {
1124
            return $str;
1125
        }
1126
1127 28
        if ($toEncoding === 'JSON') {
1128 1
            $return = self::json_encode($str);
1129 1
            if ($return === false) {
1130
                throw new \InvalidArgumentException('The input string [' . $str . '] can not be used for json_encode().');
1131
            }
1132
1133 1
            return $return;
1134
        }
1135 28
        if ($fromEncoding === 'JSON') {
1136 1
            $str = self::json_decode($str);
1137 1
            $fromEncoding = '';
1138
        }
1139
1140 28
        if ($toEncoding === 'BASE64') {
1141 2
            return \base64_encode($str);
1142
        }
1143 28
        if ($fromEncoding === 'BASE64') {
1144 2
            $str = \base64_decode($str, true);
1145 2
            $fromEncoding = '';
1146
        }
1147
1148 28
        if ($toEncoding === 'HTML-ENTITIES') {
1149 2
            return self::html_encode($str, true, 'UTF-8');
1150
        }
1151 28
        if ($fromEncoding === 'HTML-ENTITIES') {
1152 2
            $str = self::html_decode($str, \ENT_COMPAT, 'UTF-8');
1153 2
            $fromEncoding = '';
1154
        }
1155
1156 28
        $fromEncodingDetected = false;
1157
        if (
1158 28
            $autodetectFromEncoding === true
1159
            ||
1160 28
            !$fromEncoding
1161
        ) {
1162 28
            $fromEncodingDetected = self::str_detect_encoding($str);
1163
        }
1164
1165
        // DEBUG
1166
        //var_dump($toEncoding, $fromEncoding, $fromEncodingDetected, $str, "\n\n");
1167
1168 28
        if ($fromEncodingDetected !== false) {
1169 24
            $fromEncoding = $fromEncodingDetected;
1170 7
        } elseif ($autodetectFromEncoding === true) {
1171
            // fallback for the "autodetect"-mode
1172 7
            return self::to_utf8($str);
1173
        }
1174
1175
        if (
1176 24
            !$fromEncoding
1177
            ||
1178 24
            $fromEncoding === $toEncoding
1179
        ) {
1180 15
            return $str;
1181
        }
1182
1183
        if (
1184 19
            $toEncoding === 'UTF-8'
1185
            &&
1186
            (
1187 17
                $fromEncoding === 'WINDOWS-1252'
1188
                ||
1189 19
                $fromEncoding === 'ISO-8859-1'
1190
            )
1191
        ) {
1192 13
            return self::to_utf8($str);
1193
        }
1194
1195
        if (
1196 12
            $toEncoding === 'ISO-8859-1'
1197
            &&
1198
            (
1199 6
                $fromEncoding === 'WINDOWS-1252'
1200
                ||
1201 12
                $fromEncoding === 'UTF-8'
1202
            )
1203
        ) {
1204 6
            return self::to_iso8859($str);
1205
        }
1206
1207
        if (
1208 10
            $toEncoding !== 'UTF-8'
1209
            &&
1210 10
            $toEncoding !== 'ISO-8859-1'
1211
            &&
1212 10
            $toEncoding !== 'WINDOWS-1252'
1213
            &&
1214 10
            self::$SUPPORT['mbstring'] === false
1215
        ) {
1216
            \trigger_error('UTF8::encode() without mbstring cannot handle "' . $toEncoding . '" encoding', \E_USER_WARNING);
1217
        }
1218
1219 10
        if (self::$SUPPORT['mbstring'] === true) {
1220
            // warning: do not use the symfony polyfill here
1221 10
            $strEncoded = \mb_convert_encoding(
1222 10
                $str,
1223 10
                $toEncoding,
1224 10
                $fromEncoding
1225
            );
1226
1227 10
            if ($strEncoded) {
1228 10
                return $strEncoded;
1229
            }
1230
        }
1231
1232
        $return = \iconv($fromEncoding, $toEncoding, $str);
1233
        if ($return !== false) {
1234
            return $return;
1235
        }
1236
1237
        return $str;
1238
    }
1239
1240
    /**
1241
     * @param string $str
1242
     * @param string $fromCharset      [optional] <p>Set the input charset.</p>
1243
     * @param string $toCharset        [optional] <p>Set the output charset.</p>
1244
     * @param string $transferEncoding [optional] <p>Set the transfer encoding.</p>
1245
     * @param string $linefeed         [optional] <p>Set the used linefeed.</p>
1246
     * @param int    $indent           [optional] <p>Set the max length indent.</p>
1247
     *
1248
     * @return false|string
1249
     *                      An encoded MIME field on success,
1250
     *                      or false if an error occurs during the encoding
1251
     */
1252
    public static function encode_mimeheader(
1253
        $str,
1254
        $fromCharset = 'UTF-8',
1255
        $toCharset = 'UTF-8',
1256
        $transferEncoding = 'Q',
1257
        $linefeed = "\r\n",
1258
        $indent = 76
1259
    ) {
1260
        if ($fromCharset !== 'UTF-8' && $fromCharset !== 'CP850') {
1261
            $fromCharset = self::normalize_encoding($fromCharset, 'UTF-8');
1262
        }
1263
1264
        if ($toCharset !== 'UTF-8' && $toCharset !== 'CP850') {
1265
            $toCharset = self::normalize_encoding($toCharset, 'UTF-8');
1266
        }
1267
1268
        return \iconv_mime_encode(
1269
            '',
1270
            $str,
1271
            [
1272
                'scheme'           => $transferEncoding,
1273
                'line-length'      => $indent,
1274
                'input-charset'    => $fromCharset,
1275
                'output-charset'   => $toCharset,
1276
                'line-break-chars' => $linefeed,
1277
            ]
1278
        );
1279
    }
1280
1281
    /**
1282
     * Create an extract from a sentence, so if the search-string was found, it try to centered in the output.
1283
     *
1284
     * @param string   $str                    <p>The input string.</p>
1285
     * @param string   $search                 <p>The searched string.</p>
1286
     * @param int|null $length                 [optional] <p>Default: null === text->length / 2</p>
1287
     * @param string   $replacerForSkippedText [optional] <p>Default: …</p>
1288
     * @param string   $encoding               [optional] <p>Set the charset for e.g. "mb_" function</p>
1289
     *
1290
     * @return string
1291
     */
1292 1
    public static function extract_text(
1293
        string $str,
1294
        string $search = '',
1295
        int $length = null,
1296
        string $replacerForSkippedText = '…',
1297
        string $encoding = 'UTF-8'
1298
    ): string {
1299 1
        if ($str === '') {
1300 1
            return '';
1301
        }
1302
1303 1
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
1304
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
1305
        }
1306
1307 1
        $trimChars = "\t\r\n -_()!~?=+/*\\,.:;\"'[]{}`&";
1308
1309 1
        if ($length === null) {
1310 1
            $length = (int) \round((int) self::strlen($str, $encoding) / 2, 0);
1311
        }
1312
1313 1
        if ($search === '') {
1314 1
            if ($encoding === 'UTF-8') {
1315 1
                if ($length > 0) {
1316 1
                    $stringLength = (int) \mb_strlen($str);
1317 1
                    $end = ($length - 1) > $stringLength ? $stringLength : ($length - 1);
1318
                } else {
1319 1
                    $end = 0;
1320
                }
1321
1322 1
                $pos = (int) \min(
1323 1
                    \mb_strpos($str, ' ', $end),
1324 1
                    \mb_strpos($str, '.', $end)
1325
                );
1326
            } else {
1327
                if ($length > 0) {
1328
                    $stringLength = (int) self::strlen($str, $encoding);
1329
                    $end = ($length - 1) > $stringLength ? $stringLength : ($length - 1);
1330
                } else {
1331
                    $end = 0;
1332
                }
1333
1334
                $pos = (int) \min(
1335
                    self::strpos($str, ' ', $end, $encoding),
1336
                    self::strpos($str, '.', $end, $encoding)
1337
                );
1338
            }
1339
1340 1
            if ($pos) {
1341 1
                if ($encoding === 'UTF-8') {
1342 1
                    $strSub = \mb_substr($str, 0, $pos);
1343
                } else {
1344
                    $strSub = self::substr($str, 0, $pos, $encoding);
1345
                }
1346
1347 1
                if ($strSub === false) {
1348
                    return '';
1349
                }
1350
1351 1
                return \rtrim($strSub, $trimChars) . $replacerForSkippedText;
1352
            }
1353
1354
            return $str;
1355
        }
1356
1357 1
        if ($encoding === 'UTF-8') {
1358 1
            $wordPos = (int) \mb_stripos($str, $search);
1359 1
            $halfSide = (int) ($wordPos - $length / 2 + (int) \mb_strlen($search) / 2);
1360
        } else {
1361
            $wordPos = (int) self::stripos($str, $search, 0, $encoding);
1362
            $halfSide = (int) ($wordPos - $length / 2 + (int) self::strlen($search, $encoding) / 2);
1363
        }
1364
1365 1
        $pos_start = 0;
1366 1
        if ($halfSide > 0) {
1367 1
            if ($encoding === 'UTF-8') {
1368 1
                $halfText = \mb_substr($str, 0, $halfSide);
1369
            } else {
1370
                $halfText = self::substr($str, 0, $halfSide, $encoding);
1371
            }
1372 1
            if ($halfText !== false) {
1373 1
                if ($encoding === 'UTF-8') {
1374 1
                    $pos_start = (int) \max(
1375 1
                        \mb_strrpos($halfText, ' '),
1376 1
                        \mb_strrpos($halfText, '.')
1377
                    );
1378
                } else {
1379
                    $pos_start = (int) \max(
1380
                        self::strrpos($halfText, ' ', 0, $encoding),
1381
                        self::strrpos($halfText, '.', 0, $encoding)
1382
                    );
1383
                }
1384
            }
1385
        }
1386
1387 1
        if ($wordPos && $halfSide > 0) {
1388 1
            $offset = $pos_start + $length - 1;
1389 1
            $realLength = (int) self::strlen($str, $encoding);
1390
1391 1
            if ($offset > $realLength) {
1392
                $offset = $realLength;
1393
            }
1394
1395 1
            if ($encoding === 'UTF-8') {
1396 1
                $pos_end = (int) \min(
1397 1
                    \mb_strpos($str, ' ', $offset),
1398 1
                    \mb_strpos($str, '.', $offset)
1399 1
                    ) - $pos_start;
1400
            } else {
1401
                $pos_end = (int) \min(
1402
                    self::strpos($str, ' ', $offset, $encoding),
1403
                    self::strpos($str, '.', $offset, $encoding)
1404
                    ) - $pos_start;
1405
            }
1406
1407 1
            if (!$pos_end || $pos_end <= 0) {
1408 1
                if ($encoding === 'UTF-8') {
1409 1
                    $strSub = \mb_substr($str, $pos_start, (int) \mb_strlen($str));
1410
                } else {
1411
                    $strSub = self::substr($str, $pos_start, (int) self::strlen($str, $encoding), $encoding);
1412
                }
1413 1
                if ($strSub !== false) {
1414 1
                    $extract = $replacerForSkippedText . \ltrim($strSub, $trimChars);
1415
                } else {
1416 1
                    $extract = '';
1417
                }
1418
            } else {
1419 1
                if ($encoding === 'UTF-8') {
1420 1
                    $strSub = \mb_substr($str, $pos_start, $pos_end);
1421
                } else {
1422
                    $strSub = self::substr($str, $pos_start, $pos_end, $encoding);
1423
                }
1424 1
                if ($strSub !== false) {
1425 1
                    $extract = $replacerForSkippedText . \trim($strSub, $trimChars) . $replacerForSkippedText;
1426
                } else {
1427 1
                    $extract = '';
1428
                }
1429
            }
1430
        } else {
1431 1
            $offset = $length - 1;
1432 1
            $trueLength = (int) self::strlen($str, $encoding);
1433
1434 1
            if ($offset > $trueLength) {
1435
                $offset = $trueLength;
1436
            }
1437
1438 1
            if ($encoding === 'UTF-8') {
1439 1
                $pos_end = (int) \min(
1440 1
                    \mb_strpos($str, ' ', $offset),
1441 1
                    \mb_strpos($str, '.', $offset)
1442
                );
1443
            } else {
1444
                $pos_end = (int) \min(
1445
                    self::strpos($str, ' ', $offset, $encoding),
1446
                    self::strpos($str, '.', $offset, $encoding)
1447
                );
1448
            }
1449
1450 1
            if ($pos_end) {
1451 1
                if ($encoding === 'UTF-8') {
1452 1
                    $strSub = \mb_substr($str, 0, $pos_end);
1453
                } else {
1454
                    $strSub = self::substr($str, 0, $pos_end, $encoding);
1455
                }
1456 1
                if ($strSub !== false) {
1457 1
                    $extract = \rtrim($strSub, $trimChars) . $replacerForSkippedText;
1458
                } else {
1459 1
                    $extract = '';
1460
                }
1461
            } else {
1462 1
                $extract = $str;
1463
            }
1464
        }
1465
1466 1
        return $extract;
1467
    }
1468
1469
    /**
1470
     * Reads entire file into a string.
1471
     *
1472
     * WARNING: do not use UTF-8 Option ($convertToUtf8) for binary-files (e.g.: images) !!!
1473
     *
1474
     * @see http://php.net/manual/en/function.file-get-contents.php
1475
     *
1476
     * @param string        $filename         <p>
1477
     *                                        Name of the file to read.
1478
     *                                        </p>
1479
     * @param bool          $use_include_path [optional] <p>
1480
     *                                        Prior to PHP 5, this parameter is called
1481
     *                                        use_include_path and is a bool.
1482
     *                                        As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
1483
     *                                        to trigger include path
1484
     *                                        search.
1485
     *                                        </p>
1486
     * @param resource|null $context          [optional] <p>
1487
     *                                        A valid context resource created with
1488
     *                                        stream_context_create. If you don't need to use a
1489
     *                                        custom context, you can skip this parameter by &null;.
1490
     *                                        </p>
1491
     * @param int|null      $offset           [optional] <p>
1492
     *                                        The offset where the reading starts.
1493
     *                                        </p>
1494
     * @param int|null      $maxLength        [optional] <p>
1495
     *                                        Maximum length of data read. The default is to read until end
1496
     *                                        of file is reached.
1497
     *                                        </p>
1498
     * @param int           $timeout          <p>The time in seconds for the timeout.</p>
1499
     * @param bool          $convertToUtf8    <strong>WARNING!!!</strong> <p>Maybe you can't use this option for
1500
     *                                        some files, because they used non default utf-8 chars. Binary files
1501
     *                                        like images or pdf will not be converted.</p>
1502
     * @param string        $fromEncoding     [optional] <p>e.g. 'UTF-16', 'UTF-8', 'ISO-8859-1', etc.<br>
1503
     *                                        A empty string will trigger the autodetect anyway.</p>
1504
     *
1505
     * @return false|string the function returns the read data as string or <b>false</b> on failure
1506
     */
1507 12
    public static function file_get_contents(
1508
        string $filename,
1509
        bool $use_include_path = false,
1510
        $context = null,
1511
        int $offset = null,
1512
        int $maxLength = null,
1513
        int $timeout = 10,
1514
        bool $convertToUtf8 = true,
1515
        string $fromEncoding = ''
1516
    ) {
1517
        // init
1518 12
        $filename = \filter_var($filename, \FILTER_SANITIZE_STRING);
1519
1520 12
        if ($filename === false) {
1521
            return false;
1522
        }
1523
1524 12
        if ($timeout && $context === null) {
1525 9
            $context = \stream_context_create(
1526
                [
1527
                    'http' => [
1528 9
                        'timeout' => $timeout,
1529
                    ],
1530
                ]
1531
            );
1532
        }
1533
1534 12
        if ($offset === null) {
1535 12
            $offset = 0;
1536
        }
1537
1538 12
        if (\is_int($maxLength) === true) {
1539 2
            $data = \file_get_contents($filename, $use_include_path, $context, $offset, $maxLength);
1540
        } else {
1541 12
            $data = \file_get_contents($filename, $use_include_path, $context, $offset);
1542
        }
1543
1544
        // return false on error
1545 12
        if ($data === false) {
1546
            return false;
1547
        }
1548
1549 12
        if ($convertToUtf8 === true) {
1550
            if (
1551 12
                self::is_binary($data, true) === true
1552
                &&
1553 12
                self::is_utf16($data, false) === false
1554
                &&
1555 12
                self::is_utf32($data, false) === false
1556 7
            ) {
1557
                // do nothing, it's binary and not UTF16 or UTF32
1558
            } else {
1559 9
                $data = self::encode('UTF-8', $data, false, $fromEncoding);
1560 9
                $data = self::cleanup($data);
1561
            }
1562
        }
1563
1564 12
        return $data;
1565
    }
1566
1567
    /**
1568
     * Checks if a file starts with BOM (Byte Order Mark) character.
1569
     *
1570
     * @param string $file_path <p>Path to a valid file.</p>
1571
     *
1572
     * @throws \RuntimeException if file_get_contents() returned false
1573
     *
1574
     * @return bool
1575
     *              <strong>true</strong> if the file has BOM at the start, <strong>false</strong> otherwise
1576
     */
1577 2
    public static function file_has_bom(string $file_path): bool
1578
    {
1579 2
        $file_content = \file_get_contents($file_path);
1580 2
        if ($file_content === false) {
1581
            throw new \RuntimeException('file_get_contents() returned false for:' . $file_path);
1582
        }
1583
1584 2
        return self::string_has_bom($file_content);
1585
    }
1586
1587
    /**
1588
     * Normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1589
     *
1590
     * @param mixed  $var
1591
     * @param int    $normalization_form
1592
     * @param string $leading_combining
1593
     *
1594
     * @return mixed
1595
     */
1596 62
    public static function filter($var, int $normalization_form = \Normalizer::NFC, string $leading_combining = '◌')
1597
    {
1598 62
        switch (\gettype($var)) {
1599 62
            case 'array':
1600 6
                foreach ($var as $k => &$v) {
1601 6
                    $v = self::filter($v, $normalization_form, $leading_combining);
1602
                }
1603 6
                unset($v);
1604
1605 6
                break;
1606 62
            case 'object':
1607 4
                foreach ($var as $k => &$v) {
1608 4
                    $v = self::filter($v, $normalization_form, $leading_combining);
1609
                }
1610 4
                unset($v);
1611
1612 4
                break;
1613 62
            case 'string':
1614
1615 62
                if (\strpos($var, "\r") !== false) {
1616
                    // Workaround https://bugs.php.net/65732
1617 3
                    $var = self::normalize_line_ending($var);
1618
                }
1619
1620 62
                if (self::is_ascii($var) === false) {
1621 32
                    if (\Normalizer::isNormalized($var, $normalization_form)) {
1622 27
                        $n = '-';
1623
                    } else {
1624 12
                        $n = \Normalizer::normalize($var, $normalization_form);
1625
1626 12
                        if (isset($n[0])) {
1627 7
                            $var = $n;
1628
                        } else {
1629 8
                            $var = self::encode('UTF-8', $var, true);
1630
                        }
1631
                    }
1632
1633
                    if (
1634 32
                        $var[0] >= "\x80"
1635
                        &&
1636 32
                        isset($n[0], $leading_combining[0])
1637
                        &&
1638 32
                        \preg_match('/^\p{Mn}/u', $var)
1639
                    ) {
1640
                        // Prevent leading combining chars
1641
                        // for NFC-safe concatenations.
1642 3
                        $var = $leading_combining . $var;
1643
                    }
1644
                }
1645
1646 62
                break;
1647
        }
1648
1649 62
        return $var;
1650
    }
1651
1652
    /**
1653
     * "filter_input()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1654
     *
1655
     * Gets a specific external variable by name and optionally filters it
1656
     *
1657
     * @see http://php.net/manual/en/function.filter-input.php
1658
     *
1659
     * @param int    $type          <p>
1660
     *                              One of <b>INPUT_GET</b>, <b>INPUT_POST</b>,
1661
     *                              <b>INPUT_COOKIE</b>, <b>INPUT_SERVER</b>, or
1662
     *                              <b>INPUT_ENV</b>.
1663
     *                              </p>
1664
     * @param string $variable_name <p>
1665
     *                              Name of a variable to get.
1666
     *                              </p>
1667
     * @param int    $filter        [optional] <p>
1668
     *                              The ID of the filter to apply. The
1669
     *                              manual page lists the available filters.
1670
     *                              </p>
1671
     * @param mixed  $options       [optional] <p>
1672
     *                              Associative array of options or bitwise disjunction of flags. If filter
1673
     *                              accepts options, flags can be provided in "flags" field of array.
1674
     *                              </p>
1675
     *
1676
     * @return mixed Value of the requested variable on success, <b>FALSE</b> if the filter fails, or <b>NULL</b> if the
1677
     *               <i>variable_name</i> variable is not set. If the flag <b>FILTER_NULL_ON_FAILURE</b> is used, it
1678
     *               returns <b>FALSE</b> if the variable is not set and <b>NULL</b> if the filter fails.
1679
     */
1680
    public static function filter_input(
1681
        int $type,
1682
        string $variable_name,
1683
        int $filter = \FILTER_DEFAULT,
1684
        $options = null
1685
    ) {
1686
        if (\func_num_args() < 4) {
1687
            $var = \filter_input($type, $variable_name, $filter);
1688
        } else {
1689
            $var = \filter_input($type, $variable_name, $filter, $options);
1690
        }
1691
1692
        return self::filter($var);
1693
    }
1694
1695
    /**
1696
     * "filter_input_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1697
     *
1698
     * Gets external variables and optionally filters them
1699
     *
1700
     * @see http://php.net/manual/en/function.filter-input-array.php
1701
     *
1702
     * @param int   $type       <p>
1703
     *                          One of <b>INPUT_GET</b>, <b>INPUT_POST</b>,
1704
     *                          <b>INPUT_COOKIE</b>, <b>INPUT_SERVER</b>, or
1705
     *                          <b>INPUT_ENV</b>.
1706
     *                          </p>
1707
     * @param mixed $definition [optional] <p>
1708
     *                          An array defining the arguments. A valid key is a string
1709
     *                          containing a variable name and a valid value is either a filter type, or an array
1710
     *                          optionally specifying the filter, flags and options. If the value is an
1711
     *                          array, valid keys are filter which specifies the
1712
     *                          filter type,
1713
     *                          flags which specifies any flags that apply to the
1714
     *                          filter, and options which specifies any options that
1715
     *                          apply to the filter. See the example below for a better understanding.
1716
     *                          </p>
1717
     *                          <p>
1718
     *                          This parameter can be also an integer holding a filter constant. Then all values in the
1719
     *                          input array are filtered by this filter.
1720
     *                          </p>
1721
     * @param bool  $add_empty  [optional] <p>
1722
     *                          Add missing keys as <b>NULL</b> to the return value.
1723
     *                          </p>
1724
     *
1725
     * @return mixed An array containing the values of the requested variables on success, or <b>FALSE</b> on failure.
1726
     *               An array value will be <b>FALSE</b> if the filter fails, or <b>NULL</b> if the variable is not
1727
     *               set. Or if the flag <b>FILTER_NULL_ON_FAILURE</b> is used, it returns <b>FALSE</b> if the variable
1728
     *               is not set and <b>NULL</b> if the filter fails.
1729
     */
1730
    public static function filter_input_array(int $type, $definition = null, bool $add_empty = true)
1731
    {
1732
        if (\func_num_args() < 2) {
1733
            $a = \filter_input_array($type);
1734
        } else {
1735
            $a = \filter_input_array($type, $definition, $add_empty);
1736
        }
1737
1738
        return self::filter($a);
1739
    }
1740
1741
    /**
1742
     * "filter_var()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1743
     *
1744
     * Filters a variable with a specified filter
1745
     *
1746
     * @see http://php.net/manual/en/function.filter-var.php
1747
     *
1748
     * @param mixed $variable <p>
1749
     *                        Value to filter.
1750
     *                        </p>
1751
     * @param int   $filter   [optional] <p>
1752
     *                        The ID of the filter to apply. The
1753
     *                        manual page lists the available filters.
1754
     *                        </p>
1755
     * @param mixed $options  [optional] <p>
1756
     *                        Associative array of options or bitwise disjunction of flags. If filter
1757
     *                        accepts options, flags can be provided in "flags" field of array. For
1758
     *                        the "callback" filter, callable type should be passed. The
1759
     *                        callback must accept one argument, the value to be filtered, and return
1760
     *                        the value after filtering/sanitizing it.
1761
     *                        </p>
1762
     *                        <p>
1763
     *                        <code>
1764
     *                        // for filters that accept options, use this format
1765
     *                        $options = array(
1766
     *                        'options' => array(
1767
     *                        'default' => 3, // value to return if the filter fails
1768
     *                        // other options here
1769
     *                        'min_range' => 0
1770
     *                        ),
1771
     *                        'flags' => FILTER_FLAG_ALLOW_OCTAL,
1772
     *                        );
1773
     *                        $var = filter_var('0755', FILTER_VALIDATE_INT, $options);
1774
     *                        // for filter that only accept flags, you can pass them directly
1775
     *                        $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
1776
     *                        // for filter that only accept flags, you can also pass as an array
1777
     *                        $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN,
1778
     *                        array('flags' => FILTER_NULL_ON_FAILURE));
1779
     *                        // callback validate filter
1780
     *                        function foo($value)
1781
     *                        {
1782
     *                        // Expected format: Surname, GivenNames
1783
     *                        if (strpos($value, ", ") === false) return false;
1784
     *                        list($surname, $givennames) = explode(", ", $value, 2);
1785
     *                        $empty = (empty($surname) || empty($givennames));
1786
     *                        $notstrings = (!is_string($surname) || !is_string($givennames));
1787
     *                        if ($empty || $notstrings) {
1788
     *                        return false;
1789
     *                        } else {
1790
     *                        return $value;
1791
     *                        }
1792
     *                        }
1793
     *                        $var = filter_var('Doe, Jane Sue', FILTER_CALLBACK, array('options' => 'foo'));
1794
     *                        </code>
1795
     *                        </p>
1796
     *
1797
     * @return mixed the filtered data, or <b>FALSE</b> if the filter fails
1798
     */
1799 2
    public static function filter_var($variable, int $filter = \FILTER_DEFAULT, $options = null)
1800
    {
1801 2
        if (\func_num_args() < 3) {
1802 2
            $variable = \filter_var($variable, $filter);
1803
        } else {
1804 2
            $variable = \filter_var($variable, $filter, $options);
1805
        }
1806
1807 2
        return self::filter($variable);
1808
    }
1809
1810
    /**
1811
     * "filter_var_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1812
     *
1813
     * Gets multiple variables and optionally filters them
1814
     *
1815
     * @see http://php.net/manual/en/function.filter-var-array.php
1816
     *
1817
     * @param array $data       <p>
1818
     *                          An array with string keys containing the data to filter.
1819
     *                          </p>
1820
     * @param mixed $definition [optional] <p>
1821
     *                          An array defining the arguments. A valid key is a string
1822
     *                          containing a variable name and a valid value is either a
1823
     *                          filter type, or an
1824
     *                          array optionally specifying the filter, flags and options.
1825
     *                          If the value is an array, valid keys are filter
1826
     *                          which specifies the filter type,
1827
     *                          flags which specifies any flags that apply to the
1828
     *                          filter, and options which specifies any options that
1829
     *                          apply to the filter. See the example below for a better understanding.
1830
     *                          </p>
1831
     *                          <p>
1832
     *                          This parameter can be also an integer holding a filter constant. Then all values in the
1833
     *                          input array are filtered by this filter.
1834
     *                          </p>
1835
     * @param bool  $add_empty  [optional] <p>
1836
     *                          Add missing keys as <b>NULL</b> to the return value.
1837
     *                          </p>
1838
     *
1839
     * @return mixed an array containing the values of the requested variables on success, or <b>FALSE</b> on failure.
1840
     *               An array value will be <b>FALSE</b> if the filter fails, or <b>NULL</b> if the variable is not
1841
     *               set
1842
     */
1843 2
    public static function filter_var_array(array $data, $definition = null, bool $add_empty = true)
1844
    {
1845 2
        if (\func_num_args() < 2) {
1846 2
            $a = \filter_var_array($data);
1847
        } else {
1848 2
            $a = \filter_var_array($data, $definition, $add_empty);
1849
        }
1850
1851 2
        return self::filter($a);
1852
    }
1853
1854
    /**
1855
     * Checks whether finfo is available on the server.
1856
     *
1857
     * @return bool
1858
     *              <strong>true</strong> if available, <strong>false</strong> otherwise
1859
     */
1860
    public static function finfo_loaded(): bool
1861
    {
1862
        return \class_exists('finfo');
1863
    }
1864
1865
    /**
1866
     * Returns the first $n characters of the string.
1867
     *
1868
     * @param string $str      <p>The input string.</p>
1869
     * @param int    $n        <p>Number of characters to retrieve from the start.</p>
1870
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
1871
     *
1872
     * @return string
1873
     */
1874 13
    public static function first_char(string $str, int $n = 1, string $encoding = 'UTF-8'): string
1875
    {
1876 13
        if ($str === '' || $n <= 0) {
1877 5
            return '';
1878
        }
1879
1880 8
        if ($encoding === 'UTF-8') {
1881 4
            return (string) \mb_substr($str, 0, $n);
1882
        }
1883
1884 4
        return (string) self::substr($str, 0, $n, $encoding);
1885
    }
1886
1887
    /**
1888
     * Check if the number of unicode characters are not more than the specified integer.
1889
     *
1890
     * @param string $str      the original string to be checked
1891
     * @param int    $box_size the size in number of chars to be checked against string
1892
     *
1893
     * @return bool true if string is less than or equal to $box_size, false otherwise
1894
     */
1895 2
    public static function fits_inside(string $str, int $box_size): bool
1896
    {
1897 2
        return self::strlen($str) <= $box_size;
1898
    }
1899
1900
    /**
1901
     * Try to fix simple broken UTF-8 strings.
1902
     *
1903
     * INFO: Take a look at "UTF8::fix_utf8()" if you need a more advanced fix for broken UTF-8 strings.
1904
     *
1905
     * If you received an UTF-8 string that was converted from Windows-1252 as it was ISO-8859-1
1906
     * (ignoring Windows-1252 chars from 80 to 9F) use this function to fix it.
1907
     * See: http://en.wikipedia.org/wiki/Windows-1252
1908
     *
1909
     * @param string $str <p>The input string</p>
1910
     *
1911
     * @return string
1912
     */
1913 46
    public static function fix_simple_utf8(string $str): string
1914
    {
1915 46
        if ($str === '') {
1916 4
            return '';
1917
        }
1918
1919 46
        static $BROKEN_UTF8_TO_UTF8_KEYS_CACHE = null;
1920 46
        static $BROKEN_UTF8_TO_UTF8_VALUES_CACHE = null;
1921
1922 46
        if ($BROKEN_UTF8_TO_UTF8_KEYS_CACHE === null) {
1923 1
            if (self::$BROKEN_UTF8_FIX === null) {
1924 1
                self::$BROKEN_UTF8_FIX = self::getData('utf8_fix');
1925
            }
1926
1927 1
            $BROKEN_UTF8_TO_UTF8_KEYS_CACHE = \array_keys(self::$BROKEN_UTF8_FIX);
1928 1
            $BROKEN_UTF8_TO_UTF8_VALUES_CACHE = \array_values(self::$BROKEN_UTF8_FIX);
1929
        }
1930
1931 46
        return \str_replace($BROKEN_UTF8_TO_UTF8_KEYS_CACHE, $BROKEN_UTF8_TO_UTF8_VALUES_CACHE, $str);
1932
    }
1933
1934
    /**
1935
     * Fix a double (or multiple) encoded UTF8 string.
1936
     *
1937
     * @param string|string[] $str you can use a string or an array of strings
1938
     *
1939
     * @return string|string[]
1940
     *                         Will return the fixed input-"array" or
1941
     *                         the fixed input-"string"
1942
     *
1943
     * @psalm-suppress InvalidReturnType
1944
     */
1945 2
    public static function fix_utf8($str)
1946
    {
1947 2
        if (\is_array($str) === true) {
1948 2
            foreach ($str as $k => &$v) {
1949 2
                $v = self::fix_utf8($v);
1950
            }
1951 2
            unset($v);
1952
1953
            /**
1954
             * @psalm-suppress InvalidReturnStatement
1955
             */
1956 2
            return $str;
1957
        }
1958
1959 2
        $str = (string) $str;
1960 2
        $last = '';
1961 2
        while ($last !== $str) {
1962 2
            $last = $str;
1963
            /**
1964
             * @psalm-suppress PossiblyInvalidArgument
1965
             */
1966 2
            $str = self::to_utf8(
1967 2
                self::utf8_decode($str, true)
1968
            );
1969
        }
1970
1971
        /**
1972
         * @psalm-suppress InvalidReturnStatement
1973
         */
1974 2
        return $str;
1975
    }
1976
1977
    /**
1978
     * Get character of a specific character.
1979
     *
1980
     * @param string $char
1981
     *
1982
     * @return string 'RTL' or 'LTR'
1983
     */
1984 2
    public static function getCharDirection(string $char): string
1985
    {
1986 2
        if (self::$SUPPORT['intlChar'] === true) {
1987
            /** @noinspection PhpComposerExtensionStubsInspection */
1988 2
            $tmpReturn = \IntlChar::charDirection($char);
1989
1990
            // from "IntlChar"-Class
1991
            $charDirection = [
1992 2
                'RTL' => [1, 13, 14, 15, 21],
1993
                'LTR' => [0, 11, 12, 20],
1994
            ];
1995
1996 2
            if (\in_array($tmpReturn, $charDirection['LTR'], true)) {
1997
                return 'LTR';
1998
            }
1999
2000 2
            if (\in_array($tmpReturn, $charDirection['RTL'], true)) {
2001 2
                return 'RTL';
2002
            }
2003
        }
2004
2005 2
        $c = static::chr_to_decimal($char);
2006
2007 2
        if (!($c >= 0x5be && $c <= 0x10b7f)) {
2008 2
            return 'LTR';
2009
        }
2010
2011 2
        if ($c <= 0x85e) {
2012 2
            if ($c === 0x5be ||
2013 2
                $c === 0x5c0 ||
2014 2
                $c === 0x5c3 ||
2015 2
                $c === 0x5c6 ||
2016 2
                ($c >= 0x5d0 && $c <= 0x5ea) ||
2017 2
                ($c >= 0x5f0 && $c <= 0x5f4) ||
2018 2
                $c === 0x608 ||
2019 2
                $c === 0x60b ||
2020 2
                $c === 0x60d ||
2021 2
                $c === 0x61b ||
2022 2
                ($c >= 0x61e && $c <= 0x64a) ||
2023
                ($c >= 0x66d && $c <= 0x66f) ||
2024
                ($c >= 0x671 && $c <= 0x6d5) ||
2025
                ($c >= 0x6e5 && $c <= 0x6e6) ||
2026
                ($c >= 0x6ee && $c <= 0x6ef) ||
2027
                ($c >= 0x6fa && $c <= 0x70d) ||
2028
                $c === 0x710 ||
2029
                ($c >= 0x712 && $c <= 0x72f) ||
2030
                ($c >= 0x74d && $c <= 0x7a5) ||
2031
                $c === 0x7b1 ||
2032
                ($c >= 0x7c0 && $c <= 0x7ea) ||
2033
                ($c >= 0x7f4 && $c <= 0x7f5) ||
2034
                $c === 0x7fa ||
2035
                ($c >= 0x800 && $c <= 0x815) ||
2036
                $c === 0x81a ||
2037
                $c === 0x824 ||
2038
                $c === 0x828 ||
2039
                ($c >= 0x830 && $c <= 0x83e) ||
2040
                ($c >= 0x840 && $c <= 0x858) ||
2041 2
                $c === 0x85e
2042
            ) {
2043 2
                return 'RTL';
2044
            }
2045 2
        } elseif ($c === 0x200f) {
2046
            return 'RTL';
2047 2
        } elseif ($c >= 0xfb1d) {
2048 2
            if ($c === 0xfb1d ||
2049 2
                ($c >= 0xfb1f && $c <= 0xfb28) ||
2050 2
                ($c >= 0xfb2a && $c <= 0xfb36) ||
2051 2
                ($c >= 0xfb38 && $c <= 0xfb3c) ||
2052 2
                $c === 0xfb3e ||
2053 2
                ($c >= 0xfb40 && $c <= 0xfb41) ||
2054 2
                ($c >= 0xfb43 && $c <= 0xfb44) ||
2055 2
                ($c >= 0xfb46 && $c <= 0xfbc1) ||
2056 2
                ($c >= 0xfbd3 && $c <= 0xfd3d) ||
2057 2
                ($c >= 0xfd50 && $c <= 0xfd8f) ||
2058 2
                ($c >= 0xfd92 && $c <= 0xfdc7) ||
2059 2
                ($c >= 0xfdf0 && $c <= 0xfdfc) ||
2060 2
                ($c >= 0xfe70 && $c <= 0xfe74) ||
2061 2
                ($c >= 0xfe76 && $c <= 0xfefc) ||
2062 2
                ($c >= 0x10800 && $c <= 0x10805) ||
2063 2
                $c === 0x10808 ||
2064 2
                ($c >= 0x1080a && $c <= 0x10835) ||
2065 2
                ($c >= 0x10837 && $c <= 0x10838) ||
2066 2
                $c === 0x1083c ||
2067 2
                ($c >= 0x1083f && $c <= 0x10855) ||
2068 2
                ($c >= 0x10857 && $c <= 0x1085f) ||
2069 2
                ($c >= 0x10900 && $c <= 0x1091b) ||
2070 2
                ($c >= 0x10920 && $c <= 0x10939) ||
2071 2
                $c === 0x1093f ||
2072 2
                $c === 0x10a00 ||
2073 2
                ($c >= 0x10a10 && $c <= 0x10a13) ||
2074 2
                ($c >= 0x10a15 && $c <= 0x10a17) ||
2075 2
                ($c >= 0x10a19 && $c <= 0x10a33) ||
2076 2
                ($c >= 0x10a40 && $c <= 0x10a47) ||
2077 2
                ($c >= 0x10a50 && $c <= 0x10a58) ||
2078 2
                ($c >= 0x10a60 && $c <= 0x10a7f) ||
2079 2
                ($c >= 0x10b00 && $c <= 0x10b35) ||
2080 2
                ($c >= 0x10b40 && $c <= 0x10b55) ||
2081 2
                ($c >= 0x10b58 && $c <= 0x10b72) ||
2082 2
                ($c >= 0x10b78 && $c <= 0x10b7f)
2083
            ) {
2084 2
                return 'RTL';
2085
            }
2086
        }
2087
2088 2
        return 'LTR';
2089
    }
2090
2091
    /**
2092
     * Check for php-support.
2093
     *
2094
     * @param string|null $key
2095
     *
2096
     * @return mixed
2097
     *               Return the full support-"array", if $key === null<br>
2098
     *               return bool-value, if $key is used and available<br>
2099
     *               otherwise return <strong>null</strong>
2100
     */
2101 27
    public static function getSupportInfo(string $key = null)
2102
    {
2103 27
        if ($key === null) {
2104 4
            return self::$SUPPORT;
2105
        }
2106
2107 25
        if (self::$INTL_TRANSLITERATOR_LIST === null) {
2108 1
            self::$INTL_TRANSLITERATOR_LIST = self::getData('transliterator_list');
2109
        }
2110
        // compatibility fix for old versions
2111 25
        self::$SUPPORT['intl__transliterator_list_ids'] = self::$INTL_TRANSLITERATOR_LIST;
2112
2113 25
        return self::$SUPPORT[$key] ?? null;
2114
    }
2115
2116
    /**
2117
     * Warning: this method only works for some file-types (png bmp gif jpg rar zip midi exe pdf)
2118
     *          if you need more supported types, please use e.g. "finfo"
2119
     *
2120
     * @param string $str
2121
     * @param array  $fallback with this keys: 'ext', 'mime', 'type'
2122
     *
2123
     * @return array
2124
     *               with this keys: 'ext', 'mime', 'type'
2125
     */
2126 39
    public static function get_file_type(
2127
        string $str,
2128
        array $fallback = [
2129
            'ext'  => null,
2130
            'mime' => 'application/octet-stream',
2131
            'type' => null,
2132
        ]
2133
    ): array {
2134 39
        if ($str === '') {
2135
            return $fallback;
2136
        }
2137
2138 39
        $str_info = \substr($str, 0, 2);
2139 39
        if ($str_info === false || \strlen($str_info) !== 2) {
2140 11
            return $fallback;
2141
        }
2142
2143 35
        $str_info = \unpack('C2chars', $str_info);
2144 35
        if ($str_info === false) {
2145
            return $fallback;
2146
        }
2147 35
        $type_code = (int) ($str_info['chars1'] . $str_info['chars2']);
2148
2149
        // DEBUG
2150
        //var_dump($type_code);
2151
2152
        switch ($type_code) {
2153 35
            case 3780:
2154 5
                $ext = 'pdf';
2155 5
                $mime = 'application/pdf';
2156 5
                $type = 'binary';
2157
2158 5
                break;
2159 35
            case 7790:
2160
                $ext = 'exe';
2161
                $mime = 'application/octet-stream';
2162
                $type = 'binary';
2163
2164
                break;
2165 35
            case 7784:
2166
                $ext = 'midi';
2167
                $mime = 'audio/x-midi';
2168
                $type = 'binary';
2169
2170
                break;
2171 35
            case 8075:
2172 7
                $ext = 'zip';
2173 7
                $mime = 'application/zip';
2174 7
                $type = 'binary';
2175
2176 7
                break;
2177 35
            case 8297:
2178
                $ext = 'rar';
2179
                $mime = 'application/rar';
2180
                $type = 'binary';
2181
2182
                break;
2183 35
            case 255216:
2184
                $ext = 'jpg';
2185
                $mime = 'image/jpeg';
2186
                $type = 'binary';
2187
2188
                break;
2189 35
            case 7173:
2190
                $ext = 'gif';
2191
                $mime = 'image/gif';
2192
                $type = 'binary';
2193
2194
                break;
2195 35
            case 7373:
2196
                $ext = 'tiff';
2197
                $mime = 'image/tiff';
2198
                $type = 'binary';
2199
2200
                break;
2201 35
            case 6677:
2202
                $ext = 'bmp';
2203
                $mime = 'image/bmp';
2204
                $type = 'binary';
2205
2206
                break;
2207 35
            case 13780:
2208 7
                $ext = 'png';
2209 7
                $mime = 'image/png';
2210 7
                $type = 'binary';
2211
2212 7
                break;
2213
            default:
2214 32
                return $fallback;
2215
        }
2216
2217
        return [
2218 7
            'ext'  => $ext,
2219 7
            'mime' => $mime,
2220 7
            'type' => $type,
2221
        ];
2222
    }
2223
2224
    /**
2225
     * @param int    $length        <p>Length of the random string.</p>
2226
     * @param string $possibleChars [optional] <p>Characters string for the random selection.</p>
2227
     * @param string $encoding      [optional] <p>Set the charset for e.g. "mb_" function</p>
2228
     *
2229
     * @return string
2230
     */
2231 1
    public static function get_random_string(int $length, string $possibleChars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789', string $encoding = 'UTF-8'): string
2232
    {
2233
        // init
2234 1
        $i = 0;
2235 1
        $str = '';
2236
2237
        //
2238
        // add random chars
2239
        //
2240
2241 1
        if ($encoding === 'UTF-8') {
2242 1
            $maxlength = (int) \mb_strlen($possibleChars);
2243 1
            if ($maxlength === 0) {
2244 1
                return '';
2245
            }
2246
2247 1
            while ($i < $length) {
2248
                try {
2249 1
                    $randInt = \random_int(0, $maxlength - 1);
2250
                } catch (\Exception $e) {
2251
                    /** @noinspection RandomApiMigrationInspection */
2252
                    $randInt = \mt_rand(0, $maxlength - 1);
2253
                }
2254 1
                $char = \mb_substr($possibleChars, $randInt, 1);
2255 1
                if ($char !== false) {
2256 1
                    $str .= $char;
2257 1
                    ++$i;
2258
                }
2259
            }
2260
        } else {
2261
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
2262
2263
            $maxlength = (int) self::strlen($possibleChars, $encoding);
2264
            if ($maxlength === 0) {
2265
                return '';
2266
            }
2267
2268
            while ($i < $length) {
2269
                try {
2270
                    $randInt = \random_int(0, $maxlength - 1);
2271
                } catch (\Exception $e) {
2272
                    /** @noinspection RandomApiMigrationInspection */
2273
                    $randInt = \mt_rand(0, $maxlength - 1);
2274
                }
2275
                $char = self::substr($possibleChars, $randInt, 1, $encoding);
2276
                if ($char !== false) {
2277
                    $str .= $char;
2278
                    ++$i;
2279
                }
2280
            }
2281
        }
2282
2283 1
        return $str;
2284
    }
2285
2286
    /**
2287
     * @param int|string $entropyExtra [optional] <p>Extra entropy via a string or int value.</p>
2288
     * @param bool       $md5          [optional] <p>Return the unique identifier as md5-hash? Default: true</p>
2289
     *
2290
     * @return string
2291
     */
2292 1
    public static function get_unique_string($entropyExtra = '', bool $md5 = true): string
2293
    {
2294 1
        $uniqueHelper = \random_int(0, \mt_getrandmax()) .
2295 1
                        \session_id() .
2296 1
                        ($_SERVER['REMOTE_ADDR'] ?? '') .
2297 1
                        ($_SERVER['SERVER_ADDR'] ?? '') .
2298 1
                        $entropyExtra;
2299
2300 1
        $uniqueString = \uniqid($uniqueHelper, true);
2301
2302 1
        if ($md5) {
2303 1
            $uniqueString = \md5($uniqueString . $uniqueHelper);
2304
        }
2305
2306 1
        return $uniqueString;
2307
    }
2308
2309
    /**
2310
     * alias for "UTF8::string_has_bom()"
2311
     *
2312
     * @param string $str
2313
     *
2314
     * @return bool
2315
     *
2316
     * @see UTF8::string_has_bom()
2317
     * @deprecated <p>use "UTF8::string_has_bom()"</p>
2318
     */
2319 2
    public static function hasBom(string $str): bool
2320
    {
2321 2
        return self::string_has_bom($str);
2322
    }
2323
2324
    /**
2325
     * Returns true if the string contains a lower case char, false otherwise.
2326
     *
2327
     * @param string $str <p>The input string.</p>
2328
     *
2329
     * @return bool whether or not the string contains a lower case character
2330
     */
2331 47
    public static function has_lowercase(string $str): bool
2332
    {
2333 47
        if (self::$SUPPORT['mbstring'] === true) {
2334
            /** @noinspection PhpComposerExtensionStubsInspection */
2335 47
            return \mb_ereg_match('.*[[:lower:]]', $str);
2336
        }
2337
2338
        return self::str_matches_pattern($str, '.*[[:lower:]]');
2339
    }
2340
2341
    /**
2342
     * Returns true if the string contains an upper case char, false otherwise.
2343
     *
2344
     * @param string $str <p>The input string.</p>
2345
     *
2346
     * @return bool whether or not the string contains an upper case character
2347
     */
2348 12
    public static function has_uppercase(string $str): bool
2349
    {
2350 12
        if (self::$SUPPORT['mbstring'] === true) {
2351
            /** @noinspection PhpComposerExtensionStubsInspection */
2352 12
            return \mb_ereg_match('.*[[:upper:]]', $str);
2353
        }
2354
2355
        return self::str_matches_pattern($str, '.*[[:upper:]]');
2356
    }
2357
2358
    /**
2359
     * Converts a hexadecimal-value into an UTF-8 character.
2360
     *
2361
     * @param string $hexdec <p>The hexadecimal value.</p>
2362
     *
2363
     * @return false|string one single UTF-8 character
2364
     */
2365 4
    public static function hex_to_chr(string $hexdec)
2366
    {
2367 4
        return self::decimal_to_chr(\hexdec($hexdec));
2368
    }
2369
2370
    /**
2371
     * Converts hexadecimal U+xxxx code point representation to integer.
2372
     *
2373
     * INFO: opposite to UTF8::int_to_hex()
2374
     *
2375
     * @param string $hexDec <p>The hexadecimal code point representation.</p>
2376
     *
2377
     * @return false|int the code point, or false on failure
2378
     */
2379 2
    public static function hex_to_int($hexDec)
2380
    {
2381
        // init
2382 2
        $hexDec = (string) $hexDec;
2383
2384 2
        if ($hexDec === '') {
2385 2
            return false;
2386
        }
2387
2388 2
        if (\preg_match('/^(?:\\\u|U\+|)([a-zA-Z0-9]{4,6})$/', $hexDec, $match)) {
2389 2
            return \intval($match[1], 16);
2390
        }
2391
2392 2
        return false;
2393
    }
2394
2395
    /**
2396
     * alias for "UTF8::html_entity_decode()"
2397
     *
2398
     * @param string $str
2399
     * @param int    $flags
2400
     * @param string $encoding
2401
     *
2402
     * @return string
2403
     *
2404
     * @see UTF8::html_entity_decode()
2405
     */
2406 4
    public static function html_decode(string $str, int $flags = null, string $encoding = 'UTF-8'): string
2407
    {
2408 4
        return self::html_entity_decode($str, $flags, $encoding);
2409
    }
2410
2411
    /**
2412
     * Converts a UTF-8 string to a series of HTML numbered entities.
2413
     *
2414
     * INFO: opposite to UTF8::html_decode()
2415
     *
2416
     * @param string $str            <p>The Unicode string to be encoded as numbered entities.</p>
2417
     * @param bool   $keepAsciiChars [optional] <p>Keep ASCII chars.</p>
2418
     * @param string $encoding       [optional] <p>Set the charset for e.g. "mb_" function</p>
2419
     *
2420
     * @return string HTML numbered entities
2421
     */
2422 14
    public static function html_encode(string $str, bool $keepAsciiChars = false, string $encoding = 'UTF-8'): string
2423
    {
2424 14
        if ($str === '') {
2425 4
            return '';
2426
        }
2427
2428 14
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
2429 4
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
2430
        }
2431
2432
        // INFO: http://stackoverflow.com/questions/35854535/better-explanation-of-convmap-in-mb-encode-numericentity
2433 14
        if (self::$SUPPORT['mbstring'] === true) {
2434 14
            $startCode = 0x00;
2435 14
            if ($keepAsciiChars === true) {
2436 13
                $startCode = 0x80;
2437
            }
2438
2439 14
            if ($encoding === 'UTF-8') {
2440 14
                return \mb_encode_numericentity(
2441 14
                    $str,
2442 14
                    [$startCode, 0xfffff, 0, 0xfffff, 0]
2443
                );
2444
            }
2445
2446 4
            return \mb_encode_numericentity(
2447 4
                $str,
2448 4
                [$startCode, 0xfffff, 0, 0xfffff, 0],
2449 4
                $encoding
2450
            );
2451
        }
2452
2453
        //
2454
        // fallback via vanilla php
2455
        //
2456
2457
        return \implode(
2458
            '',
2459
            \array_map(
2460
                static function (string $chr) use ($keepAsciiChars, $encoding): string {
2461
                    return self::single_chr_html_encode($chr, $keepAsciiChars, $encoding);
2462
                },
2463
                self::str_split($str)
2464
            )
2465
        );
2466
    }
2467
2468
    /**
2469
     * UTF-8 version of html_entity_decode()
2470
     *
2471
     * The reason we are not using html_entity_decode() by itself is because
2472
     * while it is not technically correct to leave out the semicolon
2473
     * at the end of an entity most browsers will still interpret the entity
2474
     * correctly. html_entity_decode() does not convert entities without
2475
     * semicolons, so we are left with our own little solution here. Bummer.
2476
     *
2477
     * Convert all HTML entities to their applicable characters
2478
     *
2479
     * INFO: opposite to UTF8::html_encode()
2480
     *
2481
     * @see http://php.net/manual/en/function.html-entity-decode.php
2482
     *
2483
     * @param string $str      <p>
2484
     *                         The input string.
2485
     *                         </p>
2486
     * @param int    $flags    [optional] <p>
2487
     *                         A bitmask of one or more of the following flags, which specify how to handle quotes
2488
     *                         and which document type to use. The default is ENT_COMPAT | ENT_HTML401.
2489
     *                         <table>
2490
     *                         Available <i>flags</i> constants
2491
     *                         <tr valign="top">
2492
     *                         <td>Constant Name</td>
2493
     *                         <td>Description</td>
2494
     *                         </tr>
2495
     *                         <tr valign="top">
2496
     *                         <td><b>ENT_COMPAT</b></td>
2497
     *                         <td>Will convert double-quotes and leave single-quotes alone.</td>
2498
     *                         </tr>
2499
     *                         <tr valign="top">
2500
     *                         <td><b>ENT_QUOTES</b></td>
2501
     *                         <td>Will convert both double and single quotes.</td>
2502
     *                         </tr>
2503
     *                         <tr valign="top">
2504
     *                         <td><b>ENT_NOQUOTES</b></td>
2505
     *                         <td>Will leave both double and single quotes unconverted.</td>
2506
     *                         </tr>
2507
     *                         <tr valign="top">
2508
     *                         <td><b>ENT_HTML401</b></td>
2509
     *                         <td>
2510
     *                         Handle code as HTML 4.01.
2511
     *                         </td>
2512
     *                         </tr>
2513
     *                         <tr valign="top">
2514
     *                         <td><b>ENT_XML1</b></td>
2515
     *                         <td>
2516
     *                         Handle code as XML 1.
2517
     *                         </td>
2518
     *                         </tr>
2519
     *                         <tr valign="top">
2520
     *                         <td><b>ENT_XHTML</b></td>
2521
     *                         <td>
2522
     *                         Handle code as XHTML.
2523
     *                         </td>
2524
     *                         </tr>
2525
     *                         <tr valign="top">
2526
     *                         <td><b>ENT_HTML5</b></td>
2527
     *                         <td>
2528
     *                         Handle code as HTML 5.
2529
     *                         </td>
2530
     *                         </tr>
2531
     *                         </table>
2532
     *                         </p>
2533
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
2534
     *
2535
     * @return string the decoded string
2536
     */
2537 46
    public static function html_entity_decode(string $str, int $flags = null, string $encoding = 'UTF-8'): string
2538
    {
2539
        if (
2540 46
            !isset($str[3]) // examples: &; || &x;
2541
            ||
2542 46
            \strpos($str, '&') === false // no "&"
2543
        ) {
2544 23
            return $str;
2545
        }
2546
2547 44
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
2548 9
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
2549
        }
2550
2551 44
        if ($flags === null) {
2552 10
            $flags = \ENT_QUOTES | \ENT_HTML5;
2553
        }
2554
2555
        if (
2556 44
            $encoding !== 'UTF-8'
2557
            &&
2558 44
            $encoding !== 'ISO-8859-1'
2559
            &&
2560 44
            $encoding !== 'WINDOWS-1252'
2561
            &&
2562 44
            self::$SUPPORT['mbstring'] === false
2563
        ) {
2564
            \trigger_error('UTF8::html_entity_decode() without mbstring cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
2565
        }
2566
2567
        do {
2568 44
            $str_compare = $str;
2569
2570
            // INFO: http://stackoverflow.com/questions/35854535/better-explanation-of-convmap-in-mb-encode-numericentity
2571 44
            if (self::$SUPPORT['mbstring'] === true) {
2572 44
                if ($encoding === 'UTF-8') {
2573 44
                    $str = \mb_decode_numericentity(
2574 44
                        $str,
2575 44
                        [0x80, 0xfffff, 0, 0xfffff, 0]
2576
                    );
2577
                } else {
2578 4
                    $str = \mb_decode_numericentity(
2579 4
                        $str,
2580 4
                        [0x80, 0xfffff, 0, 0xfffff, 0],
2581 44
                        $encoding
2582
                    );
2583
                }
2584
            } else {
2585
                $str = (string) \preg_replace_callback(
2586
                    "/&#\d{2,6};/",
2587
                    /**
2588
                     * @param string[] $matches
2589
                     *
2590
                     * @return string
2591
                     */
2592
                    static function (array $matches) use ($encoding): string {
2593
                        $returnTmp = \mb_convert_encoding($matches[0], $encoding, 'HTML-ENTITIES');
2594
                        if ($returnTmp !== '"' && $returnTmp !== "'") {
2595
                            return $returnTmp;
2596
                        }
2597
2598
                        return $matches[0];
2599
                    },
2600
                    $str
2601
                );
2602
            }
2603
2604 44
            if (\strpos($str, '&') !== false) {
2605 40
                if (\strpos($str, '&#') !== false) {
2606
                    // decode also numeric & UTF16 two byte entities
2607 32
                    $str = (string) \preg_replace(
2608 32
                        '/(&#(?:x0*[0-9a-fA-F]{2,6}(?![0-9a-fA-F;])|(?:0*\d{2,6}(?![0-9;]))))/S',
2609 32
                        '$1;',
2610 32
                        $str
2611
                    );
2612
                }
2613
2614 40
                $str = \html_entity_decode(
2615 40
                    $str,
2616 40
                    $flags,
2617 40
                    $encoding
2618
                );
2619
            }
2620 44
        } while ($str_compare !== $str);
2621
2622 44
        return $str;
2623
    }
2624
2625
    /**
2626
     * Create a escape html version of the string via "UTF8::htmlspecialchars()".
2627
     *
2628
     * @param string $str
2629
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
2630
     *
2631
     * @return string
2632
     */
2633 6
    public static function html_escape(string $str, string $encoding = 'UTF-8'): string
2634
    {
2635 6
        return self::htmlspecialchars(
2636 6
            $str,
2637 6
            \ENT_QUOTES | \ENT_SUBSTITUTE,
2638 6
            $encoding
2639
        );
2640
    }
2641
2642
    /**
2643
     * Remove empty html-tag.
2644
     *
2645
     * e.g.: <tag></tag>
2646
     *
2647
     * @param string $str
2648
     *
2649
     * @return string
2650
     */
2651 1
    public static function html_stripe_empty_tags(string $str): string
2652
    {
2653 1
        return (string) \preg_replace(
2654 1
            "/<[^\/>]*>(([\s]?)*|)<\/[^>]*>/u",
2655 1
            '',
2656 1
            $str
2657
        );
2658
    }
2659
2660
    /**
2661
     * Convert all applicable characters to HTML entities: UTF-8 version of htmlentities()
2662
     *
2663
     * @see http://php.net/manual/en/function.htmlentities.php
2664
     *
2665
     * @param string $str           <p>
2666
     *                              The input string.
2667
     *                              </p>
2668
     * @param int    $flags         [optional] <p>
2669
     *                              A bitmask of one or more of the following flags, which specify how to handle
2670
     *                              quotes, invalid code unit sequences and the used document type. The default is
2671
     *                              ENT_COMPAT | ENT_HTML401.
2672
     *                              <table>
2673
     *                              Available <i>flags</i> constants
2674
     *                              <tr valign="top">
2675
     *                              <td>Constant Name</td>
2676
     *                              <td>Description</td>
2677
     *                              </tr>
2678
     *                              <tr valign="top">
2679
     *                              <td><b>ENT_COMPAT</b></td>
2680
     *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
2681
     *                              </tr>
2682
     *                              <tr valign="top">
2683
     *                              <td><b>ENT_QUOTES</b></td>
2684
     *                              <td>Will convert both double and single quotes.</td>
2685
     *                              </tr>
2686
     *                              <tr valign="top">
2687
     *                              <td><b>ENT_NOQUOTES</b></td>
2688
     *                              <td>Will leave both double and single quotes unconverted.</td>
2689
     *                              </tr>
2690
     *                              <tr valign="top">
2691
     *                              <td><b>ENT_IGNORE</b></td>
2692
     *                              <td>
2693
     *                              Silently discard invalid code unit sequences instead of returning
2694
     *                              an empty string. Using this flag is discouraged as it
2695
     *                              may have security implications.
2696
     *                              </td>
2697
     *                              </tr>
2698
     *                              <tr valign="top">
2699
     *                              <td><b>ENT_SUBSTITUTE</b></td>
2700
     *                              <td>
2701
     *                              Replace invalid code unit sequences with a Unicode Replacement Character
2702
     *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty
2703
     *                              string.
2704
     *                              </td>
2705
     *                              </tr>
2706
     *                              <tr valign="top">
2707
     *                              <td><b>ENT_DISALLOWED</b></td>
2708
     *                              <td>
2709
     *                              Replace invalid code points for the given document type with a
2710
     *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
2711
     *                              (otherwise) instead of leaving them as is. This may be useful, for
2712
     *                              instance, to ensure the well-formedness of XML documents with
2713
     *                              embedded external content.
2714
     *                              </td>
2715
     *                              </tr>
2716
     *                              <tr valign="top">
2717
     *                              <td><b>ENT_HTML401</b></td>
2718
     *                              <td>
2719
     *                              Handle code as HTML 4.01.
2720
     *                              </td>
2721
     *                              </tr>
2722
     *                              <tr valign="top">
2723
     *                              <td><b>ENT_XML1</b></td>
2724
     *                              <td>
2725
     *                              Handle code as XML 1.
2726
     *                              </td>
2727
     *                              </tr>
2728
     *                              <tr valign="top">
2729
     *                              <td><b>ENT_XHTML</b></td>
2730
     *                              <td>
2731
     *                              Handle code as XHTML.
2732
     *                              </td>
2733
     *                              </tr>
2734
     *                              <tr valign="top">
2735
     *                              <td><b>ENT_HTML5</b></td>
2736
     *                              <td>
2737
     *                              Handle code as HTML 5.
2738
     *                              </td>
2739
     *                              </tr>
2740
     *                              </table>
2741
     *                              </p>
2742
     * @param string $encoding      [optional] <p>
2743
     *                              Like <b>htmlspecialchars</b>,
2744
     *                              <b>htmlentities</b> takes an optional third argument
2745
     *                              <i>encoding</i> which defines encoding used in
2746
     *                              conversion.
2747
     *                              Although this argument is technically optional, you are highly
2748
     *                              encouraged to specify the correct value for your code.
2749
     *                              </p>
2750
     * @param bool   $double_encode [optional] <p>
2751
     *                              When <i>double_encode</i> is turned off PHP will not
2752
     *                              encode existing html entities. The default is to convert everything.
2753
     *                              </p>
2754
     *
2755
     * @return string
2756
     *                <p>
2757
     *                The encoded string.
2758
     *                <br><br>
2759
     *                If the input <i>string</i> contains an invalid code unit
2760
     *                sequence within the given <i>encoding</i> an empty string
2761
     *                will be returned, unless either the <b>ENT_IGNORE</b> or
2762
     *                <b>ENT_SUBSTITUTE</b> flags are set.
2763
     *                </p>
2764
     */
2765 9
    public static function htmlentities(
2766
        string $str,
2767
        int $flags = \ENT_COMPAT,
2768
        string $encoding = 'UTF-8',
2769
        bool $double_encode = true
2770
    ): string {
2771 9
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
2772 7
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
2773
        }
2774
2775 9
        $str = \htmlentities($str, $flags, $encoding, $double_encode);
2776
2777
        /**
2778
         * PHP doesn't replace a backslash to its html entity since this is something
2779
         * that's mostly used to escape characters when inserting in a database. Since
2780
         * we're using a decent database layer, we don't need this shit and we're replacing
2781
         * the double backslashes by its' html entity equivalent.
2782
         *
2783
         * https://github.com/forkcms/library/blob/master/spoon/filter/filter.php#L303
2784
         */
2785 9
        $str = \str_replace('\\', '&#92;', $str);
2786
2787 9
        return self::html_encode($str, true, $encoding);
2788
    }
2789
2790
    /**
2791
     * Convert only special characters to HTML entities: UTF-8 version of htmlspecialchars()
2792
     *
2793
     * INFO: Take a look at "UTF8::htmlentities()"
2794
     *
2795
     * @see http://php.net/manual/en/function.htmlspecialchars.php
2796
     *
2797
     * @param string $str           <p>
2798
     *                              The string being converted.
2799
     *                              </p>
2800
     * @param int    $flags         [optional] <p>
2801
     *                              A bitmask of one or more of the following flags, which specify how to handle
2802
     *                              quotes, invalid code unit sequences and the used document type. The default is
2803
     *                              ENT_COMPAT | ENT_HTML401.
2804
     *                              <table>
2805
     *                              Available <i>flags</i> constants
2806
     *                              <tr valign="top">
2807
     *                              <td>Constant Name</td>
2808
     *                              <td>Description</td>
2809
     *                              </tr>
2810
     *                              <tr valign="top">
2811
     *                              <td><b>ENT_COMPAT</b></td>
2812
     *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
2813
     *                              </tr>
2814
     *                              <tr valign="top">
2815
     *                              <td><b>ENT_QUOTES</b></td>
2816
     *                              <td>Will convert both double and single quotes.</td>
2817
     *                              </tr>
2818
     *                              <tr valign="top">
2819
     *                              <td><b>ENT_NOQUOTES</b></td>
2820
     *                              <td>Will leave both double and single quotes unconverted.</td>
2821
     *                              </tr>
2822
     *                              <tr valign="top">
2823
     *                              <td><b>ENT_IGNORE</b></td>
2824
     *                              <td>
2825
     *                              Silently discard invalid code unit sequences instead of returning
2826
     *                              an empty string. Using this flag is discouraged as it
2827
     *                              may have security implications.
2828
     *                              </td>
2829
     *                              </tr>
2830
     *                              <tr valign="top">
2831
     *                              <td><b>ENT_SUBSTITUTE</b></td>
2832
     *                              <td>
2833
     *                              Replace invalid code unit sequences with a Unicode Replacement Character
2834
     *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty
2835
     *                              string.
2836
     *                              </td>
2837
     *                              </tr>
2838
     *                              <tr valign="top">
2839
     *                              <td><b>ENT_DISALLOWED</b></td>
2840
     *                              <td>
2841
     *                              Replace invalid code points for the given document type with a
2842
     *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
2843
     *                              (otherwise) instead of leaving them as is. This may be useful, for
2844
     *                              instance, to ensure the well-formedness of XML documents with
2845
     *                              embedded external content.
2846
     *                              </td>
2847
     *                              </tr>
2848
     *                              <tr valign="top">
2849
     *                              <td><b>ENT_HTML401</b></td>
2850
     *                              <td>
2851
     *                              Handle code as HTML 4.01.
2852
     *                              </td>
2853
     *                              </tr>
2854
     *                              <tr valign="top">
2855
     *                              <td><b>ENT_XML1</b></td>
2856
     *                              <td>
2857
     *                              Handle code as XML 1.
2858
     *                              </td>
2859
     *                              </tr>
2860
     *                              <tr valign="top">
2861
     *                              <td><b>ENT_XHTML</b></td>
2862
     *                              <td>
2863
     *                              Handle code as XHTML.
2864
     *                              </td>
2865
     *                              </tr>
2866
     *                              <tr valign="top">
2867
     *                              <td><b>ENT_HTML5</b></td>
2868
     *                              <td>
2869
     *                              Handle code as HTML 5.
2870
     *                              </td>
2871
     *                              </tr>
2872
     *                              </table>
2873
     *                              </p>
2874
     * @param string $encoding      [optional] <p>
2875
     *                              Defines encoding used in conversion.
2876
     *                              </p>
2877
     *                              <p>
2878
     *                              For the purposes of this function, the encodings
2879
     *                              ISO-8859-1, ISO-8859-15,
2880
     *                              UTF-8, cp866,
2881
     *                              cp1251, cp1252, and
2882
     *                              KOI8-R are effectively equivalent, provided the
2883
     *                              <i>string</i> itself is valid for the encoding, as
2884
     *                              the characters affected by <b>htmlspecialchars</b> occupy
2885
     *                              the same positions in all of these encodings.
2886
     *                              </p>
2887
     * @param bool   $double_encode [optional] <p>
2888
     *                              When <i>double_encode</i> is turned off PHP will not
2889
     *                              encode existing html entities, the default is to convert everything.
2890
     *                              </p>
2891
     *
2892
     * @return string the converted string.
2893
     *                </p>
2894
     *                <p>
2895
     *                If the input <i>string</i> contains an invalid code unit
2896
     *                sequence within the given <i>encoding</i> an empty string
2897
     *                will be returned, unless either the <b>ENT_IGNORE</b> or
2898
     *                <b>ENT_SUBSTITUTE</b> flags are set
2899
     */
2900 8
    public static function htmlspecialchars(
2901
        string $str,
2902
        int $flags = \ENT_COMPAT,
2903
        string $encoding = 'UTF-8',
2904
        bool $double_encode = true
2905
    ): string {
2906 8
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
2907 8
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
2908
        }
2909
2910 8
        return \htmlspecialchars($str, $flags, $encoding, $double_encode);
2911
    }
2912
2913
    /**
2914
     * Checks whether iconv is available on the server.
2915
     *
2916
     * @return bool
2917
     *              <strong>true</strong> if available, <strong>false</strong> otherwise
2918
     */
2919
    public static function iconv_loaded(): bool
2920
    {
2921
        return \extension_loaded('iconv');
2922
    }
2923
2924
    /**
2925
     * alias for "UTF8::decimal_to_chr()"
2926
     *
2927
     * @param mixed $int
2928
     *
2929
     * @return string
2930
     *
2931
     * @see UTF8::decimal_to_chr()
2932
     */
2933 4
    public static function int_to_chr($int): string
2934
    {
2935 4
        return self::decimal_to_chr($int);
2936
    }
2937
2938
    /**
2939
     * Converts Integer to hexadecimal U+xxxx code point representation.
2940
     *
2941
     * INFO: opposite to UTF8::hex_to_int()
2942
     *
2943
     * @param int    $int  <p>The integer to be converted to hexadecimal code point.</p>
2944
     * @param string $pfix [optional]
2945
     *
2946
     * @return string the code point, or empty string on failure
2947
     */
2948 6
    public static function int_to_hex(int $int, string $pfix = 'U+'): string
2949
    {
2950 6
        $hex = \dechex($int);
2951
2952 6
        $hex = (\strlen($hex) < 4 ? \substr('0000' . $hex, -4) : $hex);
2953
2954 6
        return $pfix . $hex . '';
2955
    }
2956
2957
    /**
2958
     * Checks whether intl-char is available on the server.
2959
     *
2960
     * @return bool
2961
     *              <strong>true</strong> if available, <strong>false</strong> otherwise
2962
     */
2963
    public static function intlChar_loaded(): bool
2964
    {
2965
        return \class_exists('IntlChar');
2966
    }
2967
2968
    /**
2969
     * Checks whether intl is available on the server.
2970
     *
2971
     * @return bool
2972
     *              <strong>true</strong> if available, <strong>false</strong> otherwise
2973
     */
2974 5
    public static function intl_loaded(): bool
2975
    {
2976 5
        return \extension_loaded('intl');
2977
    }
2978
2979
    /**
2980
     * alias for "UTF8::is_ascii()"
2981
     *
2982
     * @param string $str
2983
     *
2984
     * @return bool
2985
     *
2986
     * @see UTF8::is_ascii()
2987
     * @deprecated <p>use "UTF8::is_ascii()"</p>
2988
     */
2989 2
    public static function isAscii(string $str): bool
2990
    {
2991 2
        return self::is_ascii($str);
2992
    }
2993
2994
    /**
2995
     * alias for "UTF8::is_base64()"
2996
     *
2997
     * @param string $str
2998
     *
2999
     * @return bool
3000
     *
3001
     * @see UTF8::is_base64()
3002
     * @deprecated <p>use "UTF8::is_base64()"</p>
3003
     */
3004 2
    public static function isBase64($str): bool
3005
    {
3006 2
        return self::is_base64($str);
3007
    }
3008
3009
    /**
3010
     * alias for "UTF8::is_binary()"
3011
     *
3012
     * @param mixed $str
3013
     * @param bool  $strict
3014
     *
3015
     * @return bool
3016
     *
3017
     * @see UTF8::is_binary()
3018
     * @deprecated <p>use "UTF8::is_binary()"</p>
3019
     */
3020 4
    public static function isBinary($str, $strict = false): bool
3021
    {
3022 4
        return self::is_binary($str, $strict);
3023
    }
3024
3025
    /**
3026
     * alias for "UTF8::is_bom()"
3027
     *
3028
     * @param string $utf8_chr
3029
     *
3030
     * @return bool
3031
     *
3032
     * @see UTF8::is_bom()
3033
     * @deprecated <p>use "UTF8::is_bom()"</p>
3034
     */
3035 2
    public static function isBom(string $utf8_chr): bool
3036
    {
3037 2
        return self::is_bom($utf8_chr);
3038
    }
3039
3040
    /**
3041
     * alias for "UTF8::is_html()"
3042
     *
3043
     * @param string $str
3044
     *
3045
     * @return bool
3046
     *
3047
     * @see UTF8::is_html()
3048
     * @deprecated <p>use "UTF8::is_html()"</p>
3049
     */
3050 2
    public static function isHtml(string $str): bool
3051
    {
3052 2
        return self::is_html($str);
3053
    }
3054
3055
    /**
3056
     * alias for "UTF8::is_json()"
3057
     *
3058
     * @param string $str
3059
     *
3060
     * @return bool
3061
     *
3062
     * @see UTF8::is_json()
3063
     * @deprecated <p>use "UTF8::is_json()"</p>
3064
     */
3065
    public static function isJson(string $str): bool
3066
    {
3067
        return self::is_json($str);
3068
    }
3069
3070
    /**
3071
     * alias for "UTF8::is_utf16()"
3072
     *
3073
     * @param mixed $str
3074
     *
3075
     * @return false|int
3076
     *                   <strong>false</strong> if is't not UTF16,<br>
3077
     *                   <strong>1</strong> for UTF-16LE,<br>
3078
     *                   <strong>2</strong> for UTF-16BE
3079
     *
3080
     * @see UTF8::is_utf16()
3081
     * @deprecated <p>use "UTF8::is_utf16()"</p>
3082
     */
3083 2
    public static function isUtf16($str)
3084
    {
3085 2
        return self::is_utf16($str);
3086
    }
3087
3088
    /**
3089
     * alias for "UTF8::is_utf32()"
3090
     *
3091
     * @param mixed $str
3092
     *
3093
     * @return false|int
3094
     *                   <strong>false</strong> if is't not UTF16,
3095
     *                   <strong>1</strong> for UTF-32LE,
3096
     *                   <strong>2</strong> for UTF-32BE
3097
     *
3098
     * @see UTF8::is_utf32()
3099
     * @deprecated <p>use "UTF8::is_utf32()"</p>
3100
     */
3101 2
    public static function isUtf32($str)
3102
    {
3103 2
        return self::is_utf32($str);
3104
    }
3105
3106
    /**
3107
     * alias for "UTF8::is_utf8()"
3108
     *
3109
     * @param string $str
3110
     * @param bool   $strict
3111
     *
3112
     * @return bool
3113
     *
3114
     * @see UTF8::is_utf8()
3115
     * @deprecated <p>use "UTF8::is_utf8()"</p>
3116
     */
3117 17
    public static function isUtf8($str, $strict = false): bool
3118
    {
3119 17
        return self::is_utf8($str, $strict);
3120
    }
3121
3122
    /**
3123
     * Returns true if the string contains only alphabetic chars, false otherwise.
3124
     *
3125
     * @param string $str
3126
     *
3127
     * @return bool
3128
     *              Whether or not $str contains only alphabetic chars
3129
     */
3130 10
    public static function is_alpha(string $str): bool
3131
    {
3132 10
        if (self::$SUPPORT['mbstring'] === true) {
3133
            /** @noinspection PhpComposerExtensionStubsInspection */
3134 10
            return \mb_ereg_match('^[[:alpha:]]*$', $str);
3135
        }
3136
3137
        return self::str_matches_pattern($str, '^[[:alpha:]]*$');
3138
    }
3139
3140
    /**
3141
     * Returns true if the string contains only alphabetic and numeric chars, false otherwise.
3142
     *
3143
     * @param string $str
3144
     *
3145
     * @return bool
3146
     *              Whether or not $str contains only alphanumeric chars
3147
     */
3148 13
    public static function is_alphanumeric(string $str): bool
3149
    {
3150 13
        if (self::$SUPPORT['mbstring'] === true) {
3151
            /** @noinspection PhpComposerExtensionStubsInspection */
3152 13
            return \mb_ereg_match('^[[:alnum:]]*$', $str);
3153
        }
3154
3155
        return self::str_matches_pattern($str, '^[[:alnum:]]*$');
3156
    }
3157
3158
    /**
3159
     * Checks if a string is 7 bit ASCII.
3160
     *
3161
     * @param string $str <p>The string to check.</p>
3162
     *
3163
     * @return bool
3164
     *              <strong>true</strong> if it is ASCII<br>
3165
     *              <strong>false</strong> otherwise
3166
     */
3167 137
    public static function is_ascii(string $str): bool
3168
    {
3169 137
        if ($str === '') {
3170 10
            return true;
3171
        }
3172
3173 136
        return !\preg_match('/[^\x09\x10\x13\x0A\x0D\x20-\x7E]/', $str);
3174
    }
3175
3176
    /**
3177
     * Returns true if the string is base64 encoded, false otherwise.
3178
     *
3179
     * @param mixed|string $str                <p>The input string.</p>
3180
     * @param bool         $emptyStringIsValid [optional] <p>Is an empty string valid base64 or not?</p>
3181
     *
3182
     * @return bool whether or not $str is base64 encoded
3183
     */
3184 16
    public static function is_base64($str, $emptyStringIsValid = false): bool
3185
    {
3186 16
        if ($emptyStringIsValid === false && $str === '') {
3187 3
            return false;
3188
        }
3189
3190
        /**
3191
         * @psalm-suppress RedundantConditionGivenDocblockType
3192
         */
3193 15
        if (\is_string($str) === false) {
3194 2
            return false;
3195
        }
3196
3197 15
        $base64String = \base64_decode($str, true);
3198
3199 15
        return $base64String !== false && \base64_encode($base64String) === $str;
3200
    }
3201
3202
    /**
3203
     * Check if the input is binary... (is look like a hack).
3204
     *
3205
     * @param mixed $input
3206
     * @param bool  $strict
3207
     *
3208
     * @return bool
3209
     */
3210 39
    public static function is_binary($input, bool $strict = false): bool
3211
    {
3212 39
        $input = (string) $input;
3213 39
        if ($input === '') {
3214 10
            return false;
3215
        }
3216
3217 39
        if (\preg_match('~^[01]+$~', $input)) {
3218 13
            return true;
3219
        }
3220
3221 39
        $ext = self::get_file_type($input);
3222 39
        if ($ext['type'] === 'binary') {
3223 7
            return true;
3224
        }
3225
3226 36
        $testLength = \strlen($input);
3227 36
        $testNull = \substr_count($input, "\x0", 0, $testLength);
3228 36
        if (($testNull / $testLength) > 0.25) {
3229 12
            return true;
3230
        }
3231
3232 34
        if ($strict === true) {
3233 34
            if (self::$SUPPORT['finfo'] === false) {
3234
                throw new \RuntimeException('ext-fileinfo: is not installed');
3235
            }
3236
3237
            /** @noinspection PhpComposerExtensionStubsInspection */
3238 34
            $finfo_encoding = (new \finfo(\FILEINFO_MIME_ENCODING))->buffer($input);
3239 34
            if ($finfo_encoding && $finfo_encoding === 'binary') {
3240 15
                return true;
3241
            }
3242
        }
3243
3244 30
        return false;
3245
    }
3246
3247
    /**
3248
     * Check if the file is binary.
3249
     *
3250
     * @param string $file
3251
     *
3252
     * @return bool
3253
     */
3254 6
    public static function is_binary_file($file): bool
3255
    {
3256
        // init
3257 6
        $block = '';
3258
3259 6
        $fp = \fopen($file, 'rb');
3260 6
        if (\is_resource($fp)) {
3261 6
            $block = \fread($fp, 512);
3262 6
            \fclose($fp);
3263
        }
3264
3265 6
        if ($block === '') {
3266 2
            return false;
3267
        }
3268
3269 6
        return self::is_binary($block, true);
3270
    }
3271
3272
    /**
3273
     * Returns true if the string contains only whitespace chars, false otherwise.
3274
     *
3275
     * @param string $str
3276
     *
3277
     * @return bool
3278
     *              Whether or not $str contains only whitespace characters
3279
     */
3280 15
    public static function is_blank(string $str): bool
3281
    {
3282 15
        if (self::$SUPPORT['mbstring'] === true) {
3283
            /** @noinspection PhpComposerExtensionStubsInspection */
3284 15
            return \mb_ereg_match('^[[:space:]]*$', $str);
3285
        }
3286
3287
        return self::str_matches_pattern($str, '^[[:space:]]*$');
3288
    }
3289
3290
    /**
3291
     * Checks if the given string is equal to any "Byte Order Mark".
3292
     *
3293
     * WARNING: Use "UTF8::string_has_bom()" if you will check BOM in a string.
3294
     *
3295
     * @param string $str <p>The input string.</p>
3296
     *
3297
     * @return bool
3298
     *              <strong>true</strong> if the $utf8_chr is Byte Order Mark, <strong>false</strong> otherwise
3299
     */
3300 2
    public static function is_bom($str): bool
3301
    {
3302
        /** @noinspection PhpUnusedLocalVariableInspection */
3303 2
        foreach (self::$BOM as $bomString => &$bomByteLength) {
3304 2
            if ($str === $bomString) {
3305 2
                return true;
3306
            }
3307
        }
3308
3309 2
        return false;
3310
    }
3311
3312
    /**
3313
     * Determine whether the string is considered to be empty.
3314
     *
3315
     * A variable is considered empty if it does not exist or if its value equals FALSE.
3316
     * empty() does not generate a warning if the variable does not exist.
3317
     *
3318
     * @param mixed $str
3319
     *
3320
     * @return bool whether or not $str is empty()
3321
     */
3322
    public static function is_empty($str): bool
3323
    {
3324
        return empty($str);
3325
    }
3326
3327
    /**
3328
     * Returns true if the string contains only hexadecimal chars, false otherwise.
3329
     *
3330
     * @param string $str
3331
     *
3332
     * @return bool
3333
     *              Whether or not $str contains only hexadecimal chars
3334
     */
3335 13
    public static function is_hexadecimal(string $str): bool
3336
    {
3337 13
        if (self::$SUPPORT['mbstring'] === true) {
3338
            /** @noinspection PhpComposerExtensionStubsInspection */
3339 13
            return \mb_ereg_match('^[[:xdigit:]]*$', $str);
3340
        }
3341
3342
        return self::str_matches_pattern($str, '^[[:xdigit:]]*$');
3343
    }
3344
3345
    /**
3346
     * Check if the string contains any html-tags <lall>.
3347
     *
3348
     * @param string $str <p>The input string.</p>
3349
     *
3350
     * @return bool
3351
     */
3352 3
    public static function is_html(string $str): bool
3353
    {
3354 3
        if ($str === '') {
3355 3
            return false;
3356
        }
3357
3358
        // init
3359 3
        $matches = [];
3360
3361 3
        \preg_match("/<\/?\w+(?:(?:\s+\w+(?:\s*=\s*(?:\".*?\"|'.*?'|[^'\">\s]+))?)*+\s*|\s*)\/?>/u", $str, $matches);
3362
3363 3
        return \count($matches) !== 0;
3364
    }
3365
3366
    /**
3367
     * Try to check if "$str" is an json-string.
3368
     *
3369
     * @param string $str                              <p>The input string.</p>
3370
     * @param bool   $onlyArrayOrObjectResultsAreValid [optional] <p>Only array and objects are valid json results.</p>
3371
     *
3372
     * @return bool
3373
     */
3374 42
    public static function is_json(string $str, $onlyArrayOrObjectResultsAreValid = true): bool
3375
    {
3376 42
        if ($str === '') {
3377 4
            return false;
3378
        }
3379
3380 40
        if (self::$SUPPORT['json'] === false) {
3381
            throw new \RuntimeException('ext-json: is not installed');
3382
        }
3383
3384 40
        $json = self::json_decode($str);
3385 40
        if ($json === null && \strtoupper($str) !== 'NULL') {
3386 18
            return false;
3387
        }
3388
3389
        if (
3390 24
            $onlyArrayOrObjectResultsAreValid === true
3391
            &&
3392 24
            \is_object($json) === false
3393
            &&
3394 24
            \is_array($json) === false
3395
        ) {
3396 5
            return false;
3397
        }
3398
3399
        /** @noinspection PhpComposerExtensionStubsInspection */
3400 19
        return \json_last_error() === \JSON_ERROR_NONE;
3401
    }
3402
3403
    /**
3404
     * @param string $str
3405
     *
3406
     * @return bool
3407
     */
3408 8
    public static function is_lowercase(string $str): bool
3409
    {
3410 8
        if (self::$SUPPORT['mbstring'] === true) {
3411
            /** @noinspection PhpComposerExtensionStubsInspection */
3412 8
            return \mb_ereg_match('^[[:lower:]]*$', $str);
3413
        }
3414
3415
        return self::str_matches_pattern($str, '^[[:lower:]]*$');
3416
    }
3417
3418
    /**
3419
     * Returns true if the string is serialized, false otherwise.
3420
     *
3421
     * @param string $str
3422
     *
3423
     * @return bool whether or not $str is serialized
3424
     */
3425 7
    public static function is_serialized(string $str): bool
3426
    {
3427 7
        if ($str === '') {
3428 1
            return false;
3429
        }
3430
3431
        /** @noinspection PhpUsageOfSilenceOperatorInspection */
3432
        /** @noinspection UnserializeExploitsInspection */
3433 6
        return $str === 'b:0;'
3434
               ||
3435 6
               @\unserialize($str) !== false;
3436
    }
3437
3438
    /**
3439
     * Returns true if the string contains only lower case chars, false
3440
     * otherwise.
3441
     *
3442
     * @param string $str <p>The input string.</p>
3443
     *
3444
     * @return bool
3445
     *              Whether or not $str contains only lower case characters
3446
     */
3447 8
    public static function is_uppercase(string $str): bool
3448
    {
3449 8
        if (self::$SUPPORT['mbstring'] === true) {
3450
            /** @noinspection PhpComposerExtensionStubsInspection */
3451 8
            return \mb_ereg_match('^[[:upper:]]*$', $str);
3452
        }
3453
3454
        return self::str_matches_pattern($str, '^[[:upper:]]*$');
3455
    }
3456
3457
    /**
3458
     * Check if the string is UTF-16.
3459
     *
3460
     * @param mixed $str                   <p>The input string.</p>
3461
     * @param bool  $checkIfStringIsBinary
3462
     *
3463
     * @return false|int
3464
     *                   <strong>false</strong> if is't not UTF-16,<br>
3465
     *                   <strong>1</strong> for UTF-16LE,<br>
3466
     *                   <strong>2</strong> for UTF-16BE
3467
     */
3468 22
    public static function is_utf16($str, $checkIfStringIsBinary = true)
3469
    {
3470
        // init
3471 22
        $str = (string) $str;
3472 22
        $strChars = [];
3473
3474
        if (
3475 22
            $checkIfStringIsBinary === true
3476
            &&
3477 22
            self::is_binary($str, true) === false
3478
        ) {
3479 2
            return false;
3480
        }
3481
3482 22
        if (self::$SUPPORT['mbstring'] === false) {
3483 3
            \trigger_error('UTF8::is_utf16() without mbstring may did not work correctly', \E_USER_WARNING);
3484
        }
3485
3486 22
        $str = self::remove_bom($str);
3487
3488 22
        $maybeUTF16LE = 0;
3489 22
        $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16LE');
3490 22
        if ($test) {
3491 15
            $test2 = \mb_convert_encoding($test, 'UTF-16LE', 'UTF-8');
3492 15
            $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16LE');
3493 15
            if ($test3 === $test) {
3494 15
                if (\count($strChars) === 0) {
3495 15
                    $strChars = self::count_chars($str, true, false);
3496
                }
3497 15
                foreach (self::count_chars($test3) as $test3char => &$test3charEmpty) {
0 ignored issues
show
Bug introduced by
The expression self::count_chars($test3) cannot be used as a reference.

Let?s assume that you have the following foreach statement:

foreach ($array as &$itemValue) { }

$itemValue is assigned by reference. This is possible because the expression (in the example $array) can be used as a reference target.

However, if we were to replace $array with something different like the result of a function call as in

foreach (getArray() as &$itemValue) { }

then assigning by reference is not possible anymore as there is no target that could be modified.

Available Fixes

1. Do not assign by reference
foreach (getArray() as $itemValue) { }
2. Assign to a local variable first
$array = getArray();
foreach ($array as &$itemValue) {}
3. Return a reference
function &getArray() { $array = array(); return $array; }

foreach (getArray() as &$itemValue) { }
Loading history...
3498 15
                    if (\in_array($test3char, $strChars, true) === true) {
3499 15
                        ++$maybeUTF16LE;
3500
                    }
3501
                }
3502 15
                unset($test3charEmpty);
3503
            }
3504
        }
3505
3506 22
        $maybeUTF16BE = 0;
3507 22
        $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16BE');
3508 22
        if ($test) {
3509 15
            $test2 = \mb_convert_encoding($test, 'UTF-16BE', 'UTF-8');
3510 15
            $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16BE');
3511 15
            if ($test3 === $test) {
3512 15
                if (\count($strChars) === 0) {
3513 7
                    $strChars = self::count_chars($str, true, false);
3514
                }
3515 15
                foreach (self::count_chars($test3) as $test3char => &$test3charEmpty) {
0 ignored issues
show
Bug introduced by
The expression self::count_chars($test3) cannot be used as a reference.

Let?s assume that you have the following foreach statement:

foreach ($array as &$itemValue) { }

$itemValue is assigned by reference. This is possible because the expression (in the example $array) can be used as a reference target.

However, if we were to replace $array with something different like the result of a function call as in

foreach (getArray() as &$itemValue) { }

then assigning by reference is not possible anymore as there is no target that could be modified.

Available Fixes

1. Do not assign by reference
foreach (getArray() as $itemValue) { }
2. Assign to a local variable first
$array = getArray();
foreach ($array as &$itemValue) {}
3. Return a reference
function &getArray() { $array = array(); return $array; }

foreach (getArray() as &$itemValue) { }
Loading history...
3516 15
                    if (\in_array($test3char, $strChars, true) === true) {
3517 15
                        ++$maybeUTF16BE;
3518
                    }
3519
                }
3520 15
                unset($test3charEmpty);
3521
            }
3522
        }
3523
3524 22
        if ($maybeUTF16BE !== $maybeUTF16LE) {
3525 6
            if ($maybeUTF16LE > $maybeUTF16BE) {
3526 4
                return 1;
3527
            }
3528
3529 6
            return 2;
3530
        }
3531
3532 18
        return false;
3533
    }
3534
3535
    /**
3536
     * Check if the string is UTF-32.
3537
     *
3538
     * @param mixed $str                   <p>The input string.</p>
3539
     * @param bool  $checkIfStringIsBinary
3540
     *
3541
     * @return false|int
3542
     *                   <strong>false</strong> if is't not UTF-32,<br>
3543
     *                   <strong>1</strong> for UTF-32LE,<br>
3544
     *                   <strong>2</strong> for UTF-32BE
3545
     */
3546 18
    public static function is_utf32($str, $checkIfStringIsBinary = true)
3547
    {
3548
        // init
3549 18
        $str = (string) $str;
3550 18
        $strChars = [];
3551
3552
        if (
3553 18
            $checkIfStringIsBinary === true
3554
            &&
3555 18
            self::is_binary($str, true) === false
3556
        ) {
3557 2
            return false;
3558
        }
3559
3560 18
        if (self::$SUPPORT['mbstring'] === false) {
3561 3
            \trigger_error('UTF8::is_utf32() without mbstring may did not work correctly', \E_USER_WARNING);
3562
        }
3563
3564 18
        $str = self::remove_bom($str);
3565
3566 18
        $maybeUTF32LE = 0;
3567 18
        $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32LE');
3568 18
        if ($test) {
3569 11
            $test2 = \mb_convert_encoding($test, 'UTF-32LE', 'UTF-8');
3570 11
            $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32LE');
3571 11
            if ($test3 === $test) {
3572 11
                if (\count($strChars) === 0) {
3573 11
                    $strChars = self::count_chars($str, true, false);
3574
                }
3575 11
                foreach (self::count_chars($test3) as $test3char => &$test3charEmpty) {
0 ignored issues
show
Bug introduced by
The expression self::count_chars($test3) cannot be used as a reference.

Let?s assume that you have the following foreach statement:

foreach ($array as &$itemValue) { }

$itemValue is assigned by reference. This is possible because the expression (in the example $array) can be used as a reference target.

However, if we were to replace $array with something different like the result of a function call as in

foreach (getArray() as &$itemValue) { }

then assigning by reference is not possible anymore as there is no target that could be modified.

Available Fixes

1. Do not assign by reference
foreach (getArray() as $itemValue) { }
2. Assign to a local variable first
$array = getArray();
foreach ($array as &$itemValue) {}
3. Return a reference
function &getArray() { $array = array(); return $array; }

foreach (getArray() as &$itemValue) { }
Loading history...
3576 11
                    if (\in_array($test3char, $strChars, true) === true) {
3577 11
                        ++$maybeUTF32LE;
3578
                    }
3579
                }
3580 11
                unset($test3charEmpty);
3581
            }
3582
        }
3583
3584 18
        $maybeUTF32BE = 0;
3585 18
        $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32BE');
3586 18
        if ($test) {
3587 11
            $test2 = \mb_convert_encoding($test, 'UTF-32BE', 'UTF-8');
3588 11
            $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32BE');
3589 11
            if ($test3 === $test) {
3590 11
                if (\count($strChars) === 0) {
3591 7
                    $strChars = self::count_chars($str, true, false);
3592
                }
3593 11
                foreach (self::count_chars($test3) as $test3char => &$test3charEmpty) {
0 ignored issues
show
Bug introduced by
The expression self::count_chars($test3) cannot be used as a reference.

Let?s assume that you have the following foreach statement:

foreach ($array as &$itemValue) { }

$itemValue is assigned by reference. This is possible because the expression (in the example $array) can be used as a reference target.

However, if we were to replace $array with something different like the result of a function call as in

foreach (getArray() as &$itemValue) { }

then assigning by reference is not possible anymore as there is no target that could be modified.

Available Fixes

1. Do not assign by reference
foreach (getArray() as $itemValue) { }
2. Assign to a local variable first
$array = getArray();
foreach ($array as &$itemValue) {}
3. Return a reference
function &getArray() { $array = array(); return $array; }

foreach (getArray() as &$itemValue) { }
Loading history...
3594 11
                    if (\in_array($test3char, $strChars, true) === true) {
3595 11
                        ++$maybeUTF32BE;
3596
                    }
3597
                }
3598 11
                unset($test3charEmpty);
3599
            }
3600
        }
3601
3602 18
        if ($maybeUTF32BE !== $maybeUTF32LE) {
3603 2
            if ($maybeUTF32LE > $maybeUTF32BE) {
3604 2
                return 1;
3605
            }
3606
3607 2
            return 2;
3608
        }
3609
3610 18
        return false;
3611
    }
3612
3613
    /**
3614
     * Checks whether the passed string contains only byte sequences that appear valid UTF-8 characters.
3615
     *
3616
     * @see http://hsivonen.iki.fi/php-utf8/
3617
     *
3618
     * @param string|string[] $str    <p>The string to be checked.</p>
3619
     * @param bool            $strict <p>Check also if the string is not UTF-16 or UTF-32.</p>
3620
     *
3621
     * @return bool
3622
     */
3623 106
    public static function is_utf8($str, bool $strict = false): bool
3624
    {
3625 106
        if (\is_array($str) === true) {
3626 2
            foreach ($str as &$v) {
3627 2
                if (self::is_utf8($v, $strict) === false) {
3628 2
                    return false;
3629
                }
3630
            }
3631
3632
            return true;
3633
        }
3634
3635 106
        if ($str === '') {
3636 12
            return true;
3637
        }
3638
3639 102
        if ($strict === true) {
3640 2
            $isBinary = self::is_binary($str, true);
3641
3642 2
            if ($isBinary && self::is_utf16($str, false) !== false) {
3643 2
                return false;
3644
            }
3645
3646
            if ($isBinary && self::is_utf32($str, false) !== false) {
3647
                return false;
3648
            }
3649
        }
3650
3651 102
        if (self::pcre_utf8_support() !== true) {
3652
3653
            // If even just the first character can be matched, when the /u
3654
            // modifier is used, then it's valid UTF-8. If the UTF-8 is somehow
3655
            // invalid, nothing at all will match, even if the string contains
3656
            // some valid sequences
3657
            return \preg_match('/^.{1}/us', $str, $ar) === 1;
3658
        }
3659
3660 102
        $mState = 0; // cached expected number of octets after the current octet
3661
        // until the beginning of the next UTF8 character sequence
3662 102
        $mUcs4 = 0; // cached Unicode character
3663 102
        $mBytes = 1; // cached expected number of octets in the current sequence
3664
3665 102
        if (self::$ORD === null) {
3666
            self::$ORD = self::getData('ord');
3667
        }
3668
3669 102
        $len = \strlen((string) $str);
3670
        /** @noinspection ForeachInvariantsInspection */
3671 102
        for ($i = 0; $i < $len; ++$i) {
3672 102
            $in = self::$ORD[$str[$i]];
3673 102
            if ($mState === 0) {
3674
                // When mState is zero we expect either a US-ASCII character or a
3675
                // multi-octet sequence.
3676 102
                if ((0x80 & $in) === 0) {
3677
                    // US-ASCII, pass straight through.
3678 97
                    $mBytes = 1;
3679 83
                } elseif ((0xE0 & $in) === 0xC0) {
3680
                    // First octet of 2 octet sequence.
3681 73
                    $mUcs4 = $in;
3682 73
                    $mUcs4 = ($mUcs4 & 0x1F) << 6;
3683 73
                    $mState = 1;
3684 73
                    $mBytes = 2;
3685 58
                } elseif ((0xF0 & $in) === 0xE0) {
3686
                    // First octet of 3 octet sequence.
3687 42
                    $mUcs4 = $in;
3688 42
                    $mUcs4 = ($mUcs4 & 0x0F) << 12;
3689 42
                    $mState = 2;
3690 42
                    $mBytes = 3;
3691 29
                } elseif ((0xF8 & $in) === 0xF0) {
3692
                    // First octet of 4 octet sequence.
3693 18
                    $mUcs4 = $in;
3694 18
                    $mUcs4 = ($mUcs4 & 0x07) << 18;
3695 18
                    $mState = 3;
3696 18
                    $mBytes = 4;
3697 13
                } elseif ((0xFC & $in) === 0xF8) {
3698
                    /* First octet of 5 octet sequence.
3699
                     *
3700
                     * This is illegal because the encoded codepoint must be either
3701
                     * (a) not the shortest form or
3702
                     * (b) outside the Unicode range of 0-0x10FFFF.
3703
                     * Rather than trying to resynchronize, we will carry on until the end
3704
                     * of the sequence and let the later error handling code catch it.
3705
                     */
3706 5
                    $mUcs4 = $in;
3707 5
                    $mUcs4 = ($mUcs4 & 0x03) << 24;
3708 5
                    $mState = 4;
3709 5
                    $mBytes = 5;
3710 10
                } elseif ((0xFE & $in) === 0xFC) {
3711
                    // First octet of 6 octet sequence, see comments for 5 octet sequence.
3712 5
                    $mUcs4 = $in;
3713 5
                    $mUcs4 = ($mUcs4 & 1) << 30;
3714 5
                    $mState = 5;
3715 5
                    $mBytes = 6;
3716
                } else {
3717
                    // Current octet is neither in the US-ASCII range nor a legal first
3718
                    // octet of a multi-octet sequence.
3719 102
                    return false;
3720
                }
3721 83
            } elseif ((0xC0 & $in) === 0x80) {
3722
3723
                // When mState is non-zero, we expect a continuation of the multi-octet
3724
                // sequence
3725
3726
                // Legal continuation.
3727 75
                $shift = ($mState - 1) * 6;
3728 75
                $tmp = $in;
3729 75
                $tmp = ($tmp & 0x0000003F) << $shift;
3730 75
                $mUcs4 |= $tmp;
3731
                // Prefix: End of the multi-octet sequence. mUcs4 now contains the final
3732
                // Unicode code point to be output.
3733 75
                if (--$mState === 0) {
3734
                    // Check for illegal sequences and code points.
3735
                    //
3736
                    // From Unicode 3.1, non-shortest form is illegal
3737
                    if (
3738 75
                        ($mBytes === 2 && $mUcs4 < 0x0080)
3739
                        ||
3740 75
                        ($mBytes === 3 && $mUcs4 < 0x0800)
3741
                        ||
3742 75
                        ($mBytes === 4 && $mUcs4 < 0x10000)
3743
                        ||
3744 75
                        ($mBytes > 4)
3745
                        ||
3746
                        // From Unicode 3.2, surrogate characters are illegal.
3747 75
                        (($mUcs4 & 0xFFFFF800) === 0xD800)
3748
                        ||
3749
                        // Code points outside the Unicode range are illegal.
3750 75
                        ($mUcs4 > 0x10FFFF)
3751
                    ) {
3752 8
                        return false;
3753
                    }
3754
                    // initialize UTF8 cache
3755 75
                    $mState = 0;
3756 75
                    $mUcs4 = 0;
3757 75
                    $mBytes = 1;
3758
                }
3759
            } else {
3760
                // ((0xC0 & (*in) != 0x80) && (mState != 0))
3761
                // Incomplete multi-octet sequence.
3762 35
                return false;
3763
            }
3764
        }
3765
3766 67
        return true;
3767
    }
3768
3769
    /**
3770
     * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
3771
     * Decodes a JSON string
3772
     *
3773
     * @see http://php.net/manual/en/function.json-decode.php
3774
     *
3775
     * @param string $json    <p>
3776
     *                        The <i>json</i> string being decoded.
3777
     *                        </p>
3778
     *                        <p>
3779
     *                        This function only works with UTF-8 encoded strings.
3780
     *                        </p>
3781
     *                        <p>PHP implements a superset of
3782
     *                        JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
3783
     *                        only supports these values when they are nested inside an array or an object.
3784
     *                        </p>
3785
     * @param bool   $assoc   [optional] <p>
3786
     *                        When <b>TRUE</b>, returned objects will be converted into
3787
     *                        associative arrays.
3788
     *                        </p>
3789
     * @param int    $depth   [optional] <p>
3790
     *                        User specified recursion depth.
3791
     *                        </p>
3792
     * @param int    $options [optional] <p>
3793
     *                        Bitmask of JSON decode options. Currently only
3794
     *                        <b>JSON_BIGINT_AS_STRING</b>
3795
     *                        is supported (default is to cast large integers as floats)
3796
     *                        </p>
3797
     *
3798
     * @return mixed
3799
     *               The value encoded in <i>json</i> in appropriate PHP type. Values true, false and
3800
     *               null (case-insensitive) are returned as <b>TRUE</b>, <b>FALSE</b> and <b>NULL</b> respectively.
3801
     *               <b>NULL</b> is returned if the <i>json</i> cannot be decoded or if the encoded data
3802
     *               is deeper than the recursion limit.
3803
     */
3804 43
    public static function json_decode(
3805
        string $json,
3806
        bool $assoc = false,
3807
        int $depth = 512,
3808
        int $options = 0
3809
    ) {
3810 43
        $json = self::filter($json);
3811
3812 43
        if (self::$SUPPORT['json'] === false) {
3813
            throw new \RuntimeException('ext-json: is not installed');
3814
        }
3815
3816
        /** @noinspection PhpComposerExtensionStubsInspection */
3817 43
        return \json_decode($json, $assoc, $depth, $options);
3818
    }
3819
3820
    /**
3821
     * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
3822
     * Returns the JSON representation of a value.
3823
     *
3824
     * @see http://php.net/manual/en/function.json-encode.php
3825
     *
3826
     * @param mixed $value   <p>
3827
     *                       The <i>value</i> being encoded. Can be any type except
3828
     *                       a resource.
3829
     *                       </p>
3830
     *                       <p>
3831
     *                       All string data must be UTF-8 encoded.
3832
     *                       </p>
3833
     *                       <p>PHP implements a superset of
3834
     *                       JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
3835
     *                       only supports these values when they are nested inside an array or an object.
3836
     *                       </p>
3837
     * @param int   $options [optional] <p>
3838
     *                       Bitmask consisting of <b>JSON_HEX_QUOT</b>,
3839
     *                       <b>JSON_HEX_TAG</b>,
3840
     *                       <b>JSON_HEX_AMP</b>,
3841
     *                       <b>JSON_HEX_APOS</b>,
3842
     *                       <b>JSON_NUMERIC_CHECK</b>,
3843
     *                       <b>JSON_PRETTY_PRINT</b>,
3844
     *                       <b>JSON_UNESCAPED_SLASHES</b>,
3845
     *                       <b>JSON_FORCE_OBJECT</b>,
3846
     *                       <b>JSON_UNESCAPED_UNICODE</b>. The behaviour of these
3847
     *                       constants is described on
3848
     *                       the JSON constants page.
3849
     *                       </p>
3850
     * @param int   $depth   [optional] <p>
3851
     *                       Set the maximum depth. Must be greater than zero.
3852
     *                       </p>
3853
     *
3854
     * @return false|string
3855
     *                      A JSON encoded <strong>string</strong> on success or<br>
3856
     *                      <strong>FALSE</strong> on failure
3857
     */
3858 5
    public static function json_encode($value, int $options = 0, int $depth = 512)
3859
    {
3860 5
        $value = self::filter($value);
3861
3862 5
        if (self::$SUPPORT['json'] === false) {
3863
            throw new \RuntimeException('ext-json: is not installed');
3864
        }
3865
3866
        /** @noinspection PhpComposerExtensionStubsInspection */
3867 5
        return \json_encode($value, $options, $depth);
3868
    }
3869
3870
    /**
3871
     * Checks whether JSON is available on the server.
3872
     *
3873
     * @return bool
3874
     *              <strong>true</strong> if available, <strong>false</strong> otherwise
3875
     */
3876
    public static function json_loaded(): bool
3877
    {
3878
        return \function_exists('json_decode');
3879
    }
3880
3881
    /**
3882
     * Makes string's first char lowercase.
3883
     *
3884
     * @param string      $str                   <p>The input string</p>
3885
     * @param string      $encoding              [optional] <p>Set the charset for e.g. "mb_" function</p>
3886
     * @param bool        $cleanUtf8             [optional] <p>Remove non UTF-8 chars from the string.</p>
3887
     * @param string|null $lang                  [optional] <p>Set the language for special cases: az, el, lt, tr</p>
3888
     * @param bool        $tryToKeepStringLength [optional] <p>true === try to keep the string length: e.g. ẞ -> ß</p>
3889
     *
3890
     * @return string the resulting string
3891
     */
3892 46
    public static function lcfirst(
3893
        string $str,
3894
        string $encoding = 'UTF-8',
3895
        bool $cleanUtf8 = false,
3896
        string $lang = null,
3897
        bool $tryToKeepStringLength = false
3898
    ): string {
3899 46
        if ($cleanUtf8 === true) {
3900
            $str = self::clean($str);
3901
        }
3902
3903 46
        $useMbFunction = $lang === null && $tryToKeepStringLength === false;
3904
3905 46
        if ($encoding === 'UTF-8') {
3906 43
            $strPartTwo = (string) \mb_substr($str, 1);
3907
3908 43
            if ($useMbFunction === true) {
3909 43
                $strPartOne = \mb_strtolower(
3910 43
                    (string) \mb_substr($str, 0, 1)
3911
                );
3912
            } else {
3913
                $strPartOne = self::strtolower(
3914
                    (string) \mb_substr($str, 0, 1),
3915
                    $encoding,
3916
                    false,
3917
                    $lang,
3918 43
                    $tryToKeepStringLength
3919
                );
3920
            }
3921
        } else {
3922 3
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
3923
3924 3
            $strPartTwo = (string) self::substr($str, 1, null, $encoding);
3925
3926 3
            $strPartOne = self::strtolower(
3927 3
                (string) self::substr($str, 0, 1, $encoding),
3928 3
                $encoding,
3929 3
                false,
3930 3
                $lang,
3931 3
                $tryToKeepStringLength
3932
            );
3933
        }
3934
3935 46
        return $strPartOne . $strPartTwo;
3936
    }
3937
3938
    /**
3939
     * alias for "UTF8::lcfirst()"
3940
     *
3941
     * @param string      $str
3942
     * @param string      $encoding
3943
     * @param bool        $cleanUtf8
3944
     * @param string|null $lang
3945
     * @param bool        $tryToKeepStringLength
3946
     *
3947
     * @return string
3948
     *
3949
     * @see UTF8::lcfirst()
3950
     */
3951 2
    public static function lcword(
3952
        string $str,
3953
        string $encoding = 'UTF-8',
3954
        bool $cleanUtf8 = false,
3955
        string $lang = null,
3956
        bool $tryToKeepStringLength = false
3957
    ): string {
3958 2
        return self::lcfirst($str, $encoding, $cleanUtf8, $lang, $tryToKeepStringLength);
3959
    }
3960
3961
    /**
3962
     * Lowercase for all words in the string.
3963
     *
3964
     * @param string      $str                   <p>The input string.</p>
3965
     * @param string[]    $exceptions            [optional] <p>Exclusion for some words.</p>
3966
     * @param string      $charlist              [optional] <p>Additional chars that contains to words and do not start
3967
     *                                           a new word.</p>
3968
     * @param string      $encoding              [optional] <p>Set the charset.</p>
3969
     * @param bool        $cleanUtf8             [optional] <p>Remove non UTF-8 chars from the string.</p>
3970
     * @param string|null $lang                  [optional] <p>Set the language for special cases: az, el, lt, tr</p>
3971
     * @param bool        $tryToKeepStringLength [optional] <p>true === try to keep the string length: e.g. ẞ -> ß</p>
3972
     *
3973
     * @return string
3974
     */
3975 2
    public static function lcwords(
3976
        string $str,
3977
        array $exceptions = [],
3978
        string $charlist = '',
3979
        string $encoding = 'UTF-8',
3980
        bool $cleanUtf8 = false,
3981
        string $lang = null,
3982
        bool $tryToKeepStringLength = false
3983
    ): string {
3984 2
        if (!$str) {
3985 2
            return '';
3986
        }
3987
3988 2
        $words = self::str_to_words($str, $charlist);
3989 2
        $useExceptions = \count($exceptions) > 0;
3990
3991 2
        foreach ($words as &$word) {
3992 2
            if (!$word) {
3993 2
                continue;
3994
            }
3995
3996
            if (
3997 2
                $useExceptions === false
3998
                ||
3999 2
                !\in_array($word, $exceptions, true)
4000
            ) {
4001 2
                $word = self::lcfirst($word, $encoding, $cleanUtf8, $lang, $tryToKeepStringLength);
4002
            }
4003
        }
4004
4005 2
        return \implode('', $words);
4006
    }
4007
4008
    /**
4009
     * alias for "UTF8::lcfirst()"
4010
     *
4011
     * @param string      $str
4012
     * @param string      $encoding
4013
     * @param bool        $cleanUtf8
4014
     * @param string|null $lang
4015
     * @param bool        $tryToKeepStringLength
4016
     *
4017
     * @return string
4018
     *
4019
     * @see UTF8::lcfirst()
4020
     */
4021 5
    public static function lowerCaseFirst(
4022
        string $str,
4023
        string $encoding = 'UTF-8',
4024
        bool $cleanUtf8 = false,
4025
        string $lang = null,
4026
        bool $tryToKeepStringLength = false
4027
    ): string {
4028 5
        return self::lcfirst($str, $encoding, $cleanUtf8, $lang, $tryToKeepStringLength);
4029
    }
4030
4031
    /**
4032
     * Strip whitespace or other characters from beginning of a UTF-8 string.
4033
     *
4034
     * @param string      $str   <p>The string to be trimmed</p>
4035
     * @param string|null $chars <p>Optional characters to be stripped</p>
4036
     *
4037
     * @return string the string with unwanted characters stripped from the left
4038
     */
4039 22
    public static function ltrim(string $str = '', string $chars = null): string
4040
    {
4041 22
        if ($str === '') {
4042 3
            return '';
4043
        }
4044
4045 21
        if ($chars) {
4046 10
            $chars = \preg_quote($chars, '/');
4047 10
            $pattern = "^[${chars}]+";
4048
        } else {
4049 14
            $pattern = "^[\s]+";
4050
        }
4051
4052 21
        if (self::$SUPPORT['mbstring'] === true) {
4053
            /** @noinspection PhpComposerExtensionStubsInspection */
4054 21
            return (string) \mb_ereg_replace($pattern, '', $str);
4055
        }
4056
4057
        return self::regex_replace($str, $pattern, '', '', '/');
4058
    }
4059
4060
    /**
4061
     * Returns the UTF-8 character with the maximum code point in the given data.
4062
     *
4063
     * @param array<string>|string $arg <p>A UTF-8 encoded string or an array of such strings.</p>
4064
     *
4065
     * @return string|null the character with the highest code point than others, returns null on failure or empty input
4066
     */
4067 2
    public static function max($arg)
4068
    {
4069 2
        if (\is_array($arg) === true) {
4070 2
            $arg = \implode('', $arg);
4071
        }
4072
4073 2
        $codepoints = self::codepoints($arg, false);
4074 2
        if (\count($codepoints) === 0) {
4075 2
            return null;
4076
        }
4077
4078 2
        $codepoint_max = \max($codepoints);
4079
4080 2
        return self::chr($codepoint_max);
4081
    }
4082
4083
    /**
4084
     * Calculates and returns the maximum number of bytes taken by any
4085
     * UTF-8 encoded character in the given string.
4086
     *
4087
     * @param string $str <p>The original Unicode string.</p>
4088
     *
4089
     * @return int max byte lengths of the given chars
4090
     */
4091 2
    public static function max_chr_width(string $str): int
4092
    {
4093 2
        $bytes = self::chr_size_list($str);
4094 2
        if (\count($bytes) > 0) {
4095 2
            return (int) \max($bytes);
4096
        }
4097
4098 2
        return 0;
4099
    }
4100
4101
    /**
4102
     * Checks whether mbstring is available on the server.
4103
     *
4104
     * @return bool
4105
     *              <strong>true</strong> if available, <strong>false</strong> otherwise
4106
     */
4107 27
    public static function mbstring_loaded(): bool
4108
    {
4109 27
        return \extension_loaded('mbstring');
4110
    }
4111
4112
    /**
4113
     * Returns the UTF-8 character with the minimum code point in the given data.
4114
     *
4115
     * @param mixed $arg <strong>A UTF-8 encoded string or an array of such strings.</strong>
4116
     *
4117
     * @return string|null the character with the lowest code point than others, returns null on failure or empty input
4118
     */
4119 2
    public static function min($arg)
4120
    {
4121 2
        if (\is_array($arg) === true) {
4122 2
            $arg = \implode('', $arg);
4123
        }
4124
4125 2
        $codepoints = self::codepoints($arg, false);
4126 2
        if (\count($codepoints) === 0) {
4127 2
            return null;
4128
        }
4129
4130 2
        $codepoint_min = \min($codepoints);
4131
4132 2
        return self::chr($codepoint_min);
4133
    }
4134
4135
    /**
4136
     * alias for "UTF8::normalize_encoding()"
4137
     *
4138
     * @param mixed $encoding
4139
     * @param mixed $fallback
4140
     *
4141
     * @return mixed
4142
     *
4143
     * @see UTF8::normalize_encoding()
4144
     * @deprecated <p>use "UTF8::normalize_encoding()"</p>
4145
     */
4146 2
    public static function normalizeEncoding($encoding, $fallback = '')
4147
    {
4148 2
        return self::normalize_encoding($encoding, $fallback);
4149
    }
4150
4151
    /**
4152
     * Normalize the encoding-"name" input.
4153
     *
4154
     * @param mixed $encoding <p>e.g.: ISO, UTF8, WINDOWS-1251 etc.</p>
4155
     * @param mixed $fallback <p>e.g.: UTF-8</p>
4156
     *
4157
     * @return mixed e.g.: ISO-8859-1, UTF-8, WINDOWS-1251 etc.<br>Will return a empty string as fallback (by default)
4158
     */
4159 323
    public static function normalize_encoding($encoding, $fallback = '')
4160
    {
4161 323
        static $STATIC_NORMALIZE_ENCODING_CACHE = [];
4162
4163
        // init
4164 323
        $encoding = (string) $encoding;
4165
4166 323
        if (!$encoding) {
4167 278
            return $fallback;
4168
        }
4169
4170
        if (
4171 50
            $encoding === 'UTF-8'
4172
            ||
4173 50
            $encoding === 'UTF8'
4174
        ) {
4175 24
            return 'UTF-8';
4176
        }
4177
4178
        if (
4179 43
            $encoding === '8BIT'
4180
            ||
4181 43
            $encoding === 'BINARY'
4182
        ) {
4183
            return 'CP850';
4184
        }
4185
4186
        if (
4187 43
            $encoding === 'HTML'
4188
            ||
4189 43
            $encoding === 'HTML-ENTITIES'
4190
        ) {
4191 2
            return 'HTML-ENTITIES';
4192
        }
4193
4194
        if (
4195 43
            $encoding === '1' // only a fallback, for non "strict_types" usage ...
4196
            ||
4197 43
            $encoding === '0' // only a fallback, for non "strict_types" usage ...
4198
        ) {
4199 1
            return $fallback;
4200
        }
4201
4202 42
        if (isset($STATIC_NORMALIZE_ENCODING_CACHE[$encoding])) {
4203 40
            return $STATIC_NORMALIZE_ENCODING_CACHE[$encoding];
4204
        }
4205
4206 6
        if (self::$ENCODINGS === null) {
4207 1
            self::$ENCODINGS = self::getData('encodings');
4208
        }
4209
4210 6
        if (\in_array($encoding, self::$ENCODINGS, true)) {
4211 4
            $STATIC_NORMALIZE_ENCODING_CACHE[$encoding] = $encoding;
4212
4213 4
            return $encoding;
4214
        }
4215
4216 5
        $encodingOrig = $encoding;
4217 5
        $encoding = \strtoupper($encoding);
4218 5
        $encodingUpperHelper = (string) \preg_replace('/[^a-zA-Z0-9\s]/u', '', $encoding);
4219
4220
        $equivalences = [
4221 5
            'ISO8859'     => 'ISO-8859-1',
4222
            'ISO88591'    => 'ISO-8859-1',
4223
            'ISO'         => 'ISO-8859-1',
4224
            'LATIN'       => 'ISO-8859-1',
4225
            'LATIN1'      => 'ISO-8859-1', // Western European
4226
            'ISO88592'    => 'ISO-8859-2',
4227
            'LATIN2'      => 'ISO-8859-2', // Central European
4228
            'ISO88593'    => 'ISO-8859-3',
4229
            'LATIN3'      => 'ISO-8859-3', // Southern European
4230
            'ISO88594'    => 'ISO-8859-4',
4231
            'LATIN4'      => 'ISO-8859-4', // Northern European
4232
            'ISO88595'    => 'ISO-8859-5',
4233
            'ISO88596'    => 'ISO-8859-6', // Greek
4234
            'ISO88597'    => 'ISO-8859-7',
4235
            'ISO88598'    => 'ISO-8859-8', // Hebrew
4236
            'ISO88599'    => 'ISO-8859-9',
4237
            'LATIN5'      => 'ISO-8859-9', // Turkish
4238
            'ISO885911'   => 'ISO-8859-11',
4239
            'TIS620'      => 'ISO-8859-11', // Thai
4240
            'ISO885910'   => 'ISO-8859-10',
4241
            'LATIN6'      => 'ISO-8859-10', // Nordic
4242
            'ISO885913'   => 'ISO-8859-13',
4243
            'LATIN7'      => 'ISO-8859-13', // Baltic
4244
            'ISO885914'   => 'ISO-8859-14',
4245
            'LATIN8'      => 'ISO-8859-14', // Celtic
4246
            'ISO885915'   => 'ISO-8859-15',
4247
            'LATIN9'      => 'ISO-8859-15', // Western European (with some extra chars e.g. €)
4248
            'ISO885916'   => 'ISO-8859-16',
4249
            'LATIN10'     => 'ISO-8859-16', // Southeast European
4250
            'CP1250'      => 'WINDOWS-1250',
4251
            'WIN1250'     => 'WINDOWS-1250',
4252
            'WINDOWS1250' => 'WINDOWS-1250',
4253
            'CP1251'      => 'WINDOWS-1251',
4254
            'WIN1251'     => 'WINDOWS-1251',
4255
            'WINDOWS1251' => 'WINDOWS-1251',
4256
            'CP1252'      => 'WINDOWS-1252',
4257
            'WIN1252'     => 'WINDOWS-1252',
4258
            'WINDOWS1252' => 'WINDOWS-1252',
4259
            'CP1253'      => 'WINDOWS-1253',
4260
            'WIN1253'     => 'WINDOWS-1253',
4261
            'WINDOWS1253' => 'WINDOWS-1253',
4262
            'CP1254'      => 'WINDOWS-1254',
4263
            'WIN1254'     => 'WINDOWS-1254',
4264
            'WINDOWS1254' => 'WINDOWS-1254',
4265
            'CP1255'      => 'WINDOWS-1255',
4266
            'WIN1255'     => 'WINDOWS-1255',
4267
            'WINDOWS1255' => 'WINDOWS-1255',
4268
            'CP1256'      => 'WINDOWS-1256',
4269
            'WIN1256'     => 'WINDOWS-1256',
4270
            'WINDOWS1256' => 'WINDOWS-1256',
4271
            'CP1257'      => 'WINDOWS-1257',
4272
            'WIN1257'     => 'WINDOWS-1257',
4273
            'WINDOWS1257' => 'WINDOWS-1257',
4274
            'CP1258'      => 'WINDOWS-1258',
4275
            'WIN1258'     => 'WINDOWS-1258',
4276
            'WINDOWS1258' => 'WINDOWS-1258',
4277
            'UTF16'       => 'UTF-16',
4278
            'UTF32'       => 'UTF-32',
4279
            'UTF8'        => 'UTF-8',
4280
            'UTF'         => 'UTF-8',
4281
            'UTF7'        => 'UTF-7',
4282
            '8BIT'        => 'CP850',
4283
            'BINARY'      => 'CP850',
4284
        ];
4285
4286 5
        if (!empty($equivalences[$encodingUpperHelper])) {
4287 4
            $encoding = $equivalences[$encodingUpperHelper];
4288
        }
4289
4290 5
        $STATIC_NORMALIZE_ENCODING_CACHE[$encodingOrig] = $encoding;
4291
4292 5
        return $encoding;
4293
    }
4294
4295
    /**
4296
     * Standardize line ending to unix-like.
4297
     *
4298
     * @param string $str
4299
     *
4300
     * @return string
4301
     */
4302 5
    public static function normalize_line_ending(string $str): string
4303
    {
4304 5
        return \str_replace(["\r\n", "\r"], "\n", $str);
4305
    }
4306
4307
    /**
4308
     * Normalize some MS Word special characters.
4309
     *
4310
     * @param string $str <p>The string to be normalized.</p>
4311
     *
4312
     * @return string
4313
     */
4314 38
    public static function normalize_msword(string $str): string
4315
    {
4316 38
        if ($str === '') {
4317 2
            return '';
4318
        }
4319
4320
        $keys = [
4321 38
            "\xc2\xab", // « (U+00AB) in UTF-8
4322
            "\xc2\xbb", // » (U+00BB) in UTF-8
4323
            "\xe2\x80\x98", // ‘ (U+2018) in UTF-8
4324
            "\xe2\x80\x99", // ’ (U+2019) in UTF-8
4325
            "\xe2\x80\x9a", // ‚ (U+201A) in UTF-8
4326
            "\xe2\x80\x9b", // ‛ (U+201B) in UTF-8
4327
            "\xe2\x80\x9c", // “ (U+201C) in UTF-8
4328
            "\xe2\x80\x9d", // ” (U+201D) in UTF-8
4329
            "\xe2\x80\x9e", // „ (U+201E) in UTF-8
4330
            "\xe2\x80\x9f", // ‟ (U+201F) in UTF-8
4331
            "\xe2\x80\xb9", // ‹ (U+2039) in UTF-8
4332
            "\xe2\x80\xba", // › (U+203A) in UTF-8
4333
            "\xe2\x80\x93", // – (U+2013) in UTF-8
4334
            "\xe2\x80\x94", // — (U+2014) in UTF-8
4335
            "\xe2\x80\xa6", // … (U+2026) in UTF-8
4336
        ];
4337
4338
        $values = [
4339 38
            '"', // « (U+00AB) in UTF-8
4340
            '"', // » (U+00BB) in UTF-8
4341
            "'", // ‘ (U+2018) in UTF-8
4342
            "'", // ’ (U+2019) in UTF-8
4343
            "'", // ‚ (U+201A) in UTF-8
4344
            "'", // ‛ (U+201B) in UTF-8
4345
            '"', // “ (U+201C) in UTF-8
4346
            '"', // ” (U+201D) in UTF-8
4347
            '"', // „ (U+201E) in UTF-8
4348
            '"', // ‟ (U+201F) in UTF-8
4349
            "'", // ‹ (U+2039) in UTF-8
4350
            "'", // › (U+203A) in UTF-8
4351
            '-', // – (U+2013) in UTF-8
4352
            '-', // — (U+2014) in UTF-8
4353
            '...', // … (U+2026) in UTF-8
4354
        ];
4355
4356 38
        return \str_replace($keys, $values, $str);
4357
    }
4358
4359
    /**
4360
     * Normalize the whitespace.
4361
     *
4362
     * @param string $str                     <p>The string to be normalized.</p>
4363
     * @param bool   $keepNonBreakingSpace    [optional] <p>Set to true, to keep non-breaking-spaces.</p>
4364
     * @param bool   $keepBidiUnicodeControls [optional] <p>Set to true, to keep non-printable (for the web)
4365
     *                                        bidirectional text chars.</p>
4366
     *
4367
     * @return string
4368
     */
4369 86
    public static function normalize_whitespace(string $str, bool $keepNonBreakingSpace = false, bool $keepBidiUnicodeControls = false): string
4370
    {
4371 86
        if ($str === '') {
4372 9
            return '';
4373
        }
4374
4375 86
        static $WHITESPACE_CACHE = [];
4376 86
        $cacheKey = (int) $keepNonBreakingSpace;
4377
4378 86
        if (!isset($WHITESPACE_CACHE[$cacheKey])) {
4379 2
            $WHITESPACE_CACHE[$cacheKey] = self::$WHITESPACE_TABLE;
4380
4381 2
            if ($keepNonBreakingSpace === true) {
4382 1
                unset($WHITESPACE_CACHE[$cacheKey]['NO-BREAK SPACE']);
4383
            }
4384
4385 2
            $WHITESPACE_CACHE[$cacheKey] = \array_values($WHITESPACE_CACHE[$cacheKey]);
4386
        }
4387
4388 86
        if ($keepBidiUnicodeControls === false) {
4389 86
            static $BIDI_UNICODE_CONTROLS_CACHE = null;
4390
4391 86
            if ($BIDI_UNICODE_CONTROLS_CACHE === null) {
4392 1
                $BIDI_UNICODE_CONTROLS_CACHE = \array_values(self::$BIDI_UNI_CODE_CONTROLS_TABLE);
4393
            }
4394
4395 86
            $str = \str_replace($BIDI_UNICODE_CONTROLS_CACHE, '', $str);
4396
        }
4397
4398 86
        return \str_replace($WHITESPACE_CACHE[$cacheKey], ' ', $str);
4399
    }
4400
4401
    /**
4402
     * Calculates Unicode code point of the given UTF-8 encoded character.
4403
     *
4404
     * INFO: opposite to UTF8::chr()
4405
     *
4406
     * @param string $chr      <p>The character of which to calculate code point.<p/>
4407
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
4408
     *
4409
     * @return int
4410
     *             Unicode code point of the given character,<br>
4411
     *             0 on invalid UTF-8 byte sequence
4412
     */
4413 30
    public static function ord($chr, string $encoding = 'UTF-8'): int
4414
    {
4415 30
        static $CHAR_CACHE = [];
4416
4417
        // init
4418 30
        $chr = (string) $chr;
4419
4420 30
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
4421 5
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
4422
        }
4423
4424 30
        $cacheKey = $chr . $encoding;
4425 30
        if (isset($CHAR_CACHE[$cacheKey]) === true) {
4426 30
            return $CHAR_CACHE[$cacheKey];
4427
        }
4428
4429
        // check again, if it's still not UTF-8
4430 12
        if ($encoding !== 'UTF-8') {
4431 3
            $chr = self::encode($encoding, $chr);
4432
        }
4433
4434 12
        if (self::$ORD === null) {
4435
            self::$ORD = self::getData('ord');
4436
        }
4437
4438 12
        if (isset(self::$ORD[$chr])) {
4439 12
            return $CHAR_CACHE[$cacheKey] = self::$ORD[$chr];
4440
        }
4441
4442
        //
4443
        // fallback via "IntlChar"
4444
        //
4445
4446 6
        if (self::$SUPPORT['intlChar'] === true) {
4447
            /** @noinspection PhpComposerExtensionStubsInspection */
4448 5
            $code = \IntlChar::ord($chr);
4449 5
            if ($code) {
4450 5
                return $CHAR_CACHE[$cacheKey] = $code;
4451
            }
4452
        }
4453
4454
        //
4455
        // fallback via vanilla php
4456
        //
4457
4458
        /** @noinspection CallableParameterUseCaseInTypeContextInspection */
4459 1
        $chr = \unpack('C*', (string) \substr($chr, 0, 4));
4460 1
        $code = $chr ? $chr[1] : 0;
4461
4462 1
        if ($code >= 0xF0 && isset($chr[4])) {
4463
            /** @noinspection UnnecessaryCastingInspection */
4464
            return $CHAR_CACHE[$cacheKey] = (int) ((($code - 0xF0) << 18) + (($chr[2] - 0x80) << 12) + (($chr[3] - 0x80) << 6) + $chr[4] - 0x80);
4465
        }
4466
4467 1
        if ($code >= 0xE0 && isset($chr[3])) {
4468
            /** @noinspection UnnecessaryCastingInspection */
4469 1
            return $CHAR_CACHE[$cacheKey] = (int) ((($code - 0xE0) << 12) + (($chr[2] - 0x80) << 6) + $chr[3] - 0x80);
4470
        }
4471
4472 1
        if ($code >= 0xC0 && isset($chr[2])) {
4473
            /** @noinspection UnnecessaryCastingInspection */
4474 1
            return $CHAR_CACHE[$cacheKey] = (int) ((($code - 0xC0) << 6) + $chr[2] - 0x80);
4475
        }
4476
4477
        return $CHAR_CACHE[$cacheKey] = $code;
4478
    }
4479
4480
    /**
4481
     * Parses the string into an array (into the the second parameter).
4482
     *
4483
     * WARNING: Instead of "parse_str()" this method do not (re-)placing variables in the current scope,
4484
     *          if the second parameter is not set!
4485
     *
4486
     * @see http://php.net/manual/en/function.parse-str.php
4487
     *
4488
     * @param string $str       <p>The input string.</p>
4489
     * @param array  $result    <p>The result will be returned into this reference parameter.</p>
4490
     * @param bool   $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
4491
     *
4492
     * @return bool
4493
     *              Will return <strong>false</strong> if php can't parse the string and we haven't any $result
4494
     */
4495 2
    public static function parse_str(string $str, &$result, bool $cleanUtf8 = false): bool
4496
    {
4497 2
        if ($cleanUtf8 === true) {
4498 2
            $str = self::clean($str);
4499
        }
4500
4501 2
        if (self::$SUPPORT['mbstring'] === true) {
4502 2
            $return = \mb_parse_str($str, $result);
4503
4504 2
            return $return !== false && $result !== [];
4505
        }
4506
4507
        /** @noinspection PhpVoidFunctionResultUsedInspection */
4508
        \parse_str($str, $result);
4509
4510
        return $result !== [];
4511
    }
4512
4513
    /**
4514
     * Checks if \u modifier is available that enables Unicode support in PCRE.
4515
     *
4516
     * @return bool
4517
     *              <strong>true</strong> if support is available,<br>
4518
     *              <strong>false</strong> otherwise
4519
     */
4520 102
    public static function pcre_utf8_support(): bool
4521
    {
4522
        /** @noinspection PhpUsageOfSilenceOperatorInspection */
4523 102
        return (bool) @\preg_match('//u', '');
4524
    }
4525
4526
    /**
4527
     * Create an array containing a range of UTF-8 characters.
4528
     *
4529
     * @param mixed $var1 <p>Numeric or hexadecimal code points, or a UTF-8 character to start from.</p>
4530
     * @param mixed $var2 <p>Numeric or hexadecimal code points, or a UTF-8 character to end at.</p>
4531
     *
4532
     * @return string[]
4533
     */
4534 2
    public static function range($var1, $var2): array
4535
    {
4536 2
        if (!$var1 || !$var2) {
4537 2
            return [];
4538
        }
4539
4540 2
        if (self::$SUPPORT['ctype'] === false) {
4541
            throw new \RuntimeException('ext-ctype: is not installed');
4542
        }
4543
4544
        /** @noinspection PhpComposerExtensionStubsInspection */
4545 2
        if (\ctype_digit((string) $var1)) {
4546 2
            $start = (int) $var1;
4547 2
        } /** @noinspection PhpComposerExtensionStubsInspection */ elseif (\ctype_xdigit($var1)) {
4548
            $start = (int) self::hex_to_int($var1);
4549
        } else {
4550 2
            $start = self::ord($var1);
4551
        }
4552
4553 2
        if (!$start) {
4554
            return [];
4555
        }
4556
4557
        /** @noinspection PhpComposerExtensionStubsInspection */
4558 2
        if (\ctype_digit((string) $var2)) {
4559 2
            $end = (int) $var2;
4560 2
        } /** @noinspection PhpComposerExtensionStubsInspection */ elseif (\ctype_xdigit($var2)) {
4561
            $end = (int) self::hex_to_int($var2);
4562
        } else {
4563 2
            $end = self::ord($var2);
4564
        }
4565
4566 2
        if (!$end) {
4567
            return [];
4568
        }
4569
4570 2
        return \array_map(
4571
            static function (int $i): string {
4572 2
                return (string) self::chr($i);
4573 2
            },
4574 2
            \range($start, $end)
4575
        );
4576
    }
4577
4578
    /**
4579
     * Multi decode html entity & fix urlencoded-win1252-chars.
4580
     *
4581
     * e.g:
4582
     * 'test+test'                     => 'test+test'
4583
     * 'D&#252;sseldorf'               => 'Düsseldorf'
4584
     * 'D%FCsseldorf'                  => 'Düsseldorf'
4585
     * 'D&#xFC;sseldorf'               => 'Düsseldorf'
4586
     * 'D%26%23xFC%3Bsseldorf'         => 'Düsseldorf'
4587
     * 'Düsseldorf'                   => 'Düsseldorf'
4588
     * 'D%C3%BCsseldorf'               => 'Düsseldorf'
4589
     * 'D%C3%83%C2%BCsseldorf'         => 'Düsseldorf'
4590
     * 'D%25C3%2583%25C2%25BCsseldorf' => 'Düsseldorf'
4591
     *
4592
     * @param string $str          <p>The input string.</p>
4593
     * @param bool   $multi_decode <p>Decode as often as possible.</p>
4594
     *
4595
     * @return string
4596
     */
4597 6
    public static function rawurldecode(string $str, bool $multi_decode = true): string
4598
    {
4599 6
        if ($str === '') {
4600 4
            return '';
4601
        }
4602
4603
        if (
4604 6
            \strpos($str, '&') === false
4605
            &&
4606 6
            \strpos($str, '%') === false
4607
            &&
4608 6
            \strpos($str, '+') === false
4609
            &&
4610 6
            \strpos($str, '\u') === false
4611
        ) {
4612 4
            return self::fix_simple_utf8($str);
4613
        }
4614
4615 6
        $str = self::urldecode_unicode_helper($str);
4616
4617
        do {
4618 6
            $str_compare = $str;
4619
4620
            /**
4621
             * @psalm-suppress PossiblyInvalidArgument
4622
             */
4623 6
            $str = self::fix_simple_utf8(
4624 6
                \rawurldecode(
4625 6
                    self::html_entity_decode(
4626 6
                        self::to_utf8($str),
4627 6
                        \ENT_QUOTES | \ENT_HTML5
4628
                    )
4629
                )
4630
            );
4631 6
        } while ($multi_decode === true && $str_compare !== $str);
4632
4633 6
        return $str;
4634
    }
4635
4636
    /**
4637
     * Replaces all occurrences of $pattern in $str by $replacement.
4638
     *
4639
     * @param string $str         <p>The input string.</p>
4640
     * @param string $pattern     <p>The regular expression pattern.</p>
4641
     * @param string $replacement <p>The string to replace with.</p>
4642
     * @param string $options     [optional] <p>Matching conditions to be used.</p>
4643
     * @param string $delimiter   [optional] <p>Delimiter the the regex. Default: '/'</p>
4644
     *
4645
     * @return string
4646
     */
4647 18
    public static function regex_replace(
4648
        string $str,
4649
        string $pattern,
4650
        string $replacement,
4651
        string $options = '',
4652
        string $delimiter = '/'
4653
    ): string {
4654 18
        if ($options === 'msr') {
4655 9
            $options = 'ms';
4656
        }
4657
4658
        // fallback
4659 18
        if (!$delimiter) {
4660
            $delimiter = '/';
4661
        }
4662
4663 18
        return (string) \preg_replace(
4664 18
            $delimiter . $pattern . $delimiter . 'u' . $options,
4665 18
            $replacement,
4666 18
            $str
4667
        );
4668
    }
4669
4670
    /**
4671
     * alias for "UTF8::remove_bom()"
4672
     *
4673
     * @param string $str
4674
     *
4675
     * @return string
4676
     *
4677
     * @see UTF8::remove_bom()
4678
     * @deprecated <p>use "UTF8::remove_bom()"</p>
4679
     */
4680
    public static function removeBOM(string $str): string
4681
    {
4682
        return self::remove_bom($str);
4683
    }
4684
4685
    /**
4686
     * Remove the BOM from UTF-8 / UTF-16 / UTF-32 strings.
4687
     *
4688
     * @param string $str <p>The input string.</p>
4689
     *
4690
     * @return string string without UTF-BOM
4691
     */
4692 82
    public static function remove_bom(string $str): string
4693
    {
4694 82
        if ($str === '') {
4695 9
            return '';
4696
        }
4697
4698 82
        $strLength = \strlen($str);
4699 82
        foreach (self::$BOM as $bomString => $bomByteLength) {
4700 82
            if (\strpos($str, $bomString, 0) === 0) {
4701 10
                $strTmp = \substr($str, $bomByteLength, $strLength);
4702 10
                if ($strTmp === false) {
4703
                    return '';
4704
                }
4705
4706 10
                $strLength -= (int) $bomByteLength;
4707
4708 82
                $str = (string) $strTmp;
4709
            }
4710
        }
4711
4712 82
        return $str;
4713
    }
4714
4715
    /**
4716
     * Removes duplicate occurrences of a string in another string.
4717
     *
4718
     * @param string          $str  <p>The base string.</p>
4719
     * @param string|string[] $what <p>String to search for in the base string.</p>
4720
     *
4721
     * @return string the result string with removed duplicates
4722
     */
4723 2
    public static function remove_duplicates(string $str, $what = ' '): string
4724
    {
4725 2
        if (\is_string($what) === true) {
4726 2
            $what = [$what];
4727
        }
4728
4729 2
        if (\is_array($what) === true) {
0 ignored issues
show
introduced by
The condition is_array($what) === true is always true.
Loading history...
4730
            /** @noinspection ForeachSourceInspection */
4731 2
            foreach ($what as $item) {
4732 2
                $str = (string) \preg_replace('/(' . \preg_quote($item, '/') . ')+/u', $item, $str);
4733
            }
4734
        }
4735
4736 2
        return $str;
4737
    }
4738
4739
    /**
4740
     * Remove html via "strip_tags()" from the string.
4741
     *
4742
     * @param string $str
4743
     * @param string $allowableTags [optional] <p>You can use the optional second parameter to specify tags which should
4744
     *                              not be stripped. Default: null
4745
     *                              </p>
4746
     *
4747
     * @return string
4748
     */
4749 6
    public static function remove_html(string $str, string $allowableTags = ''): string
4750
    {
4751 6
        return \strip_tags($str, $allowableTags);
4752
    }
4753
4754
    /**
4755
     * Remove all breaks [<br> | \r\n | \r | \n | ...] from the string.
4756
     *
4757
     * @param string $str
4758
     * @param string $replacement [optional] <p>Default is a empty string.</p>
4759
     *
4760
     * @return string
4761
     */
4762 6
    public static function remove_html_breaks(string $str, string $replacement = ''): string
4763
    {
4764 6
        return (string) \preg_replace("#/\r\n|\r|\n|<br.*/?>#isU", $replacement, $str);
4765
    }
4766
4767
    /**
4768
     * Remove invisible characters from a string.
4769
     *
4770
     * e.g.: This prevents sandwiching null characters between ascii characters, like Java\0script.
4771
     *
4772
     * copy&past from https://github.com/bcit-ci/CodeIgniter/blob/develop/system/core/Common.php
4773
     *
4774
     * @param string $str
4775
     * @param bool   $url_encoded
4776
     * @param string $replacement
4777
     *
4778
     * @return string
4779
     */
4780 116
    public static function remove_invisible_characters(string $str, bool $url_encoded = true, string $replacement = ''): string
4781
    {
4782
        // init
4783 116
        $non_displayables = [];
4784
4785
        // every control character except newline (dec 10),
4786
        // carriage return (dec 13) and horizontal tab (dec 09)
4787 116
        if ($url_encoded) {
4788 116
            $non_displayables[] = '/%0[0-8bcefBCEF]/'; // url encoded 00-08, 11, 12, 14, 15
4789 116
            $non_displayables[] = '/%1[0-9a-fA-F]/'; // url encoded 16-31
4790
        }
4791
4792 116
        $non_displayables[] = '/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]+/S'; // 00-08, 11, 12, 14-31, 127
4793
4794
        do {
4795 116
            $str = (string) \preg_replace($non_displayables, $replacement, $str, -1, $count);
4796 116
        } while ($count !== 0);
4797
4798 116
        return $str;
4799
    }
4800
4801
    /**
4802
     * Returns a new string with the prefix $substring removed, if present.
4803
     *
4804
     * @param string $str
4805
     * @param string $substring <p>The prefix to remove.</p>
4806
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
4807
     *
4808
     * @return string string without the prefix $substring
4809
     */
4810 12
    public static function remove_left(string $str, string $substring, string $encoding = 'UTF-8'): string
4811
    {
4812 12
        if ($substring && \strpos($str, $substring) === 0) {
4813 6
            if ($encoding === 'UTF-8') {
4814 4
                return (string) \mb_substr(
4815 4
                    $str,
4816 4
                    (int) \mb_strlen($substring)
4817
                );
4818
            }
4819
4820 2
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
4821
4822 2
            return (string) self::substr(
4823 2
                $str,
4824 2
                (int) self::strlen($substring, $encoding),
4825 2
                null,
4826 2
                $encoding
4827
            );
4828
        }
4829
4830 6
        return $str;
4831
    }
4832
4833
    /**
4834
     * Returns a new string with the suffix $substring removed, if present.
4835
     *
4836
     * @param string $str
4837
     * @param string $substring <p>The suffix to remove.</p>
4838
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
4839
     *
4840
     * @return string string having a $str without the suffix $substring
4841
     */
4842 12
    public static function remove_right(string $str, string $substring, string $encoding = 'UTF-8'): string
4843
    {
4844 12
        if ($substring && \substr($str, -\strlen($substring)) === $substring) {
4845 6
            if ($encoding === 'UTF-8') {
4846 4
                return (string) \mb_substr(
4847 4
                    $str,
4848 4
                    0,
4849 4
                    (int) \mb_strlen($str) - (int) \mb_strlen($substring)
4850
                );
4851
            }
4852
4853 2
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
4854
4855 2
            return (string) self::substr(
4856 2
                $str,
4857 2
                0,
4858 2
                (int) self::strlen($str, $encoding) - (int) self::strlen($substring, $encoding),
4859 2
                $encoding
4860
            );
4861
        }
4862
4863 6
        return $str;
4864
    }
4865
4866
    /**
4867
     * Replaces all occurrences of $search in $str by $replacement.
4868
     *
4869
     * @param string $str           <p>The input string.</p>
4870
     * @param string $search        <p>The needle to search for.</p>
4871
     * @param string $replacement   <p>The string to replace with.</p>
4872
     * @param bool   $caseSensitive [optional] <p>Whether or not to enforce case-sensitivity. Default: true</p>
4873
     *
4874
     * @return string string after the replacements
4875
     */
4876 29
    public static function replace(
4877
        string $str,
4878
        string $search,
4879
        string $replacement,
4880
        bool $caseSensitive = true
4881
    ): string {
4882 29
        if ($caseSensitive) {
4883 22
            return \str_replace($search, $replacement, $str);
4884
        }
4885
4886 7
        return self::str_ireplace($search, $replacement, $str);
4887
    }
4888
4889
    /**
4890
     * Replaces all occurrences of $search in $str by $replacement.
4891
     *
4892
     * @param string       $str           <p>The input string.</p>
4893
     * @param array        $search        <p>The elements to search for.</p>
4894
     * @param array|string $replacement   <p>The string to replace with.</p>
4895
     * @param bool         $caseSensitive [optional] <p>Whether or not to enforce case-sensitivity. Default: true</p>
4896
     *
4897
     * @return string string after the replacements
4898
     */
4899 30
    public static function replace_all(
4900
        string $str,
4901
        array $search,
4902
        $replacement,
4903
        bool $caseSensitive = true
4904
    ): string {
4905 30
        if ($caseSensitive) {
4906 23
            return \str_replace($search, $replacement, $str);
4907
        }
4908
4909 7
        return self::str_ireplace($search, $replacement, $str);
4910
    }
4911
4912
    /**
4913
     * Replace the diamond question mark (�) and invalid-UTF8 chars with the replacement.
4914
     *
4915
     * @param string $str                <p>The input string</p>
4916
     * @param string $replacementChar    <p>The replacement character.</p>
4917
     * @param bool   $processInvalidUtf8 <p>Convert invalid UTF-8 chars </p>
4918
     *
4919
     * @return string
4920
     */
4921 62
    public static function replace_diamond_question_mark(string $str, string $replacementChar = '', bool $processInvalidUtf8 = true): string
4922
    {
4923 62
        if ($str === '') {
4924 9
            return '';
4925
        }
4926
4927 62
        if ($processInvalidUtf8 === true) {
4928 62
            $replacementCharHelper = $replacementChar;
4929 62
            if ($replacementChar === '') {
4930 62
                $replacementCharHelper = 'none';
4931
            }
4932
4933 62
            if (self::$SUPPORT['mbstring'] === false) {
4934
                // if there is no native support for "mbstring",
4935
                // then we need to clean the string before ...
4936
                $str = self::clean($str);
4937
            }
4938
4939 62
            $save = \mb_substitute_character();
4940 62
            \mb_substitute_character($replacementCharHelper);
4941
            // the polyfill maybe return false, so cast to string
4942 62
            $str = (string) \mb_convert_encoding($str, 'UTF-8', 'UTF-8');
4943 62
            \mb_substitute_character($save);
4944
        }
4945
4946 62
        return \str_replace(
4947
            [
4948 62
                "\xEF\xBF\xBD",
4949
                '�',
4950
            ],
4951
            [
4952 62
                $replacementChar,
4953 62
                $replacementChar,
4954
            ],
4955 62
            $str
4956
        );
4957
    }
4958
4959
    /**
4960
     * Strip whitespace or other characters from end of a UTF-8 string.
4961
     *
4962
     * @param string      $str   <p>The string to be trimmed.</p>
4963
     * @param string|null $chars <p>Optional characters to be stripped.</p>
4964
     *
4965
     * @return string the string with unwanted characters stripped from the right
4966
     */
4967 20
    public static function rtrim(string $str = '', string $chars = null): string
4968
    {
4969 20
        if ($str === '') {
4970 3
            return '';
4971
        }
4972
4973 19
        if ($chars) {
4974 8
            $chars = \preg_quote($chars, '/');
4975 8
            $pattern = "[${chars}]+\$";
4976
        } else {
4977 14
            $pattern = "[\s]+\$";
4978
        }
4979
4980 19
        if (self::$SUPPORT['mbstring'] === true) {
4981
            /** @noinspection PhpComposerExtensionStubsInspection */
4982 19
            return (string) \mb_ereg_replace($pattern, '', $str);
4983
        }
4984
4985
        return self::regex_replace($str, $pattern, '', '', '/');
4986
    }
4987
4988
    /**
4989
     * WARNING: Print native UTF-8 support (libs), e.g. for debugging.
4990
     *
4991
     * @psalm-suppress MissingReturnType
4992
     */
4993 2
    public static function showSupport()
4994
    {
4995 2
        echo '<pre>';
4996 2
        foreach (self::$SUPPORT as $key => &$value) {
4997 2
            echo $key . ' - ' . \print_r($value, true) . "\n<br>";
4998
        }
4999 2
        unset($value);
5000 2
        echo '</pre>';
5001 2
    }
5002
5003
    /**
5004
     * Converts a UTF-8 character to HTML Numbered Entity like "&#123;".
5005
     *
5006
     * @param string $char           <p>The Unicode character to be encoded as numbered entity.</p>
5007
     * @param bool   $keepAsciiChars <p>Set to <strong>true</strong> to keep ASCII chars.</>
5008
     * @param string $encoding       [optional] <p>Set the charset for e.g. "mb_" function</p>
5009
     *
5010
     * @return string the HTML numbered entity
5011
     */
5012 2
    public static function single_chr_html_encode(string $char, bool $keepAsciiChars = false, string $encoding = 'UTF-8'): string
5013
    {
5014 2
        if ($char === '') {
5015 2
            return '';
5016
        }
5017
5018
        if (
5019 2
            $keepAsciiChars === true
5020
            &&
5021 2
            self::is_ascii($char) === true
5022
        ) {
5023 2
            return $char;
5024
        }
5025
5026 2
        return '&#' . self::ord($char, $encoding) . ';';
5027
    }
5028
5029
    /**
5030
     * @param string $str
5031
     * @param int    $tabLength
5032
     *
5033
     * @return string
5034
     */
5035 5
    public static function spaces_to_tabs(string $str, int $tabLength = 4): string
5036
    {
5037 5
        if ($tabLength === 4) {
5038 3
            $tab = '    ';
5039 2
        } elseif ($tabLength === 2) {
5040 1
            $tab = '  ';
5041
        } else {
5042 1
            $tab = \str_repeat(' ', $tabLength);
5043
        }
5044
5045 5
        return \str_replace($tab, "\t", $str);
5046
    }
5047
5048
    /**
5049
     * alias for "UTF8::str_split()"
5050
     *
5051
     * @param string|string[] $str
5052
     * @param int             $length
5053
     * @param bool            $cleanUtf8
5054
     *
5055
     * @return string[]
5056
     *
5057
     * @see UTF8::str_split()
5058
     */
5059 9
    public static function split(
5060
        $str,
5061
        int $length = 1,
5062
        bool $cleanUtf8 = false
5063
    ): array {
5064 9
        return self::str_split($str, $length, $cleanUtf8);
5065
    }
5066
5067
    /**
5068
     * alias for "UTF8::str_starts_with()"
5069
     *
5070
     * @param string $haystack
5071
     * @param string $needle
5072
     *
5073
     * @return bool
5074
     *
5075
     * @see UTF8::str_starts_with()
5076
     */
5077
    public static function str_begins(string $haystack, string $needle): bool
5078
    {
5079
        return self::str_starts_with($haystack, $needle);
5080
    }
5081
5082
    /**
5083
     * Returns a camelCase version of the string. Trims surrounding spaces,
5084
     * capitalizes letters following digits, spaces, dashes and underscores,
5085
     * and removes spaces, dashes, as well as underscores.
5086
     *
5087
     * @param string      $str                   <p>The input string.</p>
5088
     * @param string      $encoding              [optional] <p>Default: 'UTF-8'</p>
5089
     * @param bool        $cleanUtf8             [optional] <p>Remove non UTF-8 chars from the string.</p>
5090
     * @param string|null $lang                  [optional] <p>Set the language for special cases: az, el, lt, tr</p>
5091
     * @param bool        $tryToKeepStringLength [optional] <p>true === try to keep the string length: e.g. ẞ -> ß</p>
5092
     *
5093
     * @return string
5094
     */
5095 32
    public static function str_camelize(
5096
        string $str,
5097
        string $encoding = 'UTF-8',
5098
        bool $cleanUtf8 = false,
5099
        string $lang = null,
5100
        bool $tryToKeepStringLength = false
5101
    ): string {
5102 32
        if ($cleanUtf8 === true) {
5103
            $str = self::clean($str);
5104
        }
5105
5106 32
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
5107 26
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
5108
        }
5109
5110 32
        $str = self::lcfirst(
5111 32
            \trim($str),
5112 32
            $encoding,
5113 32
            false,
5114 32
            $lang,
5115 32
            $tryToKeepStringLength
5116
        );
5117 32
        $str = (string) \preg_replace('/^[-_]+/', '', $str);
5118
5119 32
        $useMbFunction = $lang === null && $tryToKeepStringLength === false;
5120
5121 32
        $str = (string) \preg_replace_callback(
5122 32
            '/[-_\s]+(.)?/u',
5123
            /**
5124
             * @param array $match
5125
             *
5126
             * @return string
5127
             */
5128
            static function (array $match) use ($useMbFunction, $encoding, $lang, $tryToKeepStringLength): string {
5129 27
                if (isset($match[1])) {
5130 27
                    if ($useMbFunction === true) {
5131 27
                        if ($encoding === 'UTF-8') {
5132 27
                            return \mb_strtoupper($match[1]);
5133
                        }
5134
5135
                        return \mb_strtoupper($match[1], $encoding);
5136
                    }
5137
5138
                    return self::strtoupper($match[1], $encoding, false, $lang, $tryToKeepStringLength);
5139
                }
5140
5141 1
                return '';
5142 32
            },
5143 32
            $str
5144
        );
5145
5146 32
        return (string) \preg_replace_callback(
5147 32
            '/[\d]+(.)?/u',
5148
            /**
5149
             * @param array $match
5150
             *
5151
             * @return string
5152
             */
5153
            static function (array $match) use ($useMbFunction, $encoding, $cleanUtf8, $lang, $tryToKeepStringLength): string {
5154 6
                if ($useMbFunction === true) {
5155 6
                    if ($encoding === 'UTF-8') {
5156 6
                        return \mb_strtoupper($match[0]);
5157
                    }
5158
5159
                    return \mb_strtoupper($match[0], $encoding);
5160
                }
5161
5162
                return self::strtoupper($match[0], $encoding, $cleanUtf8, $lang, $tryToKeepStringLength);
5163 32
            },
5164 32
            $str
5165
        );
5166
    }
5167
5168
    /**
5169
     * Returns the string with the first letter of each word capitalized,
5170
     * except for when the word is a name which shouldn't be capitalized.
5171
     *
5172
     * @param string $str
5173
     *
5174
     * @return string string with $str capitalized
5175
     */
5176 1
    public static function str_capitalize_name(string $str): string
5177
    {
5178 1
        return self::str_capitalize_name_helper(
5179 1
            self::str_capitalize_name_helper(
5180 1
                self::collapse_whitespace($str),
5181 1
                ' '
5182
            ),
5183 1
            '-'
5184
        );
5185
    }
5186
5187
    /**
5188
     * Returns true if the string contains $needle, false otherwise. By default
5189
     * the comparison is case-sensitive, but can be made insensitive by setting
5190
     * $caseSensitive to false.
5191
     *
5192
     * @param string $haystack      <p>The input string.</p>
5193
     * @param string $needle        <p>Substring to look for.</p>
5194
     * @param bool   $caseSensitive [optional] <p>Whether or not to enforce case-sensitivity. Default: true</p>
5195
     *
5196
     * @return bool whether or not $haystack contains $needle
5197
     */
5198 21
    public static function str_contains(
5199
        string $haystack,
5200
        string $needle,
5201
        bool $caseSensitive = true
5202
    ): bool {
5203 21
        if ($caseSensitive) {
5204 11
            return \strpos($haystack, $needle) !== false;
5205
        }
5206
5207 10
        return \mb_stripos($haystack, $needle) !== false;
5208
    }
5209
5210
    /**
5211
     * Returns true if the string contains all $needles, false otherwise. By
5212
     * default the comparison is case-sensitive, but can be made insensitive by
5213
     * setting $caseSensitive to false.
5214
     *
5215
     * @param string $haystack      <p>The input string.</p>
5216
     * @param array  $needles       <p>SubStrings to look for.</p>
5217
     * @param bool   $caseSensitive [optional] <p>Whether or not to enforce case-sensitivity. Default: true</p>
5218
     *
5219
     * @return bool whether or not $haystack contains $needle
5220
     */
5221 44
    public static function str_contains_all(
5222
        string $haystack,
5223
        array $needles,
5224
        bool $caseSensitive = true
5225
    ): bool {
5226 44
        if ($haystack === '' || $needles === []) {
5227 1
            return false;
5228
        }
5229
5230
        /** @noinspection LoopWhichDoesNotLoopInspection */
5231 43
        foreach ($needles as &$needle) {
5232 43
            if (!$needle) {
5233 1
                return false;
5234
            }
5235
5236 42
            if ($caseSensitive) {
5237 22
                return \strpos($haystack, $needle) !== false;
5238
            }
5239
5240 20
            return \mb_stripos($haystack, $needle) !== false;
5241
        }
5242
5243
        return true;
5244
    }
5245
5246
    /**
5247
     * Returns true if the string contains any $needles, false otherwise. By
5248
     * default the comparison is case-sensitive, but can be made insensitive by
5249
     * setting $caseSensitive to false.
5250
     *
5251
     * @param string $haystack      <p>The input string.</p>
5252
     * @param array  $needles       <p>SubStrings to look for.</p>
5253
     * @param bool   $caseSensitive [optional] <p>Whether or not to enforce case-sensitivity. Default: true</p>
5254
     *
5255
     * @return bool
5256
     *              Whether or not $str contains $needle
5257
     */
5258 43
    public static function str_contains_any(
5259
        string $haystack,
5260
        array $needles,
5261
        bool $caseSensitive = true
5262
    ): bool {
5263 43
        if ($haystack === '' || $needles === []) {
5264 1
            return false;
5265
        }
5266
5267
        /** @noinspection LoopWhichDoesNotLoopInspection */
5268 42
        foreach ($needles as &$needle) {
5269 42
            if (!$needle) {
5270
                return false;
5271
            }
5272
5273 42
            if ($caseSensitive) {
5274 22
                return \strpos($haystack, $needle) !== false;
5275
            }
5276
5277 20
            return \mb_stripos($haystack, $needle) !== false;
5278
        }
5279
5280
        return false;
5281
    }
5282
5283
    /**
5284
     * Returns a lowercase and trimmed string separated by dashes. Dashes are
5285
     * inserted before uppercase characters (with the exception of the first
5286
     * character of the string), and in place of spaces as well as underscores.
5287
     *
5288
     * @param string $str      <p>The input string.</p>
5289
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
5290
     *
5291
     * @return string
5292
     */
5293 19
    public static function str_dasherize(string $str, string $encoding = 'UTF-8'): string
5294
    {
5295 19
        return self::str_delimit($str, '-', $encoding);
5296
    }
5297
5298
    /**
5299
     * Returns a lowercase and trimmed string separated by the given delimiter.
5300
     * Delimiters are inserted before uppercase characters (with the exception
5301
     * of the first character of the string), and in place of spaces, dashes,
5302
     * and underscores. Alpha delimiters are not converted to lowercase.
5303
     *
5304
     * @param string      $str                   <p>The input string.</p>
5305
     * @param string      $delimiter             <p>Sequence used to separate parts of the string.</p>
5306
     * @param string      $encoding              [optional] <p>Set the charset for e.g. "mb_" function</p>
5307
     * @param bool        $cleanUtf8             [optional] <p>Remove non UTF-8 chars from the string.</p>
5308
     * @param string|null $lang                  [optional] <p>Set the language for special cases: az, el, lt,
5309
     *                                           tr</p>
5310
     * @param bool        $tryToKeepStringLength [optional] <p>true === try to keep the string length: e.g. ẞ ->
5311
     *                                           ß</p>
5312
     *
5313
     * @return string
5314
     */
5315 49
    public static function str_delimit(
5316
        string $str,
5317
        string $delimiter,
5318
        string $encoding = 'UTF-8',
5319
        bool $cleanUtf8 = false,
5320
        string $lang = null,
5321
        bool $tryToKeepStringLength = false
5322
    ): string {
5323 49
        if (self::$SUPPORT['mbstring'] === true) {
5324
            /** @noinspection PhpComposerExtensionStubsInspection */
5325 49
            $str = (string) \mb_ereg_replace('\B(\p{Lu})', '-\1', \trim($str));
5326
5327 49
            $useMbFunction = $lang === null && $tryToKeepStringLength === false;
5328 49
            if ($useMbFunction === true && $encoding === 'UTF-8') {
5329 22
                $str = \mb_strtolower($str);
5330
            } else {
5331 27
                $str = self::strtolower($str, $encoding, $cleanUtf8, $lang, $tryToKeepStringLength);
5332
            }
5333
5334
            /** @noinspection PhpComposerExtensionStubsInspection */
5335 49
            return (string) \mb_ereg_replace('[\-_\s]+', $delimiter, $str);
5336
        }
5337
5338
        $str = (string) \preg_replace('/\B(\p{Lu})/u', '-\1', \trim($str));
5339
5340
        $useMbFunction = $lang === null && $tryToKeepStringLength === false;
5341
        if ($useMbFunction === true && $encoding === 'UTF-8') {
5342
            $str = \mb_strtolower($str);
5343
        } else {
5344
            $str = self::strtolower($str, $encoding, $cleanUtf8, $lang, $tryToKeepStringLength);
5345
        }
5346
5347
        return (string) \preg_replace('/[\-_\s]+/u', $delimiter, $str);
5348
    }
5349
5350
    /**
5351
     * Optimized "mb_detect_encoding()"-function -> with support for UTF-16 and UTF-32.
5352
     *
5353
     * @param string $str <p>The input string.</p>
5354
     *
5355
     * @return false|string
5356
     *                      The detected string-encoding e.g. UTF-8 or UTF-16BE,<br>
5357
     *                      otherwise it will return false e.g. for BINARY or not detected encoding.
5358
     */
5359 30
    public static function str_detect_encoding($str)
5360
    {
5361
        // init
5362 30
        $str = (string) $str;
5363
5364
        //
5365
        // 1.) check binary strings (010001001...) like UTF-16 / UTF-32 / PDF / Images / ...
5366
        //
5367
5368 30
        if (self::is_binary($str, true) === true) {
5369 11
            $isUtf16 = self::is_utf16($str, false);
5370 11
            if ($isUtf16 === 1) {
5371 2
                return 'UTF-16LE';
5372
            }
5373 11
            if ($isUtf16 === 2) {
5374 2
                return 'UTF-16BE';
5375
            }
5376
5377 9
            $isUtf32 = self::is_utf32($str, false);
5378 9
            if ($isUtf32 === 1) {
5379
                return 'UTF-32LE';
5380
            }
5381 9
            if ($isUtf32 === 2) {
5382
                return 'UTF-32BE';
5383
            }
5384
5385
            // is binary but not "UTF-16" or "UTF-32"
5386 9
            return false;
5387
        }
5388
5389
        //
5390
        // 2.) simple check for ASCII chars
5391
        //
5392
5393 26
        if (self::is_ascii($str) === true) {
5394 10
            return 'ASCII';
5395
        }
5396
5397
        //
5398
        // 3.) simple check for UTF-8 chars
5399
        //
5400
5401 26
        if (self::is_utf8($str) === true) {
5402 19
            return 'UTF-8';
5403
        }
5404
5405
        //
5406
        // 4.) check via "mb_detect_encoding()"
5407
        //
5408
        // INFO: UTF-16, UTF-32, UCS2 and UCS4, encoding detection will fail always with "mb_detect_encoding()"
5409
5410
        $detectOrder = [
5411 15
            'ISO-8859-1',
5412
            'ISO-8859-2',
5413
            'ISO-8859-3',
5414
            'ISO-8859-4',
5415
            'ISO-8859-5',
5416
            'ISO-8859-6',
5417
            'ISO-8859-7',
5418
            'ISO-8859-8',
5419
            'ISO-8859-9',
5420
            'ISO-8859-10',
5421
            'ISO-8859-13',
5422
            'ISO-8859-14',
5423
            'ISO-8859-15',
5424
            'ISO-8859-16',
5425
            'WINDOWS-1251',
5426
            'WINDOWS-1252',
5427
            'WINDOWS-1254',
5428
            'CP932',
5429
            'CP936',
5430
            'CP950',
5431
            'CP866',
5432
            'CP850',
5433
            'CP51932',
5434
            'CP50220',
5435
            'CP50221',
5436
            'CP50222',
5437
            'ISO-2022-JP',
5438
            'ISO-2022-KR',
5439
            'JIS',
5440
            'JIS-ms',
5441
            'EUC-CN',
5442
            'EUC-JP',
5443
        ];
5444
5445 15
        if (self::$SUPPORT['mbstring'] === true) {
5446
            // info: do not use the symfony polyfill here
5447 15
            $encoding = \mb_detect_encoding($str, $detectOrder, true);
5448 15
            if ($encoding) {
5449 15
                return $encoding;
5450
            }
5451
        }
5452
5453
        //
5454
        // 5.) check via "iconv()"
5455
        //
5456
5457
        if (self::$ENCODINGS === null) {
5458
            self::$ENCODINGS = self::getData('encodings');
5459
        }
5460
5461
        foreach (self::$ENCODINGS as $encodingTmp) {
5462
            // INFO: //IGNORE but still throw notice
5463
            /** @noinspection PhpUsageOfSilenceOperatorInspection */
5464
            if ((string) @\iconv($encodingTmp, $encodingTmp . '//IGNORE', $str) === $str) {
5465
                return $encodingTmp;
5466
            }
5467
        }
5468
5469
        return false;
5470
    }
5471
5472
    /**
5473
     * alias for "UTF8::str_ends_with()"
5474
     *
5475
     * @param string $haystack
5476
     * @param string $needle
5477
     *
5478
     * @return bool
5479
     *
5480
     * @see UTF8::str_ends_with()
5481
     */
5482
    public static function str_ends(string $haystack, string $needle): bool
5483
    {
5484
        return self::str_ends_with($haystack, $needle);
5485
    }
5486
5487
    /**
5488
     * Check if the string ends with the given substring.
5489
     *
5490
     * @param string $haystack <p>The string to search in.</p>
5491
     * @param string $needle   <p>The substring to search for.</p>
5492
     *
5493
     * @return bool
5494
     */
5495 9
    public static function str_ends_with(string $haystack, string $needle): bool
5496
    {
5497 9
        if ($needle === '') {
5498 2
            return true;
5499
        }
5500
5501 9
        if ($haystack === '') {
5502
            return false;
5503
        }
5504
5505 9
        return \substr($haystack, -\strlen($needle)) === $needle;
5506
    }
5507
5508
    /**
5509
     * Returns true if the string ends with any of $substrings, false otherwise.
5510
     *
5511
     * - case-sensitive
5512
     *
5513
     * @param string   $str        <p>The input string.</p>
5514
     * @param string[] $substrings <p>Substrings to look for.</p>
5515
     *
5516
     * @return bool whether or not $str ends with $substring
5517
     */
5518 7
    public static function str_ends_with_any(string $str, array $substrings): bool
5519
    {
5520 7
        if ($substrings === []) {
5521
            return false;
5522
        }
5523
5524 7
        foreach ($substrings as &$substring) {
5525 7
            if (\substr($str, -\strlen($substring)) === $substring) {
5526 7
                return true;
5527
            }
5528
        }
5529
5530 6
        return false;
5531
    }
5532
5533
    /**
5534
     * Ensures that the string begins with $substring. If it doesn't, it's
5535
     * prepended.
5536
     *
5537
     * @param string $str       <p>The input string.</p>
5538
     * @param string $substring <p>The substring to add if not present.</p>
5539
     *
5540
     * @return string
5541
     */
5542 10
    public static function str_ensure_left(string $str, string $substring): string
5543
    {
5544
        if (
5545 10
            $substring !== ''
5546
            &&
5547 10
            \strpos($str, $substring) === 0
5548
        ) {
5549 6
            return $str;
5550
        }
5551
5552 4
        return $substring . $str;
5553
    }
5554
5555
    /**
5556
     * Ensures that the string ends with $substring. If it doesn't, it's appended.
5557
     *
5558
     * @param string $str       <p>The input string.</p>
5559
     * @param string $substring <p>The substring to add if not present.</p>
5560
     *
5561
     * @return string
5562
     */
5563 10
    public static function str_ensure_right(string $str, string $substring): string
5564
    {
5565
        if (
5566 10
            $str === ''
5567
            ||
5568 10
            $substring === ''
5569
            ||
5570 10
            \substr($str, -\strlen($substring)) !== $substring
5571
        ) {
5572 4
            $str .= $substring;
5573
        }
5574
5575 10
        return $str;
5576
    }
5577
5578
    /**
5579
     * Capitalizes the first word of the string, replaces underscores with
5580
     * spaces, and strips '_id'.
5581
     *
5582
     * @param string $str
5583
     *
5584
     * @return string
5585
     */
5586 3
    public static function str_humanize($str): string
5587
    {
5588 3
        $str = \str_replace(
5589
            [
5590 3
                '_id',
5591
                '_',
5592
            ],
5593
            [
5594 3
                '',
5595
                ' ',
5596
            ],
5597 3
            $str
5598
        );
5599
5600 3
        return self::ucfirst(\trim($str));
5601
    }
5602
5603
    /**
5604
     * alias for "UTF8::str_istarts_with()"
5605
     *
5606
     * @param string $haystack
5607
     * @param string $needle
5608
     *
5609
     * @return bool
5610
     *
5611
     * @see UTF8::str_istarts_with()
5612
     */
5613
    public static function str_ibegins(string $haystack, string $needle): bool
5614
    {
5615
        return self::str_istarts_with($haystack, $needle);
5616
    }
5617
5618
    /**
5619
     * alias for "UTF8::str_iends_with()"
5620
     *
5621
     * @param string $haystack
5622
     * @param string $needle
5623
     *
5624
     * @return bool
5625
     *
5626
     * @see UTF8::str_iends_with()
5627
     */
5628
    public static function str_iends(string $haystack, string $needle): bool
5629
    {
5630
        return self::str_iends_with($haystack, $needle);
5631
    }
5632
5633
    /**
5634
     * Check if the string ends with the given substring, case insensitive.
5635
     *
5636
     * @param string $haystack <p>The string to search in.</p>
5637
     * @param string $needle   <p>The substring to search for.</p>
5638
     *
5639
     * @return bool
5640
     */
5641 12
    public static function str_iends_with(string $haystack, string $needle): bool
5642
    {
5643 12
        if ($needle === '') {
5644 2
            return true;
5645
        }
5646
5647 12
        if ($haystack === '') {
5648
            return false;
5649
        }
5650
5651 12
        return self::strcasecmp(\substr($haystack, -\strlen($needle)), $needle) === 0;
5652
    }
5653
5654
    /**
5655
     * Returns true if the string ends with any of $substrings, false otherwise.
5656
     *
5657
     * - case-insensitive
5658
     *
5659
     * @param string   $str        <p>The input string.</p>
5660
     * @param string[] $substrings <p>Substrings to look for.</p>
5661
     *
5662
     * @return bool whether or not $str ends with $substring
5663
     */
5664 4
    public static function str_iends_with_any(string $str, array $substrings): bool
5665
    {
5666 4
        if ($substrings === []) {
5667
            return false;
5668
        }
5669
5670 4
        foreach ($substrings as &$substring) {
5671 4
            if (self::str_iends_with($str, $substring)) {
5672 4
                return true;
5673
            }
5674
        }
5675
5676
        return false;
5677
    }
5678
5679
    /**
5680
     * Returns the index of the first occurrence of $needle in the string,
5681
     * and false if not found. Accepts an optional offset from which to begin
5682
     * the search.
5683
     *
5684
     * @param string $str      <p>The input string.</p>
5685
     * @param string $needle   <p>Substring to look for.</p>
5686
     * @param int    $offset   [optional] <p>Offset from which to search. Default: 0</p>
5687
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
5688
     *
5689
     * @return false|int
5690
     *                   The occurrence's <strong>index</strong> if found, otherwise <strong>false</strong>
5691
     */
5692 2
    public static function str_iindex_first(
5693
        string $str,
5694
        string $needle,
5695
        int $offset = 0,
5696
        string $encoding = 'UTF-8'
5697
    ) {
5698 2
        return self::stripos(
5699 2
            $str,
5700 2
            $needle,
5701 2
            $offset,
5702 2
            $encoding
5703
        );
5704
    }
5705
5706
    /**
5707
     * Returns the index of the last occurrence of $needle in the string,
5708
     * and false if not found. Accepts an optional offset from which to begin
5709
     * the search. Offsets may be negative to count from the last character
5710
     * in the string.
5711
     *
5712
     * @param string $str      <p>The input string.</p>
5713
     * @param string $needle   <p>Substring to look for.</p>
5714
     * @param int    $offset   [optional] <p>Offset from which to search. Default: 0</p>
5715
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
5716
     *
5717
     * @return false|int
5718
     *                   The last occurrence's <strong>index</strong> if found, otherwise <strong>false</strong>
5719
     */
5720
    public static function str_iindex_last(
5721
        string $str,
5722
        string $needle,
5723
        int $offset = 0,
5724
        string $encoding = 'UTF-8'
5725
    ) {
5726
        return self::strripos(
5727
            $str,
5728
            $needle,
5729
            $offset,
5730
            $encoding
5731
        );
5732
    }
5733
5734
    /**
5735
     * Returns the index of the first occurrence of $needle in the string,
5736
     * and false if not found. Accepts an optional offset from which to begin
5737
     * the search.
5738
     *
5739
     * @param string $str      <p>The input string.</p>
5740
     * @param string $needle   <p>Substring to look for.</p>
5741
     * @param int    $offset   [optional] <p>Offset from which to search. Default: 0</p>
5742
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
5743
     *
5744
     * @return false|int
5745
     *                   The occurrence's <strong>index</strong> if found, otherwise <strong>false</strong>
5746
     */
5747 10
    public static function str_index_first(
5748
        string $str,
5749
        string $needle,
5750
        int $offset = 0,
5751
        string $encoding = 'UTF-8'
5752
    ) {
5753 10
        return self::strpos(
5754 10
            $str,
5755 10
            $needle,
5756 10
            $offset,
5757 10
            $encoding
5758
        );
5759
    }
5760
5761
    /**
5762
     * Returns the index of the last occurrence of $needle in the string,
5763
     * and false if not found. Accepts an optional offset from which to begin
5764
     * the search. Offsets may be negative to count from the last character
5765
     * in the string.
5766
     *
5767
     * @param string $str      <p>The input string.</p>
5768
     * @param string $needle   <p>Substring to look for.</p>
5769
     * @param int    $offset   [optional] <p>Offset from which to search. Default: 0</p>
5770
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
5771
     *
5772
     * @return false|int
5773
     *                   The last occurrence's <strong>index</strong> if found, otherwise <strong>false</strong>
5774
     */
5775 10
    public static function str_index_last(
5776
        string $str,
5777
        string $needle,
5778
        int $offset = 0,
5779
        string $encoding = 'UTF-8'
5780
    ) {
5781 10
        return self::strrpos(
5782 10
            $str,
5783 10
            $needle,
5784 10
            $offset,
5785 10
            $encoding
5786
        );
5787
    }
5788
5789
    /**
5790
     * Inserts $substring into the string at the $index provided.
5791
     *
5792
     * @param string $str       <p>The input string.</p>
5793
     * @param string $substring <p>String to be inserted.</p>
5794
     * @param int    $index     <p>The index at which to insert the substring.</p>
5795
     * @param string $encoding  [optional] <p>Set the charset for e.g. "mb_" function</p>
5796
     *
5797
     * @return string
5798
     */
5799 8
    public static function str_insert(
5800
        string $str,
5801
        string $substring,
5802
        int $index,
5803
        string $encoding = 'UTF-8'
5804
    ): string {
5805 8
        if ($encoding === 'UTF-8') {
5806 4
            $len = (int) \mb_strlen($str);
5807 4
            if ($index > $len) {
5808
                return $str;
5809
            }
5810
5811
            /** @noinspection UnnecessaryCastingInspection */
5812 4
            return (string) \mb_substr($str, 0, $index) .
5813 4
                   $substring .
5814 4
                   (string) \mb_substr($str, $index, $len);
5815
        }
5816
5817 4
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
5818
5819 4
        $len = (int) self::strlen($str, $encoding);
5820 4
        if ($index > $len) {
5821 1
            return $str;
5822
        }
5823
5824 3
        return ((string) self::substr($str, 0, $index, $encoding)) .
5825 3
               $substring .
5826 3
               ((string) self::substr($str, $index, $len, $encoding));
5827
    }
5828
5829
    /**
5830
     * Case-insensitive and UTF-8 safe version of <function>str_replace</function>.
5831
     *
5832
     * @see http://php.net/manual/en/function.str-ireplace.php
5833
     *
5834
     * @param mixed $search  <p>
5835
     *                       Every replacement with search array is
5836
     *                       performed on the result of previous replacement.
5837
     *                       </p>
5838
     * @param mixed $replace <p>
5839
     *                       </p>
5840
     * @param mixed $subject <p>
5841
     *                       If subject is an array, then the search and
5842
     *                       replace is performed with every entry of
5843
     *                       subject, and the return value is an array as
5844
     *                       well.
5845
     *                       </p>
5846
     * @param int   $count   [optional] <p>
5847
     *                       The number of matched and replaced needles will
5848
     *                       be returned in count which is passed by
5849
     *                       reference.
5850
     *                       </p>
5851
     *
5852
     * @return mixed a string or an array of replacements
5853
     */
5854 29
    public static function str_ireplace($search, $replace, $subject, &$count = null)
5855
    {
5856 29
        $search = (array) $search;
5857
5858
        /** @noinspection AlterInForeachInspection */
5859 29
        foreach ($search as &$s) {
5860 29
            $s = (string) $s;
5861 29
            if ($s === '') {
5862 6
                $s = '/^(?<=.)$/';
5863
            } else {
5864 29
                $s = '/' . \preg_quote($s, '/') . '/ui';
5865
            }
5866
        }
5867
5868 29
        $subject = \preg_replace($search, $replace, $subject, -1, $replace);
5869 29
        $count = $replace; // used as reference parameter
5870
5871 29
        return $subject;
5872
    }
5873
5874
    /**
5875
     * Replaces $search from the beginning of string with $replacement.
5876
     *
5877
     * @param string $str         <p>The input string.</p>
5878
     * @param string $search      <p>The string to search for.</p>
5879
     * @param string $replacement <p>The replacement.</p>
5880
     *
5881
     * @return string string after the replacements
5882
     */
5883 17
    public static function str_ireplace_beginning(string $str, string $search, string $replacement): string
5884
    {
5885 17
        if ($str === '') {
5886 4
            if ($replacement === '') {
5887 2
                return '';
5888
            }
5889
5890 2
            if ($search === '') {
5891 2
                return $replacement;
5892
            }
5893
        }
5894
5895 13
        if ($search === '') {
5896 2
            return $str . $replacement;
5897
        }
5898
5899 11
        if (\stripos($str, $search) === 0) {
5900 10
            return $replacement . \substr($str, \strlen($search));
5901
        }
5902
5903 1
        return $str;
5904
    }
5905
5906
    /**
5907
     * Replaces $search from the ending of string with $replacement.
5908
     *
5909
     * @param string $str         <p>The input string.</p>
5910
     * @param string $search      <p>The string to search for.</p>
5911
     * @param string $replacement <p>The replacement.</p>
5912
     *
5913
     * @return string string after the replacements
5914
     */
5915 17
    public static function str_ireplace_ending(string $str, string $search, string $replacement): string
5916
    {
5917 17
        if ($str === '') {
5918 4
            if ($replacement === '') {
5919 2
                return '';
5920
            }
5921
5922 2
            if ($search === '') {
5923 2
                return $replacement;
5924
            }
5925
        }
5926
5927 13
        if ($search === '') {
5928 2
            return $str . $replacement;
5929
        }
5930
5931 11
        if (\stripos($str, $search, \strlen($str) - \strlen($search)) !== false) {
5932 9
            $str = \substr($str, 0, -\strlen($search)) . $replacement;
5933
        }
5934
5935 11
        return $str;
5936
    }
5937
5938
    /**
5939
     * Check if the string starts with the given substring, case insensitive.
5940
     *
5941
     * @param string $haystack <p>The string to search in.</p>
5942
     * @param string $needle   <p>The substring to search for.</p>
5943
     *
5944
     * @return bool
5945
     */
5946 12
    public static function str_istarts_with(string $haystack, string $needle): bool
5947
    {
5948 12
        if ($needle === '') {
5949 2
            return true;
5950
        }
5951
5952 12
        if ($haystack === '') {
5953
            return false;
5954
        }
5955
5956 12
        return self::stripos($haystack, $needle) === 0;
5957
    }
5958
5959
    /**
5960
     * Returns true if the string begins with any of $substrings, false otherwise.
5961
     *
5962
     * - case-insensitive
5963
     *
5964
     * @param string $str        <p>The input string.</p>
5965
     * @param array  $substrings <p>Substrings to look for.</p>
5966
     *
5967
     * @return bool whether or not $str starts with $substring
5968
     */
5969 4
    public static function str_istarts_with_any(string $str, array $substrings): bool
5970
    {
5971 4
        if ($str === '') {
5972
            return false;
5973
        }
5974
5975 4
        if ($substrings === []) {
5976
            return false;
5977
        }
5978
5979 4
        foreach ($substrings as &$substring) {
5980 4
            if (self::str_istarts_with($str, $substring)) {
5981 4
                return true;
5982
            }
5983
        }
5984
5985
        return false;
5986
    }
5987
5988
    /**
5989
     * Gets the substring after the first occurrence of a separator.
5990
     *
5991
     * @param string $str       <p>The input string.</p>
5992
     * @param string $separator <p>The string separator.</p>
5993
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
5994
     *
5995
     * @return string
5996
     */
5997 1
    public static function str_isubstr_after_first_separator(string $str, string $separator, string $encoding = 'UTF-8'): string
5998
    {
5999 1
        if ($separator === '' || $str === '') {
6000 1
            return '';
6001
        }
6002
6003 1
        $offset = self::str_iindex_first($str, $separator);
6004 1
        if ($offset === false) {
6005 1
            return '';
6006
        }
6007
6008 1
        if ($encoding === 'UTF-8') {
6009 1
            return (string) \mb_substr(
6010 1
                $str,
6011 1
                $offset + (int) \mb_strlen($separator)
6012
            );
6013
        }
6014
6015
        return (string) self::substr(
6016
            $str,
6017
            $offset + (int) self::strlen($separator, $encoding),
6018
            null,
6019
            $encoding
6020
        );
6021
    }
6022
6023
    /**
6024
     * Gets the substring after the last occurrence of a separator.
6025
     *
6026
     * @param string $str       <p>The input string.</p>
6027
     * @param string $separator <p>The string separator.</p>
6028
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
6029
     *
6030
     * @return string
6031
     */
6032 1
    public static function str_isubstr_after_last_separator(string $str, string $separator, string $encoding = 'UTF-8'): string
6033
    {
6034 1
        if ($separator === '' || $str === '') {
6035 1
            return '';
6036
        }
6037
6038 1
        $offset = self::strripos($str, $separator);
6039 1
        if ($offset === false) {
6040 1
            return '';
6041
        }
6042
6043 1
        if ($encoding === 'UTF-8') {
6044 1
            return (string) \mb_substr(
6045 1
                $str,
6046 1
                $offset + (int) self::strlen($separator)
6047
            );
6048
        }
6049
6050
        return (string) self::substr(
6051
            $str,
6052
            $offset + (int) self::strlen($separator, $encoding),
6053
            null,
6054
            $encoding
6055
        );
6056
    }
6057
6058
    /**
6059
     * Gets the substring before the first occurrence of a separator.
6060
     *
6061
     * @param string $str       <p>The input string.</p>
6062
     * @param string $separator <p>The string separator.</p>
6063
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
6064
     *
6065
     * @return string
6066
     */
6067 1
    public static function str_isubstr_before_first_separator(string $str, string $separator, string $encoding = 'UTF-8'): string
6068
    {
6069 1
        if ($separator === '' || $str === '') {
6070 1
            return '';
6071
        }
6072
6073 1
        $offset = self::str_iindex_first($str, $separator);
6074 1
        if ($offset === false) {
6075 1
            return '';
6076
        }
6077
6078 1
        if ($encoding === 'UTF-8') {
6079 1
            return (string) \mb_substr($str, 0, $offset);
6080
        }
6081
6082
        return (string) self::substr($str, 0, $offset, $encoding);
6083
    }
6084
6085
    /**
6086
     * Gets the substring before the last occurrence of a separator.
6087
     *
6088
     * @param string $str       <p>The input string.</p>
6089
     * @param string $separator <p>The string separator.</p>
6090
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
6091
     *
6092
     * @return string
6093
     */
6094 1
    public static function str_isubstr_before_last_separator(string $str, string $separator, string $encoding = 'UTF-8'): string
6095
    {
6096 1
        if ($separator === '' || $str === '') {
6097 1
            return '';
6098
        }
6099
6100 1
        if ($encoding === 'UTF-8') {
6101 1
            $offset = \mb_strripos($str, $separator);
6102 1
            if ($offset === false) {
6103 1
                return '';
6104
            }
6105
6106 1
            return (string) \mb_substr($str, 0, $offset);
6107
        }
6108
6109
        $offset = self::strripos($str, $separator, 0, $encoding);
6110
        if ($offset === false) {
6111
            return '';
6112
        }
6113
6114
        return (string) self::substr($str, 0, $offset, $encoding);
6115
    }
6116
6117
    /**
6118
     * Gets the substring after (or before via "$beforeNeedle") the first occurrence of the "$needle".
6119
     *
6120
     * @param string $str          <p>The input string.</p>
6121
     * @param string $needle       <p>The string to look for.</p>
6122
     * @param bool   $beforeNeedle [optional] <p>Default: false</p>
6123
     * @param string $encoding     [optional] <p>Default: 'UTF-8'</p>
6124
     *
6125
     * @return string
6126
     */
6127 2
    public static function str_isubstr_first(
6128
        string $str,
6129
        string $needle,
6130
        bool $beforeNeedle = false,
6131
        string $encoding = 'UTF-8'
6132
    ): string {
6133
        if (
6134 2
            $needle === ''
6135
            ||
6136 2
            $str === ''
6137
        ) {
6138 2
            return '';
6139
        }
6140
6141 2
        $part = self::stristr(
6142 2
            $str,
6143 2
            $needle,
6144 2
            $beforeNeedle,
6145 2
            $encoding
6146
        );
6147 2
        if ($part === false) {
6148 2
            return '';
6149
        }
6150
6151 2
        return $part;
6152
    }
6153
6154
    /**
6155
     * Gets the substring after (or before via "$beforeNeedle") the last occurrence of the "$needle".
6156
     *
6157
     * @param string $str          <p>The input string.</p>
6158
     * @param string $needle       <p>The string to look for.</p>
6159
     * @param bool   $beforeNeedle [optional] <p>Default: false</p>
6160
     * @param string $encoding     [optional] <p>Default: 'UTF-8'</p>
6161
     *
6162
     * @return string
6163
     */
6164 1
    public static function str_isubstr_last(
6165
        string $str,
6166
        string $needle,
6167
        bool $beforeNeedle = false,
6168
        string $encoding = 'UTF-8'
6169
    ): string {
6170
        if (
6171 1
            $needle === ''
6172
            ||
6173 1
            $str === ''
6174
        ) {
6175 1
            return '';
6176
        }
6177
6178 1
        $part = self::strrichr($str, $needle, $beforeNeedle, $encoding);
6179 1
        if ($part === false) {
6180 1
            return '';
6181
        }
6182
6183 1
        return $part;
6184
    }
6185
6186
    /**
6187
     * Returns the last $n characters of the string.
6188
     *
6189
     * @param string $str      <p>The input string.</p>
6190
     * @param int    $n        <p>Number of characters to retrieve from the end.</p>
6191
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6192
     *
6193
     * @return string
6194
     */
6195 12
    public static function str_last_char(string $str, int $n = 1, string $encoding = 'UTF-8'): string
6196
    {
6197 12
        if ($str === '' || $n <= 0) {
6198 4
            return '';
6199
        }
6200
6201 8
        if ($encoding === 'UTF-8') {
6202 4
            return (string) \mb_substr($str, -$n);
6203
        }
6204
6205 4
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
6206
6207 4
        return (string) self::substr($str, -$n, null, $encoding);
6208
    }
6209
6210
    /**
6211
     * Limit the number of characters in a string.
6212
     *
6213
     * @param string $str      <p>The input string.</p>
6214
     * @param int    $length   [optional] <p>Default: 100</p>
6215
     * @param string $strAddOn [optional] <p>Default: …</p>
6216
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6217
     *
6218
     * @return string
6219
     */
6220 2
    public static function str_limit(
6221
        string $str,
6222
        int $length = 100,
6223
        string $strAddOn = '…',
6224
        string $encoding = 'UTF-8'
6225
    ): string {
6226 2
        if ($str === '' || $length <= 0) {
6227 2
            return '';
6228
        }
6229
6230 2
        if ($encoding === 'UTF-8') {
6231 2
            if ((int) \mb_strlen($str) <= $length) {
6232 2
                return $str;
6233
            }
6234
6235
            /** @noinspection UnnecessaryCastingInspection */
6236 2
            return (string) \mb_substr($str, 0, $length - (int) self::strlen($strAddOn)) . $strAddOn;
6237
        }
6238
6239
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
6240
6241
        if ((int) self::strlen($str, $encoding) <= $length) {
6242
            return $str;
6243
        }
6244
6245
        return ((string) self::substr($str, 0, $length - (int) self::strlen($strAddOn), $encoding)) . $strAddOn;
6246
    }
6247
6248
    /**
6249
     * Limit the number of characters in a string, but also after the next word.
6250
     *
6251
     * @param string $str      <p>The input string.</p>
6252
     * @param int    $length   [optional] <p>Default: 100</p>
6253
     * @param string $strAddOn [optional] <p>Default: …</p>
6254
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6255
     *
6256
     * @return string
6257
     */
6258 6
    public static function str_limit_after_word(
6259
        string $str,
6260
        int $length = 100,
6261
        string $strAddOn = '…',
6262
        string $encoding = 'UTF-8'
6263
    ): string {
6264 6
        if ($str === '' || $length <= 0) {
6265 2
            return '';
6266
        }
6267
6268 6
        if ($encoding === 'UTF-8') {
6269
            /** @noinspection UnnecessaryCastingInspection */
6270 2
            if ((int) \mb_strlen($str) <= $length) {
6271 2
                return $str;
6272
            }
6273
6274 2
            if (\mb_substr($str, $length - 1, 1) === ' ') {
6275 2
                return ((string) \mb_substr($str, 0, $length - 1)) . $strAddOn;
6276
            }
6277
6278 2
            $str = \mb_substr($str, 0, $length);
6279
6280 2
            $array = \explode(' ', $str);
6281 2
            \array_pop($array);
6282 2
            $new_str = \implode(' ', $array);
6283
6284 2
            if ($new_str === '') {
6285 2
                return ((string) \mb_substr($str, 0, $length - 1)) . $strAddOn;
6286
            }
6287
        } else {
6288 4
            if ((int) self::strlen($str, $encoding) <= $length) {
6289
                return $str;
6290
            }
6291
6292 4
            if (self::substr($str, $length - 1, 1, $encoding) === ' ') {
6293 3
                return ((string) self::substr($str, 0, $length - 1, $encoding)) . $strAddOn;
6294
            }
6295
6296 1
            $str = self::substr($str, 0, $length, $encoding);
6297 1
            if ($str === false) {
6298
                return '' . $strAddOn;
6299
            }
6300
6301 1
            $array = \explode(' ', $str);
6302 1
            \array_pop($array);
6303 1
            $new_str = \implode(' ', $array);
6304
6305 1
            if ($new_str === '') {
6306
                return ((string) self::substr($str, 0, $length - 1, $encoding)) . $strAddOn;
6307
            }
6308
        }
6309
6310 3
        return $new_str . $strAddOn;
6311
    }
6312
6313
    /**
6314
     * Returns the longest common prefix between the string and $otherStr.
6315
     *
6316
     * @param string $str      <p>The input sting.</p>
6317
     * @param string $otherStr <p>Second string for comparison.</p>
6318
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6319
     *
6320
     * @return string
6321
     */
6322 10
    public static function str_longest_common_prefix(string $str, string $otherStr, string $encoding = 'UTF-8'): string
6323
    {
6324
        // init
6325 10
        $longestCommonPrefix = '';
6326
6327 10
        if ($encoding === 'UTF-8') {
6328 5
            $maxLength = (int) \min(
6329 5
                \mb_strlen($str),
6330 5
                \mb_strlen($otherStr)
6331
            );
6332
6333 5
            for ($i = 0; $i < $maxLength; ++$i) {
6334 4
                $char = \mb_substr($str, $i, 1);
6335
6336
                if (
6337 4
                    $char !== false
6338
                    &&
6339 4
                    $char === \mb_substr($otherStr, $i, 1)
6340
                ) {
6341 3
                    $longestCommonPrefix .= $char;
6342
                } else {
6343 3
                    break;
6344
                }
6345
            }
6346
        } else {
6347 5
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
6348
6349 5
            $maxLength = (int) \min(
6350 5
                self::strlen($str, $encoding),
6351 5
                self::strlen($otherStr, $encoding)
6352
            );
6353
6354 5
            for ($i = 0; $i < $maxLength; ++$i) {
6355 4
                $char = self::substr($str, $i, 1, $encoding);
6356
6357
                if (
6358 4
                    $char !== false
6359
                    &&
6360 4
                    $char === self::substr($otherStr, $i, 1, $encoding)
6361
                ) {
6362 3
                    $longestCommonPrefix .= $char;
6363
                } else {
6364 3
                    break;
6365
                }
6366
            }
6367
        }
6368
6369 10
        return $longestCommonPrefix;
6370
    }
6371
6372
    /**
6373
     * Returns the longest common substring between the string and $otherStr.
6374
     * In the case of ties, it returns that which occurs first.
6375
     *
6376
     * @param string $str
6377
     * @param string $otherStr <p>Second string for comparison.</p>
6378
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6379
     *
6380
     * @return string string with its $str being the longest common substring
6381
     */
6382 11
    public static function str_longest_common_substring(string $str, string $otherStr, string $encoding = 'UTF-8'): string
6383
    {
6384 11
        if ($str === '' || $otherStr === '') {
6385 2
            return '';
6386
        }
6387
6388
        // Uses dynamic programming to solve
6389
        // http://en.wikipedia.org/wiki/Longest_common_substring_problem
6390
6391 9
        if ($encoding === 'UTF-8') {
6392 4
            $strLength = (int) \mb_strlen($str);
6393 4
            $otherLength = (int) \mb_strlen($otherStr);
6394
        } else {
6395 5
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
6396
6397 5
            $strLength = (int) self::strlen($str, $encoding);
6398 5
            $otherLength = (int) self::strlen($otherStr, $encoding);
6399
        }
6400
6401
        // Return if either string is empty
6402 9
        if ($strLength === 0 || $otherLength === 0) {
6403
            return '';
6404
        }
6405
6406 9
        $len = 0;
6407 9
        $end = 0;
6408 9
        $table = \array_fill(
6409 9
            0,
6410 9
            $strLength + 1,
6411 9
            \array_fill(0, $otherLength + 1, 0)
6412
        );
6413
6414 9
        if ($encoding === 'UTF-8') {
6415 9
            for ($i = 1; $i <= $strLength; ++$i) {
6416 9
                for ($j = 1; $j <= $otherLength; ++$j) {
6417 9
                    $strChar = \mb_substr($str, $i - 1, 1);
6418 9
                    $otherChar = \mb_substr($otherStr, $j - 1, 1);
6419
6420 9
                    if ($strChar === $otherChar) {
6421 8
                        $table[$i][$j] = $table[$i - 1][$j - 1] + 1;
6422 8
                        if ($table[$i][$j] > $len) {
6423 8
                            $len = $table[$i][$j];
6424 8
                            $end = $i;
6425
                        }
6426
                    } else {
6427 9
                        $table[$i][$j] = 0;
6428
                    }
6429
                }
6430
            }
6431
        } else {
6432
            for ($i = 1; $i <= $strLength; ++$i) {
6433
                for ($j = 1; $j <= $otherLength; ++$j) {
6434
                    $strChar = self::substr($str, $i - 1, 1, $encoding);
6435
                    $otherChar = self::substr($otherStr, $j - 1, 1, $encoding);
6436
6437
                    if ($strChar === $otherChar) {
6438
                        $table[$i][$j] = $table[$i - 1][$j - 1] + 1;
6439
                        if ($table[$i][$j] > $len) {
6440
                            $len = $table[$i][$j];
6441
                            $end = $i;
6442
                        }
6443
                    } else {
6444
                        $table[$i][$j] = 0;
6445
                    }
6446
                }
6447
            }
6448
        }
6449
6450 9
        if ($encoding === 'UTF-8') {
6451 9
            return (string) \mb_substr($str, $end - $len, $len);
6452
        }
6453
6454
        return (string) self::substr($str, $end - $len, $len, $encoding);
6455
    }
6456
6457
    /**
6458
     * Returns the longest common suffix between the string and $otherStr.
6459
     *
6460
     * @param string $str
6461
     * @param string $otherStr <p>Second string for comparison.</p>
6462
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6463
     *
6464
     * @return string
6465
     */
6466 10
    public static function str_longest_common_suffix(string $str, string $otherStr, string $encoding = 'UTF-8'): string
6467
    {
6468 10
        if ($str === '' || $otherStr === '') {
6469 2
            return '';
6470
        }
6471
6472 8
        if ($encoding === 'UTF-8') {
6473 4
            $maxLength = (int) \min(
6474 4
                \mb_strlen($str, $encoding),
6475 4
                \mb_strlen($otherStr, $encoding)
6476
            );
6477
6478 4
            $longestCommonSuffix = '';
6479 4
            for ($i = 1; $i <= $maxLength; ++$i) {
6480 4
                $char = \mb_substr($str, -$i, 1);
6481
6482
                if (
6483 4
                    $char !== false
6484
                    &&
6485 4
                    $char === \mb_substr($otherStr, -$i, 1)
6486
                ) {
6487 3
                    $longestCommonSuffix = $char . $longestCommonSuffix;
6488
                } else {
6489 3
                    break;
6490
                }
6491
            }
6492
        } else {
6493 4
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
6494
6495 4
            $maxLength = (int) \min(
6496 4
                self::strlen($str, $encoding),
6497 4
                self::strlen($otherStr, $encoding)
6498
            );
6499
6500 4
            $longestCommonSuffix = '';
6501 4
            for ($i = 1; $i <= $maxLength; ++$i) {
6502 4
                $char = self::substr($str, -$i, 1, $encoding);
6503
6504
                if (
6505 4
                    $char !== false
6506
                    &&
6507 4
                    $char === self::substr($otherStr, -$i, 1, $encoding)
6508
                ) {
6509 3
                    $longestCommonSuffix = $char . $longestCommonSuffix;
6510
                } else {
6511 3
                    break;
6512
                }
6513
            }
6514
        }
6515
6516 8
        return $longestCommonSuffix;
6517
    }
6518
6519
    /**
6520
     * Returns true if $str matches the supplied pattern, false otherwise.
6521
     *
6522
     * @param string $str     <p>The input string.</p>
6523
     * @param string $pattern <p>Regex pattern to match against.</p>
6524
     *
6525
     * @return bool whether or not $str matches the pattern
6526
     */
6527
    public static function str_matches_pattern(string $str, string $pattern): bool
6528
    {
6529
        return (bool) \preg_match('/' . $pattern . '/u', $str);
6530
    }
6531
6532
    /**
6533
     * Returns whether or not a character exists at an index. Offsets may be
6534
     * negative to count from the last character in the string. Implements
6535
     * part of the ArrayAccess interface.
6536
     *
6537
     * @param string $str      <p>The input string.</p>
6538
     * @param int    $offset   <p>The index to check.</p>
6539
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6540
     *
6541
     * @return bool whether or not the index exists
6542
     */
6543 6
    public static function str_offset_exists(string $str, int $offset, string $encoding = 'UTF-8'): bool
6544
    {
6545
        // init
6546 6
        $length = (int) self::strlen($str, $encoding);
6547
6548 6
        if ($offset >= 0) {
6549 3
            return $length > $offset;
6550
        }
6551
6552 3
        return $length >= \abs($offset);
6553
    }
6554
6555
    /**
6556
     * Returns the character at the given index. Offsets may be negative to
6557
     * count from the last character in the string. Implements part of the
6558
     * ArrayAccess interface, and throws an OutOfBoundsException if the index
6559
     * does not exist.
6560
     *
6561
     * @param string $str      <p>The input string.</p>
6562
     * @param int    $index    <p>The <strong>index</strong> from which to retrieve the char.</p>
6563
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6564
     *
6565
     * @throws \OutOfBoundsException if the positive or negative offset does not exist
6566
     *
6567
     * @return string the character at the specified index
6568
     */
6569 2
    public static function str_offset_get(string $str, int $index, string $encoding = 'UTF-8'): string
6570
    {
6571
        // init
6572 2
        $length = (int) self::strlen($str);
6573
6574
        if (
6575 2
            ($index >= 0 && $length <= $index)
6576
            ||
6577 2
            $length < \abs($index)
6578
        ) {
6579 1
            throw new \OutOfBoundsException('No character exists at the index');
6580
        }
6581
6582 1
        return self::char_at($str, $index, $encoding);
6583
    }
6584
6585
    /**
6586
     * Pad a UTF-8 string to given length with another string.
6587
     *
6588
     * @param string     $str        <p>The input string.</p>
6589
     * @param int        $pad_length <p>The length of return string.</p>
6590
     * @param string     $pad_string [optional] <p>String to use for padding the input string.</p>
6591
     * @param int|string $pad_type   [optional] <p>
6592
     *                               Can be <strong>STR_PAD_RIGHT</strong> (default), [or string "right"]<br>
6593
     *                               <strong>STR_PAD_LEFT</strong> [or string "left"] or<br>
6594
     *                               <strong>STR_PAD_BOTH</strong> [or string "both"]
6595
     *                               </p>
6596
     * @param string     $encoding   [optional] <p>Default: 'UTF-8'</p>
6597
     *
6598
     * @return string returns the padded string
6599
     */
6600 41
    public static function str_pad(
6601
        string $str,
6602
        int $pad_length,
6603
        string $pad_string = ' ',
6604
        $pad_type = \STR_PAD_RIGHT,
6605
        string $encoding = 'UTF-8'
6606
    ): string {
6607 41
        if ($pad_length === 0 || $pad_string === '') {
6608 1
            return $str;
6609
        }
6610
6611 41
        if ($pad_type !== (int) $pad_type) {
6612 13
            if ($pad_type === 'left') {
6613 3
                $pad_type = \STR_PAD_LEFT;
6614 10
            } elseif ($pad_type === 'right') {
6615 6
                $pad_type = \STR_PAD_RIGHT;
6616 4
            } elseif ($pad_type === 'both') {
6617 3
                $pad_type = \STR_PAD_BOTH;
6618
            } else {
6619 1
                throw new \InvalidArgumentException(
6620 1
                    'Pad expects $padType to be "STR_PAD_*" or ' . "to be one of 'left', 'right' or 'both'"
6621
                );
6622
            }
6623
        }
6624
6625 40
        if ($encoding === 'UTF-8') {
6626 25
            $str_length = (int) \mb_strlen($str);
6627
6628 25
            if ($pad_length >= $str_length) {
6629
                switch ($pad_type) {
6630 25
                    case \STR_PAD_LEFT:
6631 8
                        $ps_length = (int) \mb_strlen($pad_string);
6632
6633 8
                        $diff = ($pad_length - $str_length);
6634
6635 8
                        $pre = (string) \mb_substr(
6636 8
                            \str_repeat($pad_string, (int) \ceil($diff / $ps_length)),
6637 8
                            0,
6638 8
                            $diff
6639
                        );
6640 8
                        $post = '';
6641
6642 8
                        break;
6643
6644 20
                    case \STR_PAD_BOTH:
6645 14
                        $diff = ($pad_length - $str_length);
6646
6647 14
                        $ps_length_left = (int) \floor($diff / 2);
6648
6649 14
                        $ps_length_right = (int) \ceil($diff / 2);
6650
6651 14
                        $pre = (string) \mb_substr(
6652 14
                            \str_repeat($pad_string, $ps_length_left),
6653 14
                            0,
6654 14
                            $ps_length_left
6655
                        );
6656 14
                        $post = (string) \mb_substr(
6657 14
                            \str_repeat($pad_string, $ps_length_right),
6658 14
                            0,
6659 14
                            $ps_length_right
6660
                        );
6661
6662 14
                        break;
6663
6664 9
                    case \STR_PAD_RIGHT:
6665
                    default:
6666 9
                        $ps_length = (int) \mb_strlen($pad_string);
6667
6668 9
                        $diff = ($pad_length - $str_length);
6669
6670 9
                        $post = (string) \mb_substr(
6671 9
                            \str_repeat($pad_string, (int) \ceil($diff / $ps_length)),
6672 9
                            0,
6673 9
                            $diff
6674
                        );
6675 9
                        $pre = '';
6676
                }
6677
6678 25
                return $pre . $str . $post;
6679
            }
6680
6681 3
            return $str;
6682
        }
6683
6684 15
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
6685
6686 15
        $str_length = (int) self::strlen($str, $encoding);
6687
6688 15
        if ($pad_length >= $str_length) {
6689
            switch ($pad_type) {
6690 14
                case \STR_PAD_LEFT:
6691 5
                    $ps_length = (int) self::strlen($pad_string, $encoding);
6692
6693 5
                    $diff = ($pad_length - $str_length);
6694
6695 5
                    $pre = (string) self::substr(
6696 5
                        \str_repeat($pad_string, (int) \ceil($diff / $ps_length)),
6697 5
                        0,
6698 5
                        $diff,
6699 5
                        $encoding
6700
                    );
6701 5
                    $post = '';
6702
6703 5
                    break;
6704
6705 9
                case \STR_PAD_BOTH:
6706 3
                    $diff = ($pad_length - $str_length);
6707
6708 3
                    $ps_length_left = (int) \floor($diff / 2);
6709
6710 3
                    $ps_length_right = (int) \ceil($diff / 2);
6711
6712 3
                    $pre = (string) self::substr(
6713 3
                        \str_repeat($pad_string, $ps_length_left),
6714 3
                        0,
6715 3
                        $ps_length_left,
6716 3
                        $encoding
6717
                    );
6718 3
                    $post = (string) self::substr(
6719 3
                        \str_repeat($pad_string, $ps_length_right),
6720 3
                        0,
6721 3
                        $ps_length_right,
6722 3
                        $encoding
6723
                    );
6724
6725 3
                    break;
6726
6727 6
                case \STR_PAD_RIGHT:
6728
                default:
6729 6
                    $ps_length = (int) self::strlen($pad_string, $encoding);
6730
6731 6
                    $diff = ($pad_length - $str_length);
6732
6733 6
                    $post = (string) self::substr(
6734 6
                        \str_repeat($pad_string, (int) \ceil($diff / $ps_length)),
6735 6
                        0,
6736 6
                        $diff,
6737 6
                        $encoding
6738
                    );
6739 6
                    $pre = '';
6740
            }
6741
6742 14
            return $pre . $str . $post;
6743
        }
6744
6745 1
        return $str;
6746
    }
6747
6748
    /**
6749
     * Returns a new string of a given length such that both sides of the
6750
     * string are padded. Alias for pad() with a $padType of 'both'.
6751
     *
6752
     * @param string $str
6753
     * @param int    $length   <p>Desired string length after padding.</p>
6754
     * @param string $padStr   [optional] <p>String used to pad, defaults to space. Default: ' '</p>
6755
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6756
     *
6757
     * @return string string with padding applied
6758
     */
6759 11
    public static function str_pad_both(
6760
        string $str,
6761
        int $length,
6762
        string $padStr = ' ',
6763
        string $encoding = 'UTF-8'
6764
    ): string {
6765 11
        return self::str_pad($str, $length, $padStr, \STR_PAD_BOTH, $encoding);
6766
    }
6767
6768
    /**
6769
     * Returns a new string of a given length such that the beginning of the
6770
     * string is padded. Alias for pad() with a $padType of 'left'.
6771
     *
6772
     * @param string $str
6773
     * @param int    $length   <p>Desired string length after padding.</p>
6774
     * @param string $padStr   [optional] <p>String used to pad, defaults to space. Default: ' '</p>
6775
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6776
     *
6777
     * @return string string with left padding
6778
     */
6779 7
    public static function str_pad_left(
6780
        string $str,
6781
        int $length,
6782
        string $padStr = ' ',
6783
        string $encoding = 'UTF-8'
6784
    ): string {
6785 7
        return self::str_pad($str, $length, $padStr, \STR_PAD_LEFT, $encoding);
6786
    }
6787
6788
    /**
6789
     * Returns a new string of a given length such that the end of the string
6790
     * is padded. Alias for pad() with a $padType of 'right'.
6791
     *
6792
     * @param string $str
6793
     * @param int    $length   <p>Desired string length after padding.</p>
6794
     * @param string $padStr   [optional] <p>String used to pad, defaults to space. Default: ' '</p>
6795
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
6796
     *
6797
     * @return string string with right padding
6798
     */
6799 7
    public static function str_pad_right(
6800
        string $str,
6801
        int $length,
6802
        string $padStr = ' ',
6803
        string $encoding = 'UTF-8'
6804
    ): string {
6805 7
        return self::str_pad($str, $length, $padStr, \STR_PAD_RIGHT, $encoding);
6806
    }
6807
6808
    /**
6809
     * Repeat a string.
6810
     *
6811
     * @param string $str        <p>
6812
     *                           The string to be repeated.
6813
     *                           </p>
6814
     * @param int    $multiplier <p>
6815
     *                           Number of time the input string should be
6816
     *                           repeated.
6817
     *                           </p>
6818
     *                           <p>
6819
     *                           multiplier has to be greater than or equal to 0.
6820
     *                           If the multiplier is set to 0, the function
6821
     *                           will return an empty string.
6822
     *                           </p>
6823
     *
6824
     * @return string the repeated string
6825
     */
6826 9
    public static function str_repeat(string $str, int $multiplier): string
6827
    {
6828 9
        $str = self::filter($str);
6829
6830 9
        return \str_repeat($str, $multiplier);
6831
    }
6832
6833
    /**
6834
     * INFO: This is only a wrapper for "str_replace()"  -> the original functions is already UTF-8 safe.
6835
     *
6836
     * Replace all occurrences of the search string with the replacement string
6837
     *
6838
     * @see http://php.net/manual/en/function.str-replace.php
6839
     *
6840
     * @param mixed $search  <p>
6841
     *                       The value being searched for, otherwise known as the needle.
6842
     *                       An array may be used to designate multiple needles.
6843
     *                       </p>
6844
     * @param mixed $replace <p>
6845
     *                       The replacement value that replaces found search
6846
     *                       values. An array may be used to designate multiple replacements.
6847
     *                       </p>
6848
     * @param mixed $subject <p>
6849
     *                       The string or array being searched and replaced on,
6850
     *                       otherwise known as the haystack.
6851
     *                       </p>
6852
     *                       <p>
6853
     *                       If subject is an array, then the search and
6854
     *                       replace is performed with every entry of
6855
     *                       subject, and the return value is an array as
6856
     *                       well.
6857
     *                       </p>
6858
     * @param int   $count   [optional] If passed, this will hold the number of matched and replaced needles
6859
     *
6860
     * @return mixed this function returns a string or an array with the replaced values
6861
     */
6862 12
    public static function str_replace(
6863
        $search,
6864
        $replace,
6865
        $subject,
6866
        int &$count = null
6867
    ) {
6868
        /**
6869
         * @psalm-suppress PossiblyNullArgument
6870
         */
6871 12
        return \str_replace(
6872 12
            $search,
6873 12
            $replace,
6874 12
            $subject,
6875 12
            $count
6876
        );
6877
    }
6878
6879
    /**
6880
     * Replaces $search from the beginning of string with $replacement.
6881
     *
6882
     * @param string $str         <p>The input string.</p>
6883
     * @param string $search      <p>The string to search for.</p>
6884
     * @param string $replacement <p>The replacement.</p>
6885
     *
6886
     * @return string string after the replacements
6887
     */
6888 17
    public static function str_replace_beginning(string $str, string $search, string $replacement): string
6889
    {
6890 17
        if ($str === '') {
6891 4
            if ($replacement === '') {
6892 2
                return '';
6893
            }
6894
6895 2
            if ($search === '') {
6896 2
                return $replacement;
6897
            }
6898
        }
6899
6900 13
        if ($search === '') {
6901 2
            return $str . $replacement;
6902
        }
6903
6904 11
        if (\strpos($str, $search) === 0) {
6905 9
            return $replacement . \substr($str, \strlen($search));
6906
        }
6907
6908 2
        return $str;
6909
    }
6910
6911
    /**
6912
     * Replaces $search from the ending of string with $replacement.
6913
     *
6914
     * @param string $str         <p>The input string.</p>
6915
     * @param string $search      <p>The string to search for.</p>
6916
     * @param string $replacement <p>The replacement.</p>
6917
     *
6918
     * @return string string after the replacements
6919
     */
6920 17
    public static function str_replace_ending(string $str, string $search, string $replacement): string
6921
    {
6922 17
        if ($str === '') {
6923 4
            if ($replacement === '') {
6924 2
                return '';
6925
            }
6926
6927 2
            if ($search === '') {
6928 2
                return $replacement;
6929
            }
6930
        }
6931
6932 13
        if ($search === '') {
6933 2
            return $str . $replacement;
6934
        }
6935
6936 11
        if (\strpos($str, $search, \strlen($str) - \strlen($search)) !== false) {
6937 8
            $str = \substr($str, 0, -\strlen($search)) . $replacement;
6938
        }
6939
6940 11
        return $str;
6941
    }
6942
6943
    /**
6944
     * Replace the first "$search"-term with the "$replace"-term.
6945
     *
6946
     * @param string $search
6947
     * @param string $replace
6948
     * @param string $subject
6949
     *
6950
     * @return string
6951
     *
6952
     * @psalm-suppress InvalidReturnType
6953
     */
6954 2
    public static function str_replace_first(string $search, string $replace, string $subject): string
6955
    {
6956 2
        $pos = self::strpos($subject, $search);
6957
6958 2
        if ($pos !== false) {
6959
            /**
6960
             * @psalm-suppress InvalidReturnStatement
6961
             */
6962 2
            return self::substr_replace(
0 ignored issues
show
Bug Best Practice introduced by
The expression return self::substr_repl...)self::strlen($search)) could return the type string[] which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.
Loading history...
6963 2
                $subject,
6964 2
                $replace,
6965 2
                $pos,
6966 2
                (int) self::strlen($search)
6967
            );
6968
        }
6969
6970 2
        return $subject;
6971
    }
6972
6973
    /**
6974
     * Replace the last "$search"-term with the "$replace"-term.
6975
     *
6976
     * @param string $search
6977
     * @param string $replace
6978
     * @param string $subject
6979
     *
6980
     * @return string
6981
     *
6982
     * @psalm-suppress InvalidReturnType
6983
     */
6984 2
    public static function str_replace_last(
6985
        string $search,
6986
        string $replace,
6987
        string $subject
6988
    ): string {
6989 2
        $pos = self::strrpos($subject, $search);
6990 2
        if ($pos !== false) {
6991
            /**
6992
             * @psalm-suppress InvalidReturnStatement
6993
             */
6994 2
            return self::substr_replace(
0 ignored issues
show
Bug Best Practice introduced by
The expression return self::substr_repl...)self::strlen($search)) could return the type string[] which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.
Loading history...
6995 2
                $subject,
6996 2
                $replace,
6997 2
                $pos,
6998 2
                (int) self::strlen($search)
6999
            );
7000
        }
7001
7002 2
        return $subject;
7003
    }
7004
7005
    /**
7006
     * Shuffles all the characters in the string.
7007
     *
7008
     * PS: uses random algorithm which is weak for cryptography purposes
7009
     *
7010
     * @param string $str      <p>The input string</p>
7011
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
7012
     *
7013
     * @return string the shuffled string
7014
     */
7015 5
    public static function str_shuffle(string $str, string $encoding = 'UTF-8'): string
7016
    {
7017 5
        if ($encoding === 'UTF-8') {
7018 5
            $indexes = \range(0, (int) \mb_strlen($str) - 1);
7019
            /** @noinspection NonSecureShuffleUsageInspection */
7020 5
            \shuffle($indexes);
7021
7022
            // init
7023 5
            $shuffledStr = '';
7024
7025 5
            foreach ($indexes as &$i) {
7026 5
                $tmpSubStr = \mb_substr($str, $i, 1);
7027 5
                if ($tmpSubStr !== false) {
7028 5
                    $shuffledStr .= $tmpSubStr;
7029
                }
7030
            }
7031
        } else {
7032
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
7033
7034
            $indexes = \range(0, (int) self::strlen($str, $encoding) - 1);
7035
            /** @noinspection NonSecureShuffleUsageInspection */
7036
            \shuffle($indexes);
7037
7038
            // init
7039
            $shuffledStr = '';
7040
7041
            foreach ($indexes as &$i) {
7042
                $tmpSubStr = self::substr($str, $i, 1, $encoding);
7043
                if ($tmpSubStr !== false) {
7044
                    $shuffledStr .= $tmpSubStr;
7045
                }
7046
            }
7047
        }
7048
7049 5
        return $shuffledStr;
7050
    }
7051
7052
    /**
7053
     * Returns the substring beginning at $start, and up to, but not including
7054
     * the index specified by $end. If $end is omitted, the function extracts
7055
     * the remaining string. If $end is negative, it is computed from the end
7056
     * of the string.
7057
     *
7058
     * @param string $str
7059
     * @param int    $start    <p>Initial index from which to begin extraction.</p>
7060
     * @param int    $end      [optional] <p>Index at which to end extraction. Default: null</p>
7061
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
7062
     *
7063
     * @return false|string
7064
     *                      <p>The extracted substring.</p><p>If <i>str</i> is shorter than <i>start</i>
7065
     *                      characters long, <b>FALSE</b> will be returned.
7066
     */
7067 18
    public static function str_slice(
7068
        string $str,
7069
        int $start,
7070
        int $end = null,
7071
        string $encoding = 'UTF-8'
7072
    ) {
7073 18
        if ($encoding === 'UTF-8') {
7074 7
            if ($end === null) {
7075 1
                $length = (int) \mb_strlen($str);
7076 6
            } elseif ($end >= 0 && $end <= $start) {
7077 2
                return '';
7078 4
            } elseif ($end < 0) {
7079 1
                $length = (int) \mb_strlen($str) + $end - $start;
7080
            } else {
7081 3
                $length = $end - $start;
7082
            }
7083
7084 5
            return \mb_substr($str, $start, $length);
7085
        }
7086
7087 11
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
7088
7089 11
        if ($end === null) {
7090 5
            $length = (int) self::strlen($str, $encoding);
7091 6
        } elseif ($end >= 0 && $end <= $start) {
7092 2
            return '';
7093 4
        } elseif ($end < 0) {
7094 1
            $length = (int) self::strlen($str, $encoding) + $end - $start;
7095
        } else {
7096 3
            $length = $end - $start;
7097
        }
7098
7099 9
        return self::substr($str, $start, $length, $encoding);
7100
    }
7101
7102
    /**
7103
     * Convert a string to e.g.: "snake_case"
7104
     *
7105
     * @param string $str
7106
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
7107
     *
7108
     * @return string string in snake_case
7109
     */
7110 20
    public static function str_snakeize(string $str, string $encoding = 'UTF-8'): string
7111
    {
7112 20
        if ($str === '') {
7113
            return '';
7114
        }
7115
7116 20
        $str = \str_replace(
7117 20
            '-',
7118 20
            '_',
7119 20
            self::normalize_whitespace($str)
7120
        );
7121
7122 20
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
7123 17
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
7124
        }
7125
7126 20
        $str = (string) \preg_replace_callback(
7127 20
            '/([\d|\p{Lu}])/u',
7128
            /**
7129
             * @param string[] $matches
7130
             *
7131
             * @return string
7132
             */
7133
            static function (array $matches) use ($encoding): string {
7134 9
                $match = $matches[1];
7135 9
                $matchInt = (int) $match;
7136
7137 9
                if ((string) $matchInt === $match) {
7138 4
                    return '_' . $match . '_';
7139
                }
7140
7141 5
                if ($encoding === 'UTF-8') {
7142 5
                    return '_' . \mb_strtolower($match);
7143
                }
7144
7145
                return '_' . self::strtolower($match, $encoding);
7146 20
            },
7147 20
            $str
7148
        );
7149
7150 20
        $str = (string) \preg_replace(
7151
            [
7152 20
                '/\s+/u',        // convert spaces to "_"
7153
                '/^\s+|\s+$/u',  // trim leading & trailing spaces
7154
                '/_+/',         // remove double "_"
7155
            ],
7156
            [
7157 20
                '_',
7158
                '',
7159
                '_',
7160
            ],
7161 20
            $str
7162
        );
7163
7164 20
        return \trim(\trim($str, '_')); // trim leading & trailing "_" + whitespace
7165
    }
7166
7167
    /**
7168
     * Sort all characters according to code points.
7169
     *
7170
     * @param string $str    <p>A UTF-8 string.</p>
7171
     * @param bool   $unique <p>Sort unique. If <strong>true</strong>, repeated characters are ignored.</p>
7172
     * @param bool   $desc   <p>If <strong>true</strong>, will sort characters in reverse code point order.</p>
7173
     *
7174
     * @return string string of sorted characters
7175
     */
7176 2
    public static function str_sort(string $str, bool $unique = false, bool $desc = false): string
7177
    {
7178 2
        $array = self::codepoints($str);
7179
7180 2
        if ($unique) {
7181 2
            $array = \array_flip(\array_flip($array));
7182
        }
7183
7184 2
        if ($desc) {
7185 2
            \arsort($array);
0 ignored issues
show
Bug introduced by
It seems like $array can also be of type null; however, parameter $array of arsort() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

7185
            \arsort(/** @scrutinizer ignore-type */ $array);
Loading history...
7186
        } else {
7187 2
            \asort($array);
0 ignored issues
show
Bug introduced by
It seems like $array can also be of type null; however, parameter $array of asort() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

7187
            \asort(/** @scrutinizer ignore-type */ $array);
Loading history...
7188
        }
7189
7190 2
        return self::string($array);
7191
    }
7192
7193
    /**
7194
     * Convert a string to an array of Unicode characters.
7195
     *
7196
     * @param int|int[]|string|string[] $str                <p>The string to split into array.</p>
7197
     * @param int                       $length             [optional] <p>Max character length of each array
7198
     *                                                      element.</p>
7199
     * @param bool                      $cleanUtf8          [optional] <p>Remove non UTF-8 chars from the string.</p>
7200
     * @param bool                      $tryToUseMbFunction [optional] <p>Set to false, if you don't want to use
7201
     *                                                      "mb_substr"</p>
7202
     *
7203
     * @return array
7204
     *               <p>An array containing chunks of the input.</p>
7205
     */
7206 87
    public static function str_split(
7207
        $str,
7208
        int $length = 1,
7209
        bool $cleanUtf8 = false,
7210
        bool $tryToUseMbFunction = true
7211
    ): array {
7212 87
        if ($length <= 0) {
7213 3
            return [];
7214
        }
7215
7216 86
        if (\is_array($str) === true) {
7217 2
            foreach ($str as $k => &$v) {
7218 2
                $v = self::str_split(
7219 2
                    $v,
7220 2
                    $length,
7221 2
                    $cleanUtf8,
7222 2
                    $tryToUseMbFunction
7223
                );
7224
            }
7225
7226 2
            return $str;
7227
        }
7228
7229
        // init
7230 86
        $str = (string) $str;
7231
7232 86
        if ($str === '') {
7233 13
            return [];
7234
        }
7235
7236 83
        if ($cleanUtf8 === true) {
7237 19
            $str = self::clean($str);
7238
        }
7239
7240
        if (
7241 83
            $tryToUseMbFunction === true
7242
            &&
7243 83
            self::$SUPPORT['mbstring'] === true
7244
        ) {
7245 79
            $iMax = \mb_strlen($str);
7246 79
            if ($iMax <= 127) {
7247 73
                $ret = [];
7248 73
                for ($i = 0; $i < $iMax; ++$i) {
7249 73
                    $ret[] = \mb_substr($str, $i, 1);
7250
                }
7251
            } else {
7252 15
                $retArray = [];
7253 15
                \preg_match_all('/./us', $str, $retArray);
7254 79
                $ret = $retArray[0] ?? [];
7255
            }
7256 23
        } elseif (self::$SUPPORT['pcre_utf8'] === true) {
7257 17
            $retArray = [];
7258 17
            \preg_match_all('/./us', $str, $retArray);
7259 17
            $ret = $retArray[0] ?? [];
7260
        } else {
7261
7262
            // fallback
7263
7264 8
            $ret = [];
7265 8
            $len = \strlen($str);
7266
7267
            /** @noinspection ForeachInvariantsInspection */
7268 8
            for ($i = 0; $i < $len; ++$i) {
7269 8
                if (($str[$i] & "\x80") === "\x00") {
7270 8
                    $ret[] = $str[$i];
7271
                } elseif (
7272 8
                    isset($str[$i + 1])
7273
                    &&
7274 8
                    ($str[$i] & "\xE0") === "\xC0"
7275
                ) {
7276 4
                    if (($str[$i + 1] & "\xC0") === "\x80") {
7277 4
                        $ret[] = $str[$i] . $str[$i + 1];
7278
7279 4
                        ++$i;
7280
                    }
7281
                } elseif (
7282 6
                    isset($str[$i + 2])
7283
                    &&
7284 6
                    ($str[$i] & "\xF0") === "\xE0"
7285
                ) {
7286
                    if (
7287 6
                        ($str[$i + 1] & "\xC0") === "\x80"
7288
                        &&
7289 6
                        ($str[$i + 2] & "\xC0") === "\x80"
7290
                    ) {
7291 6
                        $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2];
7292
7293 6
                        $i += 2;
7294
                    }
7295
                } elseif (
7296
                    isset($str[$i + 3])
7297
                    &&
7298
                    ($str[$i] & "\xF8") === "\xF0"
7299
                ) {
7300
                    if (
7301
                        ($str[$i + 1] & "\xC0") === "\x80"
7302
                        &&
7303
                        ($str[$i + 2] & "\xC0") === "\x80"
7304
                        &&
7305
                        ($str[$i + 3] & "\xC0") === "\x80"
7306
                    ) {
7307
                        $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2] . $str[$i + 3];
7308
7309
                        $i += 3;
7310
                    }
7311
                }
7312
            }
7313
        }
7314
7315 83
        if ($length > 1) {
7316 11
            $ret = \array_chunk($ret, $length);
7317
7318 11
            return \array_map(
7319
                static function (array &$item): string {
7320 11
                    return \implode('', $item);
7321 11
                },
7322 11
                $ret
7323
            );
7324
        }
7325
7326 76
        if (isset($ret[0]) && $ret[0] === '') {
7327
            return [];
7328
        }
7329
7330 76
        return $ret;
7331
    }
7332
7333
    /**
7334
     * Splits the string with the provided regular expression, returning an
7335
     * array of Stringy objects. An optional integer $limit will truncate the
7336
     * results.
7337
     *
7338
     * @param string $str
7339
     * @param string $pattern <p>The regex with which to split the string.</p>
7340
     * @param int    $limit   [optional] <p>Maximum number of results to return. Default: -1 === no limit</p>
7341
     *
7342
     * @return string[] an array of strings
7343
     */
7344 16
    public static function str_split_pattern(string $str, string $pattern, int $limit = -1): array
7345
    {
7346 16
        if ($limit === 0) {
7347 2
            return [];
7348
        }
7349
7350 14
        if ($pattern === '') {
7351 1
            return [$str];
7352
        }
7353
7354 13
        if (self::$SUPPORT['mbstring'] === true) {
7355 13
            if ($limit >= 0) {
7356
                /** @noinspection PhpComposerExtensionStubsInspection */
7357 8
                $resultTmp = \mb_split($pattern, $str);
7358
7359 8
                $result = [];
7360 8
                foreach ($resultTmp as $itemTmp) {
7361 8
                    if ($limit === 0) {
7362 4
                        break;
7363
                    }
7364 8
                    --$limit;
7365
7366 8
                    $result[] = $itemTmp;
7367
                }
7368
7369 8
                return $result;
7370
            }
7371
7372
            /** @noinspection PhpComposerExtensionStubsInspection */
7373 5
            return \mb_split($pattern, $str);
7374
        }
7375
7376
        if ($limit > 0) {
7377
            ++$limit;
7378
        } else {
7379
            $limit = -1;
7380
        }
7381
7382
        $array = \preg_split('/' . \preg_quote($pattern, '/') . '/u', $str, $limit);
7383
7384
        if ($array === false) {
7385
            return [];
7386
        }
7387
7388
        if ($limit > 0 && \count($array) === $limit) {
7389
            \array_pop($array);
7390
        }
7391
7392
        return $array;
7393
    }
7394
7395
    /**
7396
     * Check if the string starts with the given substring.
7397
     *
7398
     * @param string $haystack <p>The string to search in.</p>
7399
     * @param string $needle   <p>The substring to search for.</p>
7400
     *
7401
     * @return bool
7402
     */
7403 19
    public static function str_starts_with(string $haystack, string $needle): bool
7404
    {
7405 19
        if ($needle === '') {
7406 2
            return true;
7407
        }
7408
7409 19
        if ($haystack === '') {
7410
            return false;
7411
        }
7412
7413 19
        return \strpos($haystack, $needle) === 0;
7414
    }
7415
7416
    /**
7417
     * Returns true if the string begins with any of $substrings, false otherwise.
7418
     *
7419
     * - case-sensitive
7420
     *
7421
     * @param string $str        <p>The input string.</p>
7422
     * @param array  $substrings <p>Substrings to look for.</p>
7423
     *
7424
     * @return bool whether or not $str starts with $substring
7425
     */
7426 8
    public static function str_starts_with_any(string $str, array $substrings): bool
7427
    {
7428 8
        if ($str === '') {
7429
            return false;
7430
        }
7431
7432 8
        if ($substrings === []) {
7433
            return false;
7434
        }
7435
7436 8
        foreach ($substrings as &$substring) {
7437 8
            if (self::str_starts_with($str, $substring)) {
7438 8
                return true;
7439
            }
7440
        }
7441
7442 6
        return false;
7443
    }
7444
7445
    /**
7446
     * Gets the substring after the first occurrence of a separator.
7447
     *
7448
     * @param string $str       <p>The input string.</p>
7449
     * @param string $separator <p>The string separator.</p>
7450
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
7451
     *
7452
     * @return string
7453
     */
7454 1
    public static function str_substr_after_first_separator(string $str, string $separator, string $encoding = 'UTF-8'): string
7455
    {
7456 1
        if ($separator === '' || $str === '') {
7457 1
            return '';
7458
        }
7459
7460 1
        if ($encoding === 'UTF-8') {
7461 1
            $offset = \mb_strpos($str, $separator);
7462 1
            if ($offset === false) {
7463 1
                return '';
7464
            }
7465
7466 1
            return (string) \mb_substr(
7467 1
                $str,
7468 1
                $offset + (int) \mb_strlen($separator)
7469
            );
7470
        }
7471
7472
        $offset = self::strpos($str, $separator, 0, $encoding);
7473
        if ($offset === false) {
7474
            return '';
7475
        }
7476
7477
        return (string) \mb_substr(
7478
            $str,
7479
            $offset + (int) self::strlen($separator, $encoding),
7480
            null,
7481
            $encoding
7482
        );
7483
    }
7484
7485
    /**
7486
     * Gets the substring after the last occurrence of a separator.
7487
     *
7488
     * @param string $str       <p>The input string.</p>
7489
     * @param string $separator <p>The string separator.</p>
7490
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
7491
     *
7492
     * @return string
7493
     */
7494 1
    public static function str_substr_after_last_separator(string $str, string $separator, string $encoding = 'UTF-8'): string
7495
    {
7496 1
        if ($separator === '' || $str === '') {
7497 1
            return '';
7498
        }
7499
7500 1
        if ($encoding === 'UTF-8') {
7501 1
            $offset = \mb_strrpos($str, $separator);
7502 1
            if ($offset === false) {
7503 1
                return '';
7504
            }
7505
7506 1
            return (string) \mb_substr(
7507 1
                $str,
7508 1
                $offset + (int) \mb_strlen($separator)
7509
            );
7510
        }
7511
7512
        $offset = self::strrpos($str, $separator, 0, $encoding);
7513
        if ($offset === false) {
7514
            return '';
7515
        }
7516
7517
        return (string) self::substr(
7518
            $str,
7519
            $offset + (int) self::strlen($separator, $encoding),
7520
            null,
7521
            $encoding
7522
        );
7523
    }
7524
7525
    /**
7526
     * Gets the substring before the first occurrence of a separator.
7527
     *
7528
     * @param string $str       <p>The input string.</p>
7529
     * @param string $separator <p>The string separator.</p>
7530
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
7531
     *
7532
     * @return string
7533
     */
7534 1
    public static function str_substr_before_first_separator(
7535
        string $str,
7536
        string $separator,
7537
        string $encoding = 'UTF-8'
7538
    ): string {
7539 1
        if ($separator === '' || $str === '') {
7540 1
            return '';
7541
        }
7542
7543 1
        if ($encoding === 'UTF-8') {
7544 1
            $offset = \mb_strpos($str, $separator);
7545 1
            if ($offset === false) {
7546 1
                return '';
7547
            }
7548
7549 1
            return (string) \mb_substr(
7550 1
                $str,
7551 1
                0,
7552 1
                $offset
7553
            );
7554
        }
7555
7556
        $offset = self::strpos($str, $separator, 0, $encoding);
7557
        if ($offset === false) {
7558
            return '';
7559
        }
7560
7561
        return (string) self::substr(
7562
            $str,
7563
            0,
7564
            $offset,
7565
            $encoding
7566
        );
7567
    }
7568
7569
    /**
7570
     * Gets the substring before the last occurrence of a separator.
7571
     *
7572
     * @param string $str       <p>The input string.</p>
7573
     * @param string $separator <p>The string separator.</p>
7574
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
7575
     *
7576
     * @return string
7577
     */
7578 1
    public static function str_substr_before_last_separator(string $str, string $separator, string $encoding = 'UTF-8'): string
7579
    {
7580 1
        if ($separator === '' || $str === '') {
7581 1
            return '';
7582
        }
7583
7584 1
        if ($encoding === 'UTF-8') {
7585 1
            $offset = \mb_strrpos($str, $separator);
7586 1
            if ($offset === false) {
7587 1
                return '';
7588
            }
7589
7590 1
            return (string) \mb_substr(
7591 1
                $str,
7592 1
                0,
7593 1
                $offset
7594
            );
7595
        }
7596
7597
        $offset = self::strrpos($str, $separator, 0, $encoding);
7598
        if ($offset === false) {
7599
            return '';
7600
        }
7601
7602
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
7603
7604
        return (string) self::substr(
7605
            $str,
7606
            0,
7607
            $offset,
7608
            $encoding
7609
        );
7610
    }
7611
7612
    /**
7613
     * Gets the substring after (or before via "$beforeNeedle") the first occurrence of the "$needle".
7614
     *
7615
     * @param string $str          <p>The input string.</p>
7616
     * @param string $needle       <p>The string to look for.</p>
7617
     * @param bool   $beforeNeedle [optional] <p>Default: false</p>
7618
     * @param string $encoding     [optional] <p>Default: 'UTF-8'</p>
7619
     *
7620
     * @return string
7621
     */
7622 2
    public static function str_substr_first(
7623
        string $str,
7624
        string $needle,
7625
        bool $beforeNeedle = false,
7626
        string $encoding = 'UTF-8'
7627
    ): string {
7628 2
        if ($str === '' || $needle === '') {
7629 2
            return '';
7630
        }
7631
7632 2
        if ($encoding === 'UTF-8') {
7633 2
            if ($beforeNeedle === true) {
7634 1
                $part = \mb_strstr(
7635 1
                    $str,
7636 1
                    $needle,
7637 1
                    $beforeNeedle
7638
                );
7639
            } else {
7640 1
                $part = \mb_strstr(
7641 1
                    $str,
7642 2
                    $needle
7643
                );
7644
            }
7645
        } else {
7646
            $part = self::strstr(
7647
                $str,
7648
                $needle,
7649
                $beforeNeedle,
7650
                $encoding
7651
            );
7652
        }
7653
7654 2
        return $part === false ? '' : $part;
7655
    }
7656
7657
    /**
7658
     * Gets the substring after (or before via "$beforeNeedle") the last occurrence of the "$needle".
7659
     *
7660
     * @param string $str          <p>The input string.</p>
7661
     * @param string $needle       <p>The string to look for.</p>
7662
     * @param bool   $beforeNeedle [optional] <p>Default: false</p>
7663
     * @param string $encoding     [optional] <p>Default: 'UTF-8'</p>
7664
     *
7665
     * @return string
7666
     */
7667 2
    public static function str_substr_last(
7668
        string $str,
7669
        string $needle,
7670
        bool $beforeNeedle = false,
7671
        string $encoding = 'UTF-8'
7672
    ): string {
7673 2
        if ($str === '' || $needle === '') {
7674 2
            return '';
7675
        }
7676
7677 2
        if ($encoding === 'UTF-8') {
7678 2
            if ($beforeNeedle === true) {
7679 1
                $part = \mb_strrchr(
7680 1
                    $str,
7681 1
                    $needle,
7682 1
                    $beforeNeedle
7683
                );
7684
            } else {
7685 1
                $part = \mb_strrchr(
7686 1
                    $str,
7687 2
                    $needle
7688
                );
7689
            }
7690
        } else {
7691
            $part = self::strrchr(
7692
                $str,
7693
                $needle,
7694
                $beforeNeedle,
7695
                $encoding
7696
            );
7697
        }
7698
7699 2
        return $part === false ? '' : $part;
7700
    }
7701
7702
    /**
7703
     * Surrounds $str with the given substring.
7704
     *
7705
     * @param string $str
7706
     * @param string $substring <p>The substring to add to both sides.</P>
7707
     *
7708
     * @return string string with the substring both prepended and appended
7709
     */
7710 5
    public static function str_surround(string $str, string $substring): string
7711
    {
7712 5
        return $substring . $str . $substring;
7713
    }
7714
7715
    /**
7716
     * Returns a trimmed string with the first letter of each word capitalized.
7717
     * Also accepts an array, $ignore, allowing you to list words not to be
7718
     * capitalized.
7719
     *
7720
     * @param string              $str
7721
     * @param array|string[]|null $ignore                [optional] <p>An array of words not to capitalize or null.
7722
     *                                                   Default: null</p>
7723
     * @param string              $encoding              [optional] <p>Default: 'UTF-8'</p>
7724
     * @param bool                $cleanUtf8             [optional] <p>Remove non UTF-8 chars from the string.</p>
7725
     * @param string|null         $lang                  [optional] <p>Set the language for special cases: az, el, lt,
7726
     *                                                   tr</p>
7727
     * @param bool                $tryToKeepStringLength [optional] <p>true === try to keep the string length: e.g. ẞ ->
7728
     *                                                   ß</p>
7729
     * @param bool                $useTrimFirst          [optional] <p>true === trim the input string, first</p>
7730
     *
7731
     * @return string the titleized string
7732
     */
7733 5
    public static function str_titleize(
7734
        string $str,
7735
        array $ignore = null,
7736
        string $encoding = 'UTF-8',
7737
        bool $cleanUtf8 = false,
7738
        string $lang = null,
7739
        bool $tryToKeepStringLength = false,
7740
        bool $useTrimFirst = true
7741
    ): string {
7742 5
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
7743 4
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
7744
        }
7745
7746 5
        if ($useTrimFirst === true) {
7747 5
            $str = \trim($str);
7748
        }
7749
7750 5
        if ($cleanUtf8 === true) {
7751
            $str = self::clean($str);
7752
        }
7753
7754 5
        $useMbFunction = $lang === null && $tryToKeepStringLength === false;
7755
7756 5
        return (string) \preg_replace_callback(
7757 5
            '/([\S]+)/u',
7758
            static function (array $match) use ($tryToKeepStringLength, $lang, $ignore, $useMbFunction, $encoding): string {
7759 5
                if ($ignore !== null && \in_array($match[0], $ignore, true)) {
7760 2
                    return $match[0];
7761
                }
7762
7763 5
                if ($useMbFunction === true) {
7764 5
                    if ($encoding === 'UTF-8') {
7765 5
                        return \mb_strtoupper(\mb_substr($match[0], 0, 1))
7766 5
                               . \mb_strtolower(\mb_substr($match[0], 1));
7767
                    }
7768
7769
                    return \mb_strtoupper(\mb_substr($match[0], 0, 1, $encoding), $encoding)
7770
                           . \mb_strtolower(\mb_substr($match[0], 1, null, $encoding), $encoding);
7771
                }
7772
7773
                return self::ucfirst(
7774
                    self::strtolower(
7775
                        $match[0],
7776
                        $encoding,
7777
                        false,
7778
                        $lang,
7779
                        $tryToKeepStringLength
7780
                    ),
7781
                    $encoding,
7782
                    false,
7783
                    $lang,
7784
                    $tryToKeepStringLength
7785
                );
7786 5
            },
7787 5
            $str
7788
        );
7789
    }
7790
7791
    /**
7792
     * Returns a trimmed string in proper title case.
7793
     *
7794
     * Also accepts an array, $ignore, allowing you to list words not to be
7795
     * capitalized.
7796
     *
7797
     * Adapted from John Gruber's script.
7798
     *
7799
     * @see https://gist.github.com/gruber/9f9e8650d68b13ce4d78
7800
     *
7801
     * @param string $str
7802
     * @param array  $ignore   <p>An array of words not to capitalize.</p>
7803
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
7804
     *
7805
     * @return string the titleized string
7806
     */
7807 35
    public static function str_titleize_for_humans(string $str, array $ignore = [], string $encoding = 'UTF-8'): string
7808
    {
7809 35
        $smallWords = \array_merge(
7810
            [
7811 35
                '(?<!q&)a',
7812
                'an',
7813
                'and',
7814
                'as',
7815
                'at(?!&t)',
7816
                'but',
7817
                'by',
7818
                'en',
7819
                'for',
7820
                'if',
7821
                'in',
7822
                'of',
7823
                'on',
7824
                'or',
7825
                'the',
7826
                'to',
7827
                'v[.]?',
7828
                'via',
7829
                'vs[.]?',
7830
            ],
7831 35
            $ignore
7832
        );
7833
7834 35
        $smallWordsRx = \implode('|', $smallWords);
7835 35
        $apostropheRx = '(?x: [\'’] [[:lower:]]* )?';
7836
7837 35
        $str = \trim($str);
7838
7839 35
        if (self::has_lowercase($str) === false) {
7840 2
            $str = self::strtolower($str, $encoding);
7841
        }
7842
7843
        // the main substitutions
7844 35
        $str = (string) \preg_replace_callback(
7845
            '~\b (_*) (?:                                                              # 1. Leading underscore and
7846
                        ( (?<=[ ][/\\\\]) [[:alpha:]]+ [-_[:alpha:]/\\\\]+ |              # 2. file path or 
7847 35
                          [-_[:alpha:]]+ [@.:] [-_[:alpha:]@.:/]+ ' . $apostropheRx . ' ) #    URL, domain, or email
7848
                        |
7849 35
                        ( (?i: ' . $smallWordsRx . ' ) ' . $apostropheRx . ' )            # 3. or small word (case-insensitive)
7850
                        |
7851 35
                        ( [[:alpha:]] [[:lower:]\'’()\[\]{}]* ' . $apostropheRx . ' )     # 4. or word w/o internal caps
7852
                        |
7853 35
                        ( [[:alpha:]] [[:alpha:]\'’()\[\]{}]* ' . $apostropheRx . ' )     # 5. or some other word
7854
                      ) (_*) \b                                                           # 6. With trailing underscore
7855
                    ~ux',
7856
            /**
7857
             * @param string[] $matches
7858
             *
7859
             * @return string
7860
             */
7861
            static function (array $matches) use ($encoding): string {
7862
                // preserve leading underscore
7863 35
                $str = $matches[1];
7864 35
                if ($matches[2]) {
7865
                    // preserve URLs, domains, emails and file paths
7866 5
                    $str .= $matches[2];
7867 35
                } elseif ($matches[3]) {
7868
                    // lower-case small words
7869 25
                    $str .= self::strtolower($matches[3], $encoding);
7870 35
                } elseif ($matches[4]) {
7871
                    // capitalize word w/o internal caps
7872 34
                    $str .= static::str_upper_first($matches[4], $encoding);
7873
                } else {
7874
                    // preserve other kinds of word (iPhone)
7875 7
                    $str .= $matches[5];
7876
                }
7877
                // Preserve trailing underscore
7878 35
                $str .= $matches[6];
7879
7880 35
                return $str;
7881 35
            },
7882 35
            $str
7883
        );
7884
7885
        // Exceptions for small words: capitalize at start of title...
7886 35
        $str = (string) \preg_replace_callback(
7887
            '~(  \A [[:punct:]]*                # start of title...
7888
                      |  [:.;?!][ ]+               # or of subsentence...
7889
                      |  [ ][\'"“‘(\[][ ]* )       # or of inserted subphrase...
7890 35
                      ( ' . $smallWordsRx . ' ) \b # ...followed by small word
7891
                     ~uxi',
7892
            /**
7893
             * @param string[] $matches
7894
             *
7895
             * @return string
7896
             */
7897
            static function (array $matches) use ($encoding): string {
7898 11
                return $matches[1] . static::str_upper_first($matches[2], $encoding);
7899 35
            },
7900 35
            $str
7901
        );
7902
7903
        // ...and end of title
7904 35
        $str = (string) \preg_replace_callback(
7905 35
            '~\b ( ' . $smallWordsRx . ' ) # small word...
7906
                      (?= [[:punct:]]* \Z     # ...at the end of the title...
7907
                      |   [\'"’”)\]] [ ] )    # ...or of an inserted subphrase?
7908
                     ~uxi',
7909
            /**
7910
             * @param string[] $matches
7911
             *
7912
             * @return string
7913
             */
7914
            static function (array $matches) use ($encoding): string {
7915 3
                return static::str_upper_first($matches[1], $encoding);
7916 35
            },
7917 35
            $str
7918
        );
7919
7920
        // Exceptions for small words in hyphenated compound words.
7921
        // e.g. "in-flight" -> In-Flight
7922 35
        $str = (string) \preg_replace_callback(
7923
            '~\b
7924
                        (?<! -)                   # Negative lookbehind for a hyphen; we do not want to match man-in-the-middle but do want (in-flight)
7925 35
                        ( ' . $smallWordsRx . ' )
7926
                        (?= -[[:alpha:]]+)        # lookahead for "-someword"
7927
                       ~uxi',
7928
            /**
7929
             * @param string[] $matches
7930
             *
7931
             * @return string
7932
             */
7933
            static function (array $matches) use ($encoding): string {
7934
                return static::str_upper_first($matches[1], $encoding);
7935 35
            },
7936 35
            $str
7937
        );
7938
7939
        // e.g. "Stand-in" -> "Stand-In" (Stand is already capped at this point)
7940 35
        $str = (string) \preg_replace_callback(
7941
            '~\b
7942
                      (?<!…)                    # Negative lookbehind for a hyphen; we do not want to match man-in-the-middle but do want (stand-in)
7943
                      ( [[:alpha:]]+- )         # $1 = first word and hyphen, should already be properly capped
7944 35
                      ( ' . $smallWordsRx . ' ) # ...followed by small word
7945
                      (?!	- )                   # Negative lookahead for another -
7946
                     ~uxi',
7947
            /**
7948
             * @param string[] $matches
7949
             *
7950
             * @return string
7951
             */
7952
            static function (array $matches) use ($encoding): string {
7953
                return $matches[1] . static::str_upper_first($matches[2], $encoding);
7954 35
            },
7955 35
            $str
7956
        );
7957
7958 35
        return $str;
7959
    }
7960
7961
    /**
7962
     * Get a binary representation of a specific string.
7963
     *
7964
     * @param string $str <p>The input string.</p>
7965
     *
7966
     * @return string
7967
     */
7968 2
    public static function str_to_binary(string $str): string
7969
    {
7970 2
        $value = \unpack('H*', $str);
7971
7972 2
        return \base_convert($value[1], 16, 2);
7973
    }
7974
7975
    /**
7976
     * @param string   $str
7977
     * @param bool     $removeEmptyValues <p>Remove empty values.</p>
7978
     * @param int|null $removeShortValues <p>The min. string length or null to disable</p>
7979
     *
7980
     * @return string[]
7981
     */
7982 17
    public static function str_to_lines(string $str, bool $removeEmptyValues = false, int $removeShortValues = null): array
7983
    {
7984 17
        if ($str === '') {
7985 1
            return $removeEmptyValues === true ? [] : [''];
7986
        }
7987
7988 16
        if (self::$SUPPORT['mbstring'] === true) {
7989
            /** @noinspection PhpComposerExtensionStubsInspection */
7990 16
            $return = \mb_split('[\r\n]{1,2}', $str);
7991
        } else {
7992
            $return = \preg_split("/[\r\n]{1,2}/u", $str);
7993
        }
7994
7995 16
        if ($return === false) {
7996
            return $removeEmptyValues === true ? [] : [''];
7997
        }
7998
7999
        if (
8000 16
            $removeShortValues === null
8001
            &&
8002 16
            $removeEmptyValues === false
8003
        ) {
8004 16
            return $return;
0 ignored issues
show
Bug Best Practice introduced by
The expression return $return returns an array which contains values of type array which are incompatible with the documented value type string.
Loading history...
8005
        }
8006
8007
        return self::reduce_string_array(
8008
            $return,
8009
            $removeEmptyValues,
8010
            $removeShortValues
8011
        );
8012
    }
8013
8014
    /**
8015
     * Convert a string into an array of words.
8016
     *
8017
     * @param string   $str
8018
     * @param string   $charList          <p>Additional chars for the definition of "words".</p>
8019
     * @param bool     $removeEmptyValues <p>Remove empty values.</p>
8020
     * @param int|null $removeShortValues <p>The min. string length or null to disable</p>
8021
     *
8022
     * @return string[]
8023
     */
8024 13
    public static function str_to_words(
8025
        string $str,
8026
        string $charList = '',
8027
        bool $removeEmptyValues = false,
8028
        int $removeShortValues = null
8029
    ): array {
8030 13
        if ($str === '') {
8031 4
            return $removeEmptyValues === true ? [] : [''];
8032
        }
8033
8034 13
        $charList = self::rxClass($charList, '\pL');
8035
8036 13
        $return = \preg_split("/({$charList}+(?:[\p{Pd}’']{$charList}+)*)/u", $str, -1, \PREG_SPLIT_DELIM_CAPTURE);
8037 13
        if ($return === false) {
8038
            return $removeEmptyValues === true ? [] : [''];
8039
        }
8040
8041
        if (
8042 13
            $removeShortValues === null
8043
            &&
8044 13
            $removeEmptyValues === false
8045
        ) {
8046 13
            return $return;
0 ignored issues
show
Bug Best Practice introduced by
The expression return $return returns an array which contains values of type array which are incompatible with the documented value type string.
Loading history...
8047
        }
8048
8049 2
        $tmpReturn = self::reduce_string_array(
8050 2
            $return,
8051 2
            $removeEmptyValues,
8052 2
            $removeShortValues
8053
        );
8054
8055 2
        foreach ($tmpReturn as &$item) {
8056 2
            $item = (string) $item;
8057
        }
8058
8059 2
        return $tmpReturn;
8060
    }
8061
8062
    /**
8063
     * alias for "UTF8::to_ascii()"
8064
     *
8065
     * @param string $str
8066
     * @param string $unknown
8067
     * @param bool   $strict
8068
     *
8069
     * @return string
8070
     *
8071
     * @see UTF8::to_ascii()
8072
     */
8073 8
    public static function str_transliterate(string $str, string $unknown = '?', bool $strict = false): string
8074
    {
8075 8
        return self::to_ascii($str, $unknown, $strict);
8076
    }
8077
8078
    /**
8079
     * Truncates the string to a given length. If $substring is provided, and
8080
     * truncating occurs, the string is further truncated so that the substring
8081
     * may be appended without exceeding the desired length.
8082
     *
8083
     * @param string $str
8084
     * @param int    $length    <p>Desired length of the truncated string.</p>
8085
     * @param string $substring [optional] <p>The substring to append if it can fit. Default: ''</p>
8086
     * @param string $encoding  [optional] <p>Default: 'UTF-8'</p>
8087
     *
8088
     * @return string string after truncating
8089
     */
8090 22
    public static function str_truncate(
8091
        string $str,
8092
        int $length,
8093
        string $substring = '',
8094
        string $encoding = 'UTF-8'
8095
    ): string {
8096 22
        if ($str === '') {
8097
            return '';
8098
        }
8099
8100 22
        if ($encoding === 'UTF-8') {
8101 10
            if ($length >= (int) \mb_strlen($str)) {
8102 2
                return $str;
8103
            }
8104
8105 8
            if ($substring !== '') {
8106 4
                $length -= (int) \mb_strlen($substring);
8107
8108
                /** @noinspection UnnecessaryCastingInspection */
8109 4
                return (string) \mb_substr($str, 0, $length) . $substring;
8110
            }
8111
8112
            /** @noinspection UnnecessaryCastingInspection */
8113 4
            return (string) \mb_substr($str, 0, $length);
8114
        }
8115
8116 12
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
8117
8118 12
        if ($length >= (int) self::strlen($str, $encoding)) {
8119 2
            return $str;
8120
        }
8121
8122 10
        if ($substring !== '') {
8123 6
            $length -= (int) self::strlen($substring, $encoding);
8124
        }
8125
8126
        return (
8127 10
               (string) self::substr(
8128 10
                   $str,
8129 10
                   0,
8130 10
                   $length,
8131 10
                   $encoding
8132
               )
8133 10
               ) . $substring;
8134
    }
8135
8136
    /**
8137
     * Truncates the string to a given length, while ensuring that it does not
8138
     * split words. If $substring is provided, and truncating occurs, the
8139
     * string is further truncated so that the substring may be appended without
8140
     * exceeding the desired length.
8141
     *
8142
     * @param string $str
8143
     * @param int    $length                          <p>Desired length of the truncated string.</p>
8144
     * @param string $substring                       [optional] <p>The substring to append if it can fit. Default:
8145
     *                                                ''</p>
8146
     * @param string $encoding                        [optional] <p>Default: 'UTF-8'</p>
8147
     * @param bool   $ignoreDoNotSplitWordsForOneWord [optional] <p>Default: false</p>
8148
     *
8149
     * @return string string after truncating
8150
     */
8151 47
    public static function str_truncate_safe(
8152
        string $str,
8153
        int $length,
8154
        string $substring = '',
8155
        string $encoding = 'UTF-8',
8156
        bool $ignoreDoNotSplitWordsForOneWord = false
8157
    ): string {
8158 47
        if ($str === '' || $length <= 0) {
8159 1
            return $substring;
8160
        }
8161
8162 47
        if ($encoding === 'UTF-8') {
8163 21
            if ($length >= (int) \mb_strlen($str)) {
8164 5
                return $str;
8165
            }
8166
8167
            // need to further trim the string so we can append the substring
8168 17
            $length -= (int) \mb_strlen($substring);
8169 17
            if ($length <= 0) {
8170 1
                return $substring;
8171
            }
8172
8173 17
            $truncated = \mb_substr($str, 0, $length);
8174
8175 17
            if ($truncated === false) {
8176
                return '';
8177
            }
8178
8179
            // if the last word was truncated
8180 17
            $strPosSpace = \mb_strpos($str, ' ', $length - 1);
8181 17
            if ($strPosSpace !== $length) {
8182
                // find pos of the last occurrence of a space, get up to that
8183 13
                $lastPos = \mb_strrpos($truncated, ' ', 0);
8184
8185
                if (
8186 13
                    $lastPos !== false
8187
                    ||
8188 13
                    ($strPosSpace !== false && $ignoreDoNotSplitWordsForOneWord === false)
8189
                ) {
8190 17
                    $truncated = (string) \mb_substr($truncated, 0, (int) $lastPos);
8191
                }
8192
            }
8193
        } else {
8194 26
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
8195
8196 26
            if ($length >= (int) self::strlen($str, $encoding)) {
8197 4
                return $str;
8198
            }
8199
8200
            // need to further trim the string so we can append the substring
8201 22
            $length -= (int) self::strlen($substring, $encoding);
8202 22
            if ($length <= 0) {
8203
                return $substring;
8204
            }
8205
8206 22
            $truncated = self::substr($str, 0, $length, $encoding);
8207
8208 22
            if ($truncated === false) {
8209
                return '';
8210
            }
8211
8212
            // if the last word was truncated
8213 22
            $strPosSpace = self::strpos($str, ' ', $length - 1, $encoding);
8214 22
            if ($strPosSpace !== $length) {
8215
                // find pos of the last occurrence of a space, get up to that
8216 12
                $lastPos = self::strrpos($truncated, ' ', 0, $encoding);
8217
8218
                if (
8219 12
                    $lastPos !== false
8220
                    ||
8221 12
                    ($strPosSpace !== false && $ignoreDoNotSplitWordsForOneWord === false)
8222
                ) {
8223 9
                    $truncated = (string) self::substr($truncated, 0, (int) $lastPos, $encoding);
8224
                }
8225
            }
8226
        }
8227
8228 39
        return $truncated . $substring;
8229
    }
8230
8231
    /**
8232
     * Returns a lowercase and trimmed string separated by underscores.
8233
     * Underscores are inserted before uppercase characters (with the exception
8234
     * of the first character of the string), and in place of spaces as well as
8235
     * dashes.
8236
     *
8237
     * @param string $str
8238
     *
8239
     * @return string the underscored string
8240
     */
8241 16
    public static function str_underscored(string $str): string
8242
    {
8243 16
        return self::str_delimit($str, '_');
8244
    }
8245
8246
    /**
8247
     * Returns an UpperCamelCase version of the supplied string. It trims
8248
     * surrounding spaces, capitalizes letters following digits, spaces, dashes
8249
     * and underscores, and removes spaces, dashes, underscores.
8250
     *
8251
     * @param string      $str                   <p>The input string.</p>
8252
     * @param string      $encoding              [optional] <p>Default: 'UTF-8'</p>
8253
     * @param bool        $cleanUtf8             [optional] <p>Remove non UTF-8 chars from the string.</p>
8254
     * @param string|null $lang                  [optional] <p>Set the language for special cases: az, el, lt, tr</p>
8255
     * @param bool        $tryToKeepStringLength [optional] <p>true === try to keep the string length: e.g. ẞ -> ß</p>
8256
     *
8257
     * @return string string in UpperCamelCase
8258
     */
8259 13
    public static function str_upper_camelize(
8260
        string $str,
8261
        string $encoding = 'UTF-8',
8262
        bool $cleanUtf8 = false,
8263
        string $lang = null,
8264
        bool $tryToKeepStringLength = false
8265
    ): string {
8266 13
        return self::ucfirst(self::str_camelize($str, $encoding), $encoding, $cleanUtf8, $lang, $tryToKeepStringLength);
8267
    }
8268
8269
    /**
8270
     * alias for "UTF8::ucfirst()"
8271
     *
8272
     * @param string      $str
8273
     * @param string      $encoding
8274
     * @param bool        $cleanUtf8
8275
     * @param string|null $lang
8276
     * @param bool        $tryToKeepStringLength
8277
     *
8278
     * @return string
8279
     *
8280
     * @see UTF8::ucfirst()
8281
     */
8282 39
    public static function str_upper_first(
8283
        string $str,
8284
        string $encoding = 'UTF-8',
8285
        bool $cleanUtf8 = false,
8286
        string $lang = null,
8287
        bool $tryToKeepStringLength = false
8288
    ): string {
8289 39
        return self::ucfirst($str, $encoding, $cleanUtf8, $lang, $tryToKeepStringLength);
8290
    }
8291
8292
    /**
8293
     * Counts number of words in the UTF-8 string.
8294
     *
8295
     * @param string $str      <p>The input string.</p>
8296
     * @param int    $format   [optional] <p>
8297
     *                         <strong>0</strong> => return a number of words (default)<br>
8298
     *                         <strong>1</strong> => return an array of words<br>
8299
     *                         <strong>2</strong> => return an array of words with word-offset as key
8300
     *                         </p>
8301
     * @param string $charlist [optional] <p>Additional chars that contains to words and do not start a new word.</p>
8302
     *
8303
     * @return int|string[] The number of words in the string
8304
     */
8305 2
    public static function str_word_count(string $str, int $format = 0, string $charlist = '')
8306
    {
8307 2
        $strParts = self::str_to_words($str, $charlist);
8308
8309 2
        $len = \count($strParts);
8310
8311 2
        if ($format === 1) {
8312 2
            $numberOfWords = [];
8313 2
            for ($i = 1; $i < $len; $i += 2) {
8314 2
                $numberOfWords[] = $strParts[$i];
8315
            }
8316 2
        } elseif ($format === 2) {
8317 2
            $numberOfWords = [];
8318 2
            $offset = (int) self::strlen($strParts[0]);
8319 2
            for ($i = 1; $i < $len; $i += 2) {
8320 2
                $numberOfWords[$offset] = $strParts[$i];
8321 2
                $offset += (int) self::strlen($strParts[$i]) + (int) self::strlen($strParts[$i + 1]);
8322
            }
8323
        } else {
8324 2
            $numberOfWords = (int) (($len - 1) / 2);
8325
        }
8326
8327 2
        return $numberOfWords;
8328
    }
8329
8330
    /**
8331
     * Case-insensitive string comparison.
8332
     *
8333
     * INFO: Case-insensitive version of UTF8::strcmp()
8334
     *
8335
     * @param string $str1     <p>The first string.</p>
8336
     * @param string $str2     <p>The second string.</p>
8337
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
8338
     *
8339
     * @return int
8340
     *             <strong>&lt; 0</strong> if str1 is less than str2;<br>
8341
     *             <strong>&gt; 0</strong> if str1 is greater than str2,<br>
8342
     *             <strong>0</strong> if they are equal
8343
     */
8344 23
    public static function strcasecmp(string $str1, string $str2, string $encoding = 'UTF-8'): int
8345
    {
8346 23
        return self::strcmp(
8347 23
            self::strtocasefold($str1, true, false, $encoding, null, false),
8348 23
            self::strtocasefold($str2, true, false, $encoding, null, false)
8349
        );
8350
    }
8351
8352
    /**
8353
     * alias for "UTF8::strstr()"
8354
     *
8355
     * @param string $haystack
8356
     * @param string $needle
8357
     * @param bool   $before_needle
8358
     * @param string $encoding
8359
     * @param bool   $cleanUtf8
8360
     *
8361
     * @return false|string
8362
     *
8363
     * @see UTF8::strstr()
8364
     */
8365 2
    public static function strchr(
8366
        string $haystack,
8367
        string $needle,
8368
        bool $before_needle = false,
8369
        string $encoding = 'UTF-8',
8370
        bool $cleanUtf8 = false
8371
    ) {
8372 2
        return self::strstr($haystack, $needle, $before_needle, $encoding, $cleanUtf8);
8373
    }
8374
8375
    /**
8376
     * Case-sensitive string comparison.
8377
     *
8378
     * @param string $str1 <p>The first string.</p>
8379
     * @param string $str2 <p>The second string.</p>
8380
     *
8381
     * @return int
8382
     *             <strong>&lt; 0</strong> if str1 is less than str2<br>
8383
     *             <strong>&gt; 0</strong> if str1 is greater than str2<br>
8384
     *             <strong>0</strong> if they are equal
8385
     */
8386 29
    public static function strcmp(string $str1, string $str2): int
8387
    {
8388 29
        if ($str1 === $str2) {
8389 21
            return 0;
8390
        }
8391
8392 24
        return \strcmp(
8393 24
            \Normalizer::normalize($str1, \Normalizer::NFD),
8394 24
            \Normalizer::normalize($str2, \Normalizer::NFD)
8395
        );
8396
    }
8397
8398
    /**
8399
     * Find length of initial segment not matching mask.
8400
     *
8401
     * @param string $str
8402
     * @param string $charList
8403
     * @param int    $offset
8404
     * @param int    $length
8405
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
8406
     *
8407
     * @return int
8408
     */
8409 12
    public static function strcspn(
8410
        string $str,
8411
        string $charList,
8412
        int $offset = null,
8413
        int $length = null,
8414
        string $encoding = 'UTF-8'
8415
    ): int {
8416 12
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
8417
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
8418
        }
8419
8420 12
        if ($charList === '') {
8421 2
            return (int) self::strlen($str, $encoding);
8422
        }
8423
8424 11
        if ($offset !== null || $length !== null) {
8425 3
            if ($encoding === 'UTF-8') {
8426 3
                if ($length === null) {
8427
                    /** @noinspection UnnecessaryCastingInspection */
8428 2
                    $strTmp = \mb_substr($str, (int) $offset);
8429
                } else {
8430
                    /** @noinspection UnnecessaryCastingInspection */
8431 3
                    $strTmp = \mb_substr($str, (int) $offset, $length);
8432
                }
8433
            } else {
8434
                /** @noinspection UnnecessaryCastingInspection */
8435
                $strTmp = self::substr($str, (int) $offset, $length, $encoding);
8436
            }
8437
8438 3
            if ($strTmp === false) {
8439
                return 0;
8440
            }
8441
8442 3
            $str = $strTmp;
8443
        }
8444
8445 11
        if ($str === '') {
8446 2
            return 0;
8447
        }
8448
8449 10
        $matches = [];
8450 10
        if (\preg_match('/^(.*?)' . self::rxClass($charList) . '/us', $str, $matches)) {
8451 9
            $return = self::strlen($matches[1], $encoding);
8452 9
            if ($return === false) {
8453
                return 0;
8454
            }
8455
8456 9
            return $return;
8457
        }
8458
8459 2
        return (int) self::strlen($str, $encoding);
8460
    }
8461
8462
    /**
8463
     * alias for "UTF8::stristr()"
8464
     *
8465
     * @param string $haystack
8466
     * @param string $needle
8467
     * @param bool   $before_needle
8468
     * @param string $encoding
8469
     * @param bool   $cleanUtf8
8470
     *
8471
     * @return false|string
8472
     *
8473
     * @see UTF8::stristr()
8474
     */
8475 1
    public static function strichr(
8476
        string $haystack,
8477
        string $needle,
8478
        bool $before_needle = false,
8479
        string $encoding = 'UTF-8',
8480
        bool $cleanUtf8 = false
8481
    ) {
8482 1
        return self::stristr($haystack, $needle, $before_needle, $encoding, $cleanUtf8);
8483
    }
8484
8485
    /**
8486
     * Create a UTF-8 string from code points.
8487
     *
8488
     * INFO: opposite to UTF8::codepoints()
8489
     *
8490
     * @param array $array <p>Integer or Hexadecimal codepoints.</p>
8491
     *
8492
     * @return string UTF-8 encoded string
8493
     */
8494 4
    public static function string(array $array): string
8495
    {
8496 4
        return \implode(
8497 4
            '',
8498 4
            \array_map(
8499
                [
8500 4
                    self::class,
8501
                    'chr',
8502
                ],
8503 4
                $array
8504
            )
8505
        );
8506
    }
8507
8508
    /**
8509
     * Checks if string starts with "BOM" (Byte Order Mark Character) character.
8510
     *
8511
     * @param string $str <p>The input string.</p>
8512
     *
8513
     * @return bool
8514
     *              <strong>true</strong> if the string has BOM at the start,<br>
8515
     *              <strong>false</strong> otherwise
8516
     */
8517 6
    public static function string_has_bom(string $str): bool
8518
    {
8519
        /** @noinspection PhpUnusedLocalVariableInspection */
8520 6
        foreach (self::$BOM as $bomString => &$bomByteLength) {
8521 6
            if (\strpos($str, $bomString) === 0) {
8522 6
                return true;
8523
            }
8524
        }
8525
8526 6
        return false;
8527
    }
8528
8529
    /**
8530
     * Strip HTML and PHP tags from a string + clean invalid UTF-8.
8531
     *
8532
     * @see http://php.net/manual/en/function.strip-tags.php
8533
     *
8534
     * @param string $str            <p>
8535
     *                               The input string.
8536
     *                               </p>
8537
     * @param string $allowable_tags [optional] <p>
8538
     *                               You can use the optional second parameter to specify tags which should
8539
     *                               not be stripped.
8540
     *                               </p>
8541
     *                               <p>
8542
     *                               HTML comments and PHP tags are also stripped. This is hardcoded and
8543
     *                               can not be changed with allowable_tags.
8544
     *                               </p>
8545
     * @param bool   $cleanUtf8      [optional] <p>Remove non UTF-8 chars from the string.</p>
8546
     *
8547
     * @return string the stripped string
8548
     */
8549 4
    public static function strip_tags(string $str, string $allowable_tags = null, bool $cleanUtf8 = false): string
8550
    {
8551 4
        if ($str === '') {
8552 1
            return '';
8553
        }
8554
8555 4
        if ($cleanUtf8 === true) {
8556 2
            $str = self::clean($str);
8557
        }
8558
8559 4
        if ($allowable_tags === null) {
8560 4
            return \strip_tags($str);
8561
        }
8562
8563 2
        return \strip_tags($str, $allowable_tags);
8564
    }
8565
8566
    /**
8567
     * Strip all whitespace characters. This includes tabs and newline
8568
     * characters, as well as multibyte whitespace such as the thin space
8569
     * and ideographic space.
8570
     *
8571
     * @param string $str
8572
     *
8573
     * @return string
8574
     */
8575 36
    public static function strip_whitespace(string $str): string
8576
    {
8577 36
        if ($str === '') {
8578 3
            return '';
8579
        }
8580
8581 33
        return (string) \preg_replace('/[[:space:]]+/u', '', $str);
8582
    }
8583
8584
    /**
8585
     * Finds position of first occurrence of a string within another, case insensitive.
8586
     *
8587
     * @see http://php.net/manual/en/function.mb-stripos.php
8588
     *
8589
     * @param string $haystack  <p>The string from which to get the position of the first occurrence of needle.</p>
8590
     * @param string $needle    <p>The string to find in haystack.</p>
8591
     * @param int    $offset    [optional] <p>The position in haystack to start searching.</p>
8592
     * @param string $encoding  [optional] <p>Set the charset for e.g. "mb_" function</p>
8593
     * @param bool   $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
8594
     *
8595
     * @return false|int
8596
     *                   Return the <strong>(int)</strong> numeric position of the first occurrence of needle in the
8597
     *                   haystack string,<br> or <strong>false</strong> if needle is not found
8598
     */
8599 24
    public static function stripos(
8600
        string $haystack,
8601
        string $needle,
8602
        int $offset = 0,
8603
        $encoding = 'UTF-8',
8604
        bool $cleanUtf8 = false
8605
    ) {
8606 24
        if ($haystack === '' || $needle === '') {
8607 5
            return false;
8608
        }
8609
8610 23
        if ($cleanUtf8 === true) {
8611
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
8612
            // if invalid characters are found in $haystack before $needle
8613 1
            $haystack = self::clean($haystack);
8614 1
            $needle = self::clean($needle);
8615
        }
8616
8617 23
        if (self::$SUPPORT['mbstring'] === true) {
8618 23
            if ($encoding === 'UTF-8') {
8619 23
                return \mb_stripos($haystack, $needle, $offset);
8620
            }
8621
8622 3
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
8623
8624 3
            return \mb_stripos($haystack, $needle, $offset, $encoding);
8625
        }
8626
8627 2
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
8628
8629
        if (
8630 2
            $encoding === 'UTF-8' // INFO: "grapheme_stripos()" can't handle other encodings
8631
            &&
8632 2
            $offset >= 0 // grapheme_stripos() can't handle negative offset
8633
            &&
8634 2
            self::$SUPPORT['intl'] === true
8635
        ) {
8636
            $returnTmp = \grapheme_stripos($haystack, $needle, $offset);
8637
            if ($returnTmp !== false) {
8638
                return $returnTmp;
8639
            }
8640
        }
8641
8642
        //
8643
        // fallback for ascii only
8644
        //
8645
8646 2
        if (self::is_ascii($haystack . $needle)) {
8647
            return \stripos($haystack, $needle, $offset);
8648
        }
8649
8650
        //
8651
        // fallback via vanilla php
8652
        //
8653
8654 2
        $haystack = self::strtocasefold($haystack, true, false, $encoding, null, false);
8655 2
        $needle = self::strtocasefold($needle, true, false, $encoding, null, false);
8656
8657 2
        return self::strpos($haystack, $needle, $offset, $encoding);
8658
    }
8659
8660
    /**
8661
     * Returns all of haystack starting from and including the first occurrence of needle to the end.
8662
     *
8663
     * @param string $haystack      <p>The input string. Must be valid UTF-8.</p>
8664
     * @param string $needle        <p>The string to look for. Must be valid UTF-8.</p>
8665
     * @param bool   $before_needle [optional] <p>
8666
     *                              If <b>TRUE</b>, it returns the part of the
8667
     *                              haystack before the first occurrence of the needle (excluding the needle).
8668
     *                              </p>
8669
     * @param string $encoding      [optional] <p>Set the charset for e.g. "mb_" function</p>
8670
     * @param bool   $cleanUtf8     [optional] <p>Remove non UTF-8 chars from the string.</p>
8671
     *
8672
     * @return false|string a sub-string,<br>or <strong>false</strong> if needle is not found
8673
     */
8674 12
    public static function stristr(
8675
        string $haystack,
8676
        string $needle,
8677
        bool $before_needle = false,
8678
        string $encoding = 'UTF-8',
8679
        bool $cleanUtf8 = false
8680
    ) {
8681 12
        if ($haystack === '' || $needle === '') {
8682 3
            return false;
8683
        }
8684
8685 9
        if ($cleanUtf8 === true) {
8686
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
8687
            // if invalid characters are found in $haystack before $needle
8688 1
            $needle = self::clean($needle);
8689 1
            $haystack = self::clean($haystack);
8690
        }
8691
8692 9
        if (!$needle) {
8693
            return $haystack;
8694
        }
8695
8696 9
        if (self::$SUPPORT['mbstring'] === true) {
8697 9
            if ($encoding === 'UTF-8') {
8698 9
                return \mb_stristr($haystack, $needle, $before_needle);
8699
            }
8700
8701 1
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
8702
8703 1
            return \mb_stristr($haystack, $needle, $before_needle, $encoding);
8704
        }
8705
8706
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
8707
8708
        if (
8709
            $encoding !== 'UTF-8'
8710
            &&
8711
            self::$SUPPORT['mbstring'] === false
8712
        ) {
8713
            \trigger_error('UTF8::stristr() without mbstring cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
8714
        }
8715
8716
        if (
8717
            $encoding === 'UTF-8' // INFO: "grapheme_stristr()" can't handle other encodings
8718
            &&
8719
            self::$SUPPORT['intl'] === true
8720
        ) {
8721
            $returnTmp = \grapheme_stristr($haystack, $needle, $before_needle);
8722
            if ($returnTmp !== false) {
8723
                return $returnTmp;
8724
            }
8725
        }
8726
8727
        if (self::is_ascii($needle . $haystack)) {
8728
            return \stristr($haystack, $needle, $before_needle);
8729
        }
8730
8731
        \preg_match('/^(.*?)' . \preg_quote($needle, '/') . '/usi', $haystack, $match);
8732
8733
        if (!isset($match[1])) {
8734
            return false;
8735
        }
8736
8737
        if ($before_needle) {
8738
            return $match[1];
8739
        }
8740
8741
        return self::substr($haystack, (int) self::strlen($match[1], $encoding), null, $encoding);
8742
    }
8743
8744
    /**
8745
     * Get the string length, not the byte-length!
8746
     *
8747
     * @see http://php.net/manual/en/function.mb-strlen.php
8748
     *
8749
     * @param string $str       <p>The string being checked for length.</p>
8750
     * @param string $encoding  [optional] <p>Set the charset for e.g. "mb_" function</p>
8751
     * @param bool   $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
8752
     *
8753
     * @return false|int
8754
     *                   The number <strong>(int)</strong> of characters in the string $str having character encoding
8755
     *                   $encoding.
8756
     *                   (One multi-byte character counted as +1).
8757
     *                   <br>
8758
     *                   Can return <strong>false</strong>, if e.g. mbstring is not installed and we process invalid
8759
     *                   chars.
8760
     */
8761 173
    public static function strlen(string $str, string $encoding = 'UTF-8', bool $cleanUtf8 = false)
8762
    {
8763 173
        if ($str === '') {
8764 21
            return 0;
8765
        }
8766
8767 171
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
8768 12
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
8769
        }
8770
8771 171
        if ($cleanUtf8 === true) {
8772
            // "mb_strlen" and "\iconv_strlen" returns wrong length,
8773
            // if invalid characters are found in $str
8774 4
            $str = self::clean($str);
8775
        }
8776
8777
        //
8778
        // fallback via mbstring
8779
        //
8780
8781 171
        if (self::$SUPPORT['mbstring'] === true) {
8782 165
            if ($encoding === 'UTF-8') {
8783 165
                return \mb_strlen($str);
8784
            }
8785
8786 4
            return \mb_strlen($str, $encoding);
8787
        }
8788
8789
        //
8790
        // fallback for binary || ascii only
8791
        //
8792
8793
        if (
8794 8
            $encoding === 'CP850'
8795
            ||
8796 8
            $encoding === 'ASCII'
8797
        ) {
8798
            return \strlen($str);
8799
        }
8800
8801
        if (
8802 8
            $encoding !== 'UTF-8'
8803
            &&
8804 8
            self::$SUPPORT['mbstring'] === false
8805
            &&
8806 8
            self::$SUPPORT['iconv'] === false
8807
        ) {
8808 2
            \trigger_error('UTF8::strlen() without mbstring / iconv cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
8809
        }
8810
8811
        //
8812
        // fallback via iconv
8813
        //
8814
8815 8
        if (self::$SUPPORT['iconv'] === true) {
8816
            $returnTmp = \iconv_strlen($str, $encoding);
8817
            if ($returnTmp !== false) {
8818
                return $returnTmp;
8819
            }
8820
        }
8821
8822
        //
8823
        // fallback via intl
8824
        //
8825
8826
        if (
8827 8
            $encoding === 'UTF-8' // INFO: "grapheme_strlen()" can't handle other encodings
8828
            &&
8829 8
            self::$SUPPORT['intl'] === true
8830
        ) {
8831
            $returnTmp = \grapheme_strlen($str);
8832
            if ($returnTmp !== null) {
8833
                return $returnTmp;
8834
            }
8835
        }
8836
8837
        //
8838
        // fallback for ascii only
8839
        //
8840
8841 8
        if (self::is_ascii($str)) {
8842 4
            return \strlen($str);
8843
        }
8844
8845
        //
8846
        // fallback via vanilla php
8847
        //
8848
8849 8
        \preg_match_all('/./us', $str, $parts);
8850
8851 8
        $returnTmp = \count($parts[0]);
8852 8
        if ($returnTmp === 0) {
8853
            return false;
8854
        }
8855
8856 8
        return $returnTmp;
8857
    }
8858
8859
    /**
8860
     * Get string length in byte.
8861
     *
8862
     * @param string $str
8863
     *
8864
     * @return int
8865
     */
8866
    public static function strlen_in_byte(string $str): int
8867
    {
8868
        if ($str === '') {
8869
            return 0;
8870
        }
8871
8872
        if (self::$SUPPORT['mbstring_func_overload'] === true) {
8873
            // "mb_" is available if overload is used, so use it ...
8874
            return \mb_strlen($str, 'CP850'); // 8-BIT
8875
        }
8876
8877
        return \strlen($str);
8878
    }
8879
8880
    /**
8881
     * Case insensitive string comparisons using a "natural order" algorithm.
8882
     *
8883
     * INFO: natural order version of UTF8::strcasecmp()
8884
     *
8885
     * @param string $str1     <p>The first string.</p>
8886
     * @param string $str2     <p>The second string.</p>
8887
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
8888
     *
8889
     * @return int
8890
     *             <strong>&lt; 0</strong> if str1 is less than str2<br>
8891
     *             <strong>&gt; 0</strong> if str1 is greater than str2<br>
8892
     *             <strong>0</strong> if they are equal
8893
     */
8894 2
    public static function strnatcasecmp(string $str1, string $str2, string $encoding = 'UTF-8'): int
8895
    {
8896 2
        return self::strnatcmp(
8897 2
            self::strtocasefold($str1, true, false, $encoding, null, false),
8898 2
            self::strtocasefold($str2, true, false, $encoding, null, false)
8899
        );
8900
    }
8901
8902
    /**
8903
     * String comparisons using a "natural order" algorithm
8904
     *
8905
     * INFO: natural order version of UTF8::strcmp()
8906
     *
8907
     * @see http://php.net/manual/en/function.strnatcmp.php
8908
     *
8909
     * @param string $str1 <p>The first string.</p>
8910
     * @param string $str2 <p>The second string.</p>
8911
     *
8912
     * @return int
8913
     *             <strong>&lt; 0</strong> if str1 is less than str2;<br>
8914
     *             <strong>&gt; 0</strong> if str1 is greater than str2;<br>
8915
     *             <strong>0</strong> if they are equal
8916
     */
8917 4
    public static function strnatcmp(string $str1, string $str2): int
8918
    {
8919 4
        if ($str1 === $str2) {
8920 4
            return 0;
8921
        }
8922
8923 4
        return \strnatcmp(
8924 4
            (string)self::strtonatfold($str1),
8925 4
            (string)self::strtonatfold($str2)
8926
        );
8927
    }
8928
8929
    /**
8930
     * Case-insensitive string comparison of the first n characters.
8931
     *
8932
     * @see http://php.net/manual/en/function.strncasecmp.php
8933
     *
8934
     * @param string $str1     <p>The first string.</p>
8935
     * @param string $str2     <p>The second string.</p>
8936
     * @param int    $len      <p>The length of strings to be used in the comparison.</p>
8937
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
8938
     *
8939
     * @return int
8940
     *             <strong>&lt; 0</strong> if <i>str1</i> is less than <i>str2</i>;<br>
8941
     *             <strong>&gt; 0</strong> if <i>str1</i> is greater than <i>str2</i>;<br>
8942
     *             <strong>0</strong> if they are equal
8943
     */
8944 2
    public static function strncasecmp(
8945
        string $str1,
8946
        string $str2,
8947
        int $len,
8948
        string $encoding = 'UTF-8'
8949
    ): int {
8950 2
        return self::strncmp(
8951 2
            self::strtocasefold($str1, true, false, $encoding, null, false),
8952 2
            self::strtocasefold($str2, true, false, $encoding, null, false),
8953 2
            $len
8954
        );
8955
    }
8956
8957
    /**
8958
     * String comparison of the first n characters.
8959
     *
8960
     * @see http://php.net/manual/en/function.strncmp.php
8961
     *
8962
     * @param string $str1     <p>The first string.</p>
8963
     * @param string $str2     <p>The second string.</p>
8964
     * @param int    $len      <p>Number of characters to use in the comparison.</p>
8965
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
8966
     *
8967
     * @return int
8968
     *             <strong>&lt; 0</strong> if <i>str1</i> is less than <i>str2</i>;<br>
8969
     *             <strong>&gt; 0</strong> if <i>str1</i> is greater than <i>str2</i>;<br>
8970
     *             <strong>0</strong> if they are equal
8971
     */
8972 4
    public static function strncmp(
8973
        string $str1,
8974
        string $str2,
8975
        int $len,
8976
        string $encoding = 'UTF-8'
8977
    ): int {
8978 4
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
8979
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
8980
        }
8981
8982 4
        if ($encoding === 'UTF-8') {
8983 4
            $str1 = (string) \mb_substr($str1, 0, $len);
8984 4
            $str2 = (string) \mb_substr($str2, 0, $len);
8985
        } else {
8986
            $str1 = (string) self::substr($str1, 0, $len, $encoding);
8987
            $str2 = (string) self::substr($str2, 0, $len, $encoding);
8988
        }
8989
8990 4
        return self::strcmp($str1, $str2);
8991
    }
8992
8993
    /**
8994
     * Search a string for any of a set of characters.
8995
     *
8996
     * @see http://php.net/manual/en/function.strpbrk.php
8997
     *
8998
     * @param string $haystack  <p>The string where char_list is looked for.</p>
8999
     * @param string $char_list <p>This parameter is case sensitive.</p>
9000
     *
9001
     * @return false|string string starting from the character found, or false if it is not found
9002
     */
9003 2
    public static function strpbrk(string $haystack, string $char_list)
9004
    {
9005 2
        if ($haystack === '' || $char_list === '') {
9006 2
            return false;
9007
        }
9008
9009 2
        if (\preg_match('/' . self::rxClass($char_list) . '/us', $haystack, $m)) {
9010 2
            return \substr($haystack, (int) \strpos($haystack, $m[0]));
9011
        }
9012
9013 2
        return false;
9014
    }
9015
9016
    /**
9017
     * Find position of first occurrence of string in a string.
9018
     *
9019
     * @see http://php.net/manual/en/function.mb-strpos.php
9020
     *
9021
     * @param string     $haystack  <p>The string from which to get the position of the first occurrence of needle.</p>
9022
     * @param int|string $needle    <p>The string to find in haystack.<br>Or a code point as int.</p>
9023
     * @param int        $offset    [optional] <p>The search offset. If it is not specified, 0 is used.</p>
9024
     * @param string     $encoding  [optional] <p>Set the charset for e.g. "mb_" function</p>
9025
     * @param bool       $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
9026
     *
9027
     * @return false|int
9028
     *                   The <strong>(int)</strong> numeric position of the first occurrence of needle in the haystack
9029
     *                   string.<br> If needle is not found it returns false.
9030
     */
9031 53
    public static function strpos(
9032
        string $haystack,
9033
        $needle,
9034
        int $offset = 0,
9035
        $encoding = 'UTF-8',
9036
        bool $cleanUtf8 = false
9037
    ) {
9038 53
        if ($haystack === '') {
9039 4
            return false;
9040
        }
9041
9042
        // iconv and mbstring do not support integer $needle
9043 52
        if ((int) $needle === $needle) {
9044
            $needle = (string) self::chr($needle);
9045
        }
9046 52
        $needle = (string) $needle;
9047
9048 52
        if ($needle === '') {
9049 2
            return false;
9050
        }
9051
9052 52
        if ($cleanUtf8 === true) {
9053
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
9054
            // if invalid characters are found in $haystack before $needle
9055 3
            $needle = self::clean($needle);
9056 3
            $haystack = self::clean($haystack);
9057
        }
9058
9059 52
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
9060 11
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
9061
        }
9062
9063
        //
9064
        // fallback via mbstring
9065
        //
9066
9067 52
        if (self::$SUPPORT['mbstring'] === true) {
9068 50
            if ($encoding === 'UTF-8') {
9069 50
                return \mb_strpos($haystack, $needle, $offset);
9070
            }
9071
9072 2
            return \mb_strpos($haystack, $needle, $offset, $encoding);
9073
        }
9074
9075
        //
9076
        // fallback for binary || ascii only
9077
        //
9078
        if (
9079 4
            $encoding === 'CP850'
9080
            ||
9081 4
            $encoding === 'ASCII'
9082
        ) {
9083 2
            return \strpos($haystack, $needle, $offset);
9084
        }
9085
9086
        if (
9087 4
            $encoding !== 'UTF-8'
9088
            &&
9089 4
            self::$SUPPORT['iconv'] === false
9090
            &&
9091 4
            self::$SUPPORT['mbstring'] === false
9092
        ) {
9093 2
            \trigger_error('UTF8::strpos() without mbstring / iconv cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
9094
        }
9095
9096
        //
9097
        // fallback via intl
9098
        //
9099
9100
        if (
9101 4
            $encoding === 'UTF-8' // INFO: "grapheme_strpos()" can't handle other encodings
9102
            &&
9103 4
            $offset >= 0 // grapheme_strpos() can't handle negative offset
9104
            &&
9105 4
            self::$SUPPORT['intl'] === true
9106
        ) {
9107
            $returnTmp = \grapheme_strpos($haystack, $needle, $offset);
9108
            if ($returnTmp !== false) {
9109
                return $returnTmp;
9110
            }
9111
        }
9112
9113
        //
9114
        // fallback via iconv
9115
        //
9116
9117
        if (
9118 4
            $offset >= 0 // iconv_strpos() can't handle negative offset
9119
            &&
9120 4
            self::$SUPPORT['iconv'] === true
9121
        ) {
9122
            // ignore invalid negative offset to keep compatibility
9123
            // with php < 5.5.35, < 5.6.21, < 7.0.6
9124
            $returnTmp = \iconv_strpos($haystack, $needle, $offset > 0 ? $offset : 0, $encoding);
9125
            if ($returnTmp !== false) {
9126
                return $returnTmp;
9127
            }
9128
        }
9129
9130
        //
9131
        // fallback for ascii only
9132
        //
9133
9134 4
        if (self::is_ascii($haystack . $needle)) {
9135 2
            return \strpos($haystack, $needle, $offset);
9136
        }
9137
9138
        //
9139
        // fallback via vanilla php
9140
        //
9141
9142 4
        $haystackTmp = self::substr($haystack, $offset, null, $encoding);
9143 4
        if ($haystackTmp === false) {
9144
            $haystackTmp = '';
9145
        }
9146 4
        $haystack = (string) $haystackTmp;
9147
9148 4
        if ($offset < 0) {
9149
            $offset = 0;
9150
        }
9151
9152 4
        $pos = \strpos($haystack, $needle);
9153 4
        if ($pos === false) {
9154 2
            return false;
9155
        }
9156
9157 4
        if ($pos) {
9158 4
            return $offset + (int) self::strlen(\substr($haystack, 0, $pos), $encoding);
9159
        }
9160
9161 2
        return $offset + 0;
9162
    }
9163
9164
    /**
9165
     * Find position of first occurrence of string in a string.
9166
     *
9167
     * @param string $haystack <p>
9168
     *                         The string being checked.
9169
     *                         </p>
9170
     * @param string $needle   <p>
9171
     *                         The position counted from the beginning of haystack.
9172
     *                         </p>
9173
     * @param int    $offset   [optional] <p>
9174
     *                         The search offset. If it is not specified, 0 is used.
9175
     *                         </p>
9176
     *
9177
     * @return false|int The numeric position of the first occurrence of needle in the
9178
     *                   haystack string. If needle is not found, it returns false.
9179
     */
9180
    public static function strpos_in_byte(string $haystack, string $needle, int $offset = 0)
9181
    {
9182
        if ($haystack === '' || $needle === '') {
9183
            return false;
9184
        }
9185
9186
        if (self::$SUPPORT['mbstring_func_overload'] === true) {
9187
            // "mb_" is available if overload is used, so use it ...
9188
            return \mb_strpos($haystack, $needle, $offset, 'CP850'); // 8-BIT
9189
        }
9190
9191
        return \strpos($haystack, $needle, $offset);
9192
    }
9193
9194
    /**
9195
     * Finds the last occurrence of a character in a string within another.
9196
     *
9197
     * @see http://php.net/manual/en/function.mb-strrchr.php
9198
     *
9199
     * @param string $haystack      <p>The string from which to get the last occurrence of needle.</p>
9200
     * @param string $needle        <p>The string to find in haystack</p>
9201
     * @param bool   $before_needle [optional] <p>
9202
     *                              Determines which portion of haystack
9203
     *                              this function returns.
9204
     *                              If set to true, it returns all of haystack
9205
     *                              from the beginning to the last occurrence of needle.
9206
     *                              If set to false, it returns all of haystack
9207
     *                              from the last occurrence of needle to the end,
9208
     *                              </p>
9209
     * @param string $encoding      [optional] <p>Set the charset for e.g. "mb_" function</p>
9210
     * @param bool   $cleanUtf8     [optional] <p>Remove non UTF-8 chars from the string.</p>
9211
     *
9212
     * @return false|string the portion of haystack or false if needle is not found
9213
     */
9214 2
    public static function strrchr(
9215
        string $haystack,
9216
        string $needle,
9217
        bool $before_needle = false,
9218
        string $encoding = 'UTF-8',
9219
        bool $cleanUtf8 = false
9220
    ) {
9221 2
        if ($haystack === '' || $needle === '') {
9222 2
            return false;
9223
        }
9224
9225 2
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
9226 2
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
9227
        }
9228
9229 2
        if ($cleanUtf8 === true) {
9230
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
9231
            // if invalid characters are found in $haystack before $needle
9232 2
            $needle = self::clean($needle);
9233 2
            $haystack = self::clean($haystack);
9234
        }
9235
9236
        //
9237
        // fallback via mbstring
9238
        //
9239
9240 2
        if (self::$SUPPORT['mbstring'] === true) {
9241 2
            if ($encoding === 'UTF-8') {
9242 2
                return \mb_strrchr($haystack, $needle, $before_needle);
9243
            }
9244
9245 2
            return \mb_strrchr($haystack, $needle, $before_needle, $encoding);
9246
        }
9247
9248
        //
9249
        // fallback for binary || ascii only
9250
        //
9251
9252
        if (
9253
            $before_needle === false
9254
            &&
9255
            (
9256
                $encoding === 'CP850'
9257
                ||
9258
                $encoding === 'ASCII'
9259
            )
9260
        ) {
9261
            return \strrchr($haystack, $needle);
9262
        }
9263
9264
        if (
9265
            $encoding !== 'UTF-8'
9266
            &&
9267
            self::$SUPPORT['mbstring'] === false
9268
        ) {
9269
            \trigger_error('UTF8::strrchr() without mbstring cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
9270
        }
9271
9272
        //
9273
        // fallback via iconv
9274
        //
9275
9276
        if (self::$SUPPORT['iconv'] === true) {
9277
            $needleTmp = self::substr($needle, 0, 1, $encoding);
9278
            if ($needleTmp === false) {
9279
                return false;
9280
            }
9281
            $needle = (string) $needleTmp;
9282
9283
            $pos = \iconv_strrpos($haystack, $needle, $encoding);
9284
            if ($pos === false) {
9285
                return false;
9286
            }
9287
9288
            if ($before_needle) {
9289
                return self::substr($haystack, 0, $pos, $encoding);
9290
            }
9291
9292
            return self::substr($haystack, $pos, null, $encoding);
9293
        }
9294
9295
        //
9296
        // fallback via vanilla php
9297
        //
9298
9299
        $needleTmp = self::substr($needle, 0, 1, $encoding);
9300
        if ($needleTmp === false) {
9301
            return false;
9302
        }
9303
        $needle = (string) $needleTmp;
9304
9305
        $pos = self::strrpos($haystack, $needle, 0, $encoding);
9306
        if ($pos === false) {
9307
            return false;
9308
        }
9309
9310
        if ($before_needle) {
9311
            return self::substr($haystack, 0, $pos, $encoding);
9312
        }
9313
9314
        return self::substr($haystack, $pos, null, $encoding);
9315
    }
9316
9317
    /**
9318
     * Reverses characters order in the string.
9319
     *
9320
     * @param string $str      <p>The input string.</p>
9321
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
9322
     *
9323
     * @return string the string with characters in the reverse sequence
9324
     */
9325 10
    public static function strrev(string $str, string $encoding = 'UTF-8'): string
9326
    {
9327 10
        if ($str === '') {
9328 4
            return '';
9329
        }
9330
9331
        // init
9332 8
        $reversed = '';
9333
9334 8
        $str = self::emoji_encode($str, true);
9335
9336 8
        if ($encoding === 'UTF-8') {
9337 8
            if (self::$SUPPORT['intl'] === true) {
9338
                // try "grapheme" first: https://stackoverflow.com/questions/17496493/strrev-dosent-support-utf-8
9339 8
                $i = (int) \grapheme_strlen($str);
9340 8
                while ($i--) {
9341 8
                    $reversedTmp = \grapheme_substr($str, $i, 1);
9342 8
                    if ($reversedTmp !== false) {
9343 8
                        $reversed .= $reversedTmp;
9344
                    }
9345
                }
9346
            } else {
9347
                $i = (int) \mb_strlen($str);
9348 8
                while ($i--) {
9349
                    $reversedTmp = \mb_substr($str, $i, 1);
9350
                    if ($reversedTmp !== false) {
9351
                        $reversed .= $reversedTmp;
9352
                    }
9353
                }
9354
            }
9355
        } else {
9356
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
9357
9358
            $i = (int) self::strlen($str, $encoding);
9359
            while ($i--) {
9360
                $reversedTmp = self::substr($str, $i, 1, $encoding);
9361
                if ($reversedTmp !== false) {
9362
                    $reversed .= $reversedTmp;
9363
                }
9364
            }
9365
        }
9366
9367 8
        return self::emoji_decode($reversed, true);
9368
    }
9369
9370
    /**
9371
     * Finds the last occurrence of a character in a string within another, case insensitive.
9372
     *
9373
     * @see http://php.net/manual/en/function.mb-strrichr.php
9374
     *
9375
     * @param string $haystack      <p>The string from which to get the last occurrence of needle.</p>
9376
     * @param string $needle        <p>The string to find in haystack.</p>
9377
     * @param bool   $before_needle [optional] <p>
9378
     *                              Determines which portion of haystack
9379
     *                              this function returns.
9380
     *                              If set to true, it returns all of haystack
9381
     *                              from the beginning to the last occurrence of needle.
9382
     *                              If set to false, it returns all of haystack
9383
     *                              from the last occurrence of needle to the end,
9384
     *                              </p>
9385
     * @param string $encoding      [optional] <p>Set the charset for e.g. "mb_" function</p>
9386
     * @param bool   $cleanUtf8     [optional] <p>Remove non UTF-8 chars from the string.</p>
9387
     *
9388
     * @return false|string the portion of haystack or<br>false if needle is not found
9389
     */
9390 3
    public static function strrichr(
9391
        string $haystack,
9392
        string $needle,
9393
        bool $before_needle = false,
9394
        string $encoding = 'UTF-8',
9395
        bool $cleanUtf8 = false
9396
    ) {
9397 3
        if ($haystack === '' || $needle === '') {
9398 2
            return false;
9399
        }
9400
9401 3
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
9402 2
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
9403
        }
9404
9405 3
        if ($cleanUtf8 === true) {
9406
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
9407
            // if invalid characters are found in $haystack before $needle
9408 2
            $needle = self::clean($needle);
9409 2
            $haystack = self::clean($haystack);
9410
        }
9411
9412
        //
9413
        // fallback via mbstring
9414
        //
9415
9416 3
        if (self::$SUPPORT['mbstring'] === true) {
9417 3
            if ($encoding === 'UTF-8') {
9418 3
                return \mb_strrichr($haystack, $needle, $before_needle);
9419
            }
9420
9421 2
            return \mb_strrichr($haystack, $needle, $before_needle, $encoding);
9422
        }
9423
9424
        //
9425
        // fallback via vanilla php
9426
        //
9427
9428
        $needleTmp = self::substr($needle, 0, 1, $encoding);
9429
        if ($needleTmp === false) {
9430
            return false;
9431
        }
9432
        $needle = (string) $needleTmp;
9433
9434
        $pos = self::strripos($haystack, $needle, 0, $encoding);
9435
        if ($pos === false) {
9436
            return false;
9437
        }
9438
9439
        if ($before_needle) {
9440
            return self::substr($haystack, 0, $pos, $encoding);
9441
        }
9442
9443
        return self::substr($haystack, $pos, null, $encoding);
9444
    }
9445
9446
    /**
9447
     * Find position of last occurrence of a case-insensitive string.
9448
     *
9449
     * @param string     $haystack  <p>The string to look in.</p>
9450
     * @param int|string $needle    <p>The string to look for.</p>
9451
     * @param int        $offset    [optional] <p>Number of characters to ignore in the beginning or end.</p>
9452
     * @param string     $encoding  [optional] <p>Set the charset for e.g. "mb_" function</p>
9453
     * @param bool       $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
9454
     *
9455
     * @return false|int
9456
     *                   The <strong>(int)</strong> numeric position of the last occurrence of needle in the haystack
9457
     *                   string.<br>If needle is not found, it returns false.
9458
     */
9459 3
    public static function strripos(
9460
        string $haystack,
9461
        $needle,
9462
        int $offset = 0,
9463
        string $encoding = 'UTF-8',
9464
        bool $cleanUtf8 = false
9465
    ) {
9466 3
        if ($haystack === '') {
9467
            return false;
9468
        }
9469
9470
        // iconv and mbstring do not support integer $needle
9471 3
        if ((int) $needle === $needle && $needle >= 0) {
9472
            $needle = (string) self::chr($needle);
9473
        }
9474 3
        $needle = (string) $needle;
9475
9476 3
        if ($needle === '') {
9477
            return false;
9478
        }
9479
9480 3
        if ($cleanUtf8 === true) {
9481
            // mb_strripos() && iconv_strripos() is not tolerant to invalid characters
9482 2
            $needle = self::clean($needle);
9483 2
            $haystack = self::clean($haystack);
9484
        }
9485
9486 3
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
9487 2
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
9488
        }
9489
9490
        //
9491
        // fallback via mbstrig
9492
        //
9493
9494 3
        if (self::$SUPPORT['mbstring'] === true) {
9495 3
            if ($encoding === 'UTF-8') {
9496 3
                return \mb_strripos($haystack, $needle, $offset);
9497
            }
9498
9499
            return \mb_strripos($haystack, $needle, $offset, $encoding);
9500
        }
9501
9502
        //
9503
        // fallback for binary || ascii only
9504
        //
9505
9506
        if (
9507
            $encoding === 'CP850'
9508
            ||
9509
            $encoding === 'ASCII'
9510
        ) {
9511
            return \strripos($haystack, $needle, $offset);
9512
        }
9513
9514
        if (
9515
            $encoding !== 'UTF-8'
9516
            &&
9517
            self::$SUPPORT['mbstring'] === false
9518
        ) {
9519
            \trigger_error('UTF8::strripos() without mbstring cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
9520
        }
9521
9522
        //
9523
        // fallback via intl
9524
        //
9525
9526
        if (
9527
            $encoding === 'UTF-8' // INFO: "grapheme_strripos()" can't handle other encodings
9528
            &&
9529
            $offset >= 0 // grapheme_strripos() can't handle negative offset
9530
            &&
9531
            self::$SUPPORT['intl'] === true
9532
        ) {
9533
            $returnTmp = \grapheme_strripos($haystack, $needle, $offset);
9534
            if ($returnTmp !== false) {
9535
                return $returnTmp;
9536
            }
9537
        }
9538
9539
        //
9540
        // fallback for ascii only
9541
        //
9542
9543
        if (self::is_ascii($haystack . $needle)) {
9544
            return \strripos($haystack, $needle, $offset);
9545
        }
9546
9547
        //
9548
        // fallback via vanilla php
9549
        //
9550
9551
        $haystack = self::strtocasefold($haystack, true, false, $encoding);
9552
        $needle = self::strtocasefold($needle, true, false, $encoding);
9553
9554
        return self::strrpos($haystack, $needle, $offset, $encoding, $cleanUtf8);
9555
    }
9556
9557
    /**
9558
     * Finds position of last occurrence of a string within another, case insensitive.
9559
     *
9560
     * @param string $haystack <p>
9561
     *                         The string from which to get the position of the last occurrence
9562
     *                         of needle.
9563
     *                         </p>
9564
     * @param string $needle   <p>
9565
     *                         The string to find in haystack.
9566
     *                         </p>
9567
     * @param int    $offset   [optional] <p>
9568
     *                         The position in haystack
9569
     *                         to start searching.
9570
     *                         </p>
9571
     *
9572
     * @return false|int return the numeric position of the last occurrence of needle in the
9573
     *                   haystack string, or false if needle is not found
9574
     */
9575
    public static function strripos_in_byte(string $haystack, string $needle, int $offset = 0)
9576
    {
9577
        if ($haystack === '' || $needle === '') {
9578
            return false;
9579
        }
9580
9581
        if (self::$SUPPORT['mbstring_func_overload'] === true) {
9582
            // "mb_" is available if overload is used, so use it ...
9583
            return \mb_strripos($haystack, $needle, $offset, 'CP850'); // 8-BIT
9584
        }
9585
9586
        return \strripos($haystack, $needle, $offset);
9587
    }
9588
9589
    /**
9590
     * Find position of last occurrence of a string in a string.
9591
     *
9592
     * @see http://php.net/manual/en/function.mb-strrpos.php
9593
     *
9594
     * @param string     $haystack  <p>The string being checked, for the last occurrence of needle</p>
9595
     * @param int|string $needle    <p>The string to find in haystack.<br>Or a code point as int.</p>
9596
     * @param int        $offset    [optional] <p>May be specified to begin searching an arbitrary number of characters
9597
     *                              into the string. Negative values will stop searching at an arbitrary point prior to
9598
     *                              the end of the string.
9599
     *                              </p>
9600
     * @param string     $encoding  [optional] <p>Set the charset.</p>
9601
     * @param bool       $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
9602
     *
9603
     * @return false|int
9604
     *                   The <strong>(int)</strong> numeric position of the last occurrence of needle in the haystack
9605
     *                   string.<br>If needle is not found, it returns false.
9606
     */
9607 35
    public static function strrpos(
9608
        string $haystack,
9609
        $needle,
9610
        int $offset = 0,
9611
        string $encoding = 'UTF-8',
9612
        bool $cleanUtf8 = false
9613
    ) {
9614 35
        if ($haystack === '') {
9615 3
            return false;
9616
        }
9617
9618
        // iconv and mbstring do not support integer $needle
9619 34
        if ((int) $needle === $needle && $needle >= 0) {
9620 2
            $needle = (string) self::chr($needle);
9621
        }
9622 34
        $needle = (string) $needle;
9623
9624 34
        if ($needle === '') {
9625 2
            return false;
9626
        }
9627
9628 34
        if ($cleanUtf8 === true) {
9629
            // \mb_strrpos && iconv_strrpos is not tolerant to invalid characters
9630 4
            $needle = self::clean($needle);
9631 4
            $haystack = self::clean($haystack);
9632
        }
9633
9634 34
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
9635 8
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
9636
        }
9637
9638
        //
9639
        // fallback via mbstring
9640
        //
9641
9642 34
        if (self::$SUPPORT['mbstring'] === true) {
9643 34
            if ($encoding === 'UTF-8') {
9644 34
                return \mb_strrpos($haystack, $needle, $offset);
9645
            }
9646
9647 2
            return \mb_strrpos($haystack, $needle, $offset, $encoding);
9648
        }
9649
9650
        //
9651
        // fallback for binary || ascii only
9652
        //
9653
9654
        if (
9655
            $encoding === 'CP850'
9656
            ||
9657
            $encoding === 'ASCII'
9658
        ) {
9659
            return \strrpos($haystack, $needle, $offset);
9660
        }
9661
9662
        if (
9663
            $encoding !== 'UTF-8'
9664
            &&
9665
            self::$SUPPORT['mbstring'] === false
9666
        ) {
9667
            \trigger_error('UTF8::strrpos() without mbstring cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
9668
        }
9669
9670
        //
9671
        // fallback via intl
9672
        //
9673
9674
        if (
9675
            $offset >= 0 // grapheme_strrpos() can't handle negative offset
9676
            &&
9677
            $encoding === 'UTF-8' // INFO: "grapheme_strrpos()" can't handle other encodings
9678
            &&
9679
            self::$SUPPORT['intl'] === true
9680
        ) {
9681
            $returnTmp = \grapheme_strrpos($haystack, $needle, $offset);
9682
            if ($returnTmp !== false) {
9683
                return $returnTmp;
9684
            }
9685
        }
9686
9687
        //
9688
        // fallback for ascii only
9689
        //
9690
9691
        if (self::is_ascii($haystack . $needle)) {
9692
            return \strrpos($haystack, $needle, $offset);
9693
        }
9694
9695
        //
9696
        // fallback via vanilla php
9697
        //
9698
9699
        $haystackTmp = null;
9700
        if ($offset > 0) {
9701
            $haystackTmp = self::substr($haystack, $offset);
9702
        } elseif ($offset < 0) {
9703
            $haystackTmp = self::substr($haystack, 0, $offset);
9704
            $offset = 0;
9705
        }
9706
9707
        if ($haystackTmp !== null) {
9708
            if ($haystackTmp === false) {
9709
                $haystackTmp = '';
9710
            }
9711
            $haystack = (string) $haystackTmp;
9712
        }
9713
9714
        $pos = \strrpos($haystack, $needle);
9715
        if ($pos === false) {
9716
            return false;
9717
        }
9718
9719
        $strTmp = \substr($haystack, 0, $pos);
9720
        if ($strTmp === false) {
9721
            return false;
9722
        }
9723
9724
        return $offset + (int) self::strlen($strTmp);
9725
    }
9726
9727
    /**
9728
     * Find position of last occurrence of a string in a string.
9729
     *
9730
     * @param string $haystack <p>
9731
     *                         The string being checked, for the last occurrence
9732
     *                         of needle.
9733
     *                         </p>
9734
     * @param string $needle   <p>
9735
     *                         The string to find in haystack.
9736
     *                         </p>
9737
     * @param int    $offset   [optional] May be specified to begin searching an arbitrary number of characters into
9738
     *                         the string. Negative values will stop searching at an arbitrary point
9739
     *                         prior to the end of the string.
9740
     *
9741
     * @return false|int The numeric position of the last occurrence of needle in the
9742
     *                   haystack string. If needle is not found, it returns false.
9743
     */
9744
    public static function strrpos_in_byte(string $haystack, string $needle, int $offset = 0)
9745
    {
9746
        if ($haystack === '' || $needle === '') {
9747
            return false;
9748
        }
9749
9750
        if (self::$SUPPORT['mbstring_func_overload'] === true) {
9751
            // "mb_" is available if overload is used, so use it ...
9752
            return \mb_strrpos($haystack, $needle, $offset, 'CP850'); // 8-BIT
9753
        }
9754
9755
        return \strrpos($haystack, $needle, $offset);
9756
    }
9757
9758
    /**
9759
     * Finds the length of the initial segment of a string consisting entirely of characters contained within a given
9760
     * mask.
9761
     *
9762
     * @param string $str      <p>The input string.</p>
9763
     * @param string $mask     <p>The mask of chars</p>
9764
     * @param int    $offset   [optional]
9765
     * @param int    $length   [optional]
9766
     * @param string $encoding [optional] <p>Set the charset.</p>
9767
     *
9768
     * @return false|int
9769
     */
9770 10
    public static function strspn(
9771
        string $str,
9772
        string $mask,
9773
        int $offset = 0,
9774
        int $length = null,
9775
        string $encoding = 'UTF-8'
9776
    ) {
9777 10
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
9778
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
9779
        }
9780
9781 10
        if ($offset || $length !== null) {
9782 2
            if ($encoding === 'UTF-8') {
9783 2
                if ($length === null) {
9784
                    $str = (string) \mb_substr($str, $offset);
9785
                } else {
9786 2
                    $str = (string) \mb_substr($str, $offset, $length);
9787
                }
9788
            } else {
9789
                $str = (string) self::substr($str, $offset, $length, $encoding);
9790
            }
9791
        }
9792
9793 10
        if ($str === '' || $mask === '') {
9794 2
            return 0;
9795
        }
9796
9797 8
        $matches = [];
9798
9799 8
        return \preg_match('/^' . self::rxClass($mask) . '+/u', $str, $matches) ? (int) self::strlen($matches[0], $encoding) : 0;
9800
    }
9801
9802
    /**
9803
     * Returns part of haystack string from the first occurrence of needle to the end of haystack.
9804
     *
9805
     * @param string $haystack      <p>The input string. Must be valid UTF-8.</p>
9806
     * @param string $needle        <p>The string to look for. Must be valid UTF-8.</p>
9807
     * @param bool   $before_needle [optional] <p>
9808
     *                              If <b>TRUE</b>, strstr() returns the part of the
9809
     *                              haystack before the first occurrence of the needle (excluding the needle).
9810
     *                              </p>
9811
     * @param string $encoding      [optional] <p>Set the charset for e.g. "mb_" function</p>
9812
     * @param bool   $cleanUtf8     [optional] <p>Remove non UTF-8 chars from the string.</p>
9813
     *
9814
     * @return false|string
9815
     *                      A sub-string,<br>or <strong>false</strong> if needle is not found
9816
     */
9817 3
    public static function strstr(
9818
        string $haystack,
9819
        string $needle,
9820
        bool $before_needle = false,
9821
        string $encoding = 'UTF-8',
9822
        $cleanUtf8 = false
9823
    ) {
9824 3
        if ($haystack === '' || $needle === '') {
9825 2
            return false;
9826
        }
9827
9828 3
        if ($cleanUtf8 === true) {
9829
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
9830
            // if invalid characters are found in $haystack before $needle
9831
            $needle = self::clean($needle);
9832
            $haystack = self::clean($haystack);
9833
        }
9834
9835 3
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
9836 2
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
9837
        }
9838
9839
        //
9840
        // fallback via mbstring
9841
        //
9842
9843 3
        if (self::$SUPPORT['mbstring'] === true) {
9844 3
            if ($encoding === 'UTF-8') {
9845 3
                return \mb_strstr($haystack, $needle, $before_needle);
9846
            }
9847
9848 2
            return \mb_strstr($haystack, $needle, $before_needle, $encoding);
9849
        }
9850
9851
        //
9852
        // fallback for binary || ascii only
9853
        //
9854
9855
        if (
9856
            $encoding === 'CP850'
9857
            ||
9858
            $encoding === 'ASCII'
9859
        ) {
9860
            return \strstr($haystack, $needle, $before_needle);
9861
        }
9862
9863
        if (
9864
            $encoding !== 'UTF-8'
9865
            &&
9866
            self::$SUPPORT['mbstring'] === false
9867
        ) {
9868
            \trigger_error('UTF8::strstr() without mbstring cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
9869
        }
9870
9871
        //
9872
        // fallback via intl
9873
        //
9874
9875
        if (
9876
            $encoding === 'UTF-8' // INFO: "grapheme_strstr()" can't handle other encodings
9877
            &&
9878
            self::$SUPPORT['intl'] === true
9879
        ) {
9880
            $returnTmp = \grapheme_strstr($haystack, $needle, $before_needle);
9881
            if ($returnTmp !== false) {
9882
                return $returnTmp;
9883
            }
9884
        }
9885
9886
        //
9887
        // fallback for ascii only
9888
        //
9889
9890
        if (self::is_ascii($haystack . $needle)) {
9891
            return \strstr($haystack, $needle, $before_needle);
9892
        }
9893
9894
        //
9895
        // fallback via vanilla php
9896
        //
9897
9898
        \preg_match('/^(.*?)' . \preg_quote($needle, '/') . '/us', $haystack, $match);
9899
9900
        if (!isset($match[1])) {
9901
            return false;
9902
        }
9903
9904
        if ($before_needle) {
9905
            return $match[1];
9906
        }
9907
9908
        return self::substr($haystack, (int) self::strlen($match[1]));
9909
    }
9910
9911
    /**
9912
     *  * Finds first occurrence of a string within another.
9913
     *
9914
     * @param string $haystack      <p>
9915
     *                              The string from which to get the first occurrence
9916
     *                              of needle.
9917
     *                              </p>
9918
     * @param string $needle        <p>
9919
     *                              The string to find in haystack.
9920
     *                              </p>
9921
     * @param bool   $before_needle [optional] <p>
9922
     *                              Determines which portion of haystack
9923
     *                              this function returns.
9924
     *                              If set to true, it returns all of haystack
9925
     *                              from the beginning to the first occurrence of needle.
9926
     *                              If set to false, it returns all of haystack
9927
     *                              from the first occurrence of needle to the end,
9928
     *                              </p>
9929
     *
9930
     * @return false|string the portion of haystack,
9931
     *                      or false if needle is not found
9932
     */
9933
    public static function strstr_in_byte(string $haystack, string $needle, bool $before_needle = false)
9934
    {
9935
        if ($haystack === '' || $needle === '') {
9936
            return false;
9937
        }
9938
9939
        if (self::$SUPPORT['mbstring_func_overload'] === true) {
9940
            // "mb_" is available if overload is used, so use it ...
9941
            return \mb_strstr($haystack, $needle, $before_needle, 'CP850'); // 8-BIT
9942
        }
9943
9944
        return \strstr($haystack, $needle, $before_needle);
9945
    }
9946
9947
    /**
9948
     * Unicode transformation for case-less matching.
9949
     *
9950
     * @see http://unicode.org/reports/tr21/tr21-5.html
9951
     *
9952
     * @param string      $str       <p>The input string.</p>
9953
     * @param bool        $full      [optional] <p>
9954
     *                               <b>true</b>, replace full case folding chars (default)<br>
9955
     *                               <b>false</b>, use only limited static array [UTF8::$COMMON_CASE_FOLD]
9956
     *                               </p>
9957
     * @param bool        $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
9958
     * @param string      $encoding  [optional] <p>Set the charset.</p>
9959
     * @param string|null $lang      [optional] <p>Set the language for special cases: az, el, lt, tr</p>
9960
     * @param bool        $lower     [optional] <p>Use lowercase string, otherwise use uppercase string. PS: uppercase
9961
     *                               is for some languages better ...</p>
9962
     *
9963
     * @return string
9964
     */
9965 32
    public static function strtocasefold(
9966
        string $str,
9967
        bool $full = true,
9968
        bool $cleanUtf8 = false,
9969
        string $encoding = 'UTF-8',
9970
        string $lang = null,
9971
        $lower = true
9972
    ): string {
9973 32
        if ($str === '') {
9974 5
            return '';
9975
        }
9976
9977 31
        if ($cleanUtf8 === true) {
9978
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
9979
            // if invalid characters are found in $haystack before $needle
9980 2
            $str = self::clean($str);
9981
        }
9982
9983 31
        $str = self::fixStrCaseHelper($str, $lower, $full);
9984
9985 31
        if ($lang === null && $encoding === 'UTF-8') {
9986 31
            if ($lower === true) {
9987 2
                return \mb_strtolower($str);
9988
            }
9989
9990 29
            return \mb_strtoupper($str);
9991
        }
9992
9993 2
        if ($lower === true) {
9994
            return self::strtolower($str, $encoding, false, $lang);
9995
        }
9996
9997 2
        return self::strtoupper($str, $encoding, false, $lang);
9998
    }
9999
10000
    /**
10001
     * Make a string lowercase.
10002
     *
10003
     * @see http://php.net/manual/en/function.mb-strtolower.php
10004
     *
10005
     * @param string      $str                   <p>The string being lowercased.</p>
10006
     * @param string      $encoding              [optional] <p>Set the charset for e.g. "mb_" function</p>
10007
     * @param bool        $cleanUtf8             [optional] <p>Remove non UTF-8 chars from the string.</p>
10008
     * @param string|null $lang                  [optional] <p>Set the language for special cases: az, el, lt, tr</p>
10009
     * @param bool        $tryToKeepStringLength [optional] <p>true === try to keep the string length: e.g. ẞ -> ß</p>
10010
     *
10011
     * @return string
10012
     *                <p>String with all alphabetic characters converted to lowercase.</p>
10013
     */
10014 73
    public static function strtolower(
10015
        $str,
10016
        string $encoding = 'UTF-8',
10017
        bool $cleanUtf8 = false,
10018
        string $lang = null,
10019
        bool $tryToKeepStringLength = false
10020
    ): string {
10021
        // init
10022 73
        $str = (string) $str;
10023
10024 73
        if ($str === '') {
10025 1
            return '';
10026
        }
10027
10028 72
        if ($cleanUtf8 === true) {
10029
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
10030
            // if invalid characters are found in $haystack before $needle
10031 2
            $str = self::clean($str);
10032
        }
10033
10034
        // hack for old php version or for the polyfill ...
10035 72
        if ($tryToKeepStringLength === true) {
10036
            $str = self::fixStrCaseHelper($str, true);
10037
        }
10038
10039 72
        if ($lang === null && $encoding === 'UTF-8') {
10040 13
            return \mb_strtolower($str);
10041
        }
10042
10043 61
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
10044
10045 61
        if ($lang !== null) {
10046 2
            if (self::$SUPPORT['intl'] === true) {
10047 2
                if (self::$INTL_TRANSLITERATOR_LIST === null) {
10048
                    self::$INTL_TRANSLITERATOR_LIST = self::getData('transliterator_list');
10049
                }
10050
10051 2
                $langCode = $lang . '-Lower';
10052 2
                if (!\in_array($langCode, self::$INTL_TRANSLITERATOR_LIST, true)) {
10053
                    \trigger_error('UTF8::strtolower() cannot handle special language: ' . $lang, \E_USER_WARNING);
10054
10055
                    $langCode = 'Any-Lower';
10056
                }
10057
10058
                /** @noinspection PhpComposerExtensionStubsInspection */
10059
                /** @noinspection UnnecessaryCastingInspection */
10060 2
                return (string) \transliterator_transliterate($langCode, $str);
10061
            }
10062
10063
            \trigger_error('UTF8::strtolower() without intl cannot handle the "lang" parameter: ' . $lang, \E_USER_WARNING);
10064
        }
10065
10066
        // always fallback via symfony polyfill
10067 61
        return \mb_strtolower($str, $encoding);
10068
    }
10069
10070
    /**
10071
     * Make a string uppercase.
10072
     *
10073
     * @see http://php.net/manual/en/function.mb-strtoupper.php
10074
     *
10075
     * @param string      $str                   <p>The string being uppercased.</p>
10076
     * @param string      $encoding              [optional] <p>Set the charset.</p>
10077
     * @param bool        $cleanUtf8             [optional] <p>Remove non UTF-8 chars from the string.</p>
10078
     * @param string|null $lang                  [optional] <p>Set the language for special cases: az, el, lt, tr</p>
10079
     * @param bool        $tryToKeepStringLength [optional] <p>true === try to keep the string length: e.g. ẞ -> ß</p>
10080
     *
10081
     * @return string
10082
     *                <p>String with all alphabetic characters converted to uppercase.</p>
10083
     */
10084 17
    public static function strtoupper(
10085
        $str,
10086
        string $encoding = 'UTF-8',
10087
        bool $cleanUtf8 = false,
10088
        string $lang = null,
10089
        bool $tryToKeepStringLength = false
10090
    ): string {
10091
        // init
10092 17
        $str = (string) $str;
10093
10094 17
        if ($str === '') {
10095 1
            return '';
10096
        }
10097
10098 16
        if ($cleanUtf8 === true) {
10099
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
10100
            // if invalid characters are found in $haystack before $needle
10101 2
            $str = self::clean($str);
10102
        }
10103
10104
        // hack for old php version or for the polyfill ...
10105 16
        if ($tryToKeepStringLength === true) {
10106 2
            $str = self::fixStrCaseHelper($str, false);
10107
        }
10108
10109 16
        if ($lang === null && $encoding === 'UTF-8') {
10110 8
            return \mb_strtoupper($str);
10111
        }
10112
10113 10
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
10114
10115 10
        if ($lang !== null) {
10116 2
            if (self::$SUPPORT['intl'] === true) {
10117 2
                if (self::$INTL_TRANSLITERATOR_LIST === null) {
10118
                    self::$INTL_TRANSLITERATOR_LIST = self::getData('transliterator_list');
10119
                }
10120
10121 2
                $langCode = $lang . '-Upper';
10122 2
                if (!\in_array($langCode, self::$INTL_TRANSLITERATOR_LIST, true)) {
10123
                    \trigger_error('UTF8::strtoupper() without intl for special language: ' . $lang, \E_USER_WARNING);
10124
10125
                    $langCode = 'Any-Upper';
10126
                }
10127
10128
                /** @noinspection PhpComposerExtensionStubsInspection */
10129
                /** @noinspection UnnecessaryCastingInspection */
10130 2
                return (string) \transliterator_transliterate($langCode, $str);
10131
            }
10132
10133
            \trigger_error('UTF8::strtolower() without intl cannot handle the "lang"-parameter: ' . $lang, \E_USER_WARNING);
10134
        }
10135
10136
        // always fallback via symfony polyfill
10137 10
        return \mb_strtoupper($str, $encoding);
10138
    }
10139
10140
    /**
10141
     * Translate characters or replace sub-strings.
10142
     *
10143
     * @see http://php.net/manual/en/function.strtr.php
10144
     *
10145
     * @param string          $str  <p>The string being translated.</p>
10146
     * @param string|string[] $from <p>The string replacing from.</p>
10147
     * @param string|string[] $to   [optional] <p>The string being translated to to.</p>
10148
     *
10149
     * @return string
10150
     *                This function returns a copy of str, translating all occurrences of each character in from to the
10151
     *                corresponding character in to
10152
     */
10153 2
    public static function strtr(string $str, $from, $to = ''): string
10154
    {
10155 2
        if ($str === '') {
10156
            return '';
10157
        }
10158
10159 2
        if ($from === $to) {
10160
            return $str;
10161
        }
10162
10163 2
        if ($to !== '') {
10164 2
            $from = self::str_split($from);
10165 2
            $to = self::str_split($to);
10166 2
            $countFrom = \count($from);
10167 2
            $countTo = \count($to);
10168
10169 2
            if ($countFrom > $countTo) {
10170 2
                $from = \array_slice($from, 0, $countTo);
10171 2
            } elseif ($countFrom < $countTo) {
10172 2
                $to = \array_slice($to, 0, $countFrom);
10173
            }
10174
10175 2
            $from = \array_combine($from, $to);
10176 2
            if ($from === false) {
10177
                throw new \InvalidArgumentException('The number of elements for each array isn\'t equal or the arrays are empty: (from: ' . \print_r($from, true) . ' | to: ' . \print_r($to, true) . ')');
10178
            }
10179
        }
10180
10181 2
        if (\is_string($from)) {
10182 2
            return \str_replace($from, '', $str);
10183
        }
10184
10185 2
        return \strtr($str, $from);
10186
    }
10187
10188
    /**
10189
     * Return the width of a string.
10190
     *
10191
     * @param string $str       <p>The input string.</p>
10192
     * @param string $encoding  [optional] <p>Set the charset for e.g. "mb_" function</p>
10193
     * @param bool   $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
10194
     *
10195
     * @return int
10196
     */
10197 2
    public static function strwidth(string $str, string $encoding = 'UTF-8', bool $cleanUtf8 = false): int
10198
    {
10199 2
        if ($str === '') {
10200 2
            return 0;
10201
        }
10202
10203 2
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
10204 2
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
10205
        }
10206
10207 2
        if ($cleanUtf8 === true) {
10208
            // iconv and mbstring are not tolerant to invalid encoding
10209
            // further, their behaviour is inconsistent with that of PHP's substr
10210 2
            $str = self::clean($str);
10211
        }
10212
10213
        //
10214
        // fallback via mbstring
10215
        //
10216
10217 2
        if (self::$SUPPORT['mbstring'] === true) {
10218 2
            if ($encoding === 'UTF-8') {
10219 2
                return \mb_strwidth($str);
10220
            }
10221
10222
            return \mb_strwidth($str, $encoding);
10223
        }
10224
10225
        //
10226
        // fallback via vanilla php
10227
        //
10228
10229
        if ($encoding !== 'UTF-8') {
10230
            $str = self::encode('UTF-8', $str, false, $encoding);
10231
        }
10232
10233
        $wide = 0;
10234
        $str = (string) \preg_replace('/[\x{1100}-\x{115F}\x{2329}\x{232A}\x{2E80}-\x{303E}\x{3040}-\x{A4CF}\x{AC00}-\x{D7A3}\x{F900}-\x{FAFF}\x{FE10}-\x{FE19}\x{FE30}-\x{FE6F}\x{FF00}-\x{FF60}\x{FFE0}-\x{FFE6}\x{20000}-\x{2FFFD}\x{30000}-\x{3FFFD}]/u', '', $str, -1, $wide);
10235
10236
        return ($wide << 1) + (int) self::strlen($str, 'UTF-8');
10237
    }
10238
10239
    /**
10240
     * Get part of a string.
10241
     *
10242
     * @see http://php.net/manual/en/function.mb-substr.php
10243
     *
10244
     * @param string $str       <p>The string being checked.</p>
10245
     * @param int    $offset    <p>The first position used in str.</p>
10246
     * @param int    $length    [optional] <p>The maximum length of the returned string.</p>
10247
     * @param string $encoding  [optional] <p>Set the charset for e.g. "mb_" function</p>
10248
     * @param bool   $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
10249
     *
10250
     * @return false|string
10251
     *                      The portion of <i>str</i> specified by the <i>offset</i> and
10252
     *                      <i>length</i> parameters.</p><p>If <i>str</i> is shorter than <i>offset</i>
10253
     *                      characters long, <b>FALSE</b> will be returned.
10254
     */
10255 172
    public static function substr(
10256
        string $str,
10257
        int $offset = 0,
10258
        int $length = null,
10259
        string $encoding = 'UTF-8',
10260
        bool $cleanUtf8 = false
10261
    ) {
10262
        // empty string
10263 172
        if ($str === '' || $length === 0) {
10264 8
            return '';
10265
        }
10266
10267 168
        if ($cleanUtf8 === true) {
10268
            // iconv and mbstring are not tolerant to invalid encoding
10269
            // further, their behaviour is inconsistent with that of PHP's substr
10270 2
            $str = self::clean($str);
10271
        }
10272
10273
        // whole string
10274 168
        if (!$offset && $length === null) {
10275 7
            return $str;
10276
        }
10277
10278 163
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
10279 19
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
10280
        }
10281
10282
        //
10283
        // fallback via mbstring
10284
        //
10285
10286 163
        if (self::$SUPPORT['mbstring'] === true) {
10287 161
            if ($encoding === 'UTF-8') {
10288 161
                if ($length === null) {
10289 64
                    return \mb_substr($str, $offset);
10290
                }
10291
10292 102
                return \mb_substr($str, $offset, $length);
10293
            }
10294
10295
            return self::substr($str, $offset, $length, $encoding);
10296
        }
10297
10298
        //
10299
        // fallback for binary || ascii only
10300
        //
10301
10302
        if (
10303 4
            $encoding === 'CP850'
10304
            ||
10305 4
            $encoding === 'ASCII'
10306
        ) {
10307
            if ($length === null) {
10308
                return \substr($str, $offset);
10309
            }
10310
10311
            return \substr($str, $offset, $length);
10312
        }
10313
10314
        // otherwise we need the string-length
10315 4
        $str_length = 0;
10316 4
        if ($offset || $length === null) {
10317 4
            $str_length = self::strlen($str, $encoding);
10318
        }
10319
10320
        // e.g.: invalid chars + mbstring not installed
10321 4
        if ($str_length === false) {
10322
            return false;
10323
        }
10324
10325
        // empty string
10326 4
        if ($offset === $str_length && !$length) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $length of type integer|null is loosely compared to false; this is ambiguous if the integer can be 0. You might want to explicitly use === null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

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
Loading history...
10327
            return '';
10328
        }
10329
10330
        // impossible
10331 4
        if ($offset && $offset > $str_length) {
10332
            return '';
10333
        }
10334
10335 4
        if ($length === null) {
10336 4
            $length = (int) $str_length;
10337
        } else {
10338 2
            $length = (int) $length;
10339
        }
10340
10341
        if (
10342 4
            $encoding !== 'UTF-8'
10343
            &&
10344 4
            self::$SUPPORT['mbstring'] === false
10345
        ) {
10346 2
            \trigger_error('UTF8::substr() without mbstring cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
10347
        }
10348
10349
        //
10350
        // fallback via intl
10351
        //
10352
10353
        if (
10354 4
            $encoding === 'UTF-8' // INFO: "grapheme_substr()" can't handle other encodings
10355
            &&
10356 4
            $offset >= 0 // grapheme_substr() can't handle negative offset
10357
            &&
10358 4
            self::$SUPPORT['intl'] === true
10359
        ) {
10360
            $returnTmp = \grapheme_substr($str, $offset, $length);
10361
            if ($returnTmp !== false) {
10362
                return $returnTmp;
10363
            }
10364
        }
10365
10366
        //
10367
        // fallback via iconv
10368
        //
10369
10370
        if (
10371 4
            $length >= 0 // "iconv_substr()" can't handle negative length
10372
            &&
10373 4
            self::$SUPPORT['iconv'] === true
10374
        ) {
10375
            $returnTmp = \iconv_substr($str, $offset, $length);
10376
            if ($returnTmp !== false) {
10377
                return $returnTmp;
10378
            }
10379
        }
10380
10381
        //
10382
        // fallback for ascii only
10383
        //
10384
10385 4
        if (self::is_ascii($str)) {
10386
            return \substr($str, $offset, $length);
10387
        }
10388
10389
        //
10390
        // fallback via vanilla php
10391
        //
10392
10393
        // split to array, and remove invalid characters
10394 4
        $array = self::str_split($str);
10395
10396
        // extract relevant part, and join to make sting again
10397 4
        return \implode('', \array_slice($array, $offset, $length));
10398
    }
10399
10400
    /**
10401
     * Binary safe comparison of two strings from an offset, up to length characters.
10402
     *
10403
     * @param string   $str1               <p>The main string being compared.</p>
10404
     * @param string   $str2               <p>The secondary string being compared.</p>
10405
     * @param int      $offset             [optional] <p>The start position for the comparison. If negative, it starts
10406
     *                                     counting from the end of the string.</p>
10407
     * @param int|null $length             [optional] <p>The length of the comparison. The default value is the largest
10408
     *                                     of the length of the str compared to the length of main_str less the
10409
     *                                     offset.</p>
10410
     * @param bool     $case_insensitivity [optional] <p>If case_insensitivity is TRUE, comparison is case
10411
     *                                     insensitive.</p>
10412
     * @param string   $encoding           [optional] <p>Set the charset for e.g. "mb_" function</p>
10413
     *
10414
     * @return int
10415
     *             <strong>&lt; 0</strong> if str1 is less than str2;<br>
10416
     *             <strong>&gt; 0</strong> if str1 is greater than str2,<br>
10417
     *             <strong>0</strong> if they are equal
10418
     */
10419 2
    public static function substr_compare(
10420
        string $str1,
10421
        string $str2,
10422
        int $offset = 0,
10423
        int $length = null,
10424
        bool $case_insensitivity = false,
10425
        string $encoding = 'UTF-8'
10426
    ): int {
10427
        if (
10428 2
            $offset !== 0
10429
            ||
10430 2
            $length !== null
10431
        ) {
10432 2
            if ($encoding === 'UTF-8') {
10433 2
                if ($length === null) {
10434 2
                    $str1 = (string) \mb_substr($str1, $offset);
10435
                } else {
10436 2
                    $str1 = (string) \mb_substr($str1, $offset, $length);
10437
                }
10438 2
                $str2 = (string) \mb_substr($str2, 0, (int) self::strlen($str1));
10439
            } else {
10440
                $encoding = self::normalize_encoding($encoding, 'UTF-8');
10441
10442
                $str1 = (string) self::substr($str1, $offset, $length, $encoding);
10443
                $str2 = (string) self::substr($str2, 0, (int) self::strlen($str1), $encoding);
10444
            }
10445
        }
10446
10447 2
        if ($case_insensitivity === true) {
10448 2
            return self::strcasecmp($str1, $str2, $encoding);
10449
        }
10450
10451 2
        return self::strcmp($str1, $str2);
10452
    }
10453
10454
    /**
10455
     * Count the number of substring occurrences.
10456
     *
10457
     * @see http://php.net/manual/en/function.substr-count.php
10458
     *
10459
     * @param string $haystack  <p>The string to search in.</p>
10460
     * @param string $needle    <p>The substring to search for.</p>
10461
     * @param int    $offset    [optional] <p>The offset where to start counting.</p>
10462
     * @param int    $length    [optional] <p>
10463
     *                          The maximum length after the specified offset to search for the
10464
     *                          substring. It outputs a warning if the offset plus the length is
10465
     *                          greater than the haystack length.
10466
     *                          </p>
10467
     * @param string $encoding  [optional] <p>Set the charset for e.g. "mb_" function</p>
10468
     * @param bool   $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
10469
     *
10470
     * @return false|int this functions returns an integer or false if there isn't a string
10471
     */
10472 5
    public static function substr_count(
10473
        string $haystack,
10474
        string $needle,
10475
        int $offset = 0,
10476
        int $length = null,
10477
        string $encoding = 'UTF-8',
10478
        bool $cleanUtf8 = false
10479
    ) {
10480 5
        if ($haystack === '' || $needle === '') {
10481 2
            return false;
10482
        }
10483
10484 5
        if ($length === 0) {
10485 2
            return 0;
10486
        }
10487
10488 5
        if ($encoding !== 'UTF-8' && $encoding !== 'CP850') {
10489 2
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
10490
        }
10491
10492 5
        if ($cleanUtf8 === true) {
10493
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
10494
            // if invalid characters are found in $haystack before $needle
10495
            $needle = self::clean($needle);
10496
            $haystack = self::clean($haystack);
10497
        }
10498
10499 5
        if ($offset || $length > 0) {
10500 2
            if ($length === null) {
10501 2
                $lengthTmp = self::strlen($haystack, $encoding);
10502 2
                if ($lengthTmp === false) {
10503
                    return false;
10504
                }
10505 2
                $length = (int) $lengthTmp;
10506
            }
10507
10508 2
            if ($encoding === 'UTF-8') {
10509 2
                $haystack = (string) \mb_substr($haystack, $offset, $length);
10510
            } else {
10511 2
                $haystack = (string) \mb_substr($haystack, $offset, $length, $encoding);
10512
            }
10513
        }
10514
10515
        if (
10516 5
            $encoding !== 'UTF-8'
10517
            &&
10518 5
            self::$SUPPORT['mbstring'] === false
10519
        ) {
10520
            \trigger_error('UTF8::substr_count() without mbstring cannot handle "' . $encoding . '" encoding', \E_USER_WARNING);
10521
        }
10522
10523 5
        if (self::$SUPPORT['mbstring'] === true) {
10524 5
            if ($encoding === 'UTF-8') {
10525 5
                return \mb_substr_count($haystack, $needle);
10526
            }
10527
10528 2
            return \mb_substr_count($haystack, $needle, $encoding);
10529
        }
10530
10531
        \preg_match_all('/' . \preg_quote($needle, '/') . '/us', $haystack, $matches, \PREG_SET_ORDER);
10532
10533
        return \count($matches);
10534
    }
10535
10536
    /**
10537
     * Count the number of substring occurrences.
10538
     *
10539
     * @param string $haystack <p>
10540
     *                         The string being checked.
10541
     *                         </p>
10542
     * @param string $needle   <p>
10543
     *                         The string being found.
10544
     *                         </p>
10545
     * @param int    $offset   [optional] <p>
10546
     *                         The offset where to start counting
10547
     *                         </p>
10548
     * @param int    $length   [optional] <p>
10549
     *                         The maximum length after the specified offset to search for the
10550
     *                         substring. It outputs a warning if the offset plus the length is
10551
     *                         greater than the haystack length.
10552
     *                         </p>
10553
     *
10554
     * @return false|int the number of times the
10555
     *                   needle substring occurs in the
10556
     *                   haystack string
10557
     */
10558
    public static function substr_count_in_byte(
10559
        string $haystack,
10560
        string $needle,
10561
        int $offset = 0,
10562
        int $length = null
10563
    ) {
10564
        if ($haystack === '' || $needle === '') {
10565
            return 0;
10566
        }
10567
10568
        if (
10569
            ($offset || $length !== null)
10570
            &&
10571
            self::$SUPPORT['mbstring_func_overload'] === true
10572
        ) {
10573
            if ($length === null) {
10574
                $lengthTmp = self::strlen($haystack);
10575
                if ($lengthTmp === false) {
10576
                    return false;
10577
                }
10578
                $length = (int) $lengthTmp;
10579
            }
10580
10581
            if (
10582
                (
10583
                    $length !== 0
10584
                    &&
10585
                    $offset !== 0
10586
                )
10587
                &&
10588
                ($length + $offset) <= 0
10589
                &&
10590
                Bootup::is_php('7.1') === false // output from "substr_count()" have changed in PHP 7.1
10591
            ) {
10592
                return false;
10593
            }
10594
10595
            $haystackTmp = \substr($haystack, $offset, $length);
10596
            if ($haystackTmp === false) {
10597
                $haystackTmp = '';
10598
            }
10599
            $haystack = (string) $haystackTmp;
10600
        }
10601
10602
        if (self::$SUPPORT['mbstring_func_overload'] === true) {
10603
            // "mb_" is available if overload is used, so use it ...
10604
            return \mb_substr_count($haystack, $needle, 'CP850'); // 8-BIT
10605
        }
10606
10607
        if ($length === null) {
10608
            return \substr_count($haystack, $needle, $offset);
10609
        }
10610
10611
        return \substr_count($haystack, $needle, $offset, $length);
10612
    }
10613
10614
    /**
10615
     * Returns the number of occurrences of $substring in the given string.
10616
     * By default, the comparison is case-sensitive, but can be made insensitive
10617
     * by setting $caseSensitive to false.
10618
     *
10619
     * @param string $str           <p>The input string.</p>
10620
     * @param string $substring     <p>The substring to search for.</p>
10621
     * @param bool   $caseSensitive [optional] <p>Whether or not to enforce case-sensitivity. Default: true</p>
10622
     * @param string $encoding      [optional] <p>Set the charset for e.g. "mb_" function</p>
10623
     *
10624
     * @return int
10625
     */
10626 15
    public static function substr_count_simple(
10627
        string $str,
10628
        string $substring,
10629
        bool $caseSensitive = true,
10630
        string $encoding = 'UTF-8'
10631
    ): int {
10632 15
        if ($str === '' || $substring === '') {
10633 2
            return 0;
10634
        }
10635
10636 13
        if ($encoding === 'UTF-8') {
10637 7
            if ($caseSensitive) {
10638
                return (int) \mb_substr_count($str, $substring);
10639
            }
10640
10641 7
            return (int) \mb_substr_count(
10642 7
                \mb_strtoupper($str),
10643 7
                \mb_strtoupper($substring)
10644
10645
            );
10646
        }
10647
10648 6
        $encoding = self::normalize_encoding($encoding, 'UTF-8');
10649
10650 6
        if ($caseSensitive) {
10651 3
            return (int) \mb_substr_count($str, $substring, $encoding);
10652
        }
10653
10654 3
        return (int) \mb_substr_count(
10655 3
            self::strtocasefold($str, true, false, $encoding, null, false),
10656 3
            self::strtocasefold($substring, true, false, $encoding, null, false),
10657 3
            $encoding
10658
        );
10659
    }
10660
10661
    /**
10662
     * Removes an prefix ($needle) from start of the string ($haystack), case insensitive.
10663
     *
10664
     * @param string $haystack <p>The string to search in.</p>
10665
     * @param string $needle   <p>The substring to search for.</p>
10666
     *
10667
     * @return string return the sub-string
10668
     */
10669 2
    public static function substr_ileft(string $haystack, string $needle): string
10670
    {
10671 2
        if ($haystack === '') {
10672 2
            return '';
10673
        }
10674
10675 2
        if ($needle === '') {
10676 2
            return $haystack;
10677
        }
10678
10679 2
        if (self::str_istarts_with($haystack, $needle) === true) {
10680 2
            $haystack = (string) \mb_substr($haystack, (int) self::strlen($needle));
10681
        }
10682
10683 2
        return $haystack;
10684
    }
10685
10686
    /**
10687
     * Get part of a string process in bytes.
10688
     *
10689
     * @param string $str    <p>The string being checked.</p>
10690
     * @param int    $offset <p>The first position used in str.</p>
10691
     * @param int    $length [optional] <p>The maximum length of the returned string.</p>
10692
     *
10693
     * @return false|string
10694
     *                      The portion of <i>str</i> specified by the <i>offset</i> and
10695
     *                      <i>length</i> parameters.</p><p>If <i>str</i> is shorter than <i>offset</i>
10696
     *                      characters long, <b>FALSE</b> will be returned.
10697
     */
10698
    public static function substr_in_byte(string $str, int $offset = 0, int $length = null)
10699
    {
10700
        // empty string
10701
        if ($str === '' || $length === 0) {
10702
            return '';
10703
        }
10704
10705
        // whole string
10706
        if (!$offset && $length === null) {
10707
            return $str;
10708
        }
10709
10710
        if (self::$SUPPORT['mbstring_func_overload'] === true) {
10711
            // "mb_" is available if overload is used, so use it ...
10712
            return \mb_substr($str, $offset, $length, 'CP850'); // 8-BIT
10713
        }
10714
10715
        return \substr($str, $offset, $length ?? 2147483647);
10716
    }
10717
10718
    /**
10719
     * Removes an suffix ($needle) from end of the string ($haystack), case insensitive.
10720
     *
10721
     * @param string $haystack <p>The string to search in.</p>
10722
     * @param string $needle   <p>The substring to search for.</p>
10723
     *
10724
     * @return string return the sub-string
10725
     */
10726 2
    public static function substr_iright(string $haystack, string $needle): string
10727
    {
10728 2
        if ($haystack === '') {
10729 2
            return '';
10730
        }
10731
10732 2
        if ($needle === '') {
10733 2
            return $haystack;
10734
        }
10735
10736 2
        if (self::str_iends_with($haystack, $needle) === true) {
10737 2
            $haystack = (string) \mb_substr($haystack, 0, (int) self::strlen($haystack) - (int) self::strlen($needle));
10738
        }
10739
10740 2
        return $haystack;
10741
    }
10742
10743
    /**
10744
     * Removes an prefix ($needle) from start of the string ($haystack).
10745
     *
10746
     * @param string $haystack <p>The string to search in.</p>
10747
     * @param string $needle   <p>The substring to search for.</p>
10748
     *
10749
     * @return string return the sub-string
10750
     */
10751 2
    public static function substr_left(string $haystack, string $needle): string
10752
    {
10753 2
        if ($haystack === '') {
10754 2
            return '';
10755
        }
10756
10757 2
        if ($needle === '') {
10758 2
            return $haystack;
10759
        }
10760
10761 2
        if (self::str_starts_with($haystack, $needle) === true) {
10762 2
            $haystack = (string) \mb_substr($haystack, (int) self::strlen($needle));
10763
        }
10764
10765 2
        return $haystack;
10766
    }
10767
10768
    /**
10769
     * Replace text within a portion of a string.
10770
     *
10771
     * source: https://gist.github.com/stemar/8287074
10772
     *
10773
     * @param string|string[] $str         <p>The input string or an array of stings.</p>
10774
     * @param string|string[] $replacement <p>The replacement string or an array of stings.</p>
10775
     * @param int|int[]       $offset      <p>
10776
     *                                     If start is positive, the replacing will begin at the start'th offset
10777
     *                                     into string.
10778
     *                                     <br><br>
10779
     *                                     If start is negative, the replacing will begin at the start'th character
10780
     *                                     from the end of string.
10781
     *                                     </p>
10782
     * @param int|int[]|null  $length      [optional] <p>If given and is positive, it represents the length of the
10783
     *                                     portion of string which is to be replaced. If it is negative, it
10784
     *                                     represents the number of characters from the end of string at which to
10785
     *                                     stop replacing. If it is not given, then it will default to strlen(
10786
     *                                     string ); i.e. end the replacing at the end of string. Of course, if
10787
     *                                     length is zero then this function will have the effect of inserting
10788
     *                                     replacement into string at the given start offset.</p>
10789
     * @param string          $encoding    [optional] <p>Set the charset for e.g. "mb_" function</p>
10790
     *
10791
     * @return string|string[] The result string is returned. If string is an array then array is returned.
10792
     */
10793 10
    public static function substr_replace(
10794
        $str,
10795
        $replacement,
10796
        $offset,
10797
        $length = null,
10798
        string $encoding = 'UTF-8'
10799
    ) {
10800 10
        if (\is_array($str) === true) {
10801 1
            $num = \count($str);
10802
10803
            // the replacement
10804 1
            if (\is_array($replacement) === true) {
10805 1
                $replacement = \array_slice($replacement, 0, $num);
10806
            } else {
10807 1
                $replacement = \array_pad([$replacement], $num, $replacement);
10808
            }
10809
10810
            // the offset
10811 1
            if (\is_array($offset) === true) {
10812 1
                $offset = \array_slice($offset, 0, $num);
10813 1
                foreach ($offset as &$valueTmp) {
10814 1
                    $valueTmp = (int) $valueTmp === $valueTmp ? $valueTmp : 0;
10815
                }
10816 1
                unset($valueTmp);
10817
            } else {
10818 1
                $offset = \array_pad([$offset], $num, $offset);
10819
            }
10820
10821
            // the length
10822 1
            if ($length === null) {
10823 1
                $length = \array_fill(0, $num, 0);
10824 1
            } elseif (\is_array($length) === true) {
10825 1
                $length = \array_slice($length, 0, $num);
10826 1
                foreach ($length as &$valueTmpV2) {
10827 1
                    $valueTmpV2 = (int) $valueTmpV2 === $valueTmpV2 ? $valueTmpV2 : $num;
10828
                }
10829 1
                unset($valueTmpV2);
10830
            } else {
10831 1
                $length = \array_pad([$length], $num, $length);
10832
            }
10833
10834
            // recursive call
10835 1
            return \array_map([self::class, 'substr_replace'], $str, $replacement, $offset, $length);
10836
        }
10837
10838 10
        if (\is_array($replacement) === true) {
10839 1
            if (\count($replacement) > 0) {
10840 1
                $replacement = $replacement[0];
10841
            } else {
10842 1
                $replacement = '';
10843
            }
10844
        }
10845
10846
        // init
10847 10
        $str = (string) $str;
10848 10
        $replacement = (string) $replacement;
10849
10850 10
        if (\is_array($length) === true) {
10851
            throw new \InvalidArgumentException('Parameter "$length" can only be an array, if "$str" is also an array.');
10852
        }
10853
10854 10
        if (\is_array($offset) === true) {
10855
            throw new \InvalidArgumentException('Parameter "$offset" can only be an array, if "$str" is also an array.');
10856
        }
10857
10858 10
        if ($str === '') {
10859 1
            return $replacement;
10860
        }
10861
10862 9
        if (self::$SUPPORT['mbstring'] === true) {
10863 9
            $string_length = (int) self::strlen($str, $encoding);
10864
10865 9
            if ($offset < 0) {
10866 1
                $offset = (int) \max(0, $string_length + $offset);
10867 9
            } elseif ($offset > $string_length) {
10868 1
                $offset = $string_length;
10869
            }
10870
10871 9
            if ($length !== null && $length < 0) {
10872 1
                $length = (int) \max(0, $string_length - $offset + $length);
10873 9
            } elseif ($length === null || $length > $string_length) {
10874 4
                $length = $string_length;
10875
            }
10876
10877
            /** @noinspection AdditionOperationOnArraysInspection */
10878 9
            if (($offset + $length) > $string_length) {
10879 4
                $length = $string_length - $offset;
10880
            }
10881
10882
            /** @noinspection AdditionOperationOnArraysInspection */
10883 9
            return ((string) \mb_substr($str, 0, $offset, $encoding)) .
10884 9
                   $replacement .
10885 9
                   ((string) \mb_substr($str, $offset + $length, $string_length - $offset - $length, $encoding));
10886
        }
10887
10888
        //
10889
        // fallback for ascii only
10890
        //
10891
10892
        if (self::is_ascii($str)) {
10893
            return ($length === null) ?
10894
                \substr_replace($str, $replacement, $offset) :
10895
                \substr_replace($str, $replacement, $offset, $length);
10896
        }
10897
10898
        //
10899
        // fallback via vanilla php
10900
        //
10901
10902
        \preg_match_all('/./us', $str, $smatches);
10903
        \preg_match_all('/./us', $replacement, $rmatches);
10904
10905
        if ($length === null) {
10906
            $lengthTmp = self::strlen($str, $encoding);
10907
            if ($lengthTmp === false) {
10908
                // e.g.: non mbstring support + invalid chars
10909
                return '';
10910
            }
10911
            $length = (int) $lengthTmp;
10912
        }
10913
10914
        \array_splice($smatches[0], $offset, $length, $rmatches[0]);
10915
10916
        return \implode('', $smatches[0]);
10917
    }
10918
10919
    /**
10920
     * Removes an suffix ($needle) from end of the string ($haystack).
10921
     *
10922
     * @param string $haystack <p>The string to search in.</p>
10923
     * @param string $needle   <p>The substring to search for.</p>
10924
     * @param string $encoding [optional] <p>Set the charset for e.g. "mb_" function</p>
10925
     *
10926
     * @return string return the sub-string
10927
     */
10928 2
    public static function substr_right(
10929
        string $haystack,
10930
        string $needle,
10931
        string $encoding = 'UTF-8'
10932
    ): string {
10933 2
        if ($haystack === '') {
10934 2
            return '';
10935
        }
10936
10937 2
        if ($needle === '') {
10938 2
            return $haystack;
10939
        }
10940
10941
        if (
10942 2
            $encoding === 'UTF-8'
10943
            &&
10944 2
            \substr($haystack, -\strlen($needle)) === $needle
10945
        ) {
10946 2
            return (string) \mb_substr($haystack, 0, (int) \mb_strlen($haystack) - (int) \mb_strlen($needle));
10947
        }
10948
10949 2
        if (\substr($haystack, -\strlen($needle)) === $needle) {
10950
            return (string) self::substr(
10951
                $haystack,
10952
                0,
10953
                (int) self::strlen($haystack, $encoding) - (int) self::strlen($needle, $encoding),
10954
                $encoding
10955
            );
10956
        }
10957
10958 2
        return $haystack;
10959
    }
10960
10961
    /**
10962
     * Returns a case swapped version of the string.
10963
     *
10964
     * @param string $str       <p>The input string.</p>
10965
     * @param string $encoding  [optional] <p>Set the charset for e.g. "mb_" function</p>
10966
     * @param bool   $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
10967
     *
10968
     * @return string each character's case swapped
10969
     */
10970 6
    public static function swapCase(string $str, string $encoding = 'UTF-8', bool $cleanUtf8 = false): string
10971
    {
10972 6
        if ($str === '') {
10973 1
            return '';
10974
        }
10975
10976 6
        if ($cleanUtf8 === true) {
10977
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
10978
            // if invalid characters are found in $haystack before $needle
10979 2
            $str = self::clean($str);
10980
        }
10981
10982 6
        if ($encoding === 'UTF-8') {
10983 4
            return (string) (\mb_strtolower($str) ^ \mb_strtoupper($str) ^ $str);
10984
        }
10985
10986 4
        return (string) (self::strtolower($str, $encoding) ^ self::strtoupper($str, $encoding) ^ $str);
10987
    }
10988
10989
    /**
10990
     * Checks whether symfony-polyfills are used.
10991
     *
10992
     * @return bool
10993
     *              <strong>true</strong> if in use, <strong>false</strong> otherwise
10994
     */
10995
    public static function symfony_polyfill_used(): bool
10996
    {
10997
        // init
10998
        $return = false;
10999
11000
        $returnTmp = \extension_loaded('mbstring');
11001
        if ($returnTmp === false && \function_exists('mb_strlen')) {
11002
            $return = true;
11003
        }
11004
11005
        $returnTmp = \extension_loaded('iconv');
11006
        if ($returnTmp === false && \function_exists('iconv')) {
11007
            $return = true;
11008
        }
11009
11010
        return $return;
11011
    }
11012
11013
    /**
11014
     * @param string $str
11015
     * @param int    $tabLength
11016
     *
11017
     * @return string
11018
     */
11019 6
    public static function tabs_to_spaces(string $str, int $tabLength = 4): string
11020
    {
11021 6
        if ($tabLength === 4) {
11022 3
            $spaces = '    ';
11023 3
        } elseif ($tabLength === 2) {
11024 1
            $spaces = '  ';
11025
        } else {
11026 2
            $spaces = \str_repeat(' ', $tabLength);
11027
        }
11028
11029 6
        return \str_replace("\t", $spaces, $str);
11030
    }
11031
11032
    /**
11033
     * Converts the first character of each word in the string to uppercase
11034
     * and all other chars to lowercase.
11035
     *
11036
     * @param string      $str                   <p>The input string.</p>
11037
     * @param string      $encoding              [optional] <p>Set the charset for e.g. "mb_" function</p>
11038
     * @param bool        $cleanUtf8             [optional] <p>Remove non UTF-8 chars from the string.</p>
11039
     * @param string|null $lang                  [optional] <p>Set the language for special cases: az, el, lt, tr</p>
11040
     * @param bool        $tryToKeepStringLength [optional] <p>true === try to keep the string length: e.g. ẞ -> ß</p>
11041
     *
11042
     * @return string string with all characters of $str being title-cased
11043
     */
11044 5
    public static function titlecase(
11045
        string $str,
11046
        string $encoding = 'UTF-8',
11047
        bool $cleanUtf8 = false,
11048
        string $lang = null,
11049
        bool $tryToKeepStringLength = false
11050
    ): string {
11051 5
        if ($cleanUtf8 === true) {
11052
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
11053
            // if invalid characters are found in $haystack before $needle
11054
            $str = self::clean($str);
11055
        }
11056
11057 5
        if ($lang === null && $tryToKeepStringLength === false) {
11058 5
            if ($encoding === 'UTF-8') {
11059 3
                return \mb_convert_case($str, \MB_CASE_TITLE);
11060
            }
11061
11062 2
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
11063
11064 2
            return \mb_convert_case($str, \MB_CASE_TITLE, $encoding);
11065
        }
11066
11067
        return self::str_titleize($str, null, $encoding, false, $lang, $tryToKeepStringLength, false);
11068
    }
11069
11070
    /**
11071
     * alias for "UTF8::to_ascii()"
11072
     *
11073
     * @param string $str
11074
     * @param string $subst_chr
11075
     * @param bool   $strict
11076
     *
11077
     * @return string
11078
     *
11079
     * @see UTF8::to_ascii()
11080
     * @deprecated <p>use "UTF8::to_ascii()"</p>
11081
     */
11082 7
    public static function toAscii(string $str, string $subst_chr = '?', bool $strict = false): string
11083
    {
11084 7
        return self::to_ascii($str, $subst_chr, $strict);
11085
    }
11086
11087
    /**
11088
     * alias for "UTF8::to_iso8859()"
11089
     *
11090
     * @param string|string[] $str
11091
     *
11092
     * @return string|string[]
11093
     *
11094
     * @see UTF8::to_iso8859()
11095
     * @deprecated <p>use "UTF8::to_iso8859()"</p>
11096
     */
11097 2
    public static function toIso8859($str)
11098
    {
11099 2
        return self::to_iso8859($str);
11100
    }
11101
11102
    /**
11103
     * alias for "UTF8::to_latin1()"
11104
     *
11105
     * @param string|string[] $str
11106
     *
11107
     * @return string|string[]
11108
     *
11109
     * @see UTF8::to_latin1()
11110
     * @deprecated <p>use "UTF8::to_latin1()"</p>
11111
     */
11112 2
    public static function toLatin1($str)
11113
    {
11114 2
        return self::to_latin1($str);
11115
    }
11116
11117
    /**
11118
     * alias for "UTF8::to_utf8()"
11119
     *
11120
     * @param string|string[] $str
11121
     *
11122
     * @return string|string[]
11123
     *
11124
     * @see UTF8::to_utf8()
11125
     * @deprecated <p>use "UTF8::to_utf8()"</p>
11126
     */
11127 2
    public static function toUTF8($str)
11128
    {
11129 2
        return self::to_utf8($str);
11130
    }
11131
11132
    /**
11133
     * Convert a string into ASCII.
11134
     *
11135
     * @param string $str     <p>The input string.</p>
11136
     * @param string $unknown [optional] <p>Character use if character unknown. (default is ?)</p>
11137
     * @param bool   $strict  [optional] <p>Use "transliterator_transliterate()" from PHP-Intl | WARNING: bad
11138
     *                        performance</p>
11139
     *
11140
     * @return string
11141
     */
11142 38
    public static function to_ascii(string $str, string $unknown = '?', bool $strict = false): string
11143
    {
11144 38
        static $UTF8_TO_ASCII;
11145
11146 38
        if ($str === '') {
11147 3
            return '';
11148
        }
11149
11150
        // check if we only have ASCII, first (better performance)
11151 35
        if (self::is_ascii($str) === true) {
11152 9
            return $str;
11153
        }
11154
11155 28
        $str = self::clean(
11156 28
            $str,
11157 28
            true,
11158 28
            true,
11159 28
            true,
11160 28
            false,
11161 28
            true,
11162 28
            true
11163
        );
11164
11165
        // check again, if we only have ASCII, now ...
11166 28
        if (self::is_ascii($str) === true) {
11167 10
            return $str;
11168
        }
11169
11170
        if (
11171 19
            $strict === true
11172
            &&
11173 19
            self::$SUPPORT['intl'] === true
11174
        ) {
11175
            // INFO: https://unicode.org/cldr/utility/character.jsp?a=%E2%84%8C
11176
            /** @noinspection PhpComposerExtensionStubsInspection */
11177
            /** @noinspection UnnecessaryCastingInspection */
11178 1
            $str = (string) \transliterator_transliterate('NFKC; [:Nonspacing Mark:] Remove; NFKC; Any-Latin; Latin-ASCII;', $str);
11179
11180
            // check again, if we only have ASCII, now ...
11181 1
            if (self::is_ascii($str) === true) {
11182 1
                return $str;
11183
            }
11184
        }
11185
11186 19
        if (self::$ORD === null) {
11187
            self::$ORD = self::getData('ord');
11188
        }
11189
11190 19
        \preg_match_all('/.{1}|[^\x00]{1,1}$/us', $str, $ar);
11191 19
        $chars = $ar[0];
11192 19
        $ord = null;
11193 19
        foreach ($chars as &$c) {
11194 19
            $ordC0 = self::$ORD[$c[0]];
11195
11196 19
            if ($ordC0 >= 0 && $ordC0 <= 127) {
11197 15
                continue;
11198
            }
11199
11200 19
            $ordC1 = self::$ORD[$c[1]];
11201
11202
            // ASCII - next please
11203 19
            if ($ordC0 >= 192 && $ordC0 <= 223) {
11204 17
                $ord = ($ordC0 - 192) * 64 + ($ordC1 - 128);
11205
            }
11206
11207 19
            if ($ordC0 >= 224) {
11208 8
                $ordC2 = self::$ORD[$c[2]];
11209
11210 8
                if ($ordC0 <= 239) {
11211 7
                    $ord = ($ordC0 - 224) * 4096 + ($ordC1 - 128) * 64 + ($ordC2 - 128);
11212
                }
11213
11214 8
                if ($ordC0 >= 240) {
11215 2
                    $ordC3 = self::$ORD[$c[3]];
11216
11217 2
                    if ($ordC0 <= 247) {
11218 2
                        $ord = ($ordC0 - 240) * 262144 + ($ordC1 - 128) * 4096 + ($ordC2 - 128) * 64 + ($ordC3 - 128);
11219
                    }
11220
11221 2
                    if ($ordC0 >= 248) {
11222
                        $ordC4 = self::$ORD[$c[4]];
11223
11224
                        if ($ordC0 <= 251) {
11225
                            $ord = ($ordC0 - 248) * 16777216 + ($ordC1 - 128) * 262144 + ($ordC2 - 128) * 4096 + ($ordC3 - 128) * 64 + ($ordC4 - 128);
11226
                        }
11227
11228
                        if ($ordC0 >= 252) {
11229
                            $ordC5 = self::$ORD[$c[5]];
11230
11231
                            if ($ordC0 <= 253) {
11232
                                $ord = ($ordC0 - 252) * 1073741824 + ($ordC1 - 128) * 16777216 + ($ordC2 - 128) * 262144 + ($ordC3 - 128) * 4096 + ($ordC4 - 128) * 64 + ($ordC5 - 128);
11233
                            }
11234
                        }
11235
                    }
11236
                }
11237
            }
11238
11239 19
            if ($ordC0 === 254 || $ordC0 === 255) {
11240
                $c = $unknown;
11241
11242
                continue;
11243
            }
11244
11245 19
            if ($ord === null) {
11246
                $c = $unknown;
11247
11248
                continue;
11249
            }
11250
11251 19
            $bank = $ord >> 8;
11252 19
            if (!isset($UTF8_TO_ASCII[$bank])) {
11253 9
                $UTF8_TO_ASCII[$bank] = self::getDataIfExists(\sprintf('x%02x', $bank));
11254 9
                if ($UTF8_TO_ASCII[$bank] === false) {
11255 2
                    $UTF8_TO_ASCII[$bank] = [];
11256
                }
11257
            }
11258
11259 19
            $newchar = $ord & 255;
11260
11261
            /** @noinspection NullCoalescingOperatorCanBeUsedInspection */
11262 19
            if (isset($UTF8_TO_ASCII[$bank][$newchar])) {
11263
11264
                // keep for debugging
11265
                /*
11266
                echo "file: " . sprintf('x%02x', $bank) . "\n";
11267
                echo "char: " . $c . "\n";
11268
                echo "ord: " . $ord . "\n";
11269
                echo "newchar: " . $newchar . "\n";
11270
                echo "ascii: " . $UTF8_TO_ASCII[$bank][$newchar] . "\n";
11271
                echo "bank:" . $bank . "\n\n";
11272
                 */
11273
11274 18
                $c = $UTF8_TO_ASCII[$bank][$newchar];
11275
            } else {
11276
11277
                // keep for debugging missing chars
11278
                /*
11279
                echo "file: " . sprintf('x%02x', $bank) . "\n";
11280
                echo "char: " . $c . "\n";
11281
                echo "ord: " . $ord . "\n";
11282
                echo "newchar: " . $newchar . "\n";
11283
                echo "bank:" . $bank . "\n\n";
11284
                 */
11285
11286 19
                $c = $unknown;
11287
            }
11288
        }
11289
11290 19
        return \implode('', $chars);
11291
    }
11292
11293
    /**
11294
     * @param mixed $str
11295
     *
11296
     * @return bool
11297
     */
11298 19
    public static function to_boolean($str): bool
11299
    {
11300
        // init
11301 19
        $str = (string) $str;
11302
11303 19
        if ($str === '') {
11304 2
            return false;
11305
        }
11306
11307
        // Info: http://php.net/manual/en/filter.filters.validate.php
11308
        $map = [
11309 17
            'true'  => true,
11310
            '1'     => true,
11311
            'on'    => true,
11312
            'yes'   => true,
11313
            'false' => false,
11314
            '0'     => false,
11315
            'off'   => false,
11316
            'no'    => false,
11317
        ];
11318
11319 17
        if (isset($map[$str])) {
11320 11
            return $map[$str];
11321
        }
11322
11323 6
        $key = \strtolower($str);
11324 6
        if (isset($map[$key])) {
11325 2
            return $map[$key];
11326
        }
11327
11328 4
        if (\is_numeric($str)) {
11329 2
            return ((float) $str + 0) > 0;
11330
        }
11331
11332 2
        return (bool) \trim($str);
11333
    }
11334
11335
    /**
11336
     * Convert given string to safe filename (and keep string case).
11337
     *
11338
     * @param string $string
11339
     * @param bool   $use_transliterate No transliteration, conversion etc. is done by default - unsafe characters are
11340
     *                                  simply replaced with hyphen.
11341
     * @param string $fallback_char
11342
     *
11343
     * @return string
11344
     */
11345 1
    public static function to_filename(string $string, bool $use_transliterate = false, string $fallback_char = '-'): string
11346
    {
11347 1
        if ($use_transliterate === true) {
11348 1
            $string = self::str_transliterate($string, $fallback_char);
11349
        }
11350
11351 1
        $fallback_char_escaped = \preg_quote($fallback_char, '/');
11352
11353 1
        $string = (string) \preg_replace(
11354
            [
11355 1
                '/[^' . $fallback_char_escaped . '\.\-a-zA-Z0-9\s]/', // 1) remove un-needed chars
11356 1
                '/[\s]+/u',                                           // 2) convert spaces to $fallback_char
11357 1
                '/[' . $fallback_char_escaped . ']+/u',               // 3) remove double $fallback_char's
11358
            ],
11359
            [
11360 1
                '',
11361 1
                $fallback_char,
11362 1
                $fallback_char,
11363
            ],
11364 1
            $string
11365
        );
11366
11367
        // trim "$fallback_char" from beginning and end of the string
11368 1
        return \trim($string, $fallback_char);
11369
    }
11370
11371
    /**
11372
     * Convert a string into "ISO-8859"-encoding (Latin-1).
11373
     *
11374
     * @param string|string[] $str
11375
     *
11376
     * @return string|string[]
11377
     */
11378 8
    public static function to_iso8859($str)
11379
    {
11380 8
        if (\is_array($str) === true) {
11381 2
            foreach ($str as $k => &$v) {
11382 2
                $v = self::to_iso8859($v);
11383
            }
11384
11385 2
            return $str;
11386
        }
11387
11388 8
        $str = (string) $str;
11389 8
        if ($str === '') {
11390 2
            return '';
11391
        }
11392
11393 8
        return self::utf8_decode($str);
11394
    }
11395
11396
    /**
11397
     * alias for "UTF8::to_iso8859()"
11398
     *
11399
     * @param string|string[] $str
11400
     *
11401
     * @return string|string[]
11402
     *
11403
     * @see UTF8::to_iso8859()
11404
     */
11405 2
    public static function to_latin1($str)
11406
    {
11407 2
        return self::to_iso8859($str);
11408
    }
11409
11410
    /**
11411
     * This function leaves UTF-8 characters alone, while converting almost all non-UTF8 to UTF8.
11412
     *
11413
     * <ul>
11414
     * <li>It decode UTF-8 codepoints and unicode escape sequences.</li>
11415
     * <li>It assumes that the encoding of the original string is either WINDOWS-1252 or ISO-8859.</li>
11416
     * <li>WARNING: It does not remove invalid UTF-8 characters, so you maybe need to use "UTF8::clean()" for this
11417
     * case.</li>
11418
     * </ul>
11419
     *
11420
     * @param string|string[] $str                    <p>Any string or array.</p>
11421
     * @param bool            $decodeHtmlEntityToUtf8 <p>Set to true, if you need to decode html-entities.</p>
11422
     *
11423
     * @return string|string[] the UTF-8 encoded string
11424
     */
11425 41
    public static function to_utf8($str, bool $decodeHtmlEntityToUtf8 = false)
11426
    {
11427 41
        if (\is_array($str) === true) {
11428 4
            foreach ($str as $k => &$v) {
11429 4
                $v = self::to_utf8($v, $decodeHtmlEntityToUtf8);
11430
            }
11431
11432 4
            return $str;
11433
        }
11434
11435 41
        $str = (string) $str;
11436 41
        if ($str === '') {
11437 6
            return $str;
11438
        }
11439
11440 41
        $max = \strlen($str);
11441 41
        $buf = '';
11442
11443 41
        for ($i = 0; $i < $max; ++$i) {
11444 41
            $c1 = $str[$i];
11445
11446 41
            if ($c1 >= "\xC0") { // should be converted to UTF8, if it's not UTF8 already
11447
11448 37
                if ($c1 <= "\xDF") { // looks like 2 bytes UTF8
11449
11450 34
                    $c2 = $i + 1 >= $max ? "\x00" : $str[$i + 1];
11451
11452 34
                    if ($c2 >= "\x80" && $c2 <= "\xBF") { // yeah, almost sure it's UTF8 already
11453 20
                        $buf .= $c1 . $c2;
11454 20
                        ++$i;
11455
                    } else { // not valid UTF8 - convert it
11456 34
                        $buf .= self::to_utf8_convert_helper($c1);
11457
                    }
11458 34
                } elseif ($c1 >= "\xE0" && $c1 <= "\xEF") { // looks like 3 bytes UTF8
11459
11460 33
                    $c2 = $i + 1 >= $max ? "\x00" : $str[$i + 1];
11461 33
                    $c3 = $i + 2 >= $max ? "\x00" : $str[$i + 2];
11462
11463 33
                    if ($c2 >= "\x80" && $c2 <= "\xBF" && $c3 >= "\x80" && $c3 <= "\xBF") { // yeah, almost sure it's UTF8 already
11464 15
                        $buf .= $c1 . $c2 . $c3;
11465 15
                        $i += 2;
11466
                    } else { // not valid UTF8 - convert it
11467 33
                        $buf .= self::to_utf8_convert_helper($c1);
11468
                    }
11469 26
                } elseif ($c1 >= "\xF0" && $c1 <= "\xF7") { // looks like 4 bytes UTF8
11470
11471 26
                    $c2 = $i + 1 >= $max ? "\x00" : $str[$i + 1];
11472 26
                    $c3 = $i + 2 >= $max ? "\x00" : $str[$i + 2];
11473 26
                    $c4 = $i + 3 >= $max ? "\x00" : $str[$i + 3];
11474
11475 26
                    if ($c2 >= "\x80" && $c2 <= "\xBF" && $c3 >= "\x80" && $c3 <= "\xBF" && $c4 >= "\x80" && $c4 <= "\xBF") { // yeah, almost sure it's UTF8 already
11476 8
                        $buf .= $c1 . $c2 . $c3 . $c4;
11477 8
                        $i += 3;
11478
                    } else { // not valid UTF8 - convert it
11479 26
                        $buf .= self::to_utf8_convert_helper($c1);
11480
                    }
11481
                } else { // doesn't look like UTF8, but should be converted
11482
11483 37
                    $buf .= self::to_utf8_convert_helper($c1);
11484
                }
11485 38
            } elseif (($c1 & "\xC0") === "\x80") { // needs conversion
11486
11487 4
                $buf .= self::to_utf8_convert_helper($c1);
11488
            } else { // it doesn't need conversion
11489
11490 38
                $buf .= $c1;
11491
            }
11492
        }
11493
11494
        // decode unicode escape sequences + unicode surrogate pairs
11495 41
        $buf = \preg_replace_callback(
11496 41
            '/\\\\u([dD][89abAB][0-9a-fA-F]{2})\\\\u([dD][cdefCDEF][\da-fA-F]{2})|\\\\u([0-9a-fA-F]{4})/',
11497
            /**
11498
             * @param array $matches
11499
             *
11500
             * @return string
11501
             */
11502
            static function (array $matches): string {
11503 12
                if (isset($matches[3])) {
11504 12
                    $cp = (int) \hexdec($matches[3]);
11505
                } else {
11506
                    // http://unicode.org/faq/utf_bom.html#utf16-4
11507
                    $cp = ((int) \hexdec($matches[1]) << 10)
11508
                          + (int) \hexdec($matches[2])
11509
                          + 0x10000
11510
                          - (0xD800 << 10)
11511
                          - 0xDC00;
11512
                }
11513
11514
                // https://github.com/php/php-src/blob/php-7.3.2/ext/standard/html.c#L471
11515
                //
11516
                // php_utf32_utf8(unsigned char *buf, unsigned k)
11517
11518 12
                if ($cp < 0x80) {
11519 8
                    return (string) self::chr($cp);
11520
                }
11521
11522 9
                if ($cp < 0xA0) {
11523
                    /** @noinspection UnnecessaryCastingInspection */
11524
                    return (string) self::chr(0xC0 | $cp >> 6) . (string) self::chr(0x80 | $cp & 0x3F);
11525
                }
11526
11527 9
                return self::decimal_to_chr($cp);
11528 41
            },
11529 41
            $buf
11530
        );
11531
11532 41
        if ($buf === null) {
11533
            return '';
11534
        }
11535
11536
        // decode UTF-8 codepoints
11537 41
        if ($decodeHtmlEntityToUtf8 === true) {
11538 2
            $buf = self::html_entity_decode($buf);
11539
        }
11540
11541 41
        return $buf;
11542
    }
11543
11544
    /**
11545
     * Strip whitespace or other characters from beginning or end of a UTF-8 string.
11546
     *
11547
     * INFO: This is slower then "trim()"
11548
     *
11549
     * We can only use the original-function, if we use <= 7-Bit in the string / chars
11550
     * but the check for ACSII (7-Bit) cost more time, then we can safe here.
11551
     *
11552
     * @param string      $str   <p>The string to be trimmed</p>
11553
     * @param string|null $chars [optional] <p>Optional characters to be stripped</p>
11554
     *
11555
     * @return string the trimmed string
11556
     */
11557 55
    public static function trim(string $str = '', string $chars = null): string
11558
    {
11559 55
        if ($str === '') {
11560 9
            return '';
11561
        }
11562
11563 48
        if ($chars) {
11564 27
            $chars = \preg_quote($chars, '/');
11565 27
            $pattern = "^[${chars}]+|[${chars}]+\$";
11566
        } else {
11567 21
            $pattern = "^[\s]+|[\s]+\$";
11568
        }
11569
11570 48
        if (self::$SUPPORT['mbstring'] === true) {
11571
            /** @noinspection PhpComposerExtensionStubsInspection */
11572 48
            return (string) \mb_ereg_replace($pattern, '', $str);
11573
        }
11574
11575 8
        return self::regex_replace($str, $pattern, '', '', '/');
11576
    }
11577
11578
    /**
11579
     * Makes string's first char uppercase.
11580
     *
11581
     * @param string      $str                   <p>The input string.</p>
11582
     * @param string      $encoding              [optional] <p>Set the charset for e.g. "mb_" function</p>
11583
     * @param bool        $cleanUtf8             [optional] <p>Remove non UTF-8 chars from the string.</p>
11584
     * @param string|null $lang                  [optional] <p>Set the language for special cases: az, el, lt, tr</p>
11585
     * @param bool        $tryToKeepStringLength [optional] <p>true === try to keep the string length: e.g. ẞ -> ß</p>
11586
     *
11587
     * @return string the resulting string
11588
     */
11589 69
    public static function ucfirst(
11590
        string $str,
11591
        string $encoding = 'UTF-8',
11592
        bool $cleanUtf8 = false,
11593
        string $lang = null,
11594
        bool $tryToKeepStringLength = false
11595
    ): string {
11596 69
        if ($str === '') {
11597 3
            return '';
11598
        }
11599
11600 68
        if ($cleanUtf8 === true) {
11601
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
11602
            // if invalid characters are found in $haystack before $needle
11603 1
            $str = self::clean($str);
11604
        }
11605
11606 68
        $useMbFunction = $lang === null && $tryToKeepStringLength === false;
11607
11608 68
        if ($encoding === 'UTF-8') {
11609 22
            $strPartTwo = (string) \mb_substr($str, 1);
11610
11611 22
            if ($useMbFunction === true) {
11612 22
                $strPartOne = \mb_strtoupper(
11613 22
                    (string) \mb_substr($str, 0, 1)
11614
                );
11615
            } else {
11616
                $strPartOne = self::strtoupper(
11617
                    (string) \mb_substr($str, 0, 1),
11618
                    $encoding,
11619
                    false,
11620
                    $lang,
11621 22
                    $tryToKeepStringLength
11622
                );
11623
            }
11624
        } else {
11625 47
            $encoding = self::normalize_encoding($encoding, 'UTF-8');
11626
11627 47
            $strPartTwo = (string) self::substr($str, 1, null, $encoding);
11628
11629 47
            if ($useMbFunction === true) {
11630 47
                $strPartOne = \mb_strtoupper(
11631 47
                    (string) \mb_substr($str, 0, 1, $encoding),
11632 47
                    $encoding
11633
                );
11634
            } else {
11635
                $strPartOne = self::strtoupper(
11636
                    (string) self::substr($str, 0, 1, $encoding),
11637
                    $encoding,
11638
                    false,
11639
                    $lang,
11640
                    $tryToKeepStringLength
11641
                );
11642
            }
11643
        }
11644
11645 68
        return $strPartOne . $strPartTwo;
11646
    }
11647
11648
    /**
11649
     * alias for "UTF8::ucfirst()"
11650
     *
11651
     * @param string $str
11652
     * @param string $encoding
11653
     * @param bool   $cleanUtf8
11654
     *
11655
     * @return string
11656
     *
11657
     * @see UTF8::ucfirst()
11658
     */
11659 1
    public static function ucword(string $str, string $encoding = 'UTF-8', bool $cleanUtf8 = false): string
11660
    {
11661 1
        return self::ucfirst($str, $encoding, $cleanUtf8);
11662
    }
11663
11664
    /**
11665
     * Uppercase for all words in the string.
11666
     *
11667
     * @param string   $str        <p>The input string.</p>
11668
     * @param string[] $exceptions [optional] <p>Exclusion for some words.</p>
11669
     * @param string   $charlist   [optional] <p>Additional chars that contains to words and do not start a new
11670
     *                             word.</p>
11671
     * @param string   $encoding   [optional] <p>Set the charset.</p>
11672
     * @param bool     $cleanUtf8  [optional] <p>Remove non UTF-8 chars from the string.</p>
11673
     *
11674
     * @return string
11675
     */
11676 8
    public static function ucwords(
11677
        string $str,
11678
        array $exceptions = [],
11679
        string $charlist = '',
11680
        string $encoding = 'UTF-8',
11681
        bool $cleanUtf8 = false
11682
    ): string {
11683 8
        if (!$str) {
11684 2
            return '';
11685
        }
11686
11687
        // INFO: mb_convert_case($str, MB_CASE_TITLE);
11688
        // -> MB_CASE_TITLE didn't only uppercase the first letter, it also lowercase all other letters
11689
11690 7
        if ($cleanUtf8 === true) {
11691
            // "mb_strpos()" and "iconv_strpos()" returns wrong position,
11692
            // if invalid characters are found in $haystack before $needle
11693 1
            $str = self::clean($str);
11694
        }
11695
11696 7
        $usePhpDefaultFunctions = !(bool) ($charlist . \implode('', $exceptions));
11697
11698
        if (
11699 7
            $usePhpDefaultFunctions === true
11700
            &&
11701 7
            self::is_ascii($str) === true
11702
        ) {
11703
            return \ucwords($str);
11704
        }
11705
11706 7
        $words = self::str_to_words($str, $charlist);
11707 7
        $useExceptions = \count($exceptions) > 0;
11708
11709 7
        foreach ($words as &$word) {
11710 7
            if (!$word) {
11711 7
                continue;
11712
            }
11713
11714
            if (
11715 7
                $useExceptions === false
11716
                ||
11717 7
                !\in_array($word, $exceptions, true)
11718
            ) {
11719 7
                $word = self::ucfirst($word, $encoding);
11720
            }
11721
        }
11722
11723 7
        return \implode('', $words);
11724
    }
11725
11726
    /**
11727
     * Multi decode html entity & fix urlencoded-win1252-chars.
11728
     *
11729
     * e.g:
11730
     * 'test+test'                     => 'test test'
11731
     * 'D&#252;sseldorf'               => 'Düsseldorf'
11732
     * 'D%FCsseldorf'                  => 'Düsseldorf'
11733
     * 'D&#xFC;sseldorf'               => 'Düsseldorf'
11734
     * 'D%26%23xFC%3Bsseldorf'         => 'Düsseldorf'
11735
     * 'Düsseldorf'                   => 'Düsseldorf'
11736
     * 'D%C3%BCsseldorf'               => 'Düsseldorf'
11737
     * 'D%C3%83%C2%BCsseldorf'         => 'Düsseldorf'
11738
     * 'D%25C3%2583%25C2%25BCsseldorf' => 'Düsseldorf'
11739
     *
11740
     * @param string $str          <p>The input string.</p>
11741
     * @param bool   $multi_decode <p>Decode as often as possible.</p>
11742
     *
11743
     * @return string
11744
     */
11745 4
    public static function urldecode(string $str, bool $multi_decode = true): string
11746
    {
11747 4
        if ($str === '') {
11748 3
            return '';
11749
        }
11750
11751
        if (
11752 4
            \strpos($str, '&') === false
11753
            &&
11754 4
            \strpos($str, '%') === false
11755
            &&
11756 4
            \strpos($str, '+') === false
11757
            &&
11758 4
            \strpos($str, '\u') === false
11759
        ) {
11760 3
            return self::fix_simple_utf8($str);
11761
        }
11762
11763 4
        $str = self::urldecode_unicode_helper($str);
11764
11765
        do {
11766 4
            $str_compare = $str;
11767
11768
            /**
11769
             * @psalm-suppress PossiblyInvalidArgument
11770
             */
11771 4
            $str = self::fix_simple_utf8(
11772 4
                \urldecode(
11773 4
                    self::html_entity_decode(
11774 4
                        self::to_utf8($str),
11775 4
                        \ENT_QUOTES | \ENT_HTML5
11776
                    )
11777
                )
11778
            );
11779 4
        } while ($multi_decode === true && $str_compare !== $str);
11780
11781 4
        return $str;
11782
    }
11783
11784
    /**
11785
     * Return a array with "urlencoded"-win1252 -> UTF-8
11786
     *
11787
     * @return string[]
11788
     *
11789
     * @deprecated <p>use the "UTF8::urldecode()" function to decode a string</p>
11790
     */
11791 2
    public static function urldecode_fix_win1252_chars(): array
11792
    {
11793
        return [
11794 2
            '%20' => ' ',
11795
            '%21' => '!',
11796
            '%22' => '"',
11797
            '%23' => '#',
11798
            '%24' => '$',
11799
            '%25' => '%',
11800
            '%26' => '&',
11801
            '%27' => "'",
11802
            '%28' => '(',
11803
            '%29' => ')',
11804
            '%2A' => '*',
11805
            '%2B' => '+',
11806
            '%2C' => ',',
11807
            '%2D' => '-',
11808
            '%2E' => '.',
11809
            '%2F' => '/',
11810
            '%30' => '0',
11811
            '%31' => '1',
11812
            '%32' => '2',
11813
            '%33' => '3',
11814
            '%34' => '4',
11815
            '%35' => '5',
11816
            '%36' => '6',
11817
            '%37' => '7',
11818
            '%38' => '8',
11819
            '%39' => '9',
11820
            '%3A' => ':',
11821
            '%3B' => ';',
11822
            '%3C' => '<',
11823
            '%3D' => '=',
11824
            '%3E' => '>',
11825
            '%3F' => '?',
11826
            '%40' => '@',
11827
            '%41' => 'A',
11828
            '%42' => 'B',
11829
            '%43' => 'C',
11830
            '%44' => 'D',
11831
            '%45' => 'E',
11832
            '%46' => 'F',
11833
            '%47' => 'G',
11834
            '%48' => 'H',
11835
            '%49' => 'I',
11836
            '%4A' => 'J',
11837
            '%4B' => 'K',
11838
            '%4C' => 'L',
11839
            '%4D' => 'M',
11840
            '%4E' => 'N',
11841
            '%4F' => 'O',
11842
            '%50' => 'P',
11843
            '%51' => 'Q',
11844
            '%52' => 'R',
11845
            '%53' => 'S',
11846
            '%54' => 'T',
11847
            '%55' => 'U',
11848
            '%56' => 'V',
11849
            '%57' => 'W',
11850
            '%58' => 'X',
11851
            '%59' => 'Y',
11852
            '%5A' => 'Z',
11853
            '%5B' => '[',
11854
            '%5C' => '\\',
11855
            '%5D' => ']',
11856
            '%5E' => '^',
11857
            '%5F' => '_',
11858
            '%60' => '`',
11859
            '%61' => 'a',
11860
            '%62' => 'b',
11861
            '%63' => 'c',
11862
            '%64' => 'd',
11863
            '%65' => 'e',
11864
            '%66' => 'f',
11865
            '%67' => 'g',
11866
            '%68' => 'h',
11867
            '%69' => 'i',
11868
            '%6A' => 'j',
11869
            '%6B' => 'k',
11870
            '%6C' => 'l',
11871
            '%6D' => 'm',
11872
            '%6E' => 'n',
11873
            '%6F' => 'o',
11874
            '%70' => 'p',
11875
            '%71' => 'q',
11876
            '%72' => 'r',
11877
            '%73' => 's',
11878
            '%74' => 't',
11879
            '%75' => 'u',
11880
            '%76' => 'v',
11881
            '%77' => 'w',
11882
            '%78' => 'x',
11883
            '%79' => 'y',
11884
            '%7A' => 'z',
11885
            '%7B' => '{',
11886
            '%7C' => '|',
11887
            '%7D' => '}',
11888
            '%7E' => '~',
11889
            '%7F' => '',
11890
            '%80' => '`',
11891
            '%81' => '',
11892
            '%82' => '‚',
11893
            '%83' => 'ƒ',
11894
            '%84' => '„',
11895
            '%85' => '…',
11896
            '%86' => '†',
11897
            '%87' => '‡',
11898
            '%88' => 'ˆ',
11899
            '%89' => '‰',
11900
            '%8A' => 'Š',
11901
            '%8B' => '‹',
11902
            '%8C' => 'Œ',
11903
            '%8D' => '',
11904
            '%8E' => 'Ž',
11905
            '%8F' => '',
11906
            '%90' => '',
11907
            '%91' => '‘',
11908
            '%92' => '’',
11909
            '%93' => '“',
11910
            '%94' => '”',
11911
            '%95' => '•',
11912
            '%96' => '–',
11913
            '%97' => '—',
11914
            '%98' => '˜',
11915
            '%99' => '™',
11916
            '%9A' => 'š',
11917
            '%9B' => '›',
11918
            '%9C' => 'œ',
11919
            '%9D' => '',
11920
            '%9E' => 'ž',
11921
            '%9F' => 'Ÿ',
11922
            '%A0' => '',
11923
            '%A1' => '¡',
11924
            '%A2' => '¢',
11925
            '%A3' => '£',
11926
            '%A4' => '¤',
11927
            '%A5' => '¥',
11928
            '%A6' => '¦',
11929
            '%A7' => '§',
11930
            '%A8' => '¨',
11931
            '%A9' => '©',
11932
            '%AA' => 'ª',
11933
            '%AB' => '«',
11934
            '%AC' => '¬',
11935
            '%AD' => '',
11936
            '%AE' => '®',
11937
            '%AF' => '¯',
11938
            '%B0' => '°',
11939
            '%B1' => '±',
11940
            '%B2' => '²',
11941
            '%B3' => '³',
11942
            '%B4' => '´',
11943
            '%B5' => 'µ',
11944
            '%B6' => '¶',
11945
            '%B7' => '·',
11946
            '%B8' => '¸',
11947
            '%B9' => '¹',
11948
            '%BA' => 'º',
11949
            '%BB' => '»',
11950
            '%BC' => '¼',
11951
            '%BD' => '½',
11952
            '%BE' => '¾',
11953
            '%BF' => '¿',
11954
            '%C0' => 'À',
11955
            '%C1' => 'Á',
11956
            '%C2' => 'Â',
11957
            '%C3' => 'Ã',
11958
            '%C4' => 'Ä',
11959
            '%C5' => 'Å',
11960
            '%C6' => 'Æ',
11961
            '%C7' => 'Ç',
11962
            '%C8' => 'È',
11963
            '%C9' => 'É',
11964
            '%CA' => 'Ê',
11965
            '%CB' => 'Ë',
11966
            '%CC' => 'Ì',
11967
            '%CD' => 'Í',
11968
            '%CE' => 'Î',
11969
            '%CF' => 'Ï',
11970
            '%D0' => 'Ð',
11971
            '%D1' => 'Ñ',
11972
            '%D2' => 'Ò',
11973
            '%D3' => 'Ó',
11974
            '%D4' => 'Ô',
11975
            '%D5' => 'Õ',
11976
            '%D6' => 'Ö',
11977
            '%D7' => '×',
11978
            '%D8' => 'Ø',
11979
            '%D9' => 'Ù',
11980
            '%DA' => 'Ú',
11981
            '%DB' => 'Û',
11982
            '%DC' => 'Ü',
11983
            '%DD' => 'Ý',
11984
            '%DE' => 'Þ',
11985
            '%DF' => 'ß',
11986
            '%E0' => 'à',
11987
            '%E1' => 'á',
11988
            '%E2' => 'â',
11989
            '%E3' => 'ã',
11990
            '%E4' => 'ä',
11991
            '%E5' => 'å',
11992
            '%E6' => 'æ',
11993
            '%E7' => 'ç',
11994
            '%E8' => 'è',
11995
            '%E9' => 'é',
11996
            '%EA' => 'ê',
11997
            '%EB' => 'ë',
11998
            '%EC' => 'ì',
11999
            '%ED' => 'í',
12000
            '%EE' => 'î',
12001
            '%EF' => 'ï',
12002
            '%F0' => 'ð',
12003
            '%F1' => 'ñ',
12004
            '%F2' => 'ò',
12005
            '%F3' => 'ó',
12006
            '%F4' => 'ô',
12007
            '%F5' => 'õ',
12008
            '%F6' => 'ö',
12009
            '%F7' => '÷',
12010
            '%F8' => 'ø',
12011
            '%F9' => 'ù',
12012
            '%FA' => 'ú',
12013
            '%FB' => 'û',
12014
            '%FC' => 'ü',
12015
            '%FD' => 'ý',
12016
            '%FE' => 'þ',
12017
            '%FF' => 'ÿ',
12018
        ];
12019
    }
12020
12021
    /**
12022
     * Decodes an UTF-8 string to ISO-8859-1.
12023
     *
12024
     * @param string $str           <p>The input string.</p>
12025
     * @param bool   $keepUtf8Chars
12026
     *
12027
     * @return string
12028
     */
12029 14
    public static function utf8_decode(string $str, bool $keepUtf8Chars = false): string
12030
    {
12031 14
        if ($str === '') {
12032 6
            return '';
12033
        }
12034
12035
        // save for later comparision
12036 14
        $str_backup = $str;
12037 14
        $len = \strlen($str);
12038
12039 14
        if (self::$ORD === null) {
12040
            self::$ORD = self::getData('ord');
12041
        }
12042
12043 14
        if (self::$CHR === null) {
12044
            self::$CHR = self::getData('chr');
12045
        }
12046
12047 14
        $noCharFound = '?';
12048
        /** @noinspection ForeachInvariantsInspection */
12049 14
        for ($i = 0, $j = 0; $i < $len; ++$i, ++$j) {
12050 14
            switch ($str[$i] & "\xF0") {
12051 14
                case "\xC0":
12052 13
                case "\xD0":
12053 13
                    $c = (self::$ORD[$str[$i] & "\x1F"] << 6) | self::$ORD[$str[++$i] & "\x3F"];
12054 13
                    $str[$j] = $c < 256 ? self::$CHR[$c] : $noCharFound;
12055
12056 13
                    break;
12057
12058
                /** @noinspection PhpMissingBreakStatementInspection */
12059 13
                case "\xF0":
12060
                    ++$i;
12061
12062
                // no break
12063
12064 13
                case "\xE0":
12065 11
                    $str[$j] = $noCharFound;
12066 11
                    $i += 2;
12067
12068 11
                    break;
12069
12070
                default:
12071 12
                    $str[$j] = $str[$i];
12072
            }
12073
        }
12074
12075 14
        $return = \substr($str, 0, $j);
12076 14
        if ($return === false) {
12077
            $return = '';
12078
        }
12079
12080
        if (
12081 14
            $keepUtf8Chars === true
12082
            &&
12083 14
            self::strlen($return) >= (int) self::strlen($str_backup)
12084
        ) {
12085 2
            return $str_backup;
12086
        }
12087
12088 14
        return $return;
12089
    }
12090
12091
    /**
12092
     * Encodes an ISO-8859-1 string to UTF-8.
12093
     *
12094
     * @param string $str <p>The input string.</p>
12095
     *
12096
     * @return string
12097
     */
12098 14
    public static function utf8_encode(string $str): string
12099
    {
12100 14
        if ($str === '') {
12101 14
            return '';
12102
        }
12103
12104 14
        $str = \utf8_encode($str);
12105
12106
        // the polyfill maybe return false
12107
        /** @noinspection CallableParameterUseCaseInTypeContextInspection */
12108
        /** @psalm-suppress TypeDoesNotContainType */
12109 14
        if ($str === false) {
12110
            return '';
12111
        }
12112
12113 14
        return $str;
12114
    }
12115
12116
    /**
12117
     * fix -> utf8-win1252 chars
12118
     *
12119
     * @param string $str <p>The input string.</p>
12120
     *
12121
     * @return string
12122
     *
12123
     * @deprecated <p>use "UTF8::fix_simple_utf8()"</p>
12124
     */
12125 2
    public static function utf8_fix_win1252_chars(string $str): string
12126
    {
12127 2
        return self::fix_simple_utf8($str);
12128
    }
12129
12130
    /**
12131
     * Returns an array with all utf8 whitespace characters.
12132
     *
12133
     * @see http://www.bogofilter.org/pipermail/bogofilter/2003-March/001889.html
12134
     *
12135
     * @return string[]
12136
     *                  An array with all known whitespace characters as values and the type of whitespace as keys
12137
     *                  as defined in above URL
12138
     */
12139 2
    public static function whitespace_table(): array
12140
    {
12141 2
        return self::$WHITESPACE_TABLE;
12142
    }
12143
12144
    /**
12145
     * Limit the number of words in a string.
12146
     *
12147
     * @param string $str      <p>The input string.</p>
12148
     * @param int    $limit    <p>The limit of words as integer.</p>
12149
     * @param string $strAddOn <p>Replacement for the striped string.</p>
12150
     *
12151
     * @return string
12152
     */
12153 2
    public static function words_limit(string $str, int $limit = 100, string $strAddOn = '…'): string
12154
    {
12155 2
        if ($str === '' || $limit < 1) {
12156 2
            return '';
12157
        }
12158
12159 2
        \preg_match('/^\s*+(?:\S++\s*+){1,' . $limit . '}/u', $str, $matches);
12160
12161
        if (
12162 2
            !isset($matches[0])
12163
            ||
12164 2
            \mb_strlen($str) === (int) \mb_strlen($matches[0])
12165
        ) {
12166 2
            return $str;
12167
        }
12168
12169 2
        return \rtrim($matches[0]) . $strAddOn;
12170
    }
12171
12172
    /**
12173
     * Wraps a string to a given number of characters
12174
     *
12175
     * @see http://php.net/manual/en/function.wordwrap.php
12176
     *
12177
     * @param string $str   <p>The input string.</p>
12178
     * @param int    $width [optional] <p>The column width.</p>
12179
     * @param string $break [optional] <p>The line is broken using the optional break parameter.</p>
12180
     * @param bool   $cut   [optional] <p>
12181
     *                      If the cut is set to true, the string is
12182
     *                      always wrapped at or before the specified width. So if you have
12183
     *                      a word that is larger than the given width, it is broken apart.
12184
     *                      </p>
12185
     *
12186
     * @return string
12187
     *                <p>The given string wrapped at the specified column.</p>
12188
     */
12189 10
    public static function wordwrap(
12190
        string $str,
12191
        int $width = 75,
12192
        string $break = "\n",
12193
        bool $cut = false
12194
    ): string {
12195 10
        if ($str === '' || $break === '') {
12196 3
            return '';
12197
        }
12198
12199 8
        $strSplit = \explode($break, $str);
12200 8
        if ($strSplit === false) {
12201
            return '';
12202
        }
12203
12204 8
        $chars = [];
12205 8
        $wordSplit = '';
12206 8
        foreach ($strSplit as $i => $iValue) {
12207 8
            if ($i) {
12208 1
                $chars[] = $break;
12209 1
                $wordSplit .= '#';
12210
            }
12211
12212 8
            foreach (self::str_split($iValue) as $c) {
12213 8
                $chars[] = $c;
12214 8
                $wordSplit .= $c === ' ' ? ' ' : '?';
12215
            }
12216
        }
12217
12218 8
        $strReturn = '';
12219 8
        $j = 0;
12220 8
        $b = $i = -1;
12221 8
        $wordSplit = \wordwrap($wordSplit, $width, '#', $cut);
12222
12223 8
        while (false !== $b = \mb_strpos($wordSplit, '#', $b + 1)) {
12224 6
            for (++$i; $i < $b; ++$i) {
12225 6
                $strReturn .= $chars[$j];
12226 6
                unset($chars[$j++]);
12227
            }
12228
12229
            if (
12230 6
                $break === $chars[$j]
12231
                ||
12232 6
                $chars[$j] === ' '
12233
            ) {
12234 3
                unset($chars[$j++]);
12235
            }
12236
12237 6
            $strReturn .= $break;
12238
        }
12239
12240 8
        return $strReturn . \implode('', $chars);
12241
    }
12242
12243
    /**
12244
     * Line-Wrap the string after $limit, but also after the next word.
12245
     *
12246
     * @param string $str
12247
     * @param int    $limit
12248
     *
12249
     * @return string
12250
     */
12251 1
    public static function wordwrap_per_line(string $str, int $limit): string
12252
    {
12253 1
        $strings = (array) \preg_split('/\\r\\n|\\r|\\n/', $str);
12254
12255 1
        $string = '';
12256 1
        foreach ($strings as &$value) {
12257 1
            if ($value === false) {
12258
                continue;
12259
            }
12260
12261 1
            $string .= \wordwrap($value, $limit);
12262 1
            $string .= "\n";
12263
        }
12264
12265 1
        return $string;
12266
    }
12267
12268
    /**
12269
     * Returns an array of Unicode White Space characters.
12270
     *
12271
     * @return string[] an array with numeric code point as key and White Space Character as value
12272
     */
12273 2
    public static function ws(): array
12274
    {
12275 2
        return self::$WHITESPACE;
12276
    }
12277
12278
    /**
12279
     * @param string $str
12280
     * @param bool   $useLower     <p>Use uppercase by default, otherwise use lowecase.</p>
12281
     * @param bool   $fullCaseFold <p>Convert not only common cases.</p>
12282
     *
12283
     * @return string
12284
     */
12285 33
    private static function fixStrCaseHelper(string $str, $useLower = false, $fullCaseFold = false): string
12286
    {
12287 33
        $upper = self::$COMMON_CASE_FOLD['upper'];
12288 33
        $lower = self::$COMMON_CASE_FOLD['lower'];
12289
12290 33
        if ($useLower === true) {
12291 2
            $str = \str_replace(
12292 2
                $upper,
12293 2
                $lower,
12294 2
                $str
12295
            );
12296
        } else {
12297 31
            $str = \str_replace(
12298 31
                $lower,
12299 31
                $upper,
12300 31
                $str
12301
            );
12302
        }
12303
12304 33
        if ($fullCaseFold) {
12305 31
            static $FULL_CASE_FOLD = null;
12306 31
            if ($FULL_CASE_FOLD === null) {
12307 1
                $FULL_CASE_FOLD = self::getData('caseFolding_full');
12308
            }
12309
12310 31
            if ($useLower === true) {
12311 2
                $str = \str_replace($FULL_CASE_FOLD[0], $FULL_CASE_FOLD[1], $str);
12312
            } else {
12313 29
                $str = \str_replace($FULL_CASE_FOLD[1], $FULL_CASE_FOLD[0], $str);
12314
            }
12315
        }
12316
12317 33
        return $str;
12318
    }
12319
12320
    /**
12321
     * get data from "/data/*.php"
12322
     *
12323
     * @param string $file
12324
     *
12325
     * @return array
12326
     */
12327 6
    private static function getData(string $file): array
12328
    {
12329
        /** @noinspection PhpIncludeInspection */
12330
        /** @noinspection UsingInclusionReturnValueInspection */
12331
        /** @psalm-suppress UnresolvableInclude */
12332 6
        return include __DIR__ . '/data/' . $file . '.php';
12333
    }
12334
12335
    /**
12336
     * get data from "/data/*.php"
12337
     *
12338
     * @param string $file
12339
     *
12340
     * @return false|mixed will return false on error
12341
     */
12342 9
    private static function getDataIfExists(string $file)
12343
    {
12344 9
        $file = __DIR__ . '/data/' . $file . '.php';
12345 9
        if (\file_exists($file)) {
12346
            /** @noinspection PhpIncludeInspection */
12347
            /** @noinspection UsingInclusionReturnValueInspection */
12348 8
            return include $file;
12349
        }
12350
12351 2
        return false;
12352
    }
12353
12354
    /**
12355
     * @return true|null
12356
     */
12357 9
    private static function initEmojiData()
12358
    {
12359 9
        if (self::$EMOJI_KEYS_CACHE === null) {
12360 1
            if (self::$EMOJI === null) {
12361 1
                self::$EMOJI = self::getData('emoji');
12362
            }
12363
12364 1
            \uksort(
12365 1
                self::$EMOJI,
12366
                static function (string $a, string $b): int {
12367 1
                    return \strlen($b) <=> \strlen($a);
12368 1
                }
12369
            );
12370
12371 1
            self::$EMOJI_KEYS_CACHE = \array_keys(self::$EMOJI);
12372 1
            self::$EMOJI_VALUES_CACHE = \array_values(self::$EMOJI);
12373
12374 1
            foreach (self::$EMOJI_KEYS_CACHE as $key) {
12375 1
                $tmpKey = \crc32($key);
12376 1
                self::$EMOJI_KEYS_REVERSIBLE_CACHE[] = '_-_PORTABLE_UTF8_-_' . $tmpKey . '_-_' . \strrev((string) $tmpKey) . '_-_8FTU_ELBATROP_-_';
12377
            }
12378
12379 1
            return true;
12380
        }
12381
12382 9
        return null;
12383
    }
12384
12385
    /**
12386
     * Checks whether mbstring "overloaded" is active on the server.
12387
     *
12388
     * @return bool
12389
     */
12390
    private static function mbstring_overloaded(): bool
12391
    {
12392
        /**
12393
         * INI directive 'mbstring.func_overload' is deprecated since PHP 7.2
12394
         */
12395
12396
        /** @noinspection PhpComposerExtensionStubsInspection */
12397
        /** @noinspection PhpUsageOfSilenceOperatorInspection */
12398
        return \defined('MB_OVERLOAD_STRING')
12399
               &&
12400
               ((int) @\ini_get('mbstring.func_overload') & \MB_OVERLOAD_STRING);
12401
    }
12402
12403
    /**
12404
     * @param array $strings
12405
     * @param bool  $removeEmptyValues
12406
     * @param int   $removeShortValues
12407
     *
12408
     * @return array
12409
     */
12410 2
    private static function reduce_string_array(array $strings, bool $removeEmptyValues, int $removeShortValues = null): array
12411
    {
12412
        // init
12413 2
        $return = [];
12414
12415 2
        foreach ($strings as &$str) {
12416
            if (
12417 2
                $removeShortValues !== null
12418
                &&
12419 2
                \mb_strlen($str) <= $removeShortValues
12420
            ) {
12421 2
                continue;
12422
            }
12423
12424
            if (
12425 2
                $removeEmptyValues === true
12426
                &&
12427 2
                \trim($str) === ''
12428
            ) {
12429 2
                continue;
12430
            }
12431
12432 2
            $return[] = $str;
12433
        }
12434
12435 2
        return $return;
12436
    }
12437
12438
    /**
12439
     * rxClass
12440
     *
12441
     * @param string $s
12442
     * @param string $class
12443
     *
12444
     * @return string
12445
     */
12446 33
    private static function rxClass(string $s, string $class = ''): string
12447
    {
12448 33
        static $RX_CLASS_CACHE = [];
12449
12450 33
        $cacheKey = $s . $class;
12451
12452 33
        if (isset($RX_CLASS_CACHE[$cacheKey])) {
12453 21
            return $RX_CLASS_CACHE[$cacheKey];
12454
        }
12455
12456 16
        $classArray = [$class];
12457
12458
        /** @noinspection SuspiciousLoopInspection */
12459
        /** @noinspection AlterInForeachInspection */
12460 16
        foreach (self::str_split($s) as &$s) {
0 ignored issues
show
Bug introduced by
The expression self::str_split($s) cannot be used as a reference.

Let?s assume that you have the following foreach statement:

foreach ($array as &$itemValue) { }

$itemValue is assigned by reference. This is possible because the expression (in the example $array) can be used as a reference target.

However, if we were to replace $array with something different like the result of a function call as in

foreach (getArray() as &$itemValue) { }

then assigning by reference is not possible anymore as there is no target that could be modified.

Available Fixes

1. Do not assign by reference
foreach (getArray() as $itemValue) { }
2. Assign to a local variable first
$array = getArray();
foreach ($array as &$itemValue) {}
3. Return a reference
function &getArray() { $array = array(); return $array; }

foreach (getArray() as &$itemValue) { }
Loading history...
12461 15
            if ($s === '-') {
12462
                $classArray[0] = '-' . $classArray[0];
12463 15
            } elseif (!isset($s[2])) {
12464 15
                $classArray[0] .= \preg_quote($s, '/');
12465 1
            } elseif (self::strlen($s) === 1) {
12466 1
                $classArray[0] .= $s;
12467
            } else {
12468 15
                $classArray[] = $s;
12469
            }
12470
        }
12471
12472 16
        if ($classArray[0]) {
12473 16
            $classArray[0] = '[' . $classArray[0] . ']';
12474
        }
12475
12476 16
        if (\count($classArray) === 1) {
12477 16
            $return = $classArray[0];
12478
        } else {
12479
            $return = '(?:' . \implode('|', $classArray) . ')';
12480
        }
12481
12482 16
        $RX_CLASS_CACHE[$cacheKey] = $return;
12483
12484 16
        return $return;
12485
    }
12486
12487
    /**
12488
     * Personal names such as "Marcus Aurelius" are sometimes typed incorrectly using lowercase ("marcus aurelius").
12489
     *
12490
     * @param string $names
12491
     * @param string $delimiter
12492
     * @param string $encoding
12493
     *
12494
     * @return string
12495
     */
12496 1
    private static function str_capitalize_name_helper(string $names, string $delimiter, string $encoding = 'UTF-8'): string
12497
    {
12498
        // init
12499 1
        $namesArray = \explode($delimiter, $names);
12500
12501 1
        if ($namesArray === false) {
12502
            return '';
12503
        }
12504
12505
        $specialCases = [
12506 1
            'names' => [
12507
                'ab',
12508
                'af',
12509
                'al',
12510
                'and',
12511
                'ap',
12512
                'bint',
12513
                'binte',
12514
                'da',
12515
                'de',
12516
                'del',
12517
                'den',
12518
                'der',
12519
                'di',
12520
                'dit',
12521
                'ibn',
12522
                'la',
12523
                'mac',
12524
                'nic',
12525
                'of',
12526
                'ter',
12527
                'the',
12528
                'und',
12529
                'van',
12530
                'von',
12531
                'y',
12532
                'zu',
12533
            ],
12534
            'prefixes' => [
12535
                'al-',
12536
                "d'",
12537
                'ff',
12538
                "l'",
12539
                'mac',
12540
                'mc',
12541
                'nic',
12542
            ],
12543
        ];
12544
12545 1
        foreach ($namesArray as &$name) {
12546 1
            if (\in_array($name, $specialCases['names'], true)) {
12547 1
                continue;
12548
            }
12549
12550 1
            $continue = false;
12551
12552 1
            if ($delimiter === '-') {
12553 1
                foreach ((array) $specialCases['names'] as &$beginning) {
12554 1
                    if (self::strpos($name, $beginning, 0, $encoding) === 0) {
12555 1
                        $continue = true;
12556
                    }
12557
                }
12558 1
                unset($beginning);
12559
            }
12560
12561 1
            foreach ((array) $specialCases['prefixes'] as &$beginning) {
12562 1
                if (self::strpos($name, $beginning, 0, $encoding) === 0) {
12563 1
                    $continue = true;
12564
                }
12565
            }
12566 1
            unset($beginning);
12567
12568 1
            if ($continue === true) {
12569 1
                continue;
12570
            }
12571
12572 1
            $name = self::ucfirst($name);
12573
        }
12574
12575 1
        return \implode($delimiter, $namesArray);
12576
    }
12577
12578
    /**
12579
     * Generic case sensitive transformation for collation matching.
12580
     *
12581
     * @param string $str <p>The input string</p>
12582
     *
12583
     * @return string|null
12584
     */
12585 6
    private static function strtonatfold(string $str)
12586
    {
12587 6
        return \preg_replace(
12588 6
            '/\p{Mn}+/u',
12589 6
            '',
12590 6
            \Normalizer::normalize($str, \Normalizer::NFD)
12591
        );
12592
    }
12593
12594
    /**
12595
     * @param int|string $input
12596
     *
12597
     * @return string
12598
     */
12599 31
    private static function to_utf8_convert_helper($input): string
12600
    {
12601
        // init
12602 31
        $buf = '';
12603
12604 31
        if (self::$ORD === null) {
12605 1
            self::$ORD = self::getData('ord');
12606
        }
12607
12608 31
        if (self::$CHR === null) {
12609 1
            self::$CHR = self::getData('chr');
12610
        }
12611
12612 31
        if (self::$WIN1252_TO_UTF8 === null) {
12613 1
            self::$WIN1252_TO_UTF8 = self::getData('win1252_to_utf8');
12614
        }
12615
12616 31
        $ordC1 = self::$ORD[$input];
12617 31
        if (isset(self::$WIN1252_TO_UTF8[$ordC1])) { // found in Windows-1252 special cases
12618 31
            $buf .= self::$WIN1252_TO_UTF8[$ordC1];
12619
        } else {
12620 1
            $cc1 = self::$CHR[$ordC1 / 64] | "\xC0";
12621 1
            $cc2 = ((string) $input & "\x3F") | "\x80";
0 ignored issues
show
Bug introduced by
Are you sure you want to use the bitwise & or did you mean &&?
Loading history...
Bug introduced by
Are you sure you want to use the bitwise | or did you mean ||?
Loading history...
12622 1
            $buf .= $cc1 . $cc2;
12623
        }
12624
12625 31
        return $buf;
12626
    }
12627
12628
    /**
12629
     * @param string $str
12630
     *
12631
     * @return string
12632
     */
12633 9
    private static function urldecode_unicode_helper(string $str): string
12634
    {
12635 9
        $pattern = '/%u([0-9a-fA-F]{3,4})/';
12636 9
        if (\preg_match($pattern, $str)) {
12637 7
            $str = (string) \preg_replace($pattern, '&#x\\1;', $str);
12638
        }
12639
12640 9
        return $str;
12641
    }
12642
}
12643